dmaengine: uniphier-mdmac: Convert to platform remove callback returning void

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().

There is an error path that has the above mentioned problem. This patch
only adds a more drastic error message. To properly fix it,
dmaengine_terminate_sync() must be known to have succeeded (or that it's
safe to not call it as other drivers seem to assume).

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Link: https://lore.kernel.org/r/20231105093415.3704633-9-u.kleine-koenig@pengutronix.de
Signed-off-by: Vinod Koul <vkoul@kernel.org>

diff --git a/drivers/dma/uniphier-mdmac.c b/drivers/dma/uniphier-mdmac.c
index 618839df074866c4d9a2feca56a9f4183baea3cb..ad7125f6e2ca8e4452195e3ad4cedf4ee154a5b3 100644 (file)
--- a/drivers/dma/uniphier-mdmac.c
+++ b/drivers/dma/uniphier-mdmac.c
@@ -453,7 +453,7 @@ disable_clk:
        return ret;
 }
 
-static int uniphier_mdmac_remove(struct platform_device *pdev)
+static void uniphier_mdmac_remove(struct platform_device *pdev)
 {
        struct uniphier_mdmac_device *mdev = platform_get_drvdata(pdev);
        struct dma_chan *chan;
@@ -468,16 +468,21 @@ static int uniphier_mdmac_remove(struct platform_device *pdev)
         */
        list_for_each_entry(chan, &mdev->ddev.channels, device_node) {
                ret = dmaengine_terminate_sync(chan);
-               if (ret)
-                       return ret;
+               if (ret) {
+                       /*
+                        * This results in resource leakage and maybe also
+                        * use-after-free errors as e.g. *mdev is kfreed.
+                        */
+                       dev_alert(&pdev->dev, "Failed to terminate channel %d (%pe)\n",
+                                 chan->chan_id, ERR_PTR(ret));
+                       return;
+               }
                uniphier_mdmac_free_chan_resources(chan);
        }
 
        of_dma_controller_free(pdev->dev.of_node);
        dma_async_device_unregister(&mdev->ddev);
        clk_disable_unprepare(mdev->clk);
-
-       return 0;
 }
 
 static const struct of_device_id uniphier_mdmac_match[] = {
@@ -488,7 +493,7 @@ MODULE_DEVICE_TABLE(of, uniphier_mdmac_match);
 
 static struct platform_driver uniphier_mdmac_driver = {
        .probe = uniphier_mdmac_probe,
-       .remove = uniphier_mdmac_remove,
+       .remove_new = uniphier_mdmac_remove,
        .driver = {
                .name = "uniphier-mio-dmac",
                .of_match_table = uniphier_mdmac_match,