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