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