1 /* $OpenBSD: usb.h,v 1.48 2014/11/01 14:04:27 mpi Exp $ */ 2 /* $NetBSD: usb.h,v 1.69 2002/09/22 23:20:50 augustss Exp $ */ 3 /* $FreeBSD: src/sys/dev/usb/usb.h,v 1.14 1999/11/17 22:33:46 n_hibma Exp $ */ 4 5 /* 6 * Copyright (c) 1998 The NetBSD Foundation, Inc. 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to The NetBSD Foundation 10 * by Lennart Augustsson (lennart@augustsson.net) at 11 * Carlstedt Research & Technology. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 36 #ifndef _USB_H_ 37 #define _USB_H_ 38 39 #include <sys/types.h> 40 #include <sys/time.h> 41 42 #include <sys/ioctl.h> 43 44 #define USB_STACK_VERSION 2 45 46 #define USB_MAX_DEVICES 128 47 #define USB_START_ADDR 0 48 49 #define USB_CONTROL_ENDPOINT 0 50 #define USB_MAX_ENDPOINTS 16 51 52 #define USB_FRAMES_PER_SECOND 1000 53 54 /* 55 * The USB records contain some unaligned little-endian word 56 * components. The U[SG]ETW macros take care of both the alignment 57 * and endian problem and should always be used to access non-byte 58 * values. 59 */ 60 typedef u_int8_t uByte; 61 typedef u_int8_t uWord[2]; 62 typedef u_int8_t uDWord[4]; 63 64 #define USETW2(w,h,l) ((w)[0] = (u_int8_t)(l), (w)[1] = (u_int8_t)(h)) 65 66 #if defined(__STRICT_ALIGNMENT) || _BYTE_ORDER != _LITTLE_ENDIAN 67 #define UGETW(w) ((w)[0] | ((w)[1] << 8)) 68 #define USETW(w,v) ((w)[0] = (u_int8_t)(v), (w)[1] = (u_int8_t)((v) >> 8)) 69 #define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24)) 70 #define USETDW(w,v) ((w)[0] = (u_int8_t)(v), \ 71 (w)[1] = (u_int8_t)((v) >> 8), \ 72 (w)[2] = (u_int8_t)((v) >> 16), \ 73 (w)[3] = (u_int8_t)((v) >> 24)) 74 #else 75 /* 76 * On little-endian machines that can handle unaligned accesses 77 * (e.g. i386) these macros can be replaced by the following. 78 */ 79 #define UGETW(w) (*(u_int16_t *)(w)) 80 #define USETW(w,v) (*(u_int16_t *)(w) = (v)) 81 #define UGETDW(w) (*(u_int32_t *)(w)) 82 #define USETDW(w,v) (*(u_int32_t *)(w) = (v)) 83 #endif 84 85 typedef struct { 86 uByte bmRequestType; 87 uByte bRequest; 88 uWord wValue; 89 uWord wIndex; 90 uWord wLength; 91 } __packed usb_device_request_t; 92 93 #define UT_WRITE 0x00 94 #define UT_READ 0x80 95 #define UT_STANDARD 0x00 96 #define UT_CLASS 0x20 97 #define UT_VENDOR 0x40 98 #define UT_DEVICE 0x00 99 #define UT_INTERFACE 0x01 100 #define UT_ENDPOINT 0x02 101 #define UT_OTHER 0x03 102 103 #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE) 104 #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE) 105 #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT) 106 #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE) 107 #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE) 108 #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT) 109 #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE) 110 #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE) 111 #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER) 112 #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT) 113 #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE) 114 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE) 115 #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER) 116 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT) 117 #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE) 118 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE) 119 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER) 120 #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT) 121 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE) 122 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE) 123 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER) 124 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT) 125 126 /* Requests */ 127 #define UR_GET_STATUS 0x00 128 #define UR_CLEAR_FEATURE 0x01 129 #define UR_SET_FEATURE 0x03 130 #define UR_SET_ADDRESS 0x05 131 #define UR_GET_DESCRIPTOR 0x06 132 #define UDESC_DEVICE 0x01 133 #define UDESC_CONFIG 0x02 134 #define UDESC_STRING 0x03 135 #define UDESC_INTERFACE 0x04 136 #define UDESC_ENDPOINT 0x05 137 #define UDESC_DEVICE_QUALIFIER 0x06 138 #define UDESC_OTHER_SPEED_CONFIGURATION 0x07 139 #define UDESC_INTERFACE_POWER 0x08 140 #define UDESC_OTG 0x09 141 #define UDESC_DEBUG 0x0A 142 #define UDESC_IFACE_ASSOC 0x0B /* interface association */ 143 #define UDESC_BOS 0x0F /* binary object store */ 144 #define UDESC_DEVICE_CAPABILITY 0x10 145 #define UDESC_CS_DEVICE 0x21 /* class specific */ 146 #define UDESC_CS_CONFIG 0x22 147 #define UDESC_CS_STRING 0x23 148 #define UDESC_CS_INTERFACE 0x24 149 #define UDESC_CS_ENDPOINT 0x25 150 #define UDESC_HUB 0x29 151 #define UDESC_SS_HUB 0x2A /* super speed */ 152 #define UDESC_ENDPOINT_SS_COMP 0x30 /* super speed */ 153 #define UR_SET_DESCRIPTOR 0x07 154 #define UR_GET_CONFIG 0x08 155 #define UR_SET_CONFIG 0x09 156 #define UR_GET_INTERFACE 0x0a 157 #define UR_SET_INTERFACE 0x0b 158 #define UR_SYNCH_FRAME 0x0c 159 160 /* Feature numbers */ 161 #define UF_ENDPOINT_HALT 0 162 #define UF_DEVICE_REMOTE_WAKEUP 1 163 #define UF_TEST_MODE 2 164 165 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */ 166 167 #define USB_2_MAX_CTRL_PACKET 64 168 #define USB_2_MAX_BULK_PACKET 512 169 170 typedef struct { 171 uByte bLength; 172 uByte bDescriptorType; 173 uByte bDescriptorSubtype; 174 } __packed usb_descriptor_t; 175 176 typedef struct { 177 uByte bLength; 178 uByte bDescriptorType; 179 uWord bcdUSB; 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 } __packed 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_BUS_POWERED 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 } __packed 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 } __packed 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 #define UE_GET_TRANS(a) (((a) >> 11) & 0x3) 248 #define UE_GET_SIZE(a) ((a) & 0x7ff) 249 uByte bInterval; 250 } __packed usb_endpoint_descriptor_t; 251 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7 252 253 typedef struct { 254 uByte bLength; 255 uByte bDescriptorType; 256 uByte bMaxBurst; 257 uByte bmAttributes; 258 uWord wBytesPerInterval; 259 } __packed usb_endpoint_ss_comp_descriptor_t; 260 #define USB_ENDPOINT_SS_COMP_DESCRIPTOR_SIZE 6 261 262 /* 263 * Note: The length of the USB string descriptor is stored in a one byte 264 * value and can therefore be no longer than 255 bytes. Two bytes are 265 * used for the length itself and the descriptor type, a theoretical maximum 266 * of 253 bytes is left for the actual string data. Since the strings are 267 * encoded as 2-byte unicode characters, only 252 bytes or 126 two-byte 268 * characters can be used. USB_MAX_STRING_LEN is defined as 127, leaving 269 * space for the terminal '\0' character in C strings. 270 */ 271 typedef struct { 272 uByte bLength; 273 uByte bDescriptorType; 274 uWord bString[126]; 275 } __packed usb_string_descriptor_t; 276 #define USB_MAX_STRING_LEN 127 277 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */ 278 279 /* Hub specific request */ 280 #define UR_GET_BUS_STATE 0x02 281 #define UR_CLEAR_TT_BUFFER 0x08 282 #define UR_RESET_TT 0x09 283 #define UR_GET_TT_STATE 0x0a 284 #define UR_STOP_TT 0x0b 285 286 /* Hub features */ 287 #define UHF_C_HUB_LOCAL_POWER 0 288 #define UHF_C_HUB_OVER_CURRENT 1 289 290 /* Port feature */ 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 #define UHF_C_PORT_L1 23 306 #define UHF_PORT_DISOWN_TO_1_1 30 307 308 /* Super-Speed Port feature */ 309 #define UHF_PORT_U1_TIMEOUT 23 310 #define UHF_PORT_U2_TIMEOUT 24 311 #define UHF_C_PORT_LINK_STATE 25 312 #define UHF_C_PORT_CONFIG_ERROR 26 313 #define UHF_PORT_REMOTE_WAKE_MASK 27 314 #define UHF_BH_PORT_RESET 28 315 #define UHF_C_BH_PORT_RESET 29 316 #define UHF_FORCE_LINKPM_ACCEPT 30 317 318 319 typedef struct { 320 uByte bDescLength; 321 uByte bDescriptorType; 322 uByte bNbrPorts; 323 uWord wHubCharacteristics; 324 #define UHD_PWR 0x0003 325 #define UHD_PWR_GANGED 0x0000 326 #define UHD_PWR_INDIVIDUAL 0x0001 327 #define UHD_PWR_NO_SWITCH 0x0002 328 #define UHD_COMPOUND 0x0004 329 #define UHD_OC 0x0018 330 #define UHD_OC_GLOBAL 0x0000 331 #define UHD_OC_INDIVIDUAL 0x0008 332 #define UHD_OC_NONE 0x0010 333 #define UHD_TT_THINK 0x0060 334 #define UHD_TT_THINK_8 0x0000 335 #define UHD_TT_THINK_16 0x0020 336 #define UHD_TT_THINK_24 0x0040 337 #define UHD_TT_THINK_32 0x0060 338 #define UHD_PORT_IND 0x0080 339 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 340 #define UHD_PWRON_FACTOR 2 341 uByte bHubContrCurrent; 342 uByte DeviceRemovable[32]; /* max 255 ports */ 343 #define UHD_NOT_REMOV(desc, i) \ 344 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) 345 } __packed usb_hub_descriptor_t; 346 #define USB_HUB_DESCRIPTOR_SIZE 8 347 348 typedef struct { 349 uByte bDescLength; 350 uByte bDescriptorType; 351 uByte bNbrPorts; 352 uWord wHubCharacteristics; 353 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 354 uByte bHubContrCurrent; 355 uByte bHubHdrDecLat; 356 uWord wHubDelay; 357 uByte DeviceRemovable[32]; /* max 255 ports */ 358 } __packed usb_hub_ss_descriptor_t; 359 #define USB_HUB_SS_DESCRIPTOR_SIZE 11 360 361 typedef struct { 362 uByte bLength; 363 uByte bDescriptorType; 364 uWord bcdUSB; 365 uByte bDeviceClass; 366 uByte bDeviceSubClass; 367 uByte bDeviceProtocol; 368 uByte bMaxPacketSize0; 369 uByte bNumConfigurations; 370 uByte bReserved; 371 } __packed usb_device_qualifier_t; 372 #define USB_DEVICE_QUALIFIER_SIZE 10 373 374 typedef struct { 375 uByte bLength; 376 uByte bDescriptorType; 377 uByte bmAttributes; 378 #define UOTG_SRP 0x01 379 #define UOTG_HNP 0x02 380 } __packed usb_otg_descriptor_t; 381 382 /* OTG feature selectors */ 383 #define UOTG_B_HNP_ENABLE 3 384 #define UOTG_A_HNP_SUPPORT 4 385 #define UOTG_A_ALT_HNP_SUPPORT 5 386 387 typedef struct { 388 uWord wStatus; 389 /* Device status flags */ 390 #define UDS_SELF_POWERED 0x0001 391 #define UDS_REMOTE_WAKEUP 0x0002 392 /* Endpoint status flags */ 393 #define UES_HALT 0x0001 394 } __packed usb_status_t; 395 396 typedef struct { 397 uWord wHubStatus; 398 #define UHS_LOCAL_POWER 0x0001 399 #define UHS_OVER_CURRENT 0x0002 400 uWord wHubChange; 401 } __packed usb_hub_status_t; 402 403 typedef struct { 404 uWord wPortStatus; 405 #define UPS_CURRENT_CONNECT_STATUS 0x0001 406 #define UPS_PORT_ENABLED 0x0002 407 #define UPS_SUSPEND 0x0004 408 #define UPS_OVERCURRENT_INDICATOR 0x0008 409 #define UPS_RESET 0x0010 410 #define UPS_PORT_L1 0x0020 /* USB 2.0 only */ 411 412 /* Super-Speed port link state values. */ 413 #define UPS_PORT_LS_U0 0x0000 414 #define UPS_PORT_LS_U1 0x0020 415 #define UPS_PORT_LS_U2 0x0040 416 #define UPS_PORT_LS_U3 0x0060 417 #define UPS_PORT_LS_SS_DISABLED 0x0080 418 #define UPS_PORT_LS_RX_DETECT 0x00a0 419 #define UPS_PORT_LS_SS_INACTIVE 0x00c0 420 #define UPS_PORT_LS_POLLING 0x00e0 421 #define UPS_PORT_LS_RECOVERY 0x0100 422 #define UPS_PORT_LS_HOT_RESET 0x0120 423 #define UPS_PORT_LS_COMP_MOD 0x0140 424 #define UPS_PORT_LS_LOOPBACK 0x0160 425 426 #define UPS_PORT_POWER 0x0100 427 #define UPS_PORT_POWER_SS 0x0200 /* USB 3.0 only */ 428 #define UPS_FULL_SPEED 0x0000 429 #define UPS_LOW_SPEED 0x0200 430 #define UPS_HIGH_SPEED 0x0400 431 #define UPS_SUPER_SPEED 0x0800 432 #define UPS_PORT_INDICATOR 0x1000 433 434 uWord wPortChange; 435 #define UPS_C_CONNECT_STATUS 0x0001 436 #define UPS_C_PORT_ENABLED 0x0002 437 #define UPS_C_SUSPEND 0x0004 438 #define UPS_C_OVERCURRENT_INDICATOR 0x0008 439 #define UPS_C_PORT_RESET 0x0010 440 #define UPS_C_PORT_L1 0x0020 /* USB 2.0 only */ 441 #define UPS_C_BH_PORT_RESET 0x0020 /* USB 3.0 only */ 442 #define UPS_C_PORT_LINK_STATE 0x0040 443 #define UPS_C_PORT_CONFIG_ERROR 0x0080 444 } __packed usb_port_status_t; 445 446 /* Device class codes */ 447 #define UDCLASS_IN_INTERFACE 0x00 448 #define UDCLASS_COMM 0x02 449 #define UDCLASS_HUB 0x09 450 #define UDSUBCLASS_HUB 0x00 451 #define UDPROTO_FSHUB 0x00 452 #define UDPROTO_HSHUBSTT 0x01 453 #define UDPROTO_HSHUBMTT 0x02 454 #define UDPROTO_SSHUB 0x03 455 #define UDCLASS_DIAGNOSTIC 0xdc 456 #define UDCLASS_WIRELESS 0xe0 457 #define UDCLASS_VIDEO 0xef 458 #define UDSUBCLASS_RF 0x01 459 #define UDPROTO_BLUETOOTH 0x01 460 #define UDCLASS_VENDOR 0xff 461 462 /* Interface class codes */ 463 #define UICLASS_UNSPEC 0x00 464 465 #define UICLASS_AUDIO 0x01 466 #define UISUBCLASS_AUDIOCONTROL 1 467 #define UISUBCLASS_AUDIOSTREAM 2 468 #define UISUBCLASS_MIDISTREAM 3 469 470 #define UICLASS_CDC 0x02 /* communication */ 471 #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1 472 #define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2 473 #define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3 474 #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4 475 #define UISUBCLASS_CAPI_CONTROLMODEL 5 476 #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6 477 #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7 478 #define UISUBCLASS_MOBILE_DIRECT_LINE_MODEL 10 479 #define UIPROTO_CDC_AT 1 480 481 #define UICLASS_HID 0x03 482 #define UISUBCLASS_BOOT 1 483 #define UIPROTO_BOOT_KEYBOARD 1 484 #define UIPROTO_BOOT_MOUSE 2 485 486 #define UICLASS_PHYSICAL 0x05 487 488 #define UICLASS_IMAGE 0x06 489 490 #define UICLASS_PRINTER 0x07 491 #define UISUBCLASS_PRINTER 1 492 #define UIPROTO_PRINTER_UNI 1 493 #define UIPROTO_PRINTER_BI 2 494 #define UIPROTO_PRINTER_1284 3 495 496 #define UICLASS_MASS 0x08 497 #define UISUBCLASS_RBC 1 498 #define UISUBCLASS_SFF8020I 2 499 #define UISUBCLASS_QIC157 3 500 #define UISUBCLASS_UFI 4 501 #define UISUBCLASS_SFF8070I 5 502 #define UISUBCLASS_SCSI 6 503 #define UIPROTO_MASS_CBI_I 0 504 #define UIPROTO_MASS_CBI 1 505 #define UIPROTO_MASS_BBB_OLD 2 /* Not in the spec anymore */ 506 #define UIPROTO_MASS_BBB 80 /* 'P' for the Iomega Zip drive */ 507 508 #define UICLASS_HUB 0x09 509 #define UISUBCLASS_HUB 0 510 #define UIPROTO_FSHUB 0 511 #define UIPROTO_HSHUBSTT 0 /* Yes, same as previous */ 512 #define UIPROTO_HSHUBMTT 1 513 514 #define UICLASS_CDC_DATA 0x0a 515 #define UISUBCLASS_DATA 0 516 #define UIPROTO_DATA_ISDNBRI 0x30 /* Physical iface */ 517 #define UIPROTO_DATA_HDLC 0x31 /* HDLC */ 518 #define UIPROTO_DATA_TRANSPARENT 0x32 /* Transparent */ 519 #define UIPROTO_DATA_Q921M 0x50 /* Management for Q921 */ 520 #define UIPROTO_DATA_Q921 0x51 /* Data for Q921 */ 521 #define UIPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */ 522 #define UIPROTO_DATA_V42BIS 0x90 /* Data compression */ 523 #define UIPROTO_DATA_Q931 0x91 /* Euro-ISDN */ 524 #define UIPROTO_DATA_V120 0x92 /* V.24 rate adaption */ 525 #define UIPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */ 526 #define UIPROTO_DATA_HOST_BASED 0xfd /* Host based driver */ 527 #define UIPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc.*/ 528 #define UIPROTO_DATA_VENDOR 0xff /* Vendor specific */ 529 530 #define UICLASS_SMARTCARD 0x0b 531 532 /*#define UICLASS_FIRM_UPD 0x0c*/ 533 534 #define UICLASS_SECURITY 0x0d 535 536 #define UICLASS_VIDEO 0x0e 537 #define UISUBCLASS_VIDEOCONTROL 1 538 #define UISUBCLASS_VIDEOSTREAM 2 539 #define UISUBCLASS_VIDEO_IF_COLLECTION 3 540 541 #define UICLASS_DIAGNOSTIC 0xdc 542 543 #define UICLASS_WIRELESS 0xe0 544 #define UISUBCLASS_RF 0x01 545 #define UIPROTO_BLUETOOTH 0x01 546 #define UIPROTO_RNDIS 0x03 547 548 #define UICLASS_MISC 0xef 549 #define UISUBCLASS_SYNC 0x01 550 #define UIPROTO_ACTIVESYNC 0x01 551 552 #define UICLASS_APPL_SPEC 0xfe 553 #define UISUBCLASS_FIRMWARE_DOWNLOAD 1 554 #define UISUBCLASS_IRDA 2 555 #define UIPROTO_IRDA 0 556 557 #define UICLASS_VENDOR 0xff 558 559 560 #define USB_HUB_MAX_DEPTH 5 561 562 /* 563 * Minimum time a device needs to be powered down to go through 564 * a power cycle. XXX Are these time in the spec? 565 */ 566 #define USB_POWER_DOWN_TIME 200 /* ms */ 567 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 568 569 #if 0 570 /* These are the values from the spec. */ 571 #define USB_PORT_RESET_DELAY 10 /* ms */ 572 #define USB_PORT_ROOT_RESET_DELAY 50 /* ms */ 573 #define USB_PORT_RESET_RECOVERY 10 /* ms */ 574 #define USB_PORT_POWERUP_DELAY 100 /* ms */ 575 #define USB_SET_ADDRESS_SETTLE 2 /* ms */ 576 #define USB_RESUME_DELAY (20*5) /* ms */ 577 #define USB_RESUME_WAIT 10 /* ms */ 578 #define USB_RESUME_RECOVERY 10 /* ms */ 579 #define USB_EXTRA_POWER_UP_TIME 0 /* ms */ 580 #else 581 /* Allow for marginal (i.e. non-conforming) devices. */ 582 #define USB_PORT_RESET_DELAY 50 /* ms */ 583 #define USB_PORT_ROOT_RESET_DELAY 100 /* ms */ 584 #define USB_PORT_RESET_RECOVERY 250 /* ms */ 585 #define USB_PORT_POWERUP_DELAY 300 /* ms */ 586 #define USB_SET_ADDRESS_SETTLE 10 /* ms */ 587 #define USB_RESUME_DELAY (50*5) /* ms */ 588 #define USB_RESUME_WAIT 50 /* ms */ 589 #define USB_RESUME_RECOVERY 50 /* ms */ 590 #define USB_EXTRA_POWER_UP_TIME 20 /* ms */ 591 #endif 592 593 #define USB_MIN_POWER 100 /* mA */ 594 #define USB_MAX_POWER 500 /* mA */ 595 596 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ 597 598 599 #define USB_UNCONFIG_NO 0 600 #define USB_UNCONFIG_INDEX (-1) 601 602 /*** ioctl() related stuff ***/ 603 604 struct usb_ctl_request { 605 int ucr_addr; 606 usb_device_request_t ucr_request; 607 void *ucr_data; 608 int ucr_flags; 609 #define USBD_SHORT_XFER_OK 0x04 /* allow short reads */ 610 int ucr_actlen; /* actual length transferred */ 611 }; 612 613 struct usb_alt_interface { 614 int uai_config_index; 615 int uai_interface_index; 616 int uai_alt_no; 617 }; 618 619 #define USB_CURRENT_CONFIG_INDEX (-1) 620 #define USB_CURRENT_ALT_INDEX (-1) 621 622 struct usb_config_desc { 623 int ucd_config_index; 624 usb_config_descriptor_t ucd_desc; 625 }; 626 627 struct usb_device_cdesc { 628 u_int8_t udc_bus; 629 u_int8_t udc_addr; /* device address */ 630 int udc_config_index; 631 usb_config_descriptor_t udc_desc; 632 }; 633 634 struct usb_interface_desc { 635 int uid_config_index; 636 int uid_interface_index; 637 int uid_alt_index; 638 usb_interface_descriptor_t uid_desc; 639 }; 640 641 struct usb_endpoint_desc { 642 int ued_config_index; 643 int ued_interface_index; 644 int ued_alt_index; 645 int ued_endpoint_index; 646 usb_endpoint_descriptor_t ued_desc; 647 }; 648 649 struct usb_full_desc { 650 int ufd_config_index; 651 u_int ufd_size; 652 u_char *ufd_data; 653 }; 654 655 struct usb_device_fdesc { 656 u_int8_t udf_bus; 657 u_int8_t udf_addr; /* device address */ 658 int udf_config_index; 659 u_int udf_size; 660 u_char *udf_data; 661 }; 662 663 struct usb_device_ddesc { 664 u_int8_t udd_bus; 665 u_int8_t udd_addr; /* device address */ 666 usb_device_descriptor_t udd_desc; 667 }; 668 669 struct usb_string_desc { 670 int usd_string_index; 671 int usd_language_id; 672 usb_string_descriptor_t usd_desc; 673 }; 674 675 struct usb_ctl_report_desc { 676 int ucrd_size; 677 u_char ucrd_data[1024]; /* filled data size will vary */ 678 }; 679 680 #define USB_MAX_DEVNAMES 4 681 #define USB_MAX_DEVNAMELEN 16 682 struct usb_device_info { 683 u_int8_t udi_bus; 684 u_int8_t udi_addr; /* device address */ 685 char udi_product[USB_MAX_STRING_LEN]; 686 char udi_vendor[USB_MAX_STRING_LEN]; 687 char udi_release[8]; 688 u_int16_t udi_productNo; 689 u_int16_t udi_vendorNo; 690 u_int16_t udi_releaseNo; 691 u_int8_t udi_class; 692 u_int8_t udi_subclass; 693 u_int8_t udi_protocol; 694 u_int8_t udi_config; 695 u_int8_t udi_speed; 696 #define USB_SPEED_LOW 1 697 #define USB_SPEED_FULL 2 698 #define USB_SPEED_HIGH 3 699 #define USB_SPEED_SUPER 4 700 int udi_power; /* power consumption in mA, 0 if selfpowered */ 701 int udi_nports; 702 char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN]; 703 u_int8_t udi_ports[16];/* hub only: addresses of devices on ports */ 704 #define USB_PORT_ENABLED 0xff 705 #define USB_PORT_SUSPENDED 0xfe 706 #define USB_PORT_POWERED 0xfd 707 #define USB_PORT_DISABLED 0xfc 708 char udi_serial[USB_MAX_STRING_LEN]; 709 }; 710 711 struct usb_ctl_report { 712 int ucr_report; 713 u_char ucr_data[1024]; /* filled data size will vary */ 714 }; 715 716 struct usb_device_stats { 717 u_long uds_requests[4]; /* indexed by transfer type UE_* */ 718 }; 719 720 /* USB controller */ 721 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 722 #define USB_SETDEBUG _IOW ('U', 2, unsigned int) 723 #define USB_DISCOVER _IO ('U', 3) 724 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 725 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 726 #define USB_DEVICE_GET_CDESC _IOWR('U', 6, struct usb_device_cdesc) 727 #define USB_DEVICE_GET_FDESC _IOWR('U', 7, struct usb_device_fdesc) 728 #define USB_DEVICE_GET_DDESC _IOWR('U', 8, struct usb_device_ddesc) 729 730 /* Generic HID device */ 731 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) 732 #define USB_SET_IMMED _IOW ('U', 22, int) 733 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) 734 #define USB_SET_REPORT _IOW ('U', 24, struct usb_ctl_report) 735 #define USB_GET_REPORT_ID _IOR ('U', 25, int) 736 737 /* Generic USB device */ 738 #define USB_GET_CONFIG _IOR ('U', 100, int) 739 #define USB_SET_CONFIG _IOW ('U', 101, int) 740 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 741 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 742 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) 743 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) 744 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) 745 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) 746 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) 747 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) 748 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc) 749 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 750 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 751 #define USB_SET_SHORT_XFER _IOW ('U', 113, int) 752 #define USB_SET_TIMEOUT _IOW ('U', 114, int) 753 754 /* Modem device */ 755 #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int) 756 #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int) 757 758 #endif /* _USB_H_ */ 759