xref: /freebsd/sys/arm/arm/nexus.c (revision aa0a1e58)
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 #include <machine/pmap.h>
60 
61 #include <machine/resource.h>
62 #include <machine/intr.h>
63 
64 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
65 
66 struct nexus_device {
67 	struct resource_list	nx_resources;
68 };
69 
70 #define DEVTONX(dev)	((struct nexus_device *)device_get_ivars(dev))
71 
72 static struct rman mem_rman;
73 
74 static	int nexus_probe(device_t);
75 static	int nexus_attach(device_t);
76 static	int nexus_print_child(device_t, device_t);
77 static	device_t nexus_add_child(device_t, u_int, const char *, int);
78 static	struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
79     u_long, u_long, u_long, u_int);
80 static	int nexus_activate_resource(device_t, device_t, int, int,
81     struct resource *);
82 static int nexus_setup_intr(device_t dev, device_t child, struct resource *res,
83     int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep);
84 static int nexus_teardown_intr(device_t, device_t, struct resource *, void *);
85 
86 static device_method_t nexus_methods[] = {
87 	/* Device interface */
88 	DEVMETHOD(device_probe,		nexus_probe),
89 	DEVMETHOD(device_attach,	nexus_attach),
90 	/* Bus interface */
91 	DEVMETHOD(bus_print_child,	nexus_print_child),
92 	DEVMETHOD(bus_add_child,	nexus_add_child),
93 	DEVMETHOD(bus_alloc_resource,	nexus_alloc_resource),
94 	DEVMETHOD(bus_activate_resource,	nexus_activate_resource),
95 	DEVMETHOD(bus_setup_intr,	nexus_setup_intr),
96 	DEVMETHOD(bus_teardown_intr,	nexus_teardown_intr),
97 	{ 0, 0 }
98 };
99 
100 static driver_t nexus_driver = {
101 	"nexus",
102 	nexus_methods,
103 	1			/* no softc */
104 };
105 static devclass_t nexus_devclass;
106 
107 static int
108 nexus_probe(device_t dev)
109 {
110 
111 	device_quiet(dev);	/* suppress attach message for neatness */
112 
113 	return (BUS_PROBE_DEFAULT);
114 }
115 
116 static int
117 nexus_setup_intr(device_t dev, device_t child, struct resource *res, int flags,
118     driver_filter_t *filt, driver_intr_t *intr, void *arg, void **cookiep)
119 {
120 
121 	if ((rman_get_flags(res) & RF_SHAREABLE) == 0)
122 		flags |= INTR_EXCL;
123 
124 	arm_setup_irqhandler(device_get_nameunit(child),
125 	    filt, intr, arg, rman_get_start(res), flags, cookiep);
126 	return (0);
127 }
128 
129 static int
130 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
131 {
132 
133 	return (arm_remove_irqhandler(rman_get_start(r), ih));
134 }
135 
136 static int
137 nexus_attach(device_t dev)
138 {
139 
140 	mem_rman.rm_start = 0;
141 	mem_rman.rm_end = ~0u;
142 	mem_rman.rm_type = RMAN_ARRAY;
143 	mem_rman.rm_descr = "I/O memory addresses";
144 	if (rman_init(&mem_rman) || rman_manage_region(&mem_rman, 0, ~0u))
145 		panic("nexus_probe mem_rman");
146 
147 	/*
148 	 * First, deal with the children we know about already
149 	 */
150 	bus_generic_probe(dev);
151 	bus_generic_attach(dev);
152 
153 	return (0);
154 }
155 
156 
157 static int
158 nexus_print_child(device_t bus, device_t child)
159 {
160 	int retval = 0;
161 
162 	retval += bus_print_child_header(bus, child);
163 	retval += printf(" on motherboard\n");	/* XXX "motherboard", ick */
164 
165 	return (retval);
166 }
167 
168 static device_t
169 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
170 {
171 	device_t child;
172 	struct nexus_device *ndev;
173 
174 	ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
175 	if (!ndev)
176 		return (0);
177 	resource_list_init(&ndev->nx_resources);
178 
179 	child = device_add_child_ordered(bus, order, name, unit);
180 
181 	/* should we free this in nexus_child_detached? */
182 	device_set_ivars(child, ndev);
183 
184 	return (child);
185 }
186 
187 
188 /*
189  * Allocate a resource on behalf of child.  NB: child is usually going to be a
190  * child of one of our descendants, not a direct child of nexus0.
191  * (Exceptions include footbridge.)
192  */
193 #define ARM_BUS_SPACE_MEM 1
194 static struct resource *
195 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
196     u_long start, u_long end, u_long count, u_int flags)
197 {
198 	struct resource *rv;
199 	struct rman *rm;
200 	int needactivate = flags & RF_ACTIVE;
201 
202 	switch (type) {
203 	case SYS_RES_MEMORY:
204 		rm = &mem_rman;
205 		break;
206 
207 	default:
208 		return (0);
209 	}
210 
211 	rv = rman_reserve_resource(rm, start, end, count, flags, child);
212 	if (rv == 0)
213 		return (0);
214 
215 	rman_set_rid(rv, *rid);
216 	rman_set_bustag(rv, (void*)ARM_BUS_SPACE_MEM);
217 	rman_set_bushandle(rv, rman_get_start(rv));
218 
219 	if (needactivate) {
220 		if (bus_activate_resource(child, type, *rid, rv)) {
221 			rman_release_resource(rv);
222 			return (0);
223 		}
224 	}
225 
226 	return (rv);
227 }
228 
229 
230 static int
231 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
232     struct resource *r)
233 {
234 	/*
235 	 * If this is a memory resource, map it into the kernel.
236 	 */
237 	if (rman_get_bustag(r) == (void*)ARM_BUS_SPACE_MEM) {
238 		caddr_t vaddr = 0;
239 		u_int32_t paddr;
240 		u_int32_t psize;
241 		u_int32_t poffs;
242 
243 		paddr = rman_get_start(r);
244 		psize = rman_get_size(r);
245 		poffs = paddr - trunc_page(paddr);
246 		vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
247 		rman_set_virtual(r, vaddr);
248 		rman_set_bushandle(r, (bus_space_handle_t) vaddr);
249 	}
250 	return (rman_activate_resource(r));
251 }
252 
253 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
254