1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2 /* 3 * This file holds USB constants and structures that are needed for 4 * USB device APIs. These are used by the USB device model, which is 5 * defined in chapter 9 of the USB 2.0 specification and in the 6 * Wireless USB 1.0 spec (now defunct). Linux has several APIs in C that 7 * need these: 8 * 9 * - the master/host side Linux-USB kernel driver API; 10 * - the "usbfs" user space API; and 11 * - the Linux "gadget" slave/device/peripheral side driver API. 12 * 13 * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems 14 * act either as a USB master/host or as a USB slave/device. That means 15 * the master and slave side APIs benefit from working well together. 16 * 17 * Note all descriptors are declared '__attribute__((packed))' so that: 18 * 19 * [a] they never get padded, either internally (USB spec writers 20 * probably handled that) or externally; 21 * 22 * [b] so that accessing bigger-than-a-bytes fields will never 23 * generate bus errors on any platform, even when the location of 24 * its descriptor inside a bundle isn't "naturally aligned", and 25 * 26 * [c] for consistency, removing all doubt even when it appears to 27 * someone that the two other points are non-issues for that 28 * particular descriptor type. 29 */ 30 31 #ifndef _UAPI__LINUX_USB_CH9_H 32 #define _UAPI__LINUX_USB_CH9_H 33 34 #include <linux/types.h> /* __u8 etc */ 35 #include <asm/byteorder.h> /* le16_to_cpu */ 36 37 /*-------------------------------------------------------------------------*/ 38 39 /* CONTROL REQUEST SUPPORT */ 40 41 /* 42 * USB directions 43 * 44 * This bit flag is used in endpoint descriptors' bEndpointAddress field. 45 * It's also one of three fields in control requests bRequestType. 46 */ 47 #define USB_DIR_OUT 0 /* to device */ 48 #define USB_DIR_IN 0x80 /* to host */ 49 50 /* 51 * USB types, the second of three bRequestType fields 52 */ 53 #define USB_TYPE_MASK (0x03 << 5) 54 #define USB_TYPE_STANDARD (0x00 << 5) 55 #define USB_TYPE_CLASS (0x01 << 5) 56 #define USB_TYPE_VENDOR (0x02 << 5) 57 #define USB_TYPE_RESERVED (0x03 << 5) 58 59 /* 60 * USB recipients, the third of three bRequestType fields 61 */ 62 #define USB_RECIP_MASK 0x1f 63 #define USB_RECIP_DEVICE 0x00 64 #define USB_RECIP_INTERFACE 0x01 65 #define USB_RECIP_ENDPOINT 0x02 66 #define USB_RECIP_OTHER 0x03 67 /* From Wireless USB 1.0 */ 68 #define USB_RECIP_PORT 0x04 69 #define USB_RECIP_RPIPE 0x05 70 71 /* 72 * Standard requests, for the bRequest field of a SETUP packet. 73 * 74 * These are qualified by the bRequestType field, so that for example 75 * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved 76 * by a GET_STATUS request. 77 */ 78 #define USB_REQ_GET_STATUS 0x00 79 #define USB_REQ_CLEAR_FEATURE 0x01 80 #define USB_REQ_SET_FEATURE 0x03 81 #define USB_REQ_SET_ADDRESS 0x05 82 #define USB_REQ_GET_DESCRIPTOR 0x06 83 #define USB_REQ_SET_DESCRIPTOR 0x07 84 #define USB_REQ_GET_CONFIGURATION 0x08 85 #define USB_REQ_SET_CONFIGURATION 0x09 86 #define USB_REQ_GET_INTERFACE 0x0A 87 #define USB_REQ_SET_INTERFACE 0x0B 88 #define USB_REQ_SYNCH_FRAME 0x0C 89 #define USB_REQ_SET_SEL 0x30 90 #define USB_REQ_SET_ISOCH_DELAY 0x31 91 92 #define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */ 93 #define USB_REQ_GET_ENCRYPTION 0x0E 94 #define USB_REQ_RPIPE_ABORT 0x0E 95 #define USB_REQ_SET_HANDSHAKE 0x0F 96 #define USB_REQ_RPIPE_RESET 0x0F 97 #define USB_REQ_GET_HANDSHAKE 0x10 98 #define USB_REQ_SET_CONNECTION 0x11 99 #define USB_REQ_SET_SECURITY_DATA 0x12 100 #define USB_REQ_GET_SECURITY_DATA 0x13 101 #define USB_REQ_SET_WUSB_DATA 0x14 102 #define USB_REQ_LOOPBACK_DATA_WRITE 0x15 103 #define USB_REQ_LOOPBACK_DATA_READ 0x16 104 #define USB_REQ_SET_INTERFACE_DS 0x17 105 106 /* specific requests for USB Power Delivery */ 107 #define USB_REQ_GET_PARTNER_PDO 20 108 #define USB_REQ_GET_BATTERY_STATUS 21 109 #define USB_REQ_SET_PDO 22 110 #define USB_REQ_GET_VDM 23 111 #define USB_REQ_SEND_VDM 24 112 113 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command, 114 * used by hubs to put ports into a new L1 suspend state, except that it 115 * forgot to define its number ... 116 */ 117 118 /* 119 * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and 120 * are read as a bit array returned by USB_REQ_GET_STATUS. (So there 121 * are at most sixteen features of each type.) Hubs may also support a 122 * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend. 123 */ 124 #define USB_DEVICE_SELF_POWERED 0 /* (read only) */ 125 #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */ 126 #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */ 127 #define USB_DEVICE_BATTERY 2 /* (wireless) */ 128 #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */ 129 #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/ 130 #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */ 131 #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */ 132 #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */ 133 134 /* 135 * Test Mode Selectors 136 * See USB 2.0 spec Table 9-7 137 */ 138 #define USB_TEST_J 1 139 #define USB_TEST_K 2 140 #define USB_TEST_SE0_NAK 3 141 #define USB_TEST_PACKET 4 142 #define USB_TEST_FORCE_ENABLE 5 143 144 /* Status Type */ 145 #define USB_STATUS_TYPE_STANDARD 0 146 #define USB_STATUS_TYPE_PTM 1 147 148 /* 149 * New Feature Selectors as added by USB 3.0 150 * See USB 3.0 spec Table 9-7 151 */ 152 #define USB_DEVICE_U1_ENABLE 48 /* dev may initiate U1 transition */ 153 #define USB_DEVICE_U2_ENABLE 49 /* dev may initiate U2 transition */ 154 #define USB_DEVICE_LTM_ENABLE 50 /* dev may send LTM */ 155 #define USB_INTRF_FUNC_SUSPEND 0 /* function suspend */ 156 157 #define USB_INTR_FUNC_SUSPEND_OPT_MASK 0xFF00 158 /* 159 * Suspend Options, Table 9-8 USB 3.0 spec 160 */ 161 #define USB_INTRF_FUNC_SUSPEND_LP (1 << (8 + 0)) 162 #define USB_INTRF_FUNC_SUSPEND_RW (1 << (8 + 1)) 163 164 /* 165 * Interface status, Figure 9-5 USB 3.0 spec 166 */ 167 #define USB_INTRF_STAT_FUNC_RW_CAP 1 168 #define USB_INTRF_STAT_FUNC_RW 2 169 170 #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */ 171 172 /* Bit array elements as returned by the USB_REQ_GET_STATUS request. */ 173 #define USB_DEV_STAT_U1_ENABLED 2 /* transition into U1 state */ 174 #define USB_DEV_STAT_U2_ENABLED 3 /* transition into U2 state */ 175 #define USB_DEV_STAT_LTM_ENABLED 4 /* Latency tolerance messages */ 176 177 /* 178 * Feature selectors from Table 9-8 USB Power Delivery spec 179 */ 180 #define USB_DEVICE_BATTERY_WAKE_MASK 40 181 #define USB_DEVICE_OS_IS_PD_AWARE 41 182 #define USB_DEVICE_POLICY_MODE 42 183 #define USB_PORT_PR_SWAP 43 184 #define USB_PORT_GOTO_MIN 44 185 #define USB_PORT_RETURN_POWER 45 186 #define USB_PORT_ACCEPT_PD_REQUEST 46 187 #define USB_PORT_REJECT_PD_REQUEST 47 188 #define USB_PORT_PORT_PD_RESET 48 189 #define USB_PORT_C_PORT_PD_CHANGE 49 190 #define USB_PORT_CABLE_PD_RESET 50 191 #define USB_DEVICE_CHARGING_POLICY 54 192 193 /** 194 * struct usb_ctrlrequest - SETUP data for a USB device control request 195 * @bRequestType: matches the USB bmRequestType field 196 * @bRequest: matches the USB bRequest field 197 * @wValue: matches the USB wValue field (le16 byte order) 198 * @wIndex: matches the USB wIndex field (le16 byte order) 199 * @wLength: matches the USB wLength field (le16 byte order) 200 * 201 * This structure is used to send control requests to a USB device. It matches 202 * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the 203 * USB spec for a fuller description of the different fields, and what they are 204 * used for. 205 * 206 * Note that the driver for any interface can issue control requests. 207 * For most devices, interfaces don't coordinate with each other, so 208 * such requests may be made at any time. 209 */ 210 struct usb_ctrlrequest { 211 __u8 bRequestType; 212 __u8 bRequest; 213 __le16 wValue; 214 __le16 wIndex; 215 __le16 wLength; 216 } __attribute__ ((packed)); 217 218 /*-------------------------------------------------------------------------*/ 219 220 /* 221 * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or 222 * (rarely) accepted by SET_DESCRIPTOR. 223 * 224 * Note that all multi-byte values here are encoded in little endian 225 * byte order "on the wire". Within the kernel and when exposed 226 * through the Linux-USB APIs, they are not converted to cpu byte 227 * order; it is the responsibility of the client code to do this. 228 * The single exception is when device and configuration descriptors (but 229 * not other descriptors) are read from character devices 230 * (i.e. /dev/bus/usb/BBB/DDD); 231 * in this case the fields are converted to host endianness by the kernel. 232 */ 233 234 /* 235 * Descriptor types ... USB 2.0 spec table 9.5 236 */ 237 #define USB_DT_DEVICE 0x01 238 #define USB_DT_CONFIG 0x02 239 #define USB_DT_STRING 0x03 240 #define USB_DT_INTERFACE 0x04 241 #define USB_DT_ENDPOINT 0x05 242 #define USB_DT_DEVICE_QUALIFIER 0x06 243 #define USB_DT_OTHER_SPEED_CONFIG 0x07 244 #define USB_DT_INTERFACE_POWER 0x08 245 /* these are from a minor usb 2.0 revision (ECN) */ 246 #define USB_DT_OTG 0x09 247 #define USB_DT_DEBUG 0x0a 248 #define USB_DT_INTERFACE_ASSOCIATION 0x0b 249 /* these are from the Wireless USB spec */ 250 #define USB_DT_SECURITY 0x0c 251 #define USB_DT_KEY 0x0d 252 #define USB_DT_ENCRYPTION_TYPE 0x0e 253 #define USB_DT_BOS 0x0f 254 #define USB_DT_DEVICE_CAPABILITY 0x10 255 #define USB_DT_WIRELESS_ENDPOINT_COMP 0x11 256 #define USB_DT_WIRE_ADAPTER 0x21 257 /* From USB Device Firmware Upgrade Specification, Revision 1.1 */ 258 #define USB_DT_DFU_FUNCTIONAL 0x21 259 /* these are from the Wireless USB spec */ 260 #define USB_DT_RPIPE 0x22 261 #define USB_DT_CS_RADIO_CONTROL 0x23 262 /* From the T10 UAS specification */ 263 #define USB_DT_PIPE_USAGE 0x24 264 /* From the USB 3.0 spec */ 265 #define USB_DT_SS_ENDPOINT_COMP 0x30 266 /* From the USB 3.1 spec */ 267 #define USB_DT_SSP_ISOC_ENDPOINT_COMP 0x31 268 269 /* Conventional codes for class-specific descriptors. The convention is 270 * defined in the USB "Common Class" Spec (3.11). Individual class specs 271 * are authoritative for their usage, not the "common class" writeup. 272 */ 273 #define USB_DT_CS_DEVICE (USB_TYPE_CLASS | USB_DT_DEVICE) 274 #define USB_DT_CS_CONFIG (USB_TYPE_CLASS | USB_DT_CONFIG) 275 #define USB_DT_CS_STRING (USB_TYPE_CLASS | USB_DT_STRING) 276 #define USB_DT_CS_INTERFACE (USB_TYPE_CLASS | USB_DT_INTERFACE) 277 #define USB_DT_CS_ENDPOINT (USB_TYPE_CLASS | USB_DT_ENDPOINT) 278 279 /* All standard descriptors have these 2 fields at the beginning */ 280 struct usb_descriptor_header { 281 __u8 bLength; 282 __u8 bDescriptorType; 283 } __attribute__ ((packed)); 284 285 286 /*-------------------------------------------------------------------------*/ 287 288 /* USB_DT_DEVICE: Device descriptor */ 289 struct usb_device_descriptor { 290 __u8 bLength; 291 __u8 bDescriptorType; 292 293 __le16 bcdUSB; 294 __u8 bDeviceClass; 295 __u8 bDeviceSubClass; 296 __u8 bDeviceProtocol; 297 __u8 bMaxPacketSize0; 298 __le16 idVendor; 299 __le16 idProduct; 300 __le16 bcdDevice; 301 __u8 iManufacturer; 302 __u8 iProduct; 303 __u8 iSerialNumber; 304 __u8 bNumConfigurations; 305 } __attribute__ ((packed)); 306 307 #define USB_DT_DEVICE_SIZE 18 308 309 310 /* 311 * Device and/or Interface Class codes 312 * as found in bDeviceClass or bInterfaceClass 313 * and defined by www.usb.org documents 314 */ 315 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */ 316 #define USB_CLASS_AUDIO 1 317 #define USB_CLASS_COMM 2 318 #define USB_CLASS_HID 3 319 #define USB_CLASS_PHYSICAL 5 320 #define USB_CLASS_STILL_IMAGE 6 321 #define USB_CLASS_PRINTER 7 322 #define USB_CLASS_MASS_STORAGE 8 323 #define USB_CLASS_HUB 9 324 #define USB_CLASS_CDC_DATA 0x0a 325 #define USB_CLASS_CSCID 0x0b /* chip+ smart card */ 326 #define USB_CLASS_CONTENT_SEC 0x0d /* content security */ 327 #define USB_CLASS_VIDEO 0x0e 328 #define USB_CLASS_WIRELESS_CONTROLLER 0xe0 329 #define USB_CLASS_PERSONAL_HEALTHCARE 0x0f 330 #define USB_CLASS_AUDIO_VIDEO 0x10 331 #define USB_CLASS_BILLBOARD 0x11 332 #define USB_CLASS_USB_TYPE_C_BRIDGE 0x12 333 #define USB_CLASS_MCTP 0x14 334 #define USB_CLASS_MISC 0xef 335 #define USB_CLASS_APP_SPEC 0xfe 336 #define USB_SUBCLASS_DFU 0x01 337 338 #define USB_CLASS_VENDOR_SPEC 0xff 339 #define USB_SUBCLASS_VENDOR_SPEC 0xff 340 341 /*-------------------------------------------------------------------------*/ 342 343 /* USB_DT_CONFIG: Configuration descriptor information. 344 * 345 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the 346 * descriptor type is different. Highspeed-capable devices can look 347 * different depending on what speed they're currently running. Only 348 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG 349 * descriptors. 350 */ 351 struct usb_config_descriptor { 352 __u8 bLength; 353 __u8 bDescriptorType; 354 355 __le16 wTotalLength; 356 __u8 bNumInterfaces; 357 __u8 bConfigurationValue; 358 __u8 iConfiguration; 359 __u8 bmAttributes; 360 __u8 bMaxPower; 361 } __attribute__ ((packed)); 362 363 #define USB_DT_CONFIG_SIZE 9 364 365 /* from config descriptor bmAttributes */ 366 #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */ 367 #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */ 368 #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */ 369 #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */ 370 371 /*-------------------------------------------------------------------------*/ 372 373 /* USB String descriptors can contain at most 126 characters. */ 374 #define USB_MAX_STRING_LEN 126 375 376 /* USB_DT_STRING: String descriptor */ 377 struct usb_string_descriptor { 378 __u8 bLength; 379 __u8 bDescriptorType; 380 381 union { 382 __le16 legacy_padding; 383 __DECLARE_FLEX_ARRAY(__le16, wData); /* UTF-16LE encoded */ 384 }; 385 } __attribute__ ((packed)); 386 387 /* note that "string" zero is special, it holds language codes that 388 * the device supports, not Unicode characters. 389 */ 390 391 /*-------------------------------------------------------------------------*/ 392 393 /* USB_DT_INTERFACE: Interface descriptor */ 394 struct usb_interface_descriptor { 395 __u8 bLength; 396 __u8 bDescriptorType; 397 398 __u8 bInterfaceNumber; 399 __u8 bAlternateSetting; 400 __u8 bNumEndpoints; 401 __u8 bInterfaceClass; 402 __u8 bInterfaceSubClass; 403 __u8 bInterfaceProtocol; 404 __u8 iInterface; 405 } __attribute__ ((packed)); 406 407 #define USB_DT_INTERFACE_SIZE 9 408 409 /*-------------------------------------------------------------------------*/ 410 411 /* USB_DT_ENDPOINT: Endpoint descriptor */ 412 struct usb_endpoint_descriptor { 413 __u8 bLength; 414 __u8 bDescriptorType; 415 416 __u8 bEndpointAddress; 417 __u8 bmAttributes; 418 __le16 wMaxPacketSize; 419 __u8 bInterval; 420 421 /* NOTE: these two are _only_ in audio endpoints. */ 422 /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */ 423 __u8 bRefresh; 424 __u8 bSynchAddress; 425 } __attribute__ ((packed)); 426 427 #define USB_DT_ENDPOINT_SIZE 7 428 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ 429 430 431 /* 432 * Endpoints 433 */ 434 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ 435 #define USB_ENDPOINT_DIR_MASK 0x80 436 437 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ 438 #define USB_ENDPOINT_XFER_CONTROL 0 439 #define USB_ENDPOINT_XFER_ISOC 1 440 #define USB_ENDPOINT_XFER_BULK 2 441 #define USB_ENDPOINT_XFER_INT 3 442 #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80 443 444 #define USB_ENDPOINT_MAXP_MASK 0x07ff 445 #define USB_EP_MAXP_MULT_SHIFT 11 446 #define USB_EP_MAXP_MULT_MASK (3 << USB_EP_MAXP_MULT_SHIFT) 447 #define USB_EP_MAXP_MULT(m) \ 448 (((m) & USB_EP_MAXP_MULT_MASK) >> USB_EP_MAXP_MULT_SHIFT) 449 450 /* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */ 451 #define USB_ENDPOINT_INTRTYPE 0x30 452 #define USB_ENDPOINT_INTR_PERIODIC (0 << 4) 453 #define USB_ENDPOINT_INTR_NOTIFICATION (1 << 4) 454 455 #define USB_ENDPOINT_SYNCTYPE 0x0c 456 #define USB_ENDPOINT_SYNC_NONE (0 << 2) 457 #define USB_ENDPOINT_SYNC_ASYNC (1 << 2) 458 #define USB_ENDPOINT_SYNC_ADAPTIVE (2 << 2) 459 #define USB_ENDPOINT_SYNC_SYNC (3 << 2) 460 461 #define USB_ENDPOINT_USAGE_MASK 0x30 462 #define USB_ENDPOINT_USAGE_DATA 0x00 463 #define USB_ENDPOINT_USAGE_FEEDBACK 0x10 464 #define USB_ENDPOINT_USAGE_IMPLICIT_FB 0x20 /* Implicit feedback Data endpoint */ 465 466 /*-------------------------------------------------------------------------*/ 467 468 /** 469 * usb_endpoint_num - get the endpoint's number 470 * @epd: endpoint to be checked 471 * 472 * Returns @epd's number: 0 to 15. 473 */ 474 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd) 475 { 476 return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK; 477 } 478 479 /** 480 * usb_endpoint_type - get the endpoint's transfer type 481 * @epd: endpoint to be checked 482 * 483 * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according 484 * to @epd's transfer type. 485 */ 486 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd) 487 { 488 return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK; 489 } 490 491 /** 492 * usb_endpoint_dir_in - check if the endpoint has IN direction 493 * @epd: endpoint to be checked 494 * 495 * Returns true if the endpoint is of type IN, otherwise it returns false. 496 */ 497 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd) 498 { 499 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN); 500 } 501 502 /** 503 * usb_endpoint_dir_out - check if the endpoint has OUT direction 504 * @epd: endpoint to be checked 505 * 506 * Returns true if the endpoint is of type OUT, otherwise it returns false. 507 */ 508 static inline int usb_endpoint_dir_out( 509 const struct usb_endpoint_descriptor *epd) 510 { 511 return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT); 512 } 513 514 /** 515 * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type 516 * @epd: endpoint to be checked 517 * 518 * Returns true if the endpoint is of type bulk, otherwise it returns false. 519 */ 520 static inline int usb_endpoint_xfer_bulk( 521 const struct usb_endpoint_descriptor *epd) 522 { 523 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 524 USB_ENDPOINT_XFER_BULK); 525 } 526 527 /** 528 * usb_endpoint_xfer_control - check if the endpoint has control transfer type 529 * @epd: endpoint to be checked 530 * 531 * Returns true if the endpoint is of type control, otherwise it returns false. 532 */ 533 static inline int usb_endpoint_xfer_control( 534 const struct usb_endpoint_descriptor *epd) 535 { 536 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 537 USB_ENDPOINT_XFER_CONTROL); 538 } 539 540 /** 541 * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type 542 * @epd: endpoint to be checked 543 * 544 * Returns true if the endpoint is of type interrupt, otherwise it returns 545 * false. 546 */ 547 static inline int usb_endpoint_xfer_int( 548 const struct usb_endpoint_descriptor *epd) 549 { 550 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 551 USB_ENDPOINT_XFER_INT); 552 } 553 554 /** 555 * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type 556 * @epd: endpoint to be checked 557 * 558 * Returns true if the endpoint is of type isochronous, otherwise it returns 559 * false. 560 */ 561 static inline int usb_endpoint_xfer_isoc( 562 const struct usb_endpoint_descriptor *epd) 563 { 564 return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 565 USB_ENDPOINT_XFER_ISOC); 566 } 567 568 /** 569 * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN 570 * @epd: endpoint to be checked 571 * 572 * Returns true if the endpoint has bulk transfer type and IN direction, 573 * otherwise it returns false. 574 */ 575 static inline int usb_endpoint_is_bulk_in( 576 const struct usb_endpoint_descriptor *epd) 577 { 578 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd); 579 } 580 581 /** 582 * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT 583 * @epd: endpoint to be checked 584 * 585 * Returns true if the endpoint has bulk transfer type and OUT direction, 586 * otherwise it returns false. 587 */ 588 static inline int usb_endpoint_is_bulk_out( 589 const struct usb_endpoint_descriptor *epd) 590 { 591 return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd); 592 } 593 594 /** 595 * usb_endpoint_is_int_in - check if the endpoint is interrupt IN 596 * @epd: endpoint to be checked 597 * 598 * Returns true if the endpoint has interrupt transfer type and IN direction, 599 * otherwise it returns false. 600 */ 601 static inline int usb_endpoint_is_int_in( 602 const struct usb_endpoint_descriptor *epd) 603 { 604 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd); 605 } 606 607 /** 608 * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT 609 * @epd: endpoint to be checked 610 * 611 * Returns true if the endpoint has interrupt transfer type and OUT direction, 612 * otherwise it returns false. 613 */ 614 static inline int usb_endpoint_is_int_out( 615 const struct usb_endpoint_descriptor *epd) 616 { 617 return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd); 618 } 619 620 /** 621 * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN 622 * @epd: endpoint to be checked 623 * 624 * Returns true if the endpoint has isochronous transfer type and IN direction, 625 * otherwise it returns false. 626 */ 627 static inline int usb_endpoint_is_isoc_in( 628 const struct usb_endpoint_descriptor *epd) 629 { 630 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd); 631 } 632 633 /** 634 * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT 635 * @epd: endpoint to be checked 636 * 637 * Returns true if the endpoint has isochronous transfer type and OUT direction, 638 * otherwise it returns false. 639 */ 640 static inline int usb_endpoint_is_isoc_out( 641 const struct usb_endpoint_descriptor *epd) 642 { 643 return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd); 644 } 645 646 /** 647 * usb_endpoint_maxp - get endpoint's max packet size 648 * @epd: endpoint to be checked 649 * 650 * Returns @epd's max packet bits [10:0] 651 */ 652 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd) 653 { 654 return __le16_to_cpu(epd->wMaxPacketSize) & USB_ENDPOINT_MAXP_MASK; 655 } 656 657 /** 658 * usb_endpoint_maxp_mult - get endpoint's transactional opportunities 659 * @epd: endpoint to be checked 660 * 661 * Return @epd's wMaxPacketSize[12:11] + 1 662 */ 663 static inline int 664 usb_endpoint_maxp_mult(const struct usb_endpoint_descriptor *epd) 665 { 666 int maxp = __le16_to_cpu(epd->wMaxPacketSize); 667 668 return USB_EP_MAXP_MULT(maxp) + 1; 669 } 670 671 static inline int usb_endpoint_interrupt_type( 672 const struct usb_endpoint_descriptor *epd) 673 { 674 return epd->bmAttributes & USB_ENDPOINT_INTRTYPE; 675 } 676 677 /*-------------------------------------------------------------------------*/ 678 679 /* USB_DT_SSP_ISOC_ENDPOINT_COMP: SuperSpeedPlus Isochronous Endpoint Companion 680 * descriptor 681 */ 682 struct usb_ssp_isoc_ep_comp_descriptor { 683 __u8 bLength; 684 __u8 bDescriptorType; 685 __le16 wReseved; 686 __le32 dwBytesPerInterval; 687 } __attribute__ ((packed)); 688 689 #define USB_DT_SSP_ISOC_EP_COMP_SIZE 8 690 691 /*-------------------------------------------------------------------------*/ 692 693 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */ 694 struct usb_ss_ep_comp_descriptor { 695 __u8 bLength; 696 __u8 bDescriptorType; 697 698 __u8 bMaxBurst; 699 __u8 bmAttributes; 700 __le16 wBytesPerInterval; 701 } __attribute__ ((packed)); 702 703 #define USB_DT_SS_EP_COMP_SIZE 6 704 705 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */ 706 static inline int 707 usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp) 708 { 709 int max_streams; 710 711 if (!comp) 712 return 0; 713 714 max_streams = comp->bmAttributes & 0x1f; 715 716 if (!max_streams) 717 return 0; 718 719 max_streams = 1 << max_streams; 720 721 return max_streams; 722 } 723 724 /* Bits 1:0 of bmAttributes if this is an isoc endpoint */ 725 #define USB_SS_MULT(p) (1 + ((p) & 0x3)) 726 /* Bit 7 of bmAttributes if a SSP isoc endpoint companion descriptor exists */ 727 #define USB_SS_SSP_ISOC_COMP(p) ((p) & (1 << 7)) 728 729 /*-------------------------------------------------------------------------*/ 730 731 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */ 732 struct usb_qualifier_descriptor { 733 __u8 bLength; 734 __u8 bDescriptorType; 735 736 __le16 bcdUSB; 737 __u8 bDeviceClass; 738 __u8 bDeviceSubClass; 739 __u8 bDeviceProtocol; 740 __u8 bMaxPacketSize0; 741 __u8 bNumConfigurations; 742 __u8 bRESERVED; 743 } __attribute__ ((packed)); 744 745 746 /*-------------------------------------------------------------------------*/ 747 748 /* USB_DT_OTG (from OTG 1.0a supplement) */ 749 struct usb_otg_descriptor { 750 __u8 bLength; 751 __u8 bDescriptorType; 752 753 __u8 bmAttributes; /* support for HNP, SRP, etc */ 754 } __attribute__ ((packed)); 755 756 /* USB_DT_OTG (from OTG 2.0 supplement) */ 757 struct usb_otg20_descriptor { 758 __u8 bLength; 759 __u8 bDescriptorType; 760 761 __u8 bmAttributes; /* support for HNP, SRP and ADP, etc */ 762 __le16 bcdOTG; /* OTG and EH supplement release number 763 * in binary-coded decimal(i.e. 2.0 is 0200H) 764 */ 765 } __attribute__ ((packed)); 766 767 /* from usb_otg_descriptor.bmAttributes */ 768 #define USB_OTG_SRP (1 << 0) 769 #define USB_OTG_HNP (1 << 1) /* swap host/device roles */ 770 #define USB_OTG_ADP (1 << 2) /* support ADP */ 771 /* OTG 3.0 */ 772 #define USB_OTG_RSP (1 << 3) /* support RSP */ 773 774 #define OTG_STS_SELECTOR 0xF000 /* OTG status selector */ 775 /*-------------------------------------------------------------------------*/ 776 777 /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */ 778 struct usb_debug_descriptor { 779 __u8 bLength; 780 __u8 bDescriptorType; 781 782 /* bulk endpoints with 8 byte maxpacket */ 783 __u8 bDebugInEndpoint; 784 __u8 bDebugOutEndpoint; 785 } __attribute__((packed)); 786 787 /*-------------------------------------------------------------------------*/ 788 789 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */ 790 struct usb_interface_assoc_descriptor { 791 __u8 bLength; 792 __u8 bDescriptorType; 793 794 __u8 bFirstInterface; 795 __u8 bInterfaceCount; 796 __u8 bFunctionClass; 797 __u8 bFunctionSubClass; 798 __u8 bFunctionProtocol; 799 __u8 iFunction; 800 } __attribute__ ((packed)); 801 802 #define USB_DT_INTERFACE_ASSOCIATION_SIZE 8 803 804 /*-------------------------------------------------------------------------*/ 805 806 /* USB_DT_SECURITY: group of wireless security descriptors, including 807 * encryption types available for setting up a CC/association. 808 */ 809 struct usb_security_descriptor { 810 __u8 bLength; 811 __u8 bDescriptorType; 812 813 __le16 wTotalLength; 814 __u8 bNumEncryptionTypes; 815 } __attribute__((packed)); 816 817 /*-------------------------------------------------------------------------*/ 818 819 /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys 820 * may be retrieved. 821 */ 822 struct usb_key_descriptor { 823 __u8 bLength; 824 __u8 bDescriptorType; 825 826 __u8 tTKID[3]; 827 __u8 bReserved; 828 __u8 bKeyData[]; 829 } __attribute__((packed)); 830 831 /*-------------------------------------------------------------------------*/ 832 833 /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */ 834 struct usb_encryption_descriptor { 835 __u8 bLength; 836 __u8 bDescriptorType; 837 838 __u8 bEncryptionType; 839 #define USB_ENC_TYPE_UNSECURE 0 840 #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */ 841 #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */ 842 #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */ 843 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */ 844 __u8 bAuthKeyIndex; 845 } __attribute__((packed)); 846 847 848 /*-------------------------------------------------------------------------*/ 849 850 /* USB_DT_BOS: group of device-level capabilities */ 851 struct usb_bos_descriptor { 852 __u8 bLength; 853 __u8 bDescriptorType; 854 855 __le16 wTotalLength; 856 __u8 bNumDeviceCaps; 857 } __attribute__((packed)); 858 859 #define USB_DT_BOS_SIZE 5 860 /*-------------------------------------------------------------------------*/ 861 862 /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */ 863 struct usb_dev_cap_header { 864 __u8 bLength; 865 __u8 bDescriptorType; 866 __u8 bDevCapabilityType; 867 } __attribute__((packed)); 868 869 #define USB_CAP_TYPE_WIRELESS_USB 1 870 871 struct usb_wireless_cap_descriptor { /* Ultra Wide Band */ 872 __u8 bLength; 873 __u8 bDescriptorType; 874 __u8 bDevCapabilityType; 875 876 __u8 bmAttributes; 877 #define USB_WIRELESS_P2P_DRD (1 << 1) 878 #define USB_WIRELESS_BEACON_MASK (3 << 2) 879 #define USB_WIRELESS_BEACON_SELF (1 << 2) 880 #define USB_WIRELESS_BEACON_DIRECTED (2 << 2) 881 #define USB_WIRELESS_BEACON_NONE (3 << 2) 882 __le16 wPHYRates; /* bit rates, Mbps */ 883 #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */ 884 #define USB_WIRELESS_PHY_80 (1 << 1) 885 #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */ 886 #define USB_WIRELESS_PHY_160 (1 << 3) 887 #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */ 888 #define USB_WIRELESS_PHY_320 (1 << 5) 889 #define USB_WIRELESS_PHY_400 (1 << 6) 890 #define USB_WIRELESS_PHY_480 (1 << 7) 891 __u8 bmTFITXPowerInfo; /* TFI power levels */ 892 __u8 bmFFITXPowerInfo; /* FFI power levels */ 893 __le16 bmBandGroup; 894 __u8 bReserved; 895 } __attribute__((packed)); 896 897 #define USB_DT_USB_WIRELESS_CAP_SIZE 11 898 899 /* USB 2.0 Extension descriptor */ 900 #define USB_CAP_TYPE_EXT 2 901 902 struct usb_ext_cap_descriptor { /* Link Power Management */ 903 __u8 bLength; 904 __u8 bDescriptorType; 905 __u8 bDevCapabilityType; 906 __le32 bmAttributes; 907 #define USB_LPM_SUPPORT (1 << 1) /* supports LPM */ 908 #define USB_BESL_SUPPORT (1 << 2) /* supports BESL */ 909 #define USB_BESL_BASELINE_VALID (1 << 3) /* Baseline BESL valid*/ 910 #define USB_BESL_DEEP_VALID (1 << 4) /* Deep BESL valid */ 911 #define USB_SET_BESL_BASELINE(p) (((p) & 0xf) << 8) 912 #define USB_SET_BESL_DEEP(p) (((p) & 0xf) << 12) 913 #define USB_GET_BESL_BASELINE(p) (((p) & (0xf << 8)) >> 8) 914 #define USB_GET_BESL_DEEP(p) (((p) & (0xf << 12)) >> 12) 915 } __attribute__((packed)); 916 917 #define USB_DT_USB_EXT_CAP_SIZE 7 918 919 /* 920 * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB 921 * specific device level capabilities 922 */ 923 #define USB_SS_CAP_TYPE 3 924 struct usb_ss_cap_descriptor { /* Link Power Management */ 925 __u8 bLength; 926 __u8 bDescriptorType; 927 __u8 bDevCapabilityType; 928 __u8 bmAttributes; 929 #define USB_LTM_SUPPORT (1 << 1) /* supports LTM */ 930 __le16 wSpeedSupported; 931 #define USB_LOW_SPEED_OPERATION (1) /* Low speed operation */ 932 #define USB_FULL_SPEED_OPERATION (1 << 1) /* Full speed operation */ 933 #define USB_HIGH_SPEED_OPERATION (1 << 2) /* High speed operation */ 934 #define USB_5GBPS_OPERATION (1 << 3) /* Operation at 5Gbps */ 935 __u8 bFunctionalitySupport; 936 __u8 bU1devExitLat; 937 __le16 bU2DevExitLat; 938 } __attribute__((packed)); 939 940 #define USB_DT_USB_SS_CAP_SIZE 10 941 942 /* 943 * Container ID Capability descriptor: Defines the instance unique ID used to 944 * identify the instance across all operating modes 945 */ 946 #define CONTAINER_ID_TYPE 4 947 struct usb_ss_container_id_descriptor { 948 __u8 bLength; 949 __u8 bDescriptorType; 950 __u8 bDevCapabilityType; 951 __u8 bReserved; 952 __u8 ContainerID[16]; /* 128-bit number */ 953 } __attribute__((packed)); 954 955 #define USB_DT_USB_SS_CONTN_ID_SIZE 20 956 957 /* 958 * Platform Device Capability descriptor: Defines platform specific device 959 * capabilities 960 */ 961 #define USB_PLAT_DEV_CAP_TYPE 5 962 struct usb_plat_dev_cap_descriptor { 963 __u8 bLength; 964 __u8 bDescriptorType; 965 __u8 bDevCapabilityType; 966 __u8 bReserved; 967 __u8 UUID[16]; 968 __u8 CapabilityData[]; 969 } __attribute__((packed)); 970 971 #define USB_DT_USB_PLAT_DEV_CAP_SIZE(capability_data_size) (20 + capability_data_size) 972 973 /* 974 * SuperSpeed Plus USB Capability descriptor: Defines the set of 975 * SuperSpeed Plus USB specific device level capabilities 976 */ 977 #define USB_SSP_CAP_TYPE 0xa 978 struct usb_ssp_cap_descriptor { 979 __u8 bLength; 980 __u8 bDescriptorType; 981 __u8 bDevCapabilityType; 982 __u8 bReserved; 983 __le32 bmAttributes; 984 #define USB_SSP_SUBLINK_SPEED_ATTRIBS (0x1f << 0) /* sublink speed entries */ 985 #define USB_SSP_SUBLINK_SPEED_IDS (0xf << 5) /* speed ID entries */ 986 __le16 wFunctionalitySupport; 987 #define USB_SSP_MIN_SUBLINK_SPEED_ATTRIBUTE_ID (0xf) 988 #define USB_SSP_MIN_RX_LANE_COUNT (0xf << 8) 989 #define USB_SSP_MIN_TX_LANE_COUNT (0xf << 12) 990 __le16 wReserved; 991 union { 992 __le32 legacy_padding; 993 /* list of sublink speed attrib entries */ 994 __DECLARE_FLEX_ARRAY(__le32, bmSublinkSpeedAttr); 995 }; 996 #define USB_SSP_SUBLINK_SPEED_SSID (0xf) /* sublink speed ID */ 997 #define USB_SSP_SUBLINK_SPEED_LSE (0x3 << 4) /* Lanespeed exponent */ 998 #define USB_SSP_SUBLINK_SPEED_LSE_BPS 0 999 #define USB_SSP_SUBLINK_SPEED_LSE_KBPS 1 1000 #define USB_SSP_SUBLINK_SPEED_LSE_MBPS 2 1001 #define USB_SSP_SUBLINK_SPEED_LSE_GBPS 3 1002 1003 #define USB_SSP_SUBLINK_SPEED_ST (0x3 << 6) /* Sublink type */ 1004 #define USB_SSP_SUBLINK_SPEED_ST_SYM_RX 0 1005 #define USB_SSP_SUBLINK_SPEED_ST_ASYM_RX 1 1006 #define USB_SSP_SUBLINK_SPEED_ST_SYM_TX 2 1007 #define USB_SSP_SUBLINK_SPEED_ST_ASYM_TX 3 1008 1009 #define USB_SSP_SUBLINK_SPEED_RSVD (0x3f << 8) /* Reserved */ 1010 #define USB_SSP_SUBLINK_SPEED_LP (0x3 << 14) /* Link protocol */ 1011 #define USB_SSP_SUBLINK_SPEED_LP_SS 0 1012 #define USB_SSP_SUBLINK_SPEED_LP_SSP 1 1013 1014 #define USB_SSP_SUBLINK_SPEED_LSM (0xff << 16) /* Lanespeed mantissa */ 1015 } __attribute__((packed)); 1016 1017 /* 1018 * USB Power Delivery Capability Descriptor: 1019 * Defines capabilities for PD 1020 */ 1021 /* Defines the various PD Capabilities of this device */ 1022 #define USB_PD_POWER_DELIVERY_CAPABILITY 0x06 1023 /* Provides information on each battery supported by the device */ 1024 #define USB_PD_BATTERY_INFO_CAPABILITY 0x07 1025 /* The Consumer characteristics of a Port on the device */ 1026 #define USB_PD_PD_CONSUMER_PORT_CAPABILITY 0x08 1027 /* The provider characteristics of a Port on the device */ 1028 #define USB_PD_PD_PROVIDER_PORT_CAPABILITY 0x09 1029 1030 struct usb_pd_cap_descriptor { 1031 __u8 bLength; 1032 __u8 bDescriptorType; 1033 __u8 bDevCapabilityType; /* set to USB_PD_POWER_DELIVERY_CAPABILITY */ 1034 __u8 bReserved; 1035 __le32 bmAttributes; 1036 #define USB_PD_CAP_BATTERY_CHARGING (1 << 1) /* supports Battery Charging specification */ 1037 #define USB_PD_CAP_USB_PD (1 << 2) /* supports USB Power Delivery specification */ 1038 #define USB_PD_CAP_PROVIDER (1 << 3) /* can provide power */ 1039 #define USB_PD_CAP_CONSUMER (1 << 4) /* can consume power */ 1040 #define USB_PD_CAP_CHARGING_POLICY (1 << 5) /* supports CHARGING_POLICY feature */ 1041 #define USB_PD_CAP_TYPE_C_CURRENT (1 << 6) /* supports power capabilities defined in the USB Type-C Specification */ 1042 1043 #define USB_PD_CAP_PWR_AC (1 << 8) 1044 #define USB_PD_CAP_PWR_BAT (1 << 9) 1045 #define USB_PD_CAP_PWR_USE_V_BUS (1 << 14) 1046 1047 __le16 bmProviderPorts; /* Bit zero refers to the UFP of the device */ 1048 __le16 bmConsumerPorts; 1049 __le16 bcdBCVersion; 1050 __le16 bcdPDVersion; 1051 __le16 bcdUSBTypeCVersion; 1052 } __attribute__((packed)); 1053 1054 struct usb_pd_cap_battery_info_descriptor { 1055 __u8 bLength; 1056 __u8 bDescriptorType; 1057 __u8 bDevCapabilityType; 1058 /* Index of string descriptor shall contain the user friendly name for this battery */ 1059 __u8 iBattery; 1060 /* Index of string descriptor shall contain the Serial Number String for this battery */ 1061 __u8 iSerial; 1062 __u8 iManufacturer; 1063 __u8 bBatteryId; /* uniquely identifies this battery in status Messages */ 1064 __u8 bReserved; 1065 /* 1066 * Shall contain the Battery Charge value above which this 1067 * battery is considered to be fully charged but not necessarily 1068 * “topped off.” 1069 */ 1070 __le32 dwChargedThreshold; /* in mWh */ 1071 /* 1072 * Shall contain the minimum charge level of this battery such 1073 * that above this threshold, a device can be assured of being 1074 * able to power up successfully (see Battery Charging 1.2). 1075 */ 1076 __le32 dwWeakThreshold; /* in mWh */ 1077 __le32 dwBatteryDesignCapacity; /* in mWh */ 1078 __le32 dwBatteryLastFullchargeCapacity; /* in mWh */ 1079 } __attribute__((packed)); 1080 1081 struct usb_pd_cap_consumer_port_descriptor { 1082 __u8 bLength; 1083 __u8 bDescriptorType; 1084 __u8 bDevCapabilityType; 1085 __u8 bReserved; 1086 __u8 bmCapabilities; 1087 /* port will oerate under: */ 1088 #define USB_PD_CAP_CONSUMER_BC (1 << 0) /* BC */ 1089 #define USB_PD_CAP_CONSUMER_PD (1 << 1) /* PD */ 1090 #define USB_PD_CAP_CONSUMER_TYPE_C (1 << 2) /* USB Type-C Current */ 1091 __le16 wMinVoltage; /* in 50mV units */ 1092 __le16 wMaxVoltage; /* in 50mV units */ 1093 __u16 wReserved; 1094 __le32 dwMaxOperatingPower; /* in 10 mW - operating at steady state */ 1095 __le32 dwMaxPeakPower; /* in 10mW units - operating at peak power */ 1096 __le32 dwMaxPeakPowerTime; /* in 100ms units - duration of peak */ 1097 #define USB_PD_CAP_CONSUMER_UNKNOWN_PEAK_POWER_TIME 0xffff 1098 } __attribute__((packed)); 1099 1100 struct usb_pd_cap_provider_port_descriptor { 1101 __u8 bLength; 1102 __u8 bDescriptorType; 1103 __u8 bDevCapabilityType; 1104 __u8 bReserved1; 1105 __u8 bmCapabilities; 1106 /* port will oerate under: */ 1107 #define USB_PD_CAP_PROVIDER_BC (1 << 0) /* BC */ 1108 #define USB_PD_CAP_PROVIDER_PD (1 << 1) /* PD */ 1109 #define USB_PD_CAP_PROVIDER_TYPE_C (1 << 2) /* USB Type-C Current */ 1110 __u8 bNumOfPDObjects; 1111 __u8 bReserved2; 1112 __le32 wPowerDataObject[]; 1113 } __attribute__((packed)); 1114 1115 /* 1116 * Precision time measurement capability descriptor: advertised by devices and 1117 * hubs that support PTM 1118 */ 1119 #define USB_PTM_CAP_TYPE 0xb 1120 struct usb_ptm_cap_descriptor { 1121 __u8 bLength; 1122 __u8 bDescriptorType; 1123 __u8 bDevCapabilityType; 1124 } __attribute__((packed)); 1125 1126 #define USB_DT_USB_PTM_ID_SIZE 3 1127 /* 1128 * The size of the descriptor for the Sublink Speed Attribute Count 1129 * (SSAC) specified in bmAttributes[4:0]. SSAC is zero-based 1130 */ 1131 #define USB_DT_USB_SSP_CAP_SIZE(ssac) (12 + (ssac + 1) * 4) 1132 1133 /*-------------------------------------------------------------------------*/ 1134 1135 /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with 1136 * each endpoint descriptor for a wireless device 1137 */ 1138 struct usb_wireless_ep_comp_descriptor { 1139 __u8 bLength; 1140 __u8 bDescriptorType; 1141 1142 __u8 bMaxBurst; 1143 __u8 bMaxSequence; 1144 __le16 wMaxStreamDelay; 1145 __le16 wOverTheAirPacketSize; 1146 __u8 bOverTheAirInterval; 1147 __u8 bmCompAttributes; 1148 #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */ 1149 #define USB_ENDPOINT_SWITCH_NO 0 1150 #define USB_ENDPOINT_SWITCH_SWITCH 1 1151 #define USB_ENDPOINT_SWITCH_SCALE 2 1152 } __attribute__((packed)); 1153 1154 /*-------------------------------------------------------------------------*/ 1155 1156 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless 1157 * host and a device for connection set up, mutual authentication, and 1158 * exchanging short lived session keys. The handshake depends on a CC. 1159 */ 1160 struct usb_handshake { 1161 __u8 bMessageNumber; 1162 __u8 bStatus; 1163 __u8 tTKID[3]; 1164 __u8 bReserved; 1165 __u8 CDID[16]; 1166 __u8 nonce[16]; 1167 __u8 MIC[8]; 1168 } __attribute__((packed)); 1169 1170 /*-------------------------------------------------------------------------*/ 1171 1172 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC). 1173 * A CC may also be set up using non-wireless secure channels (including 1174 * wired USB!), and some devices may support CCs with multiple hosts. 1175 */ 1176 struct usb_connection_context { 1177 __u8 CHID[16]; /* persistent host id */ 1178 __u8 CDID[16]; /* device id (unique w/in host context) */ 1179 __u8 CK[16]; /* connection key */ 1180 } __attribute__((packed)); 1181 1182 /*-------------------------------------------------------------------------*/ 1183 1184 /* USB 2.0 defines three speeds, here's how Linux identifies them */ 1185 1186 enum usb_device_speed { 1187 USB_SPEED_UNKNOWN = 0, /* enumerating */ 1188 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */ 1189 USB_SPEED_HIGH, /* usb 2.0 */ 1190 USB_SPEED_WIRELESS, /* wireless (usb 2.5) */ 1191 USB_SPEED_SUPER, /* usb 3.0 */ 1192 USB_SPEED_SUPER_PLUS, /* usb 3.1 */ 1193 }; 1194 1195 1196 enum usb_device_state { 1197 /* NOTATTACHED isn't in the USB spec, and this state acts 1198 * the same as ATTACHED ... but it's clearer this way. 1199 */ 1200 USB_STATE_NOTATTACHED = 0, 1201 1202 /* chapter 9 and authentication (wireless) device states */ 1203 USB_STATE_ATTACHED, 1204 USB_STATE_POWERED, /* wired */ 1205 USB_STATE_RECONNECTING, /* auth */ 1206 USB_STATE_UNAUTHENTICATED, /* auth */ 1207 USB_STATE_DEFAULT, /* limited function */ 1208 USB_STATE_ADDRESS, 1209 USB_STATE_CONFIGURED, /* most functions */ 1210 1211 USB_STATE_SUSPENDED 1212 1213 /* NOTE: there are actually four different SUSPENDED 1214 * states, returning to POWERED, DEFAULT, ADDRESS, or 1215 * CONFIGURED respectively when SOF tokens flow again. 1216 * At this level there's no difference between L1 and L2 1217 * suspend states. (L2 being original USB 1.1 suspend.) 1218 */ 1219 }; 1220 1221 enum usb3_link_state { 1222 USB3_LPM_U0 = 0, 1223 USB3_LPM_U1, 1224 USB3_LPM_U2, 1225 USB3_LPM_U3 1226 }; 1227 1228 /* 1229 * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1. 1230 * 0xff means the parent hub will accept transitions to U1, but will not 1231 * initiate a transition. 1232 * 1233 * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to 1234 * U1 after that many microseconds. Timeouts of 0x80 to 0xFE are reserved 1235 * values. 1236 * 1237 * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2. 1238 * 0xff means the parent hub will accept transitions to U2, but will not 1239 * initiate a transition. 1240 * 1241 * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to 1242 * U2 after N*256 microseconds. Therefore a U2 timeout value of 0x1 means a U2 1243 * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means 1244 * 65.024ms. 1245 */ 1246 #define USB3_LPM_DISABLED 0x0 1247 #define USB3_LPM_U1_MAX_TIMEOUT 0x7F 1248 #define USB3_LPM_U2_MAX_TIMEOUT 0xFE 1249 #define USB3_LPM_DEVICE_INITIATED 0xFF 1250 1251 struct usb_set_sel_req { 1252 __u8 u1_sel; 1253 __u8 u1_pel; 1254 __le16 u2_sel; 1255 __le16 u2_pel; 1256 } __attribute__ ((packed)); 1257 1258 /* 1259 * The Set System Exit Latency control transfer provides one byte each for 1260 * U1 SEL and U1 PEL, so the max exit latency is 0xFF. U2 SEL and U2 PEL each 1261 * are two bytes long. 1262 */ 1263 #define USB3_LPM_MAX_U1_SEL_PEL 0xFF 1264 #define USB3_LPM_MAX_U2_SEL_PEL 0xFFFF 1265 1266 /*-------------------------------------------------------------------------*/ 1267 1268 /* 1269 * As per USB compliance update, a device that is actively drawing 1270 * more than 100mA from USB must report itself as bus-powered in 1271 * the GetStatus(DEVICE) call. 1272 * https://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34 1273 */ 1274 #define USB_SELF_POWER_VBUS_MAX_DRAW 100 1275 1276 #endif /* _UAPI__LINUX_USB_CH9_H */ 1277