diff mbox series

[50/59] dma: ti: cppi41: Convert to platform remove callback returning void

Message ID 20230919133207.1400430-51-u.kleine-koenig@pengutronix.de (mailing list archive)
State Accepted
Commit 36a7e98c36a598c2865daf748a7d9d889a34aaf3
Headers show
Series dma: Convert to platform remove callback returning void | expand

Commit Message

Uwe Kleine-König Sept. 19, 2023, 1:31 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() is 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/dma/ti/cppi41.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

Péter Ujfalusi Sept. 20, 2023, 5:55 p.m. UTC | #1
On 9/19/23 16:31, 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() is renamed to .remove().
> 
> Trivially convert this driver from always returning zero in the remove
> callback to the void returning variant.

Reviewed-by: Peter Ujfalusi <peter.ujfalusi@gmail.com>

> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> ---
>  drivers/dma/ti/cppi41.c | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/dma/ti/cppi41.c b/drivers/dma/ti/cppi41.c
> index c3555cfb0681..7e0b06b5dff0 100644
> --- a/drivers/dma/ti/cppi41.c
> +++ b/drivers/dma/ti/cppi41.c
> @@ -1156,7 +1156,7 @@ static int cppi41_dma_probe(struct platform_device *pdev)
>  	return ret;
>  }
>  
> -static int cppi41_dma_remove(struct platform_device *pdev)
> +static void cppi41_dma_remove(struct platform_device *pdev)
>  {
>  	struct cppi41_dd *cdd = platform_get_drvdata(pdev);
>  	int error;
> @@ -1173,7 +1173,6 @@ static int cppi41_dma_remove(struct platform_device *pdev)
>  	pm_runtime_dont_use_autosuspend(&pdev->dev);
>  	pm_runtime_put_sync(&pdev->dev);
>  	pm_runtime_disable(&pdev->dev);
> -	return 0;
>  }
>  
>  static int __maybe_unused cppi41_suspend(struct device *dev)
> @@ -1244,7 +1243,7 @@ static const struct dev_pm_ops cppi41_pm_ops = {
>  
>  static struct platform_driver cpp41_dma_driver = {
>  	.probe  = cppi41_dma_probe,
> -	.remove = cppi41_dma_remove,
> +	.remove_new = cppi41_dma_remove,
>  	.driver = {
>  		.name = "cppi41-dma-engine",
>  		.pm = &cppi41_pm_ops,
diff mbox series

Patch

diff --git a/drivers/dma/ti/cppi41.c b/drivers/dma/ti/cppi41.c
index c3555cfb0681..7e0b06b5dff0 100644
--- a/drivers/dma/ti/cppi41.c
+++ b/drivers/dma/ti/cppi41.c
@@ -1156,7 +1156,7 @@  static int cppi41_dma_probe(struct platform_device *pdev)
 	return ret;
 }
 
-static int cppi41_dma_remove(struct platform_device *pdev)
+static void cppi41_dma_remove(struct platform_device *pdev)
 {
 	struct cppi41_dd *cdd = platform_get_drvdata(pdev);
 	int error;
@@ -1173,7 +1173,6 @@  static int cppi41_dma_remove(struct platform_device *pdev)
 	pm_runtime_dont_use_autosuspend(&pdev->dev);
 	pm_runtime_put_sync(&pdev->dev);
 	pm_runtime_disable(&pdev->dev);
-	return 0;
 }
 
 static int __maybe_unused cppi41_suspend(struct device *dev)
@@ -1244,7 +1243,7 @@  static const struct dev_pm_ops cppi41_pm_ops = {
 
 static struct platform_driver cpp41_dma_driver = {
 	.probe  = cppi41_dma_probe,
-	.remove = cppi41_dma_remove,
+	.remove_new = cppi41_dma_remove,
 	.driver = {
 		.name = "cppi41-dma-engine",
 		.pm = &cppi41_pm_ops,