Update the copyright notice format

[mirror_edk2.git] / MdePkg / Include / Protocol / Usb2HostController.h

diff --git a/MdePkg/Include/Protocol/Usb2HostController.h b/MdePkg/Include/Protocol/Usb2HostController.h
index 22a80e557ae20d82b1deb9a7dd331fe128d06a61..097eb36ee946d7abafd6ff00bd05c9d1dccc8ff3 100644 (file)
--- a/MdePkg/Include/Protocol/Usb2HostController.h
+++ b/MdePkg/Include/Protocol/Usb2HostController.h
@@ -4,8 +4,8 @@
   running in the EFI boot services environment, to perform data transactions over \r
   a USB bus. In addition, it provides an abstraction for the root hub of the USB bus.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  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
   http://opensource.org/licenses/bsd-license.php\r
@@ -18,7 +18,6 @@
 #ifndef _USB2_HOSTCONTROLLER_H_\r
 #define _USB2_HOSTCONTROLLER_H_\r
 \r
-#include <IndustryStandard/Usb.h>\r
 #include <Protocol/UsbIo.h>\r
 \r
 #define EFI_USB2_HC_PROTOCOL_GUID \\r
@@ -33,13 +32,13 @@ typedef struct _EFI_USB2_HC_PROTOCOL EFI_USB2_HC_PROTOCOL;
 \r
 \r
 typedef struct {\r
-  UINT16          PortStatus;\r
-  UINT16          PortChangeStatus;\r
+  UINT16          PortStatus;        ///< Contains current port status bitmap.\r
+  UINT16          PortChangeStatus;  ///< Contains current port status change bitmap.\r
 } EFI_USB_PORT_STATUS;\r
 \r
-//\r
-// Constant value for Port Status & Port Change Status\r
-//\r
+///\r
+/// EFI_USB_PORT_STATUS.PortStatus bit definition \r
+///\r
 #define USB_PORT_STAT_CONNECTION    0x0001\r
 #define USB_PORT_STAT_ENABLE        0x0002\r
 #define USB_PORT_STAT_SUSPEND       0x0004\r
@@ -50,6 +49,9 @@ typedef struct {
 #define USB_PORT_STAT_HIGH_SPEED    0x0400\r
 #define USB_PORT_STAT_OWNER         0x0800\r
 \r
+///\r
+/// EFI_USB_PORT_STATUS.PortChangeStatus bit definition \r
+///\r
 #define USB_PORT_STAT_C_CONNECTION  0x0001\r
 #define USB_PORT_STAT_C_ENABLE      0x0002\r
 #define USB_PORT_STAT_C_SUSPEND     0x0004\r
@@ -57,9 +59,11 @@ typedef struct {
 #define USB_PORT_STAT_C_RESET       0x0010\r
 \r
 \r
-//\r
-// Usb port features\r
-//\r
+///\r
+/// Usb port features value\r
+/// Each value indicates its bit index in the port status and status change bitmaps, \r
+/// if combines these two bitmaps into a 32-bit bitmap.\r
+///\r
 typedef enum {\r
   EfiUsbPortEnable            = 1,\r
   EfiUsbPortSuspend           = 2,\r
@@ -73,14 +77,13 @@ typedef enum {
   EfiUsbPortResetChange       = 20\r
 } EFI_USB_PORT_FEATURE;\r
 \r
-\r
-#define EFI_USB_SPEED_FULL      0x0000  // 12 Mb/s, USB 1.1 OHCI and UHCI HC.\r
-#define EFI_USB_SPEED_LOW       0x0001  // 1 Mb/s, USB 1.1 OHCI and UHCI HC.\r
-#define EFI_USB_SPEED_HIGH      0x0002  // 480 Mb/s, USB 2.0 EHCI HC.\r
+#define EFI_USB_SPEED_FULL      0x0000  ///< 12 Mb/s, USB 1.1 OHCI and UHCI HC.\r
+#define EFI_USB_SPEED_LOW       0x0001  ///< 1 Mb/s, USB 1.1 OHCI and UHCI HC.\r
+#define EFI_USB_SPEED_HIGH      0x0002  ///< 480 Mb/s, USB 2.0 EHCI HC.\r
 \r
 typedef struct {\r
-  UINT8      TranslatorHubAddress;\r
-  UINT8      TranslatorPortNumber;\r
+  UINT8      TranslatorHubAddress; ///< device address\r
+  UINT8      TranslatorPortNumber; ///< the port number of the hub that device is connected to.\r
 } EFI_USB2_HC_TRANSACTION_TRANSLATOR;\r
 \r
 //\r
@@ -553,16 +556,14 @@ EFI_STATUS
   IN EFI_USB_PORT_FEATURE    PortFeature\r
   );\r
 \r
-/**  \r
-  @par Protocol Description:\r
-  The EFI_USB2_HC_PROTOCOL provides USB host controller management, basic \r
-  data transactions over a USB bus, and USB root hub access. A device driver \r
-  that wishes to manage a USB bus in a system retrieves the EFI_USB2_HC_PROTOCOL \r
-  instance that is associated with the USB bus to be managed. A device handle \r
-  for a USB host controller will minimally contain an EFI_DEVICE_PATH_PROTOCOL \r
-  instance, and an EFI_USB2_HC_PROTOCOL instance.\r
-\r
-**/\r
+///\r
+/// The EFI_USB2_HC_PROTOCOL provides USB host controller management, basic \r
+/// data transactions over a USB bus, and USB root hub access. A device driver \r
+/// that wishes to manage a USB bus in a system retrieves the EFI_USB2_HC_PROTOCOL \r
+/// instance that is associated with the USB bus to be managed. A device handle \r
+/// for a USB host controller will minimally contain an EFI_DEVICE_PATH_PROTOCOL \r
+/// instance, and an EFI_USB2_HC_PROTOCOL instance.\r
+///\r
 struct _EFI_USB2_HC_PROTOCOL {\r
   EFI_USB2_HC_PROTOCOL_GET_CAPABILITY              GetCapability;\r
   EFI_USB2_HC_PROTOCOL_RESET                       Reset;\r