include/linux/usb/ch9.h

   1 /*
   2  * This file holds USB constants and structures that are needed for
   3  * USB device APIs.  These are used by the USB device model, which is
   4  * defined in chapter 9 of the USB 2.0 specification and in the
   5  * Wireless USB 1.0 (spread around).  Linux has several APIs in C that
   6  * need these:
   7  *
   8  * - the master/host side Linux-USB kernel driver API;
   9  * - the "usbfs" user space API; and
  10  * - the Linux "gadget" slave/device/peripheral side driver API.
  11  *
  12  * USB 2.0 adds an additional "On The Go" (OTG) mode, which lets systems
  13  * act either as a USB master/host or as a USB slave/device.  That means
  14  * the master and slave side APIs benefit from working well together.
  15  *
  16  * There's also "Wireless USB", using low power short range radios for
  17  * peripheral interconnection but otherwise building on the USB framework.
  18  *
  19  * Note all descriptors are declared '__attribute__((packed))' so that:
  20  *
  21  * [a] they never get padded, either internally (USB spec writers
  22  *     probably handled that) or externally;
  23  *
  24  * [b] so that accessing bigger-than-a-bytes fields will never
  25  *     generate bus errors on any platform, even when the location of
  26  *     its descriptor inside a bundle isn't "naturally aligned", and
  27  *
  28  * [c] for consistency, removing all doubt even when it appears to
  29  *     someone that the two other points are non-issues for that
  30  *     particular descriptor type.
  31  */
  32
  33 #ifndef __LINUX_USB_CH9_H
  34 #define __LINUX_USB_CH9_H
  35
  36 #include <linux/types.h>        /* __u8 etc */
  37 #include <asm/byteorder.h>      /* le16_to_cpu */
  38
  39 /*-------------------------------------------------------------------------*/
  40
  41 /* CONTROL REQUEST SUPPORT */
  42
  43 /*
  44  * USB directions
  45  *
  46  * This bit flag is used in endpoint descriptors' bEndpointAddress field.
  47  * It's also one of three fields in control requests bRequestType.
  48  */
  49 #define USB_DIR_OUT                     0               /* to device */
  50 #define USB_DIR_IN                      0x80            /* to host */
  51
  52 /*
  53  * USB types, the second of three bRequestType fields
  54  */
  55 #define USB_TYPE_MASK                   (0x03 << 5)
  56 #define USB_TYPE_STANDARD               (0x00 << 5)
  57 #define USB_TYPE_CLASS                  (0x01 << 5)
  58 #define USB_TYPE_VENDOR                 (0x02 << 5)
  59 #define USB_TYPE_RESERVED               (0x03 << 5)
  60
  61 /*
  62  * USB recipients, the third of three bRequestType fields
  63  */
  64 #define USB_RECIP_MASK                  0x1f
  65 #define USB_RECIP_DEVICE                0x00
  66 #define USB_RECIP_INTERFACE             0x01
  67 #define USB_RECIP_ENDPOINT              0x02
  68 #define USB_RECIP_OTHER                 0x03
  69 /* From Wireless USB 1.0 */
  70 #define USB_RECIP_PORT                  0x04
  71 #define USB_RECIP_RPIPE         0x05
  72
  73 /*
  74  * Standard requests, for the bRequest field of a SETUP packet.
  75  *
  76  * These are qualified by the bRequestType field, so that for example
  77  * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved
  78  * by a GET_STATUS request.
  79  */
  80 #define USB_REQ_GET_STATUS              0x00
  81 #define USB_REQ_CLEAR_FEATURE           0x01
  82 #define USB_REQ_SET_FEATURE             0x03
  83 #define USB_REQ_SET_ADDRESS             0x05
  84 #define USB_REQ_GET_DESCRIPTOR          0x06
  85 #define USB_REQ_SET_DESCRIPTOR          0x07
  86 #define USB_REQ_GET_CONFIGURATION       0x08
  87 #define USB_REQ_SET_CONFIGURATION       0x09
  88 #define USB_REQ_GET_INTERFACE           0x0A
  89 #define USB_REQ_SET_INTERFACE           0x0B
  90 #define USB_REQ_SYNCH_FRAME             0x0C
  91
  92 #define USB_REQ_SET_ENCRYPTION          0x0D    /* Wireless USB */
  93 #define USB_REQ_GET_ENCRYPTION          0x0E
  94 #define USB_REQ_RPIPE_ABORT             0x0E
  95 #define USB_REQ_SET_HANDSHAKE           0x0F
  96 #define USB_REQ_RPIPE_RESET             0x0F
  97 #define USB_REQ_GET_HANDSHAKE           0x10
  98 #define USB_REQ_SET_CONNECTION          0x11
  99 #define USB_REQ_SET_SECURITY_DATA       0x12
 100 #define USB_REQ_GET_SECURITY_DATA       0x13
 101 #define USB_REQ_SET_WUSB_DATA           0x14
 102 #define USB_REQ_LOOPBACK_DATA_WRITE     0x15
 103 #define USB_REQ_LOOPBACK_DATA_READ      0x16
 104 #define USB_REQ_SET_INTERFACE_DS        0x17
 105
 106 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
 107  * used by hubs to put ports into a new L1 suspend state, except that it
 108  * forgot to define its number ...
 109  */
 110
 111 /*
 112  * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
 113  * are read as a bit array returned by USB_REQ_GET_STATUS.  (So there
 114  * are at most sixteen features of each type.)  Hubs may also support a
 115  * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
 116  */
 117 #define USB_DEVICE_SELF_POWERED         0       /* (read only) */
 118 #define USB_DEVICE_REMOTE_WAKEUP        1       /* dev may initiate wakeup */
 119 #define USB_DEVICE_TEST_MODE            2       /* (wired high speed only) */
 120 #define USB_DEVICE_BATTERY              2       /* (wireless) */
 121 #define USB_DEVICE_B_HNP_ENABLE         3       /* (otg) dev may initiate HNP */
 122 #define USB_DEVICE_WUSB_DEVICE          3       /* (wireless)*/
 123 #define USB_DEVICE_A_HNP_SUPPORT        4       /* (otg) RH port supports HNP */
 124 #define USB_DEVICE_A_ALT_HNP_SUPPORT    5       /* (otg) other RH port does */
 125 #define USB_DEVICE_DEBUG_MODE           6       /* (special devices only) */
 126
 127 /*
 128  * Test Mode Selectors
 129  * See USB 2.0 spec Table 9-7
 130  */
 131 #define TEST_J          1
 132 #define TEST_K          2
 133 #define TEST_SE0_NAK    3
 134 #define TEST_PACKET     4
 135 #define TEST_FORCE_EN   5
 136
 137 /*
 138  * New Feature Selectors as added by USB 3.0
 139  * See USB 3.0 spec Table 9-6
 140  */
 141 #define USB_DEVICE_U1_ENABLE    48      /* dev may initiate U1 transition */
 142 #define USB_DEVICE_U2_ENABLE    49      /* dev may initiate U2 transition */
 143 #define USB_DEVICE_LTM_ENABLE   50      /* dev may send LTM */
 144 #define USB_INTRF_FUNC_SUSPEND  0       /* function suspend */
 145
 146 #define USB_INTR_FUNC_SUSPEND_OPT_MASK  0xFF00
 147 /*
 148  * Suspend Options, Table 9-7 USB 3.0 spec
 149  */
 150 #define USB_INTRF_FUNC_SUSPEND_LP       (1 << (8 + 0))
 151 #define USB_INTRF_FUNC_SUSPEND_RW       (1 << (8 + 1))
 152
 153 #define USB_ENDPOINT_HALT               0       /* IN/OUT will STALL */
 154
 155 /* Bit array elements as returned by the USB_REQ_GET_STATUS request. */
 156 #define USB_DEV_STAT_U1_ENABLED         2       /* transition into U1 state */
 157 #define USB_DEV_STAT_U2_ENABLED         3       /* transition into U2 state */
 158 #define USB_DEV_STAT_LTM_ENABLED        4       /* Latency tolerance messages */
 159
 160 /**
 161  * struct usb_ctrlrequest - SETUP data for a USB device control request
 162  * @bRequestType: matches the USB bmRequestType field
 163  * @bRequest: matches the USB bRequest field
 164  * @wValue: matches the USB wValue field (le16 byte order)
 165  * @wIndex: matches the USB wIndex field (le16 byte order)
 166  * @wLength: matches the USB wLength field (le16 byte order)
 167  *
 168  * This structure is used to send control requests to a USB device.  It matches
 169  * the different fields of the USB 2.0 Spec section 9.3, table 9-2.  See the
 170  * USB spec for a fuller description of the different fields, and what they are
 171  * used for.
 172  *
 173  * Note that the driver for any interface can issue control requests.
 174  * For most devices, interfaces don't coordinate with each other, so
 175  * such requests may be made at any time.
 176  */
 177 struct usb_ctrlrequest {
 178         __u8 bRequestType;
 179         __u8 bRequest;
 180         __le16 wValue;
 181         __le16 wIndex;
 182         __le16 wLength;
 183 } __attribute__ ((packed));
 184
 185 /*-------------------------------------------------------------------------*/
 186
 187 /*
 188  * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
 189  * (rarely) accepted by SET_DESCRIPTOR.
 190  *
 191  * Note that all multi-byte values here are encoded in little endian
 192  * byte order "on the wire".  Within the kernel and when exposed
 193  * through the Linux-USB APIs, they are not converted to cpu byte
 194  * order; it is the responsibility of the client code to do this.
 195  * The single exception is when device and configuration descriptors (but
 196  * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD);
 197  * in this case the fields are converted to host endianness by the kernel.
 198  */
 199
 200 /*
 201  * Descriptor types ... USB 2.0 spec table 9.5
 202  */
 203 #define USB_DT_DEVICE                   0x01
 204 #define USB_DT_CONFIG                   0x02
 205 #define USB_DT_STRING                   0x03
 206 #define USB_DT_INTERFACE                0x04
 207 #define USB_DT_ENDPOINT                 0x05
 208 #define USB_DT_DEVICE_QUALIFIER         0x06
 209 #define USB_DT_OTHER_SPEED_CONFIG       0x07
 210 #define USB_DT_INTERFACE_POWER          0x08
 211 /* these are from a minor usb 2.0 revision (ECN) */
 212 #define USB_DT_OTG                      0x09
 213 #define USB_DT_DEBUG                    0x0a
 214 #define USB_DT_INTERFACE_ASSOCIATION    0x0b
 215 /* these are from the Wireless USB spec */
 216 #define USB_DT_SECURITY                 0x0c
 217 #define USB_DT_KEY                      0x0d
 218 #define USB_DT_ENCRYPTION_TYPE          0x0e
 219 #define USB_DT_BOS                      0x0f
 220 #define USB_DT_DEVICE_CAPABILITY        0x10
 221 #define USB_DT_WIRELESS_ENDPOINT_COMP   0x11
 222 #define USB_DT_WIRE_ADAPTER             0x21
 223 #define USB_DT_RPIPE                    0x22
 224 #define USB_DT_CS_RADIO_CONTROL         0x23
 225 /* From the T10 UAS specification */
 226 #define USB_DT_PIPE_USAGE               0x24
 227 /* From the USB 3.0 spec */
 228 #define USB_DT_SS_ENDPOINT_COMP         0x30
 229
 230 /* Conventional codes for class-specific descriptors.  The convention is
 231  * defined in the USB "Common Class" Spec (3.11).  Individual class specs
 232  * are authoritative for their usage, not the "common class" writeup.
 233  */
 234 #define USB_DT_CS_DEVICE                (USB_TYPE_CLASS | USB_DT_DEVICE)
 235 #define USB_DT_CS_CONFIG                (USB_TYPE_CLASS | USB_DT_CONFIG)
 236 #define USB_DT_CS_STRING                (USB_TYPE_CLASS | USB_DT_STRING)
 237 #define USB_DT_CS_INTERFACE             (USB_TYPE_CLASS | USB_DT_INTERFACE)
 238 #define USB_DT_CS_ENDPOINT              (USB_TYPE_CLASS | USB_DT_ENDPOINT)
 239
 240 /* All standard descriptors have these 2 fields at the beginning */
 241 struct usb_descriptor_header {
 242         __u8  bLength;
 243         __u8  bDescriptorType;
 244 } __attribute__ ((packed));
 245
 246
 247 /*-------------------------------------------------------------------------*/
 248
 249 /* USB_DT_DEVICE: Device descriptor */
 250 struct usb_device_descriptor {
 251         __u8  bLength;
 252         __u8  bDescriptorType;
 253
 254         __le16 bcdUSB;
 255         __u8  bDeviceClass;
 256         __u8  bDeviceSubClass;
 257         __u8  bDeviceProtocol;
 258         __u8  bMaxPacketSize0;
 259         __le16 idVendor;
 260         __le16 idProduct;
 261         __le16 bcdDevice;
 262         __u8  iManufacturer;
 263         __u8  iProduct;
 264         __u8  iSerialNumber;
 265         __u8  bNumConfigurations;
 266 } __attribute__ ((packed));
 267
 268 #define USB_DT_DEVICE_SIZE              18
 269
 270
 271 /*
 272  * Device and/or Interface Class codes
 273  * as found in bDeviceClass or bInterfaceClass
 274  * and defined by www.usb.org documents
 275  */
 276 #define USB_CLASS_PER_INTERFACE         0       /* for DeviceClass */
 277 #define USB_CLASS_AUDIO                 1
 278 #define USB_CLASS_COMM                  2
 279 #define USB_CLASS_HID                   3
 280 #define USB_CLASS_PHYSICAL              5
 281 #define USB_CLASS_STILL_IMAGE           6
 282 #define USB_CLASS_PRINTER               7
 283 #define USB_CLASS_MASS_STORAGE          8
 284 #define USB_CLASS_HUB                   9
 285 #define USB_CLASS_CDC_DATA              0x0a
 286 #define USB_CLASS_CSCID                 0x0b    /* chip+ smart card */
 287 #define USB_CLASS_CONTENT_SEC           0x0d    /* content security */
 288 #define USB_CLASS_VIDEO                 0x0e
 289 #define USB_CLASS_WIRELESS_CONTROLLER   0xe0
 290 #define USB_CLASS_MISC                  0xef
 291 #define USB_CLASS_APP_SPEC              0xfe
 292 #define USB_CLASS_VENDOR_SPEC           0xff
 293
 294 #define USB_SUBCLASS_VENDOR_SPEC        0xff
 295
 296 /*-------------------------------------------------------------------------*/
 297
 298 /* USB_DT_CONFIG: Configuration descriptor information.
 299  *
 300  * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
 301  * descriptor type is different.  Highspeed-capable devices can look
 302  * different depending on what speed they're currently running.  Only
 303  * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
 304  * descriptors.
 305  */
 306 struct usb_config_descriptor {
 307         __u8  bLength;
 308         __u8  bDescriptorType;
 309
 310         __le16 wTotalLength;
 311         __u8  bNumInterfaces;
 312         __u8  bConfigurationValue;
 313         __u8  iConfiguration;
 314         __u8  bmAttributes;
 315         __u8  bMaxPower;
 316 } __attribute__ ((packed));
 317
 318 #define USB_DT_CONFIG_SIZE              9
 319
 320 /* from config descriptor bmAttributes */
 321 #define USB_CONFIG_ATT_ONE              (1 << 7)        /* must be set */
 322 #define USB_CONFIG_ATT_SELFPOWER        (1 << 6)        /* self powered */
 323 #define USB_CONFIG_ATT_WAKEUP           (1 << 5)        /* can wakeup */
 324 #define USB_CONFIG_ATT_BATTERY          (1 << 4)        /* battery powered */
 325
 326 /*-------------------------------------------------------------------------*/
 327
 328 /* USB_DT_STRING: String descriptor */
 329 struct usb_string_descriptor {
 330         __u8  bLength;
 331         __u8  bDescriptorType;
 332
 333         __le16 wData[1];                /* UTF-16LE encoded */
 334 } __attribute__ ((packed));
 335
 336 /* note that "string" zero is special, it holds language codes that
 337  * the device supports, not Unicode characters.
 338  */
 339
 340 /*-------------------------------------------------------------------------*/
 341
 342 /* USB_DT_INTERFACE: Interface descriptor */
 343 struct usb_interface_descriptor {
 344         __u8  bLength;
 345         __u8  bDescriptorType;
 346
 347         __u8  bInterfaceNumber;
 348         __u8  bAlternateSetting;
 349         __u8  bNumEndpoints;
 350         __u8  bInterfaceClass;
 351         __u8  bInterfaceSubClass;
 352         __u8  bInterfaceProtocol;
 353         __u8  iInterface;
 354 } __attribute__ ((packed));
 355
 356 #define USB_DT_INTERFACE_SIZE           9
 357
 358 /*-------------------------------------------------------------------------*/
 359
 360 /* USB_DT_ENDPOINT: Endpoint descriptor */
 361 struct usb_endpoint_descriptor {
 362         __u8  bLength;
 363         __u8  bDescriptorType;
 364
 365         __u8  bEndpointAddress;
 366         __u8  bmAttributes;
 367         __le16 wMaxPacketSize;
 368         __u8  bInterval;
 369
 370         /* NOTE:  these two are _only_ in audio endpoints. */
 371         /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
 372         __u8  bRefresh;
 373         __u8  bSynchAddress;
 374 } __attribute__ ((packed));
 375
 376 #define USB_DT_ENDPOINT_SIZE            7
 377 #define USB_DT_ENDPOINT_AUDIO_SIZE      9       /* Audio extension */
 378
 379
 380 /*
 381  * Endpoints
 382  */
 383 #define USB_ENDPOINT_NUMBER_MASK        0x0f    /* in bEndpointAddress */
 384 #define USB_ENDPOINT_DIR_MASK           0x80
 385
 386 #define USB_ENDPOINT_XFERTYPE_MASK      0x03    /* in bmAttributes */
 387 #define USB_ENDPOINT_XFER_CONTROL       0
 388 #define USB_ENDPOINT_XFER_ISOC          1
 389 #define USB_ENDPOINT_XFER_BULK          2
 390 #define USB_ENDPOINT_XFER_INT           3
 391 #define USB_ENDPOINT_MAX_ADJUSTABLE     0x80
 392
 393 #define USB_EP_MAXP_MULT_SHIFT  11
 394 #define USB_EP_MAXP_MULT_MASK   (3 << USB_EP_MAXP_MULT_SHIFT)
 395 #define USB_EP_MAXP_MULT(m) \
 396         (((m) & USB_EP_MAXP_MULT_MASK) >> USB_EP_MAXP_MULT_SHIFT)
 397
 398 #define USB_ENDPOINT_SYNCTYPE           0x0c
 399 #define USB_ENDPOINT_SYNC_NONE          (0 << 2)
 400 #define USB_ENDPOINT_SYNC_ASYNC         (1 << 2)
 401 #define USB_ENDPOINT_SYNC_ADAPTIVE      (2 << 2)
 402 #define USB_ENDPOINT_SYNC_SYNC          (3 << 2)
 403
 404 #define USB_ENDPOINT_USAGE_MASK         0x30
 405 #define USB_ENDPOINT_USAGE_DATA         0x00
 406 #define USB_ENDPOINT_USAGE_FEEDBACK     0x10
 407 #define USB_ENDPOINT_USAGE_IMPLICIT_FB  0x20    /* Implicit feedback Data endpoint */
 408
 409 /*-------------------------------------------------------------------------*/
 410
 411 /**
 412  * usb_endpoint_num - get the endpoint's number
 413  * @epd: endpoint to be checked
 414  *
 415  * Returns @epd's number: 0 to 15.
 416  */
 417 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
 418 {
 419         return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
 420 }
 421
 422 /**
 423  * usb_endpoint_type - get the endpoint's transfer type
 424  * @epd: endpoint to be checked
 425  *
 426  * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
 427  * to @epd's transfer type.
 428  */
 429 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
 430 {
 431         return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
 432 }
 433
 434 /**
 435  * usb_endpoint_dir_in - check if the endpoint has IN direction
 436  * @epd: endpoint to be checked
 437  *
 438  * Returns true if the endpoint is of type IN, otherwise it returns false.
 439  */
 440 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
 441 {
 442         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
 443 }
 444
 445 /**
 446  * usb_endpoint_dir_out - check if the endpoint has OUT direction
 447  * @epd: endpoint to be checked
 448  *
 449  * Returns true if the endpoint is of type OUT, otherwise it returns false.
 450  */
 451 static inline int usb_endpoint_dir_out(
 452                                 const struct usb_endpoint_descriptor *epd)
 453 {
 454         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
 455 }
 456
 457 /**
 458  * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
 459  * @epd: endpoint to be checked
 460  *
 461  * Returns true if the endpoint is of type bulk, otherwise it returns false.
 462  */
 463 static inline int usb_endpoint_xfer_bulk(
 464                                 const struct usb_endpoint_descriptor *epd)
 465 {
 466         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 467                 USB_ENDPOINT_XFER_BULK);
 468 }
 469
 470 /**
 471  * usb_endpoint_xfer_control - check if the endpoint has control transfer type
 472  * @epd: endpoint to be checked
 473  *
 474  * Returns true if the endpoint is of type control, otherwise it returns false.
 475  */
 476 static inline int usb_endpoint_xfer_control(
 477                                 const struct usb_endpoint_descriptor *epd)
 478 {
 479         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 480                 USB_ENDPOINT_XFER_CONTROL);
 481 }
 482
 483 /**
 484  * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
 485  * @epd: endpoint to be checked
 486  *
 487  * Returns true if the endpoint is of type interrupt, otherwise it returns
 488  * false.
 489  */
 490 static inline int usb_endpoint_xfer_int(
 491                                 const struct usb_endpoint_descriptor *epd)
 492 {
 493         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 494                 USB_ENDPOINT_XFER_INT);
 495 }
 496
 497 /**
 498  * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
 499  * @epd: endpoint to be checked
 500  *
 501  * Returns true if the endpoint is of type isochronous, otherwise it returns
 502  * false.
 503  */
 504 static inline int usb_endpoint_xfer_isoc(
 505                                 const struct usb_endpoint_descriptor *epd)
 506 {
 507         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 508                 USB_ENDPOINT_XFER_ISOC);
 509 }
 510
 511 /**
 512  * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
 513  * @epd: endpoint to be checked
 514  *
 515  * Returns true if the endpoint has bulk transfer type and IN direction,
 516  * otherwise it returns false.
 517  */
 518 static inline int usb_endpoint_is_bulk_in(
 519                                 const struct usb_endpoint_descriptor *epd)
 520 {
 521         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
 522 }
 523
 524 /**
 525  * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
 526  * @epd: endpoint to be checked
 527  *
 528  * Returns true if the endpoint has bulk transfer type and OUT direction,
 529  * otherwise it returns false.
 530  */
 531 static inline int usb_endpoint_is_bulk_out(
 532                                 const struct usb_endpoint_descriptor *epd)
 533 {
 534         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
 535 }
 536
 537 /**
 538  * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
 539  * @epd: endpoint to be checked
 540  *
 541  * Returns true if the endpoint has interrupt transfer type and IN direction,
 542  * otherwise it returns false.
 543  */
 544 static inline int usb_endpoint_is_int_in(
 545                                 const struct usb_endpoint_descriptor *epd)
 546 {
 547         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
 548 }
 549
 550 /**
 551  * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
 552  * @epd: endpoint to be checked
 553  *
 554  * Returns true if the endpoint has interrupt transfer type and OUT direction,
 555  * otherwise it returns false.
 556  */
 557 static inline int usb_endpoint_is_int_out(
 558                                 const struct usb_endpoint_descriptor *epd)
 559 {
 560         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
 561 }
 562
 563 /**
 564  * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
 565  * @epd: endpoint to be checked
 566  *
 567  * Returns true if the endpoint has isochronous transfer type and IN direction,
 568  * otherwise it returns false.
 569  */
 570 static inline int usb_endpoint_is_isoc_in(
 571                                 const struct usb_endpoint_descriptor *epd)
 572 {
 573         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
 574 }
 575
 576 /**
 577  * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
 578  * @epd: endpoint to be checked
 579  *
 580  * Returns true if the endpoint has isochronous transfer type and OUT direction,
 581  * otherwise it returns false.
 582  */
 583 static inline int usb_endpoint_is_isoc_out(
 584                                 const struct usb_endpoint_descriptor *epd)
 585 {
 586         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
 587 }
 588
 589 /**
 590  * usb_endpoint_maxp - get endpoint's max packet size
 591  * @epd: endpoint to be checked
 592  *
 593  * Returns @epd's max packet
 594  */
 595 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
 596 {
 597         return __le16_to_cpu(epd->wMaxPacketSize);
 598 }
 599
 600 /**
 601  * usb_endpoint_maxp_mult - get endpoint's transactional opportunities
 602  * @epd: endpoint to be checked
 603  *
 604  * Return @epd's wMaxPacketSize[12:11] + 1
 605  */
 606 static inline int
 607 usb_endpoint_maxp_mult(const struct usb_endpoint_descriptor *epd)
 608 {
 609         int maxp = __le16_to_cpu(epd->wMaxPacketSize);
 610
 611         return USB_EP_MAXP_MULT(maxp) + 1;
 612 }
 613
 614 /*-------------------------------------------------------------------------*/
 615
 616 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
 617 struct usb_ss_ep_comp_descriptor {
 618         __u8  bLength;
 619         __u8  bDescriptorType;
 620
 621         __u8  bMaxBurst;
 622         __u8  bmAttributes;
 623         __le16 wBytesPerInterval;
 624 } __attribute__ ((packed));
 625
 626 #define USB_DT_SS_EP_COMP_SIZE          6
 627
 628 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */
 629 static inline int
 630 usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp)
 631 {
 632         int             max_streams;
 633
 634         if (!comp)
 635                 return 0;
 636
 637         max_streams = comp->bmAttributes & 0x1f;
 638
 639         if (!max_streams)
 640                 return 0;
 641
 642         max_streams = 1 << max_streams;
 643
 644         return max_streams;
 645 }
 646
 647 /* Bits 1:0 of bmAttributes if this is an isoc endpoint */
 648 #define USB_SS_MULT(p)                  (1 + ((p) & 0x3))
 649
 650 /*-------------------------------------------------------------------------*/
 651
 652 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
 653 struct usb_qualifier_descriptor {
 654         __u8  bLength;
 655         __u8  bDescriptorType;
 656
 657         __le16 bcdUSB;
 658         __u8  bDeviceClass;
 659         __u8  bDeviceSubClass;
 660         __u8  bDeviceProtocol;
 661         __u8  bMaxPacketSize0;
 662         __u8  bNumConfigurations;
 663         __u8  bRESERVED;
 664 } __attribute__ ((packed));
 665
 666
 667 /*-------------------------------------------------------------------------*/
 668
 669 /* USB_DT_OTG (from OTG 1.0a supplement) */
 670 struct usb_otg_descriptor {
 671         __u8  bLength;
 672         __u8  bDescriptorType;
 673
 674         __u8  bmAttributes;     /* support for HNP, SRP, etc */
 675 } __attribute__ ((packed));
 676
 677 /* from usb_otg_descriptor.bmAttributes */
 678 #define USB_OTG_SRP             (1 << 0)
 679 #define USB_OTG_HNP             (1 << 1)        /* swap host/device roles */
 680
 681 /*-------------------------------------------------------------------------*/
 682
 683 /* USB_DT_DEBUG:  for special highspeed devices, replacing serial console */
 684 struct usb_debug_descriptor {
 685         __u8  bLength;
 686         __u8  bDescriptorType;
 687
 688         /* bulk endpoints with 8 byte maxpacket */
 689         __u8  bDebugInEndpoint;
 690         __u8  bDebugOutEndpoint;
 691 } __attribute__((packed));
 692
 693 /*-------------------------------------------------------------------------*/
 694
 695 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
 696 struct usb_interface_assoc_descriptor {
 697         __u8  bLength;
 698         __u8  bDescriptorType;
 699
 700         __u8  bFirstInterface;
 701         __u8  bInterfaceCount;
 702         __u8  bFunctionClass;
 703         __u8  bFunctionSubClass;
 704         __u8  bFunctionProtocol;
 705         __u8  iFunction;
 706 } __attribute__ ((packed));
 707
 708 #define USB_DT_INTERFACE_ASSOCIATION_SIZE       8
 709
 710 /*-------------------------------------------------------------------------*/
 711
 712 /* USB_DT_SECURITY:  group of wireless security descriptors, including
 713  * encryption types available for setting up a CC/association.
 714  */
 715 struct usb_security_descriptor {
 716         __u8  bLength;
 717         __u8  bDescriptorType;
 718
 719         __le16 wTotalLength;
 720         __u8  bNumEncryptionTypes;
 721 } __attribute__((packed));
 722
 723 /*-------------------------------------------------------------------------*/
 724
 725 /* USB_DT_KEY:  used with {GET,SET}_SECURITY_DATA; only public keys
 726  * may be retrieved.
 727  */
 728 struct usb_key_descriptor {
 729         __u8  bLength;
 730         __u8  bDescriptorType;
 731
 732         __u8  tTKID[3];
 733         __u8  bReserved;
 734         __u8  bKeyData[0];
 735 } __attribute__((packed));
 736
 737 /*-------------------------------------------------------------------------*/
 738
 739 /* USB_DT_ENCRYPTION_TYPE:  bundled in DT_SECURITY groups */
 740 struct usb_encryption_descriptor {
 741         __u8  bLength;
 742         __u8  bDescriptorType;
 743
 744         __u8  bEncryptionType;
 745 #define USB_ENC_TYPE_UNSECURE           0
 746 #define USB_ENC_TYPE_WIRED              1       /* non-wireless mode */
 747 #define USB_ENC_TYPE_CCM_1              2       /* aes128/cbc session */
 748 #define USB_ENC_TYPE_RSA_1              3       /* rsa3072/sha1 auth */
 749         __u8  bEncryptionValue;         /* use in SET_ENCRYPTION */
 750         __u8  bAuthKeyIndex;
 751 } __attribute__((packed));
 752
 753
 754 /*-------------------------------------------------------------------------*/
 755
 756 /* USB_DT_BOS:  group of device-level capabilities */
 757 struct usb_bos_descriptor {
 758         __u8  bLength;
 759         __u8  bDescriptorType;
 760
 761         __le16 wTotalLength;
 762         __u8  bNumDeviceCaps;
 763 } __attribute__((packed));
 764
 765 #define USB_DT_BOS_SIZE         5
 766 /*-------------------------------------------------------------------------*/
 767
 768 /* USB_DT_DEVICE_CAPABILITY:  grouped with BOS */
 769 struct usb_dev_cap_header {
 770         __u8  bLength;
 771         __u8  bDescriptorType;
 772         __u8  bDevCapabilityType;
 773 } __attribute__((packed));
 774
 775 #define USB_CAP_TYPE_WIRELESS_USB       1
 776
 777 struct usb_wireless_cap_descriptor {    /* Ultra Wide Band */
 778         __u8  bLength;
 779         __u8  bDescriptorType;
 780         __u8  bDevCapabilityType;
 781
 782         __u8  bmAttributes;
 783 #define USB_WIRELESS_P2P_DRD            (1 << 1)
 784 #define USB_WIRELESS_BEACON_MASK        (3 << 2)
 785 #define USB_WIRELESS_BEACON_SELF        (1 << 2)
 786 #define USB_WIRELESS_BEACON_DIRECTED    (2 << 2)
 787 #define USB_WIRELESS_BEACON_NONE        (3 << 2)
 788         __le16 wPHYRates;       /* bit rates, Mbps */
 789 #define USB_WIRELESS_PHY_53             (1 << 0)        /* always set */
 790 #define USB_WIRELESS_PHY_80             (1 << 1)
 791 #define USB_WIRELESS_PHY_107            (1 << 2)        /* always set */
 792 #define USB_WIRELESS_PHY_160            (1 << 3)
 793 #define USB_WIRELESS_PHY_200            (1 << 4)        /* always set */
 794 #define USB_WIRELESS_PHY_320            (1 << 5)
 795 #define USB_WIRELESS_PHY_400            (1 << 6)
 796 #define USB_WIRELESS_PHY_480            (1 << 7)
 797         __u8  bmTFITXPowerInfo; /* TFI power levels */
 798         __u8  bmFFITXPowerInfo; /* FFI power levels */
 799         __le16 bmBandGroup;
 800         __u8  bReserved;
 801 } __attribute__((packed));
 802
 803 #define USB_DT_USB_WIRELESS_CAP_SIZE    11
 804
 805 /* USB 2.0 Extension descriptor */
 806 #define USB_CAP_TYPE_EXT                2
 807
 808 struct usb_ext_cap_descriptor {         /* Link Power Management */
 809         __u8  bLength;
 810         __u8  bDescriptorType;
 811         __u8  bDevCapabilityType;
 812         __le32 bmAttributes;
 813 #define USB_LPM_SUPPORT                 (1 << 1)        /* supports LPM */
 814 } __attribute__((packed));
 815
 816 #define USB_DT_USB_EXT_CAP_SIZE 7
 817
 818 /*
 819  * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
 820  * specific device level capabilities
 821  */
 822 #define         USB_SS_CAP_TYPE         3
 823 struct usb_ss_cap_descriptor {          /* Link Power Management */
 824         __u8  bLength;
 825         __u8  bDescriptorType;
 826         __u8  bDevCapabilityType;
 827         __u8  bmAttributes;
 828 #define USB_LTM_SUPPORT                 (1 << 1) /* supports LTM */
 829         __le16 wSpeedSupported;
 830 #define USB_LOW_SPEED_OPERATION         (1)      /* Low speed operation */
 831 #define USB_FULL_SPEED_OPERATION        (1 << 1) /* Full speed operation */
 832 #define USB_HIGH_SPEED_OPERATION        (1 << 2) /* High speed operation */
 833 #define USB_5GBPS_OPERATION             (1 << 3) /* Operation at 5Gbps */
 834         __u8  bFunctionalitySupport;
 835         __u8  bU1devExitLat;
 836         __le16 bU2DevExitLat;
 837 } __attribute__((packed));
 838
 839 #define USB_DT_USB_SS_CAP_SIZE  10
 840
 841 /*
 842  * Container ID Capability descriptor: Defines the instance unique ID used to
 843  * identify the instance across all operating modes
 844  */
 845 #define CONTAINER_ID_TYPE       4
 846 struct usb_ss_container_id_descriptor {
 847         __u8  bLength;
 848         __u8  bDescriptorType;
 849         __u8  bDevCapabilityType;
 850         __u8  bReserved;
 851         __u8  ContainerID[16]; /* 128-bit number */
 852 } __attribute__((packed));
 853
 854 #define USB_DT_USB_SS_CONTN_ID_SIZE     20
 855 /*-------------------------------------------------------------------------*/
 856
 857 /* USB_DT_WIRELESS_ENDPOINT_COMP:  companion descriptor associated with
 858  * each endpoint descriptor for a wireless device
 859  */
 860 struct usb_wireless_ep_comp_descriptor {
 861         __u8  bLength;
 862         __u8  bDescriptorType;
 863
 864         __u8  bMaxBurst;
 865         __u8  bMaxSequence;
 866         __le16 wMaxStreamDelay;
 867         __le16 wOverTheAirPacketSize;
 868         __u8  bOverTheAirInterval;
 869         __u8  bmCompAttributes;
 870 #define USB_ENDPOINT_SWITCH_MASK        0x03    /* in bmCompAttributes */
 871 #define USB_ENDPOINT_SWITCH_NO          0
 872 #define USB_ENDPOINT_SWITCH_SWITCH      1
 873 #define USB_ENDPOINT_SWITCH_SCALE       2
 874 } __attribute__((packed));
 875
 876 /*-------------------------------------------------------------------------*/
 877
 878 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
 879  * host and a device for connection set up, mutual authentication, and
 880  * exchanging short lived session keys.  The handshake depends on a CC.
 881  */
 882 struct usb_handshake {
 883         __u8 bMessageNumber;
 884         __u8 bStatus;
 885         __u8 tTKID[3];
 886         __u8 bReserved;
 887         __u8 CDID[16];
 888         __u8 nonce[16];
 889         __u8 MIC[8];
 890 } __attribute__((packed));
 891
 892 /*-------------------------------------------------------------------------*/
 893
 894 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
 895  * A CC may also be set up using non-wireless secure channels (including
 896  * wired USB!), and some devices may support CCs with multiple hosts.
 897  */
 898 struct usb_connection_context {
 899         __u8 CHID[16];          /* persistent host id */
 900         __u8 CDID[16];          /* device id (unique w/in host context) */
 901         __u8 CK[16];            /* connection key */
 902 } __attribute__((packed));
 903
 904 /*-------------------------------------------------------------------------*/
 905
 906 /* USB 2.0 defines three speeds, here's how Linux identifies them */
 907
 908 enum usb_device_speed {
 909         USB_SPEED_UNKNOWN = 0,                  /* enumerating */
 910         USB_SPEED_LOW, USB_SPEED_FULL,          /* usb 1.1 */
 911         USB_SPEED_HIGH,                         /* usb 2.0 */
 912         USB_SPEED_WIRELESS,                     /* wireless (usb 2.5) */
 913         USB_SPEED_SUPER,                        /* usb 3.0 */
 914 };
 915
 916 #ifdef __KERNEL__
 917
 918 /**
 919  * usb_speed_string() - Returns human readable-name of the speed.
 920  * @speed: The speed to return human-readable name for.  If it's not
 921  *   any of the speeds defined in usb_device_speed enum, string for
 922  *   USB_SPEED_UNKNOWN will be returned.
 923  */
 924 extern const char *usb_speed_string(enum usb_device_speed speed);
 925
 926 #endif
 927
 928 enum usb_device_state {
 929         /* NOTATTACHED isn't in the USB spec, and this state acts
 930          * the same as ATTACHED ... but it's clearer this way.
 931          */
 932         USB_STATE_NOTATTACHED = 0,
 933
 934         /* chapter 9 and authentication (wireless) device states */
 935         USB_STATE_ATTACHED,
 936         USB_STATE_POWERED,                      /* wired */
 937         USB_STATE_RECONNECTING,                 /* auth */
 938         USB_STATE_UNAUTHENTICATED,              /* auth */
 939         USB_STATE_DEFAULT,                      /* limited function */
 940         USB_STATE_ADDRESS,
 941         USB_STATE_CONFIGURED,                   /* most functions */
 942
 943         USB_STATE_SUSPENDED
 944
 945         /* NOTE:  there are actually four different SUSPENDED
 946          * states, returning to POWERED, DEFAULT, ADDRESS, or
 947          * CONFIGURED respectively when SOF tokens flow again.
 948          * At this level there's no difference between L1 and L2
 949          * suspend states.  (L2 being original USB 1.1 suspend.)
 950          */
 951 };
 952
 953 /*-------------------------------------------------------------------------*/
 954
 955 /*
 956  * As per USB compliance update, a device that is actively drawing
 957  * more than 100mA from USB must report itself as bus-powered in
 958  * the GetStatus(DEVICE) call.
 959  * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
 960  */
 961 #define USB_SELF_POWER_VBUS_MAX_DRAW            100
 962
 963 #endif /* __LINUX_USB_CH9_H */