blob: e145b66df444e65bb5cc4f9d7e7ed4dce7f76435 [file] [log] [blame]
Eduardo Valentin4e5e4702013-07-03 15:35:39 -04001/*
2 * of-thermal.c - Generic Thermal Management device tree support.
3 *
4 * Copyright (C) 2013 Texas Instruments
5 * Copyright (C) 2013 Eduardo Valentin <eduardo.valentin@ti.com>
6 *
7 *
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2 of the License.
13 *
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
22 *
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 */
25#include <linux/thermal.h>
26#include <linux/slab.h>
27#include <linux/types.h>
28#include <linux/of_device.h>
29#include <linux/of_platform.h>
30#include <linux/err.h>
31#include <linux/export.h>
32#include <linux/string.h>
Eduardo Valentin2251aef2014-11-07 21:24:39 -040033#include <linux/thermal.h>
Eduardo Valentin4e5e4702013-07-03 15:35:39 -040034
35#include "thermal_core.h"
36
37/*** Private data structures to represent thermal device tree data ***/
38
39/**
Eduardo Valentin4e5e4702013-07-03 15:35:39 -040040 * struct __thermal_bind_param - a match between trip and cooling device
41 * @cooling_device: a pointer to identify the referred cooling device
42 * @trip_id: the trip point index
43 * @usage: the percentage (from 0 to 100) of cooling contribution
44 * @min: minimum cooling state used at this trip point
45 * @max: maximum cooling state used at this trip point
46 */
47
48struct __thermal_bind_params {
49 struct device_node *cooling_device;
50 unsigned int trip_id;
51 unsigned int usage;
52 unsigned long min;
53 unsigned long max;
54};
55
56/**
57 * struct __thermal_zone - internal representation of a thermal zone
58 * @mode: current thermal zone device mode (enabled/disabled)
59 * @passive_delay: polling interval while passive cooling is activated
60 * @polling_delay: zone polling interval
61 * @ntrips: number of trip points
62 * @trips: an array of trip points (0..ntrips - 1)
63 * @num_tbps: number of thermal bind params
64 * @tbps: an array of thermal bind params (0..num_tbps - 1)
65 * @sensor_data: sensor private data used while reading temperature and trend
Eduardo Valentin2251aef2014-11-07 21:24:39 -040066 * @ops: set of callbacks to handle the thermal zone based on DT
Eduardo Valentin4e5e4702013-07-03 15:35:39 -040067 */
68
69struct __thermal_zone {
70 enum thermal_device_mode mode;
71 int passive_delay;
72 int polling_delay;
73
74 /* trip data */
75 int ntrips;
Lukasz Majewskiad9914a2014-12-08 18:04:19 +010076 struct thermal_trip *trips;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -040077
78 /* cooling binding data */
79 int num_tbps;
80 struct __thermal_bind_params *tbps;
81
82 /* sensor interface */
83 void *sensor_data;
Eduardo Valentin2251aef2014-11-07 21:24:39 -040084 const struct thermal_zone_of_device_ops *ops;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -040085};
86
87/*** DT thermal zone device callbacks ***/
88
89static int of_thermal_get_temp(struct thermal_zone_device *tz,
90 unsigned long *temp)
91{
92 struct __thermal_zone *data = tz->devdata;
93
Eduardo Valentin2251aef2014-11-07 21:24:39 -040094 if (!data->ops->get_temp)
Eduardo Valentin4e5e4702013-07-03 15:35:39 -040095 return -EINVAL;
96
Eduardo Valentin2251aef2014-11-07 21:24:39 -040097 return data->ops->get_temp(data->sensor_data, temp);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -040098}
99
Lukasz Majewski08dab662014-12-08 18:04:17 +0100100/**
101 * of_thermal_get_ntrips - function to export number of available trip
102 * points.
103 * @tz: pointer to a thermal zone
104 *
105 * This function is a globally visible wrapper to get number of trip points
106 * stored in the local struct __thermal_zone
107 *
108 * Return: number of available trip points, -ENODEV when data not available
109 */
110int of_thermal_get_ntrips(struct thermal_zone_device *tz)
111{
112 struct __thermal_zone *data = tz->devdata;
113
114 if (!data || IS_ERR(data))
115 return -ENODEV;
116
117 return data->ntrips;
118}
119EXPORT_SYMBOL_GPL(of_thermal_get_ntrips);
120
Lukasz Majewskia9bf2cc2014-12-08 18:04:18 +0100121/**
122 * of_thermal_is_trip_valid - function to check if trip point is valid
123 *
124 * @tz: pointer to a thermal zone
125 * @trip: trip point to evaluate
126 *
127 * This function is responsible for checking if passed trip point is valid
128 *
129 * Return: true if trip point is valid, false otherwise
130 */
131bool of_thermal_is_trip_valid(struct thermal_zone_device *tz, int trip)
132{
133 struct __thermal_zone *data = tz->devdata;
134
135 if (!data || trip >= data->ntrips || trip < 0)
136 return false;
137
138 return true;
139}
140EXPORT_SYMBOL_GPL(of_thermal_is_trip_valid);
141
Lukasz Majewskice8be772014-12-08 18:04:20 +0100142/**
143 * of_thermal_get_trip_points - function to get access to a globally exported
144 * trip points
145 *
146 * @tz: pointer to a thermal zone
147 *
148 * This function provides a pointer to trip points table
149 *
150 * Return: pointer to trip points table, NULL otherwise
151 */
152const struct thermal_trip * const
153of_thermal_get_trip_points(struct thermal_zone_device *tz)
154{
155 struct __thermal_zone *data = tz->devdata;
156
157 if (!data)
158 return NULL;
159
160 return data->trips;
161}
162EXPORT_SYMBOL_GPL(of_thermal_get_trip_points);
163
Lukasz Majewski184a4bf2014-12-08 18:04:21 +0100164/**
165 * of_thermal_set_emul_temp - function to set emulated temperature
166 *
167 * @tz: pointer to a thermal zone
168 * @temp: temperature to set
169 *
170 * This function gives the ability to set emulated value of temperature,
171 * which is handy for debugging
172 *
173 * Return: zero on success, error code otherwise
174 */
175static int of_thermal_set_emul_temp(struct thermal_zone_device *tz,
176 unsigned long temp)
177{
178 struct __thermal_zone *data = tz->devdata;
179
180 if (!data->ops || !data->ops->set_emul_temp)
181 return -EINVAL;
182
183 return data->ops->set_emul_temp(data->sensor_data, temp);
184}
185
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400186static int of_thermal_get_trend(struct thermal_zone_device *tz, int trip,
187 enum thermal_trend *trend)
188{
189 struct __thermal_zone *data = tz->devdata;
190 long dev_trend;
191 int r;
192
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400193 if (!data->ops->get_trend)
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400194 return -EINVAL;
195
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400196 r = data->ops->get_trend(data->sensor_data, &dev_trend);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400197 if (r)
198 return r;
199
200 /* TODO: These intervals might have some thresholds, but in core code */
201 if (dev_trend > 0)
202 *trend = THERMAL_TREND_RAISING;
203 else if (dev_trend < 0)
204 *trend = THERMAL_TREND_DROPPING;
205 else
206 *trend = THERMAL_TREND_STABLE;
207
208 return 0;
209}
210
211static int of_thermal_bind(struct thermal_zone_device *thermal,
212 struct thermal_cooling_device *cdev)
213{
214 struct __thermal_zone *data = thermal->devdata;
215 int i;
216
217 if (!data || IS_ERR(data))
218 return -ENODEV;
219
220 /* find where to bind */
221 for (i = 0; i < data->num_tbps; i++) {
222 struct __thermal_bind_params *tbp = data->tbps + i;
223
224 if (tbp->cooling_device == cdev->np) {
225 int ret;
226
227 ret = thermal_zone_bind_cooling_device(thermal,
228 tbp->trip_id, cdev,
Punit Agrawaldd354b82014-06-03 10:59:58 +0100229 tbp->max,
230 tbp->min);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400231 if (ret)
232 return ret;
233 }
234 }
235
236 return 0;
237}
238
239static int of_thermal_unbind(struct thermal_zone_device *thermal,
240 struct thermal_cooling_device *cdev)
241{
242 struct __thermal_zone *data = thermal->devdata;
243 int i;
244
245 if (!data || IS_ERR(data))
246 return -ENODEV;
247
248 /* find where to unbind */
249 for (i = 0; i < data->num_tbps; i++) {
250 struct __thermal_bind_params *tbp = data->tbps + i;
251
252 if (tbp->cooling_device == cdev->np) {
253 int ret;
254
255 ret = thermal_zone_unbind_cooling_device(thermal,
256 tbp->trip_id, cdev);
257 if (ret)
258 return ret;
259 }
260 }
261
262 return 0;
263}
264
265static int of_thermal_get_mode(struct thermal_zone_device *tz,
266 enum thermal_device_mode *mode)
267{
268 struct __thermal_zone *data = tz->devdata;
269
270 *mode = data->mode;
271
272 return 0;
273}
274
275static int of_thermal_set_mode(struct thermal_zone_device *tz,
276 enum thermal_device_mode mode)
277{
278 struct __thermal_zone *data = tz->devdata;
279
280 mutex_lock(&tz->lock);
281
282 if (mode == THERMAL_DEVICE_ENABLED)
283 tz->polling_delay = data->polling_delay;
284 else
285 tz->polling_delay = 0;
286
287 mutex_unlock(&tz->lock);
288
289 data->mode = mode;
290 thermal_zone_device_update(tz);
291
292 return 0;
293}
294
295static int of_thermal_get_trip_type(struct thermal_zone_device *tz, int trip,
296 enum thermal_trip_type *type)
297{
298 struct __thermal_zone *data = tz->devdata;
299
300 if (trip >= data->ntrips || trip < 0)
301 return -EDOM;
302
303 *type = data->trips[trip].type;
304
305 return 0;
306}
307
308static int of_thermal_get_trip_temp(struct thermal_zone_device *tz, int trip,
309 unsigned long *temp)
310{
311 struct __thermal_zone *data = tz->devdata;
312
313 if (trip >= data->ntrips || trip < 0)
314 return -EDOM;
315
316 *temp = data->trips[trip].temperature;
317
318 return 0;
319}
320
321static int of_thermal_set_trip_temp(struct thermal_zone_device *tz, int trip,
322 unsigned long temp)
323{
324 struct __thermal_zone *data = tz->devdata;
325
326 if (trip >= data->ntrips || trip < 0)
327 return -EDOM;
328
329 /* thermal framework should take care of data->mask & (1 << trip) */
330 data->trips[trip].temperature = temp;
331
332 return 0;
333}
334
335static int of_thermal_get_trip_hyst(struct thermal_zone_device *tz, int trip,
336 unsigned long *hyst)
337{
338 struct __thermal_zone *data = tz->devdata;
339
340 if (trip >= data->ntrips || trip < 0)
341 return -EDOM;
342
343 *hyst = data->trips[trip].hysteresis;
344
345 return 0;
346}
347
348static int of_thermal_set_trip_hyst(struct thermal_zone_device *tz, int trip,
349 unsigned long hyst)
350{
351 struct __thermal_zone *data = tz->devdata;
352
353 if (trip >= data->ntrips || trip < 0)
354 return -EDOM;
355
356 /* thermal framework should take care of data->mask & (1 << trip) */
357 data->trips[trip].hysteresis = hyst;
358
359 return 0;
360}
361
362static int of_thermal_get_crit_temp(struct thermal_zone_device *tz,
363 unsigned long *temp)
364{
365 struct __thermal_zone *data = tz->devdata;
366 int i;
367
368 for (i = 0; i < data->ntrips; i++)
369 if (data->trips[i].type == THERMAL_TRIP_CRITICAL) {
370 *temp = data->trips[i].temperature;
371 return 0;
372 }
373
374 return -EINVAL;
375}
376
377static struct thermal_zone_device_ops of_thermal_ops = {
378 .get_mode = of_thermal_get_mode,
379 .set_mode = of_thermal_set_mode,
380
381 .get_trip_type = of_thermal_get_trip_type,
382 .get_trip_temp = of_thermal_get_trip_temp,
383 .set_trip_temp = of_thermal_set_trip_temp,
384 .get_trip_hyst = of_thermal_get_trip_hyst,
385 .set_trip_hyst = of_thermal_set_trip_hyst,
386 .get_crit_temp = of_thermal_get_crit_temp,
387
388 .bind = of_thermal_bind,
389 .unbind = of_thermal_unbind,
390};
391
392/*** sensor API ***/
393
394static struct thermal_zone_device *
395thermal_zone_of_add_sensor(struct device_node *zone,
396 struct device_node *sensor, void *data,
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400397 const struct thermal_zone_of_device_ops *ops)
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400398{
399 struct thermal_zone_device *tzd;
400 struct __thermal_zone *tz;
401
402 tzd = thermal_zone_get_zone_by_name(zone->name);
403 if (IS_ERR(tzd))
404 return ERR_PTR(-EPROBE_DEFER);
405
406 tz = tzd->devdata;
407
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400408 if (!ops)
409 return ERR_PTR(-EINVAL);
410
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400411 mutex_lock(&tzd->lock);
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400412 tz->ops = ops;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400413 tz->sensor_data = data;
414
415 tzd->ops->get_temp = of_thermal_get_temp;
416 tzd->ops->get_trend = of_thermal_get_trend;
Lukasz Majewski184a4bf2014-12-08 18:04:21 +0100417 tzd->ops->set_emul_temp = of_thermal_set_emul_temp;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400418 mutex_unlock(&tzd->lock);
419
420 return tzd;
421}
422
423/**
424 * thermal_zone_of_sensor_register - registers a sensor to a DT thermal zone
425 * @dev: a valid struct device pointer of a sensor device. Must contain
426 * a valid .of_node, for the sensor node.
427 * @sensor_id: a sensor identifier, in case the sensor IP has more
428 * than one sensors
429 * @data: a private pointer (owned by the caller) that will be passed
430 * back, when a temperature reading is needed.
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400431 * @ops: struct thermal_zone_of_device_ops *. Must contain at least .get_temp.
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400432 *
433 * This function will search the list of thermal zones described in device
434 * tree and look for the zone that refer to the sensor device pointed by
435 * @dev->of_node as temperature providers. For the zone pointing to the
436 * sensor node, the sensor will be added to the DT thermal zone device.
437 *
438 * The thermal zone temperature is provided by the @get_temp function
439 * pointer. When called, it will have the private pointer @data back.
440 *
441 * The thermal zone temperature trend is provided by the @get_trend function
442 * pointer. When called, it will have the private pointer @data back.
443 *
444 * TODO:
445 * 01 - This function must enqueue the new sensor instead of using
446 * it as the only source of temperature values.
447 *
448 * 02 - There must be a way to match the sensor with all thermal zones
449 * that refer to it.
450 *
451 * Return: On success returns a valid struct thermal_zone_device,
452 * otherwise, it returns a corresponding ERR_PTR(). Caller must
453 * check the return value with help of IS_ERR() helper.
454 */
455struct thermal_zone_device *
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400456thermal_zone_of_sensor_register(struct device *dev, int sensor_id, void *data,
457 const struct thermal_zone_of_device_ops *ops)
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400458{
459 struct device_node *np, *child, *sensor_np;
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300460 struct thermal_zone_device *tzd = ERR_PTR(-ENODEV);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400461
462 np = of_find_node_by_name(NULL, "thermal-zones");
463 if (!np)
464 return ERR_PTR(-ENODEV);
465
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300466 if (!dev || !dev->of_node) {
467 of_node_put(np);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400468 return ERR_PTR(-EINVAL);
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300469 }
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400470
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300471 sensor_np = of_node_get(dev->of_node);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400472
473 for_each_child_of_node(np, child) {
474 struct of_phandle_args sensor_specs;
475 int ret, id;
476
Laxman Dewangana0202792014-07-25 15:31:58 +0530477 /* Check whether child is enabled or not */
478 if (!of_device_is_available(child))
479 continue;
480
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400481 /* For now, thermal framework supports only 1 sensor per zone */
482 ret = of_parse_phandle_with_args(child, "thermal-sensors",
483 "#thermal-sensor-cells",
484 0, &sensor_specs);
485 if (ret)
486 continue;
487
488 if (sensor_specs.args_count >= 1) {
489 id = sensor_specs.args[0];
490 WARN(sensor_specs.args_count > 1,
491 "%s: too many cells in sensor specifier %d\n",
492 sensor_specs.np->name, sensor_specs.args_count);
493 } else {
494 id = 0;
495 }
496
497 if (sensor_specs.np == sensor_np && id == sensor_id) {
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300498 tzd = thermal_zone_of_add_sensor(child, sensor_np,
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400499 data, ops);
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300500 of_node_put(sensor_specs.np);
501 of_node_put(child);
502 goto exit;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400503 }
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300504 of_node_put(sensor_specs.np);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400505 }
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300506exit:
507 of_node_put(sensor_np);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400508 of_node_put(np);
509
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300510 return tzd;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400511}
512EXPORT_SYMBOL_GPL(thermal_zone_of_sensor_register);
513
514/**
515 * thermal_zone_of_sensor_unregister - unregisters a sensor from a DT thermal zone
516 * @dev: a valid struct device pointer of a sensor device. Must contain
517 * a valid .of_node, for the sensor node.
518 * @tzd: a pointer to struct thermal_zone_device where the sensor is registered.
519 *
520 * This function removes the sensor callbacks and private data from the
521 * thermal zone device registered with thermal_zone_of_sensor_register()
522 * API. It will also silent the zone by remove the .get_temp() and .get_trend()
523 * thermal zone device callbacks.
524 *
525 * TODO: When the support to several sensors per zone is added, this
526 * function must search the sensor list based on @dev parameter.
527 *
528 */
529void thermal_zone_of_sensor_unregister(struct device *dev,
530 struct thermal_zone_device *tzd)
531{
532 struct __thermal_zone *tz;
533
534 if (!dev || !tzd || !tzd->devdata)
535 return;
536
537 tz = tzd->devdata;
538
539 /* no __thermal_zone, nothing to be done */
540 if (!tz)
541 return;
542
543 mutex_lock(&tzd->lock);
544 tzd->ops->get_temp = NULL;
545 tzd->ops->get_trend = NULL;
Lukasz Majewski184a4bf2014-12-08 18:04:21 +0100546 tzd->ops->set_emul_temp = NULL;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400547
Eduardo Valentin2251aef2014-11-07 21:24:39 -0400548 tz->ops = NULL;
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400549 tz->sensor_data = NULL;
550 mutex_unlock(&tzd->lock);
551}
552EXPORT_SYMBOL_GPL(thermal_zone_of_sensor_unregister);
553
554/*** functions parsing device tree nodes ***/
555
556/**
557 * thermal_of_populate_bind_params - parse and fill cooling map data
558 * @np: DT node containing a cooling-map node
559 * @__tbp: data structure to be filled with cooling map info
560 * @trips: array of thermal zone trip points
561 * @ntrips: number of trip points inside trips.
562 *
563 * This function parses a cooling-map type of node represented by
564 * @np parameter and fills the read data into @__tbp data structure.
565 * It needs the already parsed array of trip points of the thermal zone
566 * in consideration.
567 *
568 * Return: 0 on success, proper error code otherwise
569 */
570static int thermal_of_populate_bind_params(struct device_node *np,
571 struct __thermal_bind_params *__tbp,
Lukasz Majewskiad9914a2014-12-08 18:04:19 +0100572 struct thermal_trip *trips,
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400573 int ntrips)
574{
575 struct of_phandle_args cooling_spec;
576 struct device_node *trip;
577 int ret, i;
578 u32 prop;
579
580 /* Default weight. Usage is optional */
581 __tbp->usage = 0;
582 ret = of_property_read_u32(np, "contribution", &prop);
583 if (ret == 0)
584 __tbp->usage = prop;
585
586 trip = of_parse_phandle(np, "trip", 0);
587 if (!trip) {
588 pr_err("missing trip property\n");
589 return -ENODEV;
590 }
591
592 /* match using device_node */
593 for (i = 0; i < ntrips; i++)
594 if (trip == trips[i].np) {
595 __tbp->trip_id = i;
596 break;
597 }
598
599 if (i == ntrips) {
600 ret = -ENODEV;
601 goto end;
602 }
603
604 ret = of_parse_phandle_with_args(np, "cooling-device", "#cooling-cells",
605 0, &cooling_spec);
606 if (ret < 0) {
607 pr_err("missing cooling_device property\n");
608 goto end;
609 }
610 __tbp->cooling_device = cooling_spec.np;
611 if (cooling_spec.args_count >= 2) { /* at least min and max */
612 __tbp->min = cooling_spec.args[0];
613 __tbp->max = cooling_spec.args[1];
614 } else {
615 pr_err("wrong reference to cooling device, missing limits\n");
616 }
617
618end:
619 of_node_put(trip);
620
621 return ret;
622}
623
624/**
625 * It maps 'enum thermal_trip_type' found in include/linux/thermal.h
626 * into the device tree binding of 'trip', property type.
627 */
628static const char * const trip_types[] = {
629 [THERMAL_TRIP_ACTIVE] = "active",
630 [THERMAL_TRIP_PASSIVE] = "passive",
631 [THERMAL_TRIP_HOT] = "hot",
632 [THERMAL_TRIP_CRITICAL] = "critical",
633};
634
635/**
636 * thermal_of_get_trip_type - Get phy mode for given device_node
637 * @np: Pointer to the given device_node
638 * @type: Pointer to resulting trip type
639 *
640 * The function gets trip type string from property 'type',
641 * and store its index in trip_types table in @type,
642 *
643 * Return: 0 on success, or errno in error case.
644 */
645static int thermal_of_get_trip_type(struct device_node *np,
646 enum thermal_trip_type *type)
647{
648 const char *t;
649 int err, i;
650
651 err = of_property_read_string(np, "type", &t);
652 if (err < 0)
653 return err;
654
655 for (i = 0; i < ARRAY_SIZE(trip_types); i++)
656 if (!strcasecmp(t, trip_types[i])) {
657 *type = i;
658 return 0;
659 }
660
661 return -ENODEV;
662}
663
664/**
665 * thermal_of_populate_trip - parse and fill one trip point data
666 * @np: DT node containing a trip point node
667 * @trip: trip point data structure to be filled up
668 *
669 * This function parses a trip point type of node represented by
670 * @np parameter and fills the read data into @trip data structure.
671 *
672 * Return: 0 on success, proper error code otherwise
673 */
674static int thermal_of_populate_trip(struct device_node *np,
Lukasz Majewskiad9914a2014-12-08 18:04:19 +0100675 struct thermal_trip *trip)
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400676{
677 int prop;
678 int ret;
679
680 ret = of_property_read_u32(np, "temperature", &prop);
681 if (ret < 0) {
682 pr_err("missing temperature property\n");
683 return ret;
684 }
685 trip->temperature = prop;
686
687 ret = of_property_read_u32(np, "hysteresis", &prop);
688 if (ret < 0) {
689 pr_err("missing hysteresis property\n");
690 return ret;
691 }
692 trip->hysteresis = prop;
693
694 ret = thermal_of_get_trip_type(np, &trip->type);
695 if (ret < 0) {
696 pr_err("wrong trip type property\n");
697 return ret;
698 }
699
700 /* Required for cooling map matching */
701 trip->np = np;
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300702 of_node_get(np);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400703
704 return 0;
705}
706
707/**
708 * thermal_of_build_thermal_zone - parse and fill one thermal zone data
709 * @np: DT node containing a thermal zone node
710 *
711 * This function parses a thermal zone type of node represented by
712 * @np parameter and fills the read data into a __thermal_zone data structure
713 * and return this pointer.
714 *
715 * TODO: Missing properties to parse: thermal-sensor-names and coefficients
716 *
717 * Return: On success returns a valid struct __thermal_zone,
718 * otherwise, it returns a corresponding ERR_PTR(). Caller must
719 * check the return value with help of IS_ERR() helper.
720 */
721static struct __thermal_zone *
722thermal_of_build_thermal_zone(struct device_node *np)
723{
724 struct device_node *child = NULL, *gchild;
725 struct __thermal_zone *tz;
726 int ret, i;
727 u32 prop;
728
729 if (!np) {
730 pr_err("no thermal zone np\n");
731 return ERR_PTR(-EINVAL);
732 }
733
734 tz = kzalloc(sizeof(*tz), GFP_KERNEL);
735 if (!tz)
736 return ERR_PTR(-ENOMEM);
737
738 ret = of_property_read_u32(np, "polling-delay-passive", &prop);
739 if (ret < 0) {
740 pr_err("missing polling-delay-passive property\n");
741 goto free_tz;
742 }
743 tz->passive_delay = prop;
744
745 ret = of_property_read_u32(np, "polling-delay", &prop);
746 if (ret < 0) {
747 pr_err("missing polling-delay property\n");
748 goto free_tz;
749 }
750 tz->polling_delay = prop;
751
752 /* trips */
753 child = of_get_child_by_name(np, "trips");
754
755 /* No trips provided */
756 if (!child)
757 goto finish;
758
759 tz->ntrips = of_get_child_count(child);
760 if (tz->ntrips == 0) /* must have at least one child */
761 goto finish;
762
763 tz->trips = kzalloc(tz->ntrips * sizeof(*tz->trips), GFP_KERNEL);
764 if (!tz->trips) {
765 ret = -ENOMEM;
766 goto free_tz;
767 }
768
769 i = 0;
770 for_each_child_of_node(child, gchild) {
771 ret = thermal_of_populate_trip(gchild, &tz->trips[i++]);
772 if (ret)
773 goto free_trips;
774 }
775
776 of_node_put(child);
777
778 /* cooling-maps */
779 child = of_get_child_by_name(np, "cooling-maps");
780
781 /* cooling-maps not provided */
782 if (!child)
783 goto finish;
784
785 tz->num_tbps = of_get_child_count(child);
786 if (tz->num_tbps == 0)
787 goto finish;
788
789 tz->tbps = kzalloc(tz->num_tbps * sizeof(*tz->tbps), GFP_KERNEL);
790 if (!tz->tbps) {
791 ret = -ENOMEM;
792 goto free_trips;
793 }
794
795 i = 0;
Stephen Boydca9521b2014-06-18 16:32:08 -0700796 for_each_child_of_node(child, gchild) {
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400797 ret = thermal_of_populate_bind_params(gchild, &tz->tbps[i++],
798 tz->trips, tz->ntrips);
799 if (ret)
800 goto free_tbps;
Stephen Boydca9521b2014-06-18 16:32:08 -0700801 }
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400802
803finish:
804 of_node_put(child);
805 tz->mode = THERMAL_DEVICE_DISABLED;
806
807 return tz;
808
809free_tbps:
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300810 for (i = 0; i < tz->num_tbps; i++)
811 of_node_put(tz->tbps[i].cooling_device);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400812 kfree(tz->tbps);
813free_trips:
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300814 for (i = 0; i < tz->ntrips; i++)
815 of_node_put(tz->trips[i].np);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400816 kfree(tz->trips);
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300817 of_node_put(gchild);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400818free_tz:
819 kfree(tz);
820 of_node_put(child);
821
822 return ERR_PTR(ret);
823}
824
825static inline void of_thermal_free_zone(struct __thermal_zone *tz)
826{
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300827 int i;
828
829 for (i = 0; i < tz->num_tbps; i++)
830 of_node_put(tz->tbps[i].cooling_device);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400831 kfree(tz->tbps);
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300832 for (i = 0; i < tz->ntrips; i++)
833 of_node_put(tz->trips[i].np);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400834 kfree(tz->trips);
835 kfree(tz);
836}
837
838/**
839 * of_parse_thermal_zones - parse device tree thermal data
840 *
841 * Initialization function that can be called by machine initialization
842 * code to parse thermal data and populate the thermal framework
843 * with hardware thermal zones info. This function only parses thermal zones.
844 * Cooling devices and sensor devices nodes are supposed to be parsed
845 * by their respective drivers.
846 *
847 * Return: 0 on success, proper error code otherwise
848 *
849 */
850int __init of_parse_thermal_zones(void)
851{
852 struct device_node *np, *child;
853 struct __thermal_zone *tz;
854 struct thermal_zone_device_ops *ops;
855
856 np = of_find_node_by_name(NULL, "thermal-zones");
857 if (!np) {
858 pr_debug("unable to find thermal zones\n");
859 return 0; /* Run successfully on systems without thermal DT */
860 }
861
862 for_each_child_of_node(np, child) {
863 struct thermal_zone_device *zone;
864 struct thermal_zone_params *tzp;
865
Laxman Dewangana0202792014-07-25 15:31:58 +0530866 /* Check whether child is enabled or not */
867 if (!of_device_is_available(child))
868 continue;
869
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400870 tz = thermal_of_build_thermal_zone(child);
871 if (IS_ERR(tz)) {
872 pr_err("failed to build thermal zone %s: %ld\n",
873 child->name,
874 PTR_ERR(tz));
875 continue;
876 }
877
878 ops = kmemdup(&of_thermal_ops, sizeof(*ops), GFP_KERNEL);
879 if (!ops)
880 goto exit_free;
881
882 tzp = kzalloc(sizeof(*tzp), GFP_KERNEL);
883 if (!tzp) {
884 kfree(ops);
885 goto exit_free;
886 }
887
888 /* No hwmon because there might be hwmon drivers registering */
889 tzp->no_hwmon = true;
890
891 zone = thermal_zone_device_register(child->name, tz->ntrips,
892 0, tz,
893 ops, tzp,
894 tz->passive_delay,
895 tz->polling_delay);
896 if (IS_ERR(zone)) {
897 pr_err("Failed to build %s zone %ld\n", child->name,
898 PTR_ERR(zone));
899 kfree(tzp);
900 kfree(ops);
901 of_thermal_free_zone(tz);
902 /* attempting to build remaining zones still */
903 }
904 }
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300905 of_node_put(np);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400906
907 return 0;
908
909exit_free:
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300910 of_node_put(child);
911 of_node_put(np);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400912 of_thermal_free_zone(tz);
913
914 /* no memory available, so free what we have built */
915 of_thermal_destroy_zones();
916
917 return -ENOMEM;
918}
919
920/**
921 * of_thermal_destroy_zones - remove all zones parsed and allocated resources
922 *
923 * Finds all zones parsed and added to the thermal framework and remove them
924 * from the system, together with their resources.
925 *
926 */
927void of_thermal_destroy_zones(void)
928{
929 struct device_node *np, *child;
930
931 np = of_find_node_by_name(NULL, "thermal-zones");
932 if (!np) {
933 pr_err("unable to find thermal zones\n");
934 return;
935 }
936
937 for_each_child_of_node(np, child) {
938 struct thermal_zone_device *zone;
939
Laxman Dewangana0202792014-07-25 15:31:58 +0530940 /* Check whether child is enabled or not */
941 if (!of_device_is_available(child))
942 continue;
943
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400944 zone = thermal_zone_get_zone_by_name(child->name);
945 if (IS_ERR(zone))
946 continue;
947
948 thermal_zone_device_unregister(zone);
949 kfree(zone->tzp);
950 kfree(zone->ops);
951 of_thermal_free_zone(zone->devdata);
952 }
Vladimir Zapolskiyc2aad93c2014-09-29 02:47:46 +0300953 of_node_put(np);
Eduardo Valentin4e5e4702013-07-03 15:35:39 -0400954}