xref: /freebsd/sys/arm/mv/mpic.c (revision cd642c88a1957179fdc6843a6c7bd04ca238d625)
1 /*-
2  * Copyright (c) 2006 Benno Rice.
3  * Copyright (C) 2007-2011 MARVELL INTERNATIONAL LTD.
4  * Copyright (c) 2012 Semihalf.
5  * All rights reserved.
6  *
7  * Developed by Semihalf.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * from: FreeBSD: //depot/projects/arm/src/sys/arm/xscale/pxa2x0/pxa2x0_icu.c, rev 1
30  * from: FreeBSD: src/sys/arm/mv/ic.c,v 1.5 2011/02/08 01:49:30
31  */
32 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35 
36 #include "opt_platform.h"
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/bus.h>
41 #include <sys/kernel.h>
42 #include <sys/cpuset.h>
43 #include <sys/ktr.h>
44 #include <sys/kdb.h>
45 #include <sys/module.h>
46 #include <sys/lock.h>
47 #include <sys/mutex.h>
48 #include <sys/rman.h>
49 #include <sys/proc.h>
50 
51 #include <machine/bus.h>
52 #include <machine/intr.h>
53 #include <machine/cpufunc.h>
54 #include <machine/smp.h>
55 
56 #include <arm/mv/mvvar.h>
57 #include <arm/mv/mvreg.h>
58 
59 #include <dev/ofw/ofw_bus.h>
60 #include <dev/ofw/ofw_bus_subr.h>
61 #include <dev/fdt/fdt_common.h>
62 
63 #ifdef INTRNG
64 #include "pic_if.h"
65 #endif
66 
67 #ifdef DEBUG
68 #define debugf(fmt, args...) do { printf("%s(): ", __func__);	\
69     printf(fmt,##args); } while (0)
70 #else
71 #define debugf(fmt, args...)
72 #endif
73 
74 #define	MPIC_INT_ERR			4
75 #define	MPIC_INT_MSI			96
76 
77 #define	MPIC_IRQ_MASK		0x3ff
78 
79 #define	MPIC_CTRL		0x0
80 #define	MPIC_SOFT_INT		0x4
81 #define	MPIC_SOFT_INT_DRBL1	(1 << 5)
82 #define	MPIC_ERR_CAUSE		0x20
83 #define	MPIC_ISE		0x30
84 #define	MPIC_ICE		0x34
85 #define	MPIC_INT_CTL(irq)	(0x100 + (irq)*4)
86 
87 #define	MPIC_INT_IRQ_FIQ_MASK(cpuid)	(0x101 << (cpuid))
88 #define	MPIC_CTRL_NIRQS(ctrl)	(((ctrl) >> 2) & 0x3ff)
89 
90 #define	MPIC_IN_DRBL		0x08
91 #define	MPIC_IN_DRBL_MASK	0x0c
92 #define	MPIC_PPI_CAUSE		0x10
93 #define	MPIC_CTP		0x40
94 #define	MPIC_IIACK		0x44
95 #define	MPIC_ISM		0x48
96 #define	MPIC_ICM		0x4c
97 #define	MPIC_ERR_MASK		0xe50
98 
99 #define	MPIC_PPI	32
100 
101 #ifdef INTRNG
102 struct mv_mpic_irqsrc {
103 	struct intr_irqsrc	mmi_isrc;
104 	u_int			mmi_irq;
105 };
106 #endif
107 
108 struct mv_mpic_softc {
109 	device_t		sc_dev;
110 	struct resource	*	mpic_res[4];
111 	bus_space_tag_t		mpic_bst;
112 	bus_space_handle_t	mpic_bsh;
113 	bus_space_tag_t		cpu_bst;
114 	bus_space_handle_t	cpu_bsh;
115 	bus_space_tag_t		drbl_bst;
116 	bus_space_handle_t	drbl_bsh;
117 	struct mtx		mtx;
118 #ifdef INTRNG
119 	struct mv_mpic_irqsrc *	mpic_isrcs;
120 #endif
121 	int			nirqs;
122 	void *			intr_hand;
123 };
124 
125 static struct resource_spec mv_mpic_spec[] = {
126 	{ SYS_RES_MEMORY,	0,	RF_ACTIVE },
127 	{ SYS_RES_MEMORY,	1,	RF_ACTIVE },
128 	{ SYS_RES_MEMORY,	2,	RF_ACTIVE | RF_OPTIONAL },
129 	{ SYS_RES_IRQ,		0,	RF_ACTIVE | RF_OPTIONAL },
130 	{ -1, 0 }
131 };
132 
133 static struct ofw_compat_data compat_data[] = {
134 	{"mrvl,mpic",		true},
135 	{"marvell,mpic",	true},
136 	{NULL,			false}
137 };
138 
139 static struct mv_mpic_softc *mv_mpic_sc = NULL;
140 
141 void mpic_send_ipi(int cpus, u_int ipi);
142 
143 static int	mv_mpic_probe(device_t);
144 static int	mv_mpic_attach(device_t);
145 uint32_t	mv_mpic_get_cause(void);
146 uint32_t	mv_mpic_get_cause_err(void);
147 uint32_t	mv_mpic_get_msi(void);
148 static void	mpic_unmask_irq(uintptr_t nb);
149 static void	mpic_mask_irq(uintptr_t nb);
150 static void	mpic_mask_irq_err(uintptr_t nb);
151 static void	mpic_unmask_irq_err(uintptr_t nb);
152 static int	mpic_intr(void *arg);
153 static void	mpic_unmask_msi(void);
154 #ifndef INTRNG
155 static void	arm_mask_irq_err(uintptr_t);
156 static void	arm_unmask_irq_err(uintptr_t);
157 #endif
158 
159 #define	MPIC_WRITE(softc, reg, val) \
160     bus_space_write_4((softc)->mpic_bst, (softc)->mpic_bsh, (reg), (val))
161 #define	MPIC_READ(softc, reg) \
162     bus_space_read_4((softc)->mpic_bst, (softc)->mpic_bsh, (reg))
163 
164 #define MPIC_CPU_WRITE(softc, reg, val) \
165     bus_space_write_4((softc)->cpu_bst, (softc)->cpu_bsh, (reg), (val))
166 #define MPIC_CPU_READ(softc, reg) \
167     bus_space_read_4((softc)->cpu_bst, (softc)->cpu_bsh, (reg))
168 
169 #define MPIC_DRBL_WRITE(softc, reg, val) \
170     bus_space_write_4((softc)->drbl_bst, (softc)->drbl_bsh, (reg), (val))
171 #define MPIC_DRBL_READ(softc, reg) \
172     bus_space_read_4((softc)->drbl_bst, (softc)->drbl_bsh, (reg))
173 
174 static int
175 mv_mpic_probe(device_t dev)
176 {
177 
178 	if (!ofw_bus_status_okay(dev))
179 		return (ENXIO);
180 
181 	if (!ofw_bus_search_compatible(dev, compat_data)->ocd_data)
182 		return (ENXIO);
183 
184 	device_set_desc(dev, "Marvell Integrated Interrupt Controller");
185 	return (0);
186 }
187 
188 #ifdef INTRNG
189 static int
190 mv_mpic_register_isrcs(struct mv_mpic_softc *sc)
191 {
192 	int error;
193 	uint32_t irq;
194 	struct intr_irqsrc *isrc;
195 	const char *name;
196 
197 	sc->mpic_isrcs = malloc(sc->nirqs * sizeof (*sc->mpic_isrcs), M_DEVBUF,
198 	    M_WAITOK | M_ZERO);
199 
200 	name = device_get_nameunit(sc->sc_dev);
201 	for (irq = 0; irq < sc->nirqs; irq++) {
202 		sc->mpic_isrcs[irq].mmi_irq = irq;
203 
204 		isrc = &sc->mpic_isrcs[irq].mmi_isrc;
205 		if (irq < MPIC_PPI) {
206 			error = intr_isrc_register(isrc, sc->sc_dev,
207 			    INTR_ISRCF_PPI, "%s", name);
208 		} else {
209 			error = intr_isrc_register(isrc, sc->sc_dev, 0, "%s",
210 			    name);
211 		}
212 		if (error != 0) {
213 			/* XXX call intr_isrc_deregister() */
214 			device_printf(sc->sc_dev, "%s failed", __func__);
215 			return (error);
216 		}
217 	}
218 	return (0);
219 }
220 #endif
221 
222 static int
223 mv_mpic_attach(device_t dev)
224 {
225 	struct mv_mpic_softc *sc;
226 	int error;
227 	uint32_t val;
228 
229 	sc = (struct mv_mpic_softc *)device_get_softc(dev);
230 
231 	if (mv_mpic_sc != NULL)
232 		return (ENXIO);
233 	mv_mpic_sc = sc;
234 
235 	sc->sc_dev = dev;
236 
237 	mtx_init(&sc->mtx, "MPIC lock", NULL, MTX_SPIN);
238 
239 	error = bus_alloc_resources(dev, mv_mpic_spec, sc->mpic_res);
240 	if (error) {
241 		device_printf(dev, "could not allocate resources\n");
242 		return (ENXIO);
243 	}
244 #ifdef INTRNG
245 	if (sc->mpic_res[3] == NULL)
246 		device_printf(dev, "No interrupt to use.\n");
247 	else
248 		bus_setup_intr(dev, sc->mpic_res[3], INTR_TYPE_CLK,
249 		    mpic_intr, NULL, sc, &sc->intr_hand);
250 #endif
251 
252 	sc->mpic_bst = rman_get_bustag(sc->mpic_res[0]);
253 	sc->mpic_bsh = rman_get_bushandle(sc->mpic_res[0]);
254 
255 	sc->cpu_bst = rman_get_bustag(sc->mpic_res[1]);
256 	sc->cpu_bsh = rman_get_bushandle(sc->mpic_res[1]);
257 
258 	if (sc->mpic_res[2] != NULL) {
259 		/* This is required only if MSIs are used. */
260 		sc->drbl_bst = rman_get_bustag(sc->mpic_res[2]);
261 		sc->drbl_bsh = rman_get_bushandle(sc->mpic_res[2]);
262 	}
263 
264 	bus_space_write_4(mv_mpic_sc->mpic_bst, mv_mpic_sc->mpic_bsh,
265 	    MPIC_CTRL, 1);
266 	MPIC_CPU_WRITE(mv_mpic_sc, MPIC_CTP, 0);
267 
268 	val = MPIC_READ(mv_mpic_sc, MPIC_CTRL);
269 	sc->nirqs = MPIC_CTRL_NIRQS(val);
270 
271 #ifdef INTRNG
272 	if (mv_mpic_register_isrcs(sc) != 0) {
273 		device_printf(dev, "could not register PIC ISRCs\n");
274 		bus_release_resources(dev, mv_mpic_spec, sc->mpic_res);
275 		return (ENXIO);
276 	}
277 	if (intr_pic_register(dev, OF_xref_from_device(dev)) != 0) {
278 		device_printf(dev, "could not register PIC\n");
279 		bus_release_resources(dev, mv_mpic_spec, sc->mpic_res);
280 		return (ENXIO);
281 	}
282 #endif
283 
284 	mpic_unmask_msi();
285 
286 	return (0);
287 }
288 
289 #ifdef INTRNG
290 static int
291 mpic_intr(void *arg)
292 {
293 	struct mv_mpic_softc *sc;
294 	uint32_t cause, irqsrc;
295 	unsigned int irq;
296 	u_int cpuid;
297 
298 	sc = arg;
299 	cpuid = PCPU_GET(cpuid);
300 	irq = 0;
301 
302 	for (cause = MPIC_CPU_READ(sc, MPIC_PPI_CAUSE); cause > 0;
303 	    cause >>= 1, irq++) {
304 		if (cause & 1) {
305 			irqsrc = MPIC_READ(sc, MPIC_INT_CTL(irq));
306 			if ((irqsrc & MPIC_INT_IRQ_FIQ_MASK(cpuid)) == 0)
307 				continue;
308 			if (intr_isrc_dispatch(&sc->mpic_isrcs[irq].mmi_isrc,
309 			    curthread->td_intr_frame) != 0) {
310 				mpic_mask_irq(irq);
311 				device_printf(sc->sc_dev, "Stray irq %u "
312 				    "disabled\n", irq);
313 			}
314 		}
315 	}
316 
317 	return (FILTER_HANDLED);
318 }
319 
320 static void
321 mpic_disable_intr(device_t dev, struct intr_irqsrc *isrc)
322 {
323 	u_int irq;
324 
325 	irq = ((struct mv_mpic_irqsrc *)isrc)->mmi_irq;
326 	mpic_mask_irq(irq);
327 }
328 
329 static void
330 mpic_enable_intr(device_t dev, struct intr_irqsrc *isrc)
331 {
332 	u_int irq;
333 
334 	irq = ((struct mv_mpic_irqsrc *)isrc)->mmi_irq;
335 	mpic_unmask_irq(irq);
336 }
337 
338 static int
339 mpic_map_intr(device_t dev, struct intr_map_data *data,
340     struct intr_irqsrc **isrcp)
341 {
342 	struct intr_map_data_fdt *daf;
343 	struct mv_mpic_softc *sc;
344 
345 	if (data->type != INTR_MAP_DATA_FDT)
346 		return (ENOTSUP);
347 
348 	sc = device_get_softc(dev);
349 	daf = (struct intr_map_data_fdt *)data;
350 
351 	if (daf->ncells !=1 || daf->cells[0] >= sc->nirqs)
352 		return (EINVAL);
353 
354 	*isrcp = &sc->mpic_isrcs[daf->cells[0]].mmi_isrc;
355 	return (0);
356 }
357 
358 static void
359 mpic_pre_ithread(device_t dev, struct intr_irqsrc *isrc)
360 {
361 
362 	mpic_disable_intr(dev, isrc);
363 }
364 
365 static void
366 mpic_post_ithread(device_t dev, struct intr_irqsrc *isrc)
367 {
368 
369 	mpic_enable_intr(dev, isrc);
370 }
371 #endif
372 
373 static device_method_t mv_mpic_methods[] = {
374 	DEVMETHOD(device_probe,		mv_mpic_probe),
375 	DEVMETHOD(device_attach,	mv_mpic_attach),
376 
377 #ifdef INTRNG
378 	DEVMETHOD(pic_disable_intr,	mpic_disable_intr),
379 	DEVMETHOD(pic_enable_intr,	mpic_enable_intr),
380 	DEVMETHOD(pic_map_intr,		mpic_map_intr),
381 	DEVMETHOD(pic_post_ithread,	mpic_post_ithread),
382 	DEVMETHOD(pic_pre_ithread,	mpic_pre_ithread),
383 #endif
384 	{ 0, 0 }
385 };
386 
387 static driver_t mv_mpic_driver = {
388 	"mpic",
389 	mv_mpic_methods,
390 	sizeof(struct mv_mpic_softc),
391 };
392 
393 static devclass_t mv_mpic_devclass;
394 
395 EARLY_DRIVER_MODULE(mpic, simplebus, mv_mpic_driver, mv_mpic_devclass, 0, 0,
396     BUS_PASS_INTERRUPT);
397 
398 #ifndef INTRNG
399 int
400 arm_get_next_irq(int last)
401 {
402 	u_int irq, next = -1;
403 
404 	irq = mv_mpic_get_cause() & MPIC_IRQ_MASK;
405 	CTR2(KTR_INTR, "%s: irq:%#x", __func__, irq);
406 
407 	if (irq != MPIC_IRQ_MASK) {
408 		if (irq == MPIC_INT_ERR)
409 			irq = mv_mpic_get_cause_err();
410 		if (irq == MPIC_INT_MSI)
411 			irq = mv_mpic_get_msi();
412 		next = irq;
413 	}
414 
415 	CTR3(KTR_INTR, "%s: last=%d, next=%d", __func__, last, next);
416 	return (next);
417 }
418 
419 /*
420  * XXX We can make arm_enable_irq to operate on ICE and then mask/unmask only
421  * by ISM/ICM and remove access to ICE in masking operation
422  */
423 void
424 arm_mask_irq(uintptr_t nb)
425 {
426 
427 	mpic_mask_irq(nb);
428 }
429 
430 
431 static void
432 arm_mask_irq_err(uintptr_t nb)
433 {
434 
435 	mpic_mask_irq_err(nb);
436 }
437 
438 void
439 arm_unmask_irq(uintptr_t nb)
440 {
441 
442 	mpic_unmask_irq(nb);
443 }
444 
445 void
446 arm_unmask_irq_err(uintptr_t nb)
447 {
448 
449 	mpic_unmask_irq_err(nb);
450 }
451 #endif
452 
453 static void
454 mpic_unmask_msi(void)
455 {
456 
457 	mpic_unmask_irq(MPIC_INT_MSI);
458 }
459 
460 static void
461 mpic_unmask_irq_err(uintptr_t nb)
462 {
463 	uint32_t mask;
464 	uint8_t bit_off;
465 
466 	bus_space_write_4(mv_mpic_sc->mpic_bst, mv_mpic_sc->mpic_bsh,
467 	    MPIC_ISE, MPIC_INT_ERR);
468 	MPIC_CPU_WRITE(mv_mpic_sc, MPIC_ICM, MPIC_INT_ERR);
469 
470 	bit_off = nb - ERR_IRQ;
471 	mask = MPIC_CPU_READ(mv_mpic_sc, MPIC_ERR_MASK);
472 	mask |= (1 << bit_off);
473 	MPIC_CPU_WRITE(mv_mpic_sc, MPIC_ERR_MASK, mask);
474 }
475 
476 static void
477 mpic_mask_irq_err(uintptr_t nb)
478 {
479 	uint32_t mask;
480 	uint8_t bit_off;
481 
482 	bit_off = nb - ERR_IRQ;
483 	mask = MPIC_CPU_READ(mv_mpic_sc, MPIC_ERR_MASK);
484 	mask &= ~(1 << bit_off);
485 	MPIC_CPU_WRITE(mv_mpic_sc, MPIC_ERR_MASK, mask);
486 }
487 
488 static void
489 mpic_unmask_irq(uintptr_t nb)
490 {
491 
492 	if (nb < ERR_IRQ) {
493 		bus_space_write_4(mv_mpic_sc->mpic_bst, mv_mpic_sc->mpic_bsh,
494 		    MPIC_ISE, nb);
495 		MPIC_CPU_WRITE(mv_mpic_sc, MPIC_ICM, nb);
496 	} else if (nb < MSI_IRQ)
497 		mpic_unmask_irq_err(nb);
498 
499 	if (nb == 0)
500 		MPIC_CPU_WRITE(mv_mpic_sc, MPIC_IN_DRBL_MASK, 0xffffffff);
501 }
502 
503 static void
504 mpic_mask_irq(uintptr_t nb)
505 {
506 
507 	if (nb < ERR_IRQ) {
508 		bus_space_write_4(mv_mpic_sc->mpic_bst, mv_mpic_sc->mpic_bsh,
509 		    MPIC_ICE, nb);
510 		MPIC_CPU_WRITE(mv_mpic_sc, MPIC_ISM, nb);
511 	} else if (nb < MSI_IRQ)
512 		mpic_mask_irq_err(nb);
513 }
514 
515 uint32_t
516 mv_mpic_get_cause(void)
517 {
518 
519 	return (MPIC_CPU_READ(mv_mpic_sc, MPIC_IIACK));
520 }
521 
522 uint32_t
523 mv_mpic_get_cause_err(void)
524 {
525 	uint32_t err_cause;
526 	uint8_t bit_off;
527 
528 	err_cause = bus_space_read_4(mv_mpic_sc->mpic_bst,
529 	    mv_mpic_sc->mpic_bsh, MPIC_ERR_CAUSE);
530 
531 	if (err_cause)
532 		bit_off = ffs(err_cause) - 1;
533 	else
534 		return (-1);
535 
536 	debugf("%s: irq:%x cause:%x\n", __func__, bit_off, err_cause);
537 	return (ERR_IRQ + bit_off);
538 }
539 
540 uint32_t
541 mv_mpic_get_msi(void)
542 {
543 	uint32_t cause;
544 	uint8_t bit_off;
545 
546 	KASSERT(mv_mpic_sc->drbl_bst != NULL, ("No doorbell in mv_mpic_get_msi"));
547 	cause = MPIC_DRBL_READ(mv_mpic_sc, 0);
548 
549 	if (cause)
550 		bit_off = ffs(cause) - 1;
551 	else
552 		return (-1);
553 
554 	debugf("%s: irq:%x cause:%x\n", __func__, bit_off, cause);
555 
556 	cause &= ~(1 << bit_off);
557 	MPIC_DRBL_WRITE(mv_mpic_sc, 0, cause);
558 
559 	return (MSI_IRQ + bit_off);
560 }
561 
562 int
563 mv_msi_data(int irq, uint64_t *addr, uint32_t *data)
564 {
565 	u_long phys, base, size;
566 	phandle_t node;
567 	int error;
568 
569 	node = ofw_bus_get_node(mv_mpic_sc->sc_dev);
570 
571 	/* Get physical address of register space */
572 	error = fdt_get_range(OF_parent(node), 0, &phys, &size);
573 	if (error) {
574 		printf("%s: Cannot get register physical address, err:%d",
575 		    __func__, error);
576 		return (error);
577 	}
578 
579 	/* Get offset of MPIC register space */
580 	error = fdt_regsize(node, &base, &size);
581 	if (error) {
582 		printf("%s: Cannot get MPIC register offset, err:%d",
583 		    __func__, error);
584 		return (error);
585 	}
586 
587 	*addr = phys + base + MPIC_SOFT_INT;
588 	*data = MPIC_SOFT_INT_DRBL1 | irq;
589 
590 	return (0);
591 }
592 
593 
594 #if defined(SMP) && defined(SOC_MV_ARMADAXP)
595 void
596 intr_pic_init_secondary(void)
597 {
598 }
599 
600 void
601 pic_ipi_send(cpuset_t cpus, u_int ipi)
602 {
603 	uint32_t val, i;
604 
605 	val = 0x00000000;
606 	for (i = 0; i < MAXCPU; i++)
607 		if (CPU_ISSET(i, &cpus))
608 			val |= (1 << (8 + i));
609 	val |= ipi;
610 	bus_space_write_4(mv_mpic_sc->mpic_bst, mv_mpic_sc->mpic_bsh,
611 	    MPIC_SOFT_INT, val);
612 }
613 
614 int
615 pic_ipi_read(int i __unused)
616 {
617 	uint32_t val;
618 	int ipi;
619 
620 	val = MPIC_CPU_READ(mv_mpic_sc, MPIC_IN_DRBL);
621 	if (val) {
622 		ipi = ffs(val) - 1;
623 		MPIC_CPU_WRITE(mv_mpic_sc, MPIC_IN_DRBL, ~(1 << ipi));
624 		return (ipi);
625 	}
626 
627 	return (0x3ff);
628 }
629 
630 void
631 pic_ipi_clear(int ipi)
632 {
633 }
634 
635 #endif
636