Reviewed the description in the FatBinPkg .dec file.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
index 3196681791bef17484a7ef3045fb31efe27ff1b7..188e950f9f1ab6ecf61e8e2ee527890683bd7829 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmStandbyButtonDispatch.h
@@ -1,6 +1,10 @@
 /** @file\r
   Provides the parent dispatch service for the standby button SMI source generator.\r
 \r
+  The SMM Standby Button Dispatch Protocol is defined in \r
+  the Intel Platform Innovation Framework for EFI SMM Core Interface Specification\r
+  (SMM CIS) Version 0.9.\r
+\r
   Copyright (c) 2007, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
@@ -10,18 +14,12 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:  SmmStandbyButtonDispatch.h\r
-\r
-  @par Revision Reference:\r
-  This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
-  Version 0.9.\r
-\r
 **/\r
 \r
 #ifndef _EFI_SMM_STANDBY_BUTTON_DISPATCH_H_\r
 #define _EFI_SMM_STANDBY_BUTTON_DISPATCH_H_\r
 \r
-#include <PiDxe.h>\r
+#include <FrameworkSmm.h>\r
 \r
 //\r
 // Global ID for the Standby Button SMI Protocol\r
@@ -36,6 +34,7 @@ typedef struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL  EFI_SMM_STANDBY_BUTTON
 //\r
 // Related Definitions\r
 //\r
+\r
 //\r
 // Standby Button. Example, Use for changing LEDs before ACPI OS is on.\r
 //    - DXE/BDS Phase\r
@@ -43,17 +42,22 @@ typedef struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL  EFI_SMM_STANDBY_BUTTON
 //\r
 typedef enum {\r
   EfiStandbyButtonEntry,\r
-  EfiStandbyButtonExit,\r
-  EfiStandbyButtonMax\r
+  EfiStandbyButtonExit\r
 } EFI_STANDBY_BUTTON_PHASE;\r
 \r
 typedef struct {\r
+  //\r
+  // Describes whether the child handler should be invoked upon the entry to the button\r
+  // activation or upon exit (i.e., upon receipt of the button press event or upon release of\r
+  // the event).\r
+  //\r
   EFI_STANDBY_BUTTON_PHASE  Phase;\r
 } EFI_SMM_STANDBY_BUTTON_DISPATCH_CONTEXT;\r
 \r
 //\r
 // Member functions\r
 //\r
+\r
 /**\r
   Dispatch function for a Standby Button SMI handler.\r
 \r
@@ -63,8 +67,6 @@ typedef struct {
                                 by the dispatching driver prior to\r
                                 invoking this dispatch function.\r
 \r
-  @return None\r
-\r
 **/\r
 typedef\r
 VOID\r
@@ -106,37 +108,27 @@ EFI_STATUS
 /**\r
   Unregister a child SMI source dispatch function with a parent SMM driver\r
 \r
-  @param  This                  Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL instance.\r
-  @param  DispatchHandle        Handle of the service to remove.\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 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
 \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_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL  *This,\r
+  IN EFI_HANDLE                                DispatchHandle\r
   );\r
 \r
 //\r
 // Interface structure for the SMM Standby Button SMI Dispatch Protocol\r
 //\r
-/**\r
-  @par Protocol Description:\r
-  Provides the parent dispatch service for the standby button SMI source generator.\r
 \r
-  @param Register\r
-  Installs a child service to be dispatched by this protocol.\r
-\r
-  @param UnRegister\r
-  Removes a child service dispatched by this protocol.\r
-\r
-**/\r
 struct _EFI_SMM_STANDBY_BUTTON_DISPATCH_PROTOCOL {\r
   EFI_SMM_STANDBY_BUTTON_REGISTER   Register;\r
   EFI_SMM_STANDBY_BUTTON_UNREGISTER UnRegister;\r