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