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