xref: /freebsd/sys/dev/usb/usbdi.h (revision d3d381b2b194b4d24853e92eecef55f262688d1a)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2009 Andrew Thompson
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 #ifndef _USB_USBDI_H_
29 #define _USB_USBDI_H_
30 
31 struct usb_fifo;
32 struct usb_xfer;
33 struct usb_device;
34 struct usb_attach_arg;
35 struct usb_interface;
36 struct usb_endpoint;
37 struct usb_page_cache;
38 struct usb_page_search;
39 struct usb_process;
40 struct usb_proc_msg;
41 struct usb_mbuf;
42 struct usb_fs_privdata;
43 struct mbuf;
44 
45 typedef enum {	/* keep in sync with usb_errstr_table */
46 	USB_ERR_NORMAL_COMPLETION = 0,
47 	USB_ERR_PENDING_REQUESTS,	/* 1 */
48 	USB_ERR_NOT_STARTED,		/* 2 */
49 	USB_ERR_INVAL,			/* 3 */
50 	USB_ERR_NOMEM,			/* 4 */
51 	USB_ERR_CANCELLED,		/* 5 */
52 	USB_ERR_BAD_ADDRESS,		/* 6 */
53 	USB_ERR_BAD_BUFSIZE,		/* 7 */
54 	USB_ERR_BAD_FLAG,		/* 8 */
55 	USB_ERR_NO_CALLBACK,		/* 9 */
56 	USB_ERR_IN_USE,			/* 10 */
57 	USB_ERR_NO_ADDR,		/* 11 */
58 	USB_ERR_NO_PIPE,		/* 12 */
59 	USB_ERR_ZERO_NFRAMES,		/* 13 */
60 	USB_ERR_ZERO_MAXP,		/* 14 */
61 	USB_ERR_SET_ADDR_FAILED,	/* 15 */
62 	USB_ERR_NO_POWER,		/* 16 */
63 	USB_ERR_TOO_DEEP,		/* 17 */
64 	USB_ERR_IOERROR,		/* 18 */
65 	USB_ERR_NOT_CONFIGURED,		/* 19 */
66 	USB_ERR_TIMEOUT,		/* 20 */
67 	USB_ERR_SHORT_XFER,		/* 21 */
68 	USB_ERR_STALLED,		/* 22 */
69 	USB_ERR_INTERRUPTED,		/* 23 */
70 	USB_ERR_DMA_LOAD_FAILED,	/* 24 */
71 	USB_ERR_BAD_CONTEXT,		/* 25 */
72 	USB_ERR_NO_ROOT_HUB,		/* 26 */
73 	USB_ERR_NO_INTR_THREAD,		/* 27 */
74 	USB_ERR_NOT_LOCKED,		/* 28 */
75 	USB_ERR_MAX
76 } usb_error_t;
77 
78 /*
79  * Flags for transfers
80  */
81 #define	USB_FORCE_SHORT_XFER	0x0001	/* force a short transmit last */
82 #define	USB_SHORT_XFER_OK	0x0004	/* allow short reads */
83 #define	USB_DELAY_STATUS_STAGE	0x0010	/* insert delay before STATUS stage */
84 #define	USB_USER_DATA_PTR	0x0020	/* internal flag */
85 #define	USB_MULTI_SHORT_OK	0x0040	/* allow multiple short frames */
86 #define	USB_MANUAL_STATUS	0x0080	/* manual ctrl status */
87 
88 #define	USB_NO_TIMEOUT 0
89 #define	USB_DEFAULT_TIMEOUT 5000	/* 5000 ms = 5 seconds */
90 
91 #if defined(_KERNEL)
92 /* typedefs */
93 
94 typedef void (usb_callback_t)(struct usb_xfer *, usb_error_t);
95 typedef void (usb_proc_callback_t)(struct usb_proc_msg *);
96 typedef usb_error_t (usb_handle_req_t)(struct usb_device *,
97     struct usb_device_request *, const void **, uint16_t *);
98 
99 typedef int (usb_fifo_open_t)(struct usb_fifo *fifo, int fflags);
100 typedef void (usb_fifo_close_t)(struct usb_fifo *fifo, int fflags);
101 typedef int (usb_fifo_ioctl_t)(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags);
102 typedef void (usb_fifo_cmd_t)(struct usb_fifo *fifo);
103 typedef void (usb_fifo_filter_t)(struct usb_fifo *fifo, struct usb_mbuf *m);
104 
105 
106 /* USB events */
107 #ifndef USB_GLOBAL_INCLUDE_FILE
108 #include <sys/eventhandler.h>
109 #endif
110 typedef void (*usb_dev_configured_t)(void *, struct usb_device *,
111     struct usb_attach_arg *);
112 EVENTHANDLER_DECLARE(usb_dev_configured, usb_dev_configured_t);
113 
114 /*
115  * The following macros are used used to convert milliseconds into
116  * HZ. We use 1024 instead of 1000 milliseconds per second to save a
117  * full division.
118  */
119 #define	USB_MS_HZ 1024
120 
121 #define	USB_MS_TO_TICKS(ms) \
122   (((uint32_t)((((uint32_t)(ms)) * ((uint32_t)(hz))) + USB_MS_HZ - 1)) / USB_MS_HZ)
123 
124 /*
125  * Common queue structure for USB transfers.
126  */
127 struct usb_xfer_queue {
128 	TAILQ_HEAD(, usb_xfer) head;
129 	struct usb_xfer *curr;		/* current USB transfer processed */
130 	void    (*command) (struct usb_xfer_queue *pq);
131 	uint8_t	recurse_1:1;
132 	uint8_t	recurse_2:1;
133 	uint8_t	recurse_3:1;
134 	uint8_t	reserved:5;
135 };
136 
137 /*
138  * The following structure defines an USB endpoint
139  * USB endpoint.
140  */
141 struct usb_endpoint {
142 	/* queue of USB transfers */
143 	struct usb_xfer_queue endpoint_q[USB_MAX_EP_STREAMS];
144 
145 	struct usb_endpoint_descriptor *edesc;
146 	struct usb_endpoint_ss_comp_descriptor *ecomp;
147 	const struct usb_pipe_methods *methods;	/* set by HC driver */
148 
149 	uint16_t isoc_next;
150 
151 	uint8_t	toggle_next:1;		/* next data toggle value */
152 	uint8_t	is_stalled:1;		/* set if endpoint is stalled */
153 	uint8_t	is_synced:1;		/* set if we a synchronised */
154 	uint8_t	unused:5;
155 	uint8_t	iface_index;		/* not used by "default endpoint" */
156 
157 	uint8_t refcount_alloc;		/* allocation refcount */
158 	uint8_t refcount_bw;		/* bandwidth refcount */
159 #define	USB_EP_REF_MAX 0x3f
160 
161 	/* High-Speed resource allocation (valid if "refcount_bw" > 0) */
162 
163 	uint8_t	usb_smask;		/* USB start mask */
164 	uint8_t	usb_cmask;		/* USB complete mask */
165 	uint8_t	usb_uframe;		/* USB microframe */
166 
167 	/* USB endpoint mode, see USB_EP_MODE_XXX */
168 
169 	uint8_t ep_mode;
170 };
171 
172 /*
173  * The following structure defines an USB interface.
174  */
175 struct usb_interface {
176 	struct usb_interface_descriptor *idesc;
177 	device_t subdev;
178 	uint8_t	alt_index;
179 	uint8_t	parent_iface_index;
180 
181 	/* Linux compat */
182 	struct usb_host_interface *altsetting;
183 	struct usb_host_interface *cur_altsetting;
184 	struct usb_device *linux_udev;
185 	void   *bsd_priv_sc;		/* device specific information */
186 	char   *pnpinfo;		/* additional PnP-info for this interface */
187 	uint8_t	num_altsetting;		/* number of alternate settings */
188 	uint8_t	bsd_iface_index;
189 };
190 
191 /*
192  * The following structure defines a set of USB transfer flags.
193  */
194 struct usb_xfer_flags {
195 	uint8_t	force_short_xfer:1;	/* force a short transmit transfer
196 					 * last */
197 	uint8_t	short_xfer_ok:1;	/* allow short receive transfers */
198 	uint8_t	short_frames_ok:1;	/* allow short frames */
199 	uint8_t	pipe_bof:1;		/* block pipe on failure */
200 	uint8_t	proxy_buffer:1;		/* makes buffer size a factor of
201 					 * "max_frame_size" */
202 	uint8_t	ext_buffer:1;		/* uses external DMA buffer */
203 	uint8_t	manual_status:1;	/* non automatic status stage on
204 					 * control transfers */
205 	uint8_t	no_pipe_ok:1;		/* set if "USB_ERR_NO_PIPE" error can
206 					 * be ignored */
207 	uint8_t	stall_pipe:1;		/* set if the endpoint belonging to
208 					 * this USB transfer should be stalled
209 					 * before starting this transfer! */
210 	uint8_t pre_scale_frames:1;	/* "usb_config->frames" is
211 					 * assumed to give the
212 					 * buffering time in
213 					 * milliseconds and is
214 					 * converted into the nearest
215 					 * number of frames when the
216 					 * USB transfer is setup. This
217 					 * option only has effect for
218 					 * ISOCHRONOUS transfers.
219 					 */
220 };
221 
222 /*
223  * The following structure define an USB configuration, that basically
224  * is used when setting up an USB transfer.
225  */
226 struct usb_config {
227 	usb_callback_t *callback;	/* USB transfer callback */
228 	usb_frlength_t bufsize;	/* total pipe buffer size in bytes */
229 	usb_frcount_t frames;		/* maximum number of USB frames */
230 	usb_timeout_t interval;	/* interval in milliseconds */
231 #define	USB_DEFAULT_INTERVAL	0
232 	usb_timeout_t timeout;		/* transfer timeout in milliseconds */
233 	struct usb_xfer_flags flags;	/* transfer flags */
234 	usb_stream_t stream_id;		/* USB3.0 specific */
235 	enum usb_hc_mode usb_mode;	/* host or device mode */
236 	uint8_t	type;			/* pipe type */
237 	uint8_t	endpoint;		/* pipe number */
238 	uint8_t	direction;		/* pipe direction */
239 	uint8_t	ep_index;		/* pipe index match to use */
240 	uint8_t	if_index;		/* "ifaces" index to use */
241 };
242 
243 /*
244  * Use these macro when defining USB device ID arrays if you want to
245  * have your driver module automatically loaded in host, device or
246  * both modes respectively:
247  */
248 #if USB_HAVE_ID_SECTION
249 #define	STRUCT_USB_HOST_ID \
250     struct usb_device_id __section("usb_host_id")
251 #define	STRUCT_USB_DEVICE_ID \
252     struct usb_device_id __section("usb_device_id")
253 #define	STRUCT_USB_DUAL_ID \
254     struct usb_device_id __section("usb_dual_id")
255 #else
256 #define	STRUCT_USB_HOST_ID \
257     struct usb_device_id
258 #define	STRUCT_USB_DEVICE_ID \
259     struct usb_device_id
260 #define	STRUCT_USB_DUAL_ID \
261     struct usb_device_id
262 #endif			/* USB_HAVE_ID_SECTION */
263 
264 /*
265  * The following structure is used when looking up an USB driver for
266  * an USB device. It is inspired by the Linux structure called
267  * "usb_device_id".
268  */
269 struct usb_device_id {
270 
271 	/* Select which fields to match against */
272 #if BYTE_ORDER == LITTLE_ENDIAN
273 	uint16_t
274 		match_flag_vendor:1,
275 		match_flag_product:1,
276 		match_flag_dev_lo:1,
277 		match_flag_dev_hi:1,
278 
279 		match_flag_dev_class:1,
280 		match_flag_dev_subclass:1,
281 		match_flag_dev_protocol:1,
282 		match_flag_int_class:1,
283 
284 		match_flag_int_subclass:1,
285 		match_flag_int_protocol:1,
286 		match_flag_unused:6;
287 #else
288 	uint16_t
289 		match_flag_unused:6,
290 		match_flag_int_protocol:1,
291 		match_flag_int_subclass:1,
292 
293 		match_flag_int_class:1,
294 		match_flag_dev_protocol:1,
295 		match_flag_dev_subclass:1,
296 		match_flag_dev_class:1,
297 
298 		match_flag_dev_hi:1,
299 		match_flag_dev_lo:1,
300 		match_flag_product:1,
301 		match_flag_vendor:1;
302 #endif
303 
304 	/* Used for product specific matches; the BCD range is inclusive */
305 	uint16_t idVendor;
306 	uint16_t idProduct;
307 	uint16_t bcdDevice_lo;
308 	uint16_t bcdDevice_hi;
309 
310 	/* Used for device class matches */
311 	uint8_t	bDeviceClass;
312 	uint8_t	bDeviceSubClass;
313 	uint8_t	bDeviceProtocol;
314 
315 	/* Used for interface class matches */
316 	uint8_t	bInterfaceClass;
317 	uint8_t	bInterfaceSubClass;
318 	uint8_t	bInterfaceProtocol;
319 
320 #if USB_HAVE_COMPAT_LINUX
321 	/* which fields to match against */
322 	uint16_t match_flags;
323 #define	USB_DEVICE_ID_MATCH_VENDOR		0x0001
324 #define	USB_DEVICE_ID_MATCH_PRODUCT		0x0002
325 #define	USB_DEVICE_ID_MATCH_DEV_LO		0x0004
326 #define	USB_DEVICE_ID_MATCH_DEV_HI		0x0008
327 #define	USB_DEVICE_ID_MATCH_DEV_CLASS		0x0010
328 #define	USB_DEVICE_ID_MATCH_DEV_SUBCLASS	0x0020
329 #define	USB_DEVICE_ID_MATCH_DEV_PROTOCOL	0x0040
330 #define	USB_DEVICE_ID_MATCH_INT_CLASS		0x0080
331 #define	USB_DEVICE_ID_MATCH_INT_SUBCLASS	0x0100
332 #define	USB_DEVICE_ID_MATCH_INT_PROTOCOL	0x0200
333 #endif
334 
335 	/* Hook for driver specific information */
336 	unsigned long driver_info;
337 } __aligned(32);
338 
339 #define USB_STD_PNP_INFO "M16:mask;U16:vendor;U16:product;L16:release;G16:release;" \
340 	"U8:devclass;U8:devsubclass;U8:devproto;" \
341 	"U8:intclass;U8:intsubclass;U8:intprotocol;"
342 #define USB_STD_PNP_HOST_INFO USB_STD_PNP_INFO "T:mode=host;"
343 #define USB_STD_PNP_DEVICE_INFO USB_STD_PNP_INFO "T:mode=device;"
344 #define USB_PNP_HOST_INFO(table)					\
345 	MODULE_PNP_INFO(USB_STD_PNP_HOST_INFO, uhub, table, table, sizeof(table[0]), \
346 	    sizeof(table) / sizeof(table[0]))
347 #define USB_PNP_DEVICE_INFO(table)					\
348 	MODULE_PNP_INFO(USB_STD_PNP_DEVICE_INFO, uhub, table, table, sizeof(table[0]), \
349 	    sizeof(table) / sizeof(table[0]))
350 #define USB_PNP_DUAL_INFO(table)					\
351 	MODULE_PNP_INFO(USB_STD_PNP_INFO, uhub, table, table, sizeof(table[0]), \
352 	    sizeof(table) / sizeof(table[0]))
353 
354 /* check that the size of the structure above is correct */
355 extern char usb_device_id_assert[(sizeof(struct usb_device_id) == 32) ? 1 : -1];
356 
357 #define	USB_VENDOR(vend)			\
358   .match_flag_vendor = 1, .idVendor = (vend)
359 
360 #define	USB_PRODUCT(prod)			\
361   .match_flag_product = 1, .idProduct = (prod)
362 
363 #define	USB_VP(vend,prod)			\
364   USB_VENDOR(vend), USB_PRODUCT(prod)
365 
366 #define	USB_VPI(vend,prod,info)			\
367   USB_VENDOR(vend), USB_PRODUCT(prod), USB_DRIVER_INFO(info)
368 
369 #define	USB_DEV_BCD_GTEQ(lo)	/* greater than or equal */ \
370   .match_flag_dev_lo = 1, .bcdDevice_lo = (lo)
371 
372 #define	USB_DEV_BCD_LTEQ(hi)	/* less than or equal */ \
373   .match_flag_dev_hi = 1, .bcdDevice_hi = (hi)
374 
375 #define	USB_DEV_CLASS(dc)			\
376   .match_flag_dev_class = 1, .bDeviceClass = (dc)
377 
378 #define	USB_DEV_SUBCLASS(dsc)			\
379   .match_flag_dev_subclass = 1, .bDeviceSubClass = (dsc)
380 
381 #define	USB_DEV_PROTOCOL(dp)			\
382   .match_flag_dev_protocol = 1, .bDeviceProtocol = (dp)
383 
384 #define	USB_IFACE_CLASS(ic)			\
385   .match_flag_int_class = 1, .bInterfaceClass = (ic)
386 
387 #define	USB_IFACE_SUBCLASS(isc)			\
388   .match_flag_int_subclass = 1, .bInterfaceSubClass = (isc)
389 
390 #define	USB_IFACE_PROTOCOL(ip)			\
391   .match_flag_int_protocol = 1, .bInterfaceProtocol = (ip)
392 
393 #define	USB_IF_CSI(class,subclass,info)			\
394   USB_IFACE_CLASS(class), USB_IFACE_SUBCLASS(subclass), USB_DRIVER_INFO(info)
395 
396 #define	USB_DRIVER_INFO(n)			\
397   .driver_info = (n)
398 
399 #define	USB_GET_DRIVER_INFO(did)		\
400   (did)->driver_info
401 
402 /*
403  * The following structure keeps information that is used to match
404  * against an array of "usb_device_id" elements.
405  */
406 struct usbd_lookup_info {
407 	uint16_t idVendor;
408 	uint16_t idProduct;
409 	uint16_t bcdDevice;
410 	uint8_t	bDeviceClass;
411 	uint8_t	bDeviceSubClass;
412 	uint8_t	bDeviceProtocol;
413 	uint8_t	bInterfaceClass;
414 	uint8_t	bInterfaceSubClass;
415 	uint8_t	bInterfaceProtocol;
416 	uint8_t	bIfaceIndex;
417 	uint8_t	bIfaceNum;
418 	uint8_t	bConfigIndex;
419 	uint8_t	bConfigNum;
420 };
421 
422 /* Structure used by probe and attach */
423 
424 struct usb_attach_arg {
425 	struct usbd_lookup_info info;
426 	device_t temp_dev;		/* for internal use */
427 	unsigned long driver_info;	/* for internal use */
428 	void *driver_ivar;
429 	struct usb_device *device;	/* current device */
430 	struct usb_interface *iface;	/* current interface */
431 	enum usb_hc_mode usb_mode;	/* host or device mode */
432 	uint8_t	port;
433 	uint8_t dev_state;
434 #define UAA_DEV_READY		0
435 #define UAA_DEV_DISABLED	1
436 #define UAA_DEV_EJECTING	2
437 };
438 
439 /*
440  * General purpose locking wrappers to ease supporting
441  * USB polled mode:
442  */
443 #ifdef INVARIANTS
444 #define	USB_MTX_ASSERT(_m, _t) do {		\
445 	if (!USB_IN_POLLING_MODE_FUNC())	\
446 		mtx_assert(_m, _t);		\
447 } while (0)
448 #else
449 #define	USB_MTX_ASSERT(_m, _t) do { } while (0)
450 #endif
451 
452 #define	USB_MTX_LOCK(_m) do {			\
453 	if (!USB_IN_POLLING_MODE_FUNC())	\
454 		mtx_lock(_m);			\
455 } while (0)
456 
457 #define	USB_MTX_UNLOCK(_m) do {			\
458 	if (!USB_IN_POLLING_MODE_FUNC())	\
459 		mtx_unlock(_m);			\
460 } while (0)
461 
462 #define	USB_MTX_LOCK_SPIN(_m) do {		\
463 	if (!USB_IN_POLLING_MODE_FUNC())	\
464 		mtx_lock_spin(_m);		\
465 } while (0)
466 
467 #define	USB_MTX_UNLOCK_SPIN(_m) do {		\
468 	if (!USB_IN_POLLING_MODE_FUNC())	\
469 		mtx_unlock_spin(_m);		\
470 } while (0)
471 
472 /*
473  * The following is a wrapper for the callout structure to ease
474  * porting the code to other platforms.
475  */
476 struct usb_callout {
477 	struct callout co;
478 };
479 #define	usb_callout_init_mtx(c,m,f) callout_init_mtx(&(c)->co,m,f)
480 #define	usb_callout_reset(c,...) do {			\
481 	if (!USB_IN_POLLING_MODE_FUNC())		\
482 		callout_reset(&(c)->co, __VA_ARGS__);	\
483 } while (0)
484 #define	usb_callout_reset_sbt(c,...) do {			\
485 	if (!USB_IN_POLLING_MODE_FUNC())			\
486 		callout_reset_sbt(&(c)->co, __VA_ARGS__);	\
487 } while (0)
488 #define	usb_callout_stop(c) do {			\
489 	if (!USB_IN_POLLING_MODE_FUNC()) {		\
490 		callout_stop(&(c)->co);			\
491 	} else {					\
492 		/*					\
493 		 * Cannot stop callout when		\
494 		 * polling. Set dummy callback		\
495 		 * function instead:			\
496 		 */					\
497 		(c)->co.c_func = &usbd_dummy_timeout;	\
498 	}						\
499 } while (0)
500 #define	usb_callout_drain(c) callout_drain(&(c)->co)
501 #define	usb_callout_pending(c) callout_pending(&(c)->co)
502 
503 /* USB transfer states */
504 
505 #define	USB_ST_SETUP       0
506 #define	USB_ST_TRANSFERRED 1
507 #define	USB_ST_ERROR       2
508 
509 /* USB handle request states */
510 #define	USB_HR_NOT_COMPLETE	0
511 #define	USB_HR_COMPLETE_OK	1
512 #define	USB_HR_COMPLETE_ERR	2
513 
514 /*
515  * The following macro will return the current state of an USB
516  * transfer like defined by the "USB_ST_XXX" enums.
517  */
518 #define	USB_GET_STATE(xfer) (usbd_xfer_state(xfer))
519 
520 /*
521  * The following structure defines the USB process message header.
522  */
523 struct usb_proc_msg {
524 	TAILQ_ENTRY(usb_proc_msg) pm_qentry;
525 	usb_proc_callback_t *pm_callback;
526 	usb_size_t pm_num;
527 };
528 
529 #define	USB_FIFO_TX 0
530 #define	USB_FIFO_RX 1
531 
532 /*
533  * Locking note for the following functions.  All the
534  * "usb_fifo_cmd_t" and "usb_fifo_filter_t" functions are called
535  * locked. The others are called unlocked.
536  */
537 struct usb_fifo_methods {
538 	usb_fifo_open_t *f_open;
539 	usb_fifo_close_t *f_close;
540 	usb_fifo_ioctl_t *f_ioctl;
541 	/*
542 	 * NOTE: The post-ioctl callback is called after the USB reference
543 	 * gets locked in the IOCTL handler:
544 	 */
545 	usb_fifo_ioctl_t *f_ioctl_post;
546 	usb_fifo_cmd_t *f_start_read;
547 	usb_fifo_cmd_t *f_stop_read;
548 	usb_fifo_cmd_t *f_start_write;
549 	usb_fifo_cmd_t *f_stop_write;
550 	usb_fifo_filter_t *f_filter_read;
551 	usb_fifo_filter_t *f_filter_write;
552 	const char *basename[4];
553 	const char *postfix[4];
554 };
555 
556 struct usb_fifo_sc {
557 	struct usb_fifo *fp[2];
558 	struct usb_fs_privdata *dev;
559 };
560 
561 const char *usbd_errstr(usb_error_t error);
562 void	*usbd_find_descriptor(struct usb_device *udev, void *id,
563 	    uint8_t iface_index, uint8_t type, uint8_t type_mask,
564 	    uint8_t subtype, uint8_t subtype_mask);
565 struct usb_config_descriptor *usbd_get_config_descriptor(
566 	    struct usb_device *udev);
567 struct usb_device_descriptor *usbd_get_device_descriptor(
568 	    struct usb_device *udev);
569 struct usb_interface *usbd_get_iface(struct usb_device *udev,
570 	    uint8_t iface_index);
571 struct usb_interface_descriptor *usbd_get_interface_descriptor(
572 	    struct usb_interface *iface);
573 struct usb_endpoint *usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
574 		    const struct usb_config *setup);
575 struct usb_endpoint *usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val);
576 usb_error_t	usbd_interface_count(struct usb_device *udev, uint8_t *count);
577 enum usb_hc_mode usbd_get_mode(struct usb_device *udev);
578 enum usb_dev_speed usbd_get_speed(struct usb_device *udev);
579 void	device_set_usb_desc(device_t dev);
580 void	usb_pause_mtx(struct mtx *mtx, int _ticks);
581 usb_error_t	usbd_set_pnpinfo(struct usb_device *udev,
582 			uint8_t iface_index, const char *pnpinfo);
583 usb_error_t	usbd_add_dynamic_quirk(struct usb_device *udev,
584 			uint16_t quirk);
585 usb_error_t	usbd_set_endpoint_mode(struct usb_device *udev,
586 			struct usb_endpoint *ep, uint8_t ep_mode);
587 uint8_t		usbd_get_endpoint_mode(struct usb_device *udev,
588 			struct usb_endpoint *ep);
589 
590 const struct usb_device_id *usbd_lookup_id_by_info(
591 	    const struct usb_device_id *id, usb_size_t sizeof_id,
592 	    const struct usbd_lookup_info *info);
593 int	usbd_lookup_id_by_uaa(const struct usb_device_id *id,
594 	    usb_size_t sizeof_id, struct usb_attach_arg *uaa);
595 
596 usb_error_t usbd_do_request_flags(struct usb_device *udev, struct mtx *mtx,
597 		    struct usb_device_request *req, void *data, uint16_t flags,
598 		    uint16_t *actlen, usb_timeout_t timeout);
599 #define	usbd_do_request(u,m,r,d) \
600   usbd_do_request_flags(u,m,r,d,0,NULL,USB_DEFAULT_TIMEOUT)
601 
602 uint8_t	usbd_clear_stall_callback(struct usb_xfer *xfer1,
603 	    struct usb_xfer *xfer2);
604 uint8_t	usbd_get_interface_altindex(struct usb_interface *iface);
605 usb_error_t usbd_set_alt_interface_index(struct usb_device *udev,
606 	    uint8_t iface_index, uint8_t alt_index);
607 uint32_t usbd_get_isoc_fps(struct usb_device *udev);
608 usb_error_t usbd_transfer_setup(struct usb_device *udev,
609 	    const uint8_t *ifaces, struct usb_xfer **pxfer,
610 	    const struct usb_config *setup_start, uint16_t n_setup,
611 	    void *priv_sc, struct mtx *priv_mtx);
612 void	usbd_transfer_submit(struct usb_xfer *xfer);
613 void	usbd_transfer_clear_stall(struct usb_xfer *xfer);
614 void	usbd_transfer_drain(struct usb_xfer *xfer);
615 uint8_t	usbd_transfer_pending(struct usb_xfer *xfer);
616 void	usbd_transfer_start(struct usb_xfer *xfer);
617 void	usbd_transfer_stop(struct usb_xfer *xfer);
618 void	usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup);
619 void	usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max);
620 void	usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
621 	    uint8_t parent_index);
622 uint8_t	usbd_get_bus_index(struct usb_device *udev);
623 uint8_t	usbd_get_device_index(struct usb_device *udev);
624 void	usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode);
625 uint8_t	usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode);
626 uint8_t	usbd_device_attached(struct usb_device *udev);
627 
628 usb_frlength_t
629 	usbd_xfer_old_frame_length(struct usb_xfer *xfer, usb_frcount_t frindex);
630 void	usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen,
631 	    int *aframes, int *nframes);
632 struct usb_page_cache *usbd_xfer_get_frame(struct usb_xfer *, usb_frcount_t);
633 void	*usbd_xfer_get_frame_buffer(struct usb_xfer *, usb_frcount_t);
634 void	*usbd_xfer_softc(struct usb_xfer *xfer);
635 void	*usbd_xfer_get_priv(struct usb_xfer *xfer);
636 void	usbd_xfer_set_priv(struct usb_xfer *xfer, void *);
637 void	usbd_xfer_set_interval(struct usb_xfer *xfer, int);
638 uint8_t	usbd_xfer_state(struct usb_xfer *xfer);
639 void	usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
640 	    void *ptr, usb_frlength_t len);
641 void	usbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
642 	    void **ptr, int *len);
643 void	usbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset,
644 	    usb_frcount_t frindex);
645 usb_frlength_t usbd_xfer_max_len(struct usb_xfer *xfer);
646 usb_frlength_t usbd_xfer_max_framelen(struct usb_xfer *xfer);
647 usb_frcount_t usbd_xfer_max_frames(struct usb_xfer *xfer);
648 uint8_t	usbd_xfer_get_fps_shift(struct usb_xfer *xfer);
649 usb_frlength_t usbd_xfer_frame_len(struct usb_xfer *xfer,
650 	    usb_frcount_t frindex);
651 void	usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex,
652 	    usb_frlength_t len);
653 void	usbd_xfer_set_timeout(struct usb_xfer *xfer, int timeout);
654 void	usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n);
655 void	usbd_xfer_set_stall(struct usb_xfer *xfer);
656 int	usbd_xfer_is_stalled(struct usb_xfer *xfer);
657 void	usbd_xfer_set_flag(struct usb_xfer *xfer, int flag);
658 void	usbd_xfer_clr_flag(struct usb_xfer *xfer, int flag);
659 uint16_t usbd_xfer_get_timestamp(struct usb_xfer *xfer);
660 uint8_t usbd_xfer_maxp_was_clamped(struct usb_xfer *xfer);
661 
662 void	usbd_copy_in(struct usb_page_cache *cache, usb_frlength_t offset,
663 	    const void *ptr, usb_frlength_t len);
664 int	usbd_copy_in_user(struct usb_page_cache *cache, usb_frlength_t offset,
665 	    const void *ptr, usb_frlength_t len);
666 void	usbd_copy_out(struct usb_page_cache *cache, usb_frlength_t offset,
667 	    void *ptr, usb_frlength_t len);
668 int	usbd_copy_out_user(struct usb_page_cache *cache, usb_frlength_t offset,
669 	    void *ptr, usb_frlength_t len);
670 void	usbd_get_page(struct usb_page_cache *pc, usb_frlength_t offset,
671 	    struct usb_page_search *res);
672 void	usbd_m_copy_in(struct usb_page_cache *cache, usb_frlength_t dst_offset,
673 	    struct mbuf *m, usb_size_t src_offset, usb_frlength_t src_len);
674 void	usbd_frame_zero(struct usb_page_cache *cache, usb_frlength_t offset,
675 	    usb_frlength_t len);
676 void	usbd_start_re_enumerate(struct usb_device *udev);
677 usb_error_t
678 	usbd_start_set_config(struct usb_device *, uint8_t);
679 int	usbd_in_polling_mode(void);
680 void	usbd_dummy_timeout(void *);
681 
682 int	usb_fifo_attach(struct usb_device *udev, void *priv_sc,
683 	    struct mtx *priv_mtx, struct usb_fifo_methods *pm,
684 	    struct usb_fifo_sc *f_sc, uint16_t unit, int16_t subunit,
685 	    uint8_t iface_index, uid_t uid, gid_t gid, int mode);
686 void	usb_fifo_detach(struct usb_fifo_sc *f_sc);
687 int	usb_fifo_alloc_buffer(struct usb_fifo *f, uint32_t bufsize,
688 	    uint16_t nbuf);
689 void	usb_fifo_free_buffer(struct usb_fifo *f);
690 uint32_t usb_fifo_put_bytes_max(struct usb_fifo *fifo);
691 void	usb_fifo_put_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
692 	    usb_frlength_t offset, usb_frlength_t len, uint8_t what);
693 void	usb_fifo_put_data_linear(struct usb_fifo *fifo, void *ptr,
694 	    usb_size_t len, uint8_t what);
695 uint8_t	usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len);
696 void	usb_fifo_put_data_error(struct usb_fifo *fifo);
697 uint8_t	usb_fifo_get_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
698 	    usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen,
699 	    uint8_t what);
700 uint8_t	usb_fifo_get_data_linear(struct usb_fifo *fifo, void *ptr,
701 	    usb_size_t len, usb_size_t *actlen, uint8_t what);
702 uint8_t	usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr,
703 	    usb_size_t *plen);
704 void	usb_fifo_reset(struct usb_fifo *f);
705 void	usb_fifo_wakeup(struct usb_fifo *f);
706 void	usb_fifo_get_data_error(struct usb_fifo *fifo);
707 void	*usb_fifo_softc(struct usb_fifo *fifo);
708 void	usb_fifo_set_close_zlp(struct usb_fifo *, uint8_t);
709 void	usb_fifo_set_write_defrag(struct usb_fifo *, uint8_t);
710 void	usb_fifo_free(struct usb_fifo *f);
711 #endif /* _KERNEL */
712 #endif /* _USB_USBDI_H_ */
713