2 * Copyright (C) 2009 Nathan Whitehorn
3 * Copyright (C) 2015 The FreeBSD Foundation
6 * Portions of this software were developed by Andrew Turner
7 * under sponsorship from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
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>
41 #include <machine/bus.h>
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>
48 #if defined(__arm__) || defined(__arm64__) || defined(__riscv__)
49 #include <dev/extres/clk/clk.h>
52 static int ofw_cpulist_probe(device_t);
53 static int ofw_cpulist_attach(device_t);
54 static const struct ofw_bus_devinfo *ofw_cpulist_get_devinfo(device_t dev,
57 static MALLOC_DEFINE(M_OFWCPU, "ofwcpu", "OFW CPU device information");
59 struct ofw_cpulist_softc {
60 pcell_t sc_addr_cells;
63 static device_method_t ofw_cpulist_methods[] = {
64 /* Device interface */
65 DEVMETHOD(device_probe, ofw_cpulist_probe),
66 DEVMETHOD(device_attach, ofw_cpulist_attach),
69 DEVMETHOD(bus_add_child, bus_generic_add_child),
70 DEVMETHOD(bus_child_pnpinfo, ofw_bus_gen_child_pnpinfo),
71 DEVMETHOD(bus_get_device_path, ofw_bus_gen_get_device_path),
73 /* ofw_bus interface */
74 DEVMETHOD(ofw_bus_get_devinfo, ofw_cpulist_get_devinfo),
75 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat),
76 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model),
77 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name),
78 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node),
79 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type),
84 static driver_t ofw_cpulist_driver = {
87 sizeof(struct ofw_cpulist_softc)
90 DRIVER_MODULE(ofw_cpulist, ofwbus, ofw_cpulist_driver, 0, 0);
93 ofw_cpulist_probe(device_t dev)
97 name = ofw_bus_get_name(dev);
99 if (name == NULL || strcmp(name, "cpus") != 0)
102 device_set_desc(dev, "Open Firmware CPU Group");
108 ofw_cpulist_attach(device_t dev)
110 struct ofw_cpulist_softc *sc;
111 phandle_t root, child;
113 struct ofw_bus_devinfo *dinfo;
115 sc = device_get_softc(dev);
116 root = ofw_bus_get_node(dev);
118 sc->sc_addr_cells = 1;
119 OF_getencprop(root, "#address-cells", &sc->sc_addr_cells,
120 sizeof(sc->sc_addr_cells));
122 for (child = OF_child(root); child != 0; child = OF_peer(child)) {
123 dinfo = malloc(sizeof(*dinfo), M_OFWCPU, M_WAITOK | M_ZERO);
125 if (ofw_bus_gen_setup_devinfo(dinfo, child) != 0) {
126 free(dinfo, M_OFWCPU);
129 cdev = device_add_child(dev, NULL, -1);
131 device_printf(dev, "<%s>: device_add_child failed\n",
133 ofw_bus_gen_destroy_devinfo(dinfo);
134 free(dinfo, M_OFWCPU);
137 device_set_ivars(cdev, dinfo);
140 return (bus_generic_attach(dev));
143 static const struct ofw_bus_devinfo *
144 ofw_cpulist_get_devinfo(device_t dev, device_t child)
146 return (device_get_ivars(child));
149 static int ofw_cpu_probe(device_t);
150 static int ofw_cpu_attach(device_t);
151 static int ofw_cpu_read_ivar(device_t dev, device_t child, int index,
154 struct ofw_cpu_softc {
155 struct pcpu *sc_cpu_pcpu;
156 uint32_t sc_nominal_mhz;
157 boolean_t sc_reg_valid;
161 static device_method_t ofw_cpu_methods[] = {
162 /* Device interface */
163 DEVMETHOD(device_probe, ofw_cpu_probe),
164 DEVMETHOD(device_attach, ofw_cpu_attach),
167 DEVMETHOD(bus_add_child, bus_generic_add_child),
168 DEVMETHOD(bus_read_ivar, ofw_cpu_read_ivar),
169 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
170 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
171 DEVMETHOD(bus_alloc_resource, bus_generic_alloc_resource),
172 DEVMETHOD(bus_release_resource, bus_generic_release_resource),
173 DEVMETHOD(bus_activate_resource,bus_generic_activate_resource),
178 static driver_t ofw_cpu_driver = {
181 sizeof(struct ofw_cpu_softc)
184 DRIVER_MODULE(ofw_cpu, cpulist, ofw_cpu_driver, 0, 0);
187 ofw_cpu_probe(device_t dev)
189 const char *type = ofw_bus_get_type(dev);
191 if (type == NULL || strcmp(type, "cpu") != 0)
194 device_set_desc(dev, "Open Firmware CPU");
199 ofw_cpu_attach(device_t dev)
201 struct ofw_cpulist_softc *psc;
202 struct ofw_cpu_softc *sc;
206 #if defined(__arm__) || defined(__arm64__) || defined(__riscv__)
211 sc = device_get_softc(dev);
212 psc = device_get_softc(device_get_parent(dev));
214 if (nitems(sc->sc_reg) < psc->sc_addr_cells) {
216 device_printf(dev, "Too many address cells\n");
220 node = ofw_bus_get_node(dev);
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));
226 device_printf(dev, "missing 'reg' property\n");
227 else if ((rv % 4) != 0) {
229 device_printf(dev, "Malformed reg property\n");
230 } else if ((rv / 4) != psc->sc_addr_cells) {
232 device_printf(dev, "Invalid reg size %u\n", rv);
234 sc->sc_reg_valid = true;
238 * On powerpc, "interrupt-servers" denotes a SMT CPU. Look for any
239 * thread on this CPU, and assign that.
241 if (OF_hasprop(node, "ibm,ppc-interrupt-server#s")) {
242 struct cpuref cpuref;
246 if ((nservers = OF_getencprop_alloc(node,
247 "ibm,ppc-interrupt-server#s", (void **)&servers)) < 0)
249 nservers /= sizeof(cell_t);
250 for (i = 0; i < nservers; i++) {
251 for (rv = platform_smp_first_cpu(&cpuref); rv == 0;
252 rv = platform_smp_next_cpu(&cpuref)) {
253 if (cpuref.cr_hwref == servers[i]) {
255 pcpu_find(cpuref.cr_cpuid);
256 if (sc->sc_cpu_pcpu == NULL) {
257 OF_prop_free(servers);
266 OF_prop_free(servers);
267 if (sc->sc_cpu_pcpu == NULL) {
268 device_printf(dev, "No CPU found for this device.\n");
273 sc->sc_cpu_pcpu = pcpu_find(device_get_unit(dev));
275 if (OF_getencprop(node, "clock-frequency", &cell, sizeof(cell)) < 0) {
276 #if defined(__arm__) || defined(__arm64__) || defined(__riscv__)
277 rv = clk_get_by_ofw_index(dev, 0, 0, &cpuclk);
279 rv = clk_get_freq(cpuclk, &freq);
280 if (rv != 0 && bootverbose)
282 "Cannot get freq of property clocks\n");
284 sc->sc_nominal_mhz = freq / 1000000;
290 "missing 'clock-frequency' property\n");
293 sc->sc_nominal_mhz = cell / 1000000; /* convert to MHz */
295 if (sc->sc_nominal_mhz != 0 && bootverbose)
296 device_printf(dev, "Nominal frequency %dMhz\n",
298 bus_generic_probe(dev);
299 return (bus_generic_attach(dev));
303 ofw_cpu_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
305 struct ofw_cpulist_softc *psc;
306 struct ofw_cpu_softc *sc;
308 sc = device_get_softc(dev);
312 *result = (uintptr_t)sc->sc_cpu_pcpu;
314 case CPU_IVAR_NOMINAL_MHZ:
315 if (sc->sc_nominal_mhz > 0) {
316 *result = (uintptr_t)sc->sc_nominal_mhz;
320 case CPU_IVAR_CPUID_SIZE:
321 psc = device_get_softc(device_get_parent(dev));
322 *result = psc->sc_addr_cells;
325 if (sc->sc_reg_valid) {
326 *result = (uintptr_t)sc->sc_reg;
336 ofw_cpu_early_foreach(ofw_cpu_foreach_cb callback, boolean_t only_runnable)
338 phandle_t node, child;
339 pcell_t addr_cells, reg[2];
341 char device_type[16];
349 node = OF_finddevice("/cpus");
353 /* Find the number of cells in the cpu register */
354 if (OF_getencprop(node, "#address-cells", &addr_cells,
355 sizeof(addr_cells)) < 0)
358 for (child = OF_child(node); child != 0; child = OF_peer(child),
360 /* Check if child is a CPU */
361 memset(device_type, 0, sizeof(device_type));
362 rv = OF_getprop(child, "device_type", device_type,
363 sizeof(device_type) - 1);
366 if (strcmp(device_type, "cpu") != 0)
369 /* We're processing CPU, update next_id used in the next iteration */
373 * If we are filtering by runnable then limit to only
374 * those that have been enabled, or do provide a method
379 OF_getprop(child, "status", status, sizeof(status));
380 if (status[0] != '\0' && strcmp(status, "okay") != 0 &&
381 strcmp(status, "ok") != 0 &&
382 !OF_hasprop(child, "enable-method"))
387 * Check we have a register to identify the cpu
389 rv = OF_getencprop(child, "reg", reg,
390 addr_cells * sizeof(cell_t));
391 if (rv != addr_cells * sizeof(cell_t))
394 if (callback == NULL || callback(id, child, addr_cells, reg))
398 return (only_runnable ? count : id);