1 /* $NetBSD: usbdi.h,v 1.64 2004/10/23 13:26:34 augustss Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/usbdi.h,v 1.59 2005/05/16 06:58:43 imp 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.
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 */
90 #define USBD_CALLBACK_LAST 0x10 /* restart xfer BEFORE making callback */
92 #define USBD_NO_TIMEOUT 0
93 #define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */
95 usbd_status usbd_open_pipe(usbd_interface_handle, u_int8_t,
96 u_int8_t, usbd_pipe_handle *);
97 usbd_status usbd_close_pipe(usbd_pipe_handle);
98 usbd_status usbd_transfer(usbd_xfer_handle);
99 usbd_xfer_handle usbd_alloc_xfer(usbd_device_handle);
100 usbd_status usbd_free_xfer(usbd_xfer_handle);
101 void usbd_setup_xfer(usbd_xfer_handle, usbd_pipe_handle,
102 usbd_private_handle, void *,
103 u_int32_t, u_int16_t, u_int32_t,
105 void usbd_setup_default_xfer(usbd_xfer_handle, usbd_device_handle,
106 usbd_private_handle, u_int32_t,
107 usb_device_request_t *, void *,
108 u_int32_t, u_int16_t, usbd_callback);
109 void usbd_setup_isoc_xfer(usbd_xfer_handle, usbd_pipe_handle,
110 usbd_private_handle, u_int16_t *,
111 u_int32_t, u_int16_t, usbd_callback);
112 void usbd_get_xfer_status(usbd_xfer_handle, usbd_private_handle *,
113 void **, u_int32_t *, usbd_status *);
114 usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor
115 (usbd_interface_handle, u_int8_t);
116 usbd_status usbd_abort_pipe(usbd_pipe_handle);
117 usbd_status usbd_abort_default_pipe(usbd_device_handle);
118 usbd_status usbd_clear_endpoint_stall(usbd_pipe_handle);
119 usbd_status usbd_clear_endpoint_stall_async(usbd_pipe_handle);
120 void usbd_clear_endpoint_toggle(usbd_pipe_handle);
121 usbd_status usbd_endpoint_count(usbd_interface_handle, u_int8_t *);
122 usbd_status usbd_interface_count(usbd_device_handle, u_int8_t *);
123 void usbd_interface2device_handle(usbd_interface_handle,
124 usbd_device_handle *);
125 usbd_status usbd_device2interface_handle(usbd_device_handle,
126 u_int8_t, usbd_interface_handle *);
128 usbd_device_handle usbd_pipe2device_handle(usbd_pipe_handle);
129 void *usbd_alloc_buffer(usbd_xfer_handle, u_int32_t);
130 void usbd_free_buffer(usbd_xfer_handle);
131 void *usbd_get_buffer(usbd_xfer_handle);
132 usbd_status usbd_sync_transfer(usbd_xfer_handle);
133 usbd_status usbd_open_pipe_intr(usbd_interface_handle, u_int8_t,
134 u_int8_t, usbd_pipe_handle *,
135 usbd_private_handle, void *,
136 u_int32_t, usbd_callback, int);
137 usbd_status usbd_do_request(usbd_device_handle, usb_device_request_t *, void *);
138 usbd_status usbd_do_request_async(usbd_device_handle,
139 usb_device_request_t *, void *);
140 usbd_status usbd_do_request_flags(usbd_device_handle, usb_device_request_t *,
141 void *, u_int16_t, int*, u_int32_t);
142 usbd_status usbd_do_request_flags_pipe(usbd_device_handle, usbd_pipe_handle,
143 usb_device_request_t *, void *, u_int16_t, int *, u_int32_t);
144 usb_interface_descriptor_t *usbd_get_interface_descriptor
145 (usbd_interface_handle);
146 usb_config_descriptor_t *usbd_get_config_descriptor(usbd_device_handle);
147 usb_device_descriptor_t *usbd_get_device_descriptor(usbd_device_handle);
148 int usbd_get_speed(usbd_device_handle);
149 usbd_status usbd_set_interface(usbd_interface_handle, int);
150 int usbd_get_no_alts(usb_config_descriptor_t *, int);
151 usbd_status usbd_get_interface(usbd_interface_handle, u_int8_t *);
152 void usbd_fill_deviceinfo(usbd_device_handle, struct usb_device_info *, int);
153 int usbd_get_interface_altindex(usbd_interface_handle);
155 usb_interface_descriptor_t *usbd_find_idesc(usb_config_descriptor_t *,
157 usb_endpoint_descriptor_t *usbd_find_edesc(usb_config_descriptor_t *,
160 void usbd_dopoll(usbd_interface_handle);
161 void usbd_set_polling(usbd_device_handle, int);
163 const char *usbd_errstr(usbd_status);
165 void usbd_add_dev_event(int, usbd_device_handle);
166 void usbd_add_drv_event(int, usbd_device_handle, device_t);
168 void usbd_devinfo(usbd_device_handle, int, char *);
169 const struct usbd_quirks *usbd_get_quirks(usbd_device_handle);
170 usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor
171 (usbd_interface_handle, u_int8_t);
173 usbd_status usbd_reload_device_desc(usbd_device_handle);
175 int usbd_ratecheck(struct timeval *last);
177 usbd_status usbd_get_string(usbd_device_handle dev, int si, char *buf);
179 /* An iterator for descriptors. */
184 void usb_desc_iter_init(usbd_device_handle dev, usbd_desc_iter_t *iter);
185 const usb_descriptor_t *usb_desc_iter_next(usbd_desc_iter_t *iter);
188 * The usb_task structs form a queue of things to run in the USB event
189 * thread. Normally this is just device discovery when a connect/disconnect
190 * has been detected. But it may also be used by drivers that need to
191 * perform (short) tasks that must have a process context.
194 TAILQ_ENTRY(usb_task) next;
199 #define USB_TASKQ_HC 0
200 #define USB_TASKQ_DRIVER 1
201 #define USB_NUM_TASKQS 2
202 #define USB_TASKQ_NAMES {"usbtask-hc", "usbtask-dr"}
205 struct usbd_bus *usb_getbushandle(struct usb_softc *sc);
207 void usb_do_task(usbd_device_handle, struct usb_task *, int, int);
208 void usb_add_task(usbd_device_handle, struct usb_task *, int);
209 void usb_rem_task(usbd_device_handle, struct usb_task *);
210 #define usb_init_task(t, f, a) ((t)->fun = (f), (t)->arg = (a), (t)->queue = -1)
214 u_int16_t ud_product;
216 #define USB_DEVICE(vid, pid) \
217 .ud_vendor = (vid), .ud_product = (pid)
218 const struct usb_devno *usb_match_device(const struct usb_devno *,
219 u_int, u_int, u_int16_t, u_int16_t);
220 #define usb_lookup(tbl, vendor, product) \
221 usb_match_device((const struct usb_devno *)(tbl), sizeof (tbl) / sizeof ((tbl)[0]), sizeof ((tbl)[0]), (vendor), (product))
222 #define USB_PRODUCT_ANY 0xffff
224 /* NetBSD attachment information */
227 struct usb_attach_arg {
235 usbd_device_handle device; /* current device */
236 usbd_interface_handle iface; /* current interface */
238 usbd_interface_handle *ifaces; /* all interfaces */
239 int nifaces; /* number of interfaces */
242 /* FreeBSD needs values less than zero */
243 #define UMATCH_VENDOR_PRODUCT_REV (-10)
244 #define UMATCH_VENDOR_PRODUCT (-20)
245 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO (-30)
246 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO (-40)
247 #define UMATCH_DEVCLASS_DEVSUBCLASS (-50)
248 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE (-60)
249 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE (-70)
250 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO (-80)
251 #define UMATCH_VENDOR_IFACESUBCLASS (-90)
252 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO (-100)
253 #define UMATCH_IFACECLASS_IFACESUBCLASS (-110)
254 #define UMATCH_IFACECLASS (-120)
255 #define UMATCH_IFACECLASS_GENERIC (-130)
256 #define UMATCH_GENERIC (-140)
257 #define UMATCH_NONE (ENXIO)
259 #define USBD_SHOW_DEVICE_CLASS 0x1
260 #define USBD_SHOW_INTERFACE_CLASS 0x2
262 int usbd_driver_load(module_t mod, int what, void *arg);
265 usb_get_port(device_t dev)
267 struct usb_attach_arg *uap = device_get_ivars(dev);
271 static __inline struct usbd_interface *
272 usb_get_iface(device_t dev)
274 struct usb_attach_arg *uap = device_get_ivars(dev);
278 #define IPL_USB IPL_BIO
280 #endif /* _USBDI_H_ */