usb_device.h revision 208008
150276Speter/* $FreeBSD: head/sys/dev/usb/usb_device.h 208008 2010-05-12 22:42:35Z thompsa $ */ 262453Speter/*- 350276Speter * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 450276Speter * 550276Speter * Redistribution and use in source and binary forms, with or without 650276Speter * modification, are permitted provided that the following conditions 750276Speter * are met: 850276Speter * 1. Redistributions of source code must retain the above copyright 950276Speter * notice, this list of conditions and the following disclaimer. 1050276Speter * 2. Redistributions in binary form must reproduce the above copyright 1150276Speter * notice, this list of conditions and the following disclaimer in the 1250276Speter * documentation and/or other materials provided with the distribution. 1350276Speter * 1450276Speter * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1550276Speter * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1650276Speter * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1750276Speter * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1850276Speter * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1950276Speter * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2050276Speter * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2150276Speter * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2250276Speter * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2350276Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2450276Speter * SUCH DAMAGE. 2550276Speter */ 2650276Speter 2750276Speter#ifndef _USB_DEVICE_H_ 2850276Speter#define _USB_DEVICE_H_ 2950276Speter 3050276Speterstruct usb_symlink; /* UGEN */ 3150276Speterstruct usb_device; /* linux compat */ 3250276Speter 3350276Speter#define USB_CTRL_XFER_MAX 2 3462453Speter 3562453Speter/* "usb_parse_config()" commands */ 3650276Speter 3750276Speter#define USB_CFG_ALLOC 0 3850276Speter#define USB_CFG_FREE 1 3950276Speter#define USB_CFG_INIT 2 4050276Speter 4150276Speter/* "usb_unconfigure()" flags */ 4250276Speter 4350276Speter#define USB_UNCFG_FLAG_NONE 0x00 4450276Speter#define USB_UNCFG_FLAG_FREE_EP0 0x02 /* endpoint zero is freed */ 4550276Speter 4650276Speterstruct usb_clear_stall_msg { 4750276Speter struct usb_proc_msg hdr; 4850276Speter struct usb_device *udev; 4950276Speter}; 5050276Speter 5150276Speter/* The following four structures makes up a tree, where we have the 5262453Speter * leaf structure, "usb_host_endpoint", first, and the root structure, 5350276Speter * "usb_device", last. The four structures below mirror the structure 5450276Speter * of the USB descriptors belonging to an USB configuration. Please 5566967Speter * refer to the USB specification for a definition of "endpoints" and 5650276Speter * "interfaces". 5750276Speter */ 5850276Speterstruct usb_host_endpoint { 5950276Speter struct usb_endpoint_descriptor desc; 6050276Speter TAILQ_HEAD(, urb) bsd_urb_list; 6150276Speter struct usb_xfer *bsd_xfer[2]; 6250276Speter uint8_t *extra; /* Extra descriptors */ 6350276Speter usb_frlength_t fbsd_buf_size; 6450276Speter uint16_t extralen; 6562453Speter uint8_t bsd_iface_index; 6662453Speter} __aligned(USB_HOST_ALIGN); 6762453Speter 6862453Speterstruct usb_host_interface { 6962453Speter struct usb_interface_descriptor desc; 7050276Speter /* the following array has size "desc.bNumEndpoint" */ 7162453Speter struct usb_host_endpoint *endpoint; 7262453Speter const char *string; /* iInterface string, if present */ 7362453Speter uint8_t *extra; /* Extra descriptors */ 7450276Speter uint16_t extralen; 7550276Speter uint8_t bsd_iface_index; 7650276Speter} __aligned(USB_HOST_ALIGN); 7750276Speter 7850276Speter/* 7950276Speter * The following structure defines the USB device flags. 8050276Speter */ 8150276Speterstruct usb_device_flags { 8250276Speter enum usb_hc_mode usb_mode; /* host or device mode */ 8362453Speter uint8_t self_powered:1; /* set if USB device is self powered */ 8450276Speter uint8_t no_strings:1; /* set if USB device does not support 8566967Speter * strings */ 8666967Speter uint8_t remote_wakeup:1; /* set if remote wakeup is enabled */ 8766967Speter uint8_t uq_bus_powered:1; /* set if BUS powered quirk is present */ 8866967Speter 8962453Speter /* 9062453Speter * NOTE: Although the flags below will reach the same value 9150276Speter * over time, but the instant values may differ, and 9250276Speter * consequently the flags cannot be merged into one! 9350276Speter */ 9450276Speter uint8_t peer_suspended:1; /* set if peer is suspended */ 9550276Speter uint8_t self_suspended:1; /* set if self is suspended */ 9662453Speter}; 9762453Speter 9850276Speter/* 9962453Speter * The following structure is used for power-save purposes. The data 10062453Speter * in this structure is protected by the USB BUS lock. 10162453Speter */ 10262453Speterstruct usb_power_save { 10350276Speter usb_ticks_t last_xfer_time; /* copy of "ticks" */ 10450276Speter usb_size_t type_refs[4]; /* transfer reference count */ 10550276Speter usb_size_t read_refs; /* data read references */ 10650276Speter usb_size_t write_refs; /* data write references */ 10750276Speter}; 10850276Speter 10950276Speter/* 11050276Speter * The following structure defines an USB device. There exists one of 11150276Speter * these structures for every USB device. 11250276Speter */ 11350276Speterstruct usb_device { 11450276Speter struct usb_clear_stall_msg cs_msg[2]; /* generic clear stall 11550276Speter * messages */ 11650276Speter struct sx ctrl_sx; 11750276Speter struct sx enum_sx; 11850276Speter struct sx sr_sx; 11950276Speter struct mtx device_mtx; 12050276Speter struct cv ctrlreq_cv; 12150276Speter struct cv ref_cv; 12250276Speter struct usb_interface *ifaces; 12350276Speter struct usb_endpoint ctrl_ep; /* Control Endpoint 0 */ 12450276Speter struct usb_endpoint *endpoints; 12550276Speter struct usb_power_save pwr_save;/* power save data */ 12650276Speter struct usb_bus *bus; /* our USB BUS */ 12750276Speter device_t parent_dev; /* parent device */ 12850276Speter struct usb_device *parent_hub; 12950276Speter struct usb_device *parent_hs_hub; /* high-speed parent HUB */ 13050276Speter struct usb_config_descriptor *cdesc; /* full config descr */ 13150276Speter struct usb_hub *hub; /* only if this is a hub */ 13250276Speter struct usb_xfer *ctrl_xfer[USB_CTRL_XFER_MAX]; 13350276Speter struct usb_temp_data *usb_template_ptr; 13450276Speter struct usb_endpoint *ep_curr; /* current clear stall endpoint */ 13550276Speter#if USB_HAVE_UGEN 13650276Speter struct usb_fifo *fifo[USB_FIFO_MAX]; 13750276Speter struct usb_symlink *ugen_symlink; /* our generic symlink */ 13862453Speter struct cdev *ctrl_dev; /* Control Endpoint 0 device node */ 13962453Speter LIST_HEAD(,usb_fs_privdata) pd_list; 14050276Speter char ugen_name[20]; /* name of ugenX.X device */ 14162453Speter#endif 14262453Speter usb_ticks_t plugtime; /* copy of "ticks" */ 14362453Speter 14462453Speter enum usb_dev_state state; 14562453Speter enum usb_dev_speed speed; 14662453Speter uint16_t refcount; 14762453Speter#define USB_DEV_REF_MAX 0xffff 14862453Speter 14962453Speter uint16_t power; /* mA the device uses */ 15062453Speter uint16_t langid; /* language for strings */ 15162453Speter 15250276Speter uint8_t address; /* device addess */ 15362453Speter uint8_t device_index; /* device index in "bus->devices" */ 15462453Speter uint8_t curr_config_index; /* current configuration index */ 15550276Speter uint8_t curr_config_no; /* current configuration number */ 15662453Speter uint8_t depth; /* distance from root HUB */ 15762453Speter uint8_t port_index; /* parent HUB port index */ 15866967Speter uint8_t port_no; /* parent HUB port number */ 15950276Speter uint8_t hs_hub_addr; /* high-speed HUB address */ 16062453Speter uint8_t hs_port_no; /* high-speed HUB port number */ 16162453Speter uint8_t driver_added_refcount; /* our driver added generation count */ 16250276Speter uint8_t power_mode; /* see USB_POWER_XXX */ 16362453Speter uint8_t ifaces_max; /* number of interfaces present */ 16462453Speter uint8_t endpoints_max; /* number of endpoints present */ 16562453Speter 16650276Speter /* the "flags" field is write-protected by "bus->mtx" */ 16762453Speter 16862453Speter struct usb_device_flags flags; 16950276Speter 17062453Speter struct usb_endpoint_descriptor ctrl_ep_desc; /* for endpoint 0 */ 17162453Speter struct usb_device_descriptor ddesc; /* device descriptor */ 17262453Speter 17362453Speter char *serial; /* serial number */ 17450276Speter char *manufacturer; /* manufacturer string */ 17562453Speter char *product; /* product string */ 17650276Speter 17762453Speter#if USB_HAVE_COMPAT_LINUX 17862453Speter /* Linux compat */ 17962453Speter struct usb_device_descriptor descriptor; 18062453Speter struct usb_host_endpoint ep0; 18162453Speter struct usb_interface *linux_iface_start; 18262453Speter struct usb_interface *linux_iface_end; 18350276Speter struct usb_host_endpoint *linux_endpoint_start; 18462453Speter struct usb_host_endpoint *linux_endpoint_end; 18566967Speter uint16_t devnum; 18666967Speter#endif 18762453Speter}; 18866967Speter 18962453Speter/* globals */ 19062453Speter 19150276Speterextern int usb_template; 19262453Speter 19362453Speter/* function prototypes */ 19462453Speter 19550276Speterconst char *usb_statestr(enum usb_dev_state state); 19662453Speterstruct usb_device *usb_alloc_device(device_t parent_dev, struct usb_bus *bus, 19762453Speter struct usb_device *parent_hub, uint8_t depth, 19862453Speter uint8_t port_index, uint8_t port_no, 19962453Speter enum usb_dev_speed speed, enum usb_hc_mode mode); 20050276Speterusb_error_t usb_probe_and_attach(struct usb_device *udev, 20162453Speter uint8_t iface_index); 20262453Spetervoid usb_detach_device(struct usb_device *, uint8_t, uint8_t); 20366967Speterusb_error_t usb_reset_iface_endpoints(struct usb_device *udev, 20466967Speter uint8_t iface_index); 20562453Speterusb_error_t usbd_set_config_index(struct usb_device *udev, uint8_t index); 20666967Speterusb_error_t usbd_set_endpoint_stall(struct usb_device *udev, 20762453Speter struct usb_endpoint *ep, uint8_t do_stall); 20866967Speterusb_error_t usb_suspend_resume(struct usb_device *udev, 20962453Speter uint8_t do_suspend); 21062453Spetervoid usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len); 21162453Spetervoid usb_free_device(struct usb_device *, uint8_t); 21250276Spetervoid usb_linux_free_device(struct usb_device *dev); 21362453Speteruint8_t usb_peer_can_wakeup(struct usb_device *udev); 21462453Speterstruct usb_endpoint *usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep); 21550276Spetervoid usb_set_device_state(struct usb_device *udev, 21662453Speter enum usb_dev_state state); 21762453Spetervoid usbd_enum_lock(struct usb_device *); 21850276Spetervoid usbd_enum_unlock(struct usb_device *); 21962453Spetervoid usbd_sr_lock(struct usb_device *); 22062453Spetervoid usbd_sr_unlock(struct usb_device *); 22162453Speteruint8_t usbd_enum_is_locked(struct usb_device *); 22250276Speter 22362453Speter#endif /* _USB_DEVICE_H_ */ 22462453Speter