2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2009 Andrew Thompson
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 struct usb_attach_arg;
37 struct usb_page_cache;
38 struct usb_page_search;
42 struct usb_fs_privdata;
45 typedef enum { /* keep in sync with usb_errstr_table */
46 USB_ERR_NORMAL_COMPLETION = 0,
47 USB_ERR_PENDING_REQUESTS, /* 1 */
48 USB_ERR_NOT_STARTED, /* 2 */
49 USB_ERR_INVAL, /* 3 */
50 USB_ERR_NOMEM, /* 4 */
51 USB_ERR_CANCELLED, /* 5 */
52 USB_ERR_BAD_ADDRESS, /* 6 */
53 USB_ERR_BAD_BUFSIZE, /* 7 */
54 USB_ERR_BAD_FLAG, /* 8 */
55 USB_ERR_NO_CALLBACK, /* 9 */
56 USB_ERR_IN_USE, /* 10 */
57 USB_ERR_NO_ADDR, /* 11 */
58 USB_ERR_NO_PIPE, /* 12 */
59 USB_ERR_ZERO_NFRAMES, /* 13 */
60 USB_ERR_ZERO_MAXP, /* 14 */
61 USB_ERR_SET_ADDR_FAILED, /* 15 */
62 USB_ERR_NO_POWER, /* 16 */
63 USB_ERR_TOO_DEEP, /* 17 */
64 USB_ERR_IOERROR, /* 18 */
65 USB_ERR_NOT_CONFIGURED, /* 19 */
66 USB_ERR_TIMEOUT, /* 20 */
67 USB_ERR_SHORT_XFER, /* 21 */
68 USB_ERR_STALLED, /* 22 */
69 USB_ERR_INTERRUPTED, /* 23 */
70 USB_ERR_DMA_LOAD_FAILED, /* 24 */
71 USB_ERR_BAD_CONTEXT, /* 25 */
72 USB_ERR_NO_ROOT_HUB, /* 26 */
73 USB_ERR_NO_INTR_THREAD, /* 27 */
74 USB_ERR_NOT_LOCKED, /* 28 */
81 #define USB_FORCE_SHORT_XFER 0x0001 /* force a short transmit last */
82 #define USB_SHORT_XFER_OK 0x0004 /* allow short reads */
83 #define USB_DELAY_STATUS_STAGE 0x0010 /* insert delay before STATUS stage */
84 #define USB_USER_DATA_PTR 0x0020 /* internal flag */
85 #define USB_MULTI_SHORT_OK 0x0040 /* allow multiple short frames */
86 #define USB_MANUAL_STATUS 0x0080 /* manual ctrl status */
88 #define USB_NO_TIMEOUT 0
89 #define USB_DEFAULT_TIMEOUT 5000 /* 5000 ms = 5 seconds */
91 #if defined(_KERNEL) || defined(_STANDALONE)
94 typedef void (usb_callback_t)(struct usb_xfer *, usb_error_t);
95 typedef void (usb_proc_callback_t)(struct usb_proc_msg *);
96 typedef usb_error_t (usb_handle_req_t)(struct usb_device *,
97 struct usb_device_request *, const void **, uint16_t *);
99 typedef int (usb_fifo_open_t)(struct usb_fifo *fifo, int fflags);
100 typedef void (usb_fifo_close_t)(struct usb_fifo *fifo, int fflags);
101 typedef int (usb_fifo_ioctl_t)(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags);
102 typedef void (usb_fifo_cmd_t)(struct usb_fifo *fifo);
103 typedef void (usb_fifo_filter_t)(struct usb_fifo *fifo, struct usb_mbuf *m);
106 #ifndef USB_GLOBAL_INCLUDE_FILE
107 #include <sys/_eventhandler.h>
109 typedef void (*usb_dev_configured_t)(void *, struct usb_device *,
110 struct usb_attach_arg *);
111 EVENTHANDLER_DECLARE(usb_dev_configured, usb_dev_configured_t);
114 * The following macros are used used to convert milliseconds into
115 * HZ. We use 1024 instead of 1000 milliseconds per second to save a
118 #define USB_MS_HZ 1024
120 #define USB_MS_TO_TICKS(ms) \
121 (((uint32_t)((((uint32_t)(ms)) * ((uint32_t)(hz))) + USB_MS_HZ - 1)) / USB_MS_HZ)
124 * Common queue structure for USB transfers.
126 struct usb_xfer_queue {
127 TAILQ_HEAD(, usb_xfer) head;
128 struct usb_xfer *curr; /* current USB transfer processed */
129 void (*command) (struct usb_xfer_queue *pq);
137 * The following structure defines an USB endpoint
140 struct usb_endpoint {
141 /* queue of USB transfers */
142 struct usb_xfer_queue endpoint_q[USB_MAX_EP_STREAMS];
144 struct usb_endpoint_descriptor *edesc;
145 struct usb_endpoint_ss_comp_descriptor *ecomp;
146 const struct usb_pipe_methods *methods; /* set by HC driver */
150 uint8_t toggle_next:1; /* next data toggle value */
151 uint8_t is_stalled:1; /* set if endpoint is stalled */
152 uint8_t is_synced:1; /* set if we a synchronised */
154 uint8_t iface_index; /* not used by "default endpoint" */
156 uint8_t refcount_alloc; /* allocation refcount */
157 uint8_t refcount_bw; /* bandwidth refcount */
158 #define USB_EP_REF_MAX 0x3f
160 /* High-Speed resource allocation (valid if "refcount_bw" > 0) */
162 uint8_t usb_smask; /* USB start mask */
163 uint8_t usb_cmask; /* USB complete mask */
164 uint8_t usb_uframe; /* USB microframe */
166 /* USB endpoint mode, see USB_EP_MODE_XXX */
172 * The following structure defines an USB interface.
174 struct usb_interface {
175 struct usb_interface_descriptor *idesc;
177 /* Total number of alternate settings, from 1 to 256 */
178 uint16_t num_altsetting;
179 /* Current alternate interface index, from 0 to 255 */
181 uint8_t parent_iface_index;
184 struct usb_host_interface *altsetting;
185 struct usb_host_interface *cur_altsetting;
186 struct usb_device *linux_udev;
187 void *bsd_priv_sc; /* device specific information */
188 char *pnpinfo; /* additional PnP-info for this interface */
189 uint8_t bsd_iface_index;
193 * The following structure defines a set of USB transfer flags.
195 struct usb_xfer_flags {
196 uint8_t force_short_xfer:1; /* force a short transmit transfer
198 uint8_t short_xfer_ok:1; /* allow short receive transfers */
199 uint8_t short_frames_ok:1; /* allow short frames */
200 uint8_t pipe_bof:1; /* block pipe on failure */
201 uint8_t proxy_buffer:1; /* makes buffer size a factor of
202 * "max_frame_size" */
203 uint8_t ext_buffer:1; /* uses external DMA buffer */
204 uint8_t manual_status:1; /* non automatic status stage on
205 * control transfers */
206 uint8_t no_pipe_ok:1; /* set if "USB_ERR_NO_PIPE" error can
208 uint8_t stall_pipe:1; /* set if the endpoint belonging to
209 * this USB transfer should be stalled
210 * before starting this transfer! */
211 uint8_t pre_scale_frames:1; /* "usb_config->frames" is
212 * assumed to give the
214 * milliseconds and is
215 * converted into the nearest
216 * number of frames when the
217 * USB transfer is setup. This
218 * option only has effect for
219 * ISOCHRONOUS transfers.
221 uint8_t send_zlp:1; /* send a zero length packet first */
225 * The following structure define an USB configuration, that basically
226 * is used when setting up an USB transfer.
229 usb_callback_t *callback; /* USB transfer callback */
230 usb_frlength_t bufsize; /* total pipe buffer size in bytes */
231 usb_frcount_t frames; /* maximum number of USB frames */
232 usb_timeout_t interval; /* interval in milliseconds */
233 #define USB_DEFAULT_INTERVAL 0
234 usb_timeout_t timeout; /* transfer timeout in milliseconds */
235 struct usb_xfer_flags flags; /* transfer flags */
236 usb_stream_t stream_id; /* USB3.0 specific */
237 enum usb_hc_mode usb_mode; /* host or device mode */
238 uint8_t type; /* pipe type */
239 uint8_t endpoint; /* pipe number */
240 uint8_t direction; /* pipe direction */
241 uint8_t ep_index; /* pipe index match to use */
242 uint8_t if_index; /* "ifaces" index to use */
246 * Use these macro when defining USB device ID arrays if you want to
247 * have your driver module automatically loaded in host, device or
248 * both modes respectively:
250 #if USB_HAVE_ID_SECTION
251 #define STRUCT_USB_HOST_ID \
252 struct usb_device_id __section("usb_host_id")
253 #define STRUCT_USB_DEVICE_ID \
254 struct usb_device_id __section("usb_device_id")
255 #define STRUCT_USB_DUAL_ID \
256 struct usb_device_id __section("usb_dual_id")
258 #define STRUCT_USB_HOST_ID \
260 #define STRUCT_USB_DEVICE_ID \
262 #define STRUCT_USB_DUAL_ID \
264 #endif /* USB_HAVE_ID_SECTION */
267 * The following structure is used when looking up an USB driver for
268 * an USB device. It is inspired by the Linux structure called
271 struct usb_device_id {
272 /* Select which fields to match against */
273 #if BYTE_ORDER == LITTLE_ENDIAN
276 match_flag_product:1,
280 match_flag_dev_class:1,
281 match_flag_dev_subclass:1,
282 match_flag_dev_protocol:1,
283 match_flag_int_class:1,
285 match_flag_int_subclass:1,
286 match_flag_int_protocol:1,
291 match_flag_int_protocol:1,
292 match_flag_int_subclass:1,
294 match_flag_int_class:1,
295 match_flag_dev_protocol:1,
296 match_flag_dev_subclass:1,
297 match_flag_dev_class:1,
301 match_flag_product:1,
305 /* Used for product specific matches; the BCD range is inclusive */
308 uint16_t bcdDevice_lo;
309 uint16_t bcdDevice_hi;
311 /* Used for device class matches */
312 uint8_t bDeviceClass;
313 uint8_t bDeviceSubClass;
314 uint8_t bDeviceProtocol;
316 /* Used for interface class matches */
317 uint8_t bInterfaceClass;
318 uint8_t bInterfaceSubClass;
319 uint8_t bInterfaceProtocol;
321 #if USB_HAVE_COMPAT_LINUX
322 /* which fields to match against */
323 uint16_t match_flags;
324 #define USB_DEVICE_ID_MATCH_VENDOR 0x0001
325 #define USB_DEVICE_ID_MATCH_PRODUCT 0x0002
326 #define USB_DEVICE_ID_MATCH_DEV_LO 0x0004
327 #define USB_DEVICE_ID_MATCH_DEV_HI 0x0008
328 #define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010
329 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020
330 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040
331 #define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080
332 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100
333 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200
336 /* Hook for driver specific information */
337 unsigned long driver_info;
340 #define USB_STD_PNP_INFO "M16:mask;U16:vendor;U16:product;L16:release;G16:release;" \
341 "U8:devclass;U8:devsubclass;U8:devproto;" \
342 "U8:intclass;U8:intsubclass;U8:intprotocol;"
343 #define USB_STD_PNP_HOST_INFO USB_STD_PNP_INFO "T:mode=host;"
344 #define USB_STD_PNP_DEVICE_INFO USB_STD_PNP_INFO "T:mode=device;"
345 #define USB_PNP_HOST_INFO(table) \
346 MODULE_PNP_INFO(USB_STD_PNP_HOST_INFO, uhub, table, table, \
347 sizeof(table) / sizeof(table[0]))
348 #define USB_PNP_DEVICE_INFO(table) \
349 MODULE_PNP_INFO(USB_STD_PNP_DEVICE_INFO, uhub, table, table, \
350 sizeof(table) / sizeof(table[0]))
351 #define USB_PNP_DUAL_INFO(table) \
352 MODULE_PNP_INFO(USB_STD_PNP_INFO, uhub, table, table, \
353 sizeof(table) / sizeof(table[0]))
355 /* check that the size of the structure above is correct */
356 extern char usb_device_id_assert[(sizeof(struct usb_device_id) == 32) ? 1 : -1];
358 #define USB_VENDOR(vend) \
359 .match_flag_vendor = 1, .idVendor = (vend)
361 #define USB_PRODUCT(prod) \
362 .match_flag_product = 1, .idProduct = (prod)
364 #define USB_VP(vend,prod) \
365 USB_VENDOR(vend), USB_PRODUCT(prod)
367 #define USB_VPI(vend,prod,info) \
368 USB_VENDOR(vend), USB_PRODUCT(prod), USB_DRIVER_INFO(info)
370 #define USB_DEV_BCD_GTEQ(lo) /* greater than or equal */ \
371 .match_flag_dev_lo = 1, .bcdDevice_lo = (lo)
373 #define USB_DEV_BCD_LTEQ(hi) /* less than or equal */ \
374 .match_flag_dev_hi = 1, .bcdDevice_hi = (hi)
376 #define USB_DEV_CLASS(dc) \
377 .match_flag_dev_class = 1, .bDeviceClass = (dc)
379 #define USB_DEV_SUBCLASS(dsc) \
380 .match_flag_dev_subclass = 1, .bDeviceSubClass = (dsc)
382 #define USB_DEV_PROTOCOL(dp) \
383 .match_flag_dev_protocol = 1, .bDeviceProtocol = (dp)
385 #define USB_IFACE_CLASS(ic) \
386 .match_flag_int_class = 1, .bInterfaceClass = (ic)
388 #define USB_IFACE_SUBCLASS(isc) \
389 .match_flag_int_subclass = 1, .bInterfaceSubClass = (isc)
391 #define USB_IFACE_PROTOCOL(ip) \
392 .match_flag_int_protocol = 1, .bInterfaceProtocol = (ip)
394 #define USB_IF_CSI(class,subclass,info) \
395 USB_IFACE_CLASS(class), USB_IFACE_SUBCLASS(subclass), USB_DRIVER_INFO(info)
397 #define USB_DRIVER_INFO(n) \
400 #define USB_GET_DRIVER_INFO(did) \
404 * The following structure keeps information that is used to match
405 * against an array of "usb_device_id" elements.
407 struct usbd_lookup_info {
411 uint8_t bDeviceClass;
412 uint8_t bDeviceSubClass;
413 uint8_t bDeviceProtocol;
414 uint8_t bInterfaceClass;
415 uint8_t bInterfaceSubClass;
416 uint8_t bInterfaceProtocol;
419 uint8_t bConfigIndex;
423 /* Structure used by probe and attach */
425 struct usb_attach_arg {
426 struct usbd_lookup_info info;
427 device_t temp_dev; /* for internal use */
428 unsigned long driver_info; /* for internal use */
430 struct usb_device *device; /* current device */
431 struct usb_interface *iface; /* current interface */
432 enum usb_hc_mode usb_mode; /* host or device mode */
435 #define UAA_DEV_READY 0
436 #define UAA_DEV_DISABLED 1
437 #define UAA_DEV_EJECTING 2
441 * General purpose locking wrappers to ease supporting
445 #define USB_MTX_ASSERT(_m, _t) do { \
446 if (!USB_IN_POLLING_MODE_FUNC()) \
447 mtx_assert(_m, _t); \
450 #define USB_MTX_ASSERT(_m, _t) do { } while (0)
453 #define USB_MTX_LOCK(_m) do { \
454 if (!USB_IN_POLLING_MODE_FUNC()) \
458 #define USB_MTX_UNLOCK(_m) do { \
459 if (!USB_IN_POLLING_MODE_FUNC()) \
463 #define USB_MTX_LOCK_SPIN(_m) do { \
464 if (!USB_IN_POLLING_MODE_FUNC()) \
468 #define USB_MTX_UNLOCK_SPIN(_m) do { \
469 if (!USB_IN_POLLING_MODE_FUNC()) \
470 mtx_unlock_spin(_m); \
474 * The following is a wrapper for the callout structure to ease
475 * porting the code to other platforms.
480 #define usb_callout_init_mtx(c,m,f) callout_init_mtx(&(c)->co,m,f)
481 #define usb_callout_reset(c,...) do { \
482 if (!USB_IN_POLLING_MODE_FUNC()) \
483 callout_reset(&(c)->co, __VA_ARGS__); \
485 #define usb_callout_reset_sbt(c,...) do { \
486 if (!USB_IN_POLLING_MODE_FUNC()) \
487 callout_reset_sbt(&(c)->co, __VA_ARGS__); \
489 #define usb_callout_stop(c) do { \
490 if (!USB_IN_POLLING_MODE_FUNC()) { \
491 callout_stop(&(c)->co); \
494 * Cannot stop callout when \
495 * polling. Set dummy callback \
496 * function instead: \
498 (c)->co.c_func = &usbd_dummy_timeout; \
501 #define usb_callout_drain(c) callout_drain(&(c)->co)
502 #define usb_callout_pending(c) callout_pending(&(c)->co)
504 /* USB transfer states */
506 #define USB_ST_SETUP 0
507 #define USB_ST_TRANSFERRED 1
508 #define USB_ST_ERROR 2
510 /* USB handle request states */
511 #define USB_HR_NOT_COMPLETE 0
512 #define USB_HR_COMPLETE_OK 1
513 #define USB_HR_COMPLETE_ERR 2
516 * The following macro will return the current state of an USB
517 * transfer like defined by the "USB_ST_XXX" enums.
519 #define USB_GET_STATE(xfer) (usbd_xfer_state(xfer))
522 * The following structure defines the USB process message header.
524 struct usb_proc_msg {
525 TAILQ_ENTRY(usb_proc_msg) pm_qentry;
526 usb_proc_callback_t *pm_callback;
530 #define USB_FIFO_TX 0
531 #define USB_FIFO_RX 1
534 * Locking note for the following functions. All the
535 * "usb_fifo_cmd_t" and "usb_fifo_filter_t" functions are called
536 * locked. The others are called unlocked.
538 struct usb_fifo_methods {
539 usb_fifo_open_t *f_open;
540 usb_fifo_close_t *f_close;
541 usb_fifo_ioctl_t *f_ioctl;
543 * NOTE: The post-ioctl callback is called after the USB reference
544 * gets locked in the IOCTL handler:
546 usb_fifo_ioctl_t *f_ioctl_post;
547 usb_fifo_cmd_t *f_start_read;
548 usb_fifo_cmd_t *f_stop_read;
549 usb_fifo_cmd_t *f_start_write;
550 usb_fifo_cmd_t *f_stop_write;
551 usb_fifo_filter_t *f_filter_read;
552 usb_fifo_filter_t *f_filter_write;
553 const char *basename[4];
554 const char *postfix[4];
558 struct usb_fifo *fp[2];
559 struct usb_fs_privdata *dev;
562 const char *usbd_errstr(usb_error_t error);
563 void *usbd_find_descriptor(struct usb_device *udev, void *id,
564 uint8_t iface_index, uint8_t type, uint8_t type_mask,
565 uint8_t subtype, uint8_t subtype_mask);
566 struct usb_config_descriptor *usbd_get_config_descriptor(
567 struct usb_device *udev);
568 struct usb_device_descriptor *usbd_get_device_descriptor(
569 struct usb_device *udev);
570 struct usb_interface *usbd_get_iface(struct usb_device *udev,
571 uint8_t iface_index);
572 struct usb_interface_descriptor *usbd_get_interface_descriptor(
573 struct usb_interface *iface);
574 struct usb_endpoint *usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index,
575 const struct usb_config *setup);
576 struct usb_endpoint *usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val);
577 usb_error_t usbd_interface_count(struct usb_device *udev, uint8_t *count);
578 enum usb_hc_mode usbd_get_mode(struct usb_device *udev);
579 enum usb_dev_speed usbd_get_speed(struct usb_device *udev);
580 void device_set_usb_desc(device_t dev);
581 void usb_pause_mtx(struct mtx *mtx, int _ticks);
582 usb_error_t usbd_set_pnpinfo(struct usb_device *udev,
583 uint8_t iface_index, const char *pnpinfo);
584 usb_error_t usbd_add_dynamic_quirk(struct usb_device *udev,
586 usb_error_t usbd_set_endpoint_mode(struct usb_device *udev,
587 struct usb_endpoint *ep, uint8_t ep_mode);
588 uint8_t usbd_get_endpoint_mode(struct usb_device *udev,
589 struct usb_endpoint *ep);
591 const struct usb_device_id *usbd_lookup_id_by_info(
592 const struct usb_device_id *id, usb_size_t sizeof_id,
593 const struct usbd_lookup_info *info);
594 int usbd_lookup_id_by_uaa(const struct usb_device_id *id,
595 usb_size_t sizeof_id, struct usb_attach_arg *uaa);
597 usb_error_t usbd_do_request_flags(struct usb_device *udev, struct mtx *mtx,
598 struct usb_device_request *req, void *data, uint16_t flags,
599 uint16_t *actlen, usb_timeout_t timeout);
600 #define usbd_do_request(u,m,r,d) \
601 usbd_do_request_flags(u,m,r,d,0,NULL,USB_DEFAULT_TIMEOUT)
603 uint8_t usbd_clear_stall_callback(struct usb_xfer *xfer1,
604 struct usb_xfer *xfer2);
605 uint8_t usbd_get_interface_altindex(struct usb_interface *iface);
606 usb_error_t usbd_set_alt_interface_index(struct usb_device *udev,
607 uint8_t iface_index, uint8_t alt_index);
608 uint32_t usbd_get_isoc_fps(struct usb_device *udev);
609 uint32_t usbd_get_max_frame_length(const struct usb_endpoint_descriptor *,
610 const struct usb_endpoint_ss_comp_descriptor *,
612 usb_error_t usbd_transfer_setup(struct usb_device *udev,
613 const uint8_t *ifaces, struct usb_xfer **pxfer,
614 const struct usb_config *setup_start, uint16_t n_setup,
615 void *priv_sc, struct mtx *priv_mtx);
616 void usbd_transfer_submit(struct usb_xfer *xfer);
617 void usbd_transfer_clear_stall(struct usb_xfer *xfer);
618 void usbd_transfer_drain(struct usb_xfer *xfer);
619 uint8_t usbd_transfer_pending(struct usb_xfer *xfer);
620 void usbd_transfer_start(struct usb_xfer *xfer);
621 void usbd_transfer_stop(struct usb_xfer *xfer);
622 void usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup);
623 void usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max);
624 void usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index,
625 uint8_t parent_index);
626 uint8_t usbd_get_bus_index(struct usb_device *udev);
627 uint8_t usbd_get_device_index(struct usb_device *udev);
628 void usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode);
629 uint8_t usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode);
630 uint8_t usbd_device_attached(struct usb_device *udev);
633 usbd_xfer_old_frame_length(struct usb_xfer *xfer, usb_frcount_t frindex);
634 void usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen,
635 int *aframes, int *nframes);
636 struct usb_page_cache *usbd_xfer_get_frame(struct usb_xfer *, usb_frcount_t);
637 void *usbd_xfer_get_frame_buffer(struct usb_xfer *, usb_frcount_t);
638 void *usbd_xfer_softc(struct usb_xfer *xfer);
639 void *usbd_xfer_get_priv(struct usb_xfer *xfer);
640 void usbd_xfer_set_priv(struct usb_xfer *xfer, void *);
641 void usbd_xfer_set_interval(struct usb_xfer *xfer, int);
642 uint8_t usbd_xfer_state(struct usb_xfer *xfer);
643 void usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
644 void *ptr, usb_frlength_t len);
645 void usbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex,
646 void **ptr, int *len);
647 void usbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset,
648 usb_frcount_t frindex);
649 usb_frlength_t usbd_xfer_max_len(struct usb_xfer *xfer);
650 usb_frlength_t usbd_xfer_max_framelen(struct usb_xfer *xfer);
651 usb_frcount_t usbd_xfer_max_frames(struct usb_xfer *xfer);
652 uint8_t usbd_xfer_get_fps_shift(struct usb_xfer *xfer);
653 usb_frlength_t usbd_xfer_frame_len(struct usb_xfer *xfer,
654 usb_frcount_t frindex);
655 void usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex,
657 void usbd_xfer_set_timeout(struct usb_xfer *xfer, int timeout);
658 void usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n);
659 void usbd_xfer_set_zlp(struct usb_xfer *xfer);
660 uint8_t usbd_xfer_get_and_clr_zlp(struct usb_xfer *xfer);
661 void usbd_xfer_set_stall(struct usb_xfer *xfer);
662 int usbd_xfer_is_stalled(struct usb_xfer *xfer);
663 void usbd_xfer_set_flag(struct usb_xfer *xfer, int flag);
664 void usbd_xfer_clr_flag(struct usb_xfer *xfer, int flag);
665 uint16_t usbd_xfer_get_timestamp(struct usb_xfer *xfer);
666 uint8_t usbd_xfer_maxp_was_clamped(struct usb_xfer *xfer);
668 void usbd_copy_in(struct usb_page_cache *cache, usb_frlength_t offset,
669 const void *ptr, usb_frlength_t len);
670 int usbd_copy_in_user(struct usb_page_cache *cache, usb_frlength_t offset,
671 const void *ptr, usb_frlength_t len);
672 void usbd_copy_out(struct usb_page_cache *cache, usb_frlength_t offset,
673 void *ptr, usb_frlength_t len);
674 int usbd_copy_out_user(struct usb_page_cache *cache, usb_frlength_t offset,
675 void *ptr, usb_frlength_t len);
676 void usbd_get_page(struct usb_page_cache *pc, usb_frlength_t offset,
677 struct usb_page_search *res);
678 void usbd_m_copy_in(struct usb_page_cache *cache, usb_frlength_t dst_offset,
679 struct mbuf *m, usb_size_t src_offset, usb_frlength_t src_len);
680 void usbd_frame_zero(struct usb_page_cache *cache, usb_frlength_t offset,
682 void usbd_start_re_enumerate(struct usb_device *udev);
684 usbd_start_set_config(struct usb_device *, uint8_t);
685 int usbd_in_polling_mode(void);
686 void usbd_dummy_timeout(void *);
688 int usb_fifo_attach(struct usb_device *udev, void *priv_sc,
689 struct mtx *priv_mtx, struct usb_fifo_methods *pm,
690 struct usb_fifo_sc *f_sc, uint16_t unit, int16_t subunit,
691 uint8_t iface_index, uid_t uid, gid_t gid, int mode);
692 void usb_fifo_detach(struct usb_fifo_sc *f_sc);
693 int usb_fifo_alloc_buffer(struct usb_fifo *f, uint32_t bufsize,
695 void usb_fifo_free_buffer(struct usb_fifo *f);
696 uint32_t usb_fifo_put_bytes_max(struct usb_fifo *fifo);
697 void usb_fifo_put_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
698 usb_frlength_t offset, usb_frlength_t len, uint8_t what);
699 void usb_fifo_put_data_linear(struct usb_fifo *fifo, void *ptr,
700 usb_size_t len, uint8_t what);
701 uint8_t usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len);
702 void usb_fifo_put_data_error(struct usb_fifo *fifo);
703 uint8_t usb_fifo_get_data(struct usb_fifo *fifo, struct usb_page_cache *pc,
704 usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen,
706 uint8_t usb_fifo_get_data_linear(struct usb_fifo *fifo, void *ptr,
707 usb_size_t len, usb_size_t *actlen, uint8_t what);
708 uint8_t usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr,
710 void usb_fifo_reset(struct usb_fifo *f);
711 void usb_fifo_wakeup(struct usb_fifo *f);
712 void usb_fifo_get_data_error(struct usb_fifo *fifo);
713 void *usb_fifo_softc(struct usb_fifo *fifo);
714 void usb_fifo_set_close_zlp(struct usb_fifo *, uint8_t);
715 void usb_fifo_set_write_defrag(struct usb_fifo *, uint8_t);
716 void usb_fifo_free(struct usb_fifo *f);
717 #endif /* _KERNEL || _STANDALONE */
718 #endif /* _USB_USBDI_H_ */