usb.h revision 1.23
1 /* $NetBSD: usb.h,v 1.23 1999/06/30 06:44:23 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__) 46 #include <sys/ioctl.h> 47 #endif 48 49 #if defined(__NetBSD__) 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 } usb_endpoint_descriptor_t; 238 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7 239 240 typedef struct { 241 uByte bLength; 242 uByte bDescriptorType; 243 uWord bString[127]; 244 } usb_string_descriptor_t; 245 #define USB_MAX_STRING_LEN 128 246 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */ 247 248 /* Hub specific request */ 249 #define UR_GET_BUS_STATE 0x02 250 251 /* Hub features */ 252 #define UHF_C_HUB_LOCAL_POWER 0 253 #define UHF_C_HUB_OVER_CURRENT 1 254 #define UHF_PORT_CONNECTION 0 255 #define UHF_PORT_ENABLE 1 256 #define UHF_PORT_SUSPEND 2 257 #define UHF_PORT_OVER_CURRENT 3 258 #define UHF_PORT_RESET 4 259 #define UHF_PORT_POWER 8 260 #define UHF_PORT_LOW_SPEED 9 261 #define UHF_C_PORT_CONNECTION 16 262 #define UHF_C_PORT_ENABLE 17 263 #define UHF_C_PORT_SUSPEND 18 264 #define UHF_C_PORT_OVER_CURRENT 19 265 #define UHF_C_PORT_RESET 20 266 267 typedef struct { 268 uByte bDescLength; 269 uByte bDescriptorType; 270 uByte bNbrPorts; 271 uWord wHubCharacteristics; 272 #define UHD_PWR 0x03 273 #define UHD_PWR_GANGED 0x00 274 #define UHD_PWR_INDIVIDUAL 0x01 275 #define UHD_PWR_NO_SWITCH 0x02 276 #define UHD_COMPOUND 0x04 277 #define UHD_OC 0x18 278 #define UHD_OC_GLOBAL 0x00 279 #define UHD_OC_INDIVIDUAL 0x08 280 #define UHD_OC_NONE 0x10 281 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 282 #define UHD_PWRON_FACTOR 2 283 uByte bHubContrCurrent; 284 uByte DeviceRemovable[32]; /* max 255 ports */ 285 #define UHD_NOT_REMOV(desc, i) \ 286 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) 287 /* deprecated uByte PortPowerCtrlMask[]; */ 288 } usb_hub_descriptor_t; 289 #define USB_HUB_DESCRIPTOR_SIZE 8 290 291 typedef struct { 292 uWord wStatus; 293 /* Device status flags */ 294 #define UDS_SELF_POWERED 0x0001 295 #define UDS_REMOTE_WAKEUP 0x0002 296 /* Endpoint status flags */ 297 #define UES_HALT 0x0001 298 } usb_status_t; 299 300 typedef struct { 301 uWord wHubStatus; 302 #define UHS_LOCAL_POWER 0x0001 303 #define UHS_OVER_CURRENT 0x0002 304 uWord wHubChange; 305 } usb_hub_status_t; 306 307 typedef struct { 308 uWord wPortStatus; 309 #define UPS_CURRENT_CONNECT_STATUS 0x0001 310 #define UPS_PORT_ENABLED 0x0002 311 #define UPS_SUSPEND 0x0004 312 #define UPS_OVERCURRENT_INDICATOR 0x0008 313 #define UPS_RESET 0x0010 314 #define UPS_PORT_POWER 0x0100 315 #define UPS_LOW_SPEED 0x0200 316 uWord wPortChange; 317 #define UPS_C_CONNECT_STATUS 0x0001 318 #define UPS_C_PORT_ENABLED 0x0002 319 #define UPS_C_SUSPEND 0x0004 320 #define UPS_C_OVERCURRENT_INDICATOR 0x0008 321 #define UPS_C_PORT_RESET 0x0010 322 } usb_port_status_t; 323 324 #define UDESC_CS_DEVICE 0x21 325 #define UDESC_CS_CONFIG 0x22 326 #define UDESC_CS_STRING 0x23 327 #define UDESC_CS_INTERFACE 0x24 328 #define UDESC_CS_ENDPOINT 0x25 329 330 #define UDESC_HUB 0x29 331 332 #define UCLASS_UNSPEC 0 333 #define UCLASS_AUDIO 1 334 #define USUBCLASS_AUDIOCONTROL 1 335 #define USUBCLASS_AUDIOSTREAM 2 336 #define UCLASS_CDC 2 /* communication */ 337 #define USUBCLASS_DIRECT_LINE_CONTROL_MODEL 1 338 #define USUBCLASS_ABSTRACT_CONTROL_MODEL 2 339 #define USUBCLASS_TELEPHONE_CONTROL_MODEL 3 340 #define USUBCLASS_MULTICHANNEL_CONTROL_MODEL 4 341 #define USUBCLASS_CAPI_CONTROLMODEL 5 342 #define USUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6 343 #define USUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7 344 #define UPROTO_CDC_AT 1 345 #define UCLASS_HID 3 346 #define USUBCLASS_BOOT 1 347 #define UCLASS_PRINTER 7 348 #define USUBCLASS_PRINTER 1 349 #define UPROTO_PRINTER_UNI 1 350 #define UPROTO_PRINTER_BI 2 351 #define UCLASS_MASS 8 352 #define USUBCLASS_RBC 1 353 #define USUBCLASS_SFF8020I 2 354 #define USUBCLASS_QIC157 3 355 #define USUBCLASS_UFI 4 356 #define USUBCLASS_SFF8070I 5 357 #define USUBCLASS_SCSI 6 358 #define UPROTO_MASS_CBI_C 0 359 #define UPROTO_MASS_CBI_NC 1 360 #define UCLASS_HUB 9 361 #define USUBCLASS_HUB 0 362 #define UCLASS_DATA 10 363 364 #define USB_HUB_MAX_DEPTH 5 365 366 /* 367 * Minimum time a device needs to be powered down to go through 368 * a power cycle. XXX Are these time in the spec? 369 */ 370 #define USB_POWER_DOWN_TIME 200 /* ms */ 371 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 372 373 #if 0 374 /* These are the values from the spec. */ 375 #define USB_PORT_RESET_DELAY 10 /* ms */ 376 #define USB_PORT_RESET_SETTLE 10 /* ms */ 377 #define USB_PORT_POWERUP_DELAY 100 /* ms */ 378 #define USB_SET_ADDRESS_SETTLE 2 /* ms */ 379 #define USB_RESUME_TIME (20*5) /* ms */ 380 #define USB_RESUME_WAIT 10 /* ms */ 381 #define USB_RESUME_RECOVERY 10 /* ms */ 382 #else 383 /* Allow for marginal (i.e. non-conforming) devices. */ 384 #define USB_PORT_RESET_DELAY 50 /* ms */ 385 #define USB_PORT_RESET_RECOVERY 50 /* ms */ 386 #define USB_PORT_POWERUP_DELAY 200 /* ms */ 387 #define USB_SET_ADDRESS_SETTLE 10 /* ms */ 388 #define USB_RESUME_DELAY (50*5) /* ms */ 389 #define USB_RESUME_WAIT 50 /* ms */ 390 #define USB_RESUME_RECOVERY 50 /* ms */ 391 #endif 392 393 #define USB_MIN_POWER 100 /* mA */ 394 #define USB_MAX_POWER 500 /* mA */ 395 396 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ 397 398 /*** ioctl() related stuff ***/ 399 400 struct usb_ctl_request { 401 int addr; 402 usb_device_request_t request; 403 void *data; 404 int flags; 405 /* XXX must match flags in usbdi.h */ 406 #define USBD_SHORT_XFER_OK 0x04 407 int actlen; /* actual length transferred */ 408 }; 409 410 struct usb_alt_interface { 411 int config_index; 412 int interface_index; 413 int alt_no; 414 }; 415 416 #define USB_CURRENT_CONFIG_INDEX (-1) 417 #define USB_CURRENT_ALT_INDEX (-1) 418 419 struct usb_config_desc { 420 int config_index; 421 usb_config_descriptor_t desc; 422 }; 423 424 struct usb_interface_desc { 425 int config_index; 426 int interface_index; 427 int alt_index; 428 usb_interface_descriptor_t desc; 429 }; 430 431 struct usb_endpoint_desc { 432 int config_index; 433 int interface_index; 434 int alt_index; 435 int endpoint_index; 436 usb_endpoint_descriptor_t desc; 437 }; 438 439 struct usb_full_desc { 440 int config_index; 441 u_int size; 442 u_char *data; 443 }; 444 445 struct usb_string_desc { 446 int string_index; 447 int language_id; 448 usb_string_descriptor_t desc; 449 }; 450 451 struct usb_ctl_report_desc { 452 int size; 453 u_char data[1024]; /* filled data size will vary */ 454 }; 455 456 struct usb_device_info { 457 u_int8_t addr; /* device address */ 458 char product[USB_MAX_STRING_LEN]; 459 char vendor[USB_MAX_STRING_LEN]; 460 char release[8]; 461 u_int16_t productNo; 462 u_int16_t vendorNo; 463 u_int8_t class; 464 u_int8_t config; 465 u_int8_t lowspeed; 466 int power; /* power consumption in mA, 0 if selfpowered */ 467 int nports; 468 u_int8_t ports[16];/* hub only: addresses of devices on ports */ 469 #define USB_PORT_ENABLED 0xff 470 #define USB_PORT_SUSPENDED 0xfe 471 #define USB_PORT_POWERED 0xfd 472 #define USB_PORT_DISABLED 0xfc 473 }; 474 475 struct usb_ctl_report { 476 int report; 477 u_char data[1024]; /* filled data size will vary */ 478 }; 479 480 struct usb_device_stats { 481 u_long requests[4]; /* indexed by transfer type UE_* */ 482 }; 483 484 /* USB controller */ 485 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 486 #define USB_SETDEBUG _IOW ('U', 2, int) 487 #define USB_DISCOVER _IO ('U', 3) 488 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 489 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 490 491 /* Generic HID device */ 492 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) 493 #define USB_SET_IMMED _IOW ('U', 22, int) 494 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) 495 496 /* Generic USB device */ 497 #define USB_GET_CONFIG _IOR ('U', 100, int) 498 #define USB_SET_CONFIG _IOW ('U', 101, int) 499 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 500 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 501 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) 502 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) 503 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) 504 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) 505 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) 506 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) 507 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc) 508 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 509 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 510 #define USB_SET_SHORT_XFER _IOW ('U', 113, int) 511 512 #endif /* _USB_H_ */ 513
Indexes created Mon Sep 22 05:09:51 GMT 2025