sys/dev/usb/usbdi.h

   1 /*      $NetBSD: usbdi.h,v 1.78 2009/08/16 13:20:40 martin 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  *
  21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _USBDI_H_
  35 #define _USBDI_H_
  36
  37 typedef struct usbd_bus         *usbd_bus_handle;
  38 typedef struct usbd_device      *usbd_device_handle;
  39 typedef struct usbd_interface   *usbd_interface_handle;
  40 typedef struct usbd_pipe        *usbd_pipe_handle;
  41 typedef struct usbd_xfer        *usbd_xfer_handle;
  42 typedef void                    *usbd_private_handle;
  43
  44 typedef enum {          /* keep in sync with usbd_status_msgs */
  45         USBD_NORMAL_COMPLETION = 0, /* must be 0 */
  46         USBD_IN_PROGRESS,       /* 1 */
  47         /* errors */
  48         USBD_PENDING_REQUESTS,  /* 2 */
  49         USBD_NOT_STARTED,       /* 3 */
  50         USBD_INVAL,             /* 4 */
  51         USBD_NOMEM,             /* 5 */
  52         USBD_CANCELLED,         /* 6 */
  53         USBD_BAD_ADDRESS,       /* 7 */
  54         USBD_IN_USE,            /* 8 */
  55         USBD_NO_ADDR,           /* 9 */
  56         USBD_SET_ADDR_FAILED,   /* 10 */
  57         USBD_NO_POWER,          /* 11 */
  58         USBD_TOO_DEEP,          /* 12 */
  59         USBD_IOERROR,           /* 13 */
  60         USBD_NOT_CONFIGURED,    /* 14 */
  61         USBD_TIMEOUT,           /* 15 */
  62         USBD_SHORT_XFER,        /* 16 */
  63         USBD_STALLED,           /* 17 */
  64         USBD_INTERRUPTED,       /* 18 */
  65
  66         USBD_ERROR_MAX          /* must be last */
  67 } usbd_status;
  68
  69 typedef void (*usbd_callback)(usbd_xfer_handle, usbd_private_handle,
  70                               usbd_status);
  71
  72 /* Open flags */
  73 #define USBD_EXCLUSIVE_USE      0x01
  74
  75 /* Use default (specified by ep. desc.) interval on interrupt pipe */
  76 #define USBD_DEFAULT_INTERVAL   (-1)
  77
  78 /* Request flags */
  79 #define USBD_NO_COPY            0x01    /* do not copy data to DMA buffer */
  80 #define USBD_SYNCHRONOUS        0x02    /* wait for completion */
  81 /* in usb.h #define USBD_SHORT_XFER_OK  0x04*/  /* allow short reads */
  82 #define USBD_FORCE_SHORT_XFER   0x08    /* force last short packet on write */
  83
  84 #define USBD_NO_TIMEOUT 0
  85 #define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */
  86 #define USBD_CONFIG_TIMEOUT  (3*USBD_DEFAULT_TIMEOUT)
  87
  88 #if defined(__FreeBSD__)
  89 #define USB_CDEV_MAJOR 108
  90 #endif
  91
  92 #define DEVINFOSIZE 1024
  93
  94 usbd_status usbd_open_pipe(usbd_interface_handle, u_int8_t,
  95                            u_int8_t, usbd_pipe_handle *);
  96 usbd_status usbd_close_pipe(usbd_pipe_handle);
  97 usbd_status usbd_transfer(usbd_xfer_handle);
  98 usbd_xfer_handle usbd_alloc_xfer(usbd_device_handle);
  99 usbd_status usbd_free_xfer(usbd_xfer_handle);
 100 void usbd_setup_xfer(usbd_xfer_handle, usbd_pipe_handle,
 101                      usbd_private_handle, void *,
 102                      u_int32_t, u_int16_t, u_int32_t,
 103                      usbd_callback);
 104 void usbd_setup_default_xfer(usbd_xfer_handle, usbd_device_handle,
 105                              usbd_private_handle, u_int32_t,
 106                              usb_device_request_t *, void *,
 107                              u_int32_t, u_int16_t, usbd_callback);
 108 void usbd_setup_isoc_xfer(usbd_xfer_handle, usbd_pipe_handle,
 109                           usbd_private_handle, u_int16_t *,
 110                           u_int32_t, u_int16_t, usbd_callback);
 111 void usbd_get_xfer_status(usbd_xfer_handle, usbd_private_handle *,
 112                           void **, u_int32_t *, usbd_status *);
 113 usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor
 114                         (usbd_interface_handle, u_int8_t);
 115 usbd_status usbd_abort_pipe(usbd_pipe_handle);
 116 usbd_status usbd_abort_default_pipe(usbd_device_handle);
 117 usbd_status usbd_clear_endpoint_stall(usbd_pipe_handle);
 118 usbd_status usbd_clear_endpoint_stall_async(usbd_pipe_handle);
 119 void usbd_clear_endpoint_toggle(usbd_pipe_handle);
 120 usbd_status usbd_endpoint_count(usbd_interface_handle, u_int8_t *);
 121 usbd_status usbd_interface_count(usbd_device_handle, u_int8_t *);
 122 void usbd_interface2device_handle(usbd_interface_handle,
 123                                          usbd_device_handle *);
 124 usbd_status usbd_device2interface_handle(usbd_device_handle,
 125                               u_int8_t, usbd_interface_handle *);
 126
 127 usbd_device_handle usbd_pipe2device_handle(usbd_pipe_handle);
 128 void *usbd_alloc_buffer(usbd_xfer_handle, u_int32_t);
 129 void usbd_free_buffer(usbd_xfer_handle);
 130 void *usbd_get_buffer(usbd_xfer_handle);
 131 usbd_status usbd_sync_transfer(usbd_xfer_handle);
 132 usbd_status usbd_open_pipe_intr(usbd_interface_handle, u_int8_t,
 133                                 u_int8_t, usbd_pipe_handle *,
 134                                 usbd_private_handle, void *,
 135                                 u_int32_t, usbd_callback, int);
 136 usbd_status usbd_do_request(usbd_device_handle, usb_device_request_t *, void *);
 137 usbd_status usbd_do_request_async(usbd_device_handle,
 138                                   usb_device_request_t *, void *);
 139 usbd_status usbd_do_request_flags(usbd_device_handle, usb_device_request_t *,
 140                                   void *, u_int16_t, int*, u_int32_t);
 141 usbd_status usbd_do_request_flags_pipe(usbd_device_handle, usbd_pipe_handle,
 142         usb_device_request_t *, void *, u_int16_t, int *, u_int32_t);
 143 usb_interface_descriptor_t *usbd_get_interface_descriptor
 144                                 (usbd_interface_handle);
 145 usb_config_descriptor_t *usbd_get_config_descriptor(usbd_device_handle);
 146 usb_device_descriptor_t *usbd_get_device_descriptor(usbd_device_handle);
 147 usbd_status usbd_set_interface(usbd_interface_handle, int);
 148 int usbd_get_no_alts(usb_config_descriptor_t *, int);
 149 usbd_status  usbd_get_interface(usbd_interface_handle, u_int8_t *);
 150 void usbd_fill_deviceinfo(usbd_device_handle, struct usb_device_info *, int);
 151 #ifdef COMPAT_30
 152 void usbd_fill_deviceinfo_old(usbd_device_handle, struct usb_device_info_old *,
 153     int);
 154 #endif
 155 int usbd_get_interface_altindex(usbd_interface_handle);
 156
 157 usb_interface_descriptor_t *usbd_find_idesc(usb_config_descriptor_t *,
 158                                             int, int);
 159 usb_endpoint_descriptor_t *usbd_find_edesc(usb_config_descriptor_t *,
 160                                            int, int, int);
 161
 162 void usbd_dopoll(usbd_interface_handle);
 163 void usbd_set_polling(usbd_device_handle, int);
 164
 165 const char *usbd_errstr(usbd_status);
 166
 167 void usbd_add_dev_event(int, usbd_device_handle);
 168 void usbd_add_drv_event(int, usbd_device_handle, device_t);
 169
 170 char *usbd_devinfo_alloc(usbd_device_handle, int);
 171 void usbd_devinfo_free(char *);
 172
 173 const struct usbd_quirks *usbd_get_quirks(usbd_device_handle);
 174 usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor
 175                         (usbd_interface_handle, u_int8_t);
 176
 177 usbd_status usbd_reload_device_desc(usbd_device_handle);
 178
 179 int usbd_ratecheck(struct timeval *);
 180
 181 usbd_status usbd_get_string(usbd_device_handle, int, char *);
 182 usbd_status usbd_get_string0(usbd_device_handle, int, char *, int);
 183
 184 /* An iterator for descriptors. */
 185 typedef struct {
 186         const uByte *cur;
 187         const uByte *end;
 188 } usbd_desc_iter_t;
 189 void usb_desc_iter_init(usbd_device_handle, usbd_desc_iter_t *);
 190 const usb_descriptor_t *usb_desc_iter_next(usbd_desc_iter_t *);
 191
 192 /*
 193  * The usb_task structs form a queue of things to run in the USB event
 194  * thread.  Normally this is just device discovery when a connect/disconnect
 195  * has been detected.  But it may also be used by drivers that need to
 196  * perform (short) tasks that must have a process context.
 197  */
 198 struct usb_task {
 199         TAILQ_ENTRY(usb_task) next;
 200         void (*fun)(void *);
 201         void *arg;
 202         int queue;
 203 };
 204 #define USB_TASKQ_HC            0
 205 #define USB_TASKQ_DRIVER        1
 206 #define USB_NUM_TASKQS          2
 207 #define USB_TASKQ_NAMES         {"usbtask-hc", "usbtask-dr"}
 208
 209 void usb_add_task(usbd_device_handle, struct usb_task *, int);
 210 void usb_rem_task(usbd_device_handle, struct usb_task *);
 211 #define usb_init_task(t, f, a) ((t)->fun = (f), (t)->arg = (a), (t)->queue = -1)
 212
 213 struct usb_devno {
 214         u_int16_t ud_vendor;
 215         u_int16_t ud_product;
 216 };
 217 const struct usb_devno *usb_match_device(const struct usb_devno *,
 218         u_int, u_int, u_int16_t, u_int16_t);
 219 #define usb_lookup(tbl, vendor, product) \
 220         usb_match_device((const struct usb_devno *)(tbl), sizeof (tbl) / sizeof ((tbl)[0]), sizeof ((tbl)[0]), (vendor), (product))
 221 #define USB_PRODUCT_ANY         0xffff
 222
 223 /* NetBSD attachment information */
 224
 225 /* Attach data */
 226 struct usb_attach_arg {
 227         int                     port;
 228         int                     vendor;
 229         int                     product;
 230         int                     release;
 231         usbd_device_handle      device; /* current device */
 232         int                     class, subclass, proto;
 233         int                     usegeneric;
 234 };
 235
 236 struct usbif_attach_arg {
 237         int                     port;
 238         int                     configno;
 239         int                     ifaceno;
 240         int                     vendor;
 241         int                     product;
 242         int                     release;
 243         usbd_device_handle      device; /* current device */
 244
 245         usbd_interface_handle   iface; /* current interface */
 246         int                     class, subclass, proto;
 247
 248         /* XXX need accounting for interfaces not matched to */
 249
 250         usbd_interface_handle  *ifaces; /* all interfaces */
 251         int                     nifaces; /* number of interfaces */
 252 };
 253
 254 /* Match codes. */
 255 #define UMATCH_HIGHEST                                  15
 256 /* First five codes is for a whole device. */
 257 #define UMATCH_VENDOR_PRODUCT_REV                       14
 258 #define UMATCH_VENDOR_PRODUCT                           13
 259 #define UMATCH_VENDOR_DEVCLASS_DEVPROTO                 12
 260 #define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO            11
 261 #define UMATCH_DEVCLASS_DEVSUBCLASS                     10
 262 /* Next six codes are for interfaces. */
 263 #define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE             9
 264 #define UMATCH_VENDOR_PRODUCT_CONF_IFACE                 8
 265 #define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO           7
 266 #define UMATCH_VENDOR_IFACESUBCLASS                      6
 267 #define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO       5
 268 #define UMATCH_IFACECLASS_IFACESUBCLASS                  4
 269 #define UMATCH_IFACECLASS                                3
 270 #define UMATCH_IFACECLASS_GENERIC                        2
 271 /* Generic driver */
 272 #define UMATCH_GENERIC                                   1
 273 /* No match */
 274 #define UMATCH_NONE                                      0
 275
 276 /* XXX Perhaps USB should have its own levels? */
 277 #define splusb splsoftnet
 278 #define splhardusb splbio
 279 #define IPL_USB IPL_BIO
 280 #define splsoftusb splusb
 281 #define IPL_SOFTUSB IPL_SOFTNET
 282 #define IPL_HARDUSB IPL_USB
 283
 284
 285 #endif /* _USBDI_H_ */