Skip to contentSkip to conversation

Cadence MACB/GEM support for ZynqMP SGMII

PATCH Superseded Robert Hancock 2 participants 5 messages Jan 27, 2022

Subsystems (5)

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

v3 cover Cadence MACB/GEM support for ZynqMP SGMII

Changes to allow SGMII mode to work properly in the GEM driver on the Xilinx ZynqMP platform.

Changes since v2:
-fixed missing includes in DT binding example
-fixed phy_init and phy_power_on error handling/cleanup, moved phy_power_on to open rather than probe

Changes since v1:
-changed order of controller reset and PHY init as per suggestion -switched device reset to be optional
-updated bindings doc patch for switch to YAML

Robert Hancock (3):
dt-bindings: net: cdns,macb: added generic PHY and reset mappings for
ZynqMP
net: macb: Added ZynqMP-specific initialization
arm64: dts: zynqmp: Added GEM reset definitions

 .../devicetree/bindings/net/cdns,macb.yaml    | 56 +++++++++++++++++++
 arch/arm64/boot/dts/xilinx/zynqmp.dtsi        |  8 +++
 drivers/net/ethernet/cadence/macb.h           |  5 ++
 drivers/net/ethernet/cadence/macb_main.c      | 53 +++++++++++++++++-
 4 files changed, 120 insertions(+), 2 deletions(-)
Signature · 1 line
2.31.1
#1 lore raw

PATCH v3 1/3 dt-bindings: net: cdns,macb: added generic PHY and reset mappings for ZynqMP

Updated macb DT binding documentation to reflect the phy-names, phys, resets, reset-names properties which are now used with ZynqMP GEM devices, and added a ZynqMP-specific DT example.

---
 .../devicetree/bindings/net/cdns,macb.yaml    | 56 +++++++++++++++++++
 1 file changed, 56 insertions(+)
Documentation/devicetree/bindings/net/cdns,macb.yaml +56 -0
index 8dd06db34169..6cd3d853dcba 100644
@@ -81,6 +81,25 @@ properties:
 
   phy-handle: true
 
+  phys:
+    maxItems: 1
+
+  phy-names:
+    const: sgmii-phy
+    description:
+      Required with ZynqMP SoC when in SGMII mode.
+      Should reference PS-GTR generic PHY device for this controller
+      instance. See ZynqMP example.
+
+  resets:
+    maxItems: 1
+    description:
+      Recommended with ZynqMP, specify reset control for this
+      controller instance with zynqmp-reset driver.
+
+  reset-names:
+    maxItems: 1
+
   fixed-link: true
 
   iommus:
@@ -157,3 +176,40 @@ examples:
                     reset-gpios = <&pioE 6 1>;
             };
     };
+
+  - |
+    #include <dt-bindings/clock/xlnx-zynqmp-clk.h>
+    #include <dt-bindings/power/xlnx-zynqmp-power.h>
+    #include <dt-bindings/reset/xlnx-zynqmp-resets.h>
+    #include <dt-bindings/phy/phy.h>
+
+    bus {
+            #address-cells = <2>;
+            #size-cells = <2>;
+            gem1: ethernet@ff0c0000 {
+                    compatible = "cdns,zynqmp-gem", "cdns,gem";
+                    interrupt-parent = <&gic>;
+                    interrupts = <0 59 4>, <0 59 4>;
+                    reg = <0x0 0xff0c0000 0x0 0x1000>;
+                    clocks = <&zynqmp_clk LPD_LSBUS>, <&zynqmp_clk GEM1_REF>,
+                             <&zynqmp_clk GEM1_TX>, <&zynqmp_clk GEM1_RX>,
+                             <&zynqmp_clk GEM_TSU>;
+                    clock-names = "pclk", "hclk", "tx_clk", "rx_clk", "tsu_clk";
+                    #address-cells = <1>;
+                    #size-cells = <0>;
+                    #stream-id-cells = <1>;
+                    iommus = <&smmu 0x875>;
+                    power-domains = <&zynqmp_firmware PD_ETH_1>;
+                    resets = <&zynqmp_reset ZYNQMP_RESET_GEM1>;
+                    reset-names = "gem1_rst";
+                    status = "okay";
+                    phy-mode = "sgmii";
+                    phy-names = "sgmii-phy";
+                    phys = <&psgtr 1 PHY_TYPE_SGMII 1 1>;
+                    fixed-link {
+                            speed = <1000>;
+                            full-duplex;
+                            pause;
+                    };
+            };
+    };
Signature · 1 line
2.31.1
#2 lore raw

PATCH v3 2/3 net: macb: Added ZynqMP-specific initialization

In reply to Robert Hancock

The GEM controllers on ZynqMP were missing some initialization steps which are required in some cases when using SGMII mode, which uses the PS-GTR transceivers managed by the phy-zynqmp driver.

The GEM core appears to need a hardware-level reset in order to work properly in SGMII mode in cases where the GT reference clock was not present at initial power-on. This can be done using a reset mapped to the zynqmp-reset driver in the device tree.

Also, when in SGMII mode, the GEM driver needs to ensure the PHY is initialized and powered on.

---
 drivers/net/ethernet/cadence/macb.h      |  5 +++
 drivers/net/ethernet/cadence/macb_main.c | 53 +++++++++++++++++++++++-
 2 files changed, 56 insertions(+), 2 deletions(-)
drivers/net/ethernet/cadence/macb.h +5 -0
index 9ddbee7de72b..584336b7cdaf 100644
@@ -12,6 +12,7 @@
 #include <linux/ptp_clock_kernel.h>
 #include <linux/net_tstamp.h>
 #include <linux/interrupt.h>
+#include <linux/phy/phy.h>
 
 #if defined(CONFIG_ARCH_DMA_ADDR_T_64BIT) || defined(CONFIG_MACB_USE_HWSTAMP)
 #define MACB_EXT_DESC
@@ -1291,6 +1292,9 @@ struct macb {
 	u32			wol;
 
 	struct macb_ptp_info	*ptp_info;	/* macb-ptp interface */
+
+	struct phy		*sgmii_phy;     /* for ZynqMP SGMII mode */
+
 #ifdef MACB_EXT_DESC
 	uint8_t hw_dma_cap;
 #endif
@@ -1315,6 +1319,7 @@ struct macb {
 
 	struct macb_pm_data pm_data;
 	const struct macb_usrio_config *usrio;
+
 };
 
 #ifdef CONFIG_MACB_USE_HWSTAMP
drivers/net/ethernet/cadence/macb_main.c +51 -2

102 lines not on this page · raw message

Signature · 1 line
2.31.1
#3 lore raw

Re: [PATCH net-next v3 2/3] net: macb: Added ZynqMP-specific initialization

Hi Robert,

Quoted 33 lines · Robert Hancock

EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe

The GEM controllers on ZynqMP were missing some initialization steps which are required in some cases when using SGMII mode, which uses the PS-GTR transceivers managed by the phy-zynqmp driver.

The GEM core appears to need a hardware-level reset in order to work properly in SGMII mode in cases where the GT reference clock was not present at initial power-on. This can be done using a reset mapped to the zynqmp-reset driver in the device tree.

Also, when in SGMII mode, the GEM driver needs to ensure the PHY is initialized and powered on.

---
 drivers/net/ethernet/cadence/macb.h      |  5 +++
 drivers/net/ethernet/cadence/macb_main.c | 53 +++++++++++++++++++++++-
 2 files changed, 56 insertions(+), 2 deletions(-)
drivers/net/ethernet/cadence/macb.h +1 -0
index 9ddbee7de72b..584336b7cdaf 100644
@@ -12,6 +12,7 @@
 #include <linux/ptp_clock_kernel.h>
 #include <linux/net_tstamp.h>
 #include <linux/interrupt.h>
+#include <linux/phy/phy.h>
 
 #if defined(CONFIG_ARCH_DMA_ADDR_T_64BIT) || defined(CONFIG_MACB_USE_HWSTAMP)
 #define MACB_EXT_DESC

drivers/net/ethernet/cadence/macb.h struct macb { · line 1296

Quoted 5 lines
drivers/net/ethernet/cadence/macb.h +2 -0
@@ -1291,6 +1292,9 @@ struct macb {
        u32                     wol;
 
        struct macb_ptp_info    *ptp_info;      /* macb-ptp interface */
+
+       struct phy              *sgmii_phy;     /* for ZynqMP SGMII mode */

You have spaces b/w "*sgmii_phy;" and "/* for ZynqMP SGMII mode */"

drivers/net/ethernet/cadence/macb.h struct macb { · line 1322

Quoted 9 lines
drivers/net/ethernet/cadence/macb.h +2 -0
+
 #ifdef MACB_EXT_DESC
        uint8_t hw_dma_cap;
 #endif
@@ -1315,6 +1319,7 @@ struct macb {
 
        struct macb_pm_data pm_data;
        const struct macb_usrio_config *usrio;
+

You have an extra line here.

Quoted 18 lines
drivers/net/ethernet/cadence/macb.h +0 -0
 };
 
 #ifdef CONFIG_MACB_USE_HWSTAMP
drivers/net/ethernet/cadence/macb_main.c +2 -0
index a363da928e8b..4787196e0980 100644
@@ -34,7 +34,9 @@
 #include <linux/udp.h>
 #include <linux/tcp.h>
 #include <linux/iopoll.h>
+#include <linux/phy/phy.h>
 #include <linux/pm_runtime.h>
+#include <linux/reset.h>
 #include "macb.h"
 
 /* This structure is only used for MACB on SiFive FU540 devices */

drivers/net/ethernet/cadence/macb_main.c static int macb_open(struct net_device *dev) · line 2750

Quoted 10 lines
drivers/net/ethernet/cadence/macb_main.c +4 -0
@@ -2739,6 +2741,10 @@ static int macb_open(struct net_device *dev)
 
        macb_init_hw(bp);
 
+       err = phy_power_on(bp->sgmii_phy);
+       if (err)
+               goto reset_hw;
+
        err = macb_phylink_connect(bp);
        if (err)
                goto reset_hw;

This one should phy_power_off() before resetting the hardware.

Quoted 34 lines
drivers/net/ethernet/cadence/macb_main.c +23 -0
@@ -2775,6 +2781,8 @@ static int macb_close(struct net_device *dev)
        phylink_stop(bp->phylink);
        phylink_disconnect_phy(bp->phylink);
 
+       phy_power_off(bp->sgmii_phy);
+
        spin_lock_irqsave(&bp->lock, flags);
        macb_reset_hw(bp);
        netif_carrier_off(dev);
@@ -4544,13 +4552,50 @@ static const struct macb_config np4_config = {
        .usrio = &macb_default_usrio,
 };
 
+static int zynqmp_init(struct platform_device *pdev)
+{
+       struct net_device *dev = platform_get_drvdata(pdev);
+       struct macb *bp = netdev_priv(dev);
+       int ret;
+
+       if (bp->phy_interface == PHY_INTERFACE_MODE_SGMII) {
+               /* Ensure PS-GTR PHY device used in SGMII mode is ready */
+               bp->sgmii_phy = devm_phy_get(&pdev->dev, "sgmii-phy");
+
+               if (IS_ERR(bp->sgmii_phy)) {
+                       ret = PTR_ERR(bp->sgmii_phy);
+                       dev_err_probe(&pdev->dev, ret,
+                                     "failed to get PS-GTR PHY\n");
+                       return ret;
+               }
+
+               ret = phy_init(bp->sgmii_phy);
+               if (ret) {
+                       dev_err(&pdev->dev, "failed to init PS-GTR PHY: %d\n",
+                               ret);

drivers/net/ethernet/cadence/macb_main.c static const struct macb_config np4_config = { · line 4585

Quoted 10 lines
drivers/net/ethernet/cadence/macb_main.c +10 -0
+                       return ret;
+               }
+       }
+
+       /* Fully reset GEM controller at hardware level using zynqmp-reset driver,
+        * if mapped in device tree.
+        */
+       ret = device_reset_optional(&pdev->dev);
+       if (ret) {
+               dev_err_probe(&pdev->dev, ret, "failed to reset controller");

Before doing return you should call phy_exit();

drivers/net/ethernet/cadence/macb_main.c static const struct macb_config np4_config = { · line 4589

Quoted 4 lines
drivers/net/ethernet/cadence/macb_main.c +4 -0
+               return ret;
+       }
+
+       return macb_init(pdev);

Same here, check return code and call phy_exit() if needed. In case init() call in macb_probe() fails it will jump to err_out_free_netdev and will miss calling phy_exit(). And is better to free resource in the same function they were allocated.

Quoted 43 lines
drivers/net/ethernet/cadence/macb_main.c +8 -3
+}
+
 static const struct macb_config zynqmp_config = {
        .caps = MACB_CAPS_GIGABIT_MODE_AVAILABLE |
                        MACB_CAPS_JUMBO |
                        MACB_CAPS_GEM_HAS_PTP | MACB_CAPS_BD_RD_PREFETCH,
        .dma_burst_length = 16,
        .clk_init = macb_clk_init,
-       .init = macb_init,
+       .init = zynqmp_init,
        .jumbo_max_len = 10240,
        .usrio = &macb_default_usrio,
 };
@@ -4767,7 +4812,7 @@ static int macb_probe(struct platform_device *pdev)
 
        err = macb_mii_init(bp);
        if (err)
-               goto err_out_free_netdev;
+               goto err_out_phy_exit;
 
        netif_carrier_off(dev);
 
@@ -4792,6 +4837,9 @@ static int macb_probe(struct platform_device *pdev)
        mdiobus_unregister(bp->mii_bus);
        mdiobus_free(bp->mii_bus);
 
+err_out_phy_exit:
+       phy_exit(bp->sgmii_phy);
+
 err_out_free_netdev:
        free_netdev(dev);
 
@@ -4813,6 +4861,7 @@ static int macb_remove(struct platform_device *pdev)
 
        if (dev) {
                bp = netdev_priv(dev);
+               phy_exit(bp->sgmii_phy);
                mdiobus_unregister(bp->mii_bus);
                mdiobus_free(bp->mii_bus);
 
--

2.31.1

#4 lore raw

PATCH v3 3/3 arm64: dts: zynqmp: Added GEM reset definitions

In reply to Robert Hancock

The Cadence GEM/MACB driver now utilizes the platform-level reset on the ZynqMP platform. Add reset definitions to the ZynqMP platform device tree to allow this to be used.

---
 arch/arm64/boot/dts/xilinx/zynqmp.dtsi | 8 ++++++++
 1 file changed, 8 insertions(+)
arch/arm64/boot/dts/xilinx/zynqmp.dtsi +8 -0
index 74e66443e4ce..9bec3ba20c69 100644
@@ -512,6 +512,8 @@ gem0: ethernet@ff0b0000 {
 			#stream-id-cells = <1>;
 			iommus = <&smmu 0x874>;
 			power-domains = <&zynqmp_firmware PD_ETH_0>;
+			resets = <&zynqmp_reset ZYNQMP_RESET_GEM0>;
+			reset-names = "gem0_rst";
 		};
 
 		gem1: ethernet@ff0c0000 {
@@ -526,6 +528,8 @@ gem1: ethernet@ff0c0000 {
 			#stream-id-cells = <1>;
 			iommus = <&smmu 0x875>;
 			power-domains = <&zynqmp_firmware PD_ETH_1>;
+			resets = <&zynqmp_reset ZYNQMP_RESET_GEM1>;
+			reset-names = "gem1_rst";
 		};
 
 		gem2: ethernet@ff0d0000 {
@@ -540,6 +544,8 @@ gem2: ethernet@ff0d0000 {
 			#stream-id-cells = <1>;
 			iommus = <&smmu 0x876>;
 			power-domains = <&zynqmp_firmware PD_ETH_2>;
+			resets = <&zynqmp_reset ZYNQMP_RESET_GEM2>;
+			reset-names = "gem2_rst";
 		};
 
 		gem3: ethernet@ff0e0000 {
@@ -554,6 +560,8 @@ gem3: ethernet@ff0e0000 {
 			#stream-id-cells = <1>;
 			iommus = <&smmu 0x877>;
 			power-domains = <&zynqmp_firmware PD_ETH_3>;
+			resets = <&zynqmp_reset ZYNQMP_RESET_GEM3>;
+			reset-names = "gem3_rst";
 		};
 
 		gpio: gpio@ff0a0000 {
Signature · 1 line
2.31.1