usbdivar.h revision 1.109.2.25
1 /* $NetBSD: usbdivar.h,v 1.109.2.25 2016/03/17 09:04:53 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 * ubm_open - might want to take lock? 44 * ubm_softint x 45 * ubm_dopoll - might want to take lock? 46 * ubm_allocx - 47 * ubm_freex - 48 * ubm_getlock - Called at attach time 49 * ubm_newdev - Will take lock 50 ubm_rhctrl 51 * 52 * PIPE METHOD LOCK NOTES 53 * ----------------------- ------- ------------------------- 54 * upm_transfer - 55 * upm_start - might want to take lock? 56 * upm_abort x 57 * upm_close x 58 * upm_cleartoggle - 59 * upm_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 *udma_block; 80 u_int udma_offs; 81 } usb_dma_t; 82 83 struct usbd_xfer; 84 struct usbd_pipe; 85 struct usbd_port; 86 87 struct usbd_endpoint { 88 usb_endpoint_descriptor_t *ue_edesc; 89 int ue_refcnt; 90 int ue_toggle; 91 }; 92 93 struct usbd_bus_methods { 94 usbd_status (*ubm_open)(struct usbd_pipe *); 95 void (*ubm_softint)(void *); 96 void (*ubm_dopoll)(struct usbd_bus *); 97 struct usbd_xfer *(*ubm_allocx)(struct usbd_bus *, unsigned int); 98 void (*ubm_freex)(struct usbd_bus *, struct usbd_xfer *); 99 void (*ubm_getlock)(struct usbd_bus *, kmutex_t **); 100 usbd_status (*ubm_newdev)(device_t, struct usbd_bus *, int, 101 int, int, struct usbd_port *); 102 103 int (*ubm_rhctrl)(struct usbd_bus *, 104 usb_device_request_t *, void *, int); 105 }; 106 107 struct usbd_pipe_methods { 108 int (*upm_init)(struct usbd_xfer *); 109 void (*upm_fini)(struct usbd_xfer *); 110 usbd_status (*upm_transfer)(struct usbd_xfer *); 111 usbd_status (*upm_start)(struct usbd_xfer *); 112 void (*upm_abort)(struct usbd_xfer *); 113 void (*upm_close)(struct usbd_pipe *); 114 void (*upm_cleartoggle)(struct usbd_pipe *); 115 void (*upm_done)(struct usbd_xfer *); 116 }; 117 118 struct usbd_tt { 119 struct usbd_hub *utt_hub; 120 }; 121 122 struct usbd_port { 123 usb_port_status_t up_status; 124 uint16_t up_power; /* mA of current on port */ 125 uint8_t up_portno; 126 uint8_t up_restartcnt; 127 #define USBD_RESTART_MAX 5 128 uint8_t up_reattach; 129 struct usbd_device *up_dev; /* Connected device */ 130 struct usbd_device *up_parent; /* The ports hub */ 131 struct usbd_tt *up_tt; /* Transaction translator (if any) */ 132 }; 133 134 struct usbd_hub { 135 usbd_status (*uh_explore)(struct usbd_device *hub); 136 void *uh_hubsoftc; 137 usb_hub_descriptor_t uh_hubdesc; 138 struct usbd_port uh_ports[1]; 139 }; 140 141 /*****/ 142 143 struct usbd_bus { 144 /* Filled by HC driver */ 145 void *ub_hcpriv; 146 int ub_revision; /* USB revision */ 147 #define USBREV_UNKNOWN 0 148 #define USBREV_PRE_1_0 1 149 #define USBREV_1_0 2 150 #define USBREV_1_1 3 151 #define USBREV_2_0 4 152 #define USBREV_3_0 5 153 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0", "3.0" } 154 155 const struct usbd_bus_methods *ub_methods; 156 uint32_t ub_pipesize; /* size of a pipe struct */ 157 bool ub_usedma; /* Does this HC support DMA */ 158 int ub_dmaflags; 159 bus_dma_tag_t ub_dmatag; /* DMA tag */ 160 161 /* Filled by usb driver */ 162 kmutex_t *ub_lock; 163 struct usbd_device *ub_roothub; 164 uint8_t ub_rhaddr; /* roothub address */ 165 uint8_t ub_rhconf; /* roothub configuration */ 166 struct usbd_device * ub_devices[USB_MAX_DEVICES]; 167 kcondvar_t ub_needsexplore_cv; 168 char ub_needsexplore;/* a hub a signalled a change */ 169 char ub_usepolling; 170 device_t ub_usbctl; 171 struct usb_device_stats ub_stats; 172 173 void *ub_soft; /* soft interrupt cookie */ 174 }; 175 176 struct usbd_device { 177 struct usbd_bus *ud_bus; /* our controller */ 178 struct usbd_pipe *ud_pipe0; /* pipe 0 */ 179 uint8_t ud_addr; /* device addess */ 180 uint8_t ud_config; /* current configuration # */ 181 uint8_t ud_depth; /* distance from root hub */ 182 uint8_t ud_speed; /* low/full/high speed */ 183 uint8_t ud_selfpowered; /* flag for self powered */ 184 uint16_t ud_power; /* mA the device uses */ 185 int16_t ud_langid; /* language for strings */ 186 #define USBD_NOLANG (-1) 187 usb_event_cookie_t ud_cookie; /* unique connection id */ 188 struct usbd_port *ud_powersrc; /* upstream hub port, or 0 */ 189 struct usbd_device *ud_myhub; /* upstream hub */ 190 struct usbd_port *ud_myhsport; /* closest high speed port */ 191 struct usbd_endpoint ud_ep0; /* for pipe 0 */ 192 usb_endpoint_descriptor_t ud_ep0desc; /* for pipe 0 */ 193 struct usbd_interface *ud_ifaces; /* array of all interfaces */ 194 usb_device_descriptor_t ud_ddesc; /* device descriptor */ 195 usb_config_descriptor_t *ud_cdesc; /* full config descr */ 196 usb_bos_descriptor_t *ud_bdesc; /* full BOS descr */ 197 const struct usbd_quirks *ud_quirks;/* device quirks, always set */ 198 struct usbd_hub *ud_hub; /* only if this is a hub */ 199 int ud_subdevlen; /* array length of following */ 200 device_t *ud_subdevs; /* sub-devices */ 201 int ud_nifaces_claimed; /* number of ifaces in use */ 202 void *ud_hcpriv; 203 204 char *ud_serial; /* serial number, can be NULL */ 205 char *ud_vendor; /* vendor string, can be NULL */ 206 char *ud_product; /* product string can be NULL */ 207 }; 208 209 struct usbd_interface { 210 struct usbd_device *ui_dev; 211 usb_interface_descriptor_t *ui_idesc; 212 int ui_index; 213 int ui_altindex; 214 struct usbd_endpoint *ui_endpoints; 215 void *ui_priv; 216 LIST_HEAD(, usbd_pipe) ui_pipes; 217 }; 218 219 struct usbd_pipe { 220 struct usbd_interface *up_iface; 221 struct usbd_device *up_dev; 222 struct usbd_endpoint *up_endpoint; 223 char up_running; 224 char up_aborting; 225 bool up_serialise; 226 SIMPLEQ_HEAD(, usbd_xfer) up_queue; 227 LIST_ENTRY(usbd_pipe) up_next; 228 struct usb_task up_async_task; 229 230 struct usbd_xfer *up_intrxfer; /* used for repeating requests */ 231 char up_repeat; 232 int up_interval; 233 uint8_t up_flags; 234 235 /* Filled by HC driver. */ 236 const struct usbd_pipe_methods *up_methods; 237 }; 238 239 struct usbd_xfer { 240 struct usbd_pipe *ux_pipe; 241 void *ux_priv; 242 void *ux_buffer; 243 kcondvar_t ux_cv; 244 uint32_t ux_length; 245 uint32_t ux_actlen; 246 uint16_t ux_flags; 247 uint32_t ux_timeout; 248 usbd_status ux_status; 249 usbd_callback ux_callback; 250 volatile uint8_t ux_done; 251 uint8_t ux_state; /* used for DIAGNOSTIC */ 252 #define XFER_FREE 0x46 253 #define XFER_BUSY 0x55 254 #define XFER_ONQU 0x9e 255 256 /* For control pipe */ 257 usb_device_request_t ux_request; 258 259 /* For isoc */ 260 uint16_t *ux_frlengths; 261 int ux_nframes; 262 263 const struct usbd_pipe_methods *ux_methods; 264 265 /* For memory allocation and softc */ 266 struct usbd_bus *ux_bus; 267 usb_dma_t ux_dmabuf; 268 void *ux_buf; 269 uint32_t ux_bufsize; 270 271 uint8_t ux_rqflags; 272 #define URQ_REQUEST 0x01 273 274 SIMPLEQ_ENTRY(usbd_xfer) ux_next; 275 276 void *ux_hcpriv; /* private use by the HC driver */ 277 uint8_t ux_hcflags; /* private use by the HC driver */ 278 #define UXFER_ABORTING 0x01 /* xfer is aborting. */ 279 #define UXFER_ABORTWAIT 0x02 /* abort completion is being awaited. */ 280 kcondvar_t ux_hccv; /* private use by the HC driver */ 281 282 struct callout ux_callout; 283 }; 284 285 void usbd_init(void); 286 void usbd_finish(void); 287 288 #if defined(USB_DEBUG) 289 void usbd_dump_iface(struct usbd_interface *); 290 void usbd_dump_device(struct usbd_device *); 291 void usbd_dump_endpoint(struct usbd_endpoint *); 292 void usbd_dump_queue(struct usbd_pipe *); 293 void usbd_dump_pipe(struct usbd_pipe *); 294 #endif 295 296 /* Routines from usb_subr.c */ 297 int usbctlprint(void *, const char *); 298 void usbd_get_device_strings(struct usbd_device *); 299 void usb_delay_ms_locked(struct usbd_bus *, u_int, kmutex_t *); 300 void usb_delay_ms(struct usbd_bus *, u_int); 301 void usbd_delay_ms_locked(struct usbd_device *, u_int, kmutex_t *); 302 void usbd_delay_ms(struct usbd_device *, u_int); 303 usbd_status usbd_reset_port(struct usbd_device *, int, usb_port_status_t *); 304 usbd_status usbd_setup_pipe(struct usbd_device *, 305 struct usbd_interface *, 306 struct usbd_endpoint *, int, 307 struct usbd_pipe **); 308 usbd_status usbd_setup_pipe_flags(struct usbd_device *, 309 struct usbd_interface *, 310 struct usbd_endpoint *, int, 311 struct usbd_pipe **, 312 uint8_t); 313 usbd_status usbd_new_device(device_t, struct usbd_bus *, int, int, int, 314 struct usbd_port *); 315 usbd_status usbd_reattach_device(device_t, struct usbd_device *, 316 int, const int *); 317 318 void usbd_remove_device(struct usbd_device *, struct usbd_port *); 319 int usbd_printBCD(char *, size_t, int); 320 usbd_status usbd_fill_iface_data(struct usbd_device *, int, int); 321 void usb_free_device(struct usbd_device *); 322 323 usbd_status usb_insert_transfer(struct usbd_xfer *); 324 void usb_transfer_complete(struct usbd_xfer *); 325 int usb_disconnect_port(struct usbd_port *, device_t, int); 326 327 void usbd_kill_pipe(struct usbd_pipe *); 328 usbd_status usbd_attach_roothub(device_t, struct usbd_device *); 329 usbd_status usbd_probe_and_attach(device_t, struct usbd_device *, int, int); 330 usbd_status usbd_get_initial_ddesc(struct usbd_device *, 331 usb_device_descriptor_t *); 332 333 /* Routines from usb.c */ 334 void usb_needs_explore(struct usbd_device *); 335 void usb_needs_reattach(struct usbd_device *); 336 void usb_schedsoftintr(struct usbd_bus *); 337 338 static inline int 339 usbd_xfer_isread(struct usbd_xfer *xfer) 340 { 341 if (xfer->ux_rqflags & URQ_REQUEST) 342 return xfer->ux_request.bmRequestType & UT_READ; 343 344 return xfer->ux_pipe->up_endpoint->ue_edesc->bEndpointAddress & 345 UE_DIR_IN; 346 } 347 348 /* 349 * These macros reflect the current locking scheme. They might change. 350 */ 351 352 #define usbd_lock_pipe(p) mutex_enter((p)->up_dev->ud_bus->ub_lock) 353 #define usbd_unlock_pipe(p) mutex_exit((p)->up_dev->ud_bus->ub_lock) 354
Indexes created Wed Oct 01 18:09:54 GMT 2025