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 #include <asm/unaligned.h>      /* get_unaligned() */
  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 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
 110  * used by hubs to put ports into a new L1 suspend state, except that it
 111  * forgot to define its number ...
 112  */
 113
 114 /*
 115  * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
 116  * are read as a bit array returned by USB_REQ_GET_STATUS.  (So there
 117  * are at most sixteen features of each type.)  Hubs may also support a
 118  * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
 119  */
 120 #define USB_DEVICE_SELF_POWERED         0       /* (read only) */
 121 #define USB_DEVICE_REMOTE_WAKEUP        1       /* dev may initiate wakeup */
 122 #define USB_DEVICE_TEST_MODE            2       /* (wired high speed only) */
 123 #define USB_DEVICE_BATTERY              2       /* (wireless) */
 124 #define USB_DEVICE_B_HNP_ENABLE         3       /* (otg) dev may initiate HNP */
 125 #define USB_DEVICE_WUSB_DEVICE          3       /* (wireless)*/
 126 #define USB_DEVICE_A_HNP_SUPPORT        4       /* (otg) RH port supports HNP */
 127 #define USB_DEVICE_A_ALT_HNP_SUPPORT    5       /* (otg) other RH port does */
 128 #define USB_DEVICE_DEBUG_MODE           6       /* (special devices only) */
 129
 130 /*
 131  * Test Mode Selectors
 132  * See USB 2.0 spec Table 9-7
 133  */
 134 #define TEST_J          1
 135 #define TEST_K          2
 136 #define TEST_SE0_NAK    3
 137 #define TEST_PACKET     4
 138 #define TEST_FORCE_EN   5
 139
 140 /*
 141  * New Feature Selectors as added by USB 3.0
 142  * See USB 3.0 spec Table 9-6
 143  */
 144 #define USB_DEVICE_U1_ENABLE    48      /* dev may initiate U1 transition */
 145 #define USB_DEVICE_U2_ENABLE    49      /* dev may initiate U2 transition */
 146 #define USB_DEVICE_LTM_ENABLE   50      /* dev may send LTM */
 147 #define USB_INTRF_FUNC_SUSPEND  0       /* function suspend */
 148
 149 #define USB_INTR_FUNC_SUSPEND_OPT_MASK  0xFF00
 150 /*
 151  * Suspend Options, Table 9-7 USB 3.0 spec
 152  */
 153 #define USB_INTRF_FUNC_SUSPEND_LP       (1 << (8 + 0))
 154 #define USB_INTRF_FUNC_SUSPEND_RW       (1 << (8 + 1))
 155
 156 #define USB_ENDPOINT_HALT               0       /* IN/OUT will STALL */
 157
 158 /* Bit array elements as returned by the USB_REQ_GET_STATUS request. */
 159 #define USB_DEV_STAT_U1_ENABLED         2       /* transition into U1 state */
 160 #define USB_DEV_STAT_U2_ENABLED         3       /* transition into U2 state */
 161 #define USB_DEV_STAT_LTM_ENABLED        4       /* Latency tolerance messages */
 162
 163 /**
 164  * struct usb_ctrlrequest - SETUP data for a USB device control request
 165  * @bRequestType: matches the USB bmRequestType field
 166  * @bRequest: matches the USB bRequest field
 167  * @wValue: matches the USB wValue field (le16 byte order)
 168  * @wIndex: matches the USB wIndex field (le16 byte order)
 169  * @wLength: matches the USB wLength field (le16 byte order)
 170  *
 171  * This structure is used to send control requests to a USB device.  It matches
 172  * the different fields of the USB 2.0 Spec section 9.3, table 9-2.  See the
 173  * USB spec for a fuller description of the different fields, and what they are
 174  * used for.
 175  *
 176  * Note that the driver for any interface can issue control requests.
 177  * For most devices, interfaces don't coordinate with each other, so
 178  * such requests may be made at any time.
 179  */
 180 struct usb_ctrlrequest {
 181         __u8 bRequestType;
 182         __u8 bRequest;
 183         __le16 wValue;
 184         __le16 wIndex;
 185         __le16 wLength;
 186 } __attribute__ ((packed));
 187
 188 /*-------------------------------------------------------------------------*/
 189
 190 /*
 191  * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
 192  * (rarely) accepted by SET_DESCRIPTOR.
 193  *
 194  * Note that all multi-byte values here are encoded in little endian
 195  * byte order "on the wire".  Within the kernel and when exposed
 196  * through the Linux-USB APIs, they are not converted to cpu byte
 197  * order; it is the responsibility of the client code to do this.
 198  * The single exception is when device and configuration descriptors (but
 199  * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD);
 200  * in this case the fields are converted to host endianness by the kernel.
 201  */
 202
 203 /*
 204  * Descriptor types ... USB 2.0 spec table 9.5
 205  */
 206 #define USB_DT_DEVICE                   0x01
 207 #define USB_DT_CONFIG                   0x02
 208 #define USB_DT_STRING                   0x03
 209 #define USB_DT_INTERFACE                0x04
 210 #define USB_DT_ENDPOINT                 0x05
 211 #define USB_DT_DEVICE_QUALIFIER         0x06
 212 #define USB_DT_OTHER_SPEED_CONFIG       0x07
 213 #define USB_DT_INTERFACE_POWER          0x08
 214 /* these are from a minor usb 2.0 revision (ECN) */
 215 #define USB_DT_OTG                      0x09
 216 #define USB_DT_DEBUG                    0x0a
 217 #define USB_DT_INTERFACE_ASSOCIATION    0x0b
 218 /* these are from the Wireless USB spec */
 219 #define USB_DT_SECURITY                 0x0c
 220 #define USB_DT_KEY                      0x0d
 221 #define USB_DT_ENCRYPTION_TYPE          0x0e
 222 #define USB_DT_BOS                      0x0f
 223 #define USB_DT_DEVICE_CAPABILITY        0x10
 224 #define USB_DT_WIRELESS_ENDPOINT_COMP   0x11
 225 #define USB_DT_WIRE_ADAPTER             0x21
 226 #define USB_DT_RPIPE                    0x22
 227 #define USB_DT_CS_RADIO_CONTROL         0x23
 228 /* From the T10 UAS specification */
 229 #define USB_DT_PIPE_USAGE               0x24
 230 /* From the USB 3.0 spec */
 231 #define USB_DT_SS_ENDPOINT_COMP         0x30
 232
 233 /* Conventional codes for class-specific descriptors.  The convention is
 234  * defined in the USB "Common Class" Spec (3.11).  Individual class specs
 235  * are authoritative for their usage, not the "common class" writeup.
 236  */
 237 #define USB_DT_CS_DEVICE                (USB_TYPE_CLASS | USB_DT_DEVICE)
 238 #define USB_DT_CS_CONFIG                (USB_TYPE_CLASS | USB_DT_CONFIG)
 239 #define USB_DT_CS_STRING                (USB_TYPE_CLASS | USB_DT_STRING)
 240 #define USB_DT_CS_INTERFACE             (USB_TYPE_CLASS | USB_DT_INTERFACE)
 241 #define USB_DT_CS_ENDPOINT              (USB_TYPE_CLASS | USB_DT_ENDPOINT)
 242
 243 /* All standard descriptors have these 2 fields at the beginning */
 244 struct usb_descriptor_header {
 245         __u8  bLength;
 246         __u8  bDescriptorType;
 247 } __attribute__ ((packed));
 248
 249
 250 /*-------------------------------------------------------------------------*/
 251
 252 /* USB_DT_DEVICE: Device descriptor */
 253 struct usb_device_descriptor {
 254         __u8  bLength;
 255         __u8  bDescriptorType;
 256
 257         __le16 bcdUSB;
 258         __u8  bDeviceClass;
 259         __u8  bDeviceSubClass;
 260         __u8  bDeviceProtocol;
 261         __u8  bMaxPacketSize0;
 262         __le16 idVendor;
 263         __le16 idProduct;
 264         __le16 bcdDevice;
 265         __u8  iManufacturer;
 266         __u8  iProduct;
 267         __u8  iSerialNumber;
 268         __u8  bNumConfigurations;
 269 } __attribute__ ((packed));
 270
 271 #define USB_DT_DEVICE_SIZE              18
 272
 273
 274 /*
 275  * Device and/or Interface Class codes
 276  * as found in bDeviceClass or bInterfaceClass
 277  * and defined by www.usb.org documents
 278  */
 279 #define USB_CLASS_PER_INTERFACE         0       /* for DeviceClass */
 280 #define USB_CLASS_AUDIO                 1
 281 #define USB_CLASS_COMM                  2
 282 #define USB_CLASS_HID                   3
 283 #define USB_CLASS_PHYSICAL              5
 284 #define USB_CLASS_STILL_IMAGE           6
 285 #define USB_CLASS_PRINTER               7
 286 #define USB_CLASS_MASS_STORAGE          8
 287 #define USB_CLASS_HUB                   9
 288 #define USB_CLASS_CDC_DATA              0x0a
 289 #define USB_CLASS_CSCID                 0x0b    /* chip+ smart card */
 290 #define USB_CLASS_CONTENT_SEC           0x0d    /* content security */
 291 #define USB_CLASS_VIDEO                 0x0e
 292 #define USB_CLASS_WIRELESS_CONTROLLER   0xe0
 293 #define USB_CLASS_MISC                  0xef
 294 #define USB_CLASS_APP_SPEC              0xfe
 295 #define USB_CLASS_VENDOR_SPEC           0xff
 296
 297 #define USB_SUBCLASS_VENDOR_SPEC        0xff
 298
 299 /*-------------------------------------------------------------------------*/
 300
 301 /* USB_DT_CONFIG: Configuration descriptor information.
 302  *
 303  * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
 304  * descriptor type is different.  Highspeed-capable devices can look
 305  * different depending on what speed they're currently running.  Only
 306  * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
 307  * descriptors.
 308  */
 309 struct usb_config_descriptor {
 310         __u8  bLength;
 311         __u8  bDescriptorType;
 312
 313         __le16 wTotalLength;
 314         __u8  bNumInterfaces;
 315         __u8  bConfigurationValue;
 316         __u8  iConfiguration;
 317         __u8  bmAttributes;
 318         __u8  bMaxPower;
 319 } __attribute__ ((packed));
 320
 321 #define USB_DT_CONFIG_SIZE              9
 322
 323 /* from config descriptor bmAttributes */
 324 #define USB_CONFIG_ATT_ONE              (1 << 7)        /* must be set */
 325 #define USB_CONFIG_ATT_SELFPOWER        (1 << 6)        /* self powered */
 326 #define USB_CONFIG_ATT_WAKEUP           (1 << 5)        /* can wakeup */
 327 #define USB_CONFIG_ATT_BATTERY          (1 << 4)        /* battery powered */
 328
 329 /*-------------------------------------------------------------------------*/
 330
 331 /* USB_DT_STRING: String descriptor */
 332 struct usb_string_descriptor {
 333         __u8  bLength;
 334         __u8  bDescriptorType;
 335
 336         __le16 wData[1];                /* UTF-16LE encoded */
 337 } __attribute__ ((packed));
 338
 339 /* note that "string" zero is special, it holds language codes that
 340  * the device supports, not Unicode characters.
 341  */
 342
 343 /*-------------------------------------------------------------------------*/
 344
 345 /* USB_DT_INTERFACE: Interface descriptor */
 346 struct usb_interface_descriptor {
 347         __u8  bLength;
 348         __u8  bDescriptorType;
 349
 350         __u8  bInterfaceNumber;
 351         __u8  bAlternateSetting;
 352         __u8  bNumEndpoints;
 353         __u8  bInterfaceClass;
 354         __u8  bInterfaceSubClass;
 355         __u8  bInterfaceProtocol;
 356         __u8  iInterface;
 357 } __attribute__ ((packed));
 358
 359 #define USB_DT_INTERFACE_SIZE           9
 360
 361 /*-------------------------------------------------------------------------*/
 362
 363 /* USB_DT_ENDPOINT: Endpoint descriptor */
 364 struct usb_endpoint_descriptor {
 365         __u8  bLength;
 366         __u8  bDescriptorType;
 367
 368         __u8  bEndpointAddress;
 369         __u8  bmAttributes;
 370         __le16 wMaxPacketSize;
 371         __u8  bInterval;
 372
 373         /* NOTE:  these two are _only_ in audio endpoints. */
 374         /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
 375         __u8  bRefresh;
 376         __u8  bSynchAddress;
 377 } __attribute__ ((packed));
 378
 379 #define USB_DT_ENDPOINT_SIZE            7
 380 #define USB_DT_ENDPOINT_AUDIO_SIZE      9       /* Audio extension */
 381
 382 /* Used to access common fields */
 383 struct usb_generic_descriptor {
 384         __u8  bLength;
 385         __u8  bDescriptorType;
 386 };
 387
 388 /*
 389  * Endpoints
 390  */
 391 #define USB_ENDPOINT_NUMBER_MASK        0x0f    /* in bEndpointAddress */
 392 #define USB_ENDPOINT_DIR_MASK           0x80
 393
 394 #define USB_ENDPOINT_XFERTYPE_MASK      0x03    /* in bmAttributes */
 395 #define USB_ENDPOINT_XFER_CONTROL       0
 396 #define USB_ENDPOINT_XFER_ISOC          1
 397 #define USB_ENDPOINT_XFER_BULK          2
 398 #define USB_ENDPOINT_XFER_INT           3
 399 #define USB_ENDPOINT_MAX_ADJUSTABLE     0x80
 400
 401 /* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */
 402 #define USB_ENDPOINT_INTRTYPE           0x30
 403 #define USB_ENDPOINT_INTR_PERIODIC      (0 << 4)
 404 #define USB_ENDPOINT_INTR_NOTIFICATION  (1 << 4)
 405
 406 #define USB_ENDPOINT_SYNCTYPE           0x0c
 407 #define USB_ENDPOINT_SYNC_NONE          (0 << 2)
 408 #define USB_ENDPOINT_SYNC_ASYNC         (1 << 2)
 409 #define USB_ENDPOINT_SYNC_ADAPTIVE      (2 << 2)
 410 #define USB_ENDPOINT_SYNC_SYNC          (3 << 2)
 411
 412 #define USB_ENDPOINT_USAGE_MASK         0x30
 413 #define USB_ENDPOINT_USAGE_DATA         0x00
 414 #define USB_ENDPOINT_USAGE_FEEDBACK     0x10
 415 #define USB_ENDPOINT_USAGE_IMPLICIT_FB  0x20    /* Implicit feedback Data endpoint */
 416
 417 /*-------------------------------------------------------------------------*/
 418
 419 /**
 420  * usb_endpoint_num - get the endpoint's number
 421  * @epd: endpoint to be checked
 422  *
 423  * Returns @epd's number: 0 to 15.
 424  */
 425 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
 426 {
 427         return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
 428 }
 429
 430 /**
 431  * usb_endpoint_type - get the endpoint's transfer type
 432  * @epd: endpoint to be checked
 433  *
 434  * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
 435  * to @epd's transfer type.
 436  */
 437 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
 438 {
 439         return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
 440 }
 441
 442 /**
 443  * usb_endpoint_dir_in - check if the endpoint has IN direction
 444  * @epd: endpoint to be checked
 445  *
 446  * Returns true if the endpoint is of type IN, otherwise it returns false.
 447  */
 448 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
 449 {
 450         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
 451 }
 452
 453 /**
 454  * usb_endpoint_dir_out - check if the endpoint has OUT direction
 455  * @epd: endpoint to be checked
 456  *
 457  * Returns true if the endpoint is of type OUT, otherwise it returns false.
 458  */
 459 static inline int usb_endpoint_dir_out(
 460                                 const struct usb_endpoint_descriptor *epd)
 461 {
 462         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
 463 }
 464
 465 /**
 466  * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
 467  * @epd: endpoint to be checked
 468  *
 469  * Returns true if the endpoint is of type bulk, otherwise it returns false.
 470  */
 471 static inline int usb_endpoint_xfer_bulk(
 472                                 const struct usb_endpoint_descriptor *epd)
 473 {
 474         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 475                 USB_ENDPOINT_XFER_BULK);
 476 }
 477
 478 /**
 479  * usb_endpoint_xfer_control - check if the endpoint has control transfer type
 480  * @epd: endpoint to be checked
 481  *
 482  * Returns true if the endpoint is of type control, otherwise it returns false.
 483  */
 484 static inline int usb_endpoint_xfer_control(
 485                                 const struct usb_endpoint_descriptor *epd)
 486 {
 487         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 488                 USB_ENDPOINT_XFER_CONTROL);
 489 }
 490
 491 /**
 492  * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
 493  * @epd: endpoint to be checked
 494  *
 495  * Returns true if the endpoint is of type interrupt, otherwise it returns
 496  * false.
 497  */
 498 static inline int usb_endpoint_xfer_int(
 499                                 const struct usb_endpoint_descriptor *epd)
 500 {
 501         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 502                 USB_ENDPOINT_XFER_INT);
 503 }
 504
 505 /**
 506  * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
 507  * @epd: endpoint to be checked
 508  *
 509  * Returns true if the endpoint is of type isochronous, otherwise it returns
 510  * false.
 511  */
 512 static inline int usb_endpoint_xfer_isoc(
 513                                 const struct usb_endpoint_descriptor *epd)
 514 {
 515         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 516                 USB_ENDPOINT_XFER_ISOC);
 517 }
 518
 519 /**
 520  * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
 521  * @epd: endpoint to be checked
 522  *
 523  * Returns true if the endpoint has bulk transfer type and IN direction,
 524  * otherwise it returns false.
 525  */
 526 static inline int usb_endpoint_is_bulk_in(
 527                                 const struct usb_endpoint_descriptor *epd)
 528 {
 529         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
 530 }
 531
 532 /**
 533  * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
 534  * @epd: endpoint to be checked
 535  *
 536  * Returns true if the endpoint has bulk transfer type and OUT direction,
 537  * otherwise it returns false.
 538  */
 539 static inline int usb_endpoint_is_bulk_out(
 540                                 const struct usb_endpoint_descriptor *epd)
 541 {
 542         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
 543 }
 544
 545 /**
 546  * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
 547  * @epd: endpoint to be checked
 548  *
 549  * Returns true if the endpoint has interrupt transfer type and IN direction,
 550  * otherwise it returns false.
 551  */
 552 static inline int usb_endpoint_is_int_in(
 553                                 const struct usb_endpoint_descriptor *epd)
 554 {
 555         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
 556 }
 557
 558 /**
 559  * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
 560  * @epd: endpoint to be checked
 561  *
 562  * Returns true if the endpoint has interrupt transfer type and OUT direction,
 563  * otherwise it returns false.
 564  */
 565 static inline int usb_endpoint_is_int_out(
 566                                 const struct usb_endpoint_descriptor *epd)
 567 {
 568         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
 569 }
 570
 571 /**
 572  * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
 573  * @epd: endpoint to be checked
 574  *
 575  * Returns true if the endpoint has isochronous transfer type and IN direction,
 576  * otherwise it returns false.
 577  */
 578 static inline int usb_endpoint_is_isoc_in(
 579                                 const struct usb_endpoint_descriptor *epd)
 580 {
 581         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
 582 }
 583
 584 /**
 585  * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
 586  * @epd: endpoint to be checked
 587  *
 588  * Returns true if the endpoint has isochronous transfer type and OUT direction,
 589  * otherwise it returns false.
 590  */
 591 static inline int usb_endpoint_is_isoc_out(
 592                                 const struct usb_endpoint_descriptor *epd)
 593 {
 594         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
 595 }
 596
 597 /**
 598  * usb_endpoint_maxp - get endpoint's max packet size
 599  * @epd: endpoint to be checked
 600  *
 601  * Returns @epd's max packet
 602  */
 603 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
 604 {
 605         return __le16_to_cpu(get_unaligned(&epd->wMaxPacketSize));
 606 }
 607
 608 static inline int usb_endpoint_interrupt_type(
 609                 const struct usb_endpoint_descriptor *epd)
 610 {
 611         return epd->bmAttributes & USB_ENDPOINT_INTRTYPE;
 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
 709 /*-------------------------------------------------------------------------*/
 710
 711 /* USB_DT_SECURITY:  group of wireless security descriptors, including
 712  * encryption types available for setting up a CC/association.
 713  */
 714 struct usb_security_descriptor {
 715         __u8  bLength;
 716         __u8  bDescriptorType;
 717
 718         __le16 wTotalLength;
 719         __u8  bNumEncryptionTypes;
 720 } __attribute__((packed));
 721
 722 /*-------------------------------------------------------------------------*/
 723
 724 /* USB_DT_KEY:  used with {GET,SET}_SECURITY_DATA; only public keys
 725  * may be retrieved.
 726  */
 727 struct usb_key_descriptor {
 728         __u8  bLength;
 729         __u8  bDescriptorType;
 730
 731         __u8  tTKID[3];
 732         __u8  bReserved;
 733         __u8  bKeyData[0];
 734 } __attribute__((packed));
 735
 736 /*-------------------------------------------------------------------------*/
 737
 738 /* USB_DT_ENCRYPTION_TYPE:  bundled in DT_SECURITY groups */
 739 struct usb_encryption_descriptor {
 740         __u8  bLength;
 741         __u8  bDescriptorType;
 742
 743         __u8  bEncryptionType;
 744 #define USB_ENC_TYPE_UNSECURE           0
 745 #define USB_ENC_TYPE_WIRED              1       /* non-wireless mode */
 746 #define USB_ENC_TYPE_CCM_1              2       /* aes128/cbc session */
 747 #define USB_ENC_TYPE_RSA_1              3       /* rsa3072/sha1 auth */
 748         __u8  bEncryptionValue;         /* use in SET_ENCRYPTION */
 749         __u8  bAuthKeyIndex;
 750 } __attribute__((packed));
 751
 752
 753 /*-------------------------------------------------------------------------*/
 754
 755 /* USB_DT_BOS:  group of device-level capabilities */
 756 struct usb_bos_descriptor {
 757         __u8  bLength;
 758         __u8  bDescriptorType;
 759
 760         __le16 wTotalLength;
 761         __u8  bNumDeviceCaps;
 762 } __attribute__((packed));
 763
 764 #define USB_DT_BOS_SIZE         5
 765 /*-------------------------------------------------------------------------*/
 766
 767 /* USB_DT_DEVICE_CAPABILITY:  grouped with BOS */
 768 struct usb_dev_cap_header {
 769         __u8  bLength;
 770         __u8  bDescriptorType;
 771         __u8  bDevCapabilityType;
 772 } __attribute__((packed));
 773
 774 #define USB_CAP_TYPE_WIRELESS_USB       1
 775
 776 struct usb_wireless_cap_descriptor {    /* Ultra Wide Band */
 777         __u8  bLength;
 778         __u8  bDescriptorType;
 779         __u8  bDevCapabilityType;
 780
 781         __u8  bmAttributes;
 782 #define USB_WIRELESS_P2P_DRD            (1 << 1)
 783 #define USB_WIRELESS_BEACON_MASK        (3 << 2)
 784 #define USB_WIRELESS_BEACON_SELF        (1 << 2)
 785 #define USB_WIRELESS_BEACON_DIRECTED    (2 << 2)
 786 #define USB_WIRELESS_BEACON_NONE        (3 << 2)
 787         __le16 wPHYRates;       /* bit rates, Mbps */
 788 #define USB_WIRELESS_PHY_53             (1 << 0)        /* always set */
 789 #define USB_WIRELESS_PHY_80             (1 << 1)
 790 #define USB_WIRELESS_PHY_107            (1 << 2)        /* always set */
 791 #define USB_WIRELESS_PHY_160            (1 << 3)
 792 #define USB_WIRELESS_PHY_200            (1 << 4)        /* always set */
 793 #define USB_WIRELESS_PHY_320            (1 << 5)
 794 #define USB_WIRELESS_PHY_400            (1 << 6)
 795 #define USB_WIRELESS_PHY_480            (1 << 7)
 796         __u8  bmTFITXPowerInfo; /* TFI power levels */
 797         __u8  bmFFITXPowerInfo; /* FFI power levels */
 798         __le16 bmBandGroup;
 799         __u8  bReserved;
 800 } __attribute__((packed));
 801
 802 /* USB 2.0 Extension descriptor */
 803 #define USB_CAP_TYPE_EXT                2
 804
 805 struct usb_ext_cap_descriptor {         /* Link Power Management */
 806         __u8  bLength;
 807         __u8  bDescriptorType;
 808         __u8  bDevCapabilityType;
 809         __le32 bmAttributes;
 810 #define USB_LPM_SUPPORT                 (1 << 1)        /* supports LPM */
 811 #define USB_BESL_SUPPORT                (1 << 2)        /* supports BESL */
 812 #define USB_BESL_BASELINE_VALID         (1 << 3)        /* Baseline BESL valid*/
 813 #define USB_BESL_DEEP_VALID             (1 << 4)        /* Deep BESL valid */
 814 #define USB_GET_BESL_BASELINE(p)        (((p) & (0xf << 8)) >> 8)
 815 #define USB_GET_BESL_DEEP(p)            (((p) & (0xf << 12)) >> 12)
 816 } __attribute__((packed));
 817
 818 #define USB_DT_USB_EXT_CAP_SIZE 7
 819
 820 /*
 821  * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
 822  * specific device level capabilities
 823  */
 824 #define         USB_SS_CAP_TYPE         3
 825 struct usb_ss_cap_descriptor {          /* Link Power Management */
 826         __u8  bLength;
 827         __u8  bDescriptorType;
 828         __u8  bDevCapabilityType;
 829         __u8  bmAttributes;
 830 #define USB_LTM_SUPPORT                 (1 << 1) /* supports LTM */
 831         __le16 wSpeedSupported;
 832 #define USB_LOW_SPEED_OPERATION         (1)      /* Low speed operation */
 833 #define USB_FULL_SPEED_OPERATION        (1 << 1) /* Full speed operation */
 834 #define USB_HIGH_SPEED_OPERATION        (1 << 2) /* High speed operation */
 835 #define USB_5GBPS_OPERATION             (1 << 3) /* Operation at 5Gbps */
 836         __u8  bFunctionalitySupport;
 837         __u8  bU1devExitLat;
 838         __le16 bU2DevExitLat;
 839 } __attribute__((packed));
 840
 841 #define USB_DT_USB_SS_CAP_SIZE  10
 842
 843 /*
 844  * Container ID Capability descriptor: Defines the instance unique ID used to
 845  * identify the instance across all operating modes
 846  */
 847 #define CONTAINER_ID_TYPE       4
 848 struct usb_ss_container_id_descriptor {
 849         __u8  bLength;
 850         __u8  bDescriptorType;
 851         __u8  bDevCapabilityType;
 852         __u8  bReserved;
 853         __u8  ContainerID[16]; /* 128-bit number */
 854 } __attribute__((packed));
 855
 856 #define USB_DT_USB_SS_CONTN_ID_SIZE     20
 857 /*-------------------------------------------------------------------------*/
 858
 859 /* USB_DT_WIRELESS_ENDPOINT_COMP:  companion descriptor associated with
 860  * each endpoint descriptor for a wireless device
 861  */
 862 struct usb_wireless_ep_comp_descriptor {
 863         __u8  bLength;
 864         __u8  bDescriptorType;
 865
 866         __u8  bMaxBurst;
 867         __u8  bMaxSequence;
 868         __le16 wMaxStreamDelay;
 869         __le16 wOverTheAirPacketSize;
 870         __u8  bOverTheAirInterval;
 871         __u8  bmCompAttributes;
 872 #define USB_ENDPOINT_SWITCH_MASK        0x03    /* in bmCompAttributes */
 873 #define USB_ENDPOINT_SWITCH_NO          0
 874 #define USB_ENDPOINT_SWITCH_SWITCH      1
 875 #define USB_ENDPOINT_SWITCH_SCALE       2
 876 } __attribute__((packed));
 877
 878 /*-------------------------------------------------------------------------*/
 879
 880 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
 881  * host and a device for connection set up, mutual authentication, and
 882  * exchanging short lived session keys.  The handshake depends on a CC.
 883  */
 884 struct usb_handshake {
 885         __u8 bMessageNumber;
 886         __u8 bStatus;
 887         __u8 tTKID[3];
 888         __u8 bReserved;
 889         __u8 CDID[16];
 890         __u8 nonce[16];
 891         __u8 MIC[8];
 892 } __attribute__((packed));
 893
 894 /*-------------------------------------------------------------------------*/
 895
 896 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
 897  * A CC may also be set up using non-wireless secure channels (including
 898  * wired USB!), and some devices may support CCs with multiple hosts.
 899  */
 900 struct usb_connection_context {
 901         __u8 CHID[16];          /* persistent host id */
 902         __u8 CDID[16];          /* device id (unique w/in host context) */
 903         __u8 CK[16];            /* connection key */
 904 } __attribute__((packed));
 905
 906 /*-------------------------------------------------------------------------*/
 907
 908 /* USB 2.0 defines three speeds, here's how Linux identifies them */
 909
 910 enum usb_device_speed {
 911         USB_SPEED_UNKNOWN = 0,                  /* enumerating */
 912         USB_SPEED_LOW, USB_SPEED_FULL,          /* usb 1.1 */
 913         USB_SPEED_HIGH,                         /* usb 2.0 */
 914         USB_SPEED_WIRELESS,                     /* wireless (usb 2.5) */
 915         USB_SPEED_SUPER,                        /* usb 3.0 */
 916 };
 917
 918 #ifdef __KERNEL__
 919
 920 /**
 921  * usb_speed_string() - Returns human readable-name of the speed.
 922  * @speed: The speed to return human-readable name for.  If it's not
 923  *   any of the speeds defined in usb_device_speed enum, string for
 924  *   USB_SPEED_UNKNOWN will be returned.
 925  */
 926 extern const char *usb_speed_string(enum usb_device_speed speed);
 927
 928 #endif
 929
 930 enum usb_device_state {
 931         /* NOTATTACHED isn't in the USB spec, and this state acts
 932          * the same as ATTACHED ... but it's clearer this way.
 933          */
 934         USB_STATE_NOTATTACHED = 0,
 935
 936         /* chapter 9 and authentication (wireless) device states */
 937         USB_STATE_ATTACHED,
 938         USB_STATE_POWERED,                      /* wired */
 939         USB_STATE_RECONNECTING,                 /* auth */
 940         USB_STATE_UNAUTHENTICATED,              /* auth */
 941         USB_STATE_DEFAULT,                      /* limited function */
 942         USB_STATE_ADDRESS,
 943         USB_STATE_CONFIGURED,                   /* most functions */
 944
 945         USB_STATE_SUSPENDED
 946
 947         /* NOTE:  there are actually four different SUSPENDED
 948          * states, returning to POWERED, DEFAULT, ADDRESS, or
 949          * CONFIGURED respectively when SOF tokens flow again.
 950          * At this level there's no difference between L1 and L2
 951          * suspend states.  (L2 being original USB 1.1 suspend.)
 952          */
 953 };
 954
 955 enum usb3_link_state {
 956         USB3_LPM_U0 = 0,
 957         USB3_LPM_U1,
 958         USB3_LPM_U2,
 959         USB3_LPM_U3
 960 };
 961
 962 /*
 963  * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1.
 964  * 0xff means the parent hub will accept transitions to U1, but will not
 965  * initiate a transition.
 966  *
 967  * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to
 968  * U1 after that many microseconds.  Timeouts of 0x80 to 0xFE are reserved
 969  * values.
 970  *
 971  * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2.
 972  * 0xff means the parent hub will accept transitions to U2, but will not
 973  * initiate a transition.
 974  *
 975  * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to
 976  * U2 after N*256 microseconds.  Therefore a U2 timeout value of 0x1 means a U2
 977  * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means
 978  * 65.024ms.
 979  */
 980 #define USB3_LPM_DISABLED               0x0
 981 #define USB3_LPM_U1_MAX_TIMEOUT         0x7F
 982 #define USB3_LPM_U2_MAX_TIMEOUT         0xFE
 983 #define USB3_LPM_DEVICE_INITIATED       0xFF
 984
 985 struct usb_set_sel_req {
 986         __u8    u1_sel;
 987         __u8    u1_pel;
 988         __le16  u2_sel;
 989         __le16  u2_pel;
 990 } __attribute__ ((packed));
 991
 992 /*
 993  * The Set System Exit Latency control transfer provides one byte each for
 994  * U1 SEL and U1 PEL, so the max exit latency is 0xFF.  U2 SEL and U2 PEL each
 995  * are two bytes long.
 996  */
 997 #define USB3_LPM_MAX_U1_SEL_PEL         0xFF
 998 #define USB3_LPM_MAX_U2_SEL_PEL         0xFFFF
 999
1000 /*-------------------------------------------------------------------------*/
1001
1002 /*
1003  * As per USB compliance update, a device that is actively drawing
1004  * more than 100mA from USB must report itself as bus-powered in
1005  * the GetStatus(DEVICE) call.
1006  * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
1007  */
1008 #define USB_SELF_POWER_VBUS_MAX_DRAW            100
1009
1010 /**
1011  * struct usb_string - wraps a C string and its USB id
1012  * @id:the (nonzero) ID for this string
1013  * @s:the string, in UTF-8 encoding
1014  *
1015  * If you're using usb_gadget_get_string(), use this to wrap a string
1016  * together with its ID.
1017  */
1018 struct usb_string {
1019         u8 id;
1020         const char *s;
1021 };
1022
1023 #endif /* __LINUX_USB_CH9_H */