include/uapi/linux/usb/ch9.h

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