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