xref: /freebsd/sys/arm/arm/nexus.c (revision 1d386b48)
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 and I/O memory address space.
38  */
39 
40 #include "opt_platform.h"
41 
42 #include <sys/cdefs.h>
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/bus.h>
46 #include <sys/interrupt.h>
47 #include <sys/kernel.h>
48 #include <sys/malloc.h>
49 #include <sys/module.h>
50 #include <sys/rman.h>
51 
52 #include <vm/vm.h>
53 #include <vm/pmap.h>
54 
55 #include <machine/bus.h>
56 #include <machine/pcb.h>
57 #include <machine/intr.h>
58 #include <machine/resource.h>
59 #include <machine/vmparam.h>
60 
61 #include <arm/arm/nexusvar.h>
62 
63 #ifdef FDT
64 #include <machine/fdt.h>
65 #include <dev/ofw/ofw_bus_subr.h>
66 #include "ofw_bus_if.h"
67 #endif
68 
69 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
70 
71 struct nexus_device {
72 	struct resource_list	nx_resources;
73 };
74 
75 #define DEVTONX(dev)	((struct nexus_device *)device_get_ivars(dev))
76 
77 static struct rman mem_rman;
78 static struct rman irq_rman;
79 
80 static device_probe_t		nexus_probe;
81 static device_attach_t		nexus_attach;
82 
83 static bus_add_child_t		nexus_add_child;
84 static bus_print_child_t	nexus_print_child;
85 
86 static bus_activate_resource_t	nexus_activate_resource;
87 static bus_adjust_resource_t	nexus_adjust_resource;
88 static bus_alloc_resource_t	nexus_alloc_resource;
89 static bus_deactivate_resource_t nexus_deactivate_resource;
90 static bus_release_resource_t	nexus_release_resource;
91 
92 #ifdef SMP
93 static bus_bind_intr_t		nexus_bind_intr;
94 #endif
95 static bus_config_intr_t	nexus_config_intr;
96 static bus_describe_intr_t	nexus_describe_intr;
97 static bus_setup_intr_t		nexus_setup_intr;
98 static bus_teardown_intr_t	nexus_teardown_intr;
99 
100 static bus_get_bus_tag_t	nexus_get_bus_tag;
101 static bus_get_dma_tag_t	nexus_get_dma_tag;
102 
103 #ifdef FDT
104 static ofw_bus_map_intr_t	nexus_ofw_map_intr;
105 #endif
106 
107 /*
108  * Normally NULL (which results in defaults which are handled in
109  * busdma_machdep), platform init code can use nexus_set_dma_tag() to set this
110  * to a tag that will be inherited by all busses and devices on the platform.
111  */
112 static bus_dma_tag_t nexus_dma_tag;
113 
114 static device_method_t nexus_methods[] = {
115 	/* Device interface */
116 	DEVMETHOD(device_probe,		nexus_probe),
117 	DEVMETHOD(device_attach,	nexus_attach),
118 
119 	/* Bus interface */
120 	DEVMETHOD(bus_add_child,	nexus_add_child),
121 	DEVMETHOD(bus_print_child,	nexus_print_child),
122 	DEVMETHOD(bus_activate_resource, nexus_activate_resource),
123 	DEVMETHOD(bus_adjust_resource,	nexus_adjust_resource),
124 	DEVMETHOD(bus_alloc_resource,	nexus_alloc_resource),
125 	DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
126 	DEVMETHOD(bus_release_resource,	nexus_release_resource),
127 #ifdef SMP
128 	DEVMETHOD(bus_bind_intr,	nexus_bind_intr),
129 #endif
130 	DEVMETHOD(bus_config_intr,	nexus_config_intr),
131 	DEVMETHOD(bus_describe_intr,	nexus_describe_intr),
132 	DEVMETHOD(bus_setup_intr,	nexus_setup_intr),
133 	DEVMETHOD(bus_teardown_intr,	nexus_teardown_intr),
134 	DEVMETHOD(bus_get_bus_tag,	nexus_get_bus_tag),
135 	DEVMETHOD(bus_get_dma_tag,	nexus_get_dma_tag),
136 #ifdef FDT
137 	/* ofw_bus interface */
138 	DEVMETHOD(ofw_bus_map_intr,	nexus_ofw_map_intr),
139 #endif
140 	DEVMETHOD_END
141 };
142 
143 static driver_t nexus_driver = {
144 	"nexus",
145 	nexus_methods,
146 	1			/* no softc */
147 };
148 
149 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, 0, 0,
150     BUS_PASS_BUS + BUS_PASS_ORDER_EARLY);
151 
152 static int
153 nexus_probe(device_t dev)
154 {
155 
156 	device_quiet(dev);	/* suppress attach message for neatness */
157 
158 	return (BUS_PROBE_DEFAULT);
159 }
160 
161 static int
162 nexus_attach(device_t dev)
163 {
164 
165 	mem_rman.rm_start = 0;
166 	mem_rman.rm_end = BUS_SPACE_MAXADDR;
167 	mem_rman.rm_type = RMAN_ARRAY;
168 	mem_rman.rm_descr = "I/O memory addresses";
169 	if (rman_init(&mem_rman) ||
170 	    rman_manage_region(&mem_rman, 0, BUS_SPACE_MAXADDR))
171 		panic("nexus_probe mem_rman");
172 	irq_rman.rm_start = 0;
173 	irq_rman.rm_end = ~0;
174 	irq_rman.rm_type = RMAN_ARRAY;
175 	irq_rman.rm_descr = "Interrupts";
176 	if (rman_init(&irq_rman) || rman_manage_region(&irq_rman, 0, ~0))
177 		panic("nexus_attach irq_rman");
178 
179 	/* First, add ofwbus0. */
180 	device_add_child(dev, "ofwbus", 0);
181 
182 	/*
183 	 * Next, deal with the children we know about already.
184 	 */
185 	bus_generic_probe(dev);
186 	bus_generic_attach(dev);
187 
188 	return (0);
189 }
190 
191 static int
192 nexus_print_child(device_t bus, device_t child)
193 {
194 	int retval = 0;
195 
196 	retval += bus_print_child_header(bus, child);
197 	retval += printf("\n");
198 
199 	return (retval);
200 }
201 
202 static device_t
203 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
204 {
205 	device_t child;
206 	struct nexus_device *ndev;
207 
208 	ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
209 	if (!ndev)
210 		return (0);
211 	resource_list_init(&ndev->nx_resources);
212 
213 	child = device_add_child_ordered(bus, order, name, unit);
214 
215 	device_set_ivars(child, ndev);
216 
217 	return (child);
218 }
219 
220 /*
221  * Allocate a resource on behalf of child.  NB: child is usually going to be a
222  * child of one of our descendants, not a direct child of nexus0.
223  */
224 static struct resource *
225 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
226     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
227 {
228 	struct resource *rv;
229 	struct rman *rm;
230 	int needactivate = flags & RF_ACTIVE;
231 
232 	flags &= ~RF_ACTIVE;
233 
234 	switch (type) {
235 	case SYS_RES_IRQ:
236 		rm = &irq_rman;
237 		break;
238 
239 	case SYS_RES_MEMORY:
240 	case SYS_RES_IOPORT:
241 		rm = &mem_rman;
242 		break;
243 
244 	default:
245 		return (NULL);
246 	}
247 
248 	rv = rman_reserve_resource(rm, start, end, count, flags, child);
249 	if (rv == NULL)
250 		return (NULL);
251 
252 	rman_set_rid(rv, *rid);
253 
254 	if (needactivate) {
255 		if (bus_activate_resource(child, type, *rid, rv)) {
256 			rman_release_resource(rv);
257 			return (NULL);
258 		}
259 	}
260 
261 	return (rv);
262 }
263 
264 static int
265 nexus_adjust_resource(device_t bus __unused, device_t child __unused, int type,
266     struct resource *r, rman_res_t start, rman_res_t end)
267 {
268 	struct rman *rm;
269 
270 	switch (type) {
271 	case SYS_RES_IRQ:
272 		rm = &irq_rman;
273 		break;
274 	case SYS_RES_MEMORY:
275 		rm = &mem_rman;
276 		break;
277 	default:
278 		return (EINVAL);
279 	}
280 	if (rman_is_region_manager(r, rm) == 0)
281 		return (EINVAL);
282 	return (rman_adjust_resource(r, start, end));
283 }
284 
285 static int
286 nexus_release_resource(device_t bus, device_t child, int type, int rid,
287     struct resource *res)
288 {
289 	int error;
290 
291 	if (rman_get_flags(res) & RF_ACTIVE) {
292 		error = bus_deactivate_resource(child, type, rid, res);
293 		if (error)
294 			return (error);
295 	}
296 	return (rman_release_resource(res));
297 }
298 
299 static bus_space_tag_t
300 nexus_get_bus_tag(device_t bus __unused, device_t child __unused)
301 {
302 
303 #ifdef FDT
304 	return (fdtbus_bs_tag);
305 #else
306 	return ((void *)1);
307 #endif
308 }
309 
310 static bus_dma_tag_t
311 nexus_get_dma_tag(device_t dev, device_t child)
312 {
313 
314 	return (nexus_dma_tag);
315 }
316 
317 void
318 nexus_set_dma_tag(bus_dma_tag_t tag)
319 {
320 
321 	nexus_dma_tag = tag;
322 }
323 
324 static int
325 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
326     enum intr_polarity pol)
327 {
328 	int ret = ENODEV;
329 
330 	device_printf(dev, "bus_config_intr is obsolete and not supported!\n");
331 	ret = EOPNOTSUPP;
332 	return (ret);
333 }
334 
335 static int
336 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
337     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
338 {
339 
340 	if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
341 		flags |= INTR_EXCL;
342 
343 	return (intr_setup_irq(child, res, filt, intr, arg, flags, cookiep));
344 }
345 
346 static int
347 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
348 {
349 
350 	return (intr_teardown_irq(child, r, ih));
351 }
352 
353 static int
354 nexus_describe_intr(device_t dev, device_t child, struct resource *irq,
355     void *cookie, const char *descr)
356 {
357 
358 	return (intr_describe_irq(child, irq, cookie, descr));
359 }
360 
361 #ifdef SMP
362 static int
363 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
364 {
365 
366 	return (intr_bind_irq(child, irq, cpu));
367 }
368 #endif
369 
370 static int
371 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
372     struct resource *r)
373 {
374 	int err;
375 	bus_addr_t paddr;
376 	bus_size_t psize;
377 	bus_space_handle_t vaddr;
378 
379 	if ((err = rman_activate_resource(r)) != 0)
380 		return (err);
381 
382 	/*
383 	 * If this is a memory resource, map it into the kernel.
384 	 */
385 	if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
386 		paddr = (bus_addr_t)rman_get_start(r);
387 		psize = (bus_size_t)rman_get_size(r);
388 #ifdef FDT
389 		err = bus_space_map(fdtbus_bs_tag, paddr, psize, 0, &vaddr);
390 		if (err != 0) {
391 			rman_deactivate_resource(r);
392 			return (err);
393 		}
394 		rman_set_bustag(r, fdtbus_bs_tag);
395 #else
396 		vaddr = (bus_space_handle_t)pmap_mapdev((vm_paddr_t)paddr,
397 		    (vm_size_t)psize);
398 		if (vaddr == 0) {
399 			rman_deactivate_resource(r);
400 			return (ENOMEM);
401 		}
402 		rman_set_bustag(r, (void *)1);
403 #endif
404 		rman_set_virtual(r, (void *)vaddr);
405 		rman_set_bushandle(r, vaddr);
406 		return (0);
407 	} else if (type == SYS_RES_IRQ) {
408 		err = intr_activate_irq(child, r);
409 		if (err != 0) {
410 			rman_deactivate_resource(r);
411 			return (err);
412 		}
413 	}
414 	return (0);
415 }
416 
417 static int
418 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
419     struct resource *r)
420 {
421 	bus_size_t psize;
422 	bus_space_handle_t vaddr;
423 
424 	if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
425 		psize = (bus_size_t)rman_get_size(r);
426 		vaddr = rman_get_bushandle(r);
427 
428 		if (vaddr != 0) {
429 #ifdef FDT
430 			bus_space_unmap(fdtbus_bs_tag, vaddr, psize);
431 #else
432 			pmap_unmapdev((void *)vaddr, (vm_size_t)psize);
433 #endif
434 			rman_set_virtual(r, NULL);
435 			rman_set_bushandle(r, 0);
436 		}
437 	} else if (type == SYS_RES_IRQ) {
438 		intr_deactivate_irq(child, r);
439 	}
440 
441 	return (rman_deactivate_resource(r));
442 }
443 
444 #ifdef FDT
445 static int
446 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
447     pcell_t *intr)
448 {
449 	u_int irq;
450 	struct intr_map_data_fdt *fdt_data;
451 	size_t len;
452 
453 	len = sizeof(*fdt_data) + icells * sizeof(pcell_t);
454 	fdt_data = (struct intr_map_data_fdt *)intr_alloc_map_data(
455 	    INTR_MAP_DATA_FDT, len, M_WAITOK | M_ZERO);
456 	fdt_data->iparent = iparent;
457 	fdt_data->ncells = icells;
458 	memcpy(fdt_data->cells, intr, icells * sizeof(pcell_t));
459 	irq = intr_map_irq(NULL, iparent, (struct intr_map_data *)fdt_data);
460 	return (irq);
461 }
462 #endif /* FDT */
463