usb.h revision 1.82.12.1
1 /* $NetBSD: usb.h,v 1.82.12.1 2013/11/05 18:36:31 matt 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_GET_DIR(a) ((a) & 0x80) 99 #define UT_WRITE 0x00 100 #define UT_READ 0x80 101 102 #define UT_GET_TYPE(a) ((a) & 0x60) 103 #define UT_STANDARD 0x00 104 #define UT_CLASS 0x20 105 #define UT_VENDOR 0x40 106 107 #define UT_GET_RECIPIENT(a) ((a) & 0x1f) 108 #define UT_DEVICE 0x00 109 #define UT_INTERFACE 0x01 110 #define UT_ENDPOINT 0x02 111 #define UT_OTHER 0x03 112 113 #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE) 114 #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE) 115 #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT) 116 #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE) 117 #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE) 118 #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT) 119 #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE) 120 #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE) 121 #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER) 122 #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT) 123 #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE) 124 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE) 125 #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER) 126 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT) 127 #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE) 128 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE) 129 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER) 130 #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT) 131 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE) 132 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE) 133 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER) 134 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT) 135 136 /* Requests */ 137 #define UR_GET_STATUS 0x00 138 #define UR_CLEAR_FEATURE 0x01 139 #define UR_SET_FEATURE 0x03 140 #define UR_SET_ADDRESS 0x05 141 #define UR_GET_DESCRIPTOR 0x06 142 #define UDESC_DEVICE 0x01 143 #define UDESC_CONFIG 0x02 144 #define UDESC_STRING 0x03 145 #define UDESC_INTERFACE 0x04 146 #define UDESC_ENDPOINT 0x05 147 #define UDESC_DEVICE_QUALIFIER 0x06 148 #define UDESC_OTHER_SPEED_CONFIGURATION 0x07 149 #define UDESC_INTERFACE_POWER 0x08 150 #define UDESC_OTG 0x09 151 #define UDESC_CS_DEVICE 0x21 /* class specific */ 152 #define UDESC_CS_CONFIG 0x22 153 #define UDESC_CS_STRING 0x23 154 #define UDESC_CS_INTERFACE 0x24 155 #define UDESC_CS_ENDPOINT 0x25 156 #define UDESC_HUB 0x29 157 #define UDESC_SSHUB 0x2a 158 #define UR_SET_DESCRIPTOR 0x07 159 #define UR_GET_CONFIG 0x08 160 #define UR_SET_CONFIG 0x09 161 #define UR_GET_INTERFACE 0x0a 162 #define UR_SET_INTERFACE 0x0b 163 #define UR_SYNCH_FRAME 0x0c 164 165 /* Feature numbers */ 166 #define UF_ENDPOINT_HALT 0 167 #define UF_DEVICE_REMOTE_WAKEUP 1 168 #define UF_TEST_MODE 2 169 170 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */ 171 172 #define USB_2_MAX_CTRL_PACKET 64 173 #define USB_2_MAX_BULK_PACKET 512 174 175 #define USB_3_MAX_CTRL_PACKET 512 176 177 typedef struct { 178 uByte bLength; 179 uByte bDescriptorType; 180 } UPACKED usb_descriptor_t; 181 182 typedef struct { 183 uByte bLength; 184 uByte bDescriptorType; 185 uWord bcdUSB; 186 #define UD_USB_2_0 0x0200 187 #define UD_IS_USB2(d) (UGETW((d)->bcdUSB) >= UD_USB_2_0) 188 uByte bDeviceClass; 189 uByte bDeviceSubClass; 190 uByte bDeviceProtocol; 191 uByte bMaxPacketSize; 192 /* The fields below are not part of the initial descriptor. */ 193 uWord idVendor; 194 uWord idProduct; 195 uWord bcdDevice; 196 uByte iManufacturer; 197 uByte iProduct; 198 uByte iSerialNumber; 199 uByte bNumConfigurations; 200 } UPACKED usb_device_descriptor_t; 201 #define USB_DEVICE_DESCRIPTOR_SIZE 18 202 203 typedef struct { 204 uByte bLength; 205 uByte bDescriptorType; 206 uWord wTotalLength; 207 uByte bNumInterface; 208 uByte bConfigurationValue; 209 uByte iConfiguration; 210 uByte bmAttributes; 211 #define UC_ATTR_MBO 0x80 212 #define UC_SELF_POWERED 0x40 213 #define UC_REMOTE_WAKEUP 0x20 214 uByte bMaxPower; /* max current in 2 mA units */ 215 #define UC_POWER_FACTOR 2 216 } UPACKED usb_config_descriptor_t; 217 #define USB_CONFIG_DESCRIPTOR_SIZE 9 218 219 typedef struct { 220 uByte bLength; 221 uByte bDescriptorType; 222 uByte bInterfaceNumber; 223 uByte bAlternateSetting; 224 uByte bNumEndpoints; 225 uByte bInterfaceClass; 226 uByte bInterfaceSubClass; 227 uByte bInterfaceProtocol; 228 uByte iInterface; 229 } UPACKED usb_interface_descriptor_t; 230 #define USB_INTERFACE_DESCRIPTOR_SIZE 9 231 232 typedef struct { 233 uByte bLength; 234 uByte bDescriptorType; 235 uByte bEndpointAddress; 236 #define UE_GET_DIR(a) ((a) & 0x80) 237 #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7)) 238 #define UE_DIR_IN 0x80 239 #define UE_DIR_OUT 0x00 240 #define UE_ADDR 0x0f 241 #define UE_GET_ADDR(a) ((a) & UE_ADDR) 242 uByte bmAttributes; 243 #define UE_XFERTYPE 0x03 244 #define UE_CONTROL 0x00 245 #define UE_ISOCHRONOUS 0x01 246 #define UE_BULK 0x02 247 #define UE_INTERRUPT 0x03 248 #define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE) 249 #define UE_ISO_TYPE 0x0c 250 #define UE_ISO_ASYNC 0x04 251 #define UE_ISO_ADAPT 0x08 252 #define UE_ISO_SYNC 0x0c 253 #define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE) 254 uWord wMaxPacketSize; 255 #define UE_GET_TRANS(a) (((a) >> 11) & 0x3) 256 #define UE_GET_SIZE(a) ((a) & 0x7ff) 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[126]; 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 #define USB_MAX_ENCODED_STRING_LEN (USB_MAX_STRING_LEN * 3) /* UTF8 */ 269 270 /* Hub specific request */ 271 #define UR_GET_BUS_STATE 0x02 272 #define UR_CLEAR_TT_BUFFER 0x08 273 #define UR_RESET_TT 0x09 274 #define UR_GET_TT_STATE 0x0a 275 #define UR_STOP_TT 0x0b 276 277 /* Hub features */ 278 #define UHF_C_HUB_LOCAL_POWER 0 279 #define UHF_C_HUB_OVER_CURRENT 1 280 #define UHF_PORT_CONNECTION 0 281 #define UHF_PORT_ENABLE 1 282 #define UHF_PORT_SUSPEND 2 283 #define UHF_PORT_OVER_CURRENT 3 284 #define UHF_PORT_RESET 4 285 #define UHF_PORT_POWER 8 286 #define UHF_PORT_LOW_SPEED 9 287 #define UHF_C_PORT_CONNECTION 16 288 #define UHF_C_PORT_ENABLE 17 289 #define UHF_C_PORT_SUSPEND 18 290 #define UHF_C_PORT_OVER_CURRENT 19 291 #define UHF_C_PORT_RESET 20 292 #define UHF_PORT_TEST 21 293 #define UHF_PORT_INDICATOR 22 294 295 typedef struct { 296 uByte bDescLength; 297 uByte bDescriptorType; 298 uByte bNbrPorts; 299 uWord wHubCharacteristics; 300 #define UHD_PWR 0x0003 301 #define UHD_PWR_GANGED 0x0000 302 #define UHD_PWR_INDIVIDUAL 0x0001 303 #define UHD_PWR_NO_SWITCH 0x0002 304 #define UHD_COMPOUND 0x0004 305 #define UHD_OC 0x0018 306 #define UHD_OC_GLOBAL 0x0000 307 #define UHD_OC_INDIVIDUAL 0x0008 308 #define UHD_OC_NONE 0x0010 309 #define UHD_TT_THINK 0x0060 310 #define UHD_TT_THINK_8 0x0000 311 #define UHD_TT_THINK_16 0x0020 312 #define UHD_TT_THINK_24 0x0040 313 #define UHD_TT_THINK_32 0x0060 314 #define UHD_PORT_IND 0x0080 315 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 316 #define UHD_PWRON_FACTOR 2 317 uByte bHubContrCurrent; 318 uByte DeviceRemovable[32]; /* max 255 ports */ 319 #define UHD_NOT_REMOV(desc, i) \ 320 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) 321 /* deprecated */ uByte PortPowerCtrlMask[1]; 322 } UPACKED usb_hub_descriptor_t; 323 #define USB_HUB_DESCRIPTOR_SIZE 9 /* includes deprecated PortPowerCtrlMask */ 324 325 typedef struct { 326 uByte bLength; 327 uByte bDescriptorType; 328 uWord bcdUSB; 329 uByte bDeviceClass; 330 uByte bDeviceSubClass; 331 uByte bDeviceProtocol; 332 uByte bMaxPacketSize0; 333 uByte bNumConfigurations; 334 uByte bReserved; 335 } UPACKED usb_device_qualifier_t; 336 #define USB_DEVICE_QUALIFIER_SIZE 10 337 338 typedef struct { 339 uByte bLength; 340 uByte bDescriptorType; 341 uByte bmAttributes; 342 #define UOTG_SRP 0x01 343 #define UOTG_HNP 0x02 344 } UPACKED usb_otg_descriptor_t; 345 346 /* OTG feature selectors */ 347 #define UOTG_B_HNP_ENABLE 3 348 #define UOTG_A_HNP_SUPPORT 4 349 #define UOTG_A_ALT_HNP_SUPPORT 5 350 351 typedef struct { 352 uWord wStatus; 353 /* Device status flags */ 354 #define UDS_SELF_POWERED 0x0001 355 #define UDS_REMOTE_WAKEUP 0x0002 356 /* Endpoint status flags */ 357 #define UES_HALT 0x0001 358 } UPACKED usb_status_t; 359 360 typedef struct { 361 uWord wHubStatus; 362 #define UHS_LOCAL_POWER 0x0001 363 #define UHS_OVER_CURRENT 0x0002 364 uWord wHubChange; 365 } UPACKED usb_hub_status_t; 366 367 typedef struct { 368 uWord wPortStatus; 369 #define UPS_CURRENT_CONNECT_STATUS 0x0001 370 #define UPS_PORT_ENABLED 0x0002 371 #define UPS_SUSPEND 0x0004 372 #define UPS_OVERCURRENT_INDICATOR 0x0008 373 #define UPS_RESET 0x0010 374 #define UPS_PORT_POWER 0x0100 375 #define UPS_FULL_SPEED 0x0000 /* for completeness */ 376 #define UPS_LOW_SPEED 0x0200 377 #define UPS_HIGH_SPEED 0x0400 378 #define UPS_PORT_TEST 0x0800 379 #define UPS_PORT_INDICATOR 0x1000 380 uWord wPortChange; 381 #define UPS_C_CONNECT_STATUS 0x0001 382 #define UPS_C_PORT_ENABLED 0x0002 383 #define UPS_C_SUSPEND 0x0004 384 #define UPS_C_OVERCURRENT_INDICATOR 0x0008 385 #define UPS_C_PORT_RESET 0x0010 386 } UPACKED usb_port_status_t; 387 388 /* Device class codes */ 389 #define UDCLASS_IN_INTERFACE 0x00 390 #define UDCLASS_COMM 0x02 391 #define UDCLASS_HUB 0x09 392 #define UDSUBCLASS_HUB 0x00 393 #define UDPROTO_FSHUB 0x00 394 #define UDPROTO_HSHUBSTT 0x01 395 #define UDPROTO_HSHUBMTT 0x02 396 #define UDPROTO_SSHUB 0x03 397 #define UDCLASS_DIAGNOSTIC 0xdc 398 #define UDCLASS_WIRELESS 0xe0 399 #define UDSUBCLASS_RF 0x01 400 #define UDPROTO_BLUETOOTH 0x01 401 #define UDCLASS_VENDOR 0xff 402 403 /* Interface class codes */ 404 #define UICLASS_UNSPEC 0x00 405 406 #define UICLASS_AUDIO 0x01 407 #define UISUBCLASS_AUDIOCONTROL 1 408 #define UISUBCLASS_AUDIOSTREAM 2 409 #define UISUBCLASS_MIDISTREAM 3 410 411 #define UICLASS_VIDEO 0x0E 412 #define UISUBCLASS_VIDEOCONTROL 1 413 #define UISUBCLASS_VIDEOSTREAMING 2 414 #define UISUBCLASS_VIDEOCOLLECTION 3 415 416 #define UICLASS_CDC 0x02 /* communication */ 417 #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1 418 #define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2 419 #define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3 420 #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4 421 #define UISUBCLASS_CAPI_CONTROLMODEL 5 422 #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6 423 #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7 424 #define UIPROTO_CDC_AT 1 425 426 #define UICLASS_HID 0x03 427 #define UISUBCLASS_BOOT 1 428 #define UIPROTO_BOOT_KEYBOARD 1 429 430 #define UICLASS_PHYSICAL 0x05 431 432 #define UICLASS_IMAGE 0x06 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_SMARTCARD 0x0b 475 476 /*#define UICLASS_FIRM_UPD 0x0c*/ 477 478 #define UICLASS_SECURITY 0x0d 479 480 #define UICLASS_DIAGNOSTIC 0xdc 481 482 #define UICLASS_WIRELESS 0xe0 483 #define UISUBCLASS_RF 0x01 484 #define UIPROTO_BLUETOOTH 0x01 485 486 #define UICLASS_APPL_SPEC 0xfe 487 #define UISUBCLASS_FIRMWARE_DOWNLOAD 1 488 #define UISUBCLASS_IRDA 2 489 #define UIPROTO_IRDA 0 490 491 #define UICLASS_VENDOR 0xff 492 493 494 #define USB_HUB_MAX_DEPTH 5 495 496 /* 497 * Minimum time a device needs to be powered down to go through 498 * a power cycle. XXX Are these time in the spec? 499 */ 500 #define USB_POWER_DOWN_TIME 200 /* ms */ 501 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 502 503 #if 0 504 /* These are the values from the spec. */ 505 #define USB_PORT_RESET_DELAY 10 /* ms */ 506 #define USB_PORT_ROOT_RESET_DELAY 50 /* ms */ 507 #define USB_PORT_RESET_RECOVERY 10 /* ms */ 508 #define USB_PORT_POWERUP_DELAY 100 /* ms */ 509 #define USB_SET_ADDRESS_SETTLE 2 /* ms */ 510 #define USB_RESUME_DELAY (20*5) /* ms */ 511 #define USB_RESUME_WAIT 10 /* ms */ 512 #define USB_RESUME_RECOVERY 10 /* ms */ 513 #define USB_EXTRA_POWER_UP_TIME 0 /* ms */ 514 #else 515 /* Allow for marginal (i.e. non-conforming) devices. */ 516 #define USB_PORT_RESET_DELAY 50 /* ms */ 517 #define USB_PORT_ROOT_RESET_DELAY 250 /* ms */ 518 #define USB_PORT_RESET_RECOVERY 250 /* ms */ 519 #define USB_PORT_POWERUP_DELAY 300 /* ms */ 520 #define USB_SET_ADDRESS_SETTLE 10 /* ms */ 521 #define USB_RESUME_DELAY (50*5) /* ms */ 522 #define USB_RESUME_WAIT 50 /* ms */ 523 #define USB_RESUME_RECOVERY 50 /* ms */ 524 #define USB_EXTRA_POWER_UP_TIME 20 /* ms */ 525 #endif 526 527 #define USB_MIN_POWER 100 /* mA */ 528 #define USB_MAX_POWER 500 /* mA */ 529 530 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ 531 532 533 #define USB_UNCONFIG_NO 0 534 #define USB_UNCONFIG_INDEX (-1) 535 536 /*** ioctl() related stuff ***/ 537 538 struct usb_ctl_request { 539 int ucr_addr; 540 usb_device_request_t ucr_request; 541 void *ucr_data; 542 int ucr_flags; 543 #define USBD_SHORT_XFER_OK 0x04 /* allow short reads */ 544 int ucr_actlen; /* actual length transferred */ 545 }; 546 547 struct usb_alt_interface { 548 int uai_config_index; 549 int uai_interface_index; 550 int uai_alt_no; 551 }; 552 553 #define USB_CURRENT_CONFIG_INDEX (-1) 554 #define USB_CURRENT_ALT_INDEX (-1) 555 556 struct usb_config_desc { 557 int ucd_config_index; 558 usb_config_descriptor_t ucd_desc; 559 }; 560 561 struct usb_interface_desc { 562 int uid_config_index; 563 int uid_interface_index; 564 int uid_alt_index; 565 usb_interface_descriptor_t uid_desc; 566 }; 567 568 struct usb_endpoint_desc { 569 int ued_config_index; 570 int ued_interface_index; 571 int ued_alt_index; 572 int ued_endpoint_index; 573 usb_endpoint_descriptor_t ued_desc; 574 }; 575 576 struct usb_full_desc { 577 int ufd_config_index; 578 u_int ufd_size; 579 u_char *ufd_data; 580 }; 581 582 struct usb_string_desc { 583 int usd_string_index; 584 int usd_language_id; 585 usb_string_descriptor_t usd_desc; 586 }; 587 588 struct usb_ctl_report_desc { 589 int ucrd_size; 590 u_char ucrd_data[1024]; /* filled data size will vary */ 591 }; 592 593 typedef struct { u_int32_t cookie; } usb_event_cookie_t; 594 595 #define USB_MAX_DEVNAMES 4 596 #define USB_MAX_DEVNAMELEN 16 597 struct usb_device_info { 598 u_int8_t udi_bus; 599 u_int8_t udi_addr; /* device address */ 600 usb_event_cookie_t udi_cookie; 601 char udi_product[USB_MAX_ENCODED_STRING_LEN]; 602 char udi_vendor[USB_MAX_ENCODED_STRING_LEN]; 603 char udi_release[8]; 604 char udi_serial[USB_MAX_ENCODED_STRING_LEN]; 605 u_int16_t udi_productNo; 606 u_int16_t udi_vendorNo; 607 u_int16_t udi_releaseNo; 608 u_int8_t udi_class; 609 u_int8_t udi_subclass; 610 u_int8_t udi_protocol; 611 u_int8_t udi_config; 612 u_int8_t udi_speed; 613 #define USB_SPEED_LOW 1 614 #define USB_SPEED_FULL 2 615 #define USB_SPEED_HIGH 3 616 #define USB_SPEED_SUPER 4 617 int udi_power; /* power consumption in mA, 0 if selfpowered */ 618 int udi_nports; 619 char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN]; 620 u_int8_t udi_ports[16];/* hub only: addresses of devices on ports */ 621 #define USB_PORT_ENABLED 0xff 622 #define USB_PORT_SUSPENDED 0xfe 623 #define USB_PORT_POWERED 0xfd 624 #define USB_PORT_DISABLED 0xfc 625 }; 626 627 /* <=3.0 had this layout of the structure */ 628 struct usb_device_info_old { 629 u_int8_t udi_bus; 630 u_int8_t udi_addr; /* device address */ 631 usb_event_cookie_t udi_cookie; 632 char udi_product[USB_MAX_STRING_LEN]; 633 char udi_vendor[USB_MAX_STRING_LEN]; 634 char udi_release[8]; 635 u_int16_t udi_productNo; 636 u_int16_t udi_vendorNo; 637 u_int16_t udi_releaseNo; 638 u_int8_t udi_class; 639 u_int8_t udi_subclass; 640 u_int8_t udi_protocol; 641 u_int8_t udi_config; 642 u_int8_t udi_speed; 643 int udi_power; /* power consumption in mA, 0 if selfpowered */ 644 int udi_nports; 645 char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN]; 646 u_int8_t udi_ports[16];/* hub only: addresses of devices on ports */ 647 }; 648 649 struct usb_ctl_report { 650 int ucr_report; 651 u_char ucr_data[1024]; /* filled data size will vary */ 652 }; 653 654 struct usb_device_stats { 655 u_long uds_requests[4]; /* indexed by transfer type UE_* */ 656 }; 657 658 struct usb_bulk_ra_wb_opt { 659 u_int ra_wb_buffer_size; 660 u_int ra_wb_request_size; 661 }; 662 663 /* Events that can be read from /dev/usb */ 664 struct usb_event { 665 int ue_type; 666 #define USB_EVENT_CTRLR_ATTACH 1 667 #define USB_EVENT_CTRLR_DETACH 2 668 #define USB_EVENT_DEVICE_ATTACH 3 669 #define USB_EVENT_DEVICE_DETACH 4 670 #define USB_EVENT_DRIVER_ATTACH 5 671 #define USB_EVENT_DRIVER_DETACH 6 672 #define USB_EVENT_IS_ATTACH(n) ((n) == USB_EVENT_CTRLR_ATTACH || (n) == USB_EVENT_DEVICE_ATTACH || (n) == USB_EVENT_DRIVER_ATTACH) 673 #define USB_EVENT_IS_DETACH(n) ((n) == USB_EVENT_CTRLR_DETACH || (n) == USB_EVENT_DEVICE_DETACH || (n) == USB_EVENT_DRIVER_DETACH) 674 struct timespec ue_time; 675 union { 676 struct { 677 int ue_bus; 678 } ue_ctrlr; 679 struct usb_device_info ue_device; 680 struct { 681 usb_event_cookie_t ue_cookie; 682 char ue_devname[16]; 683 } ue_driver; 684 } u; 685 }; 686 687 /* old <=3.0 compat event */ 688 struct usb_event_old { 689 int ue_type; 690 struct timespec ue_time; 691 union { 692 struct { 693 int ue_bus; 694 } ue_ctrlr; 695 struct usb_device_info_old ue_device; 696 struct { 697 usb_event_cookie_t ue_cookie; 698 char ue_devname[16]; 699 } ue_driver; 700 } u; 701 }; 702 703 704 /* USB controller */ 705 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 706 #define USB_SETDEBUG _IOW ('U', 2, int) 707 #define USB_DISCOVER _IO ('U', 3) 708 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 709 #define USB_DEVICEINFO_OLD _IOWR('U', 4, struct usb_device_info_old) 710 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 711 712 /* Generic HID device */ 713 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) 714 #define USB_SET_IMMED _IOW ('U', 22, int) 715 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) 716 #define USB_SET_REPORT _IOW ('U', 24, struct usb_ctl_report) 717 #define USB_GET_REPORT_ID _IOR ('U', 25, int) 718 719 /* Generic USB device */ 720 #define USB_GET_CONFIG _IOR ('U', 100, int) 721 #define USB_SET_CONFIG _IOW ('U', 101, int) 722 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 723 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 724 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) 725 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) 726 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) 727 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) 728 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) 729 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) 730 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc) 731 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 732 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 733 #define USB_GET_DEVICEINFO_OLD _IOR ('U', 112, struct usb_device_info_old) 734 #define USB_SET_SHORT_XFER _IOW ('U', 113, int) 735 #define USB_SET_TIMEOUT _IOW ('U', 114, int) 736 #define USB_SET_BULK_RA _IOW ('U', 115, int) 737 #define USB_SET_BULK_WB _IOW ('U', 116, int) 738 #define USB_SET_BULK_RA_OPT _IOW ('U', 117, struct usb_bulk_ra_wb_opt) 739 #define USB_SET_BULK_WB_OPT _IOW ('U', 118, struct usb_bulk_ra_wb_opt) 740 741 /* Modem device */ 742 #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int) 743 #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int) 744 745 #endif /* _USB_H_ */ 746
Indexes created Tue Sep 30 11:09:46 GMT 2025