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