1 /* $NetBSD: usb.h,v 1.17 1999/01/03 01:09:18 augustss Exp $ */ 2 /* $FreeBSD$ */ 3 4 /* 5 * Copyright (c) 1998 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Lennart Augustsson (augustss@carlstedt.se) at 10 * Carlstedt Research & Technology. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 3. All advertising materials mentioning features or use of this software 21 * must display the following acknowledgement: 22 * This product includes software developed by the NetBSD 23 * Foundation, Inc. and its contributors. 24 * 4. Neither the name of The NetBSD Foundation nor the names of its 25 * contributors may be used to endorse or promote products derived 26 * from this software without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 38 * POSSIBILITY OF SUCH DAMAGE. 39 */ 40 41 42 #ifndef _USB_H_ 43 #define _USB_H_ 44 45 #include <sys/types.h> 46 #if defined(__NetBSD__) 47 #include <sys/ioctl.h> 48 #endif 49 50 #if defined(__NetBSD__) 51 #if defined(_KERNEL) 52 #include <dev/usb/usb_port.h> 53 #endif /* _KERNEL */ 54 55 #elif defined(__FreeBSD__) 56 #include <sys/malloc.h> 57 58 #if defined(KERNEL) 59 MALLOC_DECLARE(M_USB); 60 MALLOC_DECLARE(M_USBDEV); 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_DIR 0x80 /* mask */ 221 #define UE_IN 0x80 222 #define UE_OUT 0x00 223 #define UE_ADDR 0x0f 224 #define UE_GET_ADDR(a) ((a) & UE_ADDR) 225 #define UE_GET_IN(a) (((a) >> 7) & 1) 226 uByte bmAttributes; 227 #define UE_XFERTYPE 0x03 228 #define UE_CONTROL 0x00 229 #define UE_ISOCHRONOUS 0x01 230 #define UE_BULK 0x02 231 #define UE_INTERRUPT 0x03 232 #define UE_ISO_TYPE 0x0c 233 #define UE_ISO_ASYNC 0x04 234 #define UE_ISO_ADAPT 0x08 235 #define UE_ISO_SYNC 0x0c 236 uWord wMaxPacketSize; 237 uByte bInterval; 238 } usb_endpoint_descriptor_t; 239 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7 240 241 typedef struct { 242 uByte bLength; 243 uByte bDescriptorType; 244 uWord bString[127]; 245 } usb_string_descriptor_t; 246 #define USB_MAX_STRING_LEN 128 247 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */ 248 249 /* Hub specific request */ 250 #define UR_GET_BUS_STATE 0x02 251 252 /* Hub features */ 253 #define UHF_C_HUB_LOCAL_POWER 0 254 #define UHF_C_HUB_OVER_CURRENT 1 255 #define UHF_PORT_CONNECTION 0 256 #define UHF_PORT_ENABLE 1 257 #define UHF_PORT_SUSPEND 2 258 #define UHF_PORT_OVER_CURRENT 3 259 #define UHF_PORT_RESET 4 260 #define UHF_PORT_POWER 8 261 #define UHF_PORT_LOW_SPEED 9 262 #define UHF_C_PORT_CONNECTION 16 263 #define UHF_C_PORT_ENABLE 17 264 #define UHF_C_PORT_SUSPEND 18 265 #define UHF_C_PORT_OVER_CURRENT 19 266 #define UHF_C_PORT_RESET 20 267 268 typedef struct { 269 uByte bDescLength; 270 uByte bDescriptorType; 271 uByte bNbrPorts; 272 uWord wHubCharacteristics; 273 #define UHD_PWR 0x03 274 #define UHD_PWR_GANGED 0x00 275 #define UHD_PWR_INDIVIDUAL 0x01 276 #define UHD_PWR_NO_SWITCH 0x02 277 #define UHD_COMPOUND 0x04 278 #define UHD_OC 0x18 279 #define UHD_OC_GLOBAL 0x00 280 #define UHD_OC_INDIVIDUAL 0x08 281 #define UHD_OC_NONE 0x10 282 uByte bPwrOn2PwrGood; /* delay in 2 ms units */ 283 #define UHD_PWRON_FACTOR 2 284 uByte bHubContrCurrent; 285 uByte DeviceRemovable[32]; /* max 255 ports */ 286 #define UHD_NOT_REMOV(desc, i) \ 287 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) 288 /* deprecated uByte PortPowerCtrlMask[]; */ 289 } usb_hub_descriptor_t; 290 #define USB_HUB_DESCRIPTOR_SIZE 8 291 292 typedef struct { 293 uWord wStatus; 294 /* Device status flags */ 295 #define UDS_SELF_POWERED 0x0001 296 #define UDS_REMOTE_WAKEUP 0x0002 297 /* Endpoint status flags */ 298 #define UES_HALT 0x0001 299 } usb_status_t; 300 301 typedef struct { 302 uWord wHubStatus; 303 #define UHS_LOCAL_POWER 0x0001 304 #define UHS_OVER_CURRENT 0x0002 305 uWord wHubChange; 306 } usb_hub_status_t; 307 308 typedef struct { 309 uWord wPortStatus; 310 #define UPS_CURRENT_CONNECT_STATUS 0x0001 311 #define UPS_PORT_ENABLED 0x0002 312 #define UPS_SUSPEND 0x0004 313 #define UPS_OVERCURRENT_INDICATOR 0x0008 314 #define UPS_RESET 0x0010 315 #define UPS_PORT_POWER 0x0100 316 #define UPS_LOW_SPEED 0x0200 317 uWord wPortChange; 318 #define UPS_C_CONNECT_STATUS 0x0001 319 #define UPS_C_PORT_ENABLED 0x0002 320 #define UPS_C_SUSPEND 0x0004 321 #define UPS_C_OVERCURRENT_INDICATOR 0x0008 322 #define UPS_C_PORT_RESET 0x0010 323 } usb_port_status_t; 324 325 #define UDESC_CS_DEVICE 0x21 326 #define UDESC_CS_CONFIG 0x22 327 #define UDESC_CS_STRING 0x23 328 #define UDESC_CS_INTERFACE 0x24 329 #define UDESC_CS_ENDPOINT 0x25 330 331 #define UDESC_HUB 0x29 332 333 #define UCLASS_UNSPEC 0 /* Unspecified */ 334 #define UCLASS_AUDIO 1 /* Audio */ 335 #define USUBCLASS_AUDIOCONTROL 1 336 #define USUBCLASS_AUDIOSTREAM 2 337 #define UCLASS_CDC 2 /* Communication */ 338 #define USUBCLASS_ABSTRACT_CONTROL_MODEL 2 339 #define UPROTO_CDC_AT 1 340 #define UCLASS_HID 3 /* Human Interface Device */ 341 #define USUBCLASS_BOOT 1 342 #define UCLASS_PRINTER 7 /* Printer/Parallel Port */ 343 #define USUBCLASS_PRINTER 1 344 #define UPROTO_PRINTER_UNI 1 /* Unidirectional */ 345 #define UPROTO_PRINTER_BI 2 /* Bidirectional */ 346 #define UCLASS_MASS 8 /* Mass Storage */ 347 #define USUBCLASS_RBC 1 /* Reduced Block comm. (e.g. Flash ) */ 348 #define USUBCLASS_SFF8020I 2 /* (e.g. CD ROM) */ 349 #define USUBCLASS_QIC157 3 /* (e.g. tape drives) */ 350 #define USUBCLASS_UFI 4 /* (e.g. floppy drives) */ 351 #define USUBCLASS_SFF8070I 5 /* (e.g. floppy drives) */ 352 #define USUBCLASS_SCSI 6 /* SCSI transparent comman set */ 353 #define UPROTO_MASS_CBI_I 0 /* CBI protocol with comm. compl. int */ 354 #define UPROTO_MASS_CBI 1 /* CBI protocol */ 355 /* unknown yet 1999-04-05 356 #define UPROTO_MASS_BULK ?? / * Bulk only transport * / 357 */ 358 #define UCLASS_HUB 9 /* Hub */ 359 #define USUBCLASS_HUB 0 360 #define UCLASS_DATA 10 361 362 #define USB_HUB_MAX_DEPTH 5 363 364 /* 365 * Minimum time a device needs to be powered down to go through 366 * a power cycle. XXX Are these time in the spec? 367 */ 368 #define USB_POWER_DOWN_TIME 200 /* ms */ 369 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ 370 371 #if 0 372 /* These are the values from the spec. */ 373 #define USB_PORT_RESET_DELAY 10 /* ms */ 374 #define USB_PORT_RESET_SETTLE 10 /* ms */ 375 #define USB_PORT_POWERUP_DELAY 100 /* ms */ 376 #define USB_SET_ADDRESS_SETTLE 2 /* ms */ 377 #else 378 /* Allow for marginal (i.e. non-conforming) devices. */ 379 #define USB_PORT_RESET_DELAY 20 /* ms */ 380 #define USB_PORT_RESET_RECOVERY 50 /* ms */ 381 #define USB_PORT_POWERUP_DELAY 200 /* ms */ 382 #define USB_SET_ADDRESS_SETTLE 10 /* ms */ 383 #endif 384 385 #define USB_MIN_POWER 100 /* mA */ 386 #define USB_MAX_POWER 500 /* mA */ 387 388 389 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ 390 #define USB_RESUME_DELAY 10 /* ms XXX?*/ 391 392 /*** ioctl() related stuff ***/ 393 394 struct usb_ctl_request { 395 int addr; 396 usb_device_request_t request; 397 void *data; 398 int flags; 399 /* XXX must match flags in usbdi.h */ 400 #define USBD_SHORT_XFER_OK 0x04 401 int actlen; /* actual length transferred */ 402 }; 403 404 struct usb_alt_interface { 405 int config_index; 406 int interface_index; 407 int alt_no; 408 }; 409 410 #define USB_CURRENT_CONFIG_INDEX (-1) 411 #define USB_CURRENT_ALT_INDEX (-1) 412 413 struct usb_config_desc { 414 int config_index; 415 usb_config_descriptor_t desc; 416 }; 417 418 struct usb_interface_desc { 419 int config_index; 420 int interface_index; 421 int alt_index; 422 usb_interface_descriptor_t desc; 423 }; 424 425 struct usb_endpoint_desc { 426 int config_index; 427 int interface_index; 428 int alt_index; 429 int endpoint_index; 430 usb_endpoint_descriptor_t desc; 431 }; 432 433 struct usb_full_desc { 434 int config_index; 435 u_int size; 436 u_char *data; 437 }; 438 439 struct usb_string_desc { 440 int string_index; 441 int language_id; 442 usb_string_descriptor_t desc; 443 }; 444 445 struct usb_ctl_report_desc { 446 int size; 447 u_char data[1024]; /* filled data size will vary */ 448 }; 449 450 struct usb_device_info { 451 u_int8_t addr; /* device address */ 452 char product[USB_MAX_STRING_LEN]; 453 char vendor[USB_MAX_STRING_LEN]; 454 char revision[8]; 455 u_int16_t productNo; 456 u_int16_t vendorNo; 457 u_int8_t class; 458 u_int8_t config; 459 u_int8_t lowspeed; 460 int power; /* power consumption in mA, 0 if selfpowered */ 461 int nports; 462 u_int8_t ports[16];/* hub only: addresses of devices on ports */ 463 #define USB_PORT_ENABLED 0xff 464 #define USB_PORT_SUSPENDED 0xfe 465 #define USB_PORT_POWERED 0xfd 466 #define USB_PORT_DISABLED 0xfc 467 }; 468 469 struct usb_ctl_report { 470 int report; 471 u_char data[1024]; /* filled data size will vary */ 472 }; 473 474 struct usb_device_stats { 475 u_long requests[4]; /* indexed by transfer type UE_* */ 476 }; 477 478 /* USB controller */ 479 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 480 #define USB_SETDEBUG _IOW ('U', 2, int) 481 #define USB_DISCOVER _IO ('U', 3) 482 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 483 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 484 485 /* Generic HID device */ 486 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) 487 #define USB_SET_IMMED _IOW ('U', 22, int) 488 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) 489 490 /* Generic USB device */ 491 #define USB_GET_CONFIG _IOR ('U', 100, int) 492 #define USB_SET_CONFIG _IOW ('U', 101, int) 493 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 494 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 495 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) 496 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) 497 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) 498 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) 499 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) 500 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) 501 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc) 502 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 503 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 504 #define USB_SET_SHORT_XFER _IOW ('U', 113, int) 505 506 #endif /* _USB_H_ */ 507