2022-09-26 15:45:25

by Daniel Lezcano

[permalink] [raw]
Subject: [PATCH v5 03/30] thermal/core: Add a generic thermal_zone_set_trip() function

The thermal zone ops defines a set_trip callback where we can invoke
the backend driver to set an interrupt for the next trip point
temperature being crossed the way up or down, or setting the low level
with the hysteresis.

The ops is only called from the thermal sysfs code where the userspace
has the ability to modify a trip point characteristic.

With the effort of encapsulating the thermal framework core code,
let's create a thermal_zone_set_trip() which is the writable side of
the thermal_zone_get_trip() and put there all the ops encapsulation.

Signed-off-by: Daniel Lezcano <[email protected]>
---
drivers/thermal/thermal_core.c | 45 +++++++++++++++++++++++++++++++
drivers/thermal/thermal_sysfs.c | 48 +++++++++++----------------------
include/linux/thermal.h | 3 +++
3 files changed, 64 insertions(+), 32 deletions(-)

diff --git a/drivers/thermal/thermal_core.c b/drivers/thermal/thermal_core.c
index 903a858df35f..9f61b0ab57b7 100644
--- a/drivers/thermal/thermal_core.c
+++ b/drivers/thermal/thermal_core.c
@@ -1212,6 +1212,51 @@ int thermal_zone_get_trip(struct thermal_zone_device *tz, int trip_id,
}
EXPORT_SYMBOL_GPL(thermal_zone_get_trip);

+int thermal_zone_set_trip(struct thermal_zone_device *tz, int trip_id,
+ const struct thermal_trip *trip)
+{
+ struct thermal_trip t;
+ int ret = -EINVAL;
+
+ mutex_lock(&tz->lock);
+
+ if (!tz->ops->set_trip_temp && !tz->ops->set_trip_hyst && !tz->trips)
+ goto out;
+
+ ret = __thermal_zone_get_trip(tz, trip_id, &t);
+ if (ret)
+ goto out;
+
+ if ((t.temperature != trip->temperature) && tz->ops->set_trip_temp) {
+
+ ret = tz->ops->set_trip_temp(tz, trip_id, trip->temperature);
+ if (ret)
+ goto out;
+ }
+
+ if ((t.hysteresis != trip->hysteresis) && tz->ops->set_trip_hyst) {
+
+ ret = tz->ops->set_trip_hyst(tz, trip_id, trip->hysteresis);
+ if (ret)
+ goto out;
+ }
+
+ if (((t.temperature != trip->temperature) ||
+ (t.hysteresis != trip->hysteresis)) && tz->trips)
+ tz->trips[trip_id] = *trip;
+
+out:
+ mutex_unlock(&tz->lock);
+
+ if (!ret) {
+ thermal_notify_tz_trip_change(tz->id, trip_id, trip->type,
+ trip->temperature, trip->hysteresis);
+ thermal_zone_device_update(tz, THERMAL_TRIP_CHANGED);
+ }
+
+ return ret;
+}
+
/**
* thermal_zone_device_register_with_trips() - register a new thermal zone device
* @type: the thermal zone device type
diff --git a/drivers/thermal/thermal_sysfs.c b/drivers/thermal/thermal_sysfs.c
index 18cdd7cd0008..8d7b25ab67c2 100644
--- a/drivers/thermal/thermal_sysfs.c
+++ b/drivers/thermal/thermal_sysfs.c
@@ -115,31 +115,20 @@ trip_point_temp_store(struct device *dev, struct device_attribute *attr,
struct thermal_trip trip;
int trip_id, ret;

- if (!tz->ops->set_trip_temp && !tz->trips)
- return -EPERM;
-
if (sscanf(attr->attr.name, "trip_point_%d_temp", &trip_id) != 1)
return -EINVAL;

- if (kstrtoint(buf, 10, &trip.temperature))
- return -EINVAL;
-
- ret = tz->ops->set_trip_temp(tz, trip_id, trip.temperature);
+ ret = thermal_zone_get_trip(tz, trip_id, &trip);
if (ret)
return ret;

- if (tz->trips)
- tz->trips[trip_id].temperature = trip.temperature;
+ if (kstrtoint(buf, 10, &trip.temperature))
+ return -EINVAL;

- ret = thermal_zone_get_trip(tz, trip_id, &trip);
+ ret = thermal_zone_set_trip(tz, trip_id, &trip);
if (ret)
return ret;

- thermal_notify_tz_trip_change(tz->id, trip_id, trip.type,
- trip.temperature, trip.hysteresis);
-
- thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
-
return count;
}

@@ -166,29 +155,24 @@ trip_point_hyst_store(struct device *dev, struct device_attribute *attr,
const char *buf, size_t count)
{
struct thermal_zone_device *tz = to_thermal_zone(dev);
- int trip, ret;
- int temperature;
-
- if (!tz->ops->set_trip_hyst)
- return -EPERM;
+ struct thermal_trip trip;
+ int trip_id, ret;

- if (sscanf(attr->attr.name, "trip_point_%d_hyst", &trip) != 1)
+ if (sscanf(attr->attr.name, "trip_point_%d_hyst", &trip_id) != 1)
return -EINVAL;

- if (kstrtoint(buf, 10, &temperature))
- return -EINVAL;
+ ret = thermal_zone_get_trip(tz, trip_id, &trip);
+ if (ret)
+ return ret;

- /*
- * We are not doing any check on the 'temperature' value
- * here. The driver implementing 'set_trip_hyst' has to
- * take care of this.
- */
- ret = tz->ops->set_trip_hyst(tz, trip, temperature);
+ if (kstrtoint(buf, 10, &trip.hysteresis))
+ return -EINVAL;

- if (!ret)
- thermal_zone_set_trips(tz);
+ ret = thermal_zone_set_trip(tz, trip_id, &trip);
+ if (ret)
+ return ret;

- return ret ? ret : count;
+ return count;
}

static ssize_t
diff --git a/include/linux/thermal.h b/include/linux/thermal.h
index 09dc09228717..5350a437f245 100644
--- a/include/linux/thermal.h
+++ b/include/linux/thermal.h
@@ -338,6 +338,9 @@ static inline void devm_thermal_of_zone_unregister(struct device *dev,
int thermal_zone_get_trip(struct thermal_zone_device *tz, int trip_id,
struct thermal_trip *trip);

+int thermal_zone_set_trip(struct thermal_zone_device *tz, int trip_id,
+ const struct thermal_trip *trip);
+
int thermal_zone_get_num_trips(struct thermal_zone_device *tz);

#ifdef CONFIG_THERMAL
--
2.34.1


2022-09-26 20:13:11

by Rafael J. Wysocki

[permalink] [raw]
Subject: Re: [PATCH v5 03/30] thermal/core: Add a generic thermal_zone_set_trip() function

On Mon, Sep 26, 2022 at 4:06 PM Daniel Lezcano
<[email protected]> wrote:
>
> The thermal zone ops defines a set_trip callback where we can invoke
> the backend driver to set an interrupt for the next trip point
> temperature being crossed the way up or down, or setting the low level
> with the hysteresis.
>
> The ops is only called from the thermal sysfs code where the userspace
> has the ability to modify a trip point characteristic.
>
> With the effort of encapsulating the thermal framework core code,
> let's create a thermal_zone_set_trip() which is the writable side of
> the thermal_zone_get_trip() and put there all the ops encapsulation.
>
> Signed-off-by: Daniel Lezcano <[email protected]>
> ---
> drivers/thermal/thermal_core.c | 45 +++++++++++++++++++++++++++++++
> drivers/thermal/thermal_sysfs.c | 48 +++++++++++----------------------
> include/linux/thermal.h | 3 +++
> 3 files changed, 64 insertions(+), 32 deletions(-)
>
> diff --git a/drivers/thermal/thermal_core.c b/drivers/thermal/thermal_core.c
> index 903a858df35f..9f61b0ab57b7 100644
> --- a/drivers/thermal/thermal_core.c
> +++ b/drivers/thermal/thermal_core.c
> @@ -1212,6 +1212,51 @@ int thermal_zone_get_trip(struct thermal_zone_device *tz, int trip_id,
> }
> EXPORT_SYMBOL_GPL(thermal_zone_get_trip);
>
> +int thermal_zone_set_trip(struct thermal_zone_device *tz, int trip_id,
> + const struct thermal_trip *trip)
> +{
> + struct thermal_trip t;
> + int ret = -EINVAL;
> +
> + mutex_lock(&tz->lock);
> +
> + if (!tz->ops->set_trip_temp && !tz->ops->set_trip_hyst && !tz->trips)
> + goto out;
> +
> + ret = __thermal_zone_get_trip(tz, trip_id, &t);
> + if (ret)
> + goto out;
> +
> + if ((t.temperature != trip->temperature) && tz->ops->set_trip_temp) {

The inner parens are not needed here and below.

> +

And the extra empty line is not needed here (and below) too IMO.

> + ret = tz->ops->set_trip_temp(tz, trip_id, trip->temperature);
> + if (ret)
> + goto out;
> + }
> +
> + if ((t.hysteresis != trip->hysteresis) && tz->ops->set_trip_hyst) {
> +
> + ret = tz->ops->set_trip_hyst(tz, trip_id, trip->hysteresis);
> + if (ret)
> + goto out;
> + }
> +
> + if (((t.temperature != trip->temperature) ||
> + (t.hysteresis != trip->hysteresis)) && tz->trips)
> + tz->trips[trip_id] = *trip;

I would write this as

if (tz->trips && (t.temperature != trip->temperature || t.hysteresis
!= trip->hysteresis))
tz->trips[trip_id] = *trip;

But

1. Do we want to copy the trip type here too?
2. If tz->trips is set, do we still want to invoke ->set_trip_temp()
or ->set_trip_hyst() if they are present?

> +
> +out:
> + mutex_unlock(&tz->lock);
> +
> + if (!ret) {
> + thermal_notify_tz_trip_change(tz->id, trip_id, trip->type,
> + trip->temperature, trip->hysteresis);
> + thermal_zone_device_update(tz, THERMAL_TRIP_CHANGED);
> + }
> +
> + return ret;
> +}
> +
> /**
> * thermal_zone_device_register_with_trips() - register a new thermal zone device
> * @type: the thermal zone device type
> diff --git a/drivers/thermal/thermal_sysfs.c b/drivers/thermal/thermal_sysfs.c
> index 18cdd7cd0008..8d7b25ab67c2 100644
> --- a/drivers/thermal/thermal_sysfs.c
> +++ b/drivers/thermal/thermal_sysfs.c
> @@ -115,31 +115,20 @@ trip_point_temp_store(struct device *dev, struct device_attribute *attr,
> struct thermal_trip trip;
> int trip_id, ret;
>
> - if (!tz->ops->set_trip_temp && !tz->trips)
> - return -EPERM;
> -
> if (sscanf(attr->attr.name, "trip_point_%d_temp", &trip_id) != 1)
> return -EINVAL;
>
> - if (kstrtoint(buf, 10, &trip.temperature))
> - return -EINVAL;
> -
> - ret = tz->ops->set_trip_temp(tz, trip_id, trip.temperature);
> + ret = thermal_zone_get_trip(tz, trip_id, &trip);
> if (ret)
> return ret;
>
> - if (tz->trips)
> - tz->trips[trip_id].temperature = trip.temperature;
> + if (kstrtoint(buf, 10, &trip.temperature))
> + return -EINVAL;
>
> - ret = thermal_zone_get_trip(tz, trip_id, &trip);
> + ret = thermal_zone_set_trip(tz, trip_id, &trip);
> if (ret)
> return ret;
>
> - thermal_notify_tz_trip_change(tz->id, trip_id, trip.type,
> - trip.temperature, trip.hysteresis);
> -
> - thermal_zone_device_update(tz, THERMAL_EVENT_UNSPECIFIED);
> -
> return count;
> }
>
> @@ -166,29 +155,24 @@ trip_point_hyst_store(struct device *dev, struct device_attribute *attr,
> const char *buf, size_t count)
> {
> struct thermal_zone_device *tz = to_thermal_zone(dev);
> - int trip, ret;
> - int temperature;
> -
> - if (!tz->ops->set_trip_hyst)
> - return -EPERM;
> + struct thermal_trip trip;
> + int trip_id, ret;
>
> - if (sscanf(attr->attr.name, "trip_point_%d_hyst", &trip) != 1)
> + if (sscanf(attr->attr.name, "trip_point_%d_hyst", &trip_id) != 1)
> return -EINVAL;
>
> - if (kstrtoint(buf, 10, &temperature))
> - return -EINVAL;
> + ret = thermal_zone_get_trip(tz, trip_id, &trip);
> + if (ret)
> + return ret;
>
> - /*
> - * We are not doing any check on the 'temperature' value
> - * here. The driver implementing 'set_trip_hyst' has to
> - * take care of this.
> - */
> - ret = tz->ops->set_trip_hyst(tz, trip, temperature);
> + if (kstrtoint(buf, 10, &trip.hysteresis))
> + return -EINVAL;
>
> - if (!ret)
> - thermal_zone_set_trips(tz);
> + ret = thermal_zone_set_trip(tz, trip_id, &trip);
> + if (ret)
> + return ret;
>
> - return ret ? ret : count;
> + return count;
> }
>
> static ssize_t
> diff --git a/include/linux/thermal.h b/include/linux/thermal.h
> index 09dc09228717..5350a437f245 100644
> --- a/include/linux/thermal.h
> +++ b/include/linux/thermal.h
> @@ -338,6 +338,9 @@ static inline void devm_thermal_of_zone_unregister(struct device *dev,
> int thermal_zone_get_trip(struct thermal_zone_device *tz, int trip_id,
> struct thermal_trip *trip);
>
> +int thermal_zone_set_trip(struct thermal_zone_device *tz, int trip_id,
> + const struct thermal_trip *trip);
> +
> int thermal_zone_get_num_trips(struct thermal_zone_device *tz);
>
> #ifdef CONFIG_THERMAL
> --
> 2.34.1
>

2022-09-26 23:45:16

by Daniel Lezcano

[permalink] [raw]
Subject: Re: [PATCH v5 03/30] thermal/core: Add a generic thermal_zone_set_trip() function

On 26/09/2022 21:25, Rafael J. Wysocki wrote:

[ ... ]

>> + if ((t.temperature != trip->temperature) && tz->ops->set_trip_temp) {
>
> The inner parens are not needed here and below.
>
>> +
>
> And the extra empty line is not needed here (and below) too IMO.
>
>> + ret = tz->ops->set_trip_temp(tz, trip_id, trip->temperature);
>> + if (ret)
>> + goto out;
>> + }
>

Without the parens, the following happens:


warning: this ‘if’ clause does not guard... [-Wmisleading-indentation]
1229 | if ((t.temperature != trip->temperature) &&
tz->ops->set_trip_temp)
| ^~
note: ...this statement, but the latter is misleadingly indented as if
it were guarded by the ‘if’
1231 | if (ret)
| ^~


>> + if ((t.hysteresis != trip->hysteresis) && tz->ops->set_trip_hyst) {
>> +
>> + ret = tz->ops->set_trip_hyst(tz, trip_id, trip->hysteresis);
>> + if (ret)
>> + goto out;
>> + }
>> +
>> + if (((t.temperature != trip->temperature) ||
>> + (t.hysteresis != trip->hysteresis)) && tz->trips)
>> + tz->trips[trip_id] = *trip;
>
> I would write this as
>
> if (tz->trips && (t.temperature != trip->temperature || t.hysteresis
> != trip->hysteresis))
> tz->trips[trip_id] = *trip;

Ok, sure

> But
>
> 1. Do we want to copy the trip type here too?

The function thermal_zone_set_trip() is called from thermal_sysfs.c, it
is the unique call site. However, I think it is a good idea to check the
type of the trip point is not changed, even if it is not possible with
the actual code.

> 2. If tz->trips is set, do we still want to invoke ->set_trip_temp()
> or ->set_trip_hyst() if they are present?

No but there are bogus drivers setting the interrupt with these ops
instead of using the set_trips ops (eg. [1][2][3]). So in order to keep
those working ATM, I'm keeping them and when all the drivers will be
changed, I'll wipe out the set_trip_* ops from everywhere.

[1] drivers/thermal/samsung/exynos_tmu.c
[2] drivers/thermal/qcom/qcom-spmi-temp-alarm.c
[3] drivers/thermal/imx_thermal.c


--
<http://www.linaro.org/> Linaro.org │ Open source software for ARM SoCs

Follow Linaro: <http://www.facebook.com/pages/Linaro> Facebook |
<http://twitter.com/#!/linaroorg> Twitter |
<http://www.linaro.org/linaro-blog/> Blog

2022-09-27 10:49:30

by Rafael J. Wysocki

[permalink] [raw]
Subject: Re: [PATCH v5 03/30] thermal/core: Add a generic thermal_zone_set_trip() function

On Tue, Sep 27, 2022 at 12:11 AM Daniel Lezcano
<[email protected]> wrote:
>
> On 26/09/2022 21:25, Rafael J. Wysocki wrote:
>
> [ ... ]
>
> >> + if ((t.temperature != trip->temperature) && tz->ops->set_trip_temp) {
> >
> > The inner parens are not needed here and below.
> >
> >> +
> >
> > And the extra empty line is not needed here (and below) too IMO.
> >
> >> + ret = tz->ops->set_trip_temp(tz, trip_id, trip->temperature);
> >> + if (ret)
> >> + goto out;
> >> + }
> >
>
> Without the parens, the following happens:
>
>
> warning: this ‘if’ clause does not guard... [-Wmisleading-indentation]
> 1229 | if ((t.temperature != trip->temperature) &&
> tz->ops->set_trip_temp)
> | ^~
> note: ...this statement, but the latter is misleadingly indented as if
> it were guarded by the ‘if’
> 1231 | if (ret)
> | ^~

This is about indentation, though, so it looks like white space is
mangled somehow.

As a matter of correctness, the inner parens are not needed.

> >> + if ((t.hysteresis != trip->hysteresis) && tz->ops->set_trip_hyst) {
> >> +
> >> + ret = tz->ops->set_trip_hyst(tz, trip_id, trip->hysteresis);
> >> + if (ret)
> >> + goto out;
> >> + }
> >> +
> >> + if (((t.temperature != trip->temperature) ||
> >> + (t.hysteresis != trip->hysteresis)) && tz->trips)
> >> + tz->trips[trip_id] = *trip;
> >
> > I would write this as
> >
> > if (tz->trips && (t.temperature != trip->temperature || t.hysteresis
> > != trip->hysteresis))
> > tz->trips[trip_id] = *trip;
>
> Ok, sure
>
> > But
> >
> > 1. Do we want to copy the trip type here too?
>
> The function thermal_zone_set_trip() is called from thermal_sysfs.c, it
> is the unique call site. However, I think it is a good idea to check the
> type of the trip point is not changed, even if it is not possible with
> the actual code.
>
> > 2. If tz->trips is set, do we still want to invoke ->set_trip_temp()
> > or ->set_trip_hyst() if they are present?
>
> No but there are bogus drivers setting the interrupt with these ops
> instead of using the set_trips ops (eg. [1][2][3]). So in order to keep
> those working ATM, I'm keeping them and when all the drivers will be
> changed, I'll wipe out the set_trip_* ops from everywhere.

Do those drivers set tz->trips? If not, the tz->trips check can go
before the ops ones.

> [1] drivers/thermal/samsung/exynos_tmu.c
> [2] drivers/thermal/qcom/qcom-spmi-temp-alarm.c
> [3] drivers/thermal/imx_thermal.c

2022-09-27 13:44:27

by Daniel Lezcano

[permalink] [raw]
Subject: Re: [PATCH v5 03/30] thermal/core: Add a generic thermal_zone_set_trip() function

On 27/09/2022 12:38, Rafael J. Wysocki wrote:
> On Tue, Sep 27, 2022 at 12:11 AM Daniel Lezcano
> <[email protected]> wrote:
>>
>> On 26/09/2022 21:25, Rafael J. Wysocki wrote:
>>
>> [ ... ]
>>
>>>> + if ((t.temperature != trip->temperature) && tz->ops->set_trip_temp) {
>>>
>>> The inner parens are not needed here and below.
>>>
>>>> +
>>>
>>> And the extra empty line is not needed here (and below) too IMO.
>>>
>>>> + ret = tz->ops->set_trip_temp(tz, trip_id, trip->temperature);
>>>> + if (ret)
>>>> + goto out;
>>>> + }
>>>
>>
>> Without the parens, the following happens:
>>
>>
>> warning: this ‘if’ clause does not guard... [-Wmisleading-indentation]
>> 1229 | if ((t.temperature != trip->temperature) &&
>> tz->ops->set_trip_temp)
>> | ^~
>> note: ...this statement, but the latter is misleadingly indented as if
>> it were guarded by the ‘if’
>> 1231 | if (ret)
>> | ^~
>
> This is about indentation, though, so it looks like white space is
> mangled somehow.
>
> As a matter of correctness, the inner parens are not needed.

Oh, actually I did a confusion with the 'brackets', you meant:

(t.temperature != trip->temperature && tz->ops->set_trip_temp)

right ?

>>>> + if ((t.hysteresis != trip->hysteresis) && tz->ops->set_trip_hyst) {
>>>> +
>>>> + ret = tz->ops->set_trip_hyst(tz, trip_id, trip->hysteresis);
>>>> + if (ret)
>>>> + goto out;
>>>> + }
>>>> +
>>>> + if (((t.temperature != trip->temperature) ||
>>>> + (t.hysteresis != trip->hysteresis)) && tz->trips)
>>>> + tz->trips[trip_id] = *trip;
>>>
>>> I would write this as
>>>
>>> if (tz->trips && (t.temperature != trip->temperature || t.hysteresis
>>> != trip->hysteresis))
>>> tz->trips[trip_id] = *trip;
>>
>> Ok, sure
>>
>>> But
>>>
>>> 1. Do we want to copy the trip type here too?
>>
>> The function thermal_zone_set_trip() is called from thermal_sysfs.c, it
>> is the unique call site. However, I think it is a good idea to check the
>> type of the trip point is not changed, even if it is not possible with
>> the actual code.
>>
>>> 2. If tz->trips is set, do we still want to invoke ->set_trip_temp()
>>> or ->set_trip_hyst() if they are present?
>>
>> No but there are bogus drivers setting the interrupt with these ops
>> instead of using the set_trips ops (eg. [1][2][3]). So in order to keep
>> those working ATM, I'm keeping them and when all the drivers will be
>> changed, I'll wipe out the set_trip_* ops from everywhere.
>
> Do those drivers set tz->trips? If not, the tz->trips check can go
> before the ops ones.

Unfortunately some are doing that, like the tegra's soctherm driver


>> [1] drivers/thermal/samsung/exynos_tmu.c
>> [2] drivers/thermal/qcom/qcom-spmi-temp-alarm.c
>> [3] drivers/thermal/imx_thermal.c


--
<http://www.linaro.org/> Linaro.org │ Open source software for ARM SoCs

Follow Linaro: <http://www.facebook.com/pages/Linaro> Facebook |
<http://twitter.com/#!/linaroorg> Twitter |
<http://www.linaro.org/linaro-blog/> Blog