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