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/cpufreq.h>
32 #include <linux/cpumask.h>
33 #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;
49 static void ti_thermal_work(struct work_struct *work)
51 struct ti_thermal_data *data = container_of(work,
52 struct ti_thermal_data, thermal_wq);
54 thermal_zone_device_update(data->ti_thermal);
56 dev_dbg(&data->ti_thermal->device, "updated thermal zone %s\n",
57 data->ti_thermal->type);
61 * ti_thermal_hotspot_temperature - returns sensor extrapolated temperature
62 * @t: omap sensor temperature
63 * @s: omap sensor slope value
64 * @c: omap sensor const value
66 static inline int ti_thermal_hotspot_temperature(int t, int s, int c)
68 int delta = t * s / 1000 + c;
76 /* thermal zone ops */
77 /* Get temperature callback function for thermal zone*/
78 static inline int ti_thermal_get_temp(struct thermal_zone_device *thermal,
81 struct thermal_zone_device *pcb_tz = NULL;
82 struct ti_thermal_data *data = thermal->devdata;
83 struct ti_bandgap *bgp;
84 const struct ti_temp_sensor *s;
85 int ret, tmp, slope, constant;
86 unsigned long pcb_temp;
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");
115 *temp = ti_thermal_hotspot_temperature(tmp, slope, constant);
120 /* Bind callback functions for thermal zone */
121 static int ti_thermal_bind(struct thermal_zone_device *thermal,
122 struct thermal_cooling_device *cdev)
124 struct ti_thermal_data *data = thermal->devdata;
127 if (!data || IS_ERR(data))
130 /* check if this is the cooling device we registered */
131 if (data->cool_dev != cdev)
134 id = data->sensor_id;
136 /* Simple thing, two trips, one passive another critical */
137 return thermal_zone_bind_cooling_device(thermal, 0, cdev,
138 /* bind with min and max states defined by cpu_cooling */
143 /* Unbind callback functions for thermal zone */
144 static int ti_thermal_unbind(struct thermal_zone_device *thermal,
145 struct thermal_cooling_device *cdev)
147 struct ti_thermal_data *data = thermal->devdata;
149 if (!data || IS_ERR(data))
152 /* check if this is the cooling device we registered */
153 if (data->cool_dev != cdev)
156 /* Simple thing, two trips, one passive another critical */
157 return thermal_zone_unbind_cooling_device(thermal, 0, cdev);
160 /* Get mode callback functions for thermal zone */
161 static int ti_thermal_get_mode(struct thermal_zone_device *thermal,
162 enum thermal_device_mode *mode)
164 struct ti_thermal_data *data = thermal->devdata;
172 /* Set mode callback functions for thermal zone */
173 static int ti_thermal_set_mode(struct thermal_zone_device *thermal,
174 enum thermal_device_mode mode)
176 struct ti_thermal_data *data = thermal->devdata;
178 if (!data->ti_thermal) {
179 dev_notice(&thermal->device, "thermal zone not registered\n");
183 mutex_lock(&data->ti_thermal->lock);
185 if (mode == THERMAL_DEVICE_ENABLED)
186 data->ti_thermal->polling_delay = FAST_TEMP_MONITORING_RATE;
188 data->ti_thermal->polling_delay = 0;
190 mutex_unlock(&data->ti_thermal->lock);
193 thermal_zone_device_update(data->ti_thermal);
194 dev_dbg(&thermal->device, "thermal polling set for duration=%d msec\n",
195 data->ti_thermal->polling_delay);
200 /* Get trip type callback functions for thermal zone */
201 static int ti_thermal_get_trip_type(struct thermal_zone_device *thermal,
202 int trip, enum thermal_trip_type *type)
204 if (!ti_thermal_is_valid_trip(trip))
207 if (trip + 1 == OMAP_TRIP_NUMBER)
208 *type = THERMAL_TRIP_CRITICAL;
210 *type = THERMAL_TRIP_PASSIVE;
215 /* Get trip temperature callback functions for thermal zone */
216 static int ti_thermal_get_trip_temp(struct thermal_zone_device *thermal,
217 int trip, unsigned long *temp)
219 if (!ti_thermal_is_valid_trip(trip))
222 *temp = ti_thermal_get_trip_value(trip);
227 /* Get the temperature trend callback functions for thermal zone */
228 static int ti_thermal_get_trend(struct thermal_zone_device *thermal,
229 int trip, enum thermal_trend *trend)
231 struct ti_thermal_data *data = thermal->devdata;
232 struct ti_bandgap *bgp;
236 id = data->sensor_id;
238 ret = ti_bandgap_get_trend(bgp, id, &tr);
243 *trend = THERMAL_TREND_RAISING;
245 *trend = THERMAL_TREND_DROPPING;
247 *trend = THERMAL_TREND_STABLE;
252 /* Get critical temperature callback functions for thermal zone */
253 static int ti_thermal_get_crit_temp(struct thermal_zone_device *thermal,
257 return ti_thermal_get_trip_temp(thermal, OMAP_TRIP_NUMBER - 1, temp);
260 static struct thermal_zone_device_ops ti_thermal_ops = {
261 .get_temp = ti_thermal_get_temp,
262 .get_trend = ti_thermal_get_trend,
263 .bind = ti_thermal_bind,
264 .unbind = ti_thermal_unbind,
265 .get_mode = ti_thermal_get_mode,
266 .set_mode = ti_thermal_set_mode,
267 .get_trip_type = ti_thermal_get_trip_type,
268 .get_trip_temp = ti_thermal_get_trip_temp,
269 .get_crit_temp = ti_thermal_get_crit_temp,
272 static struct ti_thermal_data
273 *ti_thermal_build_data(struct ti_bandgap *bgp, int id)
275 struct ti_thermal_data *data;
277 data = devm_kzalloc(bgp->dev, sizeof(*data), GFP_KERNEL);
279 dev_err(bgp->dev, "kzalloc fail\n");
282 data->sensor_id = id;
284 data->mode = THERMAL_DEVICE_ENABLED;
285 /* pcb_tz will be either valid or PTR_ERR() */
286 data->pcb_tz = thermal_zone_get_zone_by_name("pcb");
287 INIT_WORK(&data->thermal_wq, ti_thermal_work);
292 int ti_thermal_expose_sensor(struct ti_bandgap *bgp, int id,
295 struct ti_thermal_data *data;
297 data = ti_bandgap_get_sensor_data(bgp, id);
299 if (!data || IS_ERR(data))
300 data = ti_thermal_build_data(bgp, id);
305 /* Create thermal zone */
306 data->ti_thermal = thermal_zone_device_register(domain,
307 OMAP_TRIP_NUMBER, 0, data, &ti_thermal_ops,
308 NULL, FAST_TEMP_MONITORING_RATE,
309 FAST_TEMP_MONITORING_RATE);
310 if (IS_ERR(data->ti_thermal)) {
311 dev_err(bgp->dev, "thermal zone device is NULL\n");
312 return PTR_ERR(data->ti_thermal);
314 data->ti_thermal->polling_delay = FAST_TEMP_MONITORING_RATE;
315 ti_bandgap_set_sensor_data(bgp, id, data);
320 int ti_thermal_remove_sensor(struct ti_bandgap *bgp, int id)
322 struct ti_thermal_data *data;
324 data = ti_bandgap_get_sensor_data(bgp, id);
326 thermal_zone_device_unregister(data->ti_thermal);
331 int ti_thermal_report_sensor_temperature(struct ti_bandgap *bgp, int id)
333 struct ti_thermal_data *data;
335 data = ti_bandgap_get_sensor_data(bgp, id);
337 schedule_work(&data->thermal_wq);
342 int ti_thermal_register_cpu_cooling(struct ti_bandgap *bgp, int id)
344 struct ti_thermal_data *data;
346 data = ti_bandgap_get_sensor_data(bgp, id);
347 if (!data || IS_ERR(data))
348 data = ti_thermal_build_data(bgp, id);
353 if (!cpufreq_get_current_driver()) {
354 dev_dbg(bgp->dev, "no cpufreq driver yet\n");
355 return -EPROBE_DEFER;
358 /* Register cooling device */
359 data->cool_dev = cpufreq_cooling_register(cpu_present_mask);
360 if (IS_ERR(data->cool_dev)) {
362 "Failed to register cpufreq cooling device\n");
363 return PTR_ERR(data->cool_dev);
365 ti_bandgap_set_sensor_data(bgp, id, data);
370 int ti_thermal_unregister_cpu_cooling(struct ti_bandgap *bgp, int id)
372 struct ti_thermal_data *data;
374 data = ti_bandgap_get_sensor_data(bgp, id);
375 cpufreq_cooling_unregister(data->cool_dev);