Skip to contentSkip to conversation

Improve MDIO Ethernet PHY reset

PATCH In review Bruno Thomsen 4 participants 14 messages Jul 30, 2020 – Aug 3, 2020

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

v2 cover Improve MDIO Ethernet PHY reset

This patch series is a result of trying to upstream a new device tree for a TQMa7D based board[1][2]. Initial this DTS used some deprecated PHY reset properties on the FEC device; NXP Ethernet MAC also known as Freescale Fast Ethernet Controller.

When switching from FEC properties[3]:
"phy-reset-gpios"
"phy-reset-duration"
"phy-reset-post-delay"

To MDIO PHY properties[4]:
"reset-gpios"
"reset-assert-us"
"reset-deassert-us"

The result was that no Ethernet PHY device was detected on boot.

This issue could be worked around by disabling PHY type ID auto- detection by using "ethernet-phy-id0022.1560" as compatible string and not "ethernet-phy-ieee802.3-c22".

Upstreaming a DTS with this workaround was not accepted, so I digged into the MDIO reset flow and found that it had a few missing parts compared to the deprecated FEC reset function. After some more testing and logic analyzer traces it was revealed that the failed PHY communication was due to missing initial device reset.

I was suggested[5] in a earlier mail thread to use MDIO bus reset as that was performed before auto-detection, but current device tree binding was limited to reset assert in usec. Microchip/Micrel Ethernet PHYs recommended reset circuit[8], figure 7-12, is a little "slow" after reset deassert as that is left to a RC circuit with a tau of ~100ms; using a 10k PU resistor together with a 10uF decoupling capacitor. The diode in serie of the reset signal converts the GPIO push-pull output into a open-drain output. So a post reset delay in the range of 500-1000ms is needed, depending on component tolerances and general hardware design margins.

In the first version of this patch series[6] I reused the "reset-delay-us" property for reset deassert in usec as that would cause 50/50% duty-cycle, but that would always apply. The solution in this patch series is to add a new MDIO bus property, so post reset delay is optional and configured separately.

MDIO bus properties[7]:
"reset-delay-us"
"reset-post-delay-us" (new)

I have not marked this with "Fixes:" as no single commit is the cause and historically this code has only supported MDIO devices that need reset after auto-detection. The patch series also uses a new flexible sleep helper function that was introduced in 5.8-rc1, so the driver uses the optimal sleep function depending on value loaded from device tree.

Future work in this area could add new properties on the MDIO device, so reset points are configurable, e.g. no reset, before/after auto-detection or both.

[1] https://lore.kernel.org/linux-devicetree/[email protected]/
[2] https://lore.kernel.org/linux-devicetree/[email protected]/
[3] https://elixir.bootlin.com/linux/v5.7.8/source/Documentation/devicetree/bindings/net/fsl-fec.txt#L44
[4] https://elixir.bootlin.com/linux/v5.8-rc4/source/Documentation/devicetree/bindings/net/mdio.yaml#L78
[5] https://lore.kernel.org/netdev/CAOMZO5DtYDomD8FDCZDwYCSr2AwNT81Ay4==aDxXyBxtyvPiJA@mail.gmail.com/
[6] https://lore.kernel.org/netdev/[email protected]/
[7] https://elixir.bootlin.com/linux/v5.8-rc4/source/Documentation/devicetree/bindings/net/mdio.yaml#L36
[8] http://ww1.microchip.com/downloads/en/DeviceDoc/00002202C.pdf

Bruno Thomsen (4):
dt-bindings: net: mdio: add reset-post-delay-us property
net: mdiobus: use flexible sleeping for reset-delay-us
net: mdiobus: add reset-post-delay-us handling
net: mdio device: use flexible sleeping in reset function

 Documentation/devicetree/bindings/net/mdio.yaml | 7 +++++++
 drivers/net/phy/mdio_bus.c                      | 4 +++-
 drivers/net/phy/mdio_device.c                   | 2 +-
 drivers/of/of_mdio.c                            | 2 ++
 include/linux/phy.h                             | 2 ++
 5 files changed, 15 insertions(+), 2 deletions(-)

base-commit: 490ed0b908d371cd9ab63fc142213e5d02d810ee

Signature · 1 line
2.26.2
#1 lore raw

PATCH v2 1/4 dt-bindings: net: mdio: add reset-post-delay-us property

Add "reset-post-delay-us" parameter to MDIO bus properties, so it's possible to add a delay after reset deassert. This is optional in case external hardware slows down release of the reset signal.

---
 Documentation/devicetree/bindings/net/mdio.yaml | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/devicetree/bindings/net/mdio.yaml +7 -0
index d6a3bf8550eb..26afb556dfae 100644
@@ -39,6 +39,13 @@ properties:
       and must therefore be appropriately determined based on all devices
       requirements (maximum value of all per-device RESET pulse widths).
 
+  reset-post-delay-us:
+    description:
+      Delay after reset deassert in microseconds. It applies to all MDIO
+      devices and it's determined by how fast all devices are ready for
+      communication. This delay happens just before e.g. Ethernet PHY
+      type ID auto detection.
+
   clock-frequency:
     description:
       Desired MDIO bus clock frequency in Hz. Values greater than IEEE 802.3
Signature · 1 line
2.26.2
maintainer Reviewed-by on v2 1/4
#2 lore raw

Re: [PATCH v2 1/4 net-next] dt-bindings: net: mdio: add reset-post-delay-us property

Quoted 6 lines · Bruno Thomsen

Add "reset-post-delay-us" parameter to MDIO bus properties, so it's possible to add a delay after reset deassert. This is optional in case external hardware slows down release of the reset signal.

Andrew

Reviewed-by on v2 1/4
#3 lore raw

Re: [PATCH v2 1/4 net-next] dt-bindings: net: mdio: add reset-post-delay-us property

In reply to Bruno Thomsen
Quoted 6 lines · Bruno Thomsen

Add "reset-post-delay-us" parameter to MDIO bus properties, so it's possible to add a delay after reset deassert. This is optional in case external hardware slows down release of the reset signal.

Quoted 9 lines
---
 Documentation/devicetree/bindings/net/mdio.yaml | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/devicetree/bindings/net/mdio.yaml +0 -0
index d6a3bf8550eb..26afb556dfae 100644

Documentation/devicetree/bindings/net/mdio.yaml properties: · line 45

Quoted 7 lines
Documentation/devicetree/bindings/net/mdio.yaml +4 -0
@@ -39,6 +39,13 @@ properties:
       and must therefore be appropriately determined based on all devices
       requirements (maximum value of all per-device RESET pulse widths).
 
+  reset-post-delay-us:
+    description:
+      Delay after reset deassert in microseconds. It applies to all MDIO
+      devices and it's determined by how fast all devices are ready for

Uber nit: it is should be spelled out, but that does not warrant a resend.

Signature · 1 line
Florian
#4 lore raw

PATCH v2 2/4 net: mdiobus: use flexible sleeping for reset-delay-us

In reply to Bruno Thomsen

MDIO bus reset pulse width is created by using udelay() and that function might not be optimal depending on device tree value. By switching to the new fsleep() helper the correct delay function is called depending on delay length, e.g. udelay(), usleep_range() or msleep().

---
 drivers/net/phy/mdio_bus.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/phy/mdio_bus.c +1 -1
index 46b33701ad4b..5df3782b05b4 100644
@@ -554,7 +554,7 @@ int __mdiobus_register(struct mii_bus *bus, struct module *owner)
 		bus->reset_gpiod = gpiod;
 
 		gpiod_set_value_cansleep(gpiod, 1);
-		udelay(bus->reset_delay_us);
+		fsleep(bus->reset_delay_us);
 		gpiod_set_value_cansleep(gpiod, 0);
 	}
 
Signature · 1 line
2.26.2
maintainer Reviewed-by on v2 2/4
#5 lore raw

Re: [PATCH v2 2/4 net-next] net: mdiobus: use flexible sleeping for reset-delay-us

Quoted 7 lines · Bruno Thomsen

MDIO bus reset pulse width is created by using udelay() and that function might not be optimal depending on device tree value. By switching to the new fsleep() helper the correct delay function is called depending on delay length, e.g. udelay(), usleep_range() or msleep().

Andrew

Reviewed-by on v2 2/4
#6 lore raw

Re: [PATCH v2 2/4 net-next] net: mdiobus: use flexible sleeping for reset-delay-us

In reply to Bruno Thomsen
Quoted 7 lines · Bruno Thomsen

MDIO bus reset pulse width is created by using udelay() and that function might not be optimal depending on device tree value. By switching to the new fsleep() helper the correct delay function is called depending on delay length, e.g. udelay(), usleep_range() or msleep().

Signature · 1 line
Florian
#7 lore raw

PATCH v2 3/4 net: mdiobus: add reset-post-delay-us handling

In reply to Bruno Thomsen

Load new "reset-post-delay-us" value from MDIO properties, and if configured to a greater then zero delay do a flexible sleeping delay after MDIO bus reset deassert. This allows devices to exit reset state before start bus communication.

---
 drivers/net/phy/mdio_bus.c | 2 ++
 drivers/of/of_mdio.c       | 2 ++
 include/linux/phy.h        | 2 ++
 3 files changed, 6 insertions(+)
drivers/net/phy/mdio_bus.c +2 -0
index 5df3782b05b4..0af20faad69d 100644
@@ -556,6 +556,8 @@ int __mdiobus_register(struct mii_bus *bus, struct module *owner)
 		gpiod_set_value_cansleep(gpiod, 1);
 		fsleep(bus->reset_delay_us);
 		gpiod_set_value_cansleep(gpiod, 0);
+		if (bus->reset_post_delay_us > 0)
+			fsleep(bus->reset_post_delay_us);
 	}
 
 	if (bus->reset) {
drivers/of/of_mdio.c +2 -0
index eb84507de28a..cb32d7ef4938 100644
@@ -268,6 +268,8 @@ int of_mdiobus_register(struct mii_bus *mdio, struct device_node *np)
 	/* Get bus level PHY reset GPIO details */
 	mdio->reset_delay_us = DEFAULT_GPIO_RESET_DELAY;
 	of_property_read_u32(np, "reset-delay-us", &mdio->reset_delay_us);
+	mdio->reset_post_delay_us = 0;
+	of_property_read_u32(np, "reset-post-delay-us", &mdio->reset_post_delay_us);
 
 	/* Register the MDIO bus */
 	rc = mdiobus_register(mdio);
include/linux/phy.h +2 -0
index 0403eb799913..3a09d2bf69ea 100644
@@ -293,6 +293,8 @@ struct mii_bus {
 
 	/* GPIO reset pulse width in microseconds */
 	int reset_delay_us;
+	/* GPIO reset deassert delay in microseconds */
+	int reset_post_delay_us;
 	/* RESET GPIO descriptor pointer */
 	struct gpio_desc *reset_gpiod;
 
Signature · 1 line
2.26.2
maintainer Reviewed-by on v2 3/4
#8 lore raw

Re: [PATCH v2 3/4 net-next] net: mdiobus: add reset-post-delay-us handling

Quoted 7 lines · Bruno Thomsen

Load new "reset-post-delay-us" value from MDIO properties, and if configured to a greater then zero delay do a flexible sleeping delay after MDIO bus reset deassert. This allows devices to exit reset state before start bus communication.

Andrew

Reviewed-by on v2 3/4
#9 lore raw

Re: [PATCH v2 3/4 net-next] net: mdiobus: add reset-post-delay-us handling

In reply to Bruno Thomsen
Quoted 7 lines · Bruno Thomsen

Load new "reset-post-delay-us" value from MDIO properties, and if configured to a greater then zero delay do a flexible sleeping delay after MDIO bus reset deassert. This allows devices to exit reset state before start bus communication.

Signature · 1 line
Florian
#10 lore raw

PATCH v2 4/4 net: mdio device: use flexible sleeping in reset function

In reply to Bruno Thomsen

MDIO device reset assert and deassert length was created by usleep_range() but that does not ensure optimal handling of all the different values from device tree properties. By switching to the new flexible sleeping helper function, fsleep(), the correct delay function is called depending on delay length, e.g. udelay(), usleep_range() or msleep().

---
 drivers/net/phy/mdio_device.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/net/phy/mdio_device.c +1 -1
index 0f625a1b1644..0837319a52d7 100644
@@ -132,7 +132,7 @@ void mdio_device_reset(struct mdio_device *mdiodev, int value)
 
 	d = value ? mdiodev->reset_assert_delay : mdiodev->reset_deassert_delay;
 	if (d)
-		usleep_range(d, d + max_t(unsigned int, d / 10, 100));
+		fsleep(d);
 }
 EXPORT_SYMBOL(mdio_device_reset);
 
Signature · 1 line
2.26.2
maintainer Reviewed-by on v2 4/4
#11 lore raw

Re: [PATCH v2 4/4 net-next] net: mdio device: use flexible sleeping in reset function

Quoted 8 lines · Bruno Thomsen

MDIO device reset assert and deassert length was created by usleep_range() but that does not ensure optimal handling of all the different values from device tree properties. By switching to the new flexible sleeping helper function, fsleep(), the correct delay function is called depending on delay length, e.g. udelay(), usleep_range() or msleep().

Andrew

Reviewed-by on v2 4/4
#12 lore raw

Re: [PATCH v2 4/4 net-next] net: mdio device: use flexible sleeping in reset function

In reply to Bruno Thomsen
Quoted 8 lines · Bruno Thomsen

MDIO device reset assert and deassert length was created by usleep_range() but that does not ensure optimal handling of all the different values from device tree properties. By switching to the new flexible sleeping helper function, fsleep(), the correct delay function is called depending on delay length, e.g. udelay(), usleep_range() or msleep().

Signature · 1 line
Florian
maintainer
#13 lore raw
In reply to Bruno Thomsen

From: Bruno Thomsen <[email protected]>
Date: Thu, 30 Jul 2020 21:57:45 +0200

Quoted 21 lines

This patch series is a result of trying to upstream a new device tree for a TQMa7D based board[1][2]. Initial this DTS used some deprecated PHY reset properties on the FEC device; NXP Ethernet MAC also known as Freescale Fast Ethernet Controller.

When switching from FEC properties[3]:
"phy-reset-gpios"
"phy-reset-duration"
"phy-reset-post-delay"

To MDIO PHY properties[4]:
"reset-gpios"
"reset-assert-us"
"reset-deassert-us"

The result was that no Ethernet PHY device was detected on boot.

This issue could be worked around by disabling PHY type ID auto- detection by using "ethernet-phy-id0022.1560" as compatible string and not "ethernet-phy-ieee802.3-c22".

Quoted 6 lines

Upstreaming a DTS with this workaround was not accepted, so I digged into the MDIO reset flow and found that it had a few missing parts compared to the deprecated FEC reset function. After some more testing and logic analyzer traces it was revealed that the failed PHY communication was due to missing initial device reset.

...

Series applied, thank you.