usb.h revision 1.111.2.5
1 /* $NetBSD: usb.h,v 1.111.2.5 2014/12/03 22:40:55 skrll Exp $ */ 2 /* $FreeBSD: src/sys/dev/usb/usb.h,v 1.14 1999/11/17 22:33:46 n_hibma Exp $ */ 3 4 /* 5 * Copyright (c) 1998 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Lennart Augustsson (lennart (at) augustsson.net) at 10 * Carlstedt Research & Technology. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 35 #ifndef _USB_H_ 36 #define _USB_H_ 37 38 #include <sys/types.h> 39 #include <sys/time.h> 40 41 #include <sys/ioctl.h> 42 43 #if defined(_KERNEL) 44 45 #include <sys/device.h> 46 47 #endif 48 49 #ifdef USB_DEBUG 50 #define Static 51 #else 52 #define Static static 53 #endif 54 55 #define USB_STACK_VERSION 2 56 57 #define USB_MAX_DEVICES 128 58 #define USB_MIN_DEVICES 2 /* unused + root HUB */ 59 #define USB_START_ADDR 0 60 61 #define USB_CONTROL_ENDPOINT 0 62 #define USB_MAX_ENDPOINTS 16 63 64 #define USB_FRAMES_PER_SECOND 1000 65 #define USB_UFRAMES_PER_FRAME 8 66 67 /* 68 * The USB records contain some unaligned little-endian word 69 * components. The U[SG]ETW macros take care of both the alignment 70 * and endian problem and should always be used to access non-byte 71 * values. 72 */ 73 typedef uint8_t uByte; 74 typedef uint8_t uWord[2]; 75 typedef uint8_t uDWord[4]; 76 77 #define USETW2(w,h,l) ((w)[0] = (uint8_t)(l), (w)[1] = (uint8_t)(h)) 78 79 #define UGETW(w) ((w)[0] | ((w)[1] << 8)) 80 #define USETW(w,v) ((w)[0] = (uint8_t)(v), (w)[1] = (uint8_t)((v) >> 8)) 81 #define USETWD(val) { (uint8_t)(val), (uint8_t)((val) >> 8) } 82 #define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24)) 83 #define USETDW(w,v) ((w)[0] = (uint8_t)(v), \ 84 (w)[1] = (uint8_t)((v) >> 8), \ 85 (w)[2] = (uint8_t)((v) >> 16), \ 86 (w)[3] = (uint8_t)((v) >> 24)) 87 #define UPACKED __packed 88 89 typedef struct { 90 uByte bmRequestType; 91 uByte bRequest; 92 uWord wValue; 93 uWord wIndex; 94 uWord wLength; 95 } UPACKED usb_device_request_t; 96 97 #define UT_GET_DIR(a) ((a) & 0x80) 98 #define UT_WRITE 0x00 99 #define UT_READ 0x80 100 101 #define UT_GET_TYPE(a) ((a) & 0x60) 102 #define UT_STANDARD 0x00 103 #define UT_CLASS 0x20 104 #define UT_VENDOR 0x40 105 106 #define UT_GET_RECIPIENT(a) ((a) & 0x1f) 107 #define UT_DEVICE 0x00 108 #define UT_INTERFACE 0x01 109 #define UT_ENDPOINT 0x02 110 #define UT_OTHER 0x03 111 112 #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE) 113 #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE) 114 #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT) 115 #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE) 116 #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE) 117 #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT) 118 #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE) 119 #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE) 120 #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER) 121 #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT) 122 #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE) 123 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE) 124 #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER) 125 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT) 126 #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE) 127 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE) 128 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER) 129 #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT) 130 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE) 131 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE) 132 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER) 133 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT) 134 135 /* Standard Requests Codes from the USB 2.0 spec, table 9-4 */ 136 #define UR_GET_STATUS 0x00 137 #define UR_CLEAR_FEATURE 0x01 138 #define UR_SET_FEATURE 0x03 139 #define UR_SET_ADDRESS 0x05 140 #define UR_GET_DESCRIPTOR 0x06 141 #define UDESC_DEVICE 0x01 142 #define UDESC_CONFIG 0x02 143 #define UDESC_STRING 0x03 144 #define UDESC_INTERFACE 0x04 145 #define UDESC_ENDPOINT 0x05 146 #define UDESC_DEVICE_QUALIFIER 0x06 147 #define UDESC_OTHER_SPEED_CONFIGURATION 0x07 148 #define UDESC_INTERFACE_POWER 0x08 149 #define UDESC_OTG 0x09 150 #define UDESC_DEBUG 0x0a 151 #define UDESC_INTERFACE_ASSOC 0x0b 152 #define UDESC_BOS 0x0f 153 #define UDESC_DEVICE_CAPABILITY 0x10 154 #define UDESC_CS_DEVICE 0x21 /* class specific */ 155 #define UDESC_CS_CONFIG 0x22 156 #define UDESC_CS_STRING 0x23 157 #define UDESC_CS_INTERFACE 0x24 158 #define UDESC_CS_ENDPOINT 0x25 159 #define UDESC_HUB 0x29 160 #define UDESC_SS_HUB 0x2a /* super speed */ 161 #define UDESC_ENDPOINT_SS_COMP 0x30 /* super speed */ 162 #define UDESC_ENDPOINT_ISOCH_SSP_COMP 0x31 163 #define UR_SET_DESCRIPTOR 0x07 164 #define UR_GET_CONFIG 0x08 165 #define UR_SET_CONFIG 0x09 166 #define UR_GET_INTERFACE 0x0a 167 #define UR_SET_INTERFACE 0x0b 168 #define UR_SYNCH_FRAME 0x0c 169 #define UR_SET_ENCRYPTION 0x0d 170 #define UR_GET_ENCRYPTION 0x0e 171 #define UR_SET_HANDSHAKE 0x0f 172 #define UR_GET_HANDSHAKE 0x10 173 #define UR_SET_CONNECTION 0x11 174 #define UR_SET_SECURITY_DATA 0x12 175 #define UR_GET_SECURITY_DATA 0x13 176 #define UR_SET_WUSB_DATA 0x14 177 #define UR_LOOPBACK_DATA_WRITE 0x15 178 #define UR_LOOPBACK_DATA_READ 0x16 179 #define UR_SET_INTERFACE_DS 0x17 180 #define UR_SET_SEL 0x30 181 #define UR_SET_ISOCH_DELAY 0x31 182 183 /* 184 * Feature selectors. USB 2.0 spec, table 9-6 and OTG and EH suppliment, 185 * table 6-2 186 */ 187 #define UF_ENDPOINT_HALT 0 188 #define UF_INTERFACE_FUNCTION_SUSPEND 0 189 #define UF_DEVICE_REMOTE_WAKEUP 1 190 #define UF_TEST_MODE 2 191 #define UF_DEVICE_B_HNP_ENABLE 3 192 #define UF_DEVICE_A_HNP_SUPPORT 4 193 #define UF_DEVICE_A_ALT_HNP_SUPPORT 5 194 #define UF_DEVICE_WUSB_DEVICE 6 195 #define UF_U1_ENABLE 0x30 196 #define UF_U2_ENABLE 0x31 197 #define UF_LTM_ENABLE 0x32 198 199 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */ 200 201 #define USB_2_MAX_CTRL_PACKET 64 202 #define USB_2_MAX_BULK_PACKET 512 203 204 #define USB_3_MAX_CTRL_PACKET 512 205 206 typedef struct { 207 uByte bLength; 208 uByte bDescriptorType; 209 } UPACKED usb_descriptor_t; 210 211 typedef struct { 212 uByte bLength; 213 uByte bDescriptorType; 214 uWord bcdUSB; 215 #define UD_USB_2_0 0x0200 216 #define UD_USB_3_0 0x0300 217 #define UD_IS_USB2(d) (UGETW((d)->bcdUSB) >= UD_USB_2_0) 218 #define UD_IS_USB3(d) (UGETW((d)->bcdUSB) >= UD_USB_3_0) 219 uByte bDeviceClass; 220 uByte bDeviceSubClass; 221 uByte bDeviceProtocol; 222 uByte bMaxPacketSize; 223 /* The fields below are not part of the initial descriptor. */ 224 uWord idVendor; 225 uWord idProduct; 226 uWord bcdDevice; 227 uByte iManufacturer; 228 uByte iProduct; 229 uByte iSerialNumber; 230 uByte bNumConfigurations; 231 } UPACKED usb_device_descriptor_t; 232 #define USB_DEVICE_DESCRIPTOR_SIZE 18 233 234 typedef struct { 235 uByte bLength; 236 uByte bDescriptorType; 237 uWord wTotalLength; 238 uByte bNumInterface; 239 uByte bConfigurationValue; 240 uByte iConfiguration; 241 uByte bmAttributes; 242 #define UC_ATTR_MBO 0x80 243 #define UC_SELF_POWERED 0x40 244 #define UC_REMOTE_WAKEUP 0x20 245 uByte bMaxPower; /* max current in 2 mA units */ 246 #define UC_POWER_FACTOR 2 247 } UPACKED usb_config_descriptor_t; 248 #define USB_CONFIG_DESCRIPTOR_SIZE 9 249 250 typedef struct { 251 uByte bLength; 252 uByte bDescriptorType; 253 uByte bInterfaceNumber; 254 uByte bAlternateSetting; 255 uByte bNumEndpoints; 256 uByte bInterfaceClass; 257 uByte bInterfaceSubClass; 258 uByte bInterfaceProtocol; 259 uByte iInterface; 260 } UPACKED usb_interface_descriptor_t; 261 #define USB_INTERFACE_DESCRIPTOR_SIZE 9 262 263 typedef struct { 264 uByte bLength; 265 uByte bDescriptorType; 266 uByte bFirstInterface; 267 uByte bInterfaceCount; 268 uByte bFunctionClass; 269 uByte bFunctionSubClass; 270 uByte bFunctionProtocol; 271 uByte iFunction; 272 } UPACKED usb_interface_assoc_descriptor_t; 273 #define USB_INTERFACE_ASSOC_DESCRIPTOR_SIZE 8 274 275 typedef struct { 276 uByte bLength; 277 uByte bDescriptorType; 278 uByte bEndpointAddress; 279 #define UE_GET_DIR(a) ((a) & 0x80) 280 #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7)) 281 #define UE_DIR_IN 0x80 282 #define UE_DIR_OUT 0x00 283 #define UE_ADDR 0x0f 284 #define UE_GET_ADDR(a) ((a) & UE_ADDR) 285 uByte bmAttributes; 286 #define UE_XFERTYPE 0x03 287 #define UE_CONTROL 0x00 288 #define UE_ISOCHRONOUS 0x01 289 #define UE_BULK 0x02 290 #define UE_INTERRUPT 0x03 291 #define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE) 292 #define UE_ISO_TYPE 0x0c 293 #define UE_ISO_ASYNC 0x04 294 #define UE_ISO_ADAPT 0x08 295 #define UE_ISO_SYNC 0x0c 296 #define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE) 297 uWord wMaxPacketSize; 298 #define UE_GET_TRANS(a) (((a) >> 11) & 0x3) 299 #define UE_GET_SIZE(a) ((a) & 0x7ff) 300 uByte bInterval; 301 } UPACKED usb_endpoint_descriptor_t; 302 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7 303 304 typedef struct { 305 uByte bLength; 306 uByte bDescriptorType; 307 uByte bMaxBurst; 308 uByte bmAttributes; 309 #define UE_SSC_MAXSTREAMS(x) __SHIFTOUT(x, __BITS(4,0)) /* bulk */ 310 #define UE_SSC_MULT(x) __SHIFTOUT(x, __BITS(1,0)) /* isoch */ 311 #define UE_SSC_SSP_ISO(x) __SHIFTOUT(x, __BIT(7)) /* isoch */ 312 /* The fields below are only valid for periodic endpoints */ 313 uWord wBytesPerInterval; 314 } UPACKED usb_endpoint_ss_comp_descriptor_t; 315 #define USB_ENDPOINT_SS_COMP_DESCRIPTOR_SIZE 6 316 317 typedef struct { 318 uByte bLength; 319 uByte bDescriptorType; 320 uWord wTotalLength; 321 uByte bNumDeviceCaps; 322 } UPACKED usb_bos_descriptor_t; 323 #define USB_BOS_DESCRIPTOR_SIZE 5 324 325 typedef struct { 326 uByte bLength; 327 uByte bDescriptorType; 328 uByte bDevCapabilityType; 329 #define USB_DEVCAP_RESERVED 0x00 330 #define USB_DEVCAP_WUSB 0x01 331 #define USB_DEVCAP_USB2EXT 0x02 332 #define USB_DEVCAP_SUPER_SPEED 0x03 333 #define USB_DEVCAP_CONTAINER_ID 0x04 334 #define USB_DEVCAP_PLATFORM 0x05 335 #define USB_DEVCAP_POWER_DELIVERY_CAPABILITY 0x06 336 #define USB_DEVCAP_BATTERY_INFO_CAPABILITY 0x07 337 #define USB_DEVCAP_PD_CONSUMER_PORT_CAPABILITY 0x08 338 #define USB_DEVCAP_PD_PROVIDER_PORT_CAPABILITY 0x09 339 #define USB_DEVCAP_SUPERSPEED_PLUS 0x0a 340 #define USB_DEVCAP_PRECISION_TIME_MEASUREMENT 0x0b 341 #define USB_DEVCAP_WUSB_EXT 0x0c 342 /* data ... */ 343 } UPACKED usb_device_capability_descriptor_t; 344 #define USB_DEVICE_CAPABILITY_DESCRIPTOR_SIZE 3 /* variable length */ 345 346 typedef struct { 347 uByte bLength; 348 uByte bDescriptorType; 349 uByte bDevCapabilityType; 350 uDWord bmAttributes; 351 #define USB_DEVCAP_USB2EXT_LPM __BIT(1) 352 } UPACKED usb_usb2ext_descriptor_t; 353 #define USB_DEVCAP_USB2EXT_DESCRIPTOR_SIZE 7 354 355 typedef struct { 356 uByte bLength; 357 uByte bDescriptorType; 358 uByte bDevCapabilityType; 359 uByte bmAttributes; 360 #define USB_DEVCAP_SS_LTM __BIT(1) 361 uWord wSpeedsSupported; 362 #define USB_DEVCAP_SS_SPEED_SS __BIT(0) 363 #define USB_DEVCAP_SS_SPEED_FS __BIT(1) 364 #define USB_DEVCAP_SS_SPEED_HS __BIT(2) 365 #define USB_DEVCAP_SS_SPEED_LS __BIT(3) 366 uByte bFunctionalitySupport; 367 uByte bU1DevExitLat; 368 uWord wU2DevExitLat; 369 } UPACKED usb_devcap_ss_descriptor_t; 370 #define USB_DEVCAP_SS_DESCRIPTOR_SIZE 10 371 372 typedef struct { 373 uByte bLength; 374 uByte bDescriptorType; 375 uByte bDevCapabilityType; 376 uByte bReserved; 377 uByte ContainerID[16]; 378 } UPACKED usb_devcap_container_id_descriptor_t; 379 #define USB_DEVCAP_CONTAINER_ID_DESCRIPTOR_SIZE 20 380 381 typedef struct { 382 uByte bLength; 383 uByte bDescriptorType; 384 uByte bDevCapabilityType; 385 uByte bReserved; 386 uByte PlatformCapabilityUUID[16]; 387 uByte CapabilityData[0]; 388 } UPACKED usb_devcap_platform_descriptor_t; 389 #define USB_DEVCAP_PLATFORM_DESCRIPTOR_SIZE 20 390 391 typedef struct { 392 uByte bLength; 393 uByte bDescriptorType; 394 uByte bDevCapabilityType; 395 uByte bReserved; 396 uDWord bmAttributes; 397 uWord wFunctionalitySupport; 398 uWord wReserved; 399 uDWord bmSublinkSpeedAttr[0]; 400 } UPACKED usb_devcap_ssp_descriptor_t; 401 #define USB_DEVCAP_SSP_DESCRIPTOR_SIZE 12 /* variable length */ 402 403 typedef struct { 404 uByte bLength; 405 uByte bDescriptorType; 406 uWord bString[126]; 407 } UPACKED usb_string_descriptor_t; 408 #define USB_MAX_STRING_LEN 128 409 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */ 410 #define USB_MAX_ENCODED_STRING_LEN (USB_MAX_STRING_LEN * 3) /* UTF8 */ 411 412 /* Hub specific request */ 413 #define UR_GET_BUS_STATE 0x02 414 #define UR_CLEAR_TT_BUFFER 0x08 415 #define UR_RESET_TT 0x09 416 #define UR_GET_TT_STATE 0x0a 417 #define UR_STOP_TT 0x0b 418 #define UR_SET_HUB_DEPTH 0x0c 419 #define UR_GET_PORT_ERR_COUNT 0x0d 420 421 /* 422 * Hub features from USB 2.0 spec, table 11-17 and updated by the 423 * LPM ECN table 4-7. 424 */ 425 #define UHF_C_HUB_LOCAL_POWER 0 426 #define UHF_C_HUB_OVER_CURRENT 1 427 #define UHF_PORT_CONNECTION 0 428 #define UHF_PORT_ENABLE 1 429 #define UHF_PORT_SUSPEND 2 430 #define UHF_PORT_OVER_CURRENT 3 431 #define UHF_PORT_RESET 4 432 #define UHF_PORT_LINK_STATE 5 433 #define UHF_PORT_POWER 8 434 #define UHF_PORT_LOW_SPEED 9 435 #define UHF_PORT_L1 10 436 #define UHF_C_PORT_CONNECTION 16 437 #define UHF_C_PORT_ENABLE 17 438 #define UHF_C_PORT_SUSPEND 18 439 #define UHF_C_PORT_OVER_CURRENT 19 440 #define UHF_C_PORT_RESET 20 441 #define UHF_PORT_TEST 21 442 #define UHF_PORT_INDICATOR 22 443 #define UHF_C_PORT_L1 23 444 445 /* SS HUB specific features */ 446 #define UHF_PORT_U1_TIMEOUT 23 447 #define UHF_PORT_U2_TIMEOUT 24 448 #define UHF_C_PORT_LINK_STATE 25 449 #define UHF_C_PORT_CONFIG_ERROR 26 450 #define UHF_PORT_REMOTE_WAKE_MASK 27 451 #define UHF_BH_PORT_RESET 28 452 #define UHF_C_BH_PORT_RESET 29 453 #define UHF_FORCE_LINKPM_ACCEPT 30 454 455 typedef struct { 456 uByte bDescLength; 457 uByte bDescriptorType; 458 uByte bNbrPorts; 459 #define UHD_NPORTS_MAX 255 460 uWord wHubCharacteristics; 461 #define UHD_PWR 0x0003 462 #define UHD_PWR_GANGED 0x0000 463 #define UHD_PWR_INDIVIDUAL 0x0001 464 #define UHD_PWR_NO_SWITCH 0x0002 465 #define UHD_COMPOUND 0x0004 466 #define UHD_OC 0x0018 467 #define UHD_OC_GLOBAL 0x0000 468 #define UHD_OC_INDIVIDUAL 0x0008 469 #define UHD_OC_NONE 0x0010 470 #define UHD_TT_THINK 0x0060 471 #define UHD_TT_THINK_8 0x0000 472 #define UHD_TT_THINK_16 0x0020 473 #define UHD_TT_THINK_24 0x0040 474 #define UHD_TT_THINK_32 0x0060 475 #define UHD_PORT_IND 0x0080 476 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 477 #define UHD_PWRON_FACTOR 2 478 uByte bHubContrCurrent; 479 uByte DeviceRemovable[32]; /* max 255 ports */ 480 #define UHD_NOT_REMOV(desc, i) \ 481 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) 482 /* deprecated */ uByte PortPowerCtrlMask[1]; 483 } UPACKED usb_hub_descriptor_t; 484 #define USB_HUB_DESCRIPTOR_SIZE 9 /* includes deprecated PortPowerCtrlMask */ 485 486 typedef struct { 487 uByte bLength; 488 uByte bDescriptorType; 489 uByte bNbrPorts; 490 #define UHD_SS_NPORTS_MAX 15 491 uWord wHubCharacteristics; 492 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 493 uByte bHubContrCurrent; 494 uByte bHubHdrDecLat; 495 uWord wHubDelay; /* forward delay in nanosec */ 496 uByte DeviceRemovable[2]; /* max 15 ports */ 497 } UPACKED usb_hub_ss_descriptor_t; 498 #define USB_HUB_SS_DESCRIPTOR_SIZE 12 499 500 typedef struct { 501 uByte bLength; 502 uByte bDescriptorType; 503 uWord bcdUSB; 504 uByte bDeviceClass; 505 uByte bDeviceSubClass; 506 uByte bDeviceProtocol; 507 uByte bMaxPacketSize0; 508 uByte bNumConfigurations; 509 uByte bReserved; 510 } UPACKED usb_device_qualifier_t; 511 #define USB_DEVICE_QUALIFIER_SIZE 10 512 513 typedef struct { 514 uByte bLength; 515 uByte bDescriptorType; 516 uByte bmAttributes; 517 #define UOTG_SRP 0x01 518 #define UOTG_HNP 0x02 519 } UPACKED usb_otg_descriptor_t; 520 521 /* OTG feature selectors */ 522 #define UOTG_B_HNP_ENABLE 3 523 #define UOTG_A_HNP_SUPPORT 4 524 #define UOTG_A_ALT_HNP_SUPPORT 5 525 526 typedef struct { 527 uByte bLength; 528 uByte bDescriptorType; 529 uByte bDebugInEndpoint; 530 uByte bDebugOutEndpoint; 531 } UPACKED usb_debug_descriptor_t; 532 533 typedef struct { 534 uWord wStatus; 535 /* Device status flags */ 536 #define UDS_SELF_POWERED 0x0001 537 #define UDS_REMOTE_WAKEUP 0x0002 538 /* Endpoint status flags */ 539 #define UES_HALT 0x0001 540 } UPACKED usb_status_t; 541 542 typedef struct { 543 uWord wHubStatus; 544 #define UHS_LOCAL_POWER 0x0001 545 #define UHS_OVER_CURRENT 0x0002 546 uWord wHubChange; 547 } UPACKED usb_hub_status_t; 548 549 typedef struct { 550 uWord wPortStatus; 551 #define UPS_CURRENT_CONNECT_STATUS 0x0001 552 #define UPS_PORT_ENABLED 0x0002 553 #define UPS_SUSPEND 0x0004 554 #define UPS_OVERCURRENT_INDICATOR 0x0008 555 #define UPS_RESET 0x0010 556 #define UPS_PORT_L1 0x0020 557 #define UPS_PORT_LS_GET(x) __SHIFTOUT(x, __BITS(8,5)) 558 #define UPS_PORT_LS_U0 0x00 559 #define UPS_PORT_LS_U1 0x01 560 #define UPS_PORT_LS_U2 0x02 561 #define UPS_PORT_LS_U3 0x03 562 #define UPS_PORT_LS_SS_DIS 0x04 563 #define UPS_PORT_LS_RX_DET 0x05 564 #define UPS_PORT_LS_SS_INA 0x06 565 #define UPS_PORT_LS_POLL 0x07 566 #define UPS_PORT_LS_RECOVER 0x08 567 #define UPS_PORT_LS_HOT_RST 0x09 568 #define UPS_PORT_LS_COMP_MODE 0x0a 569 #define UPS_PORT_LS_LOOPBACK 0x0b 570 #define UPS_PORT_LS_RESUME 0x0f 571 #define UPS_PORT_POWER 0x0100 572 #define UPS_PORT_POWER_SS 0x0200 573 #define UPS_FULL_SPEED 0x0000 /* for completeness */ 574 #define UPS_LOW_SPEED 0x0200 575 #define UPS_HIGH_SPEED 0x0400 576 #define UPS_SUPER_SPEED 0x0800 577 #define UPS_PORT_TEST 0x0800 578 #define UPS_PORT_INDICATOR 0x1000 579 uWord wPortChange; 580 #define UPS_C_CONNECT_STATUS 0x0001 581 #define UPS_C_PORT_ENABLED 0x0002 582 #define UPS_C_SUSPEND 0x0004 583 #define UPS_C_OVERCURRENT_INDICATOR 0x0008 584 #define UPS_C_PORT_RESET 0x0010 585 #define UPS_C_PORT_L1 0x0020 586 #define UPS_C_BH_PORT_RESET 0x0020 587 #define UPS_C_PORT_LINK_STATE 0x0040 588 #define UPS_C_PORT_CONFIG_ERROR 0x0080 589 } UPACKED usb_port_status_t; 590 591 /* Device class codes */ 592 #define UDCLASS_IN_INTERFACE 0x00 593 #define UDCLASS_COMM 0x02 594 #define UDCLASS_HUB 0x09 595 #define UDSUBCLASS_HUB 0x00 596 #define UDPROTO_FSHUB 0x00 597 #define UDPROTO_HSHUBSTT 0x01 598 #define UDPROTO_HSHUBMTT 0x02 599 #define UDPROTO_SSHUB 0x03 600 #define UDCLASS_DIAGNOSTIC 0xdc 601 #define UDCLASS_WIRELESS 0xe0 602 #define UDSUBCLASS_RF 0x01 603 #define UDPROTO_BLUETOOTH 0x01 604 #define UDCLASS_VENDOR 0xff 605 606 /* Interface class codes */ 607 #define UICLASS_UNSPEC 0x00 608 609 #define UICLASS_AUDIO 0x01 610 #define UISUBCLASS_AUDIOCONTROL 1 611 #define UISUBCLASS_AUDIOSTREAM 2 612 #define UISUBCLASS_MIDISTREAM 3 613 614 #define UICLASS_VIDEO 0x0e 615 #define UISUBCLASS_VIDEOCONTROL 1 616 #define UISUBCLASS_VIDEOSTREAMING 2 617 #define UISUBCLASS_VIDEOCOLLECTION 3 618 619 #define UICLASS_CDC 0x02 /* communication */ 620 #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1 621 #define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2 622 #define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3 623 #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4 624 #define UISUBCLASS_CAPI_CONTROLMODEL 5 625 #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6 626 #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7 627 #define UIPROTO_CDC_NOCLASS 0 /* no class specific 628 protocol required */ 629 #define UIPROTO_CDC_AT 1 630 631 #define UICLASS_HID 0x03 632 #define UISUBCLASS_BOOT 1 633 #define UIPROTO_BOOT_KEYBOARD 1 634 #define UIPROTO_MOUSE 2 635 636 #define UICLASS_PHYSICAL 0x05 637 638 #define UICLASS_IMAGE 0x06 639 640 #define UICLASS_PRINTER 0x07 641 #define UISUBCLASS_PRINTER 1 642 #define UIPROTO_PRINTER_UNI 1 643 #define UIPROTO_PRINTER_BI 2 644 #define UIPROTO_PRINTER_1284 3 645 646 #define UICLASS_MASS 0x08 647 #define UISUBCLASS_RBC 1 648 #define UISUBCLASS_SFF8020I 2 649 #define UISUBCLASS_QIC157 3 650 #define UISUBCLASS_UFI 4 651 #define UISUBCLASS_SFF8070I 5 652 #define UISUBCLASS_SCSI 6 653 #define UIPROTO_MASS_CBI_I 0 654 #define UIPROTO_MASS_CBI 1 655 #define UIPROTO_MASS_BBB_OLD 2 /* Not in the spec anymore */ 656 #define UIPROTO_MASS_BBB 80 /* 'P' for the Iomega Zip drive */ 657 #define UIPROTO_MASS_UAS 98 /* USB Attached SCSI */ 658 659 #define UICLASS_HUB 0x09 660 #define UISUBCLASS_HUB 0 661 #define UIPROTO_FSHUB 0 662 #define UIPROTO_HSHUBSTT 0 /* Yes, same as previous */ 663 #define UIPROTO_HSHUBMTT 1 664 665 #define UICLASS_CDC_DATA 0x0a 666 #define UISUBCLASS_DATA 0 667 #define UIPROTO_DATA_ISDNBRI 0x30 /* Physical iface */ 668 #define UIPROTO_DATA_HDLC 0x31 /* HDLC */ 669 #define UIPROTO_DATA_TRANSPARENT 0x32 /* Transparent */ 670 #define UIPROTO_DATA_Q921M 0x50 /* Management for Q921 */ 671 #define UIPROTO_DATA_Q921 0x51 /* Data for Q921 */ 672 #define UIPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */ 673 #define UIPROTO_DATA_V42BIS 0x90 /* Data compression */ 674 #define UIPROTO_DATA_Q931 0x91 /* Euro-ISDN */ 675 #define UIPROTO_DATA_V120 0x92 /* V.24 rate adaption */ 676 #define UIPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */ 677 #define UIPROTO_DATA_HOST_BASED 0xfd /* Host based driver */ 678 #define UIPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc.*/ 679 #define UIPROTO_DATA_VENDOR 0xff /* Vendor specific */ 680 681 #define UICLASS_SMARTCARD 0x0b 682 683 /*#define UICLASS_FIRM_UPD 0x0c*/ 684 685 #define UICLASS_SECURITY 0x0d 686 687 #define UICLASS_DIAGNOSTIC 0xdc 688 689 #define UICLASS_WIRELESS 0xe0 690 #define UISUBCLASS_RF 0x01 691 #define UIPROTO_BLUETOOTH 0x01 692 #define UIPROTO_RNDIS 0x03 693 694 #define UICLASS_APPL_SPEC 0xfe 695 #define UISUBCLASS_FIRMWARE_DOWNLOAD 1 696 #define UISUBCLASS_IRDA 2 697 #define UIPROTO_IRDA 0 698 699 #define UICLASS_VENDOR 0xff 700 701 702 #define USB_HUB_MAX_DEPTH 5 703 704 /* 705 * Minimum time a device needs to be powered down to go through 706 * a power cycle. XXX Are these time in the spec? 707 */ 708 #define USB_POWER_DOWN_TIME 200 /* ms */ 709 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 710 711 #if 0 712 /* These are the values from the spec. */ 713 #define USB_PORT_RESET_DELAY 10 /* ms */ 714 #define USB_PORT_ROOT_RESET_DELAY 50 /* ms */ 715 #define USB_PORT_RESET_RECOVERY 10 /* ms */ 716 #define USB_PORT_POWERUP_DELAY 100 /* ms */ 717 #define USB_SET_ADDRESS_SETTLE 2 /* ms */ 718 #define USB_RESUME_DELAY (20*5) /* ms */ 719 #define USB_RESUME_WAIT 10 /* ms */ 720 #define USB_RESUME_RECOVERY 10 /* ms */ 721 #define USB_EXTRA_POWER_UP_TIME 0 /* ms */ 722 #else 723 /* Allow for marginal (i.e. non-conforming) devices. */ 724 #define USB_PORT_RESET_DELAY 50 /* ms */ 725 #define USB_PORT_ROOT_RESET_DELAY 250 /* ms */ 726 #define USB_PORT_RESET_RECOVERY 250 /* ms */ 727 #define USB_PORT_POWERUP_DELAY 300 /* ms */ 728 #define USB_SET_ADDRESS_SETTLE 10 /* ms */ 729 #define USB_RESUME_DELAY (50*5) /* ms */ 730 #define USB_RESUME_WAIT 50 /* ms */ 731 #define USB_RESUME_RECOVERY 50 /* ms */ 732 #define USB_EXTRA_POWER_UP_TIME 20 /* ms */ 733 #endif 734 735 #define USB_MIN_POWER 100 /* mA */ 736 #define USB_MAX_POWER 500 /* mA */ 737 738 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ 739 740 741 #define USB_UNCONFIG_NO 0 742 #define USB_UNCONFIG_INDEX (-1) 743 744 745 /* Packet IDs */ 746 #define UPID_RESERVED 0xf0 747 #define UPID_OUT 0xe1 748 #define UPID_ACK 0xd2 749 #define UPID_DATA0 0xc3 750 #define UPID_PING 0xb4 751 #define UPID_SOF 0xa5 752 #define UPID_NYET 0x96 753 #define UPID_DATA2 0x87 754 #define UPID_SPLIT 0x78 755 #define UPID_IN 0x69 756 #define UPID_NAK 0x5a 757 #define UPID_DATA1 0x4b 758 #define UPID_ERR 0x3c 759 #define UPID_PREAMBLE 0x3c 760 #define UPID_SETUP 0x2d 761 #define UPID_STALL 0x1e 762 #define UPID_MDATA 0x0f 763 764 765 /*** ioctl() related stuff ***/ 766 767 struct usb_ctl_request { 768 int ucr_addr; 769 usb_device_request_t ucr_request; 770 void *ucr_data; 771 int ucr_flags; 772 #define USBD_SHORT_XFER_OK 0x04 /* allow short reads */ 773 int ucr_actlen; /* actual length transferred */ 774 }; 775 776 struct usb_alt_interface { 777 int uai_config_index; 778 int uai_interface_index; 779 int uai_alt_no; 780 }; 781 782 #define USB_CURRENT_CONFIG_INDEX (-1) 783 #define USB_CURRENT_ALT_INDEX (-1) 784 785 struct usb_config_desc { 786 int ucd_config_index; 787 usb_config_descriptor_t ucd_desc; 788 }; 789 790 struct usb_interface_desc { 791 int uid_config_index; 792 int uid_interface_index; 793 int uid_alt_index; 794 usb_interface_descriptor_t uid_desc; 795 }; 796 797 struct usb_endpoint_desc { 798 int ued_config_index; 799 int ued_interface_index; 800 int ued_alt_index; 801 int ued_endpoint_index; 802 usb_endpoint_descriptor_t ued_desc; 803 }; 804 805 struct usb_full_desc { 806 int ufd_config_index; 807 u_int ufd_size; 808 u_char *ufd_data; 809 }; 810 811 struct usb_string_desc { 812 int usd_string_index; 813 int usd_language_id; 814 usb_string_descriptor_t usd_desc; 815 }; 816 817 struct usb_ctl_report_desc { 818 int ucrd_size; 819 u_char ucrd_data[1024]; /* filled data size will vary */ 820 }; 821 822 typedef struct { uint32_t cookie; } usb_event_cookie_t; 823 824 #define USB_MAX_DEVNAMES 4 825 #define USB_MAX_DEVNAMELEN 16 826 struct usb_device_info { 827 uint8_t udi_bus; 828 uint8_t udi_addr; /* device address */ 829 usb_event_cookie_t udi_cookie; 830 char udi_product[USB_MAX_ENCODED_STRING_LEN]; 831 char udi_vendor[USB_MAX_ENCODED_STRING_LEN]; 832 char udi_release[8]; 833 char udi_serial[USB_MAX_ENCODED_STRING_LEN]; 834 uint16_t udi_productNo; 835 uint16_t udi_vendorNo; 836 uint16_t udi_releaseNo; 837 uint8_t udi_class; 838 uint8_t udi_subclass; 839 uint8_t udi_protocol; 840 uint8_t udi_config; 841 uint8_t udi_speed; 842 #define USB_SPEED_LOW 1 843 #define USB_SPEED_FULL 2 844 #define USB_SPEED_HIGH 3 845 #define USB_SPEED_SUPER 4 846 int udi_power; /* power consumption in mA, 0 if selfpowered */ 847 int udi_nports; 848 char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN]; 849 uint8_t udi_ports[16];/* hub only: addresses of devices on ports */ 850 #define USB_PORT_ENABLED 0xff 851 #define USB_PORT_SUSPENDED 0xfe 852 #define USB_PORT_POWERED 0xfd 853 #define USB_PORT_DISABLED 0xfc 854 }; 855 856 /* <=3.0 had this layout of the structure */ 857 struct usb_device_info_old { 858 uint8_t udi_bus; 859 uint8_t udi_addr; /* device address */ 860 usb_event_cookie_t udi_cookie; 861 char udi_product[USB_MAX_STRING_LEN]; 862 char udi_vendor[USB_MAX_STRING_LEN]; 863 char udi_release[8]; 864 uint16_t udi_productNo; 865 uint16_t udi_vendorNo; 866 uint16_t udi_releaseNo; 867 uint8_t udi_class; 868 uint8_t udi_subclass; 869 uint8_t udi_protocol; 870 uint8_t udi_config; 871 uint8_t udi_speed; 872 int udi_power; /* power consumption in mA, 0 if selfpowered */ 873 int udi_nports; 874 char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN]; 875 uint8_t udi_ports[16];/* hub only: addresses of devices on ports */ 876 }; 877 878 struct usb_ctl_report { 879 int ucr_report; 880 u_char ucr_data[1024]; /* filled data size will vary */ 881 }; 882 883 struct usb_device_stats { 884 u_long uds_requests[4]; /* indexed by transfer type UE_* */ 885 }; 886 887 struct usb_bulk_ra_wb_opt { 888 u_int ra_wb_buffer_size; 889 u_int ra_wb_request_size; 890 }; 891 892 /* Events that can be read from /dev/usb */ 893 struct usb_event { 894 int ue_type; 895 #define USB_EVENT_CTRLR_ATTACH 1 896 #define USB_EVENT_CTRLR_DETACH 2 897 #define USB_EVENT_DEVICE_ATTACH 3 898 #define USB_EVENT_DEVICE_DETACH 4 899 #define USB_EVENT_DRIVER_ATTACH 5 900 #define USB_EVENT_DRIVER_DETACH 6 901 #define USB_EVENT_IS_ATTACH(n) ((n) == USB_EVENT_CTRLR_ATTACH || (n) == USB_EVENT_DEVICE_ATTACH || (n) == USB_EVENT_DRIVER_ATTACH) 902 #define USB_EVENT_IS_DETACH(n) ((n) == USB_EVENT_CTRLR_DETACH || (n) == USB_EVENT_DEVICE_DETACH || (n) == USB_EVENT_DRIVER_DETACH) 903 struct timespec ue_time; 904 union { 905 struct { 906 int ue_bus; 907 } ue_ctrlr; 908 struct usb_device_info ue_device; 909 struct { 910 usb_event_cookie_t ue_cookie; 911 char ue_devname[16]; 912 } ue_driver; 913 } u; 914 }; 915 916 /* old <=3.0 compat event */ 917 struct usb_event_old { 918 int ue_type; 919 struct timespec ue_time; 920 union { 921 struct { 922 int ue_bus; 923 } ue_ctrlr; 924 struct usb_device_info_old ue_device; 925 struct { 926 usb_event_cookie_t ue_cookie; 927 char ue_devname[16]; 928 } ue_driver; 929 } u; 930 }; 931 932 933 /* USB controller */ 934 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 935 #define USB_SETDEBUG _IOW ('U', 2, int) 936 #define USB_DISCOVER _IO ('U', 3) 937 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 938 #define USB_DEVICEINFO_OLD _IOWR('U', 4, struct usb_device_info_old) 939 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 940 941 /* Generic HID device */ 942 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) 943 #define USB_SET_IMMED _IOW ('U', 22, int) 944 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) 945 #define USB_SET_REPORT _IOW ('U', 24, struct usb_ctl_report) 946 #define USB_GET_REPORT_ID _IOR ('U', 25, int) 947 948 /* Generic USB device */ 949 #define USB_GET_CONFIG _IOR ('U', 100, int) 950 #define USB_SET_CONFIG _IOW ('U', 101, int) 951 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 952 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 953 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) 954 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) 955 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) 956 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) 957 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) 958 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) 959 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc) 960 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 961 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 962 #define USB_GET_DEVICEINFO_OLD _IOR ('U', 112, struct usb_device_info_old) 963 #define USB_SET_SHORT_XFER _IOW ('U', 113, int) 964 #define USB_SET_TIMEOUT _IOW ('U', 114, int) 965 #define USB_SET_BULK_RA _IOW ('U', 115, int) 966 #define USB_SET_BULK_WB _IOW ('U', 116, int) 967 #define USB_SET_BULK_RA_OPT _IOW ('U', 117, struct usb_bulk_ra_wb_opt) 968 #define USB_SET_BULK_WB_OPT _IOW ('U', 118, struct usb_bulk_ra_wb_opt) 969 970 /* Modem device */ 971 #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int) 972 #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int) 973 974 #endif /* _USB_H_ */ 975
Indexes created Tue Sep 30 17:09:57 GMT 2025