Fix broken link with TH1520 GMAC when linkspeed changes
Subsystems (7)
v3 cover Fix broken link with TH1520 GMAC when linkspeed changes
It's noted that on TH1520 SoC, the GMAC's link becomes broken after the link speed is changed (for example, running ethtool -s eth0 speed 100 on the peer when negotiated to 1Gbps), but the GMAC could function normally if the speed is brought back to the initial.
Just like many other SoCs utilizing STMMAC IP, we need to adjust the TX clock supplying TH1520's GMAC through some SoC-specific glue registers when linkspeed changes. But it's found that after the full kernel startup, reading from them results in garbage and writing to them makes no effect, which is the cause of broken link.
Further testing shows perisys-apb4-hclk must be ungated for normal access to Th1520 GMAC APB glue registers, which is neither described in dt-binding nor acquired by the driver.
This series expands the dt-binding of TH1520's GMAC to allow an extra "APB glue registers interface clock", instructs the driver to acquire and enable the clock, and finally supplies CLK_PERISYS_APB4_HCLK for TH1520's GMACs in SoC devicetree.
Changed from v2
- dt-binding: Drop the Tested-by tag
- driver
- Improve the commit message to mention the dt-compatibility problem
- Add a comment about the dt-compatibility problem
- Emit a warning when failed to get APB clock
- Stop using the optional clock-getting API since it doesn't help much when we need to handle the missing case.
- Collect review tags
- Link to v2: https://lore.kernel.org/netdev/[email protected]/
Changed from v1
- Make apb clock essential in dt-binding
- Collect review tags
- Link to v1: https://lore.kernel.org/all/[email protected]/
Yao Zi (3):
dt-bindings: net: thead,th1520-gmac: Describe APB interface clock
net: stmmac: thead: Get and enable APB clock on initialization
riscv: dts: thead: Add APB clocks for TH1520 GMACs
.../devicetree/bindings/net/thead,th1520-gmac.yaml | 6 ++++-- arch/riscv/boot/dts/thead/th1520.dtsi | 10 ++++++---- drivers/net/ethernet/stmicro/stmmac/dwmac-thead.c | 14 ++++++++++++++ 3 files changed, 24 insertions(+), 6 deletions(-)
Signature · 1 line
2.50.1
PATCH v3 1/3 dt-bindings: net: thead,th1520-gmac: Describe APB interface clock
Besides ones for GMAC core and peripheral registers, the TH1520 GMAC requires one more clock for configuring APB glue registers. Describe it in the binding.
--- .../devicetree/bindings/net/thead,th1520-gmac.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
Documentation/devicetree/bindings/net/thead,th1520-gmac.yaml +4 -2
@@ -62,11 +62,13 @@ properties: items: - description: GMAC main clock - description: Peripheral registers interface clock + - description: APB glue registers interface clock clock-names: items: - const: stmmaceth - const: pclk + - const: apb interrupts: items:
@@ -88,8 +90,8 @@ examples: compatible = "thead,th1520-gmac", "snps,dwmac-3.70a"; reg = <0xe7070000 0x2000>, <0xec003000 0x1000>; reg-names = "dwmac", "apb"; - clocks = <&clk 1>, <&clk 2>; - clock-names = "stmmaceth", "pclk"; + clocks = <&clk 1>, <&clk 2>, <&clk 3>; + clock-names = "stmmaceth", "pclk", "apb"; interrupts = <66>; interrupt-names = "macirq"; phy-mode = "rgmii-id";
Signature · 1 line
2.50.1
PATCH v3 2/3 net: stmmac: thead: Get and enable APB clock on initialization
In reply to Yao ZiIt's necessary to adjust the MAC TX clock when the linkspeed changes, but it's noted such adjustment always fails on TH1520 SoC, and reading back from APB glue registers that control clock generation results in garbage, causing broken link.
With some testing, it's found a clock must be ungated for access to APB glue registers. Without any consumer, the clock is automatically disabled during late kernel startup. Let's get and enable it if it's described in devicetree.
For backward compatibility with older devicetrees, probing won't fail if the APB clock isn't found. In this case, we emit a warning since the link will break if the speed changes.
--- drivers/net/ethernet/stmicro/stmmac/dwmac-thead.c | 14 ++++++++++++++ 1 file changed, 14 insertions(+)
drivers/net/ethernet/stmicro/stmmac/dwmac-thead.c +14 -0
@@ -211,6 +211,7 @@ static int thead_dwmac_probe(struct platform_device *pdev)struct stmmac_resources stmmac_res;struct plat_stmmacenet_data *plat;struct thead_dwmac *dwmac; +struct clk *apb_clk;void __iomem *apb;int ret;
@@ -224,6 +225,19 @@ static int thead_dwmac_probe(struct platform_device *pdev)return dev_err_probe (&pdev->dev,PTR_ERR (plat),"dt configuration failed\n" ); +/* +* The APB clock is essential for accessing glue registers. However, +* old devicetrees don't describe it correctly. We continue to probe +* and emit a warning if it isn't present. +*/ + apb_clk =devm_clk_get_enabled (&pdev->dev,"apb" ); +if (PTR_ERR (apb_clk) == -ENOENT ) +dev_warn (&pdev->dev, +"cannot get apb clock, link may break after speed changes\n" ); +else if (IS_ERR (apb_clk)) +return dev_err_probe (&pdev->dev,PTR_ERR (apb_clk), +"failed to get apb clock\n" ); + dwmac =devm_kzalloc (&pdev->dev,sizeof (*dwmac),GFP_KERNEL );if (!dwmac)return -ENOMEM ;
Signature · 1 line
2.50.1
Re: [PATCH net v3 2/3] net: stmmac: thead: Get and enable APB clock on initialization
Quoted 56 lines · Yao Zi
It's necessary to adjust the MAC TX clock when the linkspeed changes, but it's noted such adjustment always fails on TH1520 SoC, and reading back from APB glue registers that control clock generation results in garbage, causing broken link.
With some testing, it's found a clock must be ungated for access to APB glue registers. Without any consumer, the clock is automatically disabled during late kernel startup. Let's get and enable it if it's described in devicetree.
For backward compatibility with older devicetrees, probing won't fail if the APB clock isn't found. In this case, we emit a warning since the link will break if the speed changes.
Fixes 33a1a01e3afa ("net: stmmac: Add glue layer for T-HEAD TH1520 SoC")Signed-off-by Yao Zi <[email protected]>Tested-by Drew Fustini <[email protected]>--- drivers/net/ethernet/stmicro/stmmac/dwmac-thead.c | 14 ++++++++++++++ 1 file changed, 14 insertions(+)drivers/net/ethernet/stmicro/stmmac/dwmac-thead.c +14
-0@@ -211,6 +211,7 @@ static int thead_dwmac_probe(struct platform_device *pdev)struct stmmac_resources stmmac_res;struct plat_stmmacenet_data *plat;struct thead_dwmac *dwmac; +struct clk *apb_clk;void __iomem *apb;int ret;@@ -224,6 +225,19 @@ static int thead_dwmac_probe(struct platform_device *pdev)return dev_err_probe (&pdev->dev,PTR_ERR (plat),"dt configuration failed\n" ); +/* +* The APB clock is essential for accessing glue registers. However, +* old devicetrees don't describe it correctly. We continue to probe +* and emit a warning if it isn't present. +*/ + apb_clk =devm_clk_get_enabled (&pdev->dev,"apb" ); +if (PTR_ERR (apb_clk) == -ENOENT ) +dev_warn (&pdev->dev, +"cannot get apb clock, link may break after speed changes\n" ); +else if (IS_ERR (apb_clk)) +return dev_err_probe (&pdev->dev,PTR_ERR (apb_clk), +"failed to get apb clock\n" ); + dwmac =devm_kzalloc (&pdev->dev,sizeof (*dwmac),GFP_KERNEL );if (!dwmac)return -ENOMEM ;Signature · 1 line
2.50.1
Thanks for improving the commit description and adding the warning.
Drew
PATCH v3 3/3 riscv: dts: thead: Add APB clocks for TH1520 GMACs
In reply to Yao ZiDescribe perisys-apb4-hclk as the APB clock for TH1520 SoC, which is essential for accessing GMAC glue registers.
--- arch/riscv/boot/dts/thead/th1520.dtsi | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)
arch/riscv/boot/dts/thead/th1520.dtsi +6 -4
@@ -297,8 +297,9 @@ gmac1: ethernet@ffe7060000 { reg-names = "dwmac", "apb"; interrupts = <67 IRQ_TYPE_LEVEL_HIGH>; interrupt-names = "macirq"; - clocks = <&clk CLK_GMAC_AXI>, <&clk CLK_GMAC1>; - clock-names = "stmmaceth", "pclk"; + clocks = <&clk CLK_GMAC_AXI>, <&clk CLK_GMAC1>, + <&clk CLK_PERISYS_APB4_HCLK>; + clock-names = "stmmaceth", "pclk", "apb"; snps,pbl = <32>; snps,fixed-burst; snps,multicast-filter-bins = <64>;
@@ -319,8 +320,9 @@ gmac0: ethernet@ffe7070000 { reg-names = "dwmac", "apb"; interrupts = <66 IRQ_TYPE_LEVEL_HIGH>; interrupt-names = "macirq"; - clocks = <&clk CLK_GMAC_AXI>, <&clk CLK_GMAC0>; - clock-names = "stmmaceth", "pclk"; + clocks = <&clk CLK_GMAC_AXI>, <&clk CLK_GMAC0>, + <&clk CLK_PERISYS_APB4_HCLK>; + clock-names = "stmmaceth", "pclk", "apb"; snps,pbl = <32>; snps,fixed-burst; snps,multicast-filter-bins = <64>;
Signature · 1 line
2.50.1
This series was applied to netdev/net.git (main) by Paolo Abeni <[email protected]>:
Hello:
This series was applied to netdev/net.git (main)
by Paolo Abeni <[email protected]>:
Quoted 5 lines · On Fri, 8 Aug 2025 09:36:53 +0000 you wrote:
It's noted that on TH1520 SoC, the GMAC's link becomes broken after the link speed is changed (for example, running ethtool -s eth0 speed 100 on the peer when negotiated to 1Gbps), but the GMAC could function normally if the speed is brought back to the initial.
Quoted 7 lines
Just like many other SoCs utilizing STMMAC IP, we need to adjust the TX clock supplying TH1520's GMAC through some SoC-specific glue registers when linkspeed changes. But it's found that after the full kernel startup, reading from them results in garbage and writing to them makes no effect, which is the cause of broken link.
[...]
Here is the summary with links:
- [net,v3,1/3] dt-bindings: net: thead,th1520-gmac: Describe APB interface clock
https://git.kernel.org/netdev/net/c/c8a9a619c072 - [net,v3,2/3] net: stmmac: thead: Get and enable APB clock on initialization https://git.kernel.org/netdev/net/c/4cc339ce482b - [net,v3,3/3] riscv: dts: thead: Add APB clocks for TH1520 GMACs https://git.kernel.org/netdev/net/c/a7f75e2883c4
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html