1 /* 2 * This file holds USB constants and structures that are needed for 3 * USB device APIs. These are used by the USB device model, which is 4 * defined in chapter 9 of the USB 2.0 specification and in the 5 * Wireless USB 1.0 (spread around). Linux has several APIs in C that 6 * need these: 7 * 8 * - the master/host side Linux-USB kernel driver API; 9 * - the "usbfs" user space API; and 10 * - the Linux "gadget" slave/device/peripheral side driver API. 11 * 12 * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems 13 * act either as a USB master/host or as a USB slave/device. That means 14 * the master and slave side APIs benefit from working well together. 15 * 16 * There's also "Wireless USB", using low power short range radios for 17 * peripheral interconnection but otherwise building on the USB framework. 18 * 19 * Note all descriptors are declared '__attribute__((packed))' so that: 20 * 21 * [a] they never get padded, either internally (USB spec writers 22 * probably handled that) or externally; 23 * 24 * [b] so that accessing bigger-than-a-bytes fields will never 25 * generate bus errors on any platform, even when the location of 26 * its descriptor inside a bundle isn't "naturally aligned", and 27 * 28 * [c] for consistency, removing all doubt even when it appears to 29 * someone that the two other points are non-issues for that 30 * particular descriptor type. 31 */ 32 33 #ifndef __LINUX_USB_CH9_H 34 #define __LINUX_USB_CH9_H 35 36 #include <linux/types.h> /* __u8 etc */ 37 38 /*-------------------------------------------------------------------------*/ 39 40 /* CONTROL REQUEST SUPPORT */ 41 42 /* 43 * USB directions 44 * 45 * This bit flag is used in endpoint descriptors' bEndpointAddress field. 46 * It's also one of three fields in control requests bRequestType. 47 */ 48 #define USB_DIR_OUT 0 /* to device */ 49 #define USB_DIR_IN 0x80 /* to host */ 50 51 /* 52 * USB types, the second of three bRequestType fields 53 */ 54 #define USB_TYPE_MASK (0x03 << 5) 55 #define USB_TYPE_STANDARD (0x00 << 5) 56 #define USB_TYPE_CLASS (0x01 << 5) 57 #define USB_TYPE_VENDOR (0x02 << 5) 58 #define USB_TYPE_RESERVED (0x03 << 5) 59 60 /* 61 * USB recipients, the third of three bRequestType fields 62 */ 63 #define USB_RECIP_MASK 0x1f 64 #define USB_RECIP_DEVICE 0x00 65 #define USB_RECIP_INTERFACE 0x01 66 #define USB_RECIP_ENDPOINT 0x02 67 #define USB_RECIP_OTHER 0x03 68 /* From Wireless USB 1.0 */ 69 #define USB_RECIP_PORT 0x04 70 #define USB_RECIP_RPIPE 0x05 71 72 /* 73 * Standard requests, for the bRequest field of a SETUP packet. 74 * 75 * These are qualified by the bRequestType field, so that for example 76 * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved 77 * by a GET_STATUS request. 78 */ 79 #define USB_REQ_GET_STATUS 0x00 80 #define USB_REQ_CLEAR_FEATURE 0x01 81 #define USB_REQ_SET_FEATURE 0x03 82 #define USB_REQ_SET_ADDRESS 0x05 83 #define USB_REQ_GET_DESCRIPTOR 0x06 84 #define USB_REQ_SET_DESCRIPTOR 0x07 85 #define USB_REQ_GET_CONFIGURATION 0x08 86 #define USB_REQ_SET_CONFIGURATION 0x09 87 #define USB_REQ_GET_INTERFACE 0x0A 88 #define USB_REQ_SET_INTERFACE 0x0B 89 #define USB_REQ_SYNCH_FRAME 0x0C 90 91 #define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */ 92 #define USB_REQ_GET_ENCRYPTION 0x0E 93 #define USB_REQ_RPIPE_ABORT 0x0E 94 #define USB_REQ_SET_HANDSHAKE 0x0F 95 #define USB_REQ_RPIPE_RESET 0x0F 96 #define USB_REQ_GET_HANDSHAKE 0x10 97 #define USB_REQ_SET_CONNECTION 0x11 98 #define USB_REQ_SET_SECURITY_DATA 0x12 99 #define USB_REQ_GET_SECURITY_DATA 0x13 100 #define USB_REQ_SET_WUSB_DATA 0x14 101 #define USB_REQ_LOOPBACK_DATA_WRITE 0x15 102 #define USB_REQ_LOOPBACK_DATA_READ 0x16 103 #define USB_REQ_SET_INTERFACE_DS 0x17 104 105 /* 106 * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and 107 * are read as a bit array returned by USB_REQ_GET_STATUS. (So there 108 * are at most sixteen features of each type.) 109 */ 110 #define USB_DEVICE_SELF_POWERED 0 /* (read only) */ 111 #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */ 112 #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */ 113 #define USB_DEVICE_BATTERY 2 /* (wireless) */ 114 #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */ 115 #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless)*/ 116 #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */ 117 #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */ 118 #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */ 119 120 #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */ 121 122 123 /** 124 * struct usb_ctrlrequest - SETUP data for a USB device control request 125 * @bRequestType: matches the USB bmRequestType field 126 * @bRequest: matches the USB bRequest field 127 * @wValue: matches the USB wValue field (le16 byte order) 128 * @wIndex: matches the USB wIndex field (le16 byte order) 129 * @wLength: matches the USB wLength field (le16 byte order) 130 * 131 * This structure is used to send control requests to a USB device. It matches 132 * the different fields of the USB 2.0 Spec section 9.3, table 9-2. See the 133 * USB spec for a fuller description of the different fields, and what they are 134 * used for. 135 * 136 * Note that the driver for any interface can issue control requests. 137 * For most devices, interfaces don't coordinate with each other, so 138 * such requests may be made at any time. 139 */ 140 struct usb_ctrlrequest { 141 __u8 bRequestType; 142 __u8 bRequest; 143 __le16 wValue; 144 __le16 wIndex; 145 __le16 wLength; 146 } __attribute__ ((packed)); 147 148 /*-------------------------------------------------------------------------*/ 149 150 /* 151 * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or 152 * (rarely) accepted by SET_DESCRIPTOR. 153 * 154 * Note that all multi-byte values here are encoded in little endian 155 * byte order "on the wire". But when exposed through Linux-USB APIs, 156 * they've been converted to cpu byte order. 157 */ 158 159 /* 160 * Descriptor types ... USB 2.0 spec table 9.5 161 */ 162 #define USB_DT_DEVICE 0x01 163 #define USB_DT_CONFIG 0x02 164 #define USB_DT_STRING 0x03 165 #define USB_DT_INTERFACE 0x04 166 #define USB_DT_ENDPOINT 0x05 167 #define USB_DT_DEVICE_QUALIFIER 0x06 168 #define USB_DT_OTHER_SPEED_CONFIG 0x07 169 #define USB_DT_INTERFACE_POWER 0x08 170 /* these are from a minor usb 2.0 revision (ECN) */ 171 #define USB_DT_OTG 0x09 172 #define USB_DT_DEBUG 0x0a 173 #define USB_DT_INTERFACE_ASSOCIATION 0x0b 174 /* these are from the Wireless USB spec */ 175 #define USB_DT_SECURITY 0x0c 176 #define USB_DT_KEY 0x0d 177 #define USB_DT_ENCRYPTION_TYPE 0x0e 178 #define USB_DT_BOS 0x0f 179 #define USB_DT_DEVICE_CAPABILITY 0x10 180 #define USB_DT_WIRELESS_ENDPOINT_COMP 0x11 181 #define USB_DT_WIRE_ADAPTER 0x21 182 #define USB_DT_RPIPE 0x22 183 184 /* conventional codes for class-specific descriptors */ 185 #define USB_DT_CS_DEVICE 0x21 186 #define USB_DT_CS_CONFIG 0x22 187 #define USB_DT_CS_STRING 0x23 188 #define USB_DT_CS_INTERFACE 0x24 189 #define USB_DT_CS_ENDPOINT 0x25 190 191 /* All standard descriptors have these 2 fields at the beginning */ 192 struct usb_descriptor_header { 193 __u8 bLength; 194 __u8 bDescriptorType; 195 } __attribute__ ((packed)); 196 197 198 /*-------------------------------------------------------------------------*/ 199 200 /* USB_DT_DEVICE: Device descriptor */ 201 struct usb_device_descriptor { 202 __u8 bLength; 203 __u8 bDescriptorType; 204 205 __le16 bcdUSB; 206 __u8 bDeviceClass; 207 __u8 bDeviceSubClass; 208 __u8 bDeviceProtocol; 209 __u8 bMaxPacketSize0; 210 __le16 idVendor; 211 __le16 idProduct; 212 __le16 bcdDevice; 213 __u8 iManufacturer; 214 __u8 iProduct; 215 __u8 iSerialNumber; 216 __u8 bNumConfigurations; 217 } __attribute__ ((packed)); 218 219 #define USB_DT_DEVICE_SIZE 18 220 221 222 /* 223 * Device and/or Interface Class codes 224 * as found in bDeviceClass or bInterfaceClass 225 * and defined by www.usb.org documents 226 */ 227 #define USB_CLASS_PER_INTERFACE 0 /* for DeviceClass */ 228 #define USB_CLASS_AUDIO 1 229 #define USB_CLASS_COMM 2 230 #define USB_CLASS_HID 3 231 #define USB_CLASS_PHYSICAL 5 232 #define USB_CLASS_STILL_IMAGE 6 233 #define USB_CLASS_PRINTER 7 234 #define USB_CLASS_MASS_STORAGE 8 235 #define USB_CLASS_HUB 9 236 #define USB_CLASS_CDC_DATA 0x0a 237 #define USB_CLASS_CSCID 0x0b /* chip+ smart card */ 238 #define USB_CLASS_CONTENT_SEC 0x0d /* content security */ 239 #define USB_CLASS_VIDEO 0x0e 240 #define USB_CLASS_WIRELESS_CONTROLLER 0xe0 241 #define USB_CLASS_MISC 0xef 242 #define USB_CLASS_APP_SPEC 0xfe 243 #define USB_CLASS_VENDOR_SPEC 0xff 244 245 /*-------------------------------------------------------------------------*/ 246 247 /* USB_DT_CONFIG: Configuration descriptor information. 248 * 249 * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the 250 * descriptor type is different. Highspeed-capable devices can look 251 * different depending on what speed they're currently running. Only 252 * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG 253 * descriptors. 254 */ 255 struct usb_config_descriptor { 256 __u8 bLength; 257 __u8 bDescriptorType; 258 259 __le16 wTotalLength; 260 __u8 bNumInterfaces; 261 __u8 bConfigurationValue; 262 __u8 iConfiguration; 263 __u8 bmAttributes; 264 __u8 bMaxPower; 265 } __attribute__ ((packed)); 266 267 #define USB_DT_CONFIG_SIZE 9 268 269 /* from config descriptor bmAttributes */ 270 #define USB_CONFIG_ATT_ONE (1 << 7) /* must be set */ 271 #define USB_CONFIG_ATT_SELFPOWER (1 << 6) /* self powered */ 272 #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */ 273 #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */ 274 275 /*-------------------------------------------------------------------------*/ 276 277 /* USB_DT_STRING: String descriptor */ 278 struct usb_string_descriptor { 279 __u8 bLength; 280 __u8 bDescriptorType; 281 282 __le16 wData[1]; /* UTF-16LE encoded */ 283 } __attribute__ ((packed)); 284 285 /* note that "string" zero is special, it holds language codes that 286 * the device supports, not Unicode characters. 287 */ 288 289 /*-------------------------------------------------------------------------*/ 290 291 /* USB_DT_INTERFACE: Interface descriptor */ 292 struct usb_interface_descriptor { 293 __u8 bLength; 294 __u8 bDescriptorType; 295 296 __u8 bInterfaceNumber; 297 __u8 bAlternateSetting; 298 __u8 bNumEndpoints; 299 __u8 bInterfaceClass; 300 __u8 bInterfaceSubClass; 301 __u8 bInterfaceProtocol; 302 __u8 iInterface; 303 } __attribute__ ((packed)); 304 305 #define USB_DT_INTERFACE_SIZE 9 306 307 /*-------------------------------------------------------------------------*/ 308 309 /* USB_DT_ENDPOINT: Endpoint descriptor */ 310 struct usb_endpoint_descriptor { 311 __u8 bLength; 312 __u8 bDescriptorType; 313 314 __u8 bEndpointAddress; 315 __u8 bmAttributes; 316 __le16 wMaxPacketSize; 317 __u8 bInterval; 318 319 /* NOTE: these two are _only_ in audio endpoints. */ 320 /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */ 321 __u8 bRefresh; 322 __u8 bSynchAddress; 323 } __attribute__ ((packed)); 324 325 #define USB_DT_ENDPOINT_SIZE 7 326 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ 327 328 329 /* 330 * Endpoints 331 */ 332 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ 333 #define USB_ENDPOINT_DIR_MASK 0x80 334 335 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ 336 #define USB_ENDPOINT_XFER_CONTROL 0 337 #define USB_ENDPOINT_XFER_ISOC 1 338 #define USB_ENDPOINT_XFER_BULK 2 339 #define USB_ENDPOINT_XFER_INT 3 340 #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80 341 342 343 /*-------------------------------------------------------------------------*/ 344 345 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */ 346 struct usb_qualifier_descriptor { 347 __u8 bLength; 348 __u8 bDescriptorType; 349 350 __le16 bcdUSB; 351 __u8 bDeviceClass; 352 __u8 bDeviceSubClass; 353 __u8 bDeviceProtocol; 354 __u8 bMaxPacketSize0; 355 __u8 bNumConfigurations; 356 __u8 bRESERVED; 357 } __attribute__ ((packed)); 358 359 360 /*-------------------------------------------------------------------------*/ 361 362 /* USB_DT_OTG (from OTG 1.0a supplement) */ 363 struct usb_otg_descriptor { 364 __u8 bLength; 365 __u8 bDescriptorType; 366 367 __u8 bmAttributes; /* support for HNP, SRP, etc */ 368 } __attribute__ ((packed)); 369 370 /* from usb_otg_descriptor.bmAttributes */ 371 #define USB_OTG_SRP (1 << 0) 372 #define USB_OTG_HNP (1 << 1) /* swap host/device roles */ 373 374 /*-------------------------------------------------------------------------*/ 375 376 /* USB_DT_DEBUG: for special highspeed devices, replacing serial console */ 377 struct usb_debug_descriptor { 378 __u8 bLength; 379 __u8 bDescriptorType; 380 381 /* bulk endpoints with 8 byte maxpacket */ 382 __u8 bDebugInEndpoint; 383 __u8 bDebugOutEndpoint; 384 } __attribute__((packed)); 385 386 /*-------------------------------------------------------------------------*/ 387 388 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */ 389 struct usb_interface_assoc_descriptor { 390 __u8 bLength; 391 __u8 bDescriptorType; 392 393 __u8 bFirstInterface; 394 __u8 bInterfaceCount; 395 __u8 bFunctionClass; 396 __u8 bFunctionSubClass; 397 __u8 bFunctionProtocol; 398 __u8 iFunction; 399 } __attribute__ ((packed)); 400 401 402 /*-------------------------------------------------------------------------*/ 403 404 /* USB_DT_SECURITY: group of wireless security descriptors, including 405 * encryption types available for setting up a CC/association. 406 */ 407 struct usb_security_descriptor { 408 __u8 bLength; 409 __u8 bDescriptorType; 410 411 __le16 wTotalLength; 412 __u8 bNumEncryptionTypes; 413 } __attribute__((packed)); 414 415 /*-------------------------------------------------------------------------*/ 416 417 /* USB_DT_KEY: used with {GET,SET}_SECURITY_DATA; only public keys 418 * may be retrieved. 419 */ 420 struct usb_key_descriptor { 421 __u8 bLength; 422 __u8 bDescriptorType; 423 424 __u8 tTKID[3]; 425 __u8 bReserved; 426 __u8 bKeyData[0]; 427 } __attribute__((packed)); 428 429 /*-------------------------------------------------------------------------*/ 430 431 /* USB_DT_ENCRYPTION_TYPE: bundled in DT_SECURITY groups */ 432 struct usb_encryption_descriptor { 433 __u8 bLength; 434 __u8 bDescriptorType; 435 436 __u8 bEncryptionType; 437 #define USB_ENC_TYPE_UNSECURE 0 438 #define USB_ENC_TYPE_WIRED 1 /* non-wireless mode */ 439 #define USB_ENC_TYPE_CCM_1 2 /* aes128/cbc session */ 440 #define USB_ENC_TYPE_RSA_1 3 /* rsa3072/sha1 auth */ 441 __u8 bEncryptionValue; /* use in SET_ENCRYPTION */ 442 __u8 bAuthKeyIndex; 443 } __attribute__((packed)); 444 445 446 /*-------------------------------------------------------------------------*/ 447 448 /* USB_DT_BOS: group of wireless capabilities */ 449 struct usb_bos_descriptor { 450 __u8 bLength; 451 __u8 bDescriptorType; 452 453 __le16 wTotalLength; 454 __u8 bNumDeviceCaps; 455 } __attribute__((packed)); 456 457 /*-------------------------------------------------------------------------*/ 458 459 /* USB_DT_DEVICE_CAPABILITY: grouped with BOS */ 460 struct usb_dev_cap_header { 461 __u8 bLength; 462 __u8 bDescriptorType; 463 __u8 bDevCapabilityType; 464 } __attribute__((packed)); 465 466 #define USB_CAP_TYPE_WIRELESS_USB 1 467 468 struct usb_wireless_cap_descriptor { /* Ultra Wide Band */ 469 __u8 bLength; 470 __u8 bDescriptorType; 471 __u8 bDevCapabilityType; 472 473 __u8 bmAttributes; 474 #define USB_WIRELESS_P2P_DRD (1 << 1) 475 #define USB_WIRELESS_BEACON_MASK (3 << 2) 476 #define USB_WIRELESS_BEACON_SELF (1 << 2) 477 #define USB_WIRELESS_BEACON_DIRECTED (2 << 2) 478 #define USB_WIRELESS_BEACON_NONE (3 << 2) 479 __le16 wPHYRates; /* bit rates, Mbps */ 480 #define USB_WIRELESS_PHY_53 (1 << 0) /* always set */ 481 #define USB_WIRELESS_PHY_80 (1 << 1) 482 #define USB_WIRELESS_PHY_107 (1 << 2) /* always set */ 483 #define USB_WIRELESS_PHY_160 (1 << 3) 484 #define USB_WIRELESS_PHY_200 (1 << 4) /* always set */ 485 #define USB_WIRELESS_PHY_320 (1 << 5) 486 #define USB_WIRELESS_PHY_400 (1 << 6) 487 #define USB_WIRELESS_PHY_480 (1 << 7) 488 __u8 bmTFITXPowerInfo; /* TFI power levels */ 489 __u8 bmFFITXPowerInfo; /* FFI power levels */ 490 __le16 bmBandGroup; 491 __u8 bReserved; 492 } __attribute__((packed)); 493 494 /*-------------------------------------------------------------------------*/ 495 496 /* USB_DT_WIRELESS_ENDPOINT_COMP: companion descriptor associated with 497 * each endpoint descriptor for a wireless device 498 */ 499 struct usb_wireless_ep_comp_descriptor { 500 __u8 bLength; 501 __u8 bDescriptorType; 502 503 __u8 bMaxBurst; 504 __u8 bMaxSequence; 505 __le16 wMaxStreamDelay; 506 __le16 wOverTheAirPacketSize; 507 __u8 bOverTheAirInterval; 508 __u8 bmCompAttributes; 509 #define USB_ENDPOINT_SWITCH_MASK 0x03 /* in bmCompAttributes */ 510 #define USB_ENDPOINT_SWITCH_NO 0 511 #define USB_ENDPOINT_SWITCH_SWITCH 1 512 #define USB_ENDPOINT_SWITCH_SCALE 2 513 } __attribute__((packed)); 514 515 /*-------------------------------------------------------------------------*/ 516 517 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless 518 * host and a device for connection set up, mutual authentication, and 519 * exchanging short lived session keys. The handshake depends on a CC. 520 */ 521 struct usb_handshake { 522 __u8 bMessageNumber; 523 __u8 bStatus; 524 __u8 tTKID[3]; 525 __u8 bReserved; 526 __u8 CDID[16]; 527 __u8 nonce[16]; 528 __u8 MIC[8]; 529 } __attribute__((packed)); 530 531 /*-------------------------------------------------------------------------*/ 532 533 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC). 534 * A CC may also be set up using non-wireless secure channels (including 535 * wired USB!), and some devices may support CCs with multiple hosts. 536 */ 537 struct usb_connection_context { 538 __u8 CHID[16]; /* persistent host id */ 539 __u8 CDID[16]; /* device id (unique w/in host context) */ 540 __u8 CK[16]; /* connection key */ 541 } __attribute__((packed)); 542 543 /*-------------------------------------------------------------------------*/ 544 545 /* USB 2.0 defines three speeds, here's how Linux identifies them */ 546 547 enum usb_device_speed { 548 USB_SPEED_UNKNOWN = 0, /* enumerating */ 549 USB_SPEED_LOW, USB_SPEED_FULL, /* usb 1.1 */ 550 USB_SPEED_HIGH, /* usb 2.0 */ 551 USB_SPEED_VARIABLE, /* wireless (usb 2.5) */ 552 }; 553 554 enum usb_device_state { 555 /* NOTATTACHED isn't in the USB spec, and this state acts 556 * the same as ATTACHED ... but it's clearer this way. 557 */ 558 USB_STATE_NOTATTACHED = 0, 559 560 /* chapter 9 and authentication (wireless) device states */ 561 USB_STATE_ATTACHED, 562 USB_STATE_POWERED, /* wired */ 563 USB_STATE_UNAUTHENTICATED, /* auth */ 564 USB_STATE_RECONNECTING, /* auth */ 565 USB_STATE_DEFAULT, /* limited function */ 566 USB_STATE_ADDRESS, 567 USB_STATE_CONFIGURED, /* most functions */ 568 569 USB_STATE_SUSPENDED 570 571 /* NOTE: there are actually four different SUSPENDED 572 * states, returning to POWERED, DEFAULT, ADDRESS, or 573 * CONFIGURED respectively when SOF tokens flow again. 574 */ 575 }; 576 577 #endif /* __LINUX_USB_CH9_H */ 578