usbdivar.h revision 1.43
1 /* $NetBSD: usbdivar.h,v 1.43 2000/01/16 09:43:43 augustss 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 (augustss (at) carlstedt.se) 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 /* From usb_mem.h */ 42 DECLARE_USB_DMA_T; 43 44 struct usbd_xfer; 45 struct usbd_pipe; 46 47 struct usbd_endpoint { 48 usb_endpoint_descriptor_t *edesc; 49 int refcnt; 50 }; 51 52 struct usbd_bus_methods { 53 usbd_status (*open_pipe)__P((struct usbd_pipe *pipe)); 54 void (*do_poll)__P((struct usbd_bus *)); 55 usbd_status (*allocm)__P((struct usbd_bus *, usb_dma_t *, 56 u_int32_t bufsize)); 57 void (*freem)__P((struct usbd_bus *, usb_dma_t *)); 58 }; 59 60 struct usbd_pipe_methods { 61 usbd_status (*transfer)__P((usbd_xfer_handle xfer)); 62 usbd_status (*start)__P((usbd_xfer_handle xfer)); 63 void (*abort)__P((usbd_xfer_handle xfer)); 64 void (*close)__P((usbd_pipe_handle pipe)); 65 void (*cleartoggle)__P((usbd_pipe_handle pipe)); 66 void (*done)__P((usbd_xfer_handle xfer)); 67 }; 68 69 struct usbd_port { 70 usb_port_status_t status; 71 u_int16_t power; /* mA of current on port */ 72 u_int8_t portno; 73 u_int8_t restartcnt; 74 #define USBD_RESTART_MAX 5 75 struct usbd_device *device; 76 struct usbd_device *parent; /* The ports hub */ 77 }; 78 79 struct usbd_hub { 80 usbd_status (*explore)__P((usbd_device_handle hub)); 81 void *hubsoftc; 82 usb_hub_descriptor_t hubdesc; 83 struct usbd_port ports[1]; 84 }; 85 86 struct usb_softc; 87 88 /*****/ 89 90 struct usbd_bus { 91 /* Filled by HC driver */ 92 USBBASEDEVICE bdev; /* base device, host adapter */ 93 struct usbd_bus_methods *methods; 94 u_int32_t pipe_size; /* size of a pipe struct */ 95 /* Filled by usb driver */ 96 struct usbd_device *root_hub; 97 usbd_device_handle devices[USB_MAX_DEVICES]; 98 char needs_explore;/* a hub a signalled a change */ 99 char use_polling; 100 struct usb_softc *usbctl; 101 struct usb_device_stats stats; 102 int intr_context; 103 u_int no_intrs; 104 int usbrev; /* USB revision */ 105 #define USBREV_UNKNOWN 0 106 #define USBREV_PRE_1_0 1 107 #define USBREV_1_0 2 108 #define USBREV_1_1 3 109 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1" } 110 111 #if defined(__NetBSD__) || defined(__OpenBSD__) 112 bus_dma_tag_t dmatag; /* DMA tag */ 113 #endif 114 }; 115 116 struct usbd_device { 117 struct usbd_bus *bus; /* our controller */ 118 struct usbd_pipe *default_pipe; /* pipe 0 */ 119 u_int8_t address; /* device addess */ 120 u_int8_t config; /* current configuration # */ 121 u_int8_t depth; /* distance from root hub */ 122 u_int8_t lowspeed; /* lowspeed flag */ 123 u_int8_t self_powered; /* flag for self powered */ 124 u_int16_t power; /* mA the device uses */ 125 int16_t langid; /* language for strings */ 126 #define USBD_NOLANG (-1) 127 usb_event_cookie_t cookie; /* unique connection id */ 128 struct usbd_port *powersrc; /* upstream hub port, or 0 */ 129 struct usbd_endpoint def_ep; /* for pipe 0 */ 130 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 131 struct usbd_interface *ifaces; /* array of all interfaces */ 132 usb_device_descriptor_t ddesc; /* device descriptor */ 133 usb_config_descriptor_t *cdesc; /* full config descr */ 134 struct usbd_quirks *quirks; /* device quirks, always set */ 135 struct usbd_hub *hub; /* only if this is a hub */ 136 device_ptr_t *subdevs; /* sub-devices, 0 terminated */ 137 }; 138 139 struct usbd_interface { 140 struct usbd_device *device; 141 usb_interface_descriptor_t *idesc; 142 int index; 143 int altindex; 144 struct usbd_endpoint *endpoints; 145 void *priv; 146 LIST_HEAD(, usbd_pipe) pipes; 147 }; 148 149 struct usbd_pipe { 150 struct usbd_interface *iface; 151 struct usbd_device *device; 152 struct usbd_endpoint *endpoint; 153 int refcnt; 154 char running; 155 SIMPLEQ_HEAD(, usbd_xfer) queue; 156 LIST_ENTRY(usbd_pipe) next; 157 158 usbd_xfer_handle intrxfer; /* used for repeating requests */ 159 char repeat; 160 161 /* Filled by HC driver. */ 162 struct usbd_pipe_methods *methods; 163 }; 164 165 struct usbd_xfer { 166 struct usbd_pipe *pipe; 167 void *priv; 168 void *buffer; 169 u_int32_t length; 170 u_int32_t actlen; 171 u_int16_t flags; 172 u_int32_t timeout; 173 usbd_status status; 174 usbd_callback callback; 175 __volatile char done; 176 177 /* For control pipe */ 178 usb_device_request_t request; 179 180 /* For isoc */ 181 u_int16_t *frlengths; 182 int nframes; 183 184 /* For memory allocation */ 185 struct usbd_device *device; 186 usb_dma_t dmabuf; 187 188 int rqflags; 189 #define URQ_REQUEST 0x01 190 #define URQ_AUTO_DMABUF 0x10 191 #define URQ_DEV_DMABUF 0x20 192 193 SIMPLEQ_ENTRY(usbd_xfer) next; 194 195 void *hcpriv; /* private use by the HC driver */ 196 int hcprivint; /* ditto */ 197 198 #if defined(__FreeBSD__) 199 struct callout_handle timo_handle; 200 #endif 201 }; 202 203 void usbd_init __P((void)); 204 void usbd_finish __P((void)); 205 206 /* Routines from usb_subr.c */ 207 int usbctlprint __P((void *, const char *)); 208 void usb_delay_ms __P((usbd_bus_handle, u_int)); 209 void usbd_devinfo_vp __P((usbd_device_handle, char *, char *)); 210 usbd_status usbd_reset_port __P((usbd_device_handle dev, 211 int port, usb_port_status_t *ps)); 212 usbd_status usbd_setup_pipe __P((usbd_device_handle dev, 213 usbd_interface_handle iface, 214 struct usbd_endpoint *, 215 usbd_pipe_handle *pipe)); 216 usbd_status usbd_new_device __P((device_ptr_t parent, 217 usbd_bus_handle bus, int depth, 218 int lowspeed, int port, 219 struct usbd_port *)); 220 void usbd_remove_device __P((usbd_device_handle, 221 struct usbd_port *)); 222 int usbd_printBCD __P((char *cp, int bcd)); 223 usbd_status usbd_fill_iface_data __P((usbd_device_handle dev, 224 int i, int a)); 225 void usb_free_device __P((usbd_device_handle)); 226 227 usbd_status usb_insert_transfer __P((usbd_xfer_handle xfer)); 228 void usb_transfer_complete __P((usbd_xfer_handle xfer)); 229 void usb_disconnect_port __P((struct usbd_port *up, device_ptr_t)); 230 231 /* Routines from usb.c */ 232 int usb_bus_count __P((void)); 233 void usb_needs_explore __P((usbd_bus_handle)); 234 235 #ifdef DIAGNOSTIC 236 #define SPLUSBCHECK \ 237 do { int _s = splusb(), _su = splusb(); \ 238 extern int cold; \ 239 if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \ 240 _s, _su, __FILE__, __LINE__); \ 241 splx(_s); \ 242 } while (0) 243 #else 244 #define SPLUSBCHECK 245 #endif 246 247 /* Locator stuff. */ 248 249 #if defined(__NetBSD__) 250 #include "locators.h" 251 #elif defined(__FreeBSD__) || defined(__OpenBSD__) 252 /* XXX these values are used to statically bind some elements in the USB tree 253 * to specific driver instances. This should be somehow emulated in FreeBSD 254 * but can be done later on. 255 * The values are copied from the files.usb file in the NetBSD sources. 256 */ 257 #define UHUBCF_PORT_DEFAULT -1 258 #define UHUBCF_CONFIGURATION_DEFAULT -1 259 #define UHUBCF_INTERFACE_DEFAULT -1 260 #define UHUBCF_VENDOR_DEFAULT -1 261 #define UHUBCF_PRODUCT_DEFAULT -1 262 #define UHUBCF_RELEASE_DEFAULT -1 263 #endif 264 265 #if defined (__OpenBSD__) 266 #define UHUBCF_PORT 0 267 #define UHUBCF_CONFIGURATION 1 268 #define UHUBCF_INTERFACE 2 269 #define UHUBCF_VENDOR 3 270 #define UHUBCF_PRODUCT 4 271 #define UHUBCF_RELEASE 5 272 #endif 273 274 #define uhubcf_port cf_loc[UHUBCF_PORT] 275 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION] 276 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE] 277 #define uhubcf_vendor cf_loc[UHUBCF_VENDOR] 278 #define uhubcf_product cf_loc[UHUBCF_PRODUCT] 279 #define uhubcf_release cf_loc[UHUBCF_RELEASE] 280 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */ 281 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 282 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 283 #define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */ 284 #define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */ 285 #define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */ 286 287
Indexes created Thu Sep 25 16:09:42 GMT 2025