usb.h revision 1.16
1 /* $NetBSD: usb.h,v 1.16 1999/01/01 15:18:17 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 61 #include <dev/usb/usb_port.h> 62 #endif /* KERNEL */ 63 #endif /* __FreeBSD__ */ 64 65 66 #define USB_MAX_DEVICES 128 67 #define USB_START_ADDR 0 68 69 #define USB_CONTROL_ENDPOINT 0 70 #define USB_MAX_ENDPOINTS 16 71 72 #define USB_FRAMES_PER_SECOND 1000 73 74 /* 75 * The USB records contain some unaligned little-endian word 76 * components. The U[SG]ETW macros take care of both the alignment 77 * and endian problem and should always be used to access 16 bit 78 * values. 79 */ 80 typedef u_int8_t uByte; 81 typedef u_int8_t uWord[2]; 82 #define UGETW(w) ((w)[0] | ((w)[1] << 8)) 83 #define USETW(w,v) ((w)[0] = (u_int8_t)(v), (w)[1] = (u_int8_t)((v) >> 8)) 84 #define USETW2(w,h,l) ((w)[0] = (u_int8_t)(l), (w)[1] = (u_int8_t)(h)) 85 typedef u_int8_t uDWord[4]; 86 #define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24)) 87 #define USETDW(w,v) ((w)[0] = (u_int8_t)(v), \ 88 (w)[1] = (u_int8_t)((v) >> 8), \ 89 (w)[2] = (u_int8_t)((v) >> 16), \ 90 (w)[3] = (u_int8_t)((v) >> 24)) 91 /* 92 * On little-endian machines that can handle unanliged accesses 93 * (e.g. i386) these macros can be replaced by the following. 94 */ 95 #if 0 96 #define UGETW(w) (*(u_int16_t *)(w)) 97 #define USETW(w,v) (*(u_int16_t *)(w) = (v)) 98 #endif 99 100 typedef struct { 101 uByte bmRequestType; 102 uByte bRequest; 103 uWord wValue; 104 uWord wIndex; 105 uWord wLength; 106 } usb_device_request_t; 107 108 #define UT_WRITE 0x00 109 #define UT_READ 0x80 110 #define UT_STANDARD 0x00 111 #define UT_CLASS 0x20 112 #define UT_VENDOR 0x40 113 #define UT_DEVICE 0x00 114 #define UT_INTERFACE 0x01 115 #define UT_ENDPOINT 0x02 116 #define UT_OTHER 0x03 117 118 #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE) 119 #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE) 120 #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT) 121 #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE) 122 #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE) 123 #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT) 124 #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE) 125 #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE) 126 #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER) 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_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE) 131 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE) 132 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER) 133 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE) 134 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE) 135 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER) 136 137 /* Requests */ 138 #define UR_GET_STATUS 0x00 139 #define UR_CLEAR_FEATURE 0x01 140 #define UR_SET_FEATURE 0x03 141 #define UR_SET_ADDRESS 0x05 142 #define UR_GET_DESCRIPTOR 0x06 143 #define UDESC_DEVICE 1 144 #define UDESC_CONFIG 2 145 #define UDESC_STRING 3 146 #define UDESC_INTERFACE 4 147 #define UDESC_ENDPOINT 5 148 #define UR_SET_DESCRIPTOR 0x07 149 #define UR_GET_CONFIG 0x08 150 #define UR_SET_CONFIG 0x09 151 #define UR_GET_INTERFACE 0x0a 152 #define UR_SET_INTERFACE 0x0b 153 #define UR_SYNCH_FRAME 0x0c 154 155 /* Feature numbers */ 156 #define UF_ENDPOINT_HALT 0 157 #define UF_DEVICE_REMOTE_WAKEUP 1 158 159 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */ 160 161 typedef struct { 162 uByte bLength; 163 uByte bDescriptorType; 164 uByte bDescriptorSubtype; 165 } usb_descriptor_t; 166 167 typedef struct { 168 uByte bLength; 169 uByte bDescriptorType; 170 uWord bcdUSB; 171 uByte bDeviceClass; 172 uByte bDeviceSubClass; 173 uByte bDeviceProtocol; 174 uByte bMaxPacketSize; 175 /* The fields below are not part of the initial descriptor. */ 176 uWord idVendor; 177 uWord idProduct; 178 uWord bcdDevice; 179 uByte iManufacturer; 180 uByte iProduct; 181 uByte iSerialNumber; 182 uByte bNumConfigurations; 183 } usb_device_descriptor_t; 184 #define USB_DEVICE_DESCRIPTOR_SIZE 18 185 186 typedef struct { 187 uByte bLength; 188 uByte bDescriptorType; 189 uWord wTotalLength; 190 uByte bNumInterface; 191 uByte bConfigurationValue; 192 uByte iConfiguration; 193 uByte bmAttributes; 194 #define UC_BUS_POWERED 0x80 195 #define UC_SELF_POWERED 0x40 196 #define UC_REMOTE_WAKEUP 0x20 197 uByte bMaxPower; /* max current in 2 mA units */ 198 #define UC_POWER_FACTOR 2 199 } usb_config_descriptor_t; 200 #define USB_CONFIG_DESCRIPTOR_SIZE 9 201 202 typedef struct { 203 uByte bLength; 204 uByte bDescriptorType; 205 uByte bInterfaceNumber; 206 uByte bAlternateSetting; 207 uByte bNumEndpoints; 208 uByte bInterfaceClass; 209 uByte bInterfaceSubClass; 210 uByte bInterfaceProtocol; 211 uByte iInterface; 212 } usb_interface_descriptor_t; 213 #define USB_INTERFACE_DESCRIPTOR_SIZE 9 214 215 typedef struct { 216 uByte bLength; 217 uByte bDescriptorType; 218 uByte bEndpointAddress; 219 #define UE_IN 0x80 220 #define UE_OUT 0x00 221 #define UE_ADDR 0x0f 222 #define UE_GET_ADDR(a) ((a) & UE_ADDR) 223 #define UE_GET_IN(a) (((a) >> 7) & 1) 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_ABSTRACT_CONTROL_MODEL 2 337 #define UPROTO_CDC_AT 1 338 #define UCLASS_HID 3 339 #define USUBCLASS_BOOT 1 340 #define UCLASS_PRINTER 7 341 #define USUBCLASS_PRINTER 1 342 #define UPROTO_PRINTER_UNI 1 343 #define UPROTO_PRINTER_BI 2 344 #define UCLASS_HUB 9 345 #define USUBCLASS_HUB 0 346 #define UCLASS_DATA 10 347 348 #define USB_HUB_MAX_DEPTH 5 349 350 /* 351 * Minimum time a device needs to be powered down to go through 352 * a power cycle. XXX Are these time in the spec? 353 */ 354 #define USB_POWER_DOWN_TIME 200 /* ms */ 355 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 356 357 #if 0 358 /* These are the values from the spec. */ 359 #define USB_PORT_RESET_DELAY 10 /* ms */ 360 #define USB_PORT_RESET_SETTLE 10 /* ms */ 361 #define USB_PORT_POWERUP_DELAY 100 /* ms */ 362 #define USB_SET_ADDRESS_SETTLE 2 /* ms */ 363 #else 364 /* Allow for marginal (i.e. non-conforming) devices. */ 365 #define USB_PORT_RESET_DELAY 20 /* ms */ 366 #define USB_PORT_RESET_RECOVERY 50 /* ms */ 367 #define USB_PORT_POWERUP_DELAY 200 /* ms */ 368 #define USB_SET_ADDRESS_SETTLE 10 /* ms */ 369 #endif 370 371 #define USB_MIN_POWER 100 /* mA */ 372 #define USB_MAX_POWER 500 /* mA */ 373 374 375 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ 376 #define USB_RESUME_DELAY 10 /* ms XXX?*/ 377 378 /*** ioctl() related stuff ***/ 379 380 struct usb_ctl_request { 381 int addr; 382 usb_device_request_t request; 383 void *data; 384 int flags; 385 /* XXX must match flags in usbdi.h */ 386 #define USBD_SHORT_XFER_OK 0x04 387 }; 388 389 struct usb_alt_interface { 390 int config_index; 391 int interface_index; 392 int alt_no; 393 }; 394 395 #define USB_CURRENT_CONFIG_INDEX (-1) 396 #define USB_CURRENT_ALT_INDEX (-1) 397 398 struct usb_config_desc { 399 int config_index; 400 usb_config_descriptor_t desc; 401 }; 402 403 struct usb_interface_desc { 404 int config_index; 405 int interface_index; 406 int alt_index; 407 usb_interface_descriptor_t desc; 408 }; 409 410 struct usb_endpoint_desc { 411 int config_index; 412 int interface_index; 413 int alt_index; 414 int endpoint_index; 415 usb_endpoint_descriptor_t desc; 416 }; 417 418 struct usb_full_desc { 419 int config_index; 420 u_int size; 421 u_char *data; 422 }; 423 424 struct usb_string_desc { 425 int string_index; 426 int language_id; 427 usb_string_descriptor_t desc; 428 }; 429 430 struct usb_ctl_report_desc { 431 int size; 432 u_char data[1024]; /* filled data size will vary */ 433 }; 434 435 struct usb_device_info { 436 u_int8_t addr; /* device address */ 437 char product[USB_MAX_STRING_LEN]; 438 char vendor[USB_MAX_STRING_LEN]; 439 char revision[8]; 440 u_int16_t productNo; 441 u_int16_t vendorNo; 442 u_int8_t class; 443 u_int8_t config; 444 u_int8_t lowspeed; 445 int power; /* power consumption in mA, 0 if selfpowered */ 446 int nports; 447 u_int8_t ports[16];/* hub only: addresses of devices on ports */ 448 #define USB_PORT_ENABLED 0xff 449 #define USB_PORT_SUSPENDED 0xfe 450 #define USB_PORT_POWERED 0xfd 451 #define USB_PORT_DISABLED 0xfc 452 }; 453 454 struct usb_ctl_report { 455 int report; 456 u_char data[1024]; /* filled data size will vary */ 457 }; 458 459 struct usb_device_stats { 460 u_long requests[4]; /* indexed by transfer type UE_* */ 461 }; 462 463 /* USB controller */ 464 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 465 #define USB_SETDEBUG _IOW ('U', 2, int) 466 #define USB_DISCOVER _IO ('U', 3) 467 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 468 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 469 470 /* Generic HID device */ 471 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) 472 #define USB_SET_IMMED _IOW ('U', 22, int) 473 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) 474 475 /* Generic USB device */ 476 #define USB_GET_CONFIG _IOR ('U', 100, int) 477 #define USB_SET_CONFIG _IOW ('U', 101, int) 478 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 479 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 480 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) 481 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) 482 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) 483 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) 484 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) 485 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) 486 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc) 487 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 488 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 489 #define USB_SET_SHORT_XFER _IOW ('U', 113, int) 490 491 #endif /* _USB_H_ */ 492
Indexes created Mon Sep 22 10:09:38 GMT 2025