X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmPowerButtonDispatch.h;h=95a6d51bf55b0a94c79201550a2f08cf091dfd76;hp=c2c7b282f9e94d29ab11becf7a1d8eb28d60ee30;hb=3a0d56608f54c88f55986fbd1c729028f6aa7e16;hpb=79964ac84ea0ca6c68d0dea38245fa83ff1945d1

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
index c2c7b282f9..95a6d51bf5 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmPowerButtonDispatch.h
@@ -1,5 +1,5 @@
 /** @file
-  This file declares EFI Smm Power Button Smi Child Protocol
+  Provides the parent dispatch service for the power button SMI source generator.
 
   Copyright (c) 2007, Intel Corporation
   All rights reserved. This program and the accompanying materials
@@ -21,6 +21,8 @@
 #ifndef _EFI_SMM_POWER_BUTTON_DISPATCH_H_
 #define _EFI_SMM_POWER_BUTTON_DISPATCH_H_
 
+#include <PiDxe.h>
+
 //
 // Global ID for the Power Button SMI Protocol
 //
@@ -60,29 +62,27 @@ typedef struct {
                                 by the dispatching driver prior to
                                 invoking this dispatch function.
 
-  Nothing
+  @return None
 
 **/
 typedef
 VOID
-(EFIAPI *EFI_SMM_POWER_BUTTON_DISPATCH) (
+(EFIAPI *EFI_SMM_POWER_BUTTON_DISPATCH)(
   IN  EFI_HANDLE                             DispatchHandle,
   IN  EFI_SMM_POWER_BUTTON_DISPATCH_CONTEXT  *DispatchContext
   );
 
 /**
-  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.
@@ -95,32 +95,31 @@ 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
+(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
   );
 
 /**
-  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
+(EFIAPI *EFI_SMM_POWER_BUTTON_UNREGISTER)(
+  IN EFI_SMM_POWER_BUTTON_DISPATCH_PROTOCOL            *This,
+  IN EFI_HANDLE                                        DispatchHandle
   );
 
 //