usbdi.h revision 1.41
1 /* $NetBSD: usbdi.h,v 1.41 2000/03/02 12:37:51 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 (augustss (at) carlstedt.se) 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) __P((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 /* XXX Temporary hack XXX */ 89 #define USBD_NO_TSLEEP 0x80 /* XXX use busy wait */ 90 91 #define USBD_NO_TIMEOUT 0 92 #define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */ 93 94 #if defined(__FreeBSD__) 95 #define USB_CDEV_MAJOR 108 96 #endif 97 98 usbd_status usbd_open_pipe 99 __P((usbd_interface_handle iface, u_int8_t address, 100 u_int8_t flags, usbd_pipe_handle *pipe)); 101 usbd_status usbd_close_pipe __P((usbd_pipe_handle pipe)); 102 usbd_status usbd_transfer __P((usbd_xfer_handle req)); 103 usbd_xfer_handle usbd_alloc_xfer __P((usbd_device_handle)); 104 usbd_status usbd_free_xfer __P((usbd_xfer_handle xfer)); 105 void usbd_setup_xfer 106 __P((usbd_xfer_handle xfer, usbd_pipe_handle pipe, 107 usbd_private_handle priv, void *buffer, 108 u_int32_t length, u_int16_t flags, u_int32_t timeout, 109 usbd_callback)); 110 void usbd_setup_default_xfer 111 __P((usbd_xfer_handle xfer, usbd_device_handle dev, 112 usbd_private_handle priv, u_int32_t timeout, 113 usb_device_request_t *req, void *buffer, 114 u_int32_t length, u_int16_t flags, usbd_callback)); 115 void usbd_setup_isoc_xfer 116 __P((usbd_xfer_handle xfer, usbd_pipe_handle pipe, 117 usbd_private_handle priv, u_int16_t *frlengths, 118 u_int32_t nframes, u_int16_t flags, usbd_callback)); 119 void usbd_get_xfer_status 120 __P((usbd_xfer_handle xfer, usbd_private_handle *priv, 121 void **buffer, u_int32_t *count, usbd_status *status)); 122 usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor 123 __P((usbd_interface_handle iface, u_int8_t address)); 124 usbd_status usbd_abort_pipe __P((usbd_pipe_handle pipe)); 125 usbd_status usbd_clear_endpoint_stall __P((usbd_pipe_handle pipe)); 126 usbd_status usbd_clear_endpoint_stall_async __P((usbd_pipe_handle pipe)); 127 usbd_status usbd_endpoint_count 128 __P((usbd_interface_handle dev, u_int8_t *count)); 129 usbd_status usbd_interface_count 130 __P((usbd_device_handle dev, u_int8_t *count)); 131 usbd_status usbd_interface2device_handle 132 __P((usbd_interface_handle iface, usbd_device_handle *dev)); 133 usbd_status usbd_device2interface_handle 134 __P((usbd_device_handle dev, u_int8_t ifaceno, usbd_interface_handle *iface)); 135 136 usbd_device_handle usbd_pipe2device_handle __P((usbd_pipe_handle)); 137 void *usbd_alloc_buffer __P((usbd_xfer_handle req, u_int32_t size)); 138 void usbd_free_buffer __P((usbd_xfer_handle req)); 139 void *usbd_get_buffer __P((usbd_xfer_handle xfer)); 140 usbd_status usbd_sync_transfer __P((usbd_xfer_handle req)); 141 usbd_status usbd_open_pipe_intr 142 __P((usbd_interface_handle iface, u_int8_t address, 143 u_int8_t flags, usbd_pipe_handle *pipe, 144 usbd_private_handle priv, void *buffer, 145 u_int32_t length, usbd_callback, int)); 146 usbd_status usbd_do_request 147 __P((usbd_device_handle pipe, usb_device_request_t *req, void *data)); 148 usbd_status usbd_do_request_async 149 __P((usbd_device_handle pipe, usb_device_request_t *req, void *data)); 150 usbd_status usbd_do_request_flags 151 __P((usbd_device_handle pipe, usb_device_request_t *req, 152 void *data, u_int16_t flags, int *)); 153 usb_interface_descriptor_t *usbd_get_interface_descriptor 154 __P((usbd_interface_handle iface)); 155 usb_config_descriptor_t *usbd_get_config_descriptor 156 __P((usbd_device_handle dev)); 157 usb_device_descriptor_t *usbd_get_device_descriptor 158 __P((usbd_device_handle dev)); 159 usbd_status usbd_set_interface __P((usbd_interface_handle, int)); 160 int usbd_get_no_alts __P((usb_config_descriptor_t *, int)); 161 usbd_status usbd_get_interface 162 __P((usbd_interface_handle iface, u_int8_t *aiface)); 163 void usbd_fill_deviceinfo 164 __P((usbd_device_handle dev, struct usb_device_info *di)); 165 int usbd_get_interface_altindex __P((usbd_interface_handle iface)); 166 167 usb_interface_descriptor_t *usbd_find_idesc 168 __P((usb_config_descriptor_t *cd, int iindex, int ano)); 169 usb_endpoint_descriptor_t *usbd_find_edesc 170 __P((usb_config_descriptor_t *cd, int ifaceidx, int altidx, 171 int endptidx)); 172 173 void usbd_dopoll __P((usbd_interface_handle)); 174 void usbd_set_polling __P((usbd_device_handle iface, int on)); 175 176 const char *usbd_errstr __P((usbd_status err)); 177 178 void usbd_add_dev_event __P((int, usbd_device_handle)); 179 void usbd_add_drv_event __P((int, usbd_device_handle, device_ptr_t)); 180 181 void usbd_devinfo __P((usbd_device_handle, int, char *)); 182 struct usbd_quirks *usbd_get_quirks __P((usbd_device_handle)); 183 usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor 184 __P((usbd_interface_handle iface, u_int8_t address)); 185 186 usbd_status usbd_reload_device_desc __P((usbd_device_handle)); 187 188 int usbd_ratecheck __P((struct timeval *last)); 189 190 /* NetBSD attachment information */ 191 192 /* Attach data */ 193 struct usb_attach_arg { 194 int port; 195 int configno; 196 int ifaceno; 197 int vendor; 198 int product; 199 int release; 200 usbd_device_handle device; /* current device */ 201 usbd_interface_handle iface; /* current interface */ 202 int usegeneric; 203 usbd_interface_handle *ifaces; /* all interfaces */ 204 int nifaces; /* number of interfaces */ 205 }; 206 207 #if defined(__NetBSD__) || defined(__OpenBSD__) 208 /* Match codes. */ 209 /* First five codes is for a whole device. */ 210 #define UMATCH_VENDOR_PRODUCT_REV 14 211 #define UMATCH_VENDOR_PRODUCT 13 212 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO 12 213 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO 11 214 #define UMATCH_DEVCLASS_DEVSUBCLASS 10 215 /* Next six codes are for interfaces. */ 216 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE 9 217 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE 8 218 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO 7 219 #define UMATCH_VENDOR_IFACESUBCLASS 6 220 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO 5 221 #define UMATCH_IFACECLASS_IFACESUBCLASS 4 222 #define UMATCH_IFACECLASS 3 223 #define UMATCH_IFACECLASS_GENERIC 2 224 /* Generic driver */ 225 #define UMATCH_GENERIC 1 226 /* No match */ 227 #define UMATCH_NONE 0 228 229 #elif defined(__FreeBSD__) 230 /* FreeBSD needs values less than zero */ 231 #define UMATCH_VENDOR_PRODUCT_REV (-10) 232 #define UMATCH_VENDOR_PRODUCT (-20) 233 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO (-30) 234 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO (-40) 235 #define UMATCH_DEVCLASS_DEVSUBCLASS (-50) 236 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE (-60) 237 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE (-70) 238 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO (-80) 239 #define UMATCH_VENDOR_IFACESUBCLASS (-90) 240 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO (-100) 241 #define UMATCH_IFACECLASS_IFACESUBCLASS (-110) 242 #define UMATCH_IFACECLASS (-120) 243 #define UMATCH_IFACECLASS_GENERIC (-130) 244 #define UMATCH_GENERIC (-140) 245 #define UMATCH_NONE (ENXIO) 246 247 #endif 248 249 #if defined(__FreeBSD__) 250 int usbd_driver_load __P((module_t mod, int what, void *arg)); 251 #endif 252 253 /* 254 * XXX 255 * splusb MUST be the lowest level interrupt so that within USB callbacks 256 * the level can be raised the appropriate level. 257 * XXX Should probably use a softsplusb. 258 */ 259 /* XXX */ 260 #define splusb splbio 261 #define splhardusb splbio 262 #define IPL_USB IPL_BIO 263 /* XXX */ 264
Indexes created Sat Sep 27 21:09:56 GMT 2025