2 * $NetBSD: usbdivar.h,v 1.70 2002/07/11 21:14:36 augustss Exp $
3 * $FreeBSD: src/sys/dev/usb/usbdivar.h,v 1.40 2003/07/15 22:42:37 jmg Exp $
4 * $DragonFly: src/sys/bus/usb/usbdivar.h,v 1.5 2005/06/02 20:40:40 dillon Exp $
8 * Copyright (c) 1998 The NetBSD Foundation, Inc.
11 * This code is derived from software contributed to The NetBSD Foundation
12 * by Lennart Augustsson (lennart@augustsson.net) at
13 * Carlstedt Research & Technology.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
23 * 3. All advertising materials mentioning features or use of this software
24 * must display the following acknowledgement:
25 * This product includes software developed by the NetBSD
26 * Foundation, Inc. and its contributors.
27 * 4. Neither the name of The NetBSD Foundation nor the names of its
28 * contributors may be used to endorse or promote products derived
29 * from this software without specific prior written permission.
31 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
32 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
33 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
34 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
35 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
36 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
39 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGE.
44 #if defined(__NetBSD__)
45 #include <sys/callout.h>
54 struct usbd_endpoint {
55 usb_endpoint_descriptor_t *edesc;
59 struct usbd_bus_methods {
60 usbd_status (*open_pipe)(struct usbd_pipe *pipe);
61 void (*soft_intr)(void *);
62 void (*do_poll)(struct usbd_bus *);
63 usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *,
65 void (*freem)(struct usbd_bus *, usb_dma_t *);
66 struct usbd_xfer * (*allocx)(struct usbd_bus *);
67 void (*freex)(struct usbd_bus *, struct usbd_xfer *);
70 struct usbd_pipe_methods {
71 usbd_status (*transfer)(usbd_xfer_handle xfer);
72 usbd_status (*start)(usbd_xfer_handle xfer);
73 void (*abort)(usbd_xfer_handle xfer);
74 void (*close)(usbd_pipe_handle pipe);
75 void (*cleartoggle)(usbd_pipe_handle pipe);
76 void (*done)(usbd_xfer_handle xfer);
80 usb_port_status_t status;
81 u_int16_t power; /* mA of current on port */
84 #define USBD_RESTART_MAX 5
85 struct usbd_device *device; /* Connected device */
86 struct usbd_device *parent; /* The ports hub */
90 usbd_status (*explore)(usbd_device_handle hub);
92 usb_hub_descriptor_t hubdesc;
93 struct usbd_port ports[1];
101 /* Filled by HC driver */
102 USBBASEDEVICE bdev; /* base device, host adapter */
103 struct usbd_bus_methods *methods;
104 u_int32_t pipe_size; /* size of a pipe struct */
105 /* Filled by usb driver */
106 struct usbd_device *root_hub;
107 usbd_device_handle devices[USB_MAX_DEVICES];
108 char needs_explore;/* a hub a signalled a change */
110 struct usb_softc *usbctl;
111 struct usb_device_stats stats;
114 int usbrev; /* USB revision */
115 #define USBREV_UNKNOWN 0
116 #define USBREV_PRE_1_0 1
120 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" }
122 #ifdef USB_USE_SOFTINTR
123 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
124 void *soft; /* soft interrupt cookie */
126 struct callout softi;
130 bus_dma_tag_t dmatag; /* DMA tag */
134 struct usbd_bus *bus; /* our controller */
135 struct usbd_pipe *default_pipe; /* pipe 0 */
136 u_int8_t address; /* device addess */
137 u_int8_t config; /* current configuration # */
138 u_int8_t depth; /* distance from root hub */
139 u_int8_t speed; /* low/full/high speed */
140 u_int8_t self_powered; /* flag for self powered */
141 u_int16_t power; /* mA the device uses */
142 int16_t langid; /* language for strings */
143 #define USBD_NOLANG (-1)
144 usb_event_cookie_t cookie; /* unique connection id */
145 struct usbd_port *powersrc; /* upstream hub port, or 0 */
146 struct usbd_device *myhub; /* upstream hub */
147 struct usbd_device *myhighhub; /* closest high speed hub */
148 struct usbd_endpoint def_ep; /* for pipe 0 */
149 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */
150 struct usbd_interface *ifaces; /* array of all interfaces */
151 usb_device_descriptor_t ddesc; /* device descriptor */
152 usb_config_descriptor_t *cdesc; /* full config descr */
153 const struct usbd_quirks *quirks; /* device quirks, always set */
154 struct usbd_hub *hub; /* only if this is a hub */
155 device_ptr_t *subdevs; /* sub-devices, 0 terminated */
158 struct usbd_interface {
159 struct usbd_device *device;
160 usb_interface_descriptor_t *idesc;
163 struct usbd_endpoint *endpoints;
165 LIST_HEAD(, usbd_pipe) pipes;
169 struct usbd_interface *iface;
170 struct usbd_device *device;
171 struct usbd_endpoint *endpoint;
175 SIMPLEQ_HEAD(, usbd_xfer) queue;
176 LIST_ENTRY(usbd_pipe) next;
178 usbd_xfer_handle intrxfer; /* used for repeating requests */
182 /* Filled by HC driver. */
183 struct usbd_pipe_methods *methods;
187 struct usbd_pipe *pipe;
195 usbd_callback callback;
196 __volatile char done;
199 #define XFER_FREE 0x46524545
200 #define XFER_BUSY 0x42555359
201 #define XFER_ONQU 0x4f4e5155
204 /* For control pipe */
205 usb_device_request_t request;
208 u_int16_t *frlengths;
211 /* For memory allocation */
212 struct usbd_device *device;
216 #define URQ_REQUEST 0x01
217 #define URQ_AUTO_DMABUF 0x10
218 #define URQ_DEV_DMABUF 0x20
220 SIMPLEQ_ENTRY(usbd_xfer) next;
222 void *hcpriv; /* private use by the HC driver */
224 usb_callout_t timeout_handle;
227 void usbd_init(void);
228 void usbd_finish(void);
231 void usbd_dump_iface(struct usbd_interface *iface);
232 void usbd_dump_device(struct usbd_device *dev);
233 void usbd_dump_endpoint(struct usbd_endpoint *endp);
234 void usbd_dump_queue(usbd_pipe_handle pipe);
235 void usbd_dump_pipe(usbd_pipe_handle pipe);
238 /* Routines from usb_subr.c */
239 int usbctlprint(void *, const char *);
240 void usb_delay_ms(usbd_bus_handle, u_int);
241 usbd_status usbd_reset_port(usbd_device_handle dev,
242 int port, usb_port_status_t *ps);
243 usbd_status usbd_setup_pipe(usbd_device_handle dev,
244 usbd_interface_handle iface,
245 struct usbd_endpoint *, int,
246 usbd_pipe_handle *pipe);
247 usbd_status usbd_new_device(device_ptr_t parent,
248 usbd_bus_handle bus, int depth,
249 int lowspeed, int port,
251 void usbd_remove_device(usbd_device_handle, struct usbd_port *);
252 int usbd_printBCD(char *cp, int bcd);
253 usbd_status usbd_fill_iface_data(usbd_device_handle dev, int i, int a);
254 void usb_free_device(usbd_device_handle);
256 usbd_status usb_insert_transfer(usbd_xfer_handle xfer);
257 void usb_transfer_complete(usbd_xfer_handle xfer);
258 void usb_disconnect_port(struct usbd_port *up, device_ptr_t);
260 /* Routines from usb.c */
261 void usb_needs_explore(usbd_device_handle);
262 void usb_schedsoftintr(struct usbd_bus *);
266 #if defined(__NetBSD__)
267 #include "locators.h"
268 #elif defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
269 /* XXX these values are used to statically bind some elements in the USB tree
270 * to specific driver instances. This should be somehow emulated in FreeBSD
271 * but can be done later on.
272 * The values are copied from the files.usb file in the NetBSD sources.
274 #define UHUBCF_PORT_DEFAULT -1
275 #define UHUBCF_CONFIGURATION_DEFAULT -1
276 #define UHUBCF_INTERFACE_DEFAULT -1
277 #define UHUBCF_VENDOR_DEFAULT -1
278 #define UHUBCF_PRODUCT_DEFAULT -1
279 #define UHUBCF_RELEASE_DEFAULT -1
282 #if defined (__OpenBSD__)
283 #define UHUBCF_PORT 0
284 #define UHUBCF_CONFIGURATION 1
285 #define UHUBCF_INTERFACE 2
286 #define UHUBCF_VENDOR 3
287 #define UHUBCF_PRODUCT 4
288 #define UHUBCF_RELEASE 5
291 #define uhubcf_port cf_loc[UHUBCF_PORT]
292 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION]
293 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE]
294 #define uhubcf_vendor cf_loc[UHUBCF_VENDOR]
295 #define uhubcf_product cf_loc[UHUBCF_PRODUCT]
296 #define uhubcf_release cf_loc[UHUBCF_RELEASE]
297 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */
298 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */
299 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */
300 #define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */
301 #define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */
302 #define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */