diff mbox series

[06/20] pinctrl: intel: lynxpoint: Convert to platform remove callback returning void

Message ID 20231009083856.222030-7-u.kleine-koenig@pengutronix.de
State New
Headers
Series pinctrl: Convert to platform remove callback returning void |

Commit Message

Uwe Kleine-König Oct. 9, 2023, 8:38 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() will be 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/pinctrl/intel/pinctrl-lynxpoint.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

Mika Westerberg Oct. 9, 2023, 11:10 a.m. UTC | #1 
On Mon, Oct 09, 2023 at 10:38:42AM +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() will be 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>

Acked-by: Mika Westerberg <mika.westerberg@linux.intel.com>
andy@kernel.org Oct. 10, 2023, 1:18 p.m. UTC | #2 
On Mon, Oct 09, 2023 at 02:10:48PM +0300, Mika Westerberg wrote:
> On Mon, Oct 09, 2023 at 10:38:42AM +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() will be 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>
> 
> Acked-by: Mika Westerberg <mika.westerberg@linux.intel.com>

Pushed to my review and testing queue, thanks!
Andy Shevchenko Oct. 10, 2023, 3:34 p.m. UTC | #3 
On Mon, Oct 9, 2023 at 2:10 PM Mika Westerberg
<mika.westerberg@linux.intel.com> wrote:
> On Mon, Oct 09, 2023 at 10:38:42AM +0200, Uwe Kleine-König wrote:

...

> Acked-by: Mika Westerberg <mika.westerberg@linux.intel.com>

Actually this one got skipped as there is no more ->remove() in the driver!
diff mbox series

Patch

diff --git a/drivers/pinctrl/intel/pinctrl-lynxpoint.c b/drivers/pinctrl/intel/pinctrl-lynxpoint.c
index c3732a9f0658..f0725edcab3b 100644
--- a/drivers/pinctrl/intel/pinctrl-lynxpoint.c
+++ b/drivers/pinctrl/intel/pinctrl-lynxpoint.c
@@ -846,10 +846,9 @@  static int lp_gpio_probe(struct platform_device *pdev)
 	return 0;
 }
 
-static int lp_gpio_remove(struct platform_device *pdev)
+static void lp_gpio_remove(struct platform_device *pdev)
 {
 	pm_runtime_disable(&pdev->dev);
-	return 0;
 }
 
 static int lp_gpio_runtime_suspend(struct device *dev)
@@ -890,7 +889,7 @@  MODULE_DEVICE_TABLE(acpi, lynxpoint_gpio_acpi_match);
 
 static struct platform_driver lp_gpio_driver = {
 	.probe          = lp_gpio_probe,
-	.remove         = lp_gpio_remove,
+	.remove_new     = lp_gpio_remove,
 	.driver         = {
 		.name   = "lp_gpio",
 		.pm	= pm_ptr(&lp_gpio_pm_ops),