update comments to allign with spec

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

diff --git a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
index e87619d938affa1140c32b21a10a87198b22687b..5887951e98debb9832182e0333eacc5721f5c344 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
+++ b/IntelFrameworkPkg/Include/Protocol/SmmUsbDispatch.h
@@ -1,5 +1,5 @@
 /** @file\r
-  This file declares EFI Smm USB Smi Child Protocol.\r
+  Provides the parent dispatch service for the USB SMI source generator.\r
 \r
   Copyright (c) 2007, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
@@ -20,6 +20,8 @@
 #ifndef _EFI_SMM_USB_DISPATCH_H_\r
 #define _EFI_SMM_USB_DISPATCH_H_\r
 \r
+#include <PiDxe.h>\r
+\r
 //\r
 // Global ID for the USB Protocol\r
 //\r
@@ -55,12 +57,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
@@ -68,16 +70,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
@@ -90,7 +92,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
@@ -98,10 +100,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
@@ -112,7 +114,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