MdePkg/Include/IndustryStandard/Usb.h

   1 /** @file
   2   Support for USB 1.1 standard.
   3
   4   Copyright (c) 2006 - 2007, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __USB_H__
  16 #define __USB_H__
  17
  18 //
  19 // Standard device request and request type
  20 // By [Spec-USB20/Chapter-9.4]
  21 //
  22 #define USB_DEV_GET_STATUS                  0x00
  23 #define USB_DEV_GET_STATUS_REQ_TYPE_D       0x80 // Receiver : Device
  24 #define USB_DEV_GET_STATUS_REQ_TYPE_I       0x81 // Receiver : Interface
  25 #define USB_DEV_GET_STATUS_REQ_TYPE_E       0x82 // Receiver : Endpoint
  26
  27 #define USB_DEV_CLEAR_FEATURE               0x01
  28 #define USB_DEV_CLEAR_FEATURE_REQ_TYPE_D    0x00 // Receiver : Device
  29 #define USB_DEV_CLEAR_FEATURE_REQ_TYPE_I    0x01 // Receiver : Interface
  30 #define USB_DEV_CLEAR_FEATURE_REQ_TYPE_E    0x02 // Receiver : Endpoint
  31
  32 #define USB_DEV_SET_FEATURE                 0x03
  33 #define USB_DEV_SET_FEATURE_REQ_TYPE_D      0x00 // Receiver : Device
  34 #define USB_DEV_SET_FEATURE_REQ_TYPE_I      0x01 // Receiver : Interface
  35 #define USB_DEV_SET_FEATURE_REQ_TYPE_E      0x02 // Receiver : Endpoint
  36
  37 #define USB_DEV_SET_ADDRESS                 0x05
  38 #define USB_DEV_SET_ADDRESS_REQ_TYPE        0x00
  39
  40 #define USB_DEV_GET_DESCRIPTOR              0x06
  41 #define USB_DEV_GET_DESCRIPTOR_REQ_TYPE     0x80
  42
  43 #define USB_DEV_SET_DESCRIPTOR              0x07
  44 #define USB_DEV_SET_DESCRIPTOR_REQ_TYPE     0x00
  45
  46 #define USB_DEV_GET_CONFIGURATION           0x08
  47 #define USB_DEV_GET_CONFIGURATION_REQ_TYPE  0x80
  48
  49 #define USB_DEV_SET_CONFIGURATION           0x09
  50 #define USB_DEV_SET_CONFIGURATION_REQ_TYPE  0x00
  51
  52 #define USB_DEV_GET_INTERFACE               0x0A
  53 #define USB_DEV_GET_INTERFACE_REQ_TYPE      0x81
  54
  55 #define USB_DEV_SET_INTERFACE               0x0B
  56 #define USB_DEV_SET_INTERFACE_REQ_TYPE      0x01
  57
  58 #define USB_DEV_SYNCH_FRAME                 0x0C
  59 #define USB_DEV_SYNCH_FRAME_REQ_TYPE        0x82
  60
  61
  62 //
  63 // USB standard descriptors and reqeust
  64 //
  65 #pragma pack(1)
  66 typedef struct {
  67   UINT8           RequestType;
  68   UINT8           Request;
  69   UINT16          Value;
  70   UINT16          Index;
  71   UINT16          Length;
  72 } USB_DEVICE_REQUEST;
  73
  74 typedef struct {
  75   UINT8           Length;
  76   UINT8           DescriptorType;
  77   UINT16          BcdUSB;
  78   UINT8           DeviceClass;
  79   UINT8           DeviceSubClass;
  80   UINT8           DeviceProtocol;
  81   UINT8           MaxPacketSize0;
  82   UINT16          IdVendor;
  83   UINT16          IdProduct;
  84   UINT16          BcdDevice;
  85   UINT8           StrManufacturer;
  86   UINT8           StrProduct;
  87   UINT8           StrSerialNumber;
  88   UINT8           NumConfigurations;
  89 } USB_DEVICE_DESCRIPTOR;
  90
  91 typedef struct {
  92   UINT8           Length;
  93   UINT8           DescriptorType;
  94   UINT16          TotalLength;
  95   UINT8           NumInterfaces;
  96   UINT8           ConfigurationValue;
  97   UINT8           Configuration;
  98   UINT8           Attributes;
  99   UINT8           MaxPower;
 100 } USB_CONFIG_DESCRIPTOR;
 101
 102 typedef struct {
 103   UINT8           Length;
 104   UINT8           DescriptorType;
 105   UINT8           InterfaceNumber;
 106   UINT8           AlternateSetting;
 107   UINT8           NumEndpoints;
 108   UINT8           InterfaceClass;
 109   UINT8           InterfaceSubClass;
 110   UINT8           InterfaceProtocol;
 111   UINT8           Interface;
 112 } USB_INTERFACE_DESCRIPTOR;
 113
 114 typedef struct {
 115   UINT8           Length;
 116   UINT8           DescriptorType;
 117   UINT8           EndpointAddress;
 118   UINT8           Attributes;
 119   UINT16          MaxPacketSize;
 120   UINT8           Interval;
 121 } USB_ENDPOINT_DESCRIPTOR;
 122
 123 typedef struct {
 124   UINT8           Length;
 125   UINT8           DescriptorType;
 126   CHAR16          String[1];
 127 } EFI_USB_STRING_DESCRIPTOR;
 128
 129 #pragma pack()
 130
 131
 132 typedef enum {
 133   //
 134   // USB request type
 135   //
 136   USB_REQ_TYPE_STANDARD   = (0x00 << 5),
 137   USB_REQ_TYPE_CLASS      = (0x01 << 5),
 138   USB_REQ_TYPE_VENDOR     = (0x02 << 5),
 139
 140   //
 141   // Standard control transfer request type, or the value
 142   // to fill in EFI_USB_DEVICE_REQUEST.Request
 143   //
 144   USB_REQ_GET_STATUS      = 0x00,
 145   USB_REQ_CLEAR_FEATURE   = 0x01,
 146   USB_REQ_SET_FEATURE     = 0x03,
 147   USB_REQ_SET_ADDRESS     = 0x05,
 148   USB_REQ_GET_DESCRIPTOR  = 0x06,
 149   USB_REQ_SET_DESCRIPTOR  = 0x07,
 150   USB_REQ_GET_CONFIG      = 0x08,
 151   USB_REQ_SET_CONFIG      = 0x09,
 152   USB_REQ_GET_INTERFACE   = 0x0A,
 153   USB_REQ_SET_INTERFACE   = 0x0B,
 154   USB_REQ_SYNCH_FRAME     = 0x0C,
 155
 156   //
 157   // Usb control transfer target
 158   //
 159   USB_TARGET_DEVICE       = 0,
 160   USB_TARGET_INTERFACE    = 0x01,
 161   USB_TARGET_ENDPOINT     = 0x02,
 162   USB_TARGET_OTHER        = 0x03,
 163
 164   //
 165   // USB Descriptor types
 166   //
 167   USB_DESC_TYPE_DEVICE    = 0x01,
 168   USB_DESC_TYPE_CONFIG    = 0x02,
 169   USB_DESC_TYPE_STRING    = 0x03,
 170   USB_DESC_TYPE_INTERFACE = 0x04,
 171   USB_DESC_TYPE_ENDPOINT  = 0x05,
 172   USB_DESC_TYPE_HID       = 0x21,
 173   USB_DESC_TYPE_REPORT    = 0x22,
 174
 175   //
 176   // Features to be cleared by CLEAR_FEATURE requests
 177   //
 178   USB_FEATURE_ENDPOINT_HALT = 0,
 179
 180   //
 181   // USB endpoint types: 00: control, 01: isochronous, 10: bulk, 11: interrupt
 182   //
 183   USB_ENDPOINT_CONTROL    = 0x00,
 184   USB_ENDPOINT_ISO        = 0x01,
 185   USB_ENDPOINT_BULK       = 0x02,
 186   USB_ENDPOINT_INTERRUPT  = 0x03,
 187
 188   USB_ENDPOINT_TYPE_MASK  = 0x03,
 189   USB_ENDPOINT_DIR_IN     = 0x80,
 190
 191   //
 192   //Use 200 ms to increase the error handling response time
 193   //
 194   EFI_USB_INTERRUPT_DELAY = 2000000
 195 } USB_TYPES_DEFINITION;
 196
 197
 198 //
 199 // HID constants definition, see HID rev1.0
 200 //
 201
 202 //
 203 // HID standard GET_DESCRIPTOR request.
 204 //
 205 #define USB_HID_GET_DESCRIPTOR_REQ_TYPE  0x81
 206
 207 //
 208 // HID specific requests.
 209 //
 210 #define USB_HID_CLASS_GET_REQ_TYPE       0xa1
 211 #define USB_HID_CLASS_SET_REQ_TYPE       0x21
 212
 213 //
 214 // HID report item format
 215 //
 216 #define HID_ITEM_FORMAT_SHORT 0
 217 #define HID_ITEM_FORMAT_LONG  1
 218
 219 //
 220 // Special tag indicating long items
 221 //
 222 #define HID_ITEM_TAG_LONG 15
 223
 224 //
 225 // HID report descriptor item type (prefix bit 2,3)
 226 //
 227 #define HID_ITEM_TYPE_MAIN      0
 228 #define HID_ITEM_TYPE_GLOBAL    1
 229 #define HID_ITEM_TYPE_LOCAL     2
 230 #define HID_ITEM_TYPE_RESERVED  3
 231
 232 //
 233 // HID report descriptor main item tags
 234 //
 235 #define HID_MAIN_ITEM_TAG_INPUT             8
 236 #define HID_MAIN_ITEM_TAG_OUTPUT            9
 237 #define HID_MAIN_ITEM_TAG_FEATURE           11
 238 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION  10
 239 #define HID_MAIN_ITEM_TAG_END_COLLECTION    12
 240
 241 //
 242 // HID report descriptor main item contents
 243 //
 244 #define HID_MAIN_ITEM_CONSTANT      0x001
 245 #define HID_MAIN_ITEM_VARIABLE      0x002
 246 #define HID_MAIN_ITEM_RELATIVE      0x004
 247 #define HID_MAIN_ITEM_WRAP          0x008
 248 #define HID_MAIN_ITEM_NONLINEAR     0x010
 249 #define HID_MAIN_ITEM_NO_PREFERRED  0x020
 250 #define HID_MAIN_ITEM_NULL_STATE    0x040
 251 #define HID_MAIN_ITEM_VOLATILE      0x080
 252 #define HID_MAIN_ITEM_BUFFERED_BYTE 0x100
 253
 254 //
 255 // HID report descriptor collection item types
 256 //
 257 #define HID_COLLECTION_PHYSICAL     0
 258 #define HID_COLLECTION_APPLICATION  1
 259 #define HID_COLLECTION_LOGICAL      2
 260
 261 //
 262 // HID report descriptor global item tags
 263 //
 264 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE        0
 265 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM   1
 266 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM   2
 267 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM  3
 268 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM  4
 269 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT     5
 270 #define HID_GLOBAL_ITEM_TAG_UNIT              6
 271 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE       7
 272 #define HID_GLOBAL_ITEM_TAG_REPORT_ID         8
 273 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT      9
 274 #define HID_GLOBAL_ITEM_TAG_PUSH              10
 275 #define HID_GLOBAL_ITEM_TAG_POP               11
 276
 277 //
 278 // HID report descriptor local item tags
 279 //
 280 #define HID_LOCAL_ITEM_TAG_USAGE              0
 281 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM      1
 282 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM      2
 283 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX   3
 284 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM 4
 285 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM 5
 286 #define HID_LOCAL_ITEM_TAG_STRING_INDEX       7
 287 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM     8
 288 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM     9
 289 #define HID_LOCAL_ITEM_TAG_DELIMITER          10
 290
 291 //
 292 // HID report types
 293 //
 294 #define HID_INPUT_REPORT    1
 295 #define HID_OUTPUT_REPORT   2
 296 #define HID_FEATURE_REPORT  3
 297
 298 //
 299 // HID class protocol request
 300 //
 301 #define EFI_USB_GET_REPORT_REQUEST    0x01
 302 #define EFI_USB_GET_IDLE_REQUEST      0x02
 303 #define EFI_USB_GET_PROTOCOL_REQUEST  0x03
 304 #define EFI_USB_SET_REPORT_REQUEST    0x09
 305 #define EFI_USB_SET_IDLE_REQUEST      0x0a
 306 #define EFI_USB_SET_PROTOCOL_REQUEST  0x0b
 307
 308 #pragma pack(1)
 309 ///
 310 /// Descriptor header for Report/Physical Descriptors
 311 ///
 312 typedef struct hid_class_descriptor {
 313   UINT8   DescriptorType;
 314   UINT16  DescriptorLength;
 315 } EFI_USB_HID_CLASS_DESCRIPTOR;
 316
 317 typedef struct hid_descriptor {
 318   UINT8                         Length;
 319   UINT8                         DescriptorType;
 320   UINT16                        BcdHID;
 321   UINT8                         CountryCode;
 322   UINT8                         NumDescriptors;
 323   EFI_USB_HID_CLASS_DESCRIPTOR  HidClassDesc[1];
 324 } EFI_USB_HID_DESCRIPTOR;
 325
 326 #pragma pack()
 327
 328 #endif