MdePkg: Add UEFI2.5 USB Function I/O protocol definitions

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

diff --git a/MdePkg/Include/Protocol/Usb2HostController.h b/MdePkg/Include/Protocol/Usb2HostController.h
index 6687e323aaae0f515a8e153b863d1a6a583e4476..140062c5eb09df707061dcaa2f2ed2a06727f7f6 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 - 2011, 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,8 +32,8 @@ typedef struct _EFI_USB2_HC_PROTOCOL EFI_USB2_HC_PROTOCOL;
 \r
 \r
 typedef struct {\r
-  UINT16          PortStatus;        /// Contains current port status bitmap.\r
-  UINT16          PortChangeStatus;  /// Contains current port status change bitmap.\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
@@ -48,7 +47,8 @@ typedef struct {
 #define USB_PORT_STAT_POWER         0x0100\r
 #define USB_PORT_STAT_LOW_SPEED     0x0200\r
 #define USB_PORT_STAT_HIGH_SPEED    0x0400\r
-#define USB_PORT_STAT_OWNER         0x0800\r
+#define USB_PORT_STAT_SUPER_SPEED   0x0800\r
+#define USB_PORT_STAT_OWNER         0x2000\r
 \r
 ///\r
 /// EFI_USB_PORT_STATUS.PortChangeStatus bit definition \r
@@ -78,13 +78,14 @@ typedef enum {
   EfiUsbPortResetChange       = 20\r
 } EFI_USB_PORT_FEATURE;\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
+#define EFI_USB_SPEED_SUPER     0x0003  ///< 4.8 Gb/s, USB 3.0 XHCI HC.\r
 \r
 typedef struct {\r
-  UINT8      TranslatorHubAddress; /// device address\r
-  UINT8      TranslatorPortNumber; /// the port number of the hub that device is connected to.\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
@@ -195,7 +196,7 @@ typedef enum {
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_USB2_HC_PROTOCOL_GET_STATE)(\r
-  IN CONST  EFI_USB2_HC_PROTOCOL    *This,\r
+  IN        EFI_USB2_HC_PROTOCOL    *This,\r
   OUT       EFI_USB_HC_STATE        *State\r
 );\r
 \r
@@ -510,8 +511,8 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_USB2_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS)(\r
-  IN CONST  EFI_USB2_HC_PROTOCOL    *This,\r
-  IN CONST  UINT8                   PortNumber,\r
+  IN        EFI_USB2_HC_PROTOCOL    *This,\r
+  IN        UINT8                   PortNumber,\r
   OUT       EFI_USB_PORT_STATUS     *PortStatus\r
   );\r
 \r