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

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

diff --git a/MdePkg/Include/Protocol/SmmGpiDispatch2.h b/MdePkg/Include/Protocol/SmmGpiDispatch2.h
index 338e1b2a1cfe3a0b318e1c913ff05799db473fc9..2bc457e6ffcf47ed74ed305aaf298f4913a457b8 100644 (file)
--- a/MdePkg/Include/Protocol/SmmGpiDispatch2.h
+++ b/MdePkg/Include/Protocol/SmmGpiDispatch2.h
@@ -28,6 +28,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_GPI_REGISTER   -> EFI_SMM_GPI_REGISTER2\r
+///   EFI_SMM_GPI_UNREGISTER -> EFI_SMM_GPI_UNREGISTER2\r
+///\r
+\r
 #define EFI_SMM_GPI_DISPATCH2_PROTOCOL_GUID \\r
   { \\r
     0x25566b03, 0xb577, 0x4cbf, {0x95, 0x8c, 0xed, 0x66, 0x3e, 0xa2, 0x43, 0x80 } \\r
@@ -77,7 +86,7 @@ typedef struct _EFI_SMM_GPI_DISPATCH2_PROTOCOL EFI_SMM_GPI_DISPATCH2_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_GPI_REGISTER)(\r
+(EFIAPI *EFI_SMM_GPI_REGISTER2)(\r
   IN CONST EFI_SMM_GPI_DISPATCH2_PROTOCOL  *This,\r
   IN       EFI_SMM_HANDLER_ENTRY_POINT2    DispatchFunction,\r
   IN CONST EFI_SMM_GPI_REGISTER_CONTEXT    *RegisterContext,\r
@@ -98,7 +107,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_GPI_UNREGISTER)(\r
+(EFIAPI *EFI_SMM_GPI_UNREGISTER2)(\r
   IN CONST EFI_SMM_GPI_DISPATCH2_PROTOCOL  *This,\r
   IN       EFI_HANDLE                      DispatchHandle\r
   );\r
@@ -110,8 +119,8 @@ EFI_STATUS
 /// for the General Purpose Input (GPI) SMI source generator.\r
 ///\r
 struct _EFI_SMM_GPI_DISPATCH2_PROTOCOL {\r
-  EFI_SMM_GPI_REGISTER    Register;\r
-  EFI_SMM_GPI_UNREGISTER  UnRegister;\r
+  EFI_SMM_GPI_REGISTER2    Register;\r
+  EFI_SMM_GPI_UNREGISTER2  UnRegister;\r
   ///\r
   /// Denotes the maximum value of inputs that can have handlers attached.\r
   ///\r