2 * $NetBSD: usbdi.h,v 1.62 2002/07/11 21:14:35 augustss Exp $
3 * $FreeBSD: src/sys/dev/usb/usbdi.h,v 1.48 2003/07/14 20:31:03 joe Exp $
4 * $DragonFly: src/sys/bus/usb/usbdi.h,v 1.4 2004/02/11 15:17:26 joerg Exp $
8 * Copyright (c) 1998 The NetBSD Foundation, Inc.
11 * This code is derived from software contributed to The NetBSD Foundation
12 * by Lennart Augustsson (lennart@augustsson.net) at
13 * Carlstedt Research & Technology.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 * 3. All advertising materials mentioning features or use of this software
24 * must display the following acknowledgement:
25 * This product includes software developed by the NetBSD
26 * Foundation, Inc. and its contributors.
27 * 4. Neither the name of The NetBSD Foundation nor the names of its
28 * contributors may be used to endorse or promote products derived
29 * from this software without specific prior written permission.
31 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
32 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
33 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
34 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
35 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
39 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGE.
44 typedef struct usbd_bus *usbd_bus_handle;
45 typedef struct usbd_device *usbd_device_handle;
46 typedef struct usbd_interface *usbd_interface_handle;
47 typedef struct usbd_pipe *usbd_pipe_handle;
48 typedef struct usbd_xfer *usbd_xfer_handle;
49 typedef void *usbd_private_handle;
51 typedef enum { /* keep in sync with usbd_status_msgs */
52 USBD_NORMAL_COMPLETION = 0, /* must be 0 */
53 USBD_IN_PROGRESS, /* 1 */
55 USBD_PENDING_REQUESTS, /* 2 */
56 USBD_NOT_STARTED, /* 3 */
59 USBD_CANCELLED, /* 6 */
60 USBD_BAD_ADDRESS, /* 7 */
63 USBD_SET_ADDR_FAILED, /* 10 */
64 USBD_NO_POWER, /* 11 */
65 USBD_TOO_DEEP, /* 12 */
66 USBD_IOERROR, /* 13 */
67 USBD_NOT_CONFIGURED, /* 14 */
68 USBD_TIMEOUT, /* 15 */
69 USBD_SHORT_XFER, /* 16 */
70 USBD_STALLED, /* 17 */
71 USBD_INTERRUPTED, /* 18 */
73 USBD_ERROR_MAX /* must be last */
76 typedef void (*usbd_callback)(usbd_xfer_handle, usbd_private_handle,
80 #define USBD_EXCLUSIVE_USE 0x01
82 /* Use default (specified by ep. desc.) interval on interrupt pipe */
83 #define USBD_DEFAULT_INTERVAL (-1)
86 #define USBD_NO_COPY 0x01 /* do not copy data to DMA buffer */
87 #define USBD_SYNCHRONOUS 0x02 /* wait for completion */
88 /* in usb.h #define USBD_SHORT_XFER_OK 0x04*/ /* allow short reads */
89 #define USBD_FORCE_SHORT_XFER 0x08 /* force last short packet on write */
91 #define USBD_NO_TIMEOUT 0
92 #define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */
94 #if defined(__FreeBSD__) || defined(__DragonFly__)
95 #define USB_CDEV_MAJOR 108
98 usbd_status usbd_open_pipe(usbd_interface_handle iface, u_int8_t address,
99 u_int8_t flags, usbd_pipe_handle *pipe);
100 usbd_status usbd_close_pipe(usbd_pipe_handle pipe);
101 usbd_status usbd_transfer(usbd_xfer_handle req);
102 usbd_xfer_handle usbd_alloc_xfer(usbd_device_handle);
103 usbd_status usbd_free_xfer(usbd_xfer_handle xfer);
104 void usbd_setup_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
105 usbd_private_handle priv, void *buffer,
106 u_int32_t length, u_int16_t flags, u_int32_t timeout,
108 void usbd_setup_default_xfer(usbd_xfer_handle xfer, usbd_device_handle dev,
109 usbd_private_handle priv, u_int32_t timeout,
110 usb_device_request_t *req, void *buffer,
111 u_int32_t length, u_int16_t flags, usbd_callback);
112 void usbd_setup_isoc_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
113 usbd_private_handle priv, u_int16_t *frlengths,
114 u_int32_t nframes, u_int16_t flags, usbd_callback);
115 void usbd_get_xfer_status(usbd_xfer_handle xfer, usbd_private_handle *priv,
116 void **buffer, u_int32_t *count, usbd_status *status);
117 usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor
118 (usbd_interface_handle iface, u_int8_t address);
119 usbd_status usbd_abort_pipe(usbd_pipe_handle pipe);
120 usbd_status usbd_clear_endpoint_stall(usbd_pipe_handle pipe);
121 usbd_status usbd_clear_endpoint_stall_async(usbd_pipe_handle pipe);
122 void usbd_clear_endpoint_toggle(usbd_pipe_handle pipe);
123 usbd_status usbd_endpoint_count(usbd_interface_handle dev, u_int8_t *count);
124 usbd_status usbd_interface_count(usbd_device_handle dev, u_int8_t *count);
125 void usbd_interface2device_handle(usbd_interface_handle iface,
126 usbd_device_handle *dev);
127 usbd_status usbd_device2interface_handle(usbd_device_handle dev,
128 u_int8_t ifaceno, usbd_interface_handle *iface);
130 usbd_device_handle usbd_pipe2device_handle(usbd_pipe_handle);
131 void *usbd_alloc_buffer(usbd_xfer_handle xfer, u_int32_t size);
132 void usbd_free_buffer(usbd_xfer_handle xfer);
133 void *usbd_get_buffer(usbd_xfer_handle xfer);
134 usbd_status usbd_sync_transfer(usbd_xfer_handle req);
135 usbd_status usbd_open_pipe_intr(usbd_interface_handle iface, u_int8_t address,
136 u_int8_t flags, usbd_pipe_handle *pipe,
137 usbd_private_handle priv, void *buffer,
138 u_int32_t length, usbd_callback, int);
139 usbd_status usbd_do_request(usbd_device_handle pipe, usb_device_request_t *req,
141 usbd_status usbd_do_request_async(usbd_device_handle pipe,
142 usb_device_request_t *req, void *data);
143 usbd_status usbd_do_request_flags(usbd_device_handle pipe,
144 usb_device_request_t *req,
145 void *data, u_int16_t flags, int*, u_int32_t);
146 usbd_status usbd_do_request_flags_pipe(
147 usbd_device_handle dev, usbd_pipe_handle pipe,
148 usb_device_request_t *req, void *data, u_int16_t flags, int *actlen,
150 usb_interface_descriptor_t *usbd_get_interface_descriptor
151 (usbd_interface_handle iface);
152 usb_config_descriptor_t *usbd_get_config_descriptor(usbd_device_handle dev);
153 usb_device_descriptor_t *usbd_get_device_descriptor(usbd_device_handle dev);
154 usbd_status usbd_set_interface(usbd_interface_handle, int);
155 int usbd_get_no_alts(usb_config_descriptor_t *, int);
156 usbd_status usbd_get_interface(usbd_interface_handle iface, u_int8_t *aiface);
157 void usbd_fill_deviceinfo(usbd_device_handle, struct usb_device_info *, int);
158 int usbd_get_interface_altindex(usbd_interface_handle iface);
160 usb_interface_descriptor_t *usbd_find_idesc(usb_config_descriptor_t *cd,
161 int iindex, int ano);
162 usb_endpoint_descriptor_t *usbd_find_edesc(usb_config_descriptor_t *cd,
163 int ifaceidx, int altidx,
166 void usbd_dopoll(usbd_interface_handle);
167 void usbd_set_polling(usbd_device_handle dev, int on);
169 const char *usbd_errstr(usbd_status err);
171 void usbd_add_dev_event(int, usbd_device_handle);
172 void usbd_add_drv_event(int, usbd_device_handle, device_ptr_t);
174 void usbd_devinfo(usbd_device_handle, int, char *);
175 const struct usbd_quirks *usbd_get_quirks(usbd_device_handle);
176 usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor
177 (usbd_interface_handle iface, u_int8_t address);
179 usbd_status usbd_reload_device_desc(usbd_device_handle);
181 int usbd_ratecheck(struct timeval *last);
184 * The usb_task structs form a queue of things to run in the USB event
185 * thread. Normally this is just device discovery when a connect/disconnect
186 * has been detected. But it may also be used by drivers that need to
187 * perform (short) tasks that must have a process context.
190 TAILQ_ENTRY(usb_task) next;
196 void usb_add_task(usbd_device_handle dev, struct usb_task *task);
197 void usb_rem_task(usbd_device_handle dev, struct usb_task *task);
198 #define usb_init_task(t, f, a) ((t)->fun = (f), (t)->arg = (a), (t)->onqueue = 0)
202 u_int16_t ud_product;
204 const struct usb_devno *usb_match_device(const struct usb_devno *tbl,
205 u_int nentries, u_int sz, u_int16_t vendor, u_int16_t product);
206 #define usb_lookup(tbl, vendor, product) \
207 usb_match_device((const struct usb_devno *)(tbl), sizeof (tbl) / sizeof ((tbl)[0]), sizeof ((tbl)[0]), (vendor), (product))
208 #define USB_PRODUCT_ANY 0xffff
210 /* NetBSD attachment information */
213 struct usb_attach_arg {
221 usbd_device_handle device; /* current device */
222 usbd_interface_handle iface; /* current interface */
224 usbd_interface_handle *ifaces; /* all interfaces */
225 int nifaces; /* number of interfaces */
228 #if defined(__NetBSD__) || defined(__OpenBSD__)
230 /* First five codes is for a whole device. */
231 #define UMATCH_VENDOR_PRODUCT_REV 14
232 #define UMATCH_VENDOR_PRODUCT 13
233 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO 12
234 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO 11
235 #define UMATCH_DEVCLASS_DEVSUBCLASS 10
236 /* Next six codes are for interfaces. */
237 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE 9
238 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE 8
239 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO 7
240 #define UMATCH_VENDOR_IFACESUBCLASS 6
241 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO 5
242 #define UMATCH_IFACECLASS_IFACESUBCLASS 4
243 #define UMATCH_IFACECLASS 3
244 #define UMATCH_IFACECLASS_GENERIC 2
246 #define UMATCH_GENERIC 1
248 #define UMATCH_NONE 0
250 #elif defined(__FreeBSD__) || defined(__DragonFly__)
251 /* FreeBSD needs values less than zero */
252 #define UMATCH_VENDOR_PRODUCT_REV (-10)
253 #define UMATCH_VENDOR_PRODUCT (-20)
254 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO (-30)
255 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO (-40)
256 #define UMATCH_DEVCLASS_DEVSUBCLASS (-50)
257 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE (-60)
258 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE (-70)
259 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO (-80)
260 #define UMATCH_VENDOR_IFACESUBCLASS (-90)
261 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO (-100)
262 #define UMATCH_IFACECLASS_IFACESUBCLASS (-110)
263 #define UMATCH_IFACECLASS (-120)
264 #define UMATCH_IFACECLASS_GENERIC (-130)
265 #define UMATCH_GENERIC (-140)
266 #define UMATCH_NONE (ENXIO)
270 #if defined(__FreeBSD__) || defined(__DragonFly__)
271 int usbd_driver_load(module_t mod, int what, void *arg);
274 /* XXX Perhaps USB should have its own levels? */
275 #ifdef USB_USE_SOFTINTR
276 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
277 #define splusb splsoftnet
279 #define splusb splsoftclock
280 #endif /* __HAVE_GENERIC_SOFT_INTERRUPTS */
282 #define splusb splbio
283 #endif /* USB_USE_SOFTINTR */
284 #define splhardusb splbio
285 #define IPL_USB IPL_BIO