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