sys/bus/usb/usbdivar.h

   1 /*      $NetBSD: usbdivar.h,v 1.70 2002/07/11 21:14:36 augustss Exp $   */
   2 /*      $FreeBSD: src/sys/dev/usb/usbdivar.h,v 1.43.2.1 2006/03/01 01:59:05 iedowse Exp $       */
   3 /*      $DragonFly: src/sys/bus/usb/usbdivar.h,v 1.6 2006/12/10 02:03:57 sephe 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 #if defined(__NetBSD__)
  43 #include <sys/callout.h>
  44 #endif
  45
  46 /* From usb_mem.h */
  47 DECLARE_USB_DMA_T;
  48
  49 struct usbd_xfer;
  50 struct usbd_pipe;
  51
  52 struct usbd_endpoint {
  53         usb_endpoint_descriptor_t *edesc;
  54         int                     refcnt;
  55         int                     savedtoggle;
  56 };
  57
  58 struct usbd_bus_methods {
  59         usbd_status           (*open_pipe)(struct usbd_pipe *pipe);
  60         void                  (*soft_intr)(void *);
  61         void                  (*do_poll)(struct usbd_bus *);
  62         usbd_status           (*allocm)(struct usbd_bus *, usb_dma_t *,
  63                                         u_int32_t bufsize);
  64         void                  (*freem)(struct usbd_bus *, usb_dma_t *);
  65         struct usbd_xfer *    (*allocx)(struct usbd_bus *);
  66         void                  (*freex)(struct usbd_bus *, struct usbd_xfer *);
  67 };
  68
  69 struct usbd_pipe_methods {
  70         usbd_status           (*transfer)(usbd_xfer_handle xfer);
  71         usbd_status           (*start)(usbd_xfer_handle xfer);
  72         void                  (*abort)(usbd_xfer_handle xfer);
  73         void                  (*close)(usbd_pipe_handle pipe);
  74         void                  (*cleartoggle)(usbd_pipe_handle pipe);
  75         void                  (*done)(usbd_xfer_handle xfer);
  76 };
  77
  78 struct usbd_tt {
  79         struct usbd_hub         *hub;
  80 };
  81
  82 struct usbd_port {
  83         usb_port_status_t       status;
  84         u_int16_t               power;  /* mA of current on port */
  85         u_int8_t                portno;
  86         u_int8_t                restartcnt;
  87 #define USBD_RESTART_MAX 5
  88         struct usbd_device     *device; /* Connected device */
  89         struct usbd_device     *parent; /* The ports hub */
  90         struct usbd_tt         *tt; /* Transaction translator (if any) */
  91 };
  92
  93 struct usbd_hub {
  94         usbd_status           (*explore)(usbd_device_handle hub);
  95         void                   *hubsoftc;
  96         usb_hub_descriptor_t    hubdesc;
  97         struct usbd_port        ports[1];
  98 };
  99
 100 struct usb_softc;
 101
 102 /*****/
 103
 104 struct usbd_bus {
 105         /* Filled by HC driver */
 106         USBBASEDEVICE           bdev; /* base device, host adapter */
 107         struct usbd_bus_methods *methods;
 108         u_int32_t               pipe_size; /* size of a pipe struct */
 109         /* Filled by usb driver */
 110         struct usbd_device     *root_hub;
 111         usbd_device_handle      devices[USB_MAX_DEVICES];
 112         char                    needs_explore;/* a hub a signalled a change */
 113         char                    use_polling;
 114         struct usb_softc       *usbctl;
 115         struct usb_device_stats stats;
 116         int                     intr_context;
 117         u_int                   no_intrs;
 118         int                     usbrev; /* USB revision */
 119 #define USBREV_UNKNOWN  0
 120 #define USBREV_PRE_1_0  1
 121 #define USBREV_1_0      2
 122 #define USBREV_1_1      3
 123 #define USBREV_2_0      4
 124 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" }
 125
 126 #ifdef USB_USE_SOFTINTR
 127 #ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
 128         void                   *soft; /* soft interrupt cookie */
 129 #else
 130         struct callout          softi;
 131 #endif
 132 #endif
 133
 134         bus_dma_tag_t           dmatag; /* DMA tag */
 135 };
 136
 137 struct usbd_device {
 138         struct usbd_bus        *bus;           /* our controller */
 139         struct usbd_pipe       *default_pipe;  /* pipe 0 */
 140         u_int8_t                address;       /* device addess */
 141         u_int8_t                config;        /* current configuration # */
 142         u_int8_t                depth;         /* distance from root hub */
 143         u_int8_t                speed;         /* low/full/high speed */
 144         u_int8_t                self_powered;  /* flag for self powered */
 145         u_int16_t               power;         /* mA the device uses */
 146         int16_t                 langid;        /* language for strings */
 147 #define USBD_NOLANG (-1)
 148         usb_event_cookie_t      cookie;        /* unique connection id */
 149         struct usbd_port       *powersrc;      /* upstream hub port, or 0 */
 150         struct usbd_device     *myhub;         /* upstream hub */
 151         struct usbd_port       *myhsport;      /* closest high speed port */
 152         struct usbd_endpoint    def_ep;        /* for pipe 0 */
 153         usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */
 154         struct usbd_interface  *ifaces;        /* array of all interfaces */
 155         usb_device_descriptor_t ddesc;         /* device descriptor */
 156         usb_config_descriptor_t *cdesc;        /* full config descr */
 157         const struct usbd_quirks     *quirks;  /* device quirks, always set */
 158         struct usbd_hub        *hub;           /* only if this is a hub */
 159         device_ptr_t           *subdevs;       /* sub-devices, 0 terminated */
 160         uint8_t                *ifacenums;     /* sub-device interfacenumbers */
 161 };
 162
 163 struct usbd_interface {
 164         struct usbd_device     *device;
 165         usb_interface_descriptor_t *idesc;
 166         int                     index;
 167         int                     altindex;
 168         struct usbd_endpoint   *endpoints;
 169         void                   *priv;
 170         LIST_HEAD(, usbd_pipe)  pipes;
 171 };
 172
 173 struct usbd_pipe {
 174         struct usbd_interface  *iface;
 175         struct usbd_device     *device;
 176         struct usbd_endpoint   *endpoint;
 177         int                     refcnt;
 178         char                    running;
 179         char                    aborting;
 180         SIMPLEQ_HEAD(, usbd_xfer) queue;
 181         LIST_ENTRY(usbd_pipe)   next;
 182
 183         usbd_xfer_handle        intrxfer; /* used for repeating requests */
 184         char                    repeat;
 185         int                     interval;
 186
 187         /* Filled by HC driver. */
 188         struct usbd_pipe_methods *methods;
 189 };
 190
 191 struct usbd_xfer {
 192         struct usbd_pipe       *pipe;
 193         void                   *priv;
 194         void                   *buffer;
 195         u_int32_t               length;
 196         u_int32_t               actlen;
 197         u_int16_t               flags;
 198         u_int32_t               timeout;
 199         usbd_status             status;
 200         usbd_callback           callback;
 201         __volatile char         done;
 202 #ifdef DIAGNOSTIC
 203         u_int32_t               busy_free;
 204 #define XFER_FREE 0x46524545
 205 #define XFER_BUSY 0x42555359
 206 #define XFER_ONQU 0x4f4e5155
 207 #endif
 208
 209         /* For control pipe */
 210         usb_device_request_t    request;
 211
 212         /* For isoc */
 213         u_int16_t               *frlengths;
 214         int                     nframes;
 215
 216         /* For memory allocation */
 217         struct usbd_device     *device;
 218         usb_dma_t               dmabuf;
 219
 220         int                     rqflags;
 221 #define URQ_REQUEST     0x01
 222 #define URQ_AUTO_DMABUF 0x10
 223 #define URQ_DEV_DMABUF  0x20
 224
 225         SIMPLEQ_ENTRY(usbd_xfer) next;
 226
 227         void                   *hcpriv; /* private use by the HC driver */
 228
 229         usb_callout_t           timeout_handle;
 230 };
 231
 232 void usbd_init(void);
 233 void usbd_finish(void);
 234
 235 #ifdef USB_DEBUG
 236 void usbd_dump_iface(struct usbd_interface *iface);
 237 void usbd_dump_device(struct usbd_device *dev);
 238 void usbd_dump_endpoint(struct usbd_endpoint *endp);
 239 void usbd_dump_queue(usbd_pipe_handle pipe);
 240 void usbd_dump_pipe(usbd_pipe_handle pipe);
 241 #endif
 242
 243 /* Routines from usb_subr.c */
 244 int             usbctlprint(void *, const char *);
 245 void            usb_delay_ms(usbd_bus_handle, u_int);
 246 usbd_status     usbd_reset_port(usbd_device_handle dev,
 247                                 int port, usb_port_status_t *ps);
 248 usbd_status     usbd_setup_pipe(usbd_device_handle dev,
 249                                 usbd_interface_handle iface,
 250                                 struct usbd_endpoint *, int,
 251                                 usbd_pipe_handle *pipe);
 252 usbd_status     usbd_new_device(device_ptr_t parent,
 253                                 usbd_bus_handle bus, int depth,
 254                                 int lowspeed, int port,
 255                                 struct usbd_port *);
 256 void            usbd_remove_device(usbd_device_handle, struct usbd_port *);
 257 int             usbd_printBCD(char *cp, int bcd);
 258 usbd_status     usbd_fill_iface_data(usbd_device_handle dev, int i, int a);
 259 void            usb_free_device(usbd_device_handle);
 260
 261 usbd_status     usb_insert_transfer(usbd_xfer_handle xfer);
 262 void            usb_transfer_complete(usbd_xfer_handle xfer);
 263 void            usb_disconnect_port(struct usbd_port *up, device_ptr_t);
 264
 265 /* Routines from usb.c */
 266 void            usb_needs_explore(usbd_device_handle);
 267 void            usb_schedsoftintr(struct usbd_bus *);
 268
 269 /* Locator stuff. */
 270
 271 #if defined(__NetBSD__)
 272 #include "locators.h"
 273 #elif defined(__FreeBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
 274 /* XXX these values are used to statically bind some elements in the USB tree
 275  * to specific driver instances. This should be somehow emulated in FreeBSD
 276  * but can be done later on.
 277  * The values are copied from the files.usb file in the NetBSD sources.
 278  */
 279 #define UHUBCF_PORT_DEFAULT -1
 280 #define UHUBCF_CONFIGURATION_DEFAULT -1
 281 #define UHUBCF_INTERFACE_DEFAULT -1
 282 #define UHUBCF_VENDOR_DEFAULT -1
 283 #define UHUBCF_PRODUCT_DEFAULT -1
 284 #define UHUBCF_RELEASE_DEFAULT -1
 285 #endif
 286
 287 #if defined (__OpenBSD__)
 288 #define UHUBCF_PORT             0
 289 #define UHUBCF_CONFIGURATION    1
 290 #define UHUBCF_INTERFACE        2
 291 #define UHUBCF_VENDOR           3
 292 #define UHUBCF_PRODUCT          4
 293 #define UHUBCF_RELEASE          5
 294 #endif
 295
 296 #define uhubcf_port             cf_loc[UHUBCF_PORT]
 297 #define uhubcf_configuration    cf_loc[UHUBCF_CONFIGURATION]
 298 #define uhubcf_interface        cf_loc[UHUBCF_INTERFACE]
 299 #define uhubcf_vendor           cf_loc[UHUBCF_VENDOR]
 300 #define uhubcf_product          cf_loc[UHUBCF_PRODUCT]
 301 #define uhubcf_release          cf_loc[UHUBCF_RELEASE]
 302 #define UHUB_UNK_PORT           UHUBCF_PORT_DEFAULT /* wildcarded 'port' */
 303 #define UHUB_UNK_CONFIGURATION  UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */
 304 #define UHUB_UNK_INTERFACE      UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */
 305 #define UHUB_UNK_VENDOR         UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */
 306 #define UHUB_UNK_PRODUCT        UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */
 307 #define UHUB_UNK_RELEASE        UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */
 308