sys/arm/nvidia/tegra_ehci.c

   1 /*-
   2  * Copyright (c) 2016 Michal Meloun <mmel@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 /*
  31  * EHCI driver for Tegra SoCs.
  32  */
  33 #include "opt_bus.h"
  34 #include "opt_platform.h"
  35
  36 #include <sys/param.h>
  37 #include <sys/systm.h>
  38 #include <sys/kernel.h>
  39 #include <sys/module.h>
  40 #include <sys/bus.h>
  41 #include <sys/condvar.h>
  42 #include <sys/rman.h>
  43
  44 #include <machine/bus.h>
  45 #include <machine/resource.h>
  46
  47 #include <dev/extres/clk/clk.h>
  48 #include <dev/extres/hwreset/hwreset.h>
  49 #include <dev/extres/phy/phy.h>
  50 #include <dev/ofw/ofw_bus.h>
  51 #include <dev/ofw/ofw_bus_subr.h>
  52 #include <dev/usb/usb.h>
  53 #include <dev/usb/usbdi.h>
  54 #include <dev/usb/usb_busdma.h>
  55 #include <dev/usb/usb_process.h>
  56 #include <dev/usb/usb_controller.h>
  57 #include <dev/usb/usb_bus.h>
  58 #include <dev/usb/controller/ehci.h>
  59 #include <dev/usb/controller/ehcireg.h>
  60
  61 #include "usbdevs.h"
  62
  63 #define TEGRA_EHCI_REG_OFF      0x100
  64 #define TEGRA_EHCI_REG_SIZE     0x100
  65
  66 /* Compatible devices. */
  67 #define TEGRA124_EHCI           1
  68 static struct ofw_compat_data compat_data[] = {
  69         {"nvidia,tegra124-ehci",        (uintptr_t)TEGRA124_EHCI},
  70         {NULL,                  0},
  71 };
  72
  73 struct tegra_ehci_softc {
  74         ehci_softc_t    ehci_softc;
  75         device_t        dev;
  76         struct resource *ehci_mem_res;  /* EHCI core regs. */
  77         struct resource *ehci_irq_res;  /* EHCI core IRQ. */
  78         int             usb_alloc_called;
  79         clk_t           clk;
  80         phy_t           phy;
  81         hwreset_t       reset;
  82 };
  83
  84 static void
  85 tegra_ehci_post_reset(struct ehci_softc *ehci_softc)
  86 {
  87         uint32_t usbmode;
  88
  89         /* Force HOST mode. */
  90         usbmode = EOREAD4(ehci_softc, EHCI_USBMODE_LPM);
  91         usbmode &= ~EHCI_UM_CM;
  92         usbmode |= EHCI_UM_CM_HOST;
  93         device_printf(ehci_softc->sc_bus.bdev, "set host controller mode\n");
  94         EOWRITE4(ehci_softc, EHCI_USBMODE_LPM, usbmode);
  95 }
  96
  97 static int
  98 tegra_ehci_probe(device_t dev)
  99 {
 100
 101         if (!ofw_bus_status_okay(dev))
 102                 return (ENXIO);
 103
 104         if (ofw_bus_search_compatible(dev, compat_data)->ocd_data != 0) {
 105                 device_set_desc(dev, "Nvidia Tegra EHCI controller");
 106                 return (BUS_PROBE_DEFAULT);
 107         }
 108         return (ENXIO);
 109 }
 110
 111 static int
 112 tegra_ehci_detach(device_t dev)
 113 {
 114         struct tegra_ehci_softc *sc;
 115         ehci_softc_t *esc;
 116
 117         sc = device_get_softc(dev);
 118
 119         esc = &sc->ehci_softc;
 120         if (sc->clk != NULL)
 121                 clk_release(sc->clk);
 122         if (esc->sc_bus.bdev != NULL)
 123                 device_delete_child(dev, esc->sc_bus.bdev);
 124         if (esc->sc_flags & EHCI_SCFLG_DONEINIT)
 125                 ehci_detach(esc);
 126         if (esc->sc_intr_hdl != NULL)
 127                 bus_teardown_intr(dev, esc->sc_irq_res,
 128                     esc->sc_intr_hdl);
 129         if (sc->ehci_irq_res != NULL)
 130                 bus_release_resource(dev, SYS_RES_IRQ, 0,
 131                     sc->ehci_irq_res);
 132         if (sc->ehci_mem_res != NULL)
 133                 bus_release_resource(dev, SYS_RES_MEMORY, 0,
 134                     sc->ehci_mem_res);
 135         if (sc->usb_alloc_called)
 136                 usb_bus_mem_free_all(&esc->sc_bus, &ehci_iterate_hw_softc);
 137
 138         /* During module unload there are lots of children leftover. */
 139         device_delete_children(dev);
 140
 141         return (0);
 142 }
 143
 144 static int
 145 tegra_ehci_attach(device_t dev)
 146 {
 147         struct tegra_ehci_softc *sc;
 148         ehci_softc_t *esc;
 149         int rv, rid;
 150         uint64_t freq;
 151         phandle_t node;
 152
 153         sc = device_get_softc(dev);
 154         sc->dev = dev;
 155         node = ofw_bus_get_node(dev);
 156         esc = &sc->ehci_softc;
 157
 158         /* Allocate resources. */
 159         rid = 0;
 160         sc->ehci_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
 161             RF_ACTIVE | RF_SHAREABLE);
 162         if (sc->ehci_mem_res == NULL) {
 163                 device_printf(dev, "Cannot allocate memory resources\n");
 164                 rv = ENXIO;
 165                 goto out;
 166         }
 167
 168         rid = 0;
 169         sc->ehci_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 170             RF_ACTIVE);
 171         if (sc->ehci_irq_res == NULL) {
 172                 device_printf(dev, "Cannot allocate IRQ resources\n");
 173                 rv = ENXIO;
 174                 goto out;
 175         }
 176
 177         rv = hwreset_get_by_ofw_name(dev, 0, "usb", &sc->reset);
 178         if (rv != 0) {
 179                 device_printf(dev, "Cannot get reset\n");
 180                 rv = ENXIO;
 181                 goto out;
 182         }
 183
 184         rv = phy_get_by_ofw_property(sc->dev, 0, "nvidia,phy", &sc->phy);
 185         if (rv != 0) {
 186                 device_printf(sc->dev, "Cannot get 'nvidia,phy' phy\n");
 187                 rv = ENXIO;
 188                 goto out;
 189         }
 190
 191         rv = clk_get_by_ofw_index(sc->dev, 0, 0, &sc->clk);
 192         if (rv != 0) {
 193                 device_printf(dev, "Cannot get clock\n");
 194                 goto out;
 195         }
 196
 197         rv = clk_enable(sc->clk);
 198         if (rv != 0) {
 199                 device_printf(dev, "Cannot enable clock\n");
 200                 goto out;
 201         }
 202
 203         freq = 0;
 204         rv = clk_get_freq(sc->clk, &freq);
 205         if (rv != 0) {
 206                 device_printf(dev, "Cannot get clock frequency\n");
 207                 goto out;
 208         }
 209
 210         rv = hwreset_deassert(sc->reset);
 211         if (rv != 0) {
 212                 device_printf(dev, "Cannot clear reset: %d\n", rv);
 213                 rv = ENXIO;
 214                 goto out;
 215         }
 216
 217         rv = phy_enable(sc->phy);
 218         if (rv != 0) {
 219                 device_printf(dev, "Cannot enable phy: %d\n", rv);
 220                 goto out;
 221         }
 222
 223         /* Fill data for EHCI driver. */
 224         esc->sc_vendor_get_port_speed = ehci_get_port_speed_hostc;
 225         esc->sc_vendor_post_reset = tegra_ehci_post_reset;
 226         esc->sc_io_tag = rman_get_bustag(sc->ehci_mem_res);
 227         esc->sc_bus.parent = dev;
 228         esc->sc_bus.devices = esc->sc_devices;
 229         esc->sc_bus.devices_max = EHCI_MAX_DEVICES;
 230         esc->sc_bus.dma_bits = 32;
 231
 232         /* Allocate all DMA memory. */
 233         rv = usb_bus_mem_alloc_all(&esc->sc_bus, USB_GET_DMA_TAG(dev),
 234             &ehci_iterate_hw_softc);
 235         sc->usb_alloc_called = 1;
 236         if (rv != 0) {
 237                 device_printf(dev, "usb_bus_mem_alloc_all() failed\n");
 238                 rv = ENOMEM;
 239                 goto out;
 240         }
 241
 242         /*
 243          * Set handle to USB related registers subregion used by
 244          * generic EHCI driver.
 245          */
 246         rv = bus_space_subregion(esc->sc_io_tag,
 247             rman_get_bushandle(sc->ehci_mem_res),
 248             TEGRA_EHCI_REG_OFF, TEGRA_EHCI_REG_SIZE, &esc->sc_io_hdl);
 249         if (rv != 0) {
 250                 device_printf(dev, "Could not create USB memory subregion\n");
 251                 rv = ENXIO;
 252                 goto out;
 253         }
 254
 255         /* Setup interrupt handler. */
 256         rv = bus_setup_intr(dev, sc->ehci_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 257             NULL, (driver_intr_t *)ehci_interrupt, esc, &esc->sc_intr_hdl);
 258         if (rv != 0) {
 259                 device_printf(dev, "Could not setup IRQ\n");
 260                 goto out;
 261         }
 262
 263         /* Add USB bus device. */
 264         esc->sc_bus.bdev = device_add_child(dev, "usbus", -1);
 265         if (esc->sc_bus.bdev == NULL) {
 266                 device_printf(dev, "Could not add USB device\n");
 267                 goto out;
 268         }
 269         device_set_ivars(esc->sc_bus.bdev, &esc->sc_bus);
 270
 271         esc->sc_id_vendor = USB_VENDOR_FREESCALE;
 272         strlcpy(esc->sc_vendor, "Nvidia", sizeof(esc->sc_vendor));
 273
 274         /* Set flags that affect ehci_init() behavior. */
 275         esc->sc_flags |= EHCI_SCFLG_TT;
 276         esc->sc_flags |= EHCI_SCFLG_NORESTERM;
 277         rv = ehci_init(esc);
 278         if (rv != 0) {
 279                 device_printf(dev, "USB init failed: %d\n",
 280                     rv);
 281                 goto out;
 282         }
 283         esc->sc_flags |= EHCI_SCFLG_DONEINIT;
 284
 285         /* Probe the bus. */
 286         rv = device_probe_and_attach(esc->sc_bus.bdev);
 287         if (rv != 0) {
 288                 device_printf(dev,
 289                     "device_probe_and_attach() failed\n");
 290                 goto out;
 291         }
 292         return (0);
 293
 294 out:
 295         tegra_ehci_detach(dev);
 296         return (rv);
 297 }
 298
 299 static device_method_t ehci_methods[] = {
 300         /* Device interface */
 301         DEVMETHOD(device_probe, tegra_ehci_probe),
 302         DEVMETHOD(device_attach, tegra_ehci_attach),
 303         DEVMETHOD(device_detach, tegra_ehci_detach),
 304         DEVMETHOD(device_suspend, bus_generic_suspend),
 305         DEVMETHOD(device_resume, bus_generic_resume),
 306         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 307
 308         /* Bus interface */
 309         DEVMETHOD(bus_print_child, bus_generic_print_child),
 310
 311         DEVMETHOD_END
 312 };
 313
 314 static devclass_t ehci_devclass;
 315 static DEFINE_CLASS_0(ehci, ehci_driver, ehci_methods,
 316     sizeof(struct tegra_ehci_softc));
 317 DRIVER_MODULE(tegra_ehci, simplebus, ehci_driver, ehci_devclass, NULL, NULL);
 318 MODULE_DEPEND(tegra_ehci, usb, 1, 1, 1);