Committing changes to the comments, after review with engineers.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9018 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -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.
|
||||
|
Reference in New Issue
Block a user