1 /* $NetBSD: usbdivar.h,v 1.57 2000/06/01 14:29:03 augustss Exp $ */ 2 /* $FreeBSD: src/sys/dev/usb/usbdivar.h,v 1.11 1999/11/17 22:33:51 n_hibma Exp $ */ 3 4 /* 5 * Copyright (c) 1998 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Lennart Augustsson (lennart@augustsson.net) at 10 * Carlstedt Research & Technology. 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 41 #if defined(__NetBSD__) 42 #include <sys/callout.h> 43 #endif 44 45 /* From usb_mem.h */ 46 DECLARE_USB_DMA_T; 47 48 struct usbd_xfer; 49 struct usbd_pipe; 50 51 struct usbd_endpoint { 52 usb_endpoint_descriptor_t *edesc; 53 int refcnt; 54 }; 55 56 struct usbd_bus_methods { 57 usbd_status (*open_pipe)(struct usbd_pipe *pipe); 58 void (*soft_intr)(struct usbd_bus *); 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 *); 65 }; 66 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); 74 }; 75 76 struct usbd_port { 77 usb_port_status_t status; 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 82 struct usbd_device *device; 83 struct usbd_device *parent; /* The ports hub */ 84 }; 85 86 struct usbd_hub { 87 usbd_status (*explore)(usbd_device_handle hub); 88 void *hubsoftc; 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 */ 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 */ 106 char use_polling; 107 struct usb_softc *usbctl; 108 struct usb_device_stats stats; 109 int intr_context; 110 u_int no_intrs; 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 116 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1" } 117 118 #if defined(__NetBSD__) || defined(__OpenBSD__) 119 bus_dma_tag_t dmatag; /* DMA tag */ 120 #endif 121 }; 122 123 struct usbd_device { 124 struct usbd_bus *bus; /* our controller */ 125 struct usbd_pipe *default_pipe; /* pipe 0 */ 126 u_int8_t address; /* device addess */ 127 u_int8_t config; /* current configuration # */ 128 u_int8_t depth; /* distance from root hub */ 129 u_int8_t lowspeed; /* lowspeed flag */ 130 u_int8_t self_powered; /* flag for self powered */ 131 u_int16_t power; /* mA the device uses */ 132 int16_t langid; /* language for strings */ 133 #define USBD_NOLANG (-1) 134 usb_event_cookie_t cookie; /* unique connection id */ 135 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 136 struct usbd_endpoint def_ep; /* for pipe 0 */ 137 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 138 struct usbd_interface *ifaces; /* array of all interfaces */ 139 usb_device_descriptor_t ddesc; /* device descriptor */ 140 usb_config_descriptor_t *cdesc; /* full config descr */ 141 struct usbd_quirks *quirks; /* device quirks, always set */ 142 struct usbd_hub *hub; /* only if this is a hub */ 143 device_ptr_t *subdevs; /* sub-devices, 0 terminated */ 144 }; 145 146 struct usbd_interface { 147 struct usbd_device *device; 148 usb_interface_descriptor_t *idesc; 149 int index; 150 int altindex; 151 struct usbd_endpoint *endpoints; 152 void *priv; 153 LIST_HEAD(, usbd_pipe) pipes; 154 }; 155 156 struct usbd_pipe { 157 struct usbd_interface *iface; 158 struct usbd_device *device; 159 struct usbd_endpoint *endpoint; 160 int refcnt; 161 char running; 162 char aborting; 163 SIMPLEQ_HEAD(, usbd_xfer) queue; 164 LIST_ENTRY(usbd_pipe) next; 165 166 usbd_xfer_handle intrxfer; /* used for repeating requests */ 167 char repeat; 168 int interval; 169 170 usb_callout_t abort_handle; 171 172 /* Filled by HC driver. */ 173 struct usbd_pipe_methods *methods; 174 }; 175 176 struct usbd_xfer { 177 struct usbd_pipe *pipe; 178 void *priv; 179 void *buffer; 180 u_int32_t length; 181 u_int32_t actlen; 182 u_int16_t flags; 183 u_int32_t timeout; 184 usbd_status status; 185 usbd_callback callback; 186 __volatile char done; 187 #ifdef DIAGNOSTIC 188 u_int32_t busy_free; 189 #define XFER_FREE 0x46524545 190 #define XFER_BUSY 0x42555357 191 #endif 192 193 /* For control pipe */ 194 usb_device_request_t request; 195 196 /* For isoc */ 197 u_int16_t *frlengths; 198 int nframes; 199 200 /* For memory allocation */ 201 struct usbd_device *device; 202 usb_dma_t dmabuf; 203 204 int rqflags; 205 #define URQ_REQUEST 0x01 206 #define URQ_AUTO_DMABUF 0x10 207 #define URQ_DEV_DMABUF 0x20 208 209 SIMPLEQ_ENTRY(usbd_xfer) next; 210 211 void *hcpriv; /* private use by the HC driver */ 212 213 usb_callout_t timeout_handle; 214 }; 215 216 void usbd_init(void); 217 void usbd_finish(void); 218 219 /* Routines from usb_subr.c */ 220 int usbctlprint(void *, const char *); 221 void usb_delay_ms(usbd_bus_handle, u_int); 222 void usbd_devinfo_vp(usbd_device_handle, char *, char *); 223 usbd_status usbd_reset_port(usbd_device_handle dev, 224 int port, usb_port_status_t *ps); 225 usbd_status usbd_setup_pipe(usbd_device_handle dev, 226 usbd_interface_handle iface, 227 struct usbd_endpoint *, int, 228 usbd_pipe_handle *pipe); 229 usbd_status usbd_new_device(device_ptr_t parent, 230 usbd_bus_handle bus, int depth, 231 int lowspeed, int port, 232 struct usbd_port *); 233 void usbd_remove_device(usbd_device_handle, struct usbd_port *); 234 int usbd_printBCD(char *cp, int bcd); 235 usbd_status usbd_fill_iface_data(usbd_device_handle dev, int i, int a); 236 void usb_free_device(usbd_device_handle); 237 238 usbd_status usb_insert_transfer(usbd_xfer_handle xfer); 239 void usb_transfer_complete(usbd_xfer_handle xfer); 240 void usb_disconnect_port(struct usbd_port *up, device_ptr_t); 241 242 /* Routines from usb.c */ 243 void usb_needs_explore(usbd_bus_handle); 244 void usb_schedsoftintr(struct usbd_bus *); 245 246 #ifdef DIAGNOSTIC 247 #define SPLUSBCHECK \ 248 do { int _s = splusb(), _su = splusb(); \ 249 if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \ 250 _s, _su, __FILE__, __LINE__); \ 251 splx(_s); \ 252 } while (0) 253 #else 254 #define SPLUSBCHECK 255 #endif 256 257 /* Locator stuff. */ 258 259 #if defined(__NetBSD__) 260 #include "locators.h" 261 #elif defined(__FreeBSD__) || defined(__OpenBSD__) 262 /* XXX these values are used to statically bind some elements in the USB tree 263 * to specific driver instances. This should be somehow emulated in FreeBSD 264 * but can be done later on. 265 * The values are copied from the files.usb file in the NetBSD sources. 266 */ 267 #define UHUBCF_PORT_DEFAULT -1 268 #define UHUBCF_CONFIGURATION_DEFAULT -1 269 #define UHUBCF_INTERFACE_DEFAULT -1 270 #define UHUBCF_VENDOR_DEFAULT -1 271 #define UHUBCF_PRODUCT_DEFAULT -1 272 #define UHUBCF_RELEASE_DEFAULT -1 273 #endif 274 275 #if defined (__OpenBSD__) 276 #define UHUBCF_PORT 0 277 #define UHUBCF_CONFIGURATION 1 278 #define UHUBCF_INTERFACE 2 279 #define UHUBCF_VENDOR 3 280 #define UHUBCF_PRODUCT 4 281 #define UHUBCF_RELEASE 5 282 #endif 283 284 #define uhubcf_port cf_loc[UHUBCF_PORT] 285 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION] 286 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE] 287 #define uhubcf_vendor cf_loc[UHUBCF_VENDOR] 288 #define uhubcf_product cf_loc[UHUBCF_PRODUCT] 289 #define uhubcf_release cf_loc[UHUBCF_RELEASE] 290 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */ 291 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 292 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 293 #define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */ 294 #define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */ 295 #define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */ 296 297