sys/bus/usb/usb.h

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