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