1/*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2008-2019 Hans Petter Selasky. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 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. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28#ifndef _USB_DEVICE_H_ 29#define _USB_DEVICE_H_ 30 31struct usb_bus_methods; 32struct usb_config_descriptor; 33struct usb_device; /* linux compat */ 34struct usb_fs_privdata; 35struct usb_hw_ep_profile; 36struct usb_symlink; /* UGEN */ 37 38#define USB_CTRL_XFER_MAX 2 39 40/* "usb_config_parse()" commands */ 41 42#define USB_CFG_ALLOC 0 43#define USB_CFG_FREE 1 44#define USB_CFG_INIT 2 45 46/* "usb_unconfigure()" flags */ 47 48#define USB_UNCFG_FLAG_NONE 0x00 49#define USB_UNCFG_FLAG_FREE_EP0 0x02 /* endpoint zero is freed */ 50 51struct usb_udev_msg { 52 struct usb_proc_msg hdr; 53 struct usb_device *udev; 54}; 55 56/* The following four structures makes up a tree, where we have the 57 * leaf structure, "usb_host_endpoint", first, and the root structure, 58 * "usb_device", last. The four structures below mirror the structure 59 * of the USB descriptors belonging to an USB configuration. Please 60 * refer to the USB specification for a definition of "endpoints" and 61 * "interfaces". 62 */ 63struct usb_host_endpoint { 64 struct usb_endpoint_descriptor desc; 65 TAILQ_HEAD(, urb) bsd_urb_list; 66 struct usb_xfer *bsd_xfer[2]; 67 uint8_t *extra; /* Extra descriptors */ 68 usb_frlength_t fbsd_buf_size; 69 uint16_t extralen; 70 uint8_t bsd_iface_index; 71} __aligned(USB_HOST_ALIGN); 72 73struct usb_host_interface { 74 struct usb_interface_descriptor desc; 75 /* the following array has size "desc.bNumEndpoint" */ 76 struct usb_host_endpoint *endpoint; 77 const char *string; /* iInterface string, if present */ 78 uint8_t *extra; /* Extra descriptors */ 79 uint16_t extralen; 80 uint8_t bsd_iface_index; 81} __aligned(USB_HOST_ALIGN); 82 83/* 84 * The following structure defines the USB device flags. 85 */ 86struct usb_device_flags { 87 enum usb_hc_mode usb_mode; /* host or device mode */ 88 uint8_t self_powered:1; /* set if USB device is self powered */ 89 uint8_t no_strings:1; /* set if USB device does not support 90 * strings */ 91 uint8_t remote_wakeup:1; /* set if remote wakeup is enabled */ 92 uint8_t uq_bus_powered:1; /* set if BUS powered quirk is present */ 93 94 /* 95 * NOTE: Although the flags below will reach the same value 96 * over time, but the instant values may differ, and 97 * consequently the flags cannot be merged into one! 98 */ 99 uint8_t peer_suspended:1; /* set if peer is suspended */ 100 uint8_t self_suspended:1; /* set if self is suspended */ 101}; 102 103/* 104 * The following structure is used for power-save purposes. The data 105 * in this structure is protected by the USB BUS lock. 106 */ 107struct usb_power_save { 108 usb_ticks_t last_xfer_time; /* copy of "ticks" */ 109 usb_size_t type_refs[4]; /* transfer reference count */ 110 usb_size_t read_refs; /* data read references */ 111 usb_size_t write_refs; /* data write references */ 112}; 113 114/* 115 * The following structure is used when trying to allocate hardware 116 * endpoints for an USB configuration in USB device side mode. 117 */ 118struct usb_hw_ep_scratch_sub { 119 const struct usb_hw_ep_profile *pf; 120 uint16_t max_frame_size; 121 uint8_t hw_endpoint_out; 122 uint8_t hw_endpoint_in; 123 uint8_t needs_ep_type; 124 uint8_t needs_in:1; 125 uint8_t needs_out:1; 126}; 127 128/* 129 * The following structure is used when trying to allocate hardware 130 * endpoints for an USB configuration in USB device side mode. 131 */ 132struct usb_hw_ep_scratch { 133 struct usb_hw_ep_scratch_sub ep[USB_EP_MAX]; 134 struct usb_hw_ep_scratch_sub *ep_max; 135 struct usb_config_descriptor *cd; 136 struct usb_device *udev; 137 const struct usb_bus_methods *methods; 138 uint8_t bmOutAlloc[(USB_EP_MAX + 15) / 16]; 139 uint8_t bmInAlloc[(USB_EP_MAX + 15) / 16]; 140}; 141 142/* 143 * The following structure is used when generating USB descriptors 144 * from USB templates. 145 */ 146struct usb_temp_setup { 147 void *buf; 148 usb_size_t size; 149 enum usb_dev_speed usb_speed; 150 uint8_t self_powered; 151 uint8_t bNumEndpoints; 152 uint8_t bInterfaceNumber; 153 uint8_t bAlternateSetting; 154 uint8_t bConfigurationValue; 155 usb_error_t err; 156}; 157 158/* 159 * The scratch area for USB devices. Access to this structure is 160 * protected by the control SX lock. 161 */ 162union usb_device_scratch { 163 struct usb_hw_ep_scratch hw_ep_scratch[1]; 164 struct usb_temp_setup temp_setup[1]; 165 struct { 166 struct usb_xfer dummy; 167 struct usb_setup_params parm; 168 } xfer_setup[1]; 169 uint8_t data[255]; 170}; 171 172/* 173 * Helper structure to keep track of USB device statistics. 174 */ 175struct usb_device_statistics { 176 uint32_t uds_requests[4]; 177}; 178 179/* 180 * The following structure defines an USB device. There exists one of 181 * these structures for every USB device. 182 */ 183struct usb_device { 184 /* statistics */ 185 struct usb_device_statistics stats_err; 186 struct usb_device_statistics stats_ok; 187 struct usb_device_statistics stats_cancelled; 188 189 /* generic clear stall message */ 190 struct usb_udev_msg cs_msg[2]; 191 struct sx enum_sx; 192 struct sx sr_sx; 193 struct sx ctrl_sx; 194 struct mtx device_mtx; 195 struct cv ctrlreq_cv; 196 struct cv ref_cv; 197#if (USB_HAVE_FIXED_IFACE == 0) 198 struct usb_interface *ifaces; 199#else 200 struct usb_interface ifaces[USB_IFACE_MAX]; 201#endif 202 struct usb_endpoint ctrl_ep; /* Control Endpoint 0 */ 203#if (USB_HAVE_FIXED_ENDPOINT == 0) 204 struct usb_endpoint *endpoints; 205#else 206 struct usb_endpoint endpoints[USB_MAX_EP_UNITS]; 207#endif 208 struct usb_power_save pwr_save;/* power save data */ 209 struct usb_bus *bus; /* our USB BUS */ 210 device_t parent_dev; /* parent device */ 211 struct usb_device *parent_hub; 212 struct usb_device *parent_hs_hub; /* high-speed parent HUB */ 213 struct usb_config_descriptor *cdesc; /* full config descr */ 214 struct usb_hub *hub; /* only if this is a hub */ 215 struct usb_xfer *ctrl_xfer[USB_CTRL_XFER_MAX]; 216 struct usb_temp_data *usb_template_ptr; 217 struct usb_endpoint *ep_curr; /* current clear stall endpoint */ 218#if USB_HAVE_UGEN 219 struct usb_fifo *fifo[USB_FIFO_MAX]; 220 struct usb_symlink *ugen_symlink; /* our generic symlink */ 221 struct usb_fs_privdata *ctrl_dev; /* Control Endpoint 0 device node */ 222 LIST_HEAD(,usb_fs_privdata) pd_list; 223 char ugen_name[20]; /* name of ugenX.X device */ 224#endif 225 usb_ticks_t plugtime; /* copy of "ticks" */ 226 227 enum usb_dev_state state; 228 enum usb_dev_speed speed; 229 uint16_t refcount; 230#define USB_DEV_REF_MAX 0xffff 231 232 uint16_t power; /* mA the device uses */ 233 uint16_t langid; /* language for strings */ 234 uint16_t autoQuirk[USB_MAX_AUTO_QUIRK]; /* dynamic quirks */ 235 236 uint8_t address; /* device addess */ 237 uint8_t device_index; /* device index in "bus->devices" */ 238 uint8_t controller_slot_id; /* controller specific value */ 239 uint8_t next_config_index; /* used by USB_RE_ENUM_SET_CONFIG */ 240 uint8_t curr_config_index; /* current configuration index */ 241 uint8_t curr_config_no; /* current configuration number */ 242 uint8_t depth; /* distance from root HUB */ 243 uint8_t port_index; /* parent HUB port index */ 244 uint8_t port_no; /* parent HUB port number */ 245 uint8_t hs_hub_addr; /* high-speed HUB address */ 246 uint8_t hs_port_no; /* high-speed HUB port number */ 247 uint8_t driver_added_refcount; /* our driver added generation count */ 248 uint8_t power_mode; /* see USB_POWER_XXX */ 249 uint8_t re_enumerate_wait; /* set if re-enum. is in progress */ 250#define USB_RE_ENUM_DONE 0 251#define USB_RE_ENUM_START 1 252#define USB_RE_ENUM_PWR_OFF 2 253#define USB_RE_ENUM_SET_CONFIG 3 254 uint8_t ifaces_max; /* number of interfaces present */ 255 uint8_t endpoints_max; /* number of endpoints present */ 256 257 /* the "flags" field is write-protected by "bus->mtx" */ 258 259 struct usb_device_flags flags; 260 261 struct usb_endpoint_descriptor ctrl_ep_desc; /* for endpoint 0 */ 262 struct usb_endpoint_ss_comp_descriptor ctrl_ep_comp_desc; /* for endpoint 0 */ 263 struct usb_device_descriptor ddesc; /* device descriptor */ 264 265 char *serial; /* serial number, can be NULL */ 266 char *manufacturer; /* manufacturer string, can be NULL */ 267 char *product; /* product string, can be NULL */ 268 269#if USB_HAVE_COMPAT_LINUX 270 /* Linux compat */ 271 struct usb_device_descriptor descriptor; 272 struct usb_host_endpoint ep0; 273 struct usb_interface *linux_iface_start; 274 struct usb_interface *linux_iface_end; 275 struct usb_host_endpoint *linux_endpoint_start; 276 struct usb_host_endpoint *linux_endpoint_end; 277 uint16_t devnum; 278#endif 279 280 uint32_t clear_stall_errors; /* number of clear-stall failures */ 281 282 union usb_device_scratch scratch; 283 284#if (USB_HAVE_FIXED_CONFIG != 0) 285 uint32_t config_data[(USB_CONFIG_MAX + 3) / 4]; 286#endif 287}; 288 289/* globals */ 290 291extern int usb_template; 292 293/* function prototypes */ 294 295const char *usb_statestr(enum usb_dev_state state); 296struct usb_device *usb_alloc_device(device_t parent_dev, struct usb_bus *bus, 297 struct usb_device *parent_hub, uint8_t depth, 298 uint8_t port_index, uint8_t port_no, 299 enum usb_dev_speed speed, enum usb_hc_mode mode); 300#if USB_HAVE_UGEN 301struct usb_fs_privdata *usb_make_dev(struct usb_device *, const char *, 302 int, int, int, uid_t, gid_t, int); 303void usb_destroy_dev(struct usb_fs_privdata *); 304void usb_destroy_dev_sync(struct usb_fs_privdata *); 305#endif 306usb_error_t usb_probe_and_attach(struct usb_device *udev, 307 uint8_t iface_index); 308void usb_detach_device(struct usb_device *, uint8_t, uint8_t); 309usb_error_t usb_reset_iface_endpoints(struct usb_device *udev, 310 uint8_t iface_index); 311usb_error_t usbd_set_config_index(struct usb_device *udev, uint8_t index); 312usb_error_t usbd_set_endpoint_stall(struct usb_device *udev, 313 struct usb_endpoint *ep, uint8_t do_stall); 314usb_error_t usb_suspend_resume(struct usb_device *udev, 315 uint8_t do_suspend); 316void usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len); 317void usb_free_device(struct usb_device *, uint8_t); 318void usb_linux_free_device(struct usb_device *dev); 319uint8_t usb_peer_can_wakeup(struct usb_device *udev); 320struct usb_endpoint *usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep); 321void usb_set_device_state(struct usb_device *, enum usb_dev_state); 322enum usb_dev_state usb_get_device_state(struct usb_device *); 323 324void usb_set_device_strings(struct usb_device *); 325void usb_get_langid(struct usb_device *); 326 327uint8_t usbd_enum_lock(struct usb_device *); 328#if USB_HAVE_UGEN 329uint8_t usbd_enum_lock_sig(struct usb_device *); 330#endif 331void usbd_enum_unlock(struct usb_device *); 332void usbd_sr_lock(struct usb_device *); 333void usbd_sr_unlock(struct usb_device *); 334uint8_t usbd_ctrl_lock(struct usb_device *); 335void usbd_ctrl_unlock(struct usb_device *); 336uint8_t usbd_enum_is_locked(struct usb_device *); 337 338uint8_t usb_port_status_get(void); 339#if USB_HAVE_TT_SUPPORT 340void uhub_tt_buffer_reset_async_locked(struct usb_device *, struct usb_endpoint *); 341#endif 342 343uint8_t uhub_count_active_host_ports(struct usb_device *, enum usb_dev_speed); 344 345#endif /* _USB_DEVICE_H_ */ 346