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 struct usb_symlink; /* UGEN */
31 struct usb_device; /* linux compat */
33 #define USB_DEFAULT_XFER_MAX 2
35 /* "usb_parse_config()" commands */
37 #define USB_CFG_ALLOC 0
38 #define USB_CFG_FREE 1
39 #define USB_CFG_INIT 2
41 /* "usb_unconfigure()" flags */
43 #define USB_UNCFG_FLAG_NONE 0x00
44 #define USB_UNCFG_FLAG_FREE_EP0 0x02 /* endpoint zero is freed */
46 struct usb_clear_stall_msg {
47 struct usb_proc_msg hdr;
48 struct usb_device *udev;
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
58 struct 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;
65 uint8_t bsd_iface_index;
66 } __aligned(USB_HOST_ALIGN);
68 struct 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 */
75 uint8_t bsd_iface_index;
76 } __aligned(USB_HOST_ALIGN);
79 * The following structure defines the USB device flags.
81 struct 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
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 */
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!
94 uint8_t peer_suspended:1; /* set if peer is suspended */
95 uint8_t self_suspended:1; /* set if self is suspended */
99 * The following structure is used for power-save purposes. The data
100 * in this structure is protected by the USB BUS lock.
102 struct 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 */
110 * The following structure defines an USB device. There exists one of
111 * these structures for every USB device.
114 struct usb_clear_stall_msg cs_msg[2]; /* generic clear stall
116 struct sx default_sx[2];
117 struct mtx default_mtx[1];
118 struct cv default_cv[2];
119 struct usb_interface *ifaces;
120 struct usb_endpoint default_ep; /* Control Endpoint 0 */
121 struct usb_endpoint *endpoints;
122 struct usb_power_save pwr_save;/* power save data */
123 struct usb_bus *bus; /* our USB BUS */
124 device_t parent_dev; /* parent device */
125 struct usb_device *parent_hub;
126 struct usb_device *parent_hs_hub; /* high-speed parent HUB */
127 struct usb_config_descriptor *cdesc; /* full config descr */
128 struct usb_hub *hub; /* only if this is a hub */
129 struct usb_xfer *default_xfer[USB_DEFAULT_XFER_MAX];
130 struct usb_temp_data *usb_template_ptr;
131 struct usb_endpoint *ep_curr; /* current clear stall endpoint */
133 struct usb_fifo *fifo[USB_FIFO_MAX];
134 struct usb_symlink *ugen_symlink; /* our generic symlink */
135 struct cdev *default_dev; /* Control Endpoint 0 device node */
136 LIST_HEAD(,usb_fs_privdata) pd_list;
137 char ugen_name[20]; /* name of ugenX.X device */
139 usb_ticks_t plugtime; /* copy of "ticks" */
141 enum usb_dev_state state;
142 enum usb_dev_speed speed;
144 #define USB_DEV_REF_MAX 0xffff
146 uint16_t power; /* mA the device uses */
147 uint16_t langid; /* language for strings */
149 uint8_t address; /* device addess */
150 uint8_t device_index; /* device index in "bus->devices" */
151 uint8_t curr_config_index; /* current configuration index */
152 uint8_t curr_config_no; /* current configuration number */
153 uint8_t depth; /* distance from root HUB */
154 uint8_t port_index; /* parent HUB port index */
155 uint8_t port_no; /* parent HUB port number */
156 uint8_t hs_hub_addr; /* high-speed HUB address */
157 uint8_t hs_port_no; /* high-speed HUB port number */
158 uint8_t driver_added_refcount; /* our driver added generation count */
159 uint8_t power_mode; /* see USB_POWER_XXX */
160 uint8_t ifaces_max; /* number of interfaces present */
161 uint8_t endpoints_max; /* number of endpoints present */
163 /* the "flags" field is write-protected by "bus->mtx" */
165 struct usb_device_flags flags;
167 struct usb_endpoint_descriptor default_ep_desc; /* for endpoint 0 */
168 struct usb_device_descriptor ddesc; /* device descriptor */
170 char *serial; /* serial number */
171 char *manufacturer; /* manufacturer string */
172 char *product; /* product string */
174 #if USB_HAVE_COMPAT_LINUX
176 struct usb_device_descriptor descriptor;
177 struct usb_host_endpoint ep0;
178 struct usb_interface *linux_iface_start;
179 struct usb_interface *linux_iface_end;
180 struct usb_host_endpoint *linux_endpoint_start;
181 struct usb_host_endpoint *linux_endpoint_end;
188 extern int usb_template;
190 /* function prototypes */
192 const char *usb_statestr(enum usb_dev_state state);
193 struct usb_device *usb_alloc_device(device_t parent_dev, struct usb_bus *bus,
194 struct usb_device *parent_hub, uint8_t depth,
195 uint8_t port_index, uint8_t port_no,
196 enum usb_dev_speed speed, enum usb_hc_mode mode);
197 usb_error_t usb_probe_and_attach(struct usb_device *udev,
198 uint8_t iface_index);
199 usb_error_t usb_reset_iface_endpoints(struct usb_device *udev,
200 uint8_t iface_index);
201 usb_error_t usbd_set_config_index(struct usb_device *udev, uint8_t index);
202 usb_error_t usbd_set_endpoint_stall(struct usb_device *udev,
203 struct usb_endpoint *ep, uint8_t do_stall);
204 usb_error_t usb_suspend_resume(struct usb_device *udev,
206 void usb_devinfo(struct usb_device *udev, char *dst_ptr, uint16_t dst_len);
207 void usb_free_device(struct usb_device *, uint8_t);
208 void usb_linux_free_device(struct usb_device *dev);
209 uint8_t usb_peer_can_wakeup(struct usb_device *udev);
210 struct usb_endpoint *usb_endpoint_foreach(struct usb_device *udev, struct usb_endpoint *ep);
211 void usb_set_device_state(struct usb_device *udev,
212 enum usb_dev_state state);
213 void usbd_enum_lock(struct usb_device *);
214 void usbd_enum_unlock(struct usb_device *);
215 uint8_t usbd_enum_is_locked(struct usb_device *);
217 #endif /* _USB_DEVICE_H_ */