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

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

diff --git a/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch2.h b/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch2.h
index 0e791e1a0031e44ff8bdb73c92e04c2239e38f74..252729fd5c976fe22bc08c24f9c1812d8911cbe7 100644 (file)
--- a/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch2.h
+++ b/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch2.h
@@ -23,6 +23,16 @@
 \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_PERIODIC_TIMER_REGISTER   -> EFI_SMM_PERIODIC_TIMER_REGISTER2\r
+///   EFI_SMM_PERIODIC_TIMER_UNREGISTER -> EFI_SMM_PERIODIC_TIMER_UNREGISTER2\r
+///   EFI_SMM_PERIODIC_TIMER_INTERVAL   -> EFI_SMM_PERIODIC_TIMER_INTERVAL2\r
+///\r
+\r
 #define EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL_GUID \\r
   { \\r
     0x4cec368e, 0x8e8e, 0x4d71, {0x8b, 0xe1, 0x95, 0x8c, 0x45, 0xfc, 0x8a, 0x53 } \\r
@@ -105,7 +115,7 @@ typedef struct _EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL  EFI_SMM_PERIODIC_TIME
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER)(\r
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER2)(\r
   IN CONST EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL  *This,\r
   IN       EFI_SMM_HANDLER_ENTRY_POINT2               DispatchFunction,\r
   IN CONST EFI_SMM_PERIODIC_TIMER_REGISTER_CONTEXT    *RegisterContext,\r
@@ -126,7 +136,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER)(\r
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER2)(\r
   IN CONST EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL  *This,\r
   IN       EFI_HANDLE                                 DispatchHandle\r
   );\r
@@ -148,7 +158,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_INTERVAL)(\r
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_INTERVAL2)(\r
   IN CONST EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL  *This,\r
   IN OUT UINT64                                       **SmiTickInterval\r
   );\r
@@ -159,9 +169,9 @@ EFI_STATUS
 /// This protocol provides the parent dispatch service for the periodical timer SMI source generator.\r
 ///\r
 struct _EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL {\r
-  EFI_SMM_PERIODIC_TIMER_REGISTER    Register;\r
-  EFI_SMM_PERIODIC_TIMER_UNREGISTER  UnRegister;\r
-  EFI_SMM_PERIODIC_TIMER_INTERVAL    GetNextShorterInterval;\r
+  EFI_SMM_PERIODIC_TIMER_REGISTER2    Register;\r
+  EFI_SMM_PERIODIC_TIMER_UNREGISTER2  UnRegister;\r
+  EFI_SMM_PERIODIC_TIMER_INTERVAL2    GetNextShorterInterval;\r
 };\r
 \r
 extern EFI_GUID gEfiSmmPeriodicTimerDispatch2ProtocolGuid;\r