/*- * Copyright (c) 2016 Landon Fuller * Copyright (c) 2017 The FreeBSD Foundation * All rights reserved. * * Portions of this software were developed by Landon Fuller * under sponsorship from the FreeBSD Foundation. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer, * without modification. * 2. Redistributions in binary form must reproduce at minimum a disclaimer * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any * redistribution must be conditioned upon including a substantially * similar Disclaimer requirement for further binary redistribution. * * NO WARRANTY * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF * THE POSSIBILITY OF SUCH DAMAGES. */ #include #include #include #include #include #include #include #include #include #include #include #include #include "pic_if.h" #include "bcm_mipsvar.h" #include "bcm_bmipsreg.h" /* * BMIPS32 and BMIPS3300 core driver. * * These cores are only found on siba(4) chipsets, allowing * us to assume the availability of siba interrupt registers. */ struct bcm_bmips_softc; static int bcm_bmips_pic_intr(void *arg); static void bcm_bmips_mask_irq(struct bcm_bmips_softc *sc, u_int mips_irq, u_int ivec); static void bcm_bmips_unmask_irq(struct bcm_bmips_softc *sc, u_int mips_irq, u_int ivec); static const struct bhnd_device bcm_bmips_devs[] = { BHND_DEVICE(BCM, MIPS33, NULL, NULL, BHND_DF_SOC), BHND_DEVICE_END }; struct bcm_bmips_softc { struct bcm_mips_softc bcm_mips; /**< parent softc */ device_t dev; struct resource *mem; /**< cpu core registers */ int mem_rid; struct resource *cfg; /**< cpu core's cfg0 register block */ int cfg_rid; }; #define BCM_BMIPS_NCPU_IRQS 5 /**< MIPS HW IRQs 0-4 are assignable */ #define BCM_BMIPS_TIMER_IRQ 5 /**< MIPS HW IRQ5 is always assigned to the timer */ static int bcm_bmips_probe(device_t dev) { const struct bhnd_device *id; id = bhnd_device_lookup(dev, bcm_bmips_devs, sizeof(bcm_bmips_devs[0])); if (id == NULL) return (ENXIO); /* Check the chip type; should only be found on siba(4) chipsets */ if (bhnd_get_chipid(dev)->chip_type != BHND_CHIPTYPE_SIBA) return (ENXIO); bhnd_set_default_core_desc(dev); return (BUS_PROBE_DEFAULT); } static int bcm_bmips_attach(device_t dev) { struct bcm_bmips_softc *sc; int error; sc = device_get_softc(dev); sc->dev = dev; /* Allocate our core's register block */ sc->mem_rid = 0; sc->mem = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->mem_rid, RF_ACTIVE); if (sc->mem == NULL) { device_printf(dev, "failed to allocate cpu register block\n"); error = ENXIO; goto failed; } /* Determine the resource ID for our siba CFG0 registers */ sc->cfg_rid = bhnd_get_port_rid(dev, BHND_PORT_AGENT, 0, 0); if (sc->cfg_rid == -1) { device_printf(dev, "missing required cfg0 register block\n"); error = ENXIO; goto failed; } /* Allocate our CFG0 register block */ sc->cfg = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &sc->cfg_rid, RF_ACTIVE|RF_SHAREABLE); if (sc->cfg == NULL) { device_printf(dev, "failed to allocate cfg0 register block\n"); error = ENXIO; goto failed; } /* Clear interrupt map */ bus_write_4(sc->cfg, SIBA_CFG0_INTVEC, 0x0); /* MIPS IRQ0 */ bus_write_4(sc->cfg, SIBA_CFG0_IPSFLAG, 0x0); /* MIPS IRQ1-4 */ /* Initialize the generic BHND MIPS driver state */ error = bcm_mips_attach(dev, BCM_BMIPS_NCPU_IRQS, BCM_BMIPS_TIMER_IRQ, bcm_bmips_pic_intr); if (error) goto failed; return (0); failed: if (sc->mem != NULL) bus_release_resource(dev, SYS_RES_MEMORY, sc->mem_rid, sc->mem); if (sc->cfg != NULL) bus_release_resource(dev, SYS_RES_MEMORY, sc->cfg_rid, sc->cfg); return (error); } static int bcm_bmips_detach(device_t dev) { struct bcm_bmips_softc *sc; int error; sc = device_get_softc(dev); if ((error = bcm_mips_detach(dev))) return (error); bus_release_resource(dev, SYS_RES_MEMORY, sc->mem_rid, sc->mem); bus_release_resource(dev, SYS_RES_MEMORY, sc->cfg_rid, sc->cfg); return (0); } /* PIC_DISABLE_INTR() */ static void bcm_bmips_pic_disable_intr(device_t dev, struct intr_irqsrc *irqsrc) { struct bcm_bmips_softc *sc; struct bcm_mips_irqsrc *isrc; sc = device_get_softc(dev); isrc = (struct bcm_mips_irqsrc *)irqsrc; KASSERT(isrc->cpuirq != NULL, ("no assigned MIPS IRQ")); bcm_bmips_mask_irq(sc, isrc->cpuirq->mips_irq, isrc->ivec); } /* PIC_ENABLE_INTR() */ static void bcm_bmips_pic_enable_intr(device_t dev, struct intr_irqsrc *irqsrc) { struct bcm_bmips_softc *sc; struct bcm_mips_irqsrc *isrc; sc = device_get_softc(dev); isrc = (struct bcm_mips_irqsrc *)irqsrc; KASSERT(isrc->cpuirq != NULL, ("no assigned MIPS IRQ")); bcm_bmips_unmask_irq(sc, isrc->cpuirq->mips_irq, isrc->ivec); } /* PIC_PRE_ITHREAD() */ static void bcm_bmips_pic_pre_ithread(device_t dev, struct intr_irqsrc *isrc) { bcm_bmips_pic_disable_intr(dev, isrc); } /* PIC_POST_ITHREAD() */ static void bcm_bmips_pic_post_ithread(device_t dev, struct intr_irqsrc *isrc) { bcm_bmips_pic_enable_intr(dev, isrc); } /* PIC_POST_FILTER() */ static void bcm_bmips_pic_post_filter(device_t dev, struct intr_irqsrc *isrc) { } /** * Disable routing of backplane interrupt vector @p ivec to MIPS IRQ * @p mips_irq. */ static void bcm_bmips_mask_irq(struct bcm_bmips_softc *sc, u_int mips_irq, u_int ivec) { KASSERT(ivec < SIBA_MAX_INTR, ("invalid sbflag# ivec")); KASSERT(mips_irq < sc->bcm_mips.num_cpuirqs, ("invalid MIPS IRQ %u", mips_irq)); if (mips_irq == 0) { uint32_t sbintvec; sbintvec = bus_read_4(sc->cfg, SIBA_CFG0_INTVEC); sbintvec &= ~(1 << ivec); bus_write_4(sc->cfg, SIBA_CFG0_INTVEC, sbintvec); } else { uint32_t ipsflag; /* Can we route this via ipsflag? */ KASSERT(((1 << ivec) & SIBA_IPS_INT1_MASK) != 0, ("cannot route high sbflag# ivec %u", ivec)); ipsflag = bus_read_4(sc->cfg, SIBA_CFG0_IPSFLAG); ipsflag &= ~( ((1 << ivec) << SIBA_IPS_INT_SHIFT(mips_irq)) & SIBA_IPS_INT_MASK(mips_irq)); bus_write_4(sc->cfg, SIBA_CFG0_IPSFLAG, ipsflag); } } /** * Enable routing of an interrupt. */ static void bcm_bmips_unmask_irq(struct bcm_bmips_softc *sc, u_int mips_irq, u_int ivec) { KASSERT(ivec < SIBA_MAX_INTR, ("invalid sbflag# ivec")); KASSERT(mips_irq < sc->bcm_mips.num_cpuirqs, ("invalid MIPS IRQ %u", mips_irq)); if (mips_irq == 0) { uint32_t sbintvec; sbintvec = bus_read_4(sc->cfg, SIBA_CFG0_INTVEC); sbintvec |= (1 << ivec); bus_write_4(sc->cfg, SIBA_CFG0_INTVEC, sbintvec); } else { uint32_t ipsflag; /* Can we route this via ipsflag? */ KASSERT(((1 << ivec) & SIBA_IPS_INT1_MASK) != 0, ("cannot route high sbflag# ivec %u", ivec)); ipsflag = bus_read_4(sc->cfg, SIBA_CFG0_IPSFLAG); ipsflag |= (ivec << SIBA_IPS_INT_SHIFT(mips_irq)) & SIBA_IPS_INT_MASK(mips_irq); bus_write_4(sc->cfg, SIBA_CFG0_IPSFLAG, ipsflag); } } /* our MIPS CPU interrupt filter */ static int bcm_bmips_pic_intr(void *arg) { struct bcm_bmips_softc *sc; struct bcm_mips_cpuirq *cpuirq; struct bcm_mips_irqsrc *isrc_solo; uint32_t sbintvec, sbstatus; u_int mips_irq, i; int error; cpuirq = arg; sc = (struct bcm_bmips_softc*)cpuirq->sc; /* Fetch current interrupt state */ sbstatus = bus_read_4(sc->cfg, SIBA_CFG0_FLAGST); /* Fetch mask of interrupt vectors routed to this MIPS IRQ */ mips_irq = cpuirq->mips_irq; if (mips_irq == 0) { sbintvec = bus_read_4(sc->cfg, SIBA_CFG0_INTVEC); } else { uint32_t ipsflag; ipsflag = bus_read_4(sc->cfg, SIBA_CFG0_IPSFLAG); /* Map to an intvec-compatible representation */ switch (mips_irq) { case 1: sbintvec = (ipsflag & SIBA_IPS_INT1_MASK) >> SIBA_IPS_INT1_SHIFT; break; case 2: sbintvec = (ipsflag & SIBA_IPS_INT2_MASK) >> SIBA_IPS_INT2_SHIFT; break; case 3: sbintvec = (ipsflag & SIBA_IPS_INT3_MASK) >> SIBA_IPS_INT3_SHIFT; break; case 4: sbintvec = (ipsflag & SIBA_IPS_INT4_MASK) >> SIBA_IPS_INT4_SHIFT; break; default: panic("invalid irq %u", mips_irq); } } /* Ignore interrupts not routed to this MIPS IRQ */ sbstatus &= sbintvec; /* Handle isrc_solo direct dispatch path */ isrc_solo = cpuirq->isrc_solo; if (isrc_solo != NULL) { if (sbstatus & BCM_MIPS_IVEC_MASK(isrc_solo)) { error = intr_isrc_dispatch(&isrc_solo->isrc, curthread->td_intr_frame); if (error) { device_printf(sc->dev, "Stray interrupt %u " "detected\n", isrc_solo->ivec); bcm_bmips_pic_disable_intr(sc->dev, &isrc_solo->isrc); } } sbstatus &= ~(BCM_MIPS_IVEC_MASK(isrc_solo)); if (sbstatus == 0) return (FILTER_HANDLED); /* Report and mask additional stray interrupts */ while ((i = fls(sbstatus)) != 0) { i--; /* Get a 0-offset interrupt. */ sbstatus &= ~(1 << i); device_printf(sc->dev, "Stray interrupt %u " "detected\n", i); bcm_bmips_mask_irq(sc, mips_irq, i); } return (FILTER_HANDLED); } /* Standard dispatch path */ while ((i = fls(sbstatus)) != 0) { i--; /* Get a 0-offset interrupt. */ sbstatus &= ~(1 << i); KASSERT(i < nitems(sc->bcm_mips.isrcs), ("invalid ivec %u", i)); error = intr_isrc_dispatch(&sc->bcm_mips.isrcs[i].isrc, curthread->td_intr_frame); if (error) { device_printf(sc->dev, "Stray interrupt %u detected\n", i); bcm_bmips_mask_irq(sc, mips_irq, i); continue; } } return (FILTER_HANDLED); } static device_method_t bcm_bmips_methods[] = { /* Device interface */ DEVMETHOD(device_probe, bcm_bmips_probe), DEVMETHOD(device_attach, bcm_bmips_attach), DEVMETHOD(device_detach, bcm_bmips_detach), /* Interrupt controller interface */ DEVMETHOD(pic_disable_intr, bcm_bmips_pic_disable_intr), DEVMETHOD(pic_enable_intr, bcm_bmips_pic_enable_intr), DEVMETHOD(pic_pre_ithread, bcm_bmips_pic_pre_ithread), DEVMETHOD(pic_post_ithread, bcm_bmips_pic_post_ithread), DEVMETHOD(pic_post_filter, bcm_bmips_pic_post_filter), DEVMETHOD_END }; static devclass_t bcm_mips_devclass; DEFINE_CLASS_1(bcm_mips, bcm_bmips_driver, bcm_bmips_methods, sizeof(struct bcm_bmips_softc), bcm_mips_driver); EARLY_DRIVER_MODULE(bcm_bmips, bhnd, bcm_bmips_driver, bcm_mips_devclass, 0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE); MODULE_VERSION(bcm_bmips, 1); MODULE_DEPEND(bcm_bmips, bhnd, 1, 1, 1);