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