1 /* $NetBSD: usbdivar.h,v 1.93 2011/05/27 17:19:18 drochner Exp $ */ 2 /* $FreeBSD: src/sys/dev/usb/usbdivar.h,v 1.11 1999/11/17 22:33:51 n_hibma Exp $ */ 3 4 /* 5 * Copyright (c) 1998 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Lennart Augustsson (lennart@augustsson.net) at 10 * Carlstedt Research & Technology. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include <sys/callout.h> 35 36 /* From usb_mem.h */ 37 struct usb_dma_block; 38 typedef struct { 39 struct usb_dma_block *block; 40 u_int offs; 41 } usb_dma_t; 42 43 struct usbd_xfer; 44 struct usbd_pipe; 45 46 struct usbd_endpoint { 47 usb_endpoint_descriptor_t *edesc; 48 int refcnt; 49 int datatoggle; 50 }; 51 52 struct usbd_bus_methods { 53 usbd_status (*open_pipe)(struct usbd_pipe *pipe); 54 void (*soft_intr)(void *); 55 void (*do_poll)(struct usbd_bus *); 56 usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *, 57 u_int32_t bufsize); 58 void (*freem)(struct usbd_bus *, usb_dma_t *); 59 struct usbd_xfer * (*allocx)(struct usbd_bus *); 60 void (*freex)(struct usbd_bus *, struct usbd_xfer *); 61 }; 62 63 struct usbd_pipe_methods { 64 usbd_status (*transfer)(usbd_xfer_handle xfer); 65 usbd_status (*start)(usbd_xfer_handle xfer); 66 void (*abort)(usbd_xfer_handle xfer); 67 void (*close)(usbd_pipe_handle pipe); 68 void (*cleartoggle)(usbd_pipe_handle pipe); 69 void (*done)(usbd_xfer_handle xfer); 70 }; 71 72 #if 0 /* notyet */ 73 struct usbd_tt { 74 struct usbd_hub *hub; 75 }; 76 #endif 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 #if 0 88 struct usbd_tt *tt; /* Transaction translator (if any) */ 89 #endif 90 }; 91 92 struct usbd_hub { 93 usbd_status (*explore)(usbd_device_handle hub); 94 void *hubsoftc; 95 usb_hub_descriptor_t hubdesc; 96 struct usbd_port ports[1]; 97 }; 98 99 /*****/ 100 101 struct usbd_bus { 102 /* Filled by HC driver */ 103 void *hci_private; 104 const struct usbd_bus_methods *methods; 105 u_int32_t pipe_size; /* size of a pipe struct */ 106 /* Filled by usb driver */ 107 struct usbd_device *root_hub; 108 usbd_device_handle devices[USB_MAX_DEVICES]; 109 char needs_explore;/* a hub a signalled a change */ 110 char use_polling; 111 device_t usbctl; 112 struct usb_device_stats stats; 113 int intr_context; 114 u_int no_intrs; 115 int usbrev; /* USB revision */ 116 #define USBREV_UNKNOWN 0 117 #define USBREV_PRE_1_0 1 118 #define USBREV_1_0 2 119 #define USBREV_1_1 3 120 #define USBREV_2_0 4 121 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" } 122 123 void *soft; /* soft interrupt cookie */ 124 bus_dma_tag_t dmatag; /* DMA tag */ 125 }; 126 127 struct usbd_device { 128 struct usbd_bus *bus; /* our controller */ 129 struct usbd_pipe *default_pipe; /* pipe 0 */ 130 u_int8_t address; /* device addess */ 131 u_int8_t config; /* current configuration # */ 132 u_int8_t depth; /* distance from root hub */ 133 u_int8_t speed; /* low/full/high speed */ 134 u_int8_t self_powered; /* flag for self powered */ 135 u_int16_t power; /* mA the device uses */ 136 int16_t langid; /* language for strings */ 137 #define USBD_NOLANG (-1) 138 usb_event_cookie_t cookie; /* unique connection id */ 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 int subdevlen; /* array length of following */ 150 device_t *subdevs; /* sub-devices */ 151 int nifaces_claimed; /* number of ifaces in use */ 152 }; 153 154 struct usbd_interface { 155 struct usbd_device *device; 156 usb_interface_descriptor_t *idesc; 157 int index; 158 int altindex; 159 struct usbd_endpoint *endpoints; 160 void *priv; 161 LIST_HEAD(, usbd_pipe) pipes; 162 }; 163 164 struct usbd_pipe { 165 struct usbd_interface *iface; 166 struct usbd_device *device; 167 struct usbd_endpoint *endpoint; 168 int refcnt; 169 char running; 170 char aborting; 171 SIMPLEQ_HEAD(, usbd_xfer) queue; 172 LIST_ENTRY(usbd_pipe) next; 173 174 usbd_xfer_handle intrxfer; /* used for repeating requests */ 175 char repeat; 176 int interval; 177 178 /* Filled by HC driver. */ 179 const struct usbd_pipe_methods *methods; 180 }; 181 182 struct usbd_xfer { 183 struct usbd_pipe *pipe; 184 void *priv; 185 void *buffer; 186 u_int32_t length; 187 u_int32_t actlen; 188 u_int16_t flags; 189 u_int32_t timeout; 190 usbd_status status; 191 usbd_callback callback; 192 volatile u_int8_t done; 193 u_int8_t busy_free; /* used for DIAGNOSTIC */ 194 #define XFER_FREE 0x46 195 #define XFER_BUSY 0x55 196 #define XFER_ONQU 0x9e 197 198 /* For control pipe */ 199 usb_device_request_t request; 200 201 /* For isoc */ 202 u_int16_t *frlengths; 203 int nframes; 204 205 /* For memory allocation */ 206 struct usbd_device *device; 207 usb_dma_t dmabuf; 208 209 u_int8_t rqflags; 210 #define URQ_REQUEST 0x01 211 #define URQ_AUTO_DMABUF 0x10 212 #define URQ_DEV_DMABUF 0x20 213 214 SIMPLEQ_ENTRY(usbd_xfer) next; 215 216 void *hcpriv; /* private use by the HC driver */ 217 u_int8_t hcflags; /* private use by the HC driver */ 218 #define UXFER_ABORTING 0x01 /* xfer is aborting. */ 219 #define UXFER_ABORTWAIT 0x02 /* abort completion is being awaited. */ 220 221 struct callout timeout_handle; 222 }; 223 224 void usbd_init(void); 225 void usbd_finish(void); 226 227 #if defined(USB_DEBUG) || defined(EHCI_DEBUG) 228 void usbd_dump_iface(struct usbd_interface *iface); 229 void usbd_dump_device(struct usbd_device *dev); 230 void usbd_dump_endpoint(struct usbd_endpoint *endp); 231 void usbd_dump_queue(usbd_pipe_handle pipe); 232 void usbd_dump_pipe(usbd_pipe_handle pipe); 233 #endif 234 235 /* Routines from usb_subr.c */ 236 int usbctlprint(void *, const char *); 237 void usb_delay_ms(usbd_bus_handle, u_int); 238 usbd_status usbd_reset_port(usbd_device_handle, int, usb_port_status_t *); 239 usbd_status usbd_setup_pipe(usbd_device_handle dev, 240 usbd_interface_handle iface, 241 struct usbd_endpoint *, int, 242 usbd_pipe_handle *pipe); 243 usbd_status usbd_new_device(device_t, usbd_bus_handle, int, int, int, 244 struct usbd_port *); 245 usbd_status usbd_reattach_device(device_t, usbd_device_handle, 246 int, const int *); 247 248 void usbd_remove_device(usbd_device_handle, struct usbd_port *); 249 int usbd_printBCD(char *, size_t, int); 250 usbd_status usbd_fill_iface_data(usbd_device_handle, int, int); 251 void usb_free_device(usbd_device_handle); 252 253 usbd_status usb_insert_transfer(usbd_xfer_handle); 254 void usb_transfer_complete(usbd_xfer_handle); 255 int usb_disconnect_port(struct usbd_port *, device_t, int); 256 257 /* Routines from usb.c */ 258 void usb_needs_explore(usbd_device_handle); 259 void usb_needs_reattach(usbd_device_handle); 260 void usb_schedsoftintr(struct usbd_bus *); 261 262 /* 263 * XXX This check is extremely bogus. Bad Bad Bad. 264 */ 265 #if defined(DIAGNOSTIC) && 0 266 #define SPLUSBCHECK \ 267 do { int _s = splusb(), _su = splusb(); \ 268 if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \ 269 _s, _su, __FILE__, __LINE__); \ 270 splx(_s); \ 271 } while (0) 272 #else 273 #define SPLUSBCHECK 274 #endif 275