1/* $NetBSD: usbdi.h,v 1.92 2016/08/14 14:42:22 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@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
37struct usbd_bus;
38struct usbd_device;
39struct usbd_interface;
40struct usbd_pipe;
41struct usbd_xfer;
42
43typedef enum { /* keep in sync with usbd_error_strs */
44 USBD_NORMAL_COMPLETION = 0, /* must be 0 */
45 USBD_IN_PROGRESS, /* 1 */
46 /* errors */
47 USBD_PENDING_REQUESTS, /* 2 */
48 USBD_NOT_STARTED, /* 3 */
49 USBD_INVAL, /* 4 */
50 USBD_NOMEM, /* 5 */
51 USBD_CANCELLED, /* 6 */
52 USBD_BAD_ADDRESS, /* 7 */
53 USBD_IN_USE, /* 8 */
54 USBD_NO_ADDR, /* 9 */
55 USBD_SET_ADDR_FAILED, /* 10 */
56 USBD_NO_POWER, /* 11 */
57 USBD_TOO_DEEP, /* 12 */
58 USBD_IOERROR, /* 13 */
59 USBD_NOT_CONFIGURED, /* 14 */
60 USBD_TIMEOUT, /* 15 */
61 USBD_SHORT_XFER, /* 16 */
62 USBD_STALLED, /* 17 */
63 USBD_INTERRUPTED, /* 18 */
64
65 USBD_ERROR_MAX /* must be last */
66} usbd_status;
67
68typedef void (*usbd_callback)(struct usbd_xfer *, void *, usbd_status);
69
70/* Use default (specified by ep. desc.) interval on interrupt pipe */
71#define USBD_DEFAULT_INTERVAL (-1)
72
73/* Open flags */
74#define USBD_EXCLUSIVE_USE 0x01
75#define USBD_MPSAFE 0x80
76
77/* Request flags */
78#define USBD_SYNCHRONOUS 0x02 /* wait for completion */
79/* in usb.h #define USBD_SHORT_XFER_OK 0x04*/ /* allow short reads */
80#define USBD_FORCE_SHORT_XFER 0x08 /* force last short packet on write */
81#define USBD_SYNCHRONOUS_SIG 0x10 /* if waiting for completion,
82 * also take signals */
83
84#define USBD_NO_TIMEOUT 0
85#define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */
86#define USBD_CONFIG_TIMEOUT (3*USBD_DEFAULT_TIMEOUT)
87
88#define DEVINFOSIZE 1024
89
90usbd_status usbd_open_pipe_intr(struct usbd_interface *, uint8_t, uint8_t,
91 struct usbd_pipe **, void *, void *, uint32_t, usbd_callback, int);
92usbd_status usbd_open_pipe(struct usbd_interface *, uint8_t, uint8_t,
93 struct usbd_pipe **);
94usbd_status usbd_close_pipe(struct usbd_pipe *);
95
96usbd_status usbd_transfer(struct usbd_xfer *);
97
98void *usbd_get_buffer(struct usbd_xfer *);
99struct usbd_pipe *usbd_get_pipe0(struct usbd_device *);
100
101int usbd_create_xfer(struct usbd_pipe *, size_t, unsigned int, unsigned int,
102 struct usbd_xfer **);
103void usbd_destroy_xfer(struct usbd_xfer *);
104
105void usbd_setup_xfer(struct usbd_xfer *, void *, void *,
106 uint32_t, uint16_t, uint32_t, usbd_callback);
107
108void usbd_setup_default_xfer(struct usbd_xfer *, struct usbd_device *,
109 void *, uint32_t, usb_device_request_t *, void *,
110 uint32_t, uint16_t, usbd_callback);
111
112void usbd_setup_isoc_xfer(struct usbd_xfer *, void *, uint16_t *,
113 uint32_t, uint16_t, usbd_callback);
114
115void usbd_get_xfer_status(struct usbd_xfer *, void **,
116 void **, uint32_t *, usbd_status *);
117
118usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor
119 (struct usbd_interface *, uint8_t);
120
121usbd_status usbd_abort_pipe(struct usbd_pipe *);
122usbd_status usbd_abort_default_pipe(struct usbd_device *);
123
124usbd_status usbd_clear_endpoint_stall(struct usbd_pipe *);
125void usbd_clear_endpoint_stall_async(struct usbd_pipe *);
126
127void usbd_clear_endpoint_toggle(struct usbd_pipe *);
128usbd_status usbd_endpoint_count(struct usbd_interface *, uint8_t *);
129
130usbd_status usbd_interface_count(struct usbd_device *, uint8_t *);
131
132void usbd_interface2device_handle(struct usbd_interface *, struct usbd_device **);
133usbd_status usbd_device2interface_handle(struct usbd_device *,
134 uint8_t, struct usbd_interface **);
135
136struct usbd_device *usbd_pipe2device_handle(struct usbd_pipe *);
137
138usbd_status usbd_sync_transfer(struct usbd_xfer *);
139usbd_status usbd_sync_transfer_sig(struct usbd_xfer *);
140
141usbd_status usbd_do_request(struct usbd_device *, usb_device_request_t *, void *);
142usbd_status usbd_do_request_flags(struct usbd_device *, usb_device_request_t *,
143 void *, uint16_t, int *, uint32_t);
144
145usb_interface_descriptor_t *
146 usbd_get_interface_descriptor(struct usbd_interface *);
147usb_endpoint_descriptor_t *
148 usbd_get_endpoint_descriptor(struct usbd_interface *, uint8_t);
149
150usb_config_descriptor_t *usbd_get_config_descriptor(struct usbd_device *);
151usb_device_descriptor_t *usbd_get_device_descriptor(struct usbd_device *);
152
153usbd_status usbd_set_interface(struct usbd_interface *, int);
154usbd_status usbd_get_interface(struct usbd_interface *, uint8_t *);
155
156int usbd_get_no_alts(usb_config_descriptor_t *, int);
157
158void usbd_fill_deviceinfo(struct usbd_device *, struct usb_device_info *, int);
159#ifdef COMPAT_30
160void usbd_fill_deviceinfo_old(struct usbd_device *, struct usb_device_info_old *,
161 int);
162#endif
163int usbd_get_interface_altindex(struct usbd_interface *);
164
165usb_interface_descriptor_t *usbd_find_idesc(usb_config_descriptor_t *,
166 int, int);
167usb_endpoint_descriptor_t *usbd_find_edesc(usb_config_descriptor_t *,
168 int, int, int);
169
170void usbd_dopoll(struct usbd_interface *);
171void usbd_set_polling(struct usbd_device *, int);
172
173const char *usbd_errstr(usbd_status);
174
175void usbd_add_dev_event(int, struct usbd_device *);
176void usbd_add_drv_event(int, struct usbd_device *, device_t);
177
178char *usbd_devinfo_alloc(struct usbd_device *, int);
179void usbd_devinfo_free(char *);
180
181const struct usbd_quirks *usbd_get_quirks(struct usbd_device *);
182
183usbd_status usbd_reload_device_desc(struct usbd_device *);
184
185int usbd_ratecheck(struct timeval *);
186
187usbd_status usbd_get_string(struct usbd_device *, int, char *);
188usbd_status usbd_get_string0(struct usbd_device *, int, char *, int);
189
190/* An iterator for descriptors. */
191typedef struct {
192 const uByte *cur;
193 const uByte *end;
194} usbd_desc_iter_t;
195void usb_desc_iter_init(struct usbd_device *, usbd_desc_iter_t *);
196const usb_descriptor_t *usb_desc_iter_next(usbd_desc_iter_t *);
197
198/* Used to clear endpoint stalls from the softint */
199void usbd_clear_endpoint_stall_task(void *);
200
201/*
202 * The usb_task structs form a queue of things to run in the USB event
203 * thread. Normally this is just device discovery when a connect/disconnect
204 * has been detected. But it may also be used by drivers that need to
205 * perform (short) tasks that must have a process context.
206 */
207struct usb_task {
208 TAILQ_ENTRY(usb_task) next;
209 void (*fun)(void *);
210 void *arg;
211 volatile unsigned queue;
212 int flags;
213};
214#define USB_TASKQ_HC 0
215#define USB_TASKQ_DRIVER 1
216#define USB_NUM_TASKQS 2
217#define USB_TASKQ_NAMES {"usbtask-hc", "usbtask-dr"}
218#define USB_TASKQ_MPSAFE 0x80
219
220void usb_add_task(struct usbd_device *, struct usb_task *, int);
221void usb_rem_task(struct usbd_device *, struct usb_task *);
222#define usb_init_task(t, f, a, fl) ((t)->fun = (f), (t)->arg = (a), (t)->queue = USB_NUM_TASKQS, (t)->flags = (fl))
223
224struct usb_devno {
225 uint16_t ud_vendor;
226 uint16_t ud_product;
227};
228const struct usb_devno *usb_match_device(const struct usb_devno *,
229 u_int, u_int, uint16_t, uint16_t);
230#define usb_lookup(tbl, vendor, product) \
231 usb_match_device((const struct usb_devno *)(tbl), sizeof(tbl) / sizeof((tbl)[0]), sizeof((tbl)[0]), (vendor), (product))
232#define USB_PRODUCT_ANY 0xffff
233
234/* NetBSD attachment information */
235
236/* Attach data */
237struct usb_attach_arg {
238 int uaa_port;
239 int uaa_vendor;
240 int uaa_product;
241 int uaa_release;
242 struct usbd_device * uaa_device; /* current device */
243 int uaa_class;
244 int uaa_subclass;
245 int uaa_proto;
246 int uaa_usegeneric;
247};
248
249struct usbif_attach_arg {
250 int uiaa_port;
251 int uiaa_configno;
252 int uiaa_ifaceno;
253 int uiaa_vendor;
254 int uiaa_product;
255 int uiaa_release;
256 struct usbd_device * uiaa_device; /* current device */
257
258 struct usbd_interface * uiaa_iface; /* current interface */
259 int uiaa_class;
260 int uiaa_subclass;
261 int uiaa_proto;
262
263 /* XXX need accounting for interfaces not matched to */
264
265 struct usbd_interface **uiaa_ifaces; /* all interfaces */
266 int uiaa_nifaces; /* number of interfaces */
267};
268
269/* Match codes. */
270#define UMATCH_HIGHEST 15
271/* First five codes is for a whole device. */
272#define UMATCH_VENDOR_PRODUCT_REV 14
273#define UMATCH_VENDOR_PRODUCT 13
274#define UMATCH_VENDOR_DEVCLASS_DEVPROTO 12
275#define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO 11
276#define UMATCH_DEVCLASS_DEVSUBCLASS 10
277/* Next six codes are for interfaces. */
278#define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE 9
279#define UMATCH_VENDOR_PRODUCT_CONF_IFACE 8
280#define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO 7
281#define UMATCH_VENDOR_IFACESUBCLASS 6
282#define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO 5
283#define UMATCH_IFACECLASS_IFACESUBCLASS 4
284#define UMATCH_IFACECLASS 3
285#define UMATCH_IFACECLASS_GENERIC 2
286/* Generic driver */
287#define UMATCH_GENERIC 1
288/* No match */
289#define UMATCH_NONE 0
290
291
292/*
293 * IPL_USB is defined as IPL_VM for drivers that have not been made MP safe.
294 * IPL_VM (currently) takes the kernel lock.
295 *
296 * Eventually, IPL_USB can/should be changed
297 */
298#define IPL_USB IPL_VM
299#define splhardusb splvm
300
301#define SOFTINT_USB SOFTINT_SERIAL
302#define IPL_SOFTUSB IPL_SOFTSERIAL
303#define splusb splsoftserial
304
305#endif /* _USBDI_H_ */
306