1 /* $OpenBSD: usbdi.h,v 1.25 2005/09/20 08:03:59 dlg Exp $ */ 2 /* $NetBSD: usbdi.h,v 1.62 2002/07/11 21:14:35 augustss Exp $ */ 3 /* $FreeBSD: src/sys/dev/usb/usbdi.h,v 1.18 1999/11/17 22:33:49 n_hibma Exp $ */ 4 5 /* 6 * Copyright (c) 1998 The NetBSD Foundation, Inc. 7 * All rights reserved. 8 * 9 * This code is derived from software contributed to The NetBSD Foundation 10 * by Lennart Augustsson (lennart@augustsson.net) at 11 * Carlstedt Research & Technology. 12 * 13 * Redistribution and use in source and binary forms, with or without 14 * modification, are permitted provided that the following conditions 15 * are met: 16 * 1. Redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer. 18 * 2. Redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution. 21 * 3. All advertising materials mentioning features or use of this software 22 * must display the following acknowledgement: 23 * This product includes software developed by the NetBSD 24 * Foundation, Inc. and its contributors. 25 * 4. Neither the name of The NetBSD Foundation nor the names of its 26 * contributors may be used to endorse or promote products derived 27 * from this software without specific prior written permission. 28 * 29 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 30 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 31 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 32 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 33 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 34 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 35 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 36 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 37 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 39 * POSSIBILITY OF SUCH DAMAGE. 40 */ 41 42 typedef struct usbd_bus *usbd_bus_handle; 43 typedef struct usbd_device *usbd_device_handle; 44 typedef struct usbd_interface *usbd_interface_handle; 45 typedef struct usbd_pipe *usbd_pipe_handle; 46 typedef struct usbd_xfer *usbd_xfer_handle; 47 typedef void *usbd_private_handle; 48 49 typedef enum { /* keep in sync with usbd_status_msgs */ 50 USBD_NORMAL_COMPLETION = 0, /* must be 0 */ 51 USBD_IN_PROGRESS, /* 1 */ 52 /* errors */ 53 USBD_PENDING_REQUESTS, /* 2 */ 54 USBD_NOT_STARTED, /* 3 */ 55 USBD_INVAL, /* 4 */ 56 USBD_NOMEM, /* 5 */ 57 USBD_CANCELLED, /* 6 */ 58 USBD_BAD_ADDRESS, /* 7 */ 59 USBD_IN_USE, /* 8 */ 60 USBD_NO_ADDR, /* 9 */ 61 USBD_SET_ADDR_FAILED, /* 10 */ 62 USBD_NO_POWER, /* 11 */ 63 USBD_TOO_DEEP, /* 12 */ 64 USBD_IOERROR, /* 13 */ 65 USBD_NOT_CONFIGURED, /* 14 */ 66 USBD_TIMEOUT, /* 15 */ 67 USBD_SHORT_XFER, /* 16 */ 68 USBD_STALLED, /* 17 */ 69 USBD_INTERRUPTED, /* 18 */ 70 71 USBD_ERROR_MAX /* must be last */ 72 } usbd_status; 73 74 typedef void (*usbd_callback)(usbd_xfer_handle, usbd_private_handle, 75 usbd_status); 76 77 /* Open flags */ 78 #define USBD_EXCLUSIVE_USE 0x01 79 80 /* Use default (specified by ep. desc.) interval on interrupt pipe */ 81 #define USBD_DEFAULT_INTERVAL (-1) 82 83 /* Request flags */ 84 #define USBD_NO_COPY 0x01 /* do not copy data to DMA buffer */ 85 #define USBD_SYNCHRONOUS 0x02 /* wait for completion */ 86 /* in usb.h #define USBD_SHORT_XFER_OK 0x04*/ /* allow short reads */ 87 #define USBD_FORCE_SHORT_XFER 0x08 /* force last short packet on write */ 88 89 #define USBD_NO_TIMEOUT 0 90 #define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */ 91 92 #if defined(__FreeBSD__) 93 #define USB_CDEV_MAJOR 108 94 #endif 95 96 usbd_status usbd_open_pipe(usbd_interface_handle iface, u_int8_t address, 97 u_int8_t flags, usbd_pipe_handle *pipe); 98 usbd_status usbd_close_pipe(usbd_pipe_handle pipe); 99 usbd_status usbd_transfer(usbd_xfer_handle req); 100 usbd_xfer_handle usbd_alloc_xfer(usbd_device_handle); 101 usbd_status usbd_free_xfer(usbd_xfer_handle xfer); 102 void usbd_setup_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe, 103 usbd_private_handle priv, void *buffer, 104 u_int32_t length, u_int16_t flags, u_int32_t timeout, 105 usbd_callback); 106 void usbd_setup_default_xfer(usbd_xfer_handle xfer, usbd_device_handle dev, 107 usbd_private_handle priv, u_int32_t timeout, 108 usb_device_request_t *req, void *buffer, 109 u_int32_t length, u_int16_t flags, usbd_callback); 110 void usbd_setup_isoc_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe, 111 usbd_private_handle priv, u_int16_t *frlengths, 112 u_int32_t nframes, u_int16_t flags, usbd_callback); 113 void usbd_get_xfer_status(usbd_xfer_handle xfer, usbd_private_handle *priv, 114 void **buffer, u_int32_t *count, usbd_status *status); 115 usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor 116 (usbd_interface_handle iface, u_int8_t address); 117 usbd_status usbd_abort_pipe(usbd_pipe_handle pipe); 118 usbd_status usbd_clear_endpoint_stall(usbd_pipe_handle pipe); 119 usbd_status usbd_clear_endpoint_stall_async(usbd_pipe_handle pipe); 120 void usbd_clear_endpoint_toggle(usbd_pipe_handle pipe); 121 usbd_status usbd_endpoint_count(usbd_interface_handle dev, u_int8_t *count); 122 usbd_status usbd_interface_count(usbd_device_handle dev, u_int8_t *count); 123 void usbd_interface2device_handle(usbd_interface_handle iface, 124 usbd_device_handle *dev); 125 usbd_status usbd_device2interface_handle(usbd_device_handle dev, 126 u_int8_t ifaceno, usbd_interface_handle *iface); 127 128 usbd_device_handle usbd_pipe2device_handle(usbd_pipe_handle); 129 void *usbd_alloc_buffer(usbd_xfer_handle xfer, u_int32_t size); 130 void usbd_free_buffer(usbd_xfer_handle xfer); 131 void *usbd_get_buffer(usbd_xfer_handle xfer); 132 usbd_status usbd_sync_transfer(usbd_xfer_handle req); 133 usbd_status usbd_open_pipe_intr(usbd_interface_handle iface, u_int8_t address, 134 u_int8_t flags, usbd_pipe_handle *pipe, 135 usbd_private_handle priv, void *buffer, 136 u_int32_t length, usbd_callback, int); 137 usbd_status usbd_do_request(usbd_device_handle pipe, usb_device_request_t *req, 138 void *data); 139 usbd_status usbd_do_request_async(usbd_device_handle pipe, 140 usb_device_request_t *req, void *data); 141 usbd_status usbd_do_request_flags(usbd_device_handle pipe, 142 usb_device_request_t *req, 143 void *data, u_int16_t flags, int*, u_int32_t); 144 usbd_status usbd_do_request_flags_pipe( 145 usbd_device_handle dev, usbd_pipe_handle pipe, 146 usb_device_request_t *req, void *data, u_int16_t flags, int *actlen, 147 u_int32_t); 148 usb_interface_descriptor_t *usbd_get_interface_descriptor 149 (usbd_interface_handle iface); 150 usb_config_descriptor_t *usbd_get_config_descriptor(usbd_device_handle dev); 151 usb_device_descriptor_t *usbd_get_device_descriptor(usbd_device_handle dev); 152 usbd_status usbd_set_interface(usbd_interface_handle, int); 153 int usbd_get_no_alts(usb_config_descriptor_t *, int); 154 usbd_status usbd_get_interface(usbd_interface_handle iface, u_int8_t *aiface); 155 void usbd_fill_deviceinfo(usbd_device_handle, struct usb_device_info *, int); 156 int usbd_get_interface_altindex(usbd_interface_handle iface); 157 158 usb_interface_descriptor_t *usbd_find_idesc(usb_config_descriptor_t *cd, 159 int iindex, int ano); 160 usb_endpoint_descriptor_t *usbd_find_edesc(usb_config_descriptor_t *cd, 161 int ifaceidx, int altidx, 162 int endptidx); 163 164 void usbd_dopoll(usbd_interface_handle); 165 void usbd_set_polling(usbd_device_handle iface, int on); 166 167 const char *usbd_errstr(usbd_status err); 168 169 void usbd_add_dev_event(int, usbd_device_handle); 170 void usbd_add_drv_event(int, usbd_device_handle, device_ptr_t); 171 172 void usbd_devinfo(usbd_device_handle, int, char *, size_t); 173 const struct usbd_quirks *usbd_get_quirks(usbd_device_handle); 174 usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor 175 (usbd_interface_handle iface, u_int8_t address); 176 177 usbd_status usbd_reload_device_desc(usbd_device_handle); 178 179 int usbd_ratecheck(struct timeval *last); 180 181 /* An iterator for descriptors. */ 182 typedef struct { 183 const uByte *cur; 184 const uByte *end; 185 } usbd_desc_iter_t; 186 void usb_desc_iter_init(usbd_device_handle, usbd_desc_iter_t *); 187 const usb_descriptor_t *usb_desc_iter_next(usbd_desc_iter_t *); 188 189 /* 190 * The usb_task structs form a queue of things to run in the USB event 191 * thread. Normally this is just device discovery when a connect/disconnect 192 * has been detected. But it may also be used by drivers that need to 193 * perform (short) tasks that must have a process context. 194 */ 195 struct usb_task { 196 TAILQ_ENTRY(usb_task) next; 197 void (*fun)(void *); 198 void *arg; 199 char onqueue; 200 }; 201 202 void usb_add_task(usbd_device_handle dev, struct usb_task *task); 203 void usb_rem_task(usbd_device_handle dev, struct usb_task *task); 204 #define usb_init_task(t, f, a) ((t)->fun = (f), (t)->arg = (a), (t)->onqueue = 0) 205 206 struct usb_devno { 207 u_int16_t ud_vendor; 208 u_int16_t ud_product; 209 }; 210 const struct usb_devno *usb_match_device(const struct usb_devno *tbl, 211 u_int nentries, u_int sz, u_int16_t vendor, u_int16_t product); 212 #define usb_lookup(tbl, vendor, product) \ 213 usb_match_device((const struct usb_devno *)(tbl), sizeof (tbl) / sizeof ((tbl)[0]), sizeof ((tbl)[0]), (vendor), (product)) 214 #define USB_PRODUCT_ANY 0xffff 215 216 /* NetBSD attachment information */ 217 218 /* Attach data */ 219 struct usb_attach_arg { 220 int port; 221 int configno; 222 int ifaceno; 223 int vendor; 224 int product; 225 int release; 226 int matchlvl; 227 usbd_device_handle device; /* current device */ 228 usbd_interface_handle iface; /* current interface */ 229 int usegeneric; 230 usbd_interface_handle *ifaces; /* all interfaces */ 231 int nifaces; /* number of interfaces */ 232 }; 233 234 #if defined(__NetBSD__) || defined(__OpenBSD__) 235 /* Match codes. */ 236 /* First five codes is for a whole device. */ 237 #define UMATCH_VENDOR_PRODUCT_REV 14 238 #define UMATCH_VENDOR_PRODUCT 13 239 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO 12 240 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO 11 241 #define UMATCH_DEVCLASS_DEVSUBCLASS 10 242 /* Next six codes are for interfaces. */ 243 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE 9 244 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE 8 245 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO 7 246 #define UMATCH_VENDOR_IFACESUBCLASS 6 247 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO 5 248 #define UMATCH_IFACECLASS_IFACESUBCLASS 4 249 #define UMATCH_IFACECLASS 3 250 #define UMATCH_IFACECLASS_GENERIC 2 251 /* Generic driver */ 252 #define UMATCH_GENERIC 1 253 /* No match */ 254 #define UMATCH_NONE 0 255 256 #elif defined(__FreeBSD__) 257 /* FreeBSD needs values less than zero */ 258 #define UMATCH_VENDOR_PRODUCT_REV (-10) 259 #define UMATCH_VENDOR_PRODUCT (-20) 260 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO (-30) 261 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO (-40) 262 #define UMATCH_DEVCLASS_DEVSUBCLASS (-50) 263 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE (-60) 264 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE (-70) 265 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO (-80) 266 #define UMATCH_VENDOR_IFACESUBCLASS (-90) 267 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO (-100) 268 #define UMATCH_IFACECLASS_IFACESUBCLASS (-110) 269 #define UMATCH_IFACECLASS (-120) 270 #define UMATCH_IFACECLASS_GENERIC (-130) 271 #define UMATCH_GENERIC (-140) 272 #define UMATCH_NONE (ENXIO) 273 274 #endif 275 276 #if defined(__FreeBSD__) 277 int usbd_driver_load(module_t mod, int what, void *arg); 278 #endif 279 280 /* XXX Perhaps USB should have its own levels? */ 281 #ifdef USB_USE_SOFTINTR 282 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS 283 #define splusb splsoftnet 284 #else 285 #define splusb splsoftclock 286 #endif /* __HAVE_GENERIC_SOFT_INTERRUPTS */ 287 #else 288 #define splusb splbio 289 #endif /* USB_USE_SOFTINTR */ 290 #define splhardusb splbio 291 #define IPL_USB IPL_BIO 292