usb.h revision 1.52 1 /* $NetBSD: usb.h,v 1.52 2001/07/23 15:17:50 nathanw Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/usb.h,v 1.14 1999/11/17 22:33:46 n_hibma Exp $ */
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 (lennart (at) augustsson.net) 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 #include <sys/time.h>
47
48 #if defined(__NetBSD__) || defined(__OpenBSD__)
49 #include <sys/ioctl.h>
50
51 #if defined(_KERNEL)
52 #include <dev/usb/usb_port.h>
53 #endif /* _KERNEL */
54
55 #elif defined(__FreeBSD__)
56 #if defined(KERNEL)
57 #include <sys/malloc.h>
58
59 MALLOC_DECLARE(M_USB);
60 MALLOC_DECLARE(M_USBDEV);
61 MALLOC_DECLARE(M_USBHC);
62
63 #include <dev/usb/usb_port.h>
64 #endif /* KERNEL */
65 #endif /* __FreeBSD__ */
66
67
68 #define USB_MAX_DEVICES 128
69 #define USB_START_ADDR 0
70
71 #define USB_CONTROL_ENDPOINT 0
72 #define USB_MAX_ENDPOINTS 16
73
74 #define USB_FRAMES_PER_SECOND 1000
75
76 /*
77 * The USB records contain some unaligned little-endian word
78 * components. The U[SG]ETW macros take care of both the alignment
79 * and endian problem and should always be used to access non-byte
80 * values.
81 */
82 typedef u_int8_t uByte;
83 typedef u_int8_t uWord[2];
84 typedef u_int8_t uDWord[4];
85
86 #define USETW2(w,h,l) ((w)[0] = (u_int8_t)(l), (w)[1] = (u_int8_t)(h))
87
88 #if 1
89 #define UGETW(w) ((w)[0] | ((w)[1] << 8))
90 #define USETW(w,v) ((w)[0] = (u_int8_t)(v), (w)[1] = (u_int8_t)((v) >> 8))
91 #define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24))
92 #define USETDW(w,v) ((w)[0] = (u_int8_t)(v), \
93 (w)[1] = (u_int8_t)((v) >> 8), \
94 (w)[2] = (u_int8_t)((v) >> 16), \
95 (w)[3] = (u_int8_t)((v) >> 24))
96 #else
97 /*
98 * On little-endian machines that can handle unanliged accesses
99 * (e.g. i386) these macros can be replaced by the following.
100 */
101 #define UGETW(w) (*(u_int16_t *)(w))
102 #define USETW(w,v) (*(u_int16_t *)(w) = (v))
103 #define UGETDW(w) (*(u_int32_t *)(w))
104 #define USETDW(w,v) (*(u_int32_t *)(w) = (v))
105 #endif
106
107 #define UPACKED __attribute__((__packed__))
108
109 typedef struct {
110 uByte bmRequestType;
111 uByte bRequest;
112 uWord wValue;
113 uWord wIndex;
114 uWord wLength;
115 } UPACKED usb_device_request_t;
116
117 #define UT_WRITE 0x00
118 #define UT_READ 0x80
119 #define UT_STANDARD 0x00
120 #define UT_CLASS 0x20
121 #define UT_VENDOR 0x40
122 #define UT_DEVICE 0x00
123 #define UT_INTERFACE 0x01
124 #define UT_ENDPOINT 0x02
125 #define UT_OTHER 0x03
126
127 #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE)
128 #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE)
129 #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT)
130 #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE)
131 #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE)
132 #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT)
133 #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE)
134 #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE)
135 #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER)
136 #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT)
137 #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE)
138 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE)
139 #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER)
140 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT)
141 #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE)
142 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE)
143 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER)
144 #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT)
145 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE)
146 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE)
147 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER)
148 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT)
149
150 /* Requests */
151 #define UR_GET_STATUS 0x00
152 #define UR_CLEAR_FEATURE 0x01
153 #define UR_SET_FEATURE 0x03
154 #define UR_SET_ADDRESS 0x05
155 #define UR_GET_DESCRIPTOR 0x06
156 #define UDESC_DEVICE 0x01
157 #define UDESC_CONFIG 0x02
158 #define UDESC_STRING 0x03
159 #define UDESC_INTERFACE 0x04
160 #define UDESC_ENDPOINT 0x05
161 #define UDESC_CS_DEVICE 0x21 /* class specific */
162 #define UDESC_CS_CONFIG 0x22
163 #define UDESC_CS_STRING 0x23
164 #define UDESC_CS_INTERFACE 0x24
165 #define UDESC_CS_ENDPOINT 0x25
166 #define UDESC_HUB 0x29
167 #define UR_SET_DESCRIPTOR 0x07
168 #define UR_GET_CONFIG 0x08
169 #define UR_SET_CONFIG 0x09
170 #define UR_GET_INTERFACE 0x0a
171 #define UR_SET_INTERFACE 0x0b
172 #define UR_SYNCH_FRAME 0x0c
173
174 /* Feature numbers */
175 #define UF_ENDPOINT_HALT 0
176 #define UF_DEVICE_REMOTE_WAKEUP 1
177
178 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */
179
180 typedef struct {
181 uByte bLength;
182 uByte bDescriptorType;
183 uByte bDescriptorSubtype;
184 } UPACKED usb_descriptor_t;
185
186 typedef struct {
187 uByte bLength;
188 uByte bDescriptorType;
189 uWord bcdUSB;
190 uByte bDeviceClass;
191 uByte bDeviceSubClass;
192 uByte bDeviceProtocol;
193 uByte bMaxPacketSize;
194 /* The fields below are not part of the initial descriptor. */
195 uWord idVendor;
196 uWord idProduct;
197 uWord bcdDevice;
198 uByte iManufacturer;
199 uByte iProduct;
200 uByte iSerialNumber;
201 uByte bNumConfigurations;
202 } UPACKED usb_device_descriptor_t;
203 #define USB_DEVICE_DESCRIPTOR_SIZE 18
204
205 typedef struct {
206 uByte bLength;
207 uByte bDescriptorType;
208 uWord wTotalLength;
209 uByte bNumInterface;
210 uByte bConfigurationValue;
211 uByte iConfiguration;
212 uByte bmAttributes;
213 #define UC_BUS_POWERED 0x80
214 #define UC_SELF_POWERED 0x40
215 #define UC_REMOTE_WAKEUP 0x20
216 uByte bMaxPower; /* max current in 2 mA units */
217 #define UC_POWER_FACTOR 2
218 } UPACKED usb_config_descriptor_t;
219 #define USB_CONFIG_DESCRIPTOR_SIZE 9
220
221 typedef struct {
222 uByte bLength;
223 uByte bDescriptorType;
224 uByte bInterfaceNumber;
225 uByte bAlternateSetting;
226 uByte bNumEndpoints;
227 uByte bInterfaceClass;
228 uByte bInterfaceSubClass;
229 uByte bInterfaceProtocol;
230 uByte iInterface;
231 } UPACKED usb_interface_descriptor_t;
232 #define USB_INTERFACE_DESCRIPTOR_SIZE 9
233
234 typedef struct {
235 uByte bLength;
236 uByte bDescriptorType;
237 uByte bEndpointAddress;
238 #define UE_GET_DIR(a) ((a) & 0x80)
239 #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7))
240 #define UE_DIR_IN 0x80
241 #define UE_DIR_OUT 0x00
242 #define UE_ADDR 0x0f
243 #define UE_GET_ADDR(a) ((a) & UE_ADDR)
244 uByte bmAttributes;
245 #define UE_XFERTYPE 0x03
246 #define UE_CONTROL 0x00
247 #define UE_ISOCHRONOUS 0x01
248 #define UE_BULK 0x02
249 #define UE_INTERRUPT 0x03
250 #define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE)
251 #define UE_ISO_TYPE 0x0c
252 #define UE_ISO_ASYNC 0x04
253 #define UE_ISO_ADAPT 0x08
254 #define UE_ISO_SYNC 0x0c
255 #define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE)
256 uWord wMaxPacketSize;
257 uByte bInterval;
258 } UPACKED usb_endpoint_descriptor_t;
259 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7
260
261 typedef struct {
262 uByte bLength;
263 uByte bDescriptorType;
264 uWord bString[127];
265 } UPACKED usb_string_descriptor_t;
266 #define USB_MAX_STRING_LEN 128
267 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */
268
269 /* Hub specific request */
270 #define UR_GET_BUS_STATE 0x02
271
272 /* Hub features */
273 #define UHF_C_HUB_LOCAL_POWER 0
274 #define UHF_C_HUB_OVER_CURRENT 1
275 #define UHF_PORT_CONNECTION 0
276 #define UHF_PORT_ENABLE 1
277 #define UHF_PORT_SUSPEND 2
278 #define UHF_PORT_OVER_CURRENT 3
279 #define UHF_PORT_RESET 4
280 #define UHF_PORT_POWER 8
281 #define UHF_PORT_LOW_SPEED 9
282 #define UHF_C_PORT_CONNECTION 16
283 #define UHF_C_PORT_ENABLE 17
284 #define UHF_C_PORT_SUSPEND 18
285 #define UHF_C_PORT_OVER_CURRENT 19
286 #define UHF_C_PORT_RESET 20
287
288 typedef struct {
289 uByte bDescLength;
290 uByte bDescriptorType;
291 uByte bNbrPorts;
292 uWord wHubCharacteristics;
293 #define UHD_PWR 0x03
294 #define UHD_PWR_GANGED 0x00
295 #define UHD_PWR_INDIVIDUAL 0x01
296 #define UHD_PWR_NO_SWITCH 0x02
297 #define UHD_COMPOUND 0x04
298 #define UHD_OC 0x18
299 #define UHD_OC_GLOBAL 0x00
300 #define UHD_OC_INDIVIDUAL 0x08
301 #define UHD_OC_NONE 0x10
302 uByte bPwrOn2PwrGood; /* delay in 2 ms units */
303 #define UHD_PWRON_FACTOR 2
304 uByte bHubContrCurrent;
305 uByte DeviceRemovable[32]; /* max 255 ports */
306 #define UHD_NOT_REMOV(desc, i) \
307 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1)
308 /* deprecated */ uByte PortPowerCtrlMask[1];
309 } UPACKED usb_hub_descriptor_t;
310 #define USB_HUB_DESCRIPTOR_SIZE 9 /* includes deprecated PortPowerCtrlMask */
311
312 typedef struct {
313 uWord wStatus;
314 /* Device status flags */
315 #define UDS_SELF_POWERED 0x0001
316 #define UDS_REMOTE_WAKEUP 0x0002
317 /* Endpoint status flags */
318 #define UES_HALT 0x0001
319 } UPACKED usb_status_t;
320
321 typedef struct {
322 uWord wHubStatus;
323 #define UHS_LOCAL_POWER 0x0001
324 #define UHS_OVER_CURRENT 0x0002
325 uWord wHubChange;
326 } UPACKED usb_hub_status_t;
327
328 typedef struct {
329 uWord wPortStatus;
330 #define UPS_CURRENT_CONNECT_STATUS 0x0001
331 #define UPS_PORT_ENABLED 0x0002
332 #define UPS_SUSPEND 0x0004
333 #define UPS_OVERCURRENT_INDICATOR 0x0008
334 #define UPS_RESET 0x0010
335 #define UPS_PORT_POWER 0x0100
336 #define UPS_LOW_SPEED 0x0200
337 uWord wPortChange;
338 #define UPS_C_CONNECT_STATUS 0x0001
339 #define UPS_C_PORT_ENABLED 0x0002
340 #define UPS_C_SUSPEND 0x0004
341 #define UPS_C_OVERCURRENT_INDICATOR 0x0008
342 #define UPS_C_PORT_RESET 0x0010
343 } UPACKED usb_port_status_t;
344
345 /* Device class codes */
346 #define UDCLASS_AUDIO 0x00
347 #define UDCLASS_COMM 0x02
348 #define UDCLASS_HID 0x00
349 #define UDCLASS_HUB 0x09
350 #define UDSUBCLASS_HUB 0
351 #define UDCLASS_MASS 0x00
352
353 /* Interface class codes */
354 #define UICLASS_UNSPEC 0x00
355
356 #define UICLASS_AUDIO 0x01
357 #define UISUBCLASS_AUDIOCONTROL 1
358 #define UISUBCLASS_AUDIOSTREAM 2
359 #define UISUBCLASS_MIDISTREAM 3
360
361 #define UICLASS_CDC 0x02 /* communication */
362 #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1
363 #define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2
364 #define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3
365 #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4
366 #define UISUBCLASS_CAPI_CONTROLMODEL 5
367 #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6
368 #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7
369 #define UIPROTO_CDC_AT 1
370
371 #define UICLASS_HID 0x03
372 #define UISUBCLASS_BOOT 1
373 #define UIPROTO_BOOT_KEYBOARD 1
374
375 #define UICLASS_PHYSICAL 0x05
376
377 #define UICLASS_PRINTER 0x07
378 #define UISUBCLASS_PRINTER 1
379 #define UIPROTO_PRINTER_UNI 1
380 #define UIPROTO_PRINTER_BI 2
381 #define UIPROTO_PRINTER_1284 3
382
383 #define UICLASS_MASS 0x08
384 #define UISUBCLASS_RBC 1
385 #define UISUBCLASS_SFF8020I 2
386 #define UISUBCLASS_QIC157 3
387 #define UISUBCLASS_UFI 4
388 #define UISUBCLASS_SFF8070I 5
389 #define UISUBCLASS_SCSI 6
390 #define UIPROTO_MASS_CBI_I 0
391 #define UIPROTO_MASS_CBI 1
392 #define UIPROTO_MASS_BBB 2
393 #define UIPROTO_MASS_BBB_P 80 /* 'P' for the Iomega Zip drive */
394
395 #define UICLASS_HUB 0x09
396 #define UISUBCLASS_HUB 0
397
398 #define UICLASS_CDC_DATA 0x0a
399 #define UISUBCLASS_DATA 0
400 #define UIPROTO_DATA_ISDNBRI 0x30 /* Physical iface */
401 #define UIPROTO_DATA_HDLC 0x31 /* HDLC */
402 #define UIPROTO_DATA_TRANSPARENT 0x32 /* Transparent */
403 #define UIPROTO_DATA_Q921M 0x50 /* Management for Q921 */
404 #define UIPROTO_DATA_Q921 0x51 /* Data for Q921 */
405 #define UIPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */
406 #define UIPROTO_DATA_V42BIS 0x90 /* Data compression */
407 #define UIPROTO_DATA_Q931 0x91 /* Euro-ISDN */
408 #define UIPROTO_DATA_V120 0x92 /* V.24 rate adaption */
409 #define UIPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */
410 #define UIPROTO_DATA_HOST_BASED 0xfd /* Host based driver */
411 #define UIPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc.*/
412 #define UIPROTO_DATA_VENDOR 0xff /* Vendor specific */
413
414 #define UICLASS_FIRM_UPD 0x0c
415
416 #define UICLASS_APPL_SPEC 0xfe
417 #define UICLASS_VENDOR 0xff
418
419
420 #define USB_HUB_MAX_DEPTH 5
421
422 /*
423 * Minimum time a device needs to be powered down to go through
424 * a power cycle. XXX Are these time in the spec?
425 */
426 #define USB_POWER_DOWN_TIME 200 /* ms */
427 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */
428
429 #if 0
430 /* These are the values from the spec. */
431 #define USB_PORT_RESET_DELAY 10 /* ms */
432 #define USB_PORT_RESET_SETTLE 10 /* ms */
433 #define USB_PORT_POWERUP_DELAY 100 /* ms */
434 #define USB_SET_ADDRESS_SETTLE 2 /* ms */
435 #define USB_RESUME_DELAY (20*5) /* ms */
436 #define USB_RESUME_WAIT 10 /* ms */
437 #define USB_RESUME_RECOVERY 10 /* ms */
438 #define USB_EXTRA_POWER_UP_TIME 0 /* ms */
439 #else
440 /* Allow for marginal (i.e. non-conforming) devices. */
441 #define USB_PORT_RESET_DELAY 50 /* ms */
442 #define USB_PORT_RESET_RECOVERY 50 /* ms */
443 #define USB_PORT_POWERUP_DELAY 200 /* ms */
444 #define USB_SET_ADDRESS_SETTLE 10 /* ms */
445 #define USB_RESUME_DELAY (50*5) /* ms */
446 #define USB_RESUME_WAIT 50 /* ms */
447 #define USB_RESUME_RECOVERY 50 /* ms */
448 #define USB_EXTRA_POWER_UP_TIME 20 /* ms */
449 #endif
450
451 #define USB_MIN_POWER 100 /* mA */
452 #define USB_MAX_POWER 500 /* mA */
453
454 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/
455
456
457 #define USB_UNCONFIG_NO 0
458 #define USB_UNCONFIG_INDEX (-1)
459
460 /*** ioctl() related stuff ***/
461
462 struct usb_ctl_request {
463 int addr;
464 usb_device_request_t request;
465 void *data;
466 int flags;
467 #define USBD_SHORT_XFER_OK 0x04 /* allow short reads */
468 int actlen; /* actual length transferred */
469 };
470
471 struct usb_alt_interface {
472 int config_index;
473 int interface_index;
474 int alt_no;
475 };
476
477 #define USB_CURRENT_CONFIG_INDEX (-1)
478 #define USB_CURRENT_ALT_INDEX (-1)
479
480 struct usb_config_desc {
481 int config_index;
482 usb_config_descriptor_t desc;
483 };
484
485 struct usb_interface_desc {
486 int config_index;
487 int interface_index;
488 int alt_index;
489 usb_interface_descriptor_t desc;
490 };
491
492 struct usb_endpoint_desc {
493 int config_index;
494 int interface_index;
495 int alt_index;
496 int endpoint_index;
497 usb_endpoint_descriptor_t desc;
498 };
499
500 struct usb_full_desc {
501 int config_index;
502 u_int size;
503 u_char *data;
504 };
505
506 struct usb_string_desc {
507 int string_index;
508 int language_id;
509 usb_string_descriptor_t desc;
510 };
511
512 struct usb_ctl_report_desc {
513 int size;
514 u_char data[1024]; /* filled data size will vary */
515 };
516
517 typedef struct { u_int32_t cookie; } usb_event_cookie_t;
518
519 #define USB_MAX_DEVNAMES 4
520 #define USB_MAX_DEVNAMELEN 16
521 struct usb_device_info {
522 u_int8_t bus;
523 u_int8_t addr; /* device address */
524 usb_event_cookie_t cookie;
525 char product[USB_MAX_STRING_LEN];
526 char vendor[USB_MAX_STRING_LEN];
527 char release[8];
528 u_int16_t productNo;
529 u_int16_t vendorNo;
530 u_int16_t releaseNo;
531 u_int8_t class;
532 u_int8_t subclass;
533 u_int8_t protocol;
534 u_int8_t config;
535 u_int8_t lowspeed;
536 int power; /* power consumption in mA, 0 if selfpowered */
537 int nports;
538 char devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN];
539 u_int8_t ports[16];/* hub only: addresses of devices on ports */
540 #define USB_PORT_ENABLED 0xff
541 #define USB_PORT_SUSPENDED 0xfe
542 #define USB_PORT_POWERED 0xfd
543 #define USB_PORT_DISABLED 0xfc
544 };
545
546 struct usb_ctl_report {
547 int report;
548 u_char data[1024]; /* filled data size will vary */
549 };
550
551 struct usb_device_stats {
552 u_long requests[4]; /* indexed by transfer type UE_* */
553 };
554
555 /* Events that can be read from /dev/usb */
556 struct usb_event {
557 int ue_type;
558 #define USB_EVENT_CTRLR_ATTACH 1
559 #define USB_EVENT_CTRLR_DETACH 2
560 #define USB_EVENT_DEVICE_ATTACH 3
561 #define USB_EVENT_DEVICE_DETACH 4
562 #define USB_EVENT_DRIVER_ATTACH 5
563 #define USB_EVENT_DRIVER_DETACH 6
564 #define USB_EVENT_IS_ATTACH(n) ((n) == USB_EVENT_CTRLR_ATTACH || (n) == USB_EVENT_DEVICE_ATTACH || (n) == USB_EVENT_DRIVER_ATTACH)
565 struct timespec ue_time;
566 union {
567 struct {
568 int ue_bus;
569 } ue_ctrlr;
570 struct usb_device_info ue_device;
571 struct {
572 usb_event_cookie_t ue_cookie;
573 char ue_devname[16];
574 } ue_driver;
575 } u;
576 };
577
578 /* USB controller */
579 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request)
580 #define USB_SETDEBUG _IOW ('U', 2, int)
581 #define USB_DISCOVER _IO ('U', 3)
582 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info)
583 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats)
584
585 /* Generic HID device */
586 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc)
587 #define USB_SET_IMMED _IOW ('U', 22, int)
588 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report)
589 #define USB_SET_REPORT _IOW ('U', 24, struct usb_ctl_report)
590
591 /* Generic USB device */
592 #define USB_GET_CONFIG _IOR ('U', 100, int)
593 #define USB_SET_CONFIG _IOW ('U', 101, int)
594 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface)
595 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface)
596 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface)
597 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t)
598 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc)
599 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc)
600 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc)
601 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc)
602 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc)
603 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request)
604 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info)
605 #define USB_SET_SHORT_XFER _IOW ('U', 113, int)
606 #define USB_SET_TIMEOUT _IOW ('U', 114, int)
607
608 /* Modem device */
609 #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int)
610 #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int)
611
612 #endif /* _USB_H_ */
613