Home | History | Annotate | Line # | Download | only in usb
usb.h revision 1.38
      1 /*	$NetBSD: usb.h,v 1.38 1999/10/20 21:02:39 augustss Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Lennart Augustsson (augustss (at) carlstedt.se) at
      9  * Carlstedt Research & Technology.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions and the following disclaimer.
     16  * 2. Redistributions in binary form must reproduce the above copyright
     17  *    notice, this list of conditions and the following disclaimer in the
     18  *    documentation and/or other materials provided with the distribution.
     19  * 3. All advertising materials mentioning features or use of this software
     20  *    must display the following acknowledgement:
     21  *        This product includes software developed by the NetBSD
     22  *        Foundation, Inc. and its contributors.
     23  * 4. Neither the name of The NetBSD Foundation nor the names of its
     24  *    contributors may be used to endorse or promote products derived
     25  *    from this software without specific prior written permission.
     26  *
     27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     37  * POSSIBILITY OF SUCH DAMAGE.
     38  */
     39 
     40 
     41 #ifndef _USB_H_
     42 #define _USB_H_
     43 
     44 #include <sys/types.h>
     45 #include <sys/time.h>
     46 
     47 #if defined(__NetBSD__) || defined(__OpenBSD__)
     48 #include <sys/ioctl.h>
     49 
     50 #if defined(_KERNEL)
     51 #include <dev/usb/usb_port.h>
     52 #endif /* _KERNEL */
     53 
     54 #elif defined(__FreeBSD__)
     55 #if defined(KERNEL)
     56 #include <sys/malloc.h>
     57 
     58 MALLOC_DECLARE(M_USB);
     59 MALLOC_DECLARE(M_USBDEV);
     60 MALLOC_DECLARE(M_USBHC);
     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_READ_CLASS_ENDPOINT	(UT_READ  | UT_CLASS | UT_ENDPOINT)
    129 #define UT_WRITE_CLASS_DEVICE	(UT_WRITE | UT_CLASS | UT_DEVICE)
    130 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE)
    131 #define UT_WRITE_CLASS_OTHER	(UT_WRITE | UT_CLASS | UT_OTHER)
    132 #define UT_WRITE_CLASS_ENDPOINT	(UT_WRITE | UT_CLASS | UT_ENDPOINT)
    133 #define UT_READ_VENDOR_DEVICE	(UT_READ  | UT_VENDOR | UT_DEVICE)
    134 #define UT_READ_VENDOR_INTERFACE (UT_READ  | UT_VENDOR | UT_INTERFACE)
    135 #define UT_READ_VENDOR_OTHER	(UT_READ  | UT_VENDOR | UT_OTHER)
    136 #define UT_READ_VENDOR_ENDPOINT	(UT_READ  | UT_VENDOR | UT_ENDPOINT)
    137 #define UT_WRITE_VENDOR_DEVICE	(UT_WRITE | UT_VENDOR | UT_DEVICE)
    138 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE)
    139 #define UT_WRITE_VENDOR_OTHER	(UT_WRITE | UT_VENDOR | UT_OTHER)
    140 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT)
    141 
    142 /* Requests */
    143 #define UR_GET_STATUS		0x00
    144 #define UR_CLEAR_FEATURE	0x01
    145 #define UR_SET_FEATURE		0x03
    146 #define UR_SET_ADDRESS		0x05
    147 #define UR_GET_DESCRIPTOR	0x06
    148 #define  UDESC_DEVICE		0x01
    149 #define  UDESC_CONFIG		0x02
    150 #define  UDESC_STRING		0x03
    151 #define  UDESC_INTERFACE	0x04
    152 #define  UDESC_ENDPOINT		0x05
    153 #define  UDESC_CS_DEVICE	0x21	/* class specific */
    154 #define  UDESC_CS_CONFIG	0x22
    155 #define  UDESC_CS_STRING	0x23
    156 #define  UDESC_CS_INTERFACE	0x24
    157 #define  UDESC_CS_ENDPOINT	0x25
    158 #define  UDESC_HUB		0x29
    159 #define UR_SET_DESCRIPTOR	0x07
    160 #define UR_GET_CONFIG		0x08
    161 #define UR_SET_CONFIG		0x09
    162 #define UR_GET_INTERFACE	0x0a
    163 #define UR_SET_INTERFACE	0x0b
    164 #define UR_SYNCH_FRAME		0x0c
    165 
    166 /* Feature numbers */
    167 #define UF_ENDPOINT_HALT	0
    168 #define UF_DEVICE_REMOTE_WAKEUP	1
    169 
    170 #define USB_MAX_IPACKET		8 /* maximum size of the initial packet */
    171 
    172 typedef struct {
    173 	uByte		bLength;
    174 	uByte		bDescriptorType;
    175 	uByte		bDescriptorSubtype;
    176 } usb_descriptor_t;
    177 
    178 typedef struct {
    179 	uByte		bLength;
    180 	uByte		bDescriptorType;
    181 	uWord		bcdUSB;
    182 	uByte		bDeviceClass;
    183 	uByte		bDeviceSubClass;
    184 	uByte		bDeviceProtocol;
    185 	uByte		bMaxPacketSize;
    186 	/* The fields below are not part of the initial descriptor. */
    187 	uWord		idVendor;
    188 	uWord		idProduct;
    189 	uWord		bcdDevice;
    190 	uByte		iManufacturer;
    191 	uByte		iProduct;
    192 	uByte		iSerialNumber;
    193 	uByte		bNumConfigurations;
    194 } usb_device_descriptor_t;
    195 #define USB_DEVICE_DESCRIPTOR_SIZE 18
    196 
    197 typedef struct {
    198 	uByte		bLength;
    199 	uByte		bDescriptorType;
    200 	uWord		wTotalLength;
    201 	uByte		bNumInterface;
    202 	uByte		bConfigurationValue;
    203 	uByte		iConfiguration;
    204 	uByte		bmAttributes;
    205 #define UC_BUS_POWERED		0x80
    206 #define UC_SELF_POWERED		0x40
    207 #define UC_REMOTE_WAKEUP	0x20
    208 	uByte		bMaxPower; /* max current in 2 mA units */
    209 #define UC_POWER_FACTOR 2
    210 } usb_config_descriptor_t;
    211 #define USB_CONFIG_DESCRIPTOR_SIZE 9
    212 
    213 typedef struct {
    214 	uByte		bLength;
    215 	uByte		bDescriptorType;
    216 	uByte		bInterfaceNumber;
    217 	uByte		bAlternateSetting;
    218 	uByte		bNumEndpoints;
    219 	uByte		bInterfaceClass;
    220 	uByte		bInterfaceSubClass;
    221 	uByte		bInterfaceProtocol;
    222 	uByte		iInterface;
    223 } usb_interface_descriptor_t;
    224 #define USB_INTERFACE_DESCRIPTOR_SIZE 9
    225 
    226 typedef struct {
    227 	uByte		bLength;
    228 	uByte		bDescriptorType;
    229 	uByte		bEndpointAddress;
    230 #define UE_GET_DIR(a)	((a) & 0x80)
    231 #define UE_SET_DIR(a,d)	((a) | (((d)&1) << 7))
    232 #define UE_DIR_IN	0x80
    233 #define UE_DIR_OUT	0x00
    234 #define UE_ADDR		0x0f
    235 #define UE_GET_ADDR(a)	((a) & UE_ADDR)
    236 	uByte		bmAttributes;
    237 #define UE_XFERTYPE	0x03
    238 #define  UE_CONTROL	0x00
    239 #define  UE_ISOCHRONOUS	0x01
    240 #define  UE_BULK	0x02
    241 #define  UE_INTERRUPT	0x03
    242 #define UE_GET_XFERTYPE(a)	((a) & UE_XFERTYPE)
    243 #define UE_ISO_TYPE	0x0c
    244 #define  UE_ISO_ASYNC	0x04
    245 #define  UE_ISO_ADAPT	0x08
    246 #define  UE_ISO_SYNC	0x0c
    247 #define UE_GET_ISO_TYPE(a)	((a) & UE_ISO_TYPE)
    248 	uWord		wMaxPacketSize;
    249 	uByte		bInterval;
    250 } usb_endpoint_descriptor_t;
    251 #define USB_ENDPOINT_DESCRIPTOR_SIZE 7
    252 
    253 typedef struct {
    254 	uByte		bLength;
    255 	uByte		bDescriptorType;
    256 	uWord		bString[127];
    257 } usb_string_descriptor_t;
    258 #define USB_MAX_STRING_LEN 128
    259 #define USB_LANGUAGE_TABLE 0	/* # of the string language id table */
    260 
    261 /* Hub specific request */
    262 #define UR_GET_BUS_STATE	0x02
    263 
    264 /* Hub features */
    265 #define UHF_C_HUB_LOCAL_POWER	0
    266 #define UHF_C_HUB_OVER_CURRENT	1
    267 #define UHF_PORT_CONNECTION	0
    268 #define UHF_PORT_ENABLE		1
    269 #define UHF_PORT_SUSPEND	2
    270 #define UHF_PORT_OVER_CURRENT	3
    271 #define UHF_PORT_RESET		4
    272 #define UHF_PORT_POWER		8
    273 #define UHF_PORT_LOW_SPEED	9
    274 #define UHF_C_PORT_CONNECTION	16
    275 #define UHF_C_PORT_ENABLE	17
    276 #define UHF_C_PORT_SUSPEND	18
    277 #define UHF_C_PORT_OVER_CURRENT	19
    278 #define UHF_C_PORT_RESET	20
    279 
    280 typedef struct {
    281 	uByte		bDescLength;
    282 	uByte		bDescriptorType;
    283 	uByte		bNbrPorts;
    284 	uWord		wHubCharacteristics;
    285 #define UHD_PWR			0x03
    286 #define UHD_PWR_GANGED		0x00
    287 #define UHD_PWR_INDIVIDUAL	0x01
    288 #define UHD_PWR_NO_SWITCH	0x02
    289 #define UHD_COMPOUND		0x04
    290 #define UHD_OC			0x18
    291 #define UHD_OC_GLOBAL		0x00
    292 #define UHD_OC_INDIVIDUAL	0x08
    293 #define UHD_OC_NONE		0x10
    294 	uByte		bPwrOn2PwrGood;	/* delay in 2 ms units */
    295 #define UHD_PWRON_FACTOR 2
    296 	uByte		bHubContrCurrent;
    297 	uByte		DeviceRemovable[32]; /* max 255 ports */
    298 #define UHD_NOT_REMOV(desc, i) \
    299     (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1)
    300 	/* deprecated uByte		PortPowerCtrlMask[]; */
    301 } usb_hub_descriptor_t;
    302 #define USB_HUB_DESCRIPTOR_SIZE 8
    303 
    304 typedef struct {
    305 	uWord		wStatus;
    306 /* Device status flags */
    307 #define UDS_SELF_POWERED		0x0001
    308 #define UDS_REMOTE_WAKEUP		0x0002
    309 /* Endpoint status flags */
    310 #define UES_HALT			0x0001
    311 } usb_status_t;
    312 
    313 typedef struct {
    314 	uWord		wHubStatus;
    315 #define UHS_LOCAL_POWER			0x0001
    316 #define UHS_OVER_CURRENT		0x0002
    317 	uWord		wHubChange;
    318 } usb_hub_status_t;
    319 
    320 typedef struct {
    321 	uWord		wPortStatus;
    322 #define UPS_CURRENT_CONNECT_STATUS	0x0001
    323 #define UPS_PORT_ENABLED		0x0002
    324 #define UPS_SUSPEND			0x0004
    325 #define UPS_OVERCURRENT_INDICATOR	0x0008
    326 #define UPS_RESET			0x0010
    327 #define UPS_PORT_POWER			0x0100
    328 #define UPS_LOW_SPEED			0x0200
    329 	uWord		wPortChange;
    330 #define UPS_C_CONNECT_STATUS		0x0001
    331 #define UPS_C_PORT_ENABLED		0x0002
    332 #define UPS_C_SUSPEND			0x0004
    333 #define UPS_C_OVERCURRENT_INDICATOR	0x0008
    334 #define UPS_C_PORT_RESET		0x0010
    335 } usb_port_status_t;
    336 
    337 #define UCLASS_UNSPEC		0
    338 #define UCLASS_AUDIO		1
    339 #define  USUBCLASS_AUDIOCONTROL	1
    340 #define  USUBCLASS_AUDIOSTREAM	2
    341 #define  USUBCLASS_MIDISTREAM	3
    342 #define UCLASS_CDC		2 /* communication */
    343 #define	 USUBCLASS_DIRECT_LINE_CONTROL_MODEL	1
    344 #define  USUBCLASS_ABSTRACT_CONTROL_MODEL	2
    345 #define	 USUBCLASS_TELEPHONE_CONTROL_MODEL	3
    346 #define	 USUBCLASS_MULTICHANNEL_CONTROL_MODEL	4
    347 #define	 USUBCLASS_CAPI_CONTROLMODEL		5
    348 #define	 USUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6
    349 #define	 USUBCLASS_ATM_NETWORKING_CONTROL_MODEL	7
    350 #define   UPROTO_CDC_AT		1
    351 #define UCLASS_HID		3
    352 #define  USUBCLASS_BOOT	 	1
    353 #define UCLASS_PRINTER		7
    354 #define  USUBCLASS_PRINTER	1
    355 #define  UPROTO_PRINTER_UNI	1
    356 #define  UPROTO_PRINTER_BI	2
    357 #define UCLASS_MASS		8
    358 #define  USUBCLASS_RBC		1
    359 #define  USUBCLASS_SFF8020I	2
    360 #define  USUBCLASS_QIC157	3
    361 #define  USUBCLASS_UFI		4
    362 #define  USUBCLASS_SFF8070I	5
    363 #define  USUBCLASS_SCSI		6
    364 #define  UPROTO_MASS_CBI_I	0
    365 #define  UPROTO_MASS_CBI	1
    366 #define  UPROTO_MASS_BULK	2
    367 #define  UPROTO_MASS_BULK_P	80
    368 #define UCLASS_HUB		9
    369 #define  USUBCLASS_HUB		0
    370 #define UCLASS_DATA		10
    371 #define  USUBCLASS_DATA		0
    372 #define   UPROTO_DATA_ISDNBRI		0x30    /* Physical iface */
    373 #define   UPROTO_DATA_HDLC		0x31    /* HDLC */
    374 #define   UPROTO_DATA_TRANSPARENT	0x32    /* Transparent */
    375 #define   UPROTO_DATA_Q921M		0x50    /* Management for Q921 */
    376 #define   UPROTO_DATA_Q921		0x51    /* Data for Q921 */
    377 #define   UPROTO_DATA_Q921TM		0x52    /* TEI multiplexer for Q921 */
    378 #define   UPROTO_DATA_V42BIS		0x90    /* Data compression */
    379 #define   UPROTO_DATA_Q931		0x91    /* Euro-ISDN */
    380 #define   UPROTO_DATA_V120		0x92    /* V.24 rate adaption */
    381 #define   UPROTO_DATA_CAPI		0x93    /* CAPI 2.0 commands */
    382 #define   UPROTO_DATA_HOST_BASED	0xfd    /* Host based driver */
    383 #define   UPROTO_DATA_PUF		0xfe    /* see Prot. Unit Func. Desc.*/
    384 #define   UPROTO_DATA_VENDOR		0xff    /* Vendor specific */
    385 
    386 
    387 #define USB_HUB_MAX_DEPTH 5
    388 
    389 /*
    390  * Minimum time a device needs to be powered down to go through
    391  * a power cycle.  XXX Are these time in the spec?
    392  */
    393 #define USB_POWER_DOWN_TIME	200 /* ms */
    394 #define USB_PORT_POWER_DOWN_TIME	100 /* ms */
    395 
    396 #if 0
    397 /* These are the values from the spec. */
    398 #define USB_PORT_RESET_DELAY	10  /* ms */
    399 #define USB_PORT_RESET_SETTLE	10  /* ms */
    400 #define USB_PORT_POWERUP_DELAY	100 /* ms */
    401 #define USB_SET_ADDRESS_SETTLE	2   /* ms */
    402 #define USB_RESUME_TIME		(20*5)  /* ms */
    403 #define USB_RESUME_WAIT		10  /* ms */
    404 #define USB_RESUME_RECOVERY	10  /* ms */
    405 #else
    406 /* Allow for marginal (i.e. non-conforming) devices. */
    407 #define USB_PORT_RESET_DELAY	50  /* ms */
    408 #define USB_PORT_RESET_RECOVERY	50  /* ms */
    409 #define USB_PORT_POWERUP_DELAY	200 /* ms */
    410 #define USB_SET_ADDRESS_SETTLE	10  /* ms */
    411 #define USB_RESUME_DELAY	(50*5)  /* ms */
    412 #define USB_RESUME_WAIT		50  /* ms */
    413 #define USB_RESUME_RECOVERY	50  /* ms */
    414 #endif
    415 
    416 #define USB_MIN_POWER		100 /* mA */
    417 #define USB_MAX_POWER		500 /* mA */
    418 
    419 #define USB_BUS_RESET_DELAY	100 /* ms XXX?*/
    420 
    421 /*** ioctl() related stuff ***/
    422 
    423 struct usb_ctl_request {
    424 	int	addr;
    425 	usb_device_request_t request;
    426 	void	*data;
    427 	int	flags;
    428 #define USBD_SHORT_XFER_OK	0x04	/* allow short reads */
    429 	int	actlen;		/* actual length transferred */
    430 };
    431 
    432 struct usb_alt_interface {
    433 	int	config_index;
    434 	int	interface_index;
    435 	int	alt_no;
    436 };
    437 
    438 #define USB_CURRENT_CONFIG_INDEX (-1)
    439 #define USB_CURRENT_ALT_INDEX (-1)
    440 
    441 struct usb_config_desc {
    442 	int	config_index;
    443 	usb_config_descriptor_t desc;
    444 };
    445 
    446 struct usb_interface_desc {
    447 	int	config_index;
    448 	int	interface_index;
    449 	int	alt_index;
    450 	usb_interface_descriptor_t desc;
    451 };
    452 
    453 struct usb_endpoint_desc {
    454 	int	config_index;
    455 	int	interface_index;
    456 	int	alt_index;
    457 	int	endpoint_index;
    458 	usb_endpoint_descriptor_t desc;
    459 };
    460 
    461 struct usb_full_desc {
    462 	int	config_index;
    463 	u_int	size;
    464 	u_char	*data;
    465 };
    466 
    467 struct usb_string_desc {
    468 	int	string_index;
    469 	int	language_id;
    470 	usb_string_descriptor_t desc;
    471 };
    472 
    473 struct usb_ctl_report_desc {
    474 	int	size;
    475 	u_char	data[1024];	/* filled data size will vary */
    476 };
    477 
    478 struct usb_device_info {
    479 	u_int8_t	addr;	/* device address */
    480 	char		product[USB_MAX_STRING_LEN];
    481 	char		vendor[USB_MAX_STRING_LEN];
    482 	char		release[8];
    483 	u_int16_t	productNo;
    484 	u_int16_t	vendorNo;
    485 	u_int8_t	class;
    486 	u_int8_t	config;
    487 	u_int8_t	lowspeed;
    488 	int		power;	/* power consumption in mA, 0 if selfpowered */
    489 	int		nports;
    490 	u_int8_t	ports[16];/* hub only: addresses of devices on ports */
    491 #define USB_PORT_ENABLED 0xff
    492 #define USB_PORT_SUSPENDED 0xfe
    493 #define USB_PORT_POWERED 0xfd
    494 #define USB_PORT_DISABLED 0xfc
    495 };
    496 
    497 struct usb_ctl_report {
    498 	int	report;
    499 	u_char	data[1024];	/* filled data size will vary */
    500 };
    501 
    502 struct usb_device_stats {
    503 	u_long	requests[4];	/* indexed by transfer type UE_* */
    504 };
    505 
    506 typedef struct { u_int32_t cookie; } usb_event_cookie_t;
    507 /* Events that can be read from /dev/usb */
    508 struct usb_event {
    509 	int			ue_type;
    510 #define USB_EVENT_ATTACH 1
    511 #define USB_EVENT_DETACH 2
    512 	struct usb_device_info	ue_device;
    513 	struct timespec		ue_time;
    514 	usb_event_cookie_t	ue_cookie;
    515 };
    516 
    517 /* USB controller */
    518 #define USB_REQUEST		_IOWR('U', 1, struct usb_ctl_request)
    519 #define USB_SETDEBUG		_IOW ('U', 2, int)
    520 #define USB_DISCOVER		_IO  ('U', 3)
    521 #define USB_DEVICEINFO		_IOWR('U', 4, struct usb_device_info)
    522 #define USB_DEVICESTATS		_IOR ('U', 5, struct usb_device_stats)
    523 
    524 /* Generic HID device */
    525 #define USB_GET_REPORT_DESC	_IOR ('U', 21, struct usb_ctl_report_desc)
    526 #define USB_SET_IMMED		_IOW ('U', 22, int)
    527 #define USB_GET_REPORT		_IOWR('U', 23, struct usb_ctl_report)
    528 
    529 /* Generic USB device */
    530 #define USB_GET_CONFIG		_IOR ('U', 100, int)
    531 #define USB_SET_CONFIG		_IOW ('U', 101, int)
    532 #define USB_GET_ALTINTERFACE	_IOWR('U', 102, struct usb_alt_interface)
    533 #define USB_SET_ALTINTERFACE	_IOWR('U', 103, struct usb_alt_interface)
    534 #define USB_GET_NO_ALT		_IOWR('U', 104, struct usb_alt_interface)
    535 #define USB_GET_DEVICE_DESC	_IOR ('U', 105, usb_device_descriptor_t)
    536 #define USB_GET_CONFIG_DESC	_IOWR('U', 106, struct usb_config_desc)
    537 #define USB_GET_INTERFACE_DESC	_IOWR('U', 107, struct usb_interface_desc)
    538 #define USB_GET_ENDPOINT_DESC	_IOWR('U', 108, struct usb_endpoint_desc)
    539 #define USB_GET_FULL_DESC	_IOWR('U', 109, struct usb_full_desc)
    540 #define USB_GET_STRING_DESC	_IOWR('U', 110, struct usb_string_desc)
    541 #define USB_DO_REQUEST		_IOWR('U', 111, struct usb_ctl_request)
    542 #define USB_GET_DEVICEINFO	_IOR ('U', 112, struct usb_device_info)
    543 #define USB_SET_SHORT_XFER	_IOW ('U', 113, int)
    544 #define USB_SET_TIMEOUT		_IOW ('U', 114, int)
    545 
    546 /* Modem device */
    547 #define USB_GET_CM_OVER_DATA	_IOR ('U', 130, int)
    548 #define USB_SET_CM_OVER_DATA	_IOW ('U', 131, int)
    549 
    550 #endif /* _USB_H_ */
    551