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 String descriptors can contain at most 126 characters. */
 364 #define USB_MAX_STRING_LEN      126
 365
 366 /* USB_DT_STRING: String descriptor */
 367 struct usb_string_descriptor {
 368         __u8  bLength;
 369         __u8  bDescriptorType;
 370
 371         __le16 wData[1];                /* UTF-16LE encoded */
 372 } __attribute__ ((packed));
 373
 374 /* note that "string" zero is special, it holds language codes that
 375  * the device supports, not Unicode characters.
 376  */
 377
 378 /*-------------------------------------------------------------------------*/
 379
 380 /* USB_DT_INTERFACE: Interface descriptor */
 381 struct usb_interface_descriptor {
 382         __u8  bLength;
 383         __u8  bDescriptorType;
 384
 385         __u8  bInterfaceNumber;
 386         __u8  bAlternateSetting;
 387         __u8  bNumEndpoints;
 388         __u8  bInterfaceClass;
 389         __u8  bInterfaceSubClass;
 390         __u8  bInterfaceProtocol;
 391         __u8  iInterface;
 392 } __attribute__ ((packed));
 393
 394 #define USB_DT_INTERFACE_SIZE           9
 395
 396 /*-------------------------------------------------------------------------*/
 397
 398 /* USB_DT_ENDPOINT: Endpoint descriptor */
 399 struct usb_endpoint_descriptor {
 400         __u8  bLength;
 401         __u8  bDescriptorType;
 402
 403         __u8  bEndpointAddress;
 404         __u8  bmAttributes;
 405         __le16 wMaxPacketSize;
 406         __u8  bInterval;
 407
 408         /* NOTE:  these two are _only_ in audio endpoints. */
 409         /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
 410         __u8  bRefresh;
 411         __u8  bSynchAddress;
 412 } __attribute__ ((packed));
 413
 414 #define USB_DT_ENDPOINT_SIZE            7
 415 #define USB_DT_ENDPOINT_AUDIO_SIZE      9       /* Audio extension */
 416
 417
 418 /*
 419  * Endpoints
 420  */
 421 #define USB_ENDPOINT_NUMBER_MASK        0x0f    /* in bEndpointAddress */
 422 #define USB_ENDPOINT_DIR_MASK           0x80
 423
 424 #define USB_ENDPOINT_XFERTYPE_MASK      0x03    /* in bmAttributes */
 425 #define USB_ENDPOINT_XFER_CONTROL       0
 426 #define USB_ENDPOINT_XFER_ISOC          1
 427 #define USB_ENDPOINT_XFER_BULK          2
 428 #define USB_ENDPOINT_XFER_INT           3
 429 #define USB_ENDPOINT_MAX_ADJUSTABLE     0x80
 430
 431 #define USB_ENDPOINT_MAXP_MASK  0x07ff
 432 #define USB_EP_MAXP_MULT_SHIFT  11
 433 #define USB_EP_MAXP_MULT_MASK   (3 << USB_EP_MAXP_MULT_SHIFT)
 434 #define USB_EP_MAXP_MULT(m) \
 435         (((m) & USB_EP_MAXP_MULT_MASK) >> USB_EP_MAXP_MULT_SHIFT)
 436
 437 /* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */
 438 #define USB_ENDPOINT_INTRTYPE           0x30
 439 #define USB_ENDPOINT_INTR_PERIODIC      (0 << 4)
 440 #define USB_ENDPOINT_INTR_NOTIFICATION  (1 << 4)
 441
 442 #define USB_ENDPOINT_SYNCTYPE           0x0c
 443 #define USB_ENDPOINT_SYNC_NONE          (0 << 2)
 444 #define USB_ENDPOINT_SYNC_ASYNC         (1 << 2)
 445 #define USB_ENDPOINT_SYNC_ADAPTIVE      (2 << 2)
 446 #define USB_ENDPOINT_SYNC_SYNC          (3 << 2)
 447
 448 #define USB_ENDPOINT_USAGE_MASK         0x30
 449 #define USB_ENDPOINT_USAGE_DATA         0x00
 450 #define USB_ENDPOINT_USAGE_FEEDBACK     0x10
 451 #define USB_ENDPOINT_USAGE_IMPLICIT_FB  0x20    /* Implicit feedback Data endpoint */
 452
 453 /*-------------------------------------------------------------------------*/
 454
 455 /**
 456  * usb_endpoint_num - get the endpoint's number
 457  * @epd: endpoint to be checked
 458  *
 459  * Returns @epd's number: 0 to 15.
 460  */
 461 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
 462 {
 463         return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
 464 }
 465
 466 /**
 467  * usb_endpoint_type - get the endpoint's transfer type
 468  * @epd: endpoint to be checked
 469  *
 470  * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
 471  * to @epd's transfer type.
 472  */
 473 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
 474 {
 475         return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
 476 }
 477
 478 /**
 479  * usb_endpoint_dir_in - check if the endpoint has IN direction
 480  * @epd: endpoint to be checked
 481  *
 482  * Returns true if the endpoint is of type IN, otherwise it returns false.
 483  */
 484 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
 485 {
 486         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
 487 }
 488
 489 /**
 490  * usb_endpoint_dir_out - check if the endpoint has OUT direction
 491  * @epd: endpoint to be checked
 492  *
 493  * Returns true if the endpoint is of type OUT, otherwise it returns false.
 494  */
 495 static inline int usb_endpoint_dir_out(
 496                                 const struct usb_endpoint_descriptor *epd)
 497 {
 498         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
 499 }
 500
 501 /**
 502  * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
 503  * @epd: endpoint to be checked
 504  *
 505  * Returns true if the endpoint is of type bulk, otherwise it returns false.
 506  */
 507 static inline int usb_endpoint_xfer_bulk(
 508                                 const struct usb_endpoint_descriptor *epd)
 509 {
 510         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 511                 USB_ENDPOINT_XFER_BULK);
 512 }
 513
 514 /**
 515  * usb_endpoint_xfer_control - check if the endpoint has control transfer type
 516  * @epd: endpoint to be checked
 517  *
 518  * Returns true if the endpoint is of type control, otherwise it returns false.
 519  */
 520 static inline int usb_endpoint_xfer_control(
 521                                 const struct usb_endpoint_descriptor *epd)
 522 {
 523         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 524                 USB_ENDPOINT_XFER_CONTROL);
 525 }
 526
 527 /**
 528  * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
 529  * @epd: endpoint to be checked
 530  *
 531  * Returns true if the endpoint is of type interrupt, otherwise it returns
 532  * false.
 533  */
 534 static inline int usb_endpoint_xfer_int(
 535                                 const struct usb_endpoint_descriptor *epd)
 536 {
 537         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 538                 USB_ENDPOINT_XFER_INT);
 539 }
 540
 541 /**
 542  * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
 543  * @epd: endpoint to be checked
 544  *
 545  * Returns true if the endpoint is of type isochronous, otherwise it returns
 546  * false.
 547  */
 548 static inline int usb_endpoint_xfer_isoc(
 549                                 const struct usb_endpoint_descriptor *epd)
 550 {
 551         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 552                 USB_ENDPOINT_XFER_ISOC);
 553 }
 554
 555 /**
 556  * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
 557  * @epd: endpoint to be checked
 558  *
 559  * Returns true if the endpoint has bulk transfer type and IN direction,
 560  * otherwise it returns false.
 561  */
 562 static inline int usb_endpoint_is_bulk_in(
 563                                 const struct usb_endpoint_descriptor *epd)
 564 {
 565         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
 566 }
 567
 568 /**
 569  * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
 570  * @epd: endpoint to be checked
 571  *
 572  * Returns true if the endpoint has bulk transfer type and OUT direction,
 573  * otherwise it returns false.
 574  */
 575 static inline int usb_endpoint_is_bulk_out(
 576                                 const struct usb_endpoint_descriptor *epd)
 577 {
 578         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
 579 }
 580
 581 /**
 582  * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
 583  * @epd: endpoint to be checked
 584  *
 585  * Returns true if the endpoint has interrupt transfer type and IN direction,
 586  * otherwise it returns false.
 587  */
 588 static inline int usb_endpoint_is_int_in(
 589                                 const struct usb_endpoint_descriptor *epd)
 590 {
 591         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
 592 }
 593
 594 /**
 595  * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
 596  * @epd: endpoint to be checked
 597  *
 598  * Returns true if the endpoint has interrupt transfer type and OUT direction,
 599  * otherwise it returns false.
 600  */
 601 static inline int usb_endpoint_is_int_out(
 602                                 const struct usb_endpoint_descriptor *epd)
 603 {
 604         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
 605 }
 606
 607 /**
 608  * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
 609  * @epd: endpoint to be checked
 610  *
 611  * Returns true if the endpoint has isochronous transfer type and IN direction,
 612  * otherwise it returns false.
 613  */
 614 static inline int usb_endpoint_is_isoc_in(
 615                                 const struct usb_endpoint_descriptor *epd)
 616 {
 617         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
 618 }
 619
 620 /**
 621  * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
 622  * @epd: endpoint to be checked
 623  *
 624  * Returns true if the endpoint has isochronous transfer type and OUT direction,
 625  * otherwise it returns false.
 626  */
 627 static inline int usb_endpoint_is_isoc_out(
 628                                 const struct usb_endpoint_descriptor *epd)
 629 {
 630         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
 631 }
 632
 633 /**
 634  * usb_endpoint_maxp - get endpoint's max packet size
 635  * @epd: endpoint to be checked
 636  *
 637  * Returns @epd's max packet bits [10:0]
 638  */
 639 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
 640 {
 641         return __le16_to_cpu(epd->wMaxPacketSize) & USB_ENDPOINT_MAXP_MASK;
 642 }
 643
 644 /**
 645  * usb_endpoint_maxp_mult - get endpoint's transactional opportunities
 646  * @epd: endpoint to be checked
 647  *
 648  * Return @epd's wMaxPacketSize[12:11] + 1
 649  */
 650 static inline int
 651 usb_endpoint_maxp_mult(const struct usb_endpoint_descriptor *epd)
 652 {
 653         int maxp = __le16_to_cpu(epd->wMaxPacketSize);
 654
 655         return USB_EP_MAXP_MULT(maxp) + 1;
 656 }
 657
 658 static inline int usb_endpoint_interrupt_type(
 659                 const struct usb_endpoint_descriptor *epd)
 660 {
 661         return epd->bmAttributes & USB_ENDPOINT_INTRTYPE;
 662 }
 663
 664 /*-------------------------------------------------------------------------*/
 665
 666 /* USB_DT_SSP_ISOC_ENDPOINT_COMP: SuperSpeedPlus Isochronous Endpoint Companion
 667  * descriptor
 668  */
 669 struct usb_ssp_isoc_ep_comp_descriptor {
 670         __u8  bLength;
 671         __u8  bDescriptorType;
 672         __le16 wReseved;
 673         __le32 dwBytesPerInterval;
 674 } __attribute__ ((packed));
 675
 676 #define USB_DT_SSP_ISOC_EP_COMP_SIZE            8
 677
 678 /*-------------------------------------------------------------------------*/
 679
 680 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
 681 struct usb_ss_ep_comp_descriptor {
 682         __u8  bLength;
 683         __u8  bDescriptorType;
 684
 685         __u8  bMaxBurst;
 686         __u8  bmAttributes;
 687         __le16 wBytesPerInterval;
 688 } __attribute__ ((packed));
 689
 690 #define USB_DT_SS_EP_COMP_SIZE          6
 691
 692 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */
 693 static inline int
 694 usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp)
 695 {
 696         int             max_streams;
 697
 698         if (!comp)
 699                 return 0;
 700
 701         max_streams = comp->bmAttributes & 0x1f;
 702
 703         if (!max_streams)
 704                 return 0;
 705
 706         max_streams = 1 << max_streams;
 707
 708         return max_streams;
 709 }
 710
 711 /* Bits 1:0 of bmAttributes if this is an isoc endpoint */
 712 #define USB_SS_MULT(p)                  (1 + ((p) & 0x3))
 713 /* Bit 7 of bmAttributes if a SSP isoc endpoint companion descriptor exists */
 714 #define USB_SS_SSP_ISOC_COMP(p)         ((p) & (1 << 7))
 715
 716 /*-------------------------------------------------------------------------*/
 717
 718 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
 719 struct usb_qualifier_descriptor {
 720         __u8  bLength;
 721         __u8  bDescriptorType;
 722
 723         __le16 bcdUSB;
 724         __u8  bDeviceClass;
 725         __u8  bDeviceSubClass;
 726         __u8  bDeviceProtocol;
 727         __u8  bMaxPacketSize0;
 728         __u8  bNumConfigurations;
 729         __u8  bRESERVED;
 730 } __attribute__ ((packed));
 731
 732
 733 /*-------------------------------------------------------------------------*/
 734
 735 /* USB_DT_OTG (from OTG 1.0a supplement) */
 736 struct usb_otg_descriptor {
 737         __u8  bLength;
 738         __u8  bDescriptorType;
 739
 740         __u8  bmAttributes;     /* support for HNP, SRP, etc */
 741 } __attribute__ ((packed));
 742
 743 /* USB_DT_OTG (from OTG 2.0 supplement) */
 744 struct usb_otg20_descriptor {
 745         __u8  bLength;
 746         __u8  bDescriptorType;
 747
 748         __u8  bmAttributes;     /* support for HNP, SRP and ADP, etc */
 749         __le16 bcdOTG;          /* OTG and EH supplement release number
 750                                  * in binary-coded decimal(i.e. 2.0 is 0200H)
 751                                  */
 752 } __attribute__ ((packed));
 753
 754 /* from usb_otg_descriptor.bmAttributes */
 755 #define USB_OTG_SRP             (1 << 0)
 756 #define USB_OTG_HNP             (1 << 1)        /* swap host/device roles */
 757 #define USB_OTG_ADP             (1 << 2)        /* support ADP */
 758
 759 #define OTG_STS_SELECTOR        0xF000          /* OTG status selector */
 760 /*-------------------------------------------------------------------------*/
 761
 762 /* USB_DT_DEBUG:  for special highspeed devices, replacing serial console */
 763 struct usb_debug_descriptor {
 764         __u8  bLength;
 765         __u8  bDescriptorType;
 766
 767         /* bulk endpoints with 8 byte maxpacket */
 768         __u8  bDebugInEndpoint;
 769         __u8  bDebugOutEndpoint;
 770 } __attribute__((packed));
 771
 772 /*-------------------------------------------------------------------------*/
 773
 774 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
 775 struct usb_interface_assoc_descriptor {
 776         __u8  bLength;
 777         __u8  bDescriptorType;
 778
 779         __u8  bFirstInterface;
 780         __u8  bInterfaceCount;
 781         __u8  bFunctionClass;
 782         __u8  bFunctionSubClass;
 783         __u8  bFunctionProtocol;
 784         __u8  iFunction;
 785 } __attribute__ ((packed));
 786
 787 #define USB_DT_INTERFACE_ASSOCIATION_SIZE       8
 788
 789 /*-------------------------------------------------------------------------*/
 790
 791 /* USB_DT_SECURITY:  group of wireless security descriptors, including
 792  * encryption types available for setting up a CC/association.
 793  */
 794 struct usb_security_descriptor {
 795         __u8  bLength;
 796         __u8  bDescriptorType;
 797
 798         __le16 wTotalLength;
 799         __u8  bNumEncryptionTypes;
 800 } __attribute__((packed));
 801
 802 /*-------------------------------------------------------------------------*/
 803
 804 /* USB_DT_KEY:  used with {GET,SET}_SECURITY_DATA; only public keys
 805  * may be retrieved.
 806  */
 807 struct usb_key_descriptor {
 808         __u8  bLength;
 809         __u8  bDescriptorType;
 810
 811         __u8  tTKID[3];
 812         __u8  bReserved;
 813         __u8  bKeyData[0];
 814 } __attribute__((packed));
 815
 816 /*-------------------------------------------------------------------------*/
 817
 818 /* USB_DT_ENCRYPTION_TYPE:  bundled in DT_SECURITY groups */
 819 struct usb_encryption_descriptor {
 820         __u8  bLength;
 821         __u8  bDescriptorType;
 822
 823         __u8  bEncryptionType;
 824 #define USB_ENC_TYPE_UNSECURE           0
 825 #define USB_ENC_TYPE_WIRED              1       /* non-wireless mode */
 826 #define USB_ENC_TYPE_CCM_1              2       /* aes128/cbc session */
 827 #define USB_ENC_TYPE_RSA_1              3       /* rsa3072/sha1 auth */
 828         __u8  bEncryptionValue;         /* use in SET_ENCRYPTION */
 829         __u8  bAuthKeyIndex;
 830 } __attribute__((packed));
 831
 832
 833 /*-------------------------------------------------------------------------*/
 834
 835 /* USB_DT_BOS:  group of device-level capabilities */
 836 struct usb_bos_descriptor {
 837         __u8  bLength;
 838         __u8  bDescriptorType;
 839
 840         __le16 wTotalLength;
 841         __u8  bNumDeviceCaps;
 842 } __attribute__((packed));
 843
 844 #define USB_DT_BOS_SIZE         5
 845 /*-------------------------------------------------------------------------*/
 846
 847 /* USB_DT_DEVICE_CAPABILITY:  grouped with BOS */
 848 struct usb_dev_cap_header {
 849         __u8  bLength;
 850         __u8  bDescriptorType;
 851         __u8  bDevCapabilityType;
 852 } __attribute__((packed));
 853
 854 #define USB_CAP_TYPE_WIRELESS_USB       1
 855
 856 struct usb_wireless_cap_descriptor {    /* Ultra Wide Band */
 857         __u8  bLength;
 858         __u8  bDescriptorType;
 859         __u8  bDevCapabilityType;
 860
 861         __u8  bmAttributes;
 862 #define USB_WIRELESS_P2P_DRD            (1 << 1)
 863 #define USB_WIRELESS_BEACON_MASK        (3 << 2)
 864 #define USB_WIRELESS_BEACON_SELF        (1 << 2)
 865 #define USB_WIRELESS_BEACON_DIRECTED    (2 << 2)
 866 #define USB_WIRELESS_BEACON_NONE        (3 << 2)
 867         __le16 wPHYRates;       /* bit rates, Mbps */
 868 #define USB_WIRELESS_PHY_53             (1 << 0)        /* always set */
 869 #define USB_WIRELESS_PHY_80             (1 << 1)
 870 #define USB_WIRELESS_PHY_107            (1 << 2)        /* always set */
 871 #define USB_WIRELESS_PHY_160            (1 << 3)
 872 #define USB_WIRELESS_PHY_200            (1 << 4)        /* always set */
 873 #define USB_WIRELESS_PHY_320            (1 << 5)
 874 #define USB_WIRELESS_PHY_400            (1 << 6)
 875 #define USB_WIRELESS_PHY_480            (1 << 7)
 876         __u8  bmTFITXPowerInfo; /* TFI power levels */
 877         __u8  bmFFITXPowerInfo; /* FFI power levels */
 878         __le16 bmBandGroup;
 879         __u8  bReserved;
 880 } __attribute__((packed));
 881
 882 #define USB_DT_USB_WIRELESS_CAP_SIZE    11
 883
 884 /* USB 2.0 Extension descriptor */
 885 #define USB_CAP_TYPE_EXT                2
 886
 887 struct usb_ext_cap_descriptor {         /* Link Power Management */
 888         __u8  bLength;
 889         __u8  bDescriptorType;
 890         __u8  bDevCapabilityType;
 891         __le32 bmAttributes;
 892 #define USB_LPM_SUPPORT                 (1 << 1)        /* supports LPM */
 893 #define USB_BESL_SUPPORT                (1 << 2)        /* supports BESL */
 894 #define USB_BESL_BASELINE_VALID         (1 << 3)        /* Baseline BESL valid*/
 895 #define USB_BESL_DEEP_VALID             (1 << 4)        /* Deep BESL valid */
 896 #define USB_GET_BESL_BASELINE(p)        (((p) & (0xf << 8)) >> 8)
 897 #define USB_GET_BESL_DEEP(p)            (((p) & (0xf << 12)) >> 12)
 898 } __attribute__((packed));
 899
 900 #define USB_DT_USB_EXT_CAP_SIZE 7
 901
 902 /*
 903  * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
 904  * specific device level capabilities
 905  */
 906 #define         USB_SS_CAP_TYPE         3
 907 struct usb_ss_cap_descriptor {          /* Link Power Management */
 908         __u8  bLength;
 909         __u8  bDescriptorType;
 910         __u8  bDevCapabilityType;
 911         __u8  bmAttributes;
 912 #define USB_LTM_SUPPORT                 (1 << 1) /* supports LTM */
 913         __le16 wSpeedSupported;
 914 #define USB_LOW_SPEED_OPERATION         (1)      /* Low speed operation */
 915 #define USB_FULL_SPEED_OPERATION        (1 << 1) /* Full speed operation */
 916 #define USB_HIGH_SPEED_OPERATION        (1 << 2) /* High speed operation */
 917 #define USB_5GBPS_OPERATION             (1 << 3) /* Operation at 5Gbps */
 918         __u8  bFunctionalitySupport;
 919         __u8  bU1devExitLat;
 920         __le16 bU2DevExitLat;
 921 } __attribute__((packed));
 922
 923 #define USB_DT_USB_SS_CAP_SIZE  10
 924
 925 /*
 926  * Container ID Capability descriptor: Defines the instance unique ID used to
 927  * identify the instance across all operating modes
 928  */
 929 #define CONTAINER_ID_TYPE       4
 930 struct usb_ss_container_id_descriptor {
 931         __u8  bLength;
 932         __u8  bDescriptorType;
 933         __u8  bDevCapabilityType;
 934         __u8  bReserved;
 935         __u8  ContainerID[16]; /* 128-bit number */
 936 } __attribute__((packed));
 937
 938 #define USB_DT_USB_SS_CONTN_ID_SIZE     20
 939
 940 /*
 941  * SuperSpeed Plus USB Capability descriptor: Defines the set of
 942  * SuperSpeed Plus USB specific device level capabilities
 943  */
 944 #define USB_SSP_CAP_TYPE        0xa
 945 struct usb_ssp_cap_descriptor {
 946         __u8  bLength;
 947         __u8  bDescriptorType;
 948         __u8  bDevCapabilityType;
 949         __u8  bReserved;
 950         __le32 bmAttributes;
 951 #define USB_SSP_SUBLINK_SPEED_ATTRIBS   (0x1f << 0) /* sublink speed entries */
 952 #define USB_SSP_SUBLINK_SPEED_IDS       (0xf << 5)  /* speed ID entries */
 953         __le16  wFunctionalitySupport;
 954 #define USB_SSP_MIN_SUBLINK_SPEED_ATTRIBUTE_ID  (0xf)
 955 #define USB_SSP_MIN_RX_LANE_COUNT               (0xf << 8)
 956 #define USB_SSP_MIN_TX_LANE_COUNT               (0xf << 12)
 957         __le16 wReserved;
 958         __le32 bmSublinkSpeedAttr[1]; /* list of sublink speed attrib entries */
 959 #define USB_SSP_SUBLINK_SPEED_SSID      (0xf)           /* sublink speed ID */
 960 #define USB_SSP_SUBLINK_SPEED_LSE       (0x3 << 4)      /* Lanespeed exponent */
 961 #define USB_SSP_SUBLINK_SPEED_ST        (0x3 << 6)      /* Sublink type */
 962 #define USB_SSP_SUBLINK_SPEED_RSVD      (0x3f << 8)     /* Reserved */
 963 #define USB_SSP_SUBLINK_SPEED_LP        (0x3 << 14)     /* Link protocol */
 964 #define USB_SSP_SUBLINK_SPEED_LSM       (0xff << 16)    /* Lanespeed mantissa */
 965 } __attribute__((packed));
 966
 967 /*
 968  * USB Power Delivery Capability Descriptor:
 969  * Defines capabilities for PD
 970  */
 971 /* Defines the various PD Capabilities of this device */
 972 #define USB_PD_POWER_DELIVERY_CAPABILITY        0x06
 973 /* Provides information on each battery supported by the device */
 974 #define USB_PD_BATTERY_INFO_CAPABILITY          0x07
 975 /* The Consumer characteristics of a Port on the device */
 976 #define USB_PD_PD_CONSUMER_PORT_CAPABILITY      0x08
 977 /* The provider characteristics of a Port on the device */
 978 #define USB_PD_PD_PROVIDER_PORT_CAPABILITY      0x09
 979
 980 struct usb_pd_cap_descriptor {
 981         __u8  bLength;
 982         __u8  bDescriptorType;
 983         __u8  bDevCapabilityType; /* set to USB_PD_POWER_DELIVERY_CAPABILITY */
 984         __u8  bReserved;
 985         __le32 bmAttributes;
 986 #define USB_PD_CAP_BATTERY_CHARGING     (1 << 1) /* supports Battery Charging specification */
 987 #define USB_PD_CAP_USB_PD               (1 << 2) /* supports USB Power Delivery specification */
 988 #define USB_PD_CAP_PROVIDER             (1 << 3) /* can provide power */
 989 #define USB_PD_CAP_CONSUMER             (1 << 4) /* can consume power */
 990 #define USB_PD_CAP_CHARGING_POLICY      (1 << 5) /* supports CHARGING_POLICY feature */
 991 #define USB_PD_CAP_TYPE_C_CURRENT       (1 << 6) /* supports power capabilities defined in the USB Type-C Specification */
 992
 993 #define USB_PD_CAP_PWR_AC               (1 << 8)
 994 #define USB_PD_CAP_PWR_BAT              (1 << 9)
 995 #define USB_PD_CAP_PWR_USE_V_BUS        (1 << 14)
 996
 997         __le16 bmProviderPorts; /* Bit zero refers to the UFP of the device */
 998         __le16 bmConsumerPorts;
 999         __le16 bcdBCVersion;
1000         __le16 bcdPDVersion;
1001         __le16 bcdUSBTypeCVersion;
1002 } __attribute__((packed));
1003
1004 struct usb_pd_cap_battery_info_descriptor {
1005         __u8 bLength;
1006         __u8 bDescriptorType;
1007         __u8 bDevCapabilityType;
1008         /* Index of string descriptor shall contain the user friendly name for this battery */
1009         __u8 iBattery;
1010         /* Index of string descriptor shall contain the Serial Number String for this battery */
1011         __u8 iSerial;
1012         __u8 iManufacturer;
1013         __u8 bBatteryId; /* uniquely identifies this battery in status Messages */
1014         __u8 bReserved;
1015         /*
1016          * Shall contain the Battery Charge value above which this
1017          * battery is considered to be fully charged but not necessarily
1018          * “topped off.”
1019          */
1020         __le32 dwChargedThreshold; /* in mWh */
1021         /*
1022          * Shall contain the minimum charge level of this battery such
1023          * that above this threshold, a device can be assured of being
1024          * able to power up successfully (see Battery Charging 1.2).
1025          */
1026         __le32 dwWeakThreshold; /* in mWh */
1027         __le32 dwBatteryDesignCapacity; /* in mWh */
1028         __le32 dwBatteryLastFullchargeCapacity; /* in mWh */
1029 } __attribute__((packed));
1030
1031 struct usb_pd_cap_consumer_port_descriptor {
1032         __u8 bLength;
1033         __u8 bDescriptorType;
1034         __u8 bDevCapabilityType;
1035         __u8 bReserved;
1036         __u8 bmCapabilities;
1037 /* port will oerate under: */
1038 #define USB_PD_CAP_CONSUMER_BC          (1 << 0) /* BC */
1039 #define USB_PD_CAP_CONSUMER_PD          (1 << 1) /* PD */
1040 #define USB_PD_CAP_CONSUMER_TYPE_C      (1 << 2) /* USB Type-C Current */
1041         __le16 wMinVoltage; /* in 50mV units */
1042         __le16 wMaxVoltage; /* in 50mV units */
1043         __u16 wReserved;
1044         __le32 dwMaxOperatingPower; /* in 10 mW - operating at steady state */
1045         __le32 dwMaxPeakPower; /* in 10mW units - operating at peak power */
1046         __le32 dwMaxPeakPowerTime; /* in 100ms units - duration of peak */
1047 #define USB_PD_CAP_CONSUMER_UNKNOWN_PEAK_POWER_TIME 0xffff
1048 } __attribute__((packed));
1049
1050 struct usb_pd_cap_provider_port_descriptor {
1051         __u8 bLength;
1052         __u8 bDescriptorType;
1053         __u8 bDevCapabilityType;
1054         __u8 bReserved1;
1055         __u8 bmCapabilities;
1056 /* port will oerate under: */
1057 #define USB_PD_CAP_PROVIDER_BC          (1 << 0) /* BC */
1058 #define USB_PD_CAP_PROVIDER_PD          (1 << 1) /* PD */
1059 #define USB_PD_CAP_PROVIDER_TYPE_C      (1 << 2) /* USB Type-C Current */
1060         __u8 bNumOfPDObjects;
1061         __u8 bReserved2;
1062         __le32 wPowerDataObject[];
1063 } __attribute__((packed));
1064
1065 /*
1066  * Precision time measurement capability descriptor: advertised by devices and
1067  * hubs that support PTM
1068  */
1069 #define USB_PTM_CAP_TYPE        0xb
1070 struct usb_ptm_cap_descriptor {
1071         __u8  bLength;
1072         __u8  bDescriptorType;
1073         __u8  bDevCapabilityType;
1074 } __attribute__((packed));
1075
1076 #define USB_DT_USB_PTM_ID_SIZE          3
1077 /*
1078  * The size of the descriptor for the Sublink Speed Attribute Count
1079  * (SSAC) specified in bmAttributes[4:0].
1080  */
1081 #define USB_DT_USB_SSP_CAP_SIZE(ssac)   (16 + ssac * 4)
1082
1083 /*-------------------------------------------------------------------------*/
1084
1085 /* USB_DT_WIRELESS_ENDPOINT_COMP:  companion descriptor associated with
1086  * each endpoint descriptor for a wireless device
1087  */
1088 struct usb_wireless_ep_comp_descriptor {
1089         __u8  bLength;
1090         __u8  bDescriptorType;
1091
1092         __u8  bMaxBurst;
1093         __u8  bMaxSequence;
1094         __le16 wMaxStreamDelay;
1095         __le16 wOverTheAirPacketSize;
1096         __u8  bOverTheAirInterval;
1097         __u8  bmCompAttributes;
1098 #define USB_ENDPOINT_SWITCH_MASK        0x03    /* in bmCompAttributes */
1099 #define USB_ENDPOINT_SWITCH_NO          0
1100 #define USB_ENDPOINT_SWITCH_SWITCH      1
1101 #define USB_ENDPOINT_SWITCH_SCALE       2
1102 } __attribute__((packed));
1103
1104 /*-------------------------------------------------------------------------*/
1105
1106 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
1107  * host and a device for connection set up, mutual authentication, and
1108  * exchanging short lived session keys.  The handshake depends on a CC.
1109  */
1110 struct usb_handshake {
1111         __u8 bMessageNumber;
1112         __u8 bStatus;
1113         __u8 tTKID[3];
1114         __u8 bReserved;
1115         __u8 CDID[16];
1116         __u8 nonce[16];
1117         __u8 MIC[8];
1118 } __attribute__((packed));
1119
1120 /*-------------------------------------------------------------------------*/
1121
1122 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
1123  * A CC may also be set up using non-wireless secure channels (including
1124  * wired USB!), and some devices may support CCs with multiple hosts.
1125  */
1126 struct usb_connection_context {
1127         __u8 CHID[16];          /* persistent host id */
1128         __u8 CDID[16];          /* device id (unique w/in host context) */
1129         __u8 CK[16];            /* connection key */
1130 } __attribute__((packed));
1131
1132 /*-------------------------------------------------------------------------*/
1133
1134 /* USB 2.0 defines three speeds, here's how Linux identifies them */
1135
1136 enum usb_device_speed {
1137         USB_SPEED_UNKNOWN = 0,                  /* enumerating */
1138         USB_SPEED_LOW, USB_SPEED_FULL,          /* usb 1.1 */
1139         USB_SPEED_HIGH,                         /* usb 2.0 */
1140         USB_SPEED_WIRELESS,                     /* wireless (usb 2.5) */
1141         USB_SPEED_SUPER,                        /* usb 3.0 */
1142         USB_SPEED_SUPER_PLUS,                   /* usb 3.1 */
1143 };
1144
1145
1146 enum usb_device_state {
1147         /* NOTATTACHED isn't in the USB spec, and this state acts
1148          * the same as ATTACHED ... but it's clearer this way.
1149          */
1150         USB_STATE_NOTATTACHED = 0,
1151
1152         /* chapter 9 and authentication (wireless) device states */
1153         USB_STATE_ATTACHED,
1154         USB_STATE_POWERED,                      /* wired */
1155         USB_STATE_RECONNECTING,                 /* auth */
1156         USB_STATE_UNAUTHENTICATED,              /* auth */
1157         USB_STATE_DEFAULT,                      /* limited function */
1158         USB_STATE_ADDRESS,
1159         USB_STATE_CONFIGURED,                   /* most functions */
1160
1161         USB_STATE_SUSPENDED
1162
1163         /* NOTE:  there are actually four different SUSPENDED
1164          * states, returning to POWERED, DEFAULT, ADDRESS, or
1165          * CONFIGURED respectively when SOF tokens flow again.
1166          * At this level there's no difference between L1 and L2
1167          * suspend states.  (L2 being original USB 1.1 suspend.)
1168          */
1169 };
1170
1171 enum usb3_link_state {
1172         USB3_LPM_U0 = 0,
1173         USB3_LPM_U1,
1174         USB3_LPM_U2,
1175         USB3_LPM_U3
1176 };
1177
1178 /*
1179  * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1.
1180  * 0xff means the parent hub will accept transitions to U1, but will not
1181  * initiate a transition.
1182  *
1183  * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to
1184  * U1 after that many microseconds.  Timeouts of 0x80 to 0xFE are reserved
1185  * values.
1186  *
1187  * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2.
1188  * 0xff means the parent hub will accept transitions to U2, but will not
1189  * initiate a transition.
1190  *
1191  * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to
1192  * U2 after N*256 microseconds.  Therefore a U2 timeout value of 0x1 means a U2
1193  * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means
1194  * 65.024ms.
1195  */
1196 #define USB3_LPM_DISABLED               0x0
1197 #define USB3_LPM_U1_MAX_TIMEOUT         0x7F
1198 #define USB3_LPM_U2_MAX_TIMEOUT         0xFE
1199 #define USB3_LPM_DEVICE_INITIATED       0xFF
1200
1201 struct usb_set_sel_req {
1202         __u8    u1_sel;
1203         __u8    u1_pel;
1204         __le16  u2_sel;
1205         __le16  u2_pel;
1206 } __attribute__ ((packed));
1207
1208 /*
1209  * The Set System Exit Latency control transfer provides one byte each for
1210  * U1 SEL and U1 PEL, so the max exit latency is 0xFF.  U2 SEL and U2 PEL each
1211  * are two bytes long.
1212  */
1213 #define USB3_LPM_MAX_U1_SEL_PEL         0xFF
1214 #define USB3_LPM_MAX_U2_SEL_PEL         0xFFFF
1215
1216 /*-------------------------------------------------------------------------*/
1217
1218 /*
1219  * As per USB compliance update, a device that is actively drawing
1220  * more than 100mA from USB must report itself as bus-powered in
1221  * the GetStatus(DEVICE) call.
1222  * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
1223  */
1224 #define USB_SELF_POWER_VBUS_MAX_DRAW            100
1225
1226 #endif /* _UAPI__LINUX_USB_CH9_H */