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