Annotation of src/sys/dev/usb/usbdivar.h, Revision 1.63.4.1
1.63.4.1! thorpej 1: /* $NetBSD: usbdivar.h,v 1.69 2001/12/27 18:43:46 augustss 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:
76: struct usbd_port {
77: usb_port_status_t status;
1.11 augustss 78: u_int16_t power; /* mA of current on port */
79: u_int8_t portno;
80: u_int8_t restartcnt;
81: #define USBD_RESTART_MAX 5
1.63.4.1! thorpej 82: struct usbd_device *device; /* Connected device */
1.1 augustss 83: struct usbd_device *parent; /* The ports hub */
84: };
85:
86: struct usbd_hub {
1.57 augustss 87: usbd_status (*explore)(usbd_device_handle hub);
1.11 augustss 88: void *hubsoftc;
1.1 augustss 89: usb_hub_descriptor_t hubdesc;
90: struct usbd_port ports[1];
91: };
92:
93: struct usb_softc;
94:
95: /*****/
96:
97: struct usbd_bus {
98: /* Filled by HC driver */
1.28 augustss 99: USBBASEDEVICE bdev; /* base device, host adapter */
1.29 augustss 100: struct usbd_bus_methods *methods;
1.1 augustss 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 */
1.6 augustss 106: char use_polling;
1.1 augustss 107: struct usb_softc *usbctl;
1.4 augustss 108: struct usb_device_stats stats;
1.32 augustss 109: int intr_context;
110: u_int no_intrs;
1.42 augustss 111: int usbrev; /* USB revision */
112: #define USBREV_UNKNOWN 0
113: #define USBREV_PRE_1_0 1
114: #define USBREV_1_0 2
115: #define USBREV_1_1 3
1.60 augustss 116: #define USBREV_2_0 4
1.62 augustss 117: #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" }
118:
119: #ifdef USB_USE_SOFTINTR
120: #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
121: void *soft; /* soft interrupt cookie */
122: #else
123: struct callout softi;
124: #endif
125: #endif
1.42 augustss 126:
1.31 augustss 127: #if defined(__NetBSD__) || defined(__OpenBSD__)
128: bus_dma_tag_t dmatag; /* DMA tag */
129: #endif
1.1 augustss 130: };
131:
132: struct usbd_device {
1.43 augustss 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 */
1.63.4.1! thorpej 138: u_int8_t speed; /* low/full/high speed */
1.43 augustss 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 */
1.13 augustss 142: #define USBD_NOLANG (-1)
1.43 augustss 143: usb_event_cookie_t cookie; /* unique connection id */
144: struct usbd_port *powersrc; /* upstream hub port, or 0 */
1.63.4.1! thorpej 145: struct usbd_device *myhub; /* upstream hub */
! 146: struct usbd_device *myhighhub; /* closest high speed hub */
1.43 augustss 147: struct usbd_endpoint def_ep; /* for pipe 0 */
1.1 augustss 148: usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */
1.43 augustss 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 */
1.61 jdolecek 152: const struct usbd_quirks *quirks; /* device quirks, always set */
1.43 augustss 153: struct usbd_hub *hub; /* only if this is a hub */
154: device_ptr_t *subdevs; /* sub-devices, 0 terminated */
1.1 augustss 155: };
156:
157: struct usbd_interface {
158: struct usbd_device *device;
159: usb_interface_descriptor_t *idesc;
1.10 augustss 160: int index;
161: int altindex;
1.1 augustss 162: struct usbd_endpoint *endpoints;
163: void *priv;
164: LIST_HEAD(, usbd_pipe) pipes;
165: };
166:
167: struct usbd_pipe {
168: struct usbd_interface *iface;
169: struct usbd_device *device;
170: struct usbd_endpoint *endpoint;
1.21 augustss 171: int refcnt;
1.1 augustss 172: char running;
1.53 augustss 173: char aborting;
1.40 augustss 174: SIMPLEQ_HEAD(, usbd_xfer) queue;
1.1 augustss 175: LIST_ENTRY(usbd_pipe) next;
176:
1.45 augustss 177: usbd_xfer_handle intrxfer; /* used for repeating requests */
1.22 augustss 178: char repeat;
1.45 augustss 179: int interval;
1.1 augustss 180:
181: /* Filled by HC driver. */
1.29 augustss 182: struct usbd_pipe_methods *methods;
1.1 augustss 183: };
184:
1.40 augustss 185: struct usbd_xfer {
1.1 augustss 186: struct usbd_pipe *pipe;
187: void *priv;
188: void *buffer;
189: u_int32_t length;
190: u_int32_t actlen;
191: u_int16_t flags;
192: u_int32_t timeout;
193: usbd_status status;
194: usbd_callback callback;
1.27 thorpej 195: __volatile char done;
1.50 augustss 196: #ifdef DIAGNOSTIC
1.51 augustss 197: u_int32_t busy_free;
198: #define XFER_FREE 0x46524545
1.63.4.1! thorpej 199: #define XFER_BUSY 0x42555359
! 200: #define XFER_ONQU 0x4f4e5155
1.50 augustss 201: #endif
1.1 augustss 202:
1.29 augustss 203: /* For control pipe */
1.1 augustss 204: usb_device_request_t request;
1.29 augustss 205:
206: /* For isoc */
207: u_int16_t *frlengths;
208: int nframes;
209:
210: /* For memory allocation */
1.30 augustss 211: struct usbd_device *device;
1.29 augustss 212: usb_dma_t dmabuf;
213:
214: int rqflags;
215: #define URQ_REQUEST 0x01
1.30 augustss 216: #define URQ_AUTO_DMABUF 0x10
217: #define URQ_DEV_DMABUF 0x20
1.1 augustss 218:
1.40 augustss 219: SIMPLEQ_ENTRY(usbd_xfer) next;
1.1 augustss 220:
1.29 augustss 221: void *hcpriv; /* private use by the HC driver */
1.11 augustss 222:
1.52 augustss 223: usb_callout_t timeout_handle;
1.1 augustss 224: };
225:
1.57 augustss 226: void usbd_init(void);
227: void usbd_finish(void);
1.63.4.1! thorpej 228:
! 229: #ifdef USB_DEBUG
! 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);
! 235: #endif
1.1 augustss 236:
237: /* Routines from usb_subr.c */
1.57 augustss 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,
249: struct usbd_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);
254:
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);
1.1 augustss 258:
259: /* Routines from usb.c */
1.63 augustss 260: void usb_needs_explore(usbd_device_handle);
1.57 augustss 261: void usb_schedsoftintr(struct usbd_bus *);
1.33 augustss 262:
1.58 thorpej 263: /*
264: * XXX This check is extremely bogus. Bad Bad Bad.
265: */
266: #if defined(DIAGNOSTIC) && 0
1.33 augustss 267: #define SPLUSBCHECK \
268: do { int _s = splusb(), _su = splusb(); \
1.38 augustss 269: if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \
1.33 augustss 270: _s, _su, __FILE__, __LINE__); \
1.39 mycroft 271: splx(_s); \
1.33 augustss 272: } while (0)
273: #else
274: #define SPLUSBCHECK
275: #endif
1.1 augustss 276:
277: /* Locator stuff. */
278:
1.11 augustss 279: #if defined(__NetBSD__)
1.1 augustss 280: #include "locators.h"
1.23 augustss 281: #elif defined(__FreeBSD__) || defined(__OpenBSD__)
1.16 augustss 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.
286: */
287: #define UHUBCF_PORT_DEFAULT -1
288: #define UHUBCF_CONFIGURATION_DEFAULT -1
289: #define UHUBCF_INTERFACE_DEFAULT -1
1.20 augustss 290: #define UHUBCF_VENDOR_DEFAULT -1
291: #define UHUBCF_PRODUCT_DEFAULT -1
292: #define UHUBCF_RELEASE_DEFAULT -1
1.23 augustss 293: #endif
294:
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
1.11 augustss 302: #endif
1.1 augustss 303:
1.9 augustss 304: #define uhubcf_port cf_loc[UHUBCF_PORT]
305: #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION]
306: #define uhubcf_interface cf_loc[UHUBCF_INTERFACE]
1.20 augustss 307: #define uhubcf_vendor cf_loc[UHUBCF_VENDOR]
308: #define uhubcf_product cf_loc[UHUBCF_PRODUCT]
309: #define uhubcf_release cf_loc[UHUBCF_RELEASE]
1.9 augustss 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' */
1.20 augustss 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' */
1.1 augustss 316:
CVSweb <webmaster@jp.NetBSD.org>