Rename PI SMM definitions which has same name with those of Framework SMM spec but...

[mirror_edk2.git] / MdePkg / Include / Protocol / SmmPowerButtonDispatch2.h

diff --git a/MdePkg/Include/Protocol/SmmPowerButtonDispatch2.h b/MdePkg/Include/Protocol/SmmPowerButtonDispatch2.h
index b3cdb47653c7aeaf192b07f2f367fe3f5f304789..eca6d802913495d558b9e5d4782057e1e6104195 100644 (file)
--- a/MdePkg/Include/Protocol/SmmPowerButtonDispatch2.h
+++ b/MdePkg/Include/Protocol/SmmPowerButtonDispatch2.h
@@ -23,6 +23,15 @@
 \r
 #include <Pi/PiSmmCis.h>\r
 \r
+///\r
+/// Note:\r
+///   To avoid name conflict between PI and Framework SMM spec, the following names defined\r
+///   in PI 1.2 SMM spec are renamed. These renamings are not yet in a public PI spec and errta.\r
+///\r
+///   EFI_SMM_POWER_BUTTON_REGISTER   -> EFI_SMM_POWER_BUTTON_REGISTER2\r
+///   EFI_SMM_POWER_BUTTON_UNREGISTER -> EFI_SMM_POWER_BUTTON_UNREGISTER2\r
+///\r
+\r
 #define EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL_GUID \\r
   { \\r
     0x1b1183fa, 0x1823, 0x46a7, {0x88, 0x72, 0x9c, 0x57, 0x87, 0x55, 0x40, 0x9d } \\r
@@ -75,7 +84,7 @@ typedef struct _EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL EFI_SMM_POWER_BUTTON_DIS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_POWER_BUTTON_REGISTER)(\r
+(EFIAPI *EFI_SMM_POWER_BUTTON_REGISTER2)(\r
   IN CONST EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL  *This,\r
   IN       EFI_SMM_HANDLER_ENTRY_POINT2             DispatchFunction,\r
   IN       EFI_SMM_POWER_BUTTON_REGISTER_CONTEXT    *RegisterContext,\r
@@ -96,7 +105,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_POWER_BUTTON_UNREGISTER)(\r
+(EFIAPI *EFI_SMM_POWER_BUTTON_UNREGISTER2)(\r
   IN CONST EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL  *This,\r
   IN       EFI_HANDLE                               DispatchHandle\r
   );\r
@@ -107,8 +116,8 @@ EFI_STATUS
 /// This protocol provides the parent dispatch service for the power button SMI source generator.\r
 ///\r
 struct _EFI_SMM_POWER_BUTTON_DISPATCH2_PROTOCOL {\r
-  EFI_SMM_POWER_BUTTON_REGISTER    Register;\r
-  EFI_SMM_POWER_BUTTON_UNREGISTER  UnRegister;\r
+  EFI_SMM_POWER_BUTTON_REGISTER2    Register;\r
+  EFI_SMM_POWER_BUTTON_UNREGISTER2  UnRegister;\r
 };\r
 \r
 extern EFI_GUID gEfiSmmPowerButtonDispatch2ProtocolGuid;\r