| Message ID | 20230303172041.2103336-10-u.kleine-koenig@pengutronix.de (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | spi: Convert to platform remove callback returning void | expand |
On 3/3/23 09:19, 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> Reviewed-by: Florian Fainelli <f.fainelli@gmail.com>
On Fri, Mar 03, 2023 at 06:19:23PM +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> > --- > drivers/spi/spi-bcm2835.c | 12 +++--------- > 1 file changed, 3 insertions(+), 9 deletions(-) > > diff --git a/drivers/spi/spi-bcm2835.c b/drivers/spi/spi-bcm2835.c > index 747e03228c48..be6050b513a9 100644 > --- a/drivers/spi/spi-bcm2835.c > +++ b/drivers/spi/spi-bcm2835.c > @@ -1398,7 +1398,7 @@ static int bcm2835_spi_probe(struct platform_device *pdev) > return err; > } > > -static int bcm2835_spi_remove(struct platform_device *pdev) > +static void bcm2835_spi_remove(struct platform_device *pdev) > { > struct spi_controller *ctlr = platform_get_drvdata(pdev); > struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr); > @@ -1414,17 +1414,11 @@ static int bcm2835_spi_remove(struct platform_device *pdev) > BCM2835_SPI_CS_CLEAR_RX | BCM2835_SPI_CS_CLEAR_TX); > > clk_disable_unprepare(bs->clk); > - > - return 0; > } > > static void bcm2835_spi_shutdown(struct platform_device *pdev) > { > - int ret; > - > - ret = bcm2835_spi_remove(pdev); > - if (ret) > - dev_err(&pdev->dev, "failed to shutdown\n"); > + rbcm2835_spi_remove(pdev); The kernel build bot found an issue here. There is an 'r' too much. i.e. we need: diff --git a/drivers/spi/spi-bcm2835.c b/drivers/spi/spi-bcm2835.c index be6050b513a9..29445641fff0 100644 --- a/drivers/spi/spi-bcm2835.c +++ b/drivers/spi/spi-bcm2835.c @@ -1418,7 +1418,7 @@ static void bcm2835_spi_remove(struct platform_device *pdev) static void bcm2835_spi_shutdown(struct platform_device *pdev) { - rbcm2835_spi_remove(pdev); + bcm2835_spi_remove(pdev); } static const struct of_device_id bcm2835_spi_match[] = { squashed into the original commit. (I had that uncommitted in my tree while doing my build tests :-\) @broonie: how should we proceed here? Is your tree already public and you need a proper patch to fix this? Best regards Uwe
On Mon, Mar 06, 2023 at 08:04:26AM +0100, Uwe Kleine-König wrote: > squashed into the original commit. (I had that uncommitted in my tree > while doing my build tests :-\) > @broonie: how should we proceed here? Is your tree already public and > you need a proper patch to fix this? I was just going to drop the commit since it also failed my CI for the same reason, please send a new replacement. Please don't add random characters to my name, for whatever reason it's like you're misspelling it.
diff --git a/drivers/spi/spi-bcm2835.c b/drivers/spi/spi-bcm2835.c index 747e03228c48..be6050b513a9 100644 --- a/drivers/spi/spi-bcm2835.c +++ b/drivers/spi/spi-bcm2835.c @@ -1398,7 +1398,7 @@ static int bcm2835_spi_probe(struct platform_device *pdev) return err; } -static int bcm2835_spi_remove(struct platform_device *pdev) +static void bcm2835_spi_remove(struct platform_device *pdev) { struct spi_controller *ctlr = platform_get_drvdata(pdev); struct bcm2835_spi *bs = spi_controller_get_devdata(ctlr); @@ -1414,17 +1414,11 @@ static int bcm2835_spi_remove(struct platform_device *pdev) BCM2835_SPI_CS_CLEAR_RX | BCM2835_SPI_CS_CLEAR_TX); clk_disable_unprepare(bs->clk); - - return 0; } static void bcm2835_spi_shutdown(struct platform_device *pdev) { - int ret; - - ret = bcm2835_spi_remove(pdev); - if (ret) - dev_err(&pdev->dev, "failed to shutdown\n"); + rbcm2835_spi_remove(pdev); } static const struct of_device_id bcm2835_spi_match[] = { @@ -1439,7 +1433,7 @@ static struct platform_driver bcm2835_spi_driver = { .of_match_table = bcm2835_spi_match, }, .probe = bcm2835_spi_probe, - .remove = bcm2835_spi_remove, + .remove_new = bcm2835_spi_remove, .shutdown = bcm2835_spi_shutdown, }; module_platform_driver(bcm2835_spi_driver);
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-bcm2835.c | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-)