1 /* $OpenBSD: usbdivar.h,v 1.79 2018/11/27 14:56:09 mpi 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 }; 51 52 struct usbd_xfer; 53 struct usbd_pipe; 54 55 struct usbd_endpoint { 56 usb_endpoint_descriptor_t *edesc; 57 int refcnt; 58 int savedtoggle; 59 }; 60 61 struct usbd_bus_methods { 62 usbd_status (*open_pipe)(struct usbd_pipe *); 63 int (*dev_setaddr)(struct usbd_device *, int); 64 void (*soft_intr)(void *); 65 void (*do_poll)(struct usbd_bus *); 66 struct usbd_xfer * (*allocx)(struct usbd_bus *); 67 void (*freex)(struct usbd_bus *, struct usbd_xfer *); 68 }; 69 70 struct usbd_pipe_methods { 71 usbd_status (*transfer)(struct usbd_xfer *); 72 usbd_status (*start)(struct usbd_xfer *); 73 void (*abort)(struct usbd_xfer *); 74 void (*close)(struct usbd_pipe *); 75 void (*cleartoggle)(struct usbd_pipe *); 76 void (*done)(struct usbd_xfer *); 77 }; 78 79 struct usbd_tt { 80 struct usbd_hub *hub; 81 }; 82 83 struct usbd_port { 84 usb_port_status_t status; 85 u_int16_t power; /* mA of current on port */ 86 u_int8_t portno; 87 u_int8_t restartcnt; 88 #define USBD_RESTART_MAX 5 89 u_int8_t reattach; 90 struct usbd_device *device; /* Connected device */ 91 struct usbd_device *parent; /* The ports hub */ 92 struct usbd_tt *tt; /* Transaction translator (if any) */ 93 }; 94 95 struct usbd_hub { 96 int (*explore)(struct usbd_device *); 97 void *hubsoftc; 98 struct usbd_port *ports; 99 int nports; 100 u_int8_t powerdelay; 101 u_int8_t ttthink; 102 }; 103 104 struct usbd_bus { 105 /* Filled by HC driver */ 106 struct device bdev; /* base device, host adapter */ 107 struct usbd_bus_methods *methods; 108 #if NBPFILTER > 0 109 void *bpfif; 110 caddr_t bpf; 111 #endif 112 u_int32_t pipe_size; /* size of a pipe struct */ 113 /* Filled by usb driver */ 114 struct usbd_device *root_hub; 115 struct usbd_device *devices[USB_MAX_DEVICES]; 116 char use_polling; 117 char dying; 118 int flags; 119 #define USB_BUS_CONFIG_PENDING 0x01 120 #define USB_BUS_DISCONNECTING 0x02 121 struct device *usbctl; 122 struct usb_device_stats stats; 123 int intr_context; 124 u_int no_intrs; 125 int usbrev; /* USB revision */ 126 #define USBREV_UNKNOWN 0 127 #define USBREV_PRE_1_0 1 128 #define USBREV_1_0 2 129 #define USBREV_1_1 3 130 #define USBREV_2_0 4 131 #define USBREV_3_0 5 132 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0", "3.0" } 133 void *soft; /* soft interrupt cookie */ 134 bus_dma_tag_t dmatag; /* DMA tag */ 135 }; 136 137 struct usbd_device { 138 struct usbd_bus *bus; /* our controller */ 139 struct usbd_pipe *default_pipe; /* pipe 0 */ 140 u_int8_t dying; /* hardware removed */ 141 u_int8_t ref_cnt; /* # of procs using device */ 142 u_int8_t address; /* device address */ 143 u_int8_t config; /* current configuration # */ 144 u_int8_t depth; /* distance from root hub */ 145 u_int8_t speed; /* low/full/high speed */ 146 u_int8_t self_powered; /* flag for self powered */ 147 u_int16_t power; /* mA the device uses */ 148 int16_t langid; /* language for strings */ 149 #define USBD_NOLANG (-1) 150 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 151 struct usbd_device *myhub; /* upstream hub */ 152 struct usbd_port *myhsport; /* closest high speed port */ 153 struct usbd_endpoint def_ep; /* for pipe 0 */ 154 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 155 struct usbd_interface *ifaces; /* array of all interfaces */ 156 usb_device_descriptor_t ddesc; /* device descriptor */ 157 usb_config_descriptor_t *cdesc; /* full config descr */ 158 const struct usbd_quirks *quirks; /* device quirks, always set */ 159 struct usbd_hub *hub; /* only if this is a hub */ 160 struct device **subdevs; /* sub-devices, 0 terminated */ 161 int nsubdev; /* size of the `subdevs' array */ 162 int ndevs; /* # of subdevs */ 163 164 char *serial; /* serial number, can be NULL */ 165 char *vendor; /* vendor string, can be NULL */ 166 char *product; /* product string, can be NULL */ 167 }; 168 169 struct usbd_interface { 170 struct usbd_device *device; 171 usb_interface_descriptor_t *idesc; 172 int index; 173 int altindex; 174 struct usbd_endpoint *endpoints; 175 void *priv; 176 LIST_HEAD(, usbd_pipe) pipes; 177 uint8_t claimed; 178 uint8_t nendpt; 179 }; 180 181 struct usbd_pipe { 182 struct usbd_interface *iface; 183 struct usbd_device *device; 184 struct usbd_endpoint *endpoint; 185 size_t pipe_size; 186 char running; 187 char aborting; 188 SIMPLEQ_HEAD(, usbd_xfer) queue; 189 LIST_ENTRY(usbd_pipe) next; 190 191 struct usbd_xfer *intrxfer; /* used for repeating requests */ 192 char repeat; 193 int interval; 194 195 /* Filled by HC driver. */ 196 struct usbd_pipe_methods *methods; 197 }; 198 199 struct usbd_xfer { 200 struct usbd_pipe *pipe; 201 void *priv; 202 char *buffer; 203 u_int32_t length; 204 u_int32_t actlen; 205 u_int16_t flags; 206 u_int32_t timeout; 207 usbd_status status; 208 usbd_callback callback; 209 volatile char done; 210 #ifdef DIAGNOSTIC 211 u_int32_t busy_free; 212 #define XFER_FREE 0x42555359 213 #define XFER_ONQU 0x4f4e5155 214 #endif 215 216 /* For control pipe */ 217 usb_device_request_t request; 218 219 /* For isoc */ 220 u_int16_t *frlengths; 221 int nframes; 222 223 /* For memory allocation */ 224 struct usbd_device *device; 225 struct usb_dma dmabuf; 226 227 int rqflags; 228 #define URQ_REQUEST 0x01 229 #define URQ_AUTO_DMABUF 0x10 230 #define URQ_DEV_DMABUF 0x20 231 232 SIMPLEQ_ENTRY(usbd_xfer) next; 233 234 void *hcpriv; /* private use by the HC driver */ 235 236 struct usb_task abort_task; 237 struct timeout timeout_handle; 238 }; 239 240 void usbd_dump_iface(struct usbd_interface *); 241 void usbd_dump_device(struct usbd_device *); 242 void usbd_dump_endpoint(struct usbd_endpoint *); 243 void usbd_dump_queue(struct usbd_pipe *); 244 void usbd_dump_pipe(struct usbd_pipe *); 245 246 /* Routines from usb_subr.c */ 247 int usbctlprint(void *, const char *); 248 void usb_delay_ms(struct usbd_bus *, u_int); 249 usbd_status usbd_port_disown_to_1_1(struct usbd_device *, int); 250 int usbd_reset_port(struct usbd_device *, int); 251 usbd_status usbd_setup_pipe(struct usbd_device *, 252 struct usbd_interface *, struct usbd_endpoint *, int, 253 struct usbd_pipe **); 254 int usbd_set_address(struct usbd_device *, int); 255 usbd_status usbd_new_device(struct device *, struct usbd_bus *, 256 int, int, int, struct usbd_port *); 257 usbd_status usbd_fill_iface_data(struct usbd_device *, int, int); 258 259 usbd_status usb_insert_transfer(struct usbd_xfer *); 260 void usb_transfer_complete(struct usbd_xfer *); 261 int usbd_detach(struct usbd_device *, struct device *); 262 263 /* Routines from usb.c */ 264 void usb_needs_explore(struct usbd_device *, int); 265 void usb_needs_reattach(struct usbd_device *); 266 void usb_schedsoftintr(struct usbd_bus *); 267 void usb_tap(struct usbd_bus *, struct usbd_xfer *, uint8_t); 268 269 #define USBTAP_DIR_OUT 0 270 #define USBTAP_DIR_IN 1 271 272 #define UHUB_UNK_CONFIGURATION -1 273 #define UHUB_UNK_INTERFACE -1 274 275 static inline int 276 usbd_xfer_isread(struct usbd_xfer *xfer) 277 { 278 if (xfer->rqflags & URQ_REQUEST) 279 return (xfer->request.bmRequestType & UT_READ); 280 281 return (xfer->pipe->endpoint->edesc->bEndpointAddress & UE_DIR_IN); 282 } 283 284 #endif /* _USBDIVAR_H_ */ 285