2 * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/module.h>
35 #include <sys/malloc.h>
37 #include <sys/timeet.h>
38 #include <sys/timetc.h>
39 #include <sys/watchdog.h>
40 #include <machine/bus.h>
41 #include <machine/cpu.h>
42 #include <machine/intr.h>
44 #include <dev/fdt/fdt_common.h>
45 #include <dev/ofw/openfirm.h>
46 #include <dev/ofw/ofw_bus.h>
47 #include <dev/ofw/ofw_bus_subr.h>
49 #include <machine/bus.h>
50 #include <machine/fdt.h>
52 #include <arm/broadcom/bcm2835/bcm2835_mbox.h>
58 #define REG_SENDER 0x14
59 #define REG_STATUS 0x18
60 #define STATUS_FULL 0x80000000
61 #define STATUS_EMPTY 0x40000000
62 #define REG_CONFIG 0x1C
63 #define CONFIG_DATA_IRQ 0x00000001
64 #define REG_WRITE 0x20 /* This is Mailbox 1 address */
66 #define MBOX_MSG(chan, data) (((data) & ~0xf) | ((chan) & 0xf))
67 #define MBOX_CHAN(msg) ((msg) & 0xf)
68 #define MBOX_DATA(msg) ((msg) & ~0xf)
70 #define MBOX_LOCK(sc) do { \
71 mtx_lock(&(sc)->lock); \
74 #define MBOX_UNLOCK(sc) do { \
75 mtx_unlock(&(sc)->lock); \
79 #define dprintf(fmt, args...) printf(fmt, ##args)
81 #define dprintf(fmt, args...)
84 struct bcm_mbox_softc {
86 struct resource * mem_res;
87 struct resource * irq_res;
90 bus_space_handle_t bsh;
91 int valid[BCM2835_MBOX_CHANS];
92 int msg[BCM2835_MBOX_CHANS];
95 #define mbox_read_4(sc, reg) \
96 bus_space_read_4((sc)->bst, (sc)->bsh, reg)
97 #define mbox_write_4(sc, reg, val) \
98 bus_space_write_4((sc)->bst, (sc)->bsh, reg, val)
101 bcm_mbox_intr(void *arg)
103 struct bcm_mbox_softc *sc = arg;
109 while (!(mbox_read_4(sc, REG_STATUS) & STATUS_EMPTY)) {
110 msg = mbox_read_4(sc, REG_READ);
111 dprintf("bcm_mbox_intr: raw data %08x\n", msg);
112 chan = MBOX_CHAN(msg);
113 data = MBOX_DATA(msg);
114 if (sc->valid[chan]) {
115 printf("bcm_mbox_intr: channel %d oveflow\n", chan);
118 dprintf("bcm_mbox_intr: chan %d, data %08x\n", chan, data);
119 sc->msg[chan] = data;
121 wakeup(&sc->msg[chan]);
128 bcm_mbox_probe(device_t dev)
131 if (!ofw_bus_status_okay(dev))
134 if (ofw_bus_is_compatible(dev, "broadcom,bcm2835-mbox")) {
135 device_set_desc(dev, "BCM2835 VideoCore Mailbox");
136 return(BUS_PROBE_DEFAULT);
143 bcm_mbox_attach(device_t dev)
145 struct bcm_mbox_softc *sc = device_get_softc(dev);
149 sc->mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
150 if (sc->mem_res == NULL) {
151 device_printf(dev, "could not allocate memory resource\n");
155 sc->bst = rman_get_bustag(sc->mem_res);
156 sc->bsh = rman_get_bushandle(sc->mem_res);
159 sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
160 if (sc->irq_res == NULL) {
161 device_printf(dev, "could not allocate interrupt resource\n");
165 /* Setup and enable the timer */
166 if (bus_setup_intr(dev, sc->irq_res, INTR_MPSAFE | INTR_TYPE_MISC,
167 NULL, bcm_mbox_intr, sc, &sc->intr_hl) != 0) {
168 bus_release_resource(dev, SYS_RES_IRQ, rid, sc->irq_res);
169 device_printf(dev, "Unable to setup the clock irq handler.\n");
173 mtx_init(&sc->lock, "vcio mbox", NULL, MTX_DEF);
174 for (i = 0; i < BCM2835_MBOX_CHANS; i++) {
179 /* Read all pending messages */
182 mbox_write_4(sc, REG_CONFIG, CONFIG_DATA_IRQ);
191 bcm_mbox_write(device_t dev, int chan, uint32_t data)
194 struct bcm_mbox_softc *sc = device_get_softc(dev);
196 dprintf("bcm_mbox_write: chan %d, data %08x\n", chan, data);
199 while ((mbox_read_4(sc, REG_STATUS) & STATUS_FULL) && limit--) {
204 printf("bcm_mbox_write: STATUS_FULL stuck");
209 mbox_write_4(sc, REG_WRITE, MBOX_MSG(chan, data));
216 bcm_mbox_read(device_t dev, int chan, uint32_t *data)
218 struct bcm_mbox_softc *sc = device_get_softc(dev);
220 dprintf("bcm_mbox_read: chan %d\n", chan);
222 while (!sc->valid[chan])
223 msleep(&sc->msg[chan], &sc->lock, PZERO, "vcio mbox read", 0);
224 *data = sc->msg[chan];
227 dprintf("bcm_mbox_read: chan %d, data %08x\n", chan, *data);
232 static device_method_t bcm_mbox_methods[] = {
233 DEVMETHOD(device_probe, bcm_mbox_probe),
234 DEVMETHOD(device_attach, bcm_mbox_attach),
236 DEVMETHOD(mbox_read, bcm_mbox_read),
237 DEVMETHOD(mbox_write, bcm_mbox_write),
242 static driver_t bcm_mbox_driver = {
245 sizeof(struct bcm_mbox_softc),
248 static devclass_t bcm_mbox_devclass;
250 DRIVER_MODULE(mbox, simplebus, bcm_mbox_driver, bcm_mbox_devclass, 0, 0);