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