X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmStandbyButtonDispatch.h;h=3196681791bef17484a7ef3045fb31efe27ff1b7;hp=fe0510ef523b73cec0c4a8a14e560ee287a509b8;hb=700a786952c4573a6dd7c7b0c74ea772969f777a;hpb=19f17070788759d3082acc27695cddfcd81855db

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
index fe0510ef52..3196681791 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
@@ -63,7 +63,7 @@ typedef struct {
                                 by the dispatching driver prior to
                                 invoking this dispatch function.
 
-  @return Nothing
+  @return None
 
 **/
 typedef
@@ -74,18 +74,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_STANDBY_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 Standby 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.
@@ -99,31 +97,30 @@ VOID
 typedef
 EFI_STATUS
 (EFIAPI *EFI_SMM_STANDBY_BUTTON_REGISTER)(
-  IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL           *This,
-  IN  EFI_SMM_STANDBY_BUTTON_DISPATCH                   DispatchFunction,
-  IN  EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT           *DispatchContext,
-  OUT EFI_HANDLE                                        *DispatchHandle
+  IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL          *This,
+  IN EFI_SMM_STANDBY_BUTTON_DISPATCH                   DispatchFunction,
+  IN EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT           *DispatchContext,
+  OUT EFI_HANDLE                                       *DispatchHandle
   );
 
 /**
   Unregister a child SMI source dispatch function with a parent SMM driver
 
-  @param  This                  Protocol instance pointer.
-  @param  DispatchHandle        Handle of dispatch function to deregister.
+  @param  This                  Pointer to the EFI_SMM_STANDBY_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_STANDBY_BUTTON_UNREGISTER)(
   IN EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL           *This,
-  IN  EFI_HANDLE                                        DispatchHandle
+  IN EFI_HANDLE                                        DispatchHandle
   );
 
 //