/** @file\r
- Support for USB 1.1 standard.\r
+ Support for USB 2.0 standard.\r
\r
- Copyright (c) 2006, 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
- http://opensource.org/licenses/bsd-license.php \r
-\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: Usb.h\r
+ Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#define __USB_H__\r
\r
//\r
-// USB Descriptor types\r
-//\r
-#define USB_DT_DEVICE 0x01\r
-#define USB_DT_CONFIG 0x02\r
-#define USB_DT_STRING 0x03\r
-#define USB_DT_INTERFACE 0x04\r
-#define USB_DT_ENDPOINT 0x05\r
-#define USB_DT_HUB 0x29\r
-#define USB_DT_HID 0x21\r
-\r
-//\r
-// USB request type\r
+// Subset of Class and Subclass definitions from USB Specs\r
//\r
-#define USB_TYPE_STANDARD (0x00 << 5)\r
-#define USB_TYPE_CLASS (0x01 << 5)\r
-#define USB_TYPE_VENDOR (0x02 << 5)\r
-#define USB_TYPE_RESERVED (0x03 << 5)\r
\r
//\r
-// USB request targer device\r
+// Usb mass storage class code\r
//\r
-#define USB_RECIP_DEVICE 0x00\r
-#define USB_RECIP_INTERFACE 0x01\r
-#define USB_RECIP_ENDPOINT 0x02\r
-#define USB_RECIP_OTHER 0x03\r
+#define USB_MASS_STORE_CLASS 0x08\r
\r
//\r
-// Request target types.\r
-//\r
-#define USB_RT_DEVICE 0x00\r
-#define USB_RT_INTERFACE 0x01\r
-#define USB_RT_ENDPOINT 0x02\r
-#define USB_RT_HUB (USB_TYPE_CLASS | USB_RECIP_DEVICE)\r
-#define USB_RT_PORT (USB_TYPE_CLASS | USB_RECIP_OTHER)\r
-\r
-//\r
-// USB Transfer Results\r
-//\r
-#define EFI_USB_NOERROR 0x00\r
-#define EFI_USB_ERR_NOTEXECUTE 0x01\r
-#define EFI_USB_ERR_STALL 0x02\r
-#define EFI_USB_ERR_BUFFER 0x04\r
-#define EFI_USB_ERR_BABBLE 0x08\r
-#define EFI_USB_ERR_NAK 0x10\r
-#define EFI_USB_ERR_CRC 0x20\r
-#define EFI_USB_ERR_TIMEOUT 0x40\r
-#define EFI_USB_ERR_BITSTUFF 0x80\r
-#define EFI_USB_ERR_SYSTEM 0x100\r
-\r
+// Usb mass storage subclass code, specify the command set used.\r
//\r
-//Use 200 ms to increase the error handling response time\r
-//\r
-#define EFI_USB_INTERRUPT_DELAY 2000000\r
-\r
-//\r
-// USB transation direction\r
-//\r
-typedef enum {\r
- EfiUsbDataOut,\r
- EfiUsbDataIn,\r
- EfiUsbNoData\r
-} EFI_USB_DATA_DIRECTION;\r
-\r
-//\r
-// Usb Data recipient type\r
-//\r
-typedef enum {\r
- EfiUsbDevice,\r
- EfiUsbInterface,\r
- EfiUsbEndpoint\r
-} EFI_USB_RECIPIENT;\r
+#define USB_MASS_STORE_RBC 0x01 ///< Reduced Block Commands\r
+#define USB_MASS_STORE_8020I 0x02 ///< SFF-8020i, typically a CD/DVD device\r
+#define USB_MASS_STORE_QIC 0x03 ///< Typically a tape device\r
+#define USB_MASS_STORE_UFI 0x04 ///< Typically a floppy disk driver device\r
+#define USB_MASS_STORE_8070I 0x05 ///< SFF-8070i, typically a floppy disk driver device.\r
+#define USB_MASS_STORE_SCSI 0x06 ///< SCSI transparent command set\r
\r
-typedef enum {\r
- EfiUsbEndpointHalt,\r
- EfiUsbDeviceRemoteWakeup\r
-} EFI_USB_STANDARD_FEATURE_SELECTOR;\r
-\r
-#pragma pack(1)\r
//\r
-// Usb device request structure\r
+// Usb mass storage protocol code, specify the transport protocol\r
//\r
-typedef struct {\r
- UINT8 RequestType;\r
- UINT8 Request;\r
- UINT16 Value;\r
- UINT16 Index;\r
- UINT16 Length;\r
-} EFI_USB_DEVICE_REQUEST;\r
+#define USB_MASS_STORE_CBI0 0x00 ///< CBI protocol with command completion interrupt\r
+#define USB_MASS_STORE_CBI1 0x01 ///< CBI protocol without command completion interrupt\r
+#define USB_MASS_STORE_BOT 0x50 ///< Bulk-Only Transport\r
\r
//\r
-// Standard USB request\r
+// Standard device request and request type\r
+// USB 2.0 spec, Section 9.4\r
//\r
#define USB_DEV_GET_STATUS 0x00\r
+#define USB_DEV_GET_STATUS_REQ_TYPE_D 0x80 // Receiver : Device\r
+#define USB_DEV_GET_STATUS_REQ_TYPE_I 0x81 // Receiver : Interface\r
+#define USB_DEV_GET_STATUS_REQ_TYPE_E 0x82 // Receiver : Endpoint\r
\r
#define USB_DEV_CLEAR_FEATURE 0x01\r
+#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_D 0x00 // Receiver : Device\r
+#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_I 0x01 // Receiver : Interface\r
+#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_E 0x02 // Receiver : Endpoint\r
\r
#define USB_DEV_SET_FEATURE 0x03\r
+#define USB_DEV_SET_FEATURE_REQ_TYPE_D 0x00 // Receiver : Device\r
+#define USB_DEV_SET_FEATURE_REQ_TYPE_I 0x01 // Receiver : Interface\r
+#define USB_DEV_SET_FEATURE_REQ_TYPE_E 0x02 // Receiver : Endpoint\r
\r
#define USB_DEV_SET_ADDRESS 0x05\r
#define USB_DEV_SET_ADDRESS_REQ_TYPE 0x00\r
#define USB_DEV_SYNCH_FRAME 0x0C\r
#define USB_DEV_SYNCH_FRAME_REQ_TYPE 0x82\r
\r
+\r
//\r
-// Device descriptor. refer USB1.1\r
-//\r
-typedef struct usb_device_descriptor {\r
- UINT8 Length;\r
- UINT8 DescriptorType;\r
- UINT16 BcdUSB;\r
- UINT8 DeviceClass;\r
- UINT8 DeviceSubClass;\r
- UINT8 DeviceProtocol;\r
- UINT8 MaxPacketSize0;\r
- UINT16 IdVendor;\r
- UINT16 IdProduct;\r
- UINT16 BcdDevice;\r
- UINT8 StrManufacturer;\r
- UINT8 StrProduct;\r
- UINT8 StrSerialNumber;\r
- UINT8 NumConfigurations;\r
-} EFI_USB_DEVICE_DESCRIPTOR;\r
-\r
-//\r
-// Endpoint descriptor\r
+// USB standard descriptors and reqeust\r
//\r
+#pragma pack(1)\r
+\r
+///\r
+/// Format of Setup Data for USB Device Requests\r
+/// USB 2.0 spec, Section 9.3\r
+///\r
typedef struct {\r
- UINT8 Length;\r
- UINT8 DescriptorType;\r
- UINT8 EndpointAddress;\r
- UINT8 Attributes;\r
- UINT16 MaxPacketSize;\r
- UINT8 Interval;\r
-} EFI_USB_ENDPOINT_DESCRIPTOR;\r
+ UINT8 RequestType;\r
+ UINT8 Request;\r
+ UINT16 Value;\r
+ UINT16 Index;\r
+ UINT16 Length;\r
+} USB_DEVICE_REQUEST;\r
+\r
+///\r
+/// Standard Device Descriptor\r
+/// USB 2.0 spec, Section 9.6.1\r
+///\r
+typedef struct {\r
+ UINT8 Length;\r
+ UINT8 DescriptorType;\r
+ UINT16 BcdUSB;\r
+ UINT8 DeviceClass;\r
+ UINT8 DeviceSubClass;\r
+ UINT8 DeviceProtocol;\r
+ UINT8 MaxPacketSize0;\r
+ UINT16 IdVendor;\r
+ UINT16 IdProduct;\r
+ UINT16 BcdDevice;\r
+ UINT8 StrManufacturer;\r
+ UINT8 StrProduct;\r
+ UINT8 StrSerialNumber;\r
+ UINT8 NumConfigurations;\r
+} USB_DEVICE_DESCRIPTOR;\r
+\r
+///\r
+/// Standard Configuration Descriptor\r
+/// USB 2.0 spec, Section 9.6.3\r
+///\r
+typedef struct {\r
+ UINT8 Length;\r
+ UINT8 DescriptorType;\r
+ UINT16 TotalLength;\r
+ UINT8 NumInterfaces;\r
+ UINT8 ConfigurationValue;\r
+ UINT8 Configuration;\r
+ UINT8 Attributes;\r
+ UINT8 MaxPower;\r
+} USB_CONFIG_DESCRIPTOR;\r
+\r
+///\r
+/// Standard Interface Descriptor\r
+/// USB 2.0 spec, Section 9.6.5\r
+///\r
+typedef struct {\r
+ UINT8 Length;\r
+ UINT8 DescriptorType;\r
+ UINT8 InterfaceNumber;\r
+ UINT8 AlternateSetting;\r
+ UINT8 NumEndpoints;\r
+ UINT8 InterfaceClass;\r
+ UINT8 InterfaceSubClass;\r
+ UINT8 InterfaceProtocol;\r
+ UINT8 Interface;\r
+} USB_INTERFACE_DESCRIPTOR;\r
+\r
+///\r
+/// Standard Endpoint Descriptor\r
+/// USB 2.0 spec, Section 9.6.6\r
+///\r
+typedef struct {\r
+ UINT8 Length;\r
+ UINT8 DescriptorType;\r
+ UINT8 EndpointAddress;\r
+ UINT8 Attributes;\r
+ UINT16 MaxPacketSize;\r
+ UINT8 Interval;\r
+} USB_ENDPOINT_DESCRIPTOR;\r
+\r
+///\r
+/// UNICODE String Descriptor\r
+/// USB 2.0 spec, Section 9.6.7\r
+///\r
+typedef struct {\r
+ UINT8 Length;\r
+ UINT8 DescriptorType;\r
+ CHAR16 String[1];\r
+} EFI_USB_STRING_DESCRIPTOR;\r
+\r
+#pragma pack()\r
+\r
+\r
+typedef enum {\r
+ //\r
+ // USB request type\r
+ //\r
+ USB_REQ_TYPE_STANDARD = (0x00 << 5),\r
+ USB_REQ_TYPE_CLASS = (0x01 << 5),\r
+ USB_REQ_TYPE_VENDOR = (0x02 << 5),\r
+\r
+ //\r
+ // Standard control transfer request type, or the value\r
+ // to fill in EFI_USB_DEVICE_REQUEST.Request\r
+ //\r
+ USB_REQ_GET_STATUS = 0x00,\r
+ USB_REQ_CLEAR_FEATURE = 0x01,\r
+ USB_REQ_SET_FEATURE = 0x03,\r
+ USB_REQ_SET_ADDRESS = 0x05,\r
+ USB_REQ_GET_DESCRIPTOR = 0x06,\r
+ USB_REQ_SET_DESCRIPTOR = 0x07,\r
+ USB_REQ_GET_CONFIG = 0x08,\r
+ USB_REQ_SET_CONFIG = 0x09,\r
+ USB_REQ_GET_INTERFACE = 0x0A,\r
+ USB_REQ_SET_INTERFACE = 0x0B,\r
+ USB_REQ_SYNCH_FRAME = 0x0C,\r
+\r
+ //\r
+ // Usb control transfer target\r
+ //\r
+ USB_TARGET_DEVICE = 0,\r
+ USB_TARGET_INTERFACE = 0x01,\r
+ USB_TARGET_ENDPOINT = 0x02,\r
+ USB_TARGET_OTHER = 0x03,\r
+\r
+ //\r
+ // USB Descriptor types\r
+ //\r
+ USB_DESC_TYPE_DEVICE = 0x01,\r
+ USB_DESC_TYPE_CONFIG = 0x02,\r
+ USB_DESC_TYPE_STRING = 0x03,\r
+ USB_DESC_TYPE_INTERFACE = 0x04,\r
+ USB_DESC_TYPE_ENDPOINT = 0x05,\r
+ USB_DESC_TYPE_HID = 0x21,\r
+ USB_DESC_TYPE_REPORT = 0x22,\r
+\r
+ //\r
+ // Features to be cleared by CLEAR_FEATURE requests\r
+ //\r
+ USB_FEATURE_ENDPOINT_HALT = 0,\r
+\r
+ //\r
+ // USB endpoint types: 00: control, 01: isochronous, 10: bulk, 11: interrupt\r
+ //\r
+ USB_ENDPOINT_CONTROL = 0x00,\r
+ USB_ENDPOINT_ISO = 0x01,\r
+ USB_ENDPOINT_BULK = 0x02,\r
+ USB_ENDPOINT_INTERRUPT = 0x03,\r
+\r
+ USB_ENDPOINT_TYPE_MASK = 0x03,\r
+ USB_ENDPOINT_DIR_IN = 0x80,\r
+\r
+ //\r
+ //Use 200 ms to increase the error handling response time\r
+ //\r
+ EFI_USB_INTERRUPT_DELAY = 2000000\r
+} USB_TYPES_DEFINITION;\r
+\r
\r
//\r
-// Interface descriptor\r
+// HID constants definition, see Device Class Definition\r
+// for Human Interface Devices (HID) rev1.11\r
//\r
-typedef struct {\r
- UINT8 Length;\r
- UINT8 DescriptorType;\r
- UINT8 InterfaceNumber;\r
- UINT8 AlternateSetting;\r
- UINT8 NumEndpoints;\r
- UINT8 InterfaceClass;\r
- UINT8 InterfaceSubClass;\r
- UINT8 InterfaceProtocol;\r
- UINT8 Interface;\r
-} EFI_USB_INTERFACE_DESCRIPTOR;\r
\r
//\r
-// USB alternate setting\r
+// HID standard GET_DESCRIPTOR request.\r
//\r
-typedef struct {\r
- EFI_USB_INTERFACE_DESCRIPTOR *Interface;\r
-} USB_ALT_SETTING;\r
+#define USB_HID_GET_DESCRIPTOR_REQ_TYPE 0x81\r
\r
//\r
-// Configuration descriptor\r
+// HID specific requests.\r
//\r
-typedef struct {\r
- UINT8 Length;\r
- UINT8 DescriptorType;\r
- UINT16 TotalLength;\r
- UINT8 NumInterfaces;\r
- UINT8 ConfigurationValue;\r
- UINT8 Configuration;\r
- UINT8 Attributes;\r
- UINT8 MaxPower;\r
-} EFI_USB_CONFIG_DESCRIPTOR;\r
+#define USB_HID_CLASS_GET_REQ_TYPE 0xa1\r
+#define USB_HID_CLASS_SET_REQ_TYPE 0x21\r
\r
//\r
-// Supported String Languages\r
+// HID report item format\r
//\r
-typedef struct {\r
- UINT8 Length;\r
- UINT8 DescriptorType;\r
- UINT16 SupportedLanID[1];\r
-} EFI_USB_SUPPORTED_LANGUAGES;\r
+#define HID_ITEM_FORMAT_SHORT 0\r
+#define HID_ITEM_FORMAT_LONG 1\r
\r
//\r
-// String descriptor\r
+// Special tag indicating long items\r
//\r
-typedef struct {\r
- UINT8 Length;\r
- UINT8 DescriptorType;\r
- CHAR16 String[1];\r
-} EFI_USB_STRING_DESCRIPTOR;\r
+#define HID_ITEM_TAG_LONG 15\r
\r
//\r
-// Hub descriptor\r
+// HID report descriptor item type (prefix bit 2,3)\r
//\r
-#define MAXBYTES 8\r
-typedef struct {\r
- UINT8 Length;\r
- UINT8 DescriptorType;\r
- UINT8 NbrPorts;\r
- UINT8 HubCharacteristics[2];\r
- UINT8 PwrOn2PwrGood;\r
- UINT8 HubContrCurrent;\r
- UINT8 Filler[MAXBYTES];\r
-} EFI_USB_HUB_DESCRIPTOR;\r
+#define HID_ITEM_TYPE_MAIN 0\r
+#define HID_ITEM_TYPE_GLOBAL 1\r
+#define HID_ITEM_TYPE_LOCAL 2\r
+#define HID_ITEM_TYPE_RESERVED 3\r
\r
-typedef struct {\r
- UINT16 PortStatus;\r
- UINT16 PortChangeStatus;\r
-} EFI_USB_PORT_STATUS;\r
+//\r
+// HID report descriptor main item tags\r
+//\r
+#define HID_MAIN_ITEM_TAG_INPUT 8\r
+#define HID_MAIN_ITEM_TAG_OUTPUT 9\r
+#define HID_MAIN_ITEM_TAG_FEATURE 11\r
+#define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION 10\r
+#define HID_MAIN_ITEM_TAG_END_COLLECTION 12\r
+\r
+//\r
+// HID report descriptor main item contents\r
+//\r
+#define HID_MAIN_ITEM_CONSTANT 0x001\r
+#define HID_MAIN_ITEM_VARIABLE 0x002\r
+#define HID_MAIN_ITEM_RELATIVE 0x004\r
+#define HID_MAIN_ITEM_WRAP 0x008\r
+#define HID_MAIN_ITEM_NONLINEAR 0x010\r
+#define HID_MAIN_ITEM_NO_PREFERRED 0x020\r
+#define HID_MAIN_ITEM_NULL_STATE 0x040\r
+#define HID_MAIN_ITEM_VOLATILE 0x080\r
+#define HID_MAIN_ITEM_BUFFERED_BYTE 0x100\r
\r
//\r
-// Constant value for Port Status & Port Change Status\r
+// HID report descriptor collection item types\r
//\r
-#define USB_PORT_STAT_CONNECTION 0x0001\r
-#define USB_PORT_STAT_ENABLE 0x0002\r
-#define USB_PORT_STAT_SUSPEND 0x0004\r
-#define USB_PORT_STAT_OVERCURRENT 0x0008\r
-#define USB_PORT_STAT_RESET 0x0010\r
-#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 HID_COLLECTION_PHYSICAL 0\r
+#define HID_COLLECTION_APPLICATION 1\r
+#define HID_COLLECTION_LOGICAL 2\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
-#define USB_PORT_STAT_C_OVERCURRENT 0x0008\r
-#define USB_PORT_STAT_C_RESET 0x0010\r
+//\r
+// HID report descriptor global item tags\r
+//\r
+#define HID_GLOBAL_ITEM_TAG_USAGE_PAGE 0\r
+#define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM 1\r
+#define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM 2\r
+#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM 3\r
+#define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM 4\r
+#define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT 5\r
+#define HID_GLOBAL_ITEM_TAG_UNIT 6\r
+#define HID_GLOBAL_ITEM_TAG_REPORT_SIZE 7\r
+#define HID_GLOBAL_ITEM_TAG_REPORT_ID 8\r
+#define HID_GLOBAL_ITEM_TAG_REPORT_COUNT 9\r
+#define HID_GLOBAL_ITEM_TAG_PUSH 10\r
+#define HID_GLOBAL_ITEM_TAG_POP 11\r
\r
//\r
-// Used for set/clear port feature request\r
+// HID report descriptor local item tags\r
//\r
-typedef enum {\r
- EfiUsbPortEnable = 1,\r
- EfiUsbPortSuspend = 2,\r
- EfiUsbPortReset = 4,\r
- EfiUsbPortPower = 8,\r
- EfiUsbPortOwner = 13,\r
- EfiUsbPortConnectChange = 16,\r
- EfiUsbPortEnableChange = 17,\r
- EfiUsbPortSuspendChange = 18,\r
- EfiUsbPortOverCurrentChange = 19,\r
- EfiUsbPortResetChange = 20\r
-} EFI_USB_PORT_FEATURE;\r
+#define HID_LOCAL_ITEM_TAG_USAGE 0\r
+#define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM 1\r
+#define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM 2\r
+#define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX 3\r
+#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4\r
+#define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5\r
+#define HID_LOCAL_ITEM_TAG_STRING_INDEX 7\r
+#define HID_LOCAL_ITEM_TAG_STRING_MINIMUM 8\r
+#define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM 9\r
+#define HID_LOCAL_ITEM_TAG_DELIMITER 10\r
+\r
+//\r
+// HID report types\r
+//\r
+#define HID_INPUT_REPORT 1\r
+#define HID_OUTPUT_REPORT 2\r
+#define HID_FEATURE_REPORT 3\r
+\r
+//\r
+// HID class protocol request\r
+//\r
+#define EFI_USB_GET_REPORT_REQUEST 0x01\r
+#define EFI_USB_GET_IDLE_REQUEST 0x02\r
+#define EFI_USB_GET_PROTOCOL_REQUEST 0x03\r
+#define EFI_USB_SET_REPORT_REQUEST 0x09\r
+#define EFI_USB_SET_IDLE_REQUEST 0x0a\r
+#define EFI_USB_SET_PROTOCOL_REQUEST 0x0b\r
+\r
+#pragma pack(1)\r
+///\r
+/// Descriptor header for Report/Physical Descriptors\r
+/// HID 1.1, section 6.2.1\r
+///\r
+typedef struct hid_class_descriptor {\r
+ UINT8 DescriptorType;\r
+ UINT16 DescriptorLength;\r
+} EFI_USB_HID_CLASS_DESCRIPTOR;\r
+\r
+///\r
+/// The HID descriptor identifies the length and type\r
+/// of subordinate descriptors for a device.\r
+/// HID 1.1, section 6.2.1\r
+///\r
+typedef struct hid_descriptor {\r
+ UINT8 Length;\r
+ UINT8 DescriptorType;\r
+ UINT16 BcdHID;\r
+ UINT8 CountryCode;\r
+ UINT8 NumDescriptors;\r
+ EFI_USB_HID_CLASS_DESCRIPTOR HidClassDesc[1];\r
+} EFI_USB_HID_DESCRIPTOR;\r
\r
#pragma pack()\r
\r