1 /* $OpenBSD: usbdivar.h,v 1.81 2020/03/21 12:08:31 patrick Exp $ */ 2 /* $NetBSD: usbdivar.h,v 1.70 2002/07/11 21:14:36 augustss Exp $ */ 3 /* $FreeBSD: src/sys/dev/usb/usbdivar.h,v 1.11 1999/11/17 22:33:51 n_hibma Exp $ */ 4 5 /* 6 * Copyright (c) 1998 The NetBSD Foundation, Inc. 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to The NetBSD Foundation 10 * by Lennart Augustsson (lennart@augustsson.net) at 11 * Carlstedt Research & Technology. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 25 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 #ifndef _USBDIVAR_H_ 36 #define _USBDIVAR_H_ 37 38 #include "bpfilter.h" 39 #if NBPFILTER > 0 40 #include <net/bpf.h> 41 #endif 42 43 #include <sys/timeout.h> 44 45 /* From usb_mem.h */ 46 struct usb_dma_block; 47 struct usb_dma { 48 struct usb_dma_block *block; 49 u_int offs; 50 #define USB_DMA_COHERENT (1 << 0) 51 }; 52 53 struct usbd_xfer; 54 struct usbd_pipe; 55 56 struct usbd_endpoint { 57 usb_endpoint_descriptor_t *edesc; 58 int refcnt; 59 int savedtoggle; 60 }; 61 62 struct usbd_bus_methods { 63 usbd_status (*open_pipe)(struct usbd_pipe *); 64 int (*dev_setaddr)(struct usbd_device *, int); 65 void (*soft_intr)(void *); 66 void (*do_poll)(struct usbd_bus *); 67 struct usbd_xfer * (*allocx)(struct usbd_bus *); 68 void (*freex)(struct usbd_bus *, struct usbd_xfer *); 69 }; 70 71 struct usbd_pipe_methods { 72 usbd_status (*transfer)(struct usbd_xfer *); 73 usbd_status (*start)(struct usbd_xfer *); 74 void (*abort)(struct usbd_xfer *); 75 void (*close)(struct usbd_pipe *); 76 void (*cleartoggle)(struct usbd_pipe *); 77 void (*done)(struct usbd_xfer *); 78 }; 79 80 struct usbd_tt { 81 struct usbd_hub *hub; 82 }; 83 84 struct usbd_port { 85 usb_port_status_t status; 86 u_int16_t power; /* mA of current on port */ 87 u_int8_t portno; 88 u_int8_t restartcnt; 89 #define USBD_RESTART_MAX 5 90 u_int8_t reattach; 91 struct usbd_device *device; /* Connected device */ 92 struct usbd_device *parent; /* The ports hub */ 93 struct usbd_tt *tt; /* Transaction translator (if any) */ 94 }; 95 96 struct usbd_hub { 97 int (*explore)(struct usbd_device *); 98 void *hubsoftc; 99 struct usbd_port *ports; 100 int nports; 101 u_int8_t powerdelay; 102 u_int8_t ttthink; 103 }; 104 105 struct usbd_bus { 106 /* Filled by HC driver */ 107 struct device bdev; /* base device, host adapter */ 108 struct usbd_bus_methods *methods; 109 #if NBPFILTER > 0 110 void *bpfif; 111 caddr_t bpf; 112 #endif 113 u_int32_t pipe_size; /* size of a pipe struct */ 114 /* Filled by usb driver */ 115 struct usbd_device *root_hub; 116 struct usbd_device *devices[USB_MAX_DEVICES]; 117 char use_polling; 118 char dying; 119 int flags; 120 #define USB_BUS_CONFIG_PENDING 0x01 121 #define USB_BUS_DISCONNECTING 0x02 122 struct device *usbctl; 123 struct usb_device_stats stats; 124 int intr_context; 125 u_int no_intrs; 126 int usbrev; /* USB revision */ 127 #define USBREV_UNKNOWN 0 128 #define USBREV_PRE_1_0 1 129 #define USBREV_1_0 2 130 #define USBREV_1_1 3 131 #define USBREV_2_0 4 132 #define USBREV_3_0 5 133 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0", "3.0" } 134 void *soft; /* soft interrupt cookie */ 135 bus_dma_tag_t dmatag; /* DMA tag */ 136 }; 137 138 struct usbd_device { 139 struct usbd_bus *bus; /* our controller */ 140 struct usbd_pipe *default_pipe; /* pipe 0 */ 141 u_int8_t dying; /* hardware removed */ 142 u_int8_t ref_cnt; /* # of procs using device */ 143 u_int8_t address; /* device address */ 144 u_int8_t config; /* current configuration # */ 145 u_int8_t depth; /* distance from root hub */ 146 u_int8_t speed; /* low/full/high speed */ 147 u_int8_t self_powered; /* flag for self powered */ 148 u_int16_t power; /* mA the device uses */ 149 int16_t langid; /* language for strings */ 150 #define USBD_NOLANG (-1) 151 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 152 struct usbd_device *myhub; /* upstream hub */ 153 struct usbd_port *myhsport; /* closest high speed port */ 154 struct usbd_endpoint def_ep; /* for pipe 0 */ 155 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 156 struct usbd_interface *ifaces; /* array of all interfaces */ 157 usb_device_descriptor_t ddesc; /* device descriptor */ 158 usb_config_descriptor_t *cdesc; /* full config descr */ 159 const struct usbd_quirks *quirks; /* device quirks, always set */ 160 struct usbd_hub *hub; /* only if this is a hub */ 161 struct device **subdevs; /* sub-devices, 0 terminated */ 162 int nsubdev; /* size of the `subdevs' array */ 163 int ndevs; /* # of subdevs */ 164 165 char *serial; /* serial number, can be NULL */ 166 char *vendor; /* vendor string, can be NULL */ 167 char *product; /* product string, can be NULL */ 168 }; 169 170 struct usbd_interface { 171 struct usbd_device *device; 172 usb_interface_descriptor_t *idesc; 173 int index; 174 int altindex; 175 struct usbd_endpoint *endpoints; 176 void *priv; 177 LIST_HEAD(, usbd_pipe) pipes; 178 uint8_t claimed; 179 uint8_t nendpt; 180 }; 181 182 struct usbd_pipe { 183 struct usbd_interface *iface; 184 struct usbd_device *device; 185 struct usbd_endpoint *endpoint; 186 size_t pipe_size; 187 char running; 188 char aborting; 189 SIMPLEQ_HEAD(, usbd_xfer) queue; 190 LIST_ENTRY(usbd_pipe) next; 191 192 struct usbd_xfer *intrxfer; /* used for repeating requests */ 193 char repeat; 194 int interval; 195 196 /* Filled by HC driver. */ 197 struct usbd_pipe_methods *methods; 198 }; 199 200 struct usbd_xfer { 201 struct usbd_pipe *pipe; 202 void *priv; 203 char *buffer; 204 u_int32_t length; 205 u_int32_t actlen; 206 u_int16_t flags; 207 u_int32_t timeout; 208 usbd_status status; 209 usbd_callback callback; 210 volatile char done; 211 #ifdef DIAGNOSTIC 212 u_int32_t busy_free; 213 #define XFER_FREE 0x42555359 214 #define XFER_ONQU 0x4f4e5155 215 #endif 216 217 /* For control pipe */ 218 usb_device_request_t request; 219 220 /* For isoc */ 221 u_int16_t *frlengths; 222 int nframes; 223 224 /* For memory allocation */ 225 struct usbd_device *device; 226 struct usb_dma dmabuf; 227 228 int rqflags; 229 #define URQ_REQUEST 0x01 230 #define URQ_AUTO_DMABUF 0x10 231 #define URQ_DEV_DMABUF 0x20 232 233 SIMPLEQ_ENTRY(usbd_xfer) next; 234 235 void *hcpriv; /* private use by the HC driver */ 236 237 struct usb_task abort_task; 238 struct timeout timeout_handle; 239 }; 240 241 void usbd_dump_iface(struct usbd_interface *); 242 void usbd_dump_device(struct usbd_device *); 243 void usbd_dump_endpoint(struct usbd_endpoint *); 244 void usbd_dump_queue(struct usbd_pipe *); 245 void usbd_dump_pipe(struct usbd_pipe *); 246 247 /* Routines from usb_subr.c */ 248 int usbctlprint(void *, const char *); 249 void usb_delay_ms(struct usbd_bus *, u_int); 250 usbd_status usbd_port_disown_to_1_1(struct usbd_device *, int); 251 int usbd_reset_port(struct usbd_device *, int); 252 usbd_status usbd_setup_pipe(struct usbd_device *, 253 struct usbd_interface *, struct usbd_endpoint *, int, 254 struct usbd_pipe **); 255 int usbd_set_address(struct usbd_device *, int); 256 usbd_status usbd_new_device(struct device *, struct usbd_bus *, 257 int, int, int, struct usbd_port *); 258 usbd_status usbd_fill_iface_data(struct usbd_device *, int, int); 259 260 usbd_status usb_insert_transfer(struct usbd_xfer *); 261 void usb_transfer_complete(struct usbd_xfer *); 262 int usbd_detach(struct usbd_device *, struct device *); 263 264 /* Routines from usb.c */ 265 void usb_needs_explore(struct usbd_device *, int); 266 void usb_needs_reattach(struct usbd_device *); 267 void usb_schedsoftintr(struct usbd_bus *); 268 void usb_tap(struct usbd_bus *, struct usbd_xfer *, uint8_t); 269 270 #define USBTAP_DIR_OUT 0 271 #define USBTAP_DIR_IN 1 272 273 #define UHUB_UNK_CONFIGURATION -1 274 #define UHUB_UNK_INTERFACE -1 275 276 static inline int 277 usbd_xfer_isread(struct usbd_xfer *xfer) 278 { 279 if (xfer->rqflags & URQ_REQUEST) 280 return (xfer->request.bmRequestType & UT_READ); 281 282 return (xfer->pipe->endpoint->edesc->bEndpointAddress & UE_DIR_IN); 283 } 284 285 #endif /* _USBDIVAR_H_ */ 286