diff options
| author | tding1 <tding1@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-02-05 08:42:01 +0000 |
|---|---|---|
| committer | tding1 <tding1@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-02-05 08:42:01 +0000 |
| commit | 700a786952c4573a6dd7c7b0c74ea772969f777a (patch) | |
| tree | b14e97ed7b5b5c536a7e4788f2ad48bc46445f66 /IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h | |
| parent | 19f17070788759d3082acc27695cddfcd81855db (diff) | |
| download | edk2-platforms-700a786952c4573a6dd7c7b0c74ea772969f777a.tar.xz | |
update comments to allign with spec
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7436 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h')
| -rw-r--r-- | IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h | 28 |
1 files changed, 13 insertions, 15 deletions
diff --git a/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h index 70d9ef641c..6f70acd31e 100644 --- a/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h +++ b/IntelFrameworkPkg/Include/Protocol/SmmGpiDispatch.h @@ -75,16 +75,15 @@ VOID /**
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_GPI_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 GPI(s) for 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.
@@ -98,31 +97,30 @@ VOID typedef
EFI_STATUS
(EFIAPI *EFI_SMM_GPI_REGISTER)(
- IN EFI_SMM_GPI_DISPATCH_PROTOCOL *This,
- IN EFI_SMM_GPI_DISPATCH DispatchFunction,
- IN EFI_SMM_GPI_DISPATCH_CONTEXT *DispatchContext,
- OUT EFI_HANDLE *DispatchHandle
+ IN EFI_SMM_GPI_DISPATCH_PROTOCOL *This,
+ IN EFI_SMM_GPI_DISPATCH DispatchFunction,
+ IN EFI_SMM_GPI_DISPATCH_CONTEXT *DispatchContext,
+ OUT EFI_HANDLE *DispatchHandle
);
/**
- Unregister a child SMI source dispatch function with a parent SMM driver
+ Unregisters a General Purpose Input (GPI) service.
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Pointer to the EFI_SMM_GPI_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
if there are no other registered child dispatch
functions for this SMI source.
@retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
**/
typedef
EFI_STATUS
(EFIAPI *EFI_SMM_GPI_UNREGISTER)(
- IN EFI_SMM_GPI_DISPATCH_PROTOCOL *This,
- IN EFI_HANDLE DispatchHandle
+ IN EFI_SMM_GPI_DISPATCH_PROTOCOL *This,
+ IN EFI_HANDLE DispatchHandle
);
//
|