Skip to contentSkip to conversation

net: dsa: lantiq_gswip: probe fixes and remove cleanup

PATCH In review Johan Hovold 4 participants 13 messages Jan 16, 2019 – Jan 17, 2019

Subsystems (4)
lore
Share & tools
lore
#1 lore raw

PATCH 1/3 net: dsa: lantiq_gswip: fix use-after-free on failed probe

In reply to Johan Hovold

Make sure to disable and deregister the switch on late probe errors to avoid use-after-free when the device-resource-managed switch is freed.

Fixes 14fceff4771e ("net: dsa: Add Lantiq / Intel DSA driver for vrx200")
Cc stable <[email protected]> # 4.20
Cc Hauke Mehrtens <[email protected]>
---
 drivers/net/dsa/lantiq_gswip.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/net/dsa/lantiq_gswip.c +4 -1
index 693a67f45bef..b06c41c98de9 100644
@@ -1099,7 +1099,7 @@ static int gswip_probe(struct platform_device *pdev)
 		dev_err(dev, "wrong CPU port defined, HW only supports port: %i",
 			priv->hw_info->cpu_port);
 		err = -EINVAL;
-		goto mdio_bus;
+		goto disable_switch;
 	}
 
 	platform_set_drvdata(pdev, priv);
@@ -1109,6 +1109,9 @@ static int gswip_probe(struct platform_device *pdev)
 		 (version & GSWIP_VERSION_MOD_MASK) >> GSWIP_VERSION_MOD_SHIFT);
 	return 0;
 
+disable_switch:
+	gswip_mdio_mask(priv, GSWIP_MDIO_GLOB_ENABLE, 0, GSWIP_MDIO_GLOB);
+	dsa_unregister_switch(priv->ds);
 mdio_bus:
 	if (mdio_np)
 		mdiobus_unregister(priv->ds->slave_mii_bus);
Signature · 1 line
2.20.1
#0 lore raw

cover net: dsa: lantiq_gswip: probe fixes and remove cleanup

This series fix a few issues found through inspection when fixing up new bad uses of of_find_compatible_node() that have crept in since 4.19.

Note that these have only been compile tested.

Johan

Johan Hovold (3):
net: dsa: lantiq_gswip: fix use-after-free on failed probe
net: dsa: lantiq_gswip: fix OF child-node lookups
net: dsa: lantiq_gswip: drop bogus drvdata check

 drivers/net/dsa/lantiq_gswip.c | 24 +++++++++++++-----------
 1 file changed, 13 insertions(+), 11 deletions(-)
Signature · 1 line
2.20.1
#6 lore raw

PATCH 2/3 net: dsa: lantiq_gswip: fix OF child-node lookups

Use the new of_get_compatible_child() helper to look up child nodes to avoid ever matching non-child nodes elsewhere in the tree.

Also fix up the related struct device_node leaks.

Fixes 14fceff4771e ("net: dsa: Add Lantiq / Intel DSA driver for vrx200")
Cc stable <[email protected]> # 4.20
Cc Hauke Mehrtens <[email protected]>
---
 drivers/net/dsa/lantiq_gswip.c | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)
drivers/net/dsa/lantiq_gswip.c +9 -7
index b06c41c98de9..5792674dd4e4 100644
@@ -1069,10 +1069,10 @@ static int gswip_probe(struct platform_device *pdev)
 	version = gswip_switch_r(priv, GSWIP_VERSION);
 
 	/* bring up the mdio bus */
-	gphy_fw_np = of_find_compatible_node(pdev->dev.of_node, NULL,
-					     "lantiq,gphy-fw");
+	gphy_fw_np = of_get_compatible_child(dev->of_node, "lantiq,gphy-fw");
 	if (gphy_fw_np) {
 		err = gswip_gphy_fw_list(priv, gphy_fw_np, version);
+		of_node_put(gphy_fw_np);
 		if (err) {
 			dev_err(dev, "gphy fw probe failed\n");
 			return err;
@@ -1080,13 +1080,12 @@ static int gswip_probe(struct platform_device *pdev)
 	}
 
 	/* bring up the mdio bus */
-	mdio_np = of_find_compatible_node(pdev->dev.of_node, NULL,
-					  "lantiq,xrx200-mdio");
+	mdio_np = of_get_compatible_child(dev->of_node, "lantiq,xrx200-mdio");
 	if (mdio_np) {
 		err = gswip_mdio(priv, mdio_np);
 		if (err) {
 			dev_err(dev, "mdio probe failed\n");
-			goto gphy_fw;
+			goto put_mdio_node;
 		}
 	}
 
@@ -1115,7 +1114,8 @@ static int gswip_probe(struct platform_device *pdev)
 mdio_bus:
 	if (mdio_np)
 		mdiobus_unregister(priv->ds->slave_mii_bus);
-gphy_fw:
+put_mdio_node:
+	of_node_put(mdio_np);
 	for (i = 0; i < priv->num_gphy_fw; i++)
 		gswip_gphy_fw_remove(priv, &priv->gphy_fw[i]);
 	return err;
@@ -1134,8 +1134,10 @@ static int gswip_remove(struct platform_device *pdev)
 
 	dsa_unregister_switch(priv->ds);
 
-	if (priv->ds->slave_mii_bus)
+	if (priv->ds->slave_mii_bus) {
 		mdiobus_unregister(priv->ds->slave_mii_bus);
+		of_node_put(priv->ds->slave_mii_bus->dev.of_node);
+	}
 
 	for (i = 0; i < priv->num_gphy_fw; i++)
 		gswip_gphy_fw_remove(priv, &priv->gphy_fw[i]);
Signature · 1 line
2.20.1
#9 lore raw

PATCH 3/3 net: dsa: lantiq_gswip: drop bogus drvdata check

In reply to Johan Hovold

The platform-device driver data is set on successful probe and will never be NULL on remove (or we have much bigger problems).

---
 drivers/net/dsa/lantiq_gswip.c | 3 ---
 1 file changed, 3 deletions(-)
drivers/net/dsa/lantiq_gswip.c +0 -3
index 5792674dd4e4..27d092cab40e 100644
@@ -1126,9 +1126,6 @@ static int gswip_remove(struct platform_device *pdev)
 	struct gswip_priv *priv = platform_get_drvdata(pdev);
 	int i;
 
-	if (!priv)
-		return 0;
-
 	/* disable the switch */
 	gswip_mdio_mask(priv, GSWIP_MDIO_GLOB_ENABLE, 0, GSWIP_MDIO_GLOB);
 
Signature · 1 line
2.20.1
maintainer Reviewed-by on v1 1/3
#2 lore raw

Re: [PATCH 1/3] net: dsa: lantiq_gswip: fix use-after-free on failed probe

In reply to Johan Hovold
Quoted 25 lines · Johan Hovold

Make sure to disable and deregister the switch on late probe errors to avoid use-after-free when the device-resource-managed switch is freed.

Fixes 14fceff4771e ("net: dsa: Add Lantiq / Intel DSA driver for vrx200")
Cc stable <[email protected]> # 4.20
Cc Hauke Mehrtens <[email protected]>
---
 drivers/net/dsa/lantiq_gswip.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/net/dsa/lantiq_gswip.c +1 -1
index 693a67f45bef..b06c41c98de9 100644
@@ -1099,7 +1099,7 @@ static int gswip_probe(struct platform_device *pdev)
 		dev_err(dev, "wrong CPU port defined, HW only supports port: %i",
 			priv->hw_info->cpu_port);
 		err = -EINVAL;
-		goto mdio_bus;
+		goto disable_switch;
 	}
 
 	platform_set_drvdata(pdev, priv);

drivers/net/dsa/lantiq_gswip.c static int gswip_probe(struct platform_device *pdev) · line 1114

Quoted 6 lines
drivers/net/dsa/lantiq_gswip.c +3 -0
@@ -1109,6 +1109,9 @@ static int gswip_probe(struct platform_device *pdev)
 		 (version & GSWIP_VERSION_MOD_MASK) >> GSWIP_VERSION_MOD_SHIFT);
 	return 0;
 
+disable_switch:
+	gswip_mdio_mask(priv, GSWIP_MDIO_GLOB_ENABLE, 0, GSWIP_MDIO_GLOB);
+	dsa_unregister_switch(priv->ds);

This is correct. But it would be nice if somebody in the future could move the disabling of the switch to the inverse of the gswip_setup() function to make the code symmetrical.

Andrew

maintainer Reviewed-by on v1 2/3
#7 lore raw

Re: [PATCH 2/3] net: dsa: lantiq_gswip: fix OF child-node lookups

In reply to Johan Hovold
Quoted 9 lines · Johan Hovold

Use the new of_get_compatible_child() helper to look up child nodes to avoid ever matching non-child nodes elsewhere in the tree.

Also fix up the related struct device_node leaks.

Fixes 14fceff4771e ("net: dsa: Add Lantiq / Intel DSA driver for vrx200")
Cc stable <[email protected]> # 4.20
Cc Hauke Mehrtens <[email protected]>

Andrew

Acked-by on v1 1/3
#5 lore raw

Re: [PATCH 1/3] net: dsa: lantiq_gswip: fix use-after-free on failed probe

In reply to Johan Hovold
Quoted 7 lines · Johan Hovold

Make sure to disable and deregister the switch on late probe errors to avoid use-after-free when the device-resource-managed switch is freed.

Fixes 14fceff4771e ("net: dsa: Add Lantiq / Intel DSA driver for vrx200")
Cc stable <[email protected]> # 4.20
Cc Hauke Mehrtens <[email protected]>
Quoted 28 lines
---
 drivers/net/dsa/lantiq_gswip.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/net/dsa/lantiq_gswip.c +4 -1
index 693a67f45bef..b06c41c98de9 100644
@@ -1099,7 +1099,7 @@ static int gswip_probe(struct platform_device *pdev)
 		dev_err(dev, "wrong CPU port defined, HW only supports port: %i",
 			priv->hw_info->cpu_port);
 		err = -EINVAL;
-		goto mdio_bus;
+		goto disable_switch;
 	}
 
 	platform_set_drvdata(pdev, priv);
@@ -1109,6 +1109,9 @@ static int gswip_probe(struct platform_device *pdev)
 		 (version & GSWIP_VERSION_MOD_MASK) >> GSWIP_VERSION_MOD_SHIFT);
 	return 0;
 
+disable_switch:
+	gswip_mdio_mask(priv, GSWIP_MDIO_GLOB_ENABLE, 0, GSWIP_MDIO_GLOB);
+	dsa_unregister_switch(priv->ds);
 mdio_bus:
 	if (mdio_np)
 		mdiobus_unregister(priv->ds->slave_mii_bus);
#3 lore raw

Re: [PATCH 1/3] net: dsa: lantiq_gswip: fix use-after-free on failed probe

In reply to Andrew Lunn
Quoted 29 lines · Andrew Lunn
Quoted 28 lines · Johan Hovold

Make sure to disable and deregister the switch on late probe errors to avoid use-after-free when the device-resource-managed switch is freed.

Fixes 14fceff4771e ("net: dsa: Add Lantiq / Intel DSA driver for vrx200")
Cc stable <[email protected]> # 4.20
Cc Hauke Mehrtens <[email protected]>
---
 drivers/net/dsa/lantiq_gswip.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/net/dsa/lantiq_gswip.c +1 -1
index 693a67f45bef..b06c41c98de9 100644
@@ -1099,7 +1099,7 @@ static int gswip_probe(struct platform_device *pdev)
 		dev_err(dev, "wrong CPU port defined, HW only supports port: %i",
 			priv->hw_info->cpu_port);
 		err = -EINVAL;
-		goto mdio_bus;
+		goto disable_switch;
 	}
 
 	platform_set_drvdata(pdev, priv);
@@ -1109,6 +1109,9 @@ static int gswip_probe(struct platform_device *pdev)
 		 (version & GSWIP_VERSION_MOD_MASK) >> GSWIP_VERSION_MOD_SHIFT);
 	return 0;
 
Quoted 7 lines

drivers/net/dsa/lantiq_gswip.c static int gswip_probe(struct platform_device *pdev) · line 1114

Quoted 3 lines
drivers/net/dsa/lantiq_gswip.c +3 -0
+disable_switch:
+	gswip_mdio_mask(priv, GSWIP_MDIO_GLOB_ENABLE, 0, GSWIP_MDIO_GLOB);
+	dsa_unregister_switch(priv->ds);

This is correct. But it would be nice if somebody in the future could move the disabling of the switch to the inverse of the gswip_setup() function to make the code symmetrical.

Should we add an uninit callback?

Hauke

Acked-by on v1 2/3
#8 lore raw

Re: [PATCH 2/3] net: dsa: lantiq_gswip: fix OF child-node lookups

In reply to Johan Hovold
Quoted 9 lines · Johan Hovold

Use the new of_get_compatible_child() helper to look up child nodes to avoid ever matching non-child nodes elsewhere in the tree.

Also fix up the related struct device_node leaks.

Fixes 14fceff4771e ("net: dsa: Add Lantiq / Intel DSA driver for vrx200")
Cc stable <[email protected]> # 4.20
Cc Hauke Mehrtens <[email protected]>
Quoted 4 lines
---
 drivers/net/dsa/lantiq_gswip.c | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)
maintainer
#4 lore raw

Re: [PATCH 1/3] net: dsa: lantiq_gswip: fix use-after-free on failed probe

In reply to Hauke Mehrtens
Quoted 5 lines
Quoted 3 lines

This is correct. But it would be nice if somebody in the future could move the disabling of the switch to the inverse of the gswip_setup() function to make the code symmetrical.

Should we add an uninit callback?

Yes, that would be good.

It looks like lan9303-core.c could use it as well for lan9303_disable_processing(chip);

Thanks
Andrew

maintainer
#12 lore raw
In reply to Johan Hovold

From: Johan Hovold <[email protected]>
Date: Wed, 16 Jan 2019 11:23:32 +0100

Quoted 4 lines

This series fix a few issues found through inspection when fixing up new bad uses of of_find_compatible_node() that have crept in since 4.19.

Note that these have only been compile tested.

Series applied.