MFC rev 1.11 and 1.12:
[dragonfly.git] / sys / bus / usb / usbdi.h
blob8a2ff5d235b2a8af6270d47a383a0f2867982d5d
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 $ */
3 /* $DragonFly: src/sys/bus/usb/usbdi.h,v 1.10 2007/11/05 13:32:27 hasso Exp $ */
5 /*
6 * Copyright (c) 1998 The NetBSD Foundation, Inc.
7 * All rights reserved.
9 * This code is derived from software contributed to The NetBSD Foundation
10 * by Lennart Augustsson (lennart@augustsson.net) at
11 * Carlstedt Research & Technology.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. All advertising materials mentioning features or use of this software
22 * must display the following acknowledgement:
23 * This product includes software developed by the NetBSD
24 * Foundation, Inc. and its contributors.
25 * 4. Neither the name of The NetBSD Foundation nor the names of its
26 * contributors may be used to endorse or promote products derived
27 * from this software without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
30 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
31 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
32 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
33 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
34 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
35 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
36 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
37 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39 * POSSIBILITY OF SUCH DAMAGE.
42 #ifndef _USBDI_H_
43 #define _USBDI_H_
45 typedef struct usbd_bus *usbd_bus_handle;
46 typedef struct usbd_device *usbd_device_handle;
47 typedef struct usbd_interface *usbd_interface_handle;
48 typedef struct usbd_pipe *usbd_pipe_handle;
49 typedef struct usbd_xfer *usbd_xfer_handle;
50 typedef void *usbd_private_handle;
52 typedef enum { /* keep in sync with usbd_status_msgs */
53 USBD_NORMAL_COMPLETION = 0, /* must be 0 */
54 USBD_IN_PROGRESS, /* 1 */
55 /* errors */
56 USBD_PENDING_REQUESTS, /* 2 */
57 USBD_NOT_STARTED, /* 3 */
58 USBD_INVAL, /* 4 */
59 USBD_NOMEM, /* 5 */
60 USBD_CANCELLED, /* 6 */
61 USBD_BAD_ADDRESS, /* 7 */
62 USBD_IN_USE, /* 8 */
63 USBD_NO_ADDR, /* 9 */
64 USBD_SET_ADDR_FAILED, /* 10 */
65 USBD_NO_POWER, /* 11 */
66 USBD_TOO_DEEP, /* 12 */
67 USBD_IOERROR, /* 13 */
68 USBD_NOT_CONFIGURED, /* 14 */
69 USBD_TIMEOUT, /* 15 */
70 USBD_SHORT_XFER, /* 16 */
71 USBD_STALLED, /* 17 */
72 USBD_INTERRUPTED, /* 18 */
74 USBD_ERROR_MAX /* must be last */
75 } usbd_status;
77 typedef void (*usbd_callback)(usbd_xfer_handle, usbd_private_handle,
78 usbd_status);
80 /* Open flags */
81 #define USBD_EXCLUSIVE_USE 0x01
83 /* Use default (specified by ep. desc.) interval on interrupt pipe */
84 #define USBD_DEFAULT_INTERVAL (-1)
86 /* Request flags */
87 #define USBD_NO_COPY 0x01 /* do not copy data to DMA buffer */
88 #define USBD_SYNCHRONOUS 0x02 /* wait for completion */
89 /* in usb.h #define USBD_SHORT_XFER_OK 0x04*/ /* allow short reads */
90 #define USBD_FORCE_SHORT_XFER 0x08 /* force last short packet on write */
92 #define USBD_NO_TIMEOUT 0
93 #define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */
95 #define USB_CDEV_MAJOR 108
97 usbd_status usbd_open_pipe(usbd_interface_handle, u_int8_t,
98 u_int8_t, usbd_pipe_handle *);
99 usbd_status usbd_close_pipe(usbd_pipe_handle);
100 usbd_status usbd_transfer(usbd_xfer_handle);
101 usbd_xfer_handle usbd_alloc_xfer(usbd_device_handle);
102 usbd_status usbd_free_xfer(usbd_xfer_handle);
103 void usbd_setup_xfer(usbd_xfer_handle, usbd_pipe_handle,
104 usbd_private_handle, void *,
105 u_int32_t, u_int16_t, u_int32_t,
106 usbd_callback);
107 void usbd_setup_default_xfer(usbd_xfer_handle, usbd_device_handle,
108 usbd_private_handle, u_int32_t,
109 usb_device_request_t *, void *,
110 u_int32_t, u_int16_t, usbd_callback);
111 void usbd_setup_isoc_xfer(usbd_xfer_handle, usbd_pipe_handle,
112 usbd_private_handle, u_int16_t *,
113 u_int32_t, u_int16_t, usbd_callback);
114 void usbd_get_xfer_status(usbd_xfer_handle, usbd_private_handle *,
115 void **, u_int32_t *, usbd_status *);
116 usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor
117 (usbd_interface_handle, u_int8_t);
118 usbd_status usbd_abort_pipe(usbd_pipe_handle);
119 usbd_status usbd_abort_default_pipe(usbd_device_handle);
120 usbd_status usbd_clear_endpoint_stall(usbd_pipe_handle);
121 usbd_status usbd_clear_endpoint_stall_async(usbd_pipe_handle);
122 void usbd_clear_endpoint_toggle(usbd_pipe_handle);
123 usbd_status usbd_endpoint_count(usbd_interface_handle, u_int8_t *);
124 usbd_status usbd_interface_count(usbd_device_handle, u_int8_t *);
125 void usbd_interface2device_handle(usbd_interface_handle,
126 usbd_device_handle *);
127 usbd_status usbd_device2interface_handle(usbd_device_handle,
128 u_int8_t, usbd_interface_handle *);
130 usbd_device_handle usbd_pipe2device_handle(usbd_pipe_handle);
131 void *usbd_alloc_buffer(usbd_xfer_handle, u_int32_t);
132 void usbd_free_buffer(usbd_xfer_handle);
133 void *usbd_get_buffer(usbd_xfer_handle);
134 usbd_status usbd_sync_transfer(usbd_xfer_handle);
135 usbd_status usbd_open_pipe_intr(usbd_interface_handle, u_int8_t,
136 u_int8_t, usbd_pipe_handle *,
137 usbd_private_handle, void *,
138 u_int32_t, usbd_callback, int);
139 usbd_status usbd_do_request(usbd_device_handle, usb_device_request_t *, void *);
140 usbd_status usbd_do_request_async(usbd_device_handle,
141 usb_device_request_t *, void *);
142 usbd_status usbd_do_request_flags(usbd_device_handle, usb_device_request_t *,
143 void *, u_int16_t, int*, u_int32_t);
144 usbd_status usbd_do_request_flags_pipe(usbd_device_handle, usbd_pipe_handle,
145 usb_device_request_t *, void *, u_int16_t, int *, u_int32_t);
146 usb_interface_descriptor_t *usbd_get_interface_descriptor
147 (usbd_interface_handle);
148 usb_config_descriptor_t *usbd_get_config_descriptor(usbd_device_handle);
149 usb_device_descriptor_t *usbd_get_device_descriptor(usbd_device_handle);
150 int usbd_get_speed(usbd_device_handle);
151 usbd_status usbd_set_interface(usbd_interface_handle, int);
152 int usbd_get_no_alts(usb_config_descriptor_t *, int);
153 usbd_status usbd_get_interface(usbd_interface_handle, u_int8_t *);
154 void usbd_fill_deviceinfo(usbd_device_handle, struct usb_device_info *, int);
155 int usbd_get_interface_altindex(usbd_interface_handle);
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);
162 void usbd_dopoll(usbd_interface_handle);
163 void usbd_set_polling(usbd_device_handle, int);
165 const char *usbd_errstr(usbd_status);
167 void usbd_add_dev_event(int, usbd_device_handle);
168 void usbd_add_drv_event(int, usbd_device_handle, device_t);
170 void usbd_devinfo(usbd_device_handle, int, char *);
171 const struct usbd_quirks *usbd_get_quirks(usbd_device_handle);
172 usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor
173 (usbd_interface_handle, u_int8_t);
175 usbd_status usbd_reload_device_desc(usbd_device_handle);
177 int usbd_ratecheck(struct timeval *last);
179 usbd_status usbd_get_string(usbd_device_handle dev, int si, char *buf);
181 /* An iterator for descriptors. */
182 typedef struct {
183 const uByte *cur;
184 const uByte *end;
185 } usbd_desc_iter_t;
186 void usb_desc_iter_init(usbd_device_handle dev, usbd_desc_iter_t *iter);
187 const usb_descriptor_t *usb_desc_iter_next(usbd_desc_iter_t *iter);
190 * The usb_task structs form a queue of things to run in the USB event
191 * thread. Normally this is just device discovery when a connect/disconnect
192 * has been detected. But it may also be used by drivers that need to
193 * perform (short) tasks that must have a process context.
195 struct usb_task {
196 TAILQ_ENTRY(usb_task) next;
197 void (*fun)(void *);
198 void *arg;
199 int queue;
201 #define USB_TASKQ_HC 0
202 #define USB_TASKQ_DRIVER 1
203 #define USB_NUM_TASKQS 2
204 #define USB_TASKQ_NAMES {"usbtask-hc", "usbtask-dr"}
206 void usb_do_task(usbd_device_handle, struct usb_task *, int, int);
207 void usb_add_task(usbd_device_handle, struct usb_task *, int);
208 void usb_rem_task(usbd_device_handle, struct usb_task *);
209 #define usb_init_task(t, f, a) ((t)->fun = (f), (t)->arg = (a), (t)->queue = -1)
211 struct usb_devno {
212 u_int16_t ud_vendor;
213 u_int16_t ud_product;
215 #define USB_DEVICE(vid, pid) \
216 .ud_vendor = (vid), .ud_product = (pid)
217 const struct usb_devno *usb_match_device(const struct usb_devno *,
218 u_int, u_int, u_int16_t, u_int16_t);
219 #define usb_lookup(tbl, vendor, product) \
220 usb_match_device((const struct usb_devno *)(tbl), sizeof (tbl) / sizeof ((tbl)[0]), sizeof ((tbl)[0]), (vendor), (product))
221 #define USB_PRODUCT_ANY 0xffff
223 /* NetBSD attachment information */
225 /* Attach data */
226 struct usb_attach_arg {
227 int port;
228 int configno;
229 int ifaceno;
230 int vendor;
231 int product;
232 int release;
233 int matchlvl;
234 usbd_device_handle device; /* current device */
235 usbd_interface_handle iface; /* current interface */
236 int usegeneric;
237 usbd_interface_handle *ifaces; /* all interfaces */
238 int nifaces; /* number of interfaces */
241 /* FreeBSD needs values less than zero */
242 #define UMATCH_VENDOR_PRODUCT_REV (-10)
243 #define UMATCH_VENDOR_PRODUCT (-20)
244 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO (-30)
245 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO (-40)
246 #define UMATCH_DEVCLASS_DEVSUBCLASS (-50)
247 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE (-60)
248 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE (-70)
249 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO (-80)
250 #define UMATCH_VENDOR_IFACESUBCLASS (-90)
251 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO (-100)
252 #define UMATCH_IFACECLASS_IFACESUBCLASS (-110)
253 #define UMATCH_IFACECLASS (-120)
254 #define UMATCH_IFACECLASS_GENERIC (-130)
255 #define UMATCH_GENERIC (-140)
256 #define UMATCH_NONE (ENXIO)
258 #define USBD_SHOW_DEVICE_CLASS 0x1
259 #define USBD_SHOW_INTERFACE_CLASS 0x2
261 int usbd_driver_load(module_t mod, int what, void *arg);
263 static __inline int
264 usb_get_port(device_t dev)
266 struct usb_attach_arg *uap = device_get_ivars(dev);
267 return (uap->port);
270 static __inline struct usbd_interface *
271 usb_get_iface(device_t dev)
273 struct usb_attach_arg *uap = device_get_ivars(dev);
274 return (uap->iface);
277 #define IPL_USB IPL_BIO
279 #endif /* _USBDI_H_ */