81#define USB_FORCE_SHORT_XFER 0x0001
82#define USB_SHORT_XFER_OK 0x0004
83#define USB_DELAY_STATUS_STAGE 0x0010
84#define USB_USER_DATA_PTR 0x0020
85#define USB_MULTI_SHORT_OK 0x0040
86#define USB_MANUAL_STATUS 0x0080
88#define USB_NO_TIMEOUT 0
89#define USB_DEFAULT_TIMEOUT 5000
91#if defined(_KERNEL) || defined(_STANDALONE)
106#ifndef USB_GLOBAL_INCLUDE_FILE
107#include <sys/_eventhandler.h>
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)
158#define USB_EP_REF_MAX 0x3f
233#define USB_DEFAULT_INTERVAL 0
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 \
273#if BYTE_ORDER == LITTLE_ENDIAN
321#if USB_HAVE_COMPAT_LINUX
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
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]))
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) \
371 .match_flag_dev_lo = 1, .bcdDevice_lo = (lo)
373#define USB_DEV_BCD_LTEQ(hi) \
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) \
435#define UAA_DEV_READY 0
436#define UAA_DEV_DISABLED 1
437#define UAA_DEV_EJECTING 2
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); \
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); \
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)
506#define USB_ST_SETUP 0
507#define USB_ST_TRANSFERRED 1
508#define USB_ST_ERROR 2
511#define USB_HR_NOT_COMPLETE 0
512#define USB_HR_COMPLETE_OK 1
513#define USB_HR_COMPLETE_ERR 2
519#define USB_GET_STATE(xfer) (usbd_xfer_state(xfer))
564 uint8_t iface_index, uint8_t type, uint8_t type_mask,
565 uint8_t subtype, uint8_t subtype_mask);
571 uint8_t iface_index);
600#define usbd_do_request(u,m,r,d) \
601 usbd_do_request_flags(u,m,r,d,0,NULL,USB_DEFAULT_TIMEOUT)
607 uint8_t iface_index, uint8_t alt_index);
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);
625 uint8_t parent_index);
635 int *aframes,
int *nframes);
646 void **ptr,
int *
len);
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);
enum usb_hc_mode usb_mode
unsigned long driver_info
struct usbd_lookup_info info
struct usb_interface * iface
struct usb_device * device
struct usb_xfer_flags flags
enum usb_hc_mode usb_mode
usb_callback_t * callback
unsigned long driver_info
uint8_t bInterfaceSubClass
uint16_t match_flag_vendor
uint16_t match_flag_int_protocol
uint16_t match_flag_unused
uint16_t match_flag_int_subclass
uint16_t match_flag_dev_lo
uint16_t match_flag_dev_subclass
uint16_t match_flag_int_class
uint16_t match_flag_product
uint16_t match_flag_dev_protocol
uint16_t match_flag_dev_hi
uint16_t match_flag_dev_class
uint8_t bInterfaceProtocol
struct usb_endpoint_ss_comp_descriptor * ecomp
struct usb_xfer_queue endpoint_q[USB_MAX_EP_STREAMS]
const struct usb_pipe_methods * methods
struct usb_endpoint_descriptor * edesc
usb_fifo_ioctl_t * f_ioctl_post
usb_fifo_close_t * f_close
usb_fifo_cmd_t * f_start_read
usb_fifo_filter_t * f_filter_read
usb_fifo_ioctl_t * f_ioctl
usb_fifo_cmd_t * f_start_write
usb_fifo_cmd_t * f_stop_read
usb_fifo_cmd_t * f_stop_write
usb_fifo_filter_t * f_filter_write
struct usb_fs_privdata * dev
uint8_t parent_iface_index
struct usb_host_interface * cur_altsetting
struct usb_host_interface * altsetting
struct usb_interface_descriptor * idesc
struct usb_device * linux_udev
usb_proc_callback_t * pm_callback
TAILQ_ENTRY(usb_proc_msg) pm_qentry
void(* command)(struct usb_xfer_queue *pq)
TAILQ_HEAD(, usb_xfer) head
uint8_t bInterfaceSubClass
uint8_t bInterfaceProtocol
#define USB_MAX_EP_STREAMS
void(* usb_dev_configured_t)(void *, struct usb_device *, struct usb_attach_arg *)
usb_error_t usbd_set_alt_interface_index(struct usb_device *udev, uint8_t iface_index, uint8_t alt_index)
int usb_fifo_alloc_buffer(struct usb_fifo *f, uint32_t bufsize, uint16_t nbuf)
void usbd_xfer_set_flag(struct usb_xfer *xfer, int flag)
uint8_t usb_fifo_get_data_buffer(struct usb_fifo *f, void **pptr, usb_size_t *plen)
uint8_t usbd_xfer_get_and_clr_zlp(struct usb_xfer *xfer)
usb_error_t usbd_interface_count(struct usb_device *udev, uint8_t *count)
void usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode)
void usbd_transfer_submit(struct usb_xfer *xfer)
void usbd_xfer_set_frames(struct usb_xfer *xfer, usb_frcount_t n)
int() usb_fifo_ioctl_t(struct usb_fifo *fifo, u_long cmd, void *addr, int fflags)
const char * usbd_errstr(usb_error_t error)
void * usb_fifo_softc(struct usb_fifo *fifo)
int usbd_copy_in_user(struct usb_page_cache *cache, usb_frlength_t offset, const void *ptr, usb_frlength_t len)
void * usbd_xfer_get_priv(struct usb_xfer *xfer)
usb_frcount_t usbd_xfer_max_frames(struct usb_xfer *xfer)
void() usb_proc_callback_t(struct usb_proc_msg *)
void() usb_fifo_close_t(struct usb_fifo *fifo, int fflags)
uint8_t usbd_xfer_state(struct usb_xfer *xfer)
char usb_device_id_assert[(sizeof(struct usb_device_id)==32) ? 1 :-1]
void usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup)
void device_set_usb_desc(device_t dev)
void usbd_xfer_set_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex, void *ptr, usb_frlength_t len)
void usbd_xfer_set_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex, usb_frlength_t len)
struct usb_page_cache * usbd_xfer_get_frame(struct usb_xfer *, usb_frcount_t)
uint32_t usbd_get_max_frame_length(const struct usb_endpoint_descriptor *, const struct usb_endpoint_ss_comp_descriptor *, enum usb_dev_speed)
void usb_fifo_detach(struct usb_fifo_sc *f_sc)
void usb_fifo_wakeup(struct usb_fifo *f)
uint8_t usbd_clear_stall_callback(struct usb_xfer *xfer1, struct usb_xfer *xfer2)
usb_frlength_t usbd_xfer_old_frame_length(struct usb_xfer *xfer, usb_frcount_t frindex)
void usbd_transfer_clear_stall(struct usb_xfer *xfer)
void usb_fifo_put_data(struct usb_fifo *fifo, struct usb_page_cache *pc, usb_frlength_t offset, usb_frlength_t len, uint8_t what)
void usbd_frame_zero(struct usb_page_cache *cache, usb_frlength_t offset, usb_frlength_t len)
uint8_t usbd_xfer_get_fps_shift(struct usb_xfer *xfer)
void usb_fifo_free(struct usb_fifo *f)
usb_frlength_t usbd_xfer_frame_len(struct usb_xfer *xfer, usb_frcount_t frindex)
struct usb_interface_descriptor * usbd_get_interface_descriptor(struct usb_interface *iface)
usb_frlength_t usbd_xfer_max_framelen(struct usb_xfer *xfer)
void usb_fifo_put_data_linear(struct usb_fifo *fifo, void *ptr, usb_size_t len, uint8_t what)
struct usbd_lookup_info __aligned
void usb_fifo_get_data_error(struct usb_fifo *fifo)
int usbd_copy_out_user(struct usb_page_cache *cache, usb_frlength_t offset, void *ptr, usb_frlength_t len)
uint8_t usbd_device_attached(struct usb_device *udev)
int usb_fifo_attach(struct usb_device *udev, void *priv_sc, struct mtx *priv_mtx, struct usb_fifo_methods *pm, struct usb_fifo_sc *f_sc, uint16_t unit, int16_t subunit, uint8_t iface_index, uid_t uid, gid_t gid, int mode)
uint16_t usbd_xfer_get_timestamp(struct usb_xfer *xfer)
struct usb_config_descriptor * usbd_get_config_descriptor(struct usb_device *udev)
usb_error_t usbd_add_dynamic_quirk(struct usb_device *udev, uint16_t quirk)
@ USB_ERR_NORMAL_COMPLETION
@ USB_ERR_PENDING_REQUESTS
@ USB_ERR_DMA_LOAD_FAILED
@ USB_ERR_SET_ADDR_FAILED
void() usb_fifo_cmd_t(struct usb_fifo *fifo)
void usb_fifo_set_write_defrag(struct usb_fifo *, uint8_t)
void usb_fifo_free_buffer(struct usb_fifo *f)
uint8_t usbd_get_bus_index(struct usb_device *udev)
void usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index, uint8_t parent_index)
void * usbd_find_descriptor(struct usb_device *udev, void *id, uint8_t iface_index, uint8_t type, uint8_t type_mask, uint8_t subtype, uint8_t subtype_mask)
uint8_t usbd_xfer_maxp_was_clamped(struct usb_xfer *xfer)
uint8_t usbd_get_interface_altindex(struct usb_interface *iface)
void usb_fifo_put_data_error(struct usb_fifo *fifo)
uint8_t usb_fifo_get_data(struct usb_fifo *fifo, struct usb_page_cache *pc, usb_frlength_t offset, usb_frlength_t len, usb_frlength_t *actlen, uint8_t what)
void usbd_transfer_start(struct usb_xfer *xfer)
enum usb_dev_speed usbd_get_speed(struct usb_device *udev)
void usbd_xfer_set_interval(struct usb_xfer *xfer, int)
uint8_t usbd_get_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep)
void usbd_dummy_timeout(void *)
uint32_t usbd_get_isoc_fps(struct usb_device *udev)
void usb_pause_mtx(struct mtx *mtx, int _ticks)
void usb_fifo_reset(struct usb_fifo *f)
uint8_t usb_fifo_put_data_buffer(struct usb_fifo *f, void *ptr, usb_size_t len)
void usbd_xfer_frame_data(struct usb_xfer *xfer, usb_frcount_t frindex, void **ptr, int *len)
struct usb_device_descriptor * usbd_get_device_descriptor(struct usb_device *udev)
int usbd_xfer_is_stalled(struct usb_xfer *xfer)
void usbd_m_copy_in(struct usb_page_cache *cache, usb_frlength_t dst_offset, struct mbuf *m, usb_size_t src_offset, usb_frlength_t src_len)
usb_error_t usbd_set_endpoint_mode(struct usb_device *udev, struct usb_endpoint *ep, uint8_t ep_mode)
void * usbd_xfer_get_frame_buffer(struct usb_xfer *, usb_frcount_t)
uint8_t usbd_filter_power_mode(struct usb_device *udev, uint8_t power_mode)
void usbd_transfer_drain(struct usb_xfer *xfer)
int usbd_lookup_id_by_uaa(const struct usb_device_id *id, usb_size_t sizeof_id, struct usb_attach_arg *uaa)
uint8_t usb_fifo_get_data_linear(struct usb_fifo *fifo, void *ptr, usb_size_t len, usb_size_t *actlen, uint8_t what)
usb_error_t usbd_transfer_setup(struct usb_device *udev, const uint8_t *ifaces, struct usb_xfer **pxfer, const struct usb_config *setup_start, uint16_t n_setup, void *priv_sc, struct mtx *priv_mtx)
void usbd_xfer_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset, usb_frcount_t frindex)
enum usb_hc_mode usbd_get_mode(struct usb_device *udev)
void usbd_xfer_clr_flag(struct usb_xfer *xfer, int flag)
void() usb_callback_t(struct usb_xfer *, usb_error_t)
void usbd_transfer_poll(struct usb_xfer **ppxfer, uint16_t max)
void usbd_get_page(struct usb_page_cache *pc, usb_frlength_t offset, struct usb_page_search *res)
void * usbd_xfer_softc(struct usb_xfer *xfer)
void usbd_xfer_set_stall(struct usb_xfer *xfer)
struct usb_endpoint * usbd_get_ep_by_addr(struct usb_device *udev, uint8_t ea_val)
void usbd_transfer_stop(struct usb_xfer *xfer)
void usbd_xfer_set_zlp(struct usb_xfer *xfer)
int() usb_fifo_open_t(struct usb_fifo *fifo, int fflags)
void usbd_xfer_status(struct usb_xfer *xfer, int *actlen, int *sumlen, int *aframes, int *nframes)
void() usb_fifo_filter_t(struct usb_fifo *fifo, struct usb_mbuf *m)
void usbd_xfer_set_timeout(struct usb_xfer *xfer, int timeout)
void usbd_copy_in(struct usb_page_cache *cache, usb_frlength_t offset, const void *ptr, usb_frlength_t len)
usb_error_t usbd_start_set_config(struct usb_device *, uint8_t)
void usbd_start_re_enumerate(struct usb_device *udev)
struct usb_interface * usbd_get_iface(struct usb_device *udev, uint8_t iface_index)
struct usb_endpoint * usbd_get_endpoint(struct usb_device *udev, uint8_t iface_index, const struct usb_config *setup)
void usb_fifo_set_close_zlp(struct usb_fifo *, uint8_t)
EVENTHANDLER_DECLARE(usb_dev_configured, usb_dev_configured_t)
int usbd_in_polling_mode(void)
usb_error_t usbd_set_pnpinfo(struct usb_device *udev, uint8_t iface_index, const char *pnpinfo)
uint32_t usb_fifo_put_bytes_max(struct usb_fifo *fifo)
usb_frlength_t usbd_xfer_max_len(struct usb_xfer *xfer)
uint8_t usbd_transfer_pending(struct usb_xfer *xfer)
usb_error_t usbd_do_request_flags(struct usb_device *udev, struct mtx *mtx, struct usb_device_request *req, void *data, uint16_t flags, uint16_t *actlen, usb_timeout_t timeout)
const struct usb_device_id * usbd_lookup_id_by_info(const struct usb_device_id *id, usb_size_t sizeof_id, const struct usbd_lookup_info *info)
void usbd_xfer_set_priv(struct usb_xfer *xfer, void *)
void usbd_copy_out(struct usb_page_cache *cache, usb_frlength_t offset, void *ptr, usb_frlength_t len)
uint8_t usbd_get_device_index(struct usb_device *udev)
usb_error_t() usb_handle_req_t(struct usb_device *, struct usb_device_request *, const void **, uint16_t *)