diff mbox series

[67/87] spi: sifive: Convert to platform remove callback returning void

Message ID 20230303172041.2103336-68-u.kleine-koenig@pengutronix.de (mailing list archive)
State Accepted
Commit fd8998c4633737310c8165c6c3fc81197380d1d9
Headers show
Series spi: Convert to platform remove callback returning void | expand

Commit Message

Uwe Kleine-König March 3, 2023, 5:20 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 (mostly) ignored
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.

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/spi/spi-sifive.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

Comments

Conor Dooley March 3, 2023, 5:46 p.m. UTC | #1
On Fri, Mar 03, 2023 at 06:20:21PM +0100, 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 (mostly) ignored
> 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.
> 
> 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>

This one landed in my mailbox too, so:
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

Thanks,
Conor.

> ---
>  drivers/spi/spi-sifive.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/spi/spi-sifive.c b/drivers/spi/spi-sifive.c
> index e29e85cee88a..055de44e0d22 100644
> --- a/drivers/spi/spi-sifive.c
> +++ b/drivers/spi/spi-sifive.c
> @@ -415,7 +415,7 @@ static int sifive_spi_probe(struct platform_device *pdev)
>  	return ret;
>  }
>  
> -static int sifive_spi_remove(struct platform_device *pdev)
> +static void sifive_spi_remove(struct platform_device *pdev)
>  {
>  	struct spi_master *master = platform_get_drvdata(pdev);
>  	struct sifive_spi *spi = spi_master_get_devdata(master);
> @@ -423,8 +423,6 @@ static int sifive_spi_remove(struct platform_device *pdev)
>  	/* Disable all the interrupts just in case */
>  	sifive_spi_write(spi, SIFIVE_SPI_REG_IE, 0);
>  	clk_disable_unprepare(spi->clk);
> -
> -	return 0;
>  }
>  
>  static int sifive_spi_suspend(struct device *dev)
> @@ -473,7 +471,7 @@ MODULE_DEVICE_TABLE(of, sifive_spi_of_match);
>  
>  static struct platform_driver sifive_spi_driver = {
>  	.probe = sifive_spi_probe,
> -	.remove = sifive_spi_remove,
> +	.remove_new = sifive_spi_remove,
>  	.driver = {
>  		.name = SIFIVE_SPI_DRIVER_NAME,
>  		.pm = &sifive_spi_pm_ops,
> -- 
> 2.39.1
>
Uwe Kleine-König March 3, 2023, 6:33 p.m. UTC | #2
Hello Conor,

On Fri, Mar 03, 2023 at 05:46:11PM +0000, Conor Dooley wrote:
> On Fri, Mar 03, 2023 at 06:20:21PM +0100, 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 (mostly) ignored
> > 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.
> > 
> > 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>
> 
> This one landed in my mailbox too, so:
> Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

I have ~2000 of such patches pending in my tree that wait for
submission. If you want a Cc: for each of them, just tell me :-)

Best regards and thanks,
Uwe
diff mbox series

Patch

diff --git a/drivers/spi/spi-sifive.c b/drivers/spi/spi-sifive.c
index e29e85cee88a..055de44e0d22 100644
--- a/drivers/spi/spi-sifive.c
+++ b/drivers/spi/spi-sifive.c
@@ -415,7 +415,7 @@  static int sifive_spi_probe(struct platform_device *pdev)
 	return ret;
 }
 
-static int sifive_spi_remove(struct platform_device *pdev)
+static void sifive_spi_remove(struct platform_device *pdev)
 {
 	struct spi_master *master = platform_get_drvdata(pdev);
 	struct sifive_spi *spi = spi_master_get_devdata(master);
@@ -423,8 +423,6 @@  static int sifive_spi_remove(struct platform_device *pdev)
 	/* Disable all the interrupts just in case */
 	sifive_spi_write(spi, SIFIVE_SPI_REG_IE, 0);
 	clk_disable_unprepare(spi->clk);
-
-	return 0;
 }
 
 static int sifive_spi_suspend(struct device *dev)
@@ -473,7 +471,7 @@  MODULE_DEVICE_TABLE(of, sifive_spi_of_match);
 
 static struct platform_driver sifive_spi_driver = {
 	.probe = sifive_spi_probe,
-	.remove = sifive_spi_remove,
+	.remove_new = sifive_spi_remove,
 	.driver = {
 		.name = SIFIVE_SPI_DRIVER_NAME,
 		.pm = &sifive_spi_pm_ops,