Skip to contentSkip to conversation

thermal: core: Cosmetic updates

PATCH In review Rafael J. Wysocki 2 participants 7 messages Jan 16, 2025 – Jan 17, 2025 Thermal

lore
Share & tools
lore
#0 lore raw

cover thermal: core: Cosmetic updates

Hi Everyone,

The patches in this series just rename a few things in the thermal subsystem and relocate a comment.

Thanks!

#1 lore raw

PATCH 1/3 thermal: core: Rename callback functions in two governors

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

The names of :trip_crossed() callback functions in the Bang-bang and User-space thermal governors don't match their current purpose any more after previous changes, so rename them.

No functional impact.

---
 drivers/thermal/gov_bang_bang.c  |   10 +++++-----
 drivers/thermal/gov_user_space.c |   10 +++++-----
 2 files changed, 10 insertions(+), 10 deletions(-)
drivers/thermal/gov_bang_bang.c +5 -5
@@ -34,7 +34,7 @@
 }
 
 /**
- * bang_bang_control - controls devices associated with the given zone
+ * bang_bang_trip_crossed - controls devices associated with the given zone
  * @tz: thermal_zone_device
  * @trip: the trip point
  * @crossed_up: whether or not the trip has been crossed on the way up
@@ -61,9 +61,9 @@
  *     (trip_temp - hyst) so that the fan gets turned off again.
  *
  */
-static void bang_bang_control(struct thermal_zone_device *tz,
-			      const struct thermal_trip *trip,
-			      bool crossed_up)
+static void bang_bang_trip_crossed(struct thermal_zone_device *tz,
+				   const struct thermal_trip *trip,
+				   bool crossed_up)
 {
 	const struct thermal_trip_desc *td = trip_to_trip_desc(trip);
 	struct thermal_instance *instance;
@@ -123,7 +123,7 @@
 
 static struct thermal_governor thermal_gov_bang_bang = {
 	.name		= "bang_bang",
-	.trip_crossed	= bang_bang_control,
+	.trip_crossed	= bang_bang_trip_crossed,
 	.manage		= bang_bang_manage,
 	.update_tz	= bang_bang_update_tz,
 };
drivers/thermal/gov_user_space.c +5 -5
@@ -23,16 +23,16 @@
 }
 
 /**
- * notify_user_space - Notifies user space about thermal events
+ * user_space_trip_crossed - Notify user space about trip crossing events
  * @tz: thermal_zone_device
  * @trip: trip point
  * @crossed_up: whether or not the trip has been crossed on the way up
  *
  * This function notifies the user space through UEvents.
  */
-static void notify_user_space(struct thermal_zone_device *tz,
-			      const struct thermal_trip *trip,
-			      bool crossed_up)
+static void user_space_trip_crossed(struct thermal_zone_device *tz,
+				    const struct thermal_trip *trip,
+				    bool crossed_up)
 {
 	char *thermal_prop[5];
 	int i;
@@ -52,7 +52,7 @@
 
 static struct thermal_governor thermal_gov_user_space = {
 	.name		= "user_space",
-	.trip_crossed	= notify_user_space,
+	.trip_crossed	= user_space_trip_crossed,
 	.bind_to_tz	= user_space_bind,
 };
 THERMAL_GOVERNOR_DECLARE(thermal_gov_user_space);
reviewer Reviewed-by on v1 1/3
#2 lore raw

Re: [PATCH v1 1/3] thermal: core: Rename callback functions in two governors

Hi Rafael,

Quoted 74 lines · Rafael J. Wysocki

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

The names of :trip_crossed() callback functions in the Bang-bang and User-space thermal governors don't match their current purpose any more after previous changes, so rename them.

No functional impact.

---
  drivers/thermal/gov_bang_bang.c  |   10 +++++-----
  drivers/thermal/gov_user_space.c |   10 +++++-----
  2 files changed, 10 insertions(+), 10 deletions(-)
drivers/thermal/gov_bang_bang.c +5 -5
@@ -34,7 +34,7 @@
  }
 
  /**
- * bang_bang_control - controls devices associated with the given zone
+ * bang_bang_trip_crossed - controls devices associated with the given zone
   * @tz: thermal_zone_device
   * @trip: the trip point
   * @crossed_up: whether or not the trip has been crossed on the way up
@@ -61,9 +61,9 @@
   *     (trip_temp - hyst) so that the fan gets turned off again.
   *
   */
-static void bang_bang_control(struct thermal_zone_device *tz,
-			      const struct thermal_trip *trip,
-			      bool crossed_up)
+static void bang_bang_trip_crossed(struct thermal_zone_device *tz,
+				   const struct thermal_trip *trip,
+				   bool crossed_up)
  {
  	const struct thermal_trip_desc *td = trip_to_trip_desc(trip);
  	struct thermal_instance *instance;
@@ -123,7 +123,7 @@
 
  static struct thermal_governor thermal_gov_bang_bang = {
  	.name		= "bang_bang",
-	.trip_crossed	= bang_bang_control,
+	.trip_crossed	= bang_bang_trip_crossed,
  	.manage		= bang_bang_manage,
  	.update_tz	= bang_bang_update_tz,
  };
drivers/thermal/gov_user_space.c +4 -4
@@ -23,16 +23,16 @@
  }
 
  /**
- * notify_user_space - Notifies user space about thermal events
+ * user_space_trip_crossed - Notify user space about trip crossing events
   * @tz: thermal_zone_device
   * @trip: trip point
   * @crossed_up: whether or not the trip has been crossed on the way up
   *
   * This function notifies the user space through UEvents.
   */
-static void notify_user_space(struct thermal_zone_device *tz,
-			      const struct thermal_trip *trip,
-			      bool crossed_up)
+static void user_space_trip_crossed(struct thermal_zone_device *tz,
+				    const struct thermal_trip *trip,
+				    bool crossed_up)
  {
  	char *thermal_prop[5];
  	int i;

drivers/thermal/gov_user_space.c line 58

Quoted 8 lines
drivers/thermal/gov_user_space.c +1 -1
@@ -52,7 +52,7 @@
 
  static struct thermal_governor thermal_gov_user_space = {
  	.name		= "user_space",
-	.trip_crossed	= notify_user_space,
+	.trip_crossed	= user_space_trip_crossed,
  	.bind_to_tz	= user_space_bind,
  };
  THERMAL_GOVERNOR_DECLARE(thermal_gov_user_space);

Make sense and LGTM

#3 lore raw

PATCH 2/3 thermal: gov_bang_bang: Relocate regulation logic description

In reply to Rafael J. Wysocki

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

Move the regulation logic description from the bang_bang_trip_crossed() kerneldoc to the preamble.

No functional impact.

---
 drivers/thermal/gov_bang_bang.c |   43 +++++++++++++++++++---------------------
 1 file changed, 21 insertions(+), 22 deletions(-)
drivers/thermal/gov_bang_bang.c +21 -22
@@ -7,6 +7,27 @@
  *  Based on step_wise.c with following Copyrights:
  *  Copyright (C) 2012 Intel Corp
  *  Copyright (C) 2012 Durgadoss R <[email protected]>
+ * 
+ * Regulation Logic: a two point regulation, deliver cooling state depending
+ * on the previous state shown in this diagram:
+ *
+ *                Fan:   OFF    ON
+ *
+ *                              |
+ *                              |
+ *          trip_temp:    +---->+
+ *                        |     |        ^
+ *                        |     |        |
+ *                        |     |   Temperature
+ * (trip_temp - hyst):    +<----+
+ *                        |
+ *                        |
+ *                        |
+ *
+ *   * If the fan is not running and temperature exceeds trip_temp, the fan
+ *     gets turned on.
+ *   * In case the fan is running, temperature must fall below
+ *     (trip_temp - hyst) so that the fan gets turned off again.
  */
 
 #include <linux/thermal.h>
@@ -38,28 +59,6 @@
  * @tz: thermal_zone_device
  * @trip: the trip point
  * @crossed_up: whether or not the trip has been crossed on the way up
- *
- * Regulation Logic: a two point regulation, deliver cooling state depending
- * on the previous state shown in this diagram:
- *
- *                Fan:   OFF    ON
- *
- *                              |
- *                              |
- *          trip_temp:    +---->+
- *                        |     |        ^
- *                        |     |        |
- *                        |     |   Temperature
- * (trip_temp - hyst):    +<----+
- *                        |
- *                        |
- *                        |
- *
- *   * If the fan is not running and temperature exceeds trip_temp, the fan
- *     gets turned on.
- *   * In case the fan is running, temperature must fall below
- *     (trip_temp - hyst) so that the fan gets turned off again.
- *
  */
 static void bang_bang_trip_crossed(struct thermal_zone_device *tz,
 				   const struct thermal_trip *trip,
reviewer Reviewed-by on v1 2/3
#4 lore raw

Re: [PATCH v1 2/3] thermal: gov_bang_bang: Relocate regulation logic description

Quoted 64 lines · Rafael J. Wysocki

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

Move the regulation logic description from the bang_bang_trip_crossed() kerneldoc to the preamble.

No functional impact.

---
  drivers/thermal/gov_bang_bang.c |   43 +++++++++++++++++++---------------------
  1 file changed, 21 insertions(+), 22 deletions(-)
drivers/thermal/gov_bang_bang.c +21 -15
@@ -7,6 +7,27 @@
   *  Based on step_wise.c with following Copyrights:
   *  Copyright (C) 2012 Intel Corp
   *  Copyright (C) 2012 Durgadoss R <[email protected]>
+ *
+ * Regulation Logic: a two point regulation, deliver cooling state depending
+ * on the previous state shown in this diagram:
+ *
+ *                Fan:   OFF    ON
+ *
+ *                              |
+ *                              |
+ *          trip_temp:    +---->+
+ *                        |     |        ^
+ *                        |     |        |
+ *                        |     |   Temperature
+ * (trip_temp - hyst):    +<----+
+ *                        |
+ *                        |
+ *                        |
+ *
+ *   * If the fan is not running and temperature exceeds trip_temp, the fan
+ *     gets turned on.
+ *   * In case the fan is running, temperature must fall below
+ *     (trip_temp - hyst) so that the fan gets turned off again.
   */
 
  #include <linux/thermal.h>
@@ -38,28 +59,6 @@
   * @tz: thermal_zone_device
   * @trip: the trip point
   * @crossed_up: whether or not the trip has been crossed on the way up
- *
- * Regulation Logic: a two point regulation, deliver cooling state depending
- * on the previous state shown in this diagram:
- *
- *                Fan:   OFF    ON
- *
- *                              |
- *                              |
- *          trip_temp:    +---->+
- *                        |     |        ^
- *                        |     |        |
- *                        |     |   Temperature
- * (trip_temp - hyst):    +<----+
- *                        |
- *                        |

drivers/thermal/gov_bang_bang.c line 64

Quoted 10 lines
drivers/thermal/gov_bang_bang.c +0 -7
- *                        |
- *
- *   * If the fan is not running and temperature exceeds trip_temp, the fan
- *     gets turned on.
- *   * In case the fan is running, temperature must fall below
- *     (trip_temp - hyst) so that the fan gets turned off again.
- *
   */
  static void bang_bang_trip_crossed(struct thermal_zone_device *tz,
  				   const struct thermal_trip *trip,
#5 lore raw

PATCH 3/3 thermal: core: Rename function argument related to trip crossing

In reply to Rafael J. Wysocki

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

Rename the 'crossed_up' function argument to 'upward', which is more proper English and a better match for representing temperature change direction, everywhere in the code.

No functional impact.

---
 drivers/thermal/gov_bang_bang.c  |    6 +++---
 drivers/thermal/gov_user_space.c |    4 ++--
 drivers/thermal/thermal_core.c   |   10 +++++-----
 drivers/thermal/thermal_core.h   |    2 +-
 4 files changed, 11 insertions(+), 11 deletions(-)
drivers/thermal/gov_bang_bang.c +3 -3
@@ -58,11 +58,11 @@
  * bang_bang_trip_crossed - controls devices associated with the given zone
  * @tz: thermal_zone_device
  * @trip: the trip point
- * @crossed_up: whether or not the trip has been crossed on the way up
+ * @upward: whether or not the trip has been crossed on the way up
  */
 static void bang_bang_trip_crossed(struct thermal_zone_device *tz,
 				   const struct thermal_trip *trip,
-				   bool crossed_up)
+				   bool upward)
 {
 	const struct thermal_trip_desc *td = trip_to_trip_desc(trip);
 	struct thermal_instance *instance;
@@ -74,7 +74,7 @@
 		tz->temperature, trip->hysteresis);
 
 	list_for_each_entry(instance, &td->thermal_instances, trip_node)
-		bang_bang_set_instance_target(instance, crossed_up);
+		bang_bang_set_instance_target(instance, upward);
 }
 
 static void bang_bang_manage(struct thermal_zone_device *tz)
drivers/thermal/gov_user_space.c +2 -2
@@ -26,13 +26,13 @@
  * user_space_trip_crossed - Notify user space about trip crossing events
  * @tz: thermal_zone_device
  * @trip: trip point
- * @crossed_up: whether or not the trip has been crossed on the way up
+ * @upward: whether or not the trip has been crossed on the way up
  *
  * This function notifies the user space through UEvents.
  */
 static void user_space_trip_crossed(struct thermal_zone_device *tz,
 				    const struct thermal_trip *trip,
-				    bool crossed_up)
+				    bool upward)
 {
 	char *thermal_prop[5];
 	int i;
drivers/thermal/thermal_core.c +5 -5
@@ -454,23 +454,23 @@
 static void thermal_governor_trip_crossed(struct thermal_governor *governor,
 					  struct thermal_zone_device *tz,
 					  const struct thermal_trip *trip,
-					  bool crossed_up)
+					  bool upward)
 {
 	if (trip->type == THERMAL_TRIP_HOT || trip->type == THERMAL_TRIP_CRITICAL)
 		return;
 
 	if (governor->trip_crossed)
-		governor->trip_crossed(tz, trip, crossed_up);
+		governor->trip_crossed(tz, trip, upward);
 }
 
 static void thermal_trip_crossed(struct thermal_zone_device *tz,
 				 struct thermal_trip_desc *td,
 				 struct thermal_governor *governor,
-				 bool crossed_up)
+				 bool upward)
 {
 	const struct thermal_trip *trip = &td->trip;
 
-	if (crossed_up) {
+	if (upward) {
 		if (trip->type == THERMAL_TRIP_PASSIVE)
 			tz->passive++;
 		else if (trip->type == THERMAL_TRIP_CRITICAL ||
@@ -493,7 +493,7 @@
 		dev_info(&tz->device, "Trip crossed down: %d\n",
 			 trip->temperature - trip->hysteresis);
 	}
-	thermal_governor_trip_crossed(governor, tz, trip, crossed_up);
+	thermal_governor_trip_crossed(governor, tz, trip, upward);
 }
 
 void thermal_zone_set_trip_hyst(struct thermal_zone_device *tz,
drivers/thermal/thermal_core.h +1 -1
@@ -56,7 +56,7 @@
 	void (*unbind_from_tz)(struct thermal_zone_device *tz);
 	void (*trip_crossed)(struct thermal_zone_device *tz,
 			     const struct thermal_trip *trip,
-			     bool crossed_up);
+			     bool upward);
 	void (*manage)(struct thermal_zone_device *tz);
 	void (*update_tz)(struct thermal_zone_device *tz,
 			  enum thermal_notify_event reason);
reviewer Reviewed-by on v1 3/3
#6 lore raw

Re: [PATCH v1 3/3] thermal: core: Rename function argument related to trip crossing

Quoted 104 lines · Rafael J. Wysocki

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

Rename the 'crossed_up' function argument to 'upward', which is more proper English and a better match for representing temperature change direction, everywhere in the code.

No functional impact.

---
  drivers/thermal/gov_bang_bang.c  |    6 +++---
  drivers/thermal/gov_user_space.c |    4 ++--
  drivers/thermal/thermal_core.c   |   10 +++++-----
  drivers/thermal/thermal_core.h   |    2 +-
  4 files changed, 11 insertions(+), 11 deletions(-)
drivers/thermal/gov_bang_bang.c +3 -3
@@ -58,11 +58,11 @@
   * bang_bang_trip_crossed - controls devices associated with the given zone
   * @tz: thermal_zone_device
   * @trip: the trip point
- * @crossed_up: whether or not the trip has been crossed on the way up
+ * @upward: whether or not the trip has been crossed on the way up
   */
  static void bang_bang_trip_crossed(struct thermal_zone_device *tz,
  				   const struct thermal_trip *trip,
-				   bool crossed_up)
+				   bool upward)
  {
  	const struct thermal_trip_desc *td = trip_to_trip_desc(trip);
  	struct thermal_instance *instance;
@@ -74,7 +74,7 @@
  		tz->temperature, trip->hysteresis);
 
  	list_for_each_entry(instance, &td->thermal_instances, trip_node)
-		bang_bang_set_instance_target(instance, crossed_up);
+		bang_bang_set_instance_target(instance, upward);
  }
 
  static void bang_bang_manage(struct thermal_zone_device *tz)
drivers/thermal/gov_user_space.c +2 -2
@@ -26,13 +26,13 @@
   * user_space_trip_crossed - Notify user space about trip crossing events
   * @tz: thermal_zone_device
   * @trip: trip point
- * @crossed_up: whether or not the trip has been crossed on the way up
+ * @upward: whether or not the trip has been crossed on the way up
   *
   * This function notifies the user space through UEvents.
   */
  static void user_space_trip_crossed(struct thermal_zone_device *tz,
  				    const struct thermal_trip *trip,
-				    bool crossed_up)
+				    bool upward)
  {
  	char *thermal_prop[5];
  	int i;
drivers/thermal/thermal_core.c +5 -5
@@ -454,23 +454,23 @@
  static void thermal_governor_trip_crossed(struct thermal_governor *governor,
  					  struct thermal_zone_device *tz,
  					  const struct thermal_trip *trip,
-					  bool crossed_up)
+					  bool upward)
  {
  	if (trip->type == THERMAL_TRIP_HOT || trip->type == THERMAL_TRIP_CRITICAL)
  		return;
 
  	if (governor->trip_crossed)
-		governor->trip_crossed(tz, trip, crossed_up);
+		governor->trip_crossed(tz, trip, upward);
  }
 
  static void thermal_trip_crossed(struct thermal_zone_device *tz,
  				 struct thermal_trip_desc *td,
  				 struct thermal_governor *governor,
-				 bool crossed_up)
+				 bool upward)
  {
  	const struct thermal_trip *trip = &td->trip;
 
-	if (crossed_up) {
+	if (upward) {
  		if (trip->type == THERMAL_TRIP_PASSIVE)
  			tz->passive++;
  		else if (trip->type == THERMAL_TRIP_CRITICAL ||
@@ -493,7 +493,7 @@
  		dev_info(&tz->device, "Trip crossed down: %d\n",
  			 trip->temperature - trip->hysteresis);
  	}
-	thermal_governor_trip_crossed(governor, tz, trip, crossed_up);
+	thermal_governor_trip_crossed(governor, tz, trip, upward);
  }
 
  void thermal_zone_set_trip_hyst(struct thermal_zone_device *tz,

drivers/thermal/thermal_core.h line 62

Quoted 8 lines
drivers/thermal/thermal_core.h +1 -1
@@ -56,7 +56,7 @@
  	void (*unbind_from_tz)(struct thermal_zone_device *tz);
  	void (*trip_crossed)(struct thermal_zone_device *tz,
  			     const struct thermal_trip *trip,
-			     bool crossed_up);
+			     bool upward);
  	void (*manage)(struct thermal_zone_device *tz);
  	void (*update_tz)(struct thermal_zone_device *tz,
  			  enum thermal_notify_event reason);