misc: tps6594-esm: Convert to platform remove callback returning void
authorUwe Kleine-König <u.kleine-koenig@pengutronix.de>
Mon, 10 Jul 2023 08:23:11 +0000 (10:23 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 4 Aug 2023 13:39:00 +0000 (15:39 +0200)
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().

There are two calls that can go wrong in tps6594_esm_remove(); for both
there is already an error message. Not returning the error code has the
only side effect of suppressing (another) error message by the core
about the error being ignored. So tps6594_esm_remove() can be converted
to return void without any loss.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Link: https://lore.kernel.org/r/20230710082311.3474785-1-u.kleine-koenig@pengutronix.de
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/misc/tps6594-esm.c

index b488f70..a32da1c 100644 (file)
@@ -65,7 +65,7 @@ static int tps6594_esm_probe(struct platform_device *pdev)
        return 0;
 }
 
-static int tps6594_esm_remove(struct platform_device *pdev)
+static void tps6594_esm_remove(struct platform_device *pdev)
 {
        struct tps6594 *tps = dev_get_drvdata(pdev->dev.parent);
        struct device *dev = &pdev->dev;
@@ -86,8 +86,6 @@ static int tps6594_esm_remove(struct platform_device *pdev)
 out:
        pm_runtime_put_sync(dev);
        pm_runtime_disable(dev);
-
-       return ret;
 }
 
 static int tps6594_esm_suspend(struct device *dev)
@@ -121,7 +119,7 @@ static struct platform_driver tps6594_esm_driver = {
                .pm = pm_sleep_ptr(&tps6594_esm_pm_ops),
        },
        .probe = tps6594_esm_probe,
-       .remove = tps6594_esm_remove,
+       .remove_new = tps6594_esm_remove,
 };
 
 module_platform_driver(tps6594_esm_driver);