xref: /freebsd/sys/dev/ofw/ofwbus.c (revision 732a02b4e77866604a120a275c082bb6221bd2ff)
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 #ifdef INTRNG
47 #include <sys/intr.h>
48 #endif
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 #include <dev/fdt/simplebus.h>
57 
58 #include <machine/bus.h>
59 #include <machine/resource.h>
60 
61 /*
62  * The ofwbus (which is a pseudo-bus actually) iterates over the nodes that
63  * hang from the Open Firmware root node and adds them as devices to this bus
64  * (except some special nodes which are excluded) so that drivers can be
65  * attached to them.
66  *
67  */
68 
69 struct ofwbus_softc {
70 	struct simplebus_softc simplebus_sc;
71 	struct rman	sc_intr_rman;
72 	struct rman	sc_mem_rman;
73 };
74 
75 #ifndef __aarch64__
76 static device_identify_t ofwbus_identify;
77 #endif
78 static device_probe_t ofwbus_probe;
79 static device_attach_t ofwbus_attach;
80 static bus_alloc_resource_t ofwbus_alloc_resource;
81 static bus_adjust_resource_t ofwbus_adjust_resource;
82 static bus_release_resource_t ofwbus_release_resource;
83 
84 static device_method_t ofwbus_methods[] = {
85 	/* Device interface */
86 #ifndef __aarch64__
87 	DEVMETHOD(device_identify,	ofwbus_identify),
88 #endif
89 	DEVMETHOD(device_probe,		ofwbus_probe),
90 	DEVMETHOD(device_attach,	ofwbus_attach),
91 
92 	/* Bus interface */
93 	DEVMETHOD(bus_alloc_resource,	ofwbus_alloc_resource),
94 	DEVMETHOD(bus_adjust_resource,	ofwbus_adjust_resource),
95 	DEVMETHOD(bus_release_resource,	ofwbus_release_resource),
96 
97 	DEVMETHOD_END
98 };
99 
100 DEFINE_CLASS_1(ofwbus, ofwbus_driver, ofwbus_methods,
101     sizeof(struct ofwbus_softc), simplebus_driver);
102 static devclass_t ofwbus_devclass;
103 EARLY_DRIVER_MODULE(ofwbus, nexus, ofwbus_driver, ofwbus_devclass, 0, 0,
104     BUS_PASS_BUS + BUS_PASS_ORDER_MIDDLE);
105 MODULE_VERSION(ofwbus, 1);
106 
107 #ifndef __aarch64__
108 static void
109 ofwbus_identify(driver_t *driver, device_t parent)
110 {
111 
112 	/* Check if Open Firmware has been instantiated */
113 	if (OF_peer(0) == 0)
114 		return;
115 
116 	if (device_find_child(parent, "ofwbus", -1) == NULL)
117 		BUS_ADD_CHILD(parent, 0, "ofwbus", -1);
118 }
119 #endif
120 
121 static int
122 ofwbus_probe(device_t dev)
123 {
124 
125 #ifdef __aarch64__
126 	if (OF_peer(0) == 0)
127 		return (ENXIO);
128 #endif
129 
130 	device_set_desc(dev, "Open Firmware Device Tree");
131 	return (BUS_PROBE_NOWILDCARD);
132 }
133 
134 static int
135 ofwbus_attach(device_t dev)
136 {
137 	struct ofwbus_softc *sc;
138 	phandle_t node;
139 	struct ofw_bus_devinfo obd;
140 
141 	sc = device_get_softc(dev);
142 
143 	node = OF_peer(0);
144 
145 	/*
146 	 * If no Open Firmware, bail early
147 	 */
148 	if (node == -1)
149 		return (ENXIO);
150 
151 	/*
152 	 * ofwbus bus starts on unamed node in FDT, so we cannot make
153 	 * ofw_bus_devinfo from it. Pass node to simplebus_init directly.
154 	 */
155 	simplebus_init(dev, node);
156 	sc->sc_intr_rman.rm_type = RMAN_ARRAY;
157 	sc->sc_intr_rman.rm_descr = "Interrupts";
158 	sc->sc_mem_rman.rm_type = RMAN_ARRAY;
159 	sc->sc_mem_rman.rm_descr = "Device Memory";
160 	if (rman_init(&sc->sc_intr_rman) != 0 ||
161 	    rman_init(&sc->sc_mem_rman) != 0 ||
162 	    rman_manage_region(&sc->sc_intr_rman, 0, ~0) != 0 ||
163 	    rman_manage_region(&sc->sc_mem_rman, 0, BUS_SPACE_MAXADDR) != 0)
164 		panic("%s: failed to set up rmans.", __func__);
165 
166 	/*
167 	 * Allow devices to identify.
168 	 */
169 	bus_generic_probe(dev);
170 
171 	/*
172 	 * Now walk the OFW tree and attach top-level devices.
173 	 */
174 	for (node = OF_child(node); node > 0; node = OF_peer(node)) {
175 		if (ofw_bus_gen_setup_devinfo(&obd, node) != 0)
176 			continue;
177 		simplebus_add_device(dev, node, 0, NULL, -1, NULL);
178 	}
179 	return (bus_generic_attach(dev));
180 }
181 
182 static struct resource *
183 ofwbus_alloc_resource(device_t bus, device_t child, int type, int *rid,
184     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
185 {
186 	struct ofwbus_softc *sc;
187 	struct rman *rm;
188 	struct resource *rv;
189 	struct resource_list_entry *rle;
190 	int isdefault, passthrough;
191 
192 	isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
193 	passthrough = (device_get_parent(child) != bus);
194 	sc = device_get_softc(bus);
195 	rle = NULL;
196 	if (!passthrough && isdefault) {
197 		rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child),
198 		    type, *rid);
199 		if (rle == NULL) {
200 			if (bootverbose)
201 				device_printf(bus, "no default resources for "
202 				    "rid = %d, type = %d\n", *rid, type);
203 			return (NULL);
204 		}
205 		start = rle->start;
206 		count = ummax(count, rle->count);
207 		end = ummax(rle->end, start + count - 1);
208 	}
209 
210 	switch (type) {
211 	case SYS_RES_IRQ:
212 		rm = &sc->sc_intr_rman;
213 		break;
214 	case SYS_RES_MEMORY:
215 		rm = &sc->sc_mem_rman;
216 		break;
217 	default:
218 		return (NULL);
219 	}
220 
221 	rv = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
222 	    child);
223 	if (rv == NULL)
224 		return (NULL);
225 	rman_set_rid(rv, *rid);
226 
227 	if ((flags & RF_ACTIVE) != 0 && bus_activate_resource(child, type,
228 	    *rid, rv) != 0) {
229 		rman_release_resource(rv);
230 		return (NULL);
231 	}
232 
233 	if (!passthrough && rle != NULL) {
234 		rle->res = rv;
235 		rle->start = rman_get_start(rv);
236 		rle->end = rman_get_end(rv);
237 		rle->count = rle->end - rle->start + 1;
238 	}
239 
240 	return (rv);
241 }
242 
243 static int
244 ofwbus_adjust_resource(device_t bus, device_t child __unused, int type,
245     struct resource *r, rman_res_t start, rman_res_t end)
246 {
247 	struct ofwbus_softc *sc;
248 	struct rman *rm;
249 	device_t ofwbus;
250 
251 	ofwbus = bus;
252 	while (strcmp(device_get_name(device_get_parent(ofwbus)), "root") != 0)
253 		ofwbus = device_get_parent(ofwbus);
254 	sc = device_get_softc(ofwbus);
255 	switch (type) {
256 	case SYS_RES_IRQ:
257 		rm = &sc->sc_intr_rman;
258 		break;
259 	case SYS_RES_MEMORY:
260 		rm = &sc->sc_mem_rman;
261 		break;
262 	default:
263 		return (EINVAL);
264 	}
265 	if (rm == NULL)
266 		return (ENXIO);
267 	if (rman_is_region_manager(r, rm) == 0)
268 		return (EINVAL);
269 	return (rman_adjust_resource(r, start, end));
270 }
271 
272 static int
273 ofwbus_release_resource(device_t bus, device_t child, int type,
274     int rid, struct resource *r)
275 {
276 	struct resource_list_entry *rle;
277 	int passthrough;
278 	int error;
279 
280 	passthrough = (device_get_parent(child) != bus);
281 	if (!passthrough) {
282 		/* Clean resource list entry */
283 		rle = resource_list_find(BUS_GET_RESOURCE_LIST(bus, child),
284 		    type, rid);
285 		if (rle != NULL)
286 			rle->res = NULL;
287 	}
288 
289 	if ((rman_get_flags(r) & RF_ACTIVE) != 0) {
290 		error = bus_deactivate_resource(child, type, rid, r);
291 		if (error)
292 			return (error);
293 	}
294 	return (rman_release_resource(r));
295 }
296