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, 14 insertions, 17 deletions

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
index b89fb5553e..95a6d51bf5 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
@@ -62,7 +62,7 @@ typedef struct {
                                 by the dispatching driver prior to

                                 invoking this dispatch function.

 

-  Nothing

+  @return None

 

 **/

 typedef

@@ -73,18 +73,16 @@ VOID
   );

 

 /**

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

+  Provides the parent dispatch service for a given SMI source generator

 

-  @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_POWER_BUTTON_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

                                 function the Power Button SMI phase for which the dispatch

                                 function should be invoked.

-  @param  DispatchHandle        Handle of dispatch function, for when interfacing

-                                with the parent Sx state SMM driver.

+  @param  DispatchHandle        Handle generated by the dispatcher to track the function instance.

 

   @retval EFI_SUCCESS           The dispatch function has been successfully

                                 registered and the SMI source has been enabled.

@@ -98,31 +96,30 @@ VOID
 typedef

 EFI_STATUS

 (EFIAPI *EFI_SMM_POWER_BUTTON_REGISTER)(

-  IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL            *This,

-  IN  EFI_SMM_POWER_BUTTON_DISPATCH                    DispatchFunction,

-  IN  EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT            *DispatchContext,

-  OUT EFI_HANDLE                                       *DispatchHandle

+  IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL           *This,

+  IN EFI_SMM_POWER_BUTTON_DISPATCH                    DispatchFunction,

+  IN EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT            *DispatchContext,

+  OUT EFI_HANDLE                                      *DispatchHandle

   );

 

 /**

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

+  Unregisters a power-button service.

 

-  @param  This                  Protocol instance pointer.

-  @param  DispatchHandle        Handle of dispatch function to deregister.

+  @param  This                  Pointer to the EFI_SMM_POWER_BUTTON_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_POWER_BUTTON_UNREGISTER)(

-  IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL             *This,

-  IN  EFI_HANDLE                                        DispatchHandle

+  IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL            *This,

+  IN EFI_HANDLE                                        DispatchHandle

   );

 

 //