sys/bus/usb/usb.h

   1 /*      $NetBSD: usb.h,v 1.69 2002/09/22 23:20:50 augustss Exp $        */
   2 /*      $FreeBSD: src/sys/dev/usb/usb.h,v 1.39.2.1 2006/01/20 22:47:49 mux Exp $    */
   3 /*      $DragonFly: src/sys/bus/usb/usb.h,v 1.6 2007/06/27 12:27:59 hasso Exp $ */
   4
   5 /*
   6  * Copyright (c) 1998 The NetBSD Foundation, Inc.
   7  * All rights reserved.
   8  *
   9  * This code is derived from software contributed to The NetBSD Foundation
  10  * by Lennart Augustsson (lennart@augustsson.net) at
  11  * Carlstedt Research & Technology.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. All advertising materials mentioning features or use of this software
  22  *    must display the following acknowledgement:
  23  *        This product includes software developed by the NetBSD
  24  *        Foundation, Inc. and its contributors.
  25  * 4. Neither the name of The NetBSD Foundation nor the names of its
  26  *    contributors may be used to endorse or promote products derived
  27  *    from this software without specific prior written permission.
  28  *
  29  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  30  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  31  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  32  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  33  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  34  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  35  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  36  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  37  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  39  * POSSIBILITY OF SUCH DAMAGE.
  40  */
  41
  42
  43 #ifndef _USB_H_
  44 #define _USB_H_
  45
  46 #include <sys/types.h>
  47 #include <sys/time.h>
  48
  49 #if defined(_KERNEL)
  50 #include <bus/usb/usb_port.h>
  51 #endif /* _KERNEL */
  52
  53 /* These two defines are used by usbd to autoload the usb kld */
  54 #define USB_KLD         "usb"           /* name of usb module */
  55 #define USB_UHUB        "usb/uhub"      /* root hub */
  56
  57 #define USB_STACK_VERSION 2
  58
  59 #define USB_MAX_DEVICES 128
  60 #define USB_START_ADDR 0
  61
  62 #define USB_CONTROL_ENDPOINT 0
  63 #define USB_MAX_ENDPOINTS 16
  64
  65 #define USB_FRAMES_PER_SECOND 1000
  66
  67 /*
  68  * The USB records contain some unaligned little-endian word
  69  * components.  The U[SG]ETW macros take care of both the alignment
  70  * and endian problem and should always be used to access non-byte
  71  * values.
  72  */
  73 typedef u_int8_t uByte;
  74 typedef u_int8_t uWord[2];
  75 typedef u_int8_t uDWord[4];
  76
  77 #define USETW2(w,h,l) ((w)[0] = (u_int8_t)(l), (w)[1] = (u_int8_t)(h))
  78
  79 #if 1
  80 #define UGETW(w) ((w)[0] | ((w)[1] << 8))
  81 #define USETW(w,v) ((w)[0] = (u_int8_t)(v), (w)[1] = (u_int8_t)((v) >> 8))
  82 #define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24))
  83 #define USETDW(w,v) ((w)[0] = (u_int8_t)(v), \
  84                      (w)[1] = (u_int8_t)((v) >> 8), \
  85                      (w)[2] = (u_int8_t)((v) >> 16), \
  86                      (w)[3] = (u_int8_t)((v) >> 24))
  87 #else
  88 /*
  89  * On little-endian machines that can handle unanliged accesses
  90  * (e.g. i386) these macros can be replaced by the following.
  91  */
  92 #define UGETW(w) (*(u_int16_t *)(w))
  93 #define USETW(w,v) (*(u_int16_t *)(w) = (v))
  94 #define UGETDW(w) (*(u_int32_t *)(w))
  95 #define USETDW(w,v) (*(u_int32_t *)(w) = (v))
  96 #endif
  97
  98 #define UPACKED __packed
  99
 100 typedef struct {
 101         uByte           bmRequestType;
 102         uByte           bRequest;
 103         uWord           wValue;
 104         uWord           wIndex;
 105         uWord           wLength;
 106 } UPACKED usb_device_request_t;
 107
 108 #define UT_WRITE                0x00
 109 #define UT_READ                 0x80
 110 #define UT_STANDARD             0x00
 111 #define UT_CLASS                0x20
 112 #define UT_VENDOR               0x40
 113 #define UT_DEVICE               0x00
 114 #define UT_INTERFACE            0x01
 115 #define UT_ENDPOINT             0x02
 116 #define UT_OTHER                0x03
 117
 118 #define UT_READ_DEVICE          (UT_READ  | UT_STANDARD | UT_DEVICE)
 119 #define UT_READ_INTERFACE       (UT_READ  | UT_STANDARD | UT_INTERFACE)
 120 #define UT_READ_ENDPOINT        (UT_READ  | UT_STANDARD | UT_ENDPOINT)
 121 #define UT_WRITE_DEVICE         (UT_WRITE | UT_STANDARD | UT_DEVICE)
 122 #define UT_WRITE_INTERFACE      (UT_WRITE | UT_STANDARD | UT_INTERFACE)
 123 #define UT_WRITE_ENDPOINT       (UT_WRITE | UT_STANDARD | UT_ENDPOINT)
 124 #define UT_READ_CLASS_DEVICE    (UT_READ  | UT_CLASS | UT_DEVICE)
 125 #define UT_READ_CLASS_INTERFACE (UT_READ  | UT_CLASS | UT_INTERFACE)
 126 #define UT_READ_CLASS_OTHER     (UT_READ  | UT_CLASS | UT_OTHER)
 127 #define UT_READ_CLASS_ENDPOINT  (UT_READ  | UT_CLASS | UT_ENDPOINT)
 128 #define UT_WRITE_CLASS_DEVICE   (UT_WRITE | UT_CLASS | UT_DEVICE)
 129 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE)
 130 #define UT_WRITE_CLASS_OTHER    (UT_WRITE | UT_CLASS | UT_OTHER)
 131 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT)
 132 #define UT_READ_VENDOR_DEVICE   (UT_READ  | UT_VENDOR | UT_DEVICE)
 133 #define UT_READ_VENDOR_INTERFACE (UT_READ  | UT_VENDOR | UT_INTERFACE)
 134 #define UT_READ_VENDOR_OTHER    (UT_READ  | UT_VENDOR | UT_OTHER)
 135 #define UT_READ_VENDOR_ENDPOINT (UT_READ  | UT_VENDOR | UT_ENDPOINT)
 136 #define UT_WRITE_VENDOR_DEVICE  (UT_WRITE | UT_VENDOR | UT_DEVICE)
 137 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE)
 138 #define UT_WRITE_VENDOR_OTHER   (UT_WRITE | UT_VENDOR | UT_OTHER)
 139 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT)
 140
 141 /* Requests */
 142 #define UR_GET_STATUS           0x00
 143 #define UR_CLEAR_FEATURE        0x01
 144 #define UR_SET_FEATURE          0x03
 145 #define UR_SET_ADDRESS          0x05
 146 #define UR_GET_DESCRIPTOR       0x06
 147 #define  UDESC_DEVICE           0x01
 148 #define  UDESC_CONFIG           0x02
 149 #define  UDESC_STRING           0x03
 150 #define  UDESC_INTERFACE        0x04
 151 #define  UDESC_ENDPOINT         0x05
 152 #define  UDESC_DEVICE_QUALIFIER 0x06
 153 #define  UDESC_OTHER_SPEED_CONFIGURATION 0x07
 154 #define  UDESC_INTERFACE_POWER  0x08
 155 #define  UDESC_OTG              0x09
 156 #define  UDESC_CS_DEVICE        0x21    /* class specific */
 157 #define  UDESC_CS_CONFIG        0x22
 158 #define  UDESC_CS_STRING        0x23
 159 #define  UDESC_CS_INTERFACE     0x24
 160 #define  UDESC_CS_ENDPOINT      0x25
 161 #define  UDESC_HUB              0x29
 162 #define UR_SET_DESCRIPTOR       0x07
 163 #define UR_GET_CONFIG           0x08
 164 #define UR_SET_CONFIG           0x09
 165 #define UR_GET_INTERFACE        0x0a
 166 #define UR_SET_INTERFACE        0x0b
 167 #define UR_SYNCH_FRAME          0x0c
 168
 169 /* Feature numbers */
 170 #define UF_ENDPOINT_HALT        0
 171 #define UF_DEVICE_REMOTE_WAKEUP 1
 172 #define UF_TEST_MODE            2
 173
 174 #define USB_MAX_IPACKET         8 /* maximum size of the initial packet */
 175
 176 #define USB_2_MAX_CTRL_PACKET   64
 177 #define USB_2_MAX_BULK_PACKET   512
 178
 179 typedef struct {
 180         uByte           bLength;
 181         uByte           bDescriptorType;
 182         uByte           bDescriptorSubtype;
 183 } UPACKED usb_descriptor_t;
 184
 185 typedef struct {
 186         uByte           bLength;
 187         uByte           bDescriptorType;
 188         uWord           bcdUSB;
 189 #define UD_USB_2_0              0x0200
 190 #define UD_IS_USB2(d) (UGETW((d)->bcdUSB) >= UD_USB_2_0)
 191         uByte           bDeviceClass;
 192         uByte           bDeviceSubClass;
 193         uByte           bDeviceProtocol;
 194         uByte           bMaxPacketSize;
 195         /* The fields below are not part of the initial descriptor. */
 196         uWord           idVendor;
 197         uWord           idProduct;
 198         uWord           bcdDevice;
 199         uByte           iManufacturer;
 200         uByte           iProduct;
 201         uByte           iSerialNumber;
 202         uByte           bNumConfigurations;
 203 } UPACKED usb_device_descriptor_t;
 204 #define USB_DEVICE_DESCRIPTOR_SIZE 18
 205
 206 typedef struct {
 207         uByte           bLength;
 208         uByte           bDescriptorType;
 209         uWord           wTotalLength;
 210         uByte           bNumInterface;
 211         uByte           bConfigurationValue;
 212         uByte           iConfiguration;
 213         uByte           bmAttributes;
 214 #define UC_BUS_POWERED          0x80
 215 #define UC_SELF_POWERED         0x40
 216 #define UC_REMOTE_WAKEUP        0x20
 217         uByte           bMaxPower; /* max current in 2 mA units */
 218 #define UC_POWER_FACTOR 2
 219 } UPACKED usb_config_descriptor_t;
 220 #define USB_CONFIG_DESCRIPTOR_SIZE 9
 221
 222 typedef struct {
 223         uByte           bLength;
 224         uByte           bDescriptorType;
 225         uByte           bInterfaceNumber;
 226         uByte           bAlternateSetting;
 227         uByte           bNumEndpoints;
 228         uByte           bInterfaceClass;
 229         uByte           bInterfaceSubClass;
 230         uByte           bInterfaceProtocol;
 231         uByte           iInterface;
 232 } UPACKED usb_interface_descriptor_t;
 233 #define USB_INTERFACE_DESCRIPTOR_SIZE 9
 234
 235 typedef struct {
 236         uByte           bLength;
 237         uByte           bDescriptorType;
 238         uByte           bEndpointAddress;
 239 #define UE_GET_DIR(a)   ((a) & 0x80)
 240 #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7))
 241 #define UE_DIR_IN       0x80
 242 #define UE_DIR_OUT      0x00
 243 #define UE_ADDR         0x0f
 244 #define UE_GET_ADDR(a)  ((a) & UE_ADDR)
 245         uByte           bmAttributes;
 246 #define UE_XFERTYPE     0x03
 247 #define  UE_CONTROL     0x00
 248 #define  UE_ISOCHRONOUS 0x01
 249 #define  UE_BULK        0x02
 250 #define  UE_INTERRUPT   0x03
 251 #define UE_GET_XFERTYPE(a)      ((a) & UE_XFERTYPE)
 252 #define UE_ISO_TYPE     0x0c
 253 #define  UE_ISO_ASYNC   0x04
 254 #define  UE_ISO_ADAPT   0x08
 255 #define  UE_ISO_SYNC    0x0c
 256 #define UE_GET_ISO_TYPE(a)      ((a) & UE_ISO_TYPE)
 257         uWord           wMaxPacketSize;
 258         uByte           bInterval;
 259 } UPACKED usb_endpoint_descriptor_t;
 260 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7
 261
 262 typedef struct {
 263         uByte           bLength;
 264         uByte           bDescriptorType;
 265         uWord           bString[127];
 266 } UPACKED usb_string_descriptor_t;
 267 #define USB_MAX_STRING_LEN 128
 268 #define USB_LANGUAGE_TABLE 0    /* # of the string language id table */
 269
 270 /* Hub specific request */
 271 #define UR_GET_BUS_STATE        0x02
 272 #define UR_CLEAR_TT_BUFFER      0x08
 273 #define UR_RESET_TT             0x09
 274 #define UR_GET_TT_STATE         0x0a
 275 #define UR_STOP_TT              0x0b
 276
 277 /* Hub features */
 278 #define UHF_C_HUB_LOCAL_POWER   0
 279 #define UHF_C_HUB_OVER_CURRENT  1
 280 #define UHF_PORT_CONNECTION     0
 281 #define UHF_PORT_ENABLE         1
 282 #define UHF_PORT_SUSPEND        2
 283 #define UHF_PORT_OVER_CURRENT   3
 284 #define UHF_PORT_RESET          4
 285 #define UHF_PORT_POWER          8
 286 #define UHF_PORT_LOW_SPEED      9
 287 #define UHF_C_PORT_CONNECTION   16
 288 #define UHF_C_PORT_ENABLE       17
 289 #define UHF_C_PORT_SUSPEND      18
 290 #define UHF_C_PORT_OVER_CURRENT 19
 291 #define UHF_C_PORT_RESET        20
 292 #define UHF_PORT_TEST           21
 293 #define UHF_PORT_INDICATOR      22
 294
 295 typedef struct {
 296         uByte           bDescLength;
 297         uByte           bDescriptorType;
 298         uByte           bNbrPorts;
 299         uWord           wHubCharacteristics;
 300 #define UHD_PWR                 0x0003
 301 #define  UHD_PWR_GANGED         0x0000
 302 #define  UHD_PWR_INDIVIDUAL     0x0001
 303 #define  UHD_PWR_NO_SWITCH      0x0002
 304 #define UHD_COMPOUND            0x0004
 305 #define UHD_OC                  0x0018
 306 #define  UHD_OC_GLOBAL          0x0000
 307 #define  UHD_OC_INDIVIDUAL      0x0008
 308 #define  UHD_OC_NONE            0x0010
 309 #define UHD_TT_THINK            0x0060
 310 #define  UHD_TT_THINK_8         0x0000
 311 #define  UHD_TT_THINK_16        0x0020
 312 #define  UHD_TT_THINK_24        0x0040
 313 #define  UHD_TT_THINK_32        0x0060
 314 #define UHD_PORT_IND            0x0080
 315         uByte           bPwrOn2PwrGood; /* delay in 2 ms units */
 316 #define UHD_PWRON_FACTOR 2
 317         uByte           bHubContrCurrent;
 318         uByte           DeviceRemovable[32]; /* max 255 ports */
 319 #define UHD_NOT_REMOV(desc, i) \
 320     (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1)
 321         /* deprecated */ uByte          PortPowerCtrlMask[1];
 322 } UPACKED usb_hub_descriptor_t;
 323 #define USB_HUB_DESCRIPTOR_SIZE 9 /* includes deprecated PortPowerCtrlMask */
 324
 325 typedef struct {
 326         uByte           bLength;
 327         uByte           bDescriptorType;
 328         uWord           bcdUSB;
 329         uByte           bDeviceClass;
 330         uByte           bDeviceSubClass;
 331         uByte           bDeviceProtocol;
 332         uByte           bMaxPacketSize0;
 333         uByte           bNumConfigurations;
 334         uByte           bReserved;
 335 } UPACKED usb_device_qualifier_t;
 336 #define USB_DEVICE_QUALIFIER_SIZE 10
 337
 338 typedef struct {
 339         uByte           bLength;
 340         uByte           bDescriptorType;
 341         uByte           bmAttributes;
 342 #define UOTG_SRP        0x01
 343 #define UOTG_HNP        0x02
 344 } UPACKED usb_otg_descriptor_t;
 345
 346 /* OTG feature selectors */
 347 #define UOTG_B_HNP_ENABLE       3
 348 #define UOTG_A_HNP_SUPPORT      4
 349 #define UOTG_A_ALT_HNP_SUPPORT  5
 350
 351 typedef struct {
 352         uWord           wStatus;
 353 /* Device status flags */
 354 #define UDS_SELF_POWERED                0x0001
 355 #define UDS_REMOTE_WAKEUP               0x0002
 356 /* Endpoint status flags */
 357 #define UES_HALT                        0x0001
 358 } UPACKED usb_status_t;
 359
 360 typedef struct {
 361         uWord           wHubStatus;
 362 #define UHS_LOCAL_POWER                 0x0001
 363 #define UHS_OVER_CURRENT                0x0002
 364         uWord           wHubChange;
 365 } UPACKED usb_hub_status_t;
 366
 367 typedef struct {
 368         uWord           wPortStatus;
 369 #define UPS_CURRENT_CONNECT_STATUS      0x0001
 370 #define UPS_PORT_ENABLED                0x0002
 371 #define UPS_SUSPEND                     0x0004
 372 #define UPS_OVERCURRENT_INDICATOR       0x0008
 373 #define UPS_RESET                       0x0010
 374 #define UPS_PORT_POWER                  0x0100
 375 #define UPS_LOW_SPEED                   0x0200
 376 #define UPS_HIGH_SPEED                  0x0400
 377 #define UPS_PORT_TEST                   0x0800
 378 #define UPS_PORT_INDICATOR              0x1000
 379         uWord           wPortChange;
 380 #define UPS_C_CONNECT_STATUS            0x0001
 381 #define UPS_C_PORT_ENABLED              0x0002
 382 #define UPS_C_SUSPEND                   0x0004
 383 #define UPS_C_OVERCURRENT_INDICATOR     0x0008
 384 #define UPS_C_PORT_RESET                0x0010
 385 } UPACKED usb_port_status_t;
 386
 387 /* Device class codes */
 388 #define UDCLASS_IN_INTERFACE    0x00
 389 #define UDCLASS_COMM            0x02
 390 #define UDCLASS_HUB             0x09
 391 #define  UDSUBCLASS_HUB         0x00
 392 #define  UDPROTO_FSHUB          0x00
 393 #define  UDPROTO_HSHUBSTT       0x01
 394 #define  UDPROTO_HSHUBMTT       0x02
 395 #define UDCLASS_DIAGNOSTIC      0xdc
 396 #define UDCLASS_WIRELESS        0xe0
 397 #define  UDSUBCLASS_RF          0x01
 398 #define   UDPROTO_BLUETOOTH     0x01
 399 #define UDCLASS_VENDOR          0xff
 400
 401 /* Interface class codes */
 402 #define UICLASS_UNSPEC          0x00
 403
 404 #define UICLASS_AUDIO           0x01
 405 #define  UISUBCLASS_AUDIOCONTROL        1
 406 #define  UISUBCLASS_AUDIOSTREAM         2
 407 #define  UISUBCLASS_MIDISTREAM          3
 408
 409 #define UICLASS_CDC             0x02 /* communication */
 410 #define  UISUBCLASS_DIRECT_LINE_CONTROL_MODEL   1
 411 #define  UISUBCLASS_ABSTRACT_CONTROL_MODEL      2
 412 #define  UISUBCLASS_TELEPHONE_CONTROL_MODEL     3
 413 #define  UISUBCLASS_MULTICHANNEL_CONTROL_MODEL  4
 414 #define  UISUBCLASS_CAPI_CONTROLMODEL           5
 415 #define  UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6
 416 #define  UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7
 417 #define   UIPROTO_CDC_AT                        1
 418
 419 #define UICLASS_HID             0x03
 420 #define  UISUBCLASS_BOOT        1
 421 #define  UIPROTO_BOOT_KEYBOARD  1
 422
 423 #define UICLASS_PHYSICAL        0x05
 424
 425 #define UICLASS_IMAGE           0x06
 426
 427 #define UICLASS_PRINTER         0x07
 428 #define  UISUBCLASS_PRINTER     1
 429 #define  UIPROTO_PRINTER_UNI    1
 430 #define  UIPROTO_PRINTER_BI     2
 431 #define  UIPROTO_PRINTER_1284   3
 432
 433 #define UICLASS_MASS            0x08
 434 #define  UISUBCLASS_RBC         1
 435 #define  UISUBCLASS_SFF8020I    2
 436 #define  UISUBCLASS_QIC157      3
 437 #define  UISUBCLASS_UFI         4
 438 #define  UISUBCLASS_SFF8070I    5
 439 #define  UISUBCLASS_SCSI        6
 440 #define  UIPROTO_MASS_CBI_I     0
 441 #define  UIPROTO_MASS_CBI       1
 442 #define  UIPROTO_MASS_BBB_OLD   2       /* Not in the spec anymore */
 443 #define  UIPROTO_MASS_BBB       80      /* 'P' for the Iomega Zip drive */
 444
 445 #define UICLASS_HUB             0x09
 446 #define  UISUBCLASS_HUB         0
 447 #define  UIPROTO_FSHUB          0
 448 #define  UIPROTO_HSHUBSTT       0 /* Yes, same as previous */
 449 #define  UIPROTO_HSHUBMTT       1
 450
 451 #define UICLASS_CDC_DATA        0x0a
 452 #define  UISUBCLASS_DATA                0
 453 #define   UIPROTO_DATA_ISDNBRI          0x30    /* Physical iface */
 454 #define   UIPROTO_DATA_HDLC             0x31    /* HDLC */
 455 #define   UIPROTO_DATA_TRANSPARENT      0x32    /* Transparent */
 456 #define   UIPROTO_DATA_Q921M            0x50    /* Management for Q921 */
 457 #define   UIPROTO_DATA_Q921             0x51    /* Data for Q921 */
 458 #define   UIPROTO_DATA_Q921TM           0x52    /* TEI multiplexer for Q921 */
 459 #define   UIPROTO_DATA_V42BIS           0x90    /* Data compression */
 460 #define   UIPROTO_DATA_Q931             0x91    /* Euro-ISDN */
 461 #define   UIPROTO_DATA_V120             0x92    /* V.24 rate adaption */
 462 #define   UIPROTO_DATA_CAPI             0x93    /* CAPI 2.0 commands */
 463 #define   UIPROTO_DATA_HOST_BASED       0xfd    /* Host based driver */
 464 #define   UIPROTO_DATA_PUF              0xfe    /* see Prot. Unit Func. Desc.*/
 465 #define   UIPROTO_DATA_VENDOR           0xff    /* Vendor specific */
 466
 467 #define UICLASS_SMARTCARD       0x0b
 468
 469 /*#define UICLASS_FIRM_UPD      0x0c*/
 470
 471 #define UICLASS_SECURITY        0x0d
 472
 473 #define UICLASS_DIAGNOSTIC      0xdc
 474
 475 #define UICLASS_WIRELESS        0xe0
 476 #define  UISUBCLASS_RF                  0x01
 477 #define   UIPROTO_BLUETOOTH             0x01
 478
 479 #define UICLASS_APPL_SPEC       0xfe
 480 #define  UISUBCLASS_FIRMWARE_DOWNLOAD   1
 481 #define  UISUBCLASS_IRDA                2
 482 #define  UIPROTO_IRDA                   0
 483
 484 #define UICLASS_VENDOR          0xff
 485 #define  UISUBCLASS_XBOX360_CONTROLLER  0x5d
 486 #define  UIPROTO_XBOX360_GAMEPAD        0x01
 487
 488
 489 #define USB_HUB_MAX_DEPTH 5
 490
 491 /*
 492  * Minimum time a device needs to be powered down to go through
 493  * a power cycle.  XXX Are these time in the spec?
 494  */
 495 #define USB_POWER_DOWN_TIME     200 /* ms */
 496 #define USB_PORT_POWER_DOWN_TIME        100 /* ms */
 497
 498 #if 0
 499 /* These are the values from the spec. */
 500 #define USB_PORT_RESET_DELAY    10  /* ms */
 501 #define USB_PORT_ROOT_RESET_DELAY 50  /* ms */
 502 #define USB_PORT_RESET_RECOVERY 10  /* ms */
 503 #define USB_PORT_POWERUP_DELAY  100 /* ms */
 504 #define USB_SET_ADDRESS_SETTLE  2   /* ms */
 505 #define USB_RESUME_DELAY        (20*5)  /* ms */
 506 #define USB_RESUME_WAIT         10  /* ms */
 507 #define USB_RESUME_RECOVERY     10  /* ms */
 508 #define USB_EXTRA_POWER_UP_TIME 0   /* ms */
 509 #else
 510 /* Allow for marginal (i.e. non-conforming) devices. */
 511 #define USB_PORT_RESET_DELAY    50  /* ms */
 512 #define USB_PORT_ROOT_RESET_DELAY 250  /* ms */
 513 #define USB_PORT_RESET_RECOVERY 250  /* ms */
 514 #define USB_PORT_POWERUP_DELAY  300 /* ms */
 515 #define USB_SET_ADDRESS_SETTLE  10  /* ms */
 516 #define USB_RESUME_DELAY        (50*5)  /* ms */
 517 #define USB_RESUME_WAIT         50  /* ms */
 518 #define USB_RESUME_RECOVERY     50  /* ms */
 519 #define USB_EXTRA_POWER_UP_TIME 20  /* ms */
 520 #endif
 521
 522 #define USB_MIN_POWER           100 /* mA */
 523 #define USB_MAX_POWER           500 /* mA */
 524
 525 #define USB_BUS_RESET_DELAY     100 /* ms XXX?*/
 526
 527
 528 #define USB_UNCONFIG_NO 0
 529 #define USB_UNCONFIG_INDEX (-1)
 530
 531 /*** ioctl() related stuff ***/
 532
 533 struct usb_ctl_request {
 534         int     ucr_addr;
 535         usb_device_request_t ucr_request;
 536         void    *ucr_data;
 537         int     ucr_flags;
 538 #define USBD_SHORT_XFER_OK      0x04    /* allow short reads */
 539         int     ucr_actlen;             /* actual length transferred */
 540 };
 541
 542 struct usb_alt_interface {
 543         int     uai_config_index;
 544         int     uai_interface_index;
 545         int     uai_alt_no;
 546 };
 547
 548 #define USB_CURRENT_CONFIG_INDEX (-1)
 549 #define USB_CURRENT_ALT_INDEX (-1)
 550
 551 struct usb_config_desc {
 552         int     ucd_config_index;
 553         usb_config_descriptor_t ucd_desc;
 554 };
 555
 556 struct usb_interface_desc {
 557         int     uid_config_index;
 558         int     uid_interface_index;
 559         int     uid_alt_index;
 560         usb_interface_descriptor_t uid_desc;
 561 };
 562
 563 struct usb_endpoint_desc {
 564         int     ued_config_index;
 565         int     ued_interface_index;
 566         int     ued_alt_index;
 567         int     ued_endpoint_index;
 568         usb_endpoint_descriptor_t ued_desc;
 569 };
 570
 571 struct usb_full_desc {
 572         int     ufd_config_index;
 573         u_int   ufd_size;
 574         u_char  *ufd_data;
 575 };
 576
 577 struct usb_string_desc {
 578         int     usd_string_index;
 579         int     usd_language_id;
 580         usb_string_descriptor_t usd_desc;
 581 };
 582
 583 struct usb_ctl_report_desc {
 584         int     ucrd_size;
 585         u_char  ucrd_data[1024];        /* filled data size will vary */
 586 };
 587
 588 typedef struct { u_int32_t cookie; } usb_event_cookie_t;
 589
 590 #define USB_MAX_DEVNAMES 4
 591 #define USB_MAX_DEVNAMELEN 16
 592 struct usb_device_info {
 593         u_int8_t        udi_bus;
 594         u_int8_t        udi_addr;       /* device address */
 595         usb_event_cookie_t udi_cookie;
 596         char            udi_product[USB_MAX_STRING_LEN];
 597         char            udi_vendor[USB_MAX_STRING_LEN];
 598         char            udi_release[8];
 599         u_int16_t       udi_productNo;
 600         u_int16_t       udi_vendorNo;
 601         u_int16_t       udi_releaseNo;
 602         u_int8_t        udi_class;
 603         u_int8_t        udi_subclass;
 604         u_int8_t        udi_protocol;
 605         u_int8_t        udi_config;
 606         u_int8_t        udi_speed;
 607 #define USB_SPEED_LOW  1
 608 #define USB_SPEED_FULL 2
 609 #define USB_SPEED_HIGH 3
 610         int             udi_power;      /* power consumption in mA, 0 if selfpowered */
 611         int             udi_nports;
 612         char            udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN];
 613         u_int8_t        udi_ports[16];/* hub only: addresses of devices on ports */
 614 #define USB_PORT_ENABLED 0xff
 615 #define USB_PORT_SUSPENDED 0xfe
 616 #define USB_PORT_POWERED 0xfd
 617 #define USB_PORT_DISABLED 0xfc
 618 };
 619
 620 struct usb_ctl_report {
 621         int     ucr_report;
 622         u_char  ucr_data[1024]; /* filled data size will vary */
 623 };
 624
 625 struct usb_device_stats {
 626         u_long  uds_requests[4];        /* indexed by transfer type UE_* */
 627 };
 628
 629 /* Events that can be read from /dev/usb */
 630 struct usb_event {
 631         int                     ue_type;
 632 #define USB_EVENT_CTRLR_ATTACH 1
 633 #define USB_EVENT_CTRLR_DETACH 2
 634 #define USB_EVENT_DEVICE_ATTACH 3
 635 #define USB_EVENT_DEVICE_DETACH 4
 636 #define USB_EVENT_DRIVER_ATTACH 5
 637 #define USB_EVENT_DRIVER_DETACH 6
 638 #define USB_EVENT_IS_ATTACH(n) ((n) == USB_EVENT_CTRLR_ATTACH || (n) == USB_EVENT_DEVICE_ATTACH || (n) == USB_EVENT_DRIVER_ATTACH)
 639 #define USB_EVENT_IS_DETACH(n) ((n) == USB_EVENT_CTRLR_DETACH || (n) == USB_EVENT_DEVICE_DETACH || (n) == USB_EVENT_DRIVER_DETACH)
 640         struct timespec         ue_time;
 641         union {
 642                 struct {
 643                         int                     ue_bus;
 644                 } ue_ctrlr;
 645                 struct usb_device_info          ue_device;
 646                 struct {
 647                         usb_event_cookie_t      ue_cookie;
 648                         char                    ue_devname[16];
 649                 } ue_driver;
 650         } u;
 651 };
 652
 653 /* USB controller */
 654 #define USB_REQUEST             _IOWR('U', 1, struct usb_ctl_request)
 655 #define USB_SETDEBUG            _IOW ('U', 2, int)
 656 #define USB_DISCOVER            _IO  ('U', 3)
 657 #define USB_DEVICEINFO          _IOWR('U', 4, struct usb_device_info)
 658 #define USB_DEVICESTATS         _IOR ('U', 5, struct usb_device_stats)
 659
 660 /* Generic HID device */
 661 #define USB_GET_REPORT_DESC     _IOR ('U', 21, struct usb_ctl_report_desc)
 662 #define USB_SET_IMMED           _IOW ('U', 22, int)
 663 #define USB_GET_REPORT          _IOWR('U', 23, struct usb_ctl_report)
 664 #define USB_SET_REPORT          _IOW ('U', 24, struct usb_ctl_report)
 665 #define USB_GET_REPORT_ID       _IOR ('U', 25, int)
 666
 667 /* Generic USB device */
 668 #define USB_GET_CONFIG          _IOR ('U', 100, int)
 669 #define USB_SET_CONFIG          _IOW ('U', 101, int)
 670 #define USB_GET_ALTINTERFACE    _IOWR('U', 102, struct usb_alt_interface)
 671 #define USB_SET_ALTINTERFACE    _IOWR('U', 103, struct usb_alt_interface)
 672 #define USB_GET_NO_ALT          _IOWR('U', 104, struct usb_alt_interface)
 673 #define USB_GET_DEVICE_DESC     _IOR ('U', 105, usb_device_descriptor_t)
 674 #define USB_GET_CONFIG_DESC     _IOWR('U', 106, struct usb_config_desc)
 675 #define USB_GET_INTERFACE_DESC  _IOWR('U', 107, struct usb_interface_desc)
 676 #define USB_GET_ENDPOINT_DESC   _IOWR('U', 108, struct usb_endpoint_desc)
 677 #define USB_GET_FULL_DESC       _IOWR('U', 109, struct usb_full_desc)
 678 #define USB_GET_STRING_DESC     _IOWR('U', 110, struct usb_string_desc)
 679 #define USB_DO_REQUEST          _IOWR('U', 111, struct usb_ctl_request)
 680 #define USB_GET_DEVICEINFO      _IOR ('U', 112, struct usb_device_info)
 681 #define USB_SET_SHORT_XFER      _IOW ('U', 113, int)
 682 #define USB_SET_TIMEOUT         _IOW ('U', 114, int)
 683
 684 /* Modem device */
 685 #define USB_GET_CM_OVER_DATA    _IOR ('U', 130, int)
 686 #define USB_SET_CM_OVER_DATA    _IOW ('U', 131, int)
 687
 688 #endif /* _USB_H_ */