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