Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * of-thermal.c - Generic Thermal Management device tree support.
4 *
5 * Copyright (C) 2013 Texas Instruments
6 * Copyright (C) 2013 Eduardo Valentin <eduardo.valentin@ti.com>
7 */
8
9#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10
11#include <linux/err.h>
12#include <linux/export.h>
13#include <linux/of.h>
14#include <linux/slab.h>
15#include <linux/thermal.h>
16#include <linux/types.h>
17#include <linux/string.h>
18
19#include "thermal_core.h"
20
21/*** functions parsing device tree nodes ***/
22
23static int of_find_trip_id(struct device_node *np, struct device_node *trip)
24{
25 struct device_node *trips;
26 struct device_node *t;
27 int i = 0;
28
29 trips = of_get_child_by_name(np, "trips");
30 if (!trips) {
31 pr_err("Failed to find 'trips' node\n");
32 return -EINVAL;
33 }
34
35 /*
36 * Find the trip id point associated with the cooling device map
37 */
38 for_each_child_of_node(trips, t) {
39
40 if (t == trip) {
41 of_node_put(t);
42 goto out;
43 }
44 i++;
45 }
46
47 i = -ENXIO;
48out:
49 of_node_put(trips);
50
51 return i;
52}
53
54/*
55 * It maps 'enum thermal_trip_type' found in include/linux/thermal.h
56 * into the device tree binding of 'trip', property type.
57 */
58static const char * const trip_types[] = {
59 [THERMAL_TRIP_ACTIVE] = "active",
60 [THERMAL_TRIP_PASSIVE] = "passive",
61 [THERMAL_TRIP_HOT] = "hot",
62 [THERMAL_TRIP_CRITICAL] = "critical",
63};
64
65/**
66 * thermal_of_get_trip_type - Get phy mode for given device_node
67 * @np: Pointer to the given device_node
68 * @type: Pointer to resulting trip type
69 *
70 * The function gets trip type string from property 'type',
71 * and store its index in trip_types table in @type,
72 *
73 * Return: 0 on success, or errno in error case.
74 */
75static int thermal_of_get_trip_type(struct device_node *np,
76 enum thermal_trip_type *type)
77{
78 const char *t;
79 int err, i;
80
81 err = of_property_read_string(np, "type", &t);
82 if (err < 0)
83 return err;
84
85 for (i = 0; i < ARRAY_SIZE(trip_types); i++)
86 if (!strcasecmp(t, trip_types[i])) {
87 *type = i;
88 return 0;
89 }
90
91 return -ENODEV;
92}
93
94static int thermal_of_populate_trip(struct device_node *np,
95 struct thermal_trip *trip)
96{
97 int prop;
98 int ret;
99
100 ret = of_property_read_u32(np, "temperature", &prop);
101 if (ret < 0) {
102 pr_err("missing temperature property\n");
103 return ret;
104 }
105 trip->temperature = prop;
106
107 ret = of_property_read_u32(np, "hysteresis", &prop);
108 if (ret < 0) {
109 pr_err("missing hysteresis property\n");
110 return ret;
111 }
112 trip->hysteresis = prop;
113
114 ret = thermal_of_get_trip_type(np, &trip->type);
115 if (ret < 0) {
116 pr_err("wrong trip type property\n");
117 return ret;
118 }
119
120 return 0;
121}
122
123static struct thermal_trip *thermal_of_trips_init(struct device_node *np, int *ntrips)
124{
125 struct thermal_trip *tt;
126 struct device_node *trips, *trip;
127 int ret, count;
128
129 trips = of_get_child_by_name(np, "trips");
130 if (!trips) {
131 pr_err("Failed to find 'trips' node\n");
132 return ERR_PTR(-EINVAL);
133 }
134
135 count = of_get_child_count(trips);
136 if (!count) {
137 pr_err("No trip point defined\n");
138 ret = -EINVAL;
139 goto out_of_node_put;
140 }
141
142 tt = kzalloc(sizeof(*tt) * count, GFP_KERNEL);
143 if (!tt) {
144 ret = -ENOMEM;
145 goto out_of_node_put;
146 }
147
148 *ntrips = count;
149
150 count = 0;
151 for_each_child_of_node(trips, trip) {
152 ret = thermal_of_populate_trip(trip, &tt[count++]);
153 if (ret)
154 goto out_kfree;
155 }
156
157 of_node_put(trips);
158
159 return tt;
160
161out_kfree:
162 kfree(tt);
163 *ntrips = 0;
164out_of_node_put:
165 of_node_put(trips);
166
167 return ERR_PTR(ret);
168}
169
170static struct device_node *of_thermal_zone_find(struct device_node *sensor, int id)
171{
172 struct device_node *np, *tz;
173 struct of_phandle_args sensor_specs;
174
175 np = of_find_node_by_name(NULL, "thermal-zones");
176 if (!np) {
177 pr_debug("No thermal zones description\n");
178 return ERR_PTR(-ENODEV);
179 }
180
181 /*
182 * Search for each thermal zone, a defined sensor
183 * corresponding to the one passed as parameter
184 */
185 for_each_available_child_of_node(np, tz) {
186
187 int count, i;
188
189 count = of_count_phandle_with_args(tz, "thermal-sensors",
190 "#thermal-sensor-cells");
191 if (count <= 0) {
192 pr_err("%pOFn: missing thermal sensor\n", tz);
193 tz = ERR_PTR(-EINVAL);
194 goto out;
195 }
196
197 for (i = 0; i < count; i++) {
198
199 int ret;
200
201 ret = of_parse_phandle_with_args(tz, "thermal-sensors",
202 "#thermal-sensor-cells",
203 i, &sensor_specs);
204 if (ret < 0) {
205 pr_err("%pOFn: Failed to read thermal-sensors cells: %d\n", tz, ret);
206 tz = ERR_PTR(ret);
207 goto out;
208 }
209
210 if ((sensor == sensor_specs.np) && id == (sensor_specs.args_count ?
211 sensor_specs.args[0] : 0)) {
212 pr_debug("sensor %pOFn id=%d belongs to %pOFn\n", sensor, id, tz);
213 goto out;
214 }
215 }
216 }
217 tz = ERR_PTR(-ENODEV);
218out:
219 of_node_put(np);
220 return tz;
221}
222
223static int thermal_of_monitor_init(struct device_node *np, int *delay, int *pdelay)
224{
225 int ret;
226
227 ret = of_property_read_u32(np, "polling-delay-passive", pdelay);
228 if (ret < 0) {
229 pr_err("%pOFn: missing polling-delay-passive property\n", np);
230 return ret;
231 }
232
233 ret = of_property_read_u32(np, "polling-delay", delay);
234 if (ret < 0) {
235 pr_err("%pOFn: missing polling-delay property\n", np);
236 return ret;
237 }
238
239 return 0;
240}
241
242static void thermal_of_parameters_init(struct device_node *np,
243 struct thermal_zone_params *tzp)
244{
245 int coef[2];
246 int ncoef = ARRAY_SIZE(coef);
247 int prop, ret;
248
249 tzp->no_hwmon = true;
250
251 if (!of_property_read_u32(np, "sustainable-power", &prop))
252 tzp->sustainable_power = prop;
253
254 /*
255 * For now, the thermal framework supports only one sensor per
256 * thermal zone. Thus, we are considering only the first two
257 * values as slope and offset.
258 */
259 ret = of_property_read_u32_array(np, "coefficients", coef, ncoef);
260 if (ret) {
261 coef[0] = 1;
262 coef[1] = 0;
263 }
264
265 tzp->slope = coef[0];
266 tzp->offset = coef[1];
267}
268
269static struct device_node *thermal_of_zone_get_by_name(struct thermal_zone_device *tz)
270{
271 struct device_node *np, *tz_np;
272
273 np = of_find_node_by_name(NULL, "thermal-zones");
274 if (!np)
275 return ERR_PTR(-ENODEV);
276
277 tz_np = of_get_child_by_name(np, tz->type);
278
279 of_node_put(np);
280
281 if (!tz_np)
282 return ERR_PTR(-ENODEV);
283
284 return tz_np;
285}
286
287static int __thermal_of_unbind(struct device_node *map_np, int index, int trip_id,
288 struct thermal_zone_device *tz, struct thermal_cooling_device *cdev)
289{
290 struct of_phandle_args cooling_spec;
291 int ret;
292
293 ret = of_parse_phandle_with_args(map_np, "cooling-device", "#cooling-cells",
294 index, &cooling_spec);
295
296 if (ret < 0) {
297 pr_err("Invalid cooling-device entry\n");
298 return ret;
299 }
300
301 of_node_put(cooling_spec.np);
302
303 if (cooling_spec.args_count < 2) {
304 pr_err("wrong reference to cooling device, missing limits\n");
305 return -EINVAL;
306 }
307
308 if (cooling_spec.np != cdev->np)
309 return 0;
310
311 ret = thermal_zone_unbind_cooling_device(tz, trip_id, cdev);
312 if (ret)
313 pr_err("Failed to unbind '%s' with '%s': %d\n", tz->type, cdev->type, ret);
314
315 return ret;
316}
317
318static int __thermal_of_bind(struct device_node *map_np, int index, int trip_id,
319 struct thermal_zone_device *tz, struct thermal_cooling_device *cdev)
320{
321 struct of_phandle_args cooling_spec;
322 int ret, weight = THERMAL_WEIGHT_DEFAULT;
323
324 of_property_read_u32(map_np, "contribution", &weight);
325
326 ret = of_parse_phandle_with_args(map_np, "cooling-device", "#cooling-cells",
327 index, &cooling_spec);
328
329 if (ret < 0) {
330 pr_err("Invalid cooling-device entry\n");
331 return ret;
332 }
333
334 of_node_put(cooling_spec.np);
335
336 if (cooling_spec.args_count < 2) {
337 pr_err("wrong reference to cooling device, missing limits\n");
338 return -EINVAL;
339 }
340
341 if (cooling_spec.np != cdev->np)
342 return 0;
343
344 ret = thermal_zone_bind_cooling_device(tz, trip_id, cdev, cooling_spec.args[1],
345 cooling_spec.args[0],
346 weight);
347 if (ret)
348 pr_err("Failed to bind '%s' with '%s': %d\n", tz->type, cdev->type, ret);
349
350 return ret;
351}
352
353static int thermal_of_for_each_cooling_device(struct device_node *tz_np, struct device_node *map_np,
354 struct thermal_zone_device *tz, struct thermal_cooling_device *cdev,
355 int (*action)(struct device_node *, int, int,
356 struct thermal_zone_device *, struct thermal_cooling_device *))
357{
358 struct device_node *tr_np;
359 int count, i, trip_id;
360
361 tr_np = of_parse_phandle(map_np, "trip", 0);
362 if (!tr_np)
363 return -ENODEV;
364
365 trip_id = of_find_trip_id(tz_np, tr_np);
366 if (trip_id < 0)
367 return trip_id;
368
369 count = of_count_phandle_with_args(map_np, "cooling-device", "#cooling-cells");
370 if (count <= 0) {
371 pr_err("Add a cooling_device property with at least one device\n");
372 return -ENOENT;
373 }
374
375 /*
376 * At this point, we don't want to bail out when there is an
377 * error, we will try to bind/unbind as many as possible
378 * cooling devices
379 */
380 for (i = 0; i < count; i++)
381 action(map_np, i, trip_id, tz, cdev);
382
383 return 0;
384}
385
386static int thermal_of_for_each_cooling_maps(struct thermal_zone_device *tz,
387 struct thermal_cooling_device *cdev,
388 int (*action)(struct device_node *, int, int,
389 struct thermal_zone_device *, struct thermal_cooling_device *))
390{
391 struct device_node *tz_np, *cm_np, *child;
392 int ret = 0;
393
394 tz_np = thermal_of_zone_get_by_name(tz);
395 if (IS_ERR(tz_np)) {
396 pr_err("Failed to get node tz by name\n");
397 return PTR_ERR(tz_np);
398 }
399
400 cm_np = of_get_child_by_name(tz_np, "cooling-maps");
401 if (!cm_np)
402 goto out;
403
404 for_each_child_of_node(cm_np, child) {
405 ret = thermal_of_for_each_cooling_device(tz_np, child, tz, cdev, action);
406 if (ret) {
407 of_node_put(child);
408 break;
409 }
410 }
411
412 of_node_put(cm_np);
413out:
414 of_node_put(tz_np);
415
416 return ret;
417}
418
419static int thermal_of_bind(struct thermal_zone_device *tz,
420 struct thermal_cooling_device *cdev)
421{
422 return thermal_of_for_each_cooling_maps(tz, cdev, __thermal_of_bind);
423}
424
425static int thermal_of_unbind(struct thermal_zone_device *tz,
426 struct thermal_cooling_device *cdev)
427{
428 return thermal_of_for_each_cooling_maps(tz, cdev, __thermal_of_unbind);
429}
430
431/**
432 * thermal_of_zone_unregister - Cleanup the specific allocated ressources
433 *
434 * This function disables the thermal zone and frees the different
435 * ressources allocated specific to the thermal OF.
436 *
437 * @tz: a pointer to the thermal zone structure
438 */
439static void thermal_of_zone_unregister(struct thermal_zone_device *tz)
440{
441 struct thermal_trip *trips = tz->trips;
442 struct thermal_zone_device_ops *ops = tz->ops;
443
444 thermal_zone_device_disable(tz);
445 thermal_zone_device_unregister(tz);
446 kfree(trips);
447 kfree(ops);
448}
449
450/**
451 * thermal_of_zone_register - Register a thermal zone with device node
452 * sensor
453 *
454 * The thermal_of_zone_register() parses a device tree given a device
455 * node sensor and identifier. It searches for the thermal zone
456 * associated to the couple sensor/id and retrieves all the thermal
457 * zone properties and registers new thermal zone with those
458 * properties.
459 *
460 * @sensor: A device node pointer corresponding to the sensor in the device tree
461 * @id: An integer as sensor identifier
462 * @data: A private data to be stored in the thermal zone dedicated private area
463 * @ops: A set of thermal sensor ops
464 *
465 * Return: a valid thermal zone structure pointer on success.
466 * - EINVAL: if the device tree thermal description is malformed
467 * - ENOMEM: if one structure can not be allocated
468 * - Other negative errors are returned by the underlying called functions
469 */
470static struct thermal_zone_device *thermal_of_zone_register(struct device_node *sensor, int id, void *data,
471 const struct thermal_zone_device_ops *ops)
472{
473 struct thermal_zone_device *tz;
474 struct thermal_trip *trips;
475 struct thermal_zone_params tzp = {};
476 struct thermal_zone_device_ops *of_ops;
477 struct device_node *np;
478 const char *action;
479 int delay, pdelay;
480 int ntrips, mask;
481 int ret;
482
483 of_ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL);
484 if (!of_ops)
485 return ERR_PTR(-ENOMEM);
486
487 np = of_thermal_zone_find(sensor, id);
488 if (IS_ERR(np)) {
489 if (PTR_ERR(np) != -ENODEV)
490 pr_err("Failed to find thermal zone for %pOFn id=%d\n", sensor, id);
491 ret = PTR_ERR(np);
492 goto out_kfree_of_ops;
493 }
494
495 trips = thermal_of_trips_init(np, &ntrips);
496 if (IS_ERR(trips)) {
497 pr_err("Failed to find trip points for %pOFn id=%d\n", sensor, id);
498 ret = PTR_ERR(trips);
499 goto out_kfree_of_ops;
500 }
501
502 ret = thermal_of_monitor_init(np, &delay, &pdelay);
503 if (ret) {
504 pr_err("Failed to initialize monitoring delays from %pOFn\n", np);
505 goto out_kfree_trips;
506 }
507
508 thermal_of_parameters_init(np, &tzp);
509
510 of_ops->bind = thermal_of_bind;
511 of_ops->unbind = thermal_of_unbind;
512
513 mask = GENMASK_ULL((ntrips) - 1, 0);
514
515 ret = of_property_read_string(np, "critical-action", &action);
516 if (!ret)
517 if (!of_ops->critical && !strcasecmp(action, "reboot"))
518 of_ops->critical = thermal_zone_device_critical_reboot;
519
520 tz = thermal_zone_device_register_with_trips(np->name, trips, ntrips,
521 mask, data, of_ops, &tzp,
522 pdelay, delay);
523 if (IS_ERR(tz)) {
524 ret = PTR_ERR(tz);
525 pr_err("Failed to register thermal zone %pOFn: %d\n", np, ret);
526 goto out_kfree_trips;
527 }
528
529 ret = thermal_zone_device_enable(tz);
530 if (ret) {
531 pr_err("Failed to enabled thermal zone '%s', id=%d: %d\n",
532 tz->type, tz->id, ret);
533 thermal_of_zone_unregister(tz);
534 return ERR_PTR(ret);
535 }
536
537 return tz;
538
539out_kfree_trips:
540 kfree(trips);
541out_kfree_of_ops:
542 kfree(of_ops);
543
544 return ERR_PTR(ret);
545}
546
547static void devm_thermal_of_zone_release(struct device *dev, void *res)
548{
549 thermal_of_zone_unregister(*(struct thermal_zone_device **)res);
550}
551
552static int devm_thermal_of_zone_match(struct device *dev, void *res,
553 void *data)
554{
555 struct thermal_zone_device **r = res;
556
557 if (WARN_ON(!r || !*r))
558 return 0;
559
560 return *r == data;
561}
562
563/**
564 * devm_thermal_of_zone_register - register a thermal tied with the sensor life cycle
565 *
566 * This function is the device version of the thermal_of_zone_register() function.
567 *
568 * @dev: a device structure pointer to sensor to be tied with the thermal zone OF life cycle
569 * @sensor_id: the sensor identifier
570 * @data: a pointer to a private data to be stored in the thermal zone 'devdata' field
571 * @ops: a pointer to the ops structure associated with the sensor
572 */
573struct thermal_zone_device *devm_thermal_of_zone_register(struct device *dev, int sensor_id, void *data,
574 const struct thermal_zone_device_ops *ops)
575{
576 struct thermal_zone_device **ptr, *tzd;
577
578 ptr = devres_alloc(devm_thermal_of_zone_release, sizeof(*ptr),
579 GFP_KERNEL);
580 if (!ptr)
581 return ERR_PTR(-ENOMEM);
582
583 tzd = thermal_of_zone_register(dev->of_node, sensor_id, data, ops);
584 if (IS_ERR(tzd)) {
585 devres_free(ptr);
586 return tzd;
587 }
588
589 *ptr = tzd;
590 devres_add(dev, ptr);
591
592 return tzd;
593}
594EXPORT_SYMBOL_GPL(devm_thermal_of_zone_register);
595
596/**
597 * devm_thermal_of_zone_unregister - Resource managed version of
598 * thermal_of_zone_unregister().
599 * @dev: Device for which which resource was allocated.
600 * @tz: a pointer to struct thermal_zone where the sensor is registered.
601 *
602 * This function removes the sensor callbacks and private data from the
603 * thermal zone device registered with devm_thermal_zone_of_sensor_register()
604 * API. It will also silent the zone by remove the .get_temp() and .get_trend()
605 * thermal zone device callbacks.
606 * Normally this function will not need to be called and the resource
607 * management code will ensure that the resource is freed.
608 */
609void devm_thermal_of_zone_unregister(struct device *dev, struct thermal_zone_device *tz)
610{
611 WARN_ON(devres_release(dev, devm_thermal_of_zone_release,
612 devm_thermal_of_zone_match, tz));
613}
614EXPORT_SYMBOL_GPL(devm_thermal_of_zone_unregister);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * of-thermal.c - Generic Thermal Management device tree support.
4 *
5 * Copyright (C) 2013 Texas Instruments
6 * Copyright (C) 2013 Eduardo Valentin <eduardo.valentin@ti.com>
7 */
8
9#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10
11#include <linux/err.h>
12#include <linux/export.h>
13#include <linux/of_device.h>
14#include <linux/of_platform.h>
15#include <linux/slab.h>
16#include <linux/thermal.h>
17#include <linux/types.h>
18#include <linux/string.h>
19
20#include "thermal_core.h"
21
22/*** Private data structures to represent thermal device tree data ***/
23
24/**
25 * struct __thermal_cooling_bind_param - a cooling device for a trip point
26 * @cooling_device: a pointer to identify the referred cooling device
27 * @min: minimum cooling state used at this trip point
28 * @max: maximum cooling state used at this trip point
29 */
30
31struct __thermal_cooling_bind_param {
32 struct device_node *cooling_device;
33 unsigned long min;
34 unsigned long max;
35};
36
37/**
38 * struct __thermal_bind_param - a match between trip and cooling device
39 * @tcbp: a pointer to an array of cooling devices
40 * @count: number of elements in array
41 * @trip_id: the trip point index
42 * @usage: the percentage (from 0 to 100) of cooling contribution
43 */
44
45struct __thermal_bind_params {
46 struct __thermal_cooling_bind_param *tcbp;
47 unsigned int count;
48 unsigned int trip_id;
49 unsigned int usage;
50};
51
52/**
53 * struct __thermal_zone - internal representation of a thermal zone
54 * @passive_delay: polling interval while passive cooling is activated
55 * @polling_delay: zone polling interval
56 * @slope: slope of the temperature adjustment curve
57 * @offset: offset of the temperature adjustment curve
58 * @ntrips: number of trip points
59 * @trips: an array of trip points (0..ntrips - 1)
60 * @num_tbps: number of thermal bind params
61 * @tbps: an array of thermal bind params (0..num_tbps - 1)
62 * @sensor_data: sensor private data used while reading temperature and trend
63 * @ops: set of callbacks to handle the thermal zone based on DT
64 */
65
66struct __thermal_zone {
67 int passive_delay;
68 int polling_delay;
69 int slope;
70 int offset;
71
72 /* trip data */
73 int ntrips;
74 struct thermal_trip *trips;
75
76 /* cooling binding data */
77 int num_tbps;
78 struct __thermal_bind_params *tbps;
79
80 /* sensor interface */
81 void *sensor_data;
82 const struct thermal_zone_of_device_ops *ops;
83};
84
85/*** DT thermal zone device callbacks ***/
86
87static int of_thermal_get_temp(struct thermal_zone_device *tz,
88 int *temp)
89{
90 struct __thermal_zone *data = tz->devdata;
91
92 if (!data->ops->get_temp)
93 return -EINVAL;
94
95 return data->ops->get_temp(data->sensor_data, temp);
96}
97
98static int of_thermal_set_trips(struct thermal_zone_device *tz,
99 int low, int high)
100{
101 struct __thermal_zone *data = tz->devdata;
102
103 if (!data->ops || !data->ops->set_trips)
104 return -EINVAL;
105
106 return data->ops->set_trips(data->sensor_data, low, high);
107}
108
109/**
110 * of_thermal_get_ntrips - function to export number of available trip
111 * points.
112 * @tz: pointer to a thermal zone
113 *
114 * This function is a globally visible wrapper to get number of trip points
115 * stored in the local struct __thermal_zone
116 *
117 * Return: number of available trip points, -ENODEV when data not available
118 */
119int of_thermal_get_ntrips(struct thermal_zone_device *tz)
120{
121 struct __thermal_zone *data = tz->devdata;
122
123 if (!data || IS_ERR(data))
124 return -ENODEV;
125
126 return data->ntrips;
127}
128EXPORT_SYMBOL_GPL(of_thermal_get_ntrips);
129
130/**
131 * of_thermal_is_trip_valid - function to check if trip point is valid
132 *
133 * @tz: pointer to a thermal zone
134 * @trip: trip point to evaluate
135 *
136 * This function is responsible for checking if passed trip point is valid
137 *
138 * Return: true if trip point is valid, false otherwise
139 */
140bool of_thermal_is_trip_valid(struct thermal_zone_device *tz, int trip)
141{
142 struct __thermal_zone *data = tz->devdata;
143
144 if (!data || trip >= data->ntrips || trip < 0)
145 return false;
146
147 return true;
148}
149EXPORT_SYMBOL_GPL(of_thermal_is_trip_valid);
150
151/**
152 * of_thermal_get_trip_points - function to get access to a globally exported
153 * trip points
154 *
155 * @tz: pointer to a thermal zone
156 *
157 * This function provides a pointer to trip points table
158 *
159 * Return: pointer to trip points table, NULL otherwise
160 */
161const struct thermal_trip *
162of_thermal_get_trip_points(struct thermal_zone_device *tz)
163{
164 struct __thermal_zone *data = tz->devdata;
165
166 if (!data)
167 return NULL;
168
169 return data->trips;
170}
171EXPORT_SYMBOL_GPL(of_thermal_get_trip_points);
172
173/**
174 * of_thermal_set_emul_temp - function to set emulated temperature
175 *
176 * @tz: pointer to a thermal zone
177 * @temp: temperature to set
178 *
179 * This function gives the ability to set emulated value of temperature,
180 * which is handy for debugging
181 *
182 * Return: zero on success, error code otherwise
183 */
184static int of_thermal_set_emul_temp(struct thermal_zone_device *tz,
185 int temp)
186{
187 struct __thermal_zone *data = tz->devdata;
188
189 return data->ops->set_emul_temp(data->sensor_data, temp);
190}
191
192static int of_thermal_get_trend(struct thermal_zone_device *tz, int trip,
193 enum thermal_trend *trend)
194{
195 struct __thermal_zone *data = tz->devdata;
196
197 if (!data->ops->get_trend)
198 return -EINVAL;
199
200 return data->ops->get_trend(data->sensor_data, trip, trend);
201}
202
203static int of_thermal_bind(struct thermal_zone_device *thermal,
204 struct thermal_cooling_device *cdev)
205{
206 struct __thermal_zone *data = thermal->devdata;
207 struct __thermal_bind_params *tbp;
208 struct __thermal_cooling_bind_param *tcbp;
209 int i, j;
210
211 if (!data || IS_ERR(data))
212 return -ENODEV;
213
214 /* find where to bind */
215 for (i = 0; i < data->num_tbps; i++) {
216 tbp = data->tbps + i;
217
218 for (j = 0; j < tbp->count; j++) {
219 tcbp = tbp->tcbp + j;
220
221 if (tcbp->cooling_device == cdev->np) {
222 int ret;
223
224 ret = thermal_zone_bind_cooling_device(thermal,
225 tbp->trip_id, cdev,
226 tcbp->max,
227 tcbp->min,
228 tbp->usage);
229 if (ret)
230 return ret;
231 }
232 }
233 }
234
235 return 0;
236}
237
238static int of_thermal_unbind(struct thermal_zone_device *thermal,
239 struct thermal_cooling_device *cdev)
240{
241 struct __thermal_zone *data = thermal->devdata;
242 struct __thermal_bind_params *tbp;
243 struct __thermal_cooling_bind_param *tcbp;
244 int i, j;
245
246 if (!data || IS_ERR(data))
247 return -ENODEV;
248
249 /* find where to unbind */
250 for (i = 0; i < data->num_tbps; i++) {
251 tbp = data->tbps + i;
252
253 for (j = 0; j < tbp->count; j++) {
254 tcbp = tbp->tcbp + j;
255
256 if (tcbp->cooling_device == cdev->np) {
257 int ret;
258
259 ret = thermal_zone_unbind_cooling_device(thermal,
260 tbp->trip_id, cdev);
261 if (ret)
262 return ret;
263 }
264 }
265 }
266
267 return 0;
268}
269
270static int of_thermal_get_trip_type(struct thermal_zone_device *tz, int trip,
271 enum thermal_trip_type *type)
272{
273 struct __thermal_zone *data = tz->devdata;
274
275 if (trip >= data->ntrips || trip < 0)
276 return -EDOM;
277
278 *type = data->trips[trip].type;
279
280 return 0;
281}
282
283static int of_thermal_get_trip_temp(struct thermal_zone_device *tz, int trip,
284 int *temp)
285{
286 struct __thermal_zone *data = tz->devdata;
287
288 if (trip >= data->ntrips || trip < 0)
289 return -EDOM;
290
291 *temp = data->trips[trip].temperature;
292
293 return 0;
294}
295
296static int of_thermal_set_trip_temp(struct thermal_zone_device *tz, int trip,
297 int temp)
298{
299 struct __thermal_zone *data = tz->devdata;
300
301 if (trip >= data->ntrips || trip < 0)
302 return -EDOM;
303
304 if (data->ops->set_trip_temp) {
305 int ret;
306
307 ret = data->ops->set_trip_temp(data->sensor_data, trip, temp);
308 if (ret)
309 return ret;
310 }
311
312 /* thermal framework should take care of data->mask & (1 << trip) */
313 data->trips[trip].temperature = temp;
314
315 return 0;
316}
317
318static int of_thermal_get_trip_hyst(struct thermal_zone_device *tz, int trip,
319 int *hyst)
320{
321 struct __thermal_zone *data = tz->devdata;
322
323 if (trip >= data->ntrips || trip < 0)
324 return -EDOM;
325
326 *hyst = data->trips[trip].hysteresis;
327
328 return 0;
329}
330
331static int of_thermal_set_trip_hyst(struct thermal_zone_device *tz, int trip,
332 int hyst)
333{
334 struct __thermal_zone *data = tz->devdata;
335
336 if (trip >= data->ntrips || trip < 0)
337 return -EDOM;
338
339 /* thermal framework should take care of data->mask & (1 << trip) */
340 data->trips[trip].hysteresis = hyst;
341
342 return 0;
343}
344
345static int of_thermal_get_crit_temp(struct thermal_zone_device *tz,
346 int *temp)
347{
348 struct __thermal_zone *data = tz->devdata;
349 int i;
350
351 for (i = 0; i < data->ntrips; i++)
352 if (data->trips[i].type == THERMAL_TRIP_CRITICAL) {
353 *temp = data->trips[i].temperature;
354 return 0;
355 }
356
357 return -EINVAL;
358}
359
360static struct thermal_zone_device_ops of_thermal_ops = {
361 .get_trip_type = of_thermal_get_trip_type,
362 .get_trip_temp = of_thermal_get_trip_temp,
363 .set_trip_temp = of_thermal_set_trip_temp,
364 .get_trip_hyst = of_thermal_get_trip_hyst,
365 .set_trip_hyst = of_thermal_set_trip_hyst,
366 .get_crit_temp = of_thermal_get_crit_temp,
367
368 .bind = of_thermal_bind,
369 .unbind = of_thermal_unbind,
370};
371
372/*** sensor API ***/
373
374static struct thermal_zone_device *
375thermal_zone_of_add_sensor(struct device_node *zone,
376 struct device_node *sensor, void *data,
377 const struct thermal_zone_of_device_ops *ops)
378{
379 struct thermal_zone_device *tzd;
380 struct __thermal_zone *tz;
381
382 tzd = thermal_zone_get_zone_by_name(zone->name);
383 if (IS_ERR(tzd))
384 return ERR_PTR(-EPROBE_DEFER);
385
386 tz = tzd->devdata;
387
388 if (!ops)
389 return ERR_PTR(-EINVAL);
390
391 mutex_lock(&tzd->lock);
392 tz->ops = ops;
393 tz->sensor_data = data;
394
395 tzd->ops->get_temp = of_thermal_get_temp;
396 tzd->ops->get_trend = of_thermal_get_trend;
397
398 /*
399 * The thermal zone core will calculate the window if they have set the
400 * optional set_trips pointer.
401 */
402 if (ops->set_trips)
403 tzd->ops->set_trips = of_thermal_set_trips;
404
405 if (ops->set_emul_temp)
406 tzd->ops->set_emul_temp = of_thermal_set_emul_temp;
407
408 mutex_unlock(&tzd->lock);
409
410 return tzd;
411}
412
413/**
414 * thermal_zone_of_get_sensor_id - get sensor ID from a DT thermal zone
415 * @tz_np: a valid thermal zone device node.
416 * @sensor_np: a sensor node of a valid sensor device.
417 * @id: the sensor ID returned if success.
418 *
419 * This function will get sensor ID from a given thermal zone node and
420 * the sensor node must match the temperature provider @sensor_np.
421 *
422 * Return: 0 on success, proper error code otherwise.
423 */
424
425int thermal_zone_of_get_sensor_id(struct device_node *tz_np,
426 struct device_node *sensor_np,
427 u32 *id)
428{
429 struct of_phandle_args sensor_specs;
430 int ret;
431
432 ret = of_parse_phandle_with_args(tz_np,
433 "thermal-sensors",
434 "#thermal-sensor-cells",
435 0,
436 &sensor_specs);
437 if (ret)
438 return ret;
439
440 if (sensor_specs.np != sensor_np) {
441 of_node_put(sensor_specs.np);
442 return -ENODEV;
443 }
444
445 if (sensor_specs.args_count > 1)
446 pr_warn("%pOFn: too many cells in sensor specifier %d\n",
447 sensor_specs.np, sensor_specs.args_count);
448
449 *id = sensor_specs.args_count ? sensor_specs.args[0] : 0;
450
451 of_node_put(sensor_specs.np);
452
453 return 0;
454}
455EXPORT_SYMBOL_GPL(thermal_zone_of_get_sensor_id);
456
457/**
458 * thermal_zone_of_sensor_register - registers a sensor to a DT thermal zone
459 * @dev: a valid struct device pointer of a sensor device. Must contain
460 * a valid .of_node, for the sensor node.
461 * @sensor_id: a sensor identifier, in case the sensor IP has more
462 * than one sensors
463 * @data: a private pointer (owned by the caller) that will be passed
464 * back, when a temperature reading is needed.
465 * @ops: struct thermal_zone_of_device_ops *. Must contain at least .get_temp.
466 *
467 * This function will search the list of thermal zones described in device
468 * tree and look for the zone that refer to the sensor device pointed by
469 * @dev->of_node as temperature providers. For the zone pointing to the
470 * sensor node, the sensor will be added to the DT thermal zone device.
471 *
472 * The thermal zone temperature is provided by the @get_temp function
473 * pointer. When called, it will have the private pointer @data back.
474 *
475 * The thermal zone temperature trend is provided by the @get_trend function
476 * pointer. When called, it will have the private pointer @data back.
477 *
478 * TODO:
479 * 01 - This function must enqueue the new sensor instead of using
480 * it as the only source of temperature values.
481 *
482 * 02 - There must be a way to match the sensor with all thermal zones
483 * that refer to it.
484 *
485 * Return: On success returns a valid struct thermal_zone_device,
486 * otherwise, it returns a corresponding ERR_PTR(). Caller must
487 * check the return value with help of IS_ERR() helper.
488 */
489struct thermal_zone_device *
490thermal_zone_of_sensor_register(struct device *dev, int sensor_id, void *data,
491 const struct thermal_zone_of_device_ops *ops)
492{
493 struct device_node *np, *child, *sensor_np;
494 struct thermal_zone_device *tzd = ERR_PTR(-ENODEV);
495
496 np = of_find_node_by_name(NULL, "thermal-zones");
497 if (!np)
498 return ERR_PTR(-ENODEV);
499
500 if (!dev || !dev->of_node) {
501 of_node_put(np);
502 return ERR_PTR(-ENODEV);
503 }
504
505 sensor_np = of_node_get(dev->of_node);
506
507 for_each_available_child_of_node(np, child) {
508 int ret, id;
509
510 /* For now, thermal framework supports only 1 sensor per zone */
511 ret = thermal_zone_of_get_sensor_id(child, sensor_np, &id);
512 if (ret)
513 continue;
514
515 if (id == sensor_id) {
516 tzd = thermal_zone_of_add_sensor(child, sensor_np,
517 data, ops);
518 if (!IS_ERR(tzd))
519 thermal_zone_device_enable(tzd);
520
521 of_node_put(child);
522 goto exit;
523 }
524 }
525exit:
526 of_node_put(sensor_np);
527 of_node_put(np);
528
529 return tzd;
530}
531EXPORT_SYMBOL_GPL(thermal_zone_of_sensor_register);
532
533/**
534 * thermal_zone_of_sensor_unregister - unregisters a sensor from a DT thermal zone
535 * @dev: a valid struct device pointer of a sensor device. Must contain
536 * a valid .of_node, for the sensor node.
537 * @tzd: a pointer to struct thermal_zone_device where the sensor is registered.
538 *
539 * This function removes the sensor callbacks and private data from the
540 * thermal zone device registered with thermal_zone_of_sensor_register()
541 * API. It will also silent the zone by remove the .get_temp() and .get_trend()
542 * thermal zone device callbacks.
543 *
544 * TODO: When the support to several sensors per zone is added, this
545 * function must search the sensor list based on @dev parameter.
546 *
547 */
548void thermal_zone_of_sensor_unregister(struct device *dev,
549 struct thermal_zone_device *tzd)
550{
551 struct __thermal_zone *tz;
552
553 if (!dev || !tzd || !tzd->devdata)
554 return;
555
556 tz = tzd->devdata;
557
558 /* no __thermal_zone, nothing to be done */
559 if (!tz)
560 return;
561
562 mutex_lock(&tzd->lock);
563 tzd->ops->get_temp = NULL;
564 tzd->ops->get_trend = NULL;
565 tzd->ops->set_emul_temp = NULL;
566
567 tz->ops = NULL;
568 tz->sensor_data = NULL;
569 mutex_unlock(&tzd->lock);
570}
571EXPORT_SYMBOL_GPL(thermal_zone_of_sensor_unregister);
572
573static void devm_thermal_zone_of_sensor_release(struct device *dev, void *res)
574{
575 thermal_zone_of_sensor_unregister(dev,
576 *(struct thermal_zone_device **)res);
577}
578
579static int devm_thermal_zone_of_sensor_match(struct device *dev, void *res,
580 void *data)
581{
582 struct thermal_zone_device **r = res;
583
584 if (WARN_ON(!r || !*r))
585 return 0;
586
587 return *r == data;
588}
589
590/**
591 * devm_thermal_zone_of_sensor_register - Resource managed version of
592 * thermal_zone_of_sensor_register()
593 * @dev: a valid struct device pointer of a sensor device. Must contain
594 * a valid .of_node, for the sensor node.
595 * @sensor_id: a sensor identifier, in case the sensor IP has more
596 * than one sensors
597 * @data: a private pointer (owned by the caller) that will be passed
598 * back, when a temperature reading is needed.
599 * @ops: struct thermal_zone_of_device_ops *. Must contain at least .get_temp.
600 *
601 * Refer thermal_zone_of_sensor_register() for more details.
602 *
603 * Return: On success returns a valid struct thermal_zone_device,
604 * otherwise, it returns a corresponding ERR_PTR(). Caller must
605 * check the return value with help of IS_ERR() helper.
606 * Registered thermal_zone_device device will automatically be
607 * released when device is unbounded.
608 */
609struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
610 struct device *dev, int sensor_id,
611 void *data, const struct thermal_zone_of_device_ops *ops)
612{
613 struct thermal_zone_device **ptr, *tzd;
614
615 ptr = devres_alloc(devm_thermal_zone_of_sensor_release, sizeof(*ptr),
616 GFP_KERNEL);
617 if (!ptr)
618 return ERR_PTR(-ENOMEM);
619
620 tzd = thermal_zone_of_sensor_register(dev, sensor_id, data, ops);
621 if (IS_ERR(tzd)) {
622 devres_free(ptr);
623 return tzd;
624 }
625
626 *ptr = tzd;
627 devres_add(dev, ptr);
628
629 return tzd;
630}
631EXPORT_SYMBOL_GPL(devm_thermal_zone_of_sensor_register);
632
633/**
634 * devm_thermal_zone_of_sensor_unregister - Resource managed version of
635 * thermal_zone_of_sensor_unregister().
636 * @dev: Device for which which resource was allocated.
637 * @tzd: a pointer to struct thermal_zone_device where the sensor is registered.
638 *
639 * This function removes the sensor callbacks and private data from the
640 * thermal zone device registered with devm_thermal_zone_of_sensor_register()
641 * API. It will also silent the zone by remove the .get_temp() and .get_trend()
642 * thermal zone device callbacks.
643 * Normally this function will not need to be called and the resource
644 * management code will ensure that the resource is freed.
645 */
646void devm_thermal_zone_of_sensor_unregister(struct device *dev,
647 struct thermal_zone_device *tzd)
648{
649 WARN_ON(devres_release(dev, devm_thermal_zone_of_sensor_release,
650 devm_thermal_zone_of_sensor_match, tzd));
651}
652EXPORT_SYMBOL_GPL(devm_thermal_zone_of_sensor_unregister);
653
654/*** functions parsing device tree nodes ***/
655
656/**
657 * thermal_of_populate_bind_params - parse and fill cooling map data
658 * @np: DT node containing a cooling-map node
659 * @__tbp: data structure to be filled with cooling map info
660 * @trips: array of thermal zone trip points
661 * @ntrips: number of trip points inside trips.
662 *
663 * This function parses a cooling-map type of node represented by
664 * @np parameter and fills the read data into @__tbp data structure.
665 * It needs the already parsed array of trip points of the thermal zone
666 * in consideration.
667 *
668 * Return: 0 on success, proper error code otherwise
669 */
670static int thermal_of_populate_bind_params(struct device_node *np,
671 struct __thermal_bind_params *__tbp,
672 struct thermal_trip *trips,
673 int ntrips)
674{
675 struct of_phandle_args cooling_spec;
676 struct __thermal_cooling_bind_param *__tcbp;
677 struct device_node *trip;
678 int ret, i, count;
679 u32 prop;
680
681 /* Default weight. Usage is optional */
682 __tbp->usage = THERMAL_WEIGHT_DEFAULT;
683 ret = of_property_read_u32(np, "contribution", &prop);
684 if (ret == 0)
685 __tbp->usage = prop;
686
687 trip = of_parse_phandle(np, "trip", 0);
688 if (!trip) {
689 pr_err("missing trip property\n");
690 return -ENODEV;
691 }
692
693 /* match using device_node */
694 for (i = 0; i < ntrips; i++)
695 if (trip == trips[i].np) {
696 __tbp->trip_id = i;
697 break;
698 }
699
700 if (i == ntrips) {
701 ret = -ENODEV;
702 goto end;
703 }
704
705 count = of_count_phandle_with_args(np, "cooling-device",
706 "#cooling-cells");
707 if (!count) {
708 pr_err("Add a cooling_device property with at least one device\n");
709 goto end;
710 }
711
712 __tcbp = kcalloc(count, sizeof(*__tcbp), GFP_KERNEL);
713 if (!__tcbp)
714 goto end;
715
716 for (i = 0; i < count; i++) {
717 ret = of_parse_phandle_with_args(np, "cooling-device",
718 "#cooling-cells", i, &cooling_spec);
719 if (ret < 0) {
720 pr_err("Invalid cooling-device entry\n");
721 goto free_tcbp;
722 }
723
724 __tcbp[i].cooling_device = cooling_spec.np;
725
726 if (cooling_spec.args_count >= 2) { /* at least min and max */
727 __tcbp[i].min = cooling_spec.args[0];
728 __tcbp[i].max = cooling_spec.args[1];
729 } else {
730 pr_err("wrong reference to cooling device, missing limits\n");
731 }
732 }
733
734 __tbp->tcbp = __tcbp;
735 __tbp->count = count;
736
737 goto end;
738
739free_tcbp:
740 for (i = i - 1; i >= 0; i--)
741 of_node_put(__tcbp[i].cooling_device);
742 kfree(__tcbp);
743end:
744 of_node_put(trip);
745
746 return ret;
747}
748
749/*
750 * It maps 'enum thermal_trip_type' found in include/linux/thermal.h
751 * into the device tree binding of 'trip', property type.
752 */
753static const char * const trip_types[] = {
754 [THERMAL_TRIP_ACTIVE] = "active",
755 [THERMAL_TRIP_PASSIVE] = "passive",
756 [THERMAL_TRIP_HOT] = "hot",
757 [THERMAL_TRIP_CRITICAL] = "critical",
758};
759
760/**
761 * thermal_of_get_trip_type - Get phy mode for given device_node
762 * @np: Pointer to the given device_node
763 * @type: Pointer to resulting trip type
764 *
765 * The function gets trip type string from property 'type',
766 * and store its index in trip_types table in @type,
767 *
768 * Return: 0 on success, or errno in error case.
769 */
770static int thermal_of_get_trip_type(struct device_node *np,
771 enum thermal_trip_type *type)
772{
773 const char *t;
774 int err, i;
775
776 err = of_property_read_string(np, "type", &t);
777 if (err < 0)
778 return err;
779
780 for (i = 0; i < ARRAY_SIZE(trip_types); i++)
781 if (!strcasecmp(t, trip_types[i])) {
782 *type = i;
783 return 0;
784 }
785
786 return -ENODEV;
787}
788
789/**
790 * thermal_of_populate_trip - parse and fill one trip point data
791 * @np: DT node containing a trip point node
792 * @trip: trip point data structure to be filled up
793 *
794 * This function parses a trip point type of node represented by
795 * @np parameter and fills the read data into @trip data structure.
796 *
797 * Return: 0 on success, proper error code otherwise
798 */
799static int thermal_of_populate_trip(struct device_node *np,
800 struct thermal_trip *trip)
801{
802 int prop;
803 int ret;
804
805 ret = of_property_read_u32(np, "temperature", &prop);
806 if (ret < 0) {
807 pr_err("missing temperature property\n");
808 return ret;
809 }
810 trip->temperature = prop;
811
812 ret = of_property_read_u32(np, "hysteresis", &prop);
813 if (ret < 0) {
814 pr_err("missing hysteresis property\n");
815 return ret;
816 }
817 trip->hysteresis = prop;
818
819 ret = thermal_of_get_trip_type(np, &trip->type);
820 if (ret < 0) {
821 pr_err("wrong trip type property\n");
822 return ret;
823 }
824
825 /* Required for cooling map matching */
826 trip->np = np;
827 of_node_get(np);
828
829 return 0;
830}
831
832/**
833 * thermal_of_build_thermal_zone - parse and fill one thermal zone data
834 * @np: DT node containing a thermal zone node
835 *
836 * This function parses a thermal zone type of node represented by
837 * @np parameter and fills the read data into a __thermal_zone data structure
838 * and return this pointer.
839 *
840 * TODO: Missing properties to parse: thermal-sensor-names
841 *
842 * Return: On success returns a valid struct __thermal_zone,
843 * otherwise, it returns a corresponding ERR_PTR(). Caller must
844 * check the return value with help of IS_ERR() helper.
845 */
846static struct __thermal_zone
847__init *thermal_of_build_thermal_zone(struct device_node *np)
848{
849 struct device_node *child = NULL, *gchild;
850 struct __thermal_zone *tz;
851 int ret, i;
852 u32 prop, coef[2];
853
854 if (!np) {
855 pr_err("no thermal zone np\n");
856 return ERR_PTR(-EINVAL);
857 }
858
859 tz = kzalloc(sizeof(*tz), GFP_KERNEL);
860 if (!tz)
861 return ERR_PTR(-ENOMEM);
862
863 ret = of_property_read_u32(np, "polling-delay-passive", &prop);
864 if (ret < 0) {
865 pr_err("%pOFn: missing polling-delay-passive property\n", np);
866 goto free_tz;
867 }
868 tz->passive_delay = prop;
869
870 ret = of_property_read_u32(np, "polling-delay", &prop);
871 if (ret < 0) {
872 pr_err("%pOFn: missing polling-delay property\n", np);
873 goto free_tz;
874 }
875 tz->polling_delay = prop;
876
877 /*
878 * REVIST: for now, the thermal framework supports only
879 * one sensor per thermal zone. Thus, we are considering
880 * only the first two values as slope and offset.
881 */
882 ret = of_property_read_u32_array(np, "coefficients", coef, 2);
883 if (ret == 0) {
884 tz->slope = coef[0];
885 tz->offset = coef[1];
886 } else {
887 tz->slope = 1;
888 tz->offset = 0;
889 }
890
891 /* trips */
892 child = of_get_child_by_name(np, "trips");
893
894 /* No trips provided */
895 if (!child)
896 goto finish;
897
898 tz->ntrips = of_get_child_count(child);
899 if (tz->ntrips == 0) /* must have at least one child */
900 goto finish;
901
902 tz->trips = kcalloc(tz->ntrips, sizeof(*tz->trips), GFP_KERNEL);
903 if (!tz->trips) {
904 ret = -ENOMEM;
905 goto free_tz;
906 }
907
908 i = 0;
909 for_each_child_of_node(child, gchild) {
910 ret = thermal_of_populate_trip(gchild, &tz->trips[i++]);
911 if (ret)
912 goto free_trips;
913 }
914
915 of_node_put(child);
916
917 /* cooling-maps */
918 child = of_get_child_by_name(np, "cooling-maps");
919
920 /* cooling-maps not provided */
921 if (!child)
922 goto finish;
923
924 tz->num_tbps = of_get_child_count(child);
925 if (tz->num_tbps == 0)
926 goto finish;
927
928 tz->tbps = kcalloc(tz->num_tbps, sizeof(*tz->tbps), GFP_KERNEL);
929 if (!tz->tbps) {
930 ret = -ENOMEM;
931 goto free_trips;
932 }
933
934 i = 0;
935 for_each_child_of_node(child, gchild) {
936 ret = thermal_of_populate_bind_params(gchild, &tz->tbps[i++],
937 tz->trips, tz->ntrips);
938 if (ret)
939 goto free_tbps;
940 }
941
942finish:
943 of_node_put(child);
944
945 return tz;
946
947free_tbps:
948 for (i = i - 1; i >= 0; i--) {
949 struct __thermal_bind_params *tbp = tz->tbps + i;
950 int j;
951
952 for (j = 0; j < tbp->count; j++)
953 of_node_put(tbp->tcbp[j].cooling_device);
954
955 kfree(tbp->tcbp);
956 }
957
958 kfree(tz->tbps);
959free_trips:
960 for (i = 0; i < tz->ntrips; i++)
961 of_node_put(tz->trips[i].np);
962 kfree(tz->trips);
963 of_node_put(gchild);
964free_tz:
965 kfree(tz);
966 of_node_put(child);
967
968 return ERR_PTR(ret);
969}
970
971static __init void of_thermal_free_zone(struct __thermal_zone *tz)
972{
973 struct __thermal_bind_params *tbp;
974 int i, j;
975
976 for (i = 0; i < tz->num_tbps; i++) {
977 tbp = tz->tbps + i;
978
979 for (j = 0; j < tbp->count; j++)
980 of_node_put(tbp->tcbp[j].cooling_device);
981
982 kfree(tbp->tcbp);
983 }
984
985 kfree(tz->tbps);
986 for (i = 0; i < tz->ntrips; i++)
987 of_node_put(tz->trips[i].np);
988 kfree(tz->trips);
989 kfree(tz);
990}
991
992/**
993 * of_thermal_destroy_zones - remove all zones parsed and allocated resources
994 *
995 * Finds all zones parsed and added to the thermal framework and remove them
996 * from the system, together with their resources.
997 *
998 */
999static __init void of_thermal_destroy_zones(void)
1000{
1001 struct device_node *np, *child;
1002
1003 np = of_find_node_by_name(NULL, "thermal-zones");
1004 if (!np) {
1005 pr_debug("unable to find thermal zones\n");
1006 return;
1007 }
1008
1009 for_each_available_child_of_node(np, child) {
1010 struct thermal_zone_device *zone;
1011
1012 zone = thermal_zone_get_zone_by_name(child->name);
1013 if (IS_ERR(zone))
1014 continue;
1015
1016 thermal_zone_device_unregister(zone);
1017 kfree(zone->tzp);
1018 kfree(zone->ops);
1019 of_thermal_free_zone(zone->devdata);
1020 }
1021 of_node_put(np);
1022}
1023
1024/**
1025 * of_parse_thermal_zones - parse device tree thermal data
1026 *
1027 * Initialization function that can be called by machine initialization
1028 * code to parse thermal data and populate the thermal framework
1029 * with hardware thermal zones info. This function only parses thermal zones.
1030 * Cooling devices and sensor devices nodes are supposed to be parsed
1031 * by their respective drivers.
1032 *
1033 * Return: 0 on success, proper error code otherwise
1034 *
1035 */
1036int __init of_parse_thermal_zones(void)
1037{
1038 struct device_node *np, *child;
1039 struct __thermal_zone *tz;
1040 struct thermal_zone_device_ops *ops;
1041
1042 np = of_find_node_by_name(NULL, "thermal-zones");
1043 if (!np) {
1044 pr_debug("unable to find thermal zones\n");
1045 return 0; /* Run successfully on systems without thermal DT */
1046 }
1047
1048 for_each_available_child_of_node(np, child) {
1049 struct thermal_zone_device *zone;
1050 struct thermal_zone_params *tzp;
1051 int i, mask = 0;
1052 u32 prop;
1053
1054 tz = thermal_of_build_thermal_zone(child);
1055 if (IS_ERR(tz)) {
1056 pr_err("failed to build thermal zone %pOFn: %ld\n",
1057 child,
1058 PTR_ERR(tz));
1059 continue;
1060 }
1061
1062 ops = kmemdup(&of_thermal_ops, sizeof(*ops), GFP_KERNEL);
1063 if (!ops)
1064 goto exit_free;
1065
1066 tzp = kzalloc(sizeof(*tzp), GFP_KERNEL);
1067 if (!tzp) {
1068 kfree(ops);
1069 goto exit_free;
1070 }
1071
1072 /* No hwmon because there might be hwmon drivers registering */
1073 tzp->no_hwmon = true;
1074
1075 if (!of_property_read_u32(child, "sustainable-power", &prop))
1076 tzp->sustainable_power = prop;
1077
1078 for (i = 0; i < tz->ntrips; i++)
1079 mask |= 1 << i;
1080
1081 /* these two are left for temperature drivers to use */
1082 tzp->slope = tz->slope;
1083 tzp->offset = tz->offset;
1084
1085 zone = thermal_zone_device_register(child->name, tz->ntrips,
1086 mask, tz,
1087 ops, tzp,
1088 tz->passive_delay,
1089 tz->polling_delay);
1090 if (IS_ERR(zone)) {
1091 pr_err("Failed to build %pOFn zone %ld\n", child,
1092 PTR_ERR(zone));
1093 kfree(tzp);
1094 kfree(ops);
1095 of_thermal_free_zone(tz);
1096 /* attempting to build remaining zones still */
1097 }
1098 }
1099 of_node_put(np);
1100
1101 return 0;
1102
1103exit_free:
1104 of_node_put(child);
1105 of_node_put(np);
1106 of_thermal_free_zone(tz);
1107
1108 /* no memory available, so free what we have built */
1109 of_thermal_destroy_zones();
1110
1111 return -ENOMEM;
1112}