1 /* $OpenBSD: usbdivar.h,v 1.44 2012/05/15 12:48:32 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 /* From usb_mem.h */ 36 struct usb_dma_block; 37 typedef struct { 38 struct usb_dma_block *block; 39 u_int offs; 40 } usb_dma_t; 41 42 struct usbd_xfer; 43 struct usbd_pipe; 44 45 struct usbd_endpoint { 46 usb_endpoint_descriptor_t *edesc; 47 int refcnt; 48 int savedtoggle; 49 }; 50 51 struct usbd_bus_methods { 52 usbd_status (*open_pipe)(struct usbd_pipe *pipe); 53 void (*soft_intr)(void *); 54 void (*do_poll)(struct usbd_bus *); 55 usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *, 56 u_int32_t bufsize); 57 void (*freem)(struct usbd_bus *, usb_dma_t *); 58 struct usbd_xfer * (*allocx)(struct usbd_bus *); 59 void (*freex)(struct usbd_bus *, struct usbd_xfer *); 60 }; 61 62 struct usbd_pipe_methods { 63 usbd_status (*transfer)(usbd_xfer_handle xfer); 64 usbd_status (*start)(usbd_xfer_handle xfer); 65 void (*abort)(usbd_xfer_handle xfer); 66 void (*close)(usbd_pipe_handle pipe); 67 void (*cleartoggle)(usbd_pipe_handle pipe); 68 void (*done)(usbd_xfer_handle xfer); 69 }; 70 71 struct usbd_tt { 72 struct usbd_hub *hub; 73 }; 74 75 struct usbd_port { 76 usb_port_status_t status; 77 u_int16_t power; /* mA of current on port */ 78 u_int8_t portno; 79 u_int8_t restartcnt; 80 #define USBD_RESTART_MAX 5 81 u_int8_t reattach; 82 struct usbd_device *device; /* Connected device */ 83 struct usbd_device *parent; /* The ports hub */ 84 struct usbd_tt *tt; /* Transaction translator (if any) */ 85 }; 86 87 struct usbd_hub { 88 usbd_status (*explore)(usbd_device_handle hub); 89 void *hubsoftc; 90 usb_hub_descriptor_t hubdesc; 91 struct usbd_port *ports; 92 }; 93 94 struct usbd_bus { 95 /* Filled by HC driver */ 96 struct device bdev; /* base device, host adapter */ 97 struct usbd_bus_methods *methods; 98 u_int32_t pipe_size; /* size of a pipe struct */ 99 /* Filled by usb driver */ 100 struct usbd_device *root_hub; 101 usbd_device_handle devices[USB_MAX_DEVICES]; 102 char use_polling; 103 char dying; 104 int flags; 105 #define USB_BUS_CONFIG_PENDING 0x01 106 struct device *usbctl; 107 struct usb_device_stats stats; 108 int intr_context; 109 u_int no_intrs; 110 int usbrev; /* USB revision */ 111 #define USBREV_UNKNOWN 0 112 #define USBREV_PRE_1_0 1 113 #define USBREV_1_0 2 114 #define USBREV_1_1 3 115 #define USBREV_2_0 4 116 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" } 117 void *soft; /* soft interrupt cookie */ 118 bus_dma_tag_t dmatag; /* DMA tag */ 119 }; 120 121 struct usbd_device { 122 struct usbd_bus *bus; /* our controller */ 123 struct usbd_pipe *default_pipe; /* pipe 0 */ 124 u_int8_t dying; /* hardware removed */ 125 u_int8_t ref_cnt; /* # of procs using device */ 126 u_int8_t address; /* device address */ 127 u_int8_t config; /* current configuration # */ 128 u_int8_t depth; /* distance from root hub */ 129 u_int8_t speed; /* low/full/high speed */ 130 u_int8_t self_powered; /* flag for self powered */ 131 u_int16_t power; /* mA the device uses */ 132 int16_t langid; /* language for strings */ 133 #define USBD_NOLANG (-1) 134 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 135 struct usbd_device *myhub; /* upstream hub */ 136 struct usbd_port *myhsport; /* closest high speed port */ 137 struct usbd_endpoint def_ep; /* for pipe 0 */ 138 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 139 struct usbd_interface *ifaces; /* array of all interfaces */ 140 usb_device_descriptor_t ddesc; /* device descriptor */ 141 usb_config_descriptor_t *cdesc; /* full config descr */ 142 const struct usbd_quirks *quirks; /* device quirks, always set */ 143 struct usbd_hub *hub; /* only if this is a hub */ 144 struct device **subdevs; /* sub-devices, 0 terminated */ 145 int ndevs; /* # of subdevs */ 146 }; 147 148 struct usbd_interface { 149 struct usbd_device *device; 150 usb_interface_descriptor_t *idesc; 151 int index; 152 int altindex; 153 struct usbd_endpoint *endpoints; 154 void *priv; 155 LIST_HEAD(, usbd_pipe) pipes; 156 u_int8_t claimed; 157 }; 158 159 struct usbd_pipe { 160 struct usbd_interface *iface; 161 struct usbd_device *device; 162 struct usbd_endpoint *endpoint; 163 int refcnt; 164 char running; 165 char aborting; 166 SIMPLEQ_HEAD(, usbd_xfer) queue; 167 LIST_ENTRY(usbd_pipe) next; 168 169 usbd_xfer_handle intrxfer; /* used for repeating requests */ 170 char repeat; 171 int interval; 172 173 /* Filled by HC driver. */ 174 struct usbd_pipe_methods *methods; 175 }; 176 177 struct usbd_xfer { 178 struct usbd_pipe *pipe; 179 void *priv; 180 void *buffer; 181 u_int32_t length; 182 u_int32_t actlen; 183 u_int16_t flags; 184 u_int32_t timeout; 185 usbd_status status; 186 usbd_callback callback; 187 __volatile char done; 188 #ifdef DIAGNOSTIC 189 u_int32_t busy_free; 190 #define XFER_FREE 0x46524545 191 #define XFER_BUSY 0x42555359 192 #define XFER_ONQU 0x4f4e5155 193 #endif 194 195 /* For control pipe */ 196 usb_device_request_t request; 197 198 /* For isoc */ 199 u_int16_t *frlengths; 200 int nframes; 201 202 /* For memory allocation */ 203 struct usbd_device *device; 204 usb_dma_t dmabuf; 205 206 int rqflags; 207 #define URQ_REQUEST 0x01 208 #define URQ_AUTO_DMABUF 0x10 209 #define URQ_DEV_DMABUF 0x20 210 211 SIMPLEQ_ENTRY(usbd_xfer) next; 212 213 void *hcpriv; /* private use by the HC driver */ 214 215 struct timeout timeout_handle; 216 }; 217 218 void usbd_init(void); 219 void usbd_finish(void); 220 void usb_begin_tasks(void); 221 void usb_end_tasks(void); 222 223 #ifdef USB_DEBUG 224 void usbd_dump_iface(struct usbd_interface *iface); 225 void usbd_dump_device(struct usbd_device *dev); 226 void usbd_dump_endpoint(struct usbd_endpoint *endp); 227 void usbd_dump_queue(usbd_pipe_handle pipe); 228 void usbd_dump_pipe(usbd_pipe_handle pipe); 229 #endif 230 231 /* Routines from usb_subr.c */ 232 int usbctlprint(void *, const char *); 233 void usb_delay_ms(usbd_bus_handle, u_int); 234 usbd_status usbd_port_disown_to_1_1(usbd_device_handle dev, 235 int port, usb_port_status_t *ps); 236 usbd_status usbd_reset_port(usbd_device_handle dev, 237 int port, usb_port_status_t *ps); 238 usbd_status usbd_setup_pipe(usbd_device_handle dev, 239 usbd_interface_handle iface, struct usbd_endpoint *, int, 240 usbd_pipe_handle *pipe); 241 usbd_status usbd_new_device(struct device *parent, usbd_bus_handle bus, 242 int depth, int lowspeed, int port, struct usbd_port *); 243 void usbd_remove_device(usbd_device_handle, struct usbd_port *); 244 int usbd_printBCD(char *cp, size_t len, int bcd); 245 usbd_status usbd_fill_iface_data(usbd_device_handle dev, int i, int a); 246 void usb_free_device(usbd_device_handle); 247 248 usbd_status usb_insert_transfer(usbd_xfer_handle xfer); 249 void usb_transfer_complete(usbd_xfer_handle xfer); 250 void usb_disconnect_port(struct usbd_port *up, struct device *); 251 252 /* Routines from usb.c */ 253 void usb_needs_explore(usbd_device_handle, int); 254 void usb_needs_reattach(usbd_device_handle); 255 void usb_schedsoftintr(struct usbd_bus *); 256 257 /* Locator stuff. */ 258 259 /* XXX these values are used to statically bind some elements in the USB tree 260 * to specific driver instances. This should be somehow emulated in FreeBSD 261 * but can be done later on. 262 * The values are copied from the files.usb file in the NetBSD sources. 263 */ 264 #define UHUBCF_PORT_DEFAULT -1 265 #define UHUBCF_CONFIGURATION_DEFAULT -1 266 #define UHUBCF_INTERFACE_DEFAULT -1 267 #define UHUBCF_VENDOR_DEFAULT -1 268 #define UHUBCF_PRODUCT_DEFAULT -1 269 #define UHUBCF_RELEASE_DEFAULT -1 270 271 #define UHUBCF_PORT 0 272 #define UHUBCF_CONFIGURATION 1 273 #define UHUBCF_INTERFACE 2 274 #define UHUBCF_VENDOR 3 275 #define UHUBCF_PRODUCT 4 276 #define UHUBCF_RELEASE 5 277 278 #define uhubcf_port cf_loc[UHUBCF_PORT] 279 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION] 280 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE] 281 #define uhubcf_vendor cf_loc[UHUBCF_VENDOR] 282 #define uhubcf_product cf_loc[UHUBCF_PRODUCT] 283 #define uhubcf_release cf_loc[UHUBCF_RELEASE] 284 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */ 285 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 286 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 287 #define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */ 288 #define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */ 289 #define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */ 290