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