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
 383 /*
 384  * Endpoints
 385  */
 386 #define USB_ENDPOINT_NUMBER_MASK        0x0f    /* in bEndpointAddress */
 387 #define USB_ENDPOINT_DIR_MASK           0x80
 388
 389 #define USB_ENDPOINT_XFERTYPE_MASK      0x03    /* in bmAttributes */
 390 #define USB_ENDPOINT_XFER_CONTROL       0
 391 #define USB_ENDPOINT_XFER_ISOC          1
 392 #define USB_ENDPOINT_XFER_BULK          2
 393 #define USB_ENDPOINT_XFER_INT           3
 394 #define USB_ENDPOINT_MAX_ADJUSTABLE     0x80
 395
 396 /* The USB 3.0 spec redefines bits 5:4 of bmAttributes as interrupt ep type. */
 397 #define USB_ENDPOINT_INTRTYPE           0x30
 398 #define USB_ENDPOINT_INTR_PERIODIC      (0 << 4)
 399 #define USB_ENDPOINT_INTR_NOTIFICATION  (1 << 4)
 400
 401 #define USB_ENDPOINT_SYNCTYPE           0x0c
 402 #define USB_ENDPOINT_SYNC_NONE          (0 << 2)
 403 #define USB_ENDPOINT_SYNC_ASYNC         (1 << 2)
 404 #define USB_ENDPOINT_SYNC_ADAPTIVE      (2 << 2)
 405 #define USB_ENDPOINT_SYNC_SYNC          (3 << 2)
 406
 407 #define USB_ENDPOINT_USAGE_MASK         0x30
 408 #define USB_ENDPOINT_USAGE_DATA         0x00
 409 #define USB_ENDPOINT_USAGE_FEEDBACK     0x10
 410 #define USB_ENDPOINT_USAGE_IMPLICIT_FB  0x20    /* Implicit feedback Data endpoint */
 411
 412 /*-------------------------------------------------------------------------*/
 413
 414 /**
 415  * usb_endpoint_num - get the endpoint's number
 416  * @epd: endpoint to be checked
 417  *
 418  * Returns @epd's number: 0 to 15.
 419  */
 420 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
 421 {
 422         return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
 423 }
 424
 425 /**
 426  * usb_endpoint_type - get the endpoint's transfer type
 427  * @epd: endpoint to be checked
 428  *
 429  * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
 430  * to @epd's transfer type.
 431  */
 432 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
 433 {
 434         return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
 435 }
 436
 437 /**
 438  * usb_endpoint_dir_in - check if the endpoint has IN direction
 439  * @epd: endpoint to be checked
 440  *
 441  * Returns true if the endpoint is of type IN, otherwise it returns false.
 442  */
 443 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
 444 {
 445         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
 446 }
 447
 448 /**
 449  * usb_endpoint_dir_out - check if the endpoint has OUT direction
 450  * @epd: endpoint to be checked
 451  *
 452  * Returns true if the endpoint is of type OUT, otherwise it returns false.
 453  */
 454 static inline int usb_endpoint_dir_out(
 455                                 const struct usb_endpoint_descriptor *epd)
 456 {
 457         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
 458 }
 459
 460 /**
 461  * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
 462  * @epd: endpoint to be checked
 463  *
 464  * Returns true if the endpoint is of type bulk, otherwise it returns false.
 465  */
 466 static inline int usb_endpoint_xfer_bulk(
 467                                 const struct usb_endpoint_descriptor *epd)
 468 {
 469         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 470                 USB_ENDPOINT_XFER_BULK);
 471 }
 472
 473 /**
 474  * usb_endpoint_xfer_control - check if the endpoint has control transfer type
 475  * @epd: endpoint to be checked
 476  *
 477  * Returns true if the endpoint is of type control, otherwise it returns false.
 478  */
 479 static inline int usb_endpoint_xfer_control(
 480                                 const struct usb_endpoint_descriptor *epd)
 481 {
 482         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 483                 USB_ENDPOINT_XFER_CONTROL);
 484 }
 485
 486 /**
 487  * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
 488  * @epd: endpoint to be checked
 489  *
 490  * Returns true if the endpoint is of type interrupt, otherwise it returns
 491  * false.
 492  */
 493 static inline int usb_endpoint_xfer_int(
 494                                 const struct usb_endpoint_descriptor *epd)
 495 {
 496         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 497                 USB_ENDPOINT_XFER_INT);
 498 }
 499
 500 /**
 501  * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
 502  * @epd: endpoint to be checked
 503  *
 504  * Returns true if the endpoint is of type isochronous, otherwise it returns
 505  * false.
 506  */
 507 static inline int usb_endpoint_xfer_isoc(
 508                                 const struct usb_endpoint_descriptor *epd)
 509 {
 510         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 511                 USB_ENDPOINT_XFER_ISOC);
 512 }
 513
 514 /**
 515  * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
 516  * @epd: endpoint to be checked
 517  *
 518  * Returns true if the endpoint has bulk transfer type and IN direction,
 519  * otherwise it returns false.
 520  */
 521 static inline int usb_endpoint_is_bulk_in(
 522                                 const struct usb_endpoint_descriptor *epd)
 523 {
 524         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
 525 }
 526
 527 /**
 528  * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
 529  * @epd: endpoint to be checked
 530  *
 531  * Returns true if the endpoint has bulk transfer type and OUT direction,
 532  * otherwise it returns false.
 533  */
 534 static inline int usb_endpoint_is_bulk_out(
 535                                 const struct usb_endpoint_descriptor *epd)
 536 {
 537         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
 538 }
 539
 540 /**
 541  * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
 542  * @epd: endpoint to be checked
 543  *
 544  * Returns true if the endpoint has interrupt transfer type and IN direction,
 545  * otherwise it returns false.
 546  */
 547 static inline int usb_endpoint_is_int_in(
 548                                 const struct usb_endpoint_descriptor *epd)
 549 {
 550         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
 551 }
 552
 553 /**
 554  * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
 555  * @epd: endpoint to be checked
 556  *
 557  * Returns true if the endpoint has interrupt transfer type and OUT direction,
 558  * otherwise it returns false.
 559  */
 560 static inline int usb_endpoint_is_int_out(
 561                                 const struct usb_endpoint_descriptor *epd)
 562 {
 563         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
 564 }
 565
 566 /**
 567  * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
 568  * @epd: endpoint to be checked
 569  *
 570  * Returns true if the endpoint has isochronous transfer type and IN direction,
 571  * otherwise it returns false.
 572  */
 573 static inline int usb_endpoint_is_isoc_in(
 574                                 const struct usb_endpoint_descriptor *epd)
 575 {
 576         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
 577 }
 578
 579 /**
 580  * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
 581  * @epd: endpoint to be checked
 582  *
 583  * Returns true if the endpoint has isochronous transfer type and OUT direction,
 584  * otherwise it returns false.
 585  */
 586 static inline int usb_endpoint_is_isoc_out(
 587                                 const struct usb_endpoint_descriptor *epd)
 588 {
 589         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
 590 }
 591
 592 /**
 593  * usb_endpoint_maxp - get endpoint's max packet size
 594  * @epd: endpoint to be checked
 595  *
 596  * Returns @epd's max packet
 597  */
 598 static inline int usb_endpoint_maxp(const struct usb_endpoint_descriptor *epd)
 599 {
 600         return __le16_to_cpu(get_unaligned(&epd->wMaxPacketSize));
 601 }
 602
 603 static inline int usb_endpoint_interrupt_type(
 604                 const struct usb_endpoint_descriptor *epd)
 605 {
 606         return epd->bmAttributes & USB_ENDPOINT_INTRTYPE;
 607 }
 608
 609 /*-------------------------------------------------------------------------*/
 610
 611 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
 612 struct usb_ss_ep_comp_descriptor {
 613         __u8  bLength;
 614         __u8  bDescriptorType;
 615
 616         __u8  bMaxBurst;
 617         __u8  bmAttributes;
 618         __le16 wBytesPerInterval;
 619 } __attribute__ ((packed));
 620
 621 #define USB_DT_SS_EP_COMP_SIZE          6
 622
 623 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */
 624 static inline int
 625 usb_ss_max_streams(const struct usb_ss_ep_comp_descriptor *comp)
 626 {
 627         int             max_streams;
 628
 629         if (!comp)
 630                 return 0;
 631
 632         max_streams = comp->bmAttributes & 0x1f;
 633
 634         if (!max_streams)
 635                 return 0;
 636
 637         max_streams = 1 << max_streams;
 638
 639         return max_streams;
 640 }
 641
 642 /* Bits 1:0 of bmAttributes if this is an isoc endpoint */
 643 #define USB_SS_MULT(p)                  (1 + ((p) & 0x3))
 644
 645 /*-------------------------------------------------------------------------*/
 646
 647 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
 648 struct usb_qualifier_descriptor {
 649         __u8  bLength;
 650         __u8  bDescriptorType;
 651
 652         __le16 bcdUSB;
 653         __u8  bDeviceClass;
 654         __u8  bDeviceSubClass;
 655         __u8  bDeviceProtocol;
 656         __u8  bMaxPacketSize0;
 657         __u8  bNumConfigurations;
 658         __u8  bRESERVED;
 659 } __attribute__ ((packed));
 660
 661
 662 /*-------------------------------------------------------------------------*/
 663
 664 /* USB_DT_OTG (from OTG 1.0a supplement) */
 665 struct usb_otg_descriptor {
 666         __u8  bLength;
 667         __u8  bDescriptorType;
 668
 669         __u8  bmAttributes;     /* support for HNP, SRP, etc */
 670 } __attribute__ ((packed));
 671
 672 /* from usb_otg_descriptor.bmAttributes */
 673 #define USB_OTG_SRP             (1 << 0)
 674 #define USB_OTG_HNP             (1 << 1)        /* swap host/device roles */
 675
 676 /*-------------------------------------------------------------------------*/
 677
 678 /* USB_DT_DEBUG:  for special highspeed devices, replacing serial console */
 679 struct usb_debug_descriptor {
 680         __u8  bLength;
 681         __u8  bDescriptorType;
 682
 683         /* bulk endpoints with 8 byte maxpacket */
 684         __u8  bDebugInEndpoint;
 685         __u8  bDebugOutEndpoint;
 686 } __attribute__((packed));
 687
 688 /*-------------------------------------------------------------------------*/
 689
 690 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
 691 struct usb_interface_assoc_descriptor {
 692         __u8  bLength;
 693         __u8  bDescriptorType;
 694
 695         __u8  bFirstInterface;
 696         __u8  bInterfaceCount;
 697         __u8  bFunctionClass;
 698         __u8  bFunctionSubClass;
 699         __u8  bFunctionProtocol;
 700         __u8  iFunction;
 701 } __attribute__ ((packed));
 702
 703
 704 /*-------------------------------------------------------------------------*/
 705
 706 /* USB_DT_SECURITY:  group of wireless security descriptors, including
 707  * encryption types available for setting up a CC/association.
 708  */
 709 struct usb_security_descriptor {
 710         __u8  bLength;
 711         __u8  bDescriptorType;
 712
 713         __le16 wTotalLength;
 714         __u8  bNumEncryptionTypes;
 715 } __attribute__((packed));
 716
 717 /*-------------------------------------------------------------------------*/
 718
 719 /* USB_DT_KEY:  used with {GET,SET}_SECURITY_DATA; only public keys
 720  * may be retrieved.
 721  */
 722 struct usb_key_descriptor {
 723         __u8  bLength;
 724         __u8  bDescriptorType;
 725
 726         __u8  tTKID[3];
 727         __u8  bReserved;
 728         __u8  bKeyData[0];
 729 } __attribute__((packed));
 730
 731 /*-------------------------------------------------------------------------*/
 732
 733 /* USB_DT_ENCRYPTION_TYPE:  bundled in DT_SECURITY groups */
 734 struct usb_encryption_descriptor {
 735         __u8  bLength;
 736         __u8  bDescriptorType;
 737
 738         __u8  bEncryptionType;
 739 #define USB_ENC_TYPE_UNSECURE           0
 740 #define USB_ENC_TYPE_WIRED              1       /* non-wireless mode */
 741 #define USB_ENC_TYPE_CCM_1              2       /* aes128/cbc session */
 742 #define USB_ENC_TYPE_RSA_1              3       /* rsa3072/sha1 auth */
 743         __u8  bEncryptionValue;         /* use in SET_ENCRYPTION */
 744         __u8  bAuthKeyIndex;
 745 } __attribute__((packed));
 746
 747
 748 /*-------------------------------------------------------------------------*/
 749
 750 /* USB_DT_BOS:  group of device-level capabilities */
 751 struct usb_bos_descriptor {
 752         __u8  bLength;
 753         __u8  bDescriptorType;
 754
 755         __le16 wTotalLength;
 756         __u8  bNumDeviceCaps;
 757 } __attribute__((packed));
 758
 759 #define USB_DT_BOS_SIZE         5
 760 /*-------------------------------------------------------------------------*/
 761
 762 /* USB_DT_DEVICE_CAPABILITY:  grouped with BOS */
 763 struct usb_dev_cap_header {
 764         __u8  bLength;
 765         __u8  bDescriptorType;
 766         __u8  bDevCapabilityType;
 767 } __attribute__((packed));
 768
 769 #define USB_CAP_TYPE_WIRELESS_USB       1
 770
 771 struct usb_wireless_cap_descriptor {    /* Ultra Wide Band */
 772         __u8  bLength;
 773         __u8  bDescriptorType;
 774         __u8  bDevCapabilityType;
 775
 776         __u8  bmAttributes;
 777 #define USB_WIRELESS_P2P_DRD            (1 << 1)
 778 #define USB_WIRELESS_BEACON_MASK        (3 << 2)
 779 #define USB_WIRELESS_BEACON_SELF        (1 << 2)
 780 #define USB_WIRELESS_BEACON_DIRECTED    (2 << 2)
 781 #define USB_WIRELESS_BEACON_NONE        (3 << 2)
 782         __le16 wPHYRates;       /* bit rates, Mbps */
 783 #define USB_WIRELESS_PHY_53             (1 << 0)        /* always set */
 784 #define USB_WIRELESS_PHY_80             (1 << 1)
 785 #define USB_WIRELESS_PHY_107            (1 << 2)        /* always set */
 786 #define USB_WIRELESS_PHY_160            (1 << 3)
 787 #define USB_WIRELESS_PHY_200            (1 << 4)        /* always set */
 788 #define USB_WIRELESS_PHY_320            (1 << 5)
 789 #define USB_WIRELESS_PHY_400            (1 << 6)
 790 #define USB_WIRELESS_PHY_480            (1 << 7)
 791         __u8  bmTFITXPowerInfo; /* TFI power levels */
 792         __u8  bmFFITXPowerInfo; /* FFI power levels */
 793         __le16 bmBandGroup;
 794         __u8  bReserved;
 795 } __attribute__((packed));
 796
 797 /* USB 2.0 Extension descriptor */
 798 #define USB_CAP_TYPE_EXT                2
 799
 800 struct usb_ext_cap_descriptor {         /* Link Power Management */
 801         __u8  bLength;
 802         __u8  bDescriptorType;
 803         __u8  bDevCapabilityType;
 804         __le32 bmAttributes;
 805 #define USB_LPM_SUPPORT                 (1 << 1)        /* supports LPM */
 806 #define USB_BESL_SUPPORT                (1 << 2)        /* supports BESL */
 807 #define USB_BESL_BASELINE_VALID         (1 << 3)        /* Baseline BESL valid*/
 808 #define USB_BESL_DEEP_VALID             (1 << 4)        /* Deep BESL valid */
 809 #define USB_GET_BESL_BASELINE(p)        (((p) & (0xf << 8)) >> 8)
 810 #define USB_GET_BESL_DEEP(p)            (((p) & (0xf << 12)) >> 12)
 811 } __attribute__((packed));
 812
 813 #define USB_DT_USB_EXT_CAP_SIZE 7
 814
 815 /*
 816  * SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
 817  * specific device level capabilities
 818  */
 819 #define         USB_SS_CAP_TYPE         3
 820 struct usb_ss_cap_descriptor {          /* Link Power Management */
 821         __u8  bLength;
 822         __u8  bDescriptorType;
 823         __u8  bDevCapabilityType;
 824         __u8  bmAttributes;
 825 #define USB_LTM_SUPPORT                 (1 << 1) /* supports LTM */
 826         __le16 wSpeedSupported;
 827 #define USB_LOW_SPEED_OPERATION         (1)      /* Low speed operation */
 828 #define USB_FULL_SPEED_OPERATION        (1 << 1) /* Full speed operation */
 829 #define USB_HIGH_SPEED_OPERATION        (1 << 2) /* High speed operation */
 830 #define USB_5GBPS_OPERATION             (1 << 3) /* Operation at 5Gbps */
 831         __u8  bFunctionalitySupport;
 832         __u8  bU1devExitLat;
 833         __le16 bU2DevExitLat;
 834 } __attribute__((packed));
 835
 836 #define USB_DT_USB_SS_CAP_SIZE  10
 837
 838 /*
 839  * Container ID Capability descriptor: Defines the instance unique ID used to
 840  * identify the instance across all operating modes
 841  */
 842 #define CONTAINER_ID_TYPE       4
 843 struct usb_ss_container_id_descriptor {
 844         __u8  bLength;
 845         __u8  bDescriptorType;
 846         __u8  bDevCapabilityType;
 847         __u8  bReserved;
 848         __u8  ContainerID[16]; /* 128-bit number */
 849 } __attribute__((packed));
 850
 851 #define USB_DT_USB_SS_CONTN_ID_SIZE     20
 852 /*-------------------------------------------------------------------------*/
 853
 854 /* USB_DT_WIRELESS_ENDPOINT_COMP:  companion descriptor associated with
 855  * each endpoint descriptor for a wireless device
 856  */
 857 struct usb_wireless_ep_comp_descriptor {
 858         __u8  bLength;
 859         __u8  bDescriptorType;
 860
 861         __u8  bMaxBurst;
 862         __u8  bMaxSequence;
 863         __le16 wMaxStreamDelay;
 864         __le16 wOverTheAirPacketSize;
 865         __u8  bOverTheAirInterval;
 866         __u8  bmCompAttributes;
 867 #define USB_ENDPOINT_SWITCH_MASK        0x03    /* in bmCompAttributes */
 868 #define USB_ENDPOINT_SWITCH_NO          0
 869 #define USB_ENDPOINT_SWITCH_SWITCH      1
 870 #define USB_ENDPOINT_SWITCH_SCALE       2
 871 } __attribute__((packed));
 872
 873 /*-------------------------------------------------------------------------*/
 874
 875 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
 876  * host and a device for connection set up, mutual authentication, and
 877  * exchanging short lived session keys.  The handshake depends on a CC.
 878  */
 879 struct usb_handshake {
 880         __u8 bMessageNumber;
 881         __u8 bStatus;
 882         __u8 tTKID[3];
 883         __u8 bReserved;
 884         __u8 CDID[16];
 885         __u8 nonce[16];
 886         __u8 MIC[8];
 887 } __attribute__((packed));
 888
 889 /*-------------------------------------------------------------------------*/
 890
 891 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
 892  * A CC may also be set up using non-wireless secure channels (including
 893  * wired USB!), and some devices may support CCs with multiple hosts.
 894  */
 895 struct usb_connection_context {
 896         __u8 CHID[16];          /* persistent host id */
 897         __u8 CDID[16];          /* device id (unique w/in host context) */
 898         __u8 CK[16];            /* connection key */
 899 } __attribute__((packed));
 900
 901 /*-------------------------------------------------------------------------*/
 902
 903 /* USB 2.0 defines three speeds, here's how Linux identifies them */
 904
 905 enum usb_device_speed {
 906         USB_SPEED_UNKNOWN = 0,                  /* enumerating */
 907         USB_SPEED_LOW, USB_SPEED_FULL,          /* usb 1.1 */
 908         USB_SPEED_HIGH,                         /* usb 2.0 */
 909         USB_SPEED_WIRELESS,                     /* wireless (usb 2.5) */
 910         USB_SPEED_SUPER,                        /* usb 3.0 */
 911 };
 912
 913 #ifdef __KERNEL__
 914
 915 /**
 916  * usb_speed_string() - Returns human readable-name of the speed.
 917  * @speed: The speed to return human-readable name for.  If it's not
 918  *   any of the speeds defined in usb_device_speed enum, string for
 919  *   USB_SPEED_UNKNOWN will be returned.
 920  */
 921 extern const char *usb_speed_string(enum usb_device_speed speed);
 922
 923 #endif
 924
 925 enum usb_device_state {
 926         /* NOTATTACHED isn't in the USB spec, and this state acts
 927          * the same as ATTACHED ... but it's clearer this way.
 928          */
 929         USB_STATE_NOTATTACHED = 0,
 930
 931         /* chapter 9 and authentication (wireless) device states */
 932         USB_STATE_ATTACHED,
 933         USB_STATE_POWERED,                      /* wired */
 934         USB_STATE_RECONNECTING,                 /* auth */
 935         USB_STATE_UNAUTHENTICATED,              /* auth */
 936         USB_STATE_DEFAULT,                      /* limited function */
 937         USB_STATE_ADDRESS,
 938         USB_STATE_CONFIGURED,                   /* most functions */
 939
 940         USB_STATE_SUSPENDED
 941
 942         /* NOTE:  there are actually four different SUSPENDED
 943          * states, returning to POWERED, DEFAULT, ADDRESS, or
 944          * CONFIGURED respectively when SOF tokens flow again.
 945          * At this level there's no difference between L1 and L2
 946          * suspend states.  (L2 being original USB 1.1 suspend.)
 947          */
 948 };
 949
 950 enum usb3_link_state {
 951         USB3_LPM_U0 = 0,
 952         USB3_LPM_U1,
 953         USB3_LPM_U2,
 954         USB3_LPM_U3
 955 };
 956
 957 /*
 958  * A U1 timeout of 0x0 means the parent hub will reject any transitions to U1.
 959  * 0xff means the parent hub will accept transitions to U1, but will not
 960  * initiate a transition.
 961  *
 962  * A U1 timeout of 0x1 to 0x7F also causes the hub to initiate a transition to
 963  * U1 after that many microseconds.  Timeouts of 0x80 to 0xFE are reserved
 964  * values.
 965  *
 966  * A U2 timeout of 0x0 means the parent hub will reject any transitions to U2.
 967  * 0xff means the parent hub will accept transitions to U2, but will not
 968  * initiate a transition.
 969  *
 970  * A U2 timeout of 0x1 to 0xFE also causes the hub to initiate a transition to
 971  * U2 after N*256 microseconds.  Therefore a U2 timeout value of 0x1 means a U2
 972  * idle timer of 256 microseconds, 0x2 means 512 microseconds, 0xFE means
 973  * 65.024ms.
 974  */
 975 #define USB3_LPM_DISABLED               0x0
 976 #define USB3_LPM_U1_MAX_TIMEOUT         0x7F
 977 #define USB3_LPM_U2_MAX_TIMEOUT         0xFE
 978 #define USB3_LPM_DEVICE_INITIATED       0xFF
 979
 980 struct usb_set_sel_req {
 981         __u8    u1_sel;
 982         __u8    u1_pel;
 983         __le16  u2_sel;
 984         __le16  u2_pel;
 985 } __attribute__ ((packed));
 986
 987 /*
 988  * The Set System Exit Latency control transfer provides one byte each for
 989  * U1 SEL and U1 PEL, so the max exit latency is 0xFF.  U2 SEL and U2 PEL each
 990  * are two bytes long.
 991  */
 992 #define USB3_LPM_MAX_U1_SEL_PEL         0xFF
 993 #define USB3_LPM_MAX_U2_SEL_PEL         0xFFFF
 994
 995 /*-------------------------------------------------------------------------*/
 996
 997 /*
 998  * As per USB compliance update, a device that is actively drawing
 999  * more than 100mA from USB must report itself as bus-powered in
1000  * the GetStatus(DEVICE) call.
1001  * http://compliance.usb.org/index.asp?UpdateFile=Electrical&Format=Standard#34
1002  */
1003 #define USB_SELF_POWER_VBUS_MAX_DRAW            100
1004
1005 #endif /* __LINUX_USB_CH9_H */