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