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