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