xref: /OK3568_Linux_fs/kernel/arch/powerpc/platforms/embedded6xx/flipper-pic.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * arch/powerpc/platforms/embedded6xx/flipper-pic.c
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Nintendo GameCube/Wii "Flipper" interrupt controller support.
6*4882a593Smuzhiyun  * Copyright (C) 2004-2009 The GameCube Linux Team
7*4882a593Smuzhiyun  * Copyright (C) 2007,2008,2009 Albert Herranz
8*4882a593Smuzhiyun  */
9*4882a593Smuzhiyun #define DRV_MODULE_NAME "flipper-pic"
10*4882a593Smuzhiyun #define pr_fmt(fmt) DRV_MODULE_NAME ": " fmt
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include <linux/kernel.h>
13*4882a593Smuzhiyun #include <linux/init.h>
14*4882a593Smuzhiyun #include <linux/irq.h>
15*4882a593Smuzhiyun #include <linux/of.h>
16*4882a593Smuzhiyun #include <linux/of_address.h>
17*4882a593Smuzhiyun #include <asm/io.h>
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun #include "flipper-pic.h"
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun #define FLIPPER_NR_IRQS		32
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun /*
24*4882a593Smuzhiyun  * Each interrupt has a corresponding bit in both
25*4882a593Smuzhiyun  * the Interrupt Cause (ICR) and Interrupt Mask (IMR) registers.
26*4882a593Smuzhiyun  *
27*4882a593Smuzhiyun  * Enabling/disabling an interrupt line involves setting/clearing
28*4882a593Smuzhiyun  * the corresponding bit in IMR.
29*4882a593Smuzhiyun  * Except for the RSW interrupt, all interrupts get deasserted automatically
30*4882a593Smuzhiyun  * when the source deasserts the interrupt.
31*4882a593Smuzhiyun  */
32*4882a593Smuzhiyun #define FLIPPER_ICR		0x00
33*4882a593Smuzhiyun #define FLIPPER_ICR_RSS		(1<<16) /* reset switch state */
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #define FLIPPER_IMR		0x04
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun #define FLIPPER_RESET		0x24
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun /*
41*4882a593Smuzhiyun  * IRQ chip hooks.
42*4882a593Smuzhiyun  *
43*4882a593Smuzhiyun  */
44*4882a593Smuzhiyun 
flipper_pic_mask_and_ack(struct irq_data * d)45*4882a593Smuzhiyun static void flipper_pic_mask_and_ack(struct irq_data *d)
46*4882a593Smuzhiyun {
47*4882a593Smuzhiyun 	int irq = irqd_to_hwirq(d);
48*4882a593Smuzhiyun 	void __iomem *io_base = irq_data_get_irq_chip_data(d);
49*4882a593Smuzhiyun 	u32 mask = 1 << irq;
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun 	clrbits32(io_base + FLIPPER_IMR, mask);
52*4882a593Smuzhiyun 	/* this is at least needed for RSW */
53*4882a593Smuzhiyun 	out_be32(io_base + FLIPPER_ICR, mask);
54*4882a593Smuzhiyun }
55*4882a593Smuzhiyun 
flipper_pic_ack(struct irq_data * d)56*4882a593Smuzhiyun static void flipper_pic_ack(struct irq_data *d)
57*4882a593Smuzhiyun {
58*4882a593Smuzhiyun 	int irq = irqd_to_hwirq(d);
59*4882a593Smuzhiyun 	void __iomem *io_base = irq_data_get_irq_chip_data(d);
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun 	/* this is at least needed for RSW */
62*4882a593Smuzhiyun 	out_be32(io_base + FLIPPER_ICR, 1 << irq);
63*4882a593Smuzhiyun }
64*4882a593Smuzhiyun 
flipper_pic_mask(struct irq_data * d)65*4882a593Smuzhiyun static void flipper_pic_mask(struct irq_data *d)
66*4882a593Smuzhiyun {
67*4882a593Smuzhiyun 	int irq = irqd_to_hwirq(d);
68*4882a593Smuzhiyun 	void __iomem *io_base = irq_data_get_irq_chip_data(d);
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun 	clrbits32(io_base + FLIPPER_IMR, 1 << irq);
71*4882a593Smuzhiyun }
72*4882a593Smuzhiyun 
flipper_pic_unmask(struct irq_data * d)73*4882a593Smuzhiyun static void flipper_pic_unmask(struct irq_data *d)
74*4882a593Smuzhiyun {
75*4882a593Smuzhiyun 	int irq = irqd_to_hwirq(d);
76*4882a593Smuzhiyun 	void __iomem *io_base = irq_data_get_irq_chip_data(d);
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 	setbits32(io_base + FLIPPER_IMR, 1 << irq);
79*4882a593Smuzhiyun }
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun static struct irq_chip flipper_pic = {
83*4882a593Smuzhiyun 	.name		= "flipper-pic",
84*4882a593Smuzhiyun 	.irq_ack	= flipper_pic_ack,
85*4882a593Smuzhiyun 	.irq_mask_ack	= flipper_pic_mask_and_ack,
86*4882a593Smuzhiyun 	.irq_mask	= flipper_pic_mask,
87*4882a593Smuzhiyun 	.irq_unmask	= flipper_pic_unmask,
88*4882a593Smuzhiyun };
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun /*
91*4882a593Smuzhiyun  * IRQ host hooks.
92*4882a593Smuzhiyun  *
93*4882a593Smuzhiyun  */
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun static struct irq_domain *flipper_irq_host;
96*4882a593Smuzhiyun 
flipper_pic_map(struct irq_domain * h,unsigned int virq,irq_hw_number_t hwirq)97*4882a593Smuzhiyun static int flipper_pic_map(struct irq_domain *h, unsigned int virq,
98*4882a593Smuzhiyun 			   irq_hw_number_t hwirq)
99*4882a593Smuzhiyun {
100*4882a593Smuzhiyun 	irq_set_chip_data(virq, h->host_data);
101*4882a593Smuzhiyun 	irq_set_status_flags(virq, IRQ_LEVEL);
102*4882a593Smuzhiyun 	irq_set_chip_and_handler(virq, &flipper_pic, handle_level_irq);
103*4882a593Smuzhiyun 	return 0;
104*4882a593Smuzhiyun }
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun static const struct irq_domain_ops flipper_irq_domain_ops = {
107*4882a593Smuzhiyun 	.map = flipper_pic_map,
108*4882a593Smuzhiyun };
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun /*
111*4882a593Smuzhiyun  * Platform hooks.
112*4882a593Smuzhiyun  *
113*4882a593Smuzhiyun  */
114*4882a593Smuzhiyun 
__flipper_quiesce(void __iomem * io_base)115*4882a593Smuzhiyun static void __flipper_quiesce(void __iomem *io_base)
116*4882a593Smuzhiyun {
117*4882a593Smuzhiyun 	/* mask and ack all IRQs */
118*4882a593Smuzhiyun 	out_be32(io_base + FLIPPER_IMR, 0x00000000);
119*4882a593Smuzhiyun 	out_be32(io_base + FLIPPER_ICR, 0xffffffff);
120*4882a593Smuzhiyun }
121*4882a593Smuzhiyun 
flipper_pic_init(struct device_node * np)122*4882a593Smuzhiyun static struct irq_domain * __init flipper_pic_init(struct device_node *np)
123*4882a593Smuzhiyun {
124*4882a593Smuzhiyun 	struct device_node *pi;
125*4882a593Smuzhiyun 	struct irq_domain *irq_domain = NULL;
126*4882a593Smuzhiyun 	struct resource res;
127*4882a593Smuzhiyun 	void __iomem *io_base;
128*4882a593Smuzhiyun 	int retval;
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 	pi = of_get_parent(np);
131*4882a593Smuzhiyun 	if (!pi) {
132*4882a593Smuzhiyun 		pr_err("no parent found\n");
133*4882a593Smuzhiyun 		goto out;
134*4882a593Smuzhiyun 	}
135*4882a593Smuzhiyun 	if (!of_device_is_compatible(pi, "nintendo,flipper-pi")) {
136*4882a593Smuzhiyun 		pr_err("unexpected parent compatible\n");
137*4882a593Smuzhiyun 		goto out;
138*4882a593Smuzhiyun 	}
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 	retval = of_address_to_resource(pi, 0, &res);
141*4882a593Smuzhiyun 	if (retval) {
142*4882a593Smuzhiyun 		pr_err("no io memory range found\n");
143*4882a593Smuzhiyun 		goto out;
144*4882a593Smuzhiyun 	}
145*4882a593Smuzhiyun 	io_base = ioremap(res.start, resource_size(&res));
146*4882a593Smuzhiyun 
147*4882a593Smuzhiyun 	pr_info("controller at 0x%08x mapped to 0x%p\n", res.start, io_base);
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun 	__flipper_quiesce(io_base);
150*4882a593Smuzhiyun 
151*4882a593Smuzhiyun 	irq_domain = irq_domain_add_linear(np, FLIPPER_NR_IRQS,
152*4882a593Smuzhiyun 				  &flipper_irq_domain_ops, io_base);
153*4882a593Smuzhiyun 	if (!irq_domain) {
154*4882a593Smuzhiyun 		pr_err("failed to allocate irq_domain\n");
155*4882a593Smuzhiyun 		return NULL;
156*4882a593Smuzhiyun 	}
157*4882a593Smuzhiyun 
158*4882a593Smuzhiyun out:
159*4882a593Smuzhiyun 	return irq_domain;
160*4882a593Smuzhiyun }
161*4882a593Smuzhiyun 
flipper_pic_get_irq(void)162*4882a593Smuzhiyun unsigned int flipper_pic_get_irq(void)
163*4882a593Smuzhiyun {
164*4882a593Smuzhiyun 	void __iomem *io_base = flipper_irq_host->host_data;
165*4882a593Smuzhiyun 	int irq;
166*4882a593Smuzhiyun 	u32 irq_status;
167*4882a593Smuzhiyun 
168*4882a593Smuzhiyun 	irq_status = in_be32(io_base + FLIPPER_ICR) &
169*4882a593Smuzhiyun 		     in_be32(io_base + FLIPPER_IMR);
170*4882a593Smuzhiyun 	if (irq_status == 0)
171*4882a593Smuzhiyun 		return 0;	/* no more IRQs pending */
172*4882a593Smuzhiyun 
173*4882a593Smuzhiyun 	irq = __ffs(irq_status);
174*4882a593Smuzhiyun 	return irq_linear_revmap(flipper_irq_host, irq);
175*4882a593Smuzhiyun }
176*4882a593Smuzhiyun 
177*4882a593Smuzhiyun /*
178*4882a593Smuzhiyun  * Probe function.
179*4882a593Smuzhiyun  *
180*4882a593Smuzhiyun  */
181*4882a593Smuzhiyun 
flipper_pic_probe(void)182*4882a593Smuzhiyun void __init flipper_pic_probe(void)
183*4882a593Smuzhiyun {
184*4882a593Smuzhiyun 	struct device_node *np;
185*4882a593Smuzhiyun 
186*4882a593Smuzhiyun 	np = of_find_compatible_node(NULL, NULL, "nintendo,flipper-pic");
187*4882a593Smuzhiyun 	BUG_ON(!np);
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun 	flipper_irq_host = flipper_pic_init(np);
190*4882a593Smuzhiyun 	BUG_ON(!flipper_irq_host);
191*4882a593Smuzhiyun 
192*4882a593Smuzhiyun 	irq_set_default_host(flipper_irq_host);
193*4882a593Smuzhiyun 
194*4882a593Smuzhiyun 	of_node_put(np);
195*4882a593Smuzhiyun }
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun /*
198*4882a593Smuzhiyun  * Misc functions related to the flipper chipset.
199*4882a593Smuzhiyun  *
200*4882a593Smuzhiyun  */
201*4882a593Smuzhiyun 
202*4882a593Smuzhiyun /**
203*4882a593Smuzhiyun  * flipper_quiesce() - quiesce flipper irq controller
204*4882a593Smuzhiyun  *
205*4882a593Smuzhiyun  * Mask and ack all interrupt sources.
206*4882a593Smuzhiyun  *
207*4882a593Smuzhiyun  */
flipper_quiesce(void)208*4882a593Smuzhiyun void flipper_quiesce(void)
209*4882a593Smuzhiyun {
210*4882a593Smuzhiyun 	void __iomem *io_base = flipper_irq_host->host_data;
211*4882a593Smuzhiyun 
212*4882a593Smuzhiyun 	__flipper_quiesce(io_base);
213*4882a593Smuzhiyun }
214*4882a593Smuzhiyun 
215*4882a593Smuzhiyun /*
216*4882a593Smuzhiyun  * Resets the platform.
217*4882a593Smuzhiyun  */
flipper_platform_reset(void)218*4882a593Smuzhiyun void flipper_platform_reset(void)
219*4882a593Smuzhiyun {
220*4882a593Smuzhiyun 	void __iomem *io_base;
221*4882a593Smuzhiyun 
222*4882a593Smuzhiyun 	if (flipper_irq_host && flipper_irq_host->host_data) {
223*4882a593Smuzhiyun 		io_base = flipper_irq_host->host_data;
224*4882a593Smuzhiyun 		out_8(io_base + FLIPPER_RESET, 0x00);
225*4882a593Smuzhiyun 	}
226*4882a593Smuzhiyun }
227*4882a593Smuzhiyun 
228*4882a593Smuzhiyun /*
229*4882a593Smuzhiyun  * Returns non-zero if the reset button is pressed.
230*4882a593Smuzhiyun  */
flipper_is_reset_button_pressed(void)231*4882a593Smuzhiyun int flipper_is_reset_button_pressed(void)
232*4882a593Smuzhiyun {
233*4882a593Smuzhiyun 	void __iomem *io_base;
234*4882a593Smuzhiyun 	u32 icr;
235*4882a593Smuzhiyun 
236*4882a593Smuzhiyun 	if (flipper_irq_host && flipper_irq_host->host_data) {
237*4882a593Smuzhiyun 		io_base = flipper_irq_host->host_data;
238*4882a593Smuzhiyun 		icr = in_be32(io_base + FLIPPER_ICR);
239*4882a593Smuzhiyun 		return !(icr & FLIPPER_ICR_RSS);
240*4882a593Smuzhiyun 	}
241*4882a593Smuzhiyun 	return 0;
242*4882a593Smuzhiyun }
243*4882a593Smuzhiyun 
244