xref: /freebsd/sys/dev/fdt/simplebus.c (revision 4b9d6057)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2013 Nathan Whitehorn
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/module.h>
32 #include <sys/bus.h>
33 #include <sys/conf.h>
34 #include <sys/kernel.h>
35 #include <sys/rman.h>
36 
37 #include <dev/ofw/openfirm.h>
38 #include <dev/ofw/ofw_bus.h>
39 #include <dev/ofw/ofw_bus_subr.h>
40 
41 #include <dev/fdt/simplebus.h>
42 
43 /*
44  * Bus interface.
45  */
46 static int		simplebus_probe(device_t dev);
47 static struct resource *simplebus_alloc_resource(device_t, device_t, int,
48     int *, rman_res_t, rman_res_t, rman_res_t, u_int);
49 static void		simplebus_probe_nomatch(device_t bus, device_t child);
50 static int		simplebus_print_child(device_t bus, device_t child);
51 static device_t		simplebus_add_child(device_t dev, u_int order,
52     const char *name, int unit);
53 static struct resource_list *simplebus_get_resource_list(device_t bus,
54     device_t child);
55 
56 static ssize_t		simplebus_get_property(device_t bus, device_t child,
57     const char *propname, void *propvalue, size_t size,
58     device_property_type_t type);
59 /*
60  * ofw_bus interface
61  */
62 static const struct ofw_bus_devinfo *simplebus_get_devinfo(device_t bus,
63     device_t child);
64 
65 /*
66  * Driver methods.
67  */
68 static device_method_t	simplebus_methods[] = {
69 	/* Device interface */
70 	DEVMETHOD(device_probe,		simplebus_probe),
71 	DEVMETHOD(device_attach,	simplebus_attach),
72 	DEVMETHOD(device_detach,	simplebus_detach),
73 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
74 	DEVMETHOD(device_suspend,	bus_generic_suspend),
75 	DEVMETHOD(device_resume,	bus_generic_resume),
76 
77 	/* Bus interface */
78 	DEVMETHOD(bus_add_child,	simplebus_add_child),
79 	DEVMETHOD(bus_print_child,	simplebus_print_child),
80 	DEVMETHOD(bus_probe_nomatch,	simplebus_probe_nomatch),
81 	DEVMETHOD(bus_read_ivar,	bus_generic_read_ivar),
82 	DEVMETHOD(bus_write_ivar,	bus_generic_write_ivar),
83 	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
84 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
85 	DEVMETHOD(bus_alloc_resource,	simplebus_alloc_resource),
86 	DEVMETHOD(bus_release_resource,	bus_generic_release_resource),
87 	DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
88 	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
89 	DEVMETHOD(bus_adjust_resource,	bus_generic_adjust_resource),
90 	DEVMETHOD(bus_set_resource,	bus_generic_rl_set_resource),
91 	DEVMETHOD(bus_get_resource,	bus_generic_rl_get_resource),
92 	DEVMETHOD(bus_child_pnpinfo,	ofw_bus_gen_child_pnpinfo),
93 	DEVMETHOD(bus_get_resource_list, simplebus_get_resource_list),
94 	DEVMETHOD(bus_get_property,	simplebus_get_property),
95 	DEVMETHOD(bus_get_device_path,  ofw_bus_gen_get_device_path),
96 
97 	/* ofw_bus interface */
98 	DEVMETHOD(ofw_bus_get_devinfo,	simplebus_get_devinfo),
99 	DEVMETHOD(ofw_bus_get_compat,	ofw_bus_gen_get_compat),
100 	DEVMETHOD(ofw_bus_get_model,	ofw_bus_gen_get_model),
101 	DEVMETHOD(ofw_bus_get_name,	ofw_bus_gen_get_name),
102 	DEVMETHOD(ofw_bus_get_node,	ofw_bus_gen_get_node),
103 	DEVMETHOD(ofw_bus_get_type,	ofw_bus_gen_get_type),
104 
105 	DEVMETHOD_END
106 };
107 
108 DEFINE_CLASS_0(simplebus, simplebus_driver, simplebus_methods,
109     sizeof(struct simplebus_softc));
110 
111 EARLY_DRIVER_MODULE(simplebus, ofwbus, simplebus_driver, 0, 0, BUS_PASS_BUS);
112 EARLY_DRIVER_MODULE(simplebus, simplebus, simplebus_driver, 0, 0,
113     BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
114 
115 static int
116 simplebus_probe(device_t dev)
117 {
118 
119 	if (!ofw_bus_status_okay(dev))
120 		return (ENXIO);
121 	/*
122 	 * XXX We should attach only to pure' compatible = "simple-bus"',
123 	 * without any other compatible string.
124 	 * For now, filter only know cases:
125 	 * "syscon", "simple-bus"; is handled by fdt/syscon driver
126 	 * "simple-mfd", "simple-bus"; is handled by fdt/simple-mfd driver
127 	 */
128 	if (ofw_bus_is_compatible(dev, "syscon") ||
129 	    ofw_bus_is_compatible(dev, "simple-mfd"))
130 		return (ENXIO);
131 
132 	/*
133 	 * FDT data puts a "simple-bus" compatible string on many things that
134 	 * have children but aren't really buses in our world.  Without a
135 	 * ranges property we will fail to attach, so just fail to probe too.
136 	 */
137 	if (!(ofw_bus_is_compatible(dev, "simple-bus") &&
138 	    ofw_bus_has_prop(dev, "ranges")) &&
139 	    (ofw_bus_get_type(dev) == NULL || strcmp(ofw_bus_get_type(dev),
140 	     "soc") != 0))
141 		return (ENXIO);
142 
143 	device_set_desc(dev, "Flattened device tree simple bus");
144 
145 	return (BUS_PROBE_GENERIC);
146 }
147 
148 int
149 simplebus_attach_impl(device_t dev)
150 {
151 	struct		simplebus_softc *sc;
152 	phandle_t	node;
153 
154 	sc = device_get_softc(dev);
155 	simplebus_init(dev, 0);
156 	if ((sc->flags & SB_FLAG_NO_RANGES) == 0 &&
157 	    simplebus_fill_ranges(sc->node, sc) < 0) {
158 		device_printf(dev, "could not get ranges\n");
159 		return (ENXIO);
160 	}
161 
162 	/*
163 	 * In principle, simplebus could have an interrupt map, but ignore that
164 	 * for now
165 	 */
166 
167 	for (node = OF_child(sc->node); node > 0; node = OF_peer(node))
168 		simplebus_add_device(dev, node, 0, NULL, -1, NULL);
169 
170 	return (0);
171 }
172 
173 int
174 simplebus_attach(device_t dev)
175 {
176 	int	rv;
177 
178 	rv = simplebus_attach_impl(dev);
179 	if (rv != 0)
180 		return (rv);
181 
182 	return (bus_generic_attach(dev));
183 }
184 
185 int
186 simplebus_detach(device_t dev)
187 {
188 	struct		simplebus_softc *sc;
189 
190 	sc = device_get_softc(dev);
191 	if (sc->ranges != NULL)
192 		free(sc->ranges, M_DEVBUF);
193 
194 	return (bus_generic_detach(dev));
195 }
196 
197 void
198 simplebus_init(device_t dev, phandle_t node)
199 {
200 	struct simplebus_softc *sc;
201 
202 	sc = device_get_softc(dev);
203 	if (node == 0)
204 		node = ofw_bus_get_node(dev);
205 	sc->dev = dev;
206 	sc->node = node;
207 
208 	/*
209 	 * Some important numbers
210 	 */
211 	sc->acells = 2;
212 	OF_getencprop(node, "#address-cells", &sc->acells, sizeof(sc->acells));
213 	sc->scells = 1;
214 	OF_getencprop(node, "#size-cells", &sc->scells, sizeof(sc->scells));
215 }
216 
217 int
218 simplebus_fill_ranges(phandle_t node, struct simplebus_softc *sc)
219 {
220 	int host_address_cells;
221 	cell_t *base_ranges;
222 	ssize_t nbase_ranges;
223 	int err;
224 	int i, j, k;
225 
226 	err = OF_searchencprop(OF_parent(node), "#address-cells",
227 	    &host_address_cells, sizeof(host_address_cells));
228 	if (err <= 0)
229 		return (-1);
230 
231 	nbase_ranges = OF_getproplen(node, "ranges");
232 	if (nbase_ranges < 0)
233 		return (-1);
234 	sc->nranges = nbase_ranges / sizeof(cell_t) /
235 	    (sc->acells + host_address_cells + sc->scells);
236 	if (sc->nranges == 0)
237 		return (0);
238 
239 	sc->ranges = malloc(sc->nranges * sizeof(sc->ranges[0]),
240 	    M_DEVBUF, M_WAITOK);
241 	base_ranges = malloc(nbase_ranges, M_DEVBUF, M_WAITOK);
242 	OF_getencprop(node, "ranges", base_ranges, nbase_ranges);
243 
244 	for (i = 0, j = 0; i < sc->nranges; i++) {
245 		sc->ranges[i].bus = 0;
246 		for (k = 0; k < sc->acells; k++) {
247 			sc->ranges[i].bus <<= 32;
248 			sc->ranges[i].bus |= base_ranges[j++];
249 		}
250 		sc->ranges[i].host = 0;
251 		for (k = 0; k < host_address_cells; k++) {
252 			sc->ranges[i].host <<= 32;
253 			sc->ranges[i].host |= base_ranges[j++];
254 		}
255 		sc->ranges[i].size = 0;
256 		for (k = 0; k < sc->scells; k++) {
257 			sc->ranges[i].size <<= 32;
258 			sc->ranges[i].size |= base_ranges[j++];
259 		}
260 	}
261 
262 	free(base_ranges, M_DEVBUF);
263 	return (sc->nranges);
264 }
265 
266 struct simplebus_devinfo *
267 simplebus_setup_dinfo(device_t dev, phandle_t node,
268     struct simplebus_devinfo *di)
269 {
270 	struct simplebus_softc *sc;
271 	struct simplebus_devinfo *ndi;
272 
273 	sc = device_get_softc(dev);
274 	if (di == NULL)
275 		ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
276 	else
277 		ndi = di;
278 	if (ofw_bus_gen_setup_devinfo(&ndi->obdinfo, node) != 0) {
279 		if (di == NULL)
280 			free(ndi, M_DEVBUF);
281 		return (NULL);
282 	}
283 
284 	resource_list_init(&ndi->rl);
285 	ofw_bus_reg_to_rl(dev, node, sc->acells, sc->scells, &ndi->rl);
286 	ofw_bus_intr_to_rl(dev, node, &ndi->rl, NULL);
287 
288 	return (ndi);
289 }
290 
291 device_t
292 simplebus_add_device(device_t dev, phandle_t node, u_int order,
293     const char *name, int unit, struct simplebus_devinfo *di)
294 {
295 	struct simplebus_devinfo *ndi;
296 	device_t cdev;
297 
298 	if ((ndi = simplebus_setup_dinfo(dev, node, di)) == NULL)
299 		return (NULL);
300 	cdev = device_add_child_ordered(dev, order, name, unit);
301 	if (cdev == NULL) {
302 		device_printf(dev, "<%s>: device_add_child failed\n",
303 		    ndi->obdinfo.obd_name);
304 		resource_list_free(&ndi->rl);
305 		ofw_bus_gen_destroy_devinfo(&ndi->obdinfo);
306 		if (di == NULL)
307 			free(ndi, M_DEVBUF);
308 		return (NULL);
309 	}
310 	device_set_ivars(cdev, ndi);
311 
312 	return(cdev);
313 }
314 
315 static device_t
316 simplebus_add_child(device_t dev, u_int order, const char *name, int unit)
317 {
318 	device_t cdev;
319 	struct simplebus_devinfo *ndi;
320 
321 	cdev = device_add_child_ordered(dev, order, name, unit);
322 	if (cdev == NULL)
323 		return (NULL);
324 
325 	ndi = malloc(sizeof(*ndi), M_DEVBUF, M_WAITOK | M_ZERO);
326 	ndi->obdinfo.obd_node = -1;
327 	resource_list_init(&ndi->rl);
328 	device_set_ivars(cdev, ndi);
329 
330 	return (cdev);
331 }
332 
333 static const struct ofw_bus_devinfo *
334 simplebus_get_devinfo(device_t bus __unused, device_t child)
335 {
336         struct simplebus_devinfo *ndi;
337 
338         ndi = device_get_ivars(child);
339 	if (ndi == NULL)
340 		return (NULL);
341         return (&ndi->obdinfo);
342 }
343 
344 static struct resource_list *
345 simplebus_get_resource_list(device_t bus __unused, device_t child)
346 {
347 	struct simplebus_devinfo *ndi;
348 
349 	ndi = device_get_ivars(child);
350 	if (ndi == NULL)
351 		return (NULL);
352 	return (&ndi->rl);
353 }
354 
355 static ssize_t
356 simplebus_get_property(device_t bus, device_t child, const char *propname,
357     void *propvalue, size_t size, device_property_type_t type)
358 {
359 	phandle_t node, xref;
360 	ssize_t ret, i;
361 	uint32_t *buffer;
362 	uint64_t val;
363 
364 	switch (type) {
365 	case DEVICE_PROP_ANY:
366 	case DEVICE_PROP_BUFFER:
367 	case DEVICE_PROP_UINT32:
368 	case DEVICE_PROP_UINT64:
369 	case DEVICE_PROP_HANDLE:
370 		break;
371 	default:
372 		return (-1);
373 	}
374 
375 	node = ofw_bus_get_node(child);
376 	if (propvalue == NULL || size == 0)
377 		return (OF_getproplen(node, propname));
378 
379 	/*
380 	 * Integer values are stored in BE format.
381 	 * If caller declared that the underlying property type is uint32_t
382 	 * we need to do the conversion to match host endianness.
383 	 */
384 	if (type == DEVICE_PROP_UINT32)
385 		return (OF_getencprop(node, propname, propvalue, size));
386 
387 	/*
388 	 * uint64_t also requires endianness handling.
389 	 * In FDT every 8 byte value is stored using two uint32_t variables
390 	 * in BE format. Now, since the upper bits are stored as the first
391 	 * of the pair, both halves require swapping.
392 	 */
393 	 if (type == DEVICE_PROP_UINT64) {
394 		ret = OF_getencprop(node, propname, propvalue, size);
395 		if (ret <= 0) {
396 			return (ret);
397 		}
398 
399 		buffer = (uint32_t *)propvalue;
400 
401 		for (i = 0; i < size / 4; i += 2) {
402 			val = (uint64_t)buffer[i] << 32 | buffer[i + 1];
403 			((uint64_t *)buffer)[i / 2] = val;
404 		}
405 		return (ret);
406 	}
407 
408 	if (type == DEVICE_PROP_HANDLE) {
409 		if (size < sizeof(node))
410 			return (-1);
411 		ret = OF_getencprop(node, propname, &xref, sizeof(xref));
412 		if (ret <= 0)
413 			return (ret);
414 
415 		node = OF_node_from_xref(xref);
416 		if (propvalue != NULL)
417 			*(uint32_t *)propvalue = node;
418 		return (ret);
419 	}
420 
421 	return (OF_getprop(node, propname, propvalue, size));
422 }
423 
424 static struct resource *
425 simplebus_alloc_resource(device_t bus, device_t child, int type, int *rid,
426     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
427 {
428 	struct simplebus_softc *sc;
429 	struct simplebus_devinfo *di;
430 	struct resource_list_entry *rle;
431 	int j;
432 
433 	sc = device_get_softc(bus);
434 
435 	/*
436 	 * Request for the default allocation with a given rid: use resource
437 	 * list stored in the local device info.
438 	 */
439 	if (RMAN_IS_DEFAULT_RANGE(start, end)) {
440 		if ((di = device_get_ivars(child)) == NULL)
441 			return (NULL);
442 
443 		if (type == SYS_RES_IOPORT)
444 			type = SYS_RES_MEMORY;
445 
446 		rle = resource_list_find(&di->rl, type, *rid);
447 		if (rle == NULL) {
448 			if (bootverbose)
449 				device_printf(bus, "no default resources for "
450 				    "rid = %d, type = %d\n", *rid, type);
451 			return (NULL);
452 		}
453 		start = rle->start;
454 		end = rle->end;
455 		count = rle->count;
456         }
457 
458 	if (type == SYS_RES_MEMORY) {
459 		/* Remap through ranges property */
460 		for (j = 0; j < sc->nranges; j++) {
461 			if (start >= sc->ranges[j].bus && end <
462 			    sc->ranges[j].bus + sc->ranges[j].size) {
463 				start -= sc->ranges[j].bus;
464 				start += sc->ranges[j].host;
465 				end -= sc->ranges[j].bus;
466 				end += sc->ranges[j].host;
467 				break;
468 			}
469 		}
470 		if (j == sc->nranges && sc->nranges != 0) {
471 			if (bootverbose)
472 				device_printf(bus, "Could not map resource "
473 				    "%#jx-%#jx\n", start, end);
474 
475 			return (NULL);
476 		}
477 	}
478 
479 	return (bus_generic_alloc_resource(bus, child, type, rid, start, end,
480 	    count, flags));
481 }
482 
483 static int
484 simplebus_print_res(struct simplebus_devinfo *di)
485 {
486 	int rv;
487 
488 	if (di == NULL)
489 		return (0);
490 	rv = 0;
491 	rv += resource_list_print_type(&di->rl, "mem", SYS_RES_MEMORY, "%#jx");
492 	rv += resource_list_print_type(&di->rl, "irq", SYS_RES_IRQ, "%jd");
493 	return (rv);
494 }
495 
496 static void
497 simplebus_probe_nomatch(device_t bus, device_t child)
498 {
499 	const char *name, *type, *compat;
500 
501 	if (!bootverbose)
502 		return;
503 
504 	compat = ofw_bus_get_compat(child);
505 	if (compat == NULL)
506 		return;
507 	name = ofw_bus_get_name(child);
508 	type = ofw_bus_get_type(child);
509 
510 	device_printf(bus, "<%s>", name != NULL ? name : "unknown");
511 	simplebus_print_res(device_get_ivars(child));
512 	if (!ofw_bus_status_okay(child))
513 		printf(" disabled");
514 	if (type)
515 		printf(" type %s", type);
516 	printf(" compat %s (no driver attached)\n", compat);
517 }
518 
519 static int
520 simplebus_print_child(device_t bus, device_t child)
521 {
522 	int rv;
523 
524 	rv = bus_print_child_header(bus, child);
525 	rv += simplebus_print_res(device_get_ivars(child));
526 	if (!ofw_bus_status_okay(child))
527 		rv += printf(" disabled");
528 	rv += bus_print_child_footer(bus, child);
529 	return (rv);
530 }
531