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
  38 /*-------------------------------------------------------------------------*/
  39
  40 /* CONTROL REQUEST SUPPORT */
  41
  42 /*
  43  * USB directions
  44  *
  45  * This bit flag is used in endpoint descriptors' bEndpointAddress field.
  46  * It's also one of three fields in control requests bRequestType.
  47  */
  48 #define USB_DIR_OUT                     0               /* to device */
  49 #define USB_DIR_IN                      0x80            /* to host */
  50
  51 /*
  52  * USB types, the second of three bRequestType fields
  53  */
  54 #define USB_TYPE_MASK                   (0x03 << 5)
  55 #define USB_TYPE_STANDARD               (0x00 << 5)
  56 #define USB_TYPE_CLASS                  (0x01 << 5)
  57 #define USB_TYPE_VENDOR                 (0x02 << 5)
  58 #define USB_TYPE_RESERVED               (0x03 << 5)
  59
  60 /*
  61  * USB recipients, the third of three bRequestType fields
  62  */
  63 #define USB_RECIP_MASK                  0x1f
  64 #define USB_RECIP_DEVICE                0x00
  65 #define USB_RECIP_INTERFACE             0x01
  66 #define USB_RECIP_ENDPOINT              0x02
  67 #define USB_RECIP_OTHER                 0x03
  68 /* From Wireless USB 1.0 */
  69 #define USB_RECIP_PORT                  0x04
  70 #define USB_RECIP_RPIPE         0x05
  71
  72 /*
  73  * Standard requests, for the bRequest field of a SETUP packet.
  74  *
  75  * These are qualified by the bRequestType field, so that for example
  76  * TYPE_CLASS or TYPE_VENDOR specific feature flags could be retrieved
  77  * by a GET_STATUS request.
  78  */
  79 #define USB_REQ_GET_STATUS              0x00
  80 #define USB_REQ_CLEAR_FEATURE           0x01
  81 #define USB_REQ_SET_FEATURE             0x03
  82 #define USB_REQ_SET_ADDRESS             0x05
  83 #define USB_REQ_GET_DESCRIPTOR          0x06
  84 #define USB_REQ_SET_DESCRIPTOR          0x07
  85 #define USB_REQ_GET_CONFIGURATION       0x08
  86 #define USB_REQ_SET_CONFIGURATION       0x09
  87 #define USB_REQ_GET_INTERFACE           0x0A
  88 #define USB_REQ_SET_INTERFACE           0x0B
  89 #define USB_REQ_SYNCH_FRAME             0x0C
  90
  91 #define USB_REQ_SET_ENCRYPTION          0x0D    /* Wireless USB */
  92 #define USB_REQ_GET_ENCRYPTION          0x0E
  93 #define USB_REQ_RPIPE_ABORT             0x0E
  94 #define USB_REQ_SET_HANDSHAKE           0x0F
  95 #define USB_REQ_RPIPE_RESET             0x0F
  96 #define USB_REQ_GET_HANDSHAKE           0x10
  97 #define USB_REQ_SET_CONNECTION          0x11
  98 #define USB_REQ_SET_SECURITY_DATA       0x12
  99 #define USB_REQ_GET_SECURITY_DATA       0x13
 100 #define USB_REQ_SET_WUSB_DATA           0x14
 101 #define USB_REQ_LOOPBACK_DATA_WRITE     0x15
 102 #define USB_REQ_LOOPBACK_DATA_READ      0x16
 103 #define USB_REQ_SET_INTERFACE_DS        0x17
 104
 105 /* The Link Power Management (LPM) ECN defines USB_REQ_TEST_AND_SET command,
 106  * used by hubs to put ports into a new L1 suspend state, except that it
 107  * forgot to define its number ...
 108  */
 109
 110 /*
 111  * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and
 112  * are read as a bit array returned by USB_REQ_GET_STATUS.  (So there
 113  * are at most sixteen features of each type.)  Hubs may also support a
 114  * new USB_REQ_TEST_AND_SET_FEATURE to put ports into L1 suspend.
 115  */
 116 #define USB_DEVICE_SELF_POWERED         0       /* (read only) */
 117 #define USB_DEVICE_REMOTE_WAKEUP        1       /* dev may initiate wakeup */
 118 #define USB_DEVICE_TEST_MODE            2       /* (wired high speed only) */
 119 #define USB_DEVICE_BATTERY              2       /* (wireless) */
 120 #define USB_DEVICE_B_HNP_ENABLE         3       /* (otg) dev may initiate HNP */
 121 #define USB_DEVICE_WUSB_DEVICE          3       /* (wireless)*/
 122 #define USB_DEVICE_A_HNP_SUPPORT        4       /* (otg) RH port supports HNP */
 123 #define USB_DEVICE_A_ALT_HNP_SUPPORT    5       /* (otg) other RH port does */
 124 #define USB_DEVICE_DEBUG_MODE           6       /* (special devices only) */
 125
 126 #define USB_ENDPOINT_HALT               0       /* IN/OUT will STALL */
 127
 128
 129 /**
 130  * struct usb_ctrlrequest - SETUP data for a USB device control request
 131  * @bRequestType: matches the USB bmRequestType field
 132  * @bRequest: matches the USB bRequest field
 133  * @wValue: matches the USB wValue field (le16 byte order)
 134  * @wIndex: matches the USB wIndex field (le16 byte order)
 135  * @wLength: matches the USB wLength field (le16 byte order)
 136  *
 137  * This structure is used to send control requests to a USB device.  It matches
 138  * the different fields of the USB 2.0 Spec section 9.3, table 9-2.  See the
 139  * USB spec for a fuller description of the different fields, and what they are
 140  * used for.
 141  *
 142  * Note that the driver for any interface can issue control requests.
 143  * For most devices, interfaces don't coordinate with each other, so
 144  * such requests may be made at any time.
 145  */
 146 struct usb_ctrlrequest {
 147         __u8 bRequestType;
 148         __u8 bRequest;
 149         __le16 wValue;
 150         __le16 wIndex;
 151         __le16 wLength;
 152 } __attribute__ ((packed));
 153
 154 /*-------------------------------------------------------------------------*/
 155
 156 /*
 157  * STANDARD DESCRIPTORS ... as returned by GET_DESCRIPTOR, or
 158  * (rarely) accepted by SET_DESCRIPTOR.
 159  *
 160  * Note that all multi-byte values here are encoded in little endian
 161  * byte order "on the wire".  Within the kernel and when exposed
 162  * through the Linux-USB APIs, they are not converted to cpu byte
 163  * order; it is the responsibility of the client code to do this.
 164  * The single exception is when device and configuration descriptors (but
 165  * not other descriptors) are read from usbfs (i.e. /proc/bus/usb/BBB/DDD);
 166  * in this case the fields are converted to host endianness by the kernel.
 167  */
 168
 169 /*
 170  * Descriptor types ... USB 2.0 spec table 9.5
 171  */
 172 #define USB_DT_DEVICE                   0x01
 173 #define USB_DT_CONFIG                   0x02
 174 #define USB_DT_STRING                   0x03
 175 #define USB_DT_INTERFACE                0x04
 176 #define USB_DT_ENDPOINT                 0x05
 177 #define USB_DT_DEVICE_QUALIFIER         0x06
 178 #define USB_DT_OTHER_SPEED_CONFIG       0x07
 179 #define USB_DT_INTERFACE_POWER          0x08
 180 /* these are from a minor usb 2.0 revision (ECN) */
 181 #define USB_DT_OTG                      0x09
 182 #define USB_DT_DEBUG                    0x0a
 183 #define USB_DT_INTERFACE_ASSOCIATION    0x0b
 184 /* these are from the Wireless USB spec */
 185 #define USB_DT_SECURITY                 0x0c
 186 #define USB_DT_KEY                      0x0d
 187 #define USB_DT_ENCRYPTION_TYPE          0x0e
 188 #define USB_DT_BOS                      0x0f
 189 #define USB_DT_DEVICE_CAPABILITY        0x10
 190 #define USB_DT_WIRELESS_ENDPOINT_COMP   0x11
 191 #define USB_DT_WIRE_ADAPTER             0x21
 192 #define USB_DT_RPIPE                    0x22
 193 #define USB_DT_CS_RADIO_CONTROL         0x23
 194 /* From the T10 UAS specification */
 195 #define USB_DT_PIPE_USAGE               0x24
 196 /* From the USB 3.0 spec */
 197 #define USB_DT_SS_ENDPOINT_COMP         0x30
 198
 199 /* Conventional codes for class-specific descriptors.  The convention is
 200  * defined in the USB "Common Class" Spec (3.11).  Individual class specs
 201  * are authoritative for their usage, not the "common class" writeup.
 202  */
 203 #define USB_DT_CS_DEVICE                (USB_TYPE_CLASS | USB_DT_DEVICE)
 204 #define USB_DT_CS_CONFIG                (USB_TYPE_CLASS | USB_DT_CONFIG)
 205 #define USB_DT_CS_STRING                (USB_TYPE_CLASS | USB_DT_STRING)
 206 #define USB_DT_CS_INTERFACE             (USB_TYPE_CLASS | USB_DT_INTERFACE)
 207 #define USB_DT_CS_ENDPOINT              (USB_TYPE_CLASS | USB_DT_ENDPOINT)
 208
 209 /* All standard descriptors have these 2 fields at the beginning */
 210 struct usb_descriptor_header {
 211         __u8  bLength;
 212         __u8  bDescriptorType;
 213 } __attribute__ ((packed));
 214
 215
 216 /*-------------------------------------------------------------------------*/
 217
 218 /* USB_DT_DEVICE: Device descriptor */
 219 struct usb_device_descriptor {
 220         __u8  bLength;
 221         __u8  bDescriptorType;
 222
 223         __le16 bcdUSB;
 224         __u8  bDeviceClass;
 225         __u8  bDeviceSubClass;
 226         __u8  bDeviceProtocol;
 227         __u8  bMaxPacketSize0;
 228         __le16 idVendor;
 229         __le16 idProduct;
 230         __le16 bcdDevice;
 231         __u8  iManufacturer;
 232         __u8  iProduct;
 233         __u8  iSerialNumber;
 234         __u8  bNumConfigurations;
 235 } __attribute__ ((packed));
 236
 237 #define USB_DT_DEVICE_SIZE              18
 238
 239
 240 /*
 241  * Device and/or Interface Class codes
 242  * as found in bDeviceClass or bInterfaceClass
 243  * and defined by www.usb.org documents
 244  */
 245 #define USB_CLASS_PER_INTERFACE         0       /* for DeviceClass */
 246 #define USB_CLASS_AUDIO                 1
 247 #define USB_CLASS_COMM                  2
 248 #define USB_CLASS_HID                   3
 249 #define USB_CLASS_PHYSICAL              5
 250 #define USB_CLASS_STILL_IMAGE           6
 251 #define USB_CLASS_PRINTER               7
 252 #define USB_CLASS_MASS_STORAGE          8
 253 #define USB_CLASS_HUB                   9
 254 #define USB_CLASS_CDC_DATA              0x0a
 255 #define USB_CLASS_CSCID                 0x0b    /* chip+ smart card */
 256 #define USB_CLASS_CONTENT_SEC           0x0d    /* content security */
 257 #define USB_CLASS_VIDEO                 0x0e
 258 #define USB_CLASS_WIRELESS_CONTROLLER   0xe0
 259 #define USB_CLASS_MISC                  0xef
 260 #define USB_CLASS_APP_SPEC              0xfe
 261 #define USB_CLASS_VENDOR_SPEC           0xff
 262
 263 #define USB_SUBCLASS_VENDOR_SPEC        0xff
 264
 265 /*-------------------------------------------------------------------------*/
 266
 267 /* USB_DT_CONFIG: Configuration descriptor information.
 268  *
 269  * USB_DT_OTHER_SPEED_CONFIG is the same descriptor, except that the
 270  * descriptor type is different.  Highspeed-capable devices can look
 271  * different depending on what speed they're currently running.  Only
 272  * devices with a USB_DT_DEVICE_QUALIFIER have any OTHER_SPEED_CONFIG
 273  * descriptors.
 274  */
 275 struct usb_config_descriptor {
 276         __u8  bLength;
 277         __u8  bDescriptorType;
 278
 279         __le16 wTotalLength;
 280         __u8  bNumInterfaces;
 281         __u8  bConfigurationValue;
 282         __u8  iConfiguration;
 283         __u8  bmAttributes;
 284         __u8  bMaxPower;
 285 } __attribute__ ((packed));
 286
 287 #define USB_DT_CONFIG_SIZE              9
 288
 289 /* from config descriptor bmAttributes */
 290 #define USB_CONFIG_ATT_ONE              (1 << 7)        /* must be set */
 291 #define USB_CONFIG_ATT_SELFPOWER        (1 << 6)        /* self powered */
 292 #define USB_CONFIG_ATT_WAKEUP           (1 << 5)        /* can wakeup */
 293 #define USB_CONFIG_ATT_BATTERY          (1 << 4)        /* battery powered */
 294
 295 /*-------------------------------------------------------------------------*/
 296
 297 /* USB_DT_STRING: String descriptor */
 298 struct usb_string_descriptor {
 299         __u8  bLength;
 300         __u8  bDescriptorType;
 301
 302         __le16 wData[1];                /* UTF-16LE encoded */
 303 } __attribute__ ((packed));
 304
 305 /* note that "string" zero is special, it holds language codes that
 306  * the device supports, not Unicode characters.
 307  */
 308
 309 /*-------------------------------------------------------------------------*/
 310
 311 /* USB_DT_INTERFACE: Interface descriptor */
 312 struct usb_interface_descriptor {
 313         __u8  bLength;
 314         __u8  bDescriptorType;
 315
 316         __u8  bInterfaceNumber;
 317         __u8  bAlternateSetting;
 318         __u8  bNumEndpoints;
 319         __u8  bInterfaceClass;
 320         __u8  bInterfaceSubClass;
 321         __u8  bInterfaceProtocol;
 322         __u8  iInterface;
 323 } __attribute__ ((packed));
 324
 325 #define USB_DT_INTERFACE_SIZE           9
 326
 327 /*-------------------------------------------------------------------------*/
 328
 329 /* USB_DT_ENDPOINT: Endpoint descriptor */
 330 struct usb_endpoint_descriptor {
 331         __u8  bLength;
 332         __u8  bDescriptorType;
 333
 334         __u8  bEndpointAddress;
 335         __u8  bmAttributes;
 336         __le16 wMaxPacketSize;
 337         __u8  bInterval;
 338
 339         /* NOTE:  these two are _only_ in audio endpoints. */
 340         /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */
 341         __u8  bRefresh;
 342         __u8  bSynchAddress;
 343 } __attribute__ ((packed));
 344
 345 #define USB_DT_ENDPOINT_SIZE            7
 346 #define USB_DT_ENDPOINT_AUDIO_SIZE      9       /* Audio extension */
 347
 348
 349 /*
 350  * Endpoints
 351  */
 352 #define USB_ENDPOINT_NUMBER_MASK        0x0f    /* in bEndpointAddress */
 353 #define USB_ENDPOINT_DIR_MASK           0x80
 354
 355 #define USB_ENDPOINT_SYNCTYPE           0x0c
 356 #define USB_ENDPOINT_SYNC_NONE          (0 << 2)
 357 #define USB_ENDPOINT_SYNC_ASYNC         (1 << 2)
 358 #define USB_ENDPOINT_SYNC_ADAPTIVE      (2 << 2)
 359 #define USB_ENDPOINT_SYNC_SYNC          (3 << 2)
 360
 361 #define USB_ENDPOINT_XFERTYPE_MASK      0x03    /* in bmAttributes */
 362 #define USB_ENDPOINT_XFER_CONTROL       0
 363 #define USB_ENDPOINT_XFER_ISOC          1
 364 #define USB_ENDPOINT_XFER_BULK          2
 365 #define USB_ENDPOINT_XFER_INT           3
 366 #define USB_ENDPOINT_MAX_ADJUSTABLE     0x80
 367
 368 /*-------------------------------------------------------------------------*/
 369
 370 /**
 371  * usb_endpoint_num - get the endpoint's number
 372  * @epd: endpoint to be checked
 373  *
 374  * Returns @epd's number: 0 to 15.
 375  */
 376 static inline int usb_endpoint_num(const struct usb_endpoint_descriptor *epd)
 377 {
 378         return epd->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK;
 379 }
 380
 381 /**
 382  * usb_endpoint_type - get the endpoint's transfer type
 383  * @epd: endpoint to be checked
 384  *
 385  * Returns one of USB_ENDPOINT_XFER_{CONTROL, ISOC, BULK, INT} according
 386  * to @epd's transfer type.
 387  */
 388 static inline int usb_endpoint_type(const struct usb_endpoint_descriptor *epd)
 389 {
 390         return epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK;
 391 }
 392
 393 /**
 394  * usb_endpoint_dir_in - check if the endpoint has IN direction
 395  * @epd: endpoint to be checked
 396  *
 397  * Returns true if the endpoint is of type IN, otherwise it returns false.
 398  */
 399 static inline int usb_endpoint_dir_in(const struct usb_endpoint_descriptor *epd)
 400 {
 401         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN);
 402 }
 403
 404 /**
 405  * usb_endpoint_dir_out - check if the endpoint has OUT direction
 406  * @epd: endpoint to be checked
 407  *
 408  * Returns true if the endpoint is of type OUT, otherwise it returns false.
 409  */
 410 static inline int usb_endpoint_dir_out(
 411                                 const struct usb_endpoint_descriptor *epd)
 412 {
 413         return ((epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT);
 414 }
 415
 416 /**
 417  * usb_endpoint_xfer_bulk - check if the endpoint has bulk transfer type
 418  * @epd: endpoint to be checked
 419  *
 420  * Returns true if the endpoint is of type bulk, otherwise it returns false.
 421  */
 422 static inline int usb_endpoint_xfer_bulk(
 423                                 const struct usb_endpoint_descriptor *epd)
 424 {
 425         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 426                 USB_ENDPOINT_XFER_BULK);
 427 }
 428
 429 /**
 430  * usb_endpoint_xfer_control - check if the endpoint has control transfer type
 431  * @epd: endpoint to be checked
 432  *
 433  * Returns true if the endpoint is of type control, otherwise it returns false.
 434  */
 435 static inline int usb_endpoint_xfer_control(
 436                                 const struct usb_endpoint_descriptor *epd)
 437 {
 438         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 439                 USB_ENDPOINT_XFER_CONTROL);
 440 }
 441
 442 /**
 443  * usb_endpoint_xfer_int - check if the endpoint has interrupt transfer type
 444  * @epd: endpoint to be checked
 445  *
 446  * Returns true if the endpoint is of type interrupt, otherwise it returns
 447  * false.
 448  */
 449 static inline int usb_endpoint_xfer_int(
 450                                 const struct usb_endpoint_descriptor *epd)
 451 {
 452         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 453                 USB_ENDPOINT_XFER_INT);
 454 }
 455
 456 /**
 457  * usb_endpoint_xfer_isoc - check if the endpoint has isochronous transfer type
 458  * @epd: endpoint to be checked
 459  *
 460  * Returns true if the endpoint is of type isochronous, otherwise it returns
 461  * false.
 462  */
 463 static inline int usb_endpoint_xfer_isoc(
 464                                 const struct usb_endpoint_descriptor *epd)
 465 {
 466         return ((epd->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
 467                 USB_ENDPOINT_XFER_ISOC);
 468 }
 469
 470 /**
 471  * usb_endpoint_is_bulk_in - check if the endpoint is bulk IN
 472  * @epd: endpoint to be checked
 473  *
 474  * Returns true if the endpoint has bulk transfer type and IN direction,
 475  * otherwise it returns false.
 476  */
 477 static inline int usb_endpoint_is_bulk_in(
 478                                 const struct usb_endpoint_descriptor *epd)
 479 {
 480         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_in(epd);
 481 }
 482
 483 /**
 484  * usb_endpoint_is_bulk_out - check if the endpoint is bulk OUT
 485  * @epd: endpoint to be checked
 486  *
 487  * Returns true if the endpoint has bulk transfer type and OUT direction,
 488  * otherwise it returns false.
 489  */
 490 static inline int usb_endpoint_is_bulk_out(
 491                                 const struct usb_endpoint_descriptor *epd)
 492 {
 493         return usb_endpoint_xfer_bulk(epd) && usb_endpoint_dir_out(epd);
 494 }
 495
 496 /**
 497  * usb_endpoint_is_int_in - check if the endpoint is interrupt IN
 498  * @epd: endpoint to be checked
 499  *
 500  * Returns true if the endpoint has interrupt transfer type and IN direction,
 501  * otherwise it returns false.
 502  */
 503 static inline int usb_endpoint_is_int_in(
 504                                 const struct usb_endpoint_descriptor *epd)
 505 {
 506         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_in(epd);
 507 }
 508
 509 /**
 510  * usb_endpoint_is_int_out - check if the endpoint is interrupt OUT
 511  * @epd: endpoint to be checked
 512  *
 513  * Returns true if the endpoint has interrupt transfer type and OUT direction,
 514  * otherwise it returns false.
 515  */
 516 static inline int usb_endpoint_is_int_out(
 517                                 const struct usb_endpoint_descriptor *epd)
 518 {
 519         return usb_endpoint_xfer_int(epd) && usb_endpoint_dir_out(epd);
 520 }
 521
 522 /**
 523  * usb_endpoint_is_isoc_in - check if the endpoint is isochronous IN
 524  * @epd: endpoint to be checked
 525  *
 526  * Returns true if the endpoint has isochronous transfer type and IN direction,
 527  * otherwise it returns false.
 528  */
 529 static inline int usb_endpoint_is_isoc_in(
 530                                 const struct usb_endpoint_descriptor *epd)
 531 {
 532         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_in(epd);
 533 }
 534
 535 /**
 536  * usb_endpoint_is_isoc_out - check if the endpoint is isochronous OUT
 537  * @epd: endpoint to be checked
 538  *
 539  * Returns true if the endpoint has isochronous transfer type and OUT direction,
 540  * otherwise it returns false.
 541  */
 542 static inline int usb_endpoint_is_isoc_out(
 543                                 const struct usb_endpoint_descriptor *epd)
 544 {
 545         return usb_endpoint_xfer_isoc(epd) && usb_endpoint_dir_out(epd);
 546 }
 547
 548 /*-------------------------------------------------------------------------*/
 549
 550 /* USB_DT_SS_ENDPOINT_COMP: SuperSpeed Endpoint Companion descriptor */
 551 struct usb_ss_ep_comp_descriptor {
 552         __u8  bLength;
 553         __u8  bDescriptorType;
 554
 555         __u8  bMaxBurst;
 556         __u8  bmAttributes;
 557         __u16 wBytesPerInterval;
 558 } __attribute__ ((packed));
 559
 560 #define USB_DT_SS_EP_COMP_SIZE          6
 561 /* Bits 4:0 of bmAttributes if this is a bulk endpoint */
 562 #define USB_SS_MAX_STREAMS(p)           (1 << (p & 0x1f))
 563
 564 /*-------------------------------------------------------------------------*/
 565
 566 /* USB_DT_DEVICE_QUALIFIER: Device Qualifier descriptor */
 567 struct usb_qualifier_descriptor {
 568         __u8  bLength;
 569         __u8  bDescriptorType;
 570
 571         __le16 bcdUSB;
 572         __u8  bDeviceClass;
 573         __u8  bDeviceSubClass;
 574         __u8  bDeviceProtocol;
 575         __u8  bMaxPacketSize0;
 576         __u8  bNumConfigurations;
 577         __u8  bRESERVED;
 578 } __attribute__ ((packed));
 579
 580
 581 /*-------------------------------------------------------------------------*/
 582
 583 /* USB_DT_OTG (from OTG 1.0a supplement) */
 584 struct usb_otg_descriptor {
 585         __u8  bLength;
 586         __u8  bDescriptorType;
 587
 588         __u8  bmAttributes;     /* support for HNP, SRP, etc */
 589 } __attribute__ ((packed));
 590
 591 /* from usb_otg_descriptor.bmAttributes */
 592 #define USB_OTG_SRP             (1 << 0)
 593 #define USB_OTG_HNP             (1 << 1)        /* swap host/device roles */
 594
 595 /*-------------------------------------------------------------------------*/
 596
 597 /* USB_DT_DEBUG:  for special highspeed devices, replacing serial console */
 598 struct usb_debug_descriptor {
 599         __u8  bLength;
 600         __u8  bDescriptorType;
 601
 602         /* bulk endpoints with 8 byte maxpacket */
 603         __u8  bDebugInEndpoint;
 604         __u8  bDebugOutEndpoint;
 605 } __attribute__((packed));
 606
 607 /*-------------------------------------------------------------------------*/
 608
 609 /* USB_DT_INTERFACE_ASSOCIATION: groups interfaces */
 610 struct usb_interface_assoc_descriptor {
 611         __u8  bLength;
 612         __u8  bDescriptorType;
 613
 614         __u8  bFirstInterface;
 615         __u8  bInterfaceCount;
 616         __u8  bFunctionClass;
 617         __u8  bFunctionSubClass;
 618         __u8  bFunctionProtocol;
 619         __u8  iFunction;
 620 } __attribute__ ((packed));
 621
 622
 623 /*-------------------------------------------------------------------------*/
 624
 625 /* USB_DT_SECURITY:  group of wireless security descriptors, including
 626  * encryption types available for setting up a CC/association.
 627  */
 628 struct usb_security_descriptor {
 629         __u8  bLength;
 630         __u8  bDescriptorType;
 631
 632         __le16 wTotalLength;
 633         __u8  bNumEncryptionTypes;
 634 } __attribute__((packed));
 635
 636 /*-------------------------------------------------------------------------*/
 637
 638 /* USB_DT_KEY:  used with {GET,SET}_SECURITY_DATA; only public keys
 639  * may be retrieved.
 640  */
 641 struct usb_key_descriptor {
 642         __u8  bLength;
 643         __u8  bDescriptorType;
 644
 645         __u8  tTKID[3];
 646         __u8  bReserved;
 647         __u8  bKeyData[0];
 648 } __attribute__((packed));
 649
 650 /*-------------------------------------------------------------------------*/
 651
 652 /* USB_DT_ENCRYPTION_TYPE:  bundled in DT_SECURITY groups */
 653 struct usb_encryption_descriptor {
 654         __u8  bLength;
 655         __u8  bDescriptorType;
 656
 657         __u8  bEncryptionType;
 658 #define USB_ENC_TYPE_UNSECURE           0
 659 #define USB_ENC_TYPE_WIRED              1       /* non-wireless mode */
 660 #define USB_ENC_TYPE_CCM_1              2       /* aes128/cbc session */
 661 #define USB_ENC_TYPE_RSA_1              3       /* rsa3072/sha1 auth */
 662         __u8  bEncryptionValue;         /* use in SET_ENCRYPTION */
 663         __u8  bAuthKeyIndex;
 664 } __attribute__((packed));
 665
 666
 667 /*-------------------------------------------------------------------------*/
 668
 669 /* USB_DT_BOS:  group of device-level capabilities */
 670 struct usb_bos_descriptor {
 671         __u8  bLength;
 672         __u8  bDescriptorType;
 673
 674         __le16 wTotalLength;
 675         __u8  bNumDeviceCaps;
 676 } __attribute__((packed));
 677
 678 /*-------------------------------------------------------------------------*/
 679
 680 /* USB_DT_DEVICE_CAPABILITY:  grouped with BOS */
 681 struct usb_dev_cap_header {
 682         __u8  bLength;
 683         __u8  bDescriptorType;
 684         __u8  bDevCapabilityType;
 685 } __attribute__((packed));
 686
 687 #define USB_CAP_TYPE_WIRELESS_USB       1
 688
 689 struct usb_wireless_cap_descriptor {    /* Ultra Wide Band */
 690         __u8  bLength;
 691         __u8  bDescriptorType;
 692         __u8  bDevCapabilityType;
 693
 694         __u8  bmAttributes;
 695 #define USB_WIRELESS_P2P_DRD            (1 << 1)
 696 #define USB_WIRELESS_BEACON_MASK        (3 << 2)
 697 #define USB_WIRELESS_BEACON_SELF        (1 << 2)
 698 #define USB_WIRELESS_BEACON_DIRECTED    (2 << 2)
 699 #define USB_WIRELESS_BEACON_NONE        (3 << 2)
 700         __le16 wPHYRates;       /* bit rates, Mbps */
 701 #define USB_WIRELESS_PHY_53             (1 << 0)        /* always set */
 702 #define USB_WIRELESS_PHY_80             (1 << 1)
 703 #define USB_WIRELESS_PHY_107            (1 << 2)        /* always set */
 704 #define USB_WIRELESS_PHY_160            (1 << 3)
 705 #define USB_WIRELESS_PHY_200            (1 << 4)        /* always set */
 706 #define USB_WIRELESS_PHY_320            (1 << 5)
 707 #define USB_WIRELESS_PHY_400            (1 << 6)
 708 #define USB_WIRELESS_PHY_480            (1 << 7)
 709         __u8  bmTFITXPowerInfo; /* TFI power levels */
 710         __u8  bmFFITXPowerInfo; /* FFI power levels */
 711         __le16 bmBandGroup;
 712         __u8  bReserved;
 713 } __attribute__((packed));
 714
 715 #define USB_CAP_TYPE_EXT                2
 716
 717 struct usb_ext_cap_descriptor {         /* Link Power Management */
 718         __u8  bLength;
 719         __u8  bDescriptorType;
 720         __u8  bDevCapabilityType;
 721         __u8  bmAttributes;
 722 #define USB_LPM_SUPPORT                 (1 << 1)        /* supports LPM */
 723 } __attribute__((packed));
 724
 725 /*-------------------------------------------------------------------------*/
 726
 727 /* USB_DT_WIRELESS_ENDPOINT_COMP:  companion descriptor associated with
 728  * each endpoint descriptor for a wireless device
 729  */
 730 struct usb_wireless_ep_comp_descriptor {
 731         __u8  bLength;
 732         __u8  bDescriptorType;
 733
 734         __u8  bMaxBurst;
 735         __u8  bMaxSequence;
 736         __le16 wMaxStreamDelay;
 737         __le16 wOverTheAirPacketSize;
 738         __u8  bOverTheAirInterval;
 739         __u8  bmCompAttributes;
 740 #define USB_ENDPOINT_SWITCH_MASK        0x03    /* in bmCompAttributes */
 741 #define USB_ENDPOINT_SWITCH_NO          0
 742 #define USB_ENDPOINT_SWITCH_SWITCH      1
 743 #define USB_ENDPOINT_SWITCH_SCALE       2
 744 } __attribute__((packed));
 745
 746 /*-------------------------------------------------------------------------*/
 747
 748 /* USB_REQ_SET_HANDSHAKE is a four-way handshake used between a wireless
 749  * host and a device for connection set up, mutual authentication, and
 750  * exchanging short lived session keys.  The handshake depends on a CC.
 751  */
 752 struct usb_handshake {
 753         __u8 bMessageNumber;
 754         __u8 bStatus;
 755         __u8 tTKID[3];
 756         __u8 bReserved;
 757         __u8 CDID[16];
 758         __u8 nonce[16];
 759         __u8 MIC[8];
 760 } __attribute__((packed));
 761
 762 /*-------------------------------------------------------------------------*/
 763
 764 /* USB_REQ_SET_CONNECTION modifies or revokes a connection context (CC).
 765  * A CC may also be set up using non-wireless secure channels (including
 766  * wired USB!), and some devices may support CCs with multiple hosts.
 767  */
 768 struct usb_connection_context {
 769         __u8 CHID[16];          /* persistent host id */
 770         __u8 CDID[16];          /* device id (unique w/in host context) */
 771         __u8 CK[16];            /* connection key */
 772 } __attribute__((packed));
 773
 774 /*-------------------------------------------------------------------------*/
 775
 776 /* USB 2.0 defines three speeds, here's how Linux identifies them */
 777
 778 enum usb_device_speed {
 779         USB_SPEED_UNKNOWN = 0,                  /* enumerating */
 780         USB_SPEED_LOW, USB_SPEED_FULL,          /* usb 1.1 */
 781         USB_SPEED_HIGH,                         /* usb 2.0 */
 782         USB_SPEED_WIRELESS,                     /* wireless (usb 2.5) */
 783         USB_SPEED_SUPER,                        /* usb 3.0 */
 784 };
 785
 786 enum usb_device_state {
 787         /* NOTATTACHED isn't in the USB spec, and this state acts
 788          * the same as ATTACHED ... but it's clearer this way.
 789          */
 790         USB_STATE_NOTATTACHED = 0,
 791
 792         /* chapter 9 and authentication (wireless) device states */
 793         USB_STATE_ATTACHED,
 794         USB_STATE_POWERED,                      /* wired */
 795         USB_STATE_RECONNECTING,                 /* auth */
 796         USB_STATE_UNAUTHENTICATED,              /* auth */
 797         USB_STATE_DEFAULT,                      /* limited function */
 798         USB_STATE_ADDRESS,
 799         USB_STATE_CONFIGURED,                   /* most functions */
 800
 801         USB_STATE_SUSPENDED
 802
 803         /* NOTE:  there are actually four different SUSPENDED
 804          * states, returning to POWERED, DEFAULT, ADDRESS, or
 805          * CONFIGURED respectively when SOF tokens flow again.
 806          * At this level there's no difference between L1 and L2
 807          * suspend states.  (L2 being original USB 1.1 suspend.)
 808          */
 809 };
 810
 811 #endif /* __LINUX_USB_CH9_H */