1 /* $NetBSD: usbdi.h,v 1.64 2004/10/23 13:26:34 augustss Exp $ */ 2 /* $FreeBSD$ */ 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@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 typedef struct usbd_bus *usbd_bus_handle; 42 typedef struct usbd_device *usbd_device_handle; 43 typedef struct usbd_interface *usbd_interface_handle; 44 typedef struct usbd_pipe *usbd_pipe_handle; 45 typedef struct usbd_xfer *usbd_xfer_handle; 46 typedef void *usbd_private_handle; 47 48 typedef enum { /* keep in sync with usbd_status_msgs */ 49 USBD_NORMAL_COMPLETION = 0, /* must be 0 */ 50 USBD_IN_PROGRESS, /* 1 */ 51 /* errors */ 52 USBD_PENDING_REQUESTS, /* 2 */ 53 USBD_NOT_STARTED, /* 3 */ 54 USBD_INVAL, /* 4 */ 55 USBD_NOMEM, /* 5 */ 56 USBD_CANCELLED, /* 6 */ 57 USBD_BAD_ADDRESS, /* 7 */ 58 USBD_IN_USE, /* 8 */ 59 USBD_NO_ADDR, /* 9 */ 60 USBD_SET_ADDR_FAILED, /* 10 */ 61 USBD_NO_POWER, /* 11 */ 62 USBD_TOO_DEEP, /* 12 */ 63 USBD_IOERROR, /* 13 */ 64 USBD_NOT_CONFIGURED, /* 14 */ 65 USBD_TIMEOUT, /* 15 */ 66 USBD_SHORT_XFER, /* 16 */ 67 USBD_STALLED, /* 17 */ 68 USBD_INTERRUPTED, /* 18 */ 69 70 USBD_ERROR_MAX /* must be last */ 71 } usbd_status; 72 73 typedef void (*usbd_callback)(usbd_xfer_handle, usbd_private_handle, 74 usbd_status); 75 76 /* Open flags */ 77 #define USBD_EXCLUSIVE_USE 0x01 78 79 /* Use default (specified by ep. desc.) interval on interrupt pipe */ 80 #define USBD_DEFAULT_INTERVAL (-1) 81 82 /* Request flags */ 83 #define USBD_NO_COPY 0x01 /* do not copy data to DMA buffer */ 84 #define USBD_SYNCHRONOUS 0x02 /* wait for completion */ 85 /* in usb.h #define USBD_SHORT_XFER_OK 0x04*/ /* allow short reads */ 86 #define USBD_FORCE_SHORT_XFER 0x08 /* force last short packet on write */ 87 88 #define USBD_NO_TIMEOUT 0 89 #define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */ 90 91 usbd_status usbd_open_pipe(usbd_interface_handle, u_int8_t, 92 u_int8_t, usbd_pipe_handle *); 93 usbd_status usbd_close_pipe(usbd_pipe_handle); 94 usbd_status usbd_transfer(usbd_xfer_handle); 95 usbd_xfer_handle usbd_alloc_xfer(usbd_device_handle); 96 usbd_status usbd_free_xfer(usbd_xfer_handle); 97 void usbd_setup_xfer(usbd_xfer_handle, usbd_pipe_handle, 98 usbd_private_handle, void *, 99 u_int32_t, u_int16_t, u_int32_t, 100 usbd_callback); 101 void usbd_setup_default_xfer(usbd_xfer_handle, usbd_device_handle, 102 usbd_private_handle, u_int32_t, 103 usb_device_request_t *, void *, 104 u_int32_t, u_int16_t, usbd_callback); 105 void usbd_setup_isoc_xfer(usbd_xfer_handle, usbd_pipe_handle, 106 usbd_private_handle, u_int16_t *, 107 u_int32_t, u_int16_t, usbd_callback); 108 void usbd_get_xfer_status(usbd_xfer_handle, usbd_private_handle *, 109 void **, u_int32_t *, usbd_status *); 110 usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor 111 (usbd_interface_handle, u_int8_t); 112 usbd_status usbd_abort_pipe(usbd_pipe_handle); 113 usbd_status usbd_abort_default_pipe(usbd_device_handle); 114 usbd_status usbd_clear_endpoint_stall(usbd_pipe_handle); 115 usbd_status usbd_clear_endpoint_stall_async(usbd_pipe_handle); 116 void usbd_clear_endpoint_toggle(usbd_pipe_handle); 117 usbd_status usbd_endpoint_count(usbd_interface_handle, u_int8_t *); 118 usbd_status usbd_interface_count(usbd_device_handle, u_int8_t *); 119 void usbd_interface2device_handle(usbd_interface_handle, 120 usbd_device_handle *); 121 usbd_status usbd_device2interface_handle(usbd_device_handle, 122 u_int8_t, usbd_interface_handle *); 123 124 usbd_device_handle usbd_pipe2device_handle(usbd_pipe_handle); 125 void *usbd_alloc_buffer(usbd_xfer_handle, u_int32_t); 126 void usbd_free_buffer(usbd_xfer_handle); 127 void *usbd_get_buffer(usbd_xfer_handle); 128 usbd_status usbd_sync_transfer(usbd_xfer_handle); 129 usbd_status usbd_open_pipe_intr(usbd_interface_handle, u_int8_t, 130 u_int8_t, usbd_pipe_handle *, 131 usbd_private_handle, void *, 132 u_int32_t, usbd_callback, int); 133 usbd_status usbd_do_request(usbd_device_handle, usb_device_request_t *, void *); 134 usbd_status usbd_do_request_async(usbd_device_handle, 135 usb_device_request_t *, void *); 136 usbd_status usbd_do_request_flags(usbd_device_handle, usb_device_request_t *, 137 void *, u_int16_t, int*, u_int32_t); 138 usbd_status usbd_do_request_flags_pipe(usbd_device_handle, usbd_pipe_handle, 139 usb_device_request_t *, void *, u_int16_t, int *, u_int32_t); 140 usb_interface_descriptor_t *usbd_get_interface_descriptor 141 (usbd_interface_handle); 142 usb_config_descriptor_t *usbd_get_config_descriptor(usbd_device_handle); 143 usb_device_descriptor_t *usbd_get_device_descriptor(usbd_device_handle); 144 int usbd_get_speed(usbd_device_handle); 145 usbd_status usbd_set_interface(usbd_interface_handle, int); 146 int usbd_get_no_alts(usb_config_descriptor_t *, int); 147 usbd_status usbd_get_interface(usbd_interface_handle, u_int8_t *); 148 void usbd_fill_deviceinfo(usbd_device_handle, struct usb_device_info *, int); 149 int usbd_get_interface_altindex(usbd_interface_handle); 150 151 usb_interface_descriptor_t *usbd_find_idesc(usb_config_descriptor_t *, 152 int, int); 153 usb_endpoint_descriptor_t *usbd_find_edesc(usb_config_descriptor_t *, 154 int, int, int); 155 156 void usbd_dopoll(usbd_interface_handle); 157 void usbd_set_polling(usbd_device_handle, int); 158 159 const char *usbd_errstr(usbd_status); 160 161 void usbd_add_dev_event(int, usbd_device_handle); 162 void usbd_add_drv_event(int, usbd_device_handle, device_ptr_t); 163 164 void usbd_devinfo(usbd_device_handle, int, char *); 165 const struct usbd_quirks *usbd_get_quirks(usbd_device_handle); 166 usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor 167 (usbd_interface_handle, u_int8_t); 168 169 usbd_status usbd_reload_device_desc(usbd_device_handle); 170 171 int usbd_ratecheck(struct timeval *last); 172 173 usbd_status usbd_get_string(usbd_device_handle dev, int si, char *buf); 174 175 /* An iterator for descriptors. */ 176 typedef struct { 177 const uByte *cur; 178 const uByte *end; 179 } usbd_desc_iter_t; 180 void usb_desc_iter_init(usbd_device_handle dev, usbd_desc_iter_t *iter); 181 const usb_descriptor_t *usb_desc_iter_next(usbd_desc_iter_t *iter); 182 183 /* 184 * The usb_task structs form a queue of things to run in the USB event 185 * thread. Normally this is just device discovery when a connect/disconnect 186 * has been detected. But it may also be used by drivers that need to 187 * perform (short) tasks that must have a process context. 188 */ 189 struct usb_task { 190 TAILQ_ENTRY(usb_task) next; 191 void (*fun)(void *); 192 void *arg; 193 char onqueue; 194 }; 195 196 void usb_add_task(usbd_device_handle, struct usb_task *); 197 void usb_rem_task(usbd_device_handle, struct usb_task *); 198 #define usb_init_task(t, f, a) ((t)->fun = (f), (t)->arg = (a), (t)->onqueue = 0) 199 200 struct usb_devno { 201 u_int16_t ud_vendor; 202 u_int16_t ud_product; 203 }; 204 const struct usb_devno *usb_match_device(const struct usb_devno *, 205 u_int, u_int, u_int16_t, u_int16_t); 206 #define usb_lookup(tbl, vendor, product) \ 207 usb_match_device((const struct usb_devno *)(tbl), sizeof (tbl) / sizeof ((tbl)[0]), sizeof ((tbl)[0]), (vendor), (product)) 208 #define USB_PRODUCT_ANY 0xffff 209 210 /* NetBSD attachment information */ 211 212 /* Attach data */ 213 struct usb_attach_arg { 214 int port; 215 int configno; 216 int ifaceno; 217 int vendor; 218 int product; 219 int release; 220 int matchlvl; 221 usbd_device_handle device; /* current device */ 222 usbd_interface_handle iface; /* current interface */ 223 int usegeneric; 224 usbd_interface_handle *ifaces; /* all interfaces */ 225 int nifaces; /* number of interfaces */ 226 }; 227 228 #if defined(__NetBSD__) || defined(__OpenBSD__) 229 /* Match codes. */ 230 /* First five codes is for a whole device. */ 231 #define UMATCH_VENDOR_PRODUCT_REV 14 232 #define UMATCH_VENDOR_PRODUCT 13 233 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO 12 234 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO 11 235 #define UMATCH_DEVCLASS_DEVSUBCLASS 10 236 /* Next six codes are for interfaces. */ 237 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE 9 238 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE 8 239 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO 7 240 #define UMATCH_VENDOR_IFACESUBCLASS 6 241 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO 5 242 #define UMATCH_IFACECLASS_IFACESUBCLASS 4 243 #define UMATCH_IFACECLASS 3 244 #define UMATCH_IFACECLASS_GENERIC 2 245 /* Generic driver */ 246 #define UMATCH_GENERIC 1 247 /* No match */ 248 #define UMATCH_NONE 0 249 250 #elif defined(__FreeBSD__) 251 /* FreeBSD needs values less than zero */ 252 #define UMATCH_VENDOR_PRODUCT_REV (-10) 253 #define UMATCH_VENDOR_PRODUCT (-20) 254 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO (-30) 255 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO (-40) 256 #define UMATCH_DEVCLASS_DEVSUBCLASS (-50) 257 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE (-60) 258 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE (-70) 259 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO (-80) 260 #define UMATCH_VENDOR_IFACESUBCLASS (-90) 261 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO (-100) 262 #define UMATCH_IFACECLASS_IFACESUBCLASS (-110) 263 #define UMATCH_IFACECLASS (-120) 264 #define UMATCH_IFACECLASS_GENERIC (-130) 265 #define UMATCH_GENERIC (-140) 266 #define UMATCH_NONE (ENXIO) 267 268 #endif 269 270 #define USBD_SHOW_DEVICE_CLASS 0x1 271 #define USBD_SHOW_INTERFACE_CLASS 0x2 272 273 #if defined(__FreeBSD__) 274 int usbd_driver_load(module_t mod, int what, void *arg); 275 #endif 276 277 /* XXX Perhaps USB should have its own levels? */ 278 #ifdef USB_USE_SOFTINTR 279 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS 280 #define splusb splsoftnet 281 #else 282 #define splusb splsoftclock 283 #endif /* __HAVE_GENERIC_SOFT_INTERRUPTS */ 284 #else 285 #define splusb splbio 286 #endif /* USB_USE_SOFTINTR */ 287 #define splhardusb splbio 288 #define IPL_USB IPL_BIO 289