xref: /freebsd/sys/powerpc/cpufreq/pmufreq.c (revision b3e7694832e81d7a904a10f525f8797b753bf0d3)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2011 Justin Hibbits
5  * Copyright (c) 2009 Nathan Whitehorn
6  * All rights reserved.
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 ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25  * 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 <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/bus.h>
36 #include <sys/cpu.h>
37 #include <sys/kernel.h>
38 #include <sys/limits.h>
39 #include <sys/module.h>
40 
41 #include <dev/ofw/ofw_bus.h>
42 #include <dev/ofw/openfirm.h>
43 
44 #include "cpufreq_if.h"
45 #include "powerpc/powermac/pmuvar.h"
46 
47 struct pmufreq_softc {
48 	device_t dev;
49 	uint32_t minfreq;
50 	uint32_t maxfreq;
51 	uint32_t curfreq;
52 };
53 
54 static void	pmufreq_identify(driver_t *driver, device_t parent);
55 static int	pmufreq_probe(device_t dev);
56 static int	pmufreq_attach(device_t dev);
57 static int	pmufreq_settings(device_t dev, struct cf_setting *sets, int *count);
58 static int	pmufreq_set(device_t dev, const struct cf_setting *set);
59 static int	pmufreq_get(device_t dev, struct cf_setting *set);
60 static int	pmufreq_type(device_t dev, int *type);
61 
62 static device_method_t pmufreq_methods[] = {
63 	/* Device interface */
64 	DEVMETHOD(device_identify,	pmufreq_identify),
65 	DEVMETHOD(device_probe,		pmufreq_probe),
66 	DEVMETHOD(device_attach,	pmufreq_attach),
67 
68 	/* cpufreq interface */
69 	DEVMETHOD(cpufreq_drv_set,	pmufreq_set),
70 	DEVMETHOD(cpufreq_drv_get,	pmufreq_get),
71 	DEVMETHOD(cpufreq_drv_type,	pmufreq_type),
72 	DEVMETHOD(cpufreq_drv_settings,	pmufreq_settings),
73 	{0, 0}
74 };
75 
76 static driver_t pmufreq_driver = {
77 	"pmufreq",
78 	pmufreq_methods,
79 	sizeof(struct pmufreq_softc)
80 };
81 
82 DRIVER_MODULE(pmufreq, cpu, pmufreq_driver, 0, 0);
83 
84 static void
85 pmufreq_identify(driver_t *driver, device_t parent)
86 {
87 	phandle_t node;
88 	uint32_t min_freq;
89 
90 	node = ofw_bus_get_node(parent);
91 	if (OF_getprop(node, "min-clock-frequency", &min_freq, sizeof(min_freq)) == -1)
92 		return;
93 
94 	/* Make sure we're not being doubly invoked. */
95 	if (device_find_child(parent, "pmufreq", -1) != NULL)
96 		return;
97 
98 	/*
99 	 * We attach a child for every CPU since settings need to
100 	 * be performed on every CPU in the SMP case.
101 	 */
102 	if (BUS_ADD_CHILD(parent, 10, "pmufreq", -1) == NULL)
103 		device_printf(parent, "add pmufreq child failed\n");
104 }
105 
106 static int
107 pmufreq_probe(device_t dev)
108 {
109 	phandle_t node;
110 	uint32_t min_freq;
111 
112 	if (resource_disabled("pmufreq", 0))
113 		return (ENXIO);
114 
115 	node = ofw_bus_get_node(device_get_parent(dev));
116 	/*
117 	 * A scalable MPC7455 has min-clock-frequency/max-clock-frequency as OFW
118 	 * properties of the 'cpu' node.
119 	 */
120 	if (OF_getprop(node, "min-clock-frequency", &min_freq, sizeof(min_freq)) == -1)
121 		return (ENXIO);
122 	device_set_desc(dev, "PMU-based frequency scaling");
123 	return (0);
124 }
125 
126 static int
127 pmufreq_attach(device_t dev)
128 {
129 	struct pmufreq_softc *sc;
130 	phandle_t node;
131 
132 	sc = device_get_softc(dev);
133 	sc->dev = dev;
134 
135 	node = ofw_bus_get_node(device_get_parent(dev));
136 	OF_getprop(node, "min-clock-frequency", &sc->minfreq, sizeof(sc->minfreq));
137 	OF_getprop(node, "max-clock-frequency", &sc->maxfreq, sizeof(sc->maxfreq));
138 	OF_getprop(node, "rounded-clock-frequency", &sc->curfreq, sizeof(sc->curfreq));
139 	sc->minfreq /= 1000000;
140 	sc->maxfreq /= 1000000;
141 	sc->curfreq /= 1000000;
142 
143 	cpufreq_register(dev);
144 	return (0);
145 }
146 
147 static int
148 pmufreq_settings(device_t dev, struct cf_setting *sets, int *count)
149 {
150 	struct pmufreq_softc *sc;
151 
152 	sc = device_get_softc(dev);
153 	if (sets == NULL || count == NULL)
154 		return (EINVAL);
155 	if (*count < 2)
156 		return (E2BIG);
157 
158 	/* Return a list of valid settings for this driver. */
159 	memset(sets, CPUFREQ_VAL_UNKNOWN, sizeof(*sets) * 2);
160 
161 	sets[0].freq = sc->maxfreq; sets[0].dev = dev;
162 	sets[1].freq = sc->minfreq; sets[1].dev = dev;
163 	/* Set high latency for CPU frequency changes, it's a tedious process. */
164 	sets[0].lat = INT_MAX;
165 	sets[1].lat = INT_MAX;
166 	*count = 2;
167 
168 	return (0);
169 }
170 
171 static int
172 pmufreq_set(device_t dev, const struct cf_setting *set)
173 {
174 	struct pmufreq_softc *sc;
175 	int error, speed_sel;
176 
177 	if (set == NULL)
178 		return (EINVAL);
179 
180 	sc = device_get_softc(dev);
181 
182 	if (set->freq == sc->maxfreq)
183 		speed_sel = 0;
184 	else
185 		speed_sel = 1;
186 
187 	error = pmu_set_speed(speed_sel);
188 	if (error == 0)
189 		sc->curfreq = set->freq;
190 
191 	return (error);
192 }
193 
194 static int
195 pmufreq_get(device_t dev, struct cf_setting *set)
196 {
197 	struct pmufreq_softc *sc;
198 
199 	if (set == NULL)
200 		return (EINVAL);
201 	sc = device_get_softc(dev);
202 
203 	set->freq = sc->curfreq;
204 	set->dev = dev;
205 
206 	return (0);
207 }
208 
209 static int
210 pmufreq_type(device_t dev, int *type)
211 {
212 
213 	if (type == NULL)
214 		return (EINVAL);
215 
216 	*type = CPUFREQ_TYPE_ABSOLUTE;
217 	return (0);
218 }
219