Reviewed the description in the FatBinPkg .dec file.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmUsbDispatch.h

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
index 79dc3efba7d26bd2dc617b2780991aa279dda623..c2f70aceebaa73be3aeeec6b9f22f221b94c0f3a 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
@@ -41,7 +41,18 @@ typedef enum {
 } EFI_USB_SMI_TYPE;\r
 \r
 typedef struct {\r
+  ///\r
+  /// Describes whether this child handler will be invoked in response to a USB legacy\r
+  /// emulation event, such as port-trap on the PS/2* keyboard control registers, or to a\r
+  /// USB wake event, such as resumption from a sleep state. \r
+  ///\r
   EFI_USB_SMI_TYPE          Type;\r
+  ///\r
+  /// The device path is part of the context structure and describes the location of the\r
+  /// particular USB host controller in the system for which this register event will occur.\r
+  /// This location is important because of the possible integration of several USB host\r
+  /// controllers in a system. \r
+  ///\r
   EFI_DEVICE_PATH_PROTOCOL  *Device;\r
 } EFI_SMM_USB_DISPATCH_CONTEXT;\r
 \r
@@ -57,12 +68,12 @@ typedef struct {
                                 by the dispatching driver prior to\r
                                 invoking this dispatch function.\r
 \r
-  Nothing\r
+  @return None\r
 \r
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_SMM_USB_DISPATCH) (\r
+(EFIAPI *EFI_SMM_USB_DISPATCH)(\r
   IN  EFI_HANDLE                    DispatchHandle,\r
   IN  EFI_SMM_USB_DISPATCH_CONTEXT  *DispatchContext\r
   );\r
@@ -70,16 +81,16 @@ VOID
 /**\r
   Register a child SMI source dispatch function with a parent SMM driver\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchFunction      Pointer to dispatch function to be invoked for\r
-                                this SMI source\r
+  @param  This                  Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchFunction      Pointer to dispatch function to be invoked \r
+                                for this SMI source.\r
   @param  DispatchContext       Pointer to the dispatch function's context.\r
                                 The caller fills this context in before calling\r
                                 the register function to indicate to the register\r
                                 function the USB SMI types for which the dispatch\r
                                 function should be invoked.\r
-  @param  DispatchHandle        Handle of dispatch function, for when interfacing\r
-                                with the parent Sx state SMM driver.\r
+  @param  DispatchHandle        Handle generated by the dispatcher to track the \r
+                                function instance.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                 registered and the SMI source has been enabled.\r
@@ -92,7 +103,7 @@ VOID
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_USB_REGISTER) (\r
+(EFIAPI *EFI_SMM_USB_REGISTER)(\r
   IN EFI_SMM_USB_DISPATCH_PROTOCOL            *This,\r
   IN  EFI_SMM_USB_DISPATCH                    DispatchFunction,\r
   IN  EFI_SMM_USB_DISPATCH_CONTEXT            *DispatchContext,\r
@@ -100,10 +111,10 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Unregister a child SMI source dispatch function with a parent SMM driver\r
+  Unregisters a USB service\r
 \r
-  @param  This                  Protocol instance pointer.\r
-  @param  DispatchHandle        Handle of dispatch function to deregister.\r
+  @param  This                  Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
+  @param  DispatchHandle        Handle of the service to remove.\r
 \r
   @retval EFI_SUCCESS           The dispatch function has been successfully\r
                                 unregistered and the SMI source has been disabled\r
@@ -114,7 +125,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_SMM_USB_UNREGISTER) (\r
+(EFIAPI *EFI_SMM_USB_UNREGISTER)(\r
   IN EFI_SMM_USB_DISPATCH_PROTOCOL            *This,\r
   IN  EFI_HANDLE                              DispatchHandle\r
   );\r