usb.h revision 1.32
1 /* $NetBSD: usb.h,v 1.32 1999/09/06 17:16:47 augustss Exp $ */ 2 3 /* 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (augustss (at) carlstedt.se) at 9 * Carlstedt Research & Technology. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 41 #ifndef _USB_H_ 42 #define _USB_H_ 43 44 #include <sys/types.h> 45 #if defined(__NetBSD__) || defined(__OpenBSD__) 46 #include <sys/ioctl.h> 47 48 #if defined(_KERNEL) 49 #include <dev/usb/usb_port.h> 50 #endif /* _KERNEL */ 51 52 #elif defined(__FreeBSD__) 53 #include <sys/malloc.h> 54 55 #if defined(KERNEL) 56 MALLOC_DECLARE(M_USB); 57 MALLOC_DECLARE(M_USBDEV); 58 MALLOC_DECLARE(M_USBHC); 59 60 #include <dev/usb/usb_port.h> 61 #endif /* KERNEL */ 62 #endif /* __FreeBSD__ */ 63 64 65 #define USB_MAX_DEVICES 128 66 #define USB_START_ADDR 0 67 68 #define USB_CONTROL_ENDPOINT 0 69 #define USB_MAX_ENDPOINTS 16 70 71 #define USB_FRAMES_PER_SECOND 1000 72 73 /* 74 * The USB records contain some unaligned little-endian word 75 * components. The U[SG]ETW macros take care of both the alignment 76 * and endian problem and should always be used to access 16 bit 77 * values. 78 */ 79 typedef u_int8_t uByte; 80 typedef u_int8_t uWord[2]; 81 #define UGETW(w) ((w)[0] | ((w)[1] << 8)) 82 #define USETW(w,v) ((w)[0] = (u_int8_t)(v), (w)[1] = (u_int8_t)((v) >> 8)) 83 #define USETW2(w,h,l) ((w)[0] = (u_int8_t)(l), (w)[1] = (u_int8_t)(h)) 84 typedef u_int8_t uDWord[4]; 85 #define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24)) 86 #define USETDW(w,v) ((w)[0] = (u_int8_t)(v), \ 87 (w)[1] = (u_int8_t)((v) >> 8), \ 88 (w)[2] = (u_int8_t)((v) >> 16), \ 89 (w)[3] = (u_int8_t)((v) >> 24)) 90 /* 91 * On little-endian machines that can handle unanliged accesses 92 * (e.g. i386) these macros can be replaced by the following. 93 */ 94 #if 0 95 #define UGETW(w) (*(u_int16_t *)(w)) 96 #define USETW(w,v) (*(u_int16_t *)(w) = (v)) 97 #endif 98 99 typedef struct { 100 uByte bmRequestType; 101 uByte bRequest; 102 uWord wValue; 103 uWord wIndex; 104 uWord wLength; 105 } usb_device_request_t; 106 107 #define UT_WRITE 0x00 108 #define UT_READ 0x80 109 #define UT_STANDARD 0x00 110 #define UT_CLASS 0x20 111 #define UT_VENDOR 0x40 112 #define UT_DEVICE 0x00 113 #define UT_INTERFACE 0x01 114 #define UT_ENDPOINT 0x02 115 #define UT_OTHER 0x03 116 117 #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE) 118 #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE) 119 #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT) 120 #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE) 121 #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE) 122 #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT) 123 #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE) 124 #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE) 125 #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER) 126 #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT) 127 #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE) 128 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE) 129 #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER) 130 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT) 131 #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE) 132 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE) 133 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER) 134 #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT) 135 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE) 136 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE) 137 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER) 138 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT) 139 140 /* Requests */ 141 #define UR_GET_STATUS 0x00 142 #define UR_CLEAR_FEATURE 0x01 143 #define UR_SET_FEATURE 0x03 144 #define UR_SET_ADDRESS 0x05 145 #define UR_GET_DESCRIPTOR 0x06 146 #define UDESC_DEVICE 1 147 #define UDESC_CONFIG 2 148 #define UDESC_STRING 3 149 #define UDESC_INTERFACE 4 150 #define UDESC_ENDPOINT 5 151 #define UR_SET_DESCRIPTOR 0x07 152 #define UR_GET_CONFIG 0x08 153 #define UR_SET_CONFIG 0x09 154 #define UR_GET_INTERFACE 0x0a 155 #define UR_SET_INTERFACE 0x0b 156 #define UR_SYNCH_FRAME 0x0c 157 158 /* Feature numbers */ 159 #define UF_ENDPOINT_HALT 0 160 #define UF_DEVICE_REMOTE_WAKEUP 1 161 162 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */ 163 164 typedef struct { 165 uByte bLength; 166 uByte bDescriptorType; 167 uByte bDescriptorSubtype; 168 } usb_descriptor_t; 169 170 typedef struct { 171 uByte bLength; 172 uByte bDescriptorType; 173 uWord bcdUSB; 174 uByte bDeviceClass; 175 uByte bDeviceSubClass; 176 uByte bDeviceProtocol; 177 uByte bMaxPacketSize; 178 /* The fields below are not part of the initial descriptor. */ 179 uWord idVendor; 180 uWord idProduct; 181 uWord bcdDevice; 182 uByte iManufacturer; 183 uByte iProduct; 184 uByte iSerialNumber; 185 uByte bNumConfigurations; 186 } usb_device_descriptor_t; 187 #define USB_DEVICE_DESCRIPTOR_SIZE 18 188 189 typedef struct { 190 uByte bLength; 191 uByte bDescriptorType; 192 uWord wTotalLength; 193 uByte bNumInterface; 194 uByte bConfigurationValue; 195 uByte iConfiguration; 196 uByte bmAttributes; 197 #define UC_BUS_POWERED 0x80 198 #define UC_SELF_POWERED 0x40 199 #define UC_REMOTE_WAKEUP 0x20 200 uByte bMaxPower; /* max current in 2 mA units */ 201 #define UC_POWER_FACTOR 2 202 } usb_config_descriptor_t; 203 #define USB_CONFIG_DESCRIPTOR_SIZE 9 204 205 typedef struct { 206 uByte bLength; 207 uByte bDescriptorType; 208 uByte bInterfaceNumber; 209 uByte bAlternateSetting; 210 uByte bNumEndpoints; 211 uByte bInterfaceClass; 212 uByte bInterfaceSubClass; 213 uByte bInterfaceProtocol; 214 uByte iInterface; 215 } usb_interface_descriptor_t; 216 #define USB_INTERFACE_DESCRIPTOR_SIZE 9 217 218 typedef struct { 219 uByte bLength; 220 uByte bDescriptorType; 221 uByte bEndpointAddress; 222 #define UE_GET_DIR(a) ((a) & 0x80) 223 #define UE_DIR_IN 0x80 224 #define UE_DIR_OUT 0x00 225 #define UE_ADDR 0x0f 226 #define UE_GET_ADDR(a) ((a) & UE_ADDR) 227 uByte bmAttributes; 228 #define UE_XFERTYPE 0x03 229 #define UE_CONTROL 0x00 230 #define UE_ISOCHRONOUS 0x01 231 #define UE_BULK 0x02 232 #define UE_INTERRUPT 0x03 233 #define UE_ISO_TYPE 0x0c 234 #define UE_ISO_ASYNC 0x04 235 #define UE_ISO_ADAPT 0x08 236 #define UE_ISO_SYNC 0x0c 237 uWord wMaxPacketSize; 238 uByte bInterval; 239 } usb_endpoint_descriptor_t; 240 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7 241 242 typedef struct { 243 uByte bLength; 244 uByte bDescriptorType; 245 uWord bString[127]; 246 } usb_string_descriptor_t; 247 #define USB_MAX_STRING_LEN 128 248 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */ 249 250 /* Hub specific request */ 251 #define UR_GET_BUS_STATE 0x02 252 253 /* Hub features */ 254 #define UHF_C_HUB_LOCAL_POWER 0 255 #define UHF_C_HUB_OVER_CURRENT 1 256 #define UHF_PORT_CONNECTION 0 257 #define UHF_PORT_ENABLE 1 258 #define UHF_PORT_SUSPEND 2 259 #define UHF_PORT_OVER_CURRENT 3 260 #define UHF_PORT_RESET 4 261 #define UHF_PORT_POWER 8 262 #define UHF_PORT_LOW_SPEED 9 263 #define UHF_C_PORT_CONNECTION 16 264 #define UHF_C_PORT_ENABLE 17 265 #define UHF_C_PORT_SUSPEND 18 266 #define UHF_C_PORT_OVER_CURRENT 19 267 #define UHF_C_PORT_RESET 20 268 269 typedef struct { 270 uByte bDescLength; 271 uByte bDescriptorType; 272 uByte bNbrPorts; 273 uWord wHubCharacteristics; 274 #define UHD_PWR 0x03 275 #define UHD_PWR_GANGED 0x00 276 #define UHD_PWR_INDIVIDUAL 0x01 277 #define UHD_PWR_NO_SWITCH 0x02 278 #define UHD_COMPOUND 0x04 279 #define UHD_OC 0x18 280 #define UHD_OC_GLOBAL 0x00 281 #define UHD_OC_INDIVIDUAL 0x08 282 #define UHD_OC_NONE 0x10 283 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 284 #define UHD_PWRON_FACTOR 2 285 uByte bHubContrCurrent; 286 uByte DeviceRemovable[32]; /* max 255 ports */ 287 #define UHD_NOT_REMOV(desc, i) \ 288 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) 289 /* deprecated uByte PortPowerCtrlMask[]; */ 290 } usb_hub_descriptor_t; 291 #define USB_HUB_DESCRIPTOR_SIZE 8 292 293 typedef struct { 294 uWord wStatus; 295 /* Device status flags */ 296 #define UDS_SELF_POWERED 0x0001 297 #define UDS_REMOTE_WAKEUP 0x0002 298 /* Endpoint status flags */ 299 #define UES_HALT 0x0001 300 } usb_status_t; 301 302 typedef struct { 303 uWord wHubStatus; 304 #define UHS_LOCAL_POWER 0x0001 305 #define UHS_OVER_CURRENT 0x0002 306 uWord wHubChange; 307 } usb_hub_status_t; 308 309 typedef struct { 310 uWord wPortStatus; 311 #define UPS_CURRENT_CONNECT_STATUS 0x0001 312 #define UPS_PORT_ENABLED 0x0002 313 #define UPS_SUSPEND 0x0004 314 #define UPS_OVERCURRENT_INDICATOR 0x0008 315 #define UPS_RESET 0x0010 316 #define UPS_PORT_POWER 0x0100 317 #define UPS_LOW_SPEED 0x0200 318 uWord wPortChange; 319 #define UPS_C_CONNECT_STATUS 0x0001 320 #define UPS_C_PORT_ENABLED 0x0002 321 #define UPS_C_SUSPEND 0x0004 322 #define UPS_C_OVERCURRENT_INDICATOR 0x0008 323 #define UPS_C_PORT_RESET 0x0010 324 } usb_port_status_t; 325 326 #define UDESC_CS_DEVICE 0x21 327 #define UDESC_CS_CONFIG 0x22 328 #define UDESC_CS_STRING 0x23 329 #define UDESC_CS_INTERFACE 0x24 330 #define UDESC_CS_ENDPOINT 0x25 331 332 #define UDESC_HUB 0x29 333 334 #define UCLASS_UNSPEC 0 335 #define UCLASS_AUDIO 1 336 #define USUBCLASS_AUDIOCONTROL 1 337 #define USUBCLASS_AUDIOSTREAM 2 338 #define USUBCLASS_MIDISTREAM 3 339 #define UCLASS_CDC 2 /* communication */ 340 #define USUBCLASS_DIRECT_LINE_CONTROL_MODEL 1 341 #define USUBCLASS_ABSTRACT_CONTROL_MODEL 2 342 #define USUBCLASS_TELEPHONE_CONTROL_MODEL 3 343 #define USUBCLASS_MULTICHANNEL_CONTROL_MODEL 4 344 #define USUBCLASS_CAPI_CONTROLMODEL 5 345 #define USUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6 346 #define USUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7 347 #define UPROTO_CDC_AT 1 348 #define UCLASS_HID 3 349 #define USUBCLASS_BOOT 1 350 #define UCLASS_PRINTER 7 351 #define USUBCLASS_PRINTER 1 352 #define UPROTO_PRINTER_UNI 1 353 #define UPROTO_PRINTER_BI 2 354 #define UCLASS_MASS 8 355 #define USUBCLASS_RBC 1 356 #define USUBCLASS_SFF8020I 2 357 #define USUBCLASS_QIC157 3 358 #define USUBCLASS_UFI 4 359 #define USUBCLASS_SFF8070I 5 360 #define USUBCLASS_SCSI 6 361 #define UPROTO_MASS_CBI_I 0 362 #define UPROTO_MASS_CBI 1 363 #define UPROTO_MASS_BULK 80 364 #define UPROTO_MASS_BULK2 2 365 #define UCLASS_HUB 9 366 #define USUBCLASS_HUB 0 367 #define UCLASS_DATA 10 368 369 #define USB_HUB_MAX_DEPTH 5 370 371 /* 372 * Minimum time a device needs to be powered down to go through 373 * a power cycle. XXX Are these time in the spec? 374 */ 375 #define USB_POWER_DOWN_TIME 200 /* ms */ 376 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 377 378 #if 0 379 /* These are the values from the spec. */ 380 #define USB_PORT_RESET_DELAY 10 /* ms */ 381 #define USB_PORT_RESET_SETTLE 10 /* ms */ 382 #define USB_PORT_POWERUP_DELAY 100 /* ms */ 383 #define USB_SET_ADDRESS_SETTLE 2 /* ms */ 384 #define USB_RESUME_TIME (20*5) /* ms */ 385 #define USB_RESUME_WAIT 10 /* ms */ 386 #define USB_RESUME_RECOVERY 10 /* ms */ 387 #else 388 /* Allow for marginal (i.e. non-conforming) devices. */ 389 #define USB_PORT_RESET_DELAY 50 /* ms */ 390 #define USB_PORT_RESET_RECOVERY 50 /* ms */ 391 #define USB_PORT_POWERUP_DELAY 200 /* ms */ 392 #define USB_SET_ADDRESS_SETTLE 10 /* ms */ 393 #define USB_RESUME_DELAY (50*5) /* ms */ 394 #define USB_RESUME_WAIT 50 /* ms */ 395 #define USB_RESUME_RECOVERY 50 /* ms */ 396 #endif 397 398 #define USB_MIN_POWER 100 /* mA */ 399 #define USB_MAX_POWER 500 /* mA */ 400 401 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ 402 403 /*** ioctl() related stuff ***/ 404 405 struct usb_ctl_request { 406 int addr; 407 usb_device_request_t request; 408 void *data; 409 int flags; 410 /* XXX must match flags in usbdi.h */ 411 #define USBD_SHORT_XFER_OK 0x04 412 int actlen; /* actual length transferred */ 413 }; 414 415 struct usb_alt_interface { 416 int config_index; 417 int interface_index; 418 int alt_no; 419 }; 420 421 #define USB_CURRENT_CONFIG_INDEX (-1) 422 #define USB_CURRENT_ALT_INDEX (-1) 423 424 struct usb_config_desc { 425 int config_index; 426 usb_config_descriptor_t desc; 427 }; 428 429 struct usb_interface_desc { 430 int config_index; 431 int interface_index; 432 int alt_index; 433 usb_interface_descriptor_t desc; 434 }; 435 436 struct usb_endpoint_desc { 437 int config_index; 438 int interface_index; 439 int alt_index; 440 int endpoint_index; 441 usb_endpoint_descriptor_t desc; 442 }; 443 444 struct usb_full_desc { 445 int config_index; 446 u_int size; 447 u_char *data; 448 }; 449 450 struct usb_string_desc { 451 int string_index; 452 int language_id; 453 usb_string_descriptor_t desc; 454 }; 455 456 struct usb_ctl_report_desc { 457 int size; 458 u_char data[1024]; /* filled data size will vary */ 459 }; 460 461 struct usb_device_info { 462 u_int8_t addr; /* device address */ 463 char product[USB_MAX_STRING_LEN]; 464 char vendor[USB_MAX_STRING_LEN]; 465 char release[8]; 466 u_int16_t productNo; 467 u_int16_t vendorNo; 468 u_int8_t class; 469 u_int8_t config; 470 u_int8_t lowspeed; 471 int power; /* power consumption in mA, 0 if selfpowered */ 472 int nports; 473 u_int8_t ports[16];/* hub only: addresses of devices on ports */ 474 #define USB_PORT_ENABLED 0xff 475 #define USB_PORT_SUSPENDED 0xfe 476 #define USB_PORT_POWERED 0xfd 477 #define USB_PORT_DISABLED 0xfc 478 }; 479 480 struct usb_ctl_report { 481 int report; 482 u_char data[1024]; /* filled data size will vary */ 483 }; 484 485 struct usb_device_stats { 486 u_long requests[4]; /* indexed by transfer type UE_* */ 487 }; 488 489 /* USB controller */ 490 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 491 #define USB_SETDEBUG _IOW ('U', 2, int) 492 #define USB_DISCOVER _IO ('U', 3) 493 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 494 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 495 496 /* Generic HID device */ 497 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) 498 #define USB_SET_IMMED _IOW ('U', 22, int) 499 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) 500 501 /* Generic USB device */ 502 #define USB_GET_CONFIG _IOR ('U', 100, int) 503 #define USB_SET_CONFIG _IOW ('U', 101, int) 504 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 505 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 506 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) 507 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) 508 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) 509 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) 510 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) 511 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) 512 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc) 513 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 514 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 515 #define USB_SET_SHORT_XFER _IOW ('U', 113, int) 516 #define USB_SET_TIMEOUT _IOW ('U', 114, int) 517 518 /* Modem device */ 519 #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int) 520 #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int) 521 522 #endif /* _USB_H_ */ 523
Indexes created Tue Sep 23 07:09:52 GMT 2025