summaryrefslogtreecommitdiff
path: root/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
diff options
context:
space:
mode:
authortding1 <tding1@6f19259b-4bc3-4df7-8a09-765794883524>2009-02-05 08:42:01 +0000
committertding1 <tding1@6f19259b-4bc3-4df7-8a09-765794883524>2009-02-05 08:42:01 +0000
commit700a786952c4573a6dd7c7b0c74ea772969f777a (patch)
treeb14e97ed7b5b5c536a7e4788f2ad48bc46445f66 /IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
parent19f17070788759d3082acc27695cddfcd81855db (diff)
downloadedk2-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/SmmUsbDispatch.h')
-rw-r--r--IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h18
1 files changed, 9 insertions, 9 deletions
diff --git a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
index 04aef2a..5887951 100644
--- a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
@@ -57,7 +57,7 @@ typedef struct {
by the dispatching driver prior to
invoking this dispatch function.
- Nothing
+ @return None
**/
typedef
@@ -70,16 +70,16 @@ 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_USB_DISPATCH_PROTOCOL instance.
+ @param DispatchFunction Pointer to dispatch function to be invoked
+ for this SMI source.
@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 USB SMI types 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.
@@ -100,10 +100,10 @@ EFI_STATUS
);
/**
- Unregister a child SMI source dispatch function with a parent SMM driver
+ Unregisters a USB service
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Pointer to the EFI_SMM_USB_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