1 /* $OpenBSD: usbdivar.h,v 1.13 2001/05/03 02:20:34 aaron Exp $ */ 2 /* $NetBSD: usbdivar.h,v 1.63 2001/01/21 19:00:06 augustss Exp $ */ 3 /* $FreeBSD: src/sys/dev/usb/usbdivar.h,v 1.11 1999/11/17 22:33:51 n_hibma Exp $ */ 4 5 /* 6 * Copyright (c) 1998 The NetBSD Foundation, Inc. 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to The NetBSD Foundation 10 * by Lennart Augustsson (lennart@augustsson.net) at 11 * Carlstedt Research & Technology. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 3. All advertising materials mentioning features or use of this software 22 * must display the following acknowledgement: 23 * This product includes software developed by the NetBSD 24 * Foundation, Inc. and its contributors. 25 * 4. Neither the name of The NetBSD Foundation nor the names of its 26 * contributors may be used to endorse or promote products derived 27 * from this software without specific prior written permission. 28 * 29 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 30 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 31 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 32 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 33 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 34 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 35 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 36 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 37 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 39 * POSSIBILITY OF SUCH DAMAGE. 40 */ 41 42 #if defined(__NetBSD__) 43 #include <sys/callout.h> 44 #endif 45 46 /* From usb_mem.h */ 47 DECLARE_USB_DMA_T; 48 49 struct usbd_xfer; 50 struct usbd_pipe; 51 52 struct usbd_endpoint { 53 usb_endpoint_descriptor_t *edesc; 54 int refcnt; 55 }; 56 57 struct usbd_bus_methods { 58 usbd_status (*open_pipe)(struct usbd_pipe *pipe); 59 void (*soft_intr)(struct usbd_bus *); 60 void (*do_poll)(struct usbd_bus *); 61 usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *, 62 u_int32_t bufsize); 63 void (*freem)(struct usbd_bus *, usb_dma_t *); 64 struct usbd_xfer * (*allocx)(struct usbd_bus *); 65 void (*freex)(struct usbd_bus *, struct usbd_xfer *); 66 }; 67 68 struct usbd_pipe_methods { 69 usbd_status (*transfer)(usbd_xfer_handle xfer); 70 usbd_status (*start)(usbd_xfer_handle xfer); 71 void (*abort)(usbd_xfer_handle xfer); 72 void (*close)(usbd_pipe_handle pipe); 73 void (*cleartoggle)(usbd_pipe_handle pipe); 74 void (*done)(usbd_xfer_handle xfer); 75 }; 76 77 struct usbd_port { 78 usb_port_status_t status; 79 u_int16_t power; /* mA of current on port */ 80 u_int8_t portno; 81 u_int8_t restartcnt; 82 #define USBD_RESTART_MAX 5 83 struct usbd_device *device; 84 struct usbd_device *parent; /* The ports hub */ 85 }; 86 87 struct usbd_hub { 88 usbd_status (*explore)(usbd_device_handle hub); 89 void *hubsoftc; 90 usb_hub_descriptor_t hubdesc; 91 struct usbd_port ports[1]; 92 }; 93 94 struct usb_softc; 95 96 /*****/ 97 98 struct usbd_bus { 99 /* Filled by HC driver */ 100 USBBASEDEVICE bdev; /* base device, host adapter */ 101 struct usbd_bus_methods *methods; 102 u_int32_t pipe_size; /* size of a pipe struct */ 103 /* Filled by usb driver */ 104 struct usbd_device *root_hub; 105 usbd_device_handle devices[USB_MAX_DEVICES]; 106 char needs_explore;/* a hub a signalled a change */ 107 char use_polling; 108 struct usb_softc *usbctl; 109 struct usb_device_stats stats; 110 int intr_context; 111 u_int no_intrs; 112 int usbrev; /* USB revision */ 113 #define USBREV_UNKNOWN 0 114 #define USBREV_PRE_1_0 1 115 #define USBREV_1_0 2 116 #define USBREV_1_1 3 117 #define USBREV_2_0 4 118 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1" } 119 120 #if defined(__NetBSD__) || defined(__OpenBSD__) 121 bus_dma_tag_t dmatag; /* DMA tag */ 122 #endif 123 }; 124 125 struct usbd_device { 126 struct usbd_bus *bus; /* our controller */ 127 struct usbd_pipe *default_pipe; /* pipe 0 */ 128 u_int8_t address; /* device addess */ 129 u_int8_t config; /* current configuration # */ 130 u_int8_t depth; /* distance from root hub */ 131 u_int8_t lowspeed; /* lowspeed flag */ 132 u_int8_t self_powered; /* flag for self powered */ 133 u_int16_t power; /* mA the device uses */ 134 int16_t langid; /* language for strings */ 135 #define USBD_NOLANG (-1) 136 usb_event_cookie_t cookie; /* unique connection id */ 137 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 138 struct usbd_endpoint def_ep; /* for pipe 0 */ 139 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 140 struct usbd_interface *ifaces; /* array of all interfaces */ 141 usb_device_descriptor_t ddesc; /* device descriptor */ 142 usb_config_descriptor_t *cdesc; /* full config descr */ 143 const struct usbd_quirks *quirks; /* device quirks, always set */ 144 struct usbd_hub *hub; /* only if this is a hub */ 145 device_ptr_t *subdevs; /* sub-devices, 0 terminated */ 146 }; 147 148 struct usbd_interface { 149 struct usbd_device *device; 150 usb_interface_descriptor_t *idesc; 151 int index; 152 int altindex; 153 struct usbd_endpoint *endpoints; 154 void *priv; 155 LIST_HEAD(, usbd_pipe) pipes; 156 }; 157 158 struct usbd_pipe { 159 struct usbd_interface *iface; 160 struct usbd_device *device; 161 struct usbd_endpoint *endpoint; 162 int refcnt; 163 char running; 164 char aborting; 165 SIMPLEQ_HEAD(, usbd_xfer) queue; 166 LIST_ENTRY(usbd_pipe) next; 167 168 usbd_xfer_handle intrxfer; /* used for repeating requests */ 169 char repeat; 170 int interval; 171 172 usb_callout_t abort_handle; 173 174 /* Filled by HC driver. */ 175 struct usbd_pipe_methods *methods; 176 }; 177 178 struct usbd_xfer { 179 struct usbd_pipe *pipe; 180 void *priv; 181 void *buffer; 182 u_int32_t length; 183 u_int32_t actlen; 184 u_int16_t flags; 185 u_int32_t timeout; 186 usbd_status status; 187 usbd_callback callback; 188 __volatile char done; 189 #ifdef DIAGNOSTIC 190 u_int32_t busy_free; 191 #define XFER_FREE 0x46524545 192 #define XFER_BUSY 0x42555357 193 #endif 194 195 /* For control pipe */ 196 usb_device_request_t request; 197 198 /* For isoc */ 199 u_int16_t *frlengths; 200 int nframes; 201 202 /* For memory allocation */ 203 struct usbd_device *device; 204 usb_dma_t dmabuf; 205 206 int rqflags; 207 #define URQ_REQUEST 0x01 208 #define URQ_AUTO_DMABUF 0x10 209 #define URQ_DEV_DMABUF 0x20 210 211 SIMPLEQ_ENTRY(usbd_xfer) next; 212 213 void *hcpriv; /* private use by the HC driver */ 214 215 usb_callout_t timeout_handle; 216 }; 217 218 void usbd_init(void); 219 void usbd_finish(void); 220 221 /* Routines from usb_subr.c */ 222 int usbctlprint(void *, const char *); 223 void usb_delay_ms(usbd_bus_handle, u_int); 224 usbd_status usbd_reset_port(usbd_device_handle dev, 225 int port, usb_port_status_t *ps); 226 usbd_status usbd_setup_pipe(usbd_device_handle dev, 227 usbd_interface_handle iface, 228 struct usbd_endpoint *, int, 229 usbd_pipe_handle *pipe); 230 usbd_status usbd_new_device(device_ptr_t parent, 231 usbd_bus_handle bus, int depth, 232 int lowspeed, int port, 233 struct usbd_port *); 234 void usbd_remove_device(usbd_device_handle, struct usbd_port *); 235 int usbd_printBCD(char *cp, int bcd); 236 usbd_status usbd_fill_iface_data(usbd_device_handle dev, int i, int a); 237 void usb_free_device(usbd_device_handle); 238 239 usbd_status usb_insert_transfer(usbd_xfer_handle xfer); 240 void usb_transfer_complete(usbd_xfer_handle xfer); 241 void usb_disconnect_port(struct usbd_port *up, device_ptr_t); 242 243 /* Routines from usb.c */ 244 void usb_needs_explore(usbd_device_handle); 245 void usb_schedsoftintr(struct usbd_bus *); 246 247 /* 248 * XXX This check is extremely bogus. Bad Bad Bad. 249 */ 250 #if defined(DIAGNOSTIC) && 0 251 #define SPLUSBCHECK \ 252 do { int _s = splusb(), _su = splusb(); \ 253 if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \ 254 _s, _su, __FILE__, __LINE__); \ 255 splx(_s); \ 256 } while (0) 257 #else 258 #define SPLUSBCHECK 259 #endif 260 261 /* Locator stuff. */ 262 263 #if defined(__NetBSD__) 264 #include "locators.h" 265 #elif defined(__FreeBSD__) || defined(__OpenBSD__) 266 /* XXX these values are used to statically bind some elements in the USB tree 267 * to specific driver instances. This should be somehow emulated in FreeBSD 268 * but can be done later on. 269 * The values are copied from the files.usb file in the NetBSD sources. 270 */ 271 #define UHUBCF_PORT_DEFAULT -1 272 #define UHUBCF_CONFIGURATION_DEFAULT -1 273 #define UHUBCF_INTERFACE_DEFAULT -1 274 #define UHUBCF_VENDOR_DEFAULT -1 275 #define UHUBCF_PRODUCT_DEFAULT -1 276 #define UHUBCF_RELEASE_DEFAULT -1 277 #endif 278 279 #if defined (__OpenBSD__) 280 #define UHUBCF_PORT 0 281 #define UHUBCF_CONFIGURATION 1 282 #define UHUBCF_INTERFACE 2 283 #define UHUBCF_VENDOR 3 284 #define UHUBCF_PRODUCT 4 285 #define UHUBCF_RELEASE 5 286 #endif 287 288 #define uhubcf_port cf_loc[UHUBCF_PORT] 289 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION] 290 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE] 291 #define uhubcf_vendor cf_loc[UHUBCF_VENDOR] 292 #define uhubcf_product cf_loc[UHUBCF_PRODUCT] 293 #define uhubcf_release cf_loc[UHUBCF_RELEASE] 294 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */ 295 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 296 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 297 #define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */ 298 #define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */ 299 #define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */ 300 301