X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmPeriodicTimerDispatch.h;h=bd5d0666b61101108f19b308d4ed75c4e91d04d2;hb=9226e4ee0a204848ae83daf3026ebfadb80bbfa2;hp=653e2a82a15cff67014f84571164b71ca94d94e4;hpb=8411f1c002faf9a16c28a643a1c8a32de904a7d7;p=mirror_edk2.git

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
index 653e2a82a1..bd5d0666b6 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h
@@ -84,14 +84,14 @@ typedef struct {
                                 by the dispatching driver prior to
                                 invoking this dispatch function.
 
-  Nothing
+  @return None
 
 **/
 typedef
 VOID
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_DISPATCH) (
-  IN  EFI_HANDLE                                DispatchHandle,
-  IN  EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT   *DispatchContext
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_DISPATCH)(
+  IN EFI_HANDLE                                DispatchHandle,
+  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT   *DispatchContext
   );
 
 /**
@@ -111,7 +111,7 @@ VOID
 **/
 typedef
 EFI_STATUS
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_INTERVAL) (
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_INTERVAL)(
   IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL           *This,
   IN OUT UINT64                                         **SmiTickInterval
   );
@@ -119,16 +119,14 @@ EFI_STATUS
 /**
   Register a child SMI source dispatch function with a parent SMM driver
 
-  @param  This                  Protocol instance pointer.
-  @param  DispatchFunction      Pointer to dispatch function to be invoked for
-                                this SMI source
+  @param  This                  Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.
+  @param  DispatchFunction      Function to install.
   @param  DispatchContext       Pointer to the dispatch function's context.
                                 The caller fills this context in before calling
                                 the register function to indicate to the register
                                 function the period at which the dispatch function
                                 should be invoked.
-  @param  DispatchHandle        Handle of dispatch function, for when interfacing
-                                with the parent Sx state SMM driver.
+  @param  DispatchHandle        Handle generated by the dispatcher to track the function instance.
 
   @retval EFI_SUCCESS           The dispatch function has been successfully
                                 registered and the SMI source has been enabled.
@@ -141,18 +139,18 @@ EFI_STATUS
 **/
 typedef
 EFI_STATUS
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER) (
-  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL           *This,
-  IN  EFI_SMM_PERIODIC_TIMER_DISPATCH                   DispatchFunction,
-  IN  EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT           *DispatchContext,
-  OUT EFI_HANDLE                                        *DispatchHandle
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_REGISTER)(
+  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL          *This,
+  IN EFI_SMM_PERIODIC_TIMER_DISPATCH                   DispatchFunction,
+  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT           *DispatchContext,
+  OUT EFI_HANDLE                                       *DispatchHandle
   );
 
 /**
-  Unregister a child SMI source dispatch function with a parent SMM driver
+  Unregisters a periodic timer service.
 
-  @param  This                  Protocol instance pointer.
-  @param  DispatchHandle        Handle of dispatch function to deregister.
+  @param  This                  Pointer to the EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL instance.
+  @param  DispatchHandle        Handle of the service to remove.
 
   @retval EFI_SUCCESS           The dispatch function has been successfully
                                 unregistered and the SMI source has been disabled
@@ -163,9 +161,9 @@ EFI_STATUS
 **/
 typedef
 EFI_STATUS
-(EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER) (
-  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL           *This,
-  IN  EFI_HANDLE                                        DispatchHandle
+(EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER)(
+  IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL          *This,
+  IN EFI_HANDLE                                        DispatchHandle
   );
 
 //