Refine SMM USB Dispatch Protocol definition.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmUsbDispatch.h
index c2f70aceebaa73be3aeeec6b9f22f221b94c0f3a..7993b724f2b81f7e232ade1c929956ebd7318682 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Provides the parent dispatch service for the USB SMI source generator.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:  SmmUsbDispatch.h\r
-\r
   @par Revision Reference:\r
   This Protocol is defined in Framework of EFI SMM Core Interface Spec\r
   Version 0.9.\r
+\r
 **/\r
 \r
 #ifndef _EFI_SMM_USB_DISPATCH_H_\r
@@ -68,8 +67,6 @@ typedef struct {
                                 by the dispatching driver prior to\r
                                 invoking this dispatch function.\r
 \r
-  @return None\r
-\r
 **/\r
 typedef\r
 VOID\r
@@ -79,7 +76,7 @@ VOID
   );\r
 \r
 /**\r
-  Register a child SMI source dispatch function with a parent SMM driver\r
+  Register a child SMI source dispatch function with a parent SMM driver.\r
 \r
   @param  This                  Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
   @param  DispatchFunction      Pointer to dispatch function to be invoked \r
@@ -111,7 +108,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Unregisters a USB service\r
+  Unregisters a USB service.\r
 \r
   @param  This                  Pointer to the EFI_SMM_USB_DISPATCH_PROTOCOL instance.\r
   @param  DispatchHandle        Handle of the service to remove.\r
@@ -120,7 +117,7 @@ EFI_STATUS
                                 unregistered and the SMI source has been disabled\r
                                 if there are no other registered child dispatch\r
                                 functions for this SMI source.\r
-  @retval EFI_INVALID_PARAMETER Handle is invalid.\r
+  @retval EFI_INVALID_PARAMETER The DispatchHandle was not valid.\r
 \r
 **/\r
 typedef\r
@@ -130,20 +127,10 @@ EFI_STATUS
   IN  EFI_HANDLE                              DispatchHandle\r
   );\r
 \r
-//\r
-// Interface structure for the SMM USB SMI Dispatch Protocol\r
-//\r
-/**\r
-  @par Protocol Description:\r
-  Provides the parent dispatch service for the USB SMI source generator.\r
-\r
-  @param Register\r
-  Installs a child service to be dispatched by this protocol.\r
-\r
-  @param UnRegister\r
-  Removes a child service dispatched by this protocol.\r
-\r
-**/\r
+///\r
+/// The EFI_SMM_USB_DISPATCH_PROTOCOL provides the ability to install child handlers for the\r
+/// given event types.\r
+///\r
 struct _EFI_SMM_USB_DISPATCH_PROTOCOL {\r
   EFI_SMM_USB_REGISTER    Register;\r
   EFI_SMM_USB_UNREGISTER  UnRegister;\r