usb.h revision 1.29
1 /* $NetBSD: usb.h,v 1.29 1999/08/22 20:12:39 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_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE) 127 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE) 128 #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER) 129 #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE) 130 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE) 131 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER) 132 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE) 133 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE) 134 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER) 135 136 /* Requests */ 137 #define UR_GET_STATUS 0x00 138 #define UR_CLEAR_FEATURE 0x01 139 #define UR_SET_FEATURE 0x03 140 #define UR_SET_ADDRESS 0x05 141 #define UR_GET_DESCRIPTOR 0x06 142 #define UDESC_DEVICE 1 143 #define UDESC_CONFIG 2 144 #define UDESC_STRING 3 145 #define UDESC_INTERFACE 4 146 #define UDESC_ENDPOINT 5 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 158 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */ 159 160 typedef struct { 161 uByte bLength; 162 uByte bDescriptorType; 163 uByte bDescriptorSubtype; 164 } usb_descriptor_t; 165 166 typedef struct { 167 uByte bLength; 168 uByte bDescriptorType; 169 uWord bcdUSB; 170 uByte bDeviceClass; 171 uByte bDeviceSubClass; 172 uByte bDeviceProtocol; 173 uByte bMaxPacketSize; 174 /* The fields below are not part of the initial descriptor. */ 175 uWord idVendor; 176 uWord idProduct; 177 uWord bcdDevice; 178 uByte iManufacturer; 179 uByte iProduct; 180 uByte iSerialNumber; 181 uByte bNumConfigurations; 182 } usb_device_descriptor_t; 183 #define USB_DEVICE_DESCRIPTOR_SIZE 18 184 185 typedef struct { 186 uByte bLength; 187 uByte bDescriptorType; 188 uWord wTotalLength; 189 uByte bNumInterface; 190 uByte bConfigurationValue; 191 uByte iConfiguration; 192 uByte bmAttributes; 193 #define UC_BUS_POWERED 0x80 194 #define UC_SELF_POWERED 0x40 195 #define UC_REMOTE_WAKEUP 0x20 196 uByte bMaxPower; /* max current in 2 mA units */ 197 #define UC_POWER_FACTOR 2 198 } usb_config_descriptor_t; 199 #define USB_CONFIG_DESCRIPTOR_SIZE 9 200 201 typedef struct { 202 uByte bLength; 203 uByte bDescriptorType; 204 uByte bInterfaceNumber; 205 uByte bAlternateSetting; 206 uByte bNumEndpoints; 207 uByte bInterfaceClass; 208 uByte bInterfaceSubClass; 209 uByte bInterfaceProtocol; 210 uByte iInterface; 211 } usb_interface_descriptor_t; 212 #define USB_INTERFACE_DESCRIPTOR_SIZE 9 213 214 typedef struct { 215 uByte bLength; 216 uByte bDescriptorType; 217 uByte bEndpointAddress; 218 #define UE_IN 0x80 219 #define UE_OUT 0x00 220 #define UE_ADDR 0x0f 221 #define UE_GET_ADDR(a) ((a) & UE_ADDR) 222 #define UE_GET_IN(a) (((a) >> 7) & 1) 223 #define UE_GET_DIR(a) ((a) & 0x80) 224 uByte bmAttributes; 225 #define UE_XFERTYPE 0x03 226 #define UE_CONTROL 0x00 227 #define UE_ISOCHRONOUS 0x01 228 #define UE_BULK 0x02 229 #define UE_INTERRUPT 0x03 230 #define UE_ISO_TYPE 0x0c 231 #define UE_ISO_ASYNC 0x04 232 #define UE_ISO_ADAPT 0x08 233 #define UE_ISO_SYNC 0x0c 234 uWord wMaxPacketSize; 235 uByte bInterval; 236 } usb_endpoint_descriptor_t; 237 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7 238 239 typedef struct { 240 uByte bLength; 241 uByte bDescriptorType; 242 uWord bString[127]; 243 } usb_string_descriptor_t; 244 #define USB_MAX_STRING_LEN 128 245 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */ 246 247 /* Hub specific request */ 248 #define UR_GET_BUS_STATE 0x02 249 250 /* Hub features */ 251 #define UHF_C_HUB_LOCAL_POWER 0 252 #define UHF_C_HUB_OVER_CURRENT 1 253 #define UHF_PORT_CONNECTION 0 254 #define UHF_PORT_ENABLE 1 255 #define UHF_PORT_SUSPEND 2 256 #define UHF_PORT_OVER_CURRENT 3 257 #define UHF_PORT_RESET 4 258 #define UHF_PORT_POWER 8 259 #define UHF_PORT_LOW_SPEED 9 260 #define UHF_C_PORT_CONNECTION 16 261 #define UHF_C_PORT_ENABLE 17 262 #define UHF_C_PORT_SUSPEND 18 263 #define UHF_C_PORT_OVER_CURRENT 19 264 #define UHF_C_PORT_RESET 20 265 266 typedef struct { 267 uByte bDescLength; 268 uByte bDescriptorType; 269 uByte bNbrPorts; 270 uWord wHubCharacteristics; 271 #define UHD_PWR 0x03 272 #define UHD_PWR_GANGED 0x00 273 #define UHD_PWR_INDIVIDUAL 0x01 274 #define UHD_PWR_NO_SWITCH 0x02 275 #define UHD_COMPOUND 0x04 276 #define UHD_OC 0x18 277 #define UHD_OC_GLOBAL 0x00 278 #define UHD_OC_INDIVIDUAL 0x08 279 #define UHD_OC_NONE 0x10 280 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 281 #define UHD_PWRON_FACTOR 2 282 uByte bHubContrCurrent; 283 uByte DeviceRemovable[32]; /* max 255 ports */ 284 #define UHD_NOT_REMOV(desc, i) \ 285 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) 286 /* deprecated uByte PortPowerCtrlMask[]; */ 287 } usb_hub_descriptor_t; 288 #define USB_HUB_DESCRIPTOR_SIZE 8 289 290 typedef struct { 291 uWord wStatus; 292 /* Device status flags */ 293 #define UDS_SELF_POWERED 0x0001 294 #define UDS_REMOTE_WAKEUP 0x0002 295 /* Endpoint status flags */ 296 #define UES_HALT 0x0001 297 } usb_status_t; 298 299 typedef struct { 300 uWord wHubStatus; 301 #define UHS_LOCAL_POWER 0x0001 302 #define UHS_OVER_CURRENT 0x0002 303 uWord wHubChange; 304 } usb_hub_status_t; 305 306 typedef struct { 307 uWord wPortStatus; 308 #define UPS_CURRENT_CONNECT_STATUS 0x0001 309 #define UPS_PORT_ENABLED 0x0002 310 #define UPS_SUSPEND 0x0004 311 #define UPS_OVERCURRENT_INDICATOR 0x0008 312 #define UPS_RESET 0x0010 313 #define UPS_PORT_POWER 0x0100 314 #define UPS_LOW_SPEED 0x0200 315 uWord wPortChange; 316 #define UPS_C_CONNECT_STATUS 0x0001 317 #define UPS_C_PORT_ENABLED 0x0002 318 #define UPS_C_SUSPEND 0x0004 319 #define UPS_C_OVERCURRENT_INDICATOR 0x0008 320 #define UPS_C_PORT_RESET 0x0010 321 } usb_port_status_t; 322 323 #define UDESC_CS_DEVICE 0x21 324 #define UDESC_CS_CONFIG 0x22 325 #define UDESC_CS_STRING 0x23 326 #define UDESC_CS_INTERFACE 0x24 327 #define UDESC_CS_ENDPOINT 0x25 328 329 #define UDESC_HUB 0x29 330 331 #define UCLASS_UNSPEC 0 332 #define UCLASS_AUDIO 1 333 #define USUBCLASS_AUDIOCONTROL 1 334 #define USUBCLASS_AUDIOSTREAM 2 335 #define UCLASS_CDC 2 /* communication */ 336 #define USUBCLASS_DIRECT_LINE_CONTROL_MODEL 1 337 #define USUBCLASS_ABSTRACT_CONTROL_MODEL 2 338 #define USUBCLASS_TELEPHONE_CONTROL_MODEL 3 339 #define USUBCLASS_MULTICHANNEL_CONTROL_MODEL 4 340 #define USUBCLASS_CAPI_CONTROLMODEL 5 341 #define USUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6 342 #define USUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7 343 #define UPROTO_CDC_AT 1 344 #define UCLASS_HID 3 345 #define USUBCLASS_BOOT 1 346 #define UCLASS_PRINTER 7 347 #define USUBCLASS_PRINTER 1 348 #define UPROTO_PRINTER_UNI 1 349 #define UPROTO_PRINTER_BI 2 350 #define UCLASS_MASS 8 351 #define USUBCLASS_RBC 1 352 #define USUBCLASS_SFF8020I 2 353 #define USUBCLASS_QIC157 3 354 #define USUBCLASS_UFI 4 355 #define USUBCLASS_SFF8070I 5 356 #define USUBCLASS_SCSI 6 357 #define UPROTO_MASS_CBI_I 0 358 #define UPROTO_MASS_CBI 1 359 #define UPROTO_MASS_BULK 80 360 #define UPROTO_MASS_BULK2 2 361 #define UCLASS_HUB 9 362 #define USUBCLASS_HUB 0 363 #define UCLASS_DATA 10 364 365 #define USB_HUB_MAX_DEPTH 5 366 367 /* 368 * Minimum time a device needs to be powered down to go through 369 * a power cycle. XXX Are these time in the spec? 370 */ 371 #define USB_POWER_DOWN_TIME 200 /* ms */ 372 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 373 374 #if 0 375 /* These are the values from the spec. */ 376 #define USB_PORT_RESET_DELAY 10 /* ms */ 377 #define USB_PORT_RESET_SETTLE 10 /* ms */ 378 #define USB_PORT_POWERUP_DELAY 100 /* ms */ 379 #define USB_SET_ADDRESS_SETTLE 2 /* ms */ 380 #define USB_RESUME_TIME (20*5) /* ms */ 381 #define USB_RESUME_WAIT 10 /* ms */ 382 #define USB_RESUME_RECOVERY 10 /* ms */ 383 #else 384 /* Allow for marginal (i.e. non-conforming) devices. */ 385 #define USB_PORT_RESET_DELAY 50 /* ms */ 386 #define USB_PORT_RESET_RECOVERY 50 /* ms */ 387 #define USB_PORT_POWERUP_DELAY 200 /* ms */ 388 #define USB_SET_ADDRESS_SETTLE 10 /* ms */ 389 #define USB_RESUME_DELAY (50*5) /* ms */ 390 #define USB_RESUME_WAIT 50 /* ms */ 391 #define USB_RESUME_RECOVERY 50 /* ms */ 392 #endif 393 394 #define USB_MIN_POWER 100 /* mA */ 395 #define USB_MAX_POWER 500 /* mA */ 396 397 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ 398 399 /*** ioctl() related stuff ***/ 400 401 struct usb_ctl_request { 402 int addr; 403 usb_device_request_t request; 404 void *data; 405 int flags; 406 /* XXX must match flags in usbdi.h */ 407 #define USBD_SHORT_XFER_OK 0x04 408 int actlen; /* actual length transferred */ 409 }; 410 411 struct usb_alt_interface { 412 int config_index; 413 int interface_index; 414 int alt_no; 415 }; 416 417 #define USB_CURRENT_CONFIG_INDEX (-1) 418 #define USB_CURRENT_ALT_INDEX (-1) 419 420 struct usb_config_desc { 421 int config_index; 422 usb_config_descriptor_t desc; 423 }; 424 425 struct usb_interface_desc { 426 int config_index; 427 int interface_index; 428 int alt_index; 429 usb_interface_descriptor_t desc; 430 }; 431 432 struct usb_endpoint_desc { 433 int config_index; 434 int interface_index; 435 int alt_index; 436 int endpoint_index; 437 usb_endpoint_descriptor_t desc; 438 }; 439 440 struct usb_full_desc { 441 int config_index; 442 u_int size; 443 u_char *data; 444 }; 445 446 struct usb_string_desc { 447 int string_index; 448 int language_id; 449 usb_string_descriptor_t desc; 450 }; 451 452 struct usb_ctl_report_desc { 453 int size; 454 u_char data[1024]; /* filled data size will vary */ 455 }; 456 457 struct usb_device_info { 458 u_int8_t addr; /* device address */ 459 char product[USB_MAX_STRING_LEN]; 460 char vendor[USB_MAX_STRING_LEN]; 461 char release[8]; 462 u_int16_t productNo; 463 u_int16_t vendorNo; 464 u_int8_t class; 465 u_int8_t config; 466 u_int8_t lowspeed; 467 int power; /* power consumption in mA, 0 if selfpowered */ 468 int nports; 469 u_int8_t ports[16];/* hub only: addresses of devices on ports */ 470 #define USB_PORT_ENABLED 0xff 471 #define USB_PORT_SUSPENDED 0xfe 472 #define USB_PORT_POWERED 0xfd 473 #define USB_PORT_DISABLED 0xfc 474 }; 475 476 struct usb_ctl_report { 477 int report; 478 u_char data[1024]; /* filled data size will vary */ 479 }; 480 481 struct usb_device_stats { 482 u_long requests[4]; /* indexed by transfer type UE_* */ 483 }; 484 485 /* USB controller */ 486 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 487 #define USB_SETDEBUG _IOW ('U', 2, int) 488 #define USB_DISCOVER _IO ('U', 3) 489 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 490 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 491 492 /* Generic HID device */ 493 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) 494 #define USB_SET_IMMED _IOW ('U', 22, int) 495 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) 496 497 /* Generic USB device */ 498 #define USB_GET_CONFIG _IOR ('U', 100, int) 499 #define USB_SET_CONFIG _IOW ('U', 101, int) 500 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 501 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 502 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) 503 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) 504 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) 505 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) 506 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) 507 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) 508 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc) 509 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 510 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 511 #define USB_SET_SHORT_XFER _IOW ('U', 113, int) 512 #define USB_SET_TIMEOUT _IOW ('U', 114, int) 513 514 /* Modem device */ 515 #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int) 516 #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int) 517 518 #endif /* _USB_H_ */ 519
Indexes created Tue Sep 23 14:10:03 GMT 2025