Home | History | Annotate | Line # | Download | only in usb
usbdi.h revision 1.90
      1 /*	$NetBSD: usbdi.h,v 1.89 2013/09/26 07:25:31 skrll Exp $	*/
      2 /*	$FreeBSD: src/sys/dev/usb/usbdi.h,v 1.18 1999/11/17 22:33:49 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  *
     21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     31  * POSSIBILITY OF SUCH DAMAGE.
     32  */
     33 
     34 #ifndef _USBDI_H_
     35 #define _USBDI_H_
     36 
     37 typedef struct usbd_bus		*usbd_bus_handle;
     38 typedef struct usbd_device	*usbd_device_handle;
     39 typedef struct usbd_interface	*usbd_interface_handle;
     40 typedef struct usbd_pipe	*usbd_pipe_handle;
     41 typedef struct usbd_xfer	*usbd_xfer_handle;
     42 typedef void			*usbd_private_handle;
     43 
     44 typedef enum {		/* keep in sync with usbd_error_strs */
     45 	USBD_NORMAL_COMPLETION = 0, /* must be 0 */
     46 	USBD_IN_PROGRESS,	/* 1 */
     47 	/* errors */
     48 	USBD_PENDING_REQUESTS,	/* 2 */
     49 	USBD_NOT_STARTED,	/* 3 */
     50 	USBD_INVAL,		/* 4 */
     51 	USBD_NOMEM,		/* 5 */
     52 	USBD_CANCELLED,		/* 6 */
     53 	USBD_BAD_ADDRESS,	/* 7 */
     54 	USBD_IN_USE,		/* 8 */
     55 	USBD_NO_ADDR,		/* 9 */
     56 	USBD_SET_ADDR_FAILED,	/* 10 */
     57 	USBD_NO_POWER,		/* 11 */
     58 	USBD_TOO_DEEP,		/* 12 */
     59 	USBD_IOERROR,		/* 13 */
     60 	USBD_NOT_CONFIGURED,	/* 14 */
     61 	USBD_TIMEOUT,		/* 15 */
     62 	USBD_SHORT_XFER,	/* 16 */
     63 	USBD_STALLED,		/* 17 */
     64 	USBD_INTERRUPTED,	/* 18 */
     65 
     66 	USBD_ERROR_MAX		/* must be last */
     67 } usbd_status;
     68 
     69 typedef void (*usbd_callback)(usbd_xfer_handle, usbd_private_handle,
     70 			      usbd_status);
     71 
     72 /* Open flags */
     73 #define USBD_EXCLUSIVE_USE	0x01
     74 #define USBD_MPSAFE		0x80
     75 
     76 /* Use default (specified by ep. desc.) interval on interrupt pipe */
     77 #define USBD_DEFAULT_INTERVAL	(-1)
     78 
     79 /* Request flags */
     80 #define USBD_NO_COPY		0x01	/* do not copy data to DMA buffer */
     81 #define USBD_SYNCHRONOUS	0x02	/* wait for completion */
     82 /* in usb.h #define USBD_SHORT_XFER_OK	0x04*/	/* allow short reads */
     83 #define USBD_FORCE_SHORT_XFER	0x08	/* force last short packet on write */
     84 #define USBD_SYNCHRONOUS_SIG	0x10	/* if waiting for completion,
     85 					 * also take signals */
     86 
     87 #define USBD_NO_TIMEOUT 0
     88 #define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */
     89 #define	USBD_CONFIG_TIMEOUT  (3*USBD_DEFAULT_TIMEOUT)
     90 
     91 #define DEVINFOSIZE 1024
     92 
     93 usbd_status usbd_open_pipe(usbd_interface_handle, u_int8_t,
     94 			   u_int8_t, usbd_pipe_handle *);
     95 usbd_status usbd_close_pipe(usbd_pipe_handle);
     96 usbd_status usbd_transfer(usbd_xfer_handle);
     97 usbd_xfer_handle usbd_alloc_xfer(usbd_device_handle);
     98 usbd_status usbd_free_xfer(usbd_xfer_handle);
     99 void usbd_setup_xfer(usbd_xfer_handle, usbd_pipe_handle,
    100 		     usbd_private_handle, void *,
    101 		     u_int32_t, u_int16_t, u_int32_t,
    102 		     usbd_callback);
    103 void usbd_setup_default_xfer(usbd_xfer_handle, usbd_device_handle,
    104 			     usbd_private_handle, u_int32_t,
    105 			     usb_device_request_t *, void *,
    106 			     u_int32_t, u_int16_t, usbd_callback);
    107 void usbd_setup_isoc_xfer(usbd_xfer_handle, usbd_pipe_handle,
    108 			  usbd_private_handle, u_int16_t *,
    109 			  u_int32_t, u_int16_t, usbd_callback);
    110 void usbd_get_xfer_status(usbd_xfer_handle, usbd_private_handle *,
    111 			  void **, u_int32_t *, usbd_status *);
    112 usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor
    113 			(usbd_interface_handle, u_int8_t);
    114 usbd_status usbd_abort_pipe(usbd_pipe_handle);
    115 usbd_status usbd_abort_default_pipe(usbd_device_handle);
    116 usbd_status usbd_clear_endpoint_stall(usbd_pipe_handle);
    117 void usbd_clear_endpoint_stall_async(usbd_pipe_handle);
    118 void usbd_clear_endpoint_toggle(usbd_pipe_handle);
    119 usbd_status usbd_endpoint_count(usbd_interface_handle, u_int8_t *);
    120 usbd_status usbd_interface_count(usbd_device_handle, u_int8_t *);
    121 void usbd_interface2device_handle(usbd_interface_handle,
    122 				  usbd_device_handle *);
    123 usbd_status usbd_device2interface_handle(usbd_device_handle,
    124 			      u_int8_t, usbd_interface_handle *);
    125 
    126 usbd_device_handle usbd_pipe2device_handle(usbd_pipe_handle);
    127 void *usbd_alloc_buffer(usbd_xfer_handle, u_int32_t);
    128 void usbd_free_buffer(usbd_xfer_handle);
    129 void *usbd_get_buffer(usbd_xfer_handle);
    130 usbd_status usbd_sync_transfer(usbd_xfer_handle);
    131 usbd_status usbd_sync_transfer_sig(usbd_xfer_handle);
    132 usbd_status usbd_open_pipe_intr(usbd_interface_handle, u_int8_t,
    133 				u_int8_t, usbd_pipe_handle *,
    134 				usbd_private_handle, void *,
    135 				u_int32_t, usbd_callback, int);
    136 usbd_status usbd_do_request(usbd_device_handle, usb_device_request_t *, void *);
    137 usbd_status usbd_do_request_async(usbd_device_handle,
    138 				  usb_device_request_t *, void *);
    139 usbd_status usbd_do_request_flags(usbd_device_handle, usb_device_request_t *,
    140 				  void *, u_int16_t, int*, u_int32_t);
    141 usbd_status usbd_do_request_flags_pipe(usbd_device_handle, usbd_pipe_handle,
    142 	usb_device_request_t *, void *, u_int16_t, int *, u_int32_t);
    143 usb_interface_descriptor_t *usbd_get_interface_descriptor
    144 				(usbd_interface_handle);
    145 usb_config_descriptor_t *usbd_get_config_descriptor(usbd_device_handle);
    146 usb_device_descriptor_t *usbd_get_device_descriptor(usbd_device_handle);
    147 usbd_status usbd_set_interface(usbd_interface_handle, int);
    148 int usbd_get_no_alts(usb_config_descriptor_t *, int);
    149 usbd_status  usbd_get_interface(usbd_interface_handle, u_int8_t *);
    150 void usbd_fill_deviceinfo(usbd_device_handle, struct usb_device_info *, int);
    151 #ifdef COMPAT_30
    152 void usbd_fill_deviceinfo_old(usbd_device_handle, struct usb_device_info_old *,
    153     int);
    154 #endif
    155 int usbd_get_interface_altindex(usbd_interface_handle);
    156 
    157 usb_interface_descriptor_t *usbd_find_idesc(usb_config_descriptor_t *,
    158 					    int, int);
    159 usb_endpoint_descriptor_t *usbd_find_edesc(usb_config_descriptor_t *,
    160 					   int, int, int);
    161 
    162 void usbd_dopoll(usbd_interface_handle);
    163 void usbd_set_polling(usbd_device_handle, int);
    164 
    165 const char *usbd_errstr(usbd_status);
    166 
    167 void usbd_add_dev_event(int, usbd_device_handle);
    168 void usbd_add_drv_event(int, usbd_device_handle, device_t);
    169 
    170 char *usbd_devinfo_alloc(usbd_device_handle, int);
    171 void usbd_devinfo_free(char *);
    172 
    173 const struct usbd_quirks *usbd_get_quirks(usbd_device_handle);
    174 usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor
    175 			(usbd_interface_handle, u_int8_t);
    176 
    177 usbd_status usbd_reload_device_desc(usbd_device_handle);
    178 
    179 int usbd_ratecheck(struct timeval *);
    180 
    181 usbd_status usbd_get_string(usbd_device_handle, int, char *);
    182 usbd_status usbd_get_string0(usbd_device_handle, int, char *, int);
    183 
    184 /* An iterator for descriptors. */
    185 typedef struct {
    186 	const uByte *cur;
    187 	const uByte *end;
    188 } usbd_desc_iter_t;
    189 void usb_desc_iter_init(usbd_device_handle, usbd_desc_iter_t *);
    190 const usb_descriptor_t *usb_desc_iter_next(usbd_desc_iter_t *);
    191 
    192 /* Used to clear endpoint stalls from the softint */
    193 void usbd_clear_endpoint_stall_task(void *);
    194 
    195 /*
    196  * The usb_task structs form a queue of things to run in the USB event
    197  * thread.  Normally this is just device discovery when a connect/disconnect
    198  * has been detected.  But it may also be used by drivers that need to
    199  * perform (short) tasks that must have a process context.
    200  */
    201 struct usb_task {
    202 	TAILQ_ENTRY(usb_task) next;
    203 	void (*fun)(void *);
    204 	void *arg;
    205 	volatile unsigned queue;
    206 	int flags;
    207 };
    208 #define	USB_TASKQ_HC		0
    209 #define	USB_TASKQ_DRIVER	1
    210 #define	USB_NUM_TASKQS		2
    211 #define	USB_TASKQ_NAMES		{"usbtask-hc", "usbtask-dr"}
    212 #define	USB_TASKQ_MPSAFE	0x80
    213 
    214 void usb_add_task(usbd_device_handle, struct usb_task *, int);
    215 void usb_rem_task(usbd_device_handle, struct usb_task *);
    216 #define usb_init_task(t, f, a, fl) ((t)->fun = (f), (t)->arg = (a), (t)->queue = USB_NUM_TASKQS, (t)->flags = (fl))
    217 
    218 struct usb_devno {
    219 	u_int16_t ud_vendor;
    220 	u_int16_t ud_product;
    221 };
    222 const struct usb_devno *usb_match_device(const struct usb_devno *,
    223 	u_int, u_int, u_int16_t, u_int16_t);
    224 #define usb_lookup(tbl, vendor, product) \
    225 	usb_match_device((const struct usb_devno *)(tbl), sizeof (tbl) / sizeof ((tbl)[0]), sizeof ((tbl)[0]), (vendor), (product))
    226 #define	USB_PRODUCT_ANY		0xffff
    227 
    228 /* NetBSD attachment information */
    229 
    230 /* Attach data */
    231 struct usb_attach_arg {
    232 	int			port;
    233 	int			vendor;
    234 	int			product;
    235 	int			release;
    236 	usbd_device_handle	device;	/* current device */
    237 	int			class, subclass, proto;
    238 	int			usegeneric;
    239 };
    240 
    241 struct usbif_attach_arg {
    242 	int			port;
    243 	int			configno;
    244 	int			ifaceno;
    245 	int			vendor;
    246 	int			product;
    247 	int			release;
    248 	usbd_device_handle	device;	/* current device */
    249 
    250 	usbd_interface_handle	iface; /* current interface */
    251 	int			class, subclass, proto;
    252 
    253 	/* XXX need accounting for interfaces not matched to */
    254 
    255 	usbd_interface_handle  *ifaces;	/* all interfaces */
    256 	int			nifaces; /* number of interfaces */
    257 };
    258 
    259 /* Match codes. */
    260 #define UMATCH_HIGHEST					15
    261 /* First five codes is for a whole device. */
    262 #define UMATCH_VENDOR_PRODUCT_REV			14
    263 #define UMATCH_VENDOR_PRODUCT				13
    264 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO			12
    265 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO		11
    266 #define UMATCH_DEVCLASS_DEVSUBCLASS			10
    267 /* Next six codes are for interfaces. */
    268 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE		 9
    269 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE		 8
    270 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO		 7
    271 #define UMATCH_VENDOR_IFACESUBCLASS			 6
    272 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO	 5
    273 #define UMATCH_IFACECLASS_IFACESUBCLASS			 4
    274 #define UMATCH_IFACECLASS				 3
    275 #define UMATCH_IFACECLASS_GENERIC			 2
    276 /* Generic driver */
    277 #define UMATCH_GENERIC					 1
    278 /* No match */
    279 #define UMATCH_NONE					 0
    280 
    281 
    282 /*
    283  * IPL_USB is defined as IPL_VM for drivers that have not been made MP safe.
    284  * IPL_VM (currently) takes the kernel lock.
    285  *
    286  * Eventually, IPL_USB can/should be changed
    287  */
    288 #define splusb splsoftnet
    289 #define splhardusb splvm
    290 #define IPL_SOFTUSB IPL_SOFTNET
    291 #define IPL_USB IPL_VM
    292 
    293 #endif /* _USBDI_H_ */
    294