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