1 /* $OpenBSD: usb.h,v 1.62 2021/01/27 17:28:19 mglocker 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 struct usb_device_request { 86 uByte bmRequestType; 87 uByte bRequest; 88 uWord wValue; 89 uWord wIndex; 90 uWord wLength; 91 } __packed; 92 typedef struct usb_device_request usb_device_request_t; 93 94 #define UT_WRITE 0x00 95 #define UT_READ 0x80 96 #define UT_STANDARD 0x00 97 #define UT_CLASS 0x20 98 #define UT_VENDOR 0x40 99 #define UT_DEVICE 0x00 100 #define UT_INTERFACE 0x01 101 #define UT_ENDPOINT 0x02 102 #define UT_OTHER 0x03 103 104 #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE) 105 #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE) 106 #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT) 107 #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE) 108 #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE) 109 #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT) 110 #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE) 111 #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE) 112 #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER) 113 #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT) 114 #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE) 115 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE) 116 #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER) 117 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT) 118 #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE) 119 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE) 120 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER) 121 #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT) 122 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE) 123 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE) 124 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER) 125 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT) 126 127 /* Requests */ 128 #define UR_GET_STATUS 0x00 129 #define UR_CLEAR_FEATURE 0x01 130 #define UR_SET_FEATURE 0x03 131 #define UR_SET_ADDRESS 0x05 132 #define UR_GET_DESCRIPTOR 0x06 133 #define UDESC_DEVICE 0x01 134 #define UDESC_CONFIG 0x02 135 #define UDESC_STRING 0x03 136 #define UDESC_INTERFACE 0x04 137 #define UDESC_ENDPOINT 0x05 138 #define UDESC_DEVICE_QUALIFIER 0x06 139 #define UDESC_OTHER_SPEED_CONFIGURATION 0x07 140 #define UDESC_INTERFACE_POWER 0x08 141 #define UDESC_OTG 0x09 142 #define UDESC_DEBUG 0x0A 143 #define UDESC_IFACE_ASSOC 0x0B /* interface association */ 144 #define UDESC_BOS 0x0F /* binary object store */ 145 #define UDESC_DEVICE_CAPABILITY 0x10 146 #define UDESC_CS_DEVICE 0x21 /* class specific */ 147 #define UDESC_CS_CONFIG 0x22 148 #define UDESC_CS_STRING 0x23 149 #define UDESC_CS_INTERFACE 0x24 150 #define UDESC_CS_ENDPOINT 0x25 151 #define UDESC_HUB 0x29 152 #define UDESC_SS_HUB 0x2A /* super speed */ 153 #define UDESC_ENDPOINT_SS_COMP 0x30 /* super speed */ 154 #define UR_SET_DESCRIPTOR 0x07 155 #define UR_GET_CONFIG 0x08 156 #define UR_SET_CONFIG 0x09 157 #define UR_GET_INTERFACE 0x0a 158 #define UR_SET_INTERFACE 0x0b 159 #define UR_SYNCH_FRAME 0x0c 160 161 /* Feature numbers */ 162 #define UF_ENDPOINT_HALT 0 163 #define UF_DEVICE_REMOTE_WAKEUP 1 164 #define UF_TEST_MODE 2 165 166 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */ 167 168 #define USB_2_MAX_CTRL_PACKET 64 169 #define USB_2_MAX_BULK_PACKET 512 170 171 struct usb_descriptor { 172 uByte bLength; 173 uByte bDescriptorType; 174 uByte bDescriptorSubtype; 175 } __packed; 176 typedef struct usb_descriptor usb_descriptor_t; 177 178 struct usb_device_descriptor { 179 uByte bLength; 180 uByte bDescriptorType; 181 uWord bcdUSB; 182 uByte bDeviceClass; 183 uByte bDeviceSubClass; 184 uByte bDeviceProtocol; 185 uByte bMaxPacketSize; 186 /* The fields below are not part of the initial descriptor. */ 187 uWord idVendor; 188 uWord idProduct; 189 uWord bcdDevice; 190 uByte iManufacturer; 191 uByte iProduct; 192 uByte iSerialNumber; 193 uByte bNumConfigurations; 194 } __packed; 195 typedef struct usb_device_descriptor usb_device_descriptor_t; 196 #define USB_DEVICE_DESCRIPTOR_SIZE 18 197 198 struct usb_config_descriptor { 199 uByte bLength; 200 uByte bDescriptorType; 201 uWord wTotalLength; 202 uByte bNumInterfaces; 203 uByte bConfigurationValue; 204 uByte iConfiguration; 205 uByte bmAttributes; 206 #define UC_BUS_POWERED 0x80 207 #define UC_SELF_POWERED 0x40 208 #define UC_REMOTE_WAKEUP 0x20 209 uByte bMaxPower; /* max current in 2 mA units */ 210 #define UC_POWER_FACTOR 2 211 } __packed; 212 typedef struct usb_config_descriptor usb_config_descriptor_t; 213 #define USB_CONFIG_DESCRIPTOR_SIZE 9 214 215 struct usb_interface_descriptor { 216 uByte bLength; 217 uByte bDescriptorType; 218 uByte bInterfaceNumber; 219 uByte bAlternateSetting; 220 uByte bNumEndpoints; 221 uByte bInterfaceClass; 222 uByte bInterfaceSubClass; 223 uByte bInterfaceProtocol; 224 uByte iInterface; 225 } __packed; 226 typedef struct usb_interface_descriptor usb_interface_descriptor_t; 227 #define USB_INTERFACE_DESCRIPTOR_SIZE 9 228 229 struct usb_interface_assoc_descriptor { 230 uByte bLength; 231 uByte bDescriptorType; 232 uByte bFirstInterface; 233 uByte bInterfaceCount; 234 uByte bFunctionClass; 235 uByte bFunctionSubClass; 236 uByte bFunctionProtocol; 237 uByte iFunction; 238 } __packed; 239 typedef struct usb_interface_assoc_descriptor usb_interface_assoc_descriptor_t; 240 #define USB_INTERFACE_ASSOC_DESCRIPTOR_SIZE 8 241 242 struct usb_endpoint_descriptor { 243 uByte bLength; 244 uByte bDescriptorType; 245 uByte bEndpointAddress; 246 #define UE_GET_DIR(a) ((a) & 0x80) 247 #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7)) 248 #define UE_DIR_IN 0x80 249 #define UE_DIR_OUT 0x00 250 #define UE_ADDR 0x0f 251 #define UE_GET_ADDR(a) ((a) & UE_ADDR) 252 uByte bmAttributes; 253 #define UE_XFERTYPE 0x03 254 #define UE_CONTROL 0x00 255 #define UE_ISOCHRONOUS 0x01 256 #define UE_BULK 0x02 257 #define UE_INTERRUPT 0x03 258 #define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE) 259 #define UE_ISO_TYPE 0x0c 260 #define UE_ISO_ASYNC 0x04 261 #define UE_ISO_ADAPT 0x08 262 #define UE_ISO_SYNC 0x0c 263 #define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE) 264 uWord wMaxPacketSize; 265 #define UE_GET_TRANS(a) (((a) >> 11) & 0x3) 266 #define UE_GET_SIZE(a) ((a) & 0x7ff) 267 uByte bInterval; 268 } __packed; 269 typedef struct usb_endpoint_descriptor usb_endpoint_descriptor_t; 270 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7 271 272 struct usb_endpoint_ss_comp_descriptor { 273 uByte bLength; 274 uByte bDescriptorType; 275 uByte bMaxBurst; 276 uByte bmAttributes; 277 #define UCE_BULK_MAX_STREAMS(a) ((a) & 0xff) 278 #define UCE_ISOC_MULT(a) ((a) & 0x0c) 279 #define UCE_ISOC_SSP_ISO(a) ((a) & 0x80) 280 uWord wBytesPerInterval; 281 } __packed; 282 typedef struct usb_endpoint_ss_comp_descriptor 283 usb_endpoint_ss_comp_descriptor_t; 284 #define USB_ENDPOINT_SS_COMP_DESCRIPTOR_SIZE 6 285 286 /* 287 * Note: The length of the USB string descriptor is stored in a one byte 288 * value and can therefore be no longer than 255 bytes. Two bytes are 289 * used for the length itself and the descriptor type, a theoretical maximum 290 * of 253 bytes is left for the actual string data. Since the strings are 291 * encoded as 2-byte unicode characters, only 252 bytes or 126 two-byte 292 * characters can be used. USB_MAX_STRING_LEN is defined as 127, leaving 293 * space for the terminal '\0' character in C strings. 294 */ 295 struct usb_string_descriptor { 296 uByte bLength; 297 uByte bDescriptorType; 298 uWord bString[126]; 299 } __packed; 300 typedef struct usb_string_descriptor usb_string_descriptor_t; 301 #define USB_MAX_STRING_LEN 127 302 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */ 303 304 /* Hub specific request */ 305 #define UR_GET_BUS_STATE 0x02 306 #define UR_CLEAR_TT_BUFFER 0x08 307 #define UR_RESET_TT 0x09 308 #define UR_GET_TT_STATE 0x0a 309 #define UR_STOP_TT 0x0b 310 #define UR_SET_DEPTH 0x0c 311 312 /* Hub features */ 313 #define UHF_C_HUB_LOCAL_POWER 0 314 #define UHF_C_HUB_OVER_CURRENT 1 315 316 /* Port feature */ 317 #define UHF_PORT_CONNECTION 0 318 #define UHF_PORT_ENABLE 1 319 #define UHF_PORT_SUSPEND 2 320 #define UHF_PORT_OVER_CURRENT 3 321 #define UHF_PORT_RESET 4 322 #define UHF_PORT_POWER 8 323 #define UHF_PORT_LOW_SPEED 9 324 #define UHF_C_PORT_CONNECTION 16 325 #define UHF_C_PORT_ENABLE 17 326 #define UHF_C_PORT_SUSPEND 18 327 #define UHF_C_PORT_OVER_CURRENT 19 328 #define UHF_C_PORT_RESET 20 329 #define UHF_PORT_TEST 21 330 #define UHF_PORT_INDICATOR 22 331 #define UHF_C_PORT_L1 23 332 #define UHF_PORT_DISOWN_TO_1_1 30 333 334 /* Super-Speed Port feature */ 335 #define UHF_PORT_U1_TIMEOUT 23 336 #define UHF_PORT_U2_TIMEOUT 24 337 #define UHF_C_PORT_LINK_STATE 25 338 #define UHF_C_PORT_CONFIG_ERROR 26 339 #define UHF_PORT_REMOTE_WAKE_MASK 27 340 #define UHF_BH_PORT_RESET 28 341 #define UHF_C_BH_PORT_RESET 29 342 #define UHF_FORCE_LINKPM_ACCEPT 30 343 344 345 struct usb_hub_descriptor { 346 uByte bDescLength; 347 uByte bDescriptorType; 348 uByte bNbrPorts; 349 uWord wHubCharacteristics; 350 #define UHD_PWR 0x0003 351 #define UHD_PWR_GANGED 0x0000 352 #define UHD_PWR_INDIVIDUAL 0x0001 353 #define UHD_PWR_NO_SWITCH 0x0002 354 #define UHD_COMPOUND 0x0004 355 #define UHD_OC 0x0018 356 #define UHD_OC_GLOBAL 0x0000 357 #define UHD_OC_INDIVIDUAL 0x0008 358 #define UHD_OC_NONE 0x0010 359 #define UHD_TT_THINK 0x0060 360 #define UHD_TT_THINK_8 0x0000 361 #define UHD_TT_THINK_16 0x0020 362 #define UHD_TT_THINK_24 0x0040 363 #define UHD_TT_THINK_32 0x0060 364 #define UHD_PORT_IND 0x0080 365 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 366 #define UHD_PWRON_FACTOR 2 367 uByte bHubContrCurrent; 368 uByte DeviceRemovable[32]; /* max 255 ports */ 369 #define UHD_NOT_REMOV(desc, i) \ 370 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) 371 } __packed; 372 typedef struct usb_hub_descriptor usb_hub_descriptor_t; 373 #define USB_HUB_DESCRIPTOR_SIZE 8 374 375 struct usb_hub_ss_descriptor { 376 uByte bDescLength; 377 uByte bDescriptorType; 378 uByte bNbrPorts; 379 uWord wHubCharacteristics; 380 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 381 uByte bHubContrCurrent; 382 uByte bHubHdrDecLat; 383 uWord wHubDelay; 384 uByte DeviceRemovable[32]; /* max 255 ports */ 385 } __packed; 386 typedef struct usb_hub_ss_descriptor usb_hub_ss_descriptor_t; 387 #define USB_HUB_SS_DESCRIPTOR_SIZE 11 388 389 struct usb_device_qualifier { 390 uByte bLength; 391 uByte bDescriptorType; 392 uWord bcdUSB; 393 uByte bDeviceClass; 394 uByte bDeviceSubClass; 395 uByte bDeviceProtocol; 396 uByte bMaxPacketSize0; 397 uByte bNumConfigurations; 398 uByte bReserved; 399 } __packed; 400 typedef struct usb_device_qualifier usb_device_qualifier_t; 401 #define USB_DEVICE_QUALIFIER_SIZE 10 402 403 struct usb_otg_descriptor { 404 uByte bLength; 405 uByte bDescriptorType; 406 uByte bmAttributes; 407 #define UOTG_SRP 0x01 408 #define UOTG_HNP 0x02 409 } __packed; 410 typedef struct usb_otg_descriptor usb_otg_descriptor_t; 411 412 /* OTG feature selectors */ 413 #define UOTG_B_HNP_ENABLE 3 414 #define UOTG_A_HNP_SUPPORT 4 415 #define UOTG_A_ALT_HNP_SUPPORT 5 416 417 struct usb_status { 418 uWord wStatus; 419 /* Device status flags */ 420 #define UDS_SELF_POWERED 0x0001 421 #define UDS_REMOTE_WAKEUP 0x0002 422 /* Endpoint status flags */ 423 #define UES_HALT 0x0001 424 } __packed; 425 typedef struct usb_status usb_status_t; 426 427 struct usb_hub_status { 428 uWord wHubStatus; 429 #define UHS_LOCAL_POWER 0x0001 430 #define UHS_OVER_CURRENT 0x0002 431 uWord wHubChange; 432 } __packed; 433 typedef struct usb_hub_status usb_hub_status_t; 434 435 struct usb_port_status { 436 uWord wPortStatus; 437 #define UPS_CURRENT_CONNECT_STATUS 0x0001 438 #define UPS_PORT_ENABLED 0x0002 439 #define UPS_SUSPEND 0x0004 440 #define UPS_OVERCURRENT_INDICATOR 0x0008 441 #define UPS_RESET 0x0010 442 #define UPS_PORT_L1 0x0020 /* USB 2.0 only */ 443 444 /* Super-Speed port link state values. */ 445 #define UPS_PORT_LS_U0 0x00 446 #define UPS_PORT_LS_U1 0x01 447 #define UPS_PORT_LS_U2 0x02 448 #define UPS_PORT_LS_U3 0x03 449 #define UPS_PORT_LS_SS_DISABLED 0x04 450 #define UPS_PORT_LS_RX_DETECT 0x05 451 #define UPS_PORT_LS_SS_INACTIVE 0x06 452 #define UPS_PORT_LS_POLLING 0x07 453 #define UPS_PORT_LS_RECOVERY 0x08 454 #define UPS_PORT_LS_HOT_RESET 0x09 455 #define UPS_PORT_LS_COMP_MOD 0x0a 456 #define UPS_PORT_LS_LOOPBACK 0x0b 457 #define UPS_PORT_LS_RESUME 0x0f 458 #define UPS_PORT_LS_GET(x) (((x) >> 5) & 0xf) 459 #define UPS_PORT_LS_SET(x) (((x) & 0xf) << 5) 460 461 #define UPS_PORT_POWER 0x0100 462 #define UPS_PORT_POWER_SS 0x0200 /* USB 3.0 only */ 463 #define UPS_FULL_SPEED 0x0000 464 #define UPS_LOW_SPEED 0x0200 465 #define UPS_HIGH_SPEED 0x0400 466 #define UPS_PORT_TEST 0x0800 467 #define UPS_PORT_INDICATOR 0x1000 468 469 uWord wPortChange; 470 #define UPS_C_CONNECT_STATUS 0x0001 471 #define UPS_C_PORT_ENABLED 0x0002 472 #define UPS_C_SUSPEND 0x0004 473 #define UPS_C_OVERCURRENT_INDICATOR 0x0008 474 #define UPS_C_PORT_RESET 0x0010 475 #define UPS_C_PORT_L1 0x0020 /* USB 2.0 only */ 476 #define UPS_C_BH_PORT_RESET 0x0020 /* USB 3.0 only */ 477 #define UPS_C_PORT_LINK_STATE 0x0040 478 #define UPS_C_PORT_CONFIG_ERROR 0x0080 479 } __packed; 480 typedef struct usb_port_status usb_port_status_t; 481 482 /* Device class codes */ 483 #define UDCLASS_IN_INTERFACE 0x00 484 #define UDCLASS_COMM 0x02 485 #define UDCLASS_HUB 0x09 486 #define UDSUBCLASS_HUB 0x00 487 #define UDPROTO_FSHUB 0x00 488 #define UDPROTO_HSHUBSTT 0x01 489 #define UDPROTO_HSHUBMTT 0x02 490 #define UDPROTO_SSHUB 0x03 491 #define UDCLASS_DIAGNOSTIC 0xdc 492 #define UDCLASS_WIRELESS 0xe0 493 #define UDCLASS_VIDEO 0xef 494 #define UDSUBCLASS_RF 0x01 495 #define UDPROTO_BLUETOOTH 0x01 496 #define UDCLASS_VENDOR 0xff 497 498 /* Interface class codes */ 499 #define UICLASS_UNSPEC 0x00 500 501 #define UICLASS_AUDIO 0x01 502 #define UISUBCLASS_AUDIOCONTROL 1 503 #define UISUBCLASS_AUDIOSTREAM 2 504 #define UISUBCLASS_MIDISTREAM 3 505 506 #define UICLASS_CDC 0x02 /* communication */ 507 #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1 508 #define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2 509 #define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3 510 #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4 511 #define UISUBCLASS_CAPI_CONTROLMODEL 5 512 #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6 513 #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7 514 #define UISUBCLASS_MOBILE_DIRECT_LINE_MODEL 10 515 #define UISUBCLASS_NETWORK_CONTROL_MODEL 13 516 #define UISUBCLASS_MOBILE_BROADBAND_INTERFACE_MODEL 14 517 #define UIPROTO_CDC_NOCLASS 0 518 #define UIPROTO_CDC_AT 1 519 520 #define UICLASS_HID 0x03 521 #define UISUBCLASS_BOOT 1 522 #define UIPROTO_BOOT_KEYBOARD 1 523 #define UIPROTO_BOOT_MOUSE 2 524 525 #define UICLASS_PHYSICAL 0x05 526 527 #define UICLASS_IMAGE 0x06 528 529 #define UICLASS_PRINTER 0x07 530 #define UISUBCLASS_PRINTER 1 531 #define UIPROTO_PRINTER_UNI 1 532 #define UIPROTO_PRINTER_BI 2 533 #define UIPROTO_PRINTER_1284 3 534 535 #define UICLASS_MASS 0x08 536 #define UISUBCLASS_RBC 1 537 #define UISUBCLASS_SFF8020I 2 538 #define UISUBCLASS_QIC157 3 539 #define UISUBCLASS_UFI 4 540 #define UISUBCLASS_SFF8070I 5 541 #define UISUBCLASS_SCSI 6 542 #define UIPROTO_MASS_CBI_I 0 543 #define UIPROTO_MASS_CBI 1 544 #define UIPROTO_MASS_BBB_OLD 2 /* Not in the spec anymore */ 545 #define UIPROTO_MASS_BBB 80 /* 'P' for the Iomega Zip drive */ 546 547 #define UICLASS_HUB 0x09 548 #define UISUBCLASS_HUB 0 549 #define UIPROTO_FSHUB 0 550 #define UIPROTO_HSHUBSTT 0 /* Yes, same as previous */ 551 #define UIPROTO_HSHUBMTT 1 552 553 #define UICLASS_CDC_DATA 0x0a 554 #define UISUBCLASS_DATA 0 555 #define UIPROTO_DATA_MBIM 0x02 /* MBIM */ 556 #define UIPROTO_DATA_ISDNBRI 0x30 /* Physical iface */ 557 #define UIPROTO_DATA_HDLC 0x31 /* HDLC */ 558 #define UIPROTO_DATA_TRANSPARENT 0x32 /* Transparent */ 559 #define UIPROTO_DATA_Q921M 0x50 /* Management for Q921 */ 560 #define UIPROTO_DATA_Q921 0x51 /* Data for Q921 */ 561 #define UIPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */ 562 #define UIPROTO_DATA_V42BIS 0x90 /* Data compression */ 563 #define UIPROTO_DATA_Q931 0x91 /* Euro-ISDN */ 564 #define UIPROTO_DATA_V120 0x92 /* V.24 rate adaption */ 565 #define UIPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */ 566 #define UIPROTO_DATA_HOST_BASED 0xfd /* Host based driver */ 567 #define UIPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc.*/ 568 #define UIPROTO_DATA_VENDOR 0xff /* Vendor specific */ 569 570 #define UICLASS_SMARTCARD 0x0b 571 572 /*#define UICLASS_FIRM_UPD 0x0c*/ 573 574 #define UICLASS_SECURITY 0x0d 575 576 #define UICLASS_VIDEO 0x0e 577 #define UISUBCLASS_VIDEOCONTROL 1 578 #define UISUBCLASS_VIDEOSTREAM 2 579 #define UISUBCLASS_VIDEO_IF_COLLECTION 3 580 581 #define UICLASS_DIAGNOSTIC 0xdc 582 583 #define UICLASS_WIRELESS 0xe0 584 #define UISUBCLASS_RF 0x01 585 #define UIPROTO_BLUETOOTH 0x01 586 #define UIPROTO_RNDIS 0x03 587 588 #define UICLASS_MISC 0xef 589 #define UISUBCLASS_SYNC 0x01 590 #define UIPROTO_ACTIVESYNC 0x01 591 592 #define UICLASS_APPL_SPEC 0xfe 593 #define UISUBCLASS_FIRMWARE_DOWNLOAD 1 594 #define UISUBCLASS_IRDA 2 595 #define UIPROTO_IRDA 0 596 597 #define UICLASS_VENDOR 0xff 598 599 600 #define USB_HUB_MAX_DEPTH 5 601 602 /* 603 * Minimum time a device needs to be powered down to go through 604 * a power cycle. XXX Are these time in the spec? 605 */ 606 #define USB_POWER_DOWN_TIME 200 /* ms */ 607 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 608 609 #if 0 610 /* These are the values from the spec. */ 611 #define USB_PORT_RESET_DELAY 10 /* ms */ 612 #define USB_PORT_ROOT_RESET_DELAY 50 /* ms */ 613 #define USB_PORT_RESET_RECOVERY 10 /* ms */ 614 #define USB_PORT_POWERUP_DELAY 100 /* ms */ 615 #define USB_SET_ADDRESS_SETTLE 2 /* ms */ 616 #define USB_RESUME_DELAY (20*5) /* ms */ 617 #define USB_RESUME_WAIT 10 /* ms */ 618 #define USB_RESUME_RECOVERY 10 /* ms */ 619 #define USB_EXTRA_POWER_UP_TIME 0 /* ms */ 620 #else 621 /* Allow for marginal (i.e. non-conforming) devices. */ 622 #define USB_PORT_RESET_DELAY 50 /* ms */ 623 #define USB_PORT_ROOT_RESET_DELAY 100 /* ms */ 624 #define USB_PORT_RESET_RECOVERY 250 /* ms */ 625 #define USB_PORT_POWERUP_DELAY 300 /* ms */ 626 #define USB_SET_ADDRESS_SETTLE 10 /* ms */ 627 #define USB_RESUME_DELAY (50*5) /* ms */ 628 #define USB_RESUME_WAIT 50 /* ms */ 629 #define USB_RESUME_RECOVERY 50 /* ms */ 630 #define USB_EXTRA_POWER_UP_TIME 20 /* ms */ 631 #endif 632 633 #define USB_MIN_POWER 100 /* mA */ 634 #define USB_MAX_POWER 500 /* mA */ 635 636 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ 637 638 639 #define USB_UNCONFIG_NO 0 640 #define USB_UNCONFIG_INDEX (-1) 641 642 /*** ioctl() related stuff ***/ 643 644 struct usb_ctl_request { 645 int ucr_addr; 646 usb_device_request_t ucr_request; 647 void *ucr_data; 648 int ucr_flags; 649 #define USBD_SHORT_XFER_OK 0x04 /* allow short reads */ 650 int ucr_actlen; /* actual length transferred */ 651 }; 652 653 struct usb_alt_interface { 654 int uai_config_index; 655 int uai_interface_index; 656 int uai_alt_no; 657 }; 658 659 #define USB_CURRENT_CONFIG_INDEX (-1) 660 #define USB_CURRENT_ALT_INDEX (-1) 661 662 struct usb_config_desc { 663 int ucd_config_index; 664 struct usb_config_descriptor ucd_desc; 665 }; 666 667 struct usb_device_cdesc { 668 u_int8_t udc_bus; 669 u_int8_t udc_addr; /* device address */ 670 int udc_config_index; 671 struct usb_config_descriptor udc_desc; 672 }; 673 674 struct usb_interface_desc { 675 int uid_config_index; 676 int uid_interface_index; 677 int uid_alt_index; 678 struct usb_interface_descriptor uid_desc; 679 }; 680 681 struct usb_endpoint_desc { 682 int ued_config_index; 683 int ued_interface_index; 684 int ued_alt_index; 685 int ued_endpoint_index; 686 struct usb_endpoint_descriptor ued_desc; 687 }; 688 689 struct usb_full_desc { 690 int ufd_config_index; 691 u_int ufd_size; 692 u_char *ufd_data; 693 }; 694 695 struct usb_device_fdesc { 696 u_int8_t udf_bus; 697 u_int8_t udf_addr; /* device address */ 698 int udf_config_index; 699 u_int udf_size; 700 u_char *udf_data; 701 }; 702 703 struct usb_device_ddesc { 704 u_int8_t udd_bus; 705 u_int8_t udd_addr; /* device address */ 706 struct usb_device_descriptor udd_desc; 707 }; 708 709 struct usb_string_desc { 710 int usd_string_index; 711 int usd_language_id; 712 struct usb_string_descriptor usd_desc; 713 }; 714 715 struct usb_ctl_report_desc { 716 int ucrd_size; 717 u_char ucrd_data[1024]; /* filled data size will vary */ 718 }; 719 720 #define USB_MAX_DEVNAMES 4 721 #define USB_MAX_DEVNAMELEN 16 722 struct usb_device_info { 723 u_int8_t udi_bus; 724 u_int8_t udi_addr; /* device address */ 725 char udi_product[USB_MAX_STRING_LEN]; 726 char udi_vendor[USB_MAX_STRING_LEN]; 727 char udi_release[8]; 728 u_int16_t udi_productNo; 729 u_int16_t udi_vendorNo; 730 u_int16_t udi_releaseNo; 731 u_int8_t udi_class; 732 u_int8_t udi_subclass; 733 u_int8_t udi_protocol; 734 u_int8_t udi_config; 735 u_int8_t udi_speed; 736 #define USB_SPEED_LOW 1 737 #define USB_SPEED_FULL 2 738 #define USB_SPEED_HIGH 3 739 #define USB_SPEED_SUPER 4 740 u_int8_t udi_port; 741 int udi_power; /* power consumption in mA, 0 if selfpowered */ 742 int udi_nports; 743 char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN]; 744 u_int32_t udi_ports[16]; /* hub only: ports status/change */ 745 char udi_serial[USB_MAX_STRING_LEN]; 746 }; 747 748 struct usb_ctl_report { 749 int ucr_report; 750 u_char ucr_data[1024]; /* filled data size will vary */ 751 }; 752 753 struct usb_device_stats { 754 u_long uds_requests[4]; /* indexed by transfer type UE_* */ 755 }; 756 757 /* USB controller */ 758 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 759 #define USB_SETDEBUG _IOW ('U', 2, unsigned int) 760 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 761 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 762 #define USB_DEVICE_GET_CDESC _IOWR('U', 6, struct usb_device_cdesc) 763 #define USB_DEVICE_GET_FDESC _IOWR('U', 7, struct usb_device_fdesc) 764 #define USB_DEVICE_GET_DDESC _IOWR('U', 8, struct usb_device_ddesc) 765 766 /* Generic HID device */ 767 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) 768 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) 769 #define USB_SET_REPORT _IOW ('U', 24, struct usb_ctl_report) 770 #define USB_GET_REPORT_ID _IOR ('U', 25, int) 771 772 /* Generic USB device */ 773 #define USB_GET_CONFIG _IOR ('U', 100, int) 774 #define USB_SET_CONFIG _IOW ('U', 101, int) 775 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 776 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 777 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) 778 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) 779 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) 780 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) 781 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) 782 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) 783 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 784 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 785 #define USB_SET_SHORT_XFER _IOW ('U', 113, int) 786 #define USB_SET_TIMEOUT _IOW ('U', 114, int) 787 788 #endif /* _USB_H_ */ 789