1 /* $OpenBSD: usbdivar.h,v 1.61 2014/07/09 18:15:04 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 usb_hub_descriptor_t hubdesc; 94 struct usbd_port *ports; 95 }; 96 97 struct usbd_bus { 98 /* Filled by HC driver */ 99 struct device bdev; /* base device, host adapter */ 100 struct usbd_bus_methods *methods; 101 u_int32_t pipe_size; /* size of a pipe struct */ 102 /* Filled by usb driver */ 103 struct usbd_device *root_hub; 104 struct usbd_device *devices[USB_MAX_DEVICES]; 105 char use_polling; 106 char dying; 107 int flags; 108 #define USB_BUS_CONFIG_PENDING 0x01 109 #define USB_BUS_DISCONNECTING 0x02 110 struct device *usbctl; 111 struct usb_device_stats stats; 112 int intr_context; 113 u_int no_intrs; 114 int usbrev; /* USB revision */ 115 #define USBREV_UNKNOWN 0 116 #define USBREV_PRE_1_0 1 117 #define USBREV_1_0 2 118 #define USBREV_1_1 3 119 #define USBREV_2_0 4 120 #define USBREV_3_0 5 121 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0", "3.0" } 122 void *soft; /* soft interrupt cookie */ 123 bus_dma_tag_t dmatag; /* DMA tag */ 124 }; 125 126 struct usbd_device { 127 struct usbd_bus *bus; /* our controller */ 128 struct usbd_pipe *default_pipe; /* pipe 0 */ 129 u_int8_t dying; /* hardware removed */ 130 u_int8_t ref_cnt; /* # of procs using device */ 131 u_int8_t address; /* device address */ 132 u_int8_t config; /* current configuration # */ 133 u_int8_t depth; /* distance from root hub */ 134 u_int8_t speed; /* low/full/high speed */ 135 u_int8_t self_powered; /* flag for self powered */ 136 u_int16_t power; /* mA the device uses */ 137 int16_t langid; /* language for strings */ 138 #define USBD_NOLANG (-1) 139 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 140 struct usbd_device *myhub; /* upstream hub */ 141 struct usbd_port *myhsport; /* closest high speed port */ 142 struct usbd_endpoint def_ep; /* for pipe 0 */ 143 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 144 struct usbd_interface *ifaces; /* array of all interfaces */ 145 usb_device_descriptor_t ddesc; /* device descriptor */ 146 usb_config_descriptor_t *cdesc; /* full config descr */ 147 const struct usbd_quirks *quirks; /* device quirks, always set */ 148 struct usbd_hub *hub; /* only if this is a hub */ 149 struct device **subdevs; /* sub-devices, 0 terminated */ 150 int ndevs; /* # of subdevs */ 151 }; 152 153 struct usbd_interface { 154 struct usbd_device *device; 155 usb_interface_descriptor_t *idesc; 156 int index; 157 int altindex; 158 struct usbd_endpoint *endpoints; 159 void *priv; 160 LIST_HEAD(, usbd_pipe) pipes; 161 u_int8_t claimed; 162 }; 163 164 struct usbd_pipe { 165 struct usbd_interface *iface; 166 struct usbd_device *device; 167 struct usbd_endpoint *endpoint; 168 char running; 169 char aborting; 170 SIMPLEQ_HEAD(, usbd_xfer) queue; 171 LIST_ENTRY(usbd_pipe) next; 172 173 struct usbd_xfer *intrxfer; /* used for repeating requests */ 174 char repeat; 175 int interval; 176 177 /* Filled by HC driver. */ 178 struct usbd_pipe_methods *methods; 179 }; 180 181 struct usbd_xfer { 182 struct usbd_pipe *pipe; 183 void *priv; 184 void *buffer; 185 u_int32_t length; 186 u_int32_t actlen; 187 u_int16_t flags; 188 u_int32_t timeout; 189 usbd_status status; 190 usbd_callback callback; 191 volatile char done; 192 #ifdef DIAGNOSTIC 193 u_int32_t busy_free; 194 #define XFER_FREE 0x46524545 195 #define XFER_BUSY 0x42555359 196 #define XFER_ONQU 0x4f4e5155 197 #endif 198 199 /* For control pipe */ 200 usb_device_request_t request; 201 202 /* For isoc */ 203 u_int16_t *frlengths; 204 int nframes; 205 206 /* For memory allocation */ 207 struct usbd_device *device; 208 struct usb_dma dmabuf; 209 210 int rqflags; 211 #define URQ_REQUEST 0x01 212 #define URQ_AUTO_DMABUF 0x10 213 #define URQ_DEV_DMABUF 0x20 214 215 SIMPLEQ_ENTRY(usbd_xfer) next; 216 217 void *hcpriv; /* private use by the HC driver */ 218 219 struct usb_task abort_task; 220 struct timeout timeout_handle; 221 }; 222 223 #ifdef USB_DEBUG 224 void usbd_dump_iface(struct usbd_interface *); 225 void usbd_dump_device(struct usbd_device *); 226 void usbd_dump_endpoint(struct usbd_endpoint *); 227 void usbd_dump_queue(struct usbd_pipe *); 228 void usbd_dump_pipe(struct usbd_pipe *); 229 #endif 230 231 /* Routines from usb_subr.c */ 232 int usbctlprint(void *, const char *); 233 void usb_delay_ms(struct usbd_bus *, u_int); 234 usbd_status usbd_port_disown_to_1_1(struct usbd_device *, 235 int, usb_port_status_t *); 236 usbd_status usbd_reset_port(struct usbd_device *, 237 int, usb_port_status_t *); 238 usbd_status usbd_setup_pipe(struct usbd_device *, 239 struct usbd_interface *, struct usbd_endpoint *, int, 240 struct usbd_pipe **); 241 int usbd_set_address(struct usbd_device *, int); 242 usbd_status usbd_new_device(struct device *, struct usbd_bus *, 243 int, int, int, struct usbd_port *); 244 usbd_status usbd_fill_iface_data(struct usbd_device *, int, int); 245 246 usbd_status usb_insert_transfer(struct usbd_xfer *); 247 void usb_transfer_complete(struct usbd_xfer *); 248 int usbd_detach(struct usbd_device *, struct device *); 249 250 /* Routines from usb.c */ 251 void usb_needs_explore(struct usbd_device *, int); 252 void usb_needs_reattach(struct usbd_device *); 253 void usb_schedsoftintr(struct usbd_bus *); 254 255 /* Locator stuff. */ 256 257 /* XXX these values are used to statically bind some elements in the USB tree 258 * to specific driver instances. This should be somehow emulated in FreeBSD 259 * but can be done later on. 260 * The values are copied from the files.usb file in the NetBSD sources. 261 */ 262 #define UHUBCF_PORT_DEFAULT -1 263 #define UHUBCF_CONFIGURATION_DEFAULT -1 264 #define UHUBCF_INTERFACE_DEFAULT -1 265 #define UHUBCF_VENDOR_DEFAULT -1 266 #define UHUBCF_PRODUCT_DEFAULT -1 267 #define UHUBCF_RELEASE_DEFAULT -1 268 269 #define UHUBCF_PORT 0 270 #define UHUBCF_CONFIGURATION 1 271 #define UHUBCF_INTERFACE 2 272 #define UHUBCF_VENDOR 3 273 #define UHUBCF_PRODUCT 4 274 #define UHUBCF_RELEASE 5 275 276 #define uhubcf_port cf_loc[UHUBCF_PORT] 277 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION] 278 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE] 279 #define uhubcf_vendor cf_loc[UHUBCF_VENDOR] 280 #define uhubcf_product cf_loc[UHUBCF_PRODUCT] 281 #define uhubcf_release cf_loc[UHUBCF_RELEASE] 282 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */ 283 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 284 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 285 #define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */ 286 #define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */ 287 #define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */ 288 289 static inline int 290 usbd_xfer_isread(struct usbd_xfer *xfer) 291 { 292 if (xfer->rqflags & URQ_REQUEST) 293 return (xfer->request.bmRequestType & UT_READ); 294 295 return (xfer->pipe->endpoint->edesc->bEndpointAddress & UE_DIR_IN); 296 } 297 298 #endif /* _USBDIVAR_H_ */ 299