1 /* $OpenBSD: usb.h,v 1.37 2011/03/04 23:55:32 kettenis 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_CS_DEVICE 0x21 /* class specific */ 142 #define UDESC_CS_CONFIG 0x22 143 #define UDESC_CS_STRING 0x23 144 #define UDESC_CS_INTERFACE 0x24 145 #define UDESC_CS_ENDPOINT 0x25 146 #define UDESC_HUB 0x29 147 #define UR_SET_DESCRIPTOR 0x07 148 #define UR_GET_CONFIG 0x08 149 #define UR_SET_CONFIG 0x09 150 #define UR_GET_INTERFACE 0x0a 151 #define UR_SET_INTERFACE 0x0b 152 #define UR_SYNCH_FRAME 0x0c 153 154 /* Feature numbers */ 155 #define UF_ENDPOINT_HALT 0 156 #define UF_DEVICE_REMOTE_WAKEUP 1 157 #define UF_TEST_MODE 2 158 159 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */ 160 161 #define USB_2_MAX_CTRL_PACKET 64 162 #define USB_2_MAX_BULK_PACKET 512 163 164 typedef struct { 165 uByte bLength; 166 uByte bDescriptorType; 167 uByte bDescriptorSubtype; 168 } __packed usb_descriptor_t; 169 170 typedef struct { 171 uByte bLength; 172 uByte bDescriptorType; 173 uWord bcdUSB; 174 #define UD_USB_2_0 0x0200 175 #define UD_IS_USB2(d) (UGETW((d)->bcdUSB) >= UD_USB_2_0) 176 uByte bDeviceClass; 177 uByte bDeviceSubClass; 178 uByte bDeviceProtocol; 179 uByte bMaxPacketSize; 180 /* The fields below are not part of the initial descriptor. */ 181 uWord idVendor; 182 uWord idProduct; 183 uWord bcdDevice; 184 uByte iManufacturer; 185 uByte iProduct; 186 uByte iSerialNumber; 187 uByte bNumConfigurations; 188 } __packed usb_device_descriptor_t; 189 #define USB_DEVICE_DESCRIPTOR_SIZE 18 190 191 typedef struct { 192 uByte bLength; 193 uByte bDescriptorType; 194 uWord wTotalLength; 195 uByte bNumInterface; 196 uByte bConfigurationValue; 197 uByte iConfiguration; 198 uByte bmAttributes; 199 #define UC_BUS_POWERED 0x80 200 #define UC_SELF_POWERED 0x40 201 #define UC_REMOTE_WAKEUP 0x20 202 uByte bMaxPower; /* max current in 2 mA units */ 203 #define UC_POWER_FACTOR 2 204 } __packed usb_config_descriptor_t; 205 #define USB_CONFIG_DESCRIPTOR_SIZE 9 206 207 typedef struct { 208 uByte bLength; 209 uByte bDescriptorType; 210 uByte bInterfaceNumber; 211 uByte bAlternateSetting; 212 uByte bNumEndpoints; 213 uByte bInterfaceClass; 214 uByte bInterfaceSubClass; 215 uByte bInterfaceProtocol; 216 uByte iInterface; 217 } __packed usb_interface_descriptor_t; 218 #define USB_INTERFACE_DESCRIPTOR_SIZE 9 219 220 typedef struct { 221 uByte bLength; 222 uByte bDescriptorType; 223 uByte bEndpointAddress; 224 #define UE_GET_DIR(a) ((a) & 0x80) 225 #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7)) 226 #define UE_DIR_IN 0x80 227 #define UE_DIR_OUT 0x00 228 #define UE_ADDR 0x0f 229 #define UE_GET_ADDR(a) ((a) & UE_ADDR) 230 uByte bmAttributes; 231 #define UE_XFERTYPE 0x03 232 #define UE_CONTROL 0x00 233 #define UE_ISOCHRONOUS 0x01 234 #define UE_BULK 0x02 235 #define UE_INTERRUPT 0x03 236 #define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE) 237 #define UE_ISO_TYPE 0x0c 238 #define UE_ISO_ASYNC 0x04 239 #define UE_ISO_ADAPT 0x08 240 #define UE_ISO_SYNC 0x0c 241 #define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE) 242 uWord wMaxPacketSize; 243 #define UE_GET_TRANS(a) (((a) >> 11) & 0x3) 244 #define UE_GET_SIZE(a) ((a) & 0x7ff) 245 uByte bInterval; 246 } __packed usb_endpoint_descriptor_t; 247 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7 248 249 /* 250 * Note: The length of the USB string descriptor is stored in a one byte 251 * value and can therefore be no longer than 255 bytes. Two bytes are 252 * used for the length itself and the descriptor type, a theoretical maximum 253 * of 253 bytes is left for the actual string data. Since the strings are 254 * encoded as 2-byte unicode characters, only 252 bytes or 126 two-byte 255 * characters can be used. USB_MAX_STRING_LEN is defined as 127, leaving 256 * space for the terminal '\0' character in C strings. 257 */ 258 typedef struct { 259 uByte bLength; 260 uByte bDescriptorType; 261 uWord bString[126]; 262 } __packed usb_string_descriptor_t; 263 #define USB_MAX_STRING_LEN 127 264 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */ 265 266 /* Hub specific request */ 267 #define UR_GET_BUS_STATE 0x02 268 #define UR_CLEAR_TT_BUFFER 0x08 269 #define UR_RESET_TT 0x09 270 #define UR_GET_TT_STATE 0x0a 271 #define UR_STOP_TT 0x0b 272 273 /* Hub features */ 274 #define UHF_C_HUB_LOCAL_POWER 0 275 #define UHF_C_HUB_OVER_CURRENT 1 276 #define UHF_PORT_CONNECTION 0 277 #define UHF_PORT_ENABLE 1 278 #define UHF_PORT_SUSPEND 2 279 #define UHF_PORT_OVER_CURRENT 3 280 #define UHF_PORT_RESET 4 281 #define UHF_PORT_POWER 8 282 #define UHF_PORT_LOW_SPEED 9 283 #define UHF_C_PORT_CONNECTION 16 284 #define UHF_C_PORT_ENABLE 17 285 #define UHF_C_PORT_SUSPEND 18 286 #define UHF_C_PORT_OVER_CURRENT 19 287 #define UHF_C_PORT_RESET 20 288 #define UHF_PORT_TEST 21 289 #define UHF_PORT_INDICATOR 22 290 #define UHF_PORT_DISOWN_TO_1_1 30 291 292 typedef struct { 293 uByte bDescLength; 294 uByte bDescriptorType; 295 uByte bNbrPorts; 296 uWord wHubCharacteristics; 297 #define UHD_PWR 0x0003 298 #define UHD_PWR_GANGED 0x0000 299 #define UHD_PWR_INDIVIDUAL 0x0001 300 #define UHD_PWR_NO_SWITCH 0x0002 301 #define UHD_COMPOUND 0x0004 302 #define UHD_OC 0x0018 303 #define UHD_OC_GLOBAL 0x0000 304 #define UHD_OC_INDIVIDUAL 0x0008 305 #define UHD_OC_NONE 0x0010 306 #define UHD_TT_THINK 0x0060 307 #define UHD_TT_THINK_8 0x0000 308 #define UHD_TT_THINK_16 0x0020 309 #define UHD_TT_THINK_24 0x0040 310 #define UHD_TT_THINK_32 0x0060 311 #define UHD_PORT_IND 0x0080 312 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 313 #define UHD_PWRON_FACTOR 2 314 uByte bHubContrCurrent; 315 uByte DeviceRemovable[32]; /* max 255 ports */ 316 #define UHD_NOT_REMOV(desc, i) \ 317 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) 318 /* deprecated */ uByte PortPowerCtrlMask[1]; 319 } __packed usb_hub_descriptor_t; 320 #define USB_HUB_DESCRIPTOR_SIZE 9 /* includes deprecated PortPowerCtrlMask */ 321 322 typedef struct { 323 uByte bLength; 324 uByte bDescriptorType; 325 uWord bcdUSB; 326 uByte bDeviceClass; 327 uByte bDeviceSubClass; 328 uByte bDeviceProtocol; 329 uByte bMaxPacketSize0; 330 uByte bNumConfigurations; 331 uByte bReserved; 332 } __packed usb_device_qualifier_t; 333 #define USB_DEVICE_QUALIFIER_SIZE 10 334 335 typedef struct { 336 uByte bLength; 337 uByte bDescriptorType; 338 uByte bmAttributes; 339 #define UOTG_SRP 0x01 340 #define UOTG_HNP 0x02 341 } __packed usb_otg_descriptor_t; 342 343 /* OTG feature selectors */ 344 #define UOTG_B_HNP_ENABLE 3 345 #define UOTG_A_HNP_SUPPORT 4 346 #define UOTG_A_ALT_HNP_SUPPORT 5 347 348 typedef struct { 349 uWord wStatus; 350 /* Device status flags */ 351 #define UDS_SELF_POWERED 0x0001 352 #define UDS_REMOTE_WAKEUP 0x0002 353 /* Endpoint status flags */ 354 #define UES_HALT 0x0001 355 } __packed usb_status_t; 356 357 typedef struct { 358 uWord wHubStatus; 359 #define UHS_LOCAL_POWER 0x0001 360 #define UHS_OVER_CURRENT 0x0002 361 uWord wHubChange; 362 } __packed usb_hub_status_t; 363 364 typedef struct { 365 uWord wPortStatus; 366 #define UPS_CURRENT_CONNECT_STATUS 0x0001 367 #define UPS_PORT_ENABLED 0x0002 368 #define UPS_SUSPEND 0x0004 369 #define UPS_OVERCURRENT_INDICATOR 0x0008 370 #define UPS_RESET 0x0010 371 #define UPS_PORT_POWER 0x0100 372 #define UPS_LOW_SPEED 0x0200 373 #define UPS_HIGH_SPEED 0x0400 374 #define UPS_PORT_TEST 0x0800 375 #define UPS_PORT_INDICATOR 0x1000 376 uWord wPortChange; 377 #define UPS_C_CONNECT_STATUS 0x0001 378 #define UPS_C_PORT_ENABLED 0x0002 379 #define UPS_C_SUSPEND 0x0004 380 #define UPS_C_OVERCURRENT_INDICATOR 0x0008 381 #define UPS_C_PORT_RESET 0x0010 382 } __packed usb_port_status_t; 383 384 /* Device class codes */ 385 #define UDCLASS_IN_INTERFACE 0x00 386 #define UDCLASS_COMM 0x02 387 #define UDCLASS_HUB 0x09 388 #define UDSUBCLASS_HUB 0x00 389 #define UDPROTO_FSHUB 0x00 390 #define UDPROTO_HSHUBSTT 0x01 391 #define UDPROTO_HSHUBMTT 0x02 392 #define UDCLASS_DIAGNOSTIC 0xdc 393 #define UDCLASS_WIRELESS 0xe0 394 #define UDCLASS_VIDEO 0xef 395 #define UDSUBCLASS_RF 0x01 396 #define UDPROTO_BLUETOOTH 0x01 397 #define UDCLASS_VENDOR 0xff 398 399 /* Interface class codes */ 400 #define UICLASS_UNSPEC 0x00 401 402 #define UICLASS_AUDIO 0x01 403 #define UISUBCLASS_AUDIOCONTROL 1 404 #define UISUBCLASS_AUDIOSTREAM 2 405 #define UISUBCLASS_MIDISTREAM 3 406 407 #define UICLASS_CDC 0x02 /* communication */ 408 #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1 409 #define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2 410 #define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3 411 #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4 412 #define UISUBCLASS_CAPI_CONTROLMODEL 5 413 #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6 414 #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7 415 #define UIPROTO_CDC_AT 1 416 417 #define UICLASS_HID 0x03 418 #define UISUBCLASS_BOOT 1 419 #define UIPROTO_BOOT_KEYBOARD 1 420 421 #define UICLASS_PHYSICAL 0x05 422 423 #define UICLASS_IMAGE 0x06 424 425 #define UICLASS_PRINTER 0x07 426 #define UISUBCLASS_PRINTER 1 427 #define UIPROTO_PRINTER_UNI 1 428 #define UIPROTO_PRINTER_BI 2 429 #define UIPROTO_PRINTER_1284 3 430 431 #define UICLASS_MASS 0x08 432 #define UISUBCLASS_RBC 1 433 #define UISUBCLASS_SFF8020I 2 434 #define UISUBCLASS_QIC157 3 435 #define UISUBCLASS_UFI 4 436 #define UISUBCLASS_SFF8070I 5 437 #define UISUBCLASS_SCSI 6 438 #define UIPROTO_MASS_CBI_I 0 439 #define UIPROTO_MASS_CBI 1 440 #define UIPROTO_MASS_BBB_OLD 2 /* Not in the spec anymore */ 441 #define UIPROTO_MASS_BBB 80 /* 'P' for the Iomega Zip drive */ 442 443 #define UICLASS_HUB 0x09 444 #define UISUBCLASS_HUB 0 445 #define UIPROTO_FSHUB 0 446 #define UIPROTO_HSHUBSTT 0 /* Yes, same as previous */ 447 #define UIPROTO_HSHUBMTT 1 448 449 #define UICLASS_CDC_DATA 0x0a 450 #define UISUBCLASS_DATA 0 451 #define UIPROTO_DATA_ISDNBRI 0x30 /* Physical iface */ 452 #define UIPROTO_DATA_HDLC 0x31 /* HDLC */ 453 #define UIPROTO_DATA_TRANSPARENT 0x32 /* Transparent */ 454 #define UIPROTO_DATA_Q921M 0x50 /* Management for Q921 */ 455 #define UIPROTO_DATA_Q921 0x51 /* Data for Q921 */ 456 #define UIPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */ 457 #define UIPROTO_DATA_V42BIS 0x90 /* Data compression */ 458 #define UIPROTO_DATA_Q931 0x91 /* Euro-ISDN */ 459 #define UIPROTO_DATA_V120 0x92 /* V.24 rate adaption */ 460 #define UIPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */ 461 #define UIPROTO_DATA_HOST_BASED 0xfd /* Host based driver */ 462 #define UIPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc.*/ 463 #define UIPROTO_DATA_VENDOR 0xff /* Vendor specific */ 464 465 #define UICLASS_SMARTCARD 0x0b 466 467 /*#define UICLASS_FIRM_UPD 0x0c*/ 468 469 #define UICLASS_SECURITY 0x0d 470 471 #define UICLASS_VIDEO 0x0e 472 #define UISUBCLASS_VIDEOCONTROL 1 473 #define UISUBCLASS_VIDEOSTREAM 2 474 #define UISUBCLASS_VIDEO_IF_COLLECTION 3 475 476 #define UICLASS_DIAGNOSTIC 0xdc 477 478 #define UICLASS_WIRELESS 0xe0 479 #define UISUBCLASS_RF 0x01 480 #define UIPROTO_BLUETOOTH 0x01 481 #define UIPROTO_RNDIS 0x03 482 483 #define UICLASS_APPL_SPEC 0xfe 484 #define UISUBCLASS_FIRMWARE_DOWNLOAD 1 485 #define UISUBCLASS_IRDA 2 486 #define UIPROTO_IRDA 0 487 488 #define UICLASS_VENDOR 0xff 489 490 491 #define USB_HUB_MAX_DEPTH 5 492 493 /* 494 * Minimum time a device needs to be powered down to go through 495 * a power cycle. XXX Are these time in the spec? 496 */ 497 #define USB_POWER_DOWN_TIME 200 /* ms */ 498 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 499 500 #if 0 501 /* These are the values from the spec. */ 502 #define USB_PORT_RESET_DELAY 10 /* ms */ 503 #define USB_PORT_ROOT_RESET_DELAY 50 /* ms */ 504 #define USB_PORT_RESET_RECOVERY 10 /* ms */ 505 #define USB_PORT_POWERUP_DELAY 100 /* ms */ 506 #define USB_SET_ADDRESS_SETTLE 2 /* ms */ 507 #define USB_RESUME_DELAY (20*5) /* ms */ 508 #define USB_RESUME_WAIT 10 /* ms */ 509 #define USB_RESUME_RECOVERY 10 /* ms */ 510 #define USB_EXTRA_POWER_UP_TIME 0 /* ms */ 511 #else 512 /* Allow for marginal (i.e. non-conforming) devices. */ 513 #define USB_PORT_RESET_DELAY 50 /* ms */ 514 #define USB_PORT_ROOT_RESET_DELAY 100 /* ms */ 515 #define USB_PORT_RESET_RECOVERY 250 /* ms */ 516 #define USB_PORT_POWERUP_DELAY 300 /* ms */ 517 #define USB_SET_ADDRESS_SETTLE 10 /* ms */ 518 #define USB_RESUME_DELAY (50*5) /* ms */ 519 #define USB_RESUME_WAIT 50 /* ms */ 520 #define USB_RESUME_RECOVERY 50 /* ms */ 521 #define USB_EXTRA_POWER_UP_TIME 20 /* ms */ 522 #endif 523 524 #define USB_MIN_POWER 100 /* mA */ 525 #define USB_MAX_POWER 500 /* mA */ 526 527 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ 528 529 530 #define USB_UNCONFIG_NO 0 531 #define USB_UNCONFIG_INDEX (-1) 532 533 /*** ioctl() related stuff ***/ 534 535 struct usb_ctl_request { 536 int ucr_addr; 537 usb_device_request_t ucr_request; 538 void *ucr_data; 539 int ucr_flags; 540 #define USBD_SHORT_XFER_OK 0x04 /* allow short reads */ 541 int ucr_actlen; /* actual length transferred */ 542 }; 543 544 struct usb_alt_interface { 545 int uai_config_index; 546 int uai_interface_index; 547 int uai_alt_no; 548 }; 549 550 #define USB_CURRENT_CONFIG_INDEX (-1) 551 #define USB_CURRENT_ALT_INDEX (-1) 552 553 struct usb_config_desc { 554 int ucd_config_index; 555 usb_config_descriptor_t ucd_desc; 556 }; 557 558 struct usb_interface_desc { 559 int uid_config_index; 560 int uid_interface_index; 561 int uid_alt_index; 562 usb_interface_descriptor_t uid_desc; 563 }; 564 565 struct usb_endpoint_desc { 566 int ued_config_index; 567 int ued_interface_index; 568 int ued_alt_index; 569 int ued_endpoint_index; 570 usb_endpoint_descriptor_t ued_desc; 571 }; 572 573 struct usb_full_desc { 574 int ufd_config_index; 575 u_int ufd_size; 576 u_char *ufd_data; 577 }; 578 579 struct usb_string_desc { 580 int usd_string_index; 581 int usd_language_id; 582 usb_string_descriptor_t usd_desc; 583 }; 584 585 struct usb_ctl_report_desc { 586 int ucrd_size; 587 u_char ucrd_data[1024]; /* filled data size will vary */ 588 }; 589 590 typedef struct { u_int32_t cookie; } usb_event_cookie_t; 591 592 #define USB_MAX_DEVNAMES 4 593 #define USB_MAX_DEVNAMELEN 16 594 struct usb_device_info { 595 u_int8_t udi_bus; 596 u_int8_t udi_addr; /* device address */ 597 usb_event_cookie_t udi_cookie; 598 char udi_product[USB_MAX_STRING_LEN]; 599 char udi_vendor[USB_MAX_STRING_LEN]; 600 char udi_release[8]; 601 u_int16_t udi_productNo; 602 u_int16_t udi_vendorNo; 603 u_int16_t udi_releaseNo; 604 u_int8_t udi_class; 605 u_int8_t udi_subclass; 606 u_int8_t udi_protocol; 607 u_int8_t udi_config; 608 u_int8_t udi_speed; 609 #define USB_SPEED_LOW 1 610 #define USB_SPEED_FULL 2 611 #define USB_SPEED_HIGH 3 612 int udi_power; /* power consumption in mA, 0 if selfpowered */ 613 int udi_nports; 614 char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN]; 615 u_int8_t udi_ports[16];/* hub only: addresses of devices on ports */ 616 #define USB_PORT_ENABLED 0xff 617 #define USB_PORT_SUSPENDED 0xfe 618 #define USB_PORT_POWERED 0xfd 619 #define USB_PORT_DISABLED 0xfc 620 char udi_serial[USB_MAX_STRING_LEN]; 621 }; 622 623 /* OpenBSD <= 4.8 version, to be removed eventually */ 624 struct usb_device_info_48 { 625 u_int8_t udi_bus; 626 u_int8_t udi_addr; /* device address */ 627 usb_event_cookie_t udi_cookie; 628 char udi_product[USB_MAX_STRING_LEN]; 629 char udi_vendor[USB_MAX_STRING_LEN]; 630 char udi_release[8]; 631 u_int16_t udi_productNo; 632 u_int16_t udi_vendorNo; 633 u_int16_t udi_releaseNo; 634 u_int8_t udi_class; 635 u_int8_t udi_subclass; 636 u_int8_t udi_protocol; 637 u_int8_t udi_config; 638 u_int8_t udi_speed; 639 int udi_power; /* power consumption in mA, 0 if selfpowered */ 640 int udi_nports; 641 char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN]; 642 u_int8_t udi_ports[16];/* hub only: addresses of devices on ports */ 643 }; 644 645 struct usb_ctl_report { 646 int ucr_report; 647 u_char ucr_data[1024]; /* filled data size will vary */ 648 }; 649 650 struct usb_device_stats { 651 u_long uds_requests[4]; /* indexed by transfer type UE_* */ 652 }; 653 654 /* Events that can be read from /dev/usb */ 655 struct usb_event { 656 int ue_type; 657 #define USB_EVENT_CTRLR_ATTACH 1 658 #define USB_EVENT_CTRLR_DETACH 2 659 #define USB_EVENT_DEVICE_ATTACH 3 660 #define USB_EVENT_DEVICE_DETACH 4 661 #define USB_EVENT_DRIVER_ATTACH 5 662 #define USB_EVENT_DRIVER_DETACH 6 663 #define USB_EVENT_IS_ATTACH(n) ((n) == USB_EVENT_CTRLR_ATTACH || (n) == USB_EVENT_DEVICE_ATTACH || (n) == USB_EVENT_DRIVER_ATTACH) 664 #define USB_EVENT_IS_DETACH(n) ((n) == USB_EVENT_CTRLR_DETACH || (n) == USB_EVENT_DEVICE_DETACH || (n) == USB_EVENT_DRIVER_DETACH) 665 struct timespec ue_time; 666 union { 667 struct { 668 int ue_bus; 669 } ue_ctrlr; 670 struct usb_device_info ue_device; 671 struct { 672 usb_event_cookie_t ue_cookie; 673 char ue_devname[16]; 674 } ue_driver; 675 } u; 676 }; 677 678 /* USB controller */ 679 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 680 #define USB_SETDEBUG _IOW ('U', 2, unsigned int) 681 #define USB_DISCOVER _IO ('U', 3) 682 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 683 #define USB_DEVICEINFO_48 _IOWR('U', 4, struct usb_device_info_48) 684 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 685 686 /* Generic HID device */ 687 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) 688 #define USB_SET_IMMED _IOW ('U', 22, int) 689 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) 690 #define USB_SET_REPORT _IOW ('U', 24, struct usb_ctl_report) 691 #define USB_GET_REPORT_ID _IOR ('U', 25, int) 692 693 /* Generic USB device */ 694 #define USB_GET_CONFIG _IOR ('U', 100, int) 695 #define USB_SET_CONFIG _IOW ('U', 101, int) 696 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 697 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 698 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) 699 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) 700 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) 701 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) 702 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) 703 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) 704 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc) 705 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 706 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 707 #define USB_SET_SHORT_XFER _IOW ('U', 113, int) 708 #define USB_SET_TIMEOUT _IOW ('U', 114, int) 709 710 /* Modem device */ 711 #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int) 712 #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int) 713 714 #endif /* _USB_H_ */ 715