Add into MdePkg definitions for the SMM Standby Button Dispatch2 Protocol as defined...

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9232 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/SmmStandbyButtonDispatch2.h b/MdePkg/Include/Protocol/SmmStandbyButtonDispatch2.h
new file mode 100644 (file)
index 0000000..0ca8f03
--- /dev/null
+++ b/MdePkg/Include/Protocol/SmmStandbyButtonDispatch2.h
@@ -0,0 +1,119 @@
+/** @file\r
+  SMM Standby Button Dispatch2 Protocol as defined in PI 1.1 Specification\r
+  Volume 4 System Management Mode Core Interface.\r
+\r
+  This protocol provides the parent dispatch service for the standby button SMI source generator.\r
+\r
+  Copyright (c) 2009, 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
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
+\r
+  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
+  @par Revision Reference:\r
+  This protocol is from PI Version 1.1.\r
+\r
+**/\r
+\r
+#ifndef _SMM_STANDBY_BUTTON_DISPATCH2_H_\r
+#define _SMM_STANDBY_BUTTON_DISPATCH2_H_\r
+\r
+#include <Pi/PiSmmCis.h>\r
+\r
+#define EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL_GUID \\r
+  { \\r
+    0x7300c4a1, 0x43f2, 0x4017, {0xa5, 0x1b, 0xc8, 0x1a, 0x7f, 0x40, 0x58, 0x5b } \\r
+  }\r
+\r
+///\r
+/// Standby Button phases\r
+///\r
+typedef enum {\r
+  EfiStandbyButtonEntry,\r
+  EfiStandbyButtonExit,\r
+  EfiStandbyButtonMax\r
+} EFI_STANDBY_BUTTON_PHASE;\r
+\r
+///\r
+/// The dispatch function's context.\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.\r
+  ///\r
+  EFI_STANDBY_BUTTON_PHASE  Phase;\r
+} EFI_SMM_STANDBY_BUTTON_REGISTER_CONTEXT;\r
+\r
+typedef struct _EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL;\r
+\r
+/**\r
+  Provides the parent dispatch service for a standby button event.\r
+\r
+  This service registers a function (DispatchFunction) which will be called when an SMI is \r
+  generated because the standby button was pressed or released, as specified by \r
+  RegisterContext. On return, DispatchHandle contains a unique handle which may be used \r
+  later to unregister the function using UnRegister().\r
+  The DispatchFunction will be called with Context set to the same value as was passed into \r
+  this function in RegisterContext and with CommBuffer and CommBufferSize set to NULL. \r
+\r
+  @param[in]  This               Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL instance.\r
+  @param[in]  DispatchFunction   Function to register for handler when the standby button is pressed or released.\r
+  @param[in]  RegisterContext    Pointer to the dispatch function\92s context. The caller fills in this context\r
+                                 before calling the register function to indicate to the register function the \r
+                                 standby button SMI source for which the dispatch function should be invoked.\r
+  @param[out] 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
+  @retval EFI_DEVICE_ERROR       The driver was unable to enable the SMI source.\r
+  @retval EFI_INVALID_PARAMETER  RegisterContext is invalid. The standby button input value\r
+                                 is not within valid range.\r
+  @retval EFI_OUT_OF_RESOURCES   There is not enough memory (system or SMM) to manage this child.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMM_STANDBY_BUTTON_REGISTER)(\r
+  IN CONST EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL  *This,\r
+  IN       EFI_SMM_HANDLER_ENTRY_POINT2               DispatchFunction,\r
+  IN       EFI_SMM_STANDBY_BUTTON_REGISTER_CONTEXT    *RegisterContext,\r
+  OUT      EFI_HANDLE                                 *DispatchHandle\r
+  );\r
+\r
+/**\r
+  Unregisters a child SMI source dispatch function with a parent SMM driver.\r
+\r
+  This service removes the handler associated with DispatchHandle so that it will no longer be \r
+  called when the standby button is pressed or released.\r
+\r
+  @param[in] This                Pointer to the EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL instance.\r
+  @param[in] DispatchHandle      Handle of the service to remove.\r
+\r
+  @retval EFI_SUCCESS            The service has been successfully removed.\r
+  @retval EFI_INVALID_PARAMETER  The DispatchHandle was not valid.\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMM_STANDBY_BUTTON_UNREGISTER)(\r
+  IN CONST EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL  *This,\r
+  IN       EFI_HANDLE                                 DispatchHandle\r
+  );\r
+\r
+///\r
+/// Interface structure for the SMM Standby Button Dispatch2 Protocol.\r
+///\r
+/// This protocol provides the parent dispatch service for the standby\r
+/// button SMI source generator.\r
+///\r
+struct _EFI_SMM_STANDBY_BUTTON_DISPATCH2_PROTOCOL {\r
+  EFI_SMM_STANDBY_BUTTON_REGISTER    Register;\r
+  EFI_SMM_STANDBY_BUTTON_UNREGISTER  UnRegister;\r
+};\r
+\r
+extern EFI_GUID gEfiSmmStandbyButtonDispatch2ProtocolGuid;\r
+\r
+#endif\r
+\r

diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec
index 0c35fe2ff2d48673ad37562eed0d983fc94c3b1e..a6f4fde40d1227b63aa22a85ab5d04e6c650c240 100644 (file)
--- a/MdePkg/MdePkg.dec
+++ b/MdePkg/MdePkg.dec
@@ -650,6 +650,9 @@
   ## Include/Protocol/SmmGpiDispatch2.h\r
   gEfiSmmGpiDispatch2ProtocolGuid = { 0x25566b03, 0xb577, 0x4cbf, {0x95, 0x8c, 0xed, 0x66, 0x3e, 0xa2, 0x43, 0x80 }}\r
 \r
+  ## Include/Protocol/SmmStandbyButtonDispatch2.h\r
+  gEfiSmmStandbyButtonDispatch2ProtocolGuid = { 0x7300c4a1, 0x43f2, 0x4017, {0xa5, 0x1b, 0xc8, 0x1a, 0x7f, 0x40, 0x58, 0x5b }}\r
+\r
   #\r
   # Protocols defined in UEFI2.1/UEFI2.0/EFI1.1\r
   #\r