1 /* $NetBSD: usbdivar.h,v 1.69 2001/12/27 18:43:46 augustss Exp $ */
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the NetBSD
23 * Foundation, Inc. and its contributors.
24 * 4. Neither the name of The NetBSD Foundation nor the names of its
25 * contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
41 #if defined(__NetBSD__)
42 #include <sys/callout.h>
51 struct usbd_endpoint {
52 usb_endpoint_descriptor_t *edesc;
56 struct usbd_bus_methods {
57 usbd_status (*open_pipe)(struct usbd_pipe *pipe);
58 void (*soft_intr)(void *);
59 void (*do_poll)(struct usbd_bus *);
60 usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *,
62 void (*freem)(struct usbd_bus *, usb_dma_t *);
63 struct usbd_xfer * (*allocx)(struct usbd_bus *);
64 void (*freex)(struct usbd_bus *, struct usbd_xfer *);
67 struct usbd_pipe_methods {
68 usbd_status (*transfer)(usbd_xfer_handle xfer);
69 usbd_status (*start)(usbd_xfer_handle xfer);
70 void (*abort)(usbd_xfer_handle xfer);
71 void (*close)(usbd_pipe_handle pipe);
72 void (*cleartoggle)(usbd_pipe_handle pipe);
73 void (*done)(usbd_xfer_handle xfer);
77 usb_port_status_t status;
78 u_int16_t power; /* mA of current on port */
81 #define USBD_RESTART_MAX 5
82 struct usbd_device *device; /* Connected device */
83 struct usbd_device *parent; /* The ports hub */
87 usbd_status (*explore)(usbd_device_handle hub);
89 usb_hub_descriptor_t hubdesc;
90 struct usbd_port ports[1];
98 /* Filled by HC driver */
99 USBBASEDEVICE bdev; /* base device, host adapter */
100 struct usbd_bus_methods *methods;
101 u_int32_t pipe_size; /* size of a pipe struct */
102 /* Filled by usb driver */
103 struct usbd_device *root_hub;
104 usbd_device_handle devices[USB_MAX_DEVICES];
105 char needs_explore;/* a hub a signalled a change */
107 struct usb_softc *usbctl;
108 struct usb_device_stats stats;
111 int usbrev; /* USB revision */
112 #define USBREV_UNKNOWN 0
113 #define USBREV_PRE_1_0 1
117 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" }
119 #ifdef USB_USE_SOFTINTR
120 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
121 void *soft; /* soft interrupt cookie */
123 struct callout softi;
127 #if defined(__NetBSD__) || defined(__OpenBSD__)
128 bus_dma_tag_t dmatag; /* DMA tag */
133 struct usbd_bus *bus; /* our controller */
134 struct usbd_pipe *default_pipe; /* pipe 0 */
135 u_int8_t address; /* device addess */
136 u_int8_t config; /* current configuration # */
137 u_int8_t depth; /* distance from root hub */
138 u_int8_t speed; /* low/full/high speed */
139 u_int8_t self_powered; /* flag for self powered */
140 u_int16_t power; /* mA the device uses */
141 int16_t langid; /* language for strings */
142 #define USBD_NOLANG (-1)
143 usb_event_cookie_t cookie; /* unique connection id */
144 struct usbd_port *powersrc; /* upstream hub port, or 0 */
145 struct usbd_device *myhub; /* upstream hub */
146 struct usbd_device *myhighhub; /* closest high speed hub */
147 struct usbd_endpoint def_ep; /* for pipe 0 */
148 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */
149 struct usbd_interface *ifaces; /* array of all interfaces */
150 usb_device_descriptor_t ddesc; /* device descriptor */
151 usb_config_descriptor_t *cdesc; /* full config descr */
152 const struct usbd_quirks *quirks; /* device quirks, always set */
153 struct usbd_hub *hub; /* only if this is a hub */
154 device_ptr_t *subdevs; /* sub-devices, 0 terminated */
157 struct usbd_interface {
158 struct usbd_device *device;
159 usb_interface_descriptor_t *idesc;
162 struct usbd_endpoint *endpoints;
164 LIST_HEAD(, usbd_pipe) pipes;
168 struct usbd_interface *iface;
169 struct usbd_device *device;
170 struct usbd_endpoint *endpoint;
174 SIMPLEQ_HEAD(, usbd_xfer) queue;
175 LIST_ENTRY(usbd_pipe) next;
177 usbd_xfer_handle intrxfer; /* used for repeating requests */
181 /* Filled by HC driver. */
182 struct usbd_pipe_methods *methods;
186 struct usbd_pipe *pipe;
194 usbd_callback callback;
195 __volatile char done;
198 #define XFER_FREE 0x46524545
199 #define XFER_BUSY 0x42555359
200 #define XFER_ONQU 0x4f4e5155
203 /* For control pipe */
204 usb_device_request_t request;
207 u_int16_t *frlengths;
210 /* For memory allocation */
211 struct usbd_device *device;
215 #define URQ_REQUEST 0x01
216 #define URQ_AUTO_DMABUF 0x10
217 #define URQ_DEV_DMABUF 0x20
219 SIMPLEQ_ENTRY(usbd_xfer) next;
221 void *hcpriv; /* private use by the HC driver */
223 usb_callout_t timeout_handle;
226 void usbd_init(void);
227 void usbd_finish(void);
230 void usbd_dump_iface(struct usbd_interface *iface);
231 void usbd_dump_device(struct usbd_device *dev);
232 void usbd_dump_endpoint(struct usbd_endpoint *endp);
233 void usbd_dump_queue(usbd_pipe_handle pipe);
234 void usbd_dump_pipe(usbd_pipe_handle pipe);
237 /* Routines from usb_subr.c */
238 int usbctlprint(void *, const char *);
239 void usb_delay_ms(usbd_bus_handle, u_int);
240 usbd_status usbd_reset_port(usbd_device_handle dev,
241 int port, usb_port_status_t *ps);
242 usbd_status usbd_setup_pipe(usbd_device_handle dev,
243 usbd_interface_handle iface,
244 struct usbd_endpoint *, int,
245 usbd_pipe_handle *pipe);
246 usbd_status usbd_new_device(device_ptr_t parent,
247 usbd_bus_handle bus, int depth,
248 int lowspeed, int port,
250 void usbd_remove_device(usbd_device_handle, struct usbd_port *);
251 int usbd_printBCD(char *cp, int bcd);
252 usbd_status usbd_fill_iface_data(usbd_device_handle dev, int i, int a);
253 void usb_free_device(usbd_device_handle);
255 usbd_status usb_insert_transfer(usbd_xfer_handle xfer);
256 void usb_transfer_complete(usbd_xfer_handle xfer);
257 void usb_disconnect_port(struct usbd_port *up, device_ptr_t);
259 /* Routines from usb.c */
260 void usb_needs_explore(usbd_device_handle);
261 void usb_schedsoftintr(struct usbd_bus *);
264 * XXX This check is extremely bogus. Bad Bad Bad.
266 #if defined(DIAGNOSTIC) && 0
267 #define SPLUSBCHECK \
268 do { int _s = splusb(), _su = splusb(); \
269 if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \
270 _s, _su, __FILE__, __LINE__); \
279 #if defined(__NetBSD__)
280 #include "locators.h"
281 #elif defined(__FreeBSD__) || defined(__OpenBSD__)
282 /* XXX these values are used to statically bind some elements in the USB tree
283 * to specific driver instances. This should be somehow emulated in FreeBSD
284 * but can be done later on.
285 * The values are copied from the files.usb file in the NetBSD sources.
287 #define UHUBCF_PORT_DEFAULT -1
288 #define UHUBCF_CONFIGURATION_DEFAULT -1
289 #define UHUBCF_INTERFACE_DEFAULT -1
290 #define UHUBCF_VENDOR_DEFAULT -1
291 #define UHUBCF_PRODUCT_DEFAULT -1
292 #define UHUBCF_RELEASE_DEFAULT -1
295 #if defined (__OpenBSD__)
296 #define UHUBCF_PORT 0
297 #define UHUBCF_CONFIGURATION 1
298 #define UHUBCF_INTERFACE 2
299 #define UHUBCF_VENDOR 3
300 #define UHUBCF_PRODUCT 4
301 #define UHUBCF_RELEASE 5
304 #define uhubcf_port cf_loc[UHUBCF_PORT]
305 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION]
306 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE]
307 #define uhubcf_vendor cf_loc[UHUBCF_VENDOR]
308 #define uhubcf_product cf_loc[UHUBCF_PRODUCT]
309 #define uhubcf_release cf_loc[UHUBCF_RELEASE]
310 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */
311 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */
312 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */
313 #define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */
314 #define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */
315 #define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */