xref: /freebsd/sys/dev/ofw/ofw_cpu.c (revision fcb560670601b2a4d87bb31d7531c8dcc37ee71b)
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 
47 static int	ofw_cpulist_probe(device_t);
48 static int	ofw_cpulist_attach(device_t);
49 static const struct ofw_bus_devinfo *ofw_cpulist_get_devinfo(device_t dev,
50     device_t child);
51 
52 static MALLOC_DEFINE(M_OFWCPU, "ofwcpu", "OFW CPU device information");
53 
54 struct ofw_cpulist_softc {
55 	pcell_t	 sc_addr_cells;
56 };
57 
58 static device_method_t ofw_cpulist_methods[] = {
59 	/* Device interface */
60 	DEVMETHOD(device_probe,		ofw_cpulist_probe),
61 	DEVMETHOD(device_attach,	ofw_cpulist_attach),
62 
63 	/* Bus interface */
64 	DEVMETHOD(bus_add_child,	bus_generic_add_child),
65 	DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str),
66 
67 	/* ofw_bus interface */
68 	DEVMETHOD(ofw_bus_get_devinfo,	ofw_cpulist_get_devinfo),
69 	DEVMETHOD(ofw_bus_get_compat,	ofw_bus_gen_get_compat),
70 	DEVMETHOD(ofw_bus_get_model,	ofw_bus_gen_get_model),
71 	DEVMETHOD(ofw_bus_get_name,	ofw_bus_gen_get_name),
72 	DEVMETHOD(ofw_bus_get_node,	ofw_bus_gen_get_node),
73 	DEVMETHOD(ofw_bus_get_type,	ofw_bus_gen_get_type),
74 
75 	DEVMETHOD_END
76 };
77 
78 static driver_t ofw_cpulist_driver = {
79 	"cpulist",
80 	ofw_cpulist_methods,
81 	sizeof(struct ofw_cpulist_softc)
82 };
83 
84 static devclass_t ofw_cpulist_devclass;
85 
86 DRIVER_MODULE(ofw_cpulist, ofwbus, ofw_cpulist_driver, ofw_cpulist_devclass,
87     0, 0);
88 
89 static int
90 ofw_cpulist_probe(device_t dev)
91 {
92 	const char	*name;
93 
94 	name = ofw_bus_get_name(dev);
95 
96 	if (name == NULL || strcmp(name, "cpus") != 0)
97 		return (ENXIO);
98 
99 	device_set_desc(dev, "Open Firmware CPU Group");
100 
101 	return (0);
102 }
103 
104 static int
105 ofw_cpulist_attach(device_t dev)
106 {
107 	struct ofw_cpulist_softc *sc;
108 	phandle_t root, child;
109 	device_t cdev;
110 	struct ofw_bus_devinfo *dinfo;
111 
112 	sc = device_get_softc(dev);
113 	root = ofw_bus_get_node(dev);
114 
115 	sc->sc_addr_cells = 1;
116 	OF_getencprop(root, "#address-cells", &sc->sc_addr_cells,
117 	    sizeof(sc->sc_addr_cells));
118 
119 	for (child = OF_child(root); child != 0; child = OF_peer(child)) {
120 		dinfo = malloc(sizeof(*dinfo), M_OFWCPU, M_WAITOK | M_ZERO);
121 
122                 if (ofw_bus_gen_setup_devinfo(dinfo, child) != 0) {
123                         free(dinfo, M_OFWCPU);
124                         continue;
125                 }
126                 cdev = device_add_child(dev, NULL, -1);
127                 if (cdev == NULL) {
128                         device_printf(dev, "<%s>: device_add_child failed\n",
129                             dinfo->obd_name);
130                         ofw_bus_gen_destroy_devinfo(dinfo);
131                         free(dinfo, M_OFWCPU);
132                         continue;
133                 }
134 		device_set_ivars(cdev, dinfo);
135 	}
136 
137 	return (bus_generic_attach(dev));
138 }
139 
140 static const struct ofw_bus_devinfo *
141 ofw_cpulist_get_devinfo(device_t dev, device_t child)
142 {
143 	return (device_get_ivars(child));
144 }
145 
146 static int	ofw_cpu_probe(device_t);
147 static int	ofw_cpu_attach(device_t);
148 static int	ofw_cpu_read_ivar(device_t dev, device_t child, int index,
149     uintptr_t *result);
150 
151 struct ofw_cpu_softc {
152 	struct pcpu	*sc_cpu_pcpu;
153 	uint32_t	 sc_nominal_mhz;
154 	boolean_t	 sc_reg_valid;
155 	pcell_t		 sc_reg[2];
156 };
157 
158 static device_method_t ofw_cpu_methods[] = {
159 	/* Device interface */
160 	DEVMETHOD(device_probe,		ofw_cpu_probe),
161 	DEVMETHOD(device_attach,	ofw_cpu_attach),
162 
163 	/* Bus interface */
164 	DEVMETHOD(bus_add_child,	bus_generic_add_child),
165 	DEVMETHOD(bus_read_ivar,	ofw_cpu_read_ivar),
166 	DEVMETHOD(bus_setup_intr,	bus_generic_setup_intr),
167 	DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
168 	DEVMETHOD(bus_alloc_resource,	bus_generic_alloc_resource),
169 	DEVMETHOD(bus_release_resource,	bus_generic_release_resource),
170 	DEVMETHOD(bus_activate_resource,bus_generic_activate_resource),
171 
172 	DEVMETHOD_END
173 };
174 
175 static driver_t ofw_cpu_driver = {
176 	"cpu",
177 	ofw_cpu_methods,
178 	sizeof(struct ofw_cpu_softc)
179 };
180 
181 static devclass_t ofw_cpu_devclass;
182 
183 DRIVER_MODULE(ofw_cpu, cpulist, ofw_cpu_driver, ofw_cpu_devclass, 0, 0);
184 
185 static int
186 ofw_cpu_probe(device_t dev)
187 {
188 	const char *type = ofw_bus_get_type(dev);
189 
190 	if (type == NULL || strcmp(type, "cpu") != 0)
191 		return (ENXIO);
192 
193 	device_set_desc(dev, "Open Firmware CPU");
194 	return (0);
195 }
196 
197 static int
198 ofw_cpu_attach(device_t dev)
199 {
200 	struct ofw_cpulist_softc *psc;
201 	struct ofw_cpu_softc *sc;
202 	phandle_t node;
203 	pcell_t cell;
204 	int rv;
205 
206 	sc = device_get_softc(dev);
207 	psc = device_get_softc(device_get_parent(dev));
208 
209 	if (nitems(sc->sc_reg) < psc->sc_addr_cells) {
210 		if (bootverbose)
211 			device_printf(dev, "Too many address cells\n");
212 		return (EINVAL);
213 	}
214 
215 	node = ofw_bus_get_node(dev);
216 
217 	/* Read and validate the reg property for use later */
218 	sc->sc_reg_valid = false;
219 	rv = OF_getencprop(node, "reg", sc->sc_reg, sizeof(sc->sc_reg));
220 	if (rv < 0)
221 		device_printf(dev, "missing 'reg' property\n");
222 	else if ((rv % 4) != 0) {
223 		if (bootverbose)
224 			device_printf(dev, "Malformed reg property\n");
225 	} else if ((rv / 4) != psc->sc_addr_cells) {
226 		if (bootverbose)
227 			device_printf(dev, "Invalid reg size %u\n", rv);
228 	} else
229 		sc->sc_reg_valid = true;
230 
231 	sc->sc_cpu_pcpu = pcpu_find(device_get_unit(dev));
232 
233 	if (OF_getencprop(node, "clock-frequency", &cell, sizeof(cell)) < 0) {
234 		if (bootverbose)
235 			device_printf(dev,
236 			    "missing 'clock-frequency' property\n");
237 	} else
238 		sc->sc_nominal_mhz = cell / 1000000; /* convert to MHz */
239 
240 	bus_generic_probe(dev);
241 	return (bus_generic_attach(dev));
242 }
243 
244 static int
245 ofw_cpu_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
246 {
247 	struct ofw_cpu_softc *sc;
248 
249 	sc = device_get_softc(dev);
250 
251 	switch (index) {
252 	case CPU_IVAR_PCPU:
253 		*result = (uintptr_t)sc->sc_cpu_pcpu;
254 		return (0);
255 	case CPU_IVAR_NOMINAL_MHZ:
256 		if (sc->sc_nominal_mhz > 0) {
257 			*result = (uintptr_t)sc->sc_nominal_mhz;
258 			return (0);
259 		}
260 		break;
261 	}
262 
263 	return (ENOENT);
264 }
265 
266