xref: /freebsd/sys/arm/nvidia/tegra124/tegra124_coretemp.c (revision 4e99f45480598189d49d45a825533a6c9e12f02c)
1 /*-
2  * Copyright (c) 2016 Michal Meloun <mmel@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/bus.h>
33 #include <sys/cpu.h>
34 #include <sys/kernel.h>
35 #include <sys/lock.h>
36 #include <sys/malloc.h>
37 #include <sys/module.h>
38 #include <sys/sysctl.h>
39 
40 #include <machine/bus.h>
41 #include <machine/cpu.h>
42 
43 #include <dev/extres/clk/clk.h>
44 #include <dev/ofw/ofw_bus_subr.h>
45 
46 #include "tegra_soctherm_if.h"
47 
48 
49 enum therm_info {
50 	CORETEMP_TEMP,
51 	CORETEMP_DELTA,
52 	CORETEMP_RESOLUTION,
53 	CORETEMP_TJMAX,
54 };
55 
56 struct tegra124_coretemp_softc {
57 	device_t		dev;
58 	int			overheat_log;
59 	int			core_max_temp;
60 	int			cpu_id;
61 	device_t		tsens_dev;
62 	intptr_t		tsens_id;
63 };
64 
65 static int
66 coretemp_get_val_sysctl(SYSCTL_HANDLER_ARGS)
67 {
68 	device_t dev;
69 	int val, temp, rv;
70 	struct tegra124_coretemp_softc *sc;
71 	enum therm_info type;
72 	char stemp[16];
73 
74 
75 	dev = (device_t) arg1;
76 	sc = device_get_softc(dev);
77 	type = arg2;
78 
79 
80 	rv = TEGRA_SOCTHERM_GET_TEMPERATURE(sc->tsens_dev, sc->dev,
81 	     sc->tsens_id, &temp);
82 	if (rv != 0) {
83 		device_printf(sc->dev,
84 		    "Cannot read temperature sensor %d:  %d\n",
85 		    sc->tsens_id, rv);
86 		return (rv);
87 	}
88 
89 	switch (type) {
90 	case CORETEMP_TEMP:
91 		val = temp / 100;
92 		val +=  2731;
93 		break;
94 	case CORETEMP_DELTA:
95 		val = (sc->core_max_temp - temp) / 1000;
96 		break;
97 	case CORETEMP_RESOLUTION:
98 		val = 1;
99 		break;
100 	case CORETEMP_TJMAX:
101 		val = sc->core_max_temp / 100;
102 		val +=  2731;
103 		break;
104 	}
105 
106 
107 	if ((temp > sc->core_max_temp)  && !sc->overheat_log) {
108 		sc->overheat_log = 1;
109 
110 		/*
111 		 * Check for Critical Temperature Status and Critical
112 		 * Temperature Log.  It doesn't really matter if the
113 		 * current temperature is invalid because the "Critical
114 		 * Temperature Log" bit will tell us if the Critical
115 		 * Temperature has * been reached in past. It's not
116 		 * directly related to the current temperature.
117 		 *
118 		 * If we reach a critical level, allow devctl(4)
119 		 * to catch this and shutdown the system.
120 		 */
121 		device_printf(dev, "critical temperature detected, "
122 		    "suggest system shutdown\n");
123 		snprintf(stemp, sizeof(stemp), "%d", val);
124 		devctl_notify("coretemp", "Thermal", stemp,
125 		    "notify=0xcc");
126 	} else {
127 		sc->overheat_log = 0;
128 	}
129 
130 	return (sysctl_handle_int(oidp, 0, val, req));
131 }
132 
133 static int
134 tegra124_coretemp_ofw_parse(struct tegra124_coretemp_softc *sc)
135 {
136 	int rv, ncells;
137 	phandle_t node, xnode;
138 	pcell_t *cells;
139 
140 	node = OF_peer(0);
141 	node = ofw_bus_find_child(node, "thermal-zones");
142 	if (node <= 0) {
143 		device_printf(sc->dev, "Cannot find 'thermal-zones'.\n");
144 		return (ENXIO);
145 	}
146 
147 	node = ofw_bus_find_child(node, "cpu");
148 	if (node <= 0) {
149 		device_printf(sc->dev, "Cannot find 'cpu'\n");
150 		return (ENXIO);
151 	}
152 	rv = ofw_bus_parse_xref_list_alloc(node, "thermal-sensors",
153 	    "#thermal-sensor-cells", 0, &xnode, &ncells, &cells);
154 	if (rv != 0) {
155 		device_printf(sc->dev,
156 		    "Cannot parse 'thermal-sensors' property.\n");
157 		return (ENXIO);
158 	}
159 	if (ncells != 1) {
160 		device_printf(sc->dev,
161 		    "Invalid format of 'thermal-sensors' property(%d).\n",
162 		    ncells);
163 		return (ENXIO);
164 	}
165 
166 	sc->tsens_id = 0x100 + sc->cpu_id; //cells[0];
167 	OF_prop_free(cells);
168 
169 	sc->tsens_dev = OF_device_from_xref(xnode);
170 	if (sc->tsens_dev == NULL) {
171 		device_printf(sc->dev,
172 		    "Cannot find thermal sensors device.");
173 		return (ENXIO);
174 	}
175 	return (0);
176 }
177 
178 static void
179 tegra124_coretemp_identify(driver_t *driver, device_t parent)
180 {
181 	phandle_t root;
182 
183 	root = OF_finddevice("/");
184 	if (!ofw_bus_node_is_compatible(root, "nvidia,tegra124"))
185 		return;
186 	if (device_find_child(parent, "tegra124_coretemp", -1) != NULL)
187 		return;
188 	if (BUS_ADD_CHILD(parent, 0, "tegra124_coretemp", -1) == NULL)
189 		device_printf(parent, "add child failed\n");
190 }
191 
192 static int
193 tegra124_coretemp_probe(device_t dev)
194 {
195 
196 	device_set_desc(dev, "CPU Thermal Sensor");
197 	return (0);
198 }
199 
200 static int
201 tegra124_coretemp_attach(device_t dev)
202 {
203 	struct tegra124_coretemp_softc *sc;
204 	device_t pdev;
205 	struct sysctl_oid *oid;
206 	struct sysctl_ctx_list *ctx;
207 	int rv;
208 
209 	sc = device_get_softc(dev);
210 	sc->dev = dev;
211 	sc->cpu_id = device_get_unit(dev);
212 	sc->core_max_temp = 102000;
213 	pdev = device_get_parent(dev);
214 
215 	rv = tegra124_coretemp_ofw_parse(sc);
216 	if (rv != 0)
217 		return (rv);
218 
219 	ctx = device_get_sysctl_ctx(dev);
220 
221 	oid = SYSCTL_ADD_NODE(ctx,
222 	    SYSCTL_CHILDREN(device_get_sysctl_tree(pdev)), OID_AUTO,
223 	    "coretemp", CTLFLAG_RD | CTLFLAG_MPSAFE, NULL,
224 	    "Per-CPU thermal information");
225 
226 	/*
227 	 * Add the MIBs to dev.cpu.N and dev.cpu.N.coretemp.
228 	 */
229 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(device_get_sysctl_tree(pdev)),
230 	    OID_AUTO, "temperature", CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE,
231 	    dev, CORETEMP_TEMP, coretemp_get_val_sysctl, "IK",
232 	    "Current temperature");
233 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO, "delta",
234 	    CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, dev, CORETEMP_DELTA,
235 	    coretemp_get_val_sysctl, "I",
236 	    "Delta between TCC activation and current temperature");
237 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO, "resolution",
238 	    CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, dev, CORETEMP_RESOLUTION,
239 	    coretemp_get_val_sysctl, "I",
240 	    "Resolution of CPU thermal sensor");
241 	SYSCTL_ADD_PROC(ctx, SYSCTL_CHILDREN(oid), OID_AUTO, "tjmax",
242 	    CTLTYPE_INT | CTLFLAG_RD | CTLFLAG_MPSAFE, dev, CORETEMP_TJMAX,
243 	    coretemp_get_val_sysctl, "IK",
244 	    "TCC activation temperature");
245 
246 	return (0);
247 }
248 
249 static int
250 tegra124_coretemp_detach(device_t dev)
251 {
252 	struct tegra124_coretemp_softc *sc;
253 
254 	sc = device_get_softc(dev);
255 	return (0);
256 }
257 
258 static device_method_t tegra124_coretemp_methods[] = {
259 	/* Device interface */
260 	DEVMETHOD(device_identify,	tegra124_coretemp_identify),
261 	DEVMETHOD(device_probe,		tegra124_coretemp_probe),
262 	DEVMETHOD(device_attach,	tegra124_coretemp_attach),
263 	DEVMETHOD(device_detach,	tegra124_coretemp_detach),
264 
265 
266 	DEVMETHOD_END
267 };
268 
269 static devclass_t tegra124_coretemp_devclass;
270 static DEFINE_CLASS_0(tegra124_coretemp, tegra124_coretemp_driver,
271     tegra124_coretemp_methods, sizeof(struct tegra124_coretemp_softc));
272 DRIVER_MODULE(tegra124_coretemp, cpu, tegra124_coretemp_driver,
273     tegra124_coretemp_devclass, NULL, NULL);
274