USB - Add support for xfer-restart-before-callback
[dragonfly.git] / sys / bus / usb / usbdi.h
CommitLineData
281cf3c2
SZ
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 $ */
3f56796e 3/* $DragonFly: src/sys/bus/usb/usbdi.h,v 1.10 2007/11/05 13:32:27 hasso Exp $ */
984263bc
MD
4
5/*
6 * Copyright (c) 1998 The NetBSD Foundation, Inc.
7 * All rights reserved.
8 *
9 * This code is derived from software contributed to The NetBSD Foundation
10 * by Lennart Augustsson (lennart@augustsson.net) at
11 * Carlstedt Research & Technology.
12 *
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.
28 *
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.
40 */
41
281cf3c2
SZ
42#ifndef _USBDI_H_
43#define _USBDI_H_
44
984263bc
MD
45typedef struct usbd_bus *usbd_bus_handle;
46typedef struct usbd_device *usbd_device_handle;
47typedef struct usbd_interface *usbd_interface_handle;
48typedef struct usbd_pipe *usbd_pipe_handle;
49typedef struct usbd_xfer *usbd_xfer_handle;
50typedef void *usbd_private_handle;
51
1550dfd9 52typedef enum { /* keep in sync with usbd_status_msgs */
984263bc 53 USBD_NORMAL_COMPLETION = 0, /* must be 0 */
1550dfd9 54 USBD_IN_PROGRESS, /* 1 */
984263bc 55 /* errors */
1550dfd9
MD
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 */
984263bc 73
1550dfd9 74 USBD_ERROR_MAX /* must be last */
984263bc
MD
75} usbd_status;
76
77typedef void (*usbd_callback)(usbd_xfer_handle, usbd_private_handle,
1550dfd9 78 usbd_status);
984263bc
MD
79
80/* Open flags */
81#define USBD_EXCLUSIVE_USE 0x01
82
83/* Use default (specified by ep. desc.) interval on interrupt pipe */
84#define USBD_DEFAULT_INTERVAL (-1)
85
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 */
f32bdd67 91#define USBD_CALLBACK_LAST 0x10 /* restart xfer BEFORE making callback */
984263bc 92
984263bc
MD
93#define USBD_NO_TIMEOUT 0
94#define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */
95
984263bc 96#define USB_CDEV_MAJOR 108
984263bc 97
281cf3c2
SZ
98usbd_status usbd_open_pipe(usbd_interface_handle, u_int8_t,
99 u_int8_t, usbd_pipe_handle *);
100usbd_status usbd_close_pipe(usbd_pipe_handle);
101usbd_status usbd_transfer(usbd_xfer_handle);
1550dfd9 102usbd_xfer_handle usbd_alloc_xfer(usbd_device_handle);
281cf3c2
SZ
103usbd_status usbd_free_xfer(usbd_xfer_handle);
104void usbd_setup_xfer(usbd_xfer_handle, usbd_pipe_handle,
105 usbd_private_handle, void *,
106 u_int32_t, u_int16_t, u_int32_t,
1550dfd9 107 usbd_callback);
281cf3c2
SZ
108void usbd_setup_default_xfer(usbd_xfer_handle, usbd_device_handle,
109 usbd_private_handle, u_int32_t,
110 usb_device_request_t *, void *,
111 u_int32_t, u_int16_t, usbd_callback);
112void usbd_setup_isoc_xfer(usbd_xfer_handle, usbd_pipe_handle,
113 usbd_private_handle, u_int16_t *,
114 u_int32_t, u_int16_t, usbd_callback);
115void usbd_get_xfer_status(usbd_xfer_handle, usbd_private_handle *,
116 void **, u_int32_t *, usbd_status *);
984263bc 117usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor
281cf3c2
SZ
118 (usbd_interface_handle, u_int8_t);
119usbd_status usbd_abort_pipe(usbd_pipe_handle);
120usbd_status usbd_abort_default_pipe(usbd_device_handle);
121usbd_status usbd_clear_endpoint_stall(usbd_pipe_handle);
122usbd_status usbd_clear_endpoint_stall_async(usbd_pipe_handle);
123void usbd_clear_endpoint_toggle(usbd_pipe_handle);
124usbd_status usbd_endpoint_count(usbd_interface_handle, u_int8_t *);
125usbd_status usbd_interface_count(usbd_device_handle, u_int8_t *);
126void usbd_interface2device_handle(usbd_interface_handle,
127 usbd_device_handle *);
128usbd_status usbd_device2interface_handle(usbd_device_handle,
129 u_int8_t, usbd_interface_handle *);
984263bc
MD
130
131usbd_device_handle usbd_pipe2device_handle(usbd_pipe_handle);
281cf3c2
SZ
132void *usbd_alloc_buffer(usbd_xfer_handle, u_int32_t);
133void usbd_free_buffer(usbd_xfer_handle);
134void *usbd_get_buffer(usbd_xfer_handle);
135usbd_status usbd_sync_transfer(usbd_xfer_handle);
136usbd_status usbd_open_pipe_intr(usbd_interface_handle, u_int8_t,
137 u_int8_t, usbd_pipe_handle *,
138 usbd_private_handle, void *,
139 u_int32_t, usbd_callback, int);
140usbd_status usbd_do_request(usbd_device_handle, usb_device_request_t *, void *);
141usbd_status usbd_do_request_async(usbd_device_handle,
142 usb_device_request_t *, void *);
143usbd_status usbd_do_request_flags(usbd_device_handle, usb_device_request_t *,
144 void *, u_int16_t, int*, u_int32_t);
145usbd_status usbd_do_request_flags_pipe(usbd_device_handle, usbd_pipe_handle,
146 usb_device_request_t *, void *, u_int16_t, int *, u_int32_t);
984263bc 147usb_interface_descriptor_t *usbd_get_interface_descriptor
281cf3c2
SZ
148 (usbd_interface_handle);
149usb_config_descriptor_t *usbd_get_config_descriptor(usbd_device_handle);
150usb_device_descriptor_t *usbd_get_device_descriptor(usbd_device_handle);
151int usbd_get_speed(usbd_device_handle);
984263bc
MD
152usbd_status usbd_set_interface(usbd_interface_handle, int);
153int usbd_get_no_alts(usb_config_descriptor_t *, int);
281cf3c2 154usbd_status usbd_get_interface(usbd_interface_handle, u_int8_t *);
1550dfd9 155void usbd_fill_deviceinfo(usbd_device_handle, struct usb_device_info *, int);
281cf3c2 156int usbd_get_interface_altindex(usbd_interface_handle);
984263bc 157
281cf3c2
SZ
158usb_interface_descriptor_t *usbd_find_idesc(usb_config_descriptor_t *,
159 int, int);
160usb_endpoint_descriptor_t *usbd_find_edesc(usb_config_descriptor_t *,
161 int, int, int);
984263bc
MD
162
163void usbd_dopoll(usbd_interface_handle);
281cf3c2 164void usbd_set_polling(usbd_device_handle, int);
984263bc 165
281cf3c2 166const char *usbd_errstr(usbd_status);
984263bc 167
1550dfd9 168void usbd_add_dev_event(int, usbd_device_handle);
6ed427ca 169void usbd_add_drv_event(int, usbd_device_handle, device_t);
984263bc
MD
170
171void usbd_devinfo(usbd_device_handle, int, char *);
1550dfd9 172const struct usbd_quirks *usbd_get_quirks(usbd_device_handle);
984263bc 173usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor
281cf3c2 174 (usbd_interface_handle, u_int8_t);
984263bc
MD
175
176usbd_status usbd_reload_device_desc(usbd_device_handle);
177
1550dfd9
MD
178int usbd_ratecheck(struct timeval *last);
179
281cf3c2
SZ
180usbd_status usbd_get_string(usbd_device_handle dev, int si, char *buf);
181
182/* An iterator for descriptors. */
183typedef struct {
184 const uByte *cur;
185 const uByte *end;
186} usbd_desc_iter_t;
187void usb_desc_iter_init(usbd_device_handle dev, usbd_desc_iter_t *iter);
188const usb_descriptor_t *usb_desc_iter_next(usbd_desc_iter_t *iter);
189
1550dfd9
MD
190/*
191 * The usb_task structs form a queue of things to run in the USB event
192 * thread. Normally this is just device discovery when a connect/disconnect
193 * has been detected. But it may also be used by drivers that need to
194 * perform (short) tasks that must have a process context.
195 */
196struct usb_task {
197 TAILQ_ENTRY(usb_task) next;
198 void (*fun)(void *);
199 void *arg;
281cf3c2 200 int queue;
1550dfd9 201};
281cf3c2
SZ
202#define USB_TASKQ_HC 0
203#define USB_TASKQ_DRIVER 1
204#define USB_NUM_TASKQS 2
205#define USB_TASKQ_NAMES {"usbtask-hc", "usbtask-dr"}
1550dfd9 206
281cf3c2
SZ
207void usb_do_task(usbd_device_handle, struct usb_task *, int, int);
208void usb_add_task(usbd_device_handle, struct usb_task *, int);
209void 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)
1550dfd9 211
984263bc
MD
212struct usb_devno {
213 u_int16_t ud_vendor;
214 u_int16_t ud_product;
215};
3f56796e
HT
216#define USB_DEVICE(vid, pid) \
217 .ud_vendor = (vid), .ud_product = (pid)
281cf3c2
SZ
218const struct usb_devno *usb_match_device(const struct usb_devno *,
219 u_int, u_int, u_int16_t, u_int16_t);
984263bc
MD
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))
1550dfd9 222#define USB_PRODUCT_ANY 0xffff
984263bc
MD
223
224/* NetBSD attachment information */
225
226/* Attach data */
227struct usb_attach_arg {
228 int port;
229 int configno;
230 int ifaceno;
231 int vendor;
232 int product;
233 int release;
1550dfd9 234 int matchlvl;
984263bc
MD
235 usbd_device_handle device; /* current device */
236 usbd_interface_handle iface; /* current interface */
237 int usegeneric;
238 usbd_interface_handle *ifaces; /* all interfaces */
239 int nifaces; /* number of interfaces */
240};
241
984263bc
MD
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)
258
281cf3c2
SZ
259#define USBD_SHOW_DEVICE_CLASS 0x1
260#define USBD_SHOW_INTERFACE_CLASS 0x2
261
984263bc 262int usbd_driver_load(module_t mod, int what, void *arg);
281cf3c2
SZ
263
264static __inline int
265usb_get_port(device_t dev)
266{
267 struct usb_attach_arg *uap = device_get_ivars(dev);
268 return (uap->port);
269}
270
271static __inline struct usbd_interface *
272usb_get_iface(device_t dev)
273{
274 struct usb_attach_arg *uap = device_get_ivars(dev);
275 return (uap->iface);
276}
277
281cf3c2
SZ
278#define IPL_USB IPL_BIO
279
280#endif /* _USBDI_H_ */