update comments to allign with spec

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
index 1e9ff1d51081c90feb3cc22418e7c03f667265da..bd5d0666b61101108f19b308d4ed75c4e91d04d2 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
@@ -84,14 +84,14 @@ typedef struct {
                                 by the dispatching driver prior to\r
                                 invoking this dispatch function.\r
 \r
-  Nothing\r
+  @return None\r
 \r
 **/\r
 typedef\r
 VOID\r
 (EFIAPI *EFI_SMM_PERIODIC_TIMER_DISPATCH)(\r
-  IN  EFI_HANDLE                                DispatchHandle,\r
-  IN  EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT   *DispatchContext\r
+  IN EFI_HANDLE                                DispatchHandle,\r
+  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT   *DispatchContext\r
   );\r
 \r
 /**\r
@@ -119,16 +119,14 @@ EFI_STATUS
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchFunction      Pointer to dispatch function to be invoked for\r
-                                this SMI source\r
+  @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
                                 function the period at which the dispatch function\r
                                 should be invoked.\r
-  @param  DispatchHandle        Handle of dispatch function, for when interfacing\r
-                                with the parent Sx state SMM driver.\r
+  @param  DispatchHandle        Handle generated by the dispatcher to track the function instance.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                 registered and the SMI source has been enabled.\r
@@ -142,17 +140,17 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER)(\r
-  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL           *This,\r
-  IN  EFI_SMM_PERIODIC_TIMER_DISPATCH                   DispatchFunction,\r
-  IN  EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT           *DispatchContext,\r
-  OUT EFI_HANDLE                                        *DispatchHandle\r
+  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL          *This,\r
+  IN EFI_SMM_PERIODIC_TIMER_DISPATCH                   DispatchFunction,\r
+  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT           *DispatchContext,\r
+  OUT EFI_HANDLE                                       *DispatchHandle\r
   );\r
 \r
 /**\r
-  Unregister a child SMI source dispatch function with a parent SMM driver\r
+  Unregisters a periodic timer service.\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchHandle        Handle of dispatch function to deregister.\r
+  @param  This                  Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchHandle        Handle of the service to remove.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                 unregistered and the SMI source has been disabled\r
@@ -164,8 +162,8 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER)(\r
-  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL           *This,\r
-  IN  EFI_HANDLE                                        DispatchHandle\r
+  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL          *This,\r
+  IN EFI_HANDLE                                        DispatchHandle\r
   );\r
 \r
 //\r