usb.h revision 239214
1/* $FreeBSD: head/sys/dev/usb/usb.h 239214 2012-08-12 17:53:06Z hselasky $ */ 2/*- 3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved. 5 * Copyright (c) 1998 Lennart Augustsson. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29/* 30 * This file contains standard definitions for the following USB 31 * protocol versions: 32 * 33 * USB v1.0 34 * USB v1.1 35 * USB v2.0 36 * USB v3.0 37 */ 38 39#ifndef _USB_STANDARD_H_ 40#define _USB_STANDARD_H_ 41 42#if defined(_KERNEL) 43#include "opt_usb.h" 44 45/* Declare parent SYSCTL USB node. */ 46#ifdef SYSCTL_DECL 47SYSCTL_DECL(_hw_usb); 48#endif 49 50#include <sys/malloc.h> 51 52MALLOC_DECLARE(M_USB); 53MALLOC_DECLARE(M_USBDEV); 54MALLOC_DECLARE(M_USBHC); 55#endif /* _KERNEL */ 56 57#include <dev/usb/usb_endian.h> 58#include <dev/usb/usb_freebsd.h> 59 60#define USB_STACK_VERSION 2000 /* 2.0 */ 61 62/* Definition of some hardcoded USB constants. */ 63 64#define USB_MAX_IPACKET 8 /* initial USB packet size */ 65#define USB_EP_MAX (2*16) /* hardcoded */ 66#define USB_ROOT_HUB_ADDR 1 /* index */ 67#define USB_MIN_DEVICES 2 /* unused + root HUB */ 68#define USB_UNCONFIG_INDEX 0xFF /* internal use only */ 69#define USB_IFACE_INDEX_ANY 0xFF /* internal use only */ 70#define USB_START_ADDR 0 /* default USB device BUS address 71 * after USB bus reset */ 72#define USB_CONTROL_ENDPOINT 0 /* default control endpoint */ 73 74#define USB_FRAMES_PER_SECOND_FS 1000 /* full speed */ 75#define USB_FRAMES_PER_SECOND_HS 8000 /* high speed */ 76 77#define USB_FS_BYTES_PER_HS_UFRAME 188 /* bytes */ 78#define USB_HS_MICRO_FRAMES_MAX 8 /* units */ 79 80#define USB_ISOC_TIME_MAX 128 /* ms */ 81 82/* 83 * Minimum time a device needs to be powered down to go through a 84 * power cycle. These values are not in the USB specification. 85 */ 86#define USB_POWER_DOWN_TIME 200 /* ms */ 87#define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 88 89/* Definition of software USB power modes */ 90#define USB_POWER_MODE_OFF 0 /* turn off device */ 91#define USB_POWER_MODE_ON 1 /* always on */ 92#define USB_POWER_MODE_SAVE 2 /* automatic suspend and resume */ 93#define USB_POWER_MODE_SUSPEND 3 /* force suspend */ 94#define USB_POWER_MODE_RESUME 4 /* force resume */ 95 96#if 0 97/* These are the values from the USB specification. */ 98#define USB_PORT_RESET_DELAY 10 /* ms */ 99#define USB_PORT_ROOT_RESET_DELAY 50 /* ms */ 100#define USB_PORT_RESET_RECOVERY 10 /* ms */ 101#define USB_PORT_POWERUP_DELAY 100 /* ms */ 102#define USB_PORT_RESUME_DELAY 20 /* ms */ 103#define USB_SET_ADDRESS_SETTLE 2 /* ms */ 104#define USB_RESUME_DELAY (20*5) /* ms */ 105#define USB_RESUME_WAIT 10 /* ms */ 106#define USB_RESUME_RECOVERY 10 /* ms */ 107#define USB_EXTRA_POWER_UP_TIME 0 /* ms */ 108#else 109/* Allow for marginal and non-conforming devices. */ 110#define USB_PORT_RESET_DELAY 50 /* ms */ 111#define USB_PORT_ROOT_RESET_DELAY 250 /* ms */ 112#define USB_PORT_RESET_RECOVERY 250 /* ms */ 113#define USB_PORT_POWERUP_DELAY 300 /* ms */ 114#define USB_PORT_RESUME_DELAY (20*2) /* ms */ 115#define USB_SET_ADDRESS_SETTLE 10 /* ms */ 116#define USB_RESUME_DELAY (50*5) /* ms */ 117#define USB_RESUME_WAIT 50 /* ms */ 118#define USB_RESUME_RECOVERY 50 /* ms */ 119#define USB_EXTRA_POWER_UP_TIME 20 /* ms */ 120#endif 121 122#define USB_MIN_POWER 100 /* mA */ 123#define USB_MAX_POWER 500 /* mA */ 124 125#define USB_BUS_RESET_DELAY 100 /* ms */ 126 127/* 128 * USB record layout in memory: 129 * 130 * - USB config 0 131 * - USB interfaces 132 * - USB alternative interfaces 133 * - USB endpoints 134 * 135 * - USB config 1 136 * - USB interfaces 137 * - USB alternative interfaces 138 * - USB endpoints 139 */ 140 141/* Declaration of USB records */ 142 143struct usb_device_request { 144 uByte bmRequestType; 145 uByte bRequest; 146 uWord wValue; 147 uWord wIndex; 148 uWord wLength; 149} __packed; 150typedef struct usb_device_request usb_device_request_t; 151 152#define UT_WRITE 0x00 153#define UT_READ 0x80 154#define UT_STANDARD 0x00 155#define UT_CLASS 0x20 156#define UT_VENDOR 0x40 157#define UT_DEVICE 0x00 158#define UT_INTERFACE 0x01 159#define UT_ENDPOINT 0x02 160#define UT_OTHER 0x03 161 162#define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE) 163#define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE) 164#define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT) 165#define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE) 166#define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE) 167#define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT) 168#define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE) 169#define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE) 170#define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER) 171#define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT) 172#define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE) 173#define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE) 174#define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER) 175#define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT) 176#define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE) 177#define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE) 178#define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER) 179#define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT) 180#define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE) 181#define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE) 182#define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER) 183#define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT) 184 185/* Requests */ 186#define UR_GET_STATUS 0x00 187#define UR_CLEAR_FEATURE 0x01 188#define UR_SET_FEATURE 0x03 189#define UR_SET_ADDRESS 0x05 190#define UR_GET_DESCRIPTOR 0x06 191#define UDESC_DEVICE 0x01 192#define UDESC_CONFIG 0x02 193#define UDESC_STRING 0x03 194#define USB_LANGUAGE_TABLE 0x00 /* language ID string index */ 195#define UDESC_INTERFACE 0x04 196#define UDESC_ENDPOINT 0x05 197#define UDESC_DEVICE_QUALIFIER 0x06 198#define UDESC_OTHER_SPEED_CONFIGURATION 0x07 199#define UDESC_INTERFACE_POWER 0x08 200#define UDESC_OTG 0x09 201#define UDESC_DEBUG 0x0A 202#define UDESC_IFACE_ASSOC 0x0B /* interface association */ 203#define UDESC_BOS 0x0F /* binary object store */ 204#define UDESC_DEVICE_CAPABILITY 0x10 205#define UDESC_CS_DEVICE 0x21 /* class specific */ 206#define UDESC_CS_CONFIG 0x22 207#define UDESC_CS_STRING 0x23 208#define UDESC_CS_INTERFACE 0x24 209#define UDESC_CS_ENDPOINT 0x25 210#define UDESC_HUB 0x29 211#define UDESC_SS_HUB 0x2A /* super speed */ 212#define UDESC_ENDPOINT_SS_COMP 0x30 /* super speed */ 213#define UR_SET_DESCRIPTOR 0x07 214#define UR_GET_CONFIG 0x08 215#define UR_SET_CONFIG 0x09 216#define UR_GET_INTERFACE 0x0a 217#define UR_SET_INTERFACE 0x0b 218#define UR_SYNCH_FRAME 0x0c 219#define UR_SET_SEL 0x30 220#define UR_ISOCH_DELAY 0x31 221 222/* HUB specific request */ 223#define UR_GET_BUS_STATE 0x02 224#define UR_CLEAR_TT_BUFFER 0x08 225#define UR_RESET_TT 0x09 226#define UR_GET_TT_STATE 0x0a 227#define UR_STOP_TT 0x0b 228#define UR_SET_AND_TEST 0x0c /* USB 2.0 only */ 229#define UR_SET_HUB_DEPTH 0x0c /* USB 3.0 only */ 230#define USB_SS_HUB_DEPTH_MAX 5 231#define UR_GET_PORT_ERR_COUNT 0x0d 232 233/* Feature numbers */ 234#define UF_ENDPOINT_HALT 0 235#define UF_DEVICE_REMOTE_WAKEUP 1 236#define UF_TEST_MODE 2 237#define UF_U1_ENABLE 0x30 238#define UF_U2_ENABLE 0x31 239#define UF_LTM_ENABLE 0x32 240 241/* HUB specific features */ 242#define UHF_C_HUB_LOCAL_POWER 0 243#define UHF_C_HUB_OVER_CURRENT 1 244#define UHF_PORT_CONNECTION 0 245#define UHF_PORT_ENABLE 1 246#define UHF_PORT_SUSPEND 2 247#define UHF_PORT_OVER_CURRENT 3 248#define UHF_PORT_RESET 4 249#define UHF_PORT_LINK_STATE 5 250#define UHF_PORT_POWER 8 251#define UHF_PORT_LOW_SPEED 9 252#define UHF_PORT_L1 10 253#define UHF_C_PORT_CONNECTION 16 254#define UHF_C_PORT_ENABLE 17 255#define UHF_C_PORT_SUSPEND 18 256#define UHF_C_PORT_OVER_CURRENT 19 257#define UHF_C_PORT_RESET 20 258#define UHF_PORT_TEST 21 259#define UHF_PORT_INDICATOR 22 260#define UHF_C_PORT_L1 23 261 262/* SuperSpeed HUB specific features */ 263#define UHF_PORT_U1_TIMEOUT 23 264#define UHF_PORT_U2_TIMEOUT 24 265#define UHF_C_PORT_LINK_STATE 25 266#define UHF_C_PORT_CONFIG_ERROR 26 267#define UHF_PORT_REMOTE_WAKE_MASK 27 268#define UHF_BH_PORT_RESET 28 269#define UHF_C_BH_PORT_RESET 29 270#define UHF_FORCE_LINKPM_ACCEPT 30 271 272struct usb_descriptor { 273 uByte bLength; 274 uByte bDescriptorType; 275 uByte bDescriptorSubtype; 276} __packed; 277typedef struct usb_descriptor usb_descriptor_t; 278 279struct usb_device_descriptor { 280 uByte bLength; 281 uByte bDescriptorType; 282 uWord bcdUSB; 283#define UD_USB_2_0 0x0200 284#define UD_USB_3_0 0x0300 285#define UD_IS_USB2(d) ((d)->bcdUSB[1] == 0x02) 286#define UD_IS_USB3(d) ((d)->bcdUSB[1] == 0x03) 287 uByte bDeviceClass; 288 uByte bDeviceSubClass; 289 uByte bDeviceProtocol; 290 uByte bMaxPacketSize; 291 /* The fields below are not part of the initial descriptor. */ 292 uWord idVendor; 293 uWord idProduct; 294 uWord bcdDevice; 295 uByte iManufacturer; 296 uByte iProduct; 297 uByte iSerialNumber; 298 uByte bNumConfigurations; 299} __packed; 300typedef struct usb_device_descriptor usb_device_descriptor_t; 301 302/* Binary Device Object Store (BOS) */ 303struct usb_bos_descriptor { 304 uByte bLength; 305 uByte bDescriptorType; 306 uWord wTotalLength; 307 uByte bNumDeviceCaps; 308} __packed; 309typedef struct usb_bos_descriptor usb_bos_descriptor_t; 310 311/* Binary Device Object Store Capability */ 312struct usb_bos_cap_descriptor { 313 uByte bLength; 314 uByte bDescriptorType; 315 uByte bDevCapabilityType; 316#define USB_DEVCAP_RESERVED 0x00 317#define USB_DEVCAP_WUSB 0x01 318#define USB_DEVCAP_USB2EXT 0x02 319#define USB_DEVCAP_SUPER_SPEED 0x03 320#define USB_DEVCAP_CONTAINER_ID 0x04 321 /* data ... */ 322} __packed; 323typedef struct usb_bos_cap_descriptor usb_bos_cap_descriptor_t; 324 325struct usb_devcap_usb2ext_descriptor { 326 uByte bLength; 327 uByte bDescriptorType; 328 uByte bDevCapabilityType; 329 uDWord bmAttributes; 330#define USB_V2EXT_LPM (1U << 1) 331#define USB_V2EXT_BESL_SUPPORTED (1U << 2) 332#define USB_V2EXT_BESL_BASELINE_VALID (1U << 3) 333#define USB_V2EXT_BESL_DEEP_VALID (1U << 4) 334#define USB_V2EXT_BESL_BASELINE_GET(x) (((x) >> 8) & 0xF) 335#define USB_V2EXT_BESL_DEEP_GET(x) (((x) >> 12) & 0xF) 336} __packed; 337typedef struct usb_devcap_usb2ext_descriptor usb_devcap_usb2ext_descriptor_t; 338 339struct usb_devcap_ss_descriptor { 340 uByte bLength; 341 uByte bDescriptorType; 342 uByte bDevCapabilityType; 343 uByte bmAttributes; 344 uWord wSpeedsSupported; 345 uByte bFunctionalitySupport; 346 uByte bU1DevExitLat; 347 uWord wU2DevExitLat; 348} __packed; 349typedef struct usb_devcap_ss_descriptor usb_devcap_ss_descriptor_t; 350 351struct usb_devcap_container_id_descriptor { 352 uByte bLength; 353 uByte bDescriptorType; 354 uByte bDevCapabilityType; 355 uByte bReserved; 356 uByte bContainerID; 357} __packed; 358typedef struct usb_devcap_container_id_descriptor 359 usb_devcap_container_id_descriptor_t; 360 361/* Device class codes */ 362#define UDCLASS_IN_INTERFACE 0x00 363#define UDCLASS_COMM 0x02 364#define UDCLASS_HUB 0x09 365#define UDSUBCLASS_HUB 0x00 366#define UDPROTO_FSHUB 0x00 367#define UDPROTO_HSHUBSTT 0x01 368#define UDPROTO_HSHUBMTT 0x02 369#define UDPROTO_SSHUB 0x03 370#define UDCLASS_DIAGNOSTIC 0xdc 371#define UDCLASS_WIRELESS 0xe0 372#define UDSUBCLASS_RF 0x01 373#define UDPROTO_BLUETOOTH 0x01 374#define UDCLASS_VENDOR 0xff 375 376struct usb_config_descriptor { 377 uByte bLength; 378 uByte bDescriptorType; 379 uWord wTotalLength; 380 uByte bNumInterface; 381 uByte bConfigurationValue; 382#define USB_UNCONFIG_NO 0 383 uByte iConfiguration; 384 uByte bmAttributes; 385#define UC_BUS_POWERED 0x80 386#define UC_SELF_POWERED 0x40 387#define UC_REMOTE_WAKEUP 0x20 388 uByte bMaxPower; /* max current in 2 mA units */ 389#define UC_POWER_FACTOR 2 390} __packed; 391typedef struct usb_config_descriptor usb_config_descriptor_t; 392 393struct usb_interface_descriptor { 394 uByte bLength; 395 uByte bDescriptorType; 396 uByte bInterfaceNumber; 397 uByte bAlternateSetting; 398 uByte bNumEndpoints; 399 uByte bInterfaceClass; 400 uByte bInterfaceSubClass; 401 uByte bInterfaceProtocol; 402 uByte iInterface; 403} __packed; 404typedef struct usb_interface_descriptor usb_interface_descriptor_t; 405 406struct usb_interface_assoc_descriptor { 407 uByte bLength; 408 uByte bDescriptorType; 409 uByte bFirstInterface; 410 uByte bInterfaceCount; 411 uByte bFunctionClass; 412 uByte bFunctionSubClass; 413 uByte bFunctionProtocol; 414 uByte iFunction; 415} __packed; 416typedef struct usb_interface_assoc_descriptor usb_interface_assoc_descriptor_t; 417 418/* Interface class codes */ 419#define UICLASS_UNSPEC 0x00 420#define UICLASS_AUDIO 0x01 /* audio */ 421#define UISUBCLASS_AUDIOCONTROL 1 422#define UISUBCLASS_AUDIOSTREAM 2 423#define UISUBCLASS_MIDISTREAM 3 424 425#define UICLASS_CDC 0x02 /* communication */ 426#define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1 427#define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2 428#define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3 429#define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4 430#define UISUBCLASS_CAPI_CONTROLMODEL 5 431#define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6 432#define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7 433#define UISUBCLASS_WIRELESS_HANDSET_CM 8 434#define UISUBCLASS_DEVICE_MGMT 9 435#define UISUBCLASS_MOBILE_DIRECT_LINE_MODEL 10 436#define UISUBCLASS_OBEX 11 437#define UISUBCLASS_ETHERNET_EMULATION_MODEL 12 438#define UISUBCLASS_NETWORK_CONTROL_MODEL 13 439 440#define UIPROTO_CDC_AT 1 441 442#define UICLASS_HID 0x03 443#define UISUBCLASS_BOOT 1 444#define UIPROTO_BOOT_KEYBOARD 1 445#define UIPROTO_MOUSE 2 446 447#define UICLASS_PHYSICAL 0x05 448#define UICLASS_IMAGE 0x06 449#define UISUBCLASS_SIC 1 /* still image class */ 450#define UICLASS_PRINTER 0x07 451#define UISUBCLASS_PRINTER 1 452#define UIPROTO_PRINTER_UNI 1 453#define UIPROTO_PRINTER_BI 2 454#define UIPROTO_PRINTER_1284 3 455 456#define UICLASS_MASS 0x08 457#define UISUBCLASS_RBC 1 458#define UISUBCLASS_SFF8020I 2 459#define UISUBCLASS_QIC157 3 460#define UISUBCLASS_UFI 4 461#define UISUBCLASS_SFF8070I 5 462#define UISUBCLASS_SCSI 6 463#define UIPROTO_MASS_CBI_I 0 464#define UIPROTO_MASS_CBI 1 465#define UIPROTO_MASS_BBB_OLD 2 /* Not in the spec anymore */ 466#define UIPROTO_MASS_BBB 80 /* 'P' for the Iomega Zip drive */ 467 468#define UICLASS_HUB 0x09 469#define UISUBCLASS_HUB 0 470#define UIPROTO_FSHUB 0 471#define UIPROTO_HSHUBSTT 0 /* Yes, same as previous */ 472#define UIPROTO_HSHUBMTT 1 473 474#define UICLASS_CDC_DATA 0x0a 475#define UISUBCLASS_DATA 0x00 476#define UIPROTO_DATA_ISDNBRI 0x30 /* Physical iface */ 477#define UIPROTO_DATA_HDLC 0x31 /* HDLC */ 478#define UIPROTO_DATA_TRANSPARENT 0x32 /* Transparent */ 479#define UIPROTO_DATA_Q921M 0x50 /* Management for Q921 */ 480#define UIPROTO_DATA_Q921 0x51 /* Data for Q921 */ 481#define UIPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */ 482#define UIPROTO_DATA_V42BIS 0x90 /* Data compression */ 483#define UIPROTO_DATA_Q931 0x91 /* Euro-ISDN */ 484#define UIPROTO_DATA_V120 0x92 /* V.24 rate adaption */ 485#define UIPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */ 486#define UIPROTO_DATA_HOST_BASED 0xfd /* Host based driver */ 487#define UIPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc. */ 488#define UIPROTO_DATA_VENDOR 0xff /* Vendor specific */ 489#define UIPROTO_DATA_NCM 0x01 /* Network Control Model */ 490 491#define UICLASS_SMARTCARD 0x0b 492#define UICLASS_FIRM_UPD 0x0c 493#define UICLASS_SECURITY 0x0d 494#define UICLASS_DIAGNOSTIC 0xdc 495#define UICLASS_WIRELESS 0xe0 496#define UISUBCLASS_RF 0x01 497#define UIPROTO_BLUETOOTH 0x01 498 499#define UICLASS_IAD 0xEF /* Interface Association Descriptor */ 500 501#define UICLASS_APPL_SPEC 0xfe 502#define UISUBCLASS_FIRMWARE_DOWNLOAD 1 503#define UISUBCLASS_IRDA 2 504#define UIPROTO_IRDA 0 505 506#define UICLASS_VENDOR 0xff 507#define UISUBCLASS_XBOX360_CONTROLLER 0x5d 508#define UIPROTO_XBOX360_GAMEPAD 0x01 509 510struct usb_endpoint_descriptor { 511 uByte bLength; 512 uByte bDescriptorType; 513 uByte bEndpointAddress; 514#define UE_GET_DIR(a) ((a) & 0x80) 515#define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7)) 516#define UE_DIR_IN 0x80 /* IN-token endpoint, fixed */ 517#define UE_DIR_OUT 0x00 /* OUT-token endpoint, fixed */ 518#define UE_DIR_RX 0xfd /* for internal use only! */ 519#define UE_DIR_TX 0xfe /* for internal use only! */ 520#define UE_DIR_ANY 0xff /* for internal use only! */ 521#define UE_ADDR 0x0f 522#define UE_ADDR_ANY 0xff /* for internal use only! */ 523#define UE_GET_ADDR(a) ((a) & UE_ADDR) 524 uByte bmAttributes; 525#define UE_XFERTYPE 0x03 526#define UE_CONTROL 0x00 527#define UE_ISOCHRONOUS 0x01 528#define UE_BULK 0x02 529#define UE_INTERRUPT 0x03 530#define UE_BULK_INTR 0xfe /* for internal use only! */ 531#define UE_TYPE_ANY 0xff /* for internal use only! */ 532#define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE) 533#define UE_ISO_TYPE 0x0c 534#define UE_ISO_ASYNC 0x04 535#define UE_ISO_ADAPT 0x08 536#define UE_ISO_SYNC 0x0c 537#define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE) 538 uWord wMaxPacketSize; 539#define UE_ZERO_MPS 0xFFFF /* for internal use only */ 540 uByte bInterval; 541} __packed; 542typedef struct usb_endpoint_descriptor usb_endpoint_descriptor_t; 543 544struct usb_endpoint_ss_comp_descriptor { 545 uByte bLength; 546 uByte bDescriptorType; 547 uByte bMaxBurst; 548 uByte bmAttributes; 549#define UE_GET_BULK_STREAMS(x) ((x) & 0x0F) 550#define UE_GET_SS_ISO_MULT(x) ((x) & 0x03) 551 uWord wBytesPerInterval; 552} __packed; 553typedef struct usb_endpoint_ss_comp_descriptor 554 usb_endpoint_ss_comp_descriptor_t; 555 556struct usb_string_descriptor { 557 uByte bLength; 558 uByte bDescriptorType; 559 uWord bString[126]; 560 uByte bUnused; 561} __packed; 562typedef struct usb_string_descriptor usb_string_descriptor_t; 563 564#define USB_MAKE_STRING_DESC(m,name) \ 565struct name { \ 566 uByte bLength; \ 567 uByte bDescriptorType; \ 568 uByte bData[sizeof((uint8_t []){m})]; \ 569} __packed; \ 570static const struct name name = { \ 571 .bLength = sizeof(struct name), \ 572 .bDescriptorType = UDESC_STRING, \ 573 .bData = { m }, \ 574} 575 576struct usb_hub_descriptor { 577 uByte bDescLength; 578 uByte bDescriptorType; 579 uByte bNbrPorts; 580 uWord wHubCharacteristics; 581#define UHD_PWR 0x0003 582#define UHD_PWR_GANGED 0x0000 583#define UHD_PWR_INDIVIDUAL 0x0001 584#define UHD_PWR_NO_SWITCH 0x0002 585#define UHD_COMPOUND 0x0004 586#define UHD_OC 0x0018 587#define UHD_OC_GLOBAL 0x0000 588#define UHD_OC_INDIVIDUAL 0x0008 589#define UHD_OC_NONE 0x0010 590#define UHD_TT_THINK 0x0060 591#define UHD_TT_THINK_8 0x0000 592#define UHD_TT_THINK_16 0x0020 593#define UHD_TT_THINK_24 0x0040 594#define UHD_TT_THINK_32 0x0060 595#define UHD_PORT_IND 0x0080 596 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 597#define UHD_PWRON_FACTOR 2 598 uByte bHubContrCurrent; 599 uByte DeviceRemovable[32]; /* max 255 ports */ 600#define UHD_NOT_REMOV(desc, i) \ 601 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) 602 uByte PortPowerCtrlMask[1]; /* deprecated */ 603} __packed; 604typedef struct usb_hub_descriptor usb_hub_descriptor_t; 605 606struct usb_hub_ss_descriptor { 607 uByte bLength; 608 uByte bDescriptorType; 609 uByte bNbrPorts; 610 uWord wHubCharacteristics; 611 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 612 uByte bHubContrCurrent; 613 uByte bHubHdrDecLat; 614 uWord wHubDelay; 615 uByte DeviceRemovable[32]; /* max 255 ports */ 616} __packed; 617typedef struct usb_hub_ss_descriptor usb_hub_ss_descriptor_t; 618 619/* minimum HUB descriptor (8-ports maximum) */ 620struct usb_hub_descriptor_min { 621 uByte bDescLength; 622 uByte bDescriptorType; 623 uByte bNbrPorts; 624 uWord wHubCharacteristics; 625 uByte bPwrOn2PwrGood; 626 uByte bHubContrCurrent; 627 uByte DeviceRemovable[1]; 628 uByte PortPowerCtrlMask[1]; 629} __packed; 630typedef struct usb_hub_descriptor_min usb_hub_descriptor_min_t; 631 632struct usb_device_qualifier { 633 uByte bLength; 634 uByte bDescriptorType; 635 uWord bcdUSB; 636 uByte bDeviceClass; 637 uByte bDeviceSubClass; 638 uByte bDeviceProtocol; 639 uByte bMaxPacketSize0; 640 uByte bNumConfigurations; 641 uByte bReserved; 642} __packed; 643typedef struct usb_device_qualifier usb_device_qualifier_t; 644 645struct usb_otg_descriptor { 646 uByte bLength; 647 uByte bDescriptorType; 648 uByte bmAttributes; 649#define UOTG_SRP 0x01 650#define UOTG_HNP 0x02 651} __packed; 652typedef struct usb_otg_descriptor usb_otg_descriptor_t; 653 654/* OTG feature selectors */ 655#define UOTG_B_HNP_ENABLE 3 656#define UOTG_A_HNP_SUPPORT 4 657#define UOTG_A_ALT_HNP_SUPPORT 5 658 659struct usb_status { 660 uWord wStatus; 661/* Device status flags */ 662#define UDS_SELF_POWERED 0x0001 663#define UDS_REMOTE_WAKEUP 0x0002 664/* Endpoint status flags */ 665#define UES_HALT 0x0001 666} __packed; 667typedef struct usb_status usb_status_t; 668 669struct usb_hub_status { 670 uWord wHubStatus; 671#define UHS_LOCAL_POWER 0x0001 672#define UHS_OVER_CURRENT 0x0002 673 uWord wHubChange; 674} __packed; 675typedef struct usb_hub_status usb_hub_status_t; 676 677struct usb_port_status { 678 uWord wPortStatus; 679#define UPS_CURRENT_CONNECT_STATUS 0x0001 680#define UPS_PORT_ENABLED 0x0002 681#define UPS_SUSPEND 0x0004 682#define UPS_OVERCURRENT_INDICATOR 0x0008 683#define UPS_RESET 0x0010 684#define UPS_PORT_L1 0x0020 /* USB 2.0 only */ 685/* The link-state bits are valid for Super-Speed USB HUBs */ 686#define UPS_PORT_LINK_STATE_GET(x) (((x) >> 5) & 0xF) 687#define UPS_PORT_LINK_STATE_SET(x) (((x) & 0xF) << 5) 688#define UPS_PORT_LS_U0 0x00 689#define UPS_PORT_LS_U1 0x01 690#define UPS_PORT_LS_U2 0x02 691#define UPS_PORT_LS_U3 0x03 692#define UPS_PORT_LS_SS_DIS 0x04 693#define UPS_PORT_LS_RX_DET 0x05 694#define UPS_PORT_LS_SS_INA 0x06 695#define UPS_PORT_LS_POLL 0x07 696#define UPS_PORT_LS_RECOVER 0x08 697#define UPS_PORT_LS_HOT_RST 0x09 698#define UPS_PORT_LS_COMP_MODE 0x0A 699#define UPS_PORT_LS_LOOPBACK 0x0B 700#define UPS_PORT_LS_RESUME 0x0F 701#define UPS_PORT_POWER 0x0100 702#define UPS_PORT_POWER_SS 0x0200 /* super-speed only */ 703#define UPS_LOW_SPEED 0x0200 704#define UPS_HIGH_SPEED 0x0400 705#define UPS_OTHER_SPEED 0x0600 /* currently FreeBSD specific */ 706#define UPS_PORT_TEST 0x0800 707#define UPS_PORT_INDICATOR 0x1000 708#define UPS_PORT_MODE_DEVICE 0x8000 /* currently FreeBSD specific */ 709 uWord wPortChange; 710#define UPS_C_CONNECT_STATUS 0x0001 711#define UPS_C_PORT_ENABLED 0x0002 712#define UPS_C_SUSPEND 0x0004 713#define UPS_C_OVERCURRENT_INDICATOR 0x0008 714#define UPS_C_PORT_RESET 0x0010 715#define UPS_C_PORT_L1 0x0020 /* USB 2.0 only */ 716#define UPS_C_BH_PORT_RESET 0x0020 /* USB 3.0 only */ 717#define UPS_C_PORT_LINK_STATE 0x0040 718#define UPS_C_PORT_CONFIG_ERROR 0x0080 719} __packed; 720typedef struct usb_port_status usb_port_status_t; 721 722/* 723 * The "USB_SPEED" macros defines all the supported USB speeds. 724 */ 725enum usb_dev_speed { 726 USB_SPEED_VARIABLE, 727 USB_SPEED_LOW, 728 USB_SPEED_FULL, 729 USB_SPEED_HIGH, 730 USB_SPEED_SUPER, 731}; 732#define USB_SPEED_MAX (USB_SPEED_SUPER+1) 733 734/* 735 * The "USB_REV" macros defines all the supported USB revisions. 736 */ 737enum usb_revision { 738 USB_REV_UNKNOWN, 739 USB_REV_PRE_1_0, 740 USB_REV_1_0, 741 USB_REV_1_1, 742 USB_REV_2_0, 743 USB_REV_2_5, 744 USB_REV_3_0 745}; 746#define USB_REV_MAX (USB_REV_3_0+1) 747 748/* 749 * Supported host controller modes. 750 */ 751enum usb_hc_mode { 752 USB_MODE_HOST, /* initiates transfers */ 753 USB_MODE_DEVICE, /* bus transfer target */ 754 USB_MODE_DUAL /* can be host or device */ 755}; 756#define USB_MODE_MAX (USB_MODE_DUAL+1) 757 758/* 759 * The "USB_STATE" enums define all the supported device states. 760 */ 761enum usb_dev_state { 762 USB_STATE_DETACHED, 763 USB_STATE_ATTACHED, 764 USB_STATE_POWERED, 765 USB_STATE_ADDRESSED, 766 USB_STATE_CONFIGURED, 767}; 768#define USB_STATE_MAX (USB_STATE_CONFIGURED+1) 769 770/* 771 * The "USB_EP_MODE" macros define all the currently supported 772 * endpoint modes. 773 */ 774enum usb_ep_mode { 775 USB_EP_MODE_DEFAULT, 776 USB_EP_MODE_STREAMS, /* USB3.0 specific */ 777 USB_EP_MODE_HW_MASS_STORAGE, 778 USB_EP_MODE_HW_SERIAL, 779 USB_EP_MODE_HW_ETHERNET_CDC, 780 USB_EP_MODE_HW_ETHERNET_NCM, 781 USB_EP_MODE_MAX 782}; 783#endif /* _USB_STANDARD_H_ */ 784