xref: /freebsd/sys/dev/ofw/ofwbus.c (revision 864c53ead899f7838cd2e1cca3b485a4a82f5cdc)
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/param.h>
39 #include <sys/systm.h>
40 #include <sys/bus.h>
41 #include <sys/kernel.h>
42 #include <sys/malloc.h>
43 #include <sys/module.h>
44 #include <sys/pcpu.h>
45 #include <sys/rman.h>
46 
47 #include <vm/vm.h>
48 #include <vm/pmap.h>
49 
50 #include <dev/ofw/ofw_bus.h>
51 #include <dev/ofw/ofw_bus_subr.h>
52 #include <dev/ofw/openfirm.h>
53 
54 #include <machine/bus.h>
55 #include <machine/resource.h>
56 
57 /*
58  * The ofwbus (which is a pseudo-bus actually) iterates over the nodes that
59  * hang from the Open Firmware root node and adds them as devices to this bus
60  * (except some special nodes which are excluded) so that drivers can be
61  * attached to them.
62  *
63  */
64 
65 struct ofwbus_devinfo {
66 	struct ofw_bus_devinfo	ndi_obdinfo;
67 	struct resource_list	ndi_rl;
68 };
69 
70 struct ofwbus_softc {
71 	uint32_t	acells, scells;
72 	struct rman	sc_intr_rman;
73 	struct rman	sc_mem_rman;
74 };
75 
76 static device_identify_t ofwbus_identify;
77 static device_probe_t ofwbus_probe;
78 static device_attach_t ofwbus_attach;
79 static bus_print_child_t ofwbus_print_child;
80 static bus_add_child_t ofwbus_add_child;
81 static bus_probe_nomatch_t ofwbus_probe_nomatch;
82 static bus_alloc_resource_t ofwbus_alloc_resource;
83 static bus_adjust_resource_t ofwbus_adjust_resource;
84 static bus_release_resource_t ofwbus_release_resource;
85 static bus_get_resource_list_t ofwbus_get_resource_list;
86 static ofw_bus_get_devinfo_t ofwbus_get_devinfo;
87 
88 static int ofwbus_inlist(const char *, const char *const *);
89 static struct ofwbus_devinfo * ofwbus_setup_dinfo(device_t, phandle_t);
90 static void ofwbus_destroy_dinfo(struct ofwbus_devinfo *);
91 static int ofwbus_print_res(struct ofwbus_devinfo *);
92 
93 static device_method_t ofwbus_methods[] = {
94 	/* Device interface */
95 	DEVMETHOD(device_identify,	ofwbus_identify),
96 	DEVMETHOD(device_probe,		ofwbus_probe),
97 	DEVMETHOD(device_attach,	ofwbus_attach),
98 	DEVMETHOD(device_detach,	bus_generic_detach),
99 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
100 	DEVMETHOD(device_suspend,	bus_generic_suspend),
101 	DEVMETHOD(device_resume,	bus_generic_resume),
102 
103 	/* Bus interface */
104 	DEVMETHOD(bus_print_child,	ofwbus_print_child),
105 	DEVMETHOD(bus_probe_nomatch,	ofwbus_probe_nomatch),
106 	DEVMETHOD(bus_read_ivar,	bus_generic_read_ivar),
107 	DEVMETHOD(bus_write_ivar,	bus_generic_write_ivar),
108 	DEVMETHOD(bus_add_child,	ofwbus_add_child),
109 	DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
110 	DEVMETHOD(bus_alloc_resource,	ofwbus_alloc_resource),
111 	DEVMETHOD(bus_adjust_resource,	ofwbus_adjust_resource),
112 	DEVMETHOD(bus_release_resource,	ofwbus_release_resource),
113 	DEVMETHOD(bus_set_resource,	bus_generic_rl_set_resource),
114 	DEVMETHOD(bus_get_resource,	bus_generic_rl_get_resource),
115 	DEVMETHOD(bus_get_resource_list, ofwbus_get_resource_list),
116 	DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
117 	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
118 	DEVMETHOD(bus_config_intr,	bus_generic_config_intr),
119 	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
120 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
121 
122 	/* ofw_bus interface */
123 	DEVMETHOD(ofw_bus_get_devinfo,	ofwbus_get_devinfo),
124 	DEVMETHOD(ofw_bus_get_compat,	ofw_bus_gen_get_compat),
125 	DEVMETHOD(ofw_bus_get_model,	ofw_bus_gen_get_model),
126 	DEVMETHOD(ofw_bus_get_name,	ofw_bus_gen_get_name),
127 	DEVMETHOD(ofw_bus_get_node,	ofw_bus_gen_get_node),
128 	DEVMETHOD(ofw_bus_get_type,	ofw_bus_gen_get_type),
129 
130 	DEVMETHOD_END
131 };
132 
133 static driver_t ofwbus_driver = {
134 	"ofwbus",
135 	ofwbus_methods,
136 	sizeof(struct ofwbus_softc)
137 };
138 static devclass_t ofwbus_devclass;
139 DRIVER_MODULE(ofwbus, nexus, ofwbus_driver, ofwbus_devclass, 0, 0);
140 MODULE_VERSION(ofwbus, 1);
141 
142 static const char *const ofwbus_excl_name[] = {
143 	"FJSV,system",
144 	"aliases",
145 	"associations",
146 	"chosen",
147 	"cmp",
148 	"counter-timer",	/* No separate device; handled by psycho/sbus */
149 	"failsafe",
150 	"memory",
151 	"openprom",
152 	"options",
153 	"packages",
154 	"physical-memory",
155 	"rsc",
156 	"sgcn",
157 	"todsg",
158 	"virtual-memory",
159 	NULL
160 };
161 
162 static const char *const ofwbus_excl_type[] = {
163 	"core",
164 	"cpu",
165 	NULL
166 };
167 
168 static int
169 ofwbus_inlist(const char *name, const char *const *list)
170 {
171 	int i;
172 
173 	if (name == NULL)
174 		return (0);
175 	for (i = 0; list[i] != NULL; i++)
176 		if (strcmp(name, list[i]) == 0)
177 			return (1);
178 	return (0);
179 }
180 
181 #define	OFWBUS_EXCLUDED(name, type)					\
182 	(ofwbus_inlist((name), ofwbus_excl_name) ||			\
183 	((type) != NULL && ofwbus_inlist((type), ofwbus_excl_type)))
184 
185 static void
186 ofwbus_identify(driver_t *driver, device_t parent)
187 {
188 
189 	/* Check if Open Firmware has been instantiated */
190 	if (OF_peer(0) == 0)
191 		return;
192 
193 	if (device_find_child(parent, "ofwbus", -1) == NULL)
194 		BUS_ADD_CHILD(parent, 0, "ofwbus", -1);
195 }
196 
197 static int
198 ofwbus_probe(device_t dev)
199 {
200 
201 	device_set_desc(dev, "Open Firmware Device Tree");
202 	return (BUS_PROBE_NOWILDCARD);
203 }
204 
205 static int
206 ofwbus_attach(device_t dev)
207 {
208 	struct ofwbus_devinfo *ndi;
209 	struct ofwbus_softc *sc;
210 	device_t cdev;
211 	phandle_t node;
212 
213 	sc = device_get_softc(dev);
214 
215 	node = OF_peer(0);
216 
217 	/*
218 	 * If no Open Firmware, bail early
219 	 */
220 	if (node == -1)
221 		return (ENXIO);
222 
223 	sc->sc_intr_rman.rm_type = RMAN_ARRAY;
224 	sc->sc_intr_rman.rm_descr = "Interrupts";
225 	sc->sc_mem_rman.rm_type = RMAN_ARRAY;
226 	sc->sc_mem_rman.rm_descr = "Device Memory";
227 	if (rman_init(&sc->sc_intr_rman) != 0 ||
228 	    rman_init(&sc->sc_mem_rman) != 0 ||
229 	    rman_manage_region(&sc->sc_intr_rman, 0, ~0) != 0 ||
230 	    rman_manage_region(&sc->sc_mem_rman, 0, BUS_SPACE_MAXADDR) != 0)
231 		panic("%s: failed to set up rmans.", __func__);
232 
233 	/*
234 	 * Allow devices to identify.
235 	 */
236 	bus_generic_probe(dev);
237 
238 	/*
239 	 * Some important numbers
240 	 */
241 	sc->acells = 2;
242 	OF_getencprop(node, "#address-cells", &sc->acells, sizeof(sc->acells));
243 	sc->scells = 1;
244 	OF_getencprop(node, "#size-cells", &sc->scells, sizeof(sc->scells));
245 
246 	/*
247 	 * Now walk the OFW tree and attach top-level devices.
248 	 */
249 	for (node = OF_child(node); node > 0; node = OF_peer(node)) {
250 		if ((ndi = ofwbus_setup_dinfo(dev, node)) == NULL)
251 			continue;
252 		cdev = device_add_child(dev, NULL, -1);
253 		if (cdev == NULL) {
254 			device_printf(dev, "<%s>: device_add_child failed\n",
255 			    ndi->ndi_obdinfo.obd_name);
256 			ofwbus_destroy_dinfo(ndi);
257 			continue;
258 		}
259 		device_set_ivars(cdev, ndi);
260 	}
261 	return (bus_generic_attach(dev));
262 }
263 
264 static device_t
265 ofwbus_add_child(device_t dev, u_int order, const char *name, int unit)
266 {
267 	device_t cdev;
268 	struct ofwbus_devinfo *ndi;
269 
270 	cdev = device_add_child_ordered(dev, order, name, unit);
271 	if (cdev == NULL)
272 		return (NULL);
273 
274 	ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
275 	ndi->ndi_obdinfo.obd_node = -1;
276 	resource_list_init(&ndi->ndi_rl);
277 	device_set_ivars(cdev, ndi);
278 
279 	return (cdev);
280 }
281 
282 static int
283 ofwbus_print_child(device_t bus, device_t child)
284 {
285 	int rv;
286 
287 	rv = bus_print_child_header(bus, child);
288 	rv += ofwbus_print_res(device_get_ivars(child));
289 	rv += bus_print_child_footer(bus, child);
290 	return (rv);
291 }
292 
293 static void
294 ofwbus_probe_nomatch(device_t bus, device_t child)
295 {
296 	const char *name, *type;
297 
298 	if (!bootverbose)
299 		return;
300 
301 	name = ofw_bus_get_name(child);
302 	type = ofw_bus_get_type(child);
303 
304 	device_printf(bus, "<%s>",
305 	    name != NULL ? name : "unknown");
306 	ofwbus_print_res(device_get_ivars(child));
307 	printf(" type %s (no driver attached)\n",
308 	    type != NULL ? type : "unknown");
309 }
310 
311 static struct resource *
312 ofwbus_alloc_resource(device_t bus, device_t child, int type, int *rid,
313     u_long start, u_long end, u_long count, u_int flags)
314 {
315 	struct ofwbus_softc *sc;
316 	struct rman *rm;
317 	struct resource *rv;
318 	struct resource_list_entry *rle;
319 	int isdefault, passthrough;
320 
321 	isdefault = (start == 0UL && end == ~0UL);
322 	passthrough = (device_get_parent(child) != bus);
323 	sc = device_get_softc(bus);
324 	rle = NULL;
325 
326 	if (!passthrough && isdefault) {
327 		rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child),
328 		    type, *rid);
329 		if (rle == NULL)
330 			return (NULL);
331 		if (rle->res != NULL)
332 			panic("%s: resource entry is busy", __func__);
333 		start = rle->start;
334 		count = ulmax(count, rle->count);
335 		end = ulmax(rle->end, start + count - 1);
336 	}
337 
338 	switch (type) {
339 	case SYS_RES_IRQ:
340 		rm = &sc->sc_intr_rman;
341 		break;
342 	case SYS_RES_MEMORY:
343 		rm = &sc->sc_mem_rman;
344 		break;
345 	default:
346 		return (NULL);
347 	}
348 
349 	rv = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
350 	    child);
351 	if (rv == NULL)
352 		return (NULL);
353 	rman_set_rid(rv, *rid);
354 
355 	if ((flags & RF_ACTIVE) != 0 && bus_activate_resource(child, type,
356 	    *rid, rv) != 0) {
357 		rman_release_resource(rv);
358 		return (NULL);
359 	}
360 
361 	if (!passthrough && rle != NULL) {
362 		rle->res = rv;
363 		rle->start = rman_get_start(rv);
364 		rle->end = rman_get_end(rv);
365 		rle->count = rle->end - rle->start + 1;
366 	}
367 
368 	return (rv);
369 }
370 
371 static int
372 ofwbus_adjust_resource(device_t bus, device_t child __unused, int type,
373     struct resource *r, u_long start, u_long end)
374 {
375 	struct ofwbus_softc *sc;
376 	struct rman *rm;
377 	device_t ofwbus;
378 
379 	ofwbus = bus;
380 	while (strcmp(device_get_name(device_get_parent(ofwbus)), "root") != 0)
381 		ofwbus = device_get_parent(ofwbus);
382 	sc = device_get_softc(ofwbus);
383 	switch (type) {
384 	case SYS_RES_IRQ:
385 		rm = &sc->sc_intr_rman;
386 		break;
387 	case SYS_RES_MEMORY:
388 		rm = &sc->sc_mem_rman;
389 		break;
390 	default:
391 		return (EINVAL);
392 	}
393 	if (rm == NULL)
394 		return (ENXIO);
395 	if (rman_is_region_manager(r, rm) == 0)
396 		return (EINVAL);
397 	return (rman_adjust_resource(r, start, end));
398 }
399 
400 static int
401 ofwbus_release_resource(device_t bus __unused, device_t child, int type,
402     int rid, struct resource *r)
403 {
404 	int error;
405 
406 	if ((rman_get_flags(r) & RF_ACTIVE) != 0) {
407 		error = bus_deactivate_resource(child, type, rid, r);
408 		if (error)
409 			return (error);
410 	}
411 	return (rman_release_resource(r));
412 }
413 
414 static struct resource_list *
415 ofwbus_get_resource_list(device_t bus __unused, device_t child)
416 {
417 	struct ofwbus_devinfo *ndi;
418 
419 	ndi = device_get_ivars(child);
420 	return (&ndi->ndi_rl);
421 }
422 
423 static const struct ofw_bus_devinfo *
424 ofwbus_get_devinfo(device_t bus __unused, device_t child)
425 {
426 	struct ofwbus_devinfo *ndi;
427 
428 	ndi = device_get_ivars(child);
429 	return (&ndi->ndi_obdinfo);
430 }
431 
432 static struct ofwbus_devinfo *
433 ofwbus_setup_dinfo(device_t dev, phandle_t node)
434 {
435 	struct ofwbus_softc *sc;
436 	struct ofwbus_devinfo *ndi;
437 	uint32_t *reg, *intr, icells;
438 	uint64_t phys, size;
439 	phandle_t iparent;
440 	int i, j;
441 	int nintr;
442 	int nreg;
443 
444 	sc = device_get_softc(dev);
445 
446 	ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
447 	if (ofw_bus_gen_setup_devinfo(&ndi->ndi_obdinfo, node) != 0) {
448 		free(ndi, M_DEVBUF);
449 		return (NULL);
450 	}
451 	if (OFWBUS_EXCLUDED(ndi->ndi_obdinfo.obd_name,
452 	    ndi->ndi_obdinfo.obd_type)) {
453 		ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo);
454 		free(ndi, M_DEVBUF);
455 		return (NULL);
456 	}
457 
458 	resource_list_init(&ndi->ndi_rl);
459 	nreg = OF_getencprop_alloc(node, "reg", sizeof(*reg), (void **)&reg);
460 	if (nreg == -1)
461 		nreg = 0;
462 	if (nreg % (sc->acells + sc->scells) != 0) {
463 		if (bootverbose)
464 			device_printf(dev, "Malformed reg property on <%s>\n",
465 			    ndi->ndi_obdinfo.obd_name);
466 		nreg = 0;
467 	}
468 
469 	for (i = 0; i < nreg; i += sc->acells + sc->scells) {
470 		phys = size = 0;
471 		for (j = 0; j < sc->acells; j++) {
472 			phys <<= 32;
473 			phys |= reg[i + j];
474 		}
475 		for (j = 0; j < sc->scells; j++) {
476 			size <<= 32;
477 			size |= reg[i + sc->acells + j];
478 		}
479 		/* Skip the dummy reg property of glue devices like ssm(4). */
480 		if (size != 0)
481 			resource_list_add(&ndi->ndi_rl, SYS_RES_MEMORY, i,
482 			    phys, phys + size - 1, size);
483 	}
484 	free(reg, M_OFWPROP);
485 
486 	nintr = OF_getencprop_alloc(node, "interrupts",  sizeof(*intr),
487 	    (void **)&intr);
488 	if (nintr > 0) {
489 		iparent = 0;
490 		OF_searchencprop(node, "interrupt-parent", &iparent,
491 		    sizeof(iparent));
492 		OF_searchencprop(OF_xref_phandle(iparent), "#interrupt-cells",
493 		    &icells, sizeof(icells));
494 		for (i = 0; i < nintr; i+= icells) {
495 			intr[i] = ofw_bus_map_intr(dev, iparent, icells,
496 			    &intr[i]);
497 			resource_list_add(&ndi->ndi_rl, SYS_RES_IRQ, i, intr[i],
498 			    intr[i], 1);
499 		}
500 		free(intr, M_OFWPROP);
501 	}
502 
503 	return (ndi);
504 }
505 
506 static void
507 ofwbus_destroy_dinfo(struct ofwbus_devinfo *ndi)
508 {
509 
510 	resource_list_free(&ndi->ndi_rl);
511 	ofw_bus_gen_destroy_devinfo(&ndi->ndi_obdinfo);
512 	free(ndi, M_DEVBUF);
513 }
514 
515 static int
516 ofwbus_print_res(struct ofwbus_devinfo *ndi)
517 {
518 	int rv;
519 
520 	rv = 0;
521 	rv += resource_list_print_type(&ndi->ndi_rl, "mem", SYS_RES_MEMORY,
522 	    "%#lx");
523 	rv += resource_list_print_type(&ndi->ndi_rl, "irq", SYS_RES_IRQ,
524 	    "%ld");
525 	return (rv);
526 }
527 
528