1 /* $FreeBSD: head/sys/dev/usb/usb_device.h 267240 2014-06-08 20:10:29Z hselasky $ */
3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #ifndef _USB_DEVICE_H_
28 #define _USB_DEVICE_H_
30 #include <bus/u4b/usb_core.h>
31 #include <bus/u4b/usb_busdma.h>
32 #include <bus/u4b/usb_transfer.h>
34 struct usb_bus_methods;
35 struct usb_config_descriptor;
36 struct usb_device; /* linux compat */
37 struct usb_fs_privdata;
38 struct usb_hw_ep_profile;
39 struct usb_symlink; /* UGEN */
41 #define USB_CTRL_XFER_MAX 2
43 /* "usb_config_parse()" commands */
45 #define USB_CFG_ALLOC 0
46 #define USB_CFG_FREE 1
47 #define USB_CFG_INIT 2
49 /* "usb_unconfigure()" flags */
51 #define USB_UNCFG_FLAG_NONE 0x00
52 #define USB_UNCFG_FLAG_FREE_EP0 0x02 /* endpoint zero is freed */
55 struct usb_proc_msg hdr;
56 struct usb_device *udev;
59 /* The following four structures makes up a tree, where we have the
60 * leaf structure, "usb_host_endpoint", first, and the root structure,
61 * "usb_device", last. The four structures below mirror the structure
62 * of the USB descriptors belonging to an USB configuration. Please
63 * refer to the USB specification for a definition of "endpoints" and
66 struct usb_host_endpoint {
67 struct usb_endpoint_descriptor desc;
68 TAILQ_HEAD(, urb) bsd_urb_list;
69 struct usb_xfer *bsd_xfer[2];
70 uint8_t *extra; /* Extra descriptors */
71 usb_frlength_t fbsd_buf_size;
73 uint8_t bsd_iface_index;
74 } __aligned(USB_HOST_ALIGN);
76 struct usb_host_interface {
77 struct usb_interface_descriptor desc;
78 /* the following array has size "desc.bNumEndpoint" */
79 struct usb_host_endpoint *endpoint;
80 const char *string; /* iInterface string, if present */
81 uint8_t *extra; /* Extra descriptors */
83 uint8_t bsd_iface_index;
84 } __aligned(USB_HOST_ALIGN);
87 * The following structure defines the USB device flags.
89 struct usb_device_flags {
90 enum usb_hc_mode usb_mode; /* host or device mode */
91 uint8_t self_powered:1; /* set if USB device is self powered */
92 uint8_t no_strings:1; /* set if USB device does not support
94 uint8_t remote_wakeup:1; /* set if remote wakeup is enabled */
95 uint8_t uq_bus_powered:1; /* set if BUS powered quirk is present */
98 * NOTE: Although the flags below will reach the same value
99 * over time, but the instant values may differ, and
100 * consequently the flags cannot be merged into one!
102 uint8_t peer_suspended:1; /* set if peer is suspended */
103 uint8_t self_suspended:1; /* set if self is suspended */
107 * The following structure is used for power-save purposes. The data
108 * in this structure is protected by the USB BUS lock.
110 struct usb_power_save {
111 usb_ticks_t last_xfer_time; /* copy of "ticks" */
112 usb_size_t type_refs[4]; /* transfer reference count */
113 usb_size_t read_refs; /* data read references */
114 usb_size_t write_refs; /* data write references */
118 * The following structure is used when trying to allocate hardware
119 * endpoints for an USB configuration in USB device side mode.
121 struct usb_hw_ep_scratch_sub {
122 const struct usb_hw_ep_profile *pf;
123 uint16_t max_frame_size;
124 uint8_t hw_endpoint_out;
125 uint8_t hw_endpoint_in;
126 uint8_t needs_ep_type;
132 * The following structure is used when trying to allocate hardware
133 * endpoints for an USB configuration in USB device side mode.
135 struct usb_hw_ep_scratch {
136 struct usb_hw_ep_scratch_sub ep[USB_EP_MAX];
137 struct usb_hw_ep_scratch_sub *ep_max;
138 struct usb_config_descriptor *cd;
139 struct usb_device *udev;
140 const struct usb_bus_methods *methods;
141 uint8_t bmOutAlloc[(USB_EP_MAX + 15) / 16];
142 uint8_t bmInAlloc[(USB_EP_MAX + 15) / 16];
146 * The following structure is used when generating USB descriptors
147 * from USB templates.
149 struct usb_temp_setup {
152 enum usb_dev_speed usb_speed;
153 uint8_t self_powered;
154 uint8_t bNumEndpoints;
155 uint8_t bInterfaceNumber;
156 uint8_t bAlternateSetting;
157 uint8_t bConfigurationValue;
162 * The scratch area for USB devices. Access to this structure is
163 * protected by the enumeration SX lock.
165 union usb_device_scratch {
166 struct usb_hw_ep_scratch hw_ep_scratch[1];
167 struct usb_temp_setup temp_setup[1];
169 struct usb_xfer dummy;
170 struct usb_setup_params parm;
176 * The following structure defines an USB device. There exists one of
177 * these structures for every USB device.
180 /* generic clear stall message */
181 struct usb_udev_msg cs_msg[2];
182 struct lock enum_lock;
184 struct lock device_lock;
185 struct cv ctrlreq_cv;
187 #if (USB_HAVE_FIXED_IFACE == 0)
188 struct usb_interface *ifaces;
190 struct usb_interface ifaces[USB_IFACE_MAX];
192 struct usb_endpoint ctrl_ep; /* Control Endpoint 0 */
193 #if (USB_HAVE_FIXED_ENDPOINT == 0)
194 struct usb_endpoint *endpoints;
196 struct usb_endpoint endpoints[USB_MAX_EP_UNITS];
198 struct usb_power_save pwr_save;/* power save data */
199 struct usb_bus *bus; /* our USB BUS */
200 device_t parent_dev; /* parent device */
201 struct usb_device *parent_hub;
202 struct usb_device *parent_hs_hub; /* high-speed parent HUB */
203 struct usb_config_descriptor *cdesc; /* full config descr */
204 struct usb_hub *hub; /* only if this is a hub */
205 struct usb_xfer *ctrl_xfer[USB_CTRL_XFER_MAX];
206 struct usb_temp_data *usb_template_ptr;
207 struct usb_endpoint *ep_curr; /* current clear stall endpoint */
209 struct usb_fifo *fifo[USB_FIFO_MAX];
210 struct usb_symlink *ugen_symlink; /* our generic symlink */
211 struct usb_fs_privdata *ctrl_dev; /* Control Endpoint 0 device node */
212 LIST_HEAD(,usb_fs_privdata) pd_list;
213 char ugen_name[20]; /* name of ugenX.X device */
215 usb_ticks_t plugtime; /* copy of "ticks" */
217 enum usb_dev_state state;
218 enum usb_dev_speed speed;
220 #define USB_DEV_REF_MAX 0xffff
222 uint16_t power; /* mA the device uses */
223 uint16_t langid; /* language for strings */
224 uint16_t autoQuirk[USB_MAX_AUTO_QUIRK]; /* dynamic quirks */
226 uint8_t address; /* device addess */
227 uint8_t device_index; /* device index in "bus->devices" */
228 uint8_t controller_slot_id; /* controller specific value */
229 uint8_t next_config_index; /* used by USB_RE_ENUM_SET_CONFIG */
230 uint8_t curr_config_index; /* current configuration index */
231 uint8_t curr_config_no; /* current configuration number */
232 uint8_t depth; /* distance from root HUB */
233 uint8_t port_index; /* parent HUB port index */
234 uint8_t port_no; /* parent HUB port number */
235 uint8_t hs_hub_addr; /* high-speed HUB address */
236 uint8_t hs_port_no; /* high-speed HUB port number */
237 uint8_t driver_added_refcount; /* our driver added generation count */
238 uint8_t power_mode; /* see USB_POWER_XXX */
239 uint8_t re_enumerate_wait; /* set if re-enum. is in progress */
240 #define USB_RE_ENUM_DONE 0
241 #define USB_RE_ENUM_START 1
242 #define USB_RE_ENUM_PWR_OFF 2
243 #define USB_RE_ENUM_SET_CONFIG 3
244 uint8_t ifaces_max; /* number of interfaces present */
245 uint8_t endpoints_max; /* number of endpoints present */
247 /* the "flags" field is write-protected by "bus->mtx" */
249 struct usb_device_flags flags;
251 struct usb_endpoint_descriptor ctrl_ep_desc; /* for endpoint 0 */
252 struct usb_endpoint_ss_comp_descriptor ctrl_ep_comp_desc; /* for endpoint 0 */
253 struct usb_device_descriptor ddesc; /* device descriptor */
255 char *serial; /* serial number, can be NULL */
256 char *manufacturer; /* manufacturer string, can be NULL */
257 char *product; /* product string, can be NULL */
259 #if USB_HAVE_COMPAT_LINUX
261 struct usb_device_descriptor descriptor;
262 struct usb_host_endpoint ep0;
263 struct usb_interface *linux_iface_start;
264 struct usb_interface *linux_iface_end;
265 struct usb_host_endpoint *linux_endpoint_start;
266 struct usb_host_endpoint *linux_endpoint_end;
270 uint32_t clear_stall_errors; /* number of clear-stall failures */
272 union usb_device_scratch scratch;
274 #if (USB_HAVE_FIXED_CONFIG != 0)
275 uint32_t config_data[(USB_CONFIG_MAX + 3) / 4];
281 extern int usb_template;
283 /* function prototypes */
285 const char *usb_statestr(enum usb_dev_state state);
286 struct usb_device *usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
287 struct usb_device *parent_hub, uint8_t depth,
288 uint8_t port_index, uint8_t port_no,
289 enum usb_dev_speed speed, enum usb_hc_mode mode);
291 struct usb_fs_privdata *usb_make_dev(struct usb_device *, const char *,
292 int, int, int, uid_t, gid_t, int);
293 void usb_destroy_dev(struct usb_fs_privdata *);
294 void usb_destroy_dev_sync(struct usb_fs_privdata *);
296 usb_error_t usb_probe_and_attach(struct usb_device *udev,
297 uint8_t iface_index);
298 void usb_detach_device(struct usb_device *, uint8_t, uint8_t);
299 usb_error_t usb_reset_iface_endpoints(struct usb_device *udev,
300 uint8_t iface_index);
301 usb_error_t usbd_set_config_index(struct usb_device *udev, uint8_t index);
302 usb_error_t usbd_set_endpoint_stall(struct usb_device *udev,
303 struct usb_endpoint *ep, uint8_t do_stall);
304 usb_error_t usb_suspend_resume(struct usb_device *udev,
306 void usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len);
307 void usb_free_device(struct usb_device *, uint8_t);
308 void usb_linux_free_device(struct usb_device *dev);
309 uint8_t usb_peer_can_wakeup(struct usb_device *udev);
310 struct usb_endpoint *usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep);
311 void usb_set_device_state(struct usb_device *, enum usb_dev_state);
312 enum usb_dev_state usb_get_device_state(struct usb_device *);
314 uint8_t usbd_enum_lock(struct usb_device *);
315 void usbd_enum_unlock(struct usb_device *);
316 void usbd_sr_lock(struct usb_device *);
317 void usbd_sr_unlock(struct usb_device *);
318 uint8_t usbd_enum_is_locked(struct usb_device *);
320 #if USB_HAVE_TT_SUPPORT
321 void uhub_tt_buffer_reset_async_locked(struct usb_device *, struct usb_endpoint *);
324 uint8_t uhub_count_active_host_ports(struct usb_device *, enum usb_dev_speed);
326 #endif /* _USB_DEVICE_H_ */