update comments to allign with spec

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7436 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 12 insertions, 14 deletions

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
index f75bb9c06b..9c3c07743d 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmSxDispatch.h
@@ -70,7 +70,7 @@ typedef struct {
                                 and phases, so the Sx state handler(s) must check the Type and

                                 Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.

 

-  Nothing

+  @return None

 

 **/

 typedef

@@ -83,9 +83,8 @@ VOID
 /**

   Register a child SMI source dispatch function with a parent SMM driver

 

-  @param  This                  Protocol instance pointer.

-  @param  DispatchFunction      Pointer to dispatch function to be invoked for

-                                this SMI source

+  @param  This                  Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.

+  @param  DispatchFunction      Function to install.

   @param  DispatchContext       Pointer to the dispatch function's context.

                                 The caller fills this context in before calling

                                 the register function to indicate to the register

@@ -112,30 +111,29 @@ VOID
 typedef

 EFI_STATUS

 (EFIAPI *EFI_SMM_SX_REGISTER)(

-  IN EFI_SMM_SX_DISPATCH_PROTOCOL           *This,

-  IN  EFI_SMM_SX_DISPATCH                   DispatchFunction,

-  IN  EFI_SMM_SX_DISPATCH_CONTEXT           *DispatchContext,

-  OUT EFI_HANDLE                            *DispatchHandle

+  IN EFI_SMM_SX_DISPATCH_PROTOCOL          *This,

+  IN EFI_SMM_SX_DISPATCH                   DispatchFunction,

+  IN EFI_SMM_SX_DISPATCH_CONTEXT           *DispatchContext,

+  OUT EFI_HANDLE                           *DispatchHandle

   );

 

 /**

-  Unregister a child SMI source dispatch function with a parent SMM driver

+  Unregisters an Sx-state service

 

-  @param  This                  Protocol instance pointer.

-  @param  DispatchHandle        Handle of dispatch function to deregister.

+  @param  This                  Pointer to the EFI_SMM_SX_DISPATCH_PROTOCOL instance.

+  @param  DispatchHandle        Handle of the service to remove.

 

   @retval EFI_SUCCESS           The dispatch function has been successfully unregistered and the

                                 SMI source has been disabled if there are no other registered child

                                 dispatch functions for this SMI source.

   @retval EFI_INVALID_PARAMETER Handle is invalid.

-  @retval other                 TBD

 

 **/

 typedef

 EFI_STATUS

 (EFIAPI *EFI_SMM_SX_UNREGISTER)(

-  IN EFI_SMM_SX_DISPATCH_PROTOCOL           *This,

-  IN  EFI_HANDLE                            DispatchHandle

+  IN EFI_SMM_SX_DISPATCH_PROTOCOL          *This,

+  IN EFI_HANDLE                            DispatchHandle

   );

 

 //