xref: /freebsd/sys/dev/fdt/simplebus.c (revision b1866dfea3f3f142697f8e325db49b8e668fba35)
1 /*-
2  * Copyright (c) 2009-2010 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * This software was developed by Semihalf under sponsorship from
6  * the FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include "opt_platform.h"
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/ktr.h>
37 #include <sys/kernel.h>
38 #include <sys/module.h>
39 #include <sys/bus.h>
40 #include <sys/rman.h>
41 #include <sys/malloc.h>
42 
43 #include <machine/fdt.h>
44 
45 #include <dev/ofw/ofw_bus.h>
46 #include <dev/ofw/ofw_bus_subr.h>
47 #include <dev/ofw/openfirm.h>
48 
49 #include "fdt_common.h"
50 #include "ofw_bus_if.h"
51 
52 #ifdef DEBUG
53 #define debugf(fmt, args...) do { printf("%s(): ", __func__);	\
54     printf(fmt,##args); } while (0)
55 #else
56 #define debugf(fmt, args...)
57 #endif
58 
59 static MALLOC_DEFINE(M_SIMPLEBUS, "simplebus", "simplebus devices information");
60 
61 struct simplebus_softc {
62 	int	sc_addr_cells;
63 	int	sc_size_cells;
64 	u_long	sc_start_pa;
65 	u_long	sc_start_va;
66 	u_long	sc_size;
67 };
68 
69 struct simplebus_devinfo {
70 	struct ofw_bus_devinfo	di_ofw;
71 	struct resource_list	di_res;
72 
73 	/* Interrupts sense-level info for this device */
74 	struct fdt_sense_level	di_intr_sl[DI_MAX_INTR_NUM];
75 };
76 
77 /*
78  * Prototypes.
79  */
80 static int simplebus_probe(device_t);
81 static int simplebus_attach(device_t);
82 
83 static int simplebus_print_child(device_t, device_t);
84 static int simplebus_setup_intr(device_t, device_t, struct resource *, int,
85     driver_filter_t *, driver_intr_t *, void *, void **);
86 
87 static struct resource *simplebus_alloc_resource(device_t, device_t, int,
88     int *, u_long, u_long, u_long, u_int);
89 static struct resource_list *simplebus_get_resource_list(device_t, device_t);
90 
91 static ofw_bus_get_devinfo_t simplebus_get_devinfo;
92 
93 /*
94  * Bus interface definition.
95  */
96 static device_method_t simplebus_methods[] = {
97 	/* Device interface */
98 	DEVMETHOD(device_probe,		simplebus_probe),
99 	DEVMETHOD(device_attach,	simplebus_attach),
100 	DEVMETHOD(device_detach,	bus_generic_detach),
101 	DEVMETHOD(device_shutdown,	bus_generic_shutdown),
102 	DEVMETHOD(device_suspend,	bus_generic_suspend),
103 	DEVMETHOD(device_resume,	bus_generic_resume),
104 
105 	/* Bus interface */
106 	DEVMETHOD(bus_print_child,	simplebus_print_child),
107 	DEVMETHOD(bus_alloc_resource,	simplebus_alloc_resource),
108 	DEVMETHOD(bus_release_resource,	bus_generic_release_resource),
109 	DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
110 	DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
111 	DEVMETHOD(bus_setup_intr,	simplebus_setup_intr),
112 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
113 	DEVMETHOD(bus_get_resource_list, simplebus_get_resource_list),
114 
115 	/* OFW bus interface */
116 	DEVMETHOD(ofw_bus_get_devinfo,	simplebus_get_devinfo),
117 	DEVMETHOD(ofw_bus_get_compat,	ofw_bus_gen_get_compat),
118 	DEVMETHOD(ofw_bus_get_model,	ofw_bus_gen_get_model),
119 	DEVMETHOD(ofw_bus_get_name,	ofw_bus_gen_get_name),
120 	DEVMETHOD(ofw_bus_get_node,	ofw_bus_gen_get_node),
121 	DEVMETHOD(ofw_bus_get_type,	ofw_bus_gen_get_type),
122 
123 	{ 0, 0 }
124 };
125 
126 static driver_t simplebus_driver = {
127 	"simplebus",
128 	simplebus_methods,
129 	sizeof(struct simplebus_softc)
130 };
131 
132 devclass_t simplebus_devclass;
133 
134 DRIVER_MODULE(simplebus, fdtbus, simplebus_driver, simplebus_devclass, 0, 0);
135 
136 static int
137 simplebus_probe(device_t dev)
138 {
139 
140 	if (!ofw_bus_is_compatible_strict(dev, "simple-bus"))
141 		return (ENXIO);
142 
143 	device_set_desc(dev, "Flattened device tree simple bus");
144 
145 	return (BUS_PROBE_DEFAULT);
146 }
147 
148 static int
149 simplebus_attach(device_t dev)
150 {
151 	device_t dev_child;
152 	struct simplebus_devinfo *di;
153 	struct simplebus_softc *sc;
154 	phandle_t dt_node, dt_child;
155 
156 	sc = device_get_softc(dev);
157 
158 	sc->sc_start_pa = fdt_immr_pa;
159 	sc->sc_start_va = fdt_immr_va;
160 	sc->sc_size = fdt_immr_size;
161 
162 	/*
163 	 * Walk simple-bus and add direct subordinates as our children.
164 	 */
165 	dt_node = ofw_bus_get_node(dev);
166 	for (dt_child = OF_child(dt_node); dt_child != 0;
167 	    dt_child = OF_peer(dt_child)) {
168 
169 		/* Check and process 'status' property. */
170 		if (!(fdt_is_enabled(dt_child)))
171 			continue;
172 
173 		if (!(fdt_pm_is_enabled(dt_child)))
174 			continue;
175 
176 		di = malloc(sizeof(*di), M_SIMPLEBUS, M_WAITOK | M_ZERO);
177 
178 		if (ofw_bus_gen_setup_devinfo(&di->di_ofw, dt_child) != 0) {
179 			free(di, M_SIMPLEBUS);
180 			device_printf(dev, "could not set up devinfo\n");
181 			continue;
182 		}
183 
184 		resource_list_init(&di->di_res);
185 
186 		if (fdt_reg_to_rl(dt_child, &di->di_res, sc->sc_start_va)) {
187 			device_printf(dev, "%s: could not process 'reg' "
188 			    "property\n", di->di_ofw.obd_name);
189 			ofw_bus_gen_destroy_devinfo(&di->di_ofw);
190 			free(di, M_SIMPLEBUS);
191 			continue;
192 		}
193 
194 		if (fdt_intr_to_rl(dt_child, &di->di_res, di->di_intr_sl)) {
195 			device_printf(dev, "%s: could not process "
196 			    "'interrupts' property\n", di->di_ofw.obd_name);
197 			resource_list_free(&di->di_res);
198 			ofw_bus_gen_destroy_devinfo(&di->di_ofw);
199 			free(di, M_SIMPLEBUS);
200 			continue;
201 		}
202 
203 		/* Add newbus device for this FDT node */
204 		dev_child = device_add_child(dev, NULL, -1);
205 		if (dev_child == NULL) {
206 			device_printf(dev, "could not add child: %s\n",
207 			    di->di_ofw.obd_name);
208 			resource_list_free(&di->di_res);
209 			ofw_bus_gen_destroy_devinfo(&di->di_ofw);
210 			free(di, M_SIMPLEBUS);
211 			continue;
212 		}
213 #ifdef DEBUG
214 		device_printf(dev, "added child: %s\n\n", di->di_ofw.obd_name);
215 #endif
216 		device_set_ivars(dev_child, di);
217 	}
218 
219 	return (bus_generic_attach(dev));
220 }
221 
222 static int
223 simplebus_print_child(device_t dev, device_t child)
224 {
225 	struct simplebus_devinfo *di;
226 	struct resource_list *rl;
227 	int rv;
228 
229 	di = device_get_ivars(child);
230 	rl = &di->di_res;
231 
232 	rv = 0;
233 	rv += bus_print_child_header(dev, child);
234 	rv += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx");
235 	rv += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
236 	rv += bus_print_child_footer(dev, child);
237 
238 	return (rv);
239 }
240 
241 static struct resource *
242 simplebus_alloc_resource(device_t bus, device_t child, int type, int *rid,
243     u_long start, u_long end, u_long count, u_int flags)
244 {
245 	struct simplebus_devinfo *di;
246 	struct resource_list_entry *rle;
247 
248 	/*
249 	 * Request for the default allocation with a given rid: use resource
250 	 * list stored in the local device info.
251 	 */
252 	if ((start == 0UL) && (end == ~0UL)) {
253 		if ((di = device_get_ivars(child)) == NULL)
254 			return (NULL);
255 
256 		if (type == SYS_RES_IOPORT)
257 			type = SYS_RES_MEMORY;
258 
259 		rle = resource_list_find(&di->di_res, type, *rid);
260 		if (rle == NULL) {
261 			device_printf(bus, "no default resources for "
262 			    "rid = %d, type = %d\n", *rid, type);
263 			return (NULL);
264 		}
265 		start = rle->start;
266 		end = rle->end;
267 		count = rle->count;
268 	}
269 
270 	return (bus_generic_alloc_resource(bus, child, type, rid, start, end,
271 	    count, flags));
272 }
273 
274 static struct resource_list *
275 simplebus_get_resource_list(device_t bus, device_t child)
276 {
277 	struct simplebus_devinfo *di;
278 
279 	di = device_get_ivars(child);
280 	return (&di->di_res);
281 }
282 
283 static int
284 simplebus_setup_intr(device_t bus, device_t child, struct resource *res,
285     int flags, driver_filter_t *filter, driver_intr_t *ihand, void *arg,
286     void **cookiep)
287 {
288 	struct simplebus_devinfo *di;
289 	enum intr_trigger trig;
290 	enum intr_polarity pol;
291 	int irq, rid;
292 
293 	if (res == NULL)
294 		panic("simplebus_setup_intr: NULL irq resource!");
295 
296 	rid = rman_get_rid(res);
297 	if (rid > DI_MAX_INTR_NUM) {
298 		device_printf(child, "rid out of range rid = %d\n", rid);
299 		return (ERANGE);
300 	}
301 
302 	irq = rman_get_start(res);
303 
304 	if ((di = device_get_ivars(child)) == NULL) {
305 		device_printf(child, "could not retrieve devinfo\n");
306 		return (ENXIO);
307 	}
308 
309 	trig = di->di_intr_sl[rid].trig;
310 	pol = di->di_intr_sl[rid].pol;
311 
312 	debugf("intr config: irq = %d, trig = %d, pol = %d\n", irq, trig, pol);
313 
314 #if defined(__powerpc__)
315 	int err;
316 
317 	err = powerpc_config_intr(irq, trig, pol);
318 	if (err)
319 		return (err);
320 #endif
321 
322 	return (bus_generic_setup_intr(bus, child, res, flags, filter, ihand,
323 	    arg, cookiep));
324 }
325 
326 static const struct ofw_bus_devinfo *
327 simplebus_get_devinfo(device_t bus, device_t child)
328 {
329 	struct simplebus_devinfo *di;
330 
331 	di = device_get_ivars(child);
332 	return (&di->di_ofw);
333 }
334