[PATCH 6/9] net: fix phy refcounting in a bunch of drivers

[Russell King]

of_phy_find_device() increments the phy struct device refcount, which
we need to properly balance.  Add code to network drivers using this
function to ensure that the struct device refcount is correctly
balanced.

For xgene, looking back in the history, we should be able to use
of_phy_connect() with a zero flags argument for the DT case as this is
how the driver used to operate prior to de7b5b3d790a ("net: eth: xgene:
change APM X-Gene SoC platform ethernet to support ACPI").

This leaves the Cavium Thunder BGX unfixed; fixing this driver is a
complicated task, one which the maintainers need to be involved with.

Signed-off-by: Russell King 
---
 drivers/net/ethernet/apm/xgene/xgene_enet_hw.c | 24 
 drivers/net/ethernet/freescale/gianfar.c   |  3 +++
 drivers/net/ethernet/freescale/ucc_geth.c  |  8 +++-
 drivers/net/ethernet/marvell/mvneta.c  |  2 ++
 drivers/net/ethernet/xilinx/xilinx_emaclite.c  |  2 ++
 5 files changed, 30 insertions(+), 9 deletions(-)

diff --git a/drivers/net/ethernet/apm/xgene/xgene_enet_hw.c 
b/drivers/net/ethernet/apm/xgene/xgene_enet_hw.c
index cfa37041ab71..c4bb8027b3fb 100644
--- a/drivers/net/ethernet/apm/xgene/xgene_enet_hw.c
+++ b/drivers/net/ethernet/apm/xgene/xgene_enet_hw.c
@@ -689,16 +689,24 @@ static int xgene_enet_phy_connect(struct net_device *ndev)
netdev_dbg(ndev, "No phy-handle found in DT\n");
return -ENODEV;
}
-   pdata->phy_dev = of_phy_find_device(phy_np);
-   }
 
-   phy_dev = pdata->phy_dev;
+   phy_dev = of_phy_connect(ndev, phy_np, _enet_adjust_link,
+0, pdata->phy_mode);
+   if (!phy_dev) {
+   netdev_err(ndev, "Could not connect to PHY\n");
+   return -ENODEV;
+   }
+
+   pdata->phy_dev = phy_dev;
+   } else {
+   phy_dev = pdata->phy_dev;
 
-   if (!phy_dev ||
-   phy_connect_direct(ndev, phy_dev, _enet_adjust_link,
-  pdata->phy_mode)) {
-   netdev_err(ndev, "Could not connect to PHY\n");
-   return  -ENODEV;
+   if (!phy_dev ||
+   phy_connect_direct(ndev, phy_dev, _enet_adjust_link,
+  pdata->phy_mode)) {
+   netdev_err(ndev, "Could not connect to PHY\n");
+   return  -ENODEV;
+   }
}
 
pdata->phy_speed = SPEED_UNKNOWN;
diff --git a/drivers/net/ethernet/freescale/gianfar.c 
b/drivers/net/ethernet/freescale/gianfar.c
index 4b69d061d90f..65a16086faec 100644
--- a/drivers/net/ethernet/freescale/gianfar.c
+++ b/drivers/net/ethernet/freescale/gianfar.c
@@ -1702,6 +1702,7 @@ static void gfar_configure_serdes(struct net_device *dev)
tbiphy = of_phy_find_device(priv->tbi_node);
if (!tbiphy) {
dev_err(>dev, "error: Could not get TBI device\n");
+   put_device(>dev);
return;
}
 
@@ -1723,6 +1724,8 @@ static void gfar_configure_serdes(struct net_device *dev)
phy_write(tbiphy, MII_BMCR,
  BMCR_ANENABLE | BMCR_ANRESTART | BMCR_FULLDPLX |
  BMCR_SPEED1000);
+
+   put_device(>dev);
 }
 
 static int __gfar_is_rx_idle(struct gfar_private *priv)
diff --git a/drivers/net/ethernet/freescale/ucc_geth.c 
b/drivers/net/ethernet/freescale/ucc_geth.c
index 4dd40e057f40..650f7888e32b 100644
--- a/drivers/net/ethernet/freescale/ucc_geth.c
+++ b/drivers/net/ethernet/freescale/ucc_geth.c
@@ -1384,6 +1384,8 @@ static int adjust_enet_interface(struct ucc_geth_private 
*ugeth)
value = phy_read(tbiphy, ENET_TBI_MII_CR);
value &= ~0x1000;   /* Turn off autonegotiation */
phy_write(tbiphy, ENET_TBI_MII_CR, value);
+
+   put_device(>dev);
}
 
init_check_frame_length_mode(ug_info->lengthCheckRx, _regs->maccfg2);
@@ -1702,8 +1704,10 @@ static void uec_configure_serdes(struct net_device *dev)
 * everything for us?  Resetting it takes the link down and requires
 * several seconds for it to come back.
 */
-   if (phy_read(tbiphy, ENET_TBI_MII_SR) & TBISR_LSTATUS)
+   if (phy_read(tbiphy, ENET_TBI_MII_SR) & TBISR_LSTATUS) {
+   put_device(>dev);
return;
+   }
 
/* Single clk mode, mii mode off(for serdes communication) */
phy_write(tbiphy, ENET_TBI_MII_ANA, TBIANA_SETTINGS);
@@ -1711,6 +1715,8 @@ static void uec_configure_serdes(struct net_device *dev)
phy_write(tbiphy, ENET_TBI_MII_TBICON, TBICON_CLK_SELECT);
 
phy_write(tbiphy, ENET_TBI_MII_CR, TBICR_SETTINGS);
+
+   put_device(>dev);
 }
 
 /* Configure the PHY for dev.
diff --git a/drivers/net/ethernet/marvell/mvneta.c 
b/drivers/net/ethernet/marvell/mvneta.c
index 

[PATCH 6/9] net: fix phy refcounting in a bunch of drivers

[Russell King]

of_phy_find_device() increments the phy struct device refcount,
which we need to properly balance.  Add code to network drivers
using this function to ensure that the struct device refcount is
correctly balanced.

Signed-off-by: Russell King 
---
 drivers/net/ethernet/apm/xgene/xgene_enet_hw.c| 23 +++
 drivers/net/ethernet/cavium/thunder/thunder_bgx.c | 19 +++
 drivers/net/ethernet/freescale/gianfar.c  |  3 +++
 drivers/net/ethernet/freescale/ucc_geth.c |  8 +++-
 drivers/net/ethernet/marvell/mvneta.c |  2 ++
 drivers/net/ethernet/xilinx/xilinx_emaclite.c |  2 ++
 6 files changed, 48 insertions(+), 9 deletions(-)

diff --git a/drivers/net/ethernet/apm/xgene/xgene_enet_hw.c 
b/drivers/net/ethernet/apm/xgene/xgene_enet_hw.c
index cfa37041ab71..d2103a3199eb 100644
--- a/drivers/net/ethernet/apm/xgene/xgene_enet_hw.c
+++ b/drivers/net/ethernet/apm/xgene/xgene_enet_hw.c
@@ -689,16 +689,23 @@ static int xgene_enet_phy_connect(struct net_device *ndev)
netdev_dbg(ndev, "No phy-handle found in DT\n");
return -ENODEV;
}
-   pdata->phy_dev = of_phy_find_device(phy_np);
-   }
 
-   phy_dev = pdata->phy_dev;
+   pdata->phy_dev = of_phy_connect(ndev, phy_np,
+   _enet_adjust_link,
+   pdata->phy_mode);
+   if (!pdata->phy_dev) {
+   netdev_err(ndev, "Could not connect to PHY\n");
+   return -ENODEV;
+   }
+   } else {
+   phy_dev = pdata->phy_dev;
 
-   if (!phy_dev ||
-   phy_connect_direct(ndev, phy_dev, _enet_adjust_link,
-  pdata->phy_mode)) {
-   netdev_err(ndev, "Could not connect to PHY\n");
-   return  -ENODEV;
+   if (!phy_dev ||
+   phy_connect_direct(ndev, phy_dev, _enet_adjust_link,
+  pdata->phy_mode)) {
+   netdev_err(ndev, "Could not connect to PHY\n");
+   return  -ENODEV;
+   }
}
 
pdata->phy_speed = SPEED_UNKNOWN;
diff --git a/drivers/net/ethernet/cavium/thunder/thunder_bgx.c 
b/drivers/net/ethernet/cavium/thunder/thunder_bgx.c
index 574c49278900..529d212bd071 100644
--- a/drivers/net/ethernet/cavium/thunder/thunder_bgx.c
+++ b/drivers/net/ethernet/cavium/thunder/thunder_bgx.c
@@ -1000,6 +1000,20 @@ static int bgx_init_phy(struct bgx *bgx)
return bgx_init_of_phy(bgx);
 }
 
+/*
+ * This drops the refcount obtained from of_phy_find_device() above.
+ * We do not need to keep the refcount after phy_connect_direct() has
+ * taken its own reference.
+ */
+static void bgx_drop_phy_ref(struct bgx *bgx)
+{
+   unsigned int lmac;
+
+   for (lmac = 0; lmac < bgx->lmac_count; lmac++)
+   if (bgx->lmac[lmac].phydev)
+   put_device(>lmac[lmac].phydev->dev);
+}
+
 static int bgx_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
 {
int err;
@@ -1056,9 +1070,14 @@ static int bgx_probe(struct pci_dev *pdev, const struct 
pci_device_id *ent)
}
}
 
+   if (np)
+   bgx_drop_phy_ref(bgx);
+
return 0;
 
 err_enable:
+   if (np)
+   bgx_drop_phy_ref(bgx);
bgx_vnic[bgx->bgx_id] = NULL;
 err_release_regions:
pci_release_regions(pdev);
diff --git a/drivers/net/ethernet/freescale/gianfar.c 
b/drivers/net/ethernet/freescale/gianfar.c
index 4b69d061d90f..65a16086faec 100644
--- a/drivers/net/ethernet/freescale/gianfar.c
+++ b/drivers/net/ethernet/freescale/gianfar.c
@@ -1702,6 +1702,7 @@ static void gfar_configure_serdes(struct net_device *dev)
tbiphy = of_phy_find_device(priv->tbi_node);
if (!tbiphy) {
dev_err(>dev, "error: Could not get TBI device\n");
+   put_device(>dev);
return;
}
 
@@ -1723,6 +1724,8 @@ static void gfar_configure_serdes(struct net_device *dev)
phy_write(tbiphy, MII_BMCR,
  BMCR_ANENABLE | BMCR_ANRESTART | BMCR_FULLDPLX |
  BMCR_SPEED1000);
+
+   put_device(>dev);
 }
 
 static int __gfar_is_rx_idle(struct gfar_private *priv)
diff --git a/drivers/net/ethernet/freescale/ucc_geth.c 
b/drivers/net/ethernet/freescale/ucc_geth.c
index 4dd40e057f40..650f7888e32b 100644
--- a/drivers/net/ethernet/freescale/ucc_geth.c
+++ b/drivers/net/ethernet/freescale/ucc_geth.c
@@ -1384,6 +1384,8 @@ static int adjust_enet_interface(struct ucc_geth_private 
*ugeth)
value = phy_read(tbiphy, ENET_TBI_MII_CR);
value &= ~0x1000;   /* Turn off autonegotiation */
phy_write(tbiphy, ENET_TBI_MII_CR, value);
+
+   put_device(>dev);
}