2 * OMAP thermal driver interface
4 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
6 * Eduardo Valentin <eduardo.valentin@ti.com>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
24 #include <linux/device.h>
25 #include <linux/err.h>
26 #include <linux/mutex.h>
27 #include <linux/gfp.h>
28 #include <linux/kernel.h>
29 #include <linux/workqueue.h>
30 #include <linux/thermal.h>
31 #include <linux/cpumask.h>
32 #include <linux/cpu_cooling.h>
35 #include "ti-thermal.h"
36 #include "ti-bandgap.h"
38 /* common data structures */
39 struct ti_thermal_data {
40 struct thermal_zone_device *ti_thermal;
41 struct thermal_zone_device *pcb_tz;
42 struct thermal_cooling_device *cool_dev;
43 struct ti_bandgap *bgp;
44 enum thermal_device_mode mode;
45 struct work_struct thermal_wq;
50 static void ti_thermal_work(struct work_struct *work)
52 struct ti_thermal_data *data = container_of(work,
53 struct ti_thermal_data, thermal_wq);
55 thermal_zone_device_update(data->ti_thermal, THERMAL_EVENT_UNSPECIFIED);
57 dev_dbg(&data->ti_thermal->device, "updated thermal zone %s\n",
58 data->ti_thermal->type);
62 * ti_thermal_hotspot_temperature - returns sensor extrapolated temperature
63 * @t: omap sensor temperature
64 * @s: omap sensor slope value
65 * @c: omap sensor const value
67 static inline int ti_thermal_hotspot_temperature(int t, int s, int c)
69 int delta = t * s / 1000 + c;
77 /* thermal zone ops */
78 /* Get temperature callback function for thermal zone */
79 static inline int __ti_thermal_get_temp(void *devdata, int *temp)
81 struct thermal_zone_device *pcb_tz = NULL;
82 struct ti_thermal_data *data = devdata;
83 struct ti_bandgap *bgp;
84 const struct ti_temp_sensor *s;
85 int ret, tmp, slope, constant;
92 s = &bgp->conf->sensors[data->sensor_id];
94 ret = ti_bandgap_read_temperature(bgp, data->sensor_id, &tmp);
98 /* Default constants */
100 constant = s->constant;
102 pcb_tz = data->pcb_tz;
103 /* In case pcb zone is available, use the extrapolation rule with it */
104 if (!IS_ERR(pcb_tz)) {
105 ret = thermal_zone_get_temp(pcb_tz, &pcb_temp);
107 tmp -= pcb_temp; /* got a valid PCB temp */
108 slope = s->slope_pcb;
109 constant = s->constant_pcb;
112 "Failed to read PCB state. Using defaults\n");
116 *temp = ti_thermal_hotspot_temperature(tmp, slope, constant);
121 static inline int ti_thermal_get_temp(struct thermal_zone_device *thermal,
124 struct ti_thermal_data *data = thermal->devdata;
126 return __ti_thermal_get_temp(data, temp);
129 /* Bind callback functions for thermal zone */
130 static int ti_thermal_bind(struct thermal_zone_device *thermal,
131 struct thermal_cooling_device *cdev)
133 struct ti_thermal_data *data = thermal->devdata;
136 if (!data || IS_ERR(data))
139 /* check if this is the cooling device we registered */
140 if (data->cool_dev != cdev)
143 id = data->sensor_id;
145 /* Simple thing, two trips, one passive another critical */
146 return thermal_zone_bind_cooling_device(thermal, 0, cdev,
147 /* bind with min and max states defined by cpu_cooling */
150 THERMAL_WEIGHT_DEFAULT);
153 /* Unbind callback functions for thermal zone */
154 static int ti_thermal_unbind(struct thermal_zone_device *thermal,
155 struct thermal_cooling_device *cdev)
157 struct ti_thermal_data *data = thermal->devdata;
159 if (!data || IS_ERR(data))
162 /* check if this is the cooling device we registered */
163 if (data->cool_dev != cdev)
166 /* Simple thing, two trips, one passive another critical */
167 return thermal_zone_unbind_cooling_device(thermal, 0, cdev);
170 /* Get mode callback functions for thermal zone */
171 static int ti_thermal_get_mode(struct thermal_zone_device *thermal,
172 enum thermal_device_mode *mode)
174 struct ti_thermal_data *data = thermal->devdata;
182 /* Set mode callback functions for thermal zone */
183 static int ti_thermal_set_mode(struct thermal_zone_device *thermal,
184 enum thermal_device_mode mode)
186 struct ti_thermal_data *data = thermal->devdata;
187 struct ti_bandgap *bgp;
191 if (!data->ti_thermal) {
192 dev_notice(&thermal->device, "thermal zone not registered\n");
196 mutex_lock(&data->ti_thermal->lock);
198 if (mode == THERMAL_DEVICE_ENABLED)
199 data->ti_thermal->polling_delay = FAST_TEMP_MONITORING_RATE;
201 data->ti_thermal->polling_delay = 0;
203 mutex_unlock(&data->ti_thermal->lock);
206 ti_bandgap_write_update_interval(bgp, data->sensor_id,
207 data->ti_thermal->polling_delay);
208 thermal_zone_device_update(data->ti_thermal, THERMAL_EVENT_UNSPECIFIED);
209 dev_dbg(&thermal->device, "thermal polling set for duration=%d msec\n",
210 data->ti_thermal->polling_delay);
215 /* Get trip type callback functions for thermal zone */
216 static int ti_thermal_get_trip_type(struct thermal_zone_device *thermal,
217 int trip, enum thermal_trip_type *type)
219 if (!ti_thermal_is_valid_trip(trip))
222 if (trip + 1 == OMAP_TRIP_NUMBER)
223 *type = THERMAL_TRIP_CRITICAL;
225 *type = THERMAL_TRIP_PASSIVE;
230 /* Get trip temperature callback functions for thermal zone */
231 static int ti_thermal_get_trip_temp(struct thermal_zone_device *thermal,
234 if (!ti_thermal_is_valid_trip(trip))
237 *temp = ti_thermal_get_trip_value(trip);
242 static int __ti_thermal_get_trend(void *p, int trip, enum thermal_trend *trend)
244 struct ti_thermal_data *data = p;
245 struct ti_bandgap *bgp;
249 id = data->sensor_id;
251 ret = ti_bandgap_get_trend(bgp, id, &tr);
256 *trend = THERMAL_TREND_RAISING;
258 *trend = THERMAL_TREND_DROPPING;
260 *trend = THERMAL_TREND_STABLE;
265 /* Get the temperature trend callback functions for thermal zone */
266 static int ti_thermal_get_trend(struct thermal_zone_device *thermal,
267 int trip, enum thermal_trend *trend)
269 return __ti_thermal_get_trend(thermal->devdata, trip, trend);
272 /* Get critical temperature callback functions for thermal zone */
273 static int ti_thermal_get_crit_temp(struct thermal_zone_device *thermal,
277 return ti_thermal_get_trip_temp(thermal, OMAP_TRIP_NUMBER - 1, temp);
280 static const struct thermal_zone_of_device_ops ti_of_thermal_ops = {
281 .get_temp = __ti_thermal_get_temp,
282 .get_trend = __ti_thermal_get_trend,
285 static struct thermal_zone_device_ops ti_thermal_ops = {
286 .get_temp = ti_thermal_get_temp,
287 .get_trend = ti_thermal_get_trend,
288 .bind = ti_thermal_bind,
289 .unbind = ti_thermal_unbind,
290 .get_mode = ti_thermal_get_mode,
291 .set_mode = ti_thermal_set_mode,
292 .get_trip_type = ti_thermal_get_trip_type,
293 .get_trip_temp = ti_thermal_get_trip_temp,
294 .get_crit_temp = ti_thermal_get_crit_temp,
297 static struct ti_thermal_data
298 *ti_thermal_build_data(struct ti_bandgap *bgp, int id)
300 struct ti_thermal_data *data;
302 data = devm_kzalloc(bgp->dev, sizeof(*data), GFP_KERNEL);
304 dev_err(bgp->dev, "kzalloc fail\n");
307 data->sensor_id = id;
309 data->mode = THERMAL_DEVICE_ENABLED;
310 /* pcb_tz will be either valid or PTR_ERR() */
311 data->pcb_tz = thermal_zone_get_zone_by_name("pcb");
312 INIT_WORK(&data->thermal_wq, ti_thermal_work);
317 int ti_thermal_expose_sensor(struct ti_bandgap *bgp, int id,
320 struct ti_thermal_data *data;
322 data = ti_bandgap_get_sensor_data(bgp, id);
324 if (!data || IS_ERR(data))
325 data = ti_thermal_build_data(bgp, id);
330 /* in case this is specified by DT */
331 data->ti_thermal = devm_thermal_zone_of_sensor_register(bgp->dev, id,
332 data, &ti_of_thermal_ops);
333 if (IS_ERR(data->ti_thermal)) {
334 /* Create thermal zone */
335 data->ti_thermal = thermal_zone_device_register(domain,
336 OMAP_TRIP_NUMBER, 0, data, &ti_thermal_ops,
337 NULL, FAST_TEMP_MONITORING_RATE,
338 FAST_TEMP_MONITORING_RATE);
339 if (IS_ERR(data->ti_thermal)) {
340 dev_err(bgp->dev, "thermal zone device is NULL\n");
341 return PTR_ERR(data->ti_thermal);
343 data->ti_thermal->polling_delay = FAST_TEMP_MONITORING_RATE;
344 data->our_zone = true;
346 ti_bandgap_set_sensor_data(bgp, id, data);
347 ti_bandgap_write_update_interval(bgp, data->sensor_id,
348 data->ti_thermal->polling_delay);
353 int ti_thermal_remove_sensor(struct ti_bandgap *bgp, int id)
355 struct ti_thermal_data *data;
357 data = ti_bandgap_get_sensor_data(bgp, id);
359 if (data && data->ti_thermal) {
361 thermal_zone_device_unregister(data->ti_thermal);
367 int ti_thermal_report_sensor_temperature(struct ti_bandgap *bgp, int id)
369 struct ti_thermal_data *data;
371 data = ti_bandgap_get_sensor_data(bgp, id);
373 schedule_work(&data->thermal_wq);
378 int ti_thermal_register_cpu_cooling(struct ti_bandgap *bgp, int id)
380 struct ti_thermal_data *data;
381 struct device_node *np = bgp->dev->of_node;
384 * We are assuming here that if one deploys the zone
385 * using DT, then it must be aware that the cooling device
386 * loading has to happen via cpufreq driver.
388 if (of_find_property(np, "#thermal-sensor-cells", NULL))
391 data = ti_bandgap_get_sensor_data(bgp, id);
392 if (!data || IS_ERR(data))
393 data = ti_thermal_build_data(bgp, id);
398 /* Register cooling device */
399 data->cool_dev = cpufreq_cooling_register(cpu_present_mask);
400 if (IS_ERR(data->cool_dev)) {
401 int ret = PTR_ERR(data->cool_dev);
403 if (ret != -EPROBE_DEFER)
405 "Failed to register cpu cooling device %d\n",
410 ti_bandgap_set_sensor_data(bgp, id, data);
415 int ti_thermal_unregister_cpu_cooling(struct ti_bandgap *bgp, int id)
417 struct ti_thermal_data *data;
419 data = ti_bandgap_get_sensor_data(bgp, id);
422 cpufreq_cooling_unregister(data->cool_dev);