2 * Copyright (c) 2011 The FreeBSD Foundation
5 * Developed by Damjan Marion <damjan.marion@gmail.com>
7 * Based on OMAP4 GIC code by Ben Gray
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. The name of the company nor the name of the author may be used to
18 * endorse or promote products derived from this software without specific
19 * prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/systm.h>
40 #include <sys/kernel.h>
42 #include <sys/module.h>
46 #include <sys/cpuset.h>
48 #include <sys/mutex.h>
49 #include <machine/bus.h>
50 #include <machine/intr.h>
51 #include <machine/smp.h>
53 #include <dev/fdt/fdt_common.h>
54 #include <dev/ofw/openfirm.h>
55 #include <dev/ofw/ofw_bus.h>
56 #include <dev/ofw/ofw_bus_subr.h>
58 /* We are using GICv2 register naming */
60 /* Distributor Registers */
61 #define GICD_CTLR 0x000 /* v1 ICDDCR */
62 #define GICD_TYPER 0x004 /* v1 ICDICTR */
63 #define GICD_IIDR 0x008 /* v1 ICDIIDR */
64 #define GICD_IGROUPR(n) (0x0080 + ((n) * 4)) /* v1 ICDISER */
65 #define GICD_ISENABLER(n) (0x0100 + ((n) * 4)) /* v1 ICDISER */
66 #define GICD_ICENABLER(n) (0x0180 + ((n) * 4)) /* v1 ICDICER */
67 #define GICD_ISPENDR(n) (0x0200 + ((n) * 4)) /* v1 ICDISPR */
68 #define GICD_ICPENDR(n) (0x0280 + ((n) * 4)) /* v1 ICDICPR */
69 #define GICD_ICACTIVER(n) (0x0380 + ((n) * 4)) /* v1 ICDABR */
70 #define GICD_IPRIORITYR(n) (0x0400 + ((n) * 4)) /* v1 ICDIPR */
71 #define GICD_ITARGETSR(n) (0x0800 + ((n) * 4)) /* v1 ICDIPTR */
72 #define GICD_ICFGR(n) (0x0C00 + ((n) * 4)) /* v1 ICDICFR */
73 #define GICD_SGIR(n) (0x0F00 + ((n) * 4)) /* v1 ICDSGIR */
76 #define GICC_CTLR 0x0000 /* v1 ICCICR */
77 #define GICC_PMR 0x0004 /* v1 ICCPMR */
78 #define GICC_BPR 0x0008 /* v1 ICCBPR */
79 #define GICC_IAR 0x000C /* v1 ICCIAR */
80 #define GICC_EOIR 0x0010 /* v1 ICCEOIR */
81 #define GICC_RPR 0x0014 /* v1 ICCRPR */
82 #define GICC_HPPIR 0x0018 /* v1 ICCHPIR */
83 #define GICC_ABPR 0x001C /* v1 ICCABPR */
84 #define GICC_IIDR 0x00FC /* v1 ICCIIDR*/
86 #define GIC_LAST_IPI 15 /* Irqs 0-15 are IPIs. */
88 /* First bit is a polarity bit (0 - low, 1 - high) */
89 #define GICD_ICFGR_POL_LOW (0 << 0)
90 #define GICD_ICFGR_POL_HIGH (1 << 0)
91 #define GICD_ICFGR_POL_MASK 0x1
92 /* Second bit is a trigger bit (0 - level, 1 - edge) */
93 #define GICD_ICFGR_TRIG_LVL (0 << 1)
94 #define GICD_ICFGR_TRIG_EDGE (1 << 1)
95 #define GICD_ICFGR_TRIG_MASK 0x2
97 struct arm_gic_softc {
98 struct resource * gic_res[3];
99 bus_space_tag_t gic_c_bst;
100 bus_space_tag_t gic_d_bst;
101 bus_space_handle_t gic_c_bsh;
102 bus_space_handle_t gic_d_bsh;
109 static struct resource_spec arm_gic_spec[] = {
110 { SYS_RES_MEMORY, 0, RF_ACTIVE }, /* Distributor registers */
111 { SYS_RES_MEMORY, 1, RF_ACTIVE }, /* CPU Interrupt Intf. registers */
115 static struct arm_gic_softc *arm_gic_sc = NULL;
117 #define gic_c_read_4(reg) \
118 bus_space_read_4(arm_gic_sc->gic_c_bst, arm_gic_sc->gic_c_bsh, reg)
119 #define gic_c_write_4(reg, val) \
120 bus_space_write_4(arm_gic_sc->gic_c_bst, arm_gic_sc->gic_c_bsh, reg, val)
121 #define gic_d_read_4(reg) \
122 bus_space_read_4(arm_gic_sc->gic_d_bst, arm_gic_sc->gic_d_bsh, reg)
123 #define gic_d_write_4(reg, val) \
124 bus_space_write_4(arm_gic_sc->gic_d_bst, arm_gic_sc->gic_d_bsh, reg, val)
126 static int gic_config_irq(int irq, enum intr_trigger trig,
127 enum intr_polarity pol);
128 static void gic_post_filter(void *);
131 arm_gic_probe(device_t dev)
134 if (!ofw_bus_status_okay(dev))
137 if (!ofw_bus_is_compatible(dev, "arm,gic"))
139 device_set_desc(dev, "ARM Generic Interrupt Controller");
140 return (BUS_PROBE_DEFAULT);
144 gic_init_secondary(void)
148 /* Get the number of interrupts */
149 nirqs = gic_d_read_4(GICD_TYPER);
150 nirqs = 32 * ((nirqs & 0x1f) + 1);
152 for (i = 0; i < nirqs; i += 4)
153 gic_d_write_4(GICD_IPRIORITYR(i >> 2), 0);
155 /* Set all the interrupts to be in Group 0 (secure) */
156 for (i = 0; i < nirqs; i += 32) {
157 gic_d_write_4(GICD_IGROUPR(i >> 5), 0);
160 /* Enable CPU interface */
161 gic_c_write_4(GICC_CTLR, 1);
163 /* Set priority mask register. */
164 gic_c_write_4(GICC_PMR, 0xff);
166 /* Enable interrupt distribution */
167 gic_d_write_4(GICD_CTLR, 0x01);
169 /* Activate IRQ 29-30, ie private timer (secure & non-secure) IRQs */
170 gic_d_write_4(GICD_ISENABLER(29 >> 5), (1UL << (29 & 0x1F)));
171 gic_d_write_4(GICD_ISENABLER(30 >> 5), (1UL << (30 & 0x1F)));
175 arm_gic_attach(device_t dev)
177 struct arm_gic_softc *sc;
184 sc = device_get_softc(dev);
187 if (bus_alloc_resources(dev, arm_gic_spec, sc->gic_res)) {
188 device_printf(dev, "could not allocate resources\n");
192 /* Initialize mutex */
193 mtx_init(&sc->mutex, "GIC lock", "", MTX_SPIN);
195 /* Distributor Interface */
196 sc->gic_d_bst = rman_get_bustag(sc->gic_res[0]);
197 sc->gic_d_bsh = rman_get_bushandle(sc->gic_res[0]);
200 sc->gic_c_bst = rman_get_bustag(sc->gic_res[1]);
201 sc->gic_c_bsh = rman_get_bushandle(sc->gic_res[1]);
205 /* Disable interrupt forwarding to the CPU interface */
206 gic_d_write_4(GICD_CTLR, 0x00);
208 /* Get the number of interrupts */
209 sc->nirqs = gic_d_read_4(GICD_TYPER);
210 sc->nirqs = 32 * ((sc->nirqs & 0x1f) + 1);
212 /* Set up function pointers */
213 arm_post_filter = gic_post_filter;
214 arm_config_irq = gic_config_irq;
216 icciidr = gic_c_read_4(GICC_IIDR);
217 device_printf(dev,"pn 0x%x, arch 0x%x, rev 0x%x, implementer 0x%x sc->nirqs %u\n",
218 icciidr>>20, (icciidr>>16) & 0xF, (icciidr>>12) & 0xf,
219 (icciidr & 0xfff), sc->nirqs);
221 /* Set all global interrupts to be level triggered, active low. */
222 for (i = 32; i < sc->nirqs; i += 16) {
223 gic_d_write_4(GICD_ICFGR(i >> 4), 0x00000000);
226 /* Disable all interrupts. */
227 for (i = 32; i < sc->nirqs; i += 32) {
228 gic_d_write_4(GICD_ICENABLER(i >> 5), 0xFFFFFFFF);
231 for (i = 0; i < sc->nirqs; i += 4) {
232 gic_d_write_4(GICD_IPRIORITYR(i >> 2), 0);
233 gic_d_write_4(GICD_ITARGETSR(i >> 2), 1 << 0 | 1 << 8 | 1 << 16 | 1 << 24);
236 /* Set all the interrupts to be in Group 0 (secure) */
237 for (i = 0; i < sc->nirqs; i += 32) {
238 gic_d_write_4(GICD_IGROUPR(i >> 5), 0);
241 /* Enable CPU interface */
242 gic_c_write_4(GICC_CTLR, 1);
244 /* Set priority mask register. */
245 gic_c_write_4(GICC_PMR, 0xff);
247 /* Enable interrupt distribution */
248 gic_d_write_4(GICD_CTLR, 0x01);
253 static device_method_t arm_gic_methods[] = {
254 DEVMETHOD(device_probe, arm_gic_probe),
255 DEVMETHOD(device_attach, arm_gic_attach),
259 static driver_t arm_gic_driver = {
262 sizeof(struct arm_gic_softc),
265 static devclass_t arm_gic_devclass;
267 EARLY_DRIVER_MODULE(gic, simplebus, arm_gic_driver, arm_gic_devclass, 0, 0,
268 BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE);
271 gic_post_filter(void *arg)
273 uintptr_t irq = (uintptr_t) arg;
275 if (irq > GIC_LAST_IPI)
276 arm_irq_memory_barrier(irq);
277 gic_c_write_4(GICC_EOIR, irq);
281 arm_get_next_irq(int last_irq)
285 active_irq = gic_c_read_4(GICC_IAR);
288 * Immediatly EOIR the SGIs, because doing so requires the other
289 * bits (ie CPU number), not just the IRQ number, and we do not
290 * have this information later.
293 if ((active_irq & 0x3ff) <= GIC_LAST_IPI)
294 gic_c_write_4(GICC_EOIR, active_irq);
297 if (active_irq == 0x3FF) {
299 printf("Spurious interrupt detected\n");
307 arm_mask_irq(uintptr_t nb)
310 gic_d_write_4(GICD_ICENABLER(nb >> 5), (1UL << (nb & 0x1F)));
311 gic_c_write_4(GICC_EOIR, nb);
315 arm_unmask_irq(uintptr_t nb)
318 if (nb > GIC_LAST_IPI)
319 arm_irq_memory_barrier(nb);
320 gic_d_write_4(GICD_ISENABLER(nb >> 5), (1UL << (nb & 0x1F)));
324 gic_config_irq(int irq, enum intr_trigger trig,
325 enum intr_polarity pol)
330 /* Function is public-accessible, so validate input arguments */
331 if ((irq < 0) || (irq >= arm_gic_sc->nirqs))
333 if ((trig != INTR_TRIGGER_EDGE) && (trig != INTR_TRIGGER_LEVEL) &&
334 (trig != INTR_TRIGGER_CONFORM))
336 if ((pol != INTR_POLARITY_HIGH) && (pol != INTR_POLARITY_LOW) &&
337 (pol != INTR_POLARITY_CONFORM))
340 mtx_lock_spin(&arm_gic_sc->mutex);
342 reg = gic_d_read_4(GICD_ICFGR(irq >> 4));
343 mask = (reg >> 2*(irq % 16)) & 0x3;
345 if (pol == INTR_POLARITY_LOW) {
346 mask &= ~GICD_ICFGR_POL_MASK;
347 mask |= GICD_ICFGR_POL_LOW;
348 } else if (pol == INTR_POLARITY_HIGH) {
349 mask &= ~GICD_ICFGR_POL_MASK;
350 mask |= GICD_ICFGR_POL_HIGH;
353 if (trig == INTR_TRIGGER_LEVEL) {
354 mask &= ~GICD_ICFGR_TRIG_MASK;
355 mask |= GICD_ICFGR_TRIG_LVL;
356 } else if (trig == INTR_TRIGGER_EDGE) {
357 mask &= ~GICD_ICFGR_TRIG_MASK;
358 mask |= GICD_ICFGR_TRIG_EDGE;
362 reg = reg & ~(0x3 << 2*(irq % 16));
363 reg = reg | (mask << 2*(irq % 16));
364 gic_d_write_4(GICD_ICFGR(irq >> 4), reg);
366 mtx_unlock_spin(&arm_gic_sc->mutex);
371 device_printf(arm_gic_sc->dev, "gic_config_irg, invalid parameters\n");
377 pic_ipi_send(cpuset_t cpus, u_int ipi)
381 for (i = 0; i < MAXCPU; i++)
382 if (CPU_ISSET(i, &cpus))
383 val |= 1 << (16 + i);
384 gic_d_write_4(GICD_SGIR(0), val | ipi);
394 * The intr code will automagically give the frame pointer
395 * if the interrupt argument is 0.
397 if ((unsigned int)i > 16)
405 pic_ipi_clear(int ipi)