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