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>
55 #include <sys/malloc.h>
57 MALLOC_DECLARE(M_USB);
58 MALLOC_DECLARE(M_USBDEV);
59 MALLOC_DECLARE(M_USBHC);
65 #define PWR_SOFTSUSPEND 3
66 #define PWR_SOFTSTANDBY 4
67 #define PWR_SOFTRESUME 5
69 /* These two defines are used by usbd to autoload the usb kld */
70 #define USB_KLD "usb" /* name of usb module */
71 #define USB_UHUB "usb/uhub" /* root hub */
73 #define USB_STACK_VERSION 2
75 #define USB_MAX_DEVICES 128
76 #define USB_START_ADDR 0
78 #define USB_CONTROL_ENDPOINT 0
79 #define USB_MAX_ENDPOINTS 16
81 #define USB_FRAMES_PER_SECOND 1000
84 * The USB records contain some unaligned little-endian word
85 * components. The U[SG]ETW macros take care of both the alignment
86 * and endian problem and should always be used to access non-byte
89 typedef u_int8_t uByte;
90 typedef u_int8_t uWord[2];
91 typedef u_int8_t uDWord[4];
93 #define USETW2(w,h,l) ((w)[0] = (u_int8_t)(l), (w)[1] = (u_int8_t)(h))
96 #define UGETW(w) ((w)[0] | ((w)[1] << 8))
97 #define USETW(w,v) ((w)[0] = (u_int8_t)(v), (w)[1] = (u_int8_t)((v) >> 8))
98 #define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24))
99 #define USETDW(w,v) ((w)[0] = (u_int8_t)(v), \
100 (w)[1] = (u_int8_t)((v) >> 8), \
101 (w)[2] = (u_int8_t)((v) >> 16), \
102 (w)[3] = (u_int8_t)((v) >> 24))
105 * On little-endian machines that can handle unanliged accesses
106 * (e.g. i386) these macros can be replaced by the following.
108 #define UGETW(w) (*(u_int16_t *)(w))
109 #define USETW(w,v) (*(u_int16_t *)(w) = (v))
110 #define UGETDW(w) (*(u_int32_t *)(w))
111 #define USETDW(w,v) (*(u_int32_t *)(w) = (v))
114 #define UPACKED __packed
122 } UPACKED usb_device_request_t;
124 #define UT_WRITE 0x00
126 #define UT_STANDARD 0x00
127 #define UT_CLASS 0x20
128 #define UT_VENDOR 0x40
129 #define UT_DEVICE 0x00
130 #define UT_INTERFACE 0x01
131 #define UT_ENDPOINT 0x02
132 #define UT_OTHER 0x03
134 #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE)
135 #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE)
136 #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT)
137 #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE)
138 #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE)
139 #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT)
140 #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE)
141 #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE)
142 #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER)
143 #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT)
144 #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE)
145 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE)
146 #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER)
147 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT)
148 #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE)
149 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE)
150 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER)
151 #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT)
152 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE)
153 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE)
154 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER)
155 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT)
158 #define UR_GET_STATUS 0x00
159 #define UR_CLEAR_FEATURE 0x01
160 #define UR_SET_FEATURE 0x03
161 #define UR_SET_ADDRESS 0x05
162 #define UR_GET_DESCRIPTOR 0x06
163 #define UDESC_DEVICE 0x01
164 #define UDESC_CONFIG 0x02
165 #define UDESC_STRING 0x03
166 #define UDESC_INTERFACE 0x04
167 #define UDESC_ENDPOINT 0x05
168 #define UDESC_DEVICE_QUALIFIER 0x06
169 #define UDESC_OTHER_SPEED_CONFIGURATION 0x07
170 #define UDESC_INTERFACE_POWER 0x08
171 #define UDESC_OTG 0x09
172 #define UDESC_CS_DEVICE 0x21 /* class specific */
173 #define UDESC_CS_CONFIG 0x22
174 #define UDESC_CS_STRING 0x23
175 #define UDESC_CS_INTERFACE 0x24
176 #define UDESC_CS_ENDPOINT 0x25
177 #define UDESC_HUB 0x29
178 #define UR_SET_DESCRIPTOR 0x07
179 #define UR_GET_CONFIG 0x08
180 #define UR_SET_CONFIG 0x09
181 #define UR_GET_INTERFACE 0x0a
182 #define UR_SET_INTERFACE 0x0b
183 #define UR_SYNCH_FRAME 0x0c
185 /* Feature numbers */
186 #define UF_ENDPOINT_HALT 0
187 #define UF_DEVICE_REMOTE_WAKEUP 1
188 #define UF_TEST_MODE 2
190 #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */
192 #define USB_2_MAX_CTRL_PACKET 64
193 #define USB_2_MAX_BULK_PACKET 512
197 uByte bDescriptorType;
198 uByte bDescriptorSubtype;
199 } UPACKED usb_descriptor_t;
203 uByte bDescriptorType;
205 #define UD_USB_2_0 0x0200
206 #define UD_IS_USB2(d) (UGETW((d)->bcdUSB) >= UD_USB_2_0)
208 uByte bDeviceSubClass;
209 uByte bDeviceProtocol;
210 uByte bMaxPacketSize;
211 /* The fields below are not part of the initial descriptor. */
218 uByte bNumConfigurations;
219 } UPACKED usb_device_descriptor_t;
220 #define USB_DEVICE_DESCRIPTOR_SIZE 18
224 uByte bDescriptorType;
227 uByte bConfigurationValue;
228 uByte iConfiguration;
230 #define UC_BUS_POWERED 0x80
231 #define UC_SELF_POWERED 0x40
232 #define UC_REMOTE_WAKEUP 0x20
233 uByte bMaxPower; /* max current in 2 mA units */
234 #define UC_POWER_FACTOR 2
235 } UPACKED usb_config_descriptor_t;
236 #define USB_CONFIG_DESCRIPTOR_SIZE 9
240 uByte bDescriptorType;
241 uByte bInterfaceNumber;
242 uByte bAlternateSetting;
244 uByte bInterfaceClass;
245 uByte bInterfaceSubClass;
246 uByte bInterfaceProtocol;
248 } UPACKED usb_interface_descriptor_t;
249 #define USB_INTERFACE_DESCRIPTOR_SIZE 9
253 uByte bDescriptorType;
254 uByte bEndpointAddress;
255 #define UE_GET_DIR(a) ((a) & 0x80)
256 #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7))
257 #define UE_DIR_IN 0x80
258 #define UE_DIR_OUT 0x00
260 #define UE_GET_ADDR(a) ((a) & UE_ADDR)
262 #define UE_XFERTYPE 0x03
263 #define UE_CONTROL 0x00
264 #define UE_ISOCHRONOUS 0x01
266 #define UE_INTERRUPT 0x03
267 #define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE)
268 #define UE_ISO_TYPE 0x0c
269 #define UE_ISO_ASYNC 0x04
270 #define UE_ISO_ADAPT 0x08
271 #define UE_ISO_SYNC 0x0c
272 #define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE)
273 uWord wMaxPacketSize;
274 #define UE_GET_TRANS(a) (((a) >> 11) & 0x3)
275 #define UE_GET_SIZE(a) ((a) & 0x7ff)
277 } UPACKED usb_endpoint_descriptor_t;
278 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7
282 uByte bDescriptorType;
284 } UPACKED usb_string_descriptor_t;
285 #define USB_MAX_STRING_LEN 128
286 #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */
288 /* Hub specific request */
289 #define UR_GET_BUS_STATE 0x02
290 #define UR_CLEAR_TT_BUFFER 0x08
291 #define UR_RESET_TT 0x09
292 #define UR_GET_TT_STATE 0x0a
293 #define UR_STOP_TT 0x0b
296 #define UHF_C_HUB_LOCAL_POWER 0
297 #define UHF_C_HUB_OVER_CURRENT 1
298 #define UHF_PORT_CONNECTION 0
299 #define UHF_PORT_ENABLE 1
300 #define UHF_PORT_SUSPEND 2
301 #define UHF_PORT_OVER_CURRENT 3
302 #define UHF_PORT_RESET 4
303 #define UHF_PORT_POWER 8
304 #define UHF_PORT_LOW_SPEED 9
305 #define UHF_C_PORT_CONNECTION 16
306 #define UHF_C_PORT_ENABLE 17
307 #define UHF_C_PORT_SUSPEND 18
308 #define UHF_C_PORT_OVER_CURRENT 19
309 #define UHF_C_PORT_RESET 20
310 #define UHF_PORT_TEST 21
311 #define UHF_PORT_INDICATOR 22
315 uByte bDescriptorType;
317 uWord wHubCharacteristics;
318 #define UHD_PWR 0x0003
319 #define UHD_PWR_GANGED 0x0000
320 #define UHD_PWR_INDIVIDUAL 0x0001
321 #define UHD_PWR_NO_SWITCH 0x0002
322 #define UHD_COMPOUND 0x0004
323 #define UHD_OC 0x0018
324 #define UHD_OC_GLOBAL 0x0000
325 #define UHD_OC_INDIVIDUAL 0x0008
326 #define UHD_OC_NONE 0x0010
327 #define UHD_TT_THINK 0x0060
328 #define UHD_TT_THINK_8 0x0000
329 #define UHD_TT_THINK_16 0x0020
330 #define UHD_TT_THINK_24 0x0040
331 #define UHD_TT_THINK_32 0x0060
332 #define UHD_PORT_IND 0x0080
333 uByte bPwrOn2PwrGood; /* delay in 2 ms units */
334 #define UHD_PWRON_FACTOR 2
335 uByte bHubContrCurrent;
336 uByte DeviceRemovable[32]; /* max 255 ports */
337 #define UHD_NOT_REMOV(desc, i) \
338 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1)
339 /* deprecated */ uByte PortPowerCtrlMask[1];
340 } UPACKED usb_hub_descriptor_t;
341 #define USB_HUB_DESCRIPTOR_SIZE 9 /* includes deprecated PortPowerCtrlMask */
345 uByte bDescriptorType;
348 uByte bDeviceSubClass;
349 uByte bDeviceProtocol;
350 uByte bMaxPacketSize0;
351 uByte bNumConfigurations;
353 } UPACKED usb_device_qualifier_t;
354 #define USB_DEVICE_QUALIFIER_SIZE 10
358 uByte bDescriptorType;
360 #define UOTG_SRP 0x01
361 #define UOTG_HNP 0x02
362 } UPACKED usb_otg_descriptor_t;
364 /* OTG feature selectors */
365 #define UOTG_B_HNP_ENABLE 3
366 #define UOTG_A_HNP_SUPPORT 4
367 #define UOTG_A_ALT_HNP_SUPPORT 5
371 /* Device status flags */
372 #define UDS_SELF_POWERED 0x0001
373 #define UDS_REMOTE_WAKEUP 0x0002
374 /* Endpoint status flags */
375 #define UES_HALT 0x0001
376 } UPACKED usb_status_t;
380 #define UHS_LOCAL_POWER 0x0001
381 #define UHS_OVER_CURRENT 0x0002
383 } UPACKED usb_hub_status_t;
387 #define UPS_CURRENT_CONNECT_STATUS 0x0001
388 #define UPS_PORT_ENABLED 0x0002
389 #define UPS_SUSPEND 0x0004
390 #define UPS_OVERCURRENT_INDICATOR 0x0008
391 #define UPS_RESET 0x0010
392 #define UPS_PORT_POWER 0x0100
393 #define UPS_LOW_SPEED 0x0200
394 #define UPS_HIGH_SPEED 0x0400
395 #define UPS_PORT_TEST 0x0800
396 #define UPS_PORT_INDICATOR 0x1000
398 #define UPS_C_CONNECT_STATUS 0x0001
399 #define UPS_C_PORT_ENABLED 0x0002
400 #define UPS_C_SUSPEND 0x0004
401 #define UPS_C_OVERCURRENT_INDICATOR 0x0008
402 #define UPS_C_PORT_RESET 0x0010
403 } UPACKED usb_port_status_t;
405 /* Device class codes */
406 #define UDCLASS_IN_INTERFACE 0x00
407 #define UDCLASS_COMM 0x02
408 #define UDCLASS_HUB 0x09
409 #define UDSUBCLASS_HUB 0x00
410 #define UDPROTO_FSHUB 0x00
411 #define UDPROTO_HSHUBSTT 0x01
412 #define UDPROTO_HSHUBMTT 0x02
413 #define UDCLASS_DIAGNOSTIC 0xdc
414 #define UDCLASS_WIRELESS 0xe0
415 #define UDSUBCLASS_RF 0x01
416 #define UDPROTO_BLUETOOTH 0x01
417 #define UDCLASS_VENDOR 0xff
419 /* Interface class codes */
420 #define UICLASS_UNSPEC 0x00
422 #define UICLASS_AUDIO 0x01
423 #define UISUBCLASS_AUDIOCONTROL 1
424 #define UISUBCLASS_AUDIOSTREAM 2
425 #define UISUBCLASS_MIDISTREAM 3
427 #define UICLASS_CDC 0x02 /* communication */
428 #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1
429 #define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2
430 #define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3
431 #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4
432 #define UISUBCLASS_CAPI_CONTROLMODEL 5
433 #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6
434 #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7
435 #define UIPROTO_CDC_AT 1
437 #define UICLASS_HID 0x03
438 #define UISUBCLASS_BOOT 1
439 #define UIPROTO_BOOT_KEYBOARD 1
440 #define UIPROTO_MOUSE 2
442 #define UICLASS_PHYSICAL 0x05
444 #define UICLASS_IMAGE 0x06
446 #define UICLASS_PRINTER 0x07
447 #define UISUBCLASS_PRINTER 1
448 #define UIPROTO_PRINTER_UNI 1
449 #define UIPROTO_PRINTER_BI 2
450 #define UIPROTO_PRINTER_1284 3
452 #define UICLASS_MASS 0x08
453 #define UISUBCLASS_RBC 1
454 #define UISUBCLASS_SFF8020I 2
455 #define UISUBCLASS_QIC157 3
456 #define UISUBCLASS_UFI 4
457 #define UISUBCLASS_SFF8070I 5
458 #define UISUBCLASS_SCSI 6
459 #define UIPROTO_MASS_CBI_I 0
460 #define UIPROTO_MASS_CBI 1
461 #define UIPROTO_MASS_BBB_OLD 2 /* Not in the spec anymore */
462 #define UIPROTO_MASS_BBB 80 /* 'P' for the Iomega Zip drive */
464 #define UICLASS_HUB 0x09
465 #define UISUBCLASS_HUB 0
466 #define UIPROTO_FSHUB 0
467 #define UIPROTO_HSHUBSTT 0 /* Yes, same as previous */
468 #define UIPROTO_HSHUBMTT 1
470 #define UICLASS_CDC_DATA 0x0a
471 #define UISUBCLASS_DATA 0
472 #define UIPROTO_DATA_ISDNBRI 0x30 /* Physical iface */
473 #define UIPROTO_DATA_HDLC 0x31 /* HDLC */
474 #define UIPROTO_DATA_TRANSPARENT 0x32 /* Transparent */
475 #define UIPROTO_DATA_Q921M 0x50 /* Management for Q921 */
476 #define UIPROTO_DATA_Q921 0x51 /* Data for Q921 */
477 #define UIPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */
478 #define UIPROTO_DATA_V42BIS 0x90 /* Data compression */
479 #define UIPROTO_DATA_Q931 0x91 /* Euro-ISDN */
480 #define UIPROTO_DATA_V120 0x92 /* V.24 rate adaption */
481 #define UIPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */
482 #define UIPROTO_DATA_HOST_BASED 0xfd /* Host based driver */
483 #define UIPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc.*/
484 #define UIPROTO_DATA_VENDOR 0xff /* Vendor specific */
486 #define UICLASS_SMARTCARD 0x0b
488 /*#define UICLASS_FIRM_UPD 0x0c*/
490 #define UICLASS_SECURITY 0x0d
492 #define UICLASS_DIAGNOSTIC 0xdc
494 #define UICLASS_WIRELESS 0xe0
495 #define UISUBCLASS_RF 0x01
496 #define UIPROTO_BLUETOOTH 0x01
498 #define UICLASS_APPL_SPEC 0xfe
499 #define UISUBCLASS_FIRMWARE_DOWNLOAD 1
500 #define UISUBCLASS_IRDA 2
501 #define UIPROTO_IRDA 0
503 #define UICLASS_VENDOR 0xff
504 #define UISUBCLASS_XBOX360_CONTROLLER 0x5d
505 #define UIPROTO_XBOX360_GAMEPAD 0x01
508 #define USB_HUB_MAX_DEPTH 5
511 * Minimum time a device needs to be powered down to go through
512 * a power cycle. XXX Are these time in the spec?
514 #define USB_POWER_DOWN_TIME 200 /* ms */
515 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */
518 /* These are the values from the spec. */
519 #define USB_PORT_RESET_DELAY 10 /* ms */
520 #define USB_PORT_ROOT_RESET_DELAY 50 /* ms */
521 #define USB_PORT_RESET_RECOVERY 10 /* ms */
522 #define USB_PORT_POWERUP_DELAY 100 /* ms */
523 #define USB_SET_ADDRESS_SETTLE 2 /* ms */
524 #define USB_RESUME_DELAY (20*5) /* ms */
525 #define USB_RESUME_WAIT 10 /* ms */
526 #define USB_RESUME_RECOVERY 10 /* ms */
527 #define USB_EXTRA_POWER_UP_TIME 0 /* ms */
529 /* Allow for marginal (i.e. non-conforming) devices. */
530 #define USB_PORT_RESET_DELAY 50 /* ms */
531 #define USB_PORT_ROOT_RESET_DELAY 250 /* ms */
532 #define USB_PORT_RESET_RECOVERY 250 /* ms */
533 #define USB_PORT_POWERUP_DELAY 300 /* ms */
534 #define USB_SET_ADDRESS_SETTLE 10 /* ms */
535 #define USB_RESUME_DELAY (50*5) /* ms */
536 #define USB_RESUME_WAIT 50 /* ms */
537 #define USB_RESUME_RECOVERY 50 /* ms */
538 #define USB_EXTRA_POWER_UP_TIME 20 /* ms */
541 #define USB_MIN_POWER 100 /* mA */
542 #define USB_MAX_POWER 500 /* mA */
544 #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/
547 #define USB_UNCONFIG_NO 0
548 #define USB_UNCONFIG_INDEX (-1)
550 /*** ioctl() related stuff ***/
552 struct usb_ctl_request {
554 usb_device_request_t ucr_request;
557 #define USBD_SHORT_XFER_OK 0x04 /* allow short reads */
558 int ucr_actlen; /* actual length transferred */
561 struct usb_alt_interface {
562 int uai_config_index;
563 int uai_interface_index;
567 #define USB_CURRENT_CONFIG_INDEX (-1)
568 #define USB_CURRENT_ALT_INDEX (-1)
570 struct usb_config_desc {
571 int ucd_config_index;
572 usb_config_descriptor_t ucd_desc;
575 struct usb_interface_desc {
576 int uid_config_index;
577 int uid_interface_index;
579 usb_interface_descriptor_t uid_desc;
582 struct usb_endpoint_desc {
583 int ued_config_index;
584 int ued_interface_index;
586 int ued_endpoint_index;
587 usb_endpoint_descriptor_t ued_desc;
590 struct usb_full_desc {
591 int ufd_config_index;
596 struct usb_string_desc {
597 int usd_string_index;
599 usb_string_descriptor_t usd_desc;
602 struct usb_ctl_report_desc {
604 u_char ucrd_data[1024]; /* filled data size will vary */
607 typedef struct { u_int32_t cookie; } usb_event_cookie_t;
609 #define USB_MAX_DEVNAMES 4
610 #define USB_MAX_DEVNAMELEN 16
611 struct usb_device_info {
613 u_int8_t udi_addr; /* device address */
614 usb_event_cookie_t udi_cookie;
615 char udi_product[USB_MAX_STRING_LEN];
616 char udi_vendor[USB_MAX_STRING_LEN];
618 u_int16_t udi_productNo;
619 u_int16_t udi_vendorNo;
620 u_int16_t udi_releaseNo;
622 u_int8_t udi_subclass;
623 u_int8_t udi_protocol;
626 #define USB_SPEED_LOW 1
627 #define USB_SPEED_FULL 2
628 #define USB_SPEED_HIGH 3
629 int udi_power; /* power consumption in mA, 0 if selfpowered */
631 char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN];
632 u_int8_t udi_ports[16];/* hub only: addresses of devices on ports */
633 #define USB_PORT_ENABLED 0xff
634 #define USB_PORT_SUSPENDED 0xfe
635 #define USB_PORT_POWERED 0xfd
636 #define USB_PORT_DISABLED 0xfc
639 struct usb_ctl_report {
641 u_char ucr_data[1024]; /* filled data size will vary */
644 struct usb_device_stats {
645 u_long uds_requests[4]; /* indexed by transfer type UE_* */
648 /* Events that can be read from /dev/usb */
651 #define USB_EVENT_CTRLR_ATTACH 1
652 #define USB_EVENT_CTRLR_DETACH 2
653 #define USB_EVENT_DEVICE_ATTACH 3
654 #define USB_EVENT_DEVICE_DETACH 4
655 #define USB_EVENT_DRIVER_ATTACH 5
656 #define USB_EVENT_DRIVER_DETACH 6
657 #define USB_EVENT_IS_ATTACH(n) ((n) == USB_EVENT_CTRLR_ATTACH || (n) == USB_EVENT_DEVICE_ATTACH || (n) == USB_EVENT_DRIVER_ATTACH)
658 #define USB_EVENT_IS_DETACH(n) ((n) == USB_EVENT_CTRLR_DETACH || (n) == USB_EVENT_DEVICE_DETACH || (n) == USB_EVENT_DRIVER_DETACH)
659 struct timespec ue_time;
664 struct usb_device_info ue_device;
666 usb_event_cookie_t ue_cookie;
673 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request)
674 #define USB_SETDEBUG _IOW ('U', 2, int)
675 #define USB_DISCOVER _IO ('U', 3)
676 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info)
677 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats)
679 /* Generic HID device */
680 #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc)
681 #define USB_SET_IMMED _IOW ('U', 22, int)
682 #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report)
683 #define USB_SET_REPORT _IOW ('U', 24, struct usb_ctl_report)
684 #define USB_GET_REPORT_ID _IOR ('U', 25, int)
686 /* Generic USB device */
687 #define USB_GET_CONFIG _IOR ('U', 100, int)
688 #define USB_SET_CONFIG _IOW ('U', 101, int)
689 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface)
690 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface)
691 #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface)
692 #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t)
693 #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc)
694 #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc)
695 #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc)
696 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc)
697 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc)
698 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request)
699 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info)
700 #define USB_SET_SHORT_XFER _IOW ('U', 113, int)
701 #define USB_SET_TIMEOUT _IOW ('U', 114, int)
704 #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int)
705 #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int)