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