sys/dev/usb/usb.h

   1 /* $FreeBSD$ */
   2 /*-
   3  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
   4  * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved.
   5  * Copyright (c) 1998 Lennart Augustsson. All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 /*
  30  * This file contains standard definitions for the following USB
  31  * protocol versions:
  32  *
  33  * USB v1.0
  34  * USB v1.1
  35  * USB v2.0
  36  * USB v3.0
  37  */
  38
  39 #ifndef _USB_STANDARD_H_
  40 #define _USB_STANDARD_H_
  41
  42 #if defined(_KERNEL)
  43 #include "opt_usb.h"
  44
  45 /* Declare parent SYSCTL USB node. */
  46 #ifdef SYSCTL_DECL
  47 SYSCTL_DECL(_hw_usb);
  48 #endif
  49
  50 #include <sys/malloc.h>
  51
  52 MALLOC_DECLARE(M_USB);
  53 MALLOC_DECLARE(M_USBDEV);
  54 MALLOC_DECLARE(M_USBHC);
  55 #endif /* _KERNEL */
  56
  57 #include <dev/usb/usb_endian.h>
  58 #include <dev/usb/usb_freebsd.h>
  59
  60 #define USB_STACK_VERSION 2000          /* 2.0 */
  61
  62 /* Definition of some hardcoded USB constants. */
  63
  64 #define USB_MAX_IPACKET         8       /* initial USB packet size */
  65 #define USB_EP_MAX (2*16)               /* hardcoded */
  66 #define USB_ROOT_HUB_ADDR 1             /* index */
  67 #define USB_MIN_DEVICES 2               /* unused + root HUB */
  68 #define USB_UNCONFIG_INDEX 0xFF         /* internal use only */
  69 #define USB_IFACE_INDEX_ANY 0xFF        /* internal use only */
  70 #define USB_START_ADDR 0                /* default USB device BUS address
  71                                          * after USB bus reset */
  72 #define USB_CONTROL_ENDPOINT 0          /* default control endpoint */
  73
  74 #define USB_FRAMES_PER_SECOND_FS 1000   /* full speed */
  75 #define USB_FRAMES_PER_SECOND_HS 8000   /* high speed */
  76
  77 #define USB_FS_BYTES_PER_HS_UFRAME 188  /* bytes */
  78 #define USB_HS_MICRO_FRAMES_MAX 8       /* units */
  79
  80 #define USB_ISOC_TIME_MAX 128           /* ms */
  81
  82 /*
  83  * Minimum time a device needs to be powered down to go through a
  84  * power cycle. These values are not in the USB specification.
  85  */
  86 #define USB_POWER_DOWN_TIME     200     /* ms */
  87 #define USB_PORT_POWER_DOWN_TIME        100     /* ms */
  88
  89 /* Definition of software USB power modes */
  90 #define USB_POWER_MODE_OFF 0            /* turn off device */
  91 #define USB_POWER_MODE_ON 1             /* always on */
  92 #define USB_POWER_MODE_SAVE 2           /* automatic suspend and resume */
  93 #define USB_POWER_MODE_SUSPEND 3        /* force suspend */
  94 #define USB_POWER_MODE_RESUME 4         /* force resume */
  95
  96 /* These are the values from the USB specification. */
  97 #define USB_PORT_RESET_DELAY_SPEC       10      /* ms */
  98 #define USB_PORT_ROOT_RESET_DELAY_SPEC  50      /* ms */
  99 #define USB_PORT_RESET_RECOVERY_SPEC    10      /* ms */
 100 #define USB_PORT_POWERUP_DELAY_SPEC     100     /* ms */
 101 #define USB_PORT_RESUME_DELAY_SPEC      20      /* ms */
 102 #define USB_SET_ADDRESS_SETTLE_SPEC     2       /* ms */
 103 #define USB_RESUME_DELAY_SPEC           (20*5)  /* ms */
 104 #define USB_RESUME_WAIT_SPEC            10      /* ms */
 105 #define USB_RESUME_RECOVERY_SPEC        10      /* ms */
 106 #define USB_EXTRA_POWER_UP_TIME_SPEC    0       /* ms */
 107
 108 /* Allow for marginal and non-conforming devices. */
 109 #define USB_PORT_RESET_DELAY            50      /* ms */
 110 #define USB_PORT_ROOT_RESET_DELAY       250     /* ms */
 111 #define USB_PORT_RESET_RECOVERY         250     /* ms */
 112 #define USB_PORT_POWERUP_DELAY          300     /* ms */
 113 #define USB_PORT_RESUME_DELAY           (20*2)  /* ms */
 114 #define USB_SET_ADDRESS_SETTLE          10      /* ms */
 115 #define USB_RESUME_DELAY                (50*5)  /* ms */
 116 #define USB_RESUME_WAIT                 50      /* ms */
 117 #define USB_RESUME_RECOVERY             50      /* ms */
 118 #define USB_EXTRA_POWER_UP_TIME         20      /* ms */
 119
 120 #define USB_MIN_POWER           100     /* mA */
 121 #define USB_MAX_POWER           500     /* mA */
 122
 123 #define USB_BUS_RESET_DELAY     100     /* ms */
 124
 125 /*
 126  * USB record layout in memory:
 127  *
 128  * - USB config 0
 129  *   - USB interfaces
 130  *     - USB alternative interfaces
 131  *       - USB endpoints
 132  *
 133  * - USB config 1
 134  *   - USB interfaces
 135  *     - USB alternative interfaces
 136  *       - USB endpoints
 137  */
 138
 139 /* Declaration of USB records */
 140
 141 struct usb_device_request {
 142         uByte   bmRequestType;
 143         uByte   bRequest;
 144         uWord   wValue;
 145         uWord   wIndex;
 146         uWord   wLength;
 147 } __packed;
 148 typedef struct usb_device_request usb_device_request_t;
 149
 150 #define UT_WRITE                0x00
 151 #define UT_READ                 0x80
 152 #define UT_STANDARD             0x00
 153 #define UT_CLASS                0x20
 154 #define UT_VENDOR               0x40
 155 #define UT_DEVICE               0x00
 156 #define UT_INTERFACE            0x01
 157 #define UT_ENDPOINT             0x02
 158 #define UT_OTHER                0x03
 159
 160 #define UT_READ_DEVICE          (UT_READ  | UT_STANDARD | UT_DEVICE)
 161 #define UT_READ_INTERFACE       (UT_READ  | UT_STANDARD | UT_INTERFACE)
 162 #define UT_READ_ENDPOINT        (UT_READ  | UT_STANDARD | UT_ENDPOINT)
 163 #define UT_WRITE_DEVICE         (UT_WRITE | UT_STANDARD | UT_DEVICE)
 164 #define UT_WRITE_INTERFACE      (UT_WRITE | UT_STANDARD | UT_INTERFACE)
 165 #define UT_WRITE_ENDPOINT       (UT_WRITE | UT_STANDARD | UT_ENDPOINT)
 166 #define UT_READ_CLASS_DEVICE    (UT_READ  | UT_CLASS | UT_DEVICE)
 167 #define UT_READ_CLASS_INTERFACE (UT_READ  | UT_CLASS | UT_INTERFACE)
 168 #define UT_READ_CLASS_OTHER     (UT_READ  | UT_CLASS | UT_OTHER)
 169 #define UT_READ_CLASS_ENDPOINT  (UT_READ  | UT_CLASS | UT_ENDPOINT)
 170 #define UT_WRITE_CLASS_DEVICE   (UT_WRITE | UT_CLASS | UT_DEVICE)
 171 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE)
 172 #define UT_WRITE_CLASS_OTHER    (UT_WRITE | UT_CLASS | UT_OTHER)
 173 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT)
 174 #define UT_READ_VENDOR_DEVICE   (UT_READ  | UT_VENDOR | UT_DEVICE)
 175 #define UT_READ_VENDOR_INTERFACE (UT_READ  | UT_VENDOR | UT_INTERFACE)
 176 #define UT_READ_VENDOR_OTHER    (UT_READ  | UT_VENDOR | UT_OTHER)
 177 #define UT_READ_VENDOR_ENDPOINT (UT_READ  | UT_VENDOR | UT_ENDPOINT)
 178 #define UT_WRITE_VENDOR_DEVICE  (UT_WRITE | UT_VENDOR | UT_DEVICE)
 179 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE)
 180 #define UT_WRITE_VENDOR_OTHER   (UT_WRITE | UT_VENDOR | UT_OTHER)
 181 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT)
 182
 183 /* Requests */
 184 #define UR_GET_STATUS           0x00
 185 #define UR_CLEAR_FEATURE        0x01
 186 #define UR_SET_FEATURE          0x03
 187 #define UR_SET_ADDRESS          0x05
 188 #define UR_GET_DESCRIPTOR       0x06
 189 #define UDESC_DEVICE            0x01
 190 #define UDESC_CONFIG            0x02
 191 #define UDESC_STRING            0x03
 192 #define USB_LANGUAGE_TABLE      0x00    /* language ID string index */
 193 #define UDESC_INTERFACE         0x04
 194 #define UDESC_ENDPOINT          0x05
 195 #define UDESC_DEVICE_QUALIFIER  0x06
 196 #define UDESC_OTHER_SPEED_CONFIGURATION 0x07
 197 #define UDESC_INTERFACE_POWER   0x08
 198 #define UDESC_OTG               0x09
 199 #define UDESC_DEBUG             0x0A
 200 #define UDESC_IFACE_ASSOC       0x0B    /* interface association */
 201 #define UDESC_BOS               0x0F    /* binary object store */
 202 #define UDESC_DEVICE_CAPABILITY 0x10
 203 #define UDESC_CS_DEVICE         0x21    /* class specific */
 204 #define UDESC_CS_CONFIG         0x22
 205 #define UDESC_CS_STRING         0x23
 206 #define UDESC_CS_INTERFACE      0x24
 207 #define UDESC_CS_ENDPOINT       0x25
 208 #define UDESC_HUB               0x29
 209 #define UDESC_SS_HUB            0x2A    /* super speed */
 210 #define UDESC_ENDPOINT_SS_COMP  0x30    /* super speed */
 211 #define UR_SET_DESCRIPTOR       0x07
 212 #define UR_GET_CONFIG           0x08
 213 #define UR_SET_CONFIG           0x09
 214 #define UR_GET_INTERFACE        0x0a
 215 #define UR_SET_INTERFACE        0x0b
 216 #define UR_SYNCH_FRAME          0x0c
 217 #define UR_SET_SEL              0x30
 218 #define UR_ISOCH_DELAY          0x31
 219
 220 /* HUB specific request */
 221 #define UR_GET_BUS_STATE        0x02
 222 #define UR_CLEAR_TT_BUFFER      0x08
 223 #define UR_RESET_TT             0x09
 224 #define UR_GET_TT_STATE         0x0a
 225 #define UR_STOP_TT              0x0b
 226 #define UR_SET_AND_TEST         0x0c    /* USB 2.0 only */
 227 #define UR_SET_HUB_DEPTH        0x0c    /* USB 3.0 only */
 228 #define USB_SS_HUB_DEPTH_MAX    5
 229 #define UR_GET_PORT_ERR_COUNT   0x0d
 230
 231 /* Feature numbers */
 232 #define UF_ENDPOINT_HALT        0
 233 #define UF_DEVICE_REMOTE_WAKEUP 1
 234 #define UF_TEST_MODE            2
 235 #define UF_U1_ENABLE            0x30
 236 #define UF_U2_ENABLE            0x31
 237 #define UF_LTM_ENABLE           0x32
 238
 239 /* HUB specific features */
 240 #define UHF_C_HUB_LOCAL_POWER   0
 241 #define UHF_C_HUB_OVER_CURRENT  1
 242 #define UHF_PORT_CONNECTION     0
 243 #define UHF_PORT_ENABLE         1
 244 #define UHF_PORT_SUSPEND        2
 245 #define UHF_PORT_OVER_CURRENT   3
 246 #define UHF_PORT_RESET          4
 247 #define UHF_PORT_LINK_STATE     5
 248 #define UHF_PORT_POWER          8
 249 #define UHF_PORT_LOW_SPEED      9
 250 #define UHF_PORT_L1             10
 251 #define UHF_C_PORT_CONNECTION   16
 252 #define UHF_C_PORT_ENABLE       17
 253 #define UHF_C_PORT_SUSPEND      18
 254 #define UHF_C_PORT_OVER_CURRENT 19
 255 #define UHF_C_PORT_RESET        20
 256 #define UHF_PORT_TEST           21
 257 #define UHF_PORT_INDICATOR      22
 258 #define UHF_C_PORT_L1           23
 259
 260 /* SuperSpeed HUB specific features */
 261 #define UHF_PORT_U1_TIMEOUT     23
 262 #define UHF_PORT_U2_TIMEOUT     24
 263 #define UHF_C_PORT_LINK_STATE   25
 264 #define UHF_C_PORT_CONFIG_ERROR 26
 265 #define UHF_PORT_REMOTE_WAKE_MASK       27
 266 #define UHF_BH_PORT_RESET       28
 267 #define UHF_C_BH_PORT_RESET     29
 268 #define UHF_FORCE_LINKPM_ACCEPT 30
 269
 270 struct usb_descriptor {
 271         uByte   bLength;
 272         uByte   bDescriptorType;
 273         uByte   bDescriptorSubtype;
 274 } __packed;
 275 typedef struct usb_descriptor usb_descriptor_t;
 276
 277 struct usb_device_descriptor {
 278         uByte   bLength;
 279         uByte   bDescriptorType;
 280         uWord   bcdUSB;
 281 #define UD_USB_2_0              0x0200
 282 #define UD_USB_3_0              0x0300
 283 #define UD_IS_USB2(d) ((d)->bcdUSB[1] == 0x02)
 284 #define UD_IS_USB3(d) ((d)->bcdUSB[1] == 0x03)
 285         uByte   bDeviceClass;
 286         uByte   bDeviceSubClass;
 287         uByte   bDeviceProtocol;
 288         uByte   bMaxPacketSize;
 289         /* The fields below are not part of the initial descriptor. */
 290         uWord   idVendor;
 291         uWord   idProduct;
 292         uWord   bcdDevice;
 293         uByte   iManufacturer;
 294         uByte   iProduct;
 295         uByte   iSerialNumber;
 296         uByte   bNumConfigurations;
 297 } __packed;
 298 typedef struct usb_device_descriptor usb_device_descriptor_t;
 299
 300 /* Binary Device Object Store (BOS) */
 301 struct usb_bos_descriptor {
 302         uByte   bLength;
 303         uByte   bDescriptorType;
 304         uWord   wTotalLength;
 305         uByte   bNumDeviceCaps;
 306 } __packed;
 307 typedef struct usb_bos_descriptor usb_bos_descriptor_t;
 308
 309 /* Binary Device Object Store Capability */
 310 struct usb_bos_cap_descriptor {
 311         uByte   bLength;
 312         uByte   bDescriptorType;
 313         uByte   bDevCapabilityType;
 314 #define USB_DEVCAP_RESERVED     0x00
 315 #define USB_DEVCAP_WUSB         0x01
 316 #define USB_DEVCAP_USB2EXT      0x02
 317 #define USB_DEVCAP_SUPER_SPEED  0x03
 318 #define USB_DEVCAP_CONTAINER_ID 0x04
 319         /* data ... */
 320 } __packed;
 321 typedef struct usb_bos_cap_descriptor usb_bos_cap_descriptor_t;
 322
 323 struct usb_devcap_usb2ext_descriptor {
 324         uByte   bLength;
 325         uByte   bDescriptorType;
 326         uByte   bDevCapabilityType;
 327         uDWord  bmAttributes;
 328 #define USB_V2EXT_LPM (1U << 1)
 329 #define USB_V2EXT_BESL_SUPPORTED (1U << 2)
 330 #define USB_V2EXT_BESL_BASELINE_VALID (1U << 3)
 331 #define USB_V2EXT_BESL_DEEP_VALID (1U << 4)
 332 #define USB_V2EXT_BESL_BASELINE_GET(x) (((x) >> 8) & 0xF)
 333 #define USB_V2EXT_BESL_DEEP_GET(x) (((x) >> 12) & 0xF)
 334 } __packed;
 335 typedef struct usb_devcap_usb2ext_descriptor usb_devcap_usb2ext_descriptor_t;
 336
 337 struct usb_devcap_ss_descriptor {
 338         uByte   bLength;
 339         uByte   bDescriptorType;
 340         uByte   bDevCapabilityType;
 341         uByte   bmAttributes;
 342         uWord   wSpeedsSupported;
 343         uByte   bFunctionalitySupport;
 344         uByte   bU1DevExitLat;
 345         uWord   wU2DevExitLat;
 346 } __packed;
 347 typedef struct usb_devcap_ss_descriptor usb_devcap_ss_descriptor_t;
 348
 349 struct usb_devcap_container_id_descriptor {
 350         uByte   bLength;
 351         uByte   bDescriptorType;
 352         uByte   bDevCapabilityType;
 353         uByte   bReserved;
 354         uByte   bContainerID;
 355 } __packed;
 356 typedef struct usb_devcap_container_id_descriptor
 357                 usb_devcap_container_id_descriptor_t;
 358
 359 /* Device class codes */
 360 #define UDCLASS_IN_INTERFACE    0x00
 361 #define UDCLASS_COMM            0x02
 362 #define UDCLASS_HUB             0x09
 363 #define UDSUBCLASS_HUB          0x00
 364 #define UDPROTO_FSHUB           0x00
 365 #define UDPROTO_HSHUBSTT        0x01
 366 #define UDPROTO_HSHUBMTT        0x02
 367 #define UDPROTO_SSHUB           0x03
 368 #define UDCLASS_DIAGNOSTIC      0xdc
 369 #define UDCLASS_WIRELESS        0xe0
 370 #define UDSUBCLASS_RF           0x01
 371 #define UDPROTO_BLUETOOTH       0x01
 372 #define UDCLASS_VENDOR          0xff
 373
 374 struct usb_config_descriptor {
 375         uByte   bLength;
 376         uByte   bDescriptorType;
 377         uWord   wTotalLength;
 378         uByte   bNumInterface;
 379         uByte   bConfigurationValue;
 380 #define USB_UNCONFIG_NO 0
 381         uByte   iConfiguration;
 382         uByte   bmAttributes;
 383 #define UC_BUS_POWERED          0x80
 384 #define UC_SELF_POWERED         0x40
 385 #define UC_REMOTE_WAKEUP        0x20
 386         uByte   bMaxPower;              /* max current in 2 mA units */
 387 #define UC_POWER_FACTOR 2
 388 } __packed;
 389 typedef struct usb_config_descriptor usb_config_descriptor_t;
 390
 391 struct usb_interface_descriptor {
 392         uByte   bLength;
 393         uByte   bDescriptorType;
 394         uByte   bInterfaceNumber;
 395         uByte   bAlternateSetting;
 396         uByte   bNumEndpoints;
 397         uByte   bInterfaceClass;
 398         uByte   bInterfaceSubClass;
 399         uByte   bInterfaceProtocol;
 400         uByte   iInterface;
 401 } __packed;
 402 typedef struct usb_interface_descriptor usb_interface_descriptor_t;
 403
 404 struct usb_interface_assoc_descriptor {
 405         uByte   bLength;
 406         uByte   bDescriptorType;
 407         uByte   bFirstInterface;
 408         uByte   bInterfaceCount;
 409         uByte   bFunctionClass;
 410         uByte   bFunctionSubClass;
 411         uByte   bFunctionProtocol;
 412         uByte   iFunction;
 413 } __packed;
 414 typedef struct usb_interface_assoc_descriptor usb_interface_assoc_descriptor_t;
 415
 416 /* Interface class codes */
 417 #define UICLASS_UNSPEC          0x00
 418 #define UICLASS_AUDIO           0x01    /* audio */
 419 #define UISUBCLASS_AUDIOCONTROL 1
 420 #define UISUBCLASS_AUDIOSTREAM          2
 421 #define UISUBCLASS_MIDISTREAM           3
 422
 423 #define UICLASS_CDC             0x02    /* communication */
 424 #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL    1
 425 #define UISUBCLASS_ABSTRACT_CONTROL_MODEL       2
 426 #define UISUBCLASS_TELEPHONE_CONTROL_MODEL      3
 427 #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL   4
 428 #define UISUBCLASS_CAPI_CONTROLMODEL            5
 429 #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6
 430 #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7
 431 #define UISUBCLASS_WIRELESS_HANDSET_CM 8
 432 #define UISUBCLASS_DEVICE_MGMT 9
 433 #define UISUBCLASS_MOBILE_DIRECT_LINE_MODEL 10
 434 #define UISUBCLASS_OBEX 11
 435 #define UISUBCLASS_ETHERNET_EMULATION_MODEL 12
 436 #define UISUBCLASS_NETWORK_CONTROL_MODEL 13
 437
 438 #define UIPROTO_CDC_AT                  1
 439
 440 #define UICLASS_HID             0x03
 441 #define UISUBCLASS_BOOT         1
 442 #define UIPROTO_BOOT_KEYBOARD   1
 443 #define UIPROTO_MOUSE           2
 444
 445 #define UICLASS_PHYSICAL        0x05
 446 #define UICLASS_IMAGE           0x06
 447 #define UISUBCLASS_SIC          1       /* still image class */
 448 #define UICLASS_PRINTER         0x07
 449 #define UISUBCLASS_PRINTER      1
 450 #define UIPROTO_PRINTER_UNI     1
 451 #define UIPROTO_PRINTER_BI      2
 452 #define UIPROTO_PRINTER_1284    3
 453
 454 #define UICLASS_MASS            0x08
 455 #define UISUBCLASS_RBC          1
 456 #define UISUBCLASS_SFF8020I     2
 457 #define UISUBCLASS_QIC157       3
 458 #define UISUBCLASS_UFI          4
 459 #define UISUBCLASS_SFF8070I     5
 460 #define UISUBCLASS_SCSI         6
 461 #define UIPROTO_MASS_CBI_I      0
 462 #define UIPROTO_MASS_CBI        1
 463 #define UIPROTO_MASS_BBB_OLD    2       /* Not in the spec anymore */
 464 #define UIPROTO_MASS_BBB        80      /* 'P' for the Iomega Zip drive */
 465
 466 #define UICLASS_HUB             0x09
 467 #define UISUBCLASS_HUB          0
 468 #define UIPROTO_FSHUB           0
 469 #define UIPROTO_HSHUBSTT        0       /* Yes, same as previous */
 470 #define UIPROTO_HSHUBMTT        1
 471
 472 #define UICLASS_CDC_DATA        0x0a
 473 #define UISUBCLASS_DATA         0x00
 474 #define UIPROTO_DATA_ISDNBRI            0x30    /* Physical iface */
 475 #define UIPROTO_DATA_HDLC               0x31    /* HDLC */
 476 #define UIPROTO_DATA_TRANSPARENT        0x32    /* Transparent */
 477 #define UIPROTO_DATA_Q921M              0x50    /* Management for Q921 */
 478 #define UIPROTO_DATA_Q921               0x51    /* Data for Q921 */
 479 #define UIPROTO_DATA_Q921TM             0x52    /* TEI multiplexer for Q921 */
 480 #define UIPROTO_DATA_V42BIS             0x90    /* Data compression */
 481 #define UIPROTO_DATA_Q931               0x91    /* Euro-ISDN */
 482 #define UIPROTO_DATA_V120               0x92    /* V.24 rate adaption */
 483 #define UIPROTO_DATA_CAPI               0x93    /* CAPI 2.0 commands */
 484 #define UIPROTO_DATA_HOST_BASED         0xfd    /* Host based driver */
 485 #define UIPROTO_DATA_PUF                0xfe    /* see Prot. Unit Func. Desc. */
 486 #define UIPROTO_DATA_VENDOR             0xff    /* Vendor specific */
 487 #define UIPROTO_DATA_NCM                0x01    /* Network Control Model */
 488
 489 #define UICLASS_SMARTCARD       0x0b
 490 #define UICLASS_FIRM_UPD        0x0c
 491 #define UICLASS_SECURITY        0x0d
 492 #define UICLASS_DIAGNOSTIC      0xdc
 493 #define UICLASS_WIRELESS        0xe0
 494 #define UISUBCLASS_RF                   0x01
 495 #define UIPROTO_BLUETOOTH               0x01
 496
 497 #define UICLASS_IAD             0xEF    /* Interface Association Descriptor */
 498
 499 #define UICLASS_APPL_SPEC       0xfe
 500 #define UISUBCLASS_FIRMWARE_DOWNLOAD    1
 501 #define UISUBCLASS_IRDA                 2
 502 #define UIPROTO_IRDA                    0
 503
 504 #define UICLASS_VENDOR          0xff
 505 #define UISUBCLASS_XBOX360_CONTROLLER   0x5d
 506 #define UIPROTO_XBOX360_GAMEPAD 0x01
 507
 508 struct usb_endpoint_descriptor {
 509         uByte   bLength;
 510         uByte   bDescriptorType;
 511         uByte   bEndpointAddress;
 512 #define UE_GET_DIR(a)   ((a) & 0x80)
 513 #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7))
 514 #define UE_DIR_IN       0x80            /* IN-token endpoint, fixed */
 515 #define UE_DIR_OUT      0x00            /* OUT-token endpoint, fixed */
 516 #define UE_DIR_RX       0xfd            /* for internal use only! */
 517 #define UE_DIR_TX       0xfe            /* for internal use only! */
 518 #define UE_DIR_ANY      0xff            /* for internal use only! */
 519 #define UE_ADDR         0x0f
 520 #define UE_ADDR_ANY     0xff            /* for internal use only! */
 521 #define UE_GET_ADDR(a)  ((a) & UE_ADDR)
 522         uByte   bmAttributes;
 523 #define UE_XFERTYPE     0x03
 524 #define UE_CONTROL      0x00
 525 #define UE_ISOCHRONOUS  0x01
 526 #define UE_BULK 0x02
 527 #define UE_INTERRUPT    0x03
 528 #define UE_BULK_INTR    0xfe            /* for internal use only! */
 529 #define UE_TYPE_ANY     0xff            /* for internal use only! */
 530 #define UE_GET_XFERTYPE(a)      ((a) & UE_XFERTYPE)
 531 #define UE_ISO_TYPE     0x0c
 532 #define UE_ISO_ASYNC    0x04
 533 #define UE_ISO_ADAPT    0x08
 534 #define UE_ISO_SYNC     0x0c
 535 #define UE_GET_ISO_TYPE(a)      ((a) & UE_ISO_TYPE)
 536         uWord   wMaxPacketSize;
 537 #define UE_ZERO_MPS 0xFFFF              /* for internal use only */
 538         uByte   bInterval;
 539 } __packed;
 540 typedef struct usb_endpoint_descriptor usb_endpoint_descriptor_t;
 541
 542 struct usb_endpoint_ss_comp_descriptor {
 543         uByte   bLength;
 544         uByte   bDescriptorType;
 545         uByte   bMaxBurst;
 546         uByte   bmAttributes;
 547         uWord   wBytesPerInterval;
 548 } __packed;
 549 typedef struct usb_endpoint_ss_comp_descriptor
 550                 usb_endpoint_ss_comp_descriptor_t;
 551
 552 struct usb_string_descriptor {
 553         uByte   bLength;
 554         uByte   bDescriptorType;
 555         uWord   bString[126];
 556         uByte   bUnused;
 557 } __packed;
 558 typedef struct usb_string_descriptor usb_string_descriptor_t;
 559
 560 #define USB_MAKE_STRING_DESC(m,name)    \
 561 struct name {                           \
 562   uByte bLength;                        \
 563   uByte bDescriptorType;                \
 564   uByte bData[sizeof((uint8_t []){m})]; \
 565 } __packed;                             \
 566 static const struct name name = {       \
 567   .bLength = sizeof(struct name),       \
 568   .bDescriptorType = UDESC_STRING,      \
 569   .bData = { m },                       \
 570 }
 571
 572 struct usb_hub_descriptor {
 573         uByte   bDescLength;
 574         uByte   bDescriptorType;
 575         uByte   bNbrPorts;
 576         uWord   wHubCharacteristics;
 577 #define UHD_PWR                 0x0003
 578 #define UHD_PWR_GANGED          0x0000
 579 #define UHD_PWR_INDIVIDUAL      0x0001
 580 #define UHD_PWR_NO_SWITCH       0x0002
 581 #define UHD_COMPOUND            0x0004
 582 #define UHD_OC                  0x0018
 583 #define UHD_OC_GLOBAL           0x0000
 584 #define UHD_OC_INDIVIDUAL       0x0008
 585 #define UHD_OC_NONE             0x0010
 586 #define UHD_TT_THINK            0x0060
 587 #define UHD_TT_THINK_8          0x0000
 588 #define UHD_TT_THINK_16         0x0020
 589 #define UHD_TT_THINK_24         0x0040
 590 #define UHD_TT_THINK_32         0x0060
 591 #define UHD_PORT_IND            0x0080
 592         uByte   bPwrOn2PwrGood;         /* delay in 2 ms units */
 593 #define UHD_PWRON_FACTOR 2
 594         uByte   bHubContrCurrent;
 595         uByte   DeviceRemovable[32];    /* max 255 ports */
 596 #define UHD_NOT_REMOV(desc, i) \
 597     (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1)
 598         uByte   PortPowerCtrlMask[1];   /* deprecated */
 599 } __packed;
 600 typedef struct usb_hub_descriptor usb_hub_descriptor_t;
 601
 602 struct usb_hub_ss_descriptor {
 603         uByte   bLength;
 604         uByte   bDescriptorType;
 605         uByte   bNbrPorts;
 606         uWord   wHubCharacteristics;
 607         uByte   bPwrOn2PwrGood;         /* delay in 2 ms units */
 608         uByte   bHubContrCurrent;
 609         uByte   bHubHdrDecLat;
 610         uWord   wHubDelay;
 611         uByte   DeviceRemovable[32];    /* max 255 ports */
 612 } __packed;
 613 typedef struct usb_hub_ss_descriptor usb_hub_ss_descriptor_t;
 614
 615 /* minimum HUB descriptor (8-ports maximum) */
 616 struct usb_hub_descriptor_min {
 617         uByte   bDescLength;
 618         uByte   bDescriptorType;
 619         uByte   bNbrPorts;
 620         uWord   wHubCharacteristics;
 621         uByte   bPwrOn2PwrGood;
 622         uByte   bHubContrCurrent;
 623         uByte   DeviceRemovable[1];
 624         uByte   PortPowerCtrlMask[1];
 625 } __packed;
 626 typedef struct usb_hub_descriptor_min usb_hub_descriptor_min_t;
 627
 628 struct usb_device_qualifier {
 629         uByte   bLength;
 630         uByte   bDescriptorType;
 631         uWord   bcdUSB;
 632         uByte   bDeviceClass;
 633         uByte   bDeviceSubClass;
 634         uByte   bDeviceProtocol;
 635         uByte   bMaxPacketSize0;
 636         uByte   bNumConfigurations;
 637         uByte   bReserved;
 638 } __packed;
 639 typedef struct usb_device_qualifier usb_device_qualifier_t;
 640
 641 struct usb_otg_descriptor {
 642         uByte   bLength;
 643         uByte   bDescriptorType;
 644         uByte   bmAttributes;
 645 #define UOTG_SRP        0x01
 646 #define UOTG_HNP        0x02
 647 } __packed;
 648 typedef struct usb_otg_descriptor usb_otg_descriptor_t;
 649
 650 /* OTG feature selectors */
 651 #define UOTG_B_HNP_ENABLE       3
 652 #define UOTG_A_HNP_SUPPORT      4
 653 #define UOTG_A_ALT_HNP_SUPPORT  5
 654
 655 struct usb_status {
 656         uWord   wStatus;
 657 /* Device status flags */
 658 #define UDS_SELF_POWERED                0x0001
 659 #define UDS_REMOTE_WAKEUP               0x0002
 660 /* Endpoint status flags */
 661 #define UES_HALT                        0x0001
 662 } __packed;
 663 typedef struct usb_status usb_status_t;
 664
 665 struct usb_hub_status {
 666         uWord   wHubStatus;
 667 #define UHS_LOCAL_POWER                 0x0001
 668 #define UHS_OVER_CURRENT                0x0002
 669         uWord   wHubChange;
 670 } __packed;
 671 typedef struct usb_hub_status usb_hub_status_t;
 672
 673 struct usb_port_status {
 674         uWord   wPortStatus;
 675 #define UPS_CURRENT_CONNECT_STATUS      0x0001
 676 #define UPS_PORT_ENABLED                0x0002
 677 #define UPS_SUSPEND                     0x0004
 678 #define UPS_OVERCURRENT_INDICATOR       0x0008
 679 #define UPS_RESET                       0x0010
 680 #define UPS_PORT_L1                     0x0020  /* USB 2.0 only */
 681 /* The link-state bits are valid for Super-Speed USB HUBs */
 682 #define UPS_PORT_LINK_STATE_GET(x)      (((x) >> 5) & 0xF)
 683 #define UPS_PORT_LINK_STATE_SET(x)      (((x) & 0xF) << 5)
 684 #define UPS_PORT_LS_U0          0x00
 685 #define UPS_PORT_LS_U1          0x01
 686 #define UPS_PORT_LS_U2          0x02
 687 #define UPS_PORT_LS_U3          0x03
 688 #define UPS_PORT_LS_SS_DIS      0x04
 689 #define UPS_PORT_LS_RX_DET      0x05
 690 #define UPS_PORT_LS_SS_INA      0x06
 691 #define UPS_PORT_LS_POLL        0x07
 692 #define UPS_PORT_LS_RECOVER     0x08
 693 #define UPS_PORT_LS_HOT_RST     0x09
 694 #define UPS_PORT_LS_COMP_MODE   0x0A
 695 #define UPS_PORT_LS_LOOPBACK    0x0B
 696 #define UPS_PORT_LS_RESUME      0x0F
 697 #define UPS_PORT_POWER                  0x0100
 698 #define UPS_PORT_POWER_SS               0x0200  /* super-speed only */
 699 #define UPS_LOW_SPEED                   0x0200
 700 #define UPS_HIGH_SPEED                  0x0400
 701 #define UPS_OTHER_SPEED                 0x0600  /* currently FreeBSD specific */
 702 #define UPS_PORT_TEST                   0x0800
 703 #define UPS_PORT_INDICATOR              0x1000
 704 #define UPS_PORT_MODE_DEVICE            0x8000  /* currently FreeBSD specific */
 705         uWord   wPortChange;
 706 #define UPS_C_CONNECT_STATUS            0x0001
 707 #define UPS_C_PORT_ENABLED              0x0002
 708 #define UPS_C_SUSPEND                   0x0004
 709 #define UPS_C_OVERCURRENT_INDICATOR     0x0008
 710 #define UPS_C_PORT_RESET                0x0010
 711 #define UPS_C_PORT_L1                   0x0020  /* USB 2.0 only */
 712 #define UPS_C_BH_PORT_RESET             0x0020  /* USB 3.0 only */
 713 #define UPS_C_PORT_LINK_STATE           0x0040
 714 #define UPS_C_PORT_CONFIG_ERROR         0x0080
 715 } __packed;
 716 typedef struct usb_port_status usb_port_status_t;
 717
 718 /*
 719  * The "USB_SPEED" macros defines all the supported USB speeds.
 720  */
 721 enum usb_dev_speed {
 722         USB_SPEED_VARIABLE,
 723         USB_SPEED_LOW,
 724         USB_SPEED_FULL,
 725         USB_SPEED_HIGH,
 726         USB_SPEED_SUPER,
 727 };
 728 #define USB_SPEED_MAX   (USB_SPEED_SUPER+1)
 729
 730 /*
 731  * The "USB_REV" macros defines all the supported USB revisions.
 732  */
 733 enum usb_revision {
 734         USB_REV_UNKNOWN,
 735         USB_REV_PRE_1_0,
 736         USB_REV_1_0,
 737         USB_REV_1_1,
 738         USB_REV_2_0,
 739         USB_REV_2_5,
 740         USB_REV_3_0
 741 };
 742 #define USB_REV_MAX     (USB_REV_3_0+1)
 743
 744 /*
 745  * Supported host contoller modes.
 746  */
 747 enum usb_hc_mode {
 748         USB_MODE_HOST,          /* initiates transfers */
 749         USB_MODE_DEVICE,        /* bus transfer target */
 750         USB_MODE_DUAL           /* can be host or device */
 751 };
 752 #define USB_MODE_MAX    (USB_MODE_DUAL+1)
 753
 754 /*
 755  * The "USB_MODE" macros defines all the supported device states.
 756  */
 757 enum usb_dev_state {
 758         USB_STATE_DETACHED,
 759         USB_STATE_ATTACHED,
 760         USB_STATE_POWERED,
 761         USB_STATE_ADDRESSED,
 762         USB_STATE_CONFIGURED,
 763 };
 764 #define USB_STATE_MAX   (USB_STATE_CONFIGURED+1)
 765 #endif                                  /* _USB_STANDARD_H_ */