usbdivar.h revision 1.109.2.27
1 1.109.2.27 skrll /* $NetBSD: usbdivar.h,v 1.109.2.27 2016/04/30 10:34:14 skrll Exp $ */ 2 1.1 augustss 3 1.1 augustss /* 4 1.97 mrg * Copyright (c) 1998, 2012 The NetBSD Foundation, Inc. 5 1.1 augustss * All rights reserved. 6 1.1 augustss * 7 1.8 augustss * This code is derived from software contributed to The NetBSD Foundation 8 1.56 augustss * by Lennart Augustsson (lennart (at) augustsson.net) at 9 1.97 mrg * Carlstedt Research & Technology and Matthew R. Green (mrg (at) eterna.com.au). 10 1.1 augustss * 11 1.1 augustss * Redistribution and use in source and binary forms, with or without 12 1.1 augustss * modification, are permitted provided that the following conditions 13 1.1 augustss * are met: 14 1.1 augustss * 1. Redistributions of source code must retain the above copyright 15 1.1 augustss * notice, this list of conditions and the following disclaimer. 16 1.1 augustss * 2. Redistributions in binary form must reproduce the above copyright 17 1.1 augustss * notice, this list of conditions and the following disclaimer in the 18 1.1 augustss * documentation and/or other materials provided with the distribution. 19 1.1 augustss * 20 1.1 augustss * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 1.1 augustss * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 1.1 augustss * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 1.1 augustss * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 1.1 augustss * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 1.1 augustss * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 1.1 augustss * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 1.1 augustss * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 1.1 augustss * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 1.1 augustss * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 1.1 augustss * POSSIBILITY OF SUCH DAMAGE. 31 1.1 augustss */ 32 1.1 augustss 33 1.97 mrg /* 34 1.97 mrg * Discussion about locking in the USB code: 35 1.97 mrg * 36 1.104 skrll * The host controller presents one lock at IPL_SOFTUSB (aka IPL_SOFTNET). 37 1.97 mrg * 38 1.99 mrg * List of hardware interface methods, and whether the lock is held 39 1.99 mrg * when each is called by this module: 40 1.97 mrg * 41 1.109.2.10 skrll * BUS METHOD LOCK NOTES 42 1.97 mrg * ----------------------- ------- ------------------------- 43 1.109.2.9 skrll * ubm_open - might want to take lock? 44 1.109.2.9 skrll * ubm_softint x 45 1.109.2.9 skrll * ubm_dopoll - might want to take lock? 46 1.109.2.9 skrll * ubm_allocx - 47 1.109.2.9 skrll * ubm_freex - 48 1.109.2.9 skrll * ubm_getlock - Called at attach time 49 1.109.2.9 skrll * ubm_newdev - Will take lock 50 1.109.2.16 skrll ubm_rhctrl 51 1.97 mrg * 52 1.109.2.10 skrll * PIPE METHOD LOCK NOTES 53 1.97 mrg * ----------------------- ------- ------------------------- 54 1.109.2.10 skrll * upm_transfer - 55 1.109.2.10 skrll * upm_start - might want to take lock? 56 1.109.2.10 skrll * upm_abort x 57 1.109.2.10 skrll * upm_close x 58 1.109.2.10 skrll * upm_cleartoggle - 59 1.109.2.10 skrll * upm_done x 60 1.97 mrg * 61 1.97 mrg * The above semantics are likely to change. Little performance 62 1.97 mrg * evaluation has been done on this code and the locking strategy. 63 1.109 skrll * 64 1.97 mrg * USB functions known to expect the lock taken include (this list is 65 1.97 mrg * probably not exhaustive): 66 1.97 mrg * usb_transfer_complete() 67 1.97 mrg * usb_insert_transfer() 68 1.97 mrg * usb_start_next() 69 1.97 mrg * 70 1.97 mrg */ 71 1.97 mrg 72 1.48 thorpej #include <sys/callout.h> 73 1.97 mrg #include <sys/mutex.h> 74 1.96 mrg #include <sys/bus.h> 75 1.48 thorpej 76 1.29 augustss /* From usb_mem.h */ 77 1.89 dyoung struct usb_dma_block; 78 1.89 dyoung typedef struct { 79 1.109.2.5 skrll struct usb_dma_block *udma_block; 80 1.109.2.5 skrll u_int udma_offs; 81 1.89 dyoung } usb_dma_t; 82 1.29 augustss 83 1.40 augustss struct usbd_xfer; 84 1.1 augustss struct usbd_pipe; 85 1.105 jakllsch struct usbd_port; 86 1.1 augustss 87 1.1 augustss struct usbd_endpoint { 88 1.109.2.5 skrll usb_endpoint_descriptor_t *ue_edesc; 89 1.109.2.5 skrll int ue_refcnt; 90 1.109.2.5 skrll int ue_toggle; 91 1.1 augustss }; 92 1.1 augustss 93 1.29 augustss struct usbd_bus_methods { 94 1.109.2.8 skrll usbd_status (*ubm_open)(struct usbd_pipe *); 95 1.109.2.3 skrll void (*ubm_softint)(void *); 96 1.109.2.3 skrll void (*ubm_dopoll)(struct usbd_bus *); 97 1.109.2.18 skrll struct usbd_xfer *(*ubm_allocx)(struct usbd_bus *, unsigned int); 98 1.109.2.3 skrll void (*ubm_freex)(struct usbd_bus *, struct usbd_xfer *); 99 1.109.2.3 skrll void (*ubm_getlock)(struct usbd_bus *, kmutex_t **); 100 1.109.2.16 skrll usbd_status (*ubm_newdev)(device_t, struct usbd_bus *, int, 101 1.105 jakllsch int, int, struct usbd_port *); 102 1.109.2.7 skrll 103 1.109.2.7 skrll int (*ubm_rhctrl)(struct usbd_bus *, 104 1.109.2.7 skrll usb_device_request_t *, void *, int); 105 1.29 augustss }; 106 1.29 augustss 107 1.29 augustss struct usbd_pipe_methods { 108 1.109.2.19 skrll int (*upm_init)(struct usbd_xfer *); 109 1.109.2.19 skrll void (*upm_fini)(struct usbd_xfer *); 110 1.109.2.16 skrll usbd_status (*upm_transfer)(struct usbd_xfer *); 111 1.109.2.16 skrll usbd_status (*upm_start)(struct usbd_xfer *); 112 1.109.2.16 skrll void (*upm_abort)(struct usbd_xfer *); 113 1.109.2.16 skrll void (*upm_close)(struct usbd_pipe *); 114 1.109.2.16 skrll void (*upm_cleartoggle)(struct usbd_pipe *); 115 1.109.2.16 skrll void (*upm_done)(struct usbd_xfer *); 116 1.1 augustss }; 117 1.1 augustss 118 1.72 augustss struct usbd_tt { 119 1.109.2.23 skrll struct usbd_hub *utt_hub; 120 1.72 augustss }; 121 1.72 augustss 122 1.1 augustss struct usbd_port { 123 1.109.2.5 skrll usb_port_status_t up_status; 124 1.109.2.5 skrll uint16_t up_power; /* mA of current on port */ 125 1.109.2.5 skrll uint8_t up_portno; 126 1.109.2.5 skrll uint8_t up_restartcnt; 127 1.11 augustss #define USBD_RESTART_MAX 5 128 1.109.2.5 skrll uint8_t up_reattach; 129 1.109.2.5 skrll struct usbd_device *up_dev; /* Connected device */ 130 1.109.2.5 skrll struct usbd_device *up_parent; /* The ports hub */ 131 1.109.2.5 skrll struct usbd_tt *up_tt; /* Transaction translator (if any) */ 132 1.1 augustss }; 133 1.1 augustss 134 1.1 augustss struct usbd_hub { 135 1.109.2.16 skrll usbd_status (*uh_explore)(struct usbd_device *hub); 136 1.109.2.5 skrll void *uh_hubsoftc; 137 1.109.2.5 skrll usb_hub_descriptor_t uh_hubdesc; 138 1.109.2.5 skrll struct usbd_port uh_ports[1]; 139 1.1 augustss }; 140 1.1 augustss 141 1.1 augustss /*****/ 142 1.1 augustss 143 1.1 augustss struct usbd_bus { 144 1.1 augustss /* Filled by HC driver */ 145 1.109.2.5 skrll void *ub_hcpriv; 146 1.109.2.6 skrll int ub_revision; /* USB revision */ 147 1.109.2.6 skrll #define USBREV_UNKNOWN 0 148 1.109.2.6 skrll #define USBREV_PRE_1_0 1 149 1.109.2.6 skrll #define USBREV_1_0 2 150 1.109.2.6 skrll #define USBREV_1_1 3 151 1.109.2.6 skrll #define USBREV_2_0 4 152 1.109.2.6 skrll #define USBREV_3_0 5 153 1.109.2.6 skrll #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0", "3.0" } 154 1.109.2.6 skrll 155 1.109.2.26 skrll const struct usbd_bus_methods 156 1.109.2.26 skrll *ub_methods; 157 1.109.2.5 skrll uint32_t ub_pipesize; /* size of a pipe struct */ 158 1.109.2.6 skrll bool ub_usedma; /* Does this HC support DMA */ 159 1.109.2.6 skrll int ub_dmaflags; 160 1.109.2.6 skrll bus_dma_tag_t ub_dmatag; /* DMA tag */ 161 1.109.2.6 skrll 162 1.1 augustss /* Filled by usb driver */ 163 1.109.2.26 skrll kmutex_t *ub_lock; 164 1.109.2.26 skrll struct usbd_device *ub_roothub; 165 1.109.2.7 skrll uint8_t ub_rhaddr; /* roothub address */ 166 1.109.2.7 skrll uint8_t ub_rhconf; /* roothub configuration */ 167 1.109.2.26 skrll struct usbd_device *ub_devices[USB_MAX_DEVICES]; 168 1.109.2.5 skrll kcondvar_t ub_needsexplore_cv; 169 1.109.2.5 skrll char ub_needsexplore;/* a hub a signalled a change */ 170 1.109.2.5 skrll char ub_usepolling; 171 1.109.2.5 skrll device_t ub_usbctl; 172 1.109.2.5 skrll struct usb_device_stats ub_stats; 173 1.62 augustss 174 1.109.2.5 skrll void *ub_soft; /* soft interrupt cookie */ 175 1.1 augustss }; 176 1.1 augustss 177 1.1 augustss struct usbd_device { 178 1.109.2.5 skrll struct usbd_bus *ud_bus; /* our controller */ 179 1.109.2.5 skrll struct usbd_pipe *ud_pipe0; /* pipe 0 */ 180 1.109.2.5 skrll uint8_t ud_addr; /* device addess */ 181 1.109.2.5 skrll uint8_t ud_config; /* current configuration # */ 182 1.109.2.5 skrll uint8_t ud_depth; /* distance from root hub */ 183 1.109.2.5 skrll uint8_t ud_speed; /* low/full/high speed */ 184 1.109.2.5 skrll uint8_t ud_selfpowered; /* flag for self powered */ 185 1.109.2.5 skrll uint16_t ud_power; /* mA the device uses */ 186 1.109.2.5 skrll int16_t ud_langid; /* language for strings */ 187 1.13 augustss #define USBD_NOLANG (-1) 188 1.109.2.5 skrll usb_event_cookie_t ud_cookie; /* unique connection id */ 189 1.109.2.5 skrll struct usbd_port *ud_powersrc; /* upstream hub port, or 0 */ 190 1.109.2.5 skrll struct usbd_device *ud_myhub; /* upstream hub */ 191 1.109.2.5 skrll struct usbd_port *ud_myhsport; /* closest high speed port */ 192 1.109.2.5 skrll struct usbd_endpoint ud_ep0; /* for pipe 0 */ 193 1.109.2.26 skrll usb_endpoint_descriptor_t 194 1.109.2.26 skrll ud_ep0desc; /* for pipe 0 */ 195 1.109.2.5 skrll struct usbd_interface *ud_ifaces; /* array of all interfaces */ 196 1.109.2.5 skrll usb_device_descriptor_t ud_ddesc; /* device descriptor */ 197 1.109.2.5 skrll usb_config_descriptor_t *ud_cdesc; /* full config descr */ 198 1.109.2.17 skrll usb_bos_descriptor_t *ud_bdesc; /* full BOS descr */ 199 1.109.2.26 skrll const struct usbd_quirks 200 1.109.2.26 skrll *ud_quirks; /* device quirks, always set */ 201 1.109.2.5 skrll struct usbd_hub *ud_hub; /* only if this is a hub */ 202 1.109.2.5 skrll int ud_subdevlen; /* array length of following */ 203 1.109.2.5 skrll device_t *ud_subdevs; /* sub-devices */ 204 1.109.2.5 skrll int ud_nifaces_claimed; /* number of ifaces in use */ 205 1.109.2.5 skrll void *ud_hcpriv; 206 1.109.2.22 skrll 207 1.109.2.22 skrll char *ud_serial; /* serial number, can be NULL */ 208 1.109.2.22 skrll char *ud_vendor; /* vendor string, can be NULL */ 209 1.109.2.22 skrll char *ud_product; /* product string can be NULL */ 210 1.1 augustss }; 211 1.1 augustss 212 1.1 augustss struct usbd_interface { 213 1.109.2.5 skrll struct usbd_device *ui_dev; 214 1.109.2.26 skrll usb_interface_descriptor_t 215 1.109.2.26 skrll *ui_idesc; 216 1.109.2.5 skrll int ui_index; 217 1.109.2.5 skrll int ui_altindex; 218 1.109.2.5 skrll struct usbd_endpoint *ui_endpoints; 219 1.109.2.5 skrll void *ui_priv; 220 1.109.2.5 skrll LIST_HEAD(, usbd_pipe) ui_pipes; 221 1.1 augustss }; 222 1.1 augustss 223 1.1 augustss struct usbd_pipe { 224 1.109.2.5 skrll struct usbd_interface *up_iface; 225 1.109.2.5 skrll struct usbd_device *up_dev; 226 1.109.2.5 skrll struct usbd_endpoint *up_endpoint; 227 1.109.2.5 skrll char up_running; 228 1.109.2.5 skrll char up_aborting; 229 1.109.2.25 skrll bool up_serialise; 230 1.109.2.26 skrll SIMPLEQ_HEAD(, usbd_xfer) 231 1.109.2.26 skrll up_queue; 232 1.109.2.5 skrll LIST_ENTRY(usbd_pipe) up_next; 233 1.109.2.5 skrll struct usb_task up_async_task; 234 1.109.2.5 skrll 235 1.109.2.24 skrll struct usbd_xfer *up_intrxfer; /* used for repeating requests */ 236 1.109.2.5 skrll char up_repeat; 237 1.109.2.5 skrll int up_interval; 238 1.109.2.5 skrll uint8_t up_flags; 239 1.52 augustss 240 1.1 augustss /* Filled by HC driver. */ 241 1.109.2.26 skrll const struct usbd_pipe_methods 242 1.109.2.26 skrll *up_methods; 243 1.1 augustss }; 244 1.1 augustss 245 1.40 augustss struct usbd_xfer { 246 1.109.2.5 skrll struct usbd_pipe *ux_pipe; 247 1.109.2.5 skrll void *ux_priv; 248 1.109.2.5 skrll void *ux_buffer; 249 1.109.2.5 skrll kcondvar_t ux_cv; 250 1.109.2.5 skrll uint32_t ux_length; 251 1.109.2.5 skrll uint32_t ux_actlen; 252 1.109.2.5 skrll uint16_t ux_flags; 253 1.109.2.5 skrll uint32_t ux_timeout; 254 1.109.2.5 skrll usbd_status ux_status; 255 1.109.2.5 skrll usbd_callback ux_callback; 256 1.109.2.5 skrll volatile uint8_t ux_done; 257 1.109.2.5 skrll uint8_t ux_state; /* used for DIAGNOSTIC */ 258 1.77 chs #define XFER_FREE 0x46 259 1.77 chs #define XFER_BUSY 0x55 260 1.77 chs #define XFER_ONQU 0x9e 261 1.1 augustss 262 1.29 augustss /* For control pipe */ 263 1.109.2.5 skrll usb_device_request_t ux_request; 264 1.29 augustss 265 1.29 augustss /* For isoc */ 266 1.109.2.26 skrll uint16_t *ux_frlengths; 267 1.109.2.5 skrll int ux_nframes; 268 1.29 augustss 269 1.109.2.20 skrll const struct usbd_pipe_methods *ux_methods; 270 1.109.2.20 skrll 271 1.109.2.20 skrll /* For memory allocation and softc */ 272 1.109.2.20 skrll struct usbd_bus *ux_bus; 273 1.109.2.5 skrll usb_dma_t ux_dmabuf; 274 1.109.2.5 skrll void *ux_buf; 275 1.109.2.5 skrll uint32_t ux_bufsize; 276 1.29 augustss 277 1.109.2.5 skrll uint8_t ux_rqflags; 278 1.29 augustss #define URQ_REQUEST 0x01 279 1.1 augustss 280 1.109.2.26 skrll SIMPLEQ_ENTRY(usbd_xfer) 281 1.109.2.26 skrll ux_next; 282 1.1 augustss 283 1.109.2.5 skrll void *ux_hcpriv; /* private use by the HC driver */ 284 1.109.2.5 skrll uint8_t ux_hcflags; /* private use by the HC driver */ 285 1.74 augustss #define UXFER_ABORTING 0x01 /* xfer is aborting. */ 286 1.74 augustss #define UXFER_ABORTWAIT 0x02 /* abort completion is being awaited. */ 287 1.109.2.5 skrll kcondvar_t ux_hccv; /* private use by the HC driver */ 288 1.11 augustss 289 1.109.2.27 skrll struct usb_task ux_aborttask; 290 1.109.2.5 skrll struct callout ux_callout; 291 1.1 augustss }; 292 1.1 augustss 293 1.57 augustss void usbd_init(void); 294 1.57 augustss void usbd_finish(void); 295 1.64 augustss 296 1.109.2.11 skrll #if defined(USB_DEBUG) 297 1.109.2.8 skrll void usbd_dump_iface(struct usbd_interface *); 298 1.109.2.8 skrll void usbd_dump_device(struct usbd_device *); 299 1.109.2.8 skrll void usbd_dump_endpoint(struct usbd_endpoint *); 300 1.109.2.16 skrll void usbd_dump_queue(struct usbd_pipe *); 301 1.109.2.16 skrll void usbd_dump_pipe(struct usbd_pipe *); 302 1.67 augustss #endif 303 1.1 augustss 304 1.1 augustss /* Routines from usb_subr.c */ 305 1.57 augustss int usbctlprint(void *, const char *); 306 1.109.2.22 skrll void usbd_get_device_strings(struct usbd_device *); 307 1.109.2.16 skrll void usb_delay_ms_locked(struct usbd_bus *, u_int, kmutex_t *); 308 1.109.2.16 skrll void usb_delay_ms(struct usbd_bus *, u_int); 309 1.109.2.16 skrll void usbd_delay_ms_locked(struct usbd_device *, u_int, kmutex_t *); 310 1.109.2.16 skrll void usbd_delay_ms(struct usbd_device *, u_int); 311 1.109.2.16 skrll usbd_status usbd_reset_port(struct usbd_device *, int, usb_port_status_t *); 312 1.109.2.16 skrll usbd_status usbd_setup_pipe(struct usbd_device *, 313 1.109.2.16 skrll struct usbd_interface *, 314 1.57 augustss struct usbd_endpoint *, int, 315 1.109.2.16 skrll struct usbd_pipe **); 316 1.109.2.16 skrll usbd_status usbd_setup_pipe_flags(struct usbd_device *, 317 1.109.2.16 skrll struct usbd_interface *, 318 1.101 jmcneill struct usbd_endpoint *, int, 319 1.109.2.16 skrll struct usbd_pipe **, 320 1.109.2.8 skrll uint8_t); 321 1.109.2.16 skrll usbd_status usbd_new_device(device_t, struct usbd_bus *, int, int, int, 322 1.102 skrll struct usbd_port *); 323 1.109.2.16 skrll usbd_status usbd_reattach_device(device_t, struct usbd_device *, 324 1.102 skrll int, const int *); 325 1.88 kent 326 1.109.2.16 skrll void usbd_remove_device(struct usbd_device *, struct usbd_port *); 327 1.71 itojun int usbd_printBCD(char *, size_t, int); 328 1.109.2.16 skrll usbd_status usbd_fill_iface_data(struct usbd_device *, int, int); 329 1.109.2.16 skrll void usb_free_device(struct usbd_device *); 330 1.57 augustss 331 1.109.2.16 skrll usbd_status usb_insert_transfer(struct usbd_xfer *); 332 1.109.2.16 skrll void usb_transfer_complete(struct usbd_xfer *); 333 1.91 dyoung int usb_disconnect_port(struct usbd_port *, device_t, int); 334 1.1 augustss 335 1.109.2.16 skrll void usbd_kill_pipe(struct usbd_pipe *); 336 1.109.2.16 skrll usbd_status usbd_attach_roothub(device_t, struct usbd_device *); 337 1.109.2.16 skrll usbd_status usbd_probe_and_attach(device_t, struct usbd_device *, int, int); 338 1.109.2.16 skrll usbd_status usbd_get_initial_ddesc(struct usbd_device *, 339 1.105 jakllsch usb_device_descriptor_t *); 340 1.105 jakllsch 341 1.1 augustss /* Routines from usb.c */ 342 1.109.2.16 skrll void usb_needs_explore(struct usbd_device *); 343 1.109.2.16 skrll void usb_needs_reattach(struct usbd_device *); 344 1.57 augustss void usb_schedsoftintr(struct usbd_bus *); 345 1.97 mrg 346 1.109.2.15 skrll static inline int 347 1.109.2.16 skrll usbd_xfer_isread(struct usbd_xfer *xfer) 348 1.109.2.15 skrll { 349 1.109.2.15 skrll if (xfer->ux_rqflags & URQ_REQUEST) 350 1.109.2.15 skrll return xfer->ux_request.bmRequestType & UT_READ; 351 1.109.2.15 skrll 352 1.109.2.15 skrll return xfer->ux_pipe->up_endpoint->ue_edesc->bEndpointAddress & 353 1.109.2.15 skrll UE_DIR_IN; 354 1.109.2.15 skrll } 355 1.109.2.15 skrll 356 1.97 mrg /* 357 1.107 skrll * These macros reflect the current locking scheme. They might change. 358 1.97 mrg */ 359 1.97 mrg 360 1.109.2.5 skrll #define usbd_lock_pipe(p) mutex_enter((p)->up_dev->ud_bus->ub_lock) 361 1.109.2.5 skrll #define usbd_unlock_pipe(p) mutex_exit((p)->up_dev->ud_bus->ub_lock) 362
Indexes created Wed Oct 01 18:09:54 GMT 2025