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