diff mbox series

[01/59] dma: altera-msgdma: Convert to platform remove callback returning void

Message ID 20230919133207.1400430-2-u.kleine-koenig@pengutronix.de (mailing list archive)
State Accepted
Commit 8876762f285fff08b1aefeba52c7157a2c9beec1
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/altera-msgdma.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

Comments

Olivier Dautricourt Sept. 20, 2023, 6:13 p.m. UTC | #1
On Tue, Sep 19, 2023 at 03:31:09PM +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() is renamed to .remove().
> 
> Trivially convert this driver from always returning zero in the remove
> callback to the void returning variant.

Acked-by: Olivier Dautricourt <olivierdautricourt@gmail.com>

Thanks

> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> ---
>  drivers/dma/altera-msgdma.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/dma/altera-msgdma.c b/drivers/dma/altera-msgdma.c
> index 4153c2edb049..a8e3615235b8 100644
> --- a/drivers/dma/altera-msgdma.c
> +++ b/drivers/dma/altera-msgdma.c
> @@ -923,7 +923,7 @@ static int msgdma_probe(struct platform_device *pdev)
>   *
>   * Return: Always '0'
>   */
> -static int msgdma_remove(struct platform_device *pdev)
> +static void msgdma_remove(struct platform_device *pdev)
>  {
>  	struct msgdma_device *mdev = platform_get_drvdata(pdev);
>  
> @@ -933,8 +933,6 @@ static int msgdma_remove(struct platform_device *pdev)
>  	msgdma_dev_remove(mdev);
>  
>  	dev_notice(&pdev->dev, "Altera mSGDMA driver removed\n");
> -
> -	return 0;
>  }
>  
>  #ifdef CONFIG_OF
> @@ -952,7 +950,7 @@ static struct platform_driver msgdma_driver = {
>  		.of_match_table = of_match_ptr(msgdma_match),
>  	},
>  	.probe = msgdma_probe,
> -	.remove = msgdma_remove,
> +	.remove_new = msgdma_remove,
>  };
>  
>  module_platform_driver(msgdma_driver);
> -- 
> 2.40.1
>
diff mbox series

Patch

diff --git a/drivers/dma/altera-msgdma.c b/drivers/dma/altera-msgdma.c
index 4153c2edb049..a8e3615235b8 100644
--- a/drivers/dma/altera-msgdma.c
+++ b/drivers/dma/altera-msgdma.c
@@ -923,7 +923,7 @@  static int msgdma_probe(struct platform_device *pdev)
  *
  * Return: Always '0'
  */
-static int msgdma_remove(struct platform_device *pdev)
+static void msgdma_remove(struct platform_device *pdev)
 {
 	struct msgdma_device *mdev = platform_get_drvdata(pdev);
 
@@ -933,8 +933,6 @@  static int msgdma_remove(struct platform_device *pdev)
 	msgdma_dev_remove(mdev);
 
 	dev_notice(&pdev->dev, "Altera mSGDMA driver removed\n");
-
-	return 0;
 }
 
 #ifdef CONFIG_OF
@@ -952,7 +950,7 @@  static struct platform_driver msgdma_driver = {
 		.of_match_table = of_match_ptr(msgdma_match),
 	},
 	.probe = msgdma_probe,
-	.remove = msgdma_remove,
+	.remove_new = msgdma_remove,
 };
 
 module_platform_driver(msgdma_driver);