[PATCH 07/40] soc/fsl: cpm: tsa: Convert to platform remove callback returning void

Uwe Kleine-König posted 40 patches 1 year, 1 month ago
[PATCH 07/40] soc/fsl: cpm: tsa: Convert to platform remove callback returning void
Posted by Uwe Kleine-König 1 year, 1 month ago
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/soc/fsl/qe/tsa.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/drivers/soc/fsl/qe/tsa.c b/drivers/soc/fsl/qe/tsa.c
index 3646153117b3..3f9981335590 100644
--- a/drivers/soc/fsl/qe/tsa.c
+++ b/drivers/soc/fsl/qe/tsa.c
@@ -706,7 +706,7 @@ static int tsa_probe(struct platform_device *pdev)
 	return 0;
 }
 
-static int tsa_remove(struct platform_device *pdev)
+static void tsa_remove(struct platform_device *pdev)
 {
 	struct tsa *tsa = platform_get_drvdata(pdev);
 	int i;
@@ -729,7 +729,6 @@ static int tsa_remove(struct platform_device *pdev)
 			clk_put(tsa->tdm[i].l1rclk_clk);
 		}
 	}
-	return 0;
 }
 
 static const struct of_device_id tsa_id_table[] = {
@@ -744,7 +743,7 @@ static struct platform_driver tsa_driver = {
 		.of_match_table = of_match_ptr(tsa_id_table),
 	},
 	.probe = tsa_probe,
-	.remove = tsa_remove,
+	.remove_new = tsa_remove,
 };
 module_platform_driver(tsa_driver);
 
-- 
2.40.1

Re: [PATCH 07/40] soc/fsl: cpm: tsa: Convert to platform remove callback returning void
Posted by Herve Codina 1 year, 1 month ago
Hi Uwe,

On Mon, 25 Sep 2023 11:54:58 +0200
Uwe Kleine-König <u.kleine-koenig@pengutronix.de> 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/soc/fsl/qe/tsa.c | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/soc/fsl/qe/tsa.c b/drivers/soc/fsl/qe/tsa.c
> index 3646153117b3..3f9981335590 100644
> --- a/drivers/soc/fsl/qe/tsa.c
> +++ b/drivers/soc/fsl/qe/tsa.c
> @@ -706,7 +706,7 @@ static int tsa_probe(struct platform_device *pdev)
>  	return 0;
>  }
>  
> -static int tsa_remove(struct platform_device *pdev)
> +static void tsa_remove(struct platform_device *pdev)
>  {
>  	struct tsa *tsa = platform_get_drvdata(pdev);
>  	int i;
> @@ -729,7 +729,6 @@ static int tsa_remove(struct platform_device *pdev)
>  			clk_put(tsa->tdm[i].l1rclk_clk);
>  		}
>  	}
> -	return 0;
>  }
>  
>  static const struct of_device_id tsa_id_table[] = {
> @@ -744,7 +743,7 @@ static struct platform_driver tsa_driver = {
>  		.of_match_table = of_match_ptr(tsa_id_table),
>  	},
>  	.probe = tsa_probe,
> -	.remove = tsa_remove,
> +	.remove_new = tsa_remove,
>  };
>  module_platform_driver(tsa_driver);
>  

Acked-by: Herve Codina <herve.codina@bootlin.com>

Best regards,
Hervé