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