usbdivar.h revision 1.64
1 /* $NetBSD: usbdivar.h,v 1.64 2001/11/10 16:54:56 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 (at) 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)(void *); 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_2_0 4 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 126 127 #if defined(__NetBSD__) || defined(__OpenBSD__) 128 bus_dma_tag_t dmatag; /* DMA tag */ 129 #endif 130 }; 131 132 struct usbd_device { 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 */ 138 u_int8_t lowspeed; /* lowspeed flag */ 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 */ 142 #define USBD_NOLANG (-1) 143 usb_event_cookie_t cookie; /* unique connection id */ 144 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 145 struct usbd_endpoint def_ep; /* for pipe 0 */ 146 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 147 struct usbd_interface *ifaces; /* array of all interfaces */ 148 usb_device_descriptor_t ddesc; /* device descriptor */ 149 usb_config_descriptor_t *cdesc; /* full config descr */ 150 const struct usbd_quirks *quirks; /* device quirks, always set */ 151 struct usbd_hub *hub; /* only if this is a hub */ 152 device_ptr_t *subdevs; /* sub-devices, 0 terminated */ 153 }; 154 155 struct usbd_interface { 156 struct usbd_device *device; 157 usb_interface_descriptor_t *idesc; 158 int index; 159 int altindex; 160 struct usbd_endpoint *endpoints; 161 void *priv; 162 LIST_HEAD(, usbd_pipe) pipes; 163 }; 164 165 struct usbd_pipe { 166 struct usbd_interface *iface; 167 struct usbd_device *device; 168 struct usbd_endpoint *endpoint; 169 int refcnt; 170 char running; 171 char aborting; 172 SIMPLEQ_HEAD(, usbd_xfer) queue; 173 LIST_ENTRY(usbd_pipe) next; 174 175 usbd_xfer_handle intrxfer; /* used for repeating requests */ 176 char repeat; 177 int interval; 178 179 usb_callout_t abort_handle; 180 181 /* Filled by HC driver. */ 182 struct usbd_pipe_methods *methods; 183 }; 184 185 struct usbd_xfer { 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; 195 __volatile char done; 196 #ifdef DIAGNOSTIC 197 u_int32_t busy_free; 198 #define XFER_FREE 0x46524545 199 #define XFER_BUSY 0x42555357 200 #endif 201 202 /* For control pipe */ 203 usb_device_request_t request; 204 205 /* For isoc */ 206 u_int16_t *frlengths; 207 int nframes; 208 209 /* For memory allocation */ 210 struct usbd_device *device; 211 usb_dma_t dmabuf; 212 213 int rqflags; 214 #define URQ_REQUEST 0x01 215 #define URQ_AUTO_DMABUF 0x10 216 #define URQ_DEV_DMABUF 0x20 217 218 SIMPLEQ_ENTRY(usbd_xfer) next; 219 220 void *hcpriv; /* private use by the HC driver */ 221 222 usb_callout_t timeout_handle; 223 }; 224 225 void usbd_init(void); 226 void usbd_finish(void); 227 228 void usbd_dump_iface(struct usbd_interface *iface); 229 void usbd_dump_device(struct usbd_device *dev); 230 void usbd_dump_endpoint(struct usbd_endpoint *endp); 231 void usbd_dump_queue(usbd_pipe_handle pipe); 232 void usbd_dump_pipe(usbd_pipe_handle pipe); 233 234 /* Routines from usb_subr.c */ 235 int usbctlprint(void *, const char *); 236 void usb_delay_ms(usbd_bus_handle, u_int); 237 usbd_status usbd_reset_port(usbd_device_handle dev, 238 int port, usb_port_status_t *ps); 239 usbd_status usbd_setup_pipe(usbd_device_handle dev, 240 usbd_interface_handle iface, 241 struct usbd_endpoint *, int, 242 usbd_pipe_handle *pipe); 243 usbd_status usbd_new_device(device_ptr_t parent, 244 usbd_bus_handle bus, int depth, 245 int lowspeed, int port, 246 struct usbd_port *); 247 void usbd_remove_device(usbd_device_handle, struct usbd_port *); 248 int usbd_printBCD(char *cp, int bcd); 249 usbd_status usbd_fill_iface_data(usbd_device_handle dev, int i, int a); 250 void usb_free_device(usbd_device_handle); 251 252 usbd_status usb_insert_transfer(usbd_xfer_handle xfer); 253 void usb_transfer_complete(usbd_xfer_handle xfer); 254 void usb_disconnect_port(struct usbd_port *up, device_ptr_t); 255 256 /* Routines from usb.c */ 257 void usb_needs_explore(usbd_device_handle); 258 void usb_schedsoftintr(struct usbd_bus *); 259 260 /* 261 * XXX This check is extremely bogus. Bad Bad Bad. 262 */ 263 #if defined(DIAGNOSTIC) && 0 264 #define SPLUSBCHECK \ 265 do { int _s = splusb(), _su = splusb(); \ 266 if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \ 267 _s, _su, __FILE__, __LINE__); \ 268 splx(_s); \ 269 } while (0) 270 #else 271 #define SPLUSBCHECK 272 #endif 273 274 /* Locator stuff. */ 275 276 #if defined(__NetBSD__) 277 #include "locators.h" 278 #elif defined(__FreeBSD__) || defined(__OpenBSD__) 279 /* XXX these values are used to statically bind some elements in the USB tree 280 * to specific driver instances. This should be somehow emulated in FreeBSD 281 * but can be done later on. 282 * The values are copied from the files.usb file in the NetBSD sources. 283 */ 284 #define UHUBCF_PORT_DEFAULT -1 285 #define UHUBCF_CONFIGURATION_DEFAULT -1 286 #define UHUBCF_INTERFACE_DEFAULT -1 287 #define UHUBCF_VENDOR_DEFAULT -1 288 #define UHUBCF_PRODUCT_DEFAULT -1 289 #define UHUBCF_RELEASE_DEFAULT -1 290 #endif 291 292 #if defined (__OpenBSD__) 293 #define UHUBCF_PORT 0 294 #define UHUBCF_CONFIGURATION 1 295 #define UHUBCF_INTERFACE 2 296 #define UHUBCF_VENDOR 3 297 #define UHUBCF_PRODUCT 4 298 #define UHUBCF_RELEASE 5 299 #endif 300 301 #define uhubcf_port cf_loc[UHUBCF_PORT] 302 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION] 303 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE] 304 #define uhubcf_vendor cf_loc[UHUBCF_VENDOR] 305 #define uhubcf_product cf_loc[UHUBCF_PRODUCT] 306 #define uhubcf_release cf_loc[UHUBCF_RELEASE] 307 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */ 308 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 309 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 310 #define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */ 311 #define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */ 312 #define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */ 313 314
Indexes created Tue Sep 23 14:10:03 GMT 2025