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

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

diff --git a/MdePkg/Include/Protocol/SmmUsbDispatch2.h b/MdePkg/Include/Protocol/SmmUsbDispatch2.h
index a95f8f63b6efec5dc959b463d3eae1d7503c6c68..27b4674bfe7788e3d6cc3a0b5c5c2d2a33814f7e 100644 (file)
--- a/MdePkg/Include/Protocol/SmmUsbDispatch2.h
+++ b/MdePkg/Include/Protocol/SmmUsbDispatch2.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_USB_REGISTER   -> EFI_SMM_USB_REGISTER2\r
+///   EFI_SMM_USB_UNREGISTER -> EFI_SMM_USB_UNREGISTER2\r
+///\r
+\r
 #define EFI_SMM_USB_DISPATCH2_PROTOCOL_GUID \\r
   { \\r
     0xee9b8d90, 0xc5a6, 0x40a2, {0xbd, 0xe2, 0x52, 0x55, 0x8d, 0x33, 0xcc, 0xa1 } \\r
@@ -85,7 +94,7 @@ typedef struct _EFI_SMM_USB_DISPATCH2_PROTOCOL EFI_SMM_USB_DISPATCH2_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_USB_REGISTER)(\r
+(EFIAPI *EFI_SMM_USB_REGISTER2)(\r
   IN  CONST EFI_SMM_USB_DISPATCH2_PROTOCOL  *This,\r
   IN        EFI_SMM_HANDLER_ENTRY_POINT2    DispatchFunction,\r
   IN  CONST EFI_SMM_USB_REGISTER_CONTEXT    *RegisterContext,\r
@@ -109,7 +118,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_USB_UNREGISTER)(\r
+(EFIAPI *EFI_SMM_USB_UNREGISTER2)(\r
   IN CONST EFI_SMM_USB_DISPATCH2_PROTOCOL  *This,\r
   IN       EFI_HANDLE                      DispatchHandle\r
   );\r
@@ -120,8 +129,8 @@ EFI_STATUS
 /// This protocol provides the parent dispatch service for the USB SMI source generator.\r
 ///\r
 struct _EFI_SMM_USB_DISPATCH2_PROTOCOL {\r
-  EFI_SMM_USB_REGISTER    Register;\r
-  EFI_SMM_USB_UNREGISTER  UnRegister;\r
+  EFI_SMM_USB_REGISTER2    Register;\r
+  EFI_SMM_USB_UNREGISTER2  UnRegister;\r
 };\r
 \r
 extern EFI_GUID gEfiSmmUsbDispatch2ProtocolGuid;\r