update comments to allign with spec
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7436 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -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
|
||||
IN EFI_HANDLE DispatchHandle,
|
||||
IN EFI_SMM_PERIODIC_TIMER_DISPATCH_CONTEXT *DispatchContext
|
||||
);
|
||||
|
||||
/**
|
||||
@@ -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.
|
||||
@@ -142,17 +140,17 @@ 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
|
||||
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
|
||||
@@ -164,8 +162,8 @@ EFI_STATUS
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_SMM_PERIODIC_TIMER_UNREGISTER)(
|
||||
IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,
|
||||
IN EFI_HANDLE DispatchHandle
|
||||
IN EFI_SMM_PERIODIC_TIMER_DISPATCH_PROTOCOL *This,
|
||||
IN EFI_HANDLE DispatchHandle
|
||||
);
|
||||
|
||||
//
|
||||
|
Reference in New Issue
Block a user