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

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

diff --git a/MdePkg/Include/Protocol/SmmSxDispatch2.h b/MdePkg/Include/Protocol/SmmSxDispatch2.h
index 187a2ff8d8b5a3a7b7bb83fe3c148e87dd8e7813..fe0baa19608f82f1c871737c125a51b6a169a557 100644 (file)
--- a/MdePkg/Include/Protocol/SmmSxDispatch2.h
+++ b/MdePkg/Include/Protocol/SmmSxDispatch2.h
@@ -20,6 +20,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_SX_REGISTER   -> EFI_SMM_SX_REGISTER2\r
+///   EFI_SMM_SX_UNREGISTER -> EFI_SMM_SX_UNREGISTER2\r
+///\r
+\r
 #define EFI_SMM_SX_DISPATCH2_PROTOCOL_GUID \\r
   { \\r
     0x456d2859, 0xa84b, 0x4e47, {0xa2, 0xee, 0x32, 0x76, 0xd8, 0x86, 0x99, 0x7d } \\r
@@ -93,7 +102,7 @@ typedef struct _EFI_SMM_SX_DISPATCH2_PROTOCOL  EFI_SMM_SX_DISPATCH2_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_SX_REGISTER)(\r
+(EFIAPI *EFI_SMM_SX_REGISTER2)(\r
   IN  CONST EFI_SMM_SX_DISPATCH2_PROTOCOL  *This,\r
   IN        EFI_SMM_HANDLER_ENTRY_POINT2   DispatchFunction,\r
   IN  CONST EFI_SMM_SX_REGISTER_CONTEXT    *RegisterContext,\r
@@ -114,7 +123,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_SX_UNREGISTER)(\r
+(EFIAPI *EFI_SMM_SX_UNREGISTER2)(\r
   IN CONST EFI_SMM_SX_DISPATCH2_PROTOCOL  *This,\r
   IN       EFI_HANDLE                     DispatchHandle\r
   );\r
@@ -126,8 +135,8 @@ EFI_STATUS
 /// respond to sleep state related events.\r
 ///\r
 struct _EFI_SMM_SX_DISPATCH2_PROTOCOL {\r
-  EFI_SMM_SX_REGISTER    Register;\r
-  EFI_SMM_SX_UNREGISTER  UnRegister;\r
+  EFI_SMM_SX_REGISTER2    Register;\r
+  EFI_SMM_SX_UNREGISTER2  UnRegister;\r
 };\r
 \r
 extern EFI_GUID gEfiSmmSxDispatch2ProtocolGuid;\r