bcm2835_intr.c revision 297580
1/*-
2 * Copyright (c) 2012 Damjan Marion <dmarion@Freebsd.org>
3 * All rights reserved.
4 *
5 * Based on OMAP3 INTC code by Ben Gray
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD: head/sys/arm/broadcom/bcm2835/bcm2835_intr.c 297580 2016-04-05 13:37:03Z skra $");
32
33#include "opt_platform.h"
34
35#include <sys/param.h>
36#include <sys/systm.h>
37#include <sys/bus.h>
38#include <sys/kernel.h>
39#include <sys/ktr.h>
40#include <sys/module.h>
41#include <sys/proc.h>
42#include <sys/rman.h>
43#include <machine/bus.h>
44#include <machine/intr.h>
45
46#include <dev/fdt/fdt_common.h>
47#include <dev/ofw/openfirm.h>
48#include <dev/ofw/ofw_bus.h>
49#include <dev/ofw/ofw_bus_subr.h>
50
51#ifdef SOC_BCM2836
52#include <arm/broadcom/bcm2835/bcm2836.h>
53#endif
54
55#ifdef ARM_INTRNG
56#include "pic_if.h"
57#endif
58
59#define	INTC_PENDING_BASIC	0x00
60#define	INTC_PENDING_BANK1	0x04
61#define	INTC_PENDING_BANK2	0x08
62#define	INTC_FIQ_CONTROL	0x0C
63#define	INTC_ENABLE_BANK1	0x10
64#define	INTC_ENABLE_BANK2	0x14
65#define	INTC_ENABLE_BASIC	0x18
66#define	INTC_DISABLE_BANK1	0x1C
67#define	INTC_DISABLE_BANK2	0x20
68#define	INTC_DISABLE_BASIC	0x24
69
70#define INTC_PENDING_BASIC_ARM		0x0000FF
71#define INTC_PENDING_BASIC_GPU1_PEND	0x000100
72#define INTC_PENDING_BASIC_GPU2_PEND	0x000200
73#define INTC_PENDING_BASIC_GPU1_7	0x000400
74#define INTC_PENDING_BASIC_GPU1_9	0x000800
75#define INTC_PENDING_BASIC_GPU1_10	0x001000
76#define INTC_PENDING_BASIC_GPU1_18	0x002000
77#define INTC_PENDING_BASIC_GPU1_19	0x004000
78#define INTC_PENDING_BASIC_GPU2_21	0x008000
79#define INTC_PENDING_BASIC_GPU2_22	0x010000
80#define INTC_PENDING_BASIC_GPU2_23	0x020000
81#define INTC_PENDING_BASIC_GPU2_24	0x040000
82#define INTC_PENDING_BASIC_GPU2_25	0x080000
83#define INTC_PENDING_BASIC_GPU2_30	0x100000
84#define INTC_PENDING_BASIC_MASK		0x1FFFFF
85
86#define INTC_PENDING_BASIC_GPU1_MASK	(INTC_PENDING_BASIC_GPU1_7 |	\
87					 INTC_PENDING_BASIC_GPU1_9 |	\
88					 INTC_PENDING_BASIC_GPU1_10 |	\
89					 INTC_PENDING_BASIC_GPU1_18 |	\
90					 INTC_PENDING_BASIC_GPU1_19)
91
92#define INTC_PENDING_BASIC_GPU2_MASK	(INTC_PENDING_BASIC_GPU2_21 |	\
93					 INTC_PENDING_BASIC_GPU2_22 |	\
94					 INTC_PENDING_BASIC_GPU2_23 |	\
95					 INTC_PENDING_BASIC_GPU2_24 |	\
96					 INTC_PENDING_BASIC_GPU2_25 |	\
97					 INTC_PENDING_BASIC_GPU2_30)
98
99#define INTC_PENDING_BANK1_MASK (~((1 << 7) | (1 << 9) | (1 << 10) | \
100    (1 << 18) | (1 << 19)))
101#define INTC_PENDING_BANK2_MASK (~((1 << 21) | (1 << 22) | (1 << 23) | \
102    (1 << 24) | (1 << 25) | (1 << 30)))
103
104#define	BANK1_START	8
105#define	BANK1_END	(BANK1_START + 32 - 1)
106#define	BANK2_START	(BANK1_START + 32)
107#define	BANK2_END	(BANK2_START + 32 - 1)
108#ifndef ARM_INTRNG
109#define	BANK3_START	(BANK2_START + 32)
110#define	BANK3_END	(BANK3_START + 32 - 1)
111#endif
112
113#define	IS_IRQ_BASIC(n)	(((n) >= 0) && ((n) < BANK1_START))
114#define	IS_IRQ_BANK1(n)	(((n) >= BANK1_START) && ((n) <= BANK1_END))
115#define	IS_IRQ_BANK2(n)	(((n) >= BANK2_START) && ((n) <= BANK2_END))
116#ifndef ARM_INTRNG
117#define	ID_IRQ_BCM2836(n) (((n) >= BANK3_START) && ((n) <= BANK3_END))
118#endif
119#define	IRQ_BANK1(n)	((n) - BANK1_START)
120#define	IRQ_BANK2(n)	((n) - BANK2_START)
121
122#ifdef  DEBUG
123#define dprintf(fmt, args...) printf(fmt, ##args)
124#else
125#define dprintf(fmt, args...)
126#endif
127
128#ifdef ARM_INTRNG
129#define BCM_INTC_NIRQS		72	/* 8 + 32 + 32 */
130
131struct bcm_intc_irqsrc {
132	struct intr_irqsrc	bii_isrc;
133	u_int			bii_irq;
134	uint16_t		bii_disable_reg;
135	uint16_t		bii_enable_reg;
136	uint32_t		bii_mask;
137};
138#endif
139
140struct bcm_intc_softc {
141	device_t		sc_dev;
142	struct resource *	intc_res;
143	bus_space_tag_t		intc_bst;
144	bus_space_handle_t	intc_bsh;
145#ifdef ARM_INTRNG
146	struct resource *	intc_irq_res;
147	void *			intc_irq_hdl;
148	struct bcm_intc_irqsrc	intc_isrcs[BCM_INTC_NIRQS];
149#endif
150};
151
152static struct bcm_intc_softc *bcm_intc_sc = NULL;
153
154#define	intc_read_4(_sc, reg)		\
155    bus_space_read_4((_sc)->intc_bst, (_sc)->intc_bsh, (reg))
156#define	intc_write_4(_sc, reg, val)		\
157    bus_space_write_4((_sc)->intc_bst, (_sc)->intc_bsh, (reg), (val))
158
159#ifdef ARM_INTRNG
160static inline void
161bcm_intc_isrc_mask(struct bcm_intc_softc *sc, struct bcm_intc_irqsrc *bii)
162{
163
164	intc_write_4(sc, bii->bii_disable_reg,  bii->bii_mask);
165}
166
167static inline void
168bcm_intc_isrc_unmask(struct bcm_intc_softc *sc, struct bcm_intc_irqsrc *bii)
169{
170
171	intc_write_4(sc, bii->bii_enable_reg,  bii->bii_mask);
172}
173
174static inline int
175bcm2835_intc_active_intr(struct bcm_intc_softc *sc)
176{
177	uint32_t pending, pending_gpu;
178
179	pending = intc_read_4(sc, INTC_PENDING_BASIC) & INTC_PENDING_BASIC_MASK;
180	if (pending == 0)
181		return (-1);
182	if (pending & INTC_PENDING_BASIC_ARM)
183		return (ffs(pending) - 1);
184	if (pending & INTC_PENDING_BASIC_GPU1_MASK) {
185		if (pending & INTC_PENDING_BASIC_GPU1_7)
186			return (BANK1_START + 7);
187		if (pending & INTC_PENDING_BASIC_GPU1_9)
188			return (BANK1_START + 9);
189		if (pending & INTC_PENDING_BASIC_GPU1_10)
190			return (BANK1_START + 10);
191		if (pending & INTC_PENDING_BASIC_GPU1_18)
192			return (BANK1_START + 18);
193		if (pending & INTC_PENDING_BASIC_GPU1_19)
194			return (BANK1_START + 19);
195	}
196	if (pending & INTC_PENDING_BASIC_GPU2_MASK) {
197		if (pending & INTC_PENDING_BASIC_GPU2_21)
198			return (BANK2_START + 21);
199		if (pending & INTC_PENDING_BASIC_GPU2_22)
200			return (BANK2_START + 22);
201		if (pending & INTC_PENDING_BASIC_GPU2_23)
202			return (BANK2_START + 23);
203		if (pending & INTC_PENDING_BASIC_GPU2_24)
204			return (BANK2_START + 24);
205		if (pending & INTC_PENDING_BASIC_GPU2_25)
206			return (BANK2_START + 25);
207		if (pending & INTC_PENDING_BASIC_GPU2_30)
208			return (BANK2_START + 30);
209	}
210	if (pending & INTC_PENDING_BASIC_GPU1_PEND) {
211		pending_gpu = intc_read_4(sc, INTC_PENDING_BANK1);
212		pending_gpu &= INTC_PENDING_BANK1_MASK;
213		if (pending_gpu != 0)
214			return (BANK1_START + ffs(pending_gpu) - 1);
215	}
216	if (pending & INTC_PENDING_BASIC_GPU2_PEND) {
217		pending_gpu = intc_read_4(sc, INTC_PENDING_BANK2);
218		pending_gpu &= INTC_PENDING_BANK2_MASK;
219		if (pending_gpu != 0)
220			return (BANK2_START + ffs(pending_gpu) - 1);
221	}
222	return (-1);	/* It shouldn't end here, but it's hardware. */
223}
224
225static int
226bcm2835_intc_intr(void *arg)
227{
228	int irq, num;
229	struct bcm_intc_softc *sc = arg;
230
231	for (num = 0; ; num++) {
232		irq = bcm2835_intc_active_intr(sc);
233		if (irq == -1)
234			break;
235		if (intr_isrc_dispatch(&sc->intc_isrcs[irq].bii_isrc,
236		    curthread->td_intr_frame) != 0) {
237			bcm_intc_isrc_mask(sc, &sc->intc_isrcs[irq]);
238			device_printf(sc->sc_dev, "Stray irq %u disabled\n",
239			    irq);
240		}
241		arm_irq_memory_barrier(0); /* XXX */
242	}
243	if (num == 0)
244		device_printf(sc->sc_dev, "Spurious interrupt detected\n");
245
246	return (FILTER_HANDLED);
247}
248
249static void
250bcm_intc_enable_intr(device_t dev, struct intr_irqsrc *isrc)
251{
252	struct bcm_intc_irqsrc *bii = (struct bcm_intc_irqsrc *)isrc;
253
254	arm_irq_memory_barrier(bii->bii_irq);
255	bcm_intc_isrc_unmask(device_get_softc(dev), bii);
256}
257
258static void
259bcm_intc_disable_intr(device_t dev, struct intr_irqsrc *isrc)
260{
261
262	bcm_intc_isrc_mask(device_get_softc(dev),
263	    (struct bcm_intc_irqsrc *)isrc);
264}
265
266static int
267bcm_intc_map_intr(device_t dev, struct intr_map_data *data,
268    struct intr_irqsrc **isrcp)
269{
270	u_int irq;
271	struct bcm_intc_softc *sc;
272
273	if (data->type != INTR_MAP_DATA_FDT)
274		return (ENOTSUP);
275	if (data->fdt.ncells == 1)
276		irq = data->fdt.cells[0];
277	else if (data->fdt.ncells == 2)
278		irq = data->fdt.cells[0] * 32 + data->fdt.cells[1];
279	else
280		return (EINVAL);
281
282	if (irq >= BCM_INTC_NIRQS)
283		return (EINVAL);
284
285	sc = device_get_softc(dev);
286	*isrcp = &sc->intc_isrcs[irq].bii_isrc;
287	return (0);
288}
289
290static void
291bcm_intc_pre_ithread(device_t dev, struct intr_irqsrc *isrc)
292{
293
294	bcm_intc_disable_intr(dev, isrc);
295}
296
297static void
298bcm_intc_post_ithread(device_t dev, struct intr_irqsrc *isrc)
299{
300
301	bcm_intc_enable_intr(dev, isrc);
302}
303
304static void
305bcm_intc_post_filter(device_t dev, struct intr_irqsrc *isrc)
306{
307}
308
309static int
310bcm_intc_pic_register(struct bcm_intc_softc *sc, intptr_t xref)
311{
312	struct bcm_intc_irqsrc *bii;
313	int error;
314	uint32_t irq;
315	const char *name;
316
317	name = device_get_nameunit(sc->sc_dev);
318	for (irq = 0; irq < BCM_INTC_NIRQS; irq++) {
319		bii = &sc->intc_isrcs[irq];
320		bii->bii_irq = irq;
321		if (IS_IRQ_BASIC(irq)) {
322			bii->bii_disable_reg = INTC_DISABLE_BASIC;
323			bii->bii_enable_reg = INTC_ENABLE_BASIC;
324			bii->bii_mask = 1 << irq;
325		} else if (IS_IRQ_BANK1(irq)) {
326			bii->bii_disable_reg = INTC_DISABLE_BANK1;
327			bii->bii_enable_reg = INTC_ENABLE_BANK1;
328			bii->bii_mask = 1 << IRQ_BANK1(irq);
329		} else if (IS_IRQ_BANK2(irq)) {
330			bii->bii_disable_reg = INTC_DISABLE_BANK2;
331			bii->bii_enable_reg = INTC_ENABLE_BANK2;
332			bii->bii_mask = 1 << IRQ_BANK2(irq);
333		} else
334			return (ENXIO);
335
336		error = intr_isrc_register(&bii->bii_isrc, sc->sc_dev, 0,
337		    "%s,%u", name, irq);
338		if (error != 0)
339			return (error);
340	}
341	return (intr_pic_register(sc->sc_dev, xref));
342}
343#endif
344
345static int
346bcm_intc_probe(device_t dev)
347{
348
349	if (!ofw_bus_status_okay(dev))
350		return (ENXIO);
351
352	if (!ofw_bus_is_compatible(dev, "broadcom,bcm2835-armctrl-ic"))
353		return (ENXIO);
354	device_set_desc(dev, "BCM2835 Interrupt Controller");
355	return (BUS_PROBE_DEFAULT);
356}
357
358static int
359bcm_intc_attach(device_t dev)
360{
361	struct		bcm_intc_softc *sc = device_get_softc(dev);
362	int		rid = 0;
363#ifdef ARM_INTRNG
364	intptr_t	xref;
365#endif
366	sc->sc_dev = dev;
367
368	if (bcm_intc_sc)
369		return (ENXIO);
370
371	sc->intc_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
372	if (sc->intc_res == NULL) {
373		device_printf(dev, "could not allocate memory resource\n");
374		return (ENXIO);
375	}
376
377#ifdef ARM_INTRNG
378	xref = OF_xref_from_node(ofw_bus_get_node(dev));
379	if (bcm_intc_pic_register(sc, xref) != 0) {
380		bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->intc_res);
381		device_printf(dev, "could not register PIC\n");
382		return (ENXIO);
383	}
384
385	rid = 0;
386	sc->intc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
387	    RF_ACTIVE);
388	if (sc->intc_irq_res == NULL) {
389		if (intr_pic_claim_root(dev, xref, bcm2835_intc_intr, sc, 0) != 0) {
390			/* XXX clean up */
391			device_printf(dev, "could not set PIC as a root\n");
392			return (ENXIO);
393		}
394	} else {
395		if (bus_setup_intr(dev, sc->intc_irq_res, INTR_TYPE_CLK,
396		    bcm2835_intc_intr, NULL, sc, &sc->intc_irq_hdl)) {
397			/* XXX clean up */
398			device_printf(dev, "could not setup irq handler\n");
399			return (ENXIO);
400		}
401	}
402#endif
403	sc->intc_bst = rman_get_bustag(sc->intc_res);
404	sc->intc_bsh = rman_get_bushandle(sc->intc_res);
405
406	bcm_intc_sc = sc;
407
408	return (0);
409}
410
411static device_method_t bcm_intc_methods[] = {
412	DEVMETHOD(device_probe,		bcm_intc_probe),
413	DEVMETHOD(device_attach,	bcm_intc_attach),
414
415#ifdef ARM_INTRNG
416	DEVMETHOD(pic_disable_intr,	bcm_intc_disable_intr),
417	DEVMETHOD(pic_enable_intr,	bcm_intc_enable_intr),
418	DEVMETHOD(pic_map_intr,		bcm_intc_map_intr),
419	DEVMETHOD(pic_post_filter,	bcm_intc_post_filter),
420	DEVMETHOD(pic_post_ithread,	bcm_intc_post_ithread),
421	DEVMETHOD(pic_pre_ithread,	bcm_intc_pre_ithread),
422#endif
423
424	{ 0, 0 }
425};
426
427static driver_t bcm_intc_driver = {
428	"intc",
429	bcm_intc_methods,
430	sizeof(struct bcm_intc_softc),
431};
432
433static devclass_t bcm_intc_devclass;
434
435DRIVER_MODULE(intc, simplebus, bcm_intc_driver, bcm_intc_devclass, 0, 0);
436
437#ifndef ARM_INTRNG
438int
439arm_get_next_irq(int last_irq)
440{
441	struct bcm_intc_softc *sc = bcm_intc_sc;
442	uint32_t pending;
443	int32_t irq = last_irq + 1;
444#ifdef SOC_BCM2836
445	int ret;
446#endif
447
448	/* Sanity check */
449	if (irq < 0)
450		irq = 0;
451
452#ifdef SOC_BCM2836
453	if ((ret = bcm2836_get_next_irq(irq)) < 0)
454		return (-1);
455	if (ret != BCM2836_GPU_IRQ)
456		return (ret + BANK3_START);
457#endif
458
459	/* TODO: should we mask last_irq? */
460	if (irq < BANK1_START) {
461		pending = intc_read_4(sc, INTC_PENDING_BASIC);
462		if ((pending & 0xFF) == 0) {
463			irq  = BANK1_START;	/* skip to next bank */
464		} else do {
465			if (pending & (1 << irq))
466				return irq;
467			irq++;
468		} while (irq < BANK1_START);
469	}
470	if (irq < BANK2_START) {
471		pending = intc_read_4(sc, INTC_PENDING_BANK1);
472		if (pending == 0) {
473			irq  = BANK2_START;	/* skip to next bank */
474		} else do {
475			if (pending & (1 << IRQ_BANK1(irq)))
476				return irq;
477			irq++;
478		} while (irq < BANK2_START);
479	}
480	if (irq < BANK3_START) {
481		pending = intc_read_4(sc, INTC_PENDING_BANK2);
482		if (pending != 0) do {
483			if (pending & (1 << IRQ_BANK2(irq)))
484				return irq;
485			irq++;
486		} while (irq < BANK3_START);
487	}
488	return (-1);
489}
490
491void
492arm_mask_irq(uintptr_t nb)
493{
494	struct bcm_intc_softc *sc = bcm_intc_sc;
495	dprintf("%s: %d\n", __func__, nb);
496
497	if (IS_IRQ_BASIC(nb))
498		intc_write_4(sc, INTC_DISABLE_BASIC, (1 << nb));
499	else if (IS_IRQ_BANK1(nb))
500		intc_write_4(sc, INTC_DISABLE_BANK1, (1 << IRQ_BANK1(nb)));
501	else if (IS_IRQ_BANK2(nb))
502		intc_write_4(sc, INTC_DISABLE_BANK2, (1 << IRQ_BANK2(nb)));
503#ifdef SOC_BCM2836
504	else if (ID_IRQ_BCM2836(nb))
505		bcm2836_mask_irq(nb - BANK3_START);
506#endif
507	else
508		printf("arm_mask_irq: Invalid IRQ number: %d\n", nb);
509}
510
511void
512arm_unmask_irq(uintptr_t nb)
513{
514	struct bcm_intc_softc *sc = bcm_intc_sc;
515	dprintf("%s: %d\n", __func__, nb);
516
517	if (IS_IRQ_BASIC(nb))
518		intc_write_4(sc, INTC_ENABLE_BASIC, (1 << nb));
519	else if (IS_IRQ_BANK1(nb))
520		intc_write_4(sc, INTC_ENABLE_BANK1, (1 << IRQ_BANK1(nb)));
521	else if (IS_IRQ_BANK2(nb))
522		intc_write_4(sc, INTC_ENABLE_BANK2, (1 << IRQ_BANK2(nb)));
523#ifdef SOC_BCM2836
524	else if (ID_IRQ_BCM2836(nb))
525		bcm2836_unmask_irq(nb - BANK3_START);
526#endif
527	else
528		printf("arm_mask_irq: Invalid IRQ number: %d\n", nb);
529}
530
531#ifdef SMP
532void
533intr_pic_init_secondary(void)
534{
535}
536#endif
537#endif
538