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
34 #include "opt_platform.h"
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/bitstring.h>
43 #include <sys/kernel.h>
45 #include <sys/malloc.h>
46 #include <sys/module.h>
50 #include <sys/cpuset.h>
52 #include <sys/mutex.h>
58 #include <machine/bus.h>
59 #include <machine/cpu.h>
60 #include <machine/intr.h>
63 #include <dev/fdt/fdt_intr.h>
64 #include <dev/ofw/ofw_bus_subr.h>
68 #include <contrib/dev/acpica/include/acpi.h>
69 #include <dev/acpica/acpivar.h>
74 #include <arm/arm/gic_common.h>
75 #include "gic_v3_reg.h"
76 #include "gic_v3_var.h"
78 static bus_get_domain_t gic_v3_get_domain;
79 static bus_read_ivar_t gic_v3_read_ivar;
81 static pic_disable_intr_t gic_v3_disable_intr;
82 static pic_enable_intr_t gic_v3_enable_intr;
83 static pic_map_intr_t gic_v3_map_intr;
84 static pic_setup_intr_t gic_v3_setup_intr;
85 static pic_teardown_intr_t gic_v3_teardown_intr;
86 static pic_post_filter_t gic_v3_post_filter;
87 static pic_post_ithread_t gic_v3_post_ithread;
88 static pic_pre_ithread_t gic_v3_pre_ithread;
89 static pic_bind_intr_t gic_v3_bind_intr;
91 static pic_init_secondary_t gic_v3_init_secondary;
92 static pic_ipi_send_t gic_v3_ipi_send;
93 static pic_ipi_setup_t gic_v3_ipi_setup;
96 static u_int gic_irq_cpu;
98 static u_int sgi_to_ipi[GIC_LAST_SGI - GIC_FIRST_SGI + 1];
99 static u_int sgi_first_unused = GIC_FIRST_SGI;
102 static device_method_t gic_v3_methods[] = {
103 /* Device interface */
104 DEVMETHOD(device_detach, gic_v3_detach),
107 DEVMETHOD(bus_get_domain, gic_v3_get_domain),
108 DEVMETHOD(bus_read_ivar, gic_v3_read_ivar),
110 /* Interrupt controller interface */
111 DEVMETHOD(pic_disable_intr, gic_v3_disable_intr),
112 DEVMETHOD(pic_enable_intr, gic_v3_enable_intr),
113 DEVMETHOD(pic_map_intr, gic_v3_map_intr),
114 DEVMETHOD(pic_setup_intr, gic_v3_setup_intr),
115 DEVMETHOD(pic_teardown_intr, gic_v3_teardown_intr),
116 DEVMETHOD(pic_post_filter, gic_v3_post_filter),
117 DEVMETHOD(pic_post_ithread, gic_v3_post_ithread),
118 DEVMETHOD(pic_pre_ithread, gic_v3_pre_ithread),
120 DEVMETHOD(pic_bind_intr, gic_v3_bind_intr),
121 DEVMETHOD(pic_init_secondary, gic_v3_init_secondary),
122 DEVMETHOD(pic_ipi_send, gic_v3_ipi_send),
123 DEVMETHOD(pic_ipi_setup, gic_v3_ipi_setup),
130 DEFINE_CLASS_0(gic, gic_v3_driver, gic_v3_methods,
131 sizeof(struct gic_v3_softc));
134 * Driver-specific definitions.
136 MALLOC_DEFINE(M_GIC_V3, "GICv3", GIC_V3_DEVSTR);
139 * Helper functions and definitions.
141 /* Destination registers, either Distributor or Re-Distributor */
147 struct gic_v3_irqsrc {
148 struct intr_irqsrc gi_isrc;
150 enum intr_polarity gi_pol;
151 enum intr_trigger gi_trig;
154 /* Helper routines starting with gic_v3_ */
155 static int gic_v3_dist_init(struct gic_v3_softc *);
156 static int gic_v3_redist_alloc(struct gic_v3_softc *);
157 static int gic_v3_redist_find(struct gic_v3_softc *);
158 static int gic_v3_redist_init(struct gic_v3_softc *);
159 static int gic_v3_cpu_init(struct gic_v3_softc *);
160 static void gic_v3_wait_for_rwp(struct gic_v3_softc *, enum gic_v3_xdist);
162 /* A sequence of init functions for primary (boot) CPU */
163 typedef int (*gic_v3_initseq_t) (struct gic_v3_softc *);
164 /* Primary CPU initialization sequence */
165 static gic_v3_initseq_t gic_v3_primary_init[] = {
174 /* Secondary CPU initialization sequence */
175 static gic_v3_initseq_t gic_v3_secondary_init[] = {
183 gic_r_read_4(device_t dev, bus_size_t offset)
185 struct gic_v3_softc *sc;
186 struct resource *rdist;
188 sc = device_get_softc(dev);
189 rdist = &sc->gic_redists.pcpu[PCPU_GET(cpuid)]->res;
190 return (bus_read_4(rdist, offset));
194 gic_r_read_8(device_t dev, bus_size_t offset)
196 struct gic_v3_softc *sc;
197 struct resource *rdist;
199 sc = device_get_softc(dev);
200 rdist = &sc->gic_redists.pcpu[PCPU_GET(cpuid)]->res;
201 return (bus_read_8(rdist, offset));
205 gic_r_write_4(device_t dev, bus_size_t offset, uint32_t val)
207 struct gic_v3_softc *sc;
208 struct resource *rdist;
210 sc = device_get_softc(dev);
211 rdist = &sc->gic_redists.pcpu[PCPU_GET(cpuid)]->res;
212 bus_write_4(rdist, offset, val);
216 gic_r_write_8(device_t dev, bus_size_t offset, uint64_t val)
218 struct gic_v3_softc *sc;
219 struct resource *rdist;
221 sc = device_get_softc(dev);
222 rdist = &sc->gic_redists.pcpu[PCPU_GET(cpuid)]->res;
223 bus_write_8(rdist, offset, val);
230 gic_v3_attach(device_t dev)
232 struct gic_v3_softc *sc;
233 gic_v3_initseq_t *init_func;
241 sc = device_get_softc(dev);
242 sc->gic_registered = FALSE;
246 /* Initialize mutex */
247 mtx_init(&sc->gic_mtx, "GICv3 lock", NULL, MTX_SPIN);
250 * Allocate array of struct resource.
251 * One entry for Distributor and all remaining for Re-Distributor.
253 sc->gic_res = malloc(
254 sizeof(*sc->gic_res) * (sc->gic_redists.nregions + 1),
257 /* Now allocate corresponding resources */
258 for (i = 0, rid = 0; i < (sc->gic_redists.nregions + 1); i++, rid++) {
259 sc->gic_res[rid] = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
261 if (sc->gic_res[rid] == NULL)
266 * Distributor interface
268 sc->gic_dist = sc->gic_res[0];
271 * Re-Dristributor interface
273 /* Allocate space under region descriptions */
274 sc->gic_redists.regions = malloc(
275 sizeof(*sc->gic_redists.regions) * sc->gic_redists.nregions,
278 /* Fill-up bus_space information for each region. */
279 for (i = 0, rid = 1; i < sc->gic_redists.nregions; i++, rid++)
280 sc->gic_redists.regions[i] = sc->gic_res[rid];
282 /* Get the number of supported SPI interrupts */
283 typer = gic_d_read(sc, 4, GICD_TYPER);
284 sc->gic_nirqs = GICD_TYPER_I_NUM(typer);
285 if (sc->gic_nirqs > GIC_I_NUM_MAX)
286 sc->gic_nirqs = GIC_I_NUM_MAX;
288 sc->gic_irqs = malloc(sizeof(*sc->gic_irqs) * sc->gic_nirqs,
289 M_GIC_V3, M_WAITOK | M_ZERO);
290 name = device_get_nameunit(dev);
291 for (irq = 0; irq < sc->gic_nirqs; irq++) {
292 struct intr_irqsrc *isrc;
294 sc->gic_irqs[irq].gi_irq = irq;
295 sc->gic_irqs[irq].gi_pol = INTR_POLARITY_CONFORM;
296 sc->gic_irqs[irq].gi_trig = INTR_TRIGGER_CONFORM;
298 isrc = &sc->gic_irqs[irq].gi_isrc;
299 if (irq <= GIC_LAST_SGI) {
300 err = intr_isrc_register(isrc, sc->dev,
301 INTR_ISRCF_IPI, "%s,i%u", name, irq - GIC_FIRST_SGI);
302 } else if (irq <= GIC_LAST_PPI) {
303 err = intr_isrc_register(isrc, sc->dev,
304 INTR_ISRCF_PPI, "%s,p%u", name, irq - GIC_FIRST_PPI);
306 err = intr_isrc_register(isrc, sc->dev, 0,
307 "%s,s%u", name, irq - GIC_FIRST_SPI);
310 /* XXX call intr_isrc_deregister() */
311 free(sc->gic_irqs, M_DEVBUF);
317 * Read the Peripheral ID2 register. This is an implementation
318 * defined register, but seems to be implemented in all GICv3
319 * parts and Linux expects it to be there.
321 sc->gic_pidr2 = gic_d_read(sc, 4, GICD_PIDR2);
323 /* Get the number of supported interrupt identifier bits */
324 sc->gic_idbits = GICD_TYPER_IDBITS(typer);
327 device_printf(dev, "SPIs: %u, IDs: %u\n",
328 sc->gic_nirqs, (1 << sc->gic_idbits) - 1);
331 /* Train init sequence for boot CPU */
332 for (init_func = gic_v3_primary_init; *init_func != NULL; init_func++) {
333 err = (*init_func)(sc);
342 gic_v3_detach(device_t dev)
344 struct gic_v3_softc *sc;
348 sc = device_get_softc(dev);
350 if (device_is_attached(dev)) {
352 * XXX: We should probably deregister PIC
354 if (sc->gic_registered)
355 panic("Trying to detach registered PIC");
357 for (rid = 0; rid < (sc->gic_redists.nregions + 1); rid++)
358 bus_release_resource(dev, SYS_RES_MEMORY, rid, sc->gic_res[rid]);
360 for (i = 0; i <= mp_maxid; i++)
361 free(sc->gic_redists.pcpu[i], M_GIC_V3);
363 free(sc->gic_res, M_GIC_V3);
364 free(sc->gic_redists.regions, M_GIC_V3);
370 gic_v3_get_domain(device_t dev, device_t child, int *domain)
372 struct gic_v3_devinfo *di;
374 di = device_get_ivars(child);
375 if (di->gic_domain < 0)
378 *domain = di->gic_domain;
383 gic_v3_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
385 struct gic_v3_softc *sc;
387 sc = device_get_softc(dev);
390 case GICV3_IVAR_NIRQS:
391 *result = (NIRQ - sc->gic_nirqs) / sc->gic_nchildren;
393 case GICV3_IVAR_REDIST_VADDR:
394 *result = (uintptr_t)rman_get_virtual(
395 &sc->gic_redists.pcpu[PCPU_GET(cpuid)]->res);
397 case GICV3_IVAR_REDIST:
398 *result = (uintptr_t)sc->gic_redists.pcpu[PCPU_GET(cpuid)];
400 case GIC_IVAR_HW_REV:
402 GICR_PIDR2_ARCH(sc->gic_pidr2) == GICR_PIDR2_ARCH_GICv3 ||
403 GICR_PIDR2_ARCH(sc->gic_pidr2) == GICR_PIDR2_ARCH_GICv4,
404 ("gic_v3_read_ivar: Invalid GIC architecture: %d (%.08X)",
405 GICR_PIDR2_ARCH(sc->gic_pidr2), sc->gic_pidr2));
406 *result = GICR_PIDR2_ARCH(sc->gic_pidr2);
409 KASSERT(sc->gic_bus != GIC_BUS_UNKNOWN,
410 ("gic_v3_read_ivar: Unknown bus type"));
411 KASSERT(sc->gic_bus <= GIC_BUS_MAX,
412 ("gic_v3_read_ivar: Invalid bus type %u", sc->gic_bus));
413 *result = sc->gic_bus;
421 arm_gic_v3_intr(void *arg)
423 struct gic_v3_softc *sc = arg;
424 struct gic_v3_irqsrc *gi;
425 struct intr_pic *pic;
427 struct trapframe *tf;
432 if (CPU_MATCH_ERRATA_CAVIUM_THUNDERX_1_1) {
434 * Hardware: Cavium ThunderX
435 * Chip revision: Pass 1.0 (early version)
436 * Pass 1.1 (production)
437 * ERRATUM: 22978, 23154
440 "nop;nop;nop;nop;nop;nop;nop;nop; \n"
441 "mrs %0, ICC_IAR1_EL1 \n"
442 "nop;nop;nop;nop; \n"
444 : "=&r" (active_irq));
446 active_irq = gic_icc_read(IAR1);
449 if (active_irq >= GIC_FIRST_LPI) {
450 intr_child_irq_handler(pic, active_irq);
454 if (__predict_false(active_irq >= sc->gic_nirqs))
455 return (FILTER_HANDLED);
457 tf = curthread->td_intr_frame;
458 gi = &sc->gic_irqs[active_irq];
459 if (active_irq <= GIC_LAST_SGI) {
460 /* Call EOI for all IPI before dispatch. */
461 gic_icc_write(EOIR1, (uint64_t)active_irq);
463 intr_ipi_dispatch(sgi_to_ipi[gi->gi_irq], tf);
465 device_printf(sc->dev, "SGI %ju on UP system detected\n",
466 (uintmax_t)(active_irq - GIC_FIRST_SGI));
468 } else if (active_irq >= GIC_FIRST_PPI &&
469 active_irq <= GIC_LAST_SPI) {
470 if (gi->gi_trig == INTR_TRIGGER_EDGE)
471 gic_icc_write(EOIR1, gi->gi_irq);
473 if (intr_isrc_dispatch(&gi->gi_isrc, tf) != 0) {
474 if (gi->gi_trig != INTR_TRIGGER_EDGE)
475 gic_icc_write(EOIR1, gi->gi_irq);
476 gic_v3_disable_intr(sc->dev, &gi->gi_isrc);
477 device_printf(sc->dev,
478 "Stray irq %lu disabled\n", active_irq);
486 gic_map_fdt(device_t dev, u_int ncells, pcell_t *cells, u_int *irqp,
487 enum intr_polarity *polp, enum intr_trigger *trigp)
495 * The 1st cell is the interrupt type:
498 * The 2nd cell contains the interrupt number:
501 * The 3rd cell is the flags, encoded as follows:
502 * bits[3:0] trigger type and level flags
504 * 2 = edge triggered (PPI only)
505 * 4 = level-sensitive
506 * 8 = level-sensitive (PPI only)
510 irq = GIC_FIRST_SPI + cells[1];
511 /* SPI irq is checked later. */
514 irq = GIC_FIRST_PPI + cells[1];
515 if (irq > GIC_LAST_PPI) {
516 device_printf(dev, "unsupported PPI interrupt "
517 "number %u\n", cells[1]);
522 device_printf(dev, "unsupported interrupt type "
523 "configuration %u\n", cells[0]);
527 switch (cells[2] & FDT_INTR_MASK) {
528 case FDT_INTR_EDGE_RISING:
529 *trigp = INTR_TRIGGER_EDGE;
530 *polp = INTR_POLARITY_HIGH;
532 case FDT_INTR_EDGE_FALLING:
533 *trigp = INTR_TRIGGER_EDGE;
534 *polp = INTR_POLARITY_LOW;
536 case FDT_INTR_LEVEL_HIGH:
537 *trigp = INTR_TRIGGER_LEVEL;
538 *polp = INTR_POLARITY_HIGH;
540 case FDT_INTR_LEVEL_LOW:
541 *trigp = INTR_TRIGGER_LEVEL;
542 *polp = INTR_POLARITY_LOW;
545 device_printf(dev, "unsupported trigger/polarity "
546 "configuration 0x%02x\n", cells[2]);
550 /* Check the interrupt is valid */
551 if (irq >= GIC_FIRST_SPI && *polp != INTR_POLARITY_HIGH)
560 gic_map_msi(device_t dev, struct intr_map_data_msi *msi_data, u_int *irqp,
561 enum intr_polarity *polp, enum intr_trigger *trigp)
563 struct gic_v3_irqsrc *gi;
566 gi = (struct gic_v3_irqsrc *)msi_data->isrc;
572 /* MSI/MSI-X interrupts are always edge triggered with high polarity */
573 *polp = INTR_POLARITY_HIGH;
574 *trigp = INTR_TRIGGER_EDGE;
580 do_gic_v3_map_intr(device_t dev, struct intr_map_data *data, u_int *irqp,
581 enum intr_polarity *polp, enum intr_trigger *trigp)
583 struct gic_v3_softc *sc;
584 enum intr_polarity pol;
585 enum intr_trigger trig;
586 struct intr_map_data_msi *dam;
588 struct intr_map_data_fdt *daf;
591 struct intr_map_data_acpi *daa;
595 sc = device_get_softc(dev);
597 switch (data->type) {
599 case INTR_MAP_DATA_FDT:
600 daf = (struct intr_map_data_fdt *)data;
601 if (gic_map_fdt(dev, daf->ncells, daf->cells, &irq, &pol,
607 case INTR_MAP_DATA_ACPI:
608 daa = (struct intr_map_data_acpi *)data;
614 case INTR_MAP_DATA_MSI:
616 dam = (struct intr_map_data_msi *)data;
617 if (gic_map_msi(dev, dam, &irq, &pol, &trig) != 0)
624 if (irq >= sc->gic_nirqs)
627 case INTR_POLARITY_CONFORM:
628 case INTR_POLARITY_LOW:
629 case INTR_POLARITY_HIGH:
635 case INTR_TRIGGER_CONFORM:
636 case INTR_TRIGGER_EDGE:
637 case INTR_TRIGGER_LEVEL:
652 gic_v3_map_intr(device_t dev, struct intr_map_data *data,
653 struct intr_irqsrc **isrcp)
655 struct gic_v3_softc *sc;
659 error = do_gic_v3_map_intr(dev, data, &irq, NULL, NULL);
661 sc = device_get_softc(dev);
662 *isrcp = GIC_INTR_ISRC(sc, irq);
668 gic_v3_setup_intr(device_t dev, struct intr_irqsrc *isrc,
669 struct resource *res, struct intr_map_data *data)
671 struct gic_v3_softc *sc = device_get_softc(dev);
672 struct gic_v3_irqsrc *gi = (struct gic_v3_irqsrc *)isrc;
673 enum intr_trigger trig;
674 enum intr_polarity pol;
682 error = do_gic_v3_map_intr(dev, data, &irq, &pol, &trig);
686 if (gi->gi_irq != irq || pol == INTR_POLARITY_CONFORM ||
687 trig == INTR_TRIGGER_CONFORM)
690 /* Compare config if this is not first setup. */
691 if (isrc->isrc_handlers != 0) {
692 if (pol != gi->gi_pol || trig != gi->gi_trig)
702 * XXX - In case that per CPU interrupt is going to be enabled in time
703 * when SMP is already started, we need some IPI call which
704 * enables it on others CPUs. Further, it's more complicated as
705 * pic_enable_source() and pic_disable_source() should act on
706 * per CPU basis only. Thus, it should be solved here somehow.
708 if (isrc->isrc_flags & INTR_ISRCF_PPI)
709 CPU_SET(PCPU_GET(cpuid), &isrc->isrc_cpu);
711 if (irq >= GIC_FIRST_PPI && irq <= GIC_LAST_SPI) {
712 mtx_lock_spin(&sc->gic_mtx);
714 /* Set the trigger and polarity */
715 if (irq <= GIC_LAST_PPI)
716 reg = gic_r_read(sc, 4,
717 GICR_SGI_BASE_SIZE + GICD_ICFGR(irq));
719 reg = gic_d_read(sc, 4, GICD_ICFGR(irq));
720 if (trig == INTR_TRIGGER_LEVEL)
721 reg &= ~(2 << ((irq % 16) * 2));
723 reg |= 2 << ((irq % 16) * 2);
725 if (irq <= GIC_LAST_PPI) {
727 GICR_SGI_BASE_SIZE + GICD_ICFGR(irq), reg);
728 gic_v3_wait_for_rwp(sc, REDIST);
730 gic_d_write(sc, 4, GICD_ICFGR(irq), reg);
731 gic_v3_wait_for_rwp(sc, DIST);
734 mtx_unlock_spin(&sc->gic_mtx);
736 gic_v3_bind_intr(dev, isrc);
743 gic_v3_teardown_intr(device_t dev, struct intr_irqsrc *isrc,
744 struct resource *res, struct intr_map_data *data)
746 struct gic_v3_irqsrc *gi = (struct gic_v3_irqsrc *)isrc;
748 if (isrc->isrc_handlers == 0) {
749 gi->gi_pol = INTR_POLARITY_CONFORM;
750 gi->gi_trig = INTR_TRIGGER_CONFORM;
757 gic_v3_disable_intr(device_t dev, struct intr_irqsrc *isrc)
759 struct gic_v3_softc *sc;
760 struct gic_v3_irqsrc *gi;
763 sc = device_get_softc(dev);
764 gi = (struct gic_v3_irqsrc *)isrc;
767 if (irq <= GIC_LAST_PPI) {
768 /* SGIs and PPIs in corresponding Re-Distributor */
769 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICD_ICENABLER(irq),
771 gic_v3_wait_for_rwp(sc, REDIST);
772 } else if (irq >= GIC_FIRST_SPI && irq <= GIC_LAST_SPI) {
773 /* SPIs in distributor */
774 gic_d_write(sc, 4, GICD_ICENABLER(irq), GICD_I_MASK(irq));
775 gic_v3_wait_for_rwp(sc, DIST);
777 panic("%s: Unsupported IRQ %u", __func__, irq);
781 gic_v3_enable_intr(device_t dev, struct intr_irqsrc *isrc)
783 struct gic_v3_softc *sc;
784 struct gic_v3_irqsrc *gi;
787 sc = device_get_softc(dev);
788 gi = (struct gic_v3_irqsrc *)isrc;
791 if (irq <= GIC_LAST_PPI) {
792 /* SGIs and PPIs in corresponding Re-Distributor */
793 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICD_ISENABLER(irq),
795 gic_v3_wait_for_rwp(sc, REDIST);
796 } else if (irq >= GIC_FIRST_SPI && irq <= GIC_LAST_SPI) {
797 /* SPIs in distributor */
798 gic_d_write(sc, 4, GICD_ISENABLER(irq), GICD_I_MASK(irq));
799 gic_v3_wait_for_rwp(sc, DIST);
801 panic("%s: Unsupported IRQ %u", __func__, irq);
805 gic_v3_pre_ithread(device_t dev, struct intr_irqsrc *isrc)
807 struct gic_v3_irqsrc *gi = (struct gic_v3_irqsrc *)isrc;
809 gic_v3_disable_intr(dev, isrc);
810 gic_icc_write(EOIR1, gi->gi_irq);
814 gic_v3_post_ithread(device_t dev, struct intr_irqsrc *isrc)
817 gic_v3_enable_intr(dev, isrc);
821 gic_v3_post_filter(device_t dev, struct intr_irqsrc *isrc)
823 struct gic_v3_irqsrc *gi = (struct gic_v3_irqsrc *)isrc;
825 if (gi->gi_trig == INTR_TRIGGER_EDGE)
828 gic_icc_write(EOIR1, gi->gi_irq);
832 gic_v3_bind_intr(device_t dev, struct intr_irqsrc *isrc)
834 struct gic_v3_softc *sc;
835 struct gic_v3_irqsrc *gi;
838 gi = (struct gic_v3_irqsrc *)isrc;
839 if (gi->gi_irq <= GIC_LAST_PPI)
842 KASSERT(gi->gi_irq >= GIC_FIRST_SPI && gi->gi_irq <= GIC_LAST_SPI,
843 ("%s: Attempting to bind an invalid IRQ", __func__));
845 sc = device_get_softc(dev);
847 if (CPU_EMPTY(&isrc->isrc_cpu)) {
848 gic_irq_cpu = intr_irq_next_cpu(gic_irq_cpu, &all_cpus);
849 CPU_SETOF(gic_irq_cpu, &isrc->isrc_cpu);
850 gic_d_write(sc, 4, GICD_IROUTER(gi->gi_irq),
851 CPU_AFFINITY(gic_irq_cpu));
854 * We can only bind to a single CPU so select
855 * the first CPU found.
857 cpu = CPU_FFS(&isrc->isrc_cpu) - 1;
858 gic_d_write(sc, 4, GICD_IROUTER(gi->gi_irq), CPU_AFFINITY(cpu));
866 gic_v3_init_secondary(device_t dev)
869 struct gic_v3_softc *sc;
870 gic_v3_initseq_t *init_func;
871 struct intr_irqsrc *isrc;
875 sc = device_get_softc(dev);
876 cpu = PCPU_GET(cpuid);
878 /* Train init sequence for boot CPU */
879 for (init_func = gic_v3_secondary_init; *init_func != NULL;
881 err = (*init_func)(sc);
884 "Could not initialize GIC for CPU%u\n", cpu);
889 /* Unmask attached SGI interrupts. */
890 for (irq = GIC_FIRST_SGI; irq <= GIC_LAST_SGI; irq++) {
891 isrc = GIC_INTR_ISRC(sc, irq);
892 if (intr_isrc_init_on_cpu(isrc, cpu))
893 gic_v3_enable_intr(dev, isrc);
896 /* Unmask attached PPI interrupts. */
897 for (irq = GIC_FIRST_PPI; irq <= GIC_LAST_PPI; irq++) {
898 isrc = GIC_INTR_ISRC(sc, irq);
899 if (intr_isrc_init_on_cpu(isrc, cpu))
900 gic_v3_enable_intr(dev, isrc);
903 for (i = 0; i < sc->gic_nchildren; i++) {
904 child = sc->gic_children[i];
905 PIC_INIT_SECONDARY(child);
910 gic_v3_ipi_send(device_t dev, struct intr_irqsrc *isrc, cpuset_t cpus,
913 struct gic_v3_irqsrc *gi = (struct gic_v3_irqsrc *)isrc;
914 uint64_t aff, val, irq;
917 #define GIC_AFF_MASK (CPU_AFF3_MASK | CPU_AFF2_MASK | CPU_AFF1_MASK)
918 #define GIC_AFFINITY(i) (CPU_AFFINITY(i) & GIC_AFF_MASK)
919 aff = GIC_AFFINITY(0);
923 /* Iterate through all CPUs in set */
924 for (i = 0; i <= mp_maxid; i++) {
925 /* Move to the next affinity group */
926 if (aff != GIC_AFFINITY(i)) {
929 gic_icc_write(SGI1R, val);
932 aff = GIC_AFFINITY(i);
935 /* Send the IPI to this cpu */
936 if (CPU_ISSET(i, &cpus)) {
937 #define ICC_SGI1R_AFFINITY(aff) \
938 (((uint64_t)CPU_AFF3(aff) << ICC_SGI1R_EL1_AFF3_SHIFT) | \
939 ((uint64_t)CPU_AFF2(aff) << ICC_SGI1R_EL1_AFF2_SHIFT) | \
940 ((uint64_t)CPU_AFF1(aff) << ICC_SGI1R_EL1_AFF1_SHIFT))
941 /* Set the affinity when the first at this level */
943 val = ICC_SGI1R_AFFINITY(aff) |
944 irq << ICC_SGI1R_EL1_SGIID_SHIFT;
945 /* Set the bit to send the IPI to te CPU */
946 val |= 1 << CPU_AFF0(CPU_AFFINITY(i));
950 /* Send the IPI to the last cpu affinity group */
952 gic_icc_write(SGI1R, val);
958 gic_v3_ipi_setup(device_t dev, u_int ipi, struct intr_irqsrc **isrcp)
960 struct intr_irqsrc *isrc;
961 struct gic_v3_softc *sc = device_get_softc(dev);
963 if (sgi_first_unused > GIC_LAST_SGI)
966 isrc = GIC_INTR_ISRC(sc, sgi_first_unused);
967 sgi_to_ipi[sgi_first_unused++] = ipi;
969 CPU_SET(PCPU_GET(cpuid), &isrc->isrc_cpu);
980 gic_v3_wait_for_rwp(struct gic_v3_softc *sc, enum gic_v3_xdist xdist)
982 struct resource *res;
984 size_t us_left = 1000000;
986 cpuid = PCPU_GET(cpuid);
993 res = &sc->gic_redists.pcpu[cpuid]->res;
996 KASSERT(0, ("%s: Attempt to wait for unknown RWP", __func__));
1000 while ((bus_read_4(res, GICD_CTLR) & GICD_CTLR_RWP) != 0) {
1003 panic("GICD Register write pending for too long");
1007 /* CPU interface. */
1008 static __inline void
1009 gic_v3_cpu_priority(uint64_t mask)
1012 /* Set prority mask */
1013 gic_icc_write(PMR, mask & ICC_PMR_EL1_PRIO_MASK);
1017 gic_v3_cpu_enable_sre(struct gic_v3_softc *sc)
1022 cpuid = PCPU_GET(cpuid);
1024 * Set the SRE bit to enable access to GIC CPU interface
1025 * via system registers.
1027 sre = READ_SPECIALREG(icc_sre_el1);
1028 sre |= ICC_SRE_EL1_SRE;
1029 WRITE_SPECIALREG(icc_sre_el1, sre);
1032 * Now ensure that the bit is set.
1034 sre = READ_SPECIALREG(icc_sre_el1);
1035 if ((sre & ICC_SRE_EL1_SRE) == 0) {
1036 /* We are done. This was disabled in EL2 */
1037 device_printf(sc->dev, "ERROR: CPU%u cannot enable CPU interface "
1038 "via system registers\n", cpuid);
1040 } else if (bootverbose) {
1041 device_printf(sc->dev,
1042 "CPU%u enabled CPU interface via system registers\n",
1050 gic_v3_cpu_init(struct gic_v3_softc *sc)
1054 /* Enable access to CPU interface via system registers */
1055 err = gic_v3_cpu_enable_sre(sc);
1058 /* Priority mask to minimum - accept all interrupts */
1059 gic_v3_cpu_priority(GIC_PRIORITY_MIN);
1060 /* Disable EOI mode */
1061 gic_icc_clear(CTLR, ICC_CTLR_EL1_EOIMODE);
1062 /* Enable group 1 (insecure) interrups */
1063 gic_icc_set(IGRPEN1, ICC_IGRPEN0_EL1_EN);
1070 gic_v3_dist_init(struct gic_v3_softc *sc)
1076 * 1. Disable the Distributor
1078 gic_d_write(sc, 4, GICD_CTLR, 0);
1079 gic_v3_wait_for_rwp(sc, DIST);
1082 * 2. Configure the Distributor
1084 /* Set all SPIs to be Group 1 Non-secure */
1085 for (i = GIC_FIRST_SPI; i < sc->gic_nirqs; i += GICD_I_PER_IGROUPRn)
1086 gic_d_write(sc, 4, GICD_IGROUPR(i), 0xFFFFFFFF);
1088 /* Set all global interrupts to be level triggered, active low. */
1089 for (i = GIC_FIRST_SPI; i < sc->gic_nirqs; i += GICD_I_PER_ICFGRn)
1090 gic_d_write(sc, 4, GICD_ICFGR(i), 0x00000000);
1092 /* Set priority to all shared interrupts */
1093 for (i = GIC_FIRST_SPI;
1094 i < sc->gic_nirqs; i += GICD_I_PER_IPRIORITYn) {
1095 /* Set highest priority */
1096 gic_d_write(sc, 4, GICD_IPRIORITYR(i), GIC_PRIORITY_MAX);
1100 * Disable all interrupts. Leave PPI and SGIs as they are enabled in
1101 * Re-Distributor registers.
1103 for (i = GIC_FIRST_SPI; i < sc->gic_nirqs; i += GICD_I_PER_ISENABLERn)
1104 gic_d_write(sc, 4, GICD_ICENABLER(i), 0xFFFFFFFF);
1106 gic_v3_wait_for_rwp(sc, DIST);
1109 * 3. Enable Distributor
1111 /* Enable Distributor with ARE, Group 1 */
1112 gic_d_write(sc, 4, GICD_CTLR, GICD_CTLR_ARE_NS | GICD_CTLR_G1A |
1116 * 4. Route all interrupts to boot CPU.
1118 aff = CPU_AFFINITY(0);
1119 for (i = GIC_FIRST_SPI; i < sc->gic_nirqs; i++)
1120 gic_d_write(sc, 4, GICD_IROUTER(i), aff);
1125 /* Re-Distributor */
1127 gic_v3_redist_alloc(struct gic_v3_softc *sc)
1131 /* Allocate struct resource for all CPU's Re-Distributor registers */
1132 for (cpuid = 0; cpuid <= mp_maxid; cpuid++)
1133 if (CPU_ISSET(cpuid, &all_cpus) != 0)
1134 sc->gic_redists.pcpu[cpuid] =
1135 malloc(sizeof(*sc->gic_redists.pcpu[0]),
1136 M_GIC_V3, M_WAITOK);
1138 sc->gic_redists.pcpu[cpuid] = NULL;
1143 gic_v3_redist_find(struct gic_v3_softc *sc)
1145 struct resource r_res;
1146 bus_space_handle_t r_bsh;
1153 cpuid = PCPU_GET(cpuid);
1155 aff = CPU_AFFINITY(cpuid);
1156 /* Affinity in format for comparison with typer */
1157 aff = (CPU_AFF3(aff) << 24) | (CPU_AFF2(aff) << 16) |
1158 (CPU_AFF1(aff) << 8) | CPU_AFF0(aff);
1161 device_printf(sc->dev,
1162 "Start searching for Re-Distributor\n");
1164 /* Iterate through Re-Distributor regions */
1165 for (i = 0; i < sc->gic_redists.nregions; i++) {
1166 /* Take a copy of the region's resource */
1167 r_res = *sc->gic_redists.regions[i];
1168 r_bsh = rman_get_bushandle(&r_res);
1170 pidr2 = bus_read_4(&r_res, GICR_PIDR2);
1171 switch (GICR_PIDR2_ARCH(pidr2)) {
1172 case GICR_PIDR2_ARCH_GICv3: /* fall through */
1173 case GICR_PIDR2_ARCH_GICv4:
1176 device_printf(sc->dev,
1177 "No Re-Distributor found for CPU%u\n", cpuid);
1182 typer = bus_read_8(&r_res, GICR_TYPER);
1183 if ((typer >> GICR_TYPER_AFF_SHIFT) == aff) {
1184 KASSERT(sc->gic_redists.pcpu[cpuid] != NULL,
1185 ("Invalid pointer to per-CPU redistributor"));
1186 /* Copy res contents to its final destination */
1187 sc->gic_redists.pcpu[cpuid]->res = r_res;
1188 sc->gic_redists.pcpu[cpuid]->lpi_enabled = false;
1190 device_printf(sc->dev,
1191 "CPU%u Re-Distributor has been found\n",
1197 r_bsh += (GICR_RD_BASE_SIZE + GICR_SGI_BASE_SIZE);
1198 if ((typer & GICR_TYPER_VLPIS) != 0) {
1200 (GICR_VLPI_BASE_SIZE + GICR_RESERVED_SIZE);
1203 rman_set_bushandle(&r_res, r_bsh);
1204 } while ((typer & GICR_TYPER_LAST) == 0);
1207 device_printf(sc->dev, "No Re-Distributor found for CPU%u\n", cpuid);
1212 gic_v3_redist_wake(struct gic_v3_softc *sc)
1215 size_t us_left = 1000000;
1217 waker = gic_r_read(sc, 4, GICR_WAKER);
1218 /* Wake up Re-Distributor for this CPU */
1219 waker &= ~GICR_WAKER_PS;
1220 gic_r_write(sc, 4, GICR_WAKER, waker);
1222 * When clearing ProcessorSleep bit it is required to wait for
1223 * ChildrenAsleep to become zero following the processor power-on.
1225 while ((gic_r_read(sc, 4, GICR_WAKER) & GICR_WAKER_CA) != 0) {
1227 if (us_left-- == 0) {
1228 panic("Could not wake Re-Distributor for CPU%u",
1234 device_printf(sc->dev, "CPU%u Re-Distributor woke up\n",
1242 gic_v3_redist_init(struct gic_v3_softc *sc)
1247 err = gic_v3_redist_find(sc);
1251 err = gic_v3_redist_wake(sc);
1255 /* Configure SGIs and PPIs to be Group1 Non-secure */
1256 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICR_IGROUPR0,
1260 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICR_ICENABLER0,
1261 GICR_I_ENABLER_PPI_MASK);
1263 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICR_ISENABLER0,
1264 GICR_I_ENABLER_SGI_MASK);
1266 /* Set priority for SGIs and PPIs */
1267 for (i = 0; i <= GIC_LAST_PPI; i += GICR_I_PER_IPRIORITYn) {
1268 gic_r_write(sc, 4, GICR_SGI_BASE_SIZE + GICD_IPRIORITYR(i),
1272 gic_v3_wait_for_rwp(sc, REDIST);