usbdivar.h revision 1.17
1 /* $NetBSD: usbdivar.h,v 1.17 1999/01/10 19:13:16 augustss Exp $ */ 2 3 /* 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (augustss (at) carlstedt.se) at 9 * Carlstedt Research & Technology. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by the NetBSD 22 * Foundation, Inc. and its contributors. 23 * 4. Neither the name of The NetBSD Foundation nor the names of its 24 * contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37 * POSSIBILITY OF SUCH DAMAGE. 38 */ 39 40 struct usbd_request; 41 struct usbd_pipe; 42 43 struct usbd_endpoint { 44 usb_endpoint_descriptor_t *edesc; 45 usbd_endpoint_state state; 46 int refcnt; 47 int toggle; /* XXX */ 48 }; 49 50 typedef void (*usbd_xfercb)__P((usbd_request_handle req)); 51 52 struct usbd_methods { 53 usbd_status (*transfer)__P((usbd_request_handle reqh)); 54 usbd_status (*start)__P((usbd_request_handle reqh)); 55 void (*abort)__P((usbd_request_handle reqh)); 56 void (*close)__P((usbd_pipe_handle pipe)); 57 usbd_status (*isobuf)__P((usbd_pipe_handle pipe, 58 u_int32_t bufsize,u_int32_t nbuf)); 59 }; 60 61 struct usbd_port { 62 usb_port_status_t status; 63 u_int16_t power; /* mA of current on port */ 64 u_int8_t portno; 65 u_int8_t restartcnt; 66 #define USBD_RESTART_MAX 5 67 struct usbd_device *device; 68 struct usbd_device *parent; /* The ports hub */ 69 }; 70 71 struct usbd_hub { 72 usbd_status (*explore)__P((usbd_device_handle hub)); 73 void *hubsoftc; 74 usb_hub_descriptor_t hubdesc; 75 struct usbd_port ports[1]; 76 }; 77 78 struct usb_softc; 79 80 /*****/ 81 82 struct usbd_bus { 83 /* Filled by HC driver */ 84 bdevice bdev; /* base device, host adapter */ 85 usbd_status (*open_pipe)__P((struct usbd_pipe *pipe)); 86 u_int32_t pipe_size; /* size of a pipe struct */ 87 void (*do_poll)__P((struct usbd_bus *)); 88 /* Filled by usb driver */ 89 struct usbd_device *root_hub; 90 usbd_device_handle devices[USB_MAX_DEVICES]; 91 char needs_explore;/* a hub a signalled a change */ 92 char use_polling; 93 struct usb_softc *usbctl; 94 struct usb_device_stats stats; 95 }; 96 97 struct usbd_device { 98 struct usbd_bus *bus; 99 usbd_device_state state; 100 struct usbd_pipe *default_pipe; 101 u_int8_t address; 102 u_int8_t depth; 103 u_int8_t lowspeed; 104 u_int16_t power; 105 u_int8_t self_powered; 106 int config; 107 int langid; /* language to use for strings */ 108 #define USBD_NOLANG (-1) 109 struct usbd_port *powersrc; 110 struct usbd_endpoint def_ep; /* for pipe 0 */ 111 usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */ 112 struct usbd_interface *ifaces; 113 usb_device_descriptor_t ddesc; 114 usb_config_descriptor_t *cdesc; /* full config descr */ 115 struct usbd_quirks *quirks; 116 struct usbd_hub *hub; /* only if this is a hub */ 117 void *softc; /* device softc if attached */ 118 }; 119 120 struct usbd_interface { 121 struct usbd_device *device; 122 usbd_interface_state state; 123 usb_interface_descriptor_t *idesc; 124 int index; 125 int altindex; 126 struct usbd_endpoint *endpoints; 127 void *priv; 128 LIST_HEAD(, usbd_pipe) pipes; 129 }; 130 131 struct usbd_pipe { 132 struct usbd_interface *iface; 133 struct usbd_device *device; 134 struct usbd_endpoint *endpoint; 135 usbd_pipe_state state; 136 int32_t refcnt; 137 char running; 138 SIMPLEQ_HEAD(, usbd_request) queue; 139 LIST_ENTRY(usbd_pipe) next; 140 141 void (*disco) __P((void *)); 142 void *discoarg; 143 144 usbd_request_handle intrreqh; /* used for repeating requests */ 145 146 /* Filled by HC driver. */ 147 struct usbd_methods *methods; 148 }; 149 150 struct usbd_request { 151 struct usbd_pipe *pipe; 152 void *priv; 153 void *buffer; 154 u_int32_t length; 155 u_int32_t actlen; 156 u_int16_t flags; 157 u_int32_t timeout; 158 usbd_status status; 159 usbd_callback callback; 160 usbd_xfercb xfercb; 161 u_int32_t retries; 162 char done; 163 164 usb_device_request_t request; 165 u_int8_t isreq; 166 167 SIMPLEQ_ENTRY(usbd_request) next; 168 169 void *hcpriv; /* XXX private use by the HC driver */ 170 171 #if defined(__FreeBSD__) 172 struct callout_handle timo_handle; 173 #endif 174 }; 175 176 void usbd_init __P((void)); 177 178 /* Routines from usb_subr.c */ 179 int usbctlprint __P((void *, const char *)); 180 void usb_delay_ms __P((usbd_bus_handle, u_int)); 181 void usbd_devinfo_vp __P((usbd_device_handle, char *, char *)); 182 usbd_status usbd_reset_port __P((usbd_device_handle dev, 183 int port, usb_port_status_t *ps)); 184 usbd_status usbd_setup_pipe __P((usbd_device_handle dev, 185 usbd_interface_handle iface, 186 struct usbd_endpoint *, 187 usbd_pipe_handle *pipe)); 188 usbd_status usbd_new_device __P((bdevice *parent, 189 usbd_bus_handle bus, int depth, 190 int lowspeed, int port, 191 struct usbd_port *)); 192 void usbd_remove_device __P((usbd_device_handle, 193 struct usbd_port *)); 194 int usbd_printBCD __P((char *cp, int bcd)); 195 usbd_status usb_insert_transfer __P((usbd_request_handle reqh)); 196 void usb_start_next __P((usbd_pipe_handle pipe)); 197 usbd_status usbd_fill_iface_data __P((usbd_device_handle dev, 198 int i, int a)); 199 200 /* Routines from usb.c */ 201 int usb_bus_count __P((void)); 202 void usb_needs_explore __P((usbd_bus_handle)); 203 #if 0 204 usbd_status usb_get_bus_handle __P((int, usbd_bus_handle *)); 205 #endif 206 207 /* Locator stuff. */ 208 209 #if defined(__NetBSD__) 210 #include "locators.h" 211 #elif defined(__FreeBSD__) 212 /* XXX these values are used to statically bind some elements in the USB tree 213 * to specific driver instances. This should be somehow emulated in FreeBSD 214 * but can be done later on. 215 * The values are copied from the files.usb file in the NetBSD sources. 216 */ 217 #define UHUBCF_PORT_DEFAULT -1 218 #define UHUBCF_CONFIGURATION_DEFAULT -1 219 #define UHUBCF_INTERFACE_DEFAULT -1 220 #endif 221 222 #define uhubcf_port cf_loc[UHUBCF_PORT] 223 #define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION] 224 #define uhubcf_interface cf_loc[UHUBCF_INTERFACE] 225 #define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */ 226 #define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */ 227 #define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */ 228 229
Indexes created Tue Sep 23 23:09:58 GMT 2025