Skip to contentSkip to conversation

drivers: thermal: tsens: fix wrong check for tzd in irq handlers

PATCH Applied Ansuel Smith 3 participants 6 messages Sep 7, 2021 – Sep 17, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/2 drivers: thermal: tsens: fix wrong check for tzd in irq handlers

Some device can have some thermal sensor disabled from the factory. The current 2 irq handler functions check all the sensor by default and the check if the sensor was actually registered is wrong. The tzd is actually never set if the registration fail hence the IS_ERR check is wrong.

---
 drivers/thermal/qcom/tsens.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/thermal/qcom/tsens.c +2 -2
index 4c7ebd1d3f9c..b1162e566a70 100644
@@ -417,7 +417,7 @@ static irqreturn_t tsens_critical_irq_thread(int irq, void *data)
 		const struct tsens_sensor *s = &priv->sensor[i];
 		u32 hw_id = s->hw_id;
 
-		if (IS_ERR(s->tzd))
+		if (!s->tzd)
 			continue;
 		if (!tsens_threshold_violated(priv, hw_id, &d))
 			continue;
@@ -467,7 +467,7 @@ static irqreturn_t tsens_irq_thread(int irq, void *data)
 		const struct tsens_sensor *s = &priv->sensor[i];
 		u32 hw_id = s->hw_id;
 
-		if (IS_ERR(s->tzd))
+		if (!s->tzd)
 			continue;
 		if (!tsens_threshold_violated(priv, hw_id, &d))
 			continue;
Signature · 1 line
2.32.0
#1 lore raw

PATCH v2 2/2 drivers: thermal: tsens: add timeout to get_tem_tsens_valid

The function can loop and lock the system if for whatever reason the bit for the target sensor is NEVER valid. This is the case if a sensor is disabled by the factory and the valid bit is never reported as actually valid. Add a timeout check and exit if a timeout occurs. As this is a very rare condition, handle the timeout only if the first read fails. While at it also rework the function to improve readability.

---
 drivers/thermal/qcom/tsens.c | 40 +++++++++++++++++++++++-------------
 1 file changed, 26 insertions(+), 14 deletions(-)
drivers/thermal/qcom/tsens.c +26 -14
index b1162e566a70..1ff244176beb 100644
@@ -599,26 +599,38 @@ int get_temp_tsens_valid(const struct tsens_sensor *s, int *temp)
 	int hw_id = s->hw_id;
 	u32 temp_idx = LAST_TEMP_0 + hw_id;
 	u32 valid_idx = VALID_0 + hw_id;
+	unsigned long timeout;
 	u32 valid;
 	int ret;
 
 	/* VER_0 doesn't have VALID bit */
-	if (tsens_version(priv) >= VER_0_1) {
+	if (tsens_version(priv) == VER_0)
+		goto get_temp;
+
+	ret = regmap_field_read(priv->rf[valid_idx], &valid);
+	if (ret || valid)
+		goto check_valid;
+
+	timeout = jiffies + msecs_to_jiffies(20);
+	do {
+		/* Valid bit is 0 for 6 AHB clock cycles.
+		 * At 19.2MHz, 1 AHB clock is ~60ns.
+		 * We should enter this loop very, very rarely.
+		 */
+		ndelay(400);
 		ret = regmap_field_read(priv->rf[valid_idx], &valid);
-		if (ret)
-			return ret;
-		while (!valid) {
-			/* Valid bit is 0 for 6 AHB clock cycles.
-			 * At 19.2MHz, 1 AHB clock is ~60ns.
-			 * We should enter this loop very, very rarely.
-			 */
-			ndelay(400);
-			ret = regmap_field_read(priv->rf[valid_idx], &valid);
-			if (ret)
-				return ret;
-		}
-	}
+		if (ret || valid)
+			goto check_valid;
+	} while (time_before(jiffies, timeout));
+
+	return -ETIMEDOUT;
+
+check_valid:
+	/* Check ret of valid bit read */
+	if (ret)
+		return ret;
 
+get_temp:
 	/* Valid bit is set, OK to read the temperature */
 	*temp = tsens_hw_to_mC(s, temp_idx);
 
Signature · 1 line
2.32.0
#2 lore raw

Re: [PATCH v2 2/2] drivers: thermal: tsens: add timeout to get_tem_tsens_valid

Quoted 58 lines · Ansuel Smith

The function can loop and lock the system if for whatever reason the bit for the target sensor is NEVER valid. This is the case if a sensor is disabled by the factory and the valid bit is never reported as actually valid. Add a timeout check and exit if a timeout occurs. As this is a very rare condition, handle the timeout only if the first read fails. While at it also rework the function to improve readability.

---
 drivers/thermal/qcom/tsens.c | 40 +++++++++++++++++++++++-------------
 1 file changed, 26 insertions(+), 14 deletions(-)
drivers/thermal/qcom/tsens.c +19 -14
index b1162e566a70..1ff244176beb 100644
@@ -599,26 +599,38 @@ int get_temp_tsens_valid(const struct tsens_sensor *s, int *temp)
 	int hw_id = s->hw_id;
 	u32 temp_idx = LAST_TEMP_0 + hw_id;
 	u32 valid_idx = VALID_0 + hw_id;
+	unsigned long timeout;
 	u32 valid;
 	int ret;
 
 	/* VER_0 doesn't have VALID bit */
-	if (tsens_version(priv) >= VER_0_1) {
+	if (tsens_version(priv) == VER_0)
+		goto get_temp;
+
+	ret = regmap_field_read(priv->rf[valid_idx], &valid);
+	if (ret || valid)
+		goto check_valid;
+
+	timeout = jiffies + msecs_to_jiffies(20);
+	do {
+		/* Valid bit is 0 for 6 AHB clock cycles.
+		 * At 19.2MHz, 1 AHB clock is ~60ns.
+		 * We should enter this loop very, very rarely.
+		 */
+		ndelay(400);
 		ret = regmap_field_read(priv->rf[valid_idx], &valid);
-		if (ret)
-			return ret;
-		while (!valid) {
-			/* Valid bit is 0 for 6 AHB clock cycles.
-			 * At 19.2MHz, 1 AHB clock is ~60ns.
-			 * We should enter this loop very, very rarely.
-			 */
-			ndelay(400);
-			ret = regmap_field_read(priv->rf[valid_idx], &valid);
-			if (ret)
-				return ret;
-		}
-	}
+		if (ret || valid)
+			goto check_valid;
+	} while (time_before(jiffies, timeout));
+

drivers/thermal/qcom/tsens.c int get_temp_tsens_valid(const struct tsens_sensor *s, int *temp) · line 635

Quoted 10 lines
drivers/thermal/qcom/tsens.c +7 -0
+	return -ETIMEDOUT;
+
+check_valid:
+	/* Check ret of valid bit read */
+	if (ret)
+		return ret;
 
+get_temp:
 	/* Valid bit is set, OK to read the temperature */
 	*temp = tsens_hw_to_mC(s, temp_idx);

I still think that something like this would be clearer than the multiple jumps to 'check_valid':

	ret = regmap_field_read(priv->rf[valid_idx], &valid);
	if (ret)
		return ret;

	timeout = jiffies + msecs_to_jiffies(20);

	while (!valid) {
		/* Valid bit is 0 for 6 AHB clock cycles.
		 * At 19.2MHz, 1 AHB clock is ~60ns.
		 * We should enter this loop very, very rarely.
		 */
		ndelay(400);
		ret = regmap_field_read(priv->rf[valid_idx], &valid);
		if (ret)
			return ret;

		if (time_after(jiffies, timeout))
			return -ETIMEDOUT;
	};

That said, I'm just a random dude, so my opinion isn't really important, as long as the maintainers are happy with the change :)

#3 lore raw

Re: [PATCH v2 2/2] drivers: thermal: tsens: add timeout to get_tem_tsens_valid

In reply to Ansuel Smith
Quoted 24 lines · Ansuel Smith

The function can loop and lock the system if for whatever reason the bit for the target sensor is NEVER valid. This is the case if a sensor is disabled by the factory and the valid bit is never reported as actually valid. Add a timeout check and exit if a timeout occurs. As this is a very rare condition, handle the timeout only if the first read fails. While at it also rework the function to improve readability.

---
 drivers/thermal/qcom/tsens.c | 40 +++++++++++++++++++++++-------------
 1 file changed, 26 insertions(+), 14 deletions(-)
drivers/thermal/qcom/tsens.c +1 -0
index b1162e566a70..1ff244176beb 100644
@@ -599,26 +599,38 @@ int get_temp_tsens_valid(const struct tsens_sensor *s, int *temp)
 	int hw_id = s->hw_id;
 	u32 temp_idx = LAST_TEMP_0 + hw_id;
 	u32 valid_idx = VALID_0 + hw_id;
+	unsigned long timeout;
 	u32 valid;
 	int ret;
 

drivers/thermal/qcom/tsens.c int get_temp_tsens_valid(const struct tsens_sensor *s, int *temp) · line 614

Quoted 10 lines
drivers/thermal/qcom/tsens.c +8 -1
 	/* VER_0 doesn't have VALID bit */
-	if (tsens_version(priv) >= VER_0_1) {
+	if (tsens_version(priv) == VER_0)
+		goto get_temp;
+
+	ret = regmap_field_read(priv->rf[valid_idx], &valid);
+	if (ret || valid)
+		goto check_valid;
+
+	timeout = jiffies + msecs_to_jiffies(20);

Why not use regmap_field_read_poll_timeout() ?

Quoted 36 lines
drivers/thermal/qcom/tsens.c +17 -13
+	do {
+		/* Valid bit is 0 for 6 AHB clock cycles.
+		 * At 19.2MHz, 1 AHB clock is ~60ns.
+		 * We should enter this loop very, very rarely.
+		 */
+		ndelay(400);
 		ret = regmap_field_read(priv->rf[valid_idx], &valid);
-		if (ret)
-			return ret;
-		while (!valid) {
-			/* Valid bit is 0 for 6 AHB clock cycles.
-			 * At 19.2MHz, 1 AHB clock is ~60ns.
-			 * We should enter this loop very, very rarely.
-			 */
-			ndelay(400);
-			ret = regmap_field_read(priv->rf[valid_idx], &valid);
-			if (ret)
-				return ret;
-		}
-	}
+		if (ret || valid)
+			goto check_valid;
+	} while (time_before(jiffies, timeout));
+
+	return -ETIMEDOUT;
+
+check_valid:
+	/* Check ret of valid bit read */
+	if (ret)
+		return ret;
 
+get_temp:
 	/* Valid bit is set, OK to read the temperature */
 	*temp = tsens_hw_to_mC(s, temp_idx);
 
Signature · 5 lines
<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
#4 lore raw

Re: [PATCH v2 2/2] drivers: thermal: tsens: add timeout to get_tem_tsens_valid

Quoted 25 lines · Daniel Lezcano
Quoted 24 lines · Ansuel Smith

The function can loop and lock the system if for whatever reason the bit for the target sensor is NEVER valid. This is the case if a sensor is disabled by the factory and the valid bit is never reported as actually valid. Add a timeout check and exit if a timeout occurs. As this is a very rare condition, handle the timeout only if the first read fails. While at it also rework the function to improve readability.

---
 drivers/thermal/qcom/tsens.c | 40 +++++++++++++++++++++++-------------
 1 file changed, 26 insertions(+), 14 deletions(-)
drivers/thermal/qcom/tsens.c +1 -0
index b1162e566a70..1ff244176beb 100644
@@ -599,26 +599,38 @@ int get_temp_tsens_valid(const struct tsens_sensor *s, int *temp)
 	int hw_id = s->hw_id;
 	u32 temp_idx = LAST_TEMP_0 + hw_id;
 	u32 valid_idx = VALID_0 + hw_id;
+	unsigned long timeout;
 	u32 valid;
 	int ret;
 
Quoted 13 lines

drivers/thermal/qcom/tsens.c int get_temp_tsens_valid(const struct tsens_sensor *s, int *temp) · line 614

Quoted 10 lines
drivers/thermal/qcom/tsens.c +8 -1
 	/* VER_0 doesn't have VALID bit */
-	if (tsens_version(priv) >= VER_0_1) {
+	if (tsens_version(priv) == VER_0)
+		goto get_temp;
+
+	ret = regmap_field_read(priv->rf[valid_idx], &valid);
+	if (ret || valid)
+		goto check_valid;
+
+	timeout = jiffies + msecs_to_jiffies(20);

Why not use regmap_field_read_poll_timeout() ?

Ok will convert this to pool_timeout and send v3.
Thx for the review.

Quoted 44 lines
Quoted 36 lines
drivers/thermal/qcom/tsens.c +17 -13
+	do {
+		/* Valid bit is 0 for 6 AHB clock cycles.
+		 * At 19.2MHz, 1 AHB clock is ~60ns.
+		 * We should enter this loop very, very rarely.
+		 */
+		ndelay(400);
 		ret = regmap_field_read(priv->rf[valid_idx], &valid);
-		if (ret)
-			return ret;
-		while (!valid) {
-			/* Valid bit is 0 for 6 AHB clock cycles.
-			 * At 19.2MHz, 1 AHB clock is ~60ns.
-			 * We should enter this loop very, very rarely.
-			 */
-			ndelay(400);
-			ret = regmap_field_read(priv->rf[valid_idx], &valid);
-			if (ret)
-				return ret;
-		}
-	}
+		if (ret || valid)
+			goto check_valid;
+	} while (time_before(jiffies, timeout));
+
+	return -ETIMEDOUT;
+
+check_valid:
+	/* Check ret of valid bit read */
+	if (ret)
+		return ret;
 
+get_temp:
 	/* Valid bit is set, OK to read the temperature */
 	*temp = tsens_hw_to_mC(s, temp_idx);
 
Signature · 5 lines
<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
#5 lore raw
In reply to Ansuel Smith

Applied, thanks

Quoted 35 lines · Ansuel Smith

Some device can have some thermal sensor disabled from the factory. The current 2 irq handler functions check all the sensor by default and the check if the sensor was actually registered is wrong. The tzd is actually never set if the registration fail hence the IS_ERR check is wrong.

---
 drivers/thermal/qcom/tsens.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/thermal/qcom/tsens.c +2 -2
index 4c7ebd1d3f9c..b1162e566a70 100644
@@ -417,7 +417,7 @@ static irqreturn_t tsens_critical_irq_thread(int irq, void *data)
 		const struct tsens_sensor *s = &priv->sensor[i];
 		u32 hw_id = s->hw_id;
 
-		if (IS_ERR(s->tzd))
+		if (!s->tzd)
 			continue;
 		if (!tsens_threshold_violated(priv, hw_id, &d))
 			continue;
@@ -467,7 +467,7 @@ static irqreturn_t tsens_irq_thread(int irq, void *data)
 		const struct tsens_sensor *s = &priv->sensor[i];
 		u32 hw_id = s->hw_id;
 
-		if (IS_ERR(s->tzd))
+		if (!s->tzd)
 			continue;
 		if (!tsens_threshold_violated(priv, hw_id, &d))
 			continue;
Signature · 5 lines
<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