1 /* $OpenBSD: usbdivar.h,v 1.34 2008/06/29 10:04:15 yuo Exp $ */ 2 /* $NetBSD: usbdivar.h,v 1.70 2002/07/11 21:14:36 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 * 22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 /* From usb_mem.h */ 36 struct usb_dma_block; 37 typedef struct { 38 struct usb_dma_block *block; 39 u_int offs; 40 } usb_dma_t; 41 42 struct usbd_xfer; 43 struct usbd_pipe; 44 45 struct usbd_endpoint { 46 usb_endpoint_descriptor_t *edesc; 47 int refcnt; 48 int savedtoggle; 49 }; 50 51 struct usbd_bus_methods { 52 usbd_status (*open_pipe)(struct usbd_pipe *pipe); 53 void (*soft_intr)(void *); 54 void (*do_poll)(struct usbd_bus *); 55 usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *, 56 u_int32_t bufsize); 57 void (*freem)(struct usbd_bus *, usb_dma_t *); 58 struct usbd_xfer * (*allocx)(struct usbd_bus *); 59 void (*freex)(struct usbd_bus *, struct usbd_xfer *); 60 }; 61 62 struct usbd_pipe_methods { 63 usbd_status (*transfer)(usbd_xfer_handle xfer); 64 usbd_status (*start)(usbd_xfer_handle xfer); 65 void (*abort)(usbd_xfer_handle xfer); 66 void (*close)(usbd_pipe_handle pipe); 67 void (*cleartoggle)(usbd_pipe_handle pipe); 68 void (*done)(usbd_xfer_handle xfer); 69 }; 70 71 struct usbd_tt { 72 struct usbd_hub *hub; 73 }; 74 75 struct usbd_port { 76 usb_port_status_t status; 77 u_int16_t power; /* mA of current on port */ 78 u_int8_t portno; 79 u_int8_t restartcnt; 80 #define USBD_RESTART_MAX 5 81 u_int8_t reattach; 82 struct usbd_device *device; /* Connected device */ 83 struct usbd_device *parent; /* The ports hub */ 84 struct usbd_tt *tt; /* Transaction translator (if any) */ 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 struct device 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", "2.0" } 119 120 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS 121 void *soft; /* soft interrupt cookie */ 122 #endif 123 bus_dma_tag_t dmatag; /* DMA tag */ 124 }; 125 126 struct usbd_device { 127 struct usbd_bus *bus; /* our controller */ 128 struct usbd_pipe *default_pipe; /* pipe 0 */ 129 u_int8_t address; /* device address */ 130 u_int8_t config; /* current configuration # */ 131 u_int8_t depth; /* distance from root hub */ 132 u_int8_t speed; /* low/full/high speed */ 133 u_int8_t self_powered; /* flag for self powered */ 134 u_int16_t power; /* mA the device uses */ 135 int16_t langid; /* language for strings */ 136 #define USBD_NOLANG (-1) 137 usb_event_cookie_t cookie; /* unique connection id */ 138 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 139 struct usbd_device *myhub; /* upstream hub */ 140 struct usbd_port *myhsport; /* closest high speed port */ 141 struct usbd_endpoint def_ep; /* for pipe 0 */ 142 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 143 struct usbd_interface *ifaces; /* array of all interfaces */ 144 usb_device_descriptor_t ddesc; /* device descriptor */ 145 usb_config_descriptor_t *cdesc; /* full config descr */ 146 const struct usbd_quirks *quirks; /* device quirks, always set */ 147 struct usbd_hub *hub; /* only if this is a hub */ 148 struct device **subdevs; /* sub-devices, 0 terminated */ 149 }; 150 151 struct usbd_interface { 152 struct usbd_device *device; 153 usb_interface_descriptor_t *idesc; 154 int index; 155 int altindex; 156 struct usbd_endpoint *endpoints; 157 void *priv; 158 LIST_HEAD(, usbd_pipe) pipes; 159 }; 160 161 struct usbd_pipe { 162 struct usbd_interface *iface; 163 struct usbd_device *device; 164 struct usbd_endpoint *endpoint; 165 int refcnt; 166 char running; 167 char aborting; 168 SIMPLEQ_HEAD(, usbd_xfer) queue; 169 LIST_ENTRY(usbd_pipe) next; 170 171 usbd_xfer_handle intrxfer; /* used for repeating requests */ 172 char repeat; 173 int interval; 174 175 /* Filled by HC driver. */ 176 struct usbd_pipe_methods *methods; 177 }; 178 179 struct usbd_xfer { 180 struct usbd_pipe *pipe; 181 void *priv; 182 void *buffer; 183 u_int32_t length; 184 u_int32_t actlen; 185 u_int16_t flags; 186 u_int32_t timeout; 187 usbd_status status; 188 usbd_callback callback; 189 __volatile char done; 190 #ifdef DIAGNOSTIC 191 u_int32_t busy_free; 192 #define XFER_FREE 0x46524545 193 #define XFER_BUSY 0x42555359 194 #define XFER_ONQU 0x4f4e5155 195 #endif 196 197 /* For control pipe */ 198 usb_device_request_t request; 199 200 /* For isoc */ 201 u_int16_t *frlengths; 202 int nframes; 203 204 /* For memory allocation */ 205 struct usbd_device *device; 206 usb_dma_t dmabuf; 207 208 int rqflags; 209 #define URQ_REQUEST 0x01 210 #define URQ_AUTO_DMABUF 0x10 211 #define URQ_DEV_DMABUF 0x20 212 213 SIMPLEQ_ENTRY(usbd_xfer) next; 214 215 void *hcpriv; /* private use by the HC driver */ 216 217 struct timeout timeout_handle; 218 }; 219 220 void usbd_init(void); 221 void usbd_finish(void); 222 223 #ifdef USB_DEBUG 224 void usbd_dump_iface(struct usbd_interface *iface); 225 void usbd_dump_device(struct usbd_device *dev); 226 void usbd_dump_endpoint(struct usbd_endpoint *endp); 227 void usbd_dump_queue(usbd_pipe_handle pipe); 228 void usbd_dump_pipe(usbd_pipe_handle pipe); 229 #endif 230 231 /* Routines from usb_subr.c */ 232 int usbctlprint(void *, const char *); 233 void usb_delay_ms(usbd_bus_handle, u_int); 234 usbd_status usbd_port_disown_to_1_1(usbd_device_handle dev, 235 int port, usb_port_status_t *ps); 236 usbd_status usbd_reset_port(usbd_device_handle dev, 237 int port, usb_port_status_t *ps); 238 usbd_status usbd_setup_pipe(usbd_device_handle dev, 239 usbd_interface_handle iface, struct usbd_endpoint *, int, 240 usbd_pipe_handle *pipe); 241 usbd_status usbd_new_device(struct device *parent, usbd_bus_handle bus, 242 int depth, int lowspeed, int port, struct usbd_port *); 243 void usbd_remove_device(usbd_device_handle, struct usbd_port *); 244 int usbd_printBCD(char *cp, size_t len, int bcd); 245 usbd_status usbd_fill_iface_data(usbd_device_handle dev, int i, int a); 246 void usb_free_device(usbd_device_handle); 247 248 usbd_status usb_insert_transfer(usbd_xfer_handle xfer); 249 void usb_transfer_complete(usbd_xfer_handle xfer); 250 void usb_disconnect_port(struct usbd_port *up, struct device *); 251 252 /* Routines from usb.c */ 253 void usb_needs_explore(usbd_device_handle); 254 void usb_needs_reattach(usbd_device_handle); 255 void usb_schedsoftintr(struct usbd_bus *); 256 257 /* 258 * XXX This check is extremely bogus. Bad Bad Bad. 259 */ 260 #if defined(DIAGNOSTIC) && 0 261 #define SPLUSBCHECK \ 262 do { int _s = splusb(), _su = splusb(); \ 263 if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \ 264 _s, _su, __FILE__, __LINE__); \ 265 splx(_s); \ 266 } while (0) 267 #else 268 #define SPLUSBCHECK 269 #endif 270 271 /* Locator stuff. */ 272 273 /* XXX these values are used to statically bind some elements in the USB tree 274 * to specific driver instances. This should be somehow emulated in FreeBSD 275 * but can be done later on. 276 * The values are copied from the files.usb file in the NetBSD sources. 277 */ 278 #define UHUBCF_PORT_DEFAULT -1 279 #define UHUBCF_CONFIGURATION_DEFAULT -1 280 #define UHUBCF_INTERFACE_DEFAULT -1 281 #define UHUBCF_VENDOR_DEFAULT -1 282 #define UHUBCF_PRODUCT_DEFAULT -1 283 #define UHUBCF_RELEASE_DEFAULT -1 284 285 #define UHUBCF_PORT 0 286 #define UHUBCF_CONFIGURATION 1 287 #define UHUBCF_INTERFACE 2 288 #define UHUBCF_VENDOR 3 289 #define UHUBCF_PRODUCT 4 290 #define UHUBCF_RELEASE 5 291 292 #define uhubcf_port cf_loc[UHUBCF_PORT] 293 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION] 294 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE] 295 #define uhubcf_vendor cf_loc[UHUBCF_VENDOR] 296 #define uhubcf_product cf_loc[UHUBCF_PRODUCT] 297 #define uhubcf_release cf_loc[UHUBCF_RELEASE] 298 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */ 299 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 300 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 301 #define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */ 302 #define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */ 303 #define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */ 304