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