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