sys/arm/ti/ti_mbox.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2013 Rui Paulo <rpaulo@FreeBSD.org>
   5  * All rights reserved.
   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  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  20  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  22  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  24  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  25  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  */
  28 #include <sys/cdefs.h>
  29 #include <sys/param.h>
  30 #include <sys/systm.h>
  31 #include <sys/bus.h>
  32 #include <sys/kernel.h>
  33 #include <sys/module.h>
  34 #include <sys/malloc.h>
  35 #include <sys/rman.h>
  36 #include <sys/timeet.h>
  37 #include <sys/timetc.h>
  38 #include <sys/watchdog.h>
  39 #include <machine/bus.h>
  40 #include <machine/cpu.h>
  41 #include <machine/frame.h>
  42 #include <machine/intr.h>
  43
  44 #include <dev/ofw/openfirm.h>
  45 #include <dev/ofw/ofw_bus.h>
  46 #include <dev/ofw/ofw_bus_subr.h>
  47
  48 #include <machine/bus.h>
  49
  50 #include <arm/ti/ti_mbox.h>
  51 #include <arm/ti/ti_sysc.h>
  52
  53 #include "mbox_if.h"
  54
  55 #ifdef DEBUG
  56 #define DPRINTF(fmt, ...)       do {    \
  57         printf("%s: ", __func__);       \
  58         printf(fmt, __VA_ARGS__);       \
  59 } while (0)
  60 #else
  61 #define DPRINTF(fmt, ...)
  62 #endif
  63
  64 static device_probe_t           ti_mbox_probe;
  65 static device_attach_t          ti_mbox_attach;
  66 static device_detach_t          ti_mbox_detach;
  67 static void                     ti_mbox_intr(void *);
  68 static int                      ti_mbox_read(device_t, int, uint32_t *);
  69 static int                      ti_mbox_write(device_t, int, uint32_t);
  70
  71 struct ti_mbox_softc {
  72         struct mtx              sc_mtx;
  73         struct resource         *sc_mem_res;
  74         struct resource         *sc_irq_res;
  75         void                    *sc_intr;
  76         bus_space_tag_t         sc_bt;
  77         bus_space_handle_t      sc_bh;
  78 };
  79
  80 #define TI_MBOX_LOCK(sc)        mtx_lock(&(sc)->sc_mtx)
  81 #define TI_MBOX_UNLOCK(sc)      mtx_unlock(&(sc)->sc_mtx)
  82
  83 static device_method_t ti_mbox_methods[] = {
  84         DEVMETHOD(device_probe,         ti_mbox_probe),
  85         DEVMETHOD(device_attach,        ti_mbox_attach),
  86         DEVMETHOD(device_detach,        ti_mbox_detach),
  87
  88         DEVMETHOD(mbox_read,            ti_mbox_read),
  89         DEVMETHOD(mbox_write,           ti_mbox_write),
  90
  91         DEVMETHOD_END
  92 };
  93
  94 static driver_t ti_mbox_driver = {
  95         "ti_mbox",
  96         ti_mbox_methods,
  97         sizeof(struct ti_mbox_softc)
  98 };
  99
 100 DRIVER_MODULE(ti_mbox, simplebus, ti_mbox_driver, 0, 0);
 101 MODULE_DEPEND(ti_mbox, ti_sysc, 1, 1, 1);
 102
 103 static __inline uint32_t
 104 ti_mbox_reg_read(struct ti_mbox_softc *sc, uint16_t reg)
 105 {
 106         return (bus_space_read_4(sc->sc_bt, sc->sc_bh, reg));
 107 }
 108
 109 static __inline void
 110 ti_mbox_reg_write(struct ti_mbox_softc *sc, uint16_t reg, uint32_t val)
 111 {
 112         bus_space_write_4(sc->sc_bt, sc->sc_bh, reg, val);
 113 }
 114
 115 static int
 116 ti_mbox_probe(device_t dev)
 117 {
 118
 119         if (!ofw_bus_status_okay(dev))
 120                 return (ENXIO);
 121
 122         if (ofw_bus_is_compatible(dev, "ti,omap4-mailbox")) {
 123                 device_set_desc(dev, "TI System Mailbox");
 124                 return (BUS_PROBE_DEFAULT);
 125         }
 126
 127         return (ENXIO);
 128 }
 129
 130 static int
 131 ti_mbox_attach(device_t dev)
 132 {
 133         struct ti_mbox_softc *sc;
 134         int rid, delay, chan;
 135         uint32_t rev, sysconfig;
 136
 137         if (ti_sysc_clock_enable(device_get_parent(dev)) != 0) {
 138                 device_printf(dev, "could not enable MBOX clock\n");
 139                 return (ENXIO);
 140         }
 141
 142         sc = device_get_softc(dev);
 143         rid = 0;
 144         mtx_init(&sc->sc_mtx, "TI mbox", NULL, MTX_DEF);
 145         sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
 146             RF_ACTIVE);
 147         if (sc->sc_mem_res == NULL) {
 148                 device_printf(dev, "could not allocate memory resource\n");
 149                 return (ENXIO);
 150         }
 151         sc->sc_bt = rman_get_bustag(sc->sc_mem_res);
 152         sc->sc_bh = rman_get_bushandle(sc->sc_mem_res);
 153         rid = 0;
 154         sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 155             RF_ACTIVE);
 156         if (sc->sc_irq_res == NULL) {
 157                 device_printf(dev, "could not allocate interrupt resource\n");
 158                 ti_mbox_detach(dev);
 159                 return (ENXIO);
 160         }
 161         if (bus_setup_intr(dev, sc->sc_irq_res, INTR_MPSAFE | INTR_TYPE_MISC,
 162             NULL, ti_mbox_intr, sc, &sc->sc_intr) != 0) {
 163                 device_printf(dev, "unable to setup the interrupt handler\n");
 164                 ti_mbox_detach(dev);
 165                 return (ENXIO);
 166         }
 167         /*
 168          * Reset the controller.
 169          */
 170         sysconfig = ti_mbox_reg_read(sc, TI_MBOX_SYSCONFIG);
 171         DPRINTF("initial sysconfig %d\n", sysconfig);
 172         sysconfig |= TI_MBOX_SYSCONFIG_SOFTRST;
 173         ti_mbox_reg_write(sc, TI_MBOX_SYSCONFIG, sysconfig);
 174         delay = 100;
 175         while (ti_mbox_reg_read(sc, TI_MBOX_SYSCONFIG) &
 176             TI_MBOX_SYSCONFIG_SOFTRST) {
 177                 delay--;
 178                 DELAY(10);
 179         }
 180         if (delay == 0) {
 181                 device_printf(dev, "controller reset failed\n");
 182                 ti_mbox_detach(dev);
 183                 return (ENXIO);
 184         }
 185         /*
 186          * Enable smart idle mode.
 187          */
 188         ti_mbox_reg_write(sc, TI_MBOX_SYSCONFIG,
 189             ti_mbox_reg_read(sc, TI_MBOX_SYSCONFIG) | TI_MBOX_SYSCONFIG_SMARTIDLE);
 190         rev = ti_mbox_reg_read(sc,
 191             ti_sysc_get_rev_address_offset_host(device_get_parent(dev)));
 192         DPRINTF("rev %d\n", rev);
 193         device_printf(dev, "revision %d.%d\n", (rev >> 8) & 0x4, rev & 0x40);
 194         /*
 195          * Enable message interrupts.
 196          */
 197         for (chan = 0; chan < 8; chan++)
 198                 ti_mbox_reg_write(sc, TI_MBOX_IRQENABLE_SET(chan), 1);
 199
 200         return (0);
 201 }
 202
 203 static int
 204 ti_mbox_detach(device_t dev)
 205 {
 206         struct ti_mbox_softc *sc;
 207
 208         sc = device_get_softc(dev);
 209         if (sc->sc_intr)
 210                 bus_teardown_intr(dev, sc->sc_irq_res, sc->sc_intr);
 211         if (sc->sc_irq_res)
 212                 bus_release_resource(dev, SYS_RES_IRQ, rman_get_rid(sc->sc_irq_res),
 213                     sc->sc_irq_res);
 214         if (sc->sc_mem_res)
 215                 bus_release_resource(dev, SYS_RES_MEMORY, rman_get_rid(sc->sc_mem_res),
 216                     sc->sc_mem_res);
 217
 218         return (0);
 219 }
 220
 221 static void
 222 ti_mbox_intr(void *arg)
 223 {
 224         DPRINTF("interrupt %p", arg);
 225 }
 226
 227 static int
 228 ti_mbox_read(device_t dev, int chan, uint32_t *data)
 229 {
 230         struct ti_mbox_softc *sc;
 231
 232         if (chan < 0 || chan > 7)
 233                 return (EINVAL);
 234         sc = device_get_softc(dev);
 235
 236         return (ti_mbox_reg_read(sc, TI_MBOX_MESSAGE(chan)));
 237 }
 238
 239 static int
 240 ti_mbox_write(device_t dev, int chan, uint32_t data)
 241 {
 242         int limit = 500;
 243         struct ti_mbox_softc *sc;
 244
 245         if (chan < 0 || chan > 7)
 246                 return (EINVAL);
 247         sc = device_get_softc(dev);
 248         TI_MBOX_LOCK(sc);
 249         /* XXX implement interrupt method */
 250         while (ti_mbox_reg_read(sc, TI_MBOX_FIFOSTATUS(chan)) == 1 &&
 251             limit--) {
 252                 DELAY(10);
 253         }
 254         if (limit == 0) {
 255                 device_printf(dev, "FIFOSTAUS%d stuck\n", chan);
 256                 TI_MBOX_UNLOCK(sc);
 257                 return (EAGAIN);
 258         }
 259         ti_mbox_reg_write(sc, TI_MBOX_MESSAGE(chan), data);
 260
 261         return (0);
 262 }