2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright 2011 Nathan Whitehorn
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include "opt_platform.h"
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/module.h>
38 #include <sys/kernel.h>
40 #include <sys/malloc.h>
41 #include <sys/mutex.h>
47 #include <machine/bus.h>
48 #include <machine/intr_machdep.h>
49 #include <machine/md_var.h>
50 #include <machine/rtas.h>
52 #include <dev/ofw/ofw_bus.h>
53 #include <dev/ofw/ofw_bus_subr.h>
56 #include <powerpc/powernv/opal.h>
59 #include "phyp-hvcall.h"
62 #define XICP_PRIORITY 5 /* Random non-zero number */
64 #define MAX_XICP_IRQS (1<<24) /* 24-bit XIRR field */
66 static int xicp_probe(device_t);
67 static int xicp_attach(device_t);
68 static int xics_probe(device_t);
69 static int xics_attach(device_t);
71 static void xicp_bind(device_t dev, u_int irq, cpuset_t cpumask, void **priv);
72 static void xicp_dispatch(device_t, struct trapframe *);
73 static void xicp_enable(device_t, u_int, u_int, void **priv);
74 static void xicp_eoi(device_t, u_int, void *priv);
75 static void xicp_ipi(device_t, u_int);
76 static void xicp_mask(device_t, u_int, void *priv);
77 static void xicp_unmask(device_t, u_int, void *priv);
80 extern void (*powernv_smp_ap_extra_init)(void);
81 static void xicp_smp_cpu_startup(void);
84 static device_method_t xicp_methods[] = {
85 /* Device interface */
86 DEVMETHOD(device_probe, xicp_probe),
87 DEVMETHOD(device_attach, xicp_attach),
90 DEVMETHOD(pic_bind, xicp_bind),
91 DEVMETHOD(pic_dispatch, xicp_dispatch),
92 DEVMETHOD(pic_enable, xicp_enable),
93 DEVMETHOD(pic_eoi, xicp_eoi),
94 DEVMETHOD(pic_ipi, xicp_ipi),
95 DEVMETHOD(pic_mask, xicp_mask),
96 DEVMETHOD(pic_unmask, xicp_unmask),
101 static device_method_t xics_methods[] = {
102 /* Device interface */
103 DEVMETHOD(device_probe, xics_probe),
104 DEVMETHOD(device_attach, xics_attach),
117 struct resource *mem[MAXCPU];
126 /* XXX: inefficient -- hash table? tree? */
127 struct xicp_intvec intvecs[256];
133 static driver_t xicp_driver = {
136 sizeof(struct xicp_softc)
139 static driver_t xics_driver = {
146 /* We can only pass physical addresses into OPAL. Kernel stacks are in the KVA,
147 * not in the direct map, so we need to somehow extract the physical address.
148 * However, pmap_kextract() takes locks, which is forbidden in a critical region
149 * (which PIC_DISPATCH() operates in). The kernel is mapped into the Direct
150 * Map (0xc000....), and the CPU implicitly drops the top two bits when doing
151 * real address by nature that the bus width is smaller than 64-bits. Placing
152 * cpu_xirr into the DMAP lets us take advantage of this and avoids the
153 * pmap_kextract() that would otherwise be needed if using the stack variable.
155 static uint32_t cpu_xirr[MAXCPU];
158 static devclass_t xicp_devclass;
159 static devclass_t xics_devclass;
161 EARLY_DRIVER_MODULE(xicp, ofwbus, xicp_driver, xicp_devclass, 0, 0,
162 BUS_PASS_INTERRUPT-1);
163 EARLY_DRIVER_MODULE(xics, ofwbus, xics_driver, xics_devclass, 0, 0,
167 static struct resource *
168 xicp_mem_for_cpu(int cpu)
171 struct xicp_softc *sc;
174 for (i = 0; (dev = devclass_get_device(xicp_devclass, i)) != NULL; i++){
175 sc = device_get_softc(dev);
176 if (cpu >= sc->cpu_range[0] && cpu < sc->cpu_range[1])
177 return (sc->mem[cpu - sc->cpu_range[0]]);
185 xicp_probe(device_t dev)
188 if (!ofw_bus_is_compatible(dev, "ibm,ppc-xicp") &&
189 !ofw_bus_is_compatible(dev, "ibm,opal-intc"))
192 device_set_desc(dev, "External Interrupt Presentation Controller");
193 return (BUS_PROBE_GENERIC);
197 xics_probe(device_t dev)
200 if (!ofw_bus_is_compatible(dev, "ibm,ppc-xics") &&
201 !ofw_bus_is_compatible(dev, "IBM,opal-xics"))
204 device_set_desc(dev, "External Interrupt Source Controller");
205 return (BUS_PROBE_GENERIC);
209 xicp_attach(device_t dev)
211 struct xicp_softc *sc = device_get_softc(dev);
212 phandle_t phandle = ofw_bus_get_node(dev);
215 sc->ibm_int_on = rtas_token_lookup("ibm,int-on");
216 sc->ibm_int_off = rtas_token_lookup("ibm,int-off");
217 sc->ibm_set_xive = rtas_token_lookup("ibm,set-xive");
218 sc->ibm_get_xive = rtas_token_lookup("ibm,get-xive");
220 } else if (opal_check() == 0) {
224 device_printf(dev, "Cannot attach without RTAS or OPAL\n");
228 if (OF_hasprop(phandle, "ibm,interrupt-server-ranges")) {
229 OF_getencprop(phandle, "ibm,interrupt-server-ranges",
230 sc->cpu_range, sizeof(sc->cpu_range));
231 sc->cpu_range[1] += sc->cpu_range[0];
232 device_printf(dev, "Handling CPUs %d-%d\n", sc->cpu_range[0],
235 } else if (ofw_bus_is_compatible(dev, "ibm,opal-intc")) {
237 * For now run POWER9 XIVE interrupt controller in XICS
238 * compatibility mode.
241 opal_call(OPAL_XIVE_RESET, OPAL_XIVE_XICS_MODE_EMU);
244 sc->cpu_range[0] = 0;
245 sc->cpu_range[1] = mp_ncpus;
249 if (mfmsr() & PSL_HV) {
253 opal_call(OPAL_INT_SET_CPPR, 0xff);
254 for (i = 0; i < mp_ncpus; i++) {
255 opal_call(OPAL_INT_SET_MFRR,
256 pcpu_find(i)->pc_hwref, 0xff);
259 for (i = 0; i < sc->cpu_range[1] - sc->cpu_range[0]; i++) {
260 sc->mem[i] = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
262 if (sc->mem[i] == NULL) {
263 device_printf(dev, "Could not alloc mem "
268 /* Unmask interrupts on all cores */
269 bus_write_1(sc->mem[i], 4, 0xff);
270 bus_write_1(sc->mem[i], 12, 0xff);
276 mtx_init(&sc->sc_mtx, "XICP", NULL, MTX_DEF);
279 powerpc_register_pic(dev, OF_xref_from_node(phandle), MAX_XICP_IRQS,
280 1 /* Number of IPIs */, FALSE);
285 powernv_smp_ap_extra_init = xicp_smp_cpu_startup;
292 xics_attach(device_t dev)
294 phandle_t phandle = ofw_bus_get_node(dev);
296 /* The XICP (root PIC) will handle all our interrupts */
297 powerpc_register_pic(root_pic, OF_xref_from_node(phandle),
298 MAX_XICP_IRQS, 1 /* Number of IPIs */, FALSE);
303 static __inline struct xicp_intvec *
304 xicp_setup_priv(struct xicp_softc *sc, u_int irq, void **priv)
307 KASSERT(sc->nintvecs + 1 < nitems(sc->intvecs),
308 ("Too many XICP interrupts"));
309 mtx_lock(&sc->sc_mtx);
310 *priv = &sc->intvecs[sc->nintvecs++];
311 mtx_unlock(&sc->sc_mtx);
322 xicp_bind(device_t dev, u_int irq, cpuset_t cpumask, void **priv)
324 struct xicp_softc *sc = device_get_softc(dev);
325 struct xicp_intvec *iv;
327 int ncpus, i, error = -1;
330 if (irq == MAX_XICP_IRQS)
333 iv = xicp_setup_priv(sc, irq, priv);
336 * This doesn't appear to actually support affinity groups, so pick a
341 if (CPU_ISSET(cpu, &cpumask)) ncpus++;
346 if (!CPU_ISSET(cpu, &cpumask))
353 cpu = pcpu_find(cpu)->pc_hwref;
357 error = rtas_call_method(sc->ibm_set_xive, 3, 1, irq, cpu,
358 XICP_PRIORITY, &status);
361 error = opal_call(OPAL_SET_XIVE, irq, cpu << 2, XICP_PRIORITY);
365 panic("Cannot bind interrupt %d to CPU %d", irq, cpu);
369 xicp_dispatch(device_t dev, struct trapframe *tf)
371 struct xicp_softc *sc;
372 struct resource *regs = NULL;
376 sc = device_get_softc(dev);
378 if ((mfmsr() & PSL_HV) && !sc->xics_emu) {
379 regs = xicp_mem_for_cpu(PCPU_GET(hwref));
380 KASSERT(regs != NULL,
381 ("Can't find regs for CPU %ld", (uintptr_t)PCPU_GET(hwref)));
386 /* Return value in R4, use the PFT call */
388 xirr = bus_read_4(regs, 4);
390 } else if (sc->xics_emu) {
391 opal_call(OPAL_INT_GET_XIRR, &cpu_xirr[PCPU_GET(cpuid)],
393 xirr = cpu_xirr[PCPU_GET(cpuid)];
396 /* Return value in R4, use the PFT call */
397 phyp_pft_hcall(H_XIRR, 0, 0, 0, 0, &xirr, &junk, &junk);
401 if (xirr == 0) /* No more pending interrupts? */
404 if (xirr == XICP_IPI) { /* Magic number for IPIs */
405 xirr = MAX_XICP_IRQS; /* Map to FreeBSD magic */
409 bus_write_1(regs, 12, 0xff);
411 else if (sc->xics_emu)
412 opal_call(OPAL_INT_SET_MFRR,
413 PCPU_GET(hwref), 0xff);
416 phyp_hcall(H_IPI, (uint64_t)(PCPU_GET(hwref)),
420 /* XXX: super inefficient */
421 for (i = 0; i < sc->nintvecs; i++) {
422 if (sc->intvecs[i].irq == xirr)
425 KASSERT(i < sc->nintvecs, ("Unmapped XIRR"));
428 powerpc_dispatch_intr(sc->intvecs[i].vector, tf);
433 xicp_enable(device_t dev, u_int irq, u_int vector, void **priv)
435 struct xicp_softc *sc;
436 struct xicp_intvec *intr;
439 sc = device_get_softc(dev);
441 /* Bind to this CPU to start: distrib. ID is last entry in gserver# */
442 cpu = PCPU_GET(hwref);
444 intr = xicp_setup_priv(sc, irq, priv);
447 intr->vector = vector;
451 /* IPIs are also enabled. Stash off the vector index */
452 if (irq == MAX_XICP_IRQS) {
453 sc->ipi_vec = intr - sc->intvecs;
458 rtas_call_method(sc->ibm_set_xive, 3, 1, irq, cpu,
459 XICP_PRIORITY, &status);
460 xicp_unmask(dev, irq, intr);
463 status = opal_call(OPAL_SET_XIVE, irq, cpu << 2, XICP_PRIORITY);
464 /* Unmask implicit for OPAL */
467 panic("OPAL_SET_XIVE IRQ %d -> cpu %d failed: %d", irq,
474 xicp_eoi(device_t dev, u_int irq, void *priv)
477 struct xicp_softc *sc;
481 if (irq == MAX_XICP_IRQS) /* Remap IPI interrupt to internal value */
483 xirr = irq | (0xff << 24);
486 if (mfmsr() & PSL_HV) {
487 sc = device_get_softc(dev);
489 opal_call(OPAL_INT_EOI, xirr);
491 bus_write_4(xicp_mem_for_cpu(PCPU_GET(hwref)), 4, xirr);
494 phyp_hcall(H_EOI, xirr);
498 xicp_ipi(device_t dev, u_int cpu)
502 struct xicp_softc *sc;
503 cpu = pcpu_find(cpu)->pc_hwref;
505 if (mfmsr() & PSL_HV) {
506 sc = device_get_softc(dev);
509 rv = opal_call(OPAL_INT_SET_MFRR, cpu, XICP_PRIORITY);
511 device_printf(dev, "IPI SET_MFRR result: %ld\n", rv);
513 bus_write_1(xicp_mem_for_cpu(cpu), 12, XICP_PRIORITY);
516 phyp_hcall(H_IPI, (uint64_t)cpu, XICP_PRIORITY);
520 xicp_mask(device_t dev, u_int irq, void *priv)
522 struct xicp_softc *sc = device_get_softc(dev);
525 if (irq == MAX_XICP_IRQS)
529 rtas_call_method(sc->ibm_int_off, 1, 1, irq, &status);
532 struct xicp_intvec *ivec = priv;
534 KASSERT(ivec != NULL, ("Masking unconfigured interrupt"));
535 opal_call(OPAL_SET_XIVE, irq, ivec->cpu << 2, 0xff);
541 xicp_unmask(device_t dev, u_int irq, void *priv)
543 struct xicp_softc *sc = device_get_softc(dev);
546 if (irq == MAX_XICP_IRQS)
550 rtas_call_method(sc->ibm_int_on, 1, 1, irq, &status);
553 struct xicp_intvec *ivec = priv;
555 KASSERT(ivec != NULL, ("Unmasking unconfigured interrupt"));
556 opal_call(OPAL_SET_XIVE, irq, ivec->cpu << 2, XICP_PRIORITY);
562 /* This is only used on POWER9 systems with the XIVE's XICS emulation. */
564 xicp_smp_cpu_startup(void)
566 struct xicp_softc *sc;
568 if (mfmsr() & PSL_HV) {
569 sc = device_get_softc(root_pic);
572 opal_call(OPAL_INT_SET_CPPR, 0xff);