1 /* $NetBSD: usbdi.h,v 1.56 2001/12/03 01:47:12 augustss Exp $ */ 2 /* $FreeBSD: src/sys/dev/usb/usbdi.h,v 1.18 1999/11/17 22:33:49 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 (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, 51 /* errors */ 52 USBD_PENDING_REQUESTS, 53 USBD_NOT_STARTED, 54 USBD_INVAL, 55 USBD_NOMEM, 56 USBD_CANCELLED, 57 USBD_BAD_ADDRESS, 58 USBD_IN_USE, 59 USBD_NO_ADDR, 60 USBD_SET_ADDR_FAILED, 61 USBD_NO_POWER, 62 USBD_TOO_DEEP, 63 USBD_IOERROR, 64 USBD_NOT_CONFIGURED, 65 USBD_TIMEOUT, 66 USBD_SHORT_XFER, 67 USBD_STALLED, 68 USBD_INTERRUPTED, 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 #if defined(__FreeBSD__) 92 #define USB_CDEV_MAJOR 108 93 #endif 94 95 usbd_status usbd_open_pipe(usbd_interface_handle iface, u_int8_t address, 96 u_int8_t flags, usbd_pipe_handle *pipe); 97 usbd_status usbd_close_pipe(usbd_pipe_handle pipe); 98 usbd_status usbd_transfer(usbd_xfer_handle req); 99 usbd_xfer_handle usbd_alloc_xfer(usbd_device_handle); 100 usbd_status usbd_free_xfer(usbd_xfer_handle xfer); 101 void usbd_setup_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe, 102 usbd_private_handle priv, void *buffer, 103 u_int32_t length, u_int16_t flags, u_int32_t timeout, 104 usbd_callback); 105 void usbd_setup_default_xfer(usbd_xfer_handle xfer, usbd_device_handle dev, 106 usbd_private_handle priv, u_int32_t timeout, 107 usb_device_request_t *req, void *buffer, 108 u_int32_t length, u_int16_t flags, usbd_callback); 109 void usbd_setup_isoc_xfer(usbd_xfer_handle xfer, usbd_pipe_handle pipe, 110 usbd_private_handle priv, u_int16_t *frlengths, 111 u_int32_t nframes, u_int16_t flags, usbd_callback); 112 void usbd_get_xfer_status(usbd_xfer_handle xfer, usbd_private_handle *priv, 113 void **buffer, u_int32_t *count, usbd_status *status); 114 usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor 115 (usbd_interface_handle iface, u_int8_t address); 116 usbd_status usbd_abort_pipe(usbd_pipe_handle pipe); 117 usbd_status usbd_clear_endpoint_stall(usbd_pipe_handle pipe); 118 usbd_status usbd_clear_endpoint_stall_async(usbd_pipe_handle pipe); 119 usbd_status usbd_endpoint_count(usbd_interface_handle dev, u_int8_t *count); 120 usbd_status usbd_interface_count(usbd_device_handle dev, u_int8_t *count); 121 void usbd_interface2device_handle(usbd_interface_handle iface, 122 usbd_device_handle *dev); 123 usbd_status usbd_device2interface_handle(usbd_device_handle dev, 124 u_int8_t ifaceno, usbd_interface_handle *iface); 125 126 usbd_device_handle usbd_pipe2device_handle(usbd_pipe_handle); 127 void *usbd_alloc_buffer(usbd_xfer_handle req, u_int32_t size); 128 void usbd_free_buffer(usbd_xfer_handle req); 129 void *usbd_get_buffer(usbd_xfer_handle xfer); 130 usbd_status usbd_sync_transfer(usbd_xfer_handle req); 131 usbd_status usbd_open_pipe_intr(usbd_interface_handle iface, u_int8_t address, 132 u_int8_t flags, usbd_pipe_handle *pipe, 133 usbd_private_handle priv, void *buffer, 134 u_int32_t length, usbd_callback, int); 135 usbd_status usbd_do_request(usbd_device_handle pipe, usb_device_request_t *req, 136 void *data); 137 usbd_status usbd_do_request_async(usbd_device_handle pipe, 138 usb_device_request_t *req, void *data); 139 usbd_status usbd_do_request_flags(usbd_device_handle pipe, 140 usb_device_request_t *req, 141 void *data, u_int16_t flags, int *); 142 usbd_status usbd_do_request_flags_pipe( 143 usbd_device_handle dev, usbd_pipe_handle pipe, 144 usb_device_request_t *req, void *data, u_int16_t flags, int *actlen); 145 usb_interface_descriptor_t *usbd_get_interface_descriptor 146 (usbd_interface_handle iface); 147 usb_config_descriptor_t *usbd_get_config_descriptor(usbd_device_handle dev); 148 usb_device_descriptor_t *usbd_get_device_descriptor(usbd_device_handle dev); 149 usbd_status usbd_set_interface(usbd_interface_handle, int); 150 int usbd_get_no_alts(usb_config_descriptor_t *, int); 151 usbd_status usbd_get_interface(usbd_interface_handle iface, u_int8_t *aiface); 152 void usbd_fill_deviceinfo(usbd_device_handle dev, struct usb_device_info *di, int); 153 int usbd_get_interface_altindex(usbd_interface_handle iface); 154 155 usb_interface_descriptor_t *usbd_find_idesc(usb_config_descriptor_t *cd, 156 int iindex, int ano); 157 usb_endpoint_descriptor_t *usbd_find_edesc(usb_config_descriptor_t *cd, 158 int ifaceidx, int altidx, 159 int endptidx); 160 161 void usbd_dopoll(usbd_interface_handle); 162 void usbd_set_polling(usbd_device_handle iface, int on); 163 164 const char *usbd_errstr(usbd_status err); 165 166 void usbd_add_dev_event(int, usbd_device_handle); 167 void usbd_add_drv_event(int, usbd_device_handle, device_ptr_t); 168 169 void usbd_devinfo(usbd_device_handle, int, char *); 170 const struct usbd_quirks *usbd_get_quirks(usbd_device_handle); 171 usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor 172 (usbd_interface_handle iface, u_int8_t address); 173 174 usbd_status usbd_reload_device_desc(usbd_device_handle); 175 176 int usbd_ratecheck(struct timeval *last); 177 178 /* 179 * The usb_task structs form a queue of things to run in the USB event 180 * thread. Normally this is just device discovery when a connect/disconnect 181 * has been detected. But it may also be used by drivers that need to 182 * perform (short) tasks that must have a process context. 183 */ 184 struct usb_task { 185 TAILQ_ENTRY(usb_task) next; 186 void (*fun)(void *); 187 void *arg; 188 char onqueue; 189 }; 190 191 void usb_add_task(usbd_device_handle dev, struct usb_task *task); 192 void usb_rem_task(usbd_device_handle dev, struct usb_task *task); 193 #define usb_init_task(t, f, a) ((t)->fun = (f), (t)->arg = (a), (t)->onqueue = 0) 194 195 struct usb_devno { 196 u_int16_t ud_vendor; 197 u_int16_t ud_product; 198 }; 199 const struct usb_devno *usb_match_device(const struct usb_devno *tbl, 200 u_int nentries, u_int sz, u_int16_t vendor, u_int16_t product); 201 #define usb_lookup(tbl, vendor, product) \ 202 usb_match_device((const struct usb_devno *)(tbl), sizeof (tbl) / sizeof ((tbl)[0]), sizeof ((tbl)[0]), (vendor), (product)) 203 204 /* NetBSD attachment information */ 205 206 /* Attach data */ 207 struct usb_attach_arg { 208 int port; 209 int configno; 210 int ifaceno; 211 int vendor; 212 int product; 213 int release; 214 int matchlvl; 215 usbd_device_handle device; /* current device */ 216 usbd_interface_handle iface; /* current interface */ 217 int usegeneric; 218 usbd_interface_handle *ifaces; /* all interfaces */ 219 int nifaces; /* number of interfaces */ 220 }; 221 222 #if defined(__NetBSD__) || defined(__OpenBSD__) 223 /* Match codes. */ 224 /* First five codes is for a whole device. */ 225 #define UMATCH_VENDOR_PRODUCT_REV 14 226 #define UMATCH_VENDOR_PRODUCT 13 227 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO 12 228 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO 11 229 #define UMATCH_DEVCLASS_DEVSUBCLASS 10 230 /* Next six codes are for interfaces. */ 231 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE 9 232 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE 8 233 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO 7 234 #define UMATCH_VENDOR_IFACESUBCLASS 6 235 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO 5 236 #define UMATCH_IFACECLASS_IFACESUBCLASS 4 237 #define UMATCH_IFACECLASS 3 238 #define UMATCH_IFACECLASS_GENERIC 2 239 /* Generic driver */ 240 #define UMATCH_GENERIC 1 241 /* No match */ 242 #define UMATCH_NONE 0 243 244 #elif defined(__FreeBSD__) 245 /* FreeBSD needs values less than zero */ 246 #define UMATCH_VENDOR_PRODUCT_REV (-10) 247 #define UMATCH_VENDOR_PRODUCT (-20) 248 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO (-30) 249 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO (-40) 250 #define UMATCH_DEVCLASS_DEVSUBCLASS (-50) 251 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE (-60) 252 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE (-70) 253 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO (-80) 254 #define UMATCH_VENDOR_IFACESUBCLASS (-90) 255 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO (-100) 256 #define UMATCH_IFACECLASS_IFACESUBCLASS (-110) 257 #define UMATCH_IFACECLASS (-120) 258 #define UMATCH_IFACECLASS_GENERIC (-130) 259 #define UMATCH_GENERIC (-140) 260 #define UMATCH_NONE (ENXIO) 261 262 #endif 263 264 #if defined(__FreeBSD__) 265 int usbd_driver_load(module_t mod, int what, void *arg); 266 #endif 267 268 /* XXX Perhaps USB should have its own levels? */ 269 #ifdef USB_USE_SOFTINTR 270 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS 271 #define splusb splsoftnet 272 #else 273 #define splusb splsoftclock 274 #endif /* __HAVE_GENERIC_SOFT_INTERRUPTS */ 275 #else 276 #define splusb splbio 277 #endif /* USB_USE_SOFTINTR */ 278 #define splhardusb splbio 279 #define IPL_USB IPL_BIO 280