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

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

diff --git a/MdePkg/Include/Protocol/SmmSwDispatch2.h b/MdePkg/Include/Protocol/SmmSwDispatch2.h
index 2732c3dd75c9835e10973876bde25d4af0da00c0..c99a5b95d637788c46641fc30a3ac7c28f9d77dd 100644 (file)
--- a/MdePkg/Include/Protocol/SmmSwDispatch2.h
+++ b/MdePkg/Include/Protocol/SmmSwDispatch2.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_SW_REGISTER   -> EFI_SMM_SW_REGISTER2\r
+///   EFI_SMM_SW_UNREGISTER -> EFI_SMM_SW_UNREGISTER2\r
+///\r
+\r
 #define EFI_SMM_SW_DISPATCH2_PROTOCOL_GUID \\r
   { \\r
     0x18a3c6dc, 0x5eea, 0x48c8, {0xa1, 0xc1, 0xb5, 0x33, 0x89, 0xf9, 0x89, 0x99 } \\r
@@ -88,7 +97,7 @@ typedef struct _EFI_SMM_SW_DISPATCH2_PROTOCOL  EFI_SMM_SW_DISPATCH2_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_SW_REGISTER)(\r
+(EFIAPI *EFI_SMM_SW_REGISTER2)(\r
   IN  CONST EFI_SMM_SW_DISPATCH2_PROTOCOL  *This,\r
   IN        EFI_SMM_HANDLER_ENTRY_POINT2   DispatchFunction,\r
   IN  CONST EFI_SMM_SW_REGISTER_CONTEXT    *RegisterContext,\r
@@ -109,7 +118,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_SW_UNREGISTER)(\r
+(EFIAPI *EFI_SMM_SW_UNREGISTER2)(\r
   IN CONST EFI_SMM_SW_DISPATCH2_PROTOCOL  *This,\r
   IN       EFI_HANDLE                     DispatchHandle\r
 );\r
@@ -122,8 +131,8 @@ EFI_STATUS
 /// interrupt in the EFI_SMM_SW_REGISTER_CONTEXT is denoted by MaximumSwiValue.\r
 ///\r
 struct _EFI_SMM_SW_DISPATCH2_PROTOCOL {\r
-  EFI_SMM_SW_REGISTER    Register;\r
-  EFI_SMM_SW_UNREGISTER  UnRegister;\r
+  EFI_SMM_SW_REGISTER2    Register;\r
+  EFI_SMM_SW_UNREGISTER2  UnRegister;\r
   ///\r
   /// A read-only field that describes the maximum value that can be used in the \r
   /// EFI_SMM_SW_DISPATCH2_PROTOCOL.Register() service.\r