usb4bsd: Fixes, fixes, fixes.
[dragonfly.git] / sys / bus / u4b / usb_device.h
CommitLineData
12bd3c8b
SW
1/* $FreeBSD$ */
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 */
32struct usb_fs_privdata;
33
34#define USB_CTRL_XFER_MAX 2
35
36/* "usb_parse_config()" commands */
37
38#define USB_CFG_ALLOC 0
39#define USB_CFG_FREE 1
40#define USB_CFG_INIT 2
41
42/* "usb_unconfigure()" flags */
43
44#define USB_UNCFG_FLAG_NONE 0x00
45#define USB_UNCFG_FLAG_FREE_EP0 0x02 /* endpoint zero is freed */
46
47struct usb_clear_stall_msg {
48 struct usb_proc_msg hdr;
49 struct usb_device *udev;
50};
51
52/* The following four structures makes up a tree, where we have the
53 * leaf structure, "usb_host_endpoint", first, and the root structure,
54 * "usb_device", last. The four structures below mirror the structure
55 * of the USB descriptors belonging to an USB configuration. Please
56 * refer to the USB specification for a definition of "endpoints" and
57 * "interfaces".
58 */
59struct usb_host_endpoint {
60 struct usb_endpoint_descriptor desc;
61 TAILQ_HEAD(, urb) bsd_urb_list;
62 struct usb_xfer *bsd_xfer[2];
63 uint8_t *extra; /* Extra descriptors */
64 usb_frlength_t fbsd_buf_size;
65 uint16_t extralen;
66 uint8_t bsd_iface_index;
67} __aligned(USB_HOST_ALIGN);
68
69struct usb_host_interface {
70 struct usb_interface_descriptor desc;
71 /* the following array has size "desc.bNumEndpoint" */
72 struct usb_host_endpoint *endpoint;
73 const char *string; /* iInterface string, if present */
74 uint8_t *extra; /* Extra descriptors */
75 uint16_t extralen;
76 uint8_t bsd_iface_index;
77} __aligned(USB_HOST_ALIGN);
78
79/*
80 * The following structure defines the USB device flags.
81 */
82struct usb_device_flags {
83 enum usb_hc_mode usb_mode; /* host or device mode */
84 uint8_t self_powered:1; /* set if USB device is self powered */
85 uint8_t no_strings:1; /* set if USB device does not support
86 * strings */
87 uint8_t remote_wakeup:1; /* set if remote wakeup is enabled */
88 uint8_t uq_bus_powered:1; /* set if BUS powered quirk is present */
89
90 /*
91 * NOTE: Although the flags below will reach the same value
92 * over time, but the instant values may differ, and
93 * consequently the flags cannot be merged into one!
94 */
95 uint8_t peer_suspended:1; /* set if peer is suspended */
96 uint8_t self_suspended:1; /* set if self is suspended */
97};
98
99/*
100 * The following structure is used for power-save purposes. The data
101 * in this structure is protected by the USB BUS lock.
102 */
103struct usb_power_save {
104 usb_ticks_t last_xfer_time; /* copy of "ticks" */
105 usb_size_t type_refs[4]; /* transfer reference count */
106 usb_size_t read_refs; /* data read references */
107 usb_size_t write_refs; /* data write references */
108};
109
110/*
111 * The following structure defines an USB device. There exists one of
112 * these structures for every USB device.
113 */
114struct usb_device {
115 struct usb_clear_stall_msg cs_msg[2]; /* generic clear stall
116 * messages */
722d05c3
SW
117 struct lock ctrl_lock;
118 struct lock enum_lock;
119 struct lock sr_lock;
63da4a34 120 struct lock device_lock;
12bd3c8b
SW
121 struct cv ctrlreq_cv;
122 struct cv ref_cv;
123 struct usb_interface *ifaces;
124 struct usb_endpoint ctrl_ep; /* Control Endpoint 0 */
125 struct usb_endpoint *endpoints;
126 struct usb_power_save pwr_save;/* power save data */
127 struct usb_bus *bus; /* our USB BUS */
128 device_t parent_dev; /* parent device */
129 struct usb_device *parent_hub;
130 struct usb_device *parent_hs_hub; /* high-speed parent HUB */
131 struct usb_config_descriptor *cdesc; /* full config descr */
132 struct usb_hub *hub; /* only if this is a hub */
133 struct usb_xfer *ctrl_xfer[USB_CTRL_XFER_MAX];
134 struct usb_temp_data *usb_template_ptr;
135 struct usb_endpoint *ep_curr; /* current clear stall endpoint */
136#if USB_HAVE_UGEN
137 struct usb_fifo *fifo[USB_FIFO_MAX];
138 struct usb_symlink *ugen_symlink; /* our generic symlink */
139 struct usb_fs_privdata *ctrl_dev; /* Control Endpoint 0 device node */
140 LIST_HEAD(,usb_fs_privdata) pd_list;
141 char ugen_name[20]; /* name of ugenX.X device */
142#endif
143 usb_ticks_t plugtime; /* copy of "ticks" */
144
145 enum usb_dev_state state;
146 enum usb_dev_speed speed;
147 uint16_t refcount;
148#define USB_DEV_REF_MAX 0xffff
149
150 uint16_t power; /* mA the device uses */
151 uint16_t langid; /* language for strings */
152 uint16_t autoQuirk[USB_MAX_AUTO_QUIRK]; /* dynamic quirks */
153
154 uint8_t address; /* device addess */
155 uint8_t device_index; /* device index in "bus->devices" */
156 uint8_t controller_slot_id; /* controller specific value */
157 uint8_t curr_config_index; /* current configuration index */
158 uint8_t curr_config_no; /* current configuration number */
159 uint8_t depth; /* distance from root HUB */
160 uint8_t port_index; /* parent HUB port index */
161 uint8_t port_no; /* parent HUB port number */
162 uint8_t hs_hub_addr; /* high-speed HUB address */
163 uint8_t hs_port_no; /* high-speed HUB port number */
164 uint8_t driver_added_refcount; /* our driver added generation count */
165 uint8_t power_mode; /* see USB_POWER_XXX */
166 uint8_t re_enumerate_wait; /* set if re-enum. is in progress */
167 uint8_t ifaces_max; /* number of interfaces present */
168 uint8_t endpoints_max; /* number of endpoints present */
169
170 /* the "flags" field is write-protected by "bus->mtx" */
171
172 struct usb_device_flags flags;
173
174 struct usb_endpoint_descriptor ctrl_ep_desc; /* for endpoint 0 */
175 struct usb_endpoint_ss_comp_descriptor ctrl_ep_comp_desc; /* for endpoint 0 */
176 struct usb_device_descriptor ddesc; /* device descriptor */
177
178 char *serial; /* serial number, can be NULL */
179 char *manufacturer; /* manufacturer string, can be NULL */
180 char *product; /* product string, can be NULL */
181
182#if USB_HAVE_COMPAT_LINUX
183 /* Linux compat */
184 struct usb_device_descriptor descriptor;
185 struct usb_host_endpoint ep0;
186 struct usb_interface *linux_iface_start;
187 struct usb_interface *linux_iface_end;
188 struct usb_host_endpoint *linux_endpoint_start;
189 struct usb_host_endpoint *linux_endpoint_end;
190 uint16_t devnum;
191#endif
192
193 uint32_t clear_stall_errors; /* number of clear-stall failures */
194};
195
196/* globals */
197
198extern int usb_template;
199
200/* function prototypes */
201
202const char *usb_statestr(enum usb_dev_state state);
203struct usb_device *usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
204 struct usb_device *parent_hub, uint8_t depth,
205 uint8_t port_index, uint8_t port_no,
206 enum usb_dev_speed speed, enum usb_hc_mode mode);
207#if USB_HAVE_UGEN
208struct usb_fs_privdata *usb_make_dev(struct usb_device *, const char *,
209 int, int, int, uid_t, gid_t, int);
210void usb_destroy_dev(struct usb_fs_privdata *);
211#endif
212usb_error_t usb_probe_and_attach(struct usb_device *udev,
213 uint8_t iface_index);
214void usb_detach_device(struct usb_device *, uint8_t, uint8_t);
215usb_error_t usb_reset_iface_endpoints(struct usb_device *udev,
216 uint8_t iface_index);
217usb_error_t usbd_set_config_index(struct usb_device *udev, uint8_t index);
218usb_error_t usbd_set_endpoint_stall(struct usb_device *udev,
219 struct usb_endpoint *ep, uint8_t do_stall);
220usb_error_t usb_suspend_resume(struct usb_device *udev,
221 uint8_t do_suspend);
222void usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len);
223void usb_free_device(struct usb_device *, uint8_t);
224void usb_linux_free_device(struct usb_device *dev);
225uint8_t usb_peer_can_wakeup(struct usb_device *udev);
226struct usb_endpoint *usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep);
227void usb_set_device_state(struct usb_device *, enum usb_dev_state);
228enum usb_dev_state usb_get_device_state(struct usb_device *);
229
230void usbd_enum_lock(struct usb_device *);
231void usbd_enum_unlock(struct usb_device *);
232void usbd_sr_lock(struct usb_device *);
233void usbd_sr_unlock(struct usb_device *);
234uint8_t usbd_enum_is_locked(struct usb_device *);
235
236#endif /* _USB_DEVICE_H_ */