sys/bus/usb/usbdi.h

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