thermal: trip: Rework thermal_zone_set_trip() and its callers

From: Rafael J. Wysocki <[email protected]>

After recent changes in the thermal framework, a trip points array is required for registering a thermal zone that is not tripless, so the tz->trips pointer in thermal_zone_set_trip() is never NULL and the check involving it is redundant. Drop that check.

No functional impact.

Signed-off-by Rafael J. Wysocki <[email protected]>

Reviewed-by Lukasz Luba <[email protected]>

Quoted 7 lines · Rafael J. Wysocki

From: Rafael J. Wysocki <[email protected]>

After recent changes in the thermal framework, a trip points array is required for registering a thermal zone that is not tripless, so the tz->trips pointer in thermal_zone_set_trip() is never NULL and the check involving it is redundant. Drop that check.

Quoted 4 lines

No functional impact.

Signed-off-by Rafael J. Wysocki <[email protected]>

Reviewed-by Lukasz Luba <[email protected]>

Acked-by Daniel Lezcano <[email protected]>

From: Rafael J. Wysocki <[email protected]>

Both trip_point_temp_store() and trip_point_hyst_store() use thermal_zone_set_trip() to update a given trip point, but none of them actually needs to change more than one field in struct thermal_trip representing it. However, each of them effectively calls __thermal_zone_get_trip() twice in a row for the same trip index value, once directly and once via thermal_zone_set_trip(), which is not particularly efficient, and the way in which thermal_zone_set_trip() carries out the update is not particularly straightforward.

Moreover, some checks done by them both need not go under the thermal zone lock and code duplication between them can be reduced quite a bit by moving the majority of logic into thermal_zone_set_trip().

Rework all of the above functions to address the above.

No intentional functional impact.

Signed-off-by Rafael J. Wysocki <[email protected]>

---

v2 -> v3: Fix missing return statement in thermal_zone_set_trip() (Lukasz).

v1 -> v2:
* Fix 2 typos in the changelog (Lukasz).
* Split one change into the [1/2].

---
  drivers/thermal/thermal_core.h  |    9 ++++++
  drivers/thermal/thermal_sysfs.c |   52 ++++++++--------------------------
  drivers/thermal/thermal_trip.c  |   60 +++++++++++++++++++++++++++-------------
  include/linux/thermal.h         |    3 --
  4 files changed, 62 insertions(+), 62 deletions(-)

Index: linux-pm/drivers/thermal/thermal_core.h
===================================================================

drivers/thermal/thermal_core.h +9 -0

@@ -122,6 +122,15 @@ void __thermal_zone_device_update(struct
  void __thermal_zone_set_trips(struct thermal_zone_device *tz);
  int __thermal_zone_get_trip(struct thermal_zone_device *tz, int trip_id,
  			    struct thermal_trip *trip);
+
+enum thermal_set_trip_target {
+	THERMAL_TRIP_SET_TEMP,
+	THERMAL_TRIP_SET_HYST,
+};
+
+int thermal_zone_set_trip(struct thermal_zone_device *tz, int trip_id,
+			  enum thermal_set_trip_target what, const char *buf);
+
  int thermal_zone_trip_id(struct thermal_zone_device *tz,
  			 const struct thermal_trip *trip);
  int __thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);

Index: linux-pm/drivers/thermal/thermal_sysfs.c
===================================================================

drivers/thermal/thermal_sysfs.c +12 -40

@@ -120,31 +120,17 @@ trip_point_temp_store(struct device *dev
  		      const char *buf, size_t count)
  {
  	struct thermal_zone_device *tz = to_thermal_zone(dev);
-	struct thermal_trip trip;
-	int trip_id, ret;
+	int trip_id;
+	int ret;
+
+	if (!device_is_registered(dev))
+		return -ENODEV;
 
  	if (sscanf(attr->attr.name, "trip_point_%d_temp", &trip_id) != 1)
  		return -EINVAL;
 
-	mutex_lock(&tz->lock);
-
-	if (!device_is_registered(dev)) {
-		ret = -ENODEV;
-		goto unlock;
-	}
-
-	ret = __thermal_zone_get_trip(tz, trip_id, &trip);
-	if (ret)
-		goto unlock;
-
-	ret = kstrtoint(buf, 10, &trip.temperature);
-	if (ret)
-		goto unlock;
+	ret = thermal_zone_set_trip(tz, trip_id, THERMAL_TRIP_SET_TEMP, buf);
 
-	ret = thermal_zone_set_trip(tz, trip_id, &trip);
-unlock:
-	mutex_unlock(&tz->lock);
-	
  	return ret ? ret : count;
  }
 

@@ -179,30 +165,16 @@ trip_point_hyst_store(struct device *dev
  		      const char *buf, size_t count)
  {
  	struct thermal_zone_device *tz = to_thermal_zone(dev);
-	struct thermal_trip trip;
-	int trip_id, ret;
+	int trip_id;
+	int ret;
+
+	if (!device_is_registered(dev))
+		return -ENODEV;
 
  	if (sscanf(attr->attr.name, "trip_point_%d_hyst", &trip_id) != 1)
  		return -EINVAL;
 
-	mutex_lock(&tz->lock);
-
-	if (!device_is_registered(dev)) {
-		ret = -ENODEV;
-		goto unlock;
-	}
-
-	ret = __thermal_zone_get_trip(tz, trip_id, &trip);
-	if (ret)
-		goto unlock;
-
-	ret = kstrtoint(buf, 10, &trip.hysteresis);
-	if (ret)
-		goto unlock;
-
-	ret = thermal_zone_set_trip(tz, trip_id, &trip);
-unlock:
-	mutex_unlock(&tz->lock);
+	ret = thermal_zone_set_trip(tz, trip_id, THERMAL_TRIP_SET_HYST, buf);
 
  	return ret ? ret : count;
  }

Index: linux-pm/drivers/thermal/thermal_trip.c
===================================================================

drivers/thermal/thermal_trip.c +41 -19

@@ -148,39 +148,61 @@ int thermal_zone_get_trip(struct thermal
  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)
+			  enum thermal_set_trip_target what, const char *buf)
  {
-	struct thermal_trip t;
-	int ret;
+	struct thermal_trip *trip;
+	int val, ret = 0;
 
-	ret = __thermal_zone_get_trip(tz, trip_id, &t);
+	if (trip_id < 0 || trip_id >= tz->num_trips)
+		return -EINVAL;
+
+	ret = kstrtoint(buf, 10, &val);
  	if (ret)
  		return ret;
 
-	if (t.type != trip->type)
-		return -EINVAL;
+	mutex_lock(&tz->lock);
 
-	if (t.temperature != trip->temperature && tz->ops->set_trip_temp) {
-		ret = tz->ops->set_trip_temp(tz, trip_id, trip->temperature);
-		if (ret)
-			return ret;
-	}
+	trip = &tz->trips[trip_id];
 
-	if (t.hysteresis != trip->hysteresis && tz->ops->set_trip_hyst) {
-		ret = tz->ops->set_trip_hyst(tz, trip_id, trip->hysteresis);
-		if (ret)
-			return ret;
+	switch (what) {
+	case THERMAL_TRIP_SET_TEMP:
+		if (val == trip->temperature)
+			goto unlock;
+
+		if (tz->ops->set_trip_temp) {
+			ret = tz->ops->set_trip_temp(tz, trip_id, val);
+			if (ret)
+				goto unlock;
+		}
+		trip->temperature = val;
+		break;
+
+	case THERMAL_TRIP_SET_HYST:
+		if (val == trip->hysteresis)
+			goto unlock;
+
+		if (tz->ops->set_trip_hyst) {
+			ret = tz->ops->set_trip_hyst(tz, trip_id, val);
+			if (ret)
+				goto unlock;
+		}
+		trip->hysteresis = val;
+		break;
+
+	default:
+		ret = -EINVAL;
+		goto unlock;
  	}
 
-	if (tz->trips && (t.temperature != trip->temperature || t.hysteresis != trip->hysteresis))
-		tz->trips[trip_id] = *trip;
-
  	thermal_notify_tz_trip_change(tz->id, trip_id, trip->type,
  				      trip->temperature, trip->hysteresis);
 
  	__thermal_zone_device_update(tz, THERMAL_TRIP_CHANGED);
 
-	return 0;
+unlock:
+	mutex_unlock(&tz->lock);
+
+	return ret;
  }
 
  int thermal_zone_trip_id(struct thermal_zone_device *tz,

Index: linux-pm/include/linux/thermal.h
===================================================================

include/linux/thermal.h +0 -3

@@ -283,9 +283,6 @@ int __thermal_zone_get_trip(struct therm
  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 for_each_thermal_trip(struct thermal_zone_device *tz,
  			  int (*cb)(struct thermal_trip *, void *),
  			  void *data);

Hi Rafael,

Quoted 11 lines · Rafael J. Wysocki

From: Rafael J. Wysocki <[email protected]>

Both trip_point_temp_store() and trip_point_hyst_store() use thermal_zone_set_trip() to update a given trip point, but none of them actually needs to change more than one field in struct thermal_trip representing it. However, each of them effectively calls __thermal_zone_get_trip() twice in a row for the same trip index value, once directly and once via thermal_zone_set_trip(), which is not particularly efficient, and the way in which thermal_zone_set_trip() carries out the update is not particularly straightforward.

Quoted 5 lines

Moreover, some checks done by them both need not go under the thermal zone lock and code duplication between them can be reduced quite a bit by moving the majority of logic into thermal_zone_set_trip().

Rework all of the above functions to address the above.

Please hold on before merging this change. I've some comment about it but I have to double check a couple of things before

From: Rafael J. Wysocki <[email protected]>

Both trip_point_temp_store() and trip_point_hyst_store() use thermal_zone_set_trip() to update a given trip point, but none of them actually needs to change more than one field in struct thermal_trip representing it. However, each of them effectively calls __thermal_zone_get_trip() twice in a row for the same trip index value, once directly and once via thermal_zone_set_trip(), which is not particularly efficient, and the way in which thermal_zone_set_trip() carries out the update is not particularly straightforward.

Moreover, some checks done by them both need not go under the thermal zone lock and code duplication between them can be reduced quite a bit by moving the majority of logic into thermal_zone_set_trip().

Rework all of the above functions to address the above.

No intentional functional impact.

Signed-off-by Rafael J. Wysocki <[email protected]>

---

v2 -> v3: Fix missing return statement in thermal_zone_set_trip() (Lukasz).

v1 -> v2:
* Fix 2 typos in the changelog (Lukasz).
* Split one change into the [1/2].

---
  drivers/thermal/thermal_core.h  |    9 ++++++
  drivers/thermal/thermal_sysfs.c |   52 ++++++++--------------------------
  drivers/thermal/thermal_trip.c  |   60 +++++++++++++++++++++++++++-------------
  include/linux/thermal.h         |    3 --
  4 files changed, 62 insertions(+), 62 deletions(-)

From: Rafael J. Wysocki <[email protected]>

Both trip_point_temp_store() and trip_point_hyst_store() use thermal_zone_set_trip() to update a given trip point, but none of them actually needs to change more than one field in struct thermal_trip representing it. However, each of them effectively calls __thermal_zone_get_trip() twice in a row for the same trip index value, once directly and once via thermal_zone_set_trip(), which is not particularly efficient, and the way in which thermal_zone_set_trip() carries out the update is not particularly straightforward.

Moreover, some checks done by them both need not go under the thermal zone lock and code duplication between them can be reduced quite a bit by moving the majority of logic into thermal_zone_set_trip().

Rework all of the above functions to address the above.

No intentional functional impact.

Signed-off-by Rafael J. Wysocki <[email protected]>

---

v2 -> v3: Fix missing return statement in thermal_zone_set_trip() (Lukasz).

v1 -> v2:
* Fix 2 typos in the changelog (Lukasz).
* Split one change into the [1/2].

---
  drivers/thermal/thermal_core.h  |    9 ++++++
  drivers/thermal/thermal_sysfs.c |   52 ++++++++--------------------------
  drivers/thermal/thermal_trip.c  |   60 +++++++++++++++++++++++++++-------------
  include/linux/thermal.h         |    3 --
  4 files changed, 62 insertions(+), 62 deletions(-)

Index: linux-pm/drivers/thermal/thermal_core.h
===================================================================

drivers/thermal/thermal_core.h +9 -0

@@ -122,6 +122,15 @@ void __thermal_zone_device_update(struct
  void __thermal_zone_set_trips(struct thermal_zone_device *tz);
  int __thermal_zone_get_trip(struct thermal_zone_device *tz, int trip_id,
  			    struct thermal_trip *trip);
+
+enum thermal_set_trip_target {
+	THERMAL_TRIP_SET_TEMP,
+	THERMAL_TRIP_SET_HYST,
+};
+
+int thermal_zone_set_trip(struct thermal_zone_device *tz, int trip_id,
+			  enum thermal_set_trip_target what, const char *buf);
+
  int thermal_zone_trip_id(struct thermal_zone_device *tz,
  			 const struct thermal_trip *trip);
  int __thermal_zone_get_temp(struct thermal_zone_device *tz, int *temp);

Index: linux-pm/drivers/thermal/thermal_sysfs.c
===================================================================

drivers/thermal/thermal_sysfs.c +12 -40

@@ -120,31 +120,17 @@ trip_point_temp_store(struct device *dev
  		      const char *buf, size_t count)
  {
  	struct thermal_zone_device *tz = to_thermal_zone(dev);
-	struct thermal_trip trip;
-	int trip_id, ret;
+	int trip_id;
+	int ret;
+
+	if (!device_is_registered(dev))
+		return -ENODEV;
 
  	if (sscanf(attr->attr.name, "trip_point_%d_temp", &trip_id) != 1)
  		return -EINVAL;
 
-	mutex_lock(&tz->lock);
-
-	if (!device_is_registered(dev)) {
-		ret = -ENODEV;
-		goto unlock;
-	}
-
-	ret = __thermal_zone_get_trip(tz, trip_id, &trip);
-	if (ret)
-		goto unlock;
-
-	ret = kstrtoint(buf, 10, &trip.temperature);
-	if (ret)
-		goto unlock;
+	ret = thermal_zone_set_trip(tz, trip_id, THERMAL_TRIP_SET_TEMP, buf);
 
-	ret = thermal_zone_set_trip(tz, trip_id, &trip);
-unlock:
-	mutex_unlock(&tz->lock);
-	
  	return ret ? ret : count;
  }
 

@@ -179,30 +165,16 @@ trip_point_hyst_store(struct device *dev
  		      const char *buf, size_t count)
  {
  	struct thermal_zone_device *tz = to_thermal_zone(dev);
-	struct thermal_trip trip;
-	int trip_id, ret;
+	int trip_id;
+	int ret;
+
+	if (!device_is_registered(dev))
+		return -ENODEV;
 
  	if (sscanf(attr->attr.name, "trip_point_%d_hyst", &trip_id) != 1)
  		return -EINVAL;
 
-	mutex_lock(&tz->lock);
-
-	if (!device_is_registered(dev)) {
-		ret = -ENODEV;
-		goto unlock;
-	}
-
-	ret = __thermal_zone_get_trip(tz, trip_id, &trip);
-	if (ret)
-		goto unlock;
-
-	ret = kstrtoint(buf, 10, &trip.hysteresis);
-	if (ret)
-		goto unlock;
-
-	ret = thermal_zone_set_trip(tz, trip_id, &trip);
-unlock:
-	mutex_unlock(&tz->lock);
+	ret = thermal_zone_set_trip(tz, trip_id, THERMAL_TRIP_SET_HYST, buf);
 
  	return ret ? ret : count;
  }

Index: linux-pm/drivers/thermal/thermal_trip.c
===================================================================

drivers/thermal/thermal_trip.c +41 -19

@@ -148,39 +148,61 @@ int thermal_zone_get_trip(struct thermal
  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)
+			  enum thermal_set_trip_target what, const char *buf)
  {
-	struct thermal_trip t;
-	int ret;
+	struct thermal_trip *trip;
+	int val, ret = 0;
 
-	ret = __thermal_zone_get_trip(tz, trip_id, &t);
+	if (trip_id < 0 || trip_id >= tz->num_trips)
+		return -EINVAL;
+
+	ret = kstrtoint(buf, 10, &val);
  	if (ret)
  		return ret;
 
-	if (t.type != trip->type)
-		return -EINVAL;
+	mutex_lock(&tz->lock);
 
-	if (t.temperature != trip->temperature && tz->ops->set_trip_temp) {
-		ret = tz->ops->set_trip_temp(tz, trip_id, trip->temperature);
-		if (ret)
-			return ret;
-	}
+	trip = &tz->trips[trip_id];
 
-	if (t.hysteresis != trip->hysteresis && tz->ops->set_trip_hyst) {
-		ret = tz->ops->set_trip_hyst(tz, trip_id, trip->hysteresis);
-		if (ret)
-			return ret;
+	switch (what) {
+	case THERMAL_TRIP_SET_TEMP:
+		if (val == trip->temperature)
+			goto unlock;
+
+		if (tz->ops->set_trip_temp) {
+			ret = tz->ops->set_trip_temp(tz, trip_id, val);
+			if (ret)
+				goto unlock;
+		}
+		trip->temperature = val;
+		break;
+
+	case THERMAL_TRIP_SET_HYST:
+		if (val == trip->hysteresis)
+			goto unlock;
+
+		if (tz->ops->set_trip_hyst) {
+			ret = tz->ops->set_trip_hyst(tz, trip_id, val);
+			if (ret)
+				goto unlock;
+		}
+		trip->hysteresis = val;
+		break;
+
+	default:
+		ret = -EINVAL;
+		goto unlock;
  	}
 
-	if (tz->trips && (t.temperature != trip->temperature || t.hysteresis != trip->hysteresis))
-		tz->trips[trip_id] = *trip;
-
  	thermal_notify_tz_trip_change(tz->id, trip_id, trip->type,
  				      trip->temperature, trip->hysteresis);
 
  	__thermal_zone_device_update(tz, THERMAL_TRIP_CHANGED);
 
-	return 0;
+unlock:
+	mutex_unlock(&tz->lock);
+
+	return ret;
  }
 
  int thermal_zone_trip_id(struct thermal_zone_device *tz,

Index: linux-pm/include/linux/thermal.h
===================================================================

include/linux/thermal.h +0 -3

@@ -283,9 +283,6 @@ int __thermal_zone_get_trip(struct therm
  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 for_each_thermal_trip(struct thermal_zone_device *tz,
  			  int (*cb)(struct thermal_trip *, void *),
  			  void *data);

Hi Rafael,

Quoted 11 lines · Rafael J. Wysocki

From: Rafael J. Wysocki <[email protected]>

Both trip_point_temp_store() and trip_point_hyst_store() use thermal_zone_set_trip() to update a given trip point, but none of them actually needs to change more than one field in struct thermal_trip representing it. However, each of them effectively calls __thermal_zone_get_trip() twice in a row for the same trip index value, once directly and once via thermal_zone_set_trip(), which is not particularly efficient, and the way in which thermal_zone_set_trip() carries out the update is not particularly straightforward.

Quoted 5 lines

Moreover, some checks done by them both need not go under the thermal zone lock and code duplication between them can be reduced quite a bit by moving the majority of logic into thermal_zone_set_trip().

Rework all of the above functions to address the above.

The resulting change looks to me over complicate for the code it is supposed to improve. One new function, one enum and leaking the sysfs buffer to a function located outside of thermal-sysfs.c. That does not improve the readability IMO.

The function thermal_zone_set_trip is only called from thermal_syfs.c

Why not directly change the trip point temp/hyst value in the array in the thermal_sysfs functions and remove the function thermal_zone_set_trip() ?