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