sys/dev/usb/controller/ehci_mv.c

   1 /*-
   2  * Copyright (C) 2008 MARVELL INTERNATIONAL LTD.
   3  * All rights reserved.
   4  *
   5  * Developed by Semihalf.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of MARVELL nor the names of contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  */
  31
  32 /*
  33  * FDT attachment driver for the USB Enhanced Host Controller.
  34  */
  35
  36 #include <sys/cdefs.h>
  37 __FBSDID("$FreeBSD$");
  38
  39 #include "opt_bus.h"
  40
  41 #include <sys/stdint.h>
  42 #include <sys/stddef.h>
  43 #include <sys/param.h>
  44 #include <sys/queue.h>
  45 #include <sys/types.h>
  46 #include <sys/systm.h>
  47 #include <sys/kernel.h>
  48 #include <sys/bus.h>
  49 #include <sys/module.h>
  50 #include <sys/lock.h>
  51 #include <sys/mutex.h>
  52 #include <sys/condvar.h>
  53 #include <sys/sysctl.h>
  54 #include <sys/sx.h>
  55 #include <sys/unistd.h>
  56 #include <sys/callout.h>
  57 #include <sys/malloc.h>
  58 #include <sys/priv.h>
  59
  60 #include <dev/ofw/ofw_bus.h>
  61 #include <dev/ofw/ofw_bus_subr.h>
  62
  63 #include <dev/usb/usb.h>
  64 #include <dev/usb/usbdi.h>
  65
  66 #include <dev/usb/usb_core.h>
  67 #include <dev/usb/usb_busdma.h>
  68 #include <dev/usb/usb_process.h>
  69 #include <dev/usb/usb_util.h>
  70
  71 #include <dev/usb/usb_controller.h>
  72 #include <dev/usb/usb_bus.h>
  73 #include <dev/usb/controller/ehci.h>
  74 #include <dev/usb/controller/ehcireg.h>
  75
  76 #include <arm/mv/mvreg.h>
  77 #include <arm/mv/mvvar.h>
  78
  79 #define EHCI_VENDORID_MRVL      0x1286
  80 #define EHCI_HC_DEVSTR          "Marvell Integrated USB 2.0 controller"
  81
  82 static device_attach_t mv_ehci_attach;
  83 static device_detach_t mv_ehci_detach;
  84
  85 static int err_intr(void *arg);
  86
  87 static struct resource *irq_err;
  88 static void *ih_err;
  89
  90 /* EHCI HC regs start at this offset within USB range */
  91 #define MV_USB_HOST_OFST        0x0100
  92
  93 #define USB_BRIDGE_INTR_CAUSE   0x210
  94 #define USB_BRIDGE_INTR_MASK    0x214
  95 #define USB_BRIDGE_ERR_ADDR     0x21C
  96
  97 #define MV_USB_ADDR_DECODE_ERR (1 << 0)
  98 #define MV_USB_HOST_UNDERFLOW  (1 << 1)
  99 #define MV_USB_HOST_OVERFLOW   (1 << 2)
 100 #define MV_USB_DEVICE_UNDERFLOW (1 << 3)
 101
 102 static int
 103 mv_ehci_probe(device_t self)
 104 {
 105
 106         if (!ofw_bus_status_okay(self))
 107                 return (ENXIO);
 108
 109         if (!ofw_bus_is_compatible(self, "mrvl,usb-ehci"))
 110                 return (ENXIO);
 111
 112         device_set_desc(self, EHCI_HC_DEVSTR);
 113
 114         return (BUS_PROBE_DEFAULT);
 115 }
 116
 117 static int
 118 mv_ehci_attach(device_t self)
 119 {
 120         ehci_softc_t *sc = device_get_softc(self);
 121         bus_space_handle_t bsh;
 122         int err;
 123         int rid;
 124
 125         /* initialise some bus fields */
 126         sc->sc_bus.parent = self;
 127         sc->sc_bus.devices = sc->sc_devices;
 128         sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
 129
 130         /* get all DMA memory */
 131         if (usb_bus_mem_alloc_all(&sc->sc_bus,
 132             USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
 133                 return (ENOMEM);
 134         }
 135
 136         rid = 0;
 137         sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 138         if (!sc->sc_io_res) {
 139                 device_printf(self, "Could not map memory\n");
 140                 goto error;
 141         }
 142         sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
 143         bsh = rman_get_bushandle(sc->sc_io_res);
 144         sc->sc_io_size = rman_get_size(sc->sc_io_res) - MV_USB_HOST_OFST;
 145
 146         /*
 147          * Marvell EHCI host controller registers start at certain offset
 148          * within the whole USB registers range, so create a subregion for the
 149          * host mode configuration purposes.
 150          */
 151
 152         if (bus_space_subregion(sc->sc_io_tag, bsh, MV_USB_HOST_OFST,
 153             sc->sc_io_size, &sc->sc_io_hdl) != 0)
 154                 panic("%s: unable to subregion USB host registers",
 155                     device_get_name(self));
 156
 157         rid = 0;
 158         irq_err = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
 159             RF_SHAREABLE | RF_ACTIVE);
 160         if (irq_err == NULL) {
 161                 device_printf(self, "Could not allocate error irq\n");
 162                 mv_ehci_detach(self);
 163                 return (ENXIO);
 164         }
 165
 166         /*
 167          * Notice: Marvell EHCI controller has TWO interrupt lines, so make
 168          * sure to use the correct rid for the main one (controller interrupt)
 169          * -- refer to DTS for the right resource number to use here.
 170          */
 171         rid = 1;
 172         sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
 173             RF_SHAREABLE | RF_ACTIVE);
 174         if (sc->sc_irq_res == NULL) {
 175                 device_printf(self, "Could not allocate irq\n");
 176                 goto error;
 177         }
 178
 179         sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
 180         if (!sc->sc_bus.bdev) {
 181                 device_printf(self, "Could not add USB device\n");
 182                 goto error;
 183         }
 184         device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
 185         device_set_desc(sc->sc_bus.bdev, EHCI_HC_DEVSTR);
 186
 187         sprintf(sc->sc_vendor, "Marvell");
 188
 189         err = bus_setup_intr(self, irq_err, INTR_TYPE_BIO,
 190             err_intr, NULL, sc, &ih_err);
 191         if (err) {
 192                 device_printf(self, "Could not setup error irq, %d\n", err);
 193                 ih_err = NULL;
 194                 goto error;
 195         }
 196
 197         EWRITE4(sc, USB_BRIDGE_INTR_MASK, MV_USB_ADDR_DECODE_ERR |
 198             MV_USB_HOST_UNDERFLOW | MV_USB_HOST_OVERFLOW |
 199             MV_USB_DEVICE_UNDERFLOW);
 200
 201         err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 202             NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
 203         if (err) {
 204                 device_printf(self, "Could not setup irq, %d\n", err);
 205                 sc->sc_intr_hdl = NULL;
 206                 goto error;
 207         }
 208
 209         /*
 210          * Workaround for Marvell integrated EHCI controller: reset of
 211          * the EHCI core clears the USBMODE register, which sets the core in
 212          * an undefined state (neither host nor agent), so it needs to be set
 213          * again for proper operation.
 214          *
 215          * Refer to errata document MV-S500832-00D.pdf (p. 5.24 GL USB-2) for
 216          * details.
 217          */
 218         sc->sc_flags |= EHCI_SCFLG_SETMODE;
 219         if (bootverbose)
 220                 device_printf(self, "5.24 GL USB-2 workaround enabled\n");
 221
 222         /* XXX all MV chips need it? */
 223         sc->sc_flags |= EHCI_SCFLG_FORCESPEED | EHCI_SCFLG_NORESTERM;
 224
 225         err = ehci_init(sc);
 226         if (!err) {
 227                 err = device_probe_and_attach(sc->sc_bus.bdev);
 228         }
 229         if (err) {
 230                 device_printf(self, "USB init failed err=%d\n", err);
 231                 goto error;
 232         }
 233         return (0);
 234
 235 error:
 236         mv_ehci_detach(self);
 237         return (ENXIO);
 238 }
 239
 240 static int
 241 mv_ehci_detach(device_t self)
 242 {
 243         ehci_softc_t *sc = device_get_softc(self);
 244         device_t bdev;
 245         int err;
 246
 247         if (sc->sc_bus.bdev) {
 248                 bdev = sc->sc_bus.bdev;
 249                 device_detach(bdev);
 250                 device_delete_child(self, bdev);
 251         }
 252         /* during module unload there are lots of children leftover */
 253         device_delete_children(self);
 254
 255         /*
 256          * disable interrupts that might have been switched on in mv_ehci_attach
 257          */
 258         if (sc->sc_io_res) {
 259                 EWRITE4(sc, USB_BRIDGE_INTR_MASK, 0);
 260         }
 261         if (sc->sc_irq_res && sc->sc_intr_hdl) {
 262                 /*
 263                  * only call ehci_detach() after ehci_init()
 264                  */
 265                 ehci_detach(sc);
 266
 267                 err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
 268
 269                 if (err)
 270                         /* XXX or should we panic? */
 271                         device_printf(self, "Could not tear down irq, %d\n",
 272                             err);
 273                 sc->sc_intr_hdl = NULL;
 274         }
 275         if (irq_err && ih_err) {
 276                 err = bus_teardown_intr(self, irq_err, ih_err);
 277
 278                 if (err)
 279                         device_printf(self, "Could not tear down irq, %d\n",
 280                             err);
 281                 ih_err = NULL;
 282         }
 283         if (irq_err) {
 284                 bus_release_resource(self, SYS_RES_IRQ, 0, irq_err);
 285                 irq_err = NULL;
 286         }
 287         if (sc->sc_irq_res) {
 288                 bus_release_resource(self, SYS_RES_IRQ, 1, sc->sc_irq_res);
 289                 sc->sc_irq_res = NULL;
 290         }
 291         if (sc->sc_io_res) {
 292                 bus_release_resource(self, SYS_RES_MEMORY, 0,
 293                     sc->sc_io_res);
 294                 sc->sc_io_res = NULL;
 295         }
 296         usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
 297
 298         return (0);
 299 }
 300
 301 static int
 302 err_intr(void *arg)
 303 {
 304         ehci_softc_t *sc = arg;
 305         unsigned int cause;
 306
 307         cause = EREAD4(sc, USB_BRIDGE_INTR_CAUSE);
 308         if (cause) {
 309                 printf("USB error: ");
 310                 if (cause & MV_USB_ADDR_DECODE_ERR) {
 311                         uint32_t addr;
 312
 313                         addr = EREAD4(sc, USB_BRIDGE_ERR_ADDR);
 314                         printf("address decoding error (addr=%#x)\n", addr);
 315                 }
 316                 if (cause & MV_USB_HOST_UNDERFLOW)
 317                         printf("host underflow\n");
 318                 if (cause & MV_USB_HOST_OVERFLOW)
 319                         printf("host overflow\n");
 320                 if (cause & MV_USB_DEVICE_UNDERFLOW)
 321                         printf("device underflow\n");
 322                 if (cause & ~(MV_USB_ADDR_DECODE_ERR | MV_USB_HOST_UNDERFLOW |
 323                     MV_USB_HOST_OVERFLOW | MV_USB_DEVICE_UNDERFLOW))
 324                         printf("unknown cause (cause=%#x)\n", cause);
 325
 326                 EWRITE4(sc, USB_BRIDGE_INTR_CAUSE, 0);
 327         }
 328         return (FILTER_HANDLED);
 329 }
 330
 331 static device_method_t ehci_methods[] = {
 332         /* Device interface */
 333         DEVMETHOD(device_probe, mv_ehci_probe),
 334         DEVMETHOD(device_attach, mv_ehci_attach),
 335         DEVMETHOD(device_detach, mv_ehci_detach),
 336         DEVMETHOD(device_suspend, bus_generic_suspend),
 337         DEVMETHOD(device_resume, bus_generic_resume),
 338         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 339
 340         DEVMETHOD_END
 341 };
 342
 343 static driver_t ehci_driver = {
 344         "ehci",
 345         ehci_methods,
 346         sizeof(ehci_softc_t),
 347 };
 348
 349 static devclass_t ehci_devclass;
 350
 351 DRIVER_MODULE(ehci, simplebus, ehci_driver, ehci_devclass, 0, 0);
 352 MODULE_DEPEND(ehci, usb, 1, 1, 1);