diff mbox series

[05/12] ata/pata_mpc52xx: Convert to platform remove callback returning void

Message ID 20230731091636.693193-6-u.kleine-koenig@pengutronix.de
State New
Headers show
Series ata: Convert to platform remove callback returning void | expand

Commit Message

Uwe Kleine-König July 31, 2023, 9:16 a.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/ata/pata_mpc52xx.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

Comments

Damien Le Moal July 31, 2023, 11:14 a.m. UTC | #1
On 7/31/23 18:16, 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.
> 
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> ---
>  drivers/ata/pata_mpc52xx.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/ata/pata_mpc52xx.c b/drivers/ata/pata_mpc52xx.c
> index 66c9dea4ea6e..bca7f552e2b5 100644
> --- a/drivers/ata/pata_mpc52xx.c
> +++ b/drivers/ata/pata_mpc52xx.c
> @@ -800,7 +800,7 @@ static int mpc52xx_ata_probe(struct platform_device *op)
>  	return rv;
>  }
>  
> -static int
> +static void
>  mpc52xx_ata_remove(struct platform_device *op)

While at it, it would be nice to remove the unusual line break here. Will do
that when applying.

>  {
>  	struct ata_host *host = platform_get_drvdata(op);
> @@ -815,8 +815,6 @@ mpc52xx_ata_remove(struct platform_device *op)
>  	irq_dispose_mapping(task_irq);
>  	bcom_ata_release(priv->dmatsk);
>  	irq_dispose_mapping(priv->ata_irq);
> -
> -	return 0;
>  }
>  
>  #ifdef CONFIG_PM_SLEEP
> @@ -857,7 +855,7 @@ static const struct of_device_id mpc52xx_ata_of_match[] = {
>  
>  static struct platform_driver mpc52xx_ata_of_platform_driver = {
>  	.probe		= mpc52xx_ata_probe,
> -	.remove		= mpc52xx_ata_remove,
> +	.remove_new	= mpc52xx_ata_remove,
>  #ifdef CONFIG_PM_SLEEP
>  	.suspend	= mpc52xx_ata_suspend,
>  	.resume		= mpc52xx_ata_resume,
Sergey Shtylyov July 31, 2023, 5:02 p.m. UTC | #2
On 7/31/23 12:16 PM, 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.
> 
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>

Reviewed-by: Sergey Shtylyov <s.shtylyov@omp.ru>

[...]

MBR, Sergey
diff mbox series

Patch

diff --git a/drivers/ata/pata_mpc52xx.c b/drivers/ata/pata_mpc52xx.c
index 66c9dea4ea6e..bca7f552e2b5 100644
--- a/drivers/ata/pata_mpc52xx.c
+++ b/drivers/ata/pata_mpc52xx.c
@@ -800,7 +800,7 @@  static int mpc52xx_ata_probe(struct platform_device *op)
 	return rv;
 }
 
-static int
+static void
 mpc52xx_ata_remove(struct platform_device *op)
 {
 	struct ata_host *host = platform_get_drvdata(op);
@@ -815,8 +815,6 @@  mpc52xx_ata_remove(struct platform_device *op)
 	irq_dispose_mapping(task_irq);
 	bcom_ata_release(priv->dmatsk);
 	irq_dispose_mapping(priv->ata_irq);
-
-	return 0;
 }
 
 #ifdef CONFIG_PM_SLEEP
@@ -857,7 +855,7 @@  static const struct of_device_id mpc52xx_ata_of_match[] = {
 
 static struct platform_driver mpc52xx_ata_of_platform_driver = {
 	.probe		= mpc52xx_ata_probe,
-	.remove		= mpc52xx_ata_remove,
+	.remove_new	= mpc52xx_ata_remove,
 #ifdef CONFIG_PM_SLEEP
 	.suspend	= mpc52xx_ata_suspend,
 	.resume		= mpc52xx_ata_resume,