net: stmmac: restructure the error path of stmmac_probe_config_dt()

[ Upstream commit 2b6ffcd7873b7e8a62c3e15a6f305bfc747c466b ]

Current implementation of stmmac_probe_config_dt() does not release the
OF node reference obtained by of_parse_phandle() in some error paths.
The problem is that some error paths call stmmac_remove_config_dt() to
clean up but others use and unwind ladder.  These two types of error
handling have not kept in sync and have been a recurring source of bugs.
Re-write the error handling in stmmac_probe_config_dt() to use an unwind
ladder. Consequently, stmmac_remove_config_dt() is not needed anymore,
thus remove it.

This bug was found by an experimental verification tool that I am
developing.

Fixes: 4838a5405028 ("net: stmmac: Fix wrapper drivers not detecting PHY")
Signed-off-by: Joe Hattori <joe@pf.is.s.u-tokyo.ac.jp>
Link: https://patch.msgid.link/20241219024119.2017012-1-joe@pf.is.s.u-tokyo.ac.jp
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Signed-off-by: Sasha Levin <sashal@kernel.org>

diff --git a/drivers/net/ethernet/stmicro/stmmac/stmmac_platform.c b/drivers/net/ethernet/stmicro/stmmac/stmmac_platform.c
index 7f816f0cf9a520ea95aeeb361d74ecac87c742ef..36b013b9d99e6d01169273e36fe6c66496fe2956 100644 (file)
--- a/drivers/net/ethernet/stmicro/stmmac/stmmac_platform.c
+++ b/drivers/net/ethernet/stmicro/stmmac/stmmac_platform.c
@@ -472,8 +472,10 @@ stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)
                dev_warn(&pdev->dev, "snps,phy-addr property is deprecated\n");
 
        rc = stmmac_mdio_setup(plat, np, &pdev->dev);
-       if (rc)
-               return ERR_PTR(rc);
+       if (rc) {
+               ret = ERR_PTR(rc);
+               goto error_put_phy;
+       }
 
        of_property_read_u32(np, "tx-fifo-depth", &plat->tx_fifo_size);
 
@@ -559,8 +561,8 @@ stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)
        dma_cfg = devm_kzalloc(&pdev->dev, sizeof(*dma_cfg),
                               GFP_KERNEL);
        if (!dma_cfg) {
-               stmmac_remove_config_dt(pdev, plat);
-               return ERR_PTR(-ENOMEM);
+               ret = ERR_PTR(-ENOMEM);
+               goto error_put_mdio;
        }
        plat->dma_cfg = dma_cfg;
 
@@ -588,8 +590,8 @@ stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)
 
        rc = stmmac_mtl_setup(pdev, plat);
        if (rc) {
-               stmmac_remove_config_dt(pdev, plat);
-               return ERR_PTR(rc);
+               ret = ERR_PTR(rc);
+               goto error_put_mdio;
        }
 
        /* clock setup */
@@ -641,6 +643,10 @@ error_hw_init:
        clk_disable_unprepare(plat->pclk);
 error_pclk_get:
        clk_disable_unprepare(plat->stmmac_clk);
+error_put_mdio:
+       of_node_put(plat->mdio_node);
+error_put_phy:
+       of_node_put(plat->phy_node);
 
        return ret;
 }
@@ -649,16 +655,17 @@ static void devm_stmmac_remove_config_dt(void *data)
 {
        struct plat_stmmacenet_data *plat = data;
 
-       /* Platform data argument is unused */
-       stmmac_remove_config_dt(NULL, plat);
+       clk_disable_unprepare(plat->stmmac_clk);
+       clk_disable_unprepare(plat->pclk);
+       of_node_put(plat->mdio_node);
+       of_node_put(plat->phy_node);
 }
 
 /**
  * devm_stmmac_probe_config_dt
  * @pdev: platform_device structure
  * @mac: MAC address to use
- * Description: Devres variant of stmmac_probe_config_dt(). Does not require
- * the user to call stmmac_remove_config_dt() at driver detach.
+ * Description: Devres variant of stmmac_probe_config_dt().
  */
 struct plat_stmmacenet_data *
 devm_stmmac_probe_config_dt(struct platform_device *pdev, u8 *mac)