2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012-2017 Oleksandr Tymoshenko <gonzo@bluezbox.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
35 #include <sys/kernel.h>
37 #include <sys/module.h>
40 #include <machine/bus.h>
41 #include <machine/intr.h>
43 #include <dev/ofw/openfirm.h>
44 #include <dev/ofw/ofw_bus.h>
45 #include <dev/ofw/ofw_bus_subr.h>
50 #define dprintf(fmt, args...) printf(fmt, ##args)
52 #define dprintf(fmt, args...)
55 #define VICIRQSTATUS 0x000
56 #define VICFIQSTATUS 0x004
57 #define VICRAWINTR 0x008
58 #define VICINTSELECT 0x00C
59 #define VICINTENABLE 0x010
60 #define VICINTENCLEAR 0x014
61 #define VICSOFTINT 0x018
62 #define VICSOFTINTCLEAR 0x01C
63 #define VICPROTECTION 0x020
64 #define VICPERIPHID 0xFE0
65 #define VICPRIMECELLID 0xFF0
69 struct pl190_intc_irqsrc {
70 struct intr_irqsrc isrc;
74 struct pl190_intc_softc {
77 struct resource * intc_res;
78 struct pl190_intc_irqsrc isrcs[VIC_NIRQS];
81 #define INTC_VIC_READ_4(sc, reg) \
82 bus_read_4(sc->intc_res, (reg))
83 #define INTC_VIC_WRITE_4(sc, reg, val) \
84 bus_write_4(sc->intc_res, (reg), (val))
86 #define VIC_LOCK(_sc) mtx_lock_spin(&(_sc)->mtx)
87 #define VIC_UNLOCK(_sc) mtx_unlock_spin(&(_sc)->mtx)
90 pl190_intc_irq_dispatch(struct pl190_intc_softc *sc, u_int irq,
93 struct pl190_intc_irqsrc *src;
95 src = &sc->isrcs[irq];
96 if (intr_isrc_dispatch(&src->isrc, tf) != 0)
97 device_printf(sc->dev, "Stray irq %u detected\n", irq);
101 pl190_intc_intr(void *arg)
103 struct pl190_intc_softc *sc;
105 uint32_t num, pending;
106 struct trapframe *tf;
109 cpu = PCPU_GET(cpuid);
110 tf = curthread->td_intr_frame;
113 pending = INTC_VIC_READ_4(sc, VICIRQSTATUS);
115 for (num = 0 ; num < VIC_NIRQS; num++) {
116 if (pending & (1 << num))
117 pl190_intc_irq_dispatch(sc, num, tf);
120 return (FILTER_HANDLED);
124 pl190_intc_disable_intr(device_t dev, struct intr_irqsrc *isrc)
126 struct pl190_intc_softc *sc;
127 struct pl190_intc_irqsrc *src;
129 sc = device_get_softc(dev);
130 src = (struct pl190_intc_irqsrc *)isrc;
133 INTC_VIC_WRITE_4(sc, VICINTENCLEAR, (1 << src->irq));
138 pl190_intc_enable_intr(device_t dev, struct intr_irqsrc *isrc)
140 struct pl190_intc_softc *sc;
141 struct pl190_intc_irqsrc *src;
143 sc = device_get_softc(dev);
144 src = (struct pl190_intc_irqsrc *)isrc;
147 INTC_VIC_WRITE_4(sc, VICINTENABLE, (1 << src->irq));
152 pl190_intc_map_intr(device_t dev, struct intr_map_data *data,
153 struct intr_irqsrc **isrcp)
155 struct intr_map_data_fdt *daf;
156 struct pl190_intc_softc *sc;
158 if (data->type != INTR_MAP_DATA_FDT)
161 daf = (struct intr_map_data_fdt *)data;
162 if (daf->ncells != 1 || daf->cells[0] >= VIC_NIRQS)
165 sc = device_get_softc(dev);
166 *isrcp = &sc->isrcs[daf->cells[0]].isrc;
171 pl190_intc_pre_ithread(device_t dev, struct intr_irqsrc *isrc)
173 pl190_intc_disable_intr(dev, isrc);
177 pl190_intc_post_ithread(device_t dev, struct intr_irqsrc *isrc)
179 struct pl190_intc_irqsrc *src;
181 src = (struct pl190_intc_irqsrc *)isrc;
182 pl190_intc_enable_intr(dev, isrc);
183 arm_irq_memory_barrier(src->irq);
187 pl190_intc_post_filter(device_t dev, struct intr_irqsrc *isrc)
189 struct pl190_intc_irqsrc *src;
191 src = (struct pl190_intc_irqsrc *)isrc;
192 arm_irq_memory_barrier(src->irq);
196 pl190_intc_setup_intr(device_t dev, struct intr_irqsrc *isrc,
197 struct resource *res, struct intr_map_data *data)
204 pl190_intc_probe(device_t dev)
207 if (!ofw_bus_status_okay(dev))
210 if (!ofw_bus_is_compatible(dev, "arm,versatile-vic"))
212 device_set_desc(dev, "ARM PL190 VIC");
213 return (BUS_PROBE_DEFAULT);
217 pl190_intc_attach(device_t dev)
219 struct pl190_intc_softc *sc;
222 struct pl190_intc_irqsrc *isrcs;
223 struct intr_pic *pic;
229 sc = device_get_softc(dev);
231 mtx_init(&sc->mtx, device_get_nameunit(dev), "pl190",
234 /* Request memory resources */
236 sc->intc_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
238 if (sc->intc_res == NULL) {
239 device_printf(dev, "Error: could not allocate memory resources\n");
244 * All interrupts should use IRQ line
246 INTC_VIC_WRITE_4(sc, VICINTSELECT, 0x00000000);
247 /* Disable all interrupts */
248 INTC_VIC_WRITE_4(sc, VICINTENCLEAR, 0xffffffff);
251 for (i = 3; i >= 0; i--) {
253 (INTC_VIC_READ_4(sc, VICPERIPHID + i*4) & 0xff);
256 device_printf(dev, "Peripheral ID: %08x\n", id);
259 for (i = 3; i >= 0; i--) {
261 (INTC_VIC_READ_4(sc, VICPRIMECELLID + i*4) & 0xff);
264 device_printf(dev, "PrimeCell ID: %08x\n", id);
268 name = device_get_nameunit(sc->dev);
269 for (irq = 0; irq < VIC_NIRQS; irq++) {
270 isrcs[irq].irq = irq;
271 error = intr_isrc_register(&isrcs[irq].isrc, sc->dev,
272 0, "%s,%u", name, irq);
277 xref = OF_xref_from_node(ofw_bus_get_node(sc->dev));
278 pic = intr_pic_register(sc->dev, xref);
282 return (intr_pic_claim_root(sc->dev, xref, pl190_intc_intr, sc, 0));
285 static device_method_t pl190_intc_methods[] = {
286 DEVMETHOD(device_probe, pl190_intc_probe),
287 DEVMETHOD(device_attach, pl190_intc_attach),
289 DEVMETHOD(pic_disable_intr, pl190_intc_disable_intr),
290 DEVMETHOD(pic_enable_intr, pl190_intc_enable_intr),
291 DEVMETHOD(pic_map_intr, pl190_intc_map_intr),
292 DEVMETHOD(pic_post_filter, pl190_intc_post_filter),
293 DEVMETHOD(pic_post_ithread, pl190_intc_post_ithread),
294 DEVMETHOD(pic_pre_ithread, pl190_intc_pre_ithread),
295 DEVMETHOD(pic_setup_intr, pl190_intc_setup_intr),
300 static driver_t pl190_intc_driver = {
303 sizeof(struct pl190_intc_softc),
306 static devclass_t pl190_intc_devclass;
308 EARLY_DRIVER_MODULE(intc, simplebus, pl190_intc_driver, pl190_intc_devclass,
309 0, 0, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);