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