Annotation of src/sys/dev/usb/usbdivar.h, Revision 1.72.4.1
1.72.4.1! kent 1: /* $NetBSD: usbdivar.h,v 1.73 2005/01/24 01:30:38 joff Exp $ */
1.41 augustss 2: /* $FreeBSD: src/sys/dev/usb/usbdivar.h,v 1.11 1999/11/17 22:33:51 n_hibma Exp $ */
1.1 augustss 3:
4: /*
5: * Copyright (c) 1998 The NetBSD Foundation, Inc.
6: * All rights reserved.
7: *
1.8 augustss 8: * This code is derived from software contributed to The NetBSD Foundation
1.56 augustss 9: * by Lennart Augustsson (lennart@augustsson.net) at
1.8 augustss 10: * Carlstedt Research & Technology.
1.1 augustss 11: *
12: * Redistribution and use in source and binary forms, with or without
13: * modification, are permitted provided that the following conditions
14: * are met:
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.
27: *
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.
39: */
40:
1.55 augustss 41: #if defined(__NetBSD__)
1.48 thorpej 42: #include <sys/callout.h>
1.55 augustss 43: #endif
1.48 thorpej 44:
1.29 augustss 45: /* From usb_mem.h */
1.30 augustss 46: DECLARE_USB_DMA_T;
1.29 augustss 47:
1.40 augustss 48: struct usbd_xfer;
1.1 augustss 49: struct usbd_pipe;
50:
51: struct usbd_endpoint {
52: usb_endpoint_descriptor_t *edesc;
53: int refcnt;
54: };
55:
1.29 augustss 56: struct usbd_bus_methods {
1.57 augustss 57: usbd_status (*open_pipe)(struct usbd_pipe *pipe);
1.62 augustss 58: void (*soft_intr)(void *);
1.57 augustss 59: void (*do_poll)(struct usbd_bus *);
60: usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *,
61: u_int32_t bufsize);
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 *);
1.29 augustss 65: };
66:
67: struct usbd_pipe_methods {
1.57 augustss 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);
1.1 augustss 74: };
75:
1.72 augustss 76: struct usbd_tt {
77: struct usbd_hub *hub;
78: };
79:
1.1 augustss 80: struct usbd_port {
81: usb_port_status_t status;
1.11 augustss 82: u_int16_t power; /* mA of current on port */
83: u_int8_t portno;
84: u_int8_t restartcnt;
85: #define USBD_RESTART_MAX 5
1.72.4.1! kent 86: u_int8_t reattach;
1.66 augustss 87: struct usbd_device *device; /* Connected device */
1.1 augustss 88: struct usbd_device *parent; /* The ports hub */
1.72 augustss 89: struct usbd_tt *tt; /* Transaction translator (if any) */
1.1 augustss 90: };
91:
92: struct usbd_hub {
1.57 augustss 93: usbd_status (*explore)(usbd_device_handle hub);
1.11 augustss 94: void *hubsoftc;
1.1 augustss 95: usb_hub_descriptor_t hubdesc;
96: struct usbd_port ports[1];
97: };
98:
99: struct usb_softc;
100:
101: /*****/
102:
103: struct usbd_bus {
104: /* Filled by HC driver */
1.28 augustss 105: USBBASEDEVICE bdev; /* base device, host adapter */
1.29 augustss 106: struct usbd_bus_methods *methods;
1.1 augustss 107: u_int32_t pipe_size; /* size of a pipe struct */
108: /* Filled by usb driver */
109: struct usbd_device *root_hub;
110: usbd_device_handle devices[USB_MAX_DEVICES];
111: char needs_explore;/* a hub a signalled a change */
1.6 augustss 112: char use_polling;
1.1 augustss 113: struct usb_softc *usbctl;
1.4 augustss 114: struct usb_device_stats stats;
1.32 augustss 115: int intr_context;
116: u_int no_intrs;
1.42 augustss 117: int usbrev; /* USB revision */
118: #define USBREV_UNKNOWN 0
119: #define USBREV_PRE_1_0 1
120: #define USBREV_1_0 2
121: #define USBREV_1_1 3
1.60 augustss 122: #define USBREV_2_0 4
1.62 augustss 123: #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" }
124:
125: #ifdef USB_USE_SOFTINTR
126: #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
127: void *soft; /* soft interrupt cookie */
128: #else
129: struct callout softi;
130: #endif
131: #endif
1.42 augustss 132:
1.31 augustss 133: #if defined(__NetBSD__) || defined(__OpenBSD__)
134: bus_dma_tag_t dmatag; /* DMA tag */
135: #endif
1.1 augustss 136: };
137:
138: struct usbd_device {
1.43 augustss 139: struct usbd_bus *bus; /* our controller */
140: struct usbd_pipe *default_pipe; /* pipe 0 */
141: u_int8_t address; /* device addess */
142: u_int8_t config; /* current configuration # */
143: u_int8_t depth; /* distance from root hub */
1.66 augustss 144: u_int8_t speed; /* low/full/high speed */
1.43 augustss 145: u_int8_t self_powered; /* flag for self powered */
146: u_int16_t power; /* mA the device uses */
147: int16_t langid; /* language for strings */
1.13 augustss 148: #define USBD_NOLANG (-1)
1.43 augustss 149: usb_event_cookie_t cookie; /* unique connection id */
150: struct usbd_port *powersrc; /* upstream hub port, or 0 */
1.66 augustss 151: struct usbd_device *myhub; /* upstream hub */
1.72 augustss 152: struct usbd_port *myhsport; /* closest high speed port */
1.43 augustss 153: struct usbd_endpoint def_ep; /* for pipe 0 */
1.1 augustss 154: usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */
1.43 augustss 155: struct usbd_interface *ifaces; /* array of all interfaces */
156: usb_device_descriptor_t ddesc; /* device descriptor */
157: usb_config_descriptor_t *cdesc; /* full config descr */
1.61 jdolecek 158: const struct usbd_quirks *quirks; /* device quirks, always set */
1.43 augustss 159: struct usbd_hub *hub; /* only if this is a hub */
160: device_ptr_t *subdevs; /* sub-devices, 0 terminated */
1.1 augustss 161: };
162:
163: struct usbd_interface {
164: struct usbd_device *device;
165: usb_interface_descriptor_t *idesc;
1.10 augustss 166: int index;
167: int altindex;
1.1 augustss 168: struct usbd_endpoint *endpoints;
169: void *priv;
170: LIST_HEAD(, usbd_pipe) pipes;
171: };
172:
173: struct usbd_pipe {
174: struct usbd_interface *iface;
175: struct usbd_device *device;
176: struct usbd_endpoint *endpoint;
1.21 augustss 177: int refcnt;
1.1 augustss 178: char running;
1.53 augustss 179: char aborting;
1.40 augustss 180: SIMPLEQ_HEAD(, usbd_xfer) queue;
1.1 augustss 181: LIST_ENTRY(usbd_pipe) next;
182:
1.45 augustss 183: usbd_xfer_handle intrxfer; /* used for repeating requests */
1.22 augustss 184: char repeat;
1.45 augustss 185: int interval;
1.52 augustss 186:
1.1 augustss 187: /* Filled by HC driver. */
1.29 augustss 188: struct usbd_pipe_methods *methods;
1.1 augustss 189: };
190:
1.40 augustss 191: struct usbd_xfer {
1.1 augustss 192: struct usbd_pipe *pipe;
193: void *priv;
194: void *buffer;
195: u_int32_t length;
196: u_int32_t actlen;
197: u_int16_t flags;
198: u_int32_t timeout;
199: usbd_status status;
200: usbd_callback callback;
1.27 thorpej 201: __volatile char done;
1.50 augustss 202: #ifdef DIAGNOSTIC
1.51 augustss 203: u_int32_t busy_free;
204: #define XFER_FREE 0x46524545
1.69 augustss 205: #define XFER_BUSY 0x42555359
206: #define XFER_ONQU 0x4f4e5155
1.50 augustss 207: #endif
1.1 augustss 208:
1.29 augustss 209: /* For control pipe */
1.1 augustss 210: usb_device_request_t request;
1.29 augustss 211:
212: /* For isoc */
213: u_int16_t *frlengths;
214: int nframes;
215:
216: /* For memory allocation */
1.30 augustss 217: struct usbd_device *device;
1.29 augustss 218: usb_dma_t dmabuf;
219:
220: int rqflags;
221: #define URQ_REQUEST 0x01
1.30 augustss 222: #define URQ_AUTO_DMABUF 0x10
223: #define URQ_DEV_DMABUF 0x20
1.1 augustss 224:
1.40 augustss 225: SIMPLEQ_ENTRY(usbd_xfer) next;
1.1 augustss 226:
1.29 augustss 227: void *hcpriv; /* private use by the HC driver */
1.11 augustss 228:
1.52 augustss 229: usb_callout_t timeout_handle;
1.1 augustss 230: };
231:
1.57 augustss 232: void usbd_init(void);
233: void usbd_finish(void);
1.64 augustss 234:
1.67 augustss 235: #ifdef USB_DEBUG
1.64 augustss 236: void usbd_dump_iface(struct usbd_interface *iface);
237: void usbd_dump_device(struct usbd_device *dev);
238: void usbd_dump_endpoint(struct usbd_endpoint *endp);
239: void usbd_dump_queue(usbd_pipe_handle pipe);
240: void usbd_dump_pipe(usbd_pipe_handle pipe);
1.67 augustss 241: #endif
1.1 augustss 242:
243: /* Routines from usb_subr.c */
1.57 augustss 244: int usbctlprint(void *, const char *);
245: void usb_delay_ms(usbd_bus_handle, u_int);
1.71 itojun 246: usbd_status usbd_reset_port(usbd_device_handle, int, usb_port_status_t *);
1.57 augustss 247: usbd_status usbd_setup_pipe(usbd_device_handle dev,
248: usbd_interface_handle iface,
249: struct usbd_endpoint *, int,
250: usbd_pipe_handle *pipe);
1.71 itojun 251: usbd_status usbd_new_device(device_ptr_t, usbd_bus_handle, int, int, int,
1.57 augustss 252: struct usbd_port *);
253: void usbd_remove_device(usbd_device_handle, struct usbd_port *);
1.71 itojun 254: int usbd_printBCD(char *, size_t, int);
255: usbd_status usbd_fill_iface_data(usbd_device_handle, int, int);
1.57 augustss 256: void usb_free_device(usbd_device_handle);
257:
1.71 itojun 258: usbd_status usb_insert_transfer(usbd_xfer_handle);
259: void usb_transfer_complete(usbd_xfer_handle);
260: void usb_disconnect_port(struct usbd_port *, device_ptr_t);
1.1 augustss 261:
262: /* Routines from usb.c */
1.63 augustss 263: void usb_needs_explore(usbd_device_handle);
1.72.4.1! kent 264: void usb_needs_reattach(usbd_device_handle);
1.57 augustss 265: void usb_schedsoftintr(struct usbd_bus *);
1.33 augustss 266:
1.58 thorpej 267: /*
268: * XXX This check is extremely bogus. Bad Bad Bad.
269: */
270: #if defined(DIAGNOSTIC) && 0
1.33 augustss 271: #define SPLUSBCHECK \
272: do { int _s = splusb(), _su = splusb(); \
1.38 augustss 273: if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \
1.33 augustss 274: _s, _su, __FILE__, __LINE__); \
1.39 mycroft 275: splx(_s); \
1.33 augustss 276: } while (0)
277: #else
278: #define SPLUSBCHECK
279: #endif
1.1 augustss 280:
281: /* Locator stuff. */
282:
1.11 augustss 283: #if defined(__NetBSD__)
1.1 augustss 284: #include "locators.h"
1.23 augustss 285: #elif defined(__FreeBSD__) || defined(__OpenBSD__)
1.16 augustss 286: /* XXX these values are used to statically bind some elements in the USB tree
287: * to specific driver instances. This should be somehow emulated in FreeBSD
288: * but can be done later on.
289: * The values are copied from the files.usb file in the NetBSD sources.
290: */
291: #define UHUBCF_PORT_DEFAULT -1
292: #define UHUBCF_CONFIGURATION_DEFAULT -1
293: #define UHUBCF_INTERFACE_DEFAULT -1
1.20 augustss 294: #define UHUBCF_VENDOR_DEFAULT -1
295: #define UHUBCF_PRODUCT_DEFAULT -1
296: #define UHUBCF_RELEASE_DEFAULT -1
1.23 augustss 297: #endif
298:
299: #if defined (__OpenBSD__)
300: #define UHUBCF_PORT 0
301: #define UHUBCF_CONFIGURATION 1
302: #define UHUBCF_INTERFACE 2
303: #define UHUBCF_VENDOR 3
304: #define UHUBCF_PRODUCT 4
305: #define UHUBCF_RELEASE 5
1.11 augustss 306: #endif
1.1 augustss 307:
1.9 augustss 308: #define uhubcf_port cf_loc[UHUBCF_PORT]
309: #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION]
310: #define uhubcf_interface cf_loc[UHUBCF_INTERFACE]
1.20 augustss 311: #define uhubcf_vendor cf_loc[UHUBCF_VENDOR]
312: #define uhubcf_product cf_loc[UHUBCF_PRODUCT]
313: #define uhubcf_release cf_loc[UHUBCF_RELEASE]
1.9 augustss 314: #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */
315: #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */
316: #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */
1.20 augustss 317: #define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */
318: #define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */
319: #define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */
1.1 augustss 320:
CVSweb <webmaster@jp.NetBSD.org>