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