2 * Copyright (c) 2009 Andrew Thompson
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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.
32 struct usb_attach_arg;
35 struct usb_page_cache;
36 struct usb_page_search;
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 */
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 */
85 #define USB_NO_TIMEOUT 0
86 #define USB_DEFAULT_TIMEOUT 5000 /* 5000 ms = 5 seconds */
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 *);
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);
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);
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
114 #define USB_MS_HZ 1024
116 #define USB_MS_TO_TICKS(ms) \
117 (((uint32_t)((((uint32_t)(ms)) * ((uint32_t)(hz))) + USB_MS_HZ - 1)) / USB_MS_HZ)
120 * Common queue structure for USB transfers.
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);
131 * The following structure defines an USB endpoint
134 struct usb_endpoint {
135 struct usb_xfer_queue endpoint_q; /* queue of USB transfers */
137 struct usb_endpoint_descriptor *edesc;
138 struct usb_endpoint_ss_comp_descriptor *ecomp;
139 struct usb_pipe_methods *methods; /* set by HC driver */
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 */
147 uint8_t iface_index; /* not used by "default endpoint" */
149 uint8_t refcount_alloc; /* allocation refcount */
150 uint8_t refcount_bw; /* bandwidth refcount */
151 #define USB_EP_REF_MAX 0x3f
153 /* High-Speed resource allocation (valid if "refcount_bw" > 0) */
155 uint8_t usb_smask; /* USB start mask */
156 uint8_t usb_cmask; /* USB complete mask */
157 uint8_t usb_uframe; /* USB microframe */
161 * The following structure defines an USB interface.
163 struct usb_interface {
164 struct usb_interface_descriptor *idesc;
167 uint8_t parent_iface_index;
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;
180 * The following structure defines a set of USB transfer flags.
182 struct usb_xfer_flags {
183 uint8_t force_short_xfer:1; /* force a short transmit transfer
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
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 uint8_t pre_scale_frames:1; /* "usb_config->frames" is
199 * assumed to give the
201 * milliseconds and is
202 * converted into the nearest
203 * number of frames when the
204 * USB transfer is setup. This
205 * option only has effect for
206 * ISOCHRONOUS transfers.
211 * The following structure define an USB configuration, that basically
212 * is used when setting up an USB transfer.
215 usb_callback_t *callback; /* USB transfer callback */
216 usb_frlength_t bufsize; /* total pipe buffer size in bytes */
217 usb_frcount_t frames; /* maximum number of USB frames */
218 usb_timeout_t interval; /* interval in milliseconds */
219 #define USB_DEFAULT_INTERVAL 0
220 usb_timeout_t timeout; /* transfer timeout in milliseconds */
221 struct usb_xfer_flags flags; /* transfer flags */
222 enum usb_hc_mode usb_mode; /* host or device mode */
223 uint8_t type; /* pipe type */
224 uint8_t endpoint; /* pipe number */
225 uint8_t direction; /* pipe direction */
226 uint8_t ep_index; /* pipe index match to use */
227 uint8_t if_index; /* "ifaces" index to use */
231 * Use these macro when defining USB device ID arrays if you want to
232 * have your driver module automatically loaded in host, device or
233 * both modes respectivly:
235 #define STRUCT_USB_HOST_ID \
236 struct usb_device_id __section("usb_host_id")
237 #define STRUCT_USB_DEVICE_ID \
238 struct usb_device_id __section("usb_device_id")
239 #define STRUCT_USB_DUAL_ID \
240 struct usb_device_id __section("usb_dual_id")
243 * The following structure is used when looking up an USB driver for
244 * an USB device. It is inspired by the Linux structure called
247 struct usb_device_id {
249 /* Hook for driver specific information */
250 unsigned long driver_info;
252 /* Used for product specific matches; the BCD range is inclusive */
255 uint16_t bcdDevice_lo;
256 uint16_t bcdDevice_hi;
258 /* Used for device class matches */
259 uint8_t bDeviceClass;
260 uint8_t bDeviceSubClass;
261 uint8_t bDeviceProtocol;
263 /* Used for interface class matches */
264 uint8_t bInterfaceClass;
265 uint8_t bInterfaceSubClass;
266 uint8_t bInterfaceProtocol;
268 /* Select which fields to match against */
269 uint8_t match_flag_vendor:1;
270 uint8_t match_flag_product:1;
271 uint8_t match_flag_dev_lo:1;
272 uint8_t match_flag_dev_hi:1;
274 uint8_t match_flag_dev_class:1;
275 uint8_t match_flag_dev_subclass:1;
276 uint8_t match_flag_dev_protocol:1;
277 uint8_t match_flag_int_class:1;
279 uint8_t match_flag_int_subclass:1;
280 uint8_t match_flag_int_protocol:1;
281 uint8_t match_flag_unused:6;
283 #if USB_HAVE_COMPAT_LINUX
284 /* which fields to match against */
285 uint16_t match_flags;
286 #define USB_DEVICE_ID_MATCH_VENDOR 0x0001
287 #define USB_DEVICE_ID_MATCH_PRODUCT 0x0002
288 #define USB_DEVICE_ID_MATCH_DEV_LO 0x0004
289 #define USB_DEVICE_ID_MATCH_DEV_HI 0x0008
290 #define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010
291 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020
292 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040
293 #define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080
294 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100
295 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200
299 /* check that the size of the structure above is correct */
300 extern char usb_device_id_assert[(sizeof(struct usb_device_id) == 32) ? 1 : -1];
302 #define USB_VENDOR(vend) \
303 .match_flag_vendor = 1, .idVendor = (vend)
305 #define USB_PRODUCT(prod) \
306 .match_flag_product = 1, .idProduct = (prod)
308 #define USB_VP(vend,prod) \
309 USB_VENDOR(vend), USB_PRODUCT(prod)
311 #define USB_VPI(vend,prod,info) \
312 USB_VENDOR(vend), USB_PRODUCT(prod), USB_DRIVER_INFO(info)
314 #define USB_DEV_BCD_GTEQ(lo) /* greater than or equal */ \
315 .match_flag_dev_lo = 1, .bcdDevice_lo = (lo)
317 #define USB_DEV_BCD_LTEQ(hi) /* less than or equal */ \
318 .match_flag_dev_hi = 1, .bcdDevice_hi = (hi)
320 #define USB_DEV_CLASS(dc) \
321 .match_flag_dev_class = 1, .bDeviceClass = (dc)
323 #define USB_DEV_SUBCLASS(dsc) \
324 .match_flag_dev_subclass = 1, .bDeviceSubClass = (dsc)
326 #define USB_DEV_PROTOCOL(dp) \
327 .match_flag_dev_protocol = 1, .bDeviceProtocol = (dp)
329 #define USB_IFACE_CLASS(ic) \
330 .match_flag_int_class = 1, .bInterfaceClass = (ic)
332 #define USB_IFACE_SUBCLASS(isc) \
333 .match_flag_int_subclass = 1, .bInterfaceSubClass = (isc)
335 #define USB_IFACE_PROTOCOL(ip) \
336 .match_flag_int_protocol = 1, .bInterfaceProtocol = (ip)
338 #define USB_IF_CSI(class,subclass,info) \
339 USB_IFACE_CLASS(class), USB_IFACE_SUBCLASS(subclass), USB_DRIVER_INFO(info)
341 #define USB_DRIVER_INFO(n) \
344 #define USB_GET_DRIVER_INFO(did) \
348 * The following structure keeps information that is used to match
349 * against an array of "usb_device_id" elements.
351 struct usbd_lookup_info {
355 uint8_t bDeviceClass;
356 uint8_t bDeviceSubClass;
357 uint8_t bDeviceProtocol;
358 uint8_t bInterfaceClass;
359 uint8_t bInterfaceSubClass;
360 uint8_t bInterfaceProtocol;
363 uint8_t bConfigIndex;
367 /* Structure used by probe and attach */
369 struct usb_attach_arg {
370 struct usbd_lookup_info info;
371 device_t temp_dev; /* for internal use */
372 unsigned long driver_info; /* for internal use */
374 struct usb_device *device; /* current device */
375 struct usb_interface *iface; /* current interface */
376 enum usb_hc_mode usb_mode; /* host or device mode */
379 #define UAA_DEV_READY 0
380 #define UAA_DEV_DISABLED 1
381 #define UAA_DEV_EJECTING 2
385 * The following is a wrapper for the callout structure to ease
386 * porting the code to other platforms.
391 #define usb_callout_init_mtx(c,m,f) callout_init_mtx(&(c)->co,m,f)
392 #define usb_callout_reset(c,t,f,d) callout_reset(&(c)->co,t,f,d)
393 #define usb_callout_stop(c) callout_stop(&(c)->co)
394 #define usb_callout_drain(c) callout_drain(&(c)->co)
395 #define usb_callout_pending(c) callout_pending(&(c)->co)
397 /* USB transfer states */
399 #define USB_ST_SETUP 0
400 #define USB_ST_TRANSFERRED 1
401 #define USB_ST_ERROR 2
403 /* USB handle request states */
404 #define USB_HR_NOT_COMPLETE 0
405 #define USB_HR_COMPLETE_OK 1
406 #define USB_HR_COMPLETE_ERR 2
409 * The following macro will return the current state of an USB
410 * transfer like defined by the "USB_ST_XXX" enums.
412 #define USB_GET_STATE(xfer) (usbd_xfer_state(xfer))
415 * The following structure defines the USB process message header.
417 struct usb_proc_msg {
418 TAILQ_ENTRY(usb_proc_msg) pm_qentry;
419 usb_proc_callback_t *pm_callback;
423 #define USB_FIFO_TX 0
424 #define USB_FIFO_RX 1
427 * Locking note for the following functions. All the
428 * "usb_fifo_cmd_t" and "usb_fifo_filter_t" functions are called
429 * locked. The others are called unlocked.
431 struct usb_fifo_methods {
432 usb_fifo_open_t *f_open;
433 usb_fifo_close_t *f_close;
434 usb_fifo_ioctl_t *f_ioctl;
436 * NOTE: The post-ioctl callback is called after the USB reference
437 * gets locked in the IOCTL handler:
439 usb_fifo_ioctl_t *f_ioctl_post;
440 usb_fifo_cmd_t *f_start_read;
441 usb_fifo_cmd_t *f_stop_read;
442 usb_fifo_cmd_t *f_start_write;
443 usb_fifo_cmd_t *f_stop_write;
444 usb_fifo_filter_t *f_filter_read;
445 usb_fifo_filter_t *f_filter_write;
446 const char *basename[4];
447 const char *postfix[4];
451 struct usb_fifo *fp[2];
455 const char *usbd_errstr(usb_error_t error);
456 void *usbd_find_descriptor(struct usb_device *udev, void *id,
457 uint8_t iface_index, uint8_t type, uint8_t type_mask,
458 uint8_t subtype, uint8_t subtype_mask);
459 struct usb_config_descriptor *usbd_get_config_descriptor(
460 struct usb_device *udev);
461 struct usb_device_descriptor *usbd_get_device_descriptor(
462 struct usb_device *udev);
463 struct usb_interface *usbd_get_iface(struct usb_device *udev,
464 uint8_t iface_index);
465 struct usb_interface_descriptor *usbd_get_interface_descriptor(
466 struct usb_interface *iface);
467 struct usb_endpoint *usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
468 const struct usb_config *setup);
469 struct usb_endpoint *usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val);
470 usb_error_t usbd_interface_count(struct usb_device *udev, uint8_t *count);
471 enum usb_hc_mode usbd_get_mode(struct usb_device *udev);
472 enum usb_dev_speed usbd_get_speed(struct usb_device *udev);
473 void device_set_usb_desc(device_t dev);
474 void usb_pause_mtx(struct mtx *mtx, int _ticks);
475 usb_error_t usbd_set_pnpinfo(struct usb_device *udev,
476 uint8_t iface_index, const char *pnpinfo);
478 const struct usb_device_id *usbd_lookup_id_by_info(
479 const struct usb_device_id *id, usb_size_t sizeof_id,
480 const struct usbd_lookup_info *info);
481 int usbd_lookup_id_by_uaa(const struct usb_device_id *id,
482 usb_size_t sizeof_id, struct usb_attach_arg *uaa);
484 usb_error_t usbd_do_request_flags(struct usb_device *udev, struct mtx *mtx,
485 struct usb_device_request *req, void *data, uint16_t flags,
486 uint16_t *actlen, usb_timeout_t timeout);
487 #define usbd_do_request(u,m,r,d) \
488 usbd_do_request_flags(u,m,r,d,0,NULL,USB_DEFAULT_TIMEOUT)
490 uint8_t usbd_clear_stall_callback(struct usb_xfer *xfer1,
491 struct usb_xfer *xfer2);
492 uint8_t usbd_get_interface_altindex(struct usb_interface *iface);
493 usb_error_t usbd_set_alt_interface_index(struct usb_device *udev,
494 uint8_t iface_index, uint8_t alt_index);
495 uint32_t usbd_get_isoc_fps(struct usb_device *udev);
496 usb_error_t usbd_transfer_setup(struct usb_device *udev,
497 const uint8_t *ifaces, struct usb_xfer **pxfer,
498 const struct usb_config *setup_start, uint16_t n_setup,
499 void *priv_sc, struct mtx *priv_mtx);
500 void usbd_transfer_submit(struct usb_xfer *xfer);
501 void usbd_transfer_clear_stall(struct usb_xfer *xfer);
502 void usbd_transfer_drain(struct usb_xfer *xfer);
503 uint8_t usbd_transfer_pending(struct usb_xfer *xfer);
504 void usbd_transfer_start(struct usb_xfer *xfer);
505 void usbd_transfer_stop(struct usb_xfer *xfer);
506 void usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup);
507 void usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max);
508 void usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
509 uint8_t parent_index);
510 uint8_t usbd_get_bus_index(struct usb_device *udev);
511 uint8_t usbd_get_device_index(struct usb_device *udev);
512 void usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode);
513 uint8_t usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode);
514 uint8_t usbd_device_attached(struct usb_device *udev);
517 usbd_xfer_old_frame_length(struct usb_xfer *xfer, usb_frcount_t frindex);
518 void usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen,
519 int *aframes, int *nframes);
520 struct usb_page_cache *usbd_xfer_get_frame(struct usb_xfer *xfer,
521 usb_frcount_t frindex);
522 void *usbd_xfer_softc(struct usb_xfer *xfer);
523 void *usbd_xfer_get_priv(struct usb_xfer *xfer);
524 void usbd_xfer_set_priv(struct usb_xfer *xfer, void *);
525 void usbd_xfer_set_interval(struct usb_xfer *xfer, int);
526 uint8_t usbd_xfer_state(struct usb_xfer *xfer);
527 void usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
528 void *ptr, usb_frlength_t len);
529 void usbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
530 void **ptr, int *len);
531 void usbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset,
532 usb_frcount_t frindex);
533 usb_frlength_t usbd_xfer_max_len(struct usb_xfer *xfer);
534 usb_frlength_t usbd_xfer_max_framelen(struct usb_xfer *xfer);
535 usb_frcount_t usbd_xfer_max_frames(struct usb_xfer *xfer);
536 uint8_t usbd_xfer_get_fps_shift(struct usb_xfer *xfer);
537 usb_frlength_t usbd_xfer_frame_len(struct usb_xfer *xfer,
538 usb_frcount_t frindex);
539 void usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex,
541 void usbd_xfer_set_timeout(struct usb_xfer *xfer, int timeout);
542 void usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n);
543 void usbd_xfer_set_stall(struct usb_xfer *xfer);
544 int usbd_xfer_is_stalled(struct usb_xfer *xfer);
545 void usbd_xfer_set_flag(struct usb_xfer *xfer, int flag);
546 void usbd_xfer_clr_flag(struct usb_xfer *xfer, int flag);
547 uint16_t usbd_xfer_get_timestamp(struct usb_xfer *xfer);
549 void usbd_copy_in(struct usb_page_cache *cache, usb_frlength_t offset,
550 const void *ptr, usb_frlength_t len);
551 int usbd_copy_in_user(struct usb_page_cache *cache, usb_frlength_t offset,
552 const void *ptr, usb_frlength_t len);
553 void usbd_copy_out(struct usb_page_cache *cache, usb_frlength_t offset,
554 void *ptr, usb_frlength_t len);
555 int usbd_copy_out_user(struct usb_page_cache *cache, usb_frlength_t offset,
556 void *ptr, usb_frlength_t len);
557 void usbd_get_page(struct usb_page_cache *pc, usb_frlength_t offset,
558 struct usb_page_search *res);
559 void usbd_m_copy_in(struct usb_page_cache *cache, usb_frlength_t dst_offset,
560 struct mbuf *m, usb_size_t src_offset, usb_frlength_t src_len);
561 void usbd_frame_zero(struct usb_page_cache *cache, usb_frlength_t offset,
563 void usbd_start_re_enumerate(struct usb_device *udev);
565 int usb_fifo_attach(struct usb_device *udev, void *priv_sc,
566 struct mtx *priv_mtx, struct usb_fifo_methods *pm,
567 struct usb_fifo_sc *f_sc, uint16_t unit, uint16_t subunit,
568 uint8_t iface_index, uid_t uid, gid_t gid, int mode);
569 void usb_fifo_detach(struct usb_fifo_sc *f_sc);
570 int usb_fifo_alloc_buffer(struct usb_fifo *f, uint32_t bufsize,
572 void usb_fifo_free_buffer(struct usb_fifo *f);
573 uint32_t usb_fifo_put_bytes_max(struct usb_fifo *fifo);
574 void usb_fifo_put_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
575 usb_frlength_t offset, usb_frlength_t len, uint8_t what);
576 void usb_fifo_put_data_linear(struct usb_fifo *fifo, void *ptr,
577 usb_size_t len, uint8_t what);
578 uint8_t usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len);
579 void usb_fifo_put_data_error(struct usb_fifo *fifo);
580 uint8_t usb_fifo_get_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
581 usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen,
583 uint8_t usb_fifo_get_data_linear(struct usb_fifo *fifo, void *ptr,
584 usb_size_t len, usb_size_t *actlen, uint8_t what);
585 uint8_t usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr,
587 void usb_fifo_reset(struct usb_fifo *f);
588 void usb_fifo_wakeup(struct usb_fifo *f);
589 void usb_fifo_get_data_error(struct usb_fifo *fifo);
590 void *usb_fifo_softc(struct usb_fifo *fifo);
591 void usb_fifo_set_close_zlp(struct usb_fifo *, uint8_t);
592 void usb_fifo_set_write_defrag(struct usb_fifo *, uint8_t);
593 void usb_fifo_free(struct usb_fifo *f);
595 #endif /* _USB_USBDI_H_ */