1 /* $NetBSD: usb.h,v 1.69 2002/09/22 23:20:50 augustss Exp $ */
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
45 #include <sys/types.h>
48 #if defined(__NetBSD__) || defined(__OpenBSD__)
49 #include <sys/ioctl.h>
53 #include <dev/usb/usb_port.h>
56 /* These two defines are used by usbd to autoload the usb kld */
57 #define USB_KLD "usb" /* name of usb module */
58 #define USB_UHUB "usb/uhub" /* root hub */
60 #define USB_STACK_VERSION 2
62 #define USB_MAX_DEVICES 128
63 #define USB_START_ADDR 0
65 #define USB_CONTROL_ENDPOINT 0
66 #define USB_MAX_ENDPOINTS 16
68 #define USB_FRAMES_PER_SECOND 1000
71 * The USB records contain some unaligned little-endian word
72 * components. The U[SG]ETW macros take care of both the alignment
73 * and endian problem and should always be used to access non-byte
76 typedef u_int8_t uByte;
77 typedef u_int8_t uWord[2];
78 typedef u_int8_t uDWord[4];
80 #define USETW2(w,h,l) ((w)[0] = (u_int8_t)(l), (w)[1] = (u_int8_t)(h))
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 UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24))
86 #define USETDW(w,v) ((w)[0] = (u_int8_t)(v), \
87 (w)[1] = (u_int8_t)((v) >> 8), \
88 (w)[2] = (u_int8_t)((v) >> 16), \
89 (w)[3] = (u_int8_t)((v) >> 24))
92 * On little-endian machines that can handle unanliged accesses
93 * (e.g. i386) these macros can be replaced by the following.
95 #define UGETW(w) (*(u_int16_t *)(w))
96 #define USETW(w,v) (*(u_int16_t *)(w) = (v))
97 #define UGETDW(w) (*(u_int32_t *)(w))
98 #define USETDW(w,v) (*(u_int32_t *)(w) = (v))
101 #if defined(__FreeBSD__) && (__FreeBSD_version <= 500014)
102 #define UPACKED __attribute__ ((packed))
104 #define UPACKED __packed
113 } UPACKED usb_device_request_t;
115 #define UT_WRITE 0x00
117 #define UT_STANDARD 0x00
118 #define UT_CLASS 0x20
119 #define UT_VENDOR 0x40
120 #define UT_DEVICE 0x00
121 #define UT_INTERFACE 0x01
122 #define UT_ENDPOINT 0x02
123 #define UT_OTHER 0x03
125 #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE)
126 #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE)
127 #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT)
128 #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE)
129 #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE)
130 #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT)
131 #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE)
132 #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE)
133 #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER)
134 #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT)
135 #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE)
136 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE)
137 #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER)
138 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT)
139 #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE)
140 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE)
141 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER)
142 #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT)
143 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE)
144 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE)
145 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER)
146 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT)
149 #define UR_GET_STATUS 0x00
150 #define UR_CLEAR_FEATURE 0x01
151 #define UR_SET_FEATURE 0x03
152 #define UR_SET_ADDRESS 0x05
153 #define UR_GET_DESCRIPTOR 0x06
154 #define UDESC_DEVICE 0x01
155 #define UDESC_CONFIG 0x02
156 #define UDESC_STRING 0x03
157 #define UDESC_INTERFACE 0x04
158 #define UDESC_ENDPOINT 0x05
159 #define UDESC_DEVICE_QUALIFIER 0x06
160 #define UDESC_OTHER_SPEED_CONFIGURATION 0x07
161 #define UDESC_INTERFACE_POWER 0x08
162 #define UDESC_OTG 0x09
163 #define UDESC_CS_DEVICE 0x21 /* class specific */
164 #define UDESC_CS_CONFIG 0x22
165 #define UDESC_CS_STRING 0x23
166 #define UDESC_CS_INTERFACE 0x24
167 #define UDESC_CS_ENDPOINT 0x25
168 #define UDESC_HUB 0x29
169 #define UR_SET_DESCRIPTOR 0x07
170 #define UR_GET_CONFIG 0x08
171 #define UR_SET_CONFIG 0x09
172 #define UR_GET_INTERFACE 0x0a
173 #define UR_SET_INTERFACE 0x0b
174 #define UR_SYNCH_FRAME 0x0c
176 /* Feature numbers */
177 #define UF_ENDPOINT_HALT 0
178 #define UF_DEVICE_REMOTE_WAKEUP 1
179 #define UF_TEST_MODE 2
181 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */
183 #define USB_2_MAX_CTRL_PACKET 64
184 #define USB_2_MAX_BULK_PACKET 512
188 uByte bDescriptorType;
189 uByte bDescriptorSubtype;
190 } UPACKED usb_descriptor_t;
194 uByte bDescriptorType;
196 #define UD_USB_2_0 0x0200
197 #define UD_IS_USB2(d) (UGETW((d)->bcdUSB) >= UD_USB_2_0)
199 uByte bDeviceSubClass;
200 uByte bDeviceProtocol;
201 uByte bMaxPacketSize;
202 /* The fields below are not part of the initial descriptor. */
209 uByte bNumConfigurations;
210 } UPACKED usb_device_descriptor_t;
211 #define USB_DEVICE_DESCRIPTOR_SIZE 18
215 uByte bDescriptorType;
218 uByte bConfigurationValue;
219 uByte iConfiguration;
221 #define UC_BUS_POWERED 0x80
222 #define UC_SELF_POWERED 0x40
223 #define UC_REMOTE_WAKEUP 0x20
224 uByte bMaxPower; /* max current in 2 mA units */
225 #define UC_POWER_FACTOR 2
226 } UPACKED usb_config_descriptor_t;
227 #define USB_CONFIG_DESCRIPTOR_SIZE 9
231 uByte bDescriptorType;
232 uByte bInterfaceNumber;
233 uByte bAlternateSetting;
235 uByte bInterfaceClass;
236 uByte bInterfaceSubClass;
237 uByte bInterfaceProtocol;
239 } UPACKED usb_interface_descriptor_t;
240 #define USB_INTERFACE_DESCRIPTOR_SIZE 9
244 uByte bDescriptorType;
245 uByte bEndpointAddress;
246 #define UE_GET_DIR(a) ((a) & 0x80)
247 #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7))
248 #define UE_DIR_IN 0x80
249 #define UE_DIR_OUT 0x00
251 #define UE_GET_ADDR(a) ((a) & UE_ADDR)
253 #define UE_XFERTYPE 0x03
254 #define UE_CONTROL 0x00
255 #define UE_ISOCHRONOUS 0x01
257 #define UE_INTERRUPT 0x03
258 #define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE)
259 #define UE_ISO_TYPE 0x0c
260 #define UE_ISO_ASYNC 0x04
261 #define UE_ISO_ADAPT 0x08
262 #define UE_ISO_SYNC 0x0c
263 #define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE)
264 uWord wMaxPacketSize;
266 } UPACKED usb_endpoint_descriptor_t;
267 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7
271 uByte bDescriptorType;
273 } UPACKED usb_string_descriptor_t;
274 #define USB_MAX_STRING_LEN 128
275 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */
277 /* Hub specific request */
278 #define UR_GET_BUS_STATE 0x02
279 #define UR_CLEAR_TT_BUFFER 0x08
280 #define UR_RESET_TT 0x09
281 #define UR_GET_TT_STATE 0x0a
282 #define UR_STOP_TT 0x0b
285 #define UHF_C_HUB_LOCAL_POWER 0
286 #define UHF_C_HUB_OVER_CURRENT 1
287 #define UHF_PORT_CONNECTION 0
288 #define UHF_PORT_ENABLE 1
289 #define UHF_PORT_SUSPEND 2
290 #define UHF_PORT_OVER_CURRENT 3
291 #define UHF_PORT_RESET 4
292 #define UHF_PORT_POWER 8
293 #define UHF_PORT_LOW_SPEED 9
294 #define UHF_C_PORT_CONNECTION 16
295 #define UHF_C_PORT_ENABLE 17
296 #define UHF_C_PORT_SUSPEND 18
297 #define UHF_C_PORT_OVER_CURRENT 19
298 #define UHF_C_PORT_RESET 20
299 #define UHF_PORT_TEST 21
300 #define UHF_PORT_INDICATOR 22
304 uByte bDescriptorType;
306 uWord wHubCharacteristics;
307 #define UHD_PWR 0x0003
308 #define UHD_PWR_GANGED 0x0000
309 #define UHD_PWR_INDIVIDUAL 0x0001
310 #define UHD_PWR_NO_SWITCH 0x0002
311 #define UHD_COMPOUND 0x0004
312 #define UHD_OC 0x0018
313 #define UHD_OC_GLOBAL 0x0000
314 #define UHD_OC_INDIVIDUAL 0x0008
315 #define UHD_OC_NONE 0x0010
316 #define UHD_TT_THINK 0x0060
317 #define UHD_TT_THINK_8 0x0000
318 #define UHD_TT_THINK_16 0x0020
319 #define UHD_TT_THINK_24 0x0040
320 #define UHD_TT_THINK_32 0x0060
321 #define UHD_PORT_IND 0x0080
322 uByte bPwrOn2PwrGood; /* delay in 2 ms units */
323 #define UHD_PWRON_FACTOR 2
324 uByte bHubContrCurrent;
325 uByte DeviceRemovable[32]; /* max 255 ports */
326 #define UHD_NOT_REMOV(desc, i) \
327 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1)
328 /* deprecated */ uByte PortPowerCtrlMask[1];
329 } UPACKED usb_hub_descriptor_t;
330 #define USB_HUB_DESCRIPTOR_SIZE 9 /* includes deprecated PortPowerCtrlMask */
334 uByte bDescriptorType;
337 uByte bDeviceSubClass;
338 uByte bDeviceProtocol;
339 uByte bMaxPacketSize0;
340 uByte bNumConfigurations;
342 } UPACKED usb_device_qualifier_t;
343 #define USB_DEVICE_QUALIFIER_SIZE 10
347 uByte bDescriptorType;
349 #define UOTG_SRP 0x01
350 #define UOTG_HNP 0x02
351 } UPACKED usb_otg_descriptor_t;
353 /* OTG feature selectors */
354 #define UOTG_B_HNP_ENABLE 3
355 #define UOTG_A_HNP_SUPPORT 4
356 #define UOTG_A_ALT_HNP_SUPPORT 5
360 /* Device status flags */
361 #define UDS_SELF_POWERED 0x0001
362 #define UDS_REMOTE_WAKEUP 0x0002
363 /* Endpoint status flags */
364 #define UES_HALT 0x0001
365 } UPACKED usb_status_t;
369 #define UHS_LOCAL_POWER 0x0001
370 #define UHS_OVER_CURRENT 0x0002
372 } UPACKED usb_hub_status_t;
376 #define UPS_CURRENT_CONNECT_STATUS 0x0001
377 #define UPS_PORT_ENABLED 0x0002
378 #define UPS_SUSPEND 0x0004
379 #define UPS_OVERCURRENT_INDICATOR 0x0008
380 #define UPS_RESET 0x0010
381 #define UPS_PORT_POWER 0x0100
382 #define UPS_LOW_SPEED 0x0200
383 #define UPS_HIGH_SPEED 0x0400
384 #define UPS_PORT_TEST 0x0800
385 #define UPS_PORT_INDICATOR 0x1000
387 #define UPS_C_CONNECT_STATUS 0x0001
388 #define UPS_C_PORT_ENABLED 0x0002
389 #define UPS_C_SUSPEND 0x0004
390 #define UPS_C_OVERCURRENT_INDICATOR 0x0008
391 #define UPS_C_PORT_RESET 0x0010
392 } UPACKED usb_port_status_t;
394 /* Device class codes */
395 #define UDCLASS_IN_INTERFACE 0x00
396 #define UDCLASS_COMM 0x02
397 #define UDCLASS_HUB 0x09
398 #define UDSUBCLASS_HUB 0x00
399 #define UDPROTO_FSHUB 0x00
400 #define UDPROTO_HSHUBSTT 0x01
401 #define UDPROTO_HSHUBMTT 0x02
402 #define UDCLASS_DIAGNOSTIC 0xdc
403 #define UDCLASS_WIRELESS 0xe0
404 #define UDSUBCLASS_RF 0x01
405 #define UDPROTO_BLUETOOTH 0x01
406 #define UDCLASS_VENDOR 0xff
408 /* Interface class codes */
409 #define UICLASS_UNSPEC 0x00
411 #define UICLASS_AUDIO 0x01
412 #define UISUBCLASS_AUDIOCONTROL 1
413 #define UISUBCLASS_AUDIOSTREAM 2
414 #define UISUBCLASS_MIDISTREAM 3
416 #define UICLASS_CDC 0x02 /* communication */
417 #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1
418 #define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2
419 #define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3
420 #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4
421 #define UISUBCLASS_CAPI_CONTROLMODEL 5
422 #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6
423 #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7
424 #define UIPROTO_CDC_AT 1
426 #define UICLASS_HID 0x03
427 #define UISUBCLASS_BOOT 1
428 #define UIPROTO_BOOT_KEYBOARD 1
430 #define UICLASS_PHYSICAL 0x05
432 #define UICLASS_IMAGE 0x06
434 #define UICLASS_PRINTER 0x07
435 #define UISUBCLASS_PRINTER 1
436 #define UIPROTO_PRINTER_UNI 1
437 #define UIPROTO_PRINTER_BI 2
438 #define UIPROTO_PRINTER_1284 3
440 #define UICLASS_MASS 0x08
441 #define UISUBCLASS_RBC 1
442 #define UISUBCLASS_SFF8020I 2
443 #define UISUBCLASS_QIC157 3
444 #define UISUBCLASS_UFI 4
445 #define UISUBCLASS_SFF8070I 5
446 #define UISUBCLASS_SCSI 6
447 #define UIPROTO_MASS_CBI_I 0
448 #define UIPROTO_MASS_CBI 1
449 #define UIPROTO_MASS_BBB_OLD 2 /* Not in the spec anymore */
450 #define UIPROTO_MASS_BBB 80 /* 'P' for the Iomega Zip drive */
452 #define UICLASS_HUB 0x09
453 #define UISUBCLASS_HUB 0
454 #define UIPROTO_FSHUB 0
455 #define UIPROTO_HSHUBSTT 0 /* Yes, same as previous */
456 #define UIPROTO_HSHUBMTT 1
458 #define UICLASS_CDC_DATA 0x0a
459 #define UISUBCLASS_DATA 0
460 #define UIPROTO_DATA_ISDNBRI 0x30 /* Physical iface */
461 #define UIPROTO_DATA_HDLC 0x31 /* HDLC */
462 #define UIPROTO_DATA_TRANSPARENT 0x32 /* Transparent */
463 #define UIPROTO_DATA_Q921M 0x50 /* Management for Q921 */
464 #define UIPROTO_DATA_Q921 0x51 /* Data for Q921 */
465 #define UIPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */
466 #define UIPROTO_DATA_V42BIS 0x90 /* Data compression */
467 #define UIPROTO_DATA_Q931 0x91 /* Euro-ISDN */
468 #define UIPROTO_DATA_V120 0x92 /* V.24 rate adaption */
469 #define UIPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */
470 #define UIPROTO_DATA_HOST_BASED 0xfd /* Host based driver */
471 #define UIPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc.*/
472 #define UIPROTO_DATA_VENDOR 0xff /* Vendor specific */
474 #define UICLASS_SMARTCARD 0x0b
476 /*#define UICLASS_FIRM_UPD 0x0c*/
478 #define UICLASS_SECURITY 0x0d
480 #define UICLASS_DIAGNOSTIC 0xdc
482 #define UICLASS_WIRELESS 0xe0
483 #define UISUBCLASS_RF 0x01
484 #define UIPROTO_BLUETOOTH 0x01
486 #define UICLASS_APPL_SPEC 0xfe
487 #define UISUBCLASS_FIRMWARE_DOWNLOAD 1
488 #define UISUBCLASS_IRDA 2
489 #define UIPROTO_IRDA 0
491 #define UICLASS_VENDOR 0xff
494 #define USB_HUB_MAX_DEPTH 5
497 * Minimum time a device needs to be powered down to go through
498 * a power cycle. XXX Are these time in the spec?
500 #define USB_POWER_DOWN_TIME 200 /* ms */
501 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */
504 /* These are the values from the spec. */
505 #define USB_PORT_RESET_DELAY 10 /* ms */
506 #define USB_PORT_ROOT_RESET_DELAY 50 /* ms */
507 #define USB_PORT_RESET_RECOVERY 10 /* ms */
508 #define USB_PORT_POWERUP_DELAY 100 /* ms */
509 #define USB_SET_ADDRESS_SETTLE 2 /* ms */
510 #define USB_RESUME_DELAY (20*5) /* ms */
511 #define USB_RESUME_WAIT 10 /* ms */
512 #define USB_RESUME_RECOVERY 10 /* ms */
513 #define USB_EXTRA_POWER_UP_TIME 0 /* ms */
515 /* Allow for marginal (i.e. non-conforming) devices. */
516 #define USB_PORT_RESET_DELAY 50 /* ms */
517 #define USB_PORT_ROOT_RESET_DELAY 250 /* ms */
518 #define USB_PORT_RESET_RECOVERY 250 /* ms */
519 #define USB_PORT_POWERUP_DELAY 300 /* ms */
520 #define USB_SET_ADDRESS_SETTLE 10 /* ms */
521 #define USB_RESUME_DELAY (50*5) /* ms */
522 #define USB_RESUME_WAIT 50 /* ms */
523 #define USB_RESUME_RECOVERY 50 /* ms */
524 #define USB_EXTRA_POWER_UP_TIME 20 /* ms */
527 #define USB_MIN_POWER 100 /* mA */
528 #define USB_MAX_POWER 500 /* mA */
530 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/
533 #define USB_UNCONFIG_NO 0
534 #define USB_UNCONFIG_INDEX (-1)
536 /*** ioctl() related stuff ***/
538 struct usb_ctl_request {
540 usb_device_request_t ucr_request;
543 #define USBD_SHORT_XFER_OK 0x04 /* allow short reads */
544 int ucr_actlen; /* actual length transferred */
547 struct usb_alt_interface {
548 int uai_config_index;
549 int uai_interface_index;
553 #define USB_CURRENT_CONFIG_INDEX (-1)
554 #define USB_CURRENT_ALT_INDEX (-1)
556 struct usb_config_desc {
557 int ucd_config_index;
558 usb_config_descriptor_t ucd_desc;
561 struct usb_interface_desc {
562 int uid_config_index;
563 int uid_interface_index;
565 usb_interface_descriptor_t uid_desc;
568 struct usb_endpoint_desc {
569 int ued_config_index;
570 int ued_interface_index;
572 int ued_endpoint_index;
573 usb_endpoint_descriptor_t ued_desc;
576 struct usb_full_desc {
577 int ufd_config_index;
582 struct usb_string_desc {
583 int usd_string_index;
585 usb_string_descriptor_t usd_desc;
588 struct usb_ctl_report_desc {
590 u_char ucrd_data[1024]; /* filled data size will vary */
593 typedef struct { u_int32_t cookie; } usb_event_cookie_t;
595 #define USB_MAX_DEVNAMES 4
596 #define USB_MAX_DEVNAMELEN 16
597 struct usb_device_info {
599 u_int8_t udi_addr; /* device address */
600 usb_event_cookie_t udi_cookie;
601 char udi_product[USB_MAX_STRING_LEN];
602 char udi_vendor[USB_MAX_STRING_LEN];
604 u_int16_t udi_productNo;
605 u_int16_t udi_vendorNo;
606 u_int16_t udi_releaseNo;
608 u_int8_t udi_subclass;
609 u_int8_t udi_protocol;
612 #define USB_SPEED_LOW 1
613 #define USB_SPEED_FULL 2
614 #define USB_SPEED_HIGH 3
615 int udi_power; /* power consumption in mA, 0 if selfpowered */
617 char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN];
618 u_int8_t udi_ports[16];/* hub only: addresses of devices on ports */
619 #define USB_PORT_ENABLED 0xff
620 #define USB_PORT_SUSPENDED 0xfe
621 #define USB_PORT_POWERED 0xfd
622 #define USB_PORT_DISABLED 0xfc
625 struct usb_ctl_report {
627 u_char ucr_data[1024]; /* filled data size will vary */
630 struct usb_device_stats {
631 u_long uds_requests[4]; /* indexed by transfer type UE_* */
634 /* Events that can be read from /dev/usb */
637 #define USB_EVENT_CTRLR_ATTACH 1
638 #define USB_EVENT_CTRLR_DETACH 2
639 #define USB_EVENT_DEVICE_ATTACH 3
640 #define USB_EVENT_DEVICE_DETACH 4
641 #define USB_EVENT_DRIVER_ATTACH 5
642 #define USB_EVENT_DRIVER_DETACH 6
643 #define USB_EVENT_IS_ATTACH(n) ((n) == USB_EVENT_CTRLR_ATTACH || (n) == USB_EVENT_DEVICE_ATTACH || (n) == USB_EVENT_DRIVER_ATTACH)
644 #define USB_EVENT_IS_DETACH(n) ((n) == USB_EVENT_CTRLR_DETACH || (n) == USB_EVENT_DEVICE_DETACH || (n) == USB_EVENT_DRIVER_DETACH)
645 struct timespec ue_time;
650 struct usb_device_info ue_device;
652 usb_event_cookie_t ue_cookie;
659 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request)
660 #define USB_SETDEBUG _IOW ('U', 2, int)
661 #define USB_DISCOVER _IO ('U', 3)
662 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info)
663 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats)
665 /* Generic HID device */
666 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc)
667 #define USB_SET_IMMED _IOW ('U', 22, int)
668 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report)
669 #define USB_SET_REPORT _IOW ('U', 24, struct usb_ctl_report)
670 #define USB_GET_REPORT_ID _IOR ('U', 25, int)
672 /* Generic USB device */
673 #define USB_GET_CONFIG _IOR ('U', 100, int)
674 #define USB_SET_CONFIG _IOW ('U', 101, int)
675 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface)
676 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface)
677 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface)
678 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t)
679 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc)
680 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc)
681 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc)
682 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc)
683 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc)
684 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request)
685 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info)
686 #define USB_SET_SHORT_XFER _IOW ('U', 113, int)
687 #define USB_SET_TIMEOUT _IOW ('U', 114, int)
690 #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int)
691 #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int)