[PATCH v1] thermal: Add some error messages

[PATCH v1] thermal: Add some error messages

[Amit Kucheria]

When registering a thermal zone device, we currently return -EINVAL in
four cases. This is makes is a little hard to debug the real cause of
the failure.

Print some error messages to make it easier for developer to figure out
what happened.

Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
---
 drivers/thermal/thermal_core.c | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/drivers/thermal/thermal_core.c b/drivers/thermal/thermal_core.c
index 6590bb5cb688..51cb6d2bf7a2 100644
--- a/drivers/thermal/thermal_core.c
+++ b/drivers/thermal/thermal_core.c
@@ -1189,17 +1189,26 @@ thermal_zone_device_register(const char *type, int trips, int mask,
 	int count;
 	struct thermal_governor *governor;
 
-	if (!type || strlen(type) == 0)
+	if (!type || strlen(type) == 0) {
+		pr_err("Error: No thermal zone type defined");
 		return ERR_PTR(-EINVAL);
+	}
 
-	if (type && strlen(type) >= THERMAL_NAME_LENGTH)
+	if (type && strlen(type) >= THERMAL_NAME_LENGTH) {
+		pr_err("Error: Thermal zone name (%s) too long, should be under %d chars",
+		       type, THERMAL_NAME_LENGTH);
 		return ERR_PTR(-EINVAL);
+	}
 
-	if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
+	if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips) {
+		pr_err("Error: Incorrect number of thermal trips");
 		return ERR_PTR(-EINVAL);
+	}
 
-	if (!ops)
+	if (!ops) {
+		pr_err("Error: Thermal zone device ops not defined");
 		return ERR_PTR(-EINVAL);
+	}
 
 	if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp))
 		return ERR_PTR(-EINVAL);
-- 
2.17.1

Re: [PATCH v1] thermal: Add some error messages

[Daniel Lezcano]

Hi Amit,

On 26/04/2019 21:15, Amit Kucheria wrote:
> When registering a thermal zone device, we currently return -EINVAL in
> four cases. This is makes is a little hard to debug the real cause of
> the failure.
> 
> Print some error messages to make it easier for developer to figure out
> what happened.

Adding "Error" in the pr_err message is redundant. However I'm not sure
adding more traces is really important, that will add more RO data for a
function which is supposed to be called from wise code.

> Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
> ---
>  drivers/thermal/thermal_core.c | 17 +++++++++++++----
>  1 file changed, 13 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/thermal/thermal_core.c b/drivers/thermal/thermal_core.c
> index 6590bb5cb688..51cb6d2bf7a2 100644
> --- a/drivers/thermal/thermal_core.c
> +++ b/drivers/thermal/thermal_core.c
> @@ -1189,17 +1189,26 @@ thermal_zone_device_register(const char *type, int trips, int mask,
>  	int count;
>  	struct thermal_governor *governor;
>  
> -	if (!type || strlen(type) == 0)
> +	if (!type || strlen(type) == 0) {
> +		pr_err("Error: No thermal zone type defined");
>  		return ERR_PTR(-EINVAL);
> +	}
>  
> -	if (type && strlen(type) >= THERMAL_NAME_LENGTH)
> +	if (type && strlen(type) >= THERMAL_NAME_LENGTH) {
> +		pr_err("Error: Thermal zone name (%s) too long, should be under %d chars",
> +		       type, THERMAL_NAME_LENGTH);
>  		return ERR_PTR(-EINVAL);
> +	}

May be take the opportunity to remove the test 'type' is true because it
is always true after the previous test?

> -	if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips)
> +	if (trips > THERMAL_MAX_TRIPS || trips < 0 || mask >> trips) {
> +		pr_err("Error: Incorrect number of thermal trips");
>  		return ERR_PTR(-EINVAL);
> +	}
>  
> -	if (!ops)
> +	if (!ops) {
> +		pr_err("Error: Thermal zone device ops not defined");
>  		return ERR_PTR(-EINVAL);
> +	}
>  
>  	if (trips > 0 && (!ops->get_trip_type || !ops->get_trip_temp)>  		return ERR_PTR(-EINVAL);
> 


-- 
 <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