update comments to allign with spec

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmStandbyButtonDispatch.h

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
index fe0510ef523b73cec0c4a8a14e560ee287a509b8..3196681791bef17484a7ef3045fb31efe27ff1b7 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
@@ -63,7 +63,7 @@ typedef struct {
                                 by the dispatching driver prior to\r
                                 invoking this dispatch function.\r
 \r
-  @return Nothing\r
+  @return None\r
 \r
 **/\r
 typedef\r
@@ -74,18 +74,16 @@ VOID
   );\r
 \r
 /**\r
-  Register a child SMI source dispatch function with a parent SMM driver\r
+  Provides the parent dispatch service for a given SMI source generator\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchFunction      Pointer to dispatch function to be invoked for\r
-                                this SMI source\r
+  @param  This                  Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchFunction      Function to install.\r
   @param  DispatchContext       Pointer to the dispatch function's context.\r
                                 The caller fills this context in before calling\r
                                 the register function to indicate to the register\r
                                 function the Standby Button SMI phase for which the dispatch\r
                                 function should be invoked.\r
-  @param  DispatchHandle        Handle of dispatch function, for when interfacing\r
-                                with the parent Sx state SMM driver.\r
+  @param  DispatchHandle        Handle generated by the dispatcher to track the function instance.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                 registered and the SMI source has been enabled.\r
@@ -99,31 +97,30 @@ VOID
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_SMM_STANDBY_BUTTON_REGISTER)(\r
-  IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL           *This,\r
-  IN  EFI_SMM_STANDBY_BUTTON_DISPATCH                   DispatchFunction,\r
-  IN  EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT           *DispatchContext,\r
-  OUT EFI_HANDLE                                        *DispatchHandle\r
+  IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL          *This,\r
+  IN EFI_SMM_STANDBY_BUTTON_DISPATCH                   DispatchFunction,\r
+  IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT           *DispatchContext,\r
+  OUT EFI_HANDLE                                       *DispatchHandle\r
   );\r
 \r
 /**\r
   Unregister a child SMI source dispatch function with a parent SMM driver\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchHandle        Handle of dispatch function to deregister.\r
+  @param  This                  Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchHandle        Handle of the service to remove.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                 unregistered and the SMI source has been disabled\r
                                 if there are no other registered child dispatch\r
                                 functions for this SMI source.\r
   @retval EFI_INVALID_PARAMETER Handle is invalid.\r
-  @retval other                 TBD\r
 \r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_SMM_STANDBY_BUTTON_UNREGISTER)(\r
   IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL           *This,\r
-  IN  EFI_HANDLE                                        DispatchHandle\r
+  IN EFI_HANDLE                                        DispatchHandle\r
   );\r
 \r
 //\r