xref: /freebsd/sys/powerpc/powerpc/nexus.c (revision be181ee2)
1 /*-
2  * Copyright 1998 Massachusetts Institute of Technology
3  * Copyright 2001 by Thomas Moestl <tmm@FreeBSD.org>.
4  * Copyright 2006 by Marius Strobl <marius@FreeBSD.org>.
5  * All rights reserved.
6  *
7  * Permission to use, copy, modify, and distribute this software and
8  * its documentation for any purpose and without fee is hereby
9  * granted, provided that both the above copyright notice and this
10  * permission notice appear in all copies, that both the above
11  * copyright notice and this permission notice appear in all
12  * supporting documentation, and that the name of M.I.T. not be used
13  * in advertising or publicity pertaining to distribution of the
14  * software without specific, written prior permission.  M.I.T. makes
15  * no representations about the suitability of this software for any
16  * purpose.  It is provided "as is" without express or implied
17  * warranty.
18  *
19  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
20  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
21  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
23  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * 	from: FreeBSD: src/sys/i386/i386/nexus.c,v 1.43 2001/02/09
33  */
34 
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37 
38 #include <sys/endian.h>
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/bus.h>
42 #include <sys/kdb.h>
43 #include <sys/kernel.h>
44 #include <sys/malloc.h>
45 #include <sys/module.h>
46 #include <sys/pcpu.h>
47 #include <sys/rman.h>
48 #include <sys/smp.h>
49 
50 #include <vm/vm.h>
51 #include <vm/pmap.h>
52 
53 #include <dev/ofw/ofw_bus.h>
54 #include <dev/ofw/ofw_bus_subr.h>
55 #include <dev/ofw/openfirm.h>
56 
57 #include <machine/bus.h>
58 #include <machine/intr_machdep.h>
59 #include <machine/resource.h>
60 
61 /*
62  * The nexus handles root-level resource allocation requests and interrupt
63  * mapping. All direct subdevices of nexus are attached by DEVICE_IDENTIFY().
64  */
65 
66 static device_probe_t nexus_probe;
67 static device_attach_t nexus_attach;
68 static bus_setup_intr_t nexus_setup_intr;
69 static bus_teardown_intr_t nexus_teardown_intr;
70 static bus_activate_resource_t nexus_activate_resource;
71 static bus_deactivate_resource_t nexus_deactivate_resource;
72 static  int nexus_map_resource(device_t bus, device_t child, int type,
73 			       struct resource *r,
74 			       struct resource_map_request *argsp,
75 			       struct resource_map *map);
76 static  int nexus_unmap_resource(device_t bus, device_t child, int type,
77 			       struct resource *r, struct resource_map *map);
78 
79 static bus_space_tag_t nexus_get_bus_tag(device_t, device_t);
80 static int nexus_get_cpus(device_t, device_t, enum cpu_sets, size_t,
81     cpuset_t *);
82 #ifdef SMP
83 static bus_bind_intr_t nexus_bind_intr;
84 #endif
85 static bus_config_intr_t nexus_config_intr;
86 static ofw_bus_map_intr_t nexus_ofw_map_intr;
87 
88 static device_method_t nexus_methods[] = {
89 	/* Device interface */
90 	DEVMETHOD(device_probe,		nexus_probe),
91 	DEVMETHOD(device_attach,	nexus_attach),
92 
93 	/* Bus interface */
94 	DEVMETHOD(bus_add_child,	bus_generic_add_child),
95 	DEVMETHOD(bus_activate_resource,	nexus_activate_resource),
96 	DEVMETHOD(bus_deactivate_resource,	nexus_deactivate_resource),
97 	DEVMETHOD(bus_map_resource,	nexus_map_resource),
98 	DEVMETHOD(bus_unmap_resource,   nexus_unmap_resource),
99 	DEVMETHOD(bus_setup_intr,	nexus_setup_intr),
100 	DEVMETHOD(bus_teardown_intr,	nexus_teardown_intr),
101 #ifdef SMP
102 	DEVMETHOD(bus_bind_intr,	nexus_bind_intr),
103 #endif
104 	DEVMETHOD(bus_config_intr,	nexus_config_intr),
105 	DEVMETHOD(bus_get_bus_tag,	nexus_get_bus_tag),
106 	DEVMETHOD(bus_get_cpus,		nexus_get_cpus),
107 
108 	/* ofw_bus interface */
109 	DEVMETHOD(ofw_bus_map_intr,	nexus_ofw_map_intr),
110 
111 	DEVMETHOD_END
112 };
113 
114 DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, 1);
115 EARLY_DRIVER_MODULE(nexus, root, nexus_driver, 0, 0, BUS_PASS_BUS);
116 MODULE_VERSION(nexus, 1);
117 
118 static int
119 nexus_probe(device_t dev)
120 {
121 
122 	device_quiet(dev);	/* suppress attach message for neatness */
123 
124 	return (BUS_PROBE_DEFAULT);
125 }
126 
127 static int
128 nexus_attach(device_t dev)
129 {
130 
131 	bus_generic_probe(dev);
132 	bus_generic_attach(dev);
133 
134 	return (0);
135 }
136 
137 static int
138 nexus_setup_intr(device_t bus __unused, device_t child, struct resource *r,
139     int flags, driver_filter_t *filt, driver_intr_t *intr, void *arg,
140     void **cookiep)
141 {
142 	int error, domain;
143 
144 	if (r == NULL)
145 		panic("%s: NULL interrupt resource!", __func__);
146 
147 	if (cookiep != NULL)
148 		*cookiep = NULL;
149 	if ((rman_get_flags(r) & RF_SHAREABLE) == 0)
150 		flags |= INTR_EXCL;
151 
152 	/* We depend here on rman_activate_resource() being idempotent. */
153 	error = rman_activate_resource(r);
154 	if (error)
155 		return (error);
156 
157 	if (bus_get_domain(child, &domain) != 0) {
158 		if(bootverbose)
159 			device_printf(child, "no domain found\n");
160 		domain = 0;
161 	}
162 	error = powerpc_setup_intr(device_get_nameunit(child),
163 	    rman_get_start(r), filt, intr, arg, flags, cookiep, domain);
164 
165 	return (error);
166 }
167 
168 static int
169 nexus_teardown_intr(device_t bus __unused, device_t child __unused,
170     struct resource *r, void *ih)
171 {
172 
173 	if (r == NULL)
174 		return (EINVAL);
175 
176 	return (powerpc_teardown_intr(ih));
177 }
178 
179 static bus_space_tag_t
180 nexus_get_bus_tag(device_t bus __unused, device_t child __unused)
181 {
182 
183 #if BYTE_ORDER == LITTLE_ENDIAN
184 	return(&bs_le_tag);
185 #else
186 	return(&bs_be_tag);
187 #endif
188 }
189 
190 static int
191 nexus_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
192     cpuset_t *cpuset)
193 {
194 
195 	switch (op) {
196 #ifdef SMP
197 	case INTR_CPUS:
198 		if (setsize != sizeof(cpuset_t))
199 			return (EINVAL);
200 		*cpuset = all_cpus;
201 		return (0);
202 #endif
203 	default:
204 		return (bus_generic_get_cpus(dev, child, op, setsize, cpuset));
205 	}
206 }
207 
208 #ifdef SMP
209 static int
210 nexus_bind_intr(device_t bus __unused, device_t child __unused,
211     struct resource *r, int cpu)
212 {
213 
214 	return (powerpc_bind_intr(rman_get_start(r), cpu));
215 }
216 #endif
217 
218 static int
219 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
220     enum intr_polarity pol)
221 {
222 
223 	return (powerpc_config_intr(irq, trig, pol));
224 }
225 
226 static int
227 nexus_ofw_map_intr(device_t dev, device_t child, phandle_t iparent, int icells,
228     pcell_t *irq)
229 {
230 	u_int intr = MAP_IRQ(iparent, irq[0]);
231 	if (icells > 1)
232 		powerpc_fw_config_intr(intr, irq[1]);
233 	return (intr);
234 }
235 
236 static int
237 nexus_activate_resource(device_t bus __unused, device_t child __unused,
238     int type, int rid __unused, struct resource *r)
239 {
240 
241 	if (type == SYS_RES_MEMORY) {
242 		vm_paddr_t start;
243 		void *p;
244 
245 		start = (vm_paddr_t) rman_get_start(r);
246 		if (bootverbose)
247 			printf("nexus mapdev: start %jx, len %jd\n",
248 			    (uintmax_t)start, rman_get_size(r));
249 
250 		p = pmap_mapdev(start, (vm_size_t) rman_get_size(r));
251 		if (p == NULL)
252 			return (ENOMEM);
253 		rman_set_virtual(r, p);
254 		rman_set_bustag(r, &bs_be_tag);
255 		rman_set_bushandle(r, (u_long)p);
256 	}
257 	return (rman_activate_resource(r));
258 }
259 
260 static int
261 nexus_deactivate_resource(device_t bus __unused, device_t child __unused,
262     int type __unused, int rid __unused, struct resource *r)
263 {
264 
265 	/*
266 	 * If this is a memory resource, unmap it.
267 	 */
268 	if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) {
269 		bus_size_t psize;
270 
271 		psize = rman_get_size(r);
272 		pmap_unmapdev(rman_get_virtual(r), psize);
273 	}
274 
275 	return (rman_deactivate_resource(r));
276 }
277 
278 
279 static int
280 nexus_map_resource(device_t bus, device_t child, int type, struct resource *r,
281     struct resource_map_request *argsp, struct resource_map *map)
282 {
283 
284 	struct resource_map_request args;
285 	rman_res_t end, length, start;
286 
287 	/* Resources must be active to be mapped. */
288 	if (!(rman_get_flags(r) & RF_ACTIVE))
289 		return (ENXIO);
290 
291 	/* Mappings are only supported on I/O and memory resources. */
292 	switch (type) {
293 	case SYS_RES_IOPORT:
294 	case SYS_RES_MEMORY:
295 		break;
296 	default:
297 		return (EINVAL);
298 	}
299 
300 	resource_init_map_request(&args);
301 	if (argsp != NULL)
302 		bcopy(argsp, &args, imin(argsp->size, args.size));
303 
304 	start = rman_get_start(r) + args.offset;
305 	if (args.length == 0)
306 		length = rman_get_size(r);
307 	else
308 		length = args.length;
309 
310 	end = start + length - 1;
311 	if (start > rman_get_end(r) || start < rman_get_start(r))
312 		return (EINVAL);
313 
314 	if (end > rman_get_end(r) || end < start)
315 		return (EINVAL);
316 
317 	/*
318 	 * If this is a memory resource, map it into the kernel.
319 	 */
320 	switch (type) {
321 	case SYS_RES_IOPORT:
322 		panic("%s:%d SYS_RES_IOPORT handling not implemented", __func__, __LINE__);
323 		/*   XXX: untested
324 		map->r_bushandle = start;
325 		map->r_bustag = nexus_get_bus_tag(NULL, NULL);
326 		map->r_size = length;
327 		map->r_vaddr = NULL;
328 		*/
329 		break;
330 	case SYS_RES_MEMORY:
331 		map->r_vaddr = pmap_mapdev_attr(start, length, args.memattr);
332 		map->r_bustag = nexus_get_bus_tag(NULL, NULL);
333 		map->r_size = length;
334 		map->r_bushandle = (bus_space_handle_t)map->r_vaddr;
335 		break;
336 	}
337 
338 	return (0);
339 
340 }
341 
342 static int
343 nexus_unmap_resource(device_t bus, device_t child, int type, struct resource *r,
344     struct resource_map *map)
345 {
346 
347 	/*
348 	 * If this is a memory resource, unmap it.
349 	 */
350 	switch (type) {
351 	case SYS_RES_MEMORY:
352 		pmap_unmapdev(map->r_vaddr, map->r_size);
353 		/* FALLTHROUGH */
354 	case SYS_RES_IOPORT:
355 		break;
356 	default:
357 		return (EINVAL);
358 	}
359 
360 	return (0);
361 
362 }
363