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 <sys/cdefs.h>
43__FBSDID("$FreeBSD$");
44
45#include <sys/param.h>
46#include <sys/systm.h>
47#include <sys/bus.h>
48#include <sys/kernel.h>
49#include <sys/malloc.h>
50#include <sys/module.h>
51#include <machine/bus.h>
52#include <sys/rman.h>
53#include <sys/interrupt.h>
54
55#include <machine/vmparam.h>
56#include <machine/pcb.h>
57#include <vm/vm.h>
58#include <vm/pmap.h>
59
60#include <machine/resource.h>
61#include <machine/intr.h>
62
63#include "opt_platform.h"
64
65#ifdef FDT
66#include <dev/fdt/fdt_common.h>
67#include <machine/fdt.h>
68#include "ofw_bus_if.h"
69#endif
70
71static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
72
73struct nexus_device {
74	struct resource_list	nx_resources;
75};
76
77#define DEVTONX(dev)	((struct nexus_device *)device_get_ivars(dev))
78
79static struct rman mem_rman;
80
81static	int nexus_probe(device_t);
82static	int nexus_attach(device_t);
83static	int nexus_print_child(device_t, device_t);
84static	device_t nexus_add_child(device_t, u_int, const char *, int);
85static	struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
86    u_long, u_long, u_long, u_int);
87static	int nexus_activate_resource(device_t, device_t, int, int,
88    struct resource *);
89static int nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
90    enum intr_polarity pol);
91static	int nexus_deactivate_resource(device_t, device_t, int, int,
92    struct resource *);
93
94static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
95    int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
96static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
97
98#ifdef FDT
99static int nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent,
100    int icells, pcell_t *intr);
101#endif
102
103static device_method_t nexus_methods[] = {
104	/* Device interface */
105	DEVMETHOD(device_probe,		nexus_probe),
106	DEVMETHOD(device_attach,	nexus_attach),
107	/* Bus interface */
108	DEVMETHOD(bus_print_child,	nexus_print_child),
109	DEVMETHOD(bus_add_child,	nexus_add_child),
110	DEVMETHOD(bus_alloc_resource,	nexus_alloc_resource),
111	DEVMETHOD(bus_activate_resource,	nexus_activate_resource),
112	DEVMETHOD(bus_config_intr,	nexus_config_intr),
113	DEVMETHOD(bus_deactivate_resource,	nexus_deactivate_resource),
114	DEVMETHOD(bus_setup_intr,	nexus_setup_intr),
115	DEVMETHOD(bus_teardown_intr,	nexus_teardown_intr),
116#ifdef FDT
117	DEVMETHOD(ofw_bus_map_intr,	nexus_ofw_map_intr),
118#endif
119	{ 0, 0 }
120};
121
122static devclass_t nexus_devclass;
123static driver_t nexus_driver = {
124	"nexus",
125	nexus_methods,
126	1			/* no softc */
127};
128EARLY_DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0,
129    BUS_PASS_BUS + BUS_PASS_ORDER_EARLY);
130
131static int
132nexus_probe(device_t dev)
133{
134
135	device_quiet(dev);	/* suppress attach message for neatness */
136
137	return (BUS_PROBE_DEFAULT);
138}
139
140static int
141nexus_attach(device_t dev)
142{
143
144	mem_rman.rm_start = 0;
145	mem_rman.rm_end = ~0ul;
146	mem_rman.rm_type = RMAN_ARRAY;
147	mem_rman.rm_descr = "I/O memory addresses";
148	if (rman_init(&mem_rman) || rman_manage_region(&mem_rman, 0, ~0))
149		panic("nexus_probe mem_rman");
150
151	/*
152	 * First, deal with the children we know about already
153	 */
154	bus_generic_probe(dev);
155	bus_generic_attach(dev);
156
157	return (0);
158}
159
160static int
161nexus_print_child(device_t bus, device_t child)
162{
163	int retval = 0;
164
165	retval += bus_print_child_header(bus, child);
166	retval += printf("\n");
167
168	return (retval);
169}
170
171static device_t
172nexus_add_child(device_t bus, u_int order, const char *name, int unit)
173{
174	device_t child;
175	struct nexus_device *ndev;
176
177	ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
178	if (!ndev)
179		return (0);
180	resource_list_init(&ndev->nx_resources);
181
182	child = device_add_child_ordered(bus, order, name, unit);
183
184	/* should we free this in nexus_child_detached? */
185	device_set_ivars(child, ndev);
186
187	return (child);
188}
189
190
191/*
192 * Allocate a resource on behalf of child.  NB: child is usually going to be a
193 * child of one of our descendants, not a direct child of nexus0.
194 * (Exceptions include footbridge.)
195 */
196static struct resource *
197nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
198    u_long start, u_long end, u_long count, u_int flags)
199{
200	struct resource *rv;
201	struct rman *rm;
202	int needactivate = flags & RF_ACTIVE;
203
204	switch (type) {
205	case SYS_RES_MEMORY:
206	case SYS_RES_IOPORT:
207		rm = &mem_rman;
208		break;
209
210	default:
211		return (0);
212	}
213
214	rv = rman_reserve_resource(rm, start, end, count, flags, child);
215	if (rv == 0)
216		return (0);
217
218	rman_set_rid(rv, *rid);
219	rman_set_bushandle(rv, rman_get_start(rv));
220
221	if (needactivate) {
222		if (bus_activate_resource(child, type, *rid, rv)) {
223			rman_release_resource(rv);
224			return (0);
225		}
226	}
227
228	return (rv);
229}
230
231static int
232nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
233    enum intr_polarity pol)
234{
235	int ret = ENODEV;
236
237	if (arm_config_irq)
238		ret = (*arm_config_irq)(irq, trig, pol);
239
240	return (ret);
241}
242
243static int
244nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
245    driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
246{
247	int irq;
248
249	if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
250		flags |= INTR_EXCL;
251
252	for (irq = rman_get_start(res); irq <= rman_get_end(res); irq++) {
253		arm_setup_irqhandler(device_get_nameunit(child),
254		    filt, intr, arg, irq, flags, cookiep);
255		arm_unmask_irq(irq);
256	}
257	return (0);
258}
259
260static int
261nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
262{
263
264	return (arm_remove_irqhandler(rman_get_start(r), ih));
265}
266
267
268static int
269nexus_activate_resource(device_t bus, device_t child, int type, int rid,
270    struct resource *r)
271{
272	int err;
273	bus_addr_t paddr;
274	bus_size_t psize;
275	bus_space_handle_t vaddr;
276
277	if ((err = rman_activate_resource(r)) != 0)
278		return (err);
279
280	/*
281	 * If this is a memory resource, map it into the kernel.
282	 */
283	if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
284		paddr = (bus_addr_t)rman_get_start(r);
285		psize = (bus_size_t)rman_get_size(r);
286#ifdef FDT
287		err = bus_space_map(fdtbus_bs_tag, paddr, psize, 0, &vaddr);
288		if (err != 0) {
289			rman_deactivate_resource(r);
290			return (err);
291		}
292		rman_set_bustag(r, fdtbus_bs_tag);
293#else
294		vaddr = (bus_space_handle_t)pmap_mapdev((vm_offset_t)paddr,
295		    (vm_size_t)psize);
296		if (vaddr == 0) {
297			rman_deactivate_resource(r);
298			return (ENOMEM);
299		}
300		rman_set_bustag(r, (void *)1);
301#endif
302		rman_set_virtual(r, (void *)vaddr);
303		rman_set_bushandle(r, vaddr);
304	}
305	return (0);
306}
307
308static int
309nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
310    struct resource *r)
311{
312	bus_size_t psize;
313	bus_space_handle_t vaddr;
314
315	psize = (bus_size_t)rman_get_size(r);
316	vaddr = rman_get_bushandle(r);
317
318	if (vaddr != 0) {
319#ifdef FDT
320		bus_space_unmap(fdtbus_bs_tag, vaddr, psize);
321#else
322		pmap_unmapdev((vm_offset_t)vaddr, (vm_size_t)psize);
323#endif
324		rman_set_virtual(r, NULL);
325		rman_set_bushandle(r, 0);
326	}
327
328	return (rman_deactivate_resource(r));
329}
330
331#ifdef FDT
332static int
333nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
334    pcell_t *intr)
335{
336	fdt_pic_decode_t intr_decode;
337	phandle_t intr_parent;
338	int i, rv, interrupt, trig, pol;
339
340	intr_parent = OF_node_from_xref(iparent);
341	for (i = 0; i < icells; i++)
342		intr[i] = cpu_to_fdt32(intr[i]);
343
344	for (i = 0; fdt_pic_table[i] != NULL; i++) {
345		intr_decode = fdt_pic_table[i];
346		rv = intr_decode(intr_parent, intr, &interrupt, &trig, &pol);
347
348		if (rv == 0) {
349			/* This was recognized as our PIC and decoded. */
350			interrupt = FDT_MAP_IRQ(intr_parent, interrupt);
351			return (interrupt);
352		}
353	}
354
355	/* Not in table, so guess */
356	interrupt = FDT_MAP_IRQ(intr_parent, fdt32_to_cpu(intr[0]));
357
358	return (interrupt);
359}
360#endif
361
362