Move SmmLib from IntelFrameworkPkg to MdePkg because this library is useful to both...

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmPeriodicTimerDispatch.h

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
index 283f6bed0001850e44a5deeef38d3019bc0035df..5cdb320f5c6f453bc7f5795350fdaaf1c0a04bfa 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
@@ -10,8 +10,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:  SmmPeriodicTimerDispatch.h\r
-\r
   @par Revision Reference:\r
   This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
   Version 0.9.\r
@@ -21,7 +19,6 @@
 #ifndef _EFI_SMM_PERIODIC_TIMER_DISPATCH_H_\r
 #define _EFI_SMM_PERIODIC_TIMER_DISPATCH_H_\r
 \r
-#include <PiDxe.h>\r
 \r
 //\r
 // Global ID for the Periodic Timer SMI Protocol\r
@@ -39,7 +36,7 @@ typedef struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL  EFI_SMM_PERIODIC_TIMER
 \r
 typedef struct {\r
   ///\r
-  /// The minimum period of time in 100 nanosecond units that child gets called.\r
+  /// The minimum period of time that child gets called, in 100 nanosecond units.\r
   /// The child will be called back after a time greater than the time Period.\r
   ///\r
   UINT64  Period;\r
@@ -52,7 +49,7 @@ typedef struct {
   ///\r
   UINT64  SmiTickInterval;\r
   ///\r
-  /// The actual time in 100 nanosecond units elapsed since last called, a\r
+  /// The actual time in 100 nanosecond units elapsed since last called. A\r
   /// value of 0 indicates an unknown amount of time.\r
   ///\r
   UINT64  ElapsedTime;\r
@@ -87,8 +84,8 @@ VOID
   @param  This                  Protocol instance pointer.\r
   @param  SmiTickInterval       Pointer to pointer of next shorter SMI interval\r
                                 period supported by the child. This parameter works as a get-first,\r
-                                get-next field.The first time this function is called, *SmiTickInterval\r
-                                should be set to NULL to get the longest SMI interval.The returned\r
+                                get-next field. The first time this function is called, *SmiTickInterval\r
+                                should be set to NULL to get the longest SMI interval. The returned\r
                                 *SmiTickInterval should be passed in on subsequent calls to get the\r
                                 next shorter interval period until *SmiTickInterval = NULL.\r
 \r
@@ -108,8 +105,7 @@ EFI_STATUS
   @param  This                  Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
   @param  DispatchFunction      Function to install.\r
   @param  DispatchContext       Pointer to the dispatch function's context.\r
-                                The caller fills this context in before calling\r
-                                the register function to indicate to the register\r
+                                Indicates to the register\r
                                 function the period at which the dispatch function\r
                                 should be invoked.\r
   @param  DispatchHandle        Handle generated by the dispatcher to track the function instance.\r
@@ -156,22 +152,22 @@ EFI_STATUS
 // Interface structure for the SMM Periodic Timer Dispatch Protocol\r
 //\r
 /**\r
-  @par Protocol Description:\r
   Provides the parent dispatch service for the periodical timer SMI source generator.\r
-\r
-  @param Register\r
-  Installs a child service to be dispatched by this protocol.\r
-\r
-  @param UnRegister\r
-  Removes a child service dispatched by this protocol.\r
-\r
-  @param GetNextShorterInterval\r
-  Returns the next SMI tick period that is supported by the chipset.\r
-\r
 **/\r
 struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL {\r
+  ///\r
+  /// Installs a child service to be dispatched by this protocol.\r
+  ///\r
   EFI_SMM_PERIODIC_TIMER_REGISTER   Register;\r
+  \r
+  ///\r
+  /// Removes a child service dispatched by this protocol.\r
+  ///\r
   EFI_SMM_PERIODIC_TIMER_UNREGISTER UnRegister;\r
+  \r
+  ///\r
+  /// Returns the next SMI tick period that is supported by the chipset.\r
+  ///\r
   EFI_SMM_PERIODIC_TIMER_INTERVAL   GetNextShorterInterval;\r
 };\r
 \r