xref: /freebsd/sys/arm/arm/nexus.c (revision acc1a9ef)
1 /*-
2  * Copyright 1998 Massachusetts Institute of Technology
3  *
4  * Permission to use, copy, modify, and distribute this software and
5  * its documentation for any purpose and without fee is hereby
6  * granted, provided that both the above copyright notice and this
7  * permission notice appear in all copies, that both the above
8  * copyright notice and this permission notice appear in all
9  * supporting documentation, and that the name of M.I.T. not be used
10  * in advertising or publicity pertaining to distribution of the
11  * software without specific, written prior permission.  M.I.T. makes
12  * no representations about the suitability of this software for any
13  * purpose.  It is provided "as is" without express or implied
14  * warranty.
15  *
16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  */
30 
31 /*
32  * This code implements a `root nexus' for Arm Architecture
33  * machines.  The function of the root nexus is to serve as an
34  * attachment point for both processors and buses, and to manage
35  * resources which are common to all of them.  In particular,
36  * this code implements the core resource managers for interrupt
37  * requests, DMA requests (which rightfully should be a part of the
38  * ISA code but it's easier to do it here for now), I/O port addresses,
39  * and I/O memory address space.
40  */
41 
42 #include "opt_platform.h"
43 
44 #include <sys/cdefs.h>
45 __FBSDID("$FreeBSD$");
46 
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/bus.h>
50 #include <sys/kernel.h>
51 #include <sys/malloc.h>
52 #include <sys/module.h>
53 #include <machine/bus.h>
54 #include <sys/rman.h>
55 #include <sys/interrupt.h>
56 
57 #include <machine/vmparam.h>
58 #include <machine/pcb.h>
59 #include <vm/vm.h>
60 #include <vm/pmap.h>
61 
62 #include <machine/resource.h>
63 #include <machine/intr.h>
64 
65 #ifdef FDT
66 #include <machine/fdt.h>
67 #include "ofw_bus_if.h"
68 #endif
69 
70 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
71 
72 struct nexus_device {
73 	struct resource_list	nx_resources;
74 };
75 
76 #define DEVTONX(dev)	((struct nexus_device *)device_get_ivars(dev))
77 
78 static struct rman mem_rman;
79 
80 static	int nexus_probe(device_t);
81 static	int nexus_attach(device_t);
82 static	int nexus_print_child(device_t, device_t);
83 static	device_t nexus_add_child(device_t, u_int, const char *, int);
84 static	struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
85     rman_res_t, rman_res_t, rman_res_t, u_int);
86 static	int nexus_activate_resource(device_t, device_t, int, int,
87     struct resource *);
88 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t);
89 #ifdef ARM_INTRNG
90 #ifdef SMP
91 static	int nexus_bind_intr(device_t, device_t, struct resource *, int);
92 #endif
93 #endif
94 static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
95     enum intr_polarity pol);
96 #ifdef ARM_INTRNG
97 static	int nexus_describe_intr(device_t dev, device_t child,
98     struct resource *irq, void *cookie, const char *descr);
99 #endif
100 static	int nexus_deactivate_resource(device_t, device_t, int, int,
101     struct resource *);
102 static int nexus_release_resource(device_t, device_t, int, int,
103     struct resource *);
104 
105 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
106     int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
107 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
108 
109 #ifdef FDT
110 static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
111     int icells, pcell_t *intr);
112 #endif
113 
114 static device_method_t nexus_methods[] = {
115 	/* Device interface */
116 	DEVMETHOD(device_probe,		nexus_probe),
117 	DEVMETHOD(device_attach,	nexus_attach),
118 	/* Bus interface */
119 	DEVMETHOD(bus_print_child,	nexus_print_child),
120 	DEVMETHOD(bus_add_child,	nexus_add_child),
121 	DEVMETHOD(bus_alloc_resource,	nexus_alloc_resource),
122 	DEVMETHOD(bus_activate_resource,	nexus_activate_resource),
123 	DEVMETHOD(bus_config_intr,	nexus_config_intr),
124 	DEVMETHOD(bus_deactivate_resource,	nexus_deactivate_resource),
125 	DEVMETHOD(bus_release_resource,	nexus_release_resource),
126 	DEVMETHOD(bus_setup_intr,	nexus_setup_intr),
127 	DEVMETHOD(bus_teardown_intr,	nexus_teardown_intr),
128 	DEVMETHOD(bus_get_bus_tag,	nexus_get_bus_tag),
129 #ifdef ARM_INTRNG
130 	DEVMETHOD(bus_describe_intr,	nexus_describe_intr),
131 #ifdef SMP
132 	DEVMETHOD(bus_bind_intr,	nexus_bind_intr),
133 #endif
134 #endif
135 #ifdef FDT
136 	DEVMETHOD(ofw_bus_map_intr,	nexus_ofw_map_intr),
137 #endif
138 	{ 0, 0 }
139 };
140 
141 static devclass_t nexus_devclass;
142 static driver_t nexus_driver = {
143 	"nexus",
144 	nexus_methods,
145 	1			/* no softc */
146 };
147 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0,
148     BUS_PASS_BUS + BUS_PASS_ORDER_EARLY);
149 
150 static int
151 nexus_probe(device_t dev)
152 {
153 
154 	device_quiet(dev);	/* suppress attach message for neatness */
155 
156 	return (BUS_PROBE_DEFAULT);
157 }
158 
159 static int
160 nexus_attach(device_t dev)
161 {
162 
163 	mem_rman.rm_start = 0;
164 	mem_rman.rm_end = BUS_SPACE_MAXADDR;
165 	mem_rman.rm_type = RMAN_ARRAY;
166 	mem_rman.rm_descr = "I/O memory addresses";
167 	if (rman_init(&mem_rman) ||
168 	    rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
169 		panic("nexus_probe mem_rman");
170 
171 	/*
172 	 * First, deal with the children we know about already
173 	 */
174 	bus_generic_probe(dev);
175 	bus_generic_attach(dev);
176 
177 	return (0);
178 }
179 
180 static int
181 nexus_print_child(device_t bus, device_t child)
182 {
183 	int retval = 0;
184 
185 	retval += bus_print_child_header(bus, child);
186 	retval += printf("\n");
187 
188 	return (retval);
189 }
190 
191 static device_t
192 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
193 {
194 	device_t child;
195 	struct nexus_device *ndev;
196 
197 	ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
198 	if (!ndev)
199 		return (0);
200 	resource_list_init(&ndev->nx_resources);
201 
202 	child = device_add_child_ordered(bus, order, name, unit);
203 
204 	/* should we free this in nexus_child_detached? */
205 	device_set_ivars(child, ndev);
206 
207 	return (child);
208 }
209 
210 
211 /*
212  * Allocate a resource on behalf of child.  NB: child is usually going to be a
213  * child of one of our descendants, not a direct child of nexus0.
214  * (Exceptions include footbridge.)
215  */
216 static struct resource *
217 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
218     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
219 {
220 	struct resource *rv;
221 	struct rman *rm;
222 	int needactivate = flags & RF_ACTIVE;
223 
224 	flags &= ~RF_ACTIVE;
225 
226 	switch (type) {
227 	case SYS_RES_MEMORY:
228 	case SYS_RES_IOPORT:
229 		rm = &mem_rman;
230 		break;
231 
232 	default:
233 		return (NULL);
234 	}
235 
236 	rv = rman_reserve_resource(rm, start, end, count, flags, child);
237 	if (rv == 0)
238 		return (NULL);
239 
240 	rman_set_rid(rv, *rid);
241 
242 	if (needactivate) {
243 		if (bus_activate_resource(child, type, *rid, rv)) {
244 			rman_release_resource(rv);
245 			return (0);
246 		}
247 	}
248 
249 	return (rv);
250 }
251 
252 static int
253 nexus_release_resource(device_t bus, device_t child, int type, int rid,
254     struct resource *res)
255 {
256 	int error;
257 
258 	if (rman_get_flags(res) & RF_ACTIVE) {
259 		error = bus_deactivate_resource(child, type, rid, res);
260 		if (error)
261 			return (error);
262 	}
263 	return (rman_release_resource(res));
264 }
265 
266 static bus_space_tag_t
267 nexus_get_bus_tag(device_t bus __unused, device_t child __unused)
268 {
269 
270 #ifdef FDT
271 		return(fdtbus_bs_tag);
272 #else
273 		return((void *)1);
274 #endif
275 }
276 
277 static int
278 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
279     enum intr_polarity pol)
280 {
281 	int ret = ENODEV;
282 
283 #ifdef ARM_INTRNG
284 	ret = intr_irq_config(irq, trig, pol);
285 #else
286 	if (arm_config_irq)
287 		ret = (*arm_config_irq)(irq, trig, pol);
288 #endif
289 	return (ret);
290 }
291 
292 static int
293 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
294     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
295 {
296 	int irq;
297 
298 	if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
299 		flags |= INTR_EXCL;
300 
301 	for (irq = rman_get_start(res); irq <= rman_get_end(res); irq++) {
302 #ifdef ARM_INTRNG
303 		intr_irq_add_handler(child, filt, intr, arg, irq, flags,
304 		    cookiep);
305 #else
306 		arm_setup_irqhandler(device_get_nameunit(child),
307 		    filt, intr, arg, irq, flags, cookiep);
308 		arm_unmask_irq(irq);
309 #endif
310 	}
311 	return (0);
312 }
313 
314 static int
315 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
316 {
317 
318 #ifdef ARM_INTRNG
319 	return (intr_irq_remove_handler(child, rman_get_start(r), ih));
320 #else
321 	return (arm_remove_irqhandler(rman_get_start(r), ih));
322 #endif
323 }
324 
325 #ifdef ARM_INTRNG
326 static int
327 nexus_describe_intr(device_t dev, device_t child, struct resource *irq,
328     void *cookie, const char *descr)
329 {
330 
331 	return (intr_irq_describe(rman_get_start(irq), cookie, descr));
332 }
333 
334 #ifdef SMP
335 static int
336 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
337 {
338 
339 	return (intr_irq_bind(rman_get_start(irq), cpu));
340 }
341 #endif
342 #endif
343 
344 static int
345 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
346     struct resource *r)
347 {
348 	int err;
349 	bus_addr_t paddr;
350 	bus_size_t psize;
351 	bus_space_handle_t vaddr;
352 
353 	if ((err = rman_activate_resource(r)) != 0)
354 		return (err);
355 
356 	/*
357 	 * If this is a memory resource, map it into the kernel.
358 	 */
359 	if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
360 		paddr = (bus_addr_t)rman_get_start(r);
361 		psize = (bus_size_t)rman_get_size(r);
362 #ifdef FDT
363 		err = bus_space_map(fdtbus_bs_tag, paddr, psize, 0, &vaddr);
364 		if (err != 0) {
365 			rman_deactivate_resource(r);
366 			return (err);
367 		}
368 		rman_set_bustag(r, fdtbus_bs_tag);
369 #else
370 		vaddr = (bus_space_handle_t)pmap_mapdev((vm_offset_t)paddr,
371 		    (vm_size_t)psize);
372 		if (vaddr == 0) {
373 			rman_deactivate_resource(r);
374 			return (ENOMEM);
375 		}
376 		rman_set_bustag(r, (void *)1);
377 #endif
378 		rman_set_virtual(r, (void *)vaddr);
379 		rman_set_bushandle(r, vaddr);
380 	}
381 	return (0);
382 }
383 
384 static int
385 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
386     struct resource *r)
387 {
388 	bus_size_t psize;
389 	bus_space_handle_t vaddr;
390 
391 	psize = (bus_size_t)rman_get_size(r);
392 	vaddr = rman_get_bushandle(r);
393 
394 	if (vaddr != 0) {
395 #ifdef FDT
396 		bus_space_unmap(fdtbus_bs_tag, vaddr, psize);
397 #else
398 		pmap_unmapdev((vm_offset_t)vaddr, (vm_size_t)psize);
399 #endif
400 		rman_set_virtual(r, NULL);
401 		rman_set_bushandle(r, 0);
402 	}
403 
404 	return (rman_deactivate_resource(r));
405 }
406 
407 #ifdef FDT
408 static int
409 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
410     pcell_t *intr)
411 {
412 
413 	return (intr_fdt_map_irq(iparent, intr, icells));
414 }
415 #endif
416