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