1 /*- 2 * Copyright (c) 2013 Rui Paulo <rpaulo@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 ``AS IS'' AND ANY EXPRESS OR 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 17 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, 18 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 19 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 20 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 22 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 23 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 24 * POSSIBILITY OF SUCH DAMAGE. 25 */ 26 #include <sys/cdefs.h> 27 __FBSDID("$FreeBSD$"); 28 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_prcm.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 static devclass_t ti_mbox_devclass; 101 102 DRIVER_MODULE(ti_mbox, simplebus, ti_mbox_driver, ti_mbox_devclass, 0, 0); 103 104 static __inline uint32_t 105 ti_mbox_reg_read(struct ti_mbox_softc *sc, uint16_t reg) 106 { 107 return (bus_space_read_4(sc->sc_bt, sc->sc_bh, reg)); 108 } 109 110 static __inline void 111 ti_mbox_reg_write(struct ti_mbox_softc *sc, uint16_t reg, uint32_t val) 112 { 113 bus_space_write_4(sc->sc_bt, sc->sc_bh, reg, val); 114 } 115 116 static int 117 ti_mbox_probe(device_t dev) 118 { 119 120 if (!ofw_bus_status_okay(dev)) 121 return (ENXIO); 122 123 if (ofw_bus_is_compatible(dev, "ti,omap4-mailbox")) { 124 device_set_desc(dev, "TI System Mailbox"); 125 return (BUS_PROBE_DEFAULT); 126 } 127 128 return (ENXIO); 129 } 130 131 static int 132 ti_mbox_attach(device_t dev) 133 { 134 struct ti_mbox_softc *sc; 135 int rid, delay, chan; 136 uint32_t rev, sysconfig; 137 138 if (ti_prcm_clk_enable(MAILBOX0_CLK) != 0) { 139 device_printf(dev, "could not enable MBOX clock\n"); 140 return (ENXIO); 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 delay = 100; 174 while (ti_mbox_reg_read(sc, TI_MBOX_SYSCONFIG) & 175 TI_MBOX_SYSCONFIG_SOFTRST) { 176 delay--; 177 DELAY(10); 178 } 179 if (delay == 0) { 180 device_printf(dev, "controller reset failed\n"); 181 ti_mbox_detach(dev); 182 return (ENXIO); 183 } 184 /* 185 * Enable smart idle mode. 186 */ 187 ti_mbox_reg_write(sc, TI_MBOX_SYSCONFIG, 188 ti_mbox_reg_read(sc, TI_MBOX_SYSCONFIG) | TI_MBOX_SYSCONFIG_SMARTIDLE); 189 rev = ti_mbox_reg_read(sc, TI_MBOX_REVISION); 190 DPRINTF("rev %d\n", rev); 191 device_printf(dev, "revision %d.%d\n", (rev >> 8) & 0x4, rev & 0x40); 192 /* 193 * Enable message interrupts. 194 */ 195 for (chan = 0; chan < 8; chan++) 196 ti_mbox_reg_write(sc, TI_MBOX_IRQENABLE_SET(chan), 1); 197 198 return (0); 199 } 200 201 static int 202 ti_mbox_detach(device_t dev) 203 { 204 struct ti_mbox_softc *sc; 205 206 sc = device_get_softc(dev); 207 if (sc->sc_intr) 208 bus_teardown_intr(dev, sc->sc_irq_res, sc->sc_intr); 209 if (sc->sc_irq_res) 210 bus_release_resource(dev, SYS_RES_IRQ, rman_get_rid(sc->sc_irq_res), 211 sc->sc_irq_res); 212 if (sc->sc_mem_res) 213 bus_release_resource(dev, SYS_RES_MEMORY, rman_get_rid(sc->sc_mem_res), 214 sc->sc_mem_res); 215 216 return (0); 217 } 218 219 static void 220 ti_mbox_intr(void *arg) 221 { 222 struct ti_mbox_softc *sc; 223 224 sc = arg; 225 DPRINTF("interrupt %p", sc); 226 } 227 228 static int 229 ti_mbox_read(device_t dev, int chan, uint32_t *data) 230 { 231 struct ti_mbox_softc *sc; 232 233 if (chan < 0 || chan > 7) 234 return (EINVAL); 235 sc = device_get_softc(dev); 236 237 return (ti_mbox_reg_read(sc, TI_MBOX_MESSAGE(chan))); 238 } 239 240 static int 241 ti_mbox_write(device_t dev, int chan, uint32_t data) 242 { 243 int limit = 500; 244 struct ti_mbox_softc *sc; 245 246 if (chan < 0 || chan > 7) 247 return (EINVAL); 248 sc = device_get_softc(dev); 249 TI_MBOX_LOCK(sc); 250 /* XXX implement interrupt method */ 251 while (ti_mbox_reg_read(sc, TI_MBOX_FIFOSTATUS(chan)) == 1 && 252 limit--) { 253 DELAY(10); 254 } 255 if (limit == 0) { 256 device_printf(dev, "FIFOSTAUS%d stuck\n", chan); 257 TI_MBOX_UNLOCK(sc); 258 return (EAGAIN); 259 } 260 ti_mbox_reg_write(sc, TI_MBOX_MESSAGE(chan), data); 261 262 return (0); 263 } 264