staging: ti-soc-thermal: update TODO list
[deliverable/linux.git] / drivers / staging / ti-soc-thermal / ti-thermal-common.c
CommitLineData
445eaf87
EV
1/*
2 * OMAP thermal driver interface
3 *
4 * Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
5 * Contact:
6 * Eduardo Valentin <eduardo.valentin@ti.com>
7 *
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.
11 *
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.
16 *
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
20 * 02110-1301 USA
21 *
22 */
23
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>
5035d48d 32#include <linux/cpumask.h>
445eaf87
EV
33#include <linux/cpu_cooling.h>
34
7372add4
EV
35#include "ti-thermal.h"
36#include "ti-bandgap.h"
445eaf87
EV
37
38/* common data structures */
03e859d3
EV
39struct ti_thermal_data {
40 struct thermal_zone_device *ti_thermal;
445eaf87 41 struct thermal_cooling_device *cool_dev;
03e859d3 42 struct ti_bandgap *bgp;
445eaf87
EV
43 enum thermal_device_mode mode;
44 struct work_struct thermal_wq;
45 int sensor_id;
46};
47
03e859d3 48static void ti_thermal_work(struct work_struct *work)
445eaf87 49{
03e859d3
EV
50 struct ti_thermal_data *data = container_of(work,
51 struct ti_thermal_data, thermal_wq);
445eaf87 52
03e859d3 53 thermal_zone_device_update(data->ti_thermal);
445eaf87 54
03e859d3
EV
55 dev_dbg(&data->ti_thermal->device, "updated thermal zone %s\n",
56 data->ti_thermal->type);
445eaf87
EV
57}
58
59/**
03e859d3 60 * ti_thermal_hotspot_temperature - returns sensor extrapolated temperature
445eaf87
EV
61 * @t: omap sensor temperature
62 * @s: omap sensor slope value
63 * @c: omap sensor const value
64 */
03e859d3 65static inline int ti_thermal_hotspot_temperature(int t, int s, int c)
445eaf87
EV
66{
67 int delta = t * s / 1000 + c;
68
69 if (delta < 0)
70 delta = 0;
71
72 return t + delta;
73}
74
75/* thermal zone ops */
76/* Get temperature callback function for thermal zone*/
03e859d3
EV
77static inline int ti_thermal_get_temp(struct thermal_zone_device *thermal,
78 unsigned long *temp)
445eaf87 79{
03e859d3
EV
80 struct ti_thermal_data *data = thermal->devdata;
81 struct ti_bandgap *bgp;
9879b2c4 82 const struct ti_temp_sensor *s;
445eaf87
EV
83 int ret, tmp, pcb_temp, slope, constant;
84
04a4d10d
EV
85 if (!data)
86 return 0;
87
d7f080e6
EV
88 bgp = data->bgp;
89 s = &bgp->conf->sensors[data->sensor_id];
04a4d10d 90
03e859d3 91 ret = ti_bandgap_read_temperature(bgp, data->sensor_id, &tmp);
445eaf87
EV
92 if (ret)
93 return ret;
94
95 pcb_temp = 0;
96 /* TODO: Introduce pcb temperature lookup */
97 /* In case pcb zone is available, use the extrapolation rule with it */
98 if (pcb_temp) {
99 tmp -= pcb_temp;
100 slope = s->slope_pcb;
101 constant = s->constant_pcb;
102 } else {
103 slope = s->slope;
104 constant = s->constant;
105 }
03e859d3 106 *temp = ti_thermal_hotspot_temperature(tmp, slope, constant);
445eaf87
EV
107
108 return ret;
109}
110
111/* Bind callback functions for thermal zone */
03e859d3
EV
112static int ti_thermal_bind(struct thermal_zone_device *thermal,
113 struct thermal_cooling_device *cdev)
445eaf87 114{
03e859d3 115 struct ti_thermal_data *data = thermal->devdata;
5035d48d 116 int id;
445eaf87
EV
117
118 if (IS_ERR_OR_NULL(data))
119 return -ENODEV;
120
121 /* check if this is the cooling device we registered */
122 if (data->cool_dev != cdev)
123 return 0;
124
125 id = data->sensor_id;
445eaf87
EV
126
127 /* TODO: bind with min and max states */
128 /* Simple thing, two trips, one passive another critical */
a7a3b8c8
EV
129 return thermal_zone_bind_cooling_device(thermal, 0, cdev,
130 THERMAL_NO_LIMIT,
131 THERMAL_NO_LIMIT);
445eaf87
EV
132}
133
134/* Unbind callback functions for thermal zone */
03e859d3
EV
135static int ti_thermal_unbind(struct thermal_zone_device *thermal,
136 struct thermal_cooling_device *cdev)
445eaf87 137{
03e859d3 138 struct ti_thermal_data *data = thermal->devdata;
445eaf87
EV
139
140 if (IS_ERR_OR_NULL(data))
141 return -ENODEV;
142
143 /* check if this is the cooling device we registered */
144 if (data->cool_dev != cdev)
145 return 0;
146
147 /* Simple thing, two trips, one passive another critical */
148 return thermal_zone_unbind_cooling_device(thermal, 0, cdev);
149}
150
151/* Get mode callback functions for thermal zone */
03e859d3
EV
152static int ti_thermal_get_mode(struct thermal_zone_device *thermal,
153 enum thermal_device_mode *mode)
445eaf87 154{
03e859d3 155 struct ti_thermal_data *data = thermal->devdata;
445eaf87
EV
156
157 if (data)
158 *mode = data->mode;
159
160 return 0;
161}
162
163/* Set mode callback functions for thermal zone */
03e859d3
EV
164static int ti_thermal_set_mode(struct thermal_zone_device *thermal,
165 enum thermal_device_mode mode)
445eaf87 166{
03e859d3 167 struct ti_thermal_data *data = thermal->devdata;
445eaf87 168
03e859d3 169 if (!data->ti_thermal) {
445eaf87
EV
170 dev_notice(&thermal->device, "thermal zone not registered\n");
171 return 0;
172 }
173
03e859d3 174 mutex_lock(&data->ti_thermal->lock);
445eaf87
EV
175
176 if (mode == THERMAL_DEVICE_ENABLED)
03e859d3 177 data->ti_thermal->polling_delay = FAST_TEMP_MONITORING_RATE;
445eaf87 178 else
03e859d3 179 data->ti_thermal->polling_delay = 0;
445eaf87 180
03e859d3 181 mutex_unlock(&data->ti_thermal->lock);
445eaf87
EV
182
183 data->mode = mode;
03e859d3 184 thermal_zone_device_update(data->ti_thermal);
445eaf87 185 dev_dbg(&thermal->device, "thermal polling set for duration=%d msec\n",
03e859d3 186 data->ti_thermal->polling_delay);
445eaf87
EV
187
188 return 0;
189}
190
191/* Get trip type callback functions for thermal zone */
03e859d3
EV
192static int ti_thermal_get_trip_type(struct thermal_zone_device *thermal,
193 int trip, enum thermal_trip_type *type)
445eaf87 194{
03e859d3 195 if (!ti_thermal_is_valid_trip(trip))
445eaf87
EV
196 return -EINVAL;
197
198 if (trip + 1 == OMAP_TRIP_NUMBER)
199 *type = THERMAL_TRIP_CRITICAL;
200 else
201 *type = THERMAL_TRIP_PASSIVE;
202
203 return 0;
204}
205
206/* Get trip temperature callback functions for thermal zone */
03e859d3
EV
207static int ti_thermal_get_trip_temp(struct thermal_zone_device *thermal,
208 int trip, unsigned long *temp)
445eaf87 209{
03e859d3 210 if (!ti_thermal_is_valid_trip(trip))
445eaf87
EV
211 return -EINVAL;
212
03e859d3 213 *temp = ti_thermal_get_trip_value(trip);
445eaf87
EV
214
215 return 0;
216}
217
03b7f67b
K
218/* Get the temperature trend callback functions for thermal zone */
219static int ti_thermal_get_trend(struct thermal_zone_device *thermal,
220 int trip, enum thermal_trend *trend)
221{
222 struct ti_thermal_data *data = thermal->devdata;
223 struct ti_bandgap *bgp;
224 int id, tr, ret = 0;
225
226 bgp = data->bgp;
227 id = data->sensor_id;
228
229 ret = ti_bandgap_get_trend(bgp, id, &tr);
230 if (ret)
231 return ret;
232
233 if (tr > 0)
234 *trend = THERMAL_TREND_RAISING;
235 else if (tr < 0)
236 *trend = THERMAL_TREND_DROPPING;
237 else
238 *trend = THERMAL_TREND_STABLE;
239
240 return 0;
241}
242
445eaf87 243/* Get critical temperature callback functions for thermal zone */
03e859d3
EV
244static int ti_thermal_get_crit_temp(struct thermal_zone_device *thermal,
245 unsigned long *temp)
445eaf87
EV
246{
247 /* shutdown zone */
03e859d3 248 return ti_thermal_get_trip_temp(thermal, OMAP_TRIP_NUMBER - 1, temp);
445eaf87
EV
249}
250
03e859d3
EV
251static struct thermal_zone_device_ops ti_thermal_ops = {
252 .get_temp = ti_thermal_get_temp,
03b7f67b 253 .get_trend = ti_thermal_get_trend,
03e859d3
EV
254 .bind = ti_thermal_bind,
255 .unbind = ti_thermal_unbind,
256 .get_mode = ti_thermal_get_mode,
257 .set_mode = ti_thermal_set_mode,
258 .get_trip_type = ti_thermal_get_trip_type,
259 .get_trip_temp = ti_thermal_get_trip_temp,
260 .get_crit_temp = ti_thermal_get_crit_temp,
445eaf87
EV
261};
262
03e859d3
EV
263static struct ti_thermal_data
264*ti_thermal_build_data(struct ti_bandgap *bgp, int id)
445eaf87 265{
03e859d3 266 struct ti_thermal_data *data;
445eaf87 267
d7f080e6 268 data = devm_kzalloc(bgp->dev, sizeof(*data), GFP_KERNEL);
445eaf87 269 if (!data) {
d7f080e6 270 dev_err(bgp->dev, "kzalloc fail\n");
04a4d10d 271 return NULL;
445eaf87
EV
272 }
273 data->sensor_id = id;
d7f080e6 274 data->bgp = bgp;
445eaf87 275 data->mode = THERMAL_DEVICE_ENABLED;
03e859d3 276 INIT_WORK(&data->thermal_wq, ti_thermal_work);
445eaf87 277
04a4d10d
EV
278 return data;
279}
280
03e859d3
EV
281int ti_thermal_expose_sensor(struct ti_bandgap *bgp, int id,
282 char *domain)
04a4d10d 283{
03e859d3 284 struct ti_thermal_data *data;
04a4d10d 285
03e859d3 286 data = ti_bandgap_get_sensor_data(bgp, id);
04a4d10d 287
35b052a6 288 if (IS_ERR_OR_NULL(data))
03e859d3 289 data = ti_thermal_build_data(bgp, id);
04a4d10d
EV
290
291 if (!data)
292 return -EINVAL;
293
445eaf87
EV
294 /* TODO: remove TC1 TC2 */
295 /* Create thermal zone */
03e859d3
EV
296 data->ti_thermal = thermal_zone_device_register(domain,
297 OMAP_TRIP_NUMBER, 0, data, &ti_thermal_ops,
50125a9b 298 NULL, FAST_TEMP_MONITORING_RATE,
765a1939 299 FAST_TEMP_MONITORING_RATE);
03e859d3 300 if (IS_ERR_OR_NULL(data->ti_thermal)) {
d7f080e6 301 dev_err(bgp->dev, "thermal zone device is NULL\n");
03e859d3 302 return PTR_ERR(data->ti_thermal);
445eaf87 303 }
03e859d3
EV
304 data->ti_thermal->polling_delay = FAST_TEMP_MONITORING_RATE;
305 ti_bandgap_set_sensor_data(bgp, id, data);
445eaf87
EV
306
307 return 0;
308}
309
03e859d3 310int ti_thermal_remove_sensor(struct ti_bandgap *bgp, int id)
445eaf87 311{
03e859d3 312 struct ti_thermal_data *data;
445eaf87 313
03e859d3 314 data = ti_bandgap_get_sensor_data(bgp, id);
445eaf87 315
03e859d3 316 thermal_zone_device_unregister(data->ti_thermal);
445eaf87
EV
317
318 return 0;
319}
320
03e859d3 321int ti_thermal_report_sensor_temperature(struct ti_bandgap *bgp, int id)
445eaf87 322{
03e859d3 323 struct ti_thermal_data *data;
445eaf87 324
03e859d3 325 data = ti_bandgap_get_sensor_data(bgp, id);
445eaf87
EV
326
327 schedule_work(&data->thermal_wq);
328
329 return 0;
330}
331
03e859d3 332int ti_thermal_register_cpu_cooling(struct ti_bandgap *bgp, int id)
445eaf87 333{
03e859d3 334 struct ti_thermal_data *data;
445eaf87 335
03e859d3 336 data = ti_bandgap_get_sensor_data(bgp, id);
35b052a6 337 if (IS_ERR_OR_NULL(data))
03e859d3 338 data = ti_thermal_build_data(bgp, id);
04a4d10d
EV
339
340 if (!data)
341 return -EINVAL;
445eaf87 342
445eaf87 343 /* Register cooling device */
5035d48d 344 data->cool_dev = cpufreq_cooling_register(cpu_present_mask);
445eaf87 345 if (IS_ERR_OR_NULL(data->cool_dev)) {
d7f080e6 346 dev_err(bgp->dev,
445eaf87
EV
347 "Failed to register cpufreq cooling device\n");
348 return PTR_ERR(data->cool_dev);
349 }
03e859d3 350 ti_bandgap_set_sensor_data(bgp, id, data);
445eaf87
EV
351
352 return 0;
353}
354
03e859d3 355int ti_thermal_unregister_cpu_cooling(struct ti_bandgap *bgp, int id)
445eaf87 356{
03e859d3 357 struct ti_thermal_data *data;
445eaf87 358
03e859d3 359 data = ti_bandgap_get_sensor_data(bgp, id);
445eaf87
EV
360 cpufreq_cooling_unregister(data->cool_dev);
361
362 return 0;
363}
This page took 0.139592 seconds and 5 git commands to generate.