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