usbdivar.h revision 1.111
1 /* $NetBSD: usbdivar.h,v 1.111 2016/01/06 22:12:49 skrll 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 (aka IPL_SOFTNET). 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 * new_device 52 * 53 * PIPE METHOD LOCK NOTES 54 * ----------------------- ------- ------------------------- 55 * transfer - 56 * start - might want to take lock? 57 * abort x 58 * close x 59 * cleartoggle - 60 * done x 61 * 62 * The above semantics are likely to change. Little performance 63 * evaluation has been done on this code and the locking strategy. 64 * 65 * USB functions known to expect the lock taken include (this list is 66 * probably not exhaustive): 67 * usb_transfer_complete() 68 * usb_insert_transfer() 69 * usb_start_next() 70 * 71 */ 72 73 #include <sys/callout.h> 74 #include <sys/mutex.h> 75 #include <sys/bus.h> 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 struct usbd_port; 87 88 struct usbd_endpoint { 89 usb_endpoint_descriptor_t *edesc; 90 int refcnt; 91 int datatoggle; 92 }; 93 94 struct usbd_bus_methods { 95 usbd_status (*open_pipe)(struct usbd_pipe *pipe); 96 void (*soft_intr)(void *); 97 void (*do_poll)(struct usbd_bus *); 98 usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *, 99 u_int32_t bufsize); 100 void (*freem)(struct usbd_bus *, usb_dma_t *); 101 struct usbd_xfer * (*allocx)(struct usbd_bus *); 102 void (*freex)(struct usbd_bus *, struct usbd_xfer *); 103 void (*get_lock)(struct usbd_bus *, kmutex_t **); 104 usbd_status (*new_device)(device_t, usbd_bus_handle, int, 105 int, int, struct usbd_port *); 106 }; 107 108 struct usbd_pipe_methods { 109 usbd_status (*transfer)(usbd_xfer_handle xfer); 110 usbd_status (*start)(usbd_xfer_handle xfer); 111 void (*abort)(usbd_xfer_handle xfer); 112 void (*close)(usbd_pipe_handle pipe); 113 void (*cleartoggle)(usbd_pipe_handle pipe); 114 void (*done)(usbd_xfer_handle xfer); 115 }; 116 117 #if 0 /* notyet */ 118 struct usbd_tt { 119 struct usbd_hub *hub; 120 }; 121 #endif 122 123 struct usbd_port { 124 usb_port_status_t status; 125 u_int16_t power; /* mA of current on port */ 126 u_int8_t portno; 127 u_int8_t restartcnt; 128 #define USBD_RESTART_MAX 5 129 u_int8_t reattach; 130 struct usbd_device *device; /* Connected device */ 131 struct usbd_device *parent; /* The ports hub */ 132 #if 0 133 struct usbd_tt *tt; /* Transaction translator (if any) */ 134 #endif 135 }; 136 137 struct usbd_hub { 138 usbd_status (*explore)(usbd_device_handle hub); 139 void *hubsoftc; 140 usb_hub_descriptor_t hubdesc; 141 struct usbd_port ports[1]; 142 }; 143 144 /*****/ 145 146 struct usbd_bus { 147 /* Filled by HC driver */ 148 void *hci_private; 149 const struct usbd_bus_methods *methods; 150 u_int32_t pipe_size; /* size of a pipe struct */ 151 /* Filled by usb driver */ 152 kmutex_t *lock; 153 struct usbd_device *root_hub; 154 usbd_device_handle devices[USB_MAX_DEVICES]; 155 kcondvar_t needs_explore_cv; 156 char needs_explore;/* a hub a signalled a change */ 157 char use_polling; 158 device_t usbctl; 159 struct usb_device_stats stats; 160 u_int no_intrs; 161 int usbrev; /* USB revision */ 162 #define USBREV_UNKNOWN 0 163 #define USBREV_PRE_1_0 1 164 #define USBREV_1_0 2 165 #define USBREV_1_1 3 166 #define USBREV_2_0 4 167 #define USBREV_3_0 5 168 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0", "3.0" } 169 170 void *soft; /* soft interrupt cookie */ 171 bus_dma_tag_t dmatag; /* DMA tag */ 172 }; 173 174 struct usbd_device { 175 struct usbd_bus *bus; /* our controller */ 176 struct usbd_pipe *default_pipe; /* pipe 0 */ 177 u_int8_t address; /* device addess */ 178 u_int8_t config; /* current configuration # */ 179 u_int8_t depth; /* distance from root hub */ 180 u_int8_t speed; /* low/full/high speed */ 181 u_int8_t self_powered; /* flag for self powered */ 182 u_int16_t power; /* mA the device uses */ 183 int16_t langid; /* language for strings */ 184 #define USBD_NOLANG (-1) 185 usb_event_cookie_t cookie; /* unique connection id */ 186 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 187 struct usbd_device *myhub; /* upstream hub */ 188 struct usbd_port *myhsport; /* closest high speed port */ 189 struct usbd_endpoint def_ep; /* for pipe 0 */ 190 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 191 struct usbd_interface *ifaces; /* array of all interfaces */ 192 usb_device_descriptor_t ddesc; /* device descriptor */ 193 usb_config_descriptor_t *cdesc; /* full config descr */ 194 const struct usbd_quirks *quirks; /* device quirks, always set */ 195 struct usbd_hub *hub; /* only if this is a hub */ 196 int subdevlen; /* array length of following */ 197 device_t *subdevs; /* sub-devices */ 198 int nifaces_claimed; /* number of ifaces in use */ 199 void *hci_private; 200 201 char *ud_serial; /* serial number, can be NULL */ 202 char *ud_vendor; /* vendor string, can be NULL */ 203 char *ud_product; /* product string can be NULL */ 204 }; 205 206 struct usbd_interface { 207 struct usbd_device *device; 208 usb_interface_descriptor_t *idesc; 209 int index; 210 int altindex; 211 struct usbd_endpoint *endpoints; 212 void *priv; 213 LIST_HEAD(, usbd_pipe) pipes; 214 }; 215 216 struct usbd_pipe { 217 struct usbd_interface *iface; 218 struct usbd_device *device; 219 struct usbd_endpoint *endpoint; 220 int refcnt; 221 char running; 222 char aborting; 223 SIMPLEQ_HEAD(, usbd_xfer) queue; 224 LIST_ENTRY(usbd_pipe) next; 225 struct usb_task async_task; 226 227 usbd_xfer_handle intrxfer; /* used for repeating requests */ 228 char repeat; 229 int interval; 230 uint8_t flags; 231 232 /* Filled by HC driver. */ 233 const struct usbd_pipe_methods *methods; 234 }; 235 236 struct usbd_xfer { 237 struct usbd_pipe *pipe; 238 void *priv; 239 void *buffer; 240 kcondvar_t cv; 241 u_int32_t length; 242 u_int32_t actlen; 243 u_int16_t flags; 244 u_int32_t timeout; 245 usbd_status status; 246 usbd_callback callback; 247 volatile u_int8_t done; 248 u_int8_t busy_free; /* used for DIAGNOSTIC */ 249 #define XFER_FREE 0x46 250 #define XFER_BUSY 0x55 251 #define XFER_ONQU 0x9e 252 253 /* For control pipe */ 254 usb_device_request_t request; 255 256 /* For isoc */ 257 u_int16_t *frlengths; 258 int nframes; 259 260 /* For memory allocation */ 261 struct usbd_device *device; 262 usb_dma_t dmabuf; 263 264 u_int8_t rqflags; 265 #define URQ_REQUEST 0x01 266 #define URQ_AUTO_DMABUF 0x10 267 #define URQ_DEV_DMABUF 0x20 268 269 SIMPLEQ_ENTRY(usbd_xfer) next; 270 271 void *hcpriv; /* private use by the HC driver */ 272 u_int8_t hcflags; /* private use by the HC driver */ 273 #define UXFER_ABORTING 0x01 /* xfer is aborting. */ 274 #define UXFER_ABORTWAIT 0x02 /* abort completion is being awaited. */ 275 kcondvar_t hccv; /* private use by the HC driver */ 276 277 struct callout timeout_handle; 278 }; 279 280 void usbd_init(void); 281 void usbd_finish(void); 282 283 #if defined(USB_DEBUG) || defined(EHCI_DEBUG) || defined(OHCI_DEBUG) 284 void usbd_dump_iface(struct usbd_interface *iface); 285 void usbd_dump_device(struct usbd_device *dev); 286 void usbd_dump_endpoint(struct usbd_endpoint *endp); 287 void usbd_dump_queue(usbd_pipe_handle pipe); 288 void usbd_dump_pipe(usbd_pipe_handle pipe); 289 #endif 290 291 /* Routines from usb_subr.c */ 292 int usbctlprint(void *, const char *); 293 void usbd_get_device_strings(struct usbd_device *); 294 void usb_delay_ms_locked(usbd_bus_handle, u_int, kmutex_t *); 295 void usb_delay_ms(usbd_bus_handle, u_int); 296 void usbd_delay_ms_locked(usbd_device_handle, u_int, kmutex_t *); 297 void usbd_delay_ms(usbd_device_handle, u_int); 298 usbd_status usbd_reset_port(usbd_device_handle, int, usb_port_status_t *); 299 usbd_status usbd_setup_pipe(usbd_device_handle dev, 300 usbd_interface_handle iface, 301 struct usbd_endpoint *, int, 302 usbd_pipe_handle *pipe); 303 usbd_status usbd_setup_pipe_flags(usbd_device_handle dev, 304 usbd_interface_handle iface, 305 struct usbd_endpoint *, int, 306 usbd_pipe_handle *pipe, 307 uint8_t flags); 308 usbd_status usbd_new_device(device_t, usbd_bus_handle, int, int, int, 309 struct usbd_port *); 310 usbd_status usbd_reattach_device(device_t, usbd_device_handle, 311 int, const int *); 312 313 void usbd_remove_device(usbd_device_handle, struct usbd_port *); 314 int usbd_printBCD(char *, size_t, int); 315 usbd_status usbd_fill_iface_data(usbd_device_handle, int, int); 316 void usb_free_device(usbd_device_handle); 317 318 usbd_status usb_insert_transfer(usbd_xfer_handle); 319 void usb_transfer_complete(usbd_xfer_handle); 320 int usb_disconnect_port(struct usbd_port *, device_t, int); 321 322 void usbd_kill_pipe(usbd_pipe_handle); 323 usbd_status usbd_attach_roothub(device_t, usbd_device_handle); 324 usbd_status usbd_probe_and_attach(device_t, usbd_device_handle, int, int); 325 usbd_status usbd_get_initial_ddesc(usbd_device_handle, 326 usb_device_descriptor_t *); 327 328 /* Routines from usb.c */ 329 void usb_needs_explore(usbd_device_handle); 330 void usb_needs_reattach(usbd_device_handle); 331 void usb_schedsoftintr(struct usbd_bus *); 332 333 static inline int 334 usbd_xfer_isread(struct usbd_xfer *xfer) 335 { 336 if (xfer->rqflags & URQ_REQUEST) 337 return xfer->request.bmRequestType & UT_READ; 338 339 return xfer->pipe->endpoint->edesc->bEndpointAddress & 340 UE_DIR_IN; 341 } 342 343 /* 344 * These macros reflect the current locking scheme. They might change. 345 */ 346 347 #define usbd_lock_pipe(p) mutex_enter((p)->device->bus->lock) 348 #define usbd_unlock_pipe(p) mutex_exit((p)->device->bus->lock) 349
Indexes created Tue Sep 23 02:09:52 GMT 2025