1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Support for the interrupt controllers found on Power Macintosh,
4 * currently Apple's "Grand Central" interrupt controller in all
5 * it's incarnations. OpenPIC support used on newer machines is
8 * Copyright (C) 1997 Paul Mackerras (paulus@samba.org)
9 * Copyright (C) 2005 Benjamin Herrenschmidt (benh@kernel.crashing.org)
13 #include <linux/stddef.h>
14 #include <linux/init.h>
15 #include <linux/sched.h>
16 #include <linux/signal.h>
17 #include <linux/pci.h>
18 #include <linux/interrupt.h>
19 #include <linux/syscore_ops.h>
20 #include <linux/adb.h>
21 #include <linux/pmu.h>
23 #include <asm/sections.h>
27 #include <asm/pci-bridge.h>
29 #include <asm/pmac_feature.h>
43 /* Workaround flags for 32bit powermac machines */
44 unsigned int of_irq_workarounds;
45 struct device_node *of_irq_dflt_pic;
47 /* Default addresses */
48 static volatile struct pmac_irq_hw __iomem *pmac_irq_hw[4];
51 static int max_real_irqs;
53 static DEFINE_RAW_SPINLOCK(pmac_pic_lock);
55 /* The max irq number this driver deals with is 128; see max_irqs */
56 static DECLARE_BITMAP(ppc_lost_interrupts, 128);
57 static DECLARE_BITMAP(ppc_cached_irq_mask, 128);
58 static int pmac_irq_cascade = -1;
59 static struct irq_domain *pmac_pic_host;
61 static void __pmac_retrigger(unsigned int irq_nr)
63 if (irq_nr >= max_real_irqs && pmac_irq_cascade > 0) {
64 __set_bit(irq_nr, ppc_lost_interrupts);
65 irq_nr = pmac_irq_cascade;
68 if (!__test_and_set_bit(irq_nr, ppc_lost_interrupts)) {
69 atomic_inc(&ppc_n_lost_interrupts);
74 static void pmac_mask_and_ack_irq(struct irq_data *d)
76 unsigned int src = irqd_to_hwirq(d);
77 unsigned long bit = 1UL << (src & 0x1f);
81 raw_spin_lock_irqsave(&pmac_pic_lock, flags);
82 __clear_bit(src, ppc_cached_irq_mask);
83 if (__test_and_clear_bit(src, ppc_lost_interrupts))
84 atomic_dec(&ppc_n_lost_interrupts);
85 out_le32(&pmac_irq_hw[i]->enable, ppc_cached_irq_mask[i]);
86 out_le32(&pmac_irq_hw[i]->ack, bit);
88 /* make sure ack gets to controller before we enable
91 } while((in_le32(&pmac_irq_hw[i]->enable) & bit)
92 != (ppc_cached_irq_mask[i] & bit));
93 raw_spin_unlock_irqrestore(&pmac_pic_lock, flags);
96 static void pmac_ack_irq(struct irq_data *d)
98 unsigned int src = irqd_to_hwirq(d);
99 unsigned long bit = 1UL << (src & 0x1f);
103 raw_spin_lock_irqsave(&pmac_pic_lock, flags);
104 if (__test_and_clear_bit(src, ppc_lost_interrupts))
105 atomic_dec(&ppc_n_lost_interrupts);
106 out_le32(&pmac_irq_hw[i]->ack, bit);
107 (void)in_le32(&pmac_irq_hw[i]->ack);
108 raw_spin_unlock_irqrestore(&pmac_pic_lock, flags);
111 static void __pmac_set_irq_mask(unsigned int irq_nr, int nokicklost)
113 unsigned long bit = 1UL << (irq_nr & 0x1f);
116 if ((unsigned)irq_nr >= max_irqs)
119 /* enable unmasked interrupts */
120 out_le32(&pmac_irq_hw[i]->enable, ppc_cached_irq_mask[i]);
123 /* make sure mask gets to controller before we
126 } while((in_le32(&pmac_irq_hw[i]->enable) & bit)
127 != (ppc_cached_irq_mask[i] & bit));
130 * Unfortunately, setting the bit in the enable register
131 * when the device interrupt is already on *doesn't* set
132 * the bit in the flag register or request another interrupt.
134 if (bit & ppc_cached_irq_mask[i] & in_le32(&pmac_irq_hw[i]->level))
135 __pmac_retrigger(irq_nr);
138 /* When an irq gets requested for the first client, if it's an
139 * edge interrupt, we clear any previous one on the controller
141 static unsigned int pmac_startup_irq(struct irq_data *d)
144 unsigned int src = irqd_to_hwirq(d);
145 unsigned long bit = 1UL << (src & 0x1f);
148 raw_spin_lock_irqsave(&pmac_pic_lock, flags);
149 if (!irqd_is_level_type(d))
150 out_le32(&pmac_irq_hw[i]->ack, bit);
151 __set_bit(src, ppc_cached_irq_mask);
152 __pmac_set_irq_mask(src, 0);
153 raw_spin_unlock_irqrestore(&pmac_pic_lock, flags);
158 static void pmac_mask_irq(struct irq_data *d)
161 unsigned int src = irqd_to_hwirq(d);
163 raw_spin_lock_irqsave(&pmac_pic_lock, flags);
164 __clear_bit(src, ppc_cached_irq_mask);
165 __pmac_set_irq_mask(src, 1);
166 raw_spin_unlock_irqrestore(&pmac_pic_lock, flags);
169 static void pmac_unmask_irq(struct irq_data *d)
172 unsigned int src = irqd_to_hwirq(d);
174 raw_spin_lock_irqsave(&pmac_pic_lock, flags);
175 __set_bit(src, ppc_cached_irq_mask);
176 __pmac_set_irq_mask(src, 0);
177 raw_spin_unlock_irqrestore(&pmac_pic_lock, flags);
180 static int pmac_retrigger(struct irq_data *d)
184 raw_spin_lock_irqsave(&pmac_pic_lock, flags);
185 __pmac_retrigger(irqd_to_hwirq(d));
186 raw_spin_unlock_irqrestore(&pmac_pic_lock, flags);
190 static struct irq_chip pmac_pic = {
192 .irq_startup = pmac_startup_irq,
193 .irq_mask = pmac_mask_irq,
194 .irq_ack = pmac_ack_irq,
195 .irq_mask_ack = pmac_mask_and_ack_irq,
196 .irq_unmask = pmac_unmask_irq,
197 .irq_retrigger = pmac_retrigger,
200 static irqreturn_t gatwick_action(int cpl, void *dev_id)
206 raw_spin_lock_irqsave(&pmac_pic_lock, flags);
207 for (irq = max_irqs; (irq -= 32) >= max_real_irqs; ) {
209 bits = in_le32(&pmac_irq_hw[i]->event) | ppc_lost_interrupts[i];
210 bits |= in_le32(&pmac_irq_hw[i]->level);
211 bits &= ppc_cached_irq_mask[i];
214 irq += __ilog2(bits);
215 raw_spin_unlock_irqrestore(&pmac_pic_lock, flags);
216 generic_handle_irq(irq);
217 raw_spin_lock_irqsave(&pmac_pic_lock, flags);
220 raw_spin_unlock_irqrestore(&pmac_pic_lock, flags);
224 static unsigned int pmac_pic_get_irq(void)
227 unsigned long bits = 0;
230 #ifdef CONFIG_PPC_PMAC32_PSURGE
231 /* IPI's are a hack on the powersurge -- Cort */
232 if (smp_processor_id() != 0) {
233 return psurge_secondary_virq;
235 #endif /* CONFIG_PPC_PMAC32_PSURGE */
236 raw_spin_lock_irqsave(&pmac_pic_lock, flags);
237 for (irq = max_real_irqs; (irq -= 32) >= 0; ) {
239 bits = in_le32(&pmac_irq_hw[i]->event) | ppc_lost_interrupts[i];
240 bits |= in_le32(&pmac_irq_hw[i]->level);
241 bits &= ppc_cached_irq_mask[i];
244 irq += __ilog2(bits);
247 raw_spin_unlock_irqrestore(&pmac_pic_lock, flags);
248 if (unlikely(irq < 0))
250 return irq_linear_revmap(pmac_pic_host, irq);
254 static struct irqaction xmon_action = {
256 .flags = IRQF_NO_THREAD,
261 static struct irqaction gatwick_cascade_action = {
262 .handler = gatwick_action,
263 .flags = IRQF_NO_THREAD,
267 static int pmac_pic_host_match(struct irq_domain *h, struct device_node *node,
268 enum irq_domain_bus_token bus_token)
270 /* We match all, we don't always have a node anyway */
274 static int pmac_pic_host_map(struct irq_domain *h, unsigned int virq,
280 /* Mark level interrupts, set delayed disable for edge ones and set
283 irq_set_status_flags(virq, IRQ_LEVEL);
284 irq_set_chip_and_handler(virq, &pmac_pic, handle_level_irq);
288 static const struct irq_domain_ops pmac_pic_host_ops = {
289 .match = pmac_pic_host_match,
290 .map = pmac_pic_host_map,
291 .xlate = irq_domain_xlate_onecell,
294 static void __init pmac_pic_probe_oldstyle(void)
297 struct device_node *master = NULL;
298 struct device_node *slave = NULL;
302 /* Set our get_irq function */
303 ppc_md.get_irq = pmac_pic_get_irq;
306 * Find the interrupt controller type & node
309 if ((master = of_find_node_by_name(NULL, "gc")) != NULL) {
310 max_irqs = max_real_irqs = 32;
311 } else if ((master = of_find_node_by_name(NULL, "ohare")) != NULL) {
312 max_irqs = max_real_irqs = 32;
313 /* We might have a second cascaded ohare */
314 slave = of_find_node_by_name(NULL, "pci106b,7");
317 } else if ((master = of_find_node_by_name(NULL, "mac-io")) != NULL) {
318 max_irqs = max_real_irqs = 64;
320 /* We might have a second cascaded heathrow */
322 /* Compensate for of_node_put() in of_find_node_by_name() */
324 slave = of_find_node_by_name(master, "mac-io");
326 /* Check ordering of master & slave */
327 if (of_device_is_compatible(master, "gatwick")) {
328 struct device_node *tmp;
329 BUG_ON(slave == NULL);
335 /* We found a slave */
339 BUG_ON(master == NULL);
342 * Allocate an irq host
344 pmac_pic_host = irq_domain_add_linear(master, max_irqs,
345 &pmac_pic_host_ops, NULL);
346 BUG_ON(pmac_pic_host == NULL);
347 irq_set_default_host(pmac_pic_host);
349 /* Get addresses of first controller if we have a node for it */
350 BUG_ON(of_address_to_resource(master, 0, &r));
352 /* Map interrupts of primary controller */
353 addr = (u8 __iomem *) ioremap(r.start, 0x40);
355 pmac_irq_hw[i++] = (volatile struct pmac_irq_hw __iomem *)
357 if (max_real_irqs > 32)
358 pmac_irq_hw[i++] = (volatile struct pmac_irq_hw __iomem *)
362 printk(KERN_INFO "irq: Found primary Apple PIC %pOF for %d irqs\n",
363 master, max_real_irqs);
365 /* Map interrupts of cascaded controller */
366 if (slave && !of_address_to_resource(slave, 0, &r)) {
367 addr = (u8 __iomem *)ioremap(r.start, 0x40);
368 pmac_irq_hw[i++] = (volatile struct pmac_irq_hw __iomem *)
372 (volatile struct pmac_irq_hw __iomem *)
374 pmac_irq_cascade = irq_of_parse_and_map(slave, 0);
376 printk(KERN_INFO "irq: Found slave Apple PIC %pOF for %d irqs"
377 " cascade: %d\n", slave,
378 max_irqs - max_real_irqs, pmac_irq_cascade);
382 /* Disable all interrupts in all controllers */
383 for (i = 0; i * 32 < max_irqs; ++i)
384 out_le32(&pmac_irq_hw[i]->enable, 0);
386 /* Hookup cascade irq */
387 if (slave && pmac_irq_cascade)
388 setup_irq(pmac_irq_cascade, &gatwick_cascade_action);
390 printk(KERN_INFO "irq: System has %d possible interrupts\n", max_irqs);
392 setup_irq(irq_create_mapping(NULL, 20), &xmon_action);
396 int of_irq_parse_oldworld(struct device_node *device, int index,
397 struct of_phandle_args *out_irq)
399 const u32 *ints = NULL;
403 * Old machines just have a list of interrupt numbers
404 * and no interrupt-controller nodes. We also have dodgy
405 * cases where the APPL,interrupts property is completely
406 * missing behind pci-pci bridges and we have to get it
407 * from the parent (the bridge itself, as apple just wired
408 * everything together on these)
411 ints = of_get_property(device, "AAPL,interrupts", &intlen);
414 device = device->parent;
415 if (!of_node_is_type(device, "pci"))
420 intlen /= sizeof(u32);
426 out_irq->args[0] = ints[index];
427 out_irq->args_count = 1;
431 #endif /* CONFIG_PPC32 */
433 static void __init pmac_pic_setup_mpic_nmi(struct mpic *mpic)
435 #if defined(CONFIG_XMON) && defined(CONFIG_PPC32)
436 struct device_node* pswitch;
439 pswitch = of_find_node_by_name(NULL, "programmer-switch");
441 nmi_irq = irq_of_parse_and_map(pswitch, 0);
443 mpic_irq_set_priority(nmi_irq, 9);
444 setup_irq(nmi_irq, &xmon_action);
446 of_node_put(pswitch);
448 #endif /* defined(CONFIG_XMON) && defined(CONFIG_PPC32) */
451 static struct mpic * __init pmac_setup_one_mpic(struct device_node *np,
454 const char *name = master ? " MPIC 1 " : " MPIC 2 ";
456 unsigned int flags = master ? 0 : MPIC_SECONDARY;
458 pmac_call_feature(PMAC_FTR_ENABLE_MPIC, np, 0, 0);
460 if (of_get_property(np, "big-endian", NULL))
461 flags |= MPIC_BIG_ENDIAN;
463 /* Primary Big Endian means HT interrupts. This is quite dodgy
464 * but works until I find a better way
466 if (master && (flags & MPIC_BIG_ENDIAN))
467 flags |= MPIC_U3_HT_IRQS;
469 mpic = mpic_alloc(np, 0, flags, 0, 0, name);
478 static int __init pmac_pic_probe_mpic(void)
480 struct mpic *mpic1, *mpic2;
481 struct device_node *np, *master = NULL, *slave = NULL;
483 /* We can have up to 2 MPICs cascaded */
484 for_each_node_by_type(np, "open-pic") {
485 if (master == NULL &&
486 of_get_property(np, "interrupts", NULL) == NULL)
487 master = of_node_get(np);
488 else if (slave == NULL)
489 slave = of_node_get(np);
490 if (master && slave) {
496 /* Check for bogus setups */
497 if (master == NULL && slave != NULL) {
502 /* Not found, default to good old pmac pic */
506 /* Set master handler */
507 ppc_md.get_irq = mpic_get_irq;
510 mpic1 = pmac_setup_one_mpic(master, 1);
511 BUG_ON(mpic1 == NULL);
513 /* Install NMI if any */
514 pmac_pic_setup_mpic_nmi(mpic1);
518 /* Set up a cascaded controller, if present */
520 mpic2 = pmac_setup_one_mpic(slave, 0);
522 printk(KERN_ERR "Failed to setup slave MPIC\n");
530 void __init pmac_pic_init(void)
532 /* We configure the OF parsing based on our oldworld vs. newworld
533 * platform type and whether we were booted by BootX.
537 of_irq_workarounds |= OF_IMAP_OLDWORLD_MAC;
538 if (of_get_property(of_chosen, "linux,bootx", NULL) != NULL)
539 of_irq_workarounds |= OF_IMAP_NO_PHANDLE;
541 /* If we don't have phandles on a newworld, then try to locate a
542 * default interrupt controller (happens when booting with BootX).
543 * We do a first match here, hopefully, that only ever happens on
544 * machines with one controller.
546 if (pmac_newworld && (of_irq_workarounds & OF_IMAP_NO_PHANDLE)) {
547 struct device_node *np;
549 for_each_node_with_property(np, "interrupt-controller") {
550 /* Skip /chosen/interrupt-controller */
551 if (of_node_name_eq(np, "chosen"))
553 /* It seems like at least one person wants
554 * to use BootX on a machine with an AppleKiwi
555 * controller which happens to pretend to be an
556 * interrupt controller too. */
557 if (of_node_name_eq(np, "AppleKiwi"))
559 /* I think we found one ! */
560 of_irq_dflt_pic = np;
564 #endif /* CONFIG_PPC32 */
566 /* We first try to detect Apple's new Core99 chipset, since mac-io
567 * is quite different on those machines and contains an IBM MPIC2.
569 if (pmac_pic_probe_mpic() == 0)
573 pmac_pic_probe_oldstyle();
577 #if defined(CONFIG_PM) && defined(CONFIG_PPC32)
579 * These procedures are used in implementing sleep on the powerbooks.
580 * sleep_save_intrs() saves the states of all interrupt enables
581 * and disables all interrupts except for the nominated one.
582 * sleep_restore_intrs() restores the states of all interrupt enables.
584 unsigned long sleep_save_mask[2];
586 /* This used to be passed by the PMU driver but that link got
587 * broken with the new driver model. We use this tweak for now...
588 * We really want to do things differently though...
590 static int pmacpic_find_viaint(void)
594 #ifdef CONFIG_ADB_PMU
595 struct device_node *np;
597 if (pmu_get_model() != PMU_OHARE_BASED)
599 np = of_find_node_by_name(NULL, "via-pmu");
602 viaint = irq_of_parse_and_map(np, 0);
606 #endif /* CONFIG_ADB_PMU */
610 static int pmacpic_suspend(void)
612 int viaint = pmacpic_find_viaint();
614 sleep_save_mask[0] = ppc_cached_irq_mask[0];
615 sleep_save_mask[1] = ppc_cached_irq_mask[1];
616 ppc_cached_irq_mask[0] = 0;
617 ppc_cached_irq_mask[1] = 0;
619 set_bit(viaint, ppc_cached_irq_mask);
620 out_le32(&pmac_irq_hw[0]->enable, ppc_cached_irq_mask[0]);
621 if (max_real_irqs > 32)
622 out_le32(&pmac_irq_hw[1]->enable, ppc_cached_irq_mask[1]);
623 (void)in_le32(&pmac_irq_hw[0]->event);
624 /* make sure mask gets to controller before we return to caller */
626 (void)in_le32(&pmac_irq_hw[0]->enable);
631 static void pmacpic_resume(void)
635 out_le32(&pmac_irq_hw[0]->enable, 0);
636 if (max_real_irqs > 32)
637 out_le32(&pmac_irq_hw[1]->enable, 0);
639 for (i = 0; i < max_real_irqs; ++i)
640 if (test_bit(i, sleep_save_mask))
641 pmac_unmask_irq(irq_get_irq_data(i));
644 static struct syscore_ops pmacpic_syscore_ops = {
645 .suspend = pmacpic_suspend,
646 .resume = pmacpic_resume,
649 static int __init init_pmacpic_syscore(void)
652 register_syscore_ops(&pmacpic_syscore_ops);
656 machine_subsys_initcall(powermac, init_pmacpic_syscore);
658 #endif /* CONFIG_PM && CONFIG_PPC32 */