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