xref: /freebsd/sys/arm/nvidia/tegra_lic.c (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1 /*-
2  * Copyright (c) 2016 Michal Meloun <mmel@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 /*
31  * Local interrupt controller driver for Tegra SoCs.
32  */
33 #include <sys/param.h>
34 #include <sys/module.h>
35 #include <sys/systm.h>
36 #include <sys/bus.h>
37 #include <sys/conf.h>
38 #include <sys/kernel.h>
39 #include <sys/rman.h>
40 
41 #include <machine/bus.h>
42 #include <machine/intr.h>
43 #include <machine/resource.h>
44 
45 #include <dev/ofw/ofw_bus.h>
46 #include <dev/ofw/ofw_bus_subr.h>
47 
48 #include "pic_if.h"
49 
50 #define	LIC_VIRQ_CPU		0x00
51 #define	LIC_VIRQ_COP		0x04
52 #define	LIC_VFRQ_CPU		0x08
53 #define	LIC_VFRQ_COP		0x0c
54 #define	LIC_ISR			0x10
55 #define	LIC_FIR			0x14
56 #define	LIC_FIR_SET		0x18
57 #define	LIC_FIR_CLR		0x1c
58 #define	LIC_CPU_IER		0x20
59 #define	LIC_CPU_IER_SET		0x24
60 #define	LIC_CPU_IER_CLR		0x28
61 #define	LIC_CPU_IEP_CLASS	0x2C
62 #define	LIC_COP_IER		0x30
63 #define	LIC_COP_IER_SET		0x34
64 #define	LIC_COP_IER_CLR		0x38
65 #define	LIC_COP_IEP_CLASS	0x3c
66 
67 #define	WR4(_sc, _b, _r, _v)	bus_write_4((_sc)->mem_res[_b], (_r), (_v))
68 #define	RD4(_sc, _b, _r)	bus_read_4((_sc)->mem_res[_b], (_r))
69 
70 static struct resource_spec lic_spec[] = {
71 	{ SYS_RES_MEMORY,	0,	RF_ACTIVE },
72 	{ SYS_RES_MEMORY,	1,	RF_ACTIVE },
73 	{ SYS_RES_MEMORY,	2,	RF_ACTIVE },
74 	{ SYS_RES_MEMORY,	3,	RF_ACTIVE },
75 	{ SYS_RES_MEMORY,	4,	RF_ACTIVE },
76 	{ -1, 0 }
77 };
78 
79 static struct ofw_compat_data compat_data[] = {
80 	{"nvidia,tegra124-ictlr", 	1},
81 	{"nvidia,tegra210-ictlr", 	1},
82 	{NULL,				0}
83 };
84 
85 struct tegra_lic_sc {
86 	device_t		dev;
87 	struct resource		*mem_res[nitems(lic_spec)];
88 	device_t		parent;
89 };
90 
91 static int
92 tegra_lic_activate_intr(device_t dev, struct intr_irqsrc *isrc,
93     struct resource *res, struct intr_map_data *data)
94 {
95 	struct tegra_lic_sc *sc = device_get_softc(dev);
96 
97 	return (PIC_ACTIVATE_INTR(sc->parent, isrc, res, data));
98 }
99 
100 static void
101 tegra_lic_disable_intr(device_t dev, struct intr_irqsrc *isrc)
102 {
103 	struct tegra_lic_sc *sc = device_get_softc(dev);
104 
105 	PIC_DISABLE_INTR(sc->parent, isrc);
106 }
107 
108 static void
109 tegra_lic_enable_intr(device_t dev, struct intr_irqsrc *isrc)
110 {
111 	struct tegra_lic_sc *sc = device_get_softc(dev);
112 
113 	PIC_ENABLE_INTR(sc->parent, isrc);
114 }
115 
116 static int
117 tegra_lic_map_intr(device_t dev, struct intr_map_data *data,
118     struct intr_irqsrc **isrcp)
119 {
120 	struct tegra_lic_sc *sc = device_get_softc(dev);
121 
122 	return (PIC_MAP_INTR(sc->parent, data, isrcp));
123 }
124 
125 static int
126 tegra_lic_deactivate_intr(device_t dev, struct intr_irqsrc *isrc,
127     struct resource *res, struct intr_map_data *data)
128 {
129 	struct tegra_lic_sc *sc = device_get_softc(dev);
130 
131 	return (PIC_DEACTIVATE_INTR(sc->parent, isrc, res, data));
132 }
133 
134 static int
135 tegra_lic_setup_intr(device_t dev, struct intr_irqsrc *isrc,
136     struct resource *res, struct intr_map_data *data)
137 {
138 	struct tegra_lic_sc *sc = device_get_softc(dev);
139 
140 	return (PIC_SETUP_INTR(sc->parent, isrc, res, data));
141 }
142 
143 static int
144 tegra_lic_teardown_intr(device_t dev, struct intr_irqsrc *isrc,
145     struct resource *res, struct intr_map_data *data)
146 {
147 	struct tegra_lic_sc *sc = device_get_softc(dev);
148 
149 	return (PIC_TEARDOWN_INTR(sc->parent, isrc, res, data));
150 }
151 
152 static void
153 tegra_lic_pre_ithread(device_t dev, struct intr_irqsrc *isrc)
154 {
155 	struct tegra_lic_sc *sc = device_get_softc(dev);
156 
157 	PIC_PRE_ITHREAD(sc->parent, isrc);
158 }
159 
160 static void
161 tegra_lic_post_ithread(device_t dev, struct intr_irqsrc *isrc)
162 {
163 	struct tegra_lic_sc *sc = device_get_softc(dev);
164 
165 	PIC_POST_ITHREAD(sc->parent, isrc);
166 }
167 
168 static void
169 tegra_lic_post_filter(device_t dev, struct intr_irqsrc *isrc)
170 {
171 	struct tegra_lic_sc *sc = device_get_softc(dev);
172 
173 	PIC_POST_FILTER(sc->parent, isrc);
174 }
175 
176 #ifdef SMP
177 static int
178 tegra_lic_bind_intr(device_t dev, struct intr_irqsrc *isrc)
179 {
180 	struct tegra_lic_sc *sc = device_get_softc(dev);
181 
182 	return (PIC_BIND_INTR(sc->parent, isrc));
183 }
184 #endif
185 
186 static int
187 tegra_lic_probe(device_t dev)
188 {
189 	if (!ofw_bus_status_okay(dev))
190 		return (ENXIO);
191 
192 	if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
193 		return (ENXIO);
194 
195 	return (BUS_PROBE_DEFAULT);
196 }
197 
198 static int
199 tegra_lic_attach(device_t dev)
200 {
201 	struct tegra_lic_sc *sc;
202 	phandle_t node;
203 	phandle_t parent_xref;
204 	int i, rv;
205 
206 	sc = device_get_softc(dev);
207 	sc->dev = dev;
208 	node = ofw_bus_get_node(dev);
209 
210 	rv = OF_getencprop(node, "interrupt-parent", &parent_xref,
211 	    sizeof(parent_xref));
212 	if (rv <= 0) {
213 		device_printf(dev, "Cannot read parent node property\n");
214 		goto fail;
215 	}
216 	sc->parent = OF_device_from_xref(parent_xref);
217 	if (sc->parent == NULL) {
218 		device_printf(dev, "Cannott find parent controller\n");
219 		goto fail;
220 	}
221 
222 	if (bus_alloc_resources(dev, lic_spec, sc->mem_res)) {
223 		device_printf(dev, "Cannott allocate resources\n");
224 		goto fail;
225 	}
226 
227 	/* Disable all interrupts, route all to irq */
228 	for (i = 0; i < nitems(lic_spec); i++) {
229 		if (sc->mem_res[i] == NULL)
230 			continue;
231 		WR4(sc, i, LIC_CPU_IER_CLR, 0xFFFFFFFF);
232 		WR4(sc, i, LIC_CPU_IEP_CLASS, 0);
233 	}
234 
235 	if (intr_pic_register(dev, OF_xref_from_node(node)) == NULL) {
236 		device_printf(dev, "Cannot register PIC\n");
237 		goto fail;
238 	}
239 	return (0);
240 
241 fail:
242 	bus_release_resources(dev, lic_spec, sc->mem_res);
243 	return (ENXIO);
244 }
245 
246 static int
247 tegra_lic_detach(device_t dev)
248 {
249 	struct tegra_lic_sc *sc;
250 	int i;
251 
252 	sc = device_get_softc(dev);
253 	for (i = 0; i < nitems(lic_spec); i++) {
254 		if (sc->mem_res[i] == NULL)
255 			continue;
256 		bus_release_resource(dev, SYS_RES_MEMORY, i,
257 		    sc->mem_res[i]);
258 	}
259 	return (0);
260 }
261 
262 static device_method_t tegra_lic_methods[] = {
263 	DEVMETHOD(device_probe,		tegra_lic_probe),
264 	DEVMETHOD(device_attach,	tegra_lic_attach),
265 	DEVMETHOD(device_detach,	tegra_lic_detach),
266 
267 	/* Interrupt controller interface */
268 	DEVMETHOD(pic_activate_intr,	tegra_lic_activate_intr),
269 	DEVMETHOD(pic_disable_intr,	tegra_lic_disable_intr),
270 	DEVMETHOD(pic_enable_intr,	tegra_lic_enable_intr),
271 	DEVMETHOD(pic_map_intr,		tegra_lic_map_intr),
272 	DEVMETHOD(pic_deactivate_intr,	tegra_lic_deactivate_intr),
273 	DEVMETHOD(pic_setup_intr,	tegra_lic_setup_intr),
274 	DEVMETHOD(pic_teardown_intr,	tegra_lic_teardown_intr),
275 	DEVMETHOD(pic_pre_ithread,	tegra_lic_pre_ithread),
276 	DEVMETHOD(pic_post_ithread,	tegra_lic_post_ithread),
277 	DEVMETHOD(pic_post_filter,	tegra_lic_post_filter),
278 #ifdef SMP
279 	DEVMETHOD(pic_bind_intr,	tegra_lic_bind_intr),
280 #endif
281 	DEVMETHOD_END
282 };
283 
284 devclass_t tegra_lic_devclass;
285 static DEFINE_CLASS_0(lic, tegra_lic_driver, tegra_lic_methods,
286     sizeof(struct tegra_lic_sc));
287 EARLY_DRIVER_MODULE(tegra_lic, simplebus, tegra_lic_driver, tegra_lic_devclass,
288     NULL, NULL, BUS_PASS_INTERRUPT + BUS_PASS_ORDER_MIDDLE + 1);
289