usb_device.h revision 222786
1/* $FreeBSD: head/sys/dev/usb/usb_device.h 222786 2011-06-06 21:45:09Z hselasky $ */ 2/*- 3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27#ifndef _USB_DEVICE_H_ 28#define _USB_DEVICE_H_ 29 30struct usb_symlink; /* UGEN */ 31struct usb_device; /* linux compat */ 32 33#define USB_CTRL_XFER_MAX 2 34 35/* "usb_parse_config()" commands */ 36 37#define USB_CFG_ALLOC 0 38#define USB_CFG_FREE 1 39#define USB_CFG_INIT 2 40 41/* "usb_unconfigure()" flags */ 42 43#define USB_UNCFG_FLAG_NONE 0x00 44#define USB_UNCFG_FLAG_FREE_EP0 0x02 /* endpoint zero is freed */ 45 46struct usb_clear_stall_msg { 47 struct usb_proc_msg hdr; 48 struct usb_device *udev; 49}; 50 51/* The following four structures makes up a tree, where we have the 52 * leaf structure, "usb_host_endpoint", first, and the root structure, 53 * "usb_device", last. The four structures below mirror the structure 54 * of the USB descriptors belonging to an USB configuration. Please 55 * refer to the USB specification for a definition of "endpoints" and 56 * "interfaces". 57 */ 58struct usb_host_endpoint { 59 struct usb_endpoint_descriptor desc; 60 TAILQ_HEAD(, urb) bsd_urb_list; 61 struct usb_xfer *bsd_xfer[2]; 62 uint8_t *extra; /* Extra descriptors */ 63 usb_frlength_t fbsd_buf_size; 64 uint16_t extralen; 65 uint8_t bsd_iface_index; 66} __aligned(USB_HOST_ALIGN); 67 68struct usb_host_interface { 69 struct usb_interface_descriptor desc; 70 /* the following array has size "desc.bNumEndpoint" */ 71 struct usb_host_endpoint *endpoint; 72 const char *string; /* iInterface string, if present */ 73 uint8_t *extra; /* Extra descriptors */ 74 uint16_t extralen; 75 uint8_t bsd_iface_index; 76} __aligned(USB_HOST_ALIGN); 77 78/* 79 * The following structure defines the USB device flags. 80 */ 81struct usb_device_flags { 82 enum usb_hc_mode usb_mode; /* host or device mode */ 83 uint8_t self_powered:1; /* set if USB device is self powered */ 84 uint8_t no_strings:1; /* set if USB device does not support 85 * strings */ 86 uint8_t remote_wakeup:1; /* set if remote wakeup is enabled */ 87 uint8_t uq_bus_powered:1; /* set if BUS powered quirk is present */ 88 89 /* 90 * NOTE: Although the flags below will reach the same value 91 * over time, but the instant values may differ, and 92 * consequently the flags cannot be merged into one! 93 */ 94 uint8_t peer_suspended:1; /* set if peer is suspended */ 95 uint8_t self_suspended:1; /* set if self is suspended */ 96}; 97 98/* 99 * The following structure is used for power-save purposes. The data 100 * in this structure is protected by the USB BUS lock. 101 */ 102struct usb_power_save { 103 usb_ticks_t last_xfer_time; /* copy of "ticks" */ 104 usb_size_t type_refs[4]; /* transfer reference count */ 105 usb_size_t read_refs; /* data read references */ 106 usb_size_t write_refs; /* data write references */ 107}; 108 109/* 110 * The following structure defines an USB device. There exists one of 111 * these structures for every USB device. 112 */ 113struct usb_device { 114 struct usb_clear_stall_msg cs_msg[2]; /* generic clear stall 115 * messages */ 116 struct sx ctrl_sx; 117 struct sx enum_sx; 118 struct sx sr_sx; 119 struct mtx device_mtx; 120 struct cv ctrlreq_cv; 121 struct cv ref_cv; 122 struct usb_interface *ifaces; 123 struct usb_endpoint ctrl_ep; /* Control Endpoint 0 */ 124 struct usb_endpoint *endpoints; 125 struct usb_power_save pwr_save;/* power save data */ 126 struct usb_bus *bus; /* our USB BUS */ 127 device_t parent_dev; /* parent device */ 128 struct usb_device *parent_hub; 129 struct usb_device *parent_hs_hub; /* high-speed parent HUB */ 130 struct usb_config_descriptor *cdesc; /* full config descr */ 131 struct usb_hub *hub; /* only if this is a hub */ 132 struct usb_xfer *ctrl_xfer[USB_CTRL_XFER_MAX]; 133 struct usb_temp_data *usb_template_ptr; 134 struct usb_endpoint *ep_curr; /* current clear stall endpoint */ 135#if USB_HAVE_UGEN 136 struct usb_fifo *fifo[USB_FIFO_MAX]; 137 struct usb_symlink *ugen_symlink; /* our generic symlink */ 138 struct cdev *ctrl_dev; /* Control Endpoint 0 device node */ 139 LIST_HEAD(,usb_fs_privdata) pd_list; 140 char ugen_name[20]; /* name of ugenX.X device */ 141#endif 142 usb_ticks_t plugtime; /* copy of "ticks" */ 143 144 enum usb_dev_state state; 145 enum usb_dev_speed speed; 146 uint16_t refcount; 147#define USB_DEV_REF_MAX 0xffff 148 149 uint16_t power; /* mA the device uses */ 150 uint16_t langid; /* language for strings */ 151 152 uint8_t address; /* device addess */ 153 uint8_t device_index; /* device index in "bus->devices" */ 154 uint8_t controller_slot_id; /* controller specific value */ 155 uint8_t curr_config_index; /* current configuration index */ 156 uint8_t curr_config_no; /* current configuration number */ 157 uint8_t depth; /* distance from root HUB */ 158 uint8_t port_index; /* parent HUB port index */ 159 uint8_t port_no; /* parent HUB port number */ 160 uint8_t hs_hub_addr; /* high-speed HUB address */ 161 uint8_t hs_port_no; /* high-speed HUB port number */ 162 uint8_t driver_added_refcount; /* our driver added generation count */ 163 uint8_t power_mode; /* see USB_POWER_XXX */ 164 uint8_t re_enumerate_wait; /* set if re-enum. is in progress */ 165 uint8_t ifaces_max; /* number of interfaces present */ 166 uint8_t endpoints_max; /* number of endpoints present */ 167 168 /* the "flags" field is write-protected by "bus->mtx" */ 169 170 struct usb_device_flags flags; 171 172 struct usb_endpoint_descriptor ctrl_ep_desc; /* for endpoint 0 */ 173 struct usb_endpoint_ss_comp_descriptor ctrl_ep_comp_desc; /* for endpoint 0 */ 174 struct usb_device_descriptor ddesc; /* device descriptor */ 175 176 char *serial; /* serial number, can be NULL */ 177 char *manufacturer; /* manufacturer string, can be NULL */ 178 char *product; /* product string, can be NULL */ 179 180#if USB_HAVE_COMPAT_LINUX 181 /* Linux compat */ 182 struct usb_device_descriptor descriptor; 183 struct usb_host_endpoint ep0; 184 struct usb_interface *linux_iface_start; 185 struct usb_interface *linux_iface_end; 186 struct usb_host_endpoint *linux_endpoint_start; 187 struct usb_host_endpoint *linux_endpoint_end; 188 uint16_t devnum; 189#endif 190 191 uint32_t clear_stall_errors; /* number of clear-stall failures */ 192}; 193 194/* globals */ 195 196extern int usb_template; 197 198/* function prototypes */ 199 200const char *usb_statestr(enum usb_dev_state state); 201struct usb_device *usb_alloc_device(device_t parent_dev, struct usb_bus *bus, 202 struct usb_device *parent_hub, uint8_t depth, 203 uint8_t port_index, uint8_t port_no, 204 enum usb_dev_speed speed, enum usb_hc_mode mode); 205usb_error_t usb_probe_and_attach(struct usb_device *udev, 206 uint8_t iface_index); 207void usb_detach_device(struct usb_device *, uint8_t, uint8_t); 208usb_error_t usb_reset_iface_endpoints(struct usb_device *udev, 209 uint8_t iface_index); 210usb_error_t usbd_set_config_index(struct usb_device *udev, uint8_t index); 211usb_error_t usbd_set_endpoint_stall(struct usb_device *udev, 212 struct usb_endpoint *ep, uint8_t do_stall); 213usb_error_t usb_suspend_resume(struct usb_device *udev, 214 uint8_t do_suspend); 215void usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len); 216void usb_free_device(struct usb_device *, uint8_t); 217void usb_linux_free_device(struct usb_device *dev); 218uint8_t usb_peer_can_wakeup(struct usb_device *udev); 219struct usb_endpoint *usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep); 220void usb_set_device_state(struct usb_device *, enum usb_dev_state); 221enum usb_dev_state usb_get_device_state(struct usb_device *); 222 223void usbd_enum_lock(struct usb_device *); 224void usbd_enum_unlock(struct usb_device *); 225void usbd_sr_lock(struct usb_device *); 226void usbd_sr_unlock(struct usb_device *); 227uint8_t usbd_enum_is_locked(struct usb_device *); 228 229#endif /* _USB_DEVICE_H_ */ 230