include/linux/ch9.h

   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_MASK                    0x80
  49 #define USB_DIR_OUT                     0               /* to device */
  50 #define USB_DIR_IN                      0x80            /* to host */
  51
  52 /*
  53  * USB types, the second of three bRequestType fields
  54  */
  55 #define USB_TYPE_MASK                   (0x03 << 5)
  56 #define USB_TYPE_STANDARD               (0x00 << 5)
  57 #define USB_TYPE_CLASS                  (0x01 << 5)
  58 #define USB_TYPE_VENDOR                 (0x02 << 5)
  59 #define USB_TYPE_RESERVED               (0x03 << 5)
  60
  61 /*
  62  * USB recipients, the third of three bRequestType fields
  63  */
  64 #define USB_RECIP_MASK                  0x1f
  65 #define USB_RECIP_DEVICE                0x00
  66 #define USB_RECIP_INTERFACE             0x01
  67 #define USB_RECIP_ENDPOINT              0x02
  68 #define USB_RECIP_OTHER                 0x03
  69 /* From Wireless USB 1.0 */
  70 #define USB_RECIP_PORT                  0x04
  71 #define USB_RECIP_RPIPE         0x05
  72
  73 /*
  74  * Standard requests, for the bRequest field of a SETUP packet.
  75  *
  76  * These are qualified by the bRequestType field, so that for example
  77  * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved
  78  * by a GET_STATUS request.
  79  */
  80 #define USB_REQ_GET_STATUS              0x00
  81 #define USB_REQ_CLEAR_FEATURE           0x01
  82 #define USB_REQ_SET_FEATURE             0x03
  83 #define USB_REQ_SET_ADDRESS             0x05
  84 #define USB_REQ_GET_DESCRIPTOR          0x06
  85 #define USB_REQ_SET_DESCRIPTOR          0x07
  86 #define USB_REQ_GET_CONFIGURATION       0x08
  87 #define USB_REQ_SET_CONFIGURATION       0x09
  88 #define USB_REQ_GET_INTERFACE           0x0A
  89 #define USB_REQ_SET_INTERFACE           0x0B
  90 #define USB_REQ_SYNCH_FRAME             0x0C
  91
  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 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
 107  * used by hubs to put ports into a new L1 suspend state, except that it
 108  * forgot to define its number ...
 109  */
 110
 111 /*
 112  * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
 113  * are read as a bit array returned by USB_REQ_GET_STATUS.  (So there
 114  * are at most sixteen features of each type.)  Hubs may also support a
 115  * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
 116  */
 117 #define USB_DEVICE_SELF_POWERED         0       /* (read only) */
 118 #define USB_DEVICE_REMOTE_WAKEUP        1       /* dev may initiate wakeup */
 119 #define USB_DEVICE_TEST_MODE            2       /* (wired high speed only) */
 120 #define USB_DEVICE_BATTERY              2       /* (wireless) */
 121 #define USB_DEVICE_B_HNP_ENABLE         3       /* (otg) dev may initiate HNP */
 122 #define USB_DEVICE_WUSB_DEVICE          3       /* (wireless)*/
 123 #define USB_DEVICE_A_HNP_SUPPORT        4       /* (otg) RH port supports HNP */
 124 #define USB_DEVICE_A_ALT_HNP_SUPPORT    5       /* (otg) other RH port does */
 125 #define USB_DEVICE_DEBUG_MODE           6       /* (special devices only) */
 126
 127 #define USB_ENDPOINT_HALT               0       /* IN/OUT will STALL */
 128
 129
 130 /**
 131  * struct usb_ctrlrequest - SETUP data for a USB device control request
 132  * @bRequestType: matches the USB bmRequestType field
 133  * @bRequest: matches the USB bRequest field
 134  * @wValue: matches the USB wValue field (le16 byte order)
 135  * @wIndex: matches the USB wIndex field (le16 byte order)
 136  * @wLength: matches the USB wLength field (le16 byte order)
 137  *
 138  * This structure is used to send control requests to a USB device.  It matches
 139  * the different fields of the USB 2.0 Spec section 9.3, table 9-2.  See the
 140  * USB spec for a fuller description of the different fields, and what they are
 141  * used for.
 142  *
 143  * Note that the driver for any interface can issue control requests.
 144  * For most devices, interfaces don't coordinate with each other, so
 145  * such requests may be made at any time.
 146  */
 147 struct usb_ctrlrequest {
 148         __u8 bRequestType;
 149         __u8 bRequest;
 150         __le16 wValue;
 151         __le16 wIndex;
 152         __le16 wLength;
 153 } __attribute__ ((packed));
 154
 155 /*-------------------------------------------------------------------------*/
 156
 157 /*
 158  * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
 159  * (rarely) accepted by SET_DESCRIPTOR.
 160  *
 161  * Note that all multi-byte values here are encoded in little endian
 162  * byte order "on the wire".  Within the kernel and when exposed
 163  * through the Linux-USB APIs, they are not converted to cpu byte
 164  * order; it is the responsibility of the client code to do this.
 165  * The single exception is when device and configuration descriptors (but
 166  * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD);
 167  * in this case the fields are converted to host endianness by the kernel.
 168  */
 169
 170 /*
 171  * Descriptor types ... USB 2.0 spec table 9.5
 172  */
 173 #define USB_DT_DEVICE                   0x01
 174 #define USB_DT_CONFIG                   0x02
 175 #define USB_DT_STRING                   0x03
 176 #define USB_DT_INTERFACE                0x04
 177 #define USB_DT_ENDPOINT                 0x05
 178 #define USB_DT_DEVICE_QUALIFIER         0x06
 179 #define USB_DT_OTHER_SPEED_CONFIG       0x07
 180 #define USB_DT_INTERFACE_POWER          0x08
 181 /* these are from a minor usb 2.0 revision (ECN) */
 182 #define USB_DT_OTG                      0x09
 183 #define USB_DT_DEBUG                    0x0a
 184 #define USB_DT_INTERFACE_ASSOCIATION    0x0b
 185 /* these are from the Wireless USB spec */
 186 #define USB_DT_SECURITY                 0x0c
 187 #define USB_DT_KEY                      0x0d
 188 #define USB_DT_ENCRYPTION_TYPE          0x0e
 189 #define USB_DT_BOS                      0x0f
 190 #define USB_DT_DEVICE_CAPABILITY        0x10
 191 #define USB_DT_WIRELESS_ENDPOINT_COMP   0x11
 192 #define USB_DT_WIRE_ADAPTER             0x21
 193 #define USB_DT_RPIPE                    0x22
 194 #define USB_DT_CS_RADIO_CONTROL         0x23
 195 /* From the USB 3.0 spec */
 196 #define USB_DT_SS_ENDPOINT_COMP         0x30
 197
 198 /* Conventional codes for class-specific descriptors.  The convention is
 199  * defined in the USB "Common Class" Spec (3.11).  Individual class specs
 200  * are authoritative for their usage, not the "common class" writeup.
 201  */
 202 #define USB_DT_CS_DEVICE                (USB_TYPE_CLASS | USB_DT_DEVICE)
 203 #define USB_DT_CS_CONFIG                (USB_TYPE_CLASS | USB_DT_CONFIG)
 204 #define USB_DT_CS_STRING                (USB_TYPE_CLASS | USB_DT_STRING)
 205 #define USB_DT_CS_INTERFACE             (USB_TYPE_CLASS | USB_DT_INTERFACE)
 206 #define USB_DT_CS_ENDPOINT              (USB_TYPE_CLASS | USB_DT_ENDPOINT)
 207
 208 /* All standard descriptors have these 2 fields at the beginning */
 209 struct usb_descriptor_header {
 210         __u8  bLength;
 211         __u8  bDescriptorType;
 212 } __attribute__ ((packed));
 213
 214
 215 /*-------------------------------------------------------------------------*/
 216
 217 /* USB_DT_DEVICE: Device descriptor */
 218 struct usb_device_descriptor {
 219         __u8  bLength;
 220         __u8  bDescriptorType;
 221
 222         __le16 bcdUSB;
 223         __u8  bDeviceClass;
 224         __u8  bDeviceSubClass;
 225         __u8  bDeviceProtocol;
 226         __u8  bMaxPacketSize0;
 227         __le16 idVendor;
 228         __le16 idProduct;
 229         __le16 bcdDevice;
 230         __u8  iManufacturer;
 231         __u8  iProduct;
 232         __u8  iSerialNumber;
 233         __u8  bNumConfigurations;
 234 } __attribute__ ((packed));
 235
 236 #define USB_DT_DEVICE_SIZE              18
 237
 238
 239 /*
 240  * Device and/or Interface Class codes
 241  * as found in bDeviceClass or bInterfaceClass
 242  * and defined by www.usb.org documents
 243  */
 244 #define USB_CLASS_PER_INTERFACE         0       /* for DeviceClass */
 245 #define USB_CLASS_AUDIO                 1
 246 #define USB_CLASS_COMM                  2
 247 #define USB_CLASS_HID                   3
 248 #define USB_CLASS_PHYSICAL              5
 249 #define USB_CLASS_STILL_IMAGE           6
 250 #define USB_CLASS_PRINTER               7
 251 #define USB_CLASS_MASS_STORAGE          8
 252 #define USB_CLASS_HUB                   9
 253 #define USB_CLASS_CDC_DATA              0x0a
 254 #define USB_CLASS_CSCID                 0x0b    /* chip+ smart card */
 255 #define USB_CLASS_CONTENT_SEC           0x0d    /* content security */
 256 #define USB_CLASS_VIDEO                 0x0e
 257 #define USB_CLASS_WIRELESS_CONTROLLER   0xe0
 258 #define USB_CLASS_MISC                  0xef
 259 #define USB_CLASS_APP_SPEC              0xfe
 260 #define USB_CLASS_VENDOR_SPEC           0xff
 261
 262 #define USB_SUBCLASS_VENDOR_SPEC        0xff
 263
 264 /*-------------------------------------------------------------------------*/
 265
 266 /* USB_DT_CONFIG: Configuration descriptor information.
 267  *
 268  * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
 269  * descriptor type is different.  Highspeed-capable devices can look
 270  * different depending on what speed they're currently running.  Only
 271  * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
 272  * descriptors.
 273  */
 274 struct usb_config_descriptor {
 275         __u8  bLength;
 276         __u8  bDescriptorType;
 277
 278         __le16 wTotalLength;
 279         __u8  bNumInterfaces;
 280         __u8  bConfigurationValue;
 281         __u8  iConfiguration;
 282         __u8  bmAttributes;
 283         __u8  bMaxPower;
 284 } __attribute__ ((packed));
 285
 286 #define USB_DT_CONFIG_SIZE              9
 287
 288 /* from config descriptor bmAttributes */
 289 #define USB_CONFIG_ATT_ONE              (1 << 7)        /* must be set */
 290 #define USB_CONFIG_ATT_SELFPOWER        (1 << 6)        /* self powered */
 291 #define USB_CONFIG_ATT_WAKEUP           (1 << 5)        /* can wakeup */
 292 #define USB_CONFIG_ATT_BATTERY          (1 << 4)        /* battery powered */
 293
 294 /*-------------------------------------------------------------------------*/
 295
 296 /* USB_DT_STRING: String descriptor */
 297 struct usb_string_descriptor {
 298         __u8  bLength;
 299         __u8  bDescriptorType;
 300
 301         __le16 wData[1];                /* UTF-16LE encoded */
 302 } __attribute__ ((packed));
 303
 304 /* note that "string" zero is special, it holds language codes that
 305  * the device supports, not Unicode characters.
 306  */
 307
 308 /*-------------------------------------------------------------------------*/
 309
 310 /* USB_DT_INTERFACE: Interface descriptor */
 311 struct usb_interface_descriptor {
 312         __u8  bLength;
 313         __u8  bDescriptorType;
 314
 315         __u8  bInterfaceNumber;
 316         __u8  bAlternateSetting;
 317         __u8  bNumEndpoints;
 318         __u8  bInterfaceClass;
 319         __u8  bInterfaceSubClass;
 320         __u8  bInterfaceProtocol;
 321         __u8  iInterface;
 322 } __attribute__ ((packed));
 323
 324 #define USB_DT_INTERFACE_SIZE           9
 325
 326 /*-------------------------------------------------------------------------*/
 327
 328 /* USB_DT_ENDPOINT: Endpoint descriptor */
 329 struct usb_endpoint_descriptor {
 330         __u8  bLength;
 331         __u8  bDescriptorType;
 332
 333         __u8  bEndpointAddress;
 334         __u8  bmAttributes;
 335         __le16 wMaxPacketSize;
 336         __u8  bInterval;
 337 } __attribute__ ((packed));
 338
 339 #define USB_DT_ENDPOINT_SIZE            7
 340 #define USB_DT_ENDPOINT_AUDIO_SIZE      9       /* Audio extension */
 341
 342
 343 /*
 344  * Endpoints
 345  */
 346 #define USB_ENDPOINT_NUMBER_MASK        0x0f    /* in bEndpointAddress */
 347 #define USB_ENDPOINT_DIR_MASK           0x80
 348
 349 #define USB_ENDPOINT_SYNCTYPE           0x0c
 350 #define USB_ENDPOINT_SYNC_NONE          (0 << 2)
 351 #define USB_ENDPOINT_SYNC_ASYNC         (1 << 2)
 352 #define USB_ENDPOINT_SYNC_ADAPTIVE      (2 << 2)
 353 #define USB_ENDPOINT_SYNC_SYNC          (3 << 2)
 354
 355 #define USB_ENDPOINT_XFERTYPE_MASK      0x03    /* in bmAttributes */
 356 #define USB_ENDPOINT_XFER_CONTROL       0
 357 #define USB_ENDPOINT_XFER_ISOC          1
 358 #define USB_ENDPOINT_XFER_BULK          2
 359 #define USB_ENDPOINT_XFER_INT           3
 360 #define USB_ENDPOINT_MAX_ADJUSTABLE     0x80
 361
 362 /*-------------------------------------------------------------------------*/
 363
 364 /**
 365  * usb_endpoint_num - get the endpoint's number
 366  * @epd: endpoint to be checked
 367  *
 368  * Returns @epd's number: 0 to 15.
 369  */
 370 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
 371 {
 372         return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
 373 }
 374
 375 /**
 376  * usb_endpoint_type - get the endpoint's transfer type
 377  * @epd: endpoint to be checked
 378  *
 379  * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
 380  * to @epd's transfer type.
 381  */
 382 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
 383 {
 384         return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
 385 }
 386
 387 /**
 388  * usb_endpoint_dir_in - check if the endpoint has IN direction
 389  * @epd: endpoint to be checked
 390  *
 391  * Returns true if the endpoint is of type IN, otherwise it returns false.
 392  */
 393 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
 394 {
 395         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
 396 }
 397
 398 /**
 399  * usb_endpoint_dir_out - check if the endpoint has OUT direction
 400  * @epd: endpoint to be checked
 401  *
 402  * Returns true if the endpoint is of type OUT, otherwise it returns false.
 403  */
 404 static inline int usb_endpoint_dir_out(
 405                                 const struct usb_endpoint_descriptor *epd)
 406 {
 407         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
 408 }
 409
 410 /**
 411  * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
 412  * @epd: endpoint to be checked
 413  *
 414  * Returns true if the endpoint is of type bulk, otherwise it returns false.
 415  */
 416 static inline int usb_endpoint_xfer_bulk(
 417                                 const struct usb_endpoint_descriptor *epd)
 418 {
 419         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 420                 USB_ENDPOINT_XFER_BULK);
 421 }
 422
 423 /**
 424  * usb_endpoint_xfer_control - check if the endpoint has control transfer type
 425  * @epd: endpoint to be checked
 426  *
 427  * Returns true if the endpoint is of type control, otherwise it returns false.
 428  */
 429 static inline int usb_endpoint_xfer_control(
 430                                 const struct usb_endpoint_descriptor *epd)
 431 {
 432         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 433                 USB_ENDPOINT_XFER_CONTROL);
 434 }
 435
 436 /**
 437  * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
 438  * @epd: endpoint to be checked
 439  *
 440  * Returns true if the endpoint is of type interrupt, otherwise it returns
 441  * false.
 442  */
 443 static inline int usb_endpoint_xfer_int(
 444                                 const struct usb_endpoint_descriptor *epd)
 445 {
 446         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 447                 USB_ENDPOINT_XFER_INT);
 448 }
 449
 450 /**
 451  * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
 452  * @epd: endpoint to be checked
 453  *
 454  * Returns true if the endpoint is of type isochronous, otherwise it returns
 455  * false.
 456  */
 457 static inline int usb_endpoint_xfer_isoc(
 458                                 const struct usb_endpoint_descriptor *epd)
 459 {
 460         return (epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 461                 USB_ENDPOINT_XFER_ISOC;
 462 }
 463
 464 /**
 465  * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
 466  * @epd: endpoint to be checked
 467  *
 468  * Returns true if the endpoint has bulk transfer type and IN direction,
 469  * otherwise it returns false.
 470  */
 471 static inline int usb_endpoint_is_bulk_in(
 472                                 const struct usb_endpoint_descriptor *epd)
 473 {
 474         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
 475 }
 476
 477 /**
 478  * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
 479  * @epd: endpoint to be checked
 480  *
 481  * Returns true if the endpoint has bulk transfer type and OUT direction,
 482  * otherwise it returns false.
 483  */
 484 static inline int usb_endpoint_is_bulk_out(
 485                                 const struct usb_endpoint_descriptor *epd)
 486 {
 487         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
 488 }
 489
 490 /**
 491  * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
 492  * @epd: endpoint to be checked
 493  *
 494  * Returns true if the endpoint has interrupt transfer type and IN direction,
 495  * otherwise it returns false.
 496  */
 497 static inline int usb_endpoint_is_int_in(
 498                                 const struct usb_endpoint_descriptor *epd)
 499 {
 500         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
 501 }
 502
 503 /**
 504  * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
 505  * @epd: endpoint to be checked
 506  *
 507  * Returns true if the endpoint has interrupt transfer type and OUT direction,
 508  * otherwise it returns false.
 509  */
 510 static inline int usb_endpoint_is_int_out(
 511                                 const struct usb_endpoint_descriptor *epd)
 512 {
 513         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
 514 }
 515
 516 /**
 517  * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
 518  * @epd: endpoint to be checked
 519  *
 520  * Returns true if the endpoint has isochronous transfer type and IN direction,
 521  * otherwise it returns false.
 522  */
 523 static inline int usb_endpoint_is_isoc_in(
 524                                 const struct usb_endpoint_descriptor *epd)
 525 {
 526         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
 527 }
 528
 529 /**
 530  * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
 531  * @epd: endpoint to be checked
 532  *
 533  * Returns true if the endpoint has isochronous transfer type and OUT direction,
 534  * otherwise it returns false.
 535  */
 536 static inline int usb_endpoint_is_isoc_out(
 537                                 const struct usb_endpoint_descriptor *epd)
 538 {
 539         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
 540 }
 541
 542 /*-------------------------------------------------------------------------*/
 543
 544 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
 545 struct usb_ss_ep_comp_descriptor {
 546         __u8  bLength;
 547         __u8  bDescriptorType;
 548
 549         __u8  bMaxBurst;
 550         __u8  bmAttributes;
 551         __le16 wBytesPerInterval;
 552 } __attribute__ ((packed));
 553
 554 #define USB_DT_SS_EP_COMP_SIZE          6
 555
 556 /*-------------------------------------------------------------------------*/
 557
 558 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
 559 struct usb_qualifier_descriptor {
 560         __u8  bLength;
 561         __u8  bDescriptorType;
 562
 563         __le16 bcdUSB;
 564         __u8  bDeviceClass;
 565         __u8  bDeviceSubClass;
 566         __u8  bDeviceProtocol;
 567         __u8  bMaxPacketSize0;
 568         __u8  bNumConfigurations;
 569         __u8  bRESERVED;
 570 } __attribute__ ((packed));
 571
 572
 573 /*-------------------------------------------------------------------------*/
 574
 575 /* USB_DT_OTG (from OTG 1.0a supplement) */
 576 struct usb_otg_descriptor {
 577         __u8  bLength;
 578         __u8  bDescriptorType;
 579
 580         __u8  bmAttributes;     /* support for HNP, SRP, etc */
 581 } __attribute__ ((packed));
 582
 583 /* from usb_otg_descriptor.bmAttributes */
 584 #define USB_OTG_SRP             (1 << 0)
 585 #define USB_OTG_HNP             (1 << 1)        /* swap host/device roles */
 586
 587 /*-------------------------------------------------------------------------*/
 588
 589 /* USB_DT_DEBUG:  for special highspeed devices, replacing serial console */
 590 struct usb_debug_descriptor {
 591         __u8  bLength;
 592         __u8  bDescriptorType;
 593
 594         /* bulk endpoints with 8 byte maxpacket */
 595         __u8  bDebugInEndpoint;
 596         __u8  bDebugOutEndpoint;
 597 } __attribute__((packed));
 598
 599 /*-------------------------------------------------------------------------*/
 600
 601 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
 602 struct usb_interface_assoc_descriptor {
 603         __u8  bLength;
 604         __u8  bDescriptorType;
 605
 606         __u8  bFirstInterface;
 607         __u8  bInterfaceCount;
 608         __u8  bFunctionClass;
 609         __u8  bFunctionSubClass;
 610         __u8  bFunctionProtocol;
 611         __u8  iFunction;
 612 } __attribute__ ((packed));
 613
 614
 615 /*-------------------------------------------------------------------------*/
 616
 617 /* USB_DT_SECURITY:  group of wireless security descriptors, including
 618  * encryption types available for setting up a CC/association.
 619  */
 620 struct usb_security_descriptor {
 621         __u8  bLength;
 622         __u8  bDescriptorType;
 623
 624         __le16 wTotalLength;
 625         __u8  bNumEncryptionTypes;
 626 } __attribute__((packed));
 627
 628 /*-------------------------------------------------------------------------*/
 629
 630 /* USB_DT_KEY:  used with {GET,SET}_SECURITY_DATA; only public keys
 631  * may be retrieved.
 632  */
 633 struct usb_key_descriptor {
 634         __u8  bLength;
 635         __u8  bDescriptorType;
 636
 637         __u8  tTKID[3];
 638         __u8  bReserved;
 639         __u8  bKeyData[0];
 640 } __attribute__((packed));
 641
 642 /*-------------------------------------------------------------------------*/
 643
 644 /* USB_DT_ENCRYPTION_TYPE:  bundled in DT_SECURITY groups */
 645 struct usb_encryption_descriptor {
 646         __u8  bLength;
 647         __u8  bDescriptorType;
 648
 649         __u8  bEncryptionType;
 650 #define USB_ENC_TYPE_UNSECURE           0
 651 #define USB_ENC_TYPE_WIRED              1       /* non-wireless mode */
 652 #define USB_ENC_TYPE_CCM_1              2       /* aes128/cbc session */
 653 #define USB_ENC_TYPE_RSA_1              3       /* rsa3072/sha1 auth */
 654         __u8  bEncryptionValue;         /* use in SET_ENCRYPTION */
 655         __u8  bAuthKeyIndex;
 656 } __attribute__((packed));
 657
 658
 659 /*-------------------------------------------------------------------------*/
 660
 661 /* USB_DT_BOS:  group of device-level capabilities */
 662 struct usb_bos_descriptor {
 663         __u8  bLength;
 664         __u8  bDescriptorType;
 665
 666         __le16 wTotalLength;
 667         __u8  bNumDeviceCaps;
 668 } __attribute__((packed));
 669
 670 /*-------------------------------------------------------------------------*/
 671
 672 /* USB_DT_DEVICE_CAPABILITY:  grouped with BOS */
 673 struct usb_dev_cap_header {
 674         __u8  bLength;
 675         __u8  bDescriptorType;
 676         __u8  bDevCapabilityType;
 677 } __attribute__((packed));
 678
 679 #define USB_CAP_TYPE_WIRELESS_USB       1
 680
 681 struct usb_wireless_cap_descriptor {    /* Ultra Wide Band */
 682         __u8  bLength;
 683         __u8  bDescriptorType;
 684         __u8  bDevCapabilityType;
 685
 686         __u8  bmAttributes;
 687 #define USB_WIRELESS_P2P_DRD            (1 << 1)
 688 #define USB_WIRELESS_BEACON_MASK        (3 << 2)
 689 #define USB_WIRELESS_BEACON_SELF        (1 << 2)
 690 #define USB_WIRELESS_BEACON_DIRECTED    (2 << 2)
 691 #define USB_WIRELESS_BEACON_NONE        (3 << 2)
 692         __le16 wPHYRates;       /* bit rates, Mbps */
 693 #define USB_WIRELESS_PHY_53             (1 << 0)        /* always set */
 694 #define USB_WIRELESS_PHY_80             (1 << 1)
 695 #define USB_WIRELESS_PHY_107            (1 << 2)        /* always set */
 696 #define USB_WIRELESS_PHY_160            (1 << 3)
 697 #define USB_WIRELESS_PHY_200            (1 << 4)        /* always set */
 698 #define USB_WIRELESS_PHY_320            (1 << 5)
 699 #define USB_WIRELESS_PHY_400            (1 << 6)
 700 #define USB_WIRELESS_PHY_480            (1 << 7)
 701         __u8  bmTFITXPowerInfo; /* TFI power levels */
 702         __u8  bmFFITXPowerInfo; /* FFI power levels */
 703         __le16 bmBandGroup;
 704         __u8  bReserved;
 705 } __attribute__((packed));
 706
 707 #define USB_CAP_TYPE_EXT                2
 708
 709 struct usb_ext_cap_descriptor {         /* Link Power Management */
 710         __u8  bLength;
 711         __u8  bDescriptorType;
 712         __u8  bDevCapabilityType;
 713         __u8  bmAttributes;
 714 #define USB_LPM_SUPPORT                 (1 << 1)        /* supports LPM */
 715 } __attribute__((packed));
 716
 717 /*-------------------------------------------------------------------------*/
 718
 719 /* USB_DT_WIRELESS_ENDPOINT_COMP:  companion descriptor associated with
 720  * each endpoint descriptor for a wireless device
 721  */
 722 struct usb_wireless_ep_comp_descriptor {
 723         __u8  bLength;
 724         __u8  bDescriptorType;
 725
 726         __u8  bMaxBurst;
 727         __u8  bMaxSequence;
 728         __le16 wMaxStreamDelay;
 729         __le16 wOverTheAirPacketSize;
 730         __u8  bOverTheAirInterval;
 731         __u8  bmCompAttributes;
 732 #define USB_ENDPOINT_SWITCH_MASK        0x03    /* in bmCompAttributes */
 733 #define USB_ENDPOINT_SWITCH_NO          0
 734 #define USB_ENDPOINT_SWITCH_SWITCH      1
 735 #define USB_ENDPOINT_SWITCH_SCALE       2
 736 } __attribute__((packed));
 737
 738 /*-------------------------------------------------------------------------*/
 739
 740 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
 741  * host and a device for connection set up, mutual authentication, and
 742  * exchanging short lived session keys.  The handshake depends on a CC.
 743  */
 744 struct usb_handshake {
 745         __u8 bMessageNumber;
 746         __u8 bStatus;
 747         __u8 tTKID[3];
 748         __u8 bReserved;
 749         __u8 CDID[16];
 750         __u8 nonce[16];
 751         __u8 MIC[8];
 752 } __attribute__((packed));
 753
 754 /*-------------------------------------------------------------------------*/
 755
 756 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
 757  * A CC may also be set up using non-wireless secure channels (including
 758  * wired USB!), and some devices may support CCs with multiple hosts.
 759  */
 760 struct usb_connection_context {
 761         __u8 CHID[16];          /* persistent host id */
 762         __u8 CDID[16];          /* device id (unique w/in host context) */
 763         __u8 CK[16];            /* connection key */
 764 } __attribute__((packed));
 765
 766 /*-------------------------------------------------------------------------*/
 767
 768 /* USB 2.0 defines three speeds, here's how Linux identifies them */
 769
 770 enum usb_device_speed {
 771         USB_SPEED_UNKNOWN = 0,                  /* enumerating */
 772         USB_SPEED_LOW, USB_SPEED_FULL,          /* usb 1.1 */
 773         USB_SPEED_HIGH,                         /* usb 2.0 */
 774         USB_SPEED_WIRELESS,                     /* wireless (usb 2.5) */
 775         USB_SPEED_SUPER,                        /* usb 3.0 */
 776 };
 777
 778 enum usb_device_state {
 779         /* NOTATTACHED isn't in the USB spec, and this state acts
 780          * the same as ATTACHED ... but it's clearer this way.
 781          */
 782         USB_STATE_NOTATTACHED = 0,
 783
 784         /* chapter 9 and authentication (wireless) device states */
 785         USB_STATE_ATTACHED,
 786         USB_STATE_POWERED,                      /* wired */
 787         USB_STATE_RECONNECTING,                 /* auth */
 788         USB_STATE_UNAUTHENTICATED,              /* auth */
 789         USB_STATE_DEFAULT,                      /* limited function */
 790         USB_STATE_ADDRESS,
 791         USB_STATE_CONFIGURED,                   /* most functions */
 792
 793         USB_STATE_SUSPENDED
 794
 795         /* NOTE:  there are actually four different SUSPENDED
 796          * states, returning to POWERED, DEFAULT, ADDRESS, or
 797          * CONFIGURED respectively when SOF tokens flow again.
 798          * At this level there's no difference between L1 and L2
 799          * suspend states.  (L2 being original USB 1.1 suspend.)
 800          */
 801 };
 802
 803 #endif /* __LINUX_USB_CH9_H */