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