usbdivar.h revision 1.80.12.3
1 /* $NetBSD: usbdivar.h,v 1.80.12.3 2007/06/22 10:12:25 itohy Exp $ */ 2 /* $FreeBSD: src/sys/dev/usb/usbdivar.h,v 1.47 2006/09/07 00:06:42 imp 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 struct usbd_xfer; 46 struct usbd_pipe; 47 struct mbuf; 48 49 struct usbd_endpoint { 50 usb_endpoint_descriptor_t *edesc; 51 int refcnt; 52 int savedtoggle; 53 }; 54 55 enum usbd_waitflg { 56 U_NOWAIT, /* callee is not allowed to sleep */ 57 U_WAITOK /* caller has context and callee is allowed to sleep */ 58 }; 59 60 enum usbd_maptype { 61 U_MAP_NONE, /* driver dosn't provide buffer to be mapped */ 62 U_MAP_BUFFER, /* map plain buffer provided by driver */ 63 U_MAP_MBUF /* map mbuf provided by driver */ 64 }; 65 66 struct usbd_bus_methods { 67 usbd_status (*open_pipe)(struct usbd_pipe *pipe); 68 void (*soft_intr)(void *); 69 void (*do_poll)(struct usbd_bus *); 70 usbd_status (*allocm)(struct usbd_bus *, usbd_xfer_handle, 71 void *, size_t); 72 void (*freem)(struct usbd_bus *, usbd_xfer_handle, 73 enum usbd_waitflg); 74 usbd_status (*map_alloc)(usbd_xfer_handle); 75 void (*map_free)(usbd_xfer_handle); 76 void (*mapm)(usbd_xfer_handle, void *, size_t); 77 usbd_status (*mapm_mbuf)(usbd_xfer_handle, struct mbuf *); 78 void (*unmapm)(usbd_xfer_handle); 79 struct usbd_xfer * (*allocx)(struct usbd_bus *, usbd_pipe_handle, 80 enum usbd_waitflg); 81 void (*freex)(struct usbd_bus *, struct usbd_xfer *); 82 }; 83 84 struct usbd_pipe_methods { 85 usbd_status (*transfer)(usbd_xfer_handle xfer); 86 usbd_status (*start)(usbd_xfer_handle xfer); 87 void (*abort)(usbd_xfer_handle xfer); 88 void (*close)(usbd_pipe_handle pipe); 89 void (*cleartoggle)(usbd_pipe_handle pipe); 90 void (*done)(usbd_xfer_handle xfer); 91 }; 92 93 struct usbd_tt { 94 struct usbd_hub *hub; 95 }; 96 97 struct usbd_port { 98 usb_port_status_t status; 99 u_int16_t power; /* mA of current on port */ 100 u_int8_t portno; 101 u_int8_t restartcnt; 102 #define USBD_RESTART_MAX 5 103 u_int8_t reattach; 104 struct usbd_device *device; /* Connected device */ 105 struct usbd_device *parent; /* The ports hub */ 106 struct usbd_tt *tt; /* Transaction translator (if any) */ 107 }; 108 109 struct usbd_hub { 110 usbd_status (*explore)(usbd_device_handle hub); 111 void *hubsoftc; 112 usb_hub_descriptor_t hubdesc; 113 struct usbd_port ports[1]; 114 }; 115 116 struct usb_softc; 117 118 /*****/ 119 120 struct usbd_bus { 121 /* Filled by HC driver */ 122 USBBASEDEVICE bdev; /* base device, host adapter */ 123 const struct usbd_bus_methods *methods; 124 u_int32_t pipe_size; /* size of a pipe struct */ 125 /* Filled by usb driver */ 126 struct usbd_device *root_hub; 127 usbd_device_handle devices[USB_MAX_DEVICES]; 128 char needs_explore;/* a hub a signalled a change */ 129 char use_polling; 130 struct usb_softc *usbctl; 131 struct usb_device_stats stats; 132 int intr_context; 133 u_int no_intrs; 134 int usbrev; /* USB revision */ 135 #define USBREV_UNKNOWN 0 136 #define USBREV_PRE_1_0 1 137 #define USBREV_1_0 2 138 #define USBREV_1_1 3 139 #define USBREV_2_0 4 140 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" } 141 142 #ifdef USB_USE_SOFTINTR 143 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS 144 void *soft; /* soft interrupt cookie */ 145 #else 146 struct callout softi; 147 #endif 148 #endif 149 }; 150 151 struct usbd_device { 152 struct usbd_bus *bus; /* our controller */ 153 struct usbd_pipe *default_pipe; /* pipe 0 */ 154 u_int8_t address; /* device addess */ 155 u_int8_t config; /* current configuration # */ 156 u_int8_t depth; /* distance from root hub */ 157 u_int8_t speed; /* low/full/high speed */ 158 u_int8_t self_powered; /* flag for self powered */ 159 u_int16_t power; /* mA the device uses */ 160 int16_t langid; /* language for strings */ 161 #define USBD_NOLANG (-1) 162 usb_event_cookie_t cookie; /* unique connection id */ 163 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 164 struct usbd_device *myhub; /* upstream hub */ 165 struct usbd_port *myhsport; /* closest high speed port */ 166 struct usbd_endpoint def_ep; /* for pipe 0 */ 167 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 168 struct usbd_interface *ifaces; /* array of all interfaces */ 169 usb_device_descriptor_t ddesc; /* device descriptor */ 170 usb_config_descriptor_t *cdesc; /* full config descr */ 171 const struct usbd_quirks *quirks; /* device quirks, always set */ 172 struct usbd_hub *hub; /* only if this is a hub */ 173 device_ptr_t *subdevs; /* sub-devices, 0 terminated */ 174 uint8_t *ifacenums; /* sub-device interfacenumbers */ 175 }; 176 177 struct usbd_interface { 178 struct usbd_device *device; 179 usb_interface_descriptor_t *idesc; 180 int index; 181 int altindex; 182 struct usbd_endpoint *endpoints; 183 void *priv; 184 LIST_HEAD(, usbd_pipe) pipes; 185 }; 186 187 struct usbd_pipe { 188 struct usbd_interface *iface; 189 struct usbd_device *device; 190 struct usbd_endpoint *endpoint; 191 int refcnt; 192 char running; 193 char aborting; 194 SIMPLEQ_HEAD(, usbd_xfer) queue; 195 LIST_ENTRY(usbd_pipe) next; 196 197 usbd_xfer_handle intrxfer; /* used for repeating requests */ 198 char repeat; 199 int interval; 200 201 /* Filled by HC driver. */ 202 const struct usbd_pipe_methods *methods; 203 }; 204 205 struct usbd_xfer { 206 struct usbd_pipe *pipe; 207 void *priv; 208 void *buffer; 209 u_int32_t length; 210 u_int32_t actlen; 211 u_int16_t flags; 212 u_int32_t timeout; 213 usbd_status status; 214 usbd_callback callback; 215 volatile u_int8_t done; 216 #define XFER_DONE_BOTTOM 1 217 #define XFER_DONE_TOP 2 218 u_int8_t busy_free; /* used for DIAGNOSTIC */ 219 #define XFER_FREE 0x46 220 #define XFER_BUSY 0x55 221 #define XFER_ONQU 0x9e 222 223 /* For control pipe */ 224 usb_device_request_t request; 225 226 /* For isoc */ 227 u_int16_t *frlengths; 228 int nframes; 229 230 /* For memory allocation */ 231 struct usbd_device *device; 232 void *hcbuffer; /* buffer for HCI driver */ 233 234 size_t bufsize; 235 236 u_int16_t rqflags; 237 #define URQ_REQUEST 0x0001 /* xfer->request valid */ 238 #define URQ_AUTO_BUF 0x0010 /* automatically allocated buffer */ 239 #define URQ_DEV_BUF 0x0020 /* driver requested to allocate buffer*/ 240 #define URQ_DEV_MAP_PREPARED 0x0040 /* driver requested to prepare map */ 241 #define URQ_DEV_MAP_BUFFER 0x0080 /* driver requested to map buffer */ 242 #define URQ_DEV_MAP_MBUF 0x0100 /* driver requested to map mbuf */ 243 244 #define URQ_MASK_DRV_REQUESTED_BUF \ 245 (URQ_DEV_BUF | URQ_DEV_MAP_BUFFER | URQ_DEV_MAP_MBUF) 246 #define URQ_MASK_BUF (URQ_MASK_DRV_REQUESTED_BUF | URQ_AUTO_BUF) 247 248 SIMPLEQ_ENTRY(usbd_xfer) next; 249 250 void *hcpriv; /* private use by the HC driver */ 251 u_int8_t hcflags; /* private use by the HC driver */ 252 #define UXFER_ABORTING 0x01 /* xfer is aborting. */ 253 #define UXFER_ABORTWAIT 0x02 /* abort completion is being awaited. */ 254 255 usb_callout_t timeout_handle; 256 struct usb_task task; 257 }; 258 259 void usbd_init(void); 260 void usbd_finish(void); 261 262 #ifdef USB_DEBUG 263 void usbd_dump_iface(struct usbd_interface *iface); 264 void usbd_dump_device(struct usbd_device *dev); 265 void usbd_dump_endpoint(struct usbd_endpoint *endp); 266 void usbd_dump_queue(usbd_pipe_handle pipe); 267 void usbd_dump_pipe(usbd_pipe_handle pipe); 268 #endif 269 270 /* Routines from usb_subr.c */ 271 int usbctlprint(void *, const char *); 272 void usb_delay_ms(usbd_bus_handle, u_int); 273 usbd_status usbd_reset_port(usbd_device_handle, int, usb_port_status_t *); 274 usbd_status usbd_setup_pipe(usbd_device_handle dev, 275 usbd_interface_handle iface, 276 struct usbd_endpoint *, int, 277 usbd_pipe_handle *pipe); 278 usbd_status usbd_new_device(device_ptr_t, usbd_bus_handle, int, int, int, 279 struct usbd_port *); 280 void usbd_remove_device(usbd_device_handle, struct usbd_port *); 281 int usbd_printBCD(char *, size_t, int); 282 usbd_status usbd_fill_iface_data(usbd_device_handle, int, int); 283 void usb_free_device(usbd_device_handle); 284 285 int usbd_xfer_isread(usbd_xfer_handle); 286 usbd_status usb_insert_transfer(usbd_xfer_handle); 287 void usb_transfer_complete(usbd_xfer_handle); 288 void usb_disconnect_port(struct usbd_port *, device_ptr_t); 289 290 /* Routines from usb.c */ 291 void usb_needs_explore(usbd_device_handle); 292 void usb_needs_reattach(usbd_device_handle); 293 void usb_schedsoftintr(struct usbd_bus *); 294 295 /* 296 * XXX This check is extremely bogus. Bad Bad Bad. 297 */ 298 #if defined(DIAGNOSTIC) && 0 299 #define SPLUSBCHECK \ 300 do { int _s = splusb(), _su = splusb(); \ 301 if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \ 302 _s, _su, __FILE__, __LINE__); \ 303 splx(_s); \ 304 } while (0) 305 #else 306 #define SPLUSBCHECK 307 #endif 308 309 /* Locator stuff. */ 310 311 #if defined(__NetBSD__) 312 #include "locators.h" 313 #elif defined(__FreeBSD__) || defined(__OpenBSD__) 314 /* XXX these values are used to statically bind some elements in the USB tree 315 * to specific driver instances. This should be somehow emulated in FreeBSD 316 * but can be done later on. 317 * The values are copied from the files.usb file in the NetBSD sources. 318 */ 319 #define UHUBCF_PORT_DEFAULT -1 320 #define UHUBCF_CONFIGURATION_DEFAULT -1 321 #define UHUBCF_INTERFACE_DEFAULT -1 322 #define UHUBCF_VENDOR_DEFAULT -1 323 #define UHUBCF_PRODUCT_DEFAULT -1 324 #define UHUBCF_RELEASE_DEFAULT -1 325 #endif 326 327 #if defined (__OpenBSD__) 328 #define UHUBCF_PORT 0 329 #define UHUBCF_CONFIGURATION 1 330 #define UHUBCF_INTERFACE 2 331 #define UHUBCF_VENDOR 3 332 #define UHUBCF_PRODUCT 4 333 #define UHUBCF_RELEASE 5 334 #endif 335 336 #define uhubcf_port cf_loc[USBDEVIFCF_PORT] 337 #define uhubcf_configuration cf_loc[USBDEVIFCF_CONFIGURATION] 338 #define uhubcf_interface cf_loc[USBDEVIFCF_INTERFACE] 339 #define uhubcf_vendor cf_loc[USBDEVIFCF_VENDOR] 340 #define uhubcf_product cf_loc[USBDEVIFCF_PRODUCT] 341 #define uhubcf_release cf_loc[USBDEVIFCF_RELEASE] 342 #define UHUB_UNK_PORT USBDEVIFCF_PORT_DEFAULT /* wildcarded 'port' */ 343 #define UHUB_UNK_CONFIGURATION USBDEVIFCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 344 #define UHUB_UNK_INTERFACE USBDEVIFCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 345 #define UHUB_UNK_VENDOR USBDEVIFCF_VENDOR_DEFAULT /* wildcarded 'vendor' */ 346 #define UHUB_UNK_PRODUCT USBDEVIFCF_PRODUCT_DEFAULT /* wildcarded 'product' */ 347 #define UHUB_UNK_RELEASE USBDEVIFCF_RELEASE_DEFAULT /* wildcarded 'release' */ 348 349
Indexes created Wed Oct 01 13:09:50 GMT 2025