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