diff mbox series

[30/31] thermal: ti-bandgap: Convert to platform remove callback returning void

Message ID 20230927193736.2236447-31-u.kleine-koenig@pengutronix.de (mailing list archive)
State Mainlined, archived
Headers show
Series thermal: Convert to platform remove callback returning void | expand

Commit Message

Uwe Kleine-König Sept. 27, 2023, 7:37 p.m. UTC
The .remove() callback for a platform driver returns an int which makes
many driver authors wrongly assume it's possible to do error handling by
returning an error code. However the value returned is ignored (apart
from emitting a warning) and this typically results in resource leaks.

To improve here there is a quest to make the remove callback return
void. In the first step of this quest all drivers are converted to
.remove_new(), which already returns void. Eventually after all drivers
are converted, .remove_new() will be renamed to .remove().

Trivially convert this driver from always returning zero in the remove
callback to the void returning variant.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
---
 drivers/thermal/ti-soc-thermal/ti-bandgap.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

Comments

Dhruva Gole Sept. 28, 2023, 4:09 p.m. UTC | #1
On Sep 27, 2023 at 21:37:35 +0200, Uwe Kleine-König wrote:
> The .remove() callback for a platform driver returns an int which makes
> many driver authors wrongly assume it's possible to do error handling by
> returning an error code. However the value returned is ignored (apart
> from emitting a warning) and this typically results in resource leaks.
> 
> To improve here there is a quest to make the remove callback return
> void. In the first step of this quest all drivers are converted to
> .remove_new(), which already returns void. Eventually after all drivers
> are converted, .remove_new() will be renamed to .remove().
> 
> Trivially convert this driver from always returning zero in the remove
> callback to the void returning variant.
> 
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> ---
>  drivers/thermal/ti-soc-thermal/ti-bandgap.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/thermal/ti-soc-thermal/ti-bandgap.c b/drivers/thermal/ti-soc-thermal/ti-bandgap.c
> index 0c2eb9c6e58b..caadfc61be93 100644
> --- a/drivers/thermal/ti-soc-thermal/ti-bandgap.c
> +++ b/drivers/thermal/ti-soc-thermal/ti-bandgap.c
> @@ -1069,7 +1069,7 @@ int ti_bandgap_probe(struct platform_device *pdev)
>  }
>  
>  static
> -int ti_bandgap_remove(struct platform_device *pdev)
> +void ti_bandgap_remove(struct platform_device *pdev)
>  {
>  	struct ti_bandgap *bgp = platform_get_drvdata(pdev);
>  	int i;
> @@ -1098,8 +1098,6 @@ int ti_bandgap_remove(struct platform_device *pdev)
>  
>  	if (TI_BANDGAP_HAS(bgp, TSHUT))
>  		free_irq(gpiod_to_irq(bgp->tshut_gpiod), NULL);
> -
> -	return 0;
>  }
>  
>  #ifdef CONFIG_PM_SLEEP
> @@ -1283,7 +1281,7 @@ MODULE_DEVICE_TABLE(of, of_ti_bandgap_match);
>  
>  static struct platform_driver ti_bandgap_sensor_driver = {
>  	.probe = ti_bandgap_probe,
> -	.remove = ti_bandgap_remove,
> +	.remove_new = ti_bandgap_remove,

LGTM,

Reviewed-by: Dhruva Gole <d-gole@ti.com>

>  	.driver = {
>  			.name = "ti-soc-thermal",
>  			.pm = DEV_PM_OPS,
> -- 
> 2.40.1
>
diff mbox series

Patch

diff --git a/drivers/thermal/ti-soc-thermal/ti-bandgap.c b/drivers/thermal/ti-soc-thermal/ti-bandgap.c
index 0c2eb9c6e58b..caadfc61be93 100644
--- a/drivers/thermal/ti-soc-thermal/ti-bandgap.c
+++ b/drivers/thermal/ti-soc-thermal/ti-bandgap.c
@@ -1069,7 +1069,7 @@  int ti_bandgap_probe(struct platform_device *pdev)
 }
 
 static
-int ti_bandgap_remove(struct platform_device *pdev)
+void ti_bandgap_remove(struct platform_device *pdev)
 {
 	struct ti_bandgap *bgp = platform_get_drvdata(pdev);
 	int i;
@@ -1098,8 +1098,6 @@  int ti_bandgap_remove(struct platform_device *pdev)
 
 	if (TI_BANDGAP_HAS(bgp, TSHUT))
 		free_irq(gpiod_to_irq(bgp->tshut_gpiod), NULL);
-
-	return 0;
 }
 
 #ifdef CONFIG_PM_SLEEP
@@ -1283,7 +1281,7 @@  MODULE_DEVICE_TABLE(of, of_ti_bandgap_match);
 
 static struct platform_driver ti_bandgap_sensor_driver = {
 	.probe = ti_bandgap_probe,
-	.remove = ti_bandgap_remove,
+	.remove_new = ti_bandgap_remove,
 	.driver = {
 			.name = "ti-soc-thermal",
 			.pm = DEV_PM_OPS,