2 * Copyright (c) 2015-2016 The FreeBSD Foundation
5 * This software was developed by Andrew Turner under
6 * the sponsorship of the FreeBSD Foundation.
8 * This software was developed by Semihalf under
9 * the sponsorship of the FreeBSD Foundation.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include "opt_platform.h"
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/bitstring.h>
42 #include <sys/kernel.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
49 #include <sys/cpuset.h>
51 #include <sys/mutex.h>
57 #include <machine/bus.h>
58 #include <machine/cpu.h>
59 #include <machine/intr.h>
62 #include <dev/fdt/fdt_intr.h>
63 #include <dev/ofw/ofw_bus_subr.h>
68 #include <arm/arm/gic_common.h>
69 #include "gic_v3_reg.h"
70 #include "gic_v3_var.h"
72 static bus_read_ivar_t gic_v3_read_ivar;
74 static pic_disable_intr_t gic_v3_disable_intr;
75 static pic_enable_intr_t gic_v3_enable_intr;
76 static pic_map_intr_t gic_v3_map_intr;
77 static pic_setup_intr_t gic_v3_setup_intr;
78 static pic_teardown_intr_t gic_v3_teardown_intr;
79 static pic_post_filter_t gic_v3_post_filter;
80 static pic_post_ithread_t gic_v3_post_ithread;
81 static pic_pre_ithread_t gic_v3_pre_ithread;
82 static pic_bind_intr_t gic_v3_bind_intr;
84 static pic_init_secondary_t gic_v3_init_secondary;
85 static pic_ipi_send_t gic_v3_ipi_send;
86 static pic_ipi_setup_t gic_v3_ipi_setup;
89 static u_int gic_irq_cpu;
91 static u_int sgi_to_ipi[GIC_LAST_SGI - GIC_FIRST_SGI + 1];
92 static u_int sgi_first_unused = GIC_FIRST_SGI;
95 static device_method_t gic_v3_methods[] = {
96 /* Device interface */
97 DEVMETHOD(device_detach, gic_v3_detach),
100 DEVMETHOD(bus_read_ivar, gic_v3_read_ivar),
102 /* Interrupt controller interface */
103 DEVMETHOD(pic_disable_intr, gic_v3_disable_intr),
104 DEVMETHOD(pic_enable_intr, gic_v3_enable_intr),
105 DEVMETHOD(pic_map_intr, gic_v3_map_intr),
106 DEVMETHOD(pic_setup_intr, gic_v3_setup_intr),
107 DEVMETHOD(pic_teardown_intr, gic_v3_teardown_intr),
108 DEVMETHOD(pic_post_filter, gic_v3_post_filter),
109 DEVMETHOD(pic_post_ithread, gic_v3_post_ithread),
110 DEVMETHOD(pic_pre_ithread, gic_v3_pre_ithread),
112 DEVMETHOD(pic_bind_intr, gic_v3_bind_intr),
113 DEVMETHOD(pic_init_secondary, gic_v3_init_secondary),
114 DEVMETHOD(pic_ipi_send, gic_v3_ipi_send),
115 DEVMETHOD(pic_ipi_setup, gic_v3_ipi_setup),
122 DEFINE_CLASS_0(gic, gic_v3_driver, gic_v3_methods,
123 sizeof(struct gic_v3_softc));
126 * Driver-specific definitions.
128 MALLOC_DEFINE(M_GIC_V3, "GICv3", GIC_V3_DEVSTR);
131 * Helper functions and definitions.
133 /* Destination registers, either Distributor or Re-Distributor */
139 struct gic_v3_irqsrc {
140 struct intr_irqsrc gi_isrc;
142 enum intr_polarity gi_pol;
143 enum intr_trigger gi_trig;
146 /* Helper routines starting with gic_v3_ */
147 static int gic_v3_dist_init(struct gic_v3_softc *);
148 static int gic_v3_redist_alloc(struct gic_v3_softc *);
149 static int gic_v3_redist_find(struct gic_v3_softc *);
150 static int gic_v3_redist_init(struct gic_v3_softc *);
151 static int gic_v3_cpu_init(struct gic_v3_softc *);
152 static void gic_v3_wait_for_rwp(struct gic_v3_softc *, enum gic_v3_xdist);
154 /* A sequence of init functions for primary (boot) CPU */
155 typedef int (*gic_v3_initseq_t) (struct gic_v3_softc *);
156 /* Primary CPU initialization sequence */
157 static gic_v3_initseq_t gic_v3_primary_init[] = {
166 /* Secondary CPU initialization sequence */
167 static gic_v3_initseq_t gic_v3_secondary_init[] = {
175 gic_r_read_4(device_t dev, bus_size_t offset)
177 struct gic_v3_softc *sc;
179 sc = device_get_softc(dev);
180 return (bus_read_4(sc->gic_redists.pcpu[PCPU_GET(cpuid)], offset));
184 gic_r_read_8(device_t dev, bus_size_t offset)
186 struct gic_v3_softc *sc;
188 sc = device_get_softc(dev);
189 return (bus_read_8(sc->gic_redists.pcpu[PCPU_GET(cpuid)], offset));
193 gic_r_write_4(device_t dev, bus_size_t offset, uint32_t val)
195 struct gic_v3_softc *sc;
197 sc = device_get_softc(dev);
198 bus_write_4(sc->gic_redists.pcpu[PCPU_GET(cpuid)], offset, val);
202 gic_r_write_8(device_t dev, bus_size_t offset, uint64_t val)
204 struct gic_v3_softc *sc;
206 sc = device_get_softc(dev);
207 bus_write_8(sc->gic_redists.pcpu[PCPU_GET(cpuid)], offset, val);
214 gic_v3_attach(device_t dev)
216 struct gic_v3_softc *sc;
217 gic_v3_initseq_t *init_func;
225 sc = device_get_softc(dev);
226 sc->gic_registered = FALSE;
230 /* Initialize mutex */
231 mtx_init(&sc->gic_mtx, "GICv3 lock", NULL, MTX_SPIN);
234 * Allocate array of struct resource.
235 * One entry for Distributor and all remaining for Re-Distributor.
237 sc->gic_res = malloc(
238 sizeof(*sc->gic_res) * (sc->gic_redists.nregions + 1),
241 /* Now allocate corresponding resources */
242 for (i = 0, rid = 0; i < (sc->gic_redists.nregions + 1); i++, rid++) {
243 sc->gic_res[rid] = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
245 if (sc->gic_res[rid] == NULL)
250 * Distributor interface
252 sc->gic_dist = sc->gic_res[0];
255 * Re-Dristributor interface
257 /* Allocate space under region descriptions */
258 sc->gic_redists.regions = malloc(
259 sizeof(*sc->gic_redists.regions) * sc->gic_redists.nregions,
262 /* Fill-up bus_space information for each region. */
263 for (i = 0, rid = 1; i < sc->gic_redists.nregions; i++, rid++)
264 sc->gic_redists.regions[i] = sc->gic_res[rid];
266 /* Get the number of supported SPI interrupts */
267 typer = gic_d_read(sc, 4, GICD_TYPER);
268 sc->gic_nirqs = GICD_TYPER_I_NUM(typer);
269 if (sc->gic_nirqs > GIC_I_NUM_MAX)
270 sc->gic_nirqs = GIC_I_NUM_MAX;
272 sc->gic_irqs = malloc(sizeof(*sc->gic_irqs) * sc->gic_nirqs,
273 M_GIC_V3, M_WAITOK | M_ZERO);
274 name = device_get_nameunit(dev);
275 for (irq = 0; irq < sc->gic_nirqs; irq++) {
276 struct intr_irqsrc *isrc;
278 sc->gic_irqs[irq].gi_irq = irq;
279 sc->gic_irqs[irq].gi_pol = INTR_POLARITY_CONFORM;
280 sc->gic_irqs[irq].gi_trig = INTR_TRIGGER_CONFORM;
282 isrc = &sc->gic_irqs[irq].gi_isrc;
283 if (irq <= GIC_LAST_SGI) {
284 err = intr_isrc_register(isrc, sc->dev,
285 INTR_ISRCF_IPI, "%s,i%u", name, irq - GIC_FIRST_SGI);
286 } else if (irq <= GIC_LAST_PPI) {
287 err = intr_isrc_register(isrc, sc->dev,
288 INTR_ISRCF_PPI, "%s,p%u", name, irq - GIC_FIRST_PPI);
290 err = intr_isrc_register(isrc, sc->dev, 0,
291 "%s,s%u", name, irq - GIC_FIRST_SPI);
294 /* XXX call intr_isrc_deregister() */
295 free(sc->gic_irqs, M_DEVBUF);
301 * Read the Peripheral ID2 register. This is an implementation
302 * defined register, but seems to be implemented in all GICv3
303 * parts and Linux expects it to be there.
305 sc->gic_pidr2 = gic_d_read(sc, 4, GICD_PIDR2);
307 /* Get the number of supported interrupt identifier bits */
308 sc->gic_idbits = GICD_TYPER_IDBITS(typer);
311 device_printf(dev, "SPIs: %u, IDs: %u\n",
312 sc->gic_nirqs, (1 << sc->gic_idbits) - 1);
315 /* Train init sequence for boot CPU */
316 for (init_func = gic_v3_primary_init; *init_func != NULL; init_func++) {
317 err = (*init_func)(sc);
326 gic_v3_detach(device_t dev)
328 struct gic_v3_softc *sc;
332 sc = device_get_softc(dev);
334 if (device_is_attached(dev)) {
336 * XXX: We should probably deregister PIC
338 if (sc->gic_registered)
339 panic("Trying to detach registered PIC");
341 for (rid = 0; rid < (sc->gic_redists.nregions + 1); rid++)
342 bus_release_resource(dev, SYS_RES_MEMORY, rid, sc->gic_res[rid]);
344 for (i = 0; i < mp_ncpus; i++)
345 free(sc->gic_redists.pcpu[i], M_GIC_V3);
347 free(sc->gic_res, M_GIC_V3);
348 free(sc->gic_redists.regions, M_GIC_V3);
354 gic_v3_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
356 struct gic_v3_softc *sc;
358 sc = device_get_softc(dev);
361 case GICV3_IVAR_NIRQS:
362 *result = sc->gic_nirqs;
364 case GICV3_IVAR_REDIST_VADDR:
365 *result = (uintptr_t)rman_get_virtual(
366 sc->gic_redists.pcpu[PCPU_GET(cpuid)]);
368 case GIC_IVAR_HW_REV:
370 GICR_PIDR2_ARCH(sc->gic_pidr2) == GICR_PIDR2_ARCH_GICv3 ||
371 GICR_PIDR2_ARCH(sc->gic_pidr2) == GICR_PIDR2_ARCH_GICv4,
372 ("gic_v3_read_ivar: Invalid GIC architecture: %d (%.08X)",
373 GICR_PIDR2_ARCH(sc->gic_pidr2), sc->gic_pidr2));
374 *result = GICR_PIDR2_ARCH(sc->gic_pidr2);
377 KASSERT(sc->gic_bus != GIC_BUS_UNKNOWN,
378 ("gic_v3_read_ivar: Unknown bus type"));
379 KASSERT(sc->gic_bus <= GIC_BUS_MAX,
380 ("gic_v3_read_ivar: Invalid bus type %u", sc->gic_bus));
381 *result = sc->gic_bus;
389 arm_gic_v3_intr(void *arg)
391 struct gic_v3_softc *sc = arg;
392 struct gic_v3_irqsrc *gi;
393 struct intr_pic *pic;
395 struct trapframe *tf;
402 if (CPU_MATCH_ERRATA_CAVIUM_THUNDER_1_1) {
404 * Hardware: Cavium ThunderX
405 * Chip revision: Pass 1.0 (early version)
406 * Pass 1.1 (production)
407 * ERRATUM: 22978, 23154
410 "nop;nop;nop;nop;nop;nop;nop;nop; \n"
411 "mrs %0, ICC_IAR1_EL1 \n"
412 "nop;nop;nop;nop; \n"
414 : "=&r" (active_irq));
416 active_irq = gic_icc_read(IAR1);
419 if (active_irq >= GIC_FIRST_LPI) {
420 intr_child_irq_handler(pic, active_irq);
424 if (__predict_false(active_irq >= sc->gic_nirqs))
425 return (FILTER_HANDLED);
427 tf = curthread->td_intr_frame;
428 gi = &sc->gic_irqs[active_irq];
429 if (active_irq <= GIC_LAST_SGI) {
430 /* Call EOI for all IPI before dispatch. */
431 gic_icc_write(EOIR1, (uint64_t)active_irq);
433 intr_ipi_dispatch(sgi_to_ipi[gi->gi_irq], tf);
435 device_printf(sc->dev, "SGI %ju on UP system detected\n",
436 (uintmax_t)(active_irq - GIC_FIRST_SGI));
438 } else if (active_irq >= GIC_FIRST_PPI &&
439 active_irq <= GIC_LAST_SPI) {
440 if (gi->gi_trig == INTR_TRIGGER_EDGE)
441 gic_icc_write(EOIR1, gi->gi_irq);
443 if (intr_isrc_dispatch(&gi->gi_isrc, tf) != 0) {
444 if (gi->gi_trig != INTR_TRIGGER_EDGE)
445 gic_icc_write(EOIR1, gi->gi_irq);
446 gic_v3_disable_intr(sc->dev, &gi->gi_isrc);
447 device_printf(sc->dev,
448 "Stray irq %lu disabled\n", active_irq);
456 gic_map_fdt(device_t dev, u_int ncells, pcell_t *cells, u_int *irqp,
457 enum intr_polarity *polp, enum intr_trigger *trigp)
465 * The 1st cell is the interrupt type:
468 * The 2nd cell contains the interrupt number:
471 * The 3rd cell is the flags, encoded as follows:
472 * bits[3:0] trigger type and level flags
474 * 2 = edge triggered (PPI only)
475 * 4 = level-sensitive
476 * 8 = level-sensitive (PPI only)
480 irq = GIC_FIRST_SPI + cells[1];
481 /* SPI irq is checked later. */
484 irq = GIC_FIRST_PPI + cells[1];
485 if (irq > GIC_LAST_PPI) {
486 device_printf(dev, "unsupported PPI interrupt "
487 "number %u\n", cells[1]);
492 device_printf(dev, "unsupported interrupt type "
493 "configuration %u\n", cells[0]);
497 switch (cells[2] & FDT_INTR_MASK) {
498 case FDT_INTR_EDGE_RISING:
499 *trigp = INTR_TRIGGER_EDGE;
500 *polp = INTR_POLARITY_HIGH;
502 case FDT_INTR_EDGE_FALLING:
503 *trigp = INTR_TRIGGER_EDGE;
504 *polp = INTR_POLARITY_LOW;
506 case FDT_INTR_LEVEL_HIGH:
507 *trigp = INTR_TRIGGER_LEVEL;
508 *polp = INTR_POLARITY_HIGH;
510 case FDT_INTR_LEVEL_LOW:
511 *trigp = INTR_TRIGGER_LEVEL;
512 *polp = INTR_POLARITY_LOW;
515 device_printf(dev, "unsupported trigger/polarity "
516 "configuration 0x%02x\n", cells[2]);
520 /* Check the interrupt is valid */
521 if (irq >= GIC_FIRST_SPI && *polp != INTR_POLARITY_HIGH)
530 gic_map_msi(device_t dev, struct intr_map_data_msi *msi_data, u_int *irqp,
531 enum intr_polarity *polp, enum intr_trigger *trigp)
533 struct gic_v3_irqsrc *gi;
536 gi = (struct gic_v3_irqsrc *)msi_data->isrc;
542 /* MSI/MSI-X interrupts are always edge triggered with high polarity */
543 *polp = INTR_POLARITY_HIGH;
544 *trigp = INTR_TRIGGER_EDGE;
550 do_gic_v3_map_intr(device_t dev, struct intr_map_data *data, u_int *irqp,
551 enum intr_polarity *polp, enum intr_trigger *trigp)
553 struct gic_v3_softc *sc;
554 enum intr_polarity pol;
555 enum intr_trigger trig;
556 struct intr_map_data_msi *dam;
558 struct intr_map_data_fdt *daf;
562 sc = device_get_softc(dev);
564 switch (data->type) {
566 case INTR_MAP_DATA_FDT:
567 daf = (struct intr_map_data_fdt *)data;
568 if (gic_map_fdt(dev, daf->ncells, daf->cells, &irq, &pol,
573 case INTR_MAP_DATA_MSI:
575 dam = (struct intr_map_data_msi *)data;
576 if (gic_map_msi(dev, dam, &irq, &pol, &trig) != 0)
583 if (irq >= sc->gic_nirqs)
586 case INTR_POLARITY_CONFORM:
587 case INTR_POLARITY_LOW:
588 case INTR_POLARITY_HIGH:
594 case INTR_TRIGGER_CONFORM:
595 case INTR_TRIGGER_EDGE:
596 case INTR_TRIGGER_LEVEL:
611 gic_v3_map_intr(device_t dev, struct intr_map_data *data,
612 struct intr_irqsrc **isrcp)
614 struct gic_v3_softc *sc;
618 error = do_gic_v3_map_intr(dev, data, &irq, NULL, NULL);
620 sc = device_get_softc(dev);
621 *isrcp = GIC_INTR_ISRC(sc, irq);
627 gic_v3_setup_intr(device_t dev, struct intr_irqsrc *isrc,
628 struct resource *res, struct intr_map_data *data)
630 struct gic_v3_softc *sc = device_get_softc(dev);
631 struct gic_v3_irqsrc *gi = (struct gic_v3_irqsrc *)isrc;
632 enum intr_trigger trig;
633 enum intr_polarity pol;
641 error = do_gic_v3_map_intr(dev, data, &irq, &pol, &trig);
645 if (gi->gi_irq != irq || pol == INTR_POLARITY_CONFORM ||
646 trig == INTR_TRIGGER_CONFORM)
649 /* Compare config if this is not first setup. */
650 if (isrc->isrc_handlers != 0) {
651 if (pol != gi->gi_pol || trig != gi->gi_trig)
661 * XXX - In case that per CPU interrupt is going to be enabled in time
662 * when SMP is already started, we need some IPI call which
663 * enables it on others CPUs. Further, it's more complicated as
664 * pic_enable_source() and pic_disable_source() should act on
665 * per CPU basis only. Thus, it should be solved here somehow.
667 if (isrc->isrc_flags & INTR_ISRCF_PPI)
668 CPU_SET(PCPU_GET(cpuid), &isrc->isrc_cpu);
670 if (irq >= GIC_FIRST_PPI && irq <= GIC_LAST_SPI) {
671 mtx_lock_spin(&sc->gic_mtx);
673 /* Set the trigger and polarity */
674 if (irq <= GIC_LAST_PPI)
675 reg = gic_r_read(sc, 4,
676 GICR_SGI_BASE_SIZE + GICD_ICFGR(irq));
678 reg = gic_d_read(sc, 4, GICD_ICFGR(irq));
679 if (trig == INTR_TRIGGER_LEVEL)
680 reg &= ~(2 << ((irq % 16) * 2));
682 reg |= 2 << ((irq % 16) * 2);
684 if (irq <= GIC_LAST_PPI) {
686 GICR_SGI_BASE_SIZE + GICD_ICFGR(irq), reg);
687 gic_v3_wait_for_rwp(sc, REDIST);
689 gic_d_write(sc, 4, GICD_ICFGR(irq), reg);
690 gic_v3_wait_for_rwp(sc, DIST);
693 mtx_unlock_spin(&sc->gic_mtx);
695 gic_v3_bind_intr(dev, isrc);
702 gic_v3_teardown_intr(device_t dev, struct intr_irqsrc *isrc,
703 struct resource *res, struct intr_map_data *data)
705 struct gic_v3_irqsrc *gi = (struct gic_v3_irqsrc *)isrc;
707 if (isrc->isrc_handlers == 0) {
708 gi->gi_pol = INTR_POLARITY_CONFORM;
709 gi->gi_trig = INTR_TRIGGER_CONFORM;
716 gic_v3_disable_intr(device_t dev, struct intr_irqsrc *isrc)
718 struct gic_v3_softc *sc;
719 struct gic_v3_irqsrc *gi;
722 sc = device_get_softc(dev);
723 gi = (struct gic_v3_irqsrc *)isrc;
726 if (irq <= GIC_LAST_PPI) {
727 /* SGIs and PPIs in corresponding Re-Distributor */
728 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICD_ICENABLER(irq),
730 gic_v3_wait_for_rwp(sc, REDIST);
731 } else if (irq >= GIC_FIRST_SPI && irq <= GIC_LAST_SPI) {
732 /* SPIs in distributor */
733 gic_d_write(sc, 4, GICD_ICENABLER(irq), GICD_I_MASK(irq));
734 gic_v3_wait_for_rwp(sc, DIST);
736 panic("%s: Unsupported IRQ %u", __func__, irq);
740 gic_v3_enable_intr(device_t dev, struct intr_irqsrc *isrc)
742 struct gic_v3_softc *sc;
743 struct gic_v3_irqsrc *gi;
746 sc = device_get_softc(dev);
747 gi = (struct gic_v3_irqsrc *)isrc;
750 if (irq <= GIC_LAST_PPI) {
751 /* SGIs and PPIs in corresponding Re-Distributor */
752 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICD_ISENABLER(irq),
754 gic_v3_wait_for_rwp(sc, REDIST);
755 } else if (irq >= GIC_FIRST_SPI && irq <= GIC_LAST_SPI) {
756 /* SPIs in distributor */
757 gic_d_write(sc, 4, GICD_ISENABLER(irq), GICD_I_MASK(irq));
758 gic_v3_wait_for_rwp(sc, DIST);
760 panic("%s: Unsupported IRQ %u", __func__, irq);
764 gic_v3_pre_ithread(device_t dev, struct intr_irqsrc *isrc)
766 struct gic_v3_irqsrc *gi = (struct gic_v3_irqsrc *)isrc;
768 gic_v3_disable_intr(dev, isrc);
769 gic_icc_write(EOIR1, gi->gi_irq);
773 gic_v3_post_ithread(device_t dev, struct intr_irqsrc *isrc)
776 gic_v3_enable_intr(dev, isrc);
780 gic_v3_post_filter(device_t dev, struct intr_irqsrc *isrc)
782 struct gic_v3_irqsrc *gi = (struct gic_v3_irqsrc *)isrc;
784 if (gi->gi_trig == INTR_TRIGGER_EDGE)
787 gic_icc_write(EOIR1, gi->gi_irq);
791 gic_v3_bind_intr(device_t dev, struct intr_irqsrc *isrc)
793 struct gic_v3_softc *sc;
794 struct gic_v3_irqsrc *gi;
797 gi = (struct gic_v3_irqsrc *)isrc;
798 if (gi->gi_irq <= GIC_LAST_PPI)
801 KASSERT(gi->gi_irq >= GIC_FIRST_SPI && gi->gi_irq <= GIC_LAST_SPI,
802 ("%s: Attempting to bind an invalid IRQ", __func__));
804 sc = device_get_softc(dev);
806 if (CPU_EMPTY(&isrc->isrc_cpu)) {
807 gic_irq_cpu = intr_irq_next_cpu(gic_irq_cpu, &all_cpus);
808 CPU_SETOF(gic_irq_cpu, &isrc->isrc_cpu);
809 gic_d_write(sc, 4, GICD_IROUTER(gi->gi_irq),
810 CPU_AFFINITY(gic_irq_cpu));
813 * We can only bind to a single CPU so select
814 * the first CPU found.
816 cpu = CPU_FFS(&isrc->isrc_cpu) - 1;
817 gic_d_write(sc, 4, GICD_IROUTER(gi->gi_irq), CPU_AFFINITY(cpu));
825 gic_v3_init_secondary(device_t dev)
828 struct gic_v3_softc *sc;
829 gic_v3_initseq_t *init_func;
830 struct intr_irqsrc *isrc;
834 sc = device_get_softc(dev);
835 cpu = PCPU_GET(cpuid);
837 /* Train init sequence for boot CPU */
838 for (init_func = gic_v3_secondary_init; *init_func != NULL;
840 err = (*init_func)(sc);
843 "Could not initialize GIC for CPU%u\n", cpu);
848 /* Unmask attached SGI interrupts. */
849 for (irq = GIC_FIRST_SGI; irq <= GIC_LAST_SGI; irq++) {
850 isrc = GIC_INTR_ISRC(sc, irq);
851 if (intr_isrc_init_on_cpu(isrc, cpu))
852 gic_v3_enable_intr(dev, isrc);
855 /* Unmask attached PPI interrupts. */
856 for (irq = GIC_FIRST_PPI; irq <= GIC_LAST_PPI; irq++) {
857 isrc = GIC_INTR_ISRC(sc, irq);
858 if (intr_isrc_init_on_cpu(isrc, cpu))
859 gic_v3_enable_intr(dev, isrc);
862 for (i = 0; i < sc->gic_nchildren; i++) {
863 child = sc->gic_children[i];
864 PIC_INIT_SECONDARY(child);
869 gic_v3_ipi_send(device_t dev, struct intr_irqsrc *isrc, cpuset_t cpus,
872 struct gic_v3_irqsrc *gi = (struct gic_v3_irqsrc *)isrc;
873 uint64_t aff, val, irq;
876 #define GIC_AFF_MASK (CPU_AFF3_MASK | CPU_AFF2_MASK | CPU_AFF1_MASK)
877 #define GIC_AFFINITY(i) (CPU_AFFINITY(i) & GIC_AFF_MASK)
878 aff = GIC_AFFINITY(0);
882 /* Iterate through all CPUs in set */
883 for (i = 0; i < mp_ncpus; i++) {
884 /* Move to the next affinity group */
885 if (aff != GIC_AFFINITY(i)) {
888 gic_icc_write(SGI1R, val);
891 aff = GIC_AFFINITY(i);
894 /* Send the IPI to this cpu */
895 if (CPU_ISSET(i, &cpus)) {
896 #define ICC_SGI1R_AFFINITY(aff) \
897 (((uint64_t)CPU_AFF3(aff) << ICC_SGI1R_EL1_AFF3_SHIFT) | \
898 ((uint64_t)CPU_AFF2(aff) << ICC_SGI1R_EL1_AFF2_SHIFT) | \
899 ((uint64_t)CPU_AFF1(aff) << ICC_SGI1R_EL1_AFF1_SHIFT))
900 /* Set the affinity when the first at this level */
902 val = ICC_SGI1R_AFFINITY(aff) |
903 irq << ICC_SGI1R_EL1_SGIID_SHIFT;
904 /* Set the bit to send the IPI to te CPU */
905 val |= 1 << CPU_AFF0(CPU_AFFINITY(i));
909 /* Send the IPI to the last cpu affinity group */
911 gic_icc_write(SGI1R, val);
917 gic_v3_ipi_setup(device_t dev, u_int ipi, struct intr_irqsrc **isrcp)
919 struct intr_irqsrc *isrc;
920 struct gic_v3_softc *sc = device_get_softc(dev);
922 if (sgi_first_unused > GIC_LAST_SGI)
925 isrc = GIC_INTR_ISRC(sc, sgi_first_unused);
926 sgi_to_ipi[sgi_first_unused++] = ipi;
928 CPU_SET(PCPU_GET(cpuid), &isrc->isrc_cpu);
939 gic_v3_wait_for_rwp(struct gic_v3_softc *sc, enum gic_v3_xdist xdist)
941 struct resource *res;
943 size_t us_left = 1000000;
945 cpuid = PCPU_GET(cpuid);
952 res = sc->gic_redists.pcpu[cpuid];
955 KASSERT(0, ("%s: Attempt to wait for unknown RWP", __func__));
959 while ((bus_read_4(res, GICD_CTLR) & GICD_CTLR_RWP) != 0) {
962 panic("GICD Register write pending for too long");
968 gic_v3_cpu_priority(uint64_t mask)
971 /* Set prority mask */
972 gic_icc_write(PMR, mask & ICC_PMR_EL1_PRIO_MASK);
976 gic_v3_cpu_enable_sre(struct gic_v3_softc *sc)
981 cpuid = PCPU_GET(cpuid);
983 * Set the SRE bit to enable access to GIC CPU interface
984 * via system registers.
986 sre = READ_SPECIALREG(icc_sre_el1);
987 sre |= ICC_SRE_EL1_SRE;
988 WRITE_SPECIALREG(icc_sre_el1, sre);
991 * Now ensure that the bit is set.
993 sre = READ_SPECIALREG(icc_sre_el1);
994 if ((sre & ICC_SRE_EL1_SRE) == 0) {
995 /* We are done. This was disabled in EL2 */
996 device_printf(sc->dev, "ERROR: CPU%u cannot enable CPU interface "
997 "via system registers\n", cpuid);
999 } else if (bootverbose) {
1000 device_printf(sc->dev,
1001 "CPU%u enabled CPU interface via system registers\n",
1009 gic_v3_cpu_init(struct gic_v3_softc *sc)
1013 /* Enable access to CPU interface via system registers */
1014 err = gic_v3_cpu_enable_sre(sc);
1017 /* Priority mask to minimum - accept all interrupts */
1018 gic_v3_cpu_priority(GIC_PRIORITY_MIN);
1019 /* Disable EOI mode */
1020 gic_icc_clear(CTLR, ICC_CTLR_EL1_EOIMODE);
1021 /* Enable group 1 (insecure) interrups */
1022 gic_icc_set(IGRPEN1, ICC_IGRPEN0_EL1_EN);
1029 gic_v3_dist_init(struct gic_v3_softc *sc)
1035 * 1. Disable the Distributor
1037 gic_d_write(sc, 4, GICD_CTLR, 0);
1038 gic_v3_wait_for_rwp(sc, DIST);
1041 * 2. Configure the Distributor
1043 /* Set all SPIs to be Group 1 Non-secure */
1044 for (i = GIC_FIRST_SPI; i < sc->gic_nirqs; i += GICD_I_PER_IGROUPRn)
1045 gic_d_write(sc, 4, GICD_IGROUPR(i), 0xFFFFFFFF);
1047 /* Set all global interrupts to be level triggered, active low. */
1048 for (i = GIC_FIRST_SPI; i < sc->gic_nirqs; i += GICD_I_PER_ICFGRn)
1049 gic_d_write(sc, 4, GICD_ICFGR(i), 0x00000000);
1051 /* Set priority to all shared interrupts */
1052 for (i = GIC_FIRST_SPI;
1053 i < sc->gic_nirqs; i += GICD_I_PER_IPRIORITYn) {
1054 /* Set highest priority */
1055 gic_d_write(sc, 4, GICD_IPRIORITYR(i), GIC_PRIORITY_MAX);
1059 * Disable all interrupts. Leave PPI and SGIs as they are enabled in
1060 * Re-Distributor registers.
1062 for (i = GIC_FIRST_SPI; i < sc->gic_nirqs; i += GICD_I_PER_ISENABLERn)
1063 gic_d_write(sc, 4, GICD_ICENABLER(i), 0xFFFFFFFF);
1065 gic_v3_wait_for_rwp(sc, DIST);
1068 * 3. Enable Distributor
1070 /* Enable Distributor with ARE, Group 1 */
1071 gic_d_write(sc, 4, GICD_CTLR, GICD_CTLR_ARE_NS | GICD_CTLR_G1A |
1075 * 4. Route all interrupts to boot CPU.
1077 aff = CPU_AFFINITY(0);
1078 for (i = GIC_FIRST_SPI; i < sc->gic_nirqs; i++)
1079 gic_d_write(sc, 4, GICD_IROUTER(i), aff);
1084 /* Re-Distributor */
1086 gic_v3_redist_alloc(struct gic_v3_softc *sc)
1090 /* Allocate struct resource for all CPU's Re-Distributor registers */
1091 for (cpuid = 0; cpuid < mp_ncpus; cpuid++)
1092 if (CPU_ISSET(cpuid, &all_cpus) != 0)
1093 sc->gic_redists.pcpu[cpuid] =
1094 malloc(sizeof(*sc->gic_redists.pcpu[0]),
1095 M_GIC_V3, M_WAITOK);
1097 sc->gic_redists.pcpu[cpuid] = NULL;
1102 gic_v3_redist_find(struct gic_v3_softc *sc)
1104 struct resource r_res;
1105 bus_space_handle_t r_bsh;
1112 cpuid = PCPU_GET(cpuid);
1114 aff = CPU_AFFINITY(cpuid);
1115 /* Affinity in format for comparison with typer */
1116 aff = (CPU_AFF3(aff) << 24) | (CPU_AFF2(aff) << 16) |
1117 (CPU_AFF1(aff) << 8) | CPU_AFF0(aff);
1120 device_printf(sc->dev,
1121 "Start searching for Re-Distributor\n");
1123 /* Iterate through Re-Distributor regions */
1124 for (i = 0; i < sc->gic_redists.nregions; i++) {
1125 /* Take a copy of the region's resource */
1126 r_res = *sc->gic_redists.regions[i];
1127 r_bsh = rman_get_bushandle(&r_res);
1129 pidr2 = bus_read_4(&r_res, GICR_PIDR2);
1130 switch (GICR_PIDR2_ARCH(pidr2)) {
1131 case GICR_PIDR2_ARCH_GICv3: /* fall through */
1132 case GICR_PIDR2_ARCH_GICv4:
1135 device_printf(sc->dev,
1136 "No Re-Distributor found for CPU%u\n", cpuid);
1141 typer = bus_read_8(&r_res, GICR_TYPER);
1142 if ((typer >> GICR_TYPER_AFF_SHIFT) == aff) {
1143 KASSERT(sc->gic_redists.pcpu[cpuid] != NULL,
1144 ("Invalid pointer to per-CPU redistributor"));
1145 /* Copy res contents to its final destination */
1146 *sc->gic_redists.pcpu[cpuid] = r_res;
1148 device_printf(sc->dev,
1149 "CPU%u Re-Distributor has been found\n",
1155 r_bsh += (GICR_RD_BASE_SIZE + GICR_SGI_BASE_SIZE);
1156 if ((typer & GICR_TYPER_VLPIS) != 0) {
1158 (GICR_VLPI_BASE_SIZE + GICR_RESERVED_SIZE);
1161 rman_set_bushandle(&r_res, r_bsh);
1162 } while ((typer & GICR_TYPER_LAST) == 0);
1165 device_printf(sc->dev, "No Re-Distributor found for CPU%u\n", cpuid);
1170 gic_v3_redist_wake(struct gic_v3_softc *sc)
1173 size_t us_left = 1000000;
1175 waker = gic_r_read(sc, 4, GICR_WAKER);
1176 /* Wake up Re-Distributor for this CPU */
1177 waker &= ~GICR_WAKER_PS;
1178 gic_r_write(sc, 4, GICR_WAKER, waker);
1180 * When clearing ProcessorSleep bit it is required to wait for
1181 * ChildrenAsleep to become zero following the processor power-on.
1183 while ((gic_r_read(sc, 4, GICR_WAKER) & GICR_WAKER_CA) != 0) {
1185 if (us_left-- == 0) {
1186 panic("Could not wake Re-Distributor for CPU%u",
1192 device_printf(sc->dev, "CPU%u Re-Distributor woke up\n",
1200 gic_v3_redist_init(struct gic_v3_softc *sc)
1205 err = gic_v3_redist_find(sc);
1209 err = gic_v3_redist_wake(sc);
1213 /* Configure SGIs and PPIs to be Group1 Non-secure */
1214 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICR_IGROUPR0,
1218 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICR_ICENABLER0,
1219 GICR_I_ENABLER_PPI_MASK);
1221 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICR_ISENABLER0,
1222 GICR_I_ENABLER_SGI_MASK);
1224 /* Set priority for SGIs and PPIs */
1225 for (i = 0; i <= GIC_LAST_PPI; i += GICR_I_PER_IPRIORITYn) {
1226 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICD_IPRIORITYR(i),
1230 gic_v3_wait_for_rwp(sc, REDIST);