xref: /freebsd/sys/dev/usb/usbdi.h (revision eb6d21b4ca6d668cf89afd99eef7baeafa712197)
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 
134 	uint8_t	toggle_next:1;		/* next data toggle value */
135 	uint8_t	is_stalled:1;		/* set if endpoint is stalled */
136 	uint8_t	is_synced:1;		/* set if we a synchronised */
137 	uint8_t	unused:5;
138 	uint8_t	iface_index;		/* not used by "default endpoint" */
139 
140 	uint8_t refcount_alloc;		/* allocation refcount */
141 	uint8_t refcount_bw;		/* bandwidth refcount */
142 #define	USB_EP_REF_MAX 0x3f
143 
144 	/* High-Speed resource allocation (valid if "refcount_bw" > 0) */
145 
146 	uint8_t	usb_smask;		/* USB start mask */
147 	uint8_t	usb_cmask;		/* USB complete mask */
148 	uint8_t	usb_uframe;		/* USB microframe */
149 };
150 
151 /*
152  * The following structure defines an USB interface.
153  */
154 struct usb_interface {
155 	struct usb_interface_descriptor *idesc;
156 	device_t subdev;
157 	uint8_t	alt_index;
158 	uint8_t	parent_iface_index;
159 
160 	/* Linux compat */
161 	struct usb_host_interface *altsetting;
162 	struct usb_host_interface *cur_altsetting;
163 	struct usb_device *linux_udev;
164 	void   *bsd_priv_sc;		/* device specific information */
165 	uint8_t	num_altsetting;		/* number of alternate settings */
166 	uint8_t	bsd_iface_index;
167 };
168 
169 /*
170  * The following structure defines a set of USB transfer flags.
171  */
172 struct usb_xfer_flags {
173 	uint8_t	force_short_xfer:1;	/* force a short transmit transfer
174 					 * last */
175 	uint8_t	short_xfer_ok:1;	/* allow short receive transfers */
176 	uint8_t	short_frames_ok:1;	/* allow short frames */
177 	uint8_t	pipe_bof:1;		/* block pipe on failure */
178 	uint8_t	proxy_buffer:1;		/* makes buffer size a factor of
179 					 * "max_frame_size" */
180 	uint8_t	ext_buffer:1;		/* uses external DMA buffer */
181 	uint8_t	manual_status:1;	/* non automatic status stage on
182 					 * control transfers */
183 	uint8_t	no_pipe_ok:1;		/* set if "USB_ERR_NO_PIPE" error can
184 					 * be ignored */
185 	uint8_t	stall_pipe:1;		/* set if the endpoint belonging to
186 					 * this USB transfer should be stalled
187 					 * before starting this transfer! */
188 };
189 
190 /*
191  * The following structure define an USB configuration, that basically
192  * is used when setting up an USB transfer.
193  */
194 struct usb_config {
195 	usb_callback_t *callback;	/* USB transfer callback */
196 	usb_frlength_t bufsize;	/* total pipe buffer size in bytes */
197 	usb_frcount_t frames;		/* maximum number of USB frames */
198 	usb_timeout_t interval;	/* interval in milliseconds */
199 #define	USB_DEFAULT_INTERVAL	0
200 	usb_timeout_t timeout;		/* transfer timeout in milliseconds */
201 	struct usb_xfer_flags flags;	/* transfer flags */
202 	enum usb_hc_mode usb_mode;	/* host or device mode */
203 	uint8_t	type;			/* pipe type */
204 	uint8_t	endpoint;		/* pipe number */
205 	uint8_t	direction;		/* pipe direction */
206 	uint8_t	ep_index;		/* pipe index match to use */
207 	uint8_t	if_index;		/* "ifaces" index to use */
208 };
209 
210 /*
211  * The following structure is used when looking up an USB driver for
212  * an USB device. It is inspired by the Linux structure called
213  * "usb_device_id".
214  */
215 struct usb_device_id {
216 
217 	/* Hook for driver specific information */
218 	unsigned long driver_info;
219 
220 	/* Used for product specific matches; the BCD range is inclusive */
221 	uint16_t idVendor;
222 	uint16_t idProduct;
223 	uint16_t bcdDevice_lo;
224 	uint16_t bcdDevice_hi;
225 
226 	/* Used for device class matches */
227 	uint8_t	bDeviceClass;
228 	uint8_t	bDeviceSubClass;
229 	uint8_t	bDeviceProtocol;
230 
231 	/* Used for interface class matches */
232 	uint8_t	bInterfaceClass;
233 	uint8_t	bInterfaceSubClass;
234 	uint8_t	bInterfaceProtocol;
235 
236 	/* Select which fields to match against */
237 	uint8_t	match_flag_vendor:1;
238 	uint8_t	match_flag_product:1;
239 	uint8_t	match_flag_dev_lo:1;
240 	uint8_t	match_flag_dev_hi:1;
241 	uint8_t	match_flag_dev_class:1;
242 	uint8_t	match_flag_dev_subclass:1;
243 	uint8_t	match_flag_dev_protocol:1;
244 	uint8_t	match_flag_int_class:1;
245 	uint8_t	match_flag_int_subclass:1;
246 	uint8_t	match_flag_int_protocol:1;
247 
248 #if USB_HAVE_COMPAT_LINUX
249 	/* which fields to match against */
250 	uint16_t match_flags;
251 #define	USB_DEVICE_ID_MATCH_VENDOR		0x0001
252 #define	USB_DEVICE_ID_MATCH_PRODUCT		0x0002
253 #define	USB_DEVICE_ID_MATCH_DEV_LO		0x0004
254 #define	USB_DEVICE_ID_MATCH_DEV_HI		0x0008
255 #define	USB_DEVICE_ID_MATCH_DEV_CLASS		0x0010
256 #define	USB_DEVICE_ID_MATCH_DEV_SUBCLASS	0x0020
257 #define	USB_DEVICE_ID_MATCH_DEV_PROTOCOL	0x0040
258 #define	USB_DEVICE_ID_MATCH_INT_CLASS		0x0080
259 #define	USB_DEVICE_ID_MATCH_INT_SUBCLASS	0x0100
260 #define	USB_DEVICE_ID_MATCH_INT_PROTOCOL	0x0200
261 #endif
262 };
263 
264 #define	USB_VENDOR(vend)			\
265   .match_flag_vendor = 1, .idVendor = (vend)
266 
267 #define	USB_PRODUCT(prod)			\
268   .match_flag_product = 1, .idProduct = (prod)
269 
270 #define	USB_VP(vend,prod)			\
271   USB_VENDOR(vend), USB_PRODUCT(prod)
272 
273 #define	USB_VPI(vend,prod,info)			\
274   USB_VENDOR(vend), USB_PRODUCT(prod), USB_DRIVER_INFO(info)
275 
276 #define	USB_DEV_BCD_GTEQ(lo)	/* greater than or equal */ \
277   .match_flag_dev_lo = 1, .bcdDevice_lo = (lo)
278 
279 #define	USB_DEV_BCD_LTEQ(hi)	/* less than or equal */ \
280   .match_flag_dev_hi = 1, .bcdDevice_hi = (hi)
281 
282 #define	USB_DEV_CLASS(dc)			\
283   .match_flag_dev_class = 1, .bDeviceClass = (dc)
284 
285 #define	USB_DEV_SUBCLASS(dsc)			\
286   .match_flag_dev_subclass = 1, .bDeviceSubClass = (dsc)
287 
288 #define	USB_DEV_PROTOCOL(dp)			\
289   .match_flag_dev_protocol = 1, .bDeviceProtocol = (dp)
290 
291 #define	USB_IFACE_CLASS(ic)			\
292   .match_flag_int_class = 1, .bInterfaceClass = (ic)
293 
294 #define	USB_IFACE_SUBCLASS(isc)			\
295   .match_flag_int_subclass = 1, .bInterfaceSubClass = (isc)
296 
297 #define	USB_IFACE_PROTOCOL(ip)			\
298   .match_flag_int_protocol = 1, .bInterfaceProtocol = (ip)
299 
300 #define	USB_IF_CSI(class,subclass,info)			\
301   USB_IFACE_CLASS(class), USB_IFACE_SUBCLASS(subclass), USB_DRIVER_INFO(info)
302 
303 #define	USB_DRIVER_INFO(n)			\
304   .driver_info = (n)
305 
306 #define	USB_GET_DRIVER_INFO(did)		\
307   (did)->driver_info
308 
309 /*
310  * The following structure keeps information that is used to match
311  * against an array of "usb_device_id" elements.
312  */
313 struct usbd_lookup_info {
314 	uint16_t idVendor;
315 	uint16_t idProduct;
316 	uint16_t bcdDevice;
317 	uint8_t	bDeviceClass;
318 	uint8_t	bDeviceSubClass;
319 	uint8_t	bDeviceProtocol;
320 	uint8_t	bInterfaceClass;
321 	uint8_t	bInterfaceSubClass;
322 	uint8_t	bInterfaceProtocol;
323 	uint8_t	bIfaceIndex;
324 	uint8_t	bIfaceNum;
325 	uint8_t	bConfigIndex;
326 	uint8_t	bConfigNum;
327 };
328 
329 /* Structure used by probe and attach */
330 
331 struct usb_attach_arg {
332 	struct usbd_lookup_info info;
333 	device_t temp_dev;		/* for internal use */
334 	unsigned long driver_info;	/* for internal use */
335 	void *driver_ivar;
336 	struct usb_device *device;	/* current device */
337 	struct usb_interface *iface;	/* current interface */
338 	enum usb_hc_mode usb_mode;	/* host or device mode */
339 	uint8_t	port;
340 	uint8_t	use_generic;		/* hint for generic drivers */
341 };
342 
343 /*
344  * The following is a wrapper for the callout structure to ease
345  * porting the code to other platforms.
346  */
347 struct usb_callout {
348 	struct callout co;
349 };
350 #define	usb_callout_init_mtx(c,m,f) callout_init_mtx(&(c)->co,m,f)
351 #define	usb_callout_reset(c,t,f,d) callout_reset(&(c)->co,t,f,d)
352 #define	usb_callout_stop(c) callout_stop(&(c)->co)
353 #define	usb_callout_drain(c) callout_drain(&(c)->co)
354 #define	usb_callout_pending(c) callout_pending(&(c)->co)
355 
356 /* USB transfer states */
357 
358 #define	USB_ST_SETUP       0
359 #define	USB_ST_TRANSFERRED 1
360 #define	USB_ST_ERROR       2
361 
362 /* USB handle request states */
363 #define	USB_HR_NOT_COMPLETE	0
364 #define	USB_HR_COMPLETE_OK	1
365 #define	USB_HR_COMPLETE_ERR	2
366 
367 /*
368  * The following macro will return the current state of an USB
369  * transfer like defined by the "USB_ST_XXX" enums.
370  */
371 #define	USB_GET_STATE(xfer) (usbd_xfer_state(xfer))
372 
373 /*
374  * The following structure defines the USB process message header.
375  */
376 struct usb_proc_msg {
377 	TAILQ_ENTRY(usb_proc_msg) pm_qentry;
378 	usb_proc_callback_t *pm_callback;
379 	usb_size_t pm_num;
380 };
381 
382 #define	USB_FIFO_TX 0
383 #define	USB_FIFO_RX 1
384 
385 /*
386  * Locking note for the following functions.  All the
387  * "usb_fifo_cmd_t" and "usb_fifo_filter_t" functions are called
388  * locked. The others are called unlocked.
389  */
390 struct usb_fifo_methods {
391 	usb_fifo_open_t *f_open;
392 	usb_fifo_close_t *f_close;
393 	usb_fifo_ioctl_t *f_ioctl;
394 	/*
395 	 * NOTE: The post-ioctl callback is called after the USB reference
396 	 * gets locked in the IOCTL handler:
397 	 */
398 	usb_fifo_ioctl_t *f_ioctl_post;
399 	usb_fifo_cmd_t *f_start_read;
400 	usb_fifo_cmd_t *f_stop_read;
401 	usb_fifo_cmd_t *f_start_write;
402 	usb_fifo_cmd_t *f_stop_write;
403 	usb_fifo_filter_t *f_filter_read;
404 	usb_fifo_filter_t *f_filter_write;
405 	const char *basename[4];
406 	const char *postfix[4];
407 };
408 
409 struct usb_fifo_sc {
410 	struct usb_fifo *fp[2];
411 	struct cdev* dev;
412 };
413 
414 const char *usbd_errstr(usb_error_t error);
415 void	*usbd_find_descriptor(struct usb_device *udev, void *id,
416 	    uint8_t iface_index, uint8_t type, uint8_t type_mask,
417 	    uint8_t subtype, uint8_t subtype_mask);
418 struct usb_config_descriptor *usbd_get_config_descriptor(
419 	    struct usb_device *udev);
420 struct usb_device_descriptor *usbd_get_device_descriptor(
421 	    struct usb_device *udev);
422 struct usb_interface *usbd_get_iface(struct usb_device *udev,
423 	    uint8_t iface_index);
424 struct usb_interface_descriptor *usbd_get_interface_descriptor(
425 	    struct usb_interface *iface);
426 struct usb_endpoint *usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
427 		    const struct usb_config *setup);
428 struct usb_endpoint *usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val);
429 usb_error_t	usbd_interface_count(struct usb_device *udev, uint8_t *count);
430 enum usb_hc_mode usbd_get_mode(struct usb_device *udev);
431 enum usb_dev_speed usbd_get_speed(struct usb_device *udev);
432 void	device_set_usb_desc(device_t dev);
433 void	usb_pause_mtx(struct mtx *mtx, int _ticks);
434 
435 const struct usb_device_id *usbd_lookup_id_by_info(
436 	    const struct usb_device_id *id, usb_size_t sizeof_id,
437 	    const struct usbd_lookup_info *info);
438 int	usbd_lookup_id_by_uaa(const struct usb_device_id *id,
439 	    usb_size_t sizeof_id, struct usb_attach_arg *uaa);
440 
441 usb_error_t usbd_do_request_flags(struct usb_device *udev, struct mtx *mtx,
442 		    struct usb_device_request *req, void *data, uint16_t flags,
443 		    uint16_t *actlen, usb_timeout_t timeout);
444 #define	usbd_do_request(u,m,r,d) \
445   usbd_do_request_flags(u,m,r,d,0,NULL,USB_DEFAULT_TIMEOUT)
446 
447 uint8_t	usbd_clear_stall_callback(struct usb_xfer *xfer1,
448 	    struct usb_xfer *xfer2);
449 uint8_t	usbd_get_interface_altindex(struct usb_interface *iface);
450 usb_error_t usbd_set_alt_interface_index(struct usb_device *udev,
451 	    uint8_t iface_index, uint8_t alt_index);
452 uint32_t usbd_get_isoc_fps(struct usb_device *udev);
453 usb_error_t usbd_transfer_setup(struct usb_device *udev,
454 	    const uint8_t *ifaces, struct usb_xfer **pxfer,
455 	    const struct usb_config *setup_start, uint16_t n_setup,
456 	    void *priv_sc, struct mtx *priv_mtx);
457 void	usbd_transfer_submit(struct usb_xfer *xfer);
458 void	usbd_transfer_clear_stall(struct usb_xfer *xfer);
459 void	usbd_transfer_drain(struct usb_xfer *xfer);
460 uint8_t	usbd_transfer_pending(struct usb_xfer *xfer);
461 void	usbd_transfer_start(struct usb_xfer *xfer);
462 void	usbd_transfer_stop(struct usb_xfer *xfer);
463 void	usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup);
464 void	usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max);
465 void	usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
466 	    uint8_t parent_index);
467 uint8_t	usbd_get_bus_index(struct usb_device *udev);
468 uint8_t	usbd_get_device_index(struct usb_device *udev);
469 void	usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode);
470 uint8_t	usbd_device_attached(struct usb_device *udev);
471 
472 void	usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen,
473 	    int *aframes, int *nframes);
474 struct usb_page_cache *usbd_xfer_get_frame(struct usb_xfer *xfer,
475 	    usb_frcount_t frindex);
476 void	*usbd_xfer_softc(struct usb_xfer *xfer);
477 void	*usbd_xfer_get_priv(struct usb_xfer *xfer);
478 void	usbd_xfer_set_priv(struct usb_xfer *xfer, void *);
479 void	usbd_xfer_set_interval(struct usb_xfer *xfer, int);
480 uint8_t	usbd_xfer_state(struct usb_xfer *xfer);
481 void	usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
482 	    void *ptr, usb_frlength_t len);
483 void	usbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
484 	    void **ptr, int *len);
485 void	usbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset,
486 	    usb_frcount_t frindex);
487 usb_frlength_t usbd_xfer_max_len(struct usb_xfer *xfer);
488 usb_frlength_t usbd_xfer_max_framelen(struct usb_xfer *xfer);
489 usb_frcount_t usbd_xfer_max_frames(struct usb_xfer *xfer);
490 uint8_t	usbd_xfer_get_fps_shift(struct usb_xfer *xfer);
491 usb_frlength_t usbd_xfer_frame_len(struct usb_xfer *xfer,
492 	    usb_frcount_t frindex);
493 void	usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex,
494 	    usb_frlength_t len);
495 void	usbd_xfer_set_timeout(struct usb_xfer *xfer, int timeout);
496 void	usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n);
497 void	usbd_xfer_set_stall(struct usb_xfer *xfer);
498 int	usbd_xfer_is_stalled(struct usb_xfer *xfer);
499 void	usbd_xfer_set_flag(struct usb_xfer *xfer, int flag);
500 void	usbd_xfer_clr_flag(struct usb_xfer *xfer, int flag);
501 uint16_t usbd_xfer_get_timestamp(struct usb_xfer *xfer);
502 
503 void	usbd_copy_in(struct usb_page_cache *cache, usb_frlength_t offset,
504 	    const void *ptr, usb_frlength_t len);
505 int	usbd_copy_in_user(struct usb_page_cache *cache, usb_frlength_t offset,
506 	    const void *ptr, usb_frlength_t len);
507 void	usbd_copy_out(struct usb_page_cache *cache, usb_frlength_t offset,
508 	    void *ptr, usb_frlength_t len);
509 int	usbd_copy_out_user(struct usb_page_cache *cache, usb_frlength_t offset,
510 	    void *ptr, usb_frlength_t len);
511 void	usbd_get_page(struct usb_page_cache *pc, usb_frlength_t offset,
512 	    struct usb_page_search *res);
513 void	usbd_m_copy_in(struct usb_page_cache *cache, usb_frlength_t dst_offset,
514 	    struct mbuf *m, usb_size_t src_offset, usb_frlength_t src_len);
515 void	usbd_frame_zero(struct usb_page_cache *cache, usb_frlength_t offset,
516 	    usb_frlength_t len);
517 
518 int	usb_fifo_attach(struct usb_device *udev, void *priv_sc,
519 	    struct mtx *priv_mtx, struct usb_fifo_methods *pm,
520 	    struct usb_fifo_sc *f_sc, uint16_t unit, uint16_t subunit,
521 	    uint8_t iface_index, uid_t uid, gid_t gid, int mode);
522 void	usb_fifo_detach(struct usb_fifo_sc *f_sc);
523 int	usb_fifo_alloc_buffer(struct usb_fifo *f, uint32_t bufsize,
524 	    uint16_t nbuf);
525 void	usb_fifo_free_buffer(struct usb_fifo *f);
526 uint32_t usb_fifo_put_bytes_max(struct usb_fifo *fifo);
527 void	usb_fifo_put_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
528 	    usb_frlength_t offset, usb_frlength_t len, uint8_t what);
529 void	usb_fifo_put_data_linear(struct usb_fifo *fifo, void *ptr,
530 	    usb_size_t len, uint8_t what);
531 uint8_t	usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len);
532 void	usb_fifo_put_data_error(struct usb_fifo *fifo);
533 uint8_t	usb_fifo_get_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
534 	    usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen,
535 	    uint8_t what);
536 uint8_t	usb_fifo_get_data_linear(struct usb_fifo *fifo, void *ptr,
537 	    usb_size_t len, usb_size_t *actlen, uint8_t what);
538 uint8_t	usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr,
539 	    usb_size_t *plen);
540 void	usb_fifo_reset(struct usb_fifo *f);
541 void	usb_fifo_wakeup(struct usb_fifo *f);
542 void	usb_fifo_get_data_error(struct usb_fifo *fifo);
543 void	*usb_fifo_softc(struct usb_fifo *fifo);
544 void	usb_fifo_set_close_zlp(struct usb_fifo *, uint8_t);
545 void	usb_fifo_set_write_defrag(struct usb_fifo *, uint8_t);
546 void	usb_fifo_free(struct usb_fifo *f);
547 #endif /* _KERNEL */
548 #endif /* _USB_USBDI_H_ */
549