xref: /freebsd/sys/dev/ofw/ofw_cpu.c (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
1 /*-
2  * Copyright (C) 2009 Nathan Whitehorn
3  * Copyright (C) 2015 The FreeBSD Foundation
4  * All rights reserved.
5  *
6  * Portions of this software were developed by Andrew Turner
7  * under sponsorship from the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/module.h>
38 #include <sys/malloc.h>
39 #include <sys/bus.h>
40 #include <sys/cpu.h>
41 #include <machine/bus.h>
42 
43 #include <dev/ofw/openfirm.h>
44 #include <dev/ofw/ofw_bus.h>
45 #include <dev/ofw/ofw_bus_subr.h>
46 #include <dev/ofw/ofw_cpu.h>
47 
48 static int	ofw_cpulist_probe(device_t);
49 static int	ofw_cpulist_attach(device_t);
50 static const struct ofw_bus_devinfo *ofw_cpulist_get_devinfo(device_t dev,
51     device_t child);
52 
53 static MALLOC_DEFINE(M_OFWCPU, "ofwcpu", "OFW CPU device information");
54 
55 struct ofw_cpulist_softc {
56 	pcell_t	 sc_addr_cells;
57 };
58 
59 static device_method_t ofw_cpulist_methods[] = {
60 	/* Device interface */
61 	DEVMETHOD(device_probe,		ofw_cpulist_probe),
62 	DEVMETHOD(device_attach,	ofw_cpulist_attach),
63 
64 	/* Bus interface */
65 	DEVMETHOD(bus_add_child,	bus_generic_add_child),
66 	DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
67 
68 	/* ofw_bus interface */
69 	DEVMETHOD(ofw_bus_get_devinfo,	ofw_cpulist_get_devinfo),
70 	DEVMETHOD(ofw_bus_get_compat,	ofw_bus_gen_get_compat),
71 	DEVMETHOD(ofw_bus_get_model,	ofw_bus_gen_get_model),
72 	DEVMETHOD(ofw_bus_get_name,	ofw_bus_gen_get_name),
73 	DEVMETHOD(ofw_bus_get_node,	ofw_bus_gen_get_node),
74 	DEVMETHOD(ofw_bus_get_type,	ofw_bus_gen_get_type),
75 
76 	DEVMETHOD_END
77 };
78 
79 static driver_t ofw_cpulist_driver = {
80 	"cpulist",
81 	ofw_cpulist_methods,
82 	sizeof(struct ofw_cpulist_softc)
83 };
84 
85 static devclass_t ofw_cpulist_devclass;
86 
87 DRIVER_MODULE(ofw_cpulist, ofwbus, ofw_cpulist_driver, ofw_cpulist_devclass,
88     0, 0);
89 
90 static int
91 ofw_cpulist_probe(device_t dev)
92 {
93 	const char	*name;
94 
95 	name = ofw_bus_get_name(dev);
96 
97 	if (name == NULL || strcmp(name, "cpus") != 0)
98 		return (ENXIO);
99 
100 	device_set_desc(dev, "Open Firmware CPU Group");
101 
102 	return (0);
103 }
104 
105 static int
106 ofw_cpulist_attach(device_t dev)
107 {
108 	struct ofw_cpulist_softc *sc;
109 	phandle_t root, child;
110 	device_t cdev;
111 	struct ofw_bus_devinfo *dinfo;
112 
113 	sc = device_get_softc(dev);
114 	root = ofw_bus_get_node(dev);
115 
116 	sc->sc_addr_cells = 1;
117 	OF_getencprop(root, "#address-cells", &sc->sc_addr_cells,
118 	    sizeof(sc->sc_addr_cells));
119 
120 	for (child = OF_child(root); child != 0; child = OF_peer(child)) {
121 		dinfo = malloc(sizeof(*dinfo), M_OFWCPU, M_WAITOK | M_ZERO);
122 
123                 if (ofw_bus_gen_setup_devinfo(dinfo, child) != 0) {
124                         free(dinfo, M_OFWCPU);
125                         continue;
126                 }
127                 cdev = device_add_child(dev, NULL, -1);
128                 if (cdev == NULL) {
129                         device_printf(dev, "<%s>: device_add_child failed\n",
130                             dinfo->obd_name);
131                         ofw_bus_gen_destroy_devinfo(dinfo);
132                         free(dinfo, M_OFWCPU);
133                         continue;
134                 }
135 		device_set_ivars(cdev, dinfo);
136 	}
137 
138 	return (bus_generic_attach(dev));
139 }
140 
141 static const struct ofw_bus_devinfo *
142 ofw_cpulist_get_devinfo(device_t dev, device_t child)
143 {
144 	return (device_get_ivars(child));
145 }
146 
147 static int	ofw_cpu_probe(device_t);
148 static int	ofw_cpu_attach(device_t);
149 static int	ofw_cpu_read_ivar(device_t dev, device_t child, int index,
150     uintptr_t *result);
151 
152 struct ofw_cpu_softc {
153 	struct pcpu	*sc_cpu_pcpu;
154 	uint32_t	 sc_nominal_mhz;
155 	boolean_t	 sc_reg_valid;
156 	pcell_t		 sc_reg[2];
157 };
158 
159 static device_method_t ofw_cpu_methods[] = {
160 	/* Device interface */
161 	DEVMETHOD(device_probe,		ofw_cpu_probe),
162 	DEVMETHOD(device_attach,	ofw_cpu_attach),
163 
164 	/* Bus interface */
165 	DEVMETHOD(bus_add_child,	bus_generic_add_child),
166 	DEVMETHOD(bus_read_ivar,	ofw_cpu_read_ivar),
167 	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
168 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
169 	DEVMETHOD(bus_alloc_resource,	bus_generic_alloc_resource),
170 	DEVMETHOD(bus_release_resource,	bus_generic_release_resource),
171 	DEVMETHOD(bus_activate_resource,bus_generic_activate_resource),
172 
173 	DEVMETHOD_END
174 };
175 
176 static driver_t ofw_cpu_driver = {
177 	"cpu",
178 	ofw_cpu_methods,
179 	sizeof(struct ofw_cpu_softc)
180 };
181 
182 static devclass_t ofw_cpu_devclass;
183 
184 DRIVER_MODULE(ofw_cpu, cpulist, ofw_cpu_driver, ofw_cpu_devclass, 0, 0);
185 
186 static int
187 ofw_cpu_probe(device_t dev)
188 {
189 	const char *type = ofw_bus_get_type(dev);
190 
191 	if (type == NULL || strcmp(type, "cpu") != 0)
192 		return (ENXIO);
193 
194 	/* Skip SMT CPUs, which we can't reasonably represent with this code */
195 	if (OF_hasprop(ofw_bus_get_node(dev), "ibm,ppc-interrupt-server#s"))
196 		return (ENXIO);
197 
198 	device_set_desc(dev, "Open Firmware CPU");
199 	return (0);
200 }
201 
202 static int
203 ofw_cpu_attach(device_t dev)
204 {
205 	struct ofw_cpulist_softc *psc;
206 	struct ofw_cpu_softc *sc;
207 	phandle_t node;
208 	pcell_t cell;
209 	int rv;
210 
211 	sc = device_get_softc(dev);
212 	psc = device_get_softc(device_get_parent(dev));
213 
214 	if (nitems(sc->sc_reg) < psc->sc_addr_cells) {
215 		if (bootverbose)
216 			device_printf(dev, "Too many address cells\n");
217 		return (EINVAL);
218 	}
219 
220 	node = ofw_bus_get_node(dev);
221 
222 	/* Read and validate the reg property for use later */
223 	sc->sc_reg_valid = false;
224 	rv = OF_getencprop(node, "reg", sc->sc_reg, sizeof(sc->sc_reg));
225 	if (rv < 0)
226 		device_printf(dev, "missing 'reg' property\n");
227 	else if ((rv % 4) != 0) {
228 		if (bootverbose)
229 			device_printf(dev, "Malformed reg property\n");
230 	} else if ((rv / 4) != psc->sc_addr_cells) {
231 		if (bootverbose)
232 			device_printf(dev, "Invalid reg size %u\n", rv);
233 	} else
234 		sc->sc_reg_valid = true;
235 
236 	sc->sc_cpu_pcpu = pcpu_find(device_get_unit(dev));
237 
238 	if (OF_getencprop(node, "clock-frequency", &cell, sizeof(cell)) < 0) {
239 		if (bootverbose)
240 			device_printf(dev,
241 			    "missing 'clock-frequency' property\n");
242 	} else
243 		sc->sc_nominal_mhz = cell / 1000000; /* convert to MHz */
244 
245 	bus_generic_probe(dev);
246 	return (bus_generic_attach(dev));
247 }
248 
249 static int
250 ofw_cpu_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
251 {
252 	struct ofw_cpulist_softc *psc;
253 	struct ofw_cpu_softc *sc;
254 
255 	sc = device_get_softc(dev);
256 
257 	switch (index) {
258 	case CPU_IVAR_PCPU:
259 		*result = (uintptr_t)sc->sc_cpu_pcpu;
260 		return (0);
261 	case CPU_IVAR_NOMINAL_MHZ:
262 		if (sc->sc_nominal_mhz > 0) {
263 			*result = (uintptr_t)sc->sc_nominal_mhz;
264 			return (0);
265 		}
266 		break;
267 	case CPU_IVAR_CPUID_SIZE:
268 		psc = device_get_softc(device_get_parent(dev));
269 		*result = psc->sc_addr_cells;
270 		return (0);
271 	case CPU_IVAR_CPUID:
272 		if (sc->sc_reg_valid) {
273 			*result = (uintptr_t)sc->sc_reg;
274 			return (0);
275 		}
276 		break;
277 	}
278 
279 	return (ENOENT);
280 }
281 
282 int
283 ofw_cpu_early_foreach(ofw_cpu_foreach_cb callback, boolean_t only_runnable)
284 {
285 	phandle_t node, child;
286 	pcell_t addr_cells, reg[2];
287 	char status[16];
288 	char device_type[16];
289 	u_int id, next_id;
290 	int count, rv;
291 
292 	count = 0;
293 	id = 0;
294 	next_id = 0;
295 
296 	node = OF_finddevice("/cpus");
297 	if (node == -1)
298 		return (-1);
299 
300 	/* Find the number of cells in the cpu register */
301 	if (OF_getencprop(node, "#address-cells", &addr_cells,
302 	    sizeof(addr_cells)) < 0)
303 		return (-1);
304 
305 	for (child = OF_child(node); child != 0; child = OF_peer(child),
306 	    id = next_id) {
307 
308 		/* Check if child is a CPU */
309 		memset(device_type, 0, sizeof(device_type));
310 		rv = OF_getprop(child, "device_type", device_type,
311 		    sizeof(device_type) - 1);
312 		if (rv < 0)
313 			continue;
314 		if (strcmp(device_type, "cpu") != 0)
315 			continue;
316 
317 		/* We're processing CPU, update next_id used in the next iteration */
318 		next_id++;
319 
320 		/*
321 		 * If we are filtering by runnable then limit to only
322 		 * those that have been enabled, or do provide a method
323 		 * to enable them.
324 		 */
325 		if (only_runnable) {
326 			status[0] = '\0';
327 			OF_getprop(child, "status", status, sizeof(status));
328 			if (status[0] != '\0' && strcmp(status, "okay") != 0 &&
329 				strcmp(status, "ok") != 0 &&
330 				!OF_hasprop(child, "enable-method"))
331 					continue;
332 		}
333 
334 		/*
335 		 * Check we have a register to identify the cpu
336 		 */
337 		rv = OF_getencprop(child, "reg", reg,
338 		    addr_cells * sizeof(cell_t));
339 		if (rv != addr_cells * sizeof(cell_t))
340 			continue;
341 
342 		if (callback == NULL || callback(id, child, addr_cells, reg))
343 			count++;
344 	}
345 
346 	return (only_runnable ? count : id);
347 }
348