1 /* 2 * This file holds USB constants and structures that are needed for 3 * USB device APIs. These are used by the USB device model, which is 4 * defined in chapter 9 of the USB 2.0 specification and in the 5 * Wireless USB 1.0 (spread around). Linux has several APIs in C that 6 * need these: 7 * 8 * - the master/host side Linux-USB kernel driver API; 9 * - the "usbfs" user space API; and 10 * - the Linux "gadget" slave/device/peripheral side driver API. 11 * 12 * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems 13 * act either as a USB master/host or as a USB slave/device. That means 14 * the master and slave side APIs benefit from working well together. 15 * 16 * There's also "Wireless USB", using low power short range radios for 17 * peripheral interconnection but otherwise building on the USB framework. 18 * 19 * Note all descriptors are declared '__attribute__((packed))' so that: 20 * 21 * [a] they never get padded, either internally (USB spec writers 22 * probably handled that) or externally; 23 * 24 * [b] so that accessing bigger-than-a-bytes fields will never 25 * generate bus errors on any platform, even when the location of 26 * its descriptor inside a bundle isn't "naturally aligned", and 27 * 28 * [c] for consistency, removing all doubt even when it appears to 29 * someone that the two other points are non-issues for that 30 * particular descriptor type. 31 */ 32 33 #ifndef __LINUX_USB_CH9_H 34 #define __LINUX_USB_CH9_H 35 36 #include <linux/types.h> /* __u8 etc */ 37 38 /*-------------------------------------------------------------------------*/ 39 40 /* CONTROL REQUEST SUPPORT */ 41 42 /* 43 * USB directions 44 * 45 * This bit flag is used in endpoint descriptors' bEndpointAddress field. 46 * It's also one of three fields in control requests bRequestType. 47 */ 48 #define USB_DIR_OUT 0 /* to device */ 49 #define USB_DIR_IN 0x80 /* to host */ 50 51 /* 52 * USB types, the second of three bRequestType fields 53 */ 54 #define USB_TYPE_MASK (0x03 << 5) 55 #define USB_TYPE_STANDARD (0x00 << 5) 56 #define USB_TYPE_CLASS (0x01 << 5) 57 #define USB_TYPE_VENDOR (0x02 << 5) 58 #define USB_TYPE_RESERVED (0x03 << 5) 59 60 /* 61 * USB recipients, the third of three bRequestType fields 62 */ 63 #define USB_RECIP_MASK 0x1f 64 #define USB_RECIP_DEVICE 0x00 65 #define USB_RECIP_INTERFACE 0x01 66 #define USB_RECIP_ENDPOINT 0x02 67 #define USB_RECIP_OTHER 0x03 68 /* From Wireless USB 1.0 */ 69 #define USB_RECIP_PORT 0x04 70 #define USB_RECIP_RPIPE 0x05 71 72 /* 73 * Standard requests, for the bRequest field of a SETUP packet. 74 * 75 * These are qualified by the bRequestType field, so that for example 76 * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved 77 * by a GET_STATUS request. 78 */ 79 #define USB_REQ_GET_STATUS 0x00 80 #define USB_REQ_CLEAR_FEATURE 0x01 81 #define USB_REQ_SET_FEATURE 0x03 82 #define USB_REQ_SET_ADDRESS 0x05 83 #define USB_REQ_GET_DESCRIPTOR 0x06 84 #define USB_REQ_SET_DESCRIPTOR 0x07 85 #define USB_REQ_GET_CONFIGURATION 0x08 86 #define USB_REQ_SET_CONFIGURATION 0x09 87 #define USB_REQ_GET_INTERFACE 0x0A 88 #define USB_REQ_SET_INTERFACE 0x0B 89 #define USB_REQ_SYNCH_FRAME 0x0C 90 91 #define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */ 92 #define USB_REQ_GET_ENCRYPTION 0x0E 93 #define USB_REQ_RPIPE_ABORT 0x0E 94 #define USB_REQ_SET_HANDSHAKE 0x0F 95 #define USB_REQ_RPIPE_RESET 0x0F 96 #define USB_REQ_GET_HANDSHAKE 0x10 97 #define USB_REQ_SET_CONNECTION 0x11 98 #define USB_REQ_SET_SECURITY_DATA 0x12 99 #define USB_REQ_GET_SECURITY_DATA 0x13 100 #define USB_REQ_SET_WUSB_DATA 0x14 101 #define USB_REQ_LOOPBACK_DATA_WRITE 0x15 102 #define USB_REQ_LOOPBACK_DATA_READ 0x16 103 #define USB_REQ_SET_INTERFACE_DS 0x17 104 105 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command, 106 * used by hubs to put ports into a new L1 suspend state, except that it 107 * forgot to define its number ... 108 */ 109 110 /* 111 * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and 112 * are read as a bit array returned by USB_REQ_GET_STATUS. (So there 113 * are at most sixteen features of each type.) Hubs may also support a 114 * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend. 115 */ 116 #define USB_DEVICE_SELF_POWERED 0 /* (read only) */ 117 #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */ 118 #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */ 119 #define USB_DEVICE_BATTERY 2 /* (wireless) */ 120 #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */ 121 #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/ 122 #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */ 123 #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */ 124 #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */ 125 126 /* 127 * New Feature Selectors as added by USB 3.0 128 * See USB 3.0 spec Table 9-6 129 */ 130 #define USB_DEVICE_U1_ENABLE 48 /* dev may initiate U1 transition */ 131 #define USB_DEVICE_U2_ENABLE 49 /* dev may initiate U2 transition */ 132 #define USB_DEVICE_LTM_ENABLE 50 /* dev may send LTM */ 133 #define USB_INTRF_FUNC_SUSPEND 0 /* function suspend */ 134 135 #define USB_INTR_FUNC_SUSPEND_OPT_MASK 0xFF00 136 137 #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */ 138 139 /* Bit array elements as returned by the USB_REQ_GET_STATUS request. */ 140 #define USB_DEV_STAT_U1_ENABLED 2 /* transition into U1 state */ 141 #define USB_DEV_STAT_U2_ENABLED 3 /* transition into U2 state */ 142 #define USB_DEV_STAT_LTM_ENABLED 4 /* Latency tolerance messages */ 143 144 /** 145 * struct usb_ctrlrequest - SETUP data for a USB device control request 146 * @bRequestType: matches the USB bmRequestType field 147 * @bRequest: matches the USB bRequest field 148 * @wValue: matches the USB wValue field (le16 byte order) 149 * @wIndex: matches the USB wIndex field (le16 byte order) 150 * @wLength: matches the USB wLength field (le16 byte order) 151 * 152 * This structure is used to send control requests to a USB device. It matches 153 * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the 154 * USB spec for a fuller description of the different fields, and what they are 155 * used for. 156 * 157 * Note that the driver for any interface can issue control requests. 158 * For most devices, interfaces don't coordinate with each other, so 159 * such requests may be made at any time. 160 */ 161 struct usb_ctrlrequest { 162 __u8 bRequestType; 163 __u8 bRequest; 164 __le16 wValue; 165 __le16 wIndex; 166 __le16 wLength; 167 } __attribute__ ((packed)); 168 169 /*-------------------------------------------------------------------------*/ 170 171 /* 172 * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or 173 * (rarely) accepted by SET_DESCRIPTOR. 174 * 175 * Note that all multi-byte values here are encoded in little endian 176 * byte order "on the wire". Within the kernel and when exposed 177 * through the Linux-USB APIs, they are not converted to cpu byte 178 * order; it is the responsibility of the client code to do this. 179 * The single exception is when device and configuration descriptors (but 180 * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD); 181 * in this case the fields are converted to host endianness by the kernel. 182 */ 183 184 /* 185 * Descriptor types ... USB 2.0 spec table 9.5 186 */ 187 #define USB_DT_DEVICE 0x01 188 #define USB_DT_CONFIG 0x02 189 #define USB_DT_STRING 0x03 190 #define USB_DT_INTERFACE 0x04 191 #define USB_DT_ENDPOINT 0x05 192 #define USB_DT_DEVICE_QUALIFIER 0x06 193 #define USB_DT_OTHER_SPEED_CONFIG 0x07 194 #define USB_DT_INTERFACE_POWER 0x08 195 /* these are from a minor usb 2.0 revision (ECN) */ 196 #define USB_DT_OTG 0x09 197 #define USB_DT_DEBUG 0x0a 198 #define USB_DT_INTERFACE_ASSOCIATION 0x0b 199 /* these are from the Wireless USB spec */ 200 #define USB_DT_SECURITY 0x0c 201 #define USB_DT_KEY 0x0d 202 #define USB_DT_ENCRYPTION_TYPE 0x0e 203 #define USB_DT_BOS 0x0f 204 #define USB_DT_DEVICE_CAPABILITY 0x10 205 #define USB_DT_WIRELESS_ENDPOINT_COMP 0x11 206 #define USB_DT_WIRE_ADAPTER 0x21 207 #define USB_DT_RPIPE 0x22 208 #define USB_DT_CS_RADIO_CONTROL 0x23 209 /* From the T10 UAS specification */ 210 #define USB_DT_PIPE_USAGE 0x24 211 /* From the USB 3.0 spec */ 212 #define USB_DT_SS_ENDPOINT_COMP 0x30 213 214 /* Conventional codes for class-specific descriptors. The convention is 215 * defined in the USB "Common Class" Spec (3.11). Individual class specs 216 * are authoritative for their usage, not the "common class" writeup. 217 */ 218 #define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE) 219 #define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG) 220 #define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING) 221 #define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE) 222 #define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT) 223 224 /* All standard descriptors have these 2 fields at the beginning */ 225 struct usb_descriptor_header { 226 __u8 bLength; 227 __u8 bDescriptorType; 228 } __attribute__ ((packed)); 229 230 231 /*-------------------------------------------------------------------------*/ 232 233 /* USB_DT_DEVICE: Device descriptor */ 234 struct usb_device_descriptor { 235 __u8 bLength; 236 __u8 bDescriptorType; 237 238 __le16 bcdUSB; 239 __u8 bDeviceClass; 240 __u8 bDeviceSubClass; 241 __u8 bDeviceProtocol; 242 __u8 bMaxPacketSize0; 243 __le16 idVendor; 244 __le16 idProduct; 245 __le16 bcdDevice; 246 __u8 iManufacturer; 247 __u8 iProduct; 248 __u8 iSerialNumber; 249 __u8 bNumConfigurations; 250 } __attribute__ ((packed)); 251 252 #define USB_DT_DEVICE_SIZE 18 253 254 255 /* 256 * Device and/or Interface Class codes 257 * as found in bDeviceClass or bInterfaceClass 258 * and defined by www.usb.org documents 259 */ 260 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */ 261 #define USB_CLASS_AUDIO 1 262 #define USB_CLASS_COMM 2 263 #define USB_CLASS_HID 3 264 #define USB_CLASS_PHYSICAL 5 265 #define USB_CLASS_STILL_IMAGE 6 266 #define USB_CLASS_PRINTER 7 267 #define USB_CLASS_MASS_STORAGE 8 268 #define USB_CLASS_HUB 9 269 #define USB_CLASS_CDC_DATA 0x0a 270 #define USB_CLASS_CSCID 0x0b /* chip+ smart card */ 271 #define USB_CLASS_CONTENT_SEC 0x0d /* content security */ 272 #define USB_CLASS_VIDEO 0x0e 273 #define USB_CLASS_WIRELESS_CONTROLLER 0xe0 274 #define USB_CLASS_MISC 0xef 275 #define USB_CLASS_APP_SPEC 0xfe 276 #define USB_CLASS_VENDOR_SPEC 0xff 277 278 #define USB_SUBCLASS_VENDOR_SPEC 0xff 279 280 /*-------------------------------------------------------------------------*/ 281 282 /* USB_DT_CONFIG: Configuration descriptor information. 283 * 284 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the 285 * descriptor type is different. Highspeed-capable devices can look 286 * different depending on what speed they're currently running. Only 287 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG 288 * descriptors. 289 */ 290 struct usb_config_descriptor { 291 __u8 bLength; 292 __u8 bDescriptorType; 293 294 __le16 wTotalLength; 295 __u8 bNumInterfaces; 296 __u8 bConfigurationValue; 297 __u8 iConfiguration; 298 __u8 bmAttributes; 299 __u8 bMaxPower; 300 } __attribute__ ((packed)); 301 302 #define USB_DT_CONFIG_SIZE 9 303 304 /* from config descriptor bmAttributes */ 305 #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */ 306 #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */ 307 #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */ 308 #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */ 309 310 /*-------------------------------------------------------------------------*/ 311 312 /* USB_DT_STRING: String descriptor */ 313 struct usb_string_descriptor { 314 __u8 bLength; 315 __u8 bDescriptorType; 316 317 __le16 wData[1]; /* UTF-16LE encoded */ 318 } __attribute__ ((packed)); 319 320 /* note that "string" zero is special, it holds language codes that 321 * the device supports, not Unicode characters. 322 */ 323 324 /*-------------------------------------------------------------------------*/ 325 326 /* USB_DT_INTERFACE: Interface descriptor */ 327 struct usb_interface_descriptor { 328 __u8 bLength; 329 __u8 bDescriptorType; 330 331 __u8 bInterfaceNumber; 332 __u8 bAlternateSetting; 333 __u8 bNumEndpoints; 334 __u8 bInterfaceClass; 335 __u8 bInterfaceSubClass; 336 __u8 bInterfaceProtocol; 337 __u8 iInterface; 338 } __attribute__ ((packed)); 339 340 #define USB_DT_INTERFACE_SIZE 9 341 342 /*-------------------------------------------------------------------------*/ 343 344 /* USB_DT_ENDPOINT: Endpoint descriptor */ 345 struct usb_endpoint_descriptor { 346 __u8 bLength; 347 __u8 bDescriptorType; 348 349 __u8 bEndpointAddress; 350 __u8 bmAttributes; 351 __le16 wMaxPacketSize; 352 __u8 bInterval; 353 354 /* NOTE: these two are _only_ in audio endpoints. */ 355 /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */ 356 __u8 bRefresh; 357 __u8 bSynchAddress; 358 } __attribute__ ((packed)); 359 360 #define USB_DT_ENDPOINT_SIZE 7 361 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ 362 363 364 /* 365 * Endpoints 366 */ 367 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ 368 #define USB_ENDPOINT_DIR_MASK 0x80 369 370 #define USB_ENDPOINT_SYNCTYPE 0x0c 371 #define USB_ENDPOINT_SYNC_NONE (0 << 2) 372 #define USB_ENDPOINT_SYNC_ASYNC (1 << 2) 373 #define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2) 374 #define USB_ENDPOINT_SYNC_SYNC (3 << 2) 375 376 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ 377 #define USB_ENDPOINT_XFER_CONTROL 0 378 #define USB_ENDPOINT_XFER_ISOC 1 379 #define USB_ENDPOINT_XFER_BULK 2 380 #define USB_ENDPOINT_XFER_INT 3 381 #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80 382 383 /*-------------------------------------------------------------------------*/ 384 385 /** 386 * usb_endpoint_num - get the endpoint's number 387 * @epd: endpoint to be checked 388 * 389 * Returns @epd's number: 0 to 15. 390 */ 391 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd) 392 { 393 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK; 394 } 395 396 /** 397 * usb_endpoint_type - get the endpoint's transfer type 398 * @epd: endpoint to be checked 399 * 400 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according 401 * to @epd's transfer type. 402 */ 403 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd) 404 { 405 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK; 406 } 407 408 /** 409 * usb_endpoint_dir_in - check if the endpoint has IN direction 410 * @epd: endpoint to be checked 411 * 412 * Returns true if the endpoint is of type IN, otherwise it returns false. 413 */ 414 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd) 415 { 416 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN); 417 } 418 419 /** 420 * usb_endpoint_dir_out - check if the endpoint has OUT direction 421 * @epd: endpoint to be checked 422 * 423 * Returns true if the endpoint is of type OUT, otherwise it returns false. 424 */ 425 static inline int usb_endpoint_dir_out( 426 const struct usb_endpoint_descriptor *epd) 427 { 428 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT); 429 } 430 431 /** 432 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type 433 * @epd: endpoint to be checked 434 * 435 * Returns true if the endpoint is of type bulk, otherwise it returns false. 436 */ 437 static inline int usb_endpoint_xfer_bulk( 438 const struct usb_endpoint_descriptor *epd) 439 { 440 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 441 USB_ENDPOINT_XFER_BULK); 442 } 443 444 /** 445 * usb_endpoint_xfer_control - check if the endpoint has control transfer type 446 * @epd: endpoint to be checked 447 * 448 * Returns true if the endpoint is of type control, otherwise it returns false. 449 */ 450 static inline int usb_endpoint_xfer_control( 451 const struct usb_endpoint_descriptor *epd) 452 { 453 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 454 USB_ENDPOINT_XFER_CONTROL); 455 } 456 457 /** 458 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type 459 * @epd: endpoint to be checked 460 * 461 * Returns true if the endpoint is of type interrupt, otherwise it returns 462 * false. 463 */ 464 static inline int usb_endpoint_xfer_int( 465 const struct usb_endpoint_descriptor *epd) 466 { 467 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 468 USB_ENDPOINT_XFER_INT); 469 } 470 471 /** 472 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type 473 * @epd: endpoint to be checked 474 * 475 * Returns true if the endpoint is of type isochronous, otherwise it returns 476 * false. 477 */ 478 static inline int usb_endpoint_xfer_isoc( 479 const struct usb_endpoint_descriptor *epd) 480 { 481 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 482 USB_ENDPOINT_XFER_ISOC); 483 } 484 485 /** 486 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN 487 * @epd: endpoint to be checked 488 * 489 * Returns true if the endpoint has bulk transfer type and IN direction, 490 * otherwise it returns false. 491 */ 492 static inline int usb_endpoint_is_bulk_in( 493 const struct usb_endpoint_descriptor *epd) 494 { 495 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd); 496 } 497 498 /** 499 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT 500 * @epd: endpoint to be checked 501 * 502 * Returns true if the endpoint has bulk transfer type and OUT direction, 503 * otherwise it returns false. 504 */ 505 static inline int usb_endpoint_is_bulk_out( 506 const struct usb_endpoint_descriptor *epd) 507 { 508 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd); 509 } 510 511 /** 512 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN 513 * @epd: endpoint to be checked 514 * 515 * Returns true if the endpoint has interrupt transfer type and IN direction, 516 * otherwise it returns false. 517 */ 518 static inline int usb_endpoint_is_int_in( 519 const struct usb_endpoint_descriptor *epd) 520 { 521 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd); 522 } 523 524 /** 525 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT 526 * @epd: endpoint to be checked 527 * 528 * Returns true if the endpoint has interrupt transfer type and OUT direction, 529 * otherwise it returns false. 530 */ 531 static inline int usb_endpoint_is_int_out( 532 const struct usb_endpoint_descriptor *epd) 533 { 534 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd); 535 } 536 537 /** 538 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN 539 * @epd: endpoint to be checked 540 * 541 * Returns true if the endpoint has isochronous transfer type and IN direction, 542 * otherwise it returns false. 543 */ 544 static inline int usb_endpoint_is_isoc_in( 545 const struct usb_endpoint_descriptor *epd) 546 { 547 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd); 548 } 549 550 /** 551 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT 552 * @epd: endpoint to be checked 553 * 554 * Returns true if the endpoint has isochronous transfer type and OUT direction, 555 * otherwise it returns false. 556 */ 557 static inline int usb_endpoint_is_isoc_out( 558 const struct usb_endpoint_descriptor *epd) 559 { 560 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd); 561 } 562 563 /*-------------------------------------------------------------------------*/ 564 565 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */ 566 struct usb_ss_ep_comp_descriptor { 567 __u8 bLength; 568 __u8 bDescriptorType; 569 570 __u8 bMaxBurst; 571 __u8 bmAttributes; 572 __u16 wBytesPerInterval; 573 } __attribute__ ((packed)); 574 575 #define USB_DT_SS_EP_COMP_SIZE 6 576 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */ 577 #define USB_SS_MAX_STREAMS(p) (1 << (p & 0x1f)) 578 579 /*-------------------------------------------------------------------------*/ 580 581 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */ 582 struct usb_qualifier_descriptor { 583 __u8 bLength; 584 __u8 bDescriptorType; 585 586 __le16 bcdUSB; 587 __u8 bDeviceClass; 588 __u8 bDeviceSubClass; 589 __u8 bDeviceProtocol; 590 __u8 bMaxPacketSize0; 591 __u8 bNumConfigurations; 592 __u8 bRESERVED; 593 } __attribute__ ((packed)); 594 595 596 /*-------------------------------------------------------------------------*/ 597 598 /* USB_DT_OTG (from OTG 1.0a supplement) */ 599 struct usb_otg_descriptor { 600 __u8 bLength; 601 __u8 bDescriptorType; 602 603 __u8 bmAttributes; /* support for HNP, SRP, etc */ 604 } __attribute__ ((packed)); 605 606 /* from usb_otg_descriptor.bmAttributes */ 607 #define USB_OTG_SRP (1 << 0) 608 #define USB_OTG_HNP (1 << 1) /* swap host/device roles */ 609 610 /*-------------------------------------------------------------------------*/ 611 612 /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */ 613 struct usb_debug_descriptor { 614 __u8 bLength; 615 __u8 bDescriptorType; 616 617 /* bulk endpoints with 8 byte maxpacket */ 618 __u8 bDebugInEndpoint; 619 __u8 bDebugOutEndpoint; 620 } __attribute__((packed)); 621 622 /*-------------------------------------------------------------------------*/ 623 624 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */ 625 struct usb_interface_assoc_descriptor { 626 __u8 bLength; 627 __u8 bDescriptorType; 628 629 __u8 bFirstInterface; 630 __u8 bInterfaceCount; 631 __u8 bFunctionClass; 632 __u8 bFunctionSubClass; 633 __u8 bFunctionProtocol; 634 __u8 iFunction; 635 } __attribute__ ((packed)); 636 637 638 /*-------------------------------------------------------------------------*/ 639 640 /* USB_DT_SECURITY: group of wireless security descriptors, including 641 * encryption types available for setting up a CC/association. 642 */ 643 struct usb_security_descriptor { 644 __u8 bLength; 645 __u8 bDescriptorType; 646 647 __le16 wTotalLength; 648 __u8 bNumEncryptionTypes; 649 } __attribute__((packed)); 650 651 /*-------------------------------------------------------------------------*/ 652 653 /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys 654 * may be retrieved. 655 */ 656 struct usb_key_descriptor { 657 __u8 bLength; 658 __u8 bDescriptorType; 659 660 __u8 tTKID[3]; 661 __u8 bReserved; 662 __u8 bKeyData[0]; 663 } __attribute__((packed)); 664 665 /*-------------------------------------------------------------------------*/ 666 667 /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */ 668 struct usb_encryption_descriptor { 669 __u8 bLength; 670 __u8 bDescriptorType; 671 672 __u8 bEncryptionType; 673 #define USB_ENC_TYPE_UNSECURE 0 674 #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */ 675 #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */ 676 #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */ 677 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */ 678 __u8 bAuthKeyIndex; 679 } __attribute__((packed)); 680 681 682 /*-------------------------------------------------------------------------*/ 683 684 /* USB_DT_BOS: group of device-level capabilities */ 685 struct usb_bos_descriptor { 686 __u8 bLength; 687 __u8 bDescriptorType; 688 689 __le16 wTotalLength; 690 __u8 bNumDeviceCaps; 691 } __attribute__((packed)); 692 693 #define USB_DT_BOS_SIZE 5 694 /*-------------------------------------------------------------------------*/ 695 696 /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */ 697 struct usb_dev_cap_header { 698 __u8 bLength; 699 __u8 bDescriptorType; 700 __u8 bDevCapabilityType; 701 } __attribute__((packed)); 702 703 #define USB_CAP_TYPE_WIRELESS_USB 1 704 705 struct usb_wireless_cap_descriptor { /* Ultra Wide Band */ 706 __u8 bLength; 707 __u8 bDescriptorType; 708 __u8 bDevCapabilityType; 709 710 __u8 bmAttributes; 711 #define USB_WIRELESS_P2P_DRD (1 << 1) 712 #define USB_WIRELESS_BEACON_MASK (3 << 2) 713 #define USB_WIRELESS_BEACON_SELF (1 << 2) 714 #define USB_WIRELESS_BEACON_DIRECTED (2 << 2) 715 #define USB_WIRELESS_BEACON_NONE (3 << 2) 716 __le16 wPHYRates; /* bit rates, Mbps */ 717 #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */ 718 #define USB_WIRELESS_PHY_80 (1 << 1) 719 #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */ 720 #define USB_WIRELESS_PHY_160 (1 << 3) 721 #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */ 722 #define USB_WIRELESS_PHY_320 (1 << 5) 723 #define USB_WIRELESS_PHY_400 (1 << 6) 724 #define USB_WIRELESS_PHY_480 (1 << 7) 725 __u8 bmTFITXPowerInfo; /* TFI power levels */ 726 __u8 bmFFITXPowerInfo; /* FFI power levels */ 727 __le16 bmBandGroup; 728 __u8 bReserved; 729 } __attribute__((packed)); 730 731 /* USB 2.0 Extension descriptor */ 732 #define USB_CAP_TYPE_EXT 2 733 734 struct usb_ext_cap_descriptor { /* Link Power Management */ 735 __u8 bLength; 736 __u8 bDescriptorType; 737 __u8 bDevCapabilityType; 738 __le32 bmAttributes; 739 #define USB_LPM_SUPPORT (1 << 1) /* supports LPM */ 740 } __attribute__((packed)); 741 742 #define USB_DT_USB_EXT_CAP_SIZE 7 743 744 /* 745 * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB 746 * specific device level capabilities 747 */ 748 #define USB_SS_CAP_TYPE 3 749 struct usb_ss_cap_descriptor { /* Link Power Management */ 750 __u8 bLength; 751 __u8 bDescriptorType; 752 __u8 bDevCapabilityType; 753 __u8 bmAttributes; 754 #define USB_LTM_SUPPORT (1 << 1) /* supports LTM */ 755 __le16 wSpeedSupported; 756 #define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */ 757 #define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */ 758 #define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */ 759 #define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */ 760 __u8 bFunctionalitySupport; 761 __u8 bU1devExitLat; 762 __le16 bU2DevExitLat; 763 } __attribute__((packed)); 764 765 #define USB_DT_USB_SS_CAP_SIZE 10 766 767 /* 768 * Container ID Capability descriptor: Defines the instance unique ID used to 769 * identify the instance across all operating modes 770 */ 771 #define CONTAINER_ID_TYPE 4 772 struct usb_ss_container_id_descriptor { 773 __u8 bLength; 774 __u8 bDescriptorType; 775 __u8 bDevCapabilityType; 776 __u8 bReserved; 777 __u8 ContainerID[16]; /* 128-bit number */ 778 } __attribute__((packed)); 779 780 #define USB_DT_USB_SS_CONTN_ID_SIZE 20 781 /*-------------------------------------------------------------------------*/ 782 783 /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with 784 * each endpoint descriptor for a wireless device 785 */ 786 struct usb_wireless_ep_comp_descriptor { 787 __u8 bLength; 788 __u8 bDescriptorType; 789 790 __u8 bMaxBurst; 791 __u8 bMaxSequence; 792 __le16 wMaxStreamDelay; 793 __le16 wOverTheAirPacketSize; 794 __u8 bOverTheAirInterval; 795 __u8 bmCompAttributes; 796 #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */ 797 #define USB_ENDPOINT_SWITCH_NO 0 798 #define USB_ENDPOINT_SWITCH_SWITCH 1 799 #define USB_ENDPOINT_SWITCH_SCALE 2 800 } __attribute__((packed)); 801 802 /*-------------------------------------------------------------------------*/ 803 804 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless 805 * host and a device for connection set up, mutual authentication, and 806 * exchanging short lived session keys. The handshake depends on a CC. 807 */ 808 struct usb_handshake { 809 __u8 bMessageNumber; 810 __u8 bStatus; 811 __u8 tTKID[3]; 812 __u8 bReserved; 813 __u8 CDID[16]; 814 __u8 nonce[16]; 815 __u8 MIC[8]; 816 } __attribute__((packed)); 817 818 /*-------------------------------------------------------------------------*/ 819 820 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC). 821 * A CC may also be set up using non-wireless secure channels (including 822 * wired USB!), and some devices may support CCs with multiple hosts. 823 */ 824 struct usb_connection_context { 825 __u8 CHID[16]; /* persistent host id */ 826 __u8 CDID[16]; /* device id (unique w/in host context) */ 827 __u8 CK[16]; /* connection key */ 828 } __attribute__((packed)); 829 830 /*-------------------------------------------------------------------------*/ 831 832 /* USB 2.0 defines three speeds, here's how Linux identifies them */ 833 834 enum usb_device_speed { 835 USB_SPEED_UNKNOWN = 0, /* enumerating */ 836 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */ 837 USB_SPEED_HIGH, /* usb 2.0 */ 838 USB_SPEED_WIRELESS, /* wireless (usb 2.5) */ 839 USB_SPEED_SUPER, /* usb 3.0 */ 840 }; 841 842 enum usb_device_state { 843 /* NOTATTACHED isn't in the USB spec, and this state acts 844 * the same as ATTACHED ... but it's clearer this way. 845 */ 846 USB_STATE_NOTATTACHED = 0, 847 848 /* chapter 9 and authentication (wireless) device states */ 849 USB_STATE_ATTACHED, 850 USB_STATE_POWERED, /* wired */ 851 USB_STATE_RECONNECTING, /* auth */ 852 USB_STATE_UNAUTHENTICATED, /* auth */ 853 USB_STATE_DEFAULT, /* limited function */ 854 USB_STATE_ADDRESS, 855 USB_STATE_CONFIGURED, /* most functions */ 856 857 USB_STATE_SUSPENDED 858 859 /* NOTE: there are actually four different SUSPENDED 860 * states, returning to POWERED, DEFAULT, ADDRESS, or 861 * CONFIGURED respectively when SOF tokens flow again. 862 * At this level there's no difference between L1 and L2 863 * suspend states. (L2 being original USB 1.1 suspend.) 864 */ 865 }; 866 867 /*-------------------------------------------------------------------------*/ 868 869 /* 870 * As per USB compliance update, a device that is actively drawing 871 * more than 100mA from USB must report itself as bus-powered in 872 * the GetStatus(DEVICE) call. 873 * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34 874 */ 875 #define USB_SELF_POWER_VBUS_MAX_DRAW 100 876 877 #endif /* __LINUX_USB_CH9_H */ 878