PCI: keystone: Convert to platform remove callback returning void
authorUwe Kleine-König <u.kleine-koenig@pengutronix.de>
Mon, 4 Dec 2023 09:47:41 +0000 (10:47 +0100)
committerKrzysztof Wilczyński <kwilczynski@kernel.org>
Sat, 16 Dec 2023 00:39:05 +0000 (00:39 +0000)
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().

In the error path emit an error message replacing the (less useful)
message by the core. Apart from the improved error message there is no
change in behaviour.

Trivially convert this driver from always returning zero in the remove
callback to the void returning variant.

Link: https://lore.kernel.org/linux-pci/06612aff79dfb52d5b0b20129dff5e4b1f04d3a7.1701682617.git.u.kleine-koenig@pengutronix.de
Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: Krzysztof Wilczyński <kwilczynski@kernel.org>
drivers/pci/controller/dwc/pci-keystone.c

index 0def919f89fafb51bc28109d26d23893506b804f..41c7ff862732560115eddc0e4ff939b69bebc715 100644 (file)
@@ -1302,7 +1302,7 @@ err_link:
        return ret;
 }
 
-static int ks_pcie_remove(struct platform_device *pdev)
+static void ks_pcie_remove(struct platform_device *pdev)
 {
        struct keystone_pcie *ks_pcie = platform_get_drvdata(pdev);
        struct device_link **link = ks_pcie->link;
@@ -1314,13 +1314,11 @@ static int ks_pcie_remove(struct platform_device *pdev)
        ks_pcie_disable_phy(ks_pcie);
        while (num_lanes--)
                device_link_del(link[num_lanes]);
-
-       return 0;
 }
 
 static struct platform_driver ks_pcie_driver = {
        .probe  = ks_pcie_probe,
-       .remove = ks_pcie_remove,
+       .remove_new = ks_pcie_remove,
        .driver = {
                .name   = "keystone-pcie",
                .of_match_table = ks_pcie_of_match,