sys/arm/broadcom/bcm2835/bcm2835_mbox.c

   1 /*-
   2  * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@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 #include <sys/param.h>
  31 #include <sys/systm.h>
  32 #include <sys/bus.h>
  33 #include <sys/kernel.h>
  34 #include <sys/module.h>
  35 #include <sys/malloc.h>
  36 #include <sys/rman.h>
  37 #include <sys/sema.h>
  38 #include <sys/timeet.h>
  39 #include <sys/timetc.h>
  40 #include <sys/watchdog.h>
  41 #include <machine/bus.h>
  42 #include <machine/cpu.h>
  43 #include <machine/intr.h>
  44
  45 #include <dev/fdt/fdt_common.h>
  46 #include <dev/ofw/openfirm.h>
  47 #include <dev/ofw/ofw_bus.h>
  48 #include <dev/ofw/ofw_bus_subr.h>
  49
  50 #include <machine/bus.h>
  51 #include <machine/fdt.h>
  52
  53 #include <arm/broadcom/bcm2835/bcm2835_mbox.h>
  54
  55 #include "mbox_if.h"
  56
  57 #define REG_READ        0x00
  58 #define REG_POL         0x10
  59 #define REG_SENDER      0x14
  60 #define REG_STATUS      0x18
  61 #define         STATUS_FULL     0x80000000
  62 #define         STATUS_EMPTY    0x40000000
  63 #define REG_CONFIG      0x1C
  64 #define         CONFIG_DATA_IRQ 0x00000001
  65 #define REG_WRITE       0x20 /* This is Mailbox 1 address */
  66
  67 #define MBOX_MSG(chan, data)    (((data) & ~0xf) | ((chan) & 0xf))
  68 #define MBOX_CHAN(msg)          ((msg) & 0xf)
  69 #define MBOX_DATA(msg)          ((msg) & ~0xf)
  70
  71 #define MBOX_LOCK(sc)   do {    \
  72         mtx_lock(&(sc)->lock);  \
  73 } while(0)
  74
  75 #define MBOX_UNLOCK(sc) do {            \
  76         mtx_unlock(&(sc)->lock);        \
  77 } while(0)
  78
  79 #undef DEBUG
  80 #ifdef  DEBUG
  81 #define dprintf(fmt, args...) printf(fmt, ##args)
  82 #else
  83 #define dprintf(fmt, args...)
  84 #endif
  85
  86 struct bcm_mbox_softc {
  87         struct mtx              lock;
  88         struct resource *       mem_res;
  89         struct resource *       irq_res;
  90         void*                   intr_hl;
  91         bus_space_tag_t         bst;
  92         bus_space_handle_t      bsh;
  93         int                     msg[BCM2835_MBOX_CHANS];
  94         struct sema             sema[BCM2835_MBOX_CHANS];
  95 };
  96
  97 #define mbox_read_4(sc, reg)            \
  98     bus_space_read_4((sc)->bst, (sc)->bsh, reg)
  99 #define mbox_write_4(sc, reg, val)              \
 100     bus_space_write_4((sc)->bst, (sc)->bsh, reg, val)
 101
 102 static void
 103 bcm_mbox_intr(void *arg)
 104 {
 105         struct bcm_mbox_softc *sc = arg;
 106         int chan;
 107         uint32_t data;
 108         uint32_t msg;
 109
 110         while (!(mbox_read_4(sc, REG_STATUS) & STATUS_EMPTY)) {
 111                 msg = mbox_read_4(sc, REG_READ);
 112                 dprintf("bcm_mbox_intr: raw data %08x\n", msg);
 113                 chan = MBOX_CHAN(msg);
 114                 data = MBOX_DATA(msg);
 115                 if (sc->msg[chan]) {
 116                         printf("bcm_mbox_intr: channel %d oveflow\n", chan);
 117                         continue;
 118                 }
 119                 dprintf("bcm_mbox_intr: chan %d, data %08x\n", chan, data);
 120                 sc->msg[chan] = msg;
 121                 sema_post(&sc->sema[chan]);
 122         }
 123 }
 124
 125 static int
 126 bcm_mbox_probe(device_t dev)
 127 {
 128
 129         if (!ofw_bus_status_okay(dev))
 130                 return (ENXIO);
 131
 132         if (ofw_bus_is_compatible(dev, "broadcom,bcm2835-mbox")) {
 133                 device_set_desc(dev, "BCM2835 VideoCore Mailbox");
 134                 return(BUS_PROBE_DEFAULT);
 135         }
 136
 137         return (ENXIO);
 138 }
 139
 140 static int
 141 bcm_mbox_attach(device_t dev)
 142 {
 143         struct bcm_mbox_softc *sc = device_get_softc(dev);
 144         int i;
 145         int rid = 0;
 146
 147         sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 148         if (sc->mem_res == NULL) {
 149                 device_printf(dev, "could not allocate memory resource\n");
 150                 return (ENXIO);
 151         }
 152
 153         sc->bst = rman_get_bustag(sc->mem_res);
 154         sc->bsh = rman_get_bushandle(sc->mem_res);
 155
 156         rid = 0;
 157         sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
 158         if (sc->irq_res == NULL) {
 159                 device_printf(dev, "could not allocate interrupt resource\n");
 160                 return (ENXIO);
 161         }
 162
 163         /* Setup and enable the timer */
 164         if (bus_setup_intr(dev, sc->irq_res, INTR_MPSAFE | INTR_TYPE_MISC,
 165             NULL, bcm_mbox_intr, sc, &sc->intr_hl) != 0) {
 166                 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->irq_res);
 167                 device_printf(dev, "Unable to setup the clock irq handler.\n");
 168                 return (ENXIO);
 169         }
 170
 171         mtx_init(&sc->lock, "vcio mbox", NULL, MTX_DEF);
 172         for (i = 0; i < BCM2835_MBOX_CHANS; i++) {
 173                 sc->msg[i] = 0;
 174                 sema_init(&sc->sema[i], 0, "mbox");
 175         }
 176
 177         /* Read all pending messages */
 178         while ((mbox_read_4(sc, REG_STATUS) & STATUS_EMPTY) == 0)
 179                 (void)mbox_read_4(sc, REG_READ);
 180
 181         mbox_write_4(sc, REG_CONFIG, CONFIG_DATA_IRQ);
 182
 183         return (0);
 184 }
 185
 186 /*
 187  * Mailbox API
 188  */
 189 static int
 190 bcm_mbox_write(device_t dev, int chan, uint32_t data)
 191 {
 192         int limit = 20000;
 193         struct bcm_mbox_softc *sc = device_get_softc(dev);
 194
 195         dprintf("bcm_mbox_write: chan %d, data %08x\n", chan, data);
 196         MBOX_LOCK(sc);
 197
 198         while ((mbox_read_4(sc, REG_STATUS) & STATUS_FULL) && limit--) {
 199                 DELAY(2);
 200         }
 201
 202         if (limit == 0) {
 203                 printf("bcm_mbox_write: STATUS_FULL stuck");
 204                 MBOX_UNLOCK(sc);
 205                 return (EAGAIN);
 206         }
 207
 208         mbox_write_4(sc, REG_WRITE, MBOX_MSG(chan, data));
 209
 210         MBOX_UNLOCK(sc);
 211         return (0);
 212 }
 213
 214 static int
 215 bcm_mbox_read(device_t dev, int chan, uint32_t *data)
 216 {
 217         struct bcm_mbox_softc *sc = device_get_softc(dev);
 218
 219         dprintf("bcm_mbox_read: chan %d\n", chan);
 220         MBOX_LOCK(sc);
 221         while (sema_trywait(&sc->sema[chan]) == 0) {
 222                 /* do not unlock sc while waiting for the mbox */
 223                 if (sema_timedwait(&sc->sema[chan], 10*hz) == 0)
 224                         break;
 225                 printf("timeout sema for chan %d\n", chan);
 226         }
 227         /*
 228          *  get data from intr handler, the same channel is never coming
 229          *  because of holding sc lock.
 230          */
 231         *data = MBOX_DATA(sc->msg[chan]);
 232         sc->msg[chan] = 0;
 233         MBOX_UNLOCK(sc);
 234         dprintf("bcm_mbox_read: chan %d, data %08x\n", chan, *data);
 235
 236         return (0);
 237 }
 238
 239 static device_method_t bcm_mbox_methods[] = {
 240         DEVMETHOD(device_probe,         bcm_mbox_probe),
 241         DEVMETHOD(device_attach,        bcm_mbox_attach),
 242
 243         DEVMETHOD(mbox_read,            bcm_mbox_read),
 244         DEVMETHOD(mbox_write,           bcm_mbox_write),
 245
 246         DEVMETHOD_END
 247 };
 248
 249 static driver_t bcm_mbox_driver = {
 250         "mbox",
 251         bcm_mbox_methods,
 252         sizeof(struct bcm_mbox_softc),
 253 };
 254
 255 static devclass_t bcm_mbox_devclass;
 256
 257 DRIVER_MODULE(mbox, simplebus, bcm_mbox_driver, bcm_mbox_devclass, 0, 0);
 258