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