usbdivar.h revision 1.93.8.11
1 /* $NetBSD: usbdivar.h,v 1.93.8.11 2012/02/26 06:59:38 mrg 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, 2012 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 and Matthew R. Green (mrg (at) eterna.com.au). 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 * 21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include <sys/callout.h> 35 #include <sys/mutex.h> 36 #include <sys/bus.h> 37 38 /* 39 * Discussion about locking in the USB code: 40 * 41 * The host controller presents one lock at IPL_USB. 42 * 43 * List of hardware interface methods, and which locks are held when each 44 * is called by this module: 45 * 46 * BUS METHOD LOCK NOTES 47 * ----------------------- ------- ------------------------- 48 * open_pipe - might want to take lock? 49 * soft_intr x 50 * do_poll - might want to take lock? 51 * allocm - 52 * freem - 53 * allocx - 54 * freex - 55 * get_lock - Called at attach time 56 * 57 * PIPE METHOD LOCK NOTES 58 * ----------------------- ------- ------------------------- 59 * transfer - 60 * start - might want to take lock? 61 * abort x 62 * close x 63 * cleartoggle - 64 * done x 65 * 66 * The above semantics are likely to change. Little performance 67 * evaluation has been done on this code and the locking strategy. 68 * 69 * USB functions known to expect the lock taken include (this list is 70 * probably not exhaustive): 71 * usb_transfer_complete() 72 * usb_insert_transfer() 73 * usb_start_next() 74 * 75 */ 76 77 /* From usb_mem.h */ 78 struct usb_dma_block; 79 typedef struct { 80 struct usb_dma_block *block; 81 u_int offs; 82 } usb_dma_t; 83 84 struct usbd_xfer; 85 struct usbd_pipe; 86 87 struct usbd_endpoint { 88 usb_endpoint_descriptor_t *edesc; 89 int refcnt; 90 int datatoggle; 91 }; 92 93 struct usbd_bus_methods { 94 usbd_status (*open_pipe)(struct usbd_pipe *pipe); 95 void (*soft_intr)(void *); 96 void (*do_poll)(struct usbd_bus *); 97 usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *, 98 u_int32_t bufsize); 99 void (*freem)(struct usbd_bus *, usb_dma_t *); 100 struct usbd_xfer * (*allocx)(struct usbd_bus *); 101 void (*freex)(struct usbd_bus *, struct usbd_xfer *); 102 void (*get_lock)(struct usbd_bus *, kmutex_t **); 103 }; 104 105 struct usbd_pipe_methods { 106 usbd_status (*transfer)(usbd_xfer_handle xfer); 107 usbd_status (*start)(usbd_xfer_handle xfer); 108 void (*abort)(usbd_xfer_handle xfer); 109 void (*close)(usbd_pipe_handle pipe); 110 void (*cleartoggle)(usbd_pipe_handle pipe); 111 void (*done)(usbd_xfer_handle xfer); 112 }; 113 114 #if 0 /* notyet */ 115 struct usbd_tt { 116 struct usbd_hub *hub; 117 }; 118 #endif 119 120 struct usbd_port { 121 usb_port_status_t status; 122 u_int16_t power; /* mA of current on port */ 123 u_int8_t portno; 124 u_int8_t restartcnt; 125 #define USBD_RESTART_MAX 5 126 u_int8_t reattach; 127 struct usbd_device *device; /* Connected device */ 128 struct usbd_device *parent; /* The ports hub */ 129 #if 0 130 struct usbd_tt *tt; /* Transaction translator (if any) */ 131 #endif 132 }; 133 134 struct usbd_hub { 135 usbd_status (*explore)(usbd_device_handle hub); 136 void *hubsoftc; 137 usb_hub_descriptor_t hubdesc; 138 struct usbd_port ports[1]; 139 }; 140 141 /*****/ 142 143 struct usbd_bus { 144 /* Filled by HC driver */ 145 void *hci_private; 146 const struct usbd_bus_methods *methods; 147 u_int32_t pipe_size; /* size of a pipe struct */ 148 /* Filled by usb driver */ 149 kmutex_t *lock; 150 struct usbd_device *root_hub; 151 usbd_device_handle devices[USB_MAX_DEVICES]; 152 kcondvar_t needs_explore_cv; 153 char needs_explore;/* a hub a signalled a change */ 154 char use_polling; 155 device_t usbctl; 156 struct usb_device_stats stats; 157 u_int no_intrs; 158 int usbrev; /* USB revision */ 159 #define USBREV_UNKNOWN 0 160 #define USBREV_PRE_1_0 1 161 #define USBREV_1_0 2 162 #define USBREV_1_1 3 163 #define USBREV_2_0 4 164 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" } 165 166 void *soft; /* soft interrupt cookie */ 167 bus_dma_tag_t dmatag; /* DMA tag */ 168 }; 169 170 struct usbd_device { 171 struct usbd_bus *bus; /* our controller */ 172 struct usbd_pipe *default_pipe; /* pipe 0 */ 173 u_int8_t address; /* device addess */ 174 u_int8_t config; /* current configuration # */ 175 u_int8_t depth; /* distance from root hub */ 176 u_int8_t speed; /* low/full/high speed */ 177 u_int8_t self_powered; /* flag for self powered */ 178 u_int16_t power; /* mA the device uses */ 179 int16_t langid; /* language for strings */ 180 #define USBD_NOLANG (-1) 181 usb_event_cookie_t cookie; /* unique connection id */ 182 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 183 struct usbd_device *myhub; /* upstream hub */ 184 struct usbd_port *myhsport; /* closest high speed port */ 185 struct usbd_endpoint def_ep; /* for pipe 0 */ 186 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 187 struct usbd_interface *ifaces; /* array of all interfaces */ 188 usb_device_descriptor_t ddesc; /* device descriptor */ 189 usb_config_descriptor_t *cdesc; /* full config descr */ 190 const struct usbd_quirks *quirks; /* device quirks, always set */ 191 struct usbd_hub *hub; /* only if this is a hub */ 192 int subdevlen; /* array length of following */ 193 device_t *subdevs; /* sub-devices */ 194 int nifaces_claimed; /* number of ifaces in use */ 195 }; 196 197 struct usbd_interface { 198 struct usbd_device *device; 199 usb_interface_descriptor_t *idesc; 200 int index; 201 int altindex; 202 struct usbd_endpoint *endpoints; 203 void *priv; 204 LIST_HEAD(, usbd_pipe) pipes; 205 }; 206 207 struct usbd_pipe { 208 struct usbd_interface *iface; 209 struct usbd_device *device; 210 struct usbd_endpoint *endpoint; 211 int refcnt; 212 char running; 213 char aborting; 214 SIMPLEQ_HEAD(, usbd_xfer) queue; 215 LIST_ENTRY(usbd_pipe) next; 216 217 usbd_xfer_handle intrxfer; /* used for repeating requests */ 218 char repeat; 219 int interval; 220 221 /* Filled by HC driver. */ 222 const struct usbd_pipe_methods *methods; 223 }; 224 225 struct usbd_xfer { 226 struct usbd_pipe *pipe; 227 void *priv; 228 void *buffer; 229 kcondvar_t cv; 230 u_int32_t length; 231 u_int32_t actlen; 232 u_int16_t flags; 233 u_int32_t timeout; 234 usbd_status status; 235 usbd_callback callback; 236 volatile u_int8_t done; 237 u_int8_t busy_free; /* used for DIAGNOSTIC */ 238 #define XFER_FREE 0x46 239 #define XFER_BUSY 0x55 240 #define XFER_ONQU 0x9e 241 242 /* For control pipe */ 243 usb_device_request_t request; 244 245 /* For isoc */ 246 u_int16_t *frlengths; 247 int nframes; 248 249 /* For memory allocation */ 250 struct usbd_device *device; 251 usb_dma_t dmabuf; 252 253 u_int8_t rqflags; 254 #define URQ_REQUEST 0x01 255 #define URQ_AUTO_DMABUF 0x10 256 #define URQ_DEV_DMABUF 0x20 257 258 SIMPLEQ_ENTRY(usbd_xfer) next; 259 260 void *hcpriv; /* private use by the HC driver */ 261 u_int8_t hcflags; /* private use by the HC driver */ 262 #define UXFER_ABORTING 0x01 /* xfer is aborting. */ 263 #define UXFER_ABORTWAIT 0x02 /* abort completion is being awaited. */ 264 kcondvar_t hccv; /* private use by the HC driver */ 265 266 struct callout timeout_handle; 267 }; 268 269 void usbd_init(void); 270 void usbd_finish(void); 271 272 #if defined(USB_DEBUG) || defined(EHCI_DEBUG) 273 void usbd_dump_iface(struct usbd_interface *iface); 274 void usbd_dump_device(struct usbd_device *dev); 275 void usbd_dump_endpoint(struct usbd_endpoint *endp); 276 void usbd_dump_queue(usbd_pipe_handle pipe); 277 void usbd_dump_pipe(usbd_pipe_handle pipe); 278 #endif 279 280 /* Routines from usb_subr.c */ 281 int usbctlprint(void *, const char *); 282 void usb_delay_ms_locked(usbd_bus_handle, u_int, kmutex_t *); 283 void usb_delay_ms(usbd_bus_handle, u_int); 284 void usbd_delay_ms_locked(usbd_device_handle, u_int, kmutex_t *); 285 void usbd_delay_ms(usbd_device_handle, u_int); 286 usbd_status usbd_reset_port(usbd_device_handle, int, usb_port_status_t *); 287 usbd_status usbd_setup_pipe(usbd_device_handle dev, 288 usbd_interface_handle iface, 289 struct usbd_endpoint *, int, 290 usbd_pipe_handle *pipe); 291 usbd_status usbd_new_device(device_t, usbd_bus_handle, int, int, int, 292 struct usbd_port *); 293 usbd_status usbd_reattach_device(device_t, usbd_device_handle, 294 int, const int *); 295 296 void usbd_remove_device(usbd_device_handle, struct usbd_port *); 297 int usbd_printBCD(char *, size_t, int); 298 usbd_status usbd_fill_iface_data(usbd_device_handle, int, int); 299 void usb_free_device(usbd_device_handle); 300 301 usbd_status usb_insert_transfer(usbd_xfer_handle); 302 void usb_transfer_complete(usbd_xfer_handle); 303 int usb_disconnect_port(struct usbd_port *, device_t, int); 304 305 /* Routines from usb.c */ 306 void usb_needs_explore(usbd_device_handle); 307 void usb_needs_reattach(usbd_device_handle); 308 void usb_schedsoftintr(struct usbd_bus *); 309 310 /* 311 * These macros help while not all host controllers are ported to the MP code. 312 */ 313 #define usbd_mutex_enter(m) do { \ 314 if (m) { \ 315 s = -1; \ 316 mutex_enter(m); \ 317 } else \ 318 s = splusb(); \ 319 } while (0) 320 321 #define usbd_mutex_exit(m) do { \ 322 if (m) { \ 323 s = -1; \ 324 mutex_exit(m); \ 325 } else \ 326 splx(s); \ 327 } while (0) 328 329 #define usbd_lock_pipe(p) usbd_mutex_enter((p)->device->bus->lock) 330 #define usbd_unlock_pipe(p) usbd_mutex_exit((p)->device->bus->lock) 331
Indexes created Wed Oct 01 18:09:54 GMT 2025