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