usbdivar.h revision 1.83
1 /* $NetBSD: usbdivar.h,v 1.83 2008/03/28 17:14:46 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 (at) 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 * 3. All advertising materials mentioning features or use of this software 21 * must display the following acknowledgement: 22 * This product includes software developed by the NetBSD 23 * Foundation, Inc. and its contributors. 24 * 4. Neither the name of The NetBSD Foundation nor the names of its 25 * contributors may be used to endorse or promote products derived 26 * from this software without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 38 * POSSIBILITY OF SUCH DAMAGE. 39 */ 40 41 #if defined(__NetBSD__) 42 #include <sys/callout.h> 43 #endif 44 45 /* From usb_mem.h */ 46 DECLARE_USB_DMA_T; 47 48 struct usbd_xfer; 49 struct usbd_pipe; 50 51 struct usbd_endpoint { 52 usb_endpoint_descriptor_t *edesc; 53 int refcnt; 54 }; 55 56 struct usbd_bus_methods { 57 usbd_status (*open_pipe)(struct usbd_pipe *pipe); 58 void (*soft_intr)(void *); 59 void (*do_poll)(struct usbd_bus *); 60 usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *, 61 u_int32_t bufsize); 62 void (*freem)(struct usbd_bus *, usb_dma_t *); 63 struct usbd_xfer * (*allocx)(struct usbd_bus *); 64 void (*freex)(struct usbd_bus *, struct usbd_xfer *); 65 }; 66 67 struct usbd_pipe_methods { 68 usbd_status (*transfer)(usbd_xfer_handle xfer); 69 usbd_status (*start)(usbd_xfer_handle xfer); 70 void (*abort)(usbd_xfer_handle xfer); 71 void (*close)(usbd_pipe_handle pipe); 72 void (*cleartoggle)(usbd_pipe_handle pipe); 73 void (*done)(usbd_xfer_handle xfer); 74 }; 75 76 #if 0 /* notyet */ 77 struct usbd_tt { 78 struct usbd_hub *hub; 79 }; 80 #endif 81 82 struct usbd_port { 83 usb_port_status_t status; 84 u_int16_t power; /* mA of current on port */ 85 u_int8_t portno; 86 u_int8_t restartcnt; 87 #define USBD_RESTART_MAX 5 88 u_int8_t reattach; 89 struct usbd_device *device; /* Connected device */ 90 struct usbd_device *parent; /* The ports hub */ 91 #if 0 92 struct usbd_tt *tt; /* Transaction translator (if any) */ 93 #endif 94 }; 95 96 struct usbd_hub { 97 usbd_status (*explore)(usbd_device_handle hub); 98 void *hubsoftc; 99 usb_hub_descriptor_t hubdesc; 100 struct usbd_port ports[1]; 101 }; 102 103 /*****/ 104 105 struct usbd_bus { 106 /* Filled by HC driver */ 107 void *hci_private; 108 const struct usbd_bus_methods *methods; 109 u_int32_t pipe_size; /* size of a pipe struct */ 110 /* Filled by usb driver */ 111 struct usbd_device *root_hub; 112 usbd_device_handle devices[USB_MAX_DEVICES]; 113 char needs_explore;/* a hub a signalled a change */ 114 char use_polling; 115 device_t usbctl; 116 struct usb_device_stats stats; 117 int intr_context; 118 u_int no_intrs; 119 int usbrev; /* USB revision */ 120 #define USBREV_UNKNOWN 0 121 #define USBREV_PRE_1_0 1 122 #define USBREV_1_0 2 123 #define USBREV_1_1 3 124 #define USBREV_2_0 4 125 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" } 126 127 void *soft; /* soft interrupt cookie */ 128 #if defined(__NetBSD__) || defined(__OpenBSD__) 129 bus_dma_tag_t dmatag; /* DMA tag */ 130 #endif 131 }; 132 133 struct usbd_device { 134 struct usbd_bus *bus; /* our controller */ 135 struct usbd_pipe *default_pipe; /* pipe 0 */ 136 u_int8_t address; /* device addess */ 137 u_int8_t config; /* current configuration # */ 138 u_int8_t depth; /* distance from root hub */ 139 u_int8_t speed; /* low/full/high speed */ 140 u_int8_t self_powered; /* flag for self powered */ 141 u_int16_t power; /* mA the device uses */ 142 int16_t langid; /* language for strings */ 143 #define USBD_NOLANG (-1) 144 usb_event_cookie_t cookie; /* unique connection id */ 145 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 146 struct usbd_device *myhub; /* upstream hub */ 147 struct usbd_port *myhsport; /* closest high speed port */ 148 struct usbd_endpoint def_ep; /* for pipe 0 */ 149 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 150 struct usbd_interface *ifaces; /* array of all interfaces */ 151 usb_device_descriptor_t ddesc; /* device descriptor */ 152 usb_config_descriptor_t *cdesc; /* full config descr */ 153 const struct usbd_quirks *quirks; /* device quirks, always set */ 154 struct usbd_hub *hub; /* only if this is a hub */ 155 device_t *subdevs; /* sub-devices, 0 terminated */ 156 }; 157 158 struct usbd_interface { 159 struct usbd_device *device; 160 usb_interface_descriptor_t *idesc; 161 int index; 162 int altindex; 163 struct usbd_endpoint *endpoints; 164 void *priv; 165 LIST_HEAD(, usbd_pipe) pipes; 166 }; 167 168 struct usbd_pipe { 169 struct usbd_interface *iface; 170 struct usbd_device *device; 171 struct usbd_endpoint *endpoint; 172 int refcnt; 173 char running; 174 char aborting; 175 SIMPLEQ_HEAD(, usbd_xfer) queue; 176 LIST_ENTRY(usbd_pipe) next; 177 178 usbd_xfer_handle intrxfer; /* used for repeating requests */ 179 char repeat; 180 int interval; 181 182 /* Filled by HC driver. */ 183 const struct usbd_pipe_methods *methods; 184 }; 185 186 struct usbd_xfer { 187 struct usbd_pipe *pipe; 188 void *priv; 189 void *buffer; 190 u_int32_t length; 191 u_int32_t actlen; 192 u_int16_t flags; 193 u_int32_t timeout; 194 usbd_status status; 195 usbd_callback callback; 196 volatile u_int8_t done; 197 u_int8_t busy_free; /* used for DIAGNOSTIC */ 198 #define XFER_FREE 0x46 199 #define XFER_BUSY 0x55 200 #define XFER_ONQU 0x9e 201 202 /* For control pipe */ 203 usb_device_request_t request; 204 205 /* For isoc */ 206 u_int16_t *frlengths; 207 int nframes; 208 209 /* For memory allocation */ 210 struct usbd_device *device; 211 usb_dma_t dmabuf; 212 213 u_int8_t rqflags; 214 #define URQ_REQUEST 0x01 215 #define URQ_AUTO_DMABUF 0x10 216 #define URQ_DEV_DMABUF 0x20 217 218 SIMPLEQ_ENTRY(usbd_xfer) next; 219 220 void *hcpriv; /* private use by the HC driver */ 221 u_int8_t hcflags; /* private use by the HC driver */ 222 #define UXFER_ABORTING 0x01 /* xfer is aborting. */ 223 #define UXFER_ABORTWAIT 0x02 /* abort completion is being awaited. */ 224 225 usb_callout_t timeout_handle; 226 }; 227 228 void usbd_init(void); 229 void usbd_finish(void); 230 231 #ifdef USB_DEBUG 232 void usbd_dump_iface(struct usbd_interface *iface); 233 void usbd_dump_device(struct usbd_device *dev); 234 void usbd_dump_endpoint(struct usbd_endpoint *endp); 235 void usbd_dump_queue(usbd_pipe_handle pipe); 236 void usbd_dump_pipe(usbd_pipe_handle pipe); 237 #endif 238 239 /* Routines from usb_subr.c */ 240 int usbctlprint(void *, const char *); 241 void usb_delay_ms(usbd_bus_handle, u_int); 242 usbd_status usbd_reset_port(usbd_device_handle, int, usb_port_status_t *); 243 usbd_status usbd_setup_pipe(usbd_device_handle dev, 244 usbd_interface_handle iface, 245 struct usbd_endpoint *, int, 246 usbd_pipe_handle *pipe); 247 usbd_status usbd_new_device(device_ptr_t, usbd_bus_handle, int, int, int, 248 struct usbd_port *); 249 void usbd_remove_device(usbd_device_handle, struct usbd_port *); 250 int usbd_printBCD(char *, size_t, int); 251 usbd_status usbd_fill_iface_data(usbd_device_handle, int, int); 252 void usb_free_device(usbd_device_handle); 253 254 usbd_status usb_insert_transfer(usbd_xfer_handle); 255 void usb_transfer_complete(usbd_xfer_handle); 256 void usb_disconnect_port(struct usbd_port *, device_ptr_t); 257 258 /* Routines from usb.c */ 259 void usb_needs_explore(usbd_device_handle); 260 void usb_needs_reattach(usbd_device_handle); 261 void usb_schedsoftintr(struct usbd_bus *); 262 263 /* 264 * XXX This check is extremely bogus. Bad Bad Bad. 265 */ 266 #if defined(DIAGNOSTIC) && 0 267 #define SPLUSBCHECK \ 268 do { int _s = splusb(), _su = splusb(); \ 269 if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \ 270 _s, _su, __FILE__, __LINE__); \ 271 splx(_s); \ 272 } while (0) 273 #else 274 #define SPLUSBCHECK 275 #endif 276 277 /* Locator stuff. */ 278 279 #if defined(__NetBSD__) 280 #include "locators.h" 281 #elif defined(__FreeBSD__) || defined(__OpenBSD__) 282 /* XXX these values are used to statically bind some elements in the USB tree 283 * to specific driver instances. This should be somehow emulated in FreeBSD 284 * but can be done later on. 285 * The values are copied from the files.usb file in the NetBSD sources. 286 */ 287 #define UHUBCF_PORT_DEFAULT -1 288 #define UHUBCF_CONFIGURATION_DEFAULT -1 289 #define UHUBCF_INTERFACE_DEFAULT -1 290 #define UHUBCF_VENDOR_DEFAULT -1 291 #define UHUBCF_PRODUCT_DEFAULT -1 292 #define UHUBCF_RELEASE_DEFAULT -1 293 #endif 294 295 #if defined (__OpenBSD__) 296 #define UHUBCF_PORT 0 297 #define UHUBCF_CONFIGURATION 1 298 #define UHUBCF_INTERFACE 2 299 #define UHUBCF_VENDOR 3 300 #define UHUBCF_PRODUCT 4 301 #define UHUBCF_RELEASE 5 302 #endif 303 304 #define uhubcf_port cf_loc[USBDEVIFCF_PORT] 305 #define uhubcf_configuration cf_loc[USBDEVIFCF_CONFIGURATION] 306 #define uhubcf_interface cf_loc[USBDEVIFCF_INTERFACE] 307 #define uhubcf_vendor cf_loc[USBDEVIFCF_VENDOR] 308 #define uhubcf_product cf_loc[USBDEVIFCF_PRODUCT] 309 #define uhubcf_release cf_loc[USBDEVIFCF_RELEASE] 310 #define UHUB_UNK_PORT USBDEVIFCF_PORT_DEFAULT /* wildcarded 'port' */ 311 #define UHUB_UNK_CONFIGURATION USBDEVIFCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 312 #define UHUB_UNK_INTERFACE USBDEVIFCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 313 #define UHUB_UNK_VENDOR USBDEVIFCF_VENDOR_DEFAULT /* wildcarded 'vendor' */ 314 #define UHUB_UNK_PRODUCT USBDEVIFCF_PRODUCT_DEFAULT /* wildcarded 'product' */ 315 #define UHUB_UNK_RELEASE USBDEVIFCF_RELEASE_DEFAULT /* wildcarded 'release' */ 316 317
Indexes created Thu Sep 25 16:09:42 GMT 2025