sys/dev/usb/usbdivar.h

   1 /*      $NetBSD: usbdivar.h,v 1.90 2009/11/12 08:16:50 uebayasi Exp $   */
   2 /*      $FreeBSD: src/sys/dev/usb/usbdivar.h,v 1.11 1999/11/17 22:33:51 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 #include <sys/callout.h>
  35
  36 /* From usb_mem.h */
  37 struct usb_dma_block;
  38 typedef struct {
  39         struct usb_dma_block *block;
  40         u_int offs;
  41 } usb_dma_t;
  42
  43 struct usbd_xfer;
  44 struct usbd_pipe;
  45
  46 struct usbd_endpoint {
  47         usb_endpoint_descriptor_t *edesc;
  48         int                     refcnt;
  49 };
  50
  51 struct usbd_bus_methods {
  52         usbd_status           (*open_pipe)(struct usbd_pipe *pipe);
  53         void                  (*soft_intr)(void *);
  54         void                  (*do_poll)(struct usbd_bus *);
  55         usbd_status           (*allocm)(struct usbd_bus *, usb_dma_t *,
  56                                         u_int32_t bufsize);
  57         void                  (*freem)(struct usbd_bus *, usb_dma_t *);
  58         struct usbd_xfer *    (*allocx)(struct usbd_bus *);
  59         void                  (*freex)(struct usbd_bus *, struct usbd_xfer *);
  60 };
  61
  62 struct usbd_pipe_methods {
  63         usbd_status           (*transfer)(usbd_xfer_handle xfer);
  64         usbd_status           (*start)(usbd_xfer_handle xfer);
  65         void                  (*abort)(usbd_xfer_handle xfer);
  66         void                  (*close)(usbd_pipe_handle pipe);
  67         void                  (*cleartoggle)(usbd_pipe_handle pipe);
  68         void                  (*done)(usbd_xfer_handle xfer);
  69 };
  70
  71 #if 0 /* notyet */
  72 struct usbd_tt {
  73         struct usbd_hub        *hub;
  74 };
  75 #endif
  76
  77 struct usbd_port {
  78         usb_port_status_t       status;
  79         u_int16_t               power;  /* mA of current on port */
  80         u_int8_t                portno;
  81         u_int8_t                restartcnt;
  82 #define USBD_RESTART_MAX 5
  83         u_int8_t                reattach;
  84         struct usbd_device     *device; /* Connected device */
  85         struct usbd_device     *parent; /* The ports hub */
  86 #if 0
  87         struct usbd_tt         *tt; /* Transaction translator (if any) */
  88 #endif
  89 };
  90
  91 struct usbd_hub {
  92         usbd_status           (*explore)(usbd_device_handle hub);
  93         void                   *hubsoftc;
  94         usb_hub_descriptor_t    hubdesc;
  95         struct usbd_port        ports[1];
  96 };
  97
  98 /*****/
  99
 100 struct usbd_bus {
 101         /* Filled by HC driver */
 102         void                    *hci_private;
 103         const struct usbd_bus_methods *methods;
 104         u_int32_t               pipe_size; /* size of a pipe struct */
 105         /* Filled by usb driver */
 106         struct usbd_device     *root_hub;
 107         usbd_device_handle      devices[USB_MAX_DEVICES];
 108         char                    needs_explore;/* a hub a signalled a change */
 109         char                    use_polling;
 110         device_t                usbctl;
 111         struct usb_device_stats stats;
 112         int                     intr_context;
 113         u_int                   no_intrs;
 114         int                     usbrev; /* USB revision */
 115 #define USBREV_UNKNOWN  0
 116 #define USBREV_PRE_1_0  1
 117 #define USBREV_1_0      2
 118 #define USBREV_1_1      3
 119 #define USBREV_2_0      4
 120 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" }
 121
 122         void                   *soft; /* soft interrupt cookie */
 123         bus_dma_tag_t           dmatag; /* DMA tag */
 124 };
 125
 126 struct usbd_device {
 127         struct usbd_bus        *bus;           /* our controller */
 128         struct usbd_pipe       *default_pipe;  /* pipe 0 */
 129         u_int8_t                address;       /* device addess */
 130         u_int8_t                config;        /* current configuration # */
 131         u_int8_t                depth;         /* distance from root hub */
 132         u_int8_t                speed;         /* low/full/high speed */
 133         u_int8_t                self_powered;  /* flag for self powered */
 134         u_int16_t               power;         /* mA the device uses */
 135         int16_t                 langid;        /* language for strings */
 136 #define USBD_NOLANG (-1)
 137         usb_event_cookie_t      cookie;        /* unique connection id */
 138         struct usbd_port       *powersrc;      /* upstream hub port, or 0 */
 139         struct usbd_device     *myhub;         /* upstream hub */
 140         struct usbd_port       *myhsport;      /* closest high speed port */
 141         struct usbd_endpoint    def_ep;        /* for pipe 0 */
 142         usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */
 143         struct usbd_interface  *ifaces;        /* array of all interfaces */
 144         usb_device_descriptor_t ddesc;         /* device descriptor */
 145         usb_config_descriptor_t *cdesc;        /* full config descr */
 146         const struct usbd_quirks     *quirks;  /* device quirks, always set */
 147         struct usbd_hub        *hub;           /* only if this is a hub */
 148         int                     subdevlen;     /* array length of following */
 149         device_t               *subdevs;       /* sub-devices */
 150         int                     nifaces_claimed; /* number of ifaces in use */
 151 };
 152
 153 struct usbd_interface {
 154         struct usbd_device     *device;
 155         usb_interface_descriptor_t *idesc;
 156         int                     index;
 157         int                     altindex;
 158         struct usbd_endpoint   *endpoints;
 159         void                   *priv;
 160         LIST_HEAD(, usbd_pipe)  pipes;
 161 };
 162
 163 struct usbd_pipe {
 164         struct usbd_interface  *iface;
 165         struct usbd_device     *device;
 166         struct usbd_endpoint   *endpoint;
 167         int                     refcnt;
 168         char                    running;
 169         char                    aborting;
 170         SIMPLEQ_HEAD(, usbd_xfer) queue;
 171         LIST_ENTRY(usbd_pipe)   next;
 172
 173         usbd_xfer_handle        intrxfer; /* used for repeating requests */
 174         char                    repeat;
 175         int                     interval;
 176
 177         /* Filled by HC driver. */
 178         const struct usbd_pipe_methods *methods;
 179 };
 180
 181 struct usbd_xfer {
 182         struct usbd_pipe       *pipe;
 183         void                   *priv;
 184         void                   *buffer;
 185         u_int32_t               length;
 186         u_int32_t               actlen;
 187         u_int16_t               flags;
 188         u_int32_t               timeout;
 189         usbd_status             status;
 190         usbd_callback           callback;
 191         volatile u_int8_t       done;
 192         u_int8_t                busy_free;      /* used for DIAGNOSTIC */
 193 #define XFER_FREE 0x46
 194 #define XFER_BUSY 0x55
 195 #define XFER_ONQU 0x9e
 196
 197         /* For control pipe */
 198         usb_device_request_t    request;
 199
 200         /* For isoc */
 201         u_int16_t               *frlengths;
 202         int                     nframes;
 203
 204         /* For memory allocation */
 205         struct usbd_device     *device;
 206         usb_dma_t               dmabuf;
 207
 208         u_int8_t                rqflags;
 209 #define URQ_REQUEST     0x01
 210 #define URQ_AUTO_DMABUF 0x10
 211 #define URQ_DEV_DMABUF  0x20
 212
 213         SIMPLEQ_ENTRY(usbd_xfer) next;
 214
 215         void                   *hcpriv; /* private use by the HC driver */
 216         u_int8_t                hcflags; /* private use by the HC driver */
 217 #define UXFER_ABORTING  0x01    /* xfer is aborting. */
 218 #define UXFER_ABORTWAIT 0x02    /* abort completion is being awaited. */
 219
 220         struct callout timeout_handle;
 221 };
 222
 223 void usbd_init(void);
 224 void usbd_finish(void);
 225
 226 #ifdef USB_DEBUG
 227 void usbd_dump_iface(struct usbd_interface *iface);
 228 void usbd_dump_device(struct usbd_device *dev);
 229 void usbd_dump_endpoint(struct usbd_endpoint *endp);
 230 void usbd_dump_queue(usbd_pipe_handle pipe);
 231 void usbd_dump_pipe(usbd_pipe_handle pipe);
 232 #endif
 233
 234 /* Routines from usb_subr.c */
 235 int             usbctlprint(void *, const char *);
 236 void            usb_delay_ms(usbd_bus_handle, u_int);
 237 usbd_status     usbd_reset_port(usbd_device_handle, int, usb_port_status_t *);
 238 usbd_status     usbd_setup_pipe(usbd_device_handle dev,
 239                                 usbd_interface_handle iface,
 240                                 struct usbd_endpoint *, int,
 241                                 usbd_pipe_handle *pipe);
 242 usbd_status     usbd_new_device(device_t, usbd_bus_handle, int, int, int,
 243                                 struct usbd_port *);
 244 usbd_status     usbd_reattach_device(device_t, usbd_device_handle,
 245                                      int, const int *);
 246
 247 void            usbd_remove_device(usbd_device_handle, struct usbd_port *);
 248 int             usbd_printBCD(char *, size_t, int);
 249 usbd_status     usbd_fill_iface_data(usbd_device_handle, int, int);
 250 void            usb_free_device(usbd_device_handle);
 251
 252 usbd_status     usb_insert_transfer(usbd_xfer_handle);
 253 void            usb_transfer_complete(usbd_xfer_handle);
 254 int             usb_disconnect_port(struct usbd_port *, device_t, int);
 255
 256 /* Routines from usb.c */
 257 void            usb_needs_explore(usbd_device_handle);
 258 void            usb_needs_reattach(usbd_device_handle);
 259 void            usb_schedsoftintr(struct usbd_bus *);
 260
 261 /*
 262  * XXX This check is extremely bogus. Bad Bad Bad.
 263  */
 264 #if defined(DIAGNOSTIC) && 0
 265 #define SPLUSBCHECK \
 266         do { int _s = splusb(), _su = splusb(); \
 267              if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \
 268                                    _s, _su, __FILE__, __LINE__); \
 269              splx(_s); \
 270         } while (0)
 271 #else
 272 #define SPLUSBCHECK
 273 #endif