X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FSmmPeriodicTimerDispatch.h;h=5cdb320f5c6f453bc7f5795350fdaaf1c0a04bfa;hb=5259c97d7ac7f464c134c3a15186b30e8e8eadff;hp=e035e1eba79539567803e70447defb6f78d48372;hpb=d3a12d776c9985cfc9055d9b9b61aa39682a261e;p=mirror_edk2.git diff --git a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h index e035e1eba7..5cdb320f5c 100644 --- a/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h +++ b/IntelFrameworkPkg/Include/Protocol/SmmPeriodicTimerDispatch.h @@ -36,7 +36,7 @@ typedef struct _EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL EFI_SMM_PERIODIC_TIMER typedef struct { /// - /// The minimum period of time in 100 nanosecond units that child gets called. + /// The minimum period of time that child gets called, in 100 nanosecond units. /// The child will be called back after a time greater than the time Period. /// UINT64 Period; @@ -49,7 +49,7 @@ typedef struct { /// UINT64 SmiTickInterval; /// - /// The actual time in 100 nanosecond units elapsed since last called, a + /// The actual time in 100 nanosecond units elapsed since last called. A /// value of 0 indicates an unknown amount of time. /// UINT64 ElapsedTime; @@ -84,8 +84,8 @@ VOID @param This Protocol instance pointer. @param SmiTickInterval Pointer to pointer of next shorter SMI interval period supported by the child. This parameter works as a get-first, - get-next field.The first time this function is called, *SmiTickInterval - should be set to NULL to get the longest SMI interval.The returned + get-next field. The first time this function is called, *SmiTickInterval + should be set to NULL to get the longest SMI interval. The returned *SmiTickInterval should be passed in on subsequent calls to get the next shorter interval period until *SmiTickInterval = NULL. @@ -105,8 +105,7 @@ EFI_STATUS @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 + Indicates to the register function the period at which the dispatch function should be invoked. @param DispatchHandle Handle generated by the dispatcher to track the function instance.