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