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/SmmIchnDispatch.h | |
| parent | 19f17070788759d3082acc27695cddfcd81855db (diff) | |
| download | edk2-700a786952c4573a6dd7c7b0c74ea772969f777a.zip edk2-700a786952c4573a6dd7c7b0c74ea772969f777a.tar.gz edk2-700a786952c4573a6dd7c7b0c74ea772969f777a.tar.bz2 | |
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/SmmIchnDispatch.h')
| -rw-r--r-- | IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h | 32 |
1 files changed, 15 insertions, 17 deletions
diff --git a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h index 933f70b..0b7b5dc 100644 --- a/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h +++ b/IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h @@ -107,7 +107,7 @@ typedef struct { // Member functions
//
/**
- Dispatch function for a ICH n specific SMI handler.
+ Dispatch function for a ICHN specific SMI handler.
@param DispatchHandle Handle of this dispatch function.
@param DispatchContext Pointer to the dispatch function's context.
@@ -115,7 +115,7 @@ typedef struct { by the dispatching driver prior to
invoking this dispatch function.
- Nothing
+ @return None
**/
typedef
@@ -128,16 +128,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_ICHN_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 ICHN SMI source 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.
@@ -151,35 +150,34 @@ VOID typedef
EFI_STATUS
(EFIAPI *EFI_SMM_ICHN_REGISTER)(
- IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,
- IN EFI_SMM_ICHN_DISPATCH DispatchFunction,
- IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext,
- OUT EFI_HANDLE *DispatchHandle
+ IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,
+ IN EFI_SMM_ICHN_DISPATCH DispatchFunction,
+ IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext,
+ OUT EFI_HANDLE *DispatchHandle
);
/**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Pointer to the EFI_SMM_ICHN_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_ICHN_UNREGISTER)(
- IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,
- IN EFI_HANDLE DispatchHandle
+ IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,
+ IN EFI_HANDLE DispatchHandle
);
//
-// Interface structure for the SMM Ich n specific SMI Dispatch Protocol
+// Interface structure for the SMM ICHN specific SMI Dispatch Protocol
//
/**
@par Protocol Description:
|