1 // SPDX-License-Identifier: GPL-2.0
3 * of-thermal.c - Generic Thermal Management device tree support.
5 * Copyright (C) 2013 Texas Instruments
6 * Copyright (C) 2013 Eduardo Valentin <eduardo.valentin@ti.com>
9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
20 #include "thermal_core.h"
23 * of_thermal_get_ntrips - function to export number of available trip
25 * @tz: pointer to a thermal zone
27 * This function is a globally visible wrapper to get number of trip points
28 * stored in the local struct __thermal_zone
30 * Return: number of available trip points, -ENODEV when data not available
32 int of_thermal_get_ntrips(struct thermal_zone_device *tz)
36 EXPORT_SYMBOL_GPL(of_thermal_get_ntrips);
39 * of_thermal_is_trip_valid - function to check if trip point is valid
41 * @tz: pointer to a thermal zone
42 * @trip: trip point to evaluate
44 * This function is responsible for checking if passed trip point is valid
46 * Return: true if trip point is valid, false otherwise
48 bool of_thermal_is_trip_valid(struct thermal_zone_device *tz, int trip)
50 if (trip >= tz->num_trips || trip < 0)
55 EXPORT_SYMBOL_GPL(of_thermal_is_trip_valid);
58 * of_thermal_get_trip_points - function to get access to a globally exported
61 * @tz: pointer to a thermal zone
63 * This function provides a pointer to trip points table
65 * Return: pointer to trip points table, NULL otherwise
67 const struct thermal_trip *
68 of_thermal_get_trip_points(struct thermal_zone_device *tz)
72 EXPORT_SYMBOL_GPL(of_thermal_get_trip_points);
74 static int of_thermal_get_trip_type(struct thermal_zone_device *tz, int trip,
75 enum thermal_trip_type *type)
77 if (trip >= tz->num_trips || trip < 0)
80 *type = tz->trips[trip].type;
85 static int of_thermal_get_trip_temp(struct thermal_zone_device *tz, int trip,
88 if (trip >= tz->num_trips || trip < 0)
91 *temp = tz->trips[trip].temperature;
96 static int of_thermal_get_trip_hyst(struct thermal_zone_device *tz, int trip,
99 if (trip >= tz->num_trips || trip < 0)
102 *hyst = tz->trips[trip].hysteresis;
107 static int of_thermal_set_trip_hyst(struct thermal_zone_device *tz, int trip,
110 if (trip >= tz->num_trips || trip < 0)
113 /* thermal framework should take care of data->mask & (1 << trip) */
114 tz->trips[trip].hysteresis = hyst;
119 static int of_thermal_get_crit_temp(struct thermal_zone_device *tz,
124 for (i = 0; i < tz->num_trips; i++)
125 if (tz->trips[i].type == THERMAL_TRIP_CRITICAL) {
126 *temp = tz->trips[i].temperature;
133 /*** functions parsing device tree nodes ***/
135 static int of_find_trip_id(struct device_node *np, struct device_node *trip)
137 struct device_node *trips;
138 struct device_node *t;
141 trips = of_get_child_by_name(np, "trips");
143 pr_err("Failed to find 'trips' node\n");
148 * Find the trip id point associated with the cooling device map
150 for_each_child_of_node(trips, t) {
165 * It maps 'enum thermal_trip_type' found in include/linux/thermal.h
166 * into the device tree binding of 'trip', property type.
168 static const char * const trip_types[] = {
169 [THERMAL_TRIP_ACTIVE] = "active",
170 [THERMAL_TRIP_PASSIVE] = "passive",
171 [THERMAL_TRIP_HOT] = "hot",
172 [THERMAL_TRIP_CRITICAL] = "critical",
176 * thermal_of_get_trip_type - Get phy mode for given device_node
177 * @np: Pointer to the given device_node
178 * @type: Pointer to resulting trip type
180 * The function gets trip type string from property 'type',
181 * and store its index in trip_types table in @type,
183 * Return: 0 on success, or errno in error case.
185 static int thermal_of_get_trip_type(struct device_node *np,
186 enum thermal_trip_type *type)
191 err = of_property_read_string(np, "type", &t);
195 for (i = 0; i < ARRAY_SIZE(trip_types); i++)
196 if (!strcasecmp(t, trip_types[i])) {
204 static int thermal_of_populate_trip(struct device_node *np,
205 struct thermal_trip *trip)
210 ret = of_property_read_u32(np, "temperature", &prop);
212 pr_err("missing temperature property\n");
215 trip->temperature = prop;
217 ret = of_property_read_u32(np, "hysteresis", &prop);
219 pr_err("missing hysteresis property\n");
222 trip->hysteresis = prop;
224 ret = thermal_of_get_trip_type(np, &trip->type);
226 pr_err("wrong trip type property\n");
233 static struct thermal_trip *thermal_of_trips_init(struct device_node *np, int *ntrips)
235 struct thermal_trip *tt;
236 struct device_node *trips, *trip;
239 trips = of_get_child_by_name(np, "trips");
241 pr_err("Failed to find 'trips' node\n");
242 return ERR_PTR(-EINVAL);
245 count = of_get_child_count(trips);
247 pr_err("No trip point defined\n");
249 goto out_of_node_put;
252 tt = kzalloc(sizeof(*tt) * count, GFP_KERNEL);
255 goto out_of_node_put;
261 for_each_child_of_node(trips, trip) {
262 ret = thermal_of_populate_trip(trip, &tt[count++]);
280 static struct device_node *of_thermal_zone_find(struct device_node *sensor, int id)
282 struct device_node *np, *tz;
283 struct of_phandle_args sensor_specs;
285 np = of_find_node_by_name(NULL, "thermal-zones");
287 pr_debug("No thermal zones description\n");
288 return ERR_PTR(-ENODEV);
292 * Search for each thermal zone, a defined sensor
293 * corresponding to the one passed as parameter
295 for_each_available_child_of_node(np, tz) {
299 count = of_count_phandle_with_args(tz, "thermal-sensors",
300 "#thermal-sensor-cells");
302 pr_err("%pOFn: missing thermal sensor\n", tz);
303 tz = ERR_PTR(-EINVAL);
307 for (i = 0; i < count; i++) {
311 ret = of_parse_phandle_with_args(tz, "thermal-sensors",
312 "#thermal-sensor-cells",
315 pr_err("%pOFn: Failed to read thermal-sensors cells: %d\n", tz, ret);
320 if ((sensor == sensor_specs.np) && id == (sensor_specs.args_count ?
321 sensor_specs.args[0] : 0)) {
322 pr_debug("sensor %pOFn id=%d belongs to %pOFn\n", sensor, id, tz);
327 tz = ERR_PTR(-ENODEV);
333 static int thermal_of_monitor_init(struct device_node *np, int *delay, int *pdelay)
337 ret = of_property_read_u32(np, "polling-delay-passive", pdelay);
339 pr_err("%pOFn: missing polling-delay-passive property\n", np);
343 ret = of_property_read_u32(np, "polling-delay", delay);
345 pr_err("%pOFn: missing polling-delay property\n", np);
352 static struct thermal_zone_params *thermal_of_parameters_init(struct device_node *np)
354 struct thermal_zone_params *tzp;
356 int ncoef = ARRAY_SIZE(coef);
359 tzp = kzalloc(sizeof(*tzp), GFP_KERNEL);
361 return ERR_PTR(-ENOMEM);
363 tzp->no_hwmon = true;
365 if (!of_property_read_u32(np, "sustainable-power", &prop))
366 tzp->sustainable_power = prop;
369 * For now, the thermal framework supports only one sensor per
370 * thermal zone. Thus, we are considering only the first two
371 * values as slope and offset.
373 ret = of_property_read_u32_array(np, "coefficients", coef, ncoef);
379 tzp->slope = coef[0];
380 tzp->offset = coef[1];
385 static struct device_node *thermal_of_zone_get_by_name(struct thermal_zone_device *tz)
387 struct device_node *np, *tz_np;
389 np = of_find_node_by_name(NULL, "thermal-zones");
391 return ERR_PTR(-ENODEV);
393 tz_np = of_get_child_by_name(np, tz->type);
398 return ERR_PTR(-ENODEV);
403 static int __thermal_of_unbind(struct device_node *map_np, int index, int trip_id,
404 struct thermal_zone_device *tz, struct thermal_cooling_device *cdev)
406 struct of_phandle_args cooling_spec;
409 ret = of_parse_phandle_with_args(map_np, "cooling-device", "#cooling-cells",
410 index, &cooling_spec);
412 of_node_put(cooling_spec.np);
415 pr_err("Invalid cooling-device entry\n");
419 if (cooling_spec.args_count < 2) {
420 pr_err("wrong reference to cooling device, missing limits\n");
424 if (cooling_spec.np != cdev->np)
427 ret = thermal_zone_unbind_cooling_device(tz, trip_id, cdev);
429 pr_err("Failed to unbind '%s' with '%s': %d\n", tz->type, cdev->type, ret);
434 static int __thermal_of_bind(struct device_node *map_np, int index, int trip_id,
435 struct thermal_zone_device *tz, struct thermal_cooling_device *cdev)
437 struct of_phandle_args cooling_spec;
438 int ret, weight = THERMAL_WEIGHT_DEFAULT;
440 of_property_read_u32(map_np, "contribution", &weight);
442 ret = of_parse_phandle_with_args(map_np, "cooling-device", "#cooling-cells",
443 index, &cooling_spec);
445 of_node_put(cooling_spec.np);
448 pr_err("Invalid cooling-device entry\n");
452 if (cooling_spec.args_count < 2) {
453 pr_err("wrong reference to cooling device, missing limits\n");
457 if (cooling_spec.np != cdev->np)
460 ret = thermal_zone_bind_cooling_device(tz, trip_id, cdev, cooling_spec.args[1],
461 cooling_spec.args[0],
464 pr_err("Failed to bind '%s' with '%s': %d\n", tz->type, cdev->type, ret);
469 static int thermal_of_for_each_cooling_device(struct device_node *tz_np, struct device_node *map_np,
470 struct thermal_zone_device *tz, struct thermal_cooling_device *cdev,
471 int (*action)(struct device_node *, int, int,
472 struct thermal_zone_device *, struct thermal_cooling_device *))
474 struct device_node *tr_np;
475 int count, i, trip_id;
477 tr_np = of_parse_phandle(map_np, "trip", 0);
481 trip_id = of_find_trip_id(tz_np, tr_np);
485 count = of_count_phandle_with_args(map_np, "cooling-device", "#cooling-cells");
487 pr_err("Add a cooling_device property with at least one device\n");
492 * At this point, we don't want to bail out when there is an
493 * error, we will try to bind/unbind as many as possible
496 for (i = 0; i < count; i++)
497 action(map_np, i, trip_id, tz, cdev);
502 static int thermal_of_for_each_cooling_maps(struct thermal_zone_device *tz,
503 struct thermal_cooling_device *cdev,
504 int (*action)(struct device_node *, int, int,
505 struct thermal_zone_device *, struct thermal_cooling_device *))
507 struct device_node *tz_np, *cm_np, *child;
510 tz_np = thermal_of_zone_get_by_name(tz);
512 pr_err("Failed to get node tz by name\n");
513 return PTR_ERR(tz_np);
516 cm_np = of_get_child_by_name(tz_np, "cooling-maps");
520 for_each_child_of_node(cm_np, child) {
521 ret = thermal_of_for_each_cooling_device(tz_np, child, tz, cdev, action);
533 static int thermal_of_bind(struct thermal_zone_device *tz,
534 struct thermal_cooling_device *cdev)
536 return thermal_of_for_each_cooling_maps(tz, cdev, __thermal_of_bind);
539 static int thermal_of_unbind(struct thermal_zone_device *tz,
540 struct thermal_cooling_device *cdev)
542 return thermal_of_for_each_cooling_maps(tz, cdev, __thermal_of_unbind);
546 * thermal_of_zone_unregister - Cleanup the specific allocated ressources
548 * This function disables the thermal zone and frees the different
549 * ressources allocated specific to the thermal OF.
551 * @tz: a pointer to the thermal zone structure
553 void thermal_of_zone_unregister(struct thermal_zone_device *tz)
555 struct thermal_trip *trips = tz->trips;
556 struct thermal_zone_params *tzp = tz->tzp;
557 struct thermal_zone_device_ops *ops = tz->ops;
559 thermal_zone_device_disable(tz);
560 thermal_zone_device_unregister(tz);
565 EXPORT_SYMBOL_GPL(thermal_of_zone_unregister);
568 * thermal_of_zone_register - Register a thermal zone with device node
571 * The thermal_of_zone_register() parses a device tree given a device
572 * node sensor and identifier. It searches for the thermal zone
573 * associated to the couple sensor/id and retrieves all the thermal
574 * zone properties and registers new thermal zone with those
577 * @sensor: A device node pointer corresponding to the sensor in the device tree
578 * @id: An integer as sensor identifier
579 * @data: A private data to be stored in the thermal zone dedicated private area
580 * @ops: A set of thermal sensor ops
582 * Return: a valid thermal zone structure pointer on success.
583 * - EINVAL: if the device tree thermal description is malformed
584 * - ENOMEM: if one structure can not be allocated
585 * - Other negative errors are returned by the underlying called functions
587 struct thermal_zone_device *thermal_of_zone_register(struct device_node *sensor, int id, void *data,
588 const struct thermal_zone_device_ops *ops)
590 struct thermal_zone_device *tz;
591 struct thermal_trip *trips;
592 struct thermal_zone_params *tzp;
593 struct thermal_zone_device_ops *of_ops;
594 struct device_node *np;
599 of_ops = kmemdup(ops, sizeof(*ops), GFP_KERNEL);
601 return ERR_PTR(-ENOMEM);
603 np = of_thermal_zone_find(sensor, id);
605 if (PTR_ERR(np) != -ENODEV)
606 pr_err("Failed to find thermal zone for %pOFn id=%d\n", sensor, id);
610 trips = thermal_of_trips_init(np, &ntrips);
612 pr_err("Failed to find trip points for %pOFn id=%d\n", sensor, id);
613 return ERR_CAST(trips);
616 ret = thermal_of_monitor_init(np, &delay, &pdelay);
618 pr_err("Failed to initialize monitoring delays from %pOFn\n", np);
619 goto out_kfree_trips;
622 tzp = thermal_of_parameters_init(np);
625 pr_err("Failed to initialize parameter from %pOFn: %d\n", np, ret);
626 goto out_kfree_trips;
629 of_ops->get_trip_type = of_ops->get_trip_type ? : of_thermal_get_trip_type;
630 of_ops->get_trip_temp = of_ops->get_trip_temp ? : of_thermal_get_trip_temp;
631 of_ops->get_trip_hyst = of_ops->get_trip_hyst ? : of_thermal_get_trip_hyst;
632 of_ops->set_trip_hyst = of_ops->set_trip_hyst ? : of_thermal_set_trip_hyst;
633 of_ops->get_crit_temp = of_ops->get_crit_temp ? : of_thermal_get_crit_temp;
634 of_ops->bind = thermal_of_bind;
635 of_ops->unbind = thermal_of_unbind;
637 mask = GENMASK_ULL((ntrips) - 1, 0);
639 tz = thermal_zone_device_register_with_trips(np->name, trips, ntrips,
640 mask, data, of_ops, tzp,
644 pr_err("Failed to register thermal zone %pOFn: %d\n", np, ret);
648 ret = thermal_zone_device_enable(tz);
650 pr_err("Failed to enabled thermal zone '%s', id=%d: %d\n",
651 tz->type, tz->id, ret);
652 thermal_of_zone_unregister(tz);
665 EXPORT_SYMBOL_GPL(thermal_of_zone_register);
667 static void devm_thermal_of_zone_release(struct device *dev, void *res)
669 thermal_of_zone_unregister(*(struct thermal_zone_device **)res);
672 static int devm_thermal_of_zone_match(struct device *dev, void *res,
675 struct thermal_zone_device **r = res;
677 if (WARN_ON(!r || !*r))
684 * devm_thermal_of_zone_register - register a thermal tied with the sensor life cycle
686 * This function is the device version of the thermal_of_zone_register() function.
688 * @dev: a device structure pointer to sensor to be tied with the thermal zone OF life cycle
689 * @sensor_id: the sensor identifier
690 * @data: a pointer to a private data to be stored in the thermal zone 'devdata' field
691 * @ops: a pointer to the ops structure associated with the sensor
693 struct thermal_zone_device *devm_thermal_of_zone_register(struct device *dev, int sensor_id, void *data,
694 const struct thermal_zone_device_ops *ops)
696 struct thermal_zone_device **ptr, *tzd;
698 ptr = devres_alloc(devm_thermal_of_zone_release, sizeof(*ptr),
701 return ERR_PTR(-ENOMEM);
703 tzd = thermal_of_zone_register(dev->of_node, sensor_id, data, ops);
710 devres_add(dev, ptr);
714 EXPORT_SYMBOL_GPL(devm_thermal_of_zone_register);
717 * devm_thermal_of_zone_unregister - Resource managed version of
718 * thermal_of_zone_unregister().
719 * @dev: Device for which which resource was allocated.
720 * @tz: a pointer to struct thermal_zone where the sensor is registered.
722 * This function removes the sensor callbacks and private data from the
723 * thermal zone device registered with devm_thermal_zone_of_sensor_register()
724 * API. It will also silent the zone by remove the .get_temp() and .get_trend()
725 * thermal zone device callbacks.
726 * Normally this function will not need to be called and the resource
727 * management code will ensure that the resource is freed.
729 void devm_thermal_of_zone_unregister(struct device *dev, struct thermal_zone_device *tz)
731 WARN_ON(devres_release(dev, devm_thermal_of_zone_release,
732 devm_thermal_of_zone_match, tz));
734 EXPORT_SYMBOL_GPL(devm_thermal_of_zone_unregister);