modify coding style to pass ecc tool and provide comments that complied with Doxgen.

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbBusDxe / UsbEnumer.h

diff --git a/MdeModulePkg/Bus/Usb/UsbBusDxe/UsbEnumer.h b/MdeModulePkg/Bus/Usb/UsbBusDxe/UsbEnumer.h
index 54f4dd2ca0eeca94870a1ddd308a9057dd1ca457..1b36a6d853720bca6f4d41eb59dfd3a171b8d871 100644 (file)
--- a/MdeModulePkg/Bus/Usb/UsbBusDxe/UsbEnumer.h
+++ b/MdeModulePkg/Bus/Usb/UsbBusDxe/UsbEnumer.h
@@ -1,5 +1,7 @@
 /** @file\r
 \r
+    USB bus enumeration interface.\r
+\r
 Copyright (c) 2007, 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
@@ -9,17 +11,6 @@ http://opensource.org/licenses/bsd-license.php
 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:\r
-\r
-    UsbEnumer.h\r
-\r
-  Abstract:\r
-\r
-    USB bus enumeration interface\r
-\r
-  Revision History\r
-\r
-\r
 **/\r
 \r
 #ifndef _USB_ENUMERATION_H_\r
@@ -110,35 +101,93 @@ struct _USB_HUB_API{
   USB_HUB_RELEASE             Release;\r
 };\r
 \r
+/**\r
+  Return the endpoint descriptor in this interface.\r
+\r
+  @param  UsbIf                 The interface to search in.\r
+  @param  EpAddr                The address of the endpoint to return.\r
+\r
+  @return The endpoint descriptor or NULL.\r
+\r
+**/\r
 USB_ENDPOINT_DESC*\r
 UsbGetEndpointDesc (\r
   IN USB_INTERFACE        *UsbIf,\r
   IN UINT8                EpAddr\r
   );\r
 \r
+/**\r
+  Select an alternate setting for the interface.\r
+  Each interface can have several mutually exclusive\r
+  settings. Only one setting is active. It will\r
+  also reset its endpoints' toggle to zero.\r
+\r
+  @param  IfDesc                The interface descriptor to set.\r
+  @param  Alternate             The alternate setting number to locate.\r
+\r
+  @retval EFI_NOT_FOUND         There is no setting with this alternate index.\r
+  @retval EFI_SUCCESS           The interface is set to Alternate setting.\r
 \r
+**/\r
 EFI_STATUS\r
 UsbSelectSetting (\r
   IN USB_INTERFACE_DESC   *IfDesc,\r
   IN UINT8                Alternate\r
   );\r
 \r
+/**\r
+  Select a new configuration for the device. Each\r
+  device may support several configurations.\r
+\r
+  @param  Device                The device to select configuration.\r
+  @param  ConfigIndex           The index of the configuration ( != 0).\r
+\r
+  @retval EFI_NOT_FOUND         There is no configuration with the index.\r
+  @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource.\r
+  @retval EFI_SUCCESS           The configuration is selected.\r
+\r
+**/\r
 EFI_STATUS\r
 UsbSelectConfig (\r
   IN USB_DEVICE           *Device,\r
   IN UINT8                ConfigIndex\r
   );\r
 \r
+/**\r
+  Remove the current device configuration.\r
+\r
+  @param  Device                The USB device to remove configuration from.\r
+\r
+  @return None.\r
+\r
+**/\r
 VOID\r
 UsbRemoveConfig (\r
   IN USB_DEVICE           *Device\r
   );\r
 \r
+/**\r
+  Remove the device and all its children from the bus.\r
+\r
+  @param  Device                The device to remove.\r
+\r
+  @retval EFI_SUCCESS           The device is removed.\r
+\r
+**/\r
 EFI_STATUS\r
 UsbRemoveDevice (\r
   IN USB_DEVICE           *Device\r
   );\r
 \r
+/**\r
+  Enumerate all the changed hub ports.\r
+\r
+  @param  Event                 The event that is triggered.\r
+  @param  Context               The context to the event.\r
+\r
+  @return None.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 UsbHubEnumeration (\r
@@ -146,6 +195,15 @@ UsbHubEnumeration (
   IN VOID                 *Context\r
   );\r
 \r
+/**\r
+  Enumerate all the changed hub ports.\r
+\r
+  @param  Event                 The event that is triggered.\r
+  @param  Context               The context to the event.\r
+\r
+  @return None.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 UsbRootHubEnumeration (\r