diff options
Diffstat (limited to 'sys/dev/usb/usb_core.h')
| -rw-r--r-- | sys/dev/usb/usb_core.h | 393 |
1 files changed, 16 insertions, 377 deletions
diff --git a/sys/dev/usb/usb_core.h b/sys/dev/usb/usb_core.h index ad302bc..84c163b 100644 --- a/sys/dev/usb/usb_core.h +++ b/sys/dev/usb/usb_core.h @@ -31,193 +31,6 @@ #ifndef _USB_CORE_H_ #define _USB_CORE_H_ -#define USB_STACK_VERSION 2000 /* 2.0 */ - -/* Allow defines in "opt_usb.h" to override configuration */ - -#include "opt_usb.h" -#include "opt_bus.h" - -/* Default USB configuration */ - -/* - * The following macro defines if the code shall support - * /dev/usb/x.y.z. - */ -#ifndef USB_HAVE_UGEN -#define USB_HAVE_UGEN 1 -#endif - -/* - * The following macro defines if the code shall support BUS-DMA. - */ -#ifndef USB_HAVE_BUSDMA -#define USB_HAVE_BUSDMA 1 -#endif - -/* - * The following macro defines if the code shall support the Linux - * compatibility layer. - */ -#ifndef USB_HAVE_COMPAT_LINUX -#define USB_HAVE_COMPAT_LINUX 1 -#endif - -/* - * The following macro defines if the code shall support - * userland data transfer via copyin() and copyout() - */ -#ifndef USB_HAVE_USER_IO -#define USB_HAVE_USER_IO 1 -#endif - -/* - * The following macro defines if the code shall support copy in via - * bsd-mbufs to USB. - */ -#ifndef USB_HAVE_MBUF -#define USB_HAVE_MBUF 1 -#endif - -/* - * The following macro defines if the code shall compile a table - * describing USB vendor and product IDs. - */ -#ifndef USB_VERBOSE -#define USB_VERBOSE 1 -#endif - -/* - * The following macro defines if USB debugging support shall be - * compiled for the USB core and all drivers. - */ -#ifndef USB_DEBUG -#define USB_DEBUG 1 -#endif - -/* - * The following macro defines if USB transaction translator support - * shall be supported for the USB HUB and USB controller drivers. - */ -#ifndef USB_HAVE_TT_SUPPORT -#define USB_HAVE_TT_SUPPORT 1 -#endif - -/* - * The following macro defines if the USB power daemon shall - * be supported in the USB core. - */ -#ifndef USB_HAVE_POWERD -#define USB_HAVE_POWERD 1 -#endif - -/* - * The following macro defines if the USB autoinstall detection shall - * be supported in the USB core. - */ -#ifndef USB_HAVE_MSCTEST -#define USB_HAVE_MSCTEST 1 -#endif - -#ifndef USB_TD_GET_PROC -#define USB_TD_GET_PROC(td) (td)->td_proc -#endif - -#ifndef USB_PROC_GET_GID -#define USB_PROC_GET_GID(td) (td)->p_pgid -#endif - -/* Include files */ - -#include <sys/stdint.h> -#include <sys/stddef.h> -#include <sys/param.h> -#include <sys/queue.h> -#include <sys/types.h> -#include <sys/systm.h> -#include <sys/kernel.h> -#include <sys/bus.h> -#include <sys/linker_set.h> -#include <sys/module.h> -#include <sys/lock.h> -#include <sys/mutex.h> -#include <sys/condvar.h> -#include <sys/sysctl.h> -#include <sys/sx.h> -#include <sys/unistd.h> -#include <sys/callout.h> -#include <sys/malloc.h> -#include <sys/priv.h> - -#include <dev/usb/usb_defs.h> -#include <dev/usb/usb_revision.h> - -#include "usb_if.h" - -#ifndef USB_HOST_ALIGN -#define USB_HOST_ALIGN 8 /* bytes, must be power of two */ -#endif - -#ifndef USB_FS_ISOC_UFRAME_MAX -#define USB_FS_ISOC_UFRAME_MAX 4 /* exclusive unit */ -#endif - -#if (USB_FS_ISOC_UFRAME_MAX > 6) -#error "USB_FS_ISOC_UFRAME_MAX cannot be set higher than 6" -#endif - -#ifndef USB_BUS_MAX -#define USB_BUS_MAX 256 /* units */ -#endif - -#ifndef USB_MAX_DEVICES -#define USB_MAX_DEVICES 128 /* units */ -#endif - -#if (USB_MAX_DEVICES < USB_MIN_DEVICES) -#error "Minimum number of devices is greater than maximum number of devices." -#endif - -#ifndef USB_IFACE_MAX -#define USB_IFACE_MAX 32 /* units */ -#endif - -#ifndef USB_FIFO_MAX -#define USB_FIFO_MAX 128 /* units */ -#endif - -#if (USB_FIFO_MAX & 1) -#error "Number of FIFOs must be odd." -#endif - -#define USB_MAX_FS_ISOC_FRAMES_PER_XFER (120) /* units */ -#define USB_MAX_HS_ISOC_FRAMES_PER_XFER (8*120) /* units */ - -#ifndef USB_HUB_MAX_DEPTH -#define USB_HUB_MAX_DEPTH 5 -#endif - -#ifndef USB_EP0_BUFSIZE -#define USB_EP0_BUFSIZE 1024 /* bytes */ -#endif - -/* USB transfer states */ - -#define USB_ST_SETUP 0 -#define USB_ST_TRANSFERRED 1 -#define USB_ST_ERROR 2 - -/* USB handle request states */ -#define USB_HR_NOT_COMPLETE 0 -#define USB_HR_COMPLETE_OK 1 -#define USB_HR_COMPLETE_ERR 2 - -/* - * The following macro will return the current state of an USB - * transfer like defined by the "USB_ST_XXX" enums. - */ -#define USB_GET_STATE(xfer) ((xfer)->usb_state) - /* * The following macro will tell if an USB transfer is currently * receiving or transferring data. @@ -226,30 +39,26 @@ USB_MODE_DEVICE ? (((xfer)->endpointno & UE_DIR_IN) ? 0 : 1) : \ (((xfer)->endpointno & UE_DIR_IN) ? 1 : 0)) -/* - * The following macros are used used to convert milliseconds into - * HZ. We use 1024 instead of 1000 milliseconds per second to save a - * full division. - */ -#define USB_MS_HZ 1024 - -#define USB_MS_TO_TICKS(ms) \ - (((uint32_t)((((uint32_t)(ms)) * ((uint32_t)(hz))) + USB_MS_HZ - 1)) / USB_MS_HZ) - /* macros */ -#define usb_callout_init_mtx(c,m,f) callout_init_mtx(&(c)->co,m,f) -#define usb_callout_reset(c,t,f,d) callout_reset(&(c)->co,t,f,d) -#define usb_callout_stop(c) callout_stop(&(c)->co) -#define usb_callout_drain(c) callout_drain(&(c)->co) -#define usb_callout_pending(c) callout_pending(&(c)->co) - #define USB_BUS_LOCK(_b) mtx_lock(&(_b)->bus_mtx) #define USB_BUS_UNLOCK(_b) mtx_unlock(&(_b)->bus_mtx) #define USB_BUS_LOCK_ASSERT(_b, _t) mtx_assert(&(_b)->bus_mtx, _t) #define USB_XFER_LOCK(_x) mtx_lock((_x)->xroot->xfer_mtx) #define USB_XFER_UNLOCK(_x) mtx_unlock((_x)->xroot->xfer_mtx) #define USB_XFER_LOCK_ASSERT(_x, _t) mtx_assert((_x)->xroot->xfer_mtx, _t) + +/* helper for converting pointers to integers */ +#define USB_P2U(ptr) \ + (((const uint8_t *)(ptr)) - ((const uint8_t *)0)) + +/* helper for computing offsets */ +#define USB_ADD_BYTES(ptr,size) \ + ((void *)(USB_P2U(ptr) + (size))) + +/* debug macro */ +#define USB_ASSERT KASSERT + /* structure prototypes */ struct file; @@ -263,82 +72,9 @@ struct usb_xfer_root; /* typedefs */ -typedef void (usb_callback_t)(struct usb_xfer *); - -#ifndef USB_HAVE_USB_ERROR_T -typedef uint8_t usb_error_t; /* see "USB_ERR_XXX" */ -#endif - -#ifndef USB_HAVE_TIMEOUT_T -typedef uint32_t usb_timeout_t; /* milliseconds */ -#endif - -#ifndef USB_HAVE_FRLENGTH_T -typedef uint32_t usb_frlength_t; /* bytes */ -#endif - -#ifndef USB_HAVE_FRCOUNT_T -typedef uint32_t usb_frcount_t; /* units */ -#endif - -#ifndef USB_HAVE_SIZE_T -typedef uint32_t usb_size_t; /* bytes */ -#endif - -#ifndef USB_HAVE_TICKS_T -typedef uint32_t usb_ticks_t; /* system defined */ -#endif - -#ifndef USB_HAVE_POWER_MASK_T -typedef uint16_t usb_power_mask_t; /* see "USB_HW_POWER_XXX" */ -#endif - -typedef usb_error_t (usb_handle_req_t)(struct usb_device *, - struct usb_device_request *, const void **, uint16_t *); - /* structures */ /* - * Common queue structure for USB transfers. - */ -struct usb_xfer_queue { - TAILQ_HEAD(, usb_xfer) head; - struct usb_xfer *curr; /* current USB transfer processed */ - void (*command) (struct usb_xfer_queue *pq); - uint8_t recurse_1:1; - uint8_t recurse_2:1; -}; - -/* - * The following is a wrapper for the callout structure to ease - * porting the code to other platforms. - */ -struct usb_callout { - struct callout co; -}; - -/* - * The following structure defines a set of USB transfer flags. - */ -struct usb_xfer_flags { - uint8_t force_short_xfer:1; /* force a short transmit transfer - * last */ - uint8_t short_xfer_ok:1; /* allow short receive transfers */ - uint8_t short_frames_ok:1; /* allow short frames */ - uint8_t pipe_bof:1; /* block pipe on failure */ - uint8_t proxy_buffer:1; /* makes buffer size a factor of - * "max_frame_size" */ - uint8_t ext_buffer:1; /* uses external DMA buffer */ - uint8_t manual_status:1; /* non automatic status stage on - * control transfers */ - uint8_t no_pipe_ok:1; /* set if "USB_ERR_NO_PIPE" error can - * be ignored */ - uint8_t stall_pipe:1; /* set if the endpoint belonging to - * this USB transfer should be stalled - * before starting this transfer! */ -}; - -/* * The following structure defines a set of internal USB transfer * flags. */ @@ -379,26 +115,6 @@ struct usb_xfer_flags_int { }; /* - * The following structure define an USB configuration, that basically - * is used when setting up an USB transfer. - */ -struct usb_config { - usb_callback_t *callback; /* USB transfer callback */ - usb_frlength_t bufsize; /* total pipe buffer size in bytes */ - usb_frcount_t frames; /* maximum number of USB frames */ - usb_timeout_t interval; /* interval in milliseconds */ -#define USB_DEFAULT_INTERVAL 0 - usb_timeout_t timeout; /* transfer timeout in milliseconds */ - struct usb_xfer_flags flags; /* transfer flags */ - enum usb_hc_mode usb_mode; /* host or device mode */ - uint8_t type; /* pipe type */ - uint8_t endpoint; /* pipe number */ - uint8_t direction; /* pipe direction */ - uint8_t ep_index; /* pipe index match to use */ - uint8_t if_index; /* "ifaces" index to use */ -}; - -/* * The following structure defines an USB transfer. */ struct usb_xfer { @@ -428,8 +144,6 @@ struct usb_xfer { usb_frlength_t sumlen; /* sum of all lengths in bytes */ usb_frlength_t actlen; /* actual length in bytes */ usb_timeout_t timeout; /* milliseconds */ -#define USB_NO_TIMEOUT 0 -#define USB_DEFAULT_TIMEOUT 5000 /* 5000 ms = 5 seconds */ usb_frcount_t max_frame_count; /* initial value of "nframes" after * setup */ @@ -457,89 +171,14 @@ struct usb_xfer { struct usb_xfer_flags_int flags_int; }; -/* - * The following structure keeps information that is used to match - * against an array of "usb_device_id" elements. - */ -struct usbd_lookup_info { - uint16_t idVendor; - uint16_t idProduct; - uint16_t bcdDevice; - uint8_t bDeviceClass; - uint8_t bDeviceSubClass; - uint8_t bDeviceProtocol; - uint8_t bInterfaceClass; - uint8_t bInterfaceSubClass; - uint8_t bInterfaceProtocol; - uint8_t bIfaceIndex; - uint8_t bIfaceNum; - uint8_t bConfigIndex; - uint8_t bConfigNum; -}; - -/* Structure used by probe and attach */ - -struct usb_attach_arg { - struct usbd_lookup_info info; - device_t temp_dev; /* for internal use */ - unsigned long driver_info; /* for internal use */ - void *driver_ivar; - struct usb_device *device; /* current device */ - struct usb_interface *iface; /* current interface */ - enum usb_hc_mode usb_mode; /* host or device mode */ - uint8_t port; - uint8_t use_generic; /* hint for generic drivers */ -}; - /* external variables */ -MALLOC_DECLARE(M_USB); -MALLOC_DECLARE(M_USBDEV); -MALLOC_DECLARE(M_USBHC); - extern struct mtx usb_ref_lock; -/* prototypes */ +/* typedefs */ -const char *usbd_errstr(usb_error_t error); -const char *usb_statestr(enum usb_dev_state state); -struct usb_config_descriptor *usbd_get_config_descriptor( - struct usb_device *udev); -struct usb_device_descriptor *usbd_get_device_descriptor( - struct usb_device *udev); -struct usb_interface *usbd_get_iface(struct usb_device *udev, - uint8_t iface_index); -struct usb_interface_descriptor *usbd_get_interface_descriptor( - struct usb_interface *iface); -uint8_t usbd_clear_stall_callback(struct usb_xfer *xfer1, - struct usb_xfer *xfer2); -uint8_t usbd_get_interface_altindex(struct usb_interface *iface); -usb_error_t usbd_set_alt_interface_index(struct usb_device *udev, - uint8_t iface_index, uint8_t alt_index); -enum usb_hc_mode usbd_get_mode(struct usb_device *udev); -enum usb_dev_speed usbd_get_speed(struct usb_device *udev); -uint32_t usbd_get_isoc_fps(struct usb_device *udev); -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_set_frame_data(struct usb_xfer *xfer, void *ptr, - usb_frcount_t frindex); -void usbd_set_frame_offset(struct usb_xfer *xfer, usb_frlength_t offset, - usb_frcount_t frindex); -void usbd_transfer_submit(struct usb_xfer *xfer); -void usbd_transfer_clear_stall(struct usb_xfer *xfer); -void usbd_transfer_drain(struct usb_xfer *xfer); -void usbd_transfer_set_stall(struct usb_xfer *xfer); -uint8_t usbd_transfer_pending(struct usb_xfer *xfer); -void usbd_transfer_start(struct usb_xfer *xfer); -void usbd_transfer_stop(struct usb_xfer *xfer); -void usbd_transfer_unsetup(struct usb_xfer **pxfer, uint16_t n_setup); -void usbd_set_parent_iface(struct usb_device *udev, uint8_t iface_index, - uint8_t parent_index); -uint8_t usbd_get_bus_index(struct usb_device *udev); -uint8_t usbd_get_device_index(struct usb_device *udev); -void usbd_set_power_mode(struct usb_device *udev, uint8_t power_mode); -uint8_t usbd_device_attached(struct usb_device *udev); +typedef struct malloc_type *usb_malloc_type; + +/* prototypes */ #endif /* _USB_CORE_H_ */ |
