Skip to contentSkip to conversation

RGMII Internal delay common property

PATCH Superseded Dan Murphy 4 participants 12 messages Jun 4, 2020 – Jun 15, 2020

Subsystems (4)

v6 of 11 Superseded Latest is v11 →

lore
Share & tools
lore

Dan Murphy

author
#0 lore raw

v6 cover RGMII Internal delay common property

Hello

The RGMII internal delay is a common setting found in most RGMII capable PHY devices. It was found that many vendor specific device tree properties exist to do the same function. This creates a common property to be used for PHY's that have tunable internal delays for the Rx and Tx paths.

Dan Murphy (4):
dt-bindings: net: Add tx and rx internal delays
net: phy: Add a helper to return the index for of the internal delay
dt-bindings: net: Add RGMII internal delay for DP83869
net: dp83869: Add RGMII internal delay configuration

 .../devicetree/bindings/net/ethernet-phy.yaml | 13 ++++
 .../devicetree/bindings/net/ti,dp83869.yaml   | 16 ++++-
 drivers/net/phy/dp83869.c                     | 53 ++++++++++++++-
 drivers/net/phy/phy_device.c                  | 68 +++++++++++++++++++
 include/linux/phy.h                           |  4 ++
 5 files changed, 150 insertions(+), 4 deletions(-)
Signature · 1 line
2.26.2
author
#1 lore raw

PATCH v6 1/4 dt-bindings: net: Add tx and rx internal delays

tx-internal-delays and rx-internal-delays are a common setting for RGMII capable devices.

These properties are used when the phy-mode or phy-controller is set to rgmii-id, rgmii-rxid or rgmii-txid. These modes indicate to the controller that the PHY will add the internal delay for the connection.

---
 .../devicetree/bindings/net/ethernet-phy.yaml       | 13 +++++++++++++
 1 file changed, 13 insertions(+)
Documentation/devicetree/bindings/net/ethernet-phy.yaml +13 -0
index 9b1f1147ca36..edd0245d132b 100644
@@ -162,6 +162,19 @@ properties:
     description:
       Specifies a reference to a node representing a SFP cage.
 
+
+  rx-internal-delay-ps:
+    $ref: /schemas/types.yaml#definitions/uint32
+    description: |
+      RGMII Receive PHY Clock Delay defined in pico seconds.  This is used for
+      PHY's that have configurable RX internal delays.
+
+  tx-internal-delay-ps:
+    $ref: /schemas/types.yaml#definitions/uint32
+    description: |
+      RGMII Transmit PHY Clock Delay defined in pico seconds.  This is used for
+      PHY's that have configurable TX internal delays.
+
 required:
   - reg
 
Signature · 1 line
2.26.2
maintainer
#2 lore raw

Re: [PATCH net-next v6 1/4] dt-bindings: net: Add tx and rx internal delays

Quoted 17 lines · Dan Murphy

tx-internal-delays and rx-internal-delays are a common setting for RGMII capable devices.

These properties are used when the phy-mode or phy-controller is set to rgmii-id, rgmii-rxid or rgmii-txid. These modes indicate to the controller that the PHY will add the internal delay for the connection.

---
 .../devicetree/bindings/net/ethernet-phy.yaml       | 13 +++++++++++++
 1 file changed, 13 insertions(+)
Documentation/devicetree/bindings/net/ethernet-phy.yaml +0 -0
index 9b1f1147ca36..edd0245d132b 100644

Documentation/devicetree/bindings/net/ethernet-phy.yaml properties: · line 167

Quoted 6 lines
Documentation/devicetree/bindings/net/ethernet-phy.yaml +3 -0
@@ -162,6 +162,19 @@ properties:
     description:
       Specifies a reference to a node representing a SFP cage.
 
+
+  rx-internal-delay-ps:
+    $ref: /schemas/types.yaml#definitions/uint32

Standard units already have a type, so you can drop this.

Quoted 16 lines
Documentation/devicetree/bindings/net/ethernet-phy.yaml +10 -0
+    description: |
+      RGMII Receive PHY Clock Delay defined in pico seconds.  This is used for
+      PHY's that have configurable RX internal delays.
+
+  tx-internal-delay-ps:
+    $ref: /schemas/types.yaml#definitions/uint32
+    description: |
+      RGMII Transmit PHY Clock Delay defined in pico seconds.  This is used for
+      PHY's that have configurable TX internal delays.
+
 required:
   - reg
 
Signature · 1 line
2.26.2
author
#3 lore raw

PATCH v6 2/4 net: phy: Add a helper to return the index for of the internal delay

In reply to Dan Murphy

Add a helper function that will return the index in the array for the passed in internal delay value. The helper requires the array, size and delay value.

The helper will then return the index for the exact match or return the index for the index to the closest smaller value.

---
 drivers/net/phy/phy_device.c | 68 ++++++++++++++++++++++++++++++++++++
 include/linux/phy.h          |  4 +++
 2 files changed, 72 insertions(+)
drivers/net/phy/phy_device.c +68 -0
index 04946de74fa0..611d4e68e3c6 100644
@@ -31,6 +31,7 @@
 #include <linux/mdio.h>
 #include <linux/io.h>
 #include <linux/uaccess.h>
+#include <linux/property.h>
 
 MODULE_DESCRIPTION("PHY library");
 MODULE_AUTHOR("Andy Fleming");
@@ -2657,6 +2658,73 @@ void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause)
 }
 EXPORT_SYMBOL(phy_get_pause);
 
+/**
+ * phy_get_delay_index - returns the index of the internal delay
+ * @phydev: phy_device struct
+ * @dev: pointer to the devices device struct
+ * @delay_values: array of delays the PHY supports
+ * @size: the size of the delay array
+ * @is_rx: boolean to indicate to get the rx internal delay
+ *
+ * Returns the index within the array of internal delay passed in.
+ * Or if size == 0 then the delay read from the firmware is returned.
+ * The array must be in ascending order.
+ * Return errno if the delay is invalid or cannot be found.
+ */
+s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
+			   const int *delay_values, int size, bool is_rx)
+{
+	int ret;
+	int i;
+	s32 delay;
+
+	if (is_rx)
+		ret = device_property_read_u32(dev, "rx-internal-delay-ps",
+					       &delay);
+	else
+		ret = device_property_read_u32(dev, "tx-internal-delay-ps",
+					       &delay);
+	if (ret) {
+		phydev_err(phydev, "internal delay not defined\n");
+		return -EINVAL;
+	}
+
+	if (delay < 0)
+		return -EINVAL;
+
+	if (size <= 0)
+		return delay;
+
+	if (delay < delay_values[0] || delay > delay_values[size - 1]) {
+		phydev_err(phydev, "Delay %d is out of range\n", delay);
+		return -EINVAL;
+	}
+
+	if (delay == delay_values[0])
+		return 0;
+
+	for (i = 1; i < size; i++) {
+		if (delay == delay_values[i])
+			return i;
+
+		/* Find an approximate index by looking up the table */
+		if (delay > delay_values[i - 1] &&
+		    delay < delay_values[i]) {
+			if (delay - delay_values[i - 1] <
+			    delay_values[i] - delay)
+				return i - 1;
+			else
+				return i;
+		}
+	}
+
+	phydev_err(phydev, "error finding internal delay index for %d\n",
+		   delay);
+
+	return -EINVAL;
+}
+EXPORT_SYMBOL(phy_get_internal_delay);
+
 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
 {
 	return phydrv->config_intr && phydrv->ack_interrupt;
include/linux/phy.h +4 -0
index 8c05d0fb5c00..917bfd422e06 100644
@@ -1430,6 +1430,10 @@ void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx);
 bool phy_validate_pause(struct phy_device *phydev,
 			struct ethtool_pauseparam *pp);
 void phy_get_pause(struct phy_device *phydev, bool *tx_pause, bool *rx_pause);
+
+s32 phy_get_internal_delay(struct phy_device *phydev, struct device *dev,
+			   const int *delay_values, int size, bool is_rx);
+
 void phy_resolve_pause(unsigned long *local_adv, unsigned long *partner_adv,
 		       bool *tx_pause, bool *rx_pause);
 
Signature · 1 line
2.26.2
author
#4 lore raw

PATCH v6 3/4 dt-bindings: net: Add RGMII internal delay for DP83869

In reply to Dan Murphy

Add the internal delay values into the header and update the binding with the internal delay properties.

---
 .../devicetree/bindings/net/ti,dp83869.yaml      | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)
Documentation/devicetree/bindings/net/ti,dp83869.yaml +15 -1
index 5b69ef03bbf7..71e90a3e4652 100644
@@ -8,7 +8,7 @@ $schema: "http://devicetree.org/meta-schemas/core.yaml#"
 title: TI DP83869 ethernet PHY
 
 allOf:
-  - $ref: "ethernet-controller.yaml#"
+  - $ref: "ethernet-phy.yaml#"
 
 maintainers:
   - Dan Murphy <[email protected]>
@@ -64,6 +64,18 @@ properties:
        Operational mode for the PHY.  If this is not set then the operational
        mode is set by the straps. see dt-bindings/net/ti-dp83869.h for values
 
+  rx-internal-delay-ps:
+    description: Delay is in pico seconds
+    enum: [ 250, 500, 750, 1000, 1250, 1500, 1750, 2000, 2250, 2500, 2750, 3000,
+            3250, 3500, 3750, 4000 ]
+    default: 2000
+
+  tx-internal-delay-ps:
+    description: Delay is in pico seconds
+    enum: [ 250, 500, 750, 1000, 1250, 1500, 1750, 2000, 2250, 2500, 2750, 3000,
+            3250, 3500, 3750, 4000 ]
+    default: 2000
+
 required:
   - reg
 
@@ -80,5 +92,7 @@ examples:
         ti,op-mode = <DP83869_RGMII_COPPER_ETHERNET>;
         ti,max-output-impedance = "true";
         ti,clk-output-sel = <DP83869_CLK_O_SEL_CHN_A_RCLK>;
+        rx-internal-delay-ps = <2000>;
+        tx-internal-delay-ps = <2000>;
       };
     };
Signature · 1 line
2.26.2
maintainer Reviewed-by on v6 3/4
#5 lore raw

Re: [PATCH net-next v6 3/4] dt-bindings: net: Add RGMII internal delay for DP83869

Quoted 8 lines · Dan Murphy

Add the internal delay values into the header and update the binding with the internal delay properties.

---
 .../devicetree/bindings/net/ti,dp83869.yaml      | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)
author
#6 lore raw

PATCH v6 4/4 net: dp83869: Add RGMII internal delay configuration

In reply to Dan Murphy

Add RGMII internal delay configuration for Rx and Tx.

---
 drivers/net/phy/dp83869.c | 53 ++++++++++++++++++++++++++++++++++++---
 1 file changed, 50 insertions(+), 3 deletions(-)
drivers/net/phy/dp83869.c +50 -3
index cfb22a21a2e6..801341edbe31 100644
@@ -64,6 +64,10 @@
 #define DP83869_RGMII_TX_CLK_DELAY_EN		BIT(1)
 #define DP83869_RGMII_RX_CLK_DELAY_EN		BIT(0)
 
+/* RGMIIDCTL */
+#define DP83869_RGMII_CLK_DELAY_SHIFT		4
+#define DP83869_CLK_DELAY_DEF			7
+
 /* STRAP_STS1 bits */
 #define DP83869_STRAP_OP_MODE_MASK		GENMASK(2, 0)
 #define DP83869_STRAP_STS1_RESERVED		BIT(11)
@@ -78,9 +82,6 @@
 #define DP83869_PHYCR_FIFO_DEPTH_MASK	GENMASK(15, 12)
 #define DP83869_PHYCR_RESERVED_MASK	BIT(11)
 
-/* RGMIIDCTL bits */
-#define DP83869_RGMII_TX_CLK_DELAY_SHIFT	4
-
 /* IO_MUX_CFG bits */
 #define DP83869_IO_MUX_CFG_IO_IMPEDANCE_CTRL	0x1f
 
@@ -99,6 +100,10 @@
 #define DP83869_OP_MODE_MII			BIT(5)
 #define DP83869_SGMII_RGMII_BRIDGE		BIT(6)
 
+static const int dp83869_internal_delay[] = {250, 500, 750, 1000, 1250, 1500,
+					     1750, 2000, 2250, 2500, 2750, 3000,
+					     3250, 3500, 3750, 4000};
+
 enum {
 	DP83869_PORT_MIRRORING_KEEP,
 	DP83869_PORT_MIRRORING_EN,
@@ -108,6 +113,8 @@ enum {
 struct dp83869_private {
 	int tx_fifo_depth;
 	int rx_fifo_depth;
+	s32 rx_id_delay;
+	s32 tx_id_delay;
 	int io_impedance;
 	int port_mirroring;
 	bool rxctrl_strap_quirk;
@@ -182,6 +189,7 @@ static int dp83869_of_init(struct phy_device *phydev)
 	struct dp83869_private *dp83869 = phydev->priv;
 	struct device *dev = &phydev->mdio.dev;
 	struct device_node *of_node = dev->of_node;
+	int delay_size = ARRAY_SIZE(dp83869_internal_delay);
 	int ret;
 
 	if (!of_node)
@@ -232,6 +240,20 @@ static int dp83869_of_init(struct phy_device *phydev)
 				 &dp83869->tx_fifo_depth))
 		dp83869->tx_fifo_depth = DP83869_PHYCR_FIFO_DEPTH_4_B_NIB;
 
+	dp83869->rx_id_delay = phy_get_internal_delay(phydev, dev,
+						     &dp83869_internal_delay[0],
+						      delay_size, true);
+	if (dp83869->rx_id_delay < 0)
+		dp83869->rx_id_delay =
+				dp83869_internal_delay[DP83869_CLK_DELAY_DEF];
+
+	dp83869->tx_id_delay = phy_get_internal_delay(phydev, dev,
+						     &dp83869_internal_delay[0],
+						      delay_size, false);
+	if (dp83869->tx_id_delay < 0)
+		dp83869->tx_id_delay =
+				dp83869_internal_delay[DP83869_CLK_DELAY_DEF];
+
 	return ret;
 }
 #else
@@ -394,6 +416,31 @@ static int dp83869_config_init(struct phy_device *phydev)
 				     dp83869->clk_output_sel <<
 				     DP83869_IO_MUX_CFG_CLK_O_SEL_SHIFT);
 
+	if (phy_interface_is_rgmii(phydev)) {
+		ret = phy_write_mmd(phydev, DP83869_DEVADDR, DP83869_RGMIIDCTL,
+				    dp83869->rx_id_delay |
+			dp83869->tx_id_delay << DP83869_RGMII_CLK_DELAY_SHIFT);
+		if (ret)
+			return ret;
+
+		val = phy_read_mmd(phydev, DP83869_DEVADDR, DP83869_RGMIICTL);
+		val &= ~(DP83869_RGMII_TX_CLK_DELAY_EN |
+			 DP83869_RGMII_RX_CLK_DELAY_EN);
+
+		if (phydev->interface == PHY_INTERFACE_MODE_RGMII_ID)
+			val |= (DP83869_RGMII_TX_CLK_DELAY_EN |
+				DP83869_RGMII_RX_CLK_DELAY_EN);
+
+		if (phydev->interface == PHY_INTERFACE_MODE_RGMII_TXID)
+			val |= DP83869_RGMII_TX_CLK_DELAY_EN;
+
+		if (phydev->interface == PHY_INTERFACE_MODE_RGMII_RXID)
+			val |= DP83869_RGMII_RX_CLK_DELAY_EN;
+
+		ret = phy_write_mmd(phydev, DP83869_DEVADDR, DP83869_RGMIICTL,
+				    val);
+	}
+
 	return ret;
 }
 
Signature · 1 line
2.26.2
maintainer
#7 lore raw

Re: [PATCH net-next v6 4/4] net: dp83869: Add RGMII internal delay configuration

Quoted 3 lines · On Thu, 4 Jun 2020 06:14:10 -0500 Dan Murphy wrote:

Add RGMII internal delay configuration for Rx and Tx.

Hi Dan, please make sure W=1 C=1 build is clean:

drivers/net/phy/dp83869.c:103:18: warning: ‘dp83869_internal_delay’ defined but not used [-Wunused-const-variable=]
103 | static const int dp83869_internal_delay[] = {250, 500, 750, 1000, 1250, 1500,

      |                  ^~~~~~~~~~~~~~~~~~~~~~

Also net-next is closed right now, you can post RFCs but normal patches should be deferred until after net-next reopens.

author
#8 lore raw

Re: [PATCH net-next v6 4/4] net: dp83869: Add RGMII internal delay configuration

Jakub

Quoted 9 lines · Jakub Kicinski
Quoted 3 lines · On Thu, 4 Jun 2020 06:14:10 -0500 Dan Murphy wrote:

Add RGMII internal delay configuration for Rx and Tx.

Hi Dan, please make sure W=1 C=1 build is clean:

drivers/net/phy/dp83869.c:103:18: warning: ‘dp83869_internal_delay’ defined but not used [-Wunused-const-variable=]
103 | static const int dp83869_internal_delay[] = {250, 500, 750, 1000, 1250, 1500,

       |                  ^~~~~~~~~~~~~~~~~~~~~~

I built with W=1 and C=1 and did not see this warning.

What defconfig are you using?

Can you check if CONFIG_OF_MDIO is set or not?  That would be the only way that warning would come up.

Quoted 2 lines

Also net-next is closed right now, you can post RFCs but normal patches should be deferred until after net-next reopens.

I know net-next is closed.

I pinged David M when it was open about what is meant by "new" patches in the net-dev FAQ.  So I figured I would send the patches to see what the response was.

To me these are not new they are in process patches.  My understand is New is v1 patchesets.

But now I have the answer.

Dan

maintainer
#9 lore raw

Re: [PATCH net-next v6 4/4] net: dp83869: Add RGMII internal delay configuration

Quoted 9 lines · On Thu, 4 Jun 2020 11:38:14 -0500 Dan Murphy wrote:

Jakub

Quoted 6 lines · Jakub Kicinski
Quoted 3 lines · On Thu, 4 Jun 2020 06:14:10 -0500 Dan Murphy wrote:

Add RGMII internal delay configuration for Rx and Tx.

Hi Dan, please make sure W=1 C=1 build is clean:

Quoted 7 lines
Quoted 3 lines

drivers/net/phy/dp83869.c:103:18: warning: ‘dp83869_internal_delay’ defined but not used [-Wunused-const-variable=]
103 | static const int dp83869_internal_delay[] = {250, 500, 750, 1000, 1250, 1500,

       |                  ^~~~~~~~~~~~~~~~~~~~~~  

I built with W=1 and C=1 and did not see this warning.

What defconfig are you using?

allmodconfig with gcc-10

Quoted 2 lines

Can you check if CONFIG_OF_MDIO is set or not?  That would be the only way that warning would come up.

Hm. I don't have the config from this particular build but just running allmodconfig makes it CONFIG_OF_MDIO=m

Quoted 5 lines
Quoted 2 lines

Also net-next is closed right now, you can post RFCs but normal patches should be deferred until after net-next reopens.

I know net-next is closed.

Quoted 8 lines

I pinged David M when it was open about what is meant by "new" patches in the net-dev FAQ.  So I figured I would send the patches to see what the response was.

To me these are not new they are in process patches.  My understand is New is v1 patchesets.

But now I have the answer.

Oh sorry, I may be wrong in this case, I haven't tracked this series.

author
#10 lore raw

Re: [PATCH net-next v6 4/4] net: dp83869: Add RGMII internal delay configuration

Jakub

Quoted 15 lines · Jakub Kicinski
Quoted 14 lines · On Thu, 4 Jun 2020 11:38:14 -0500 Dan Murphy wrote:

Jakub

Quoted 9 lines · Jakub Kicinski
Quoted 3 lines · On Thu, 4 Jun 2020 06:14:10 -0500 Dan Murphy wrote:

Add RGMII internal delay configuration for Rx and Tx.

Hi Dan, please make sure W=1 C=1 build is clean:

drivers/net/phy/dp83869.c:103:18: warning: ‘dp83869_internal_delay’ defined but not used [-Wunused-const-variable=]

    103 | static const int dp83869_internal_delay[] = {250, 500, 750, 1000, 1250, 1500,
        |                  ^~~~~~~~~~~~~~~~~~~~~~

I built with W=1 and C=1 and did not see this warning.

Quoted 7 lines
Quoted 1 line

What defconfig are you using?

allmodconfig with gcc-10

Quoted 2 lines

Can you check if CONFIG_OF_MDIO is set or not?  That would be the only way that warning would come up.

Hm. I don't have the config from this particular build but just running allmodconfig makes it CONFIG_OF_MDIO=m

OK that makes sense then.  That is an existing bug that shows up because of this.

#ifdef CONFIG_OF_MDIO

So the addition of the array exposed an existing issue.

That bug fix can go to net then.

Quoted 8 lines
Quoted 8 lines
Quoted 2 lines

Also net-next is closed right now, you can post RFCs but normal patches should be deferred until after net-next reopens.

I know net-next is closed.

I pinged David M when it was open about what is meant by "new" patches in the net-dev FAQ.  So I figured I would send the patches to see what the response was.

Quoted 6 lines
Quoted 4 lines

To me these are not new they are in process patches.  My understand is New is v1 patchesets.

But now I have the answer.

Oh sorry, I may be wrong in this case, I haven't tracked this series.

It says v6 in $subject.

But still you may be correct I don't know

Dan

#11 lore raw

Re: [PATCH net-next v6 4/4] net: dp83869: Add RGMII internal delay configuration

In reply to Dan Murphy
I love your patch! Perhaps something to improve:

Hi Dan,

I love your patch! Perhaps something to improve:

[auto build test WARNING on net-next/master]
[also build test WARNING on robh/for-next sparc-next/master net/master linus/master v5.7 next-20200604] [if your patch is applied to the wrong git tree, please drop us a note to help
improve the system. BTW, we also suggest to use '--base' option to specify the
base tree in git format-patch, please see https://stackoverflow.com/a/37406982]

url:    https://github.com/0day-ci/linux/commits/Dan-Murphy/RGMII-Internal-delay-common-property/20200605-003113
base:   https://git.kernel.org/pub/scm/linux/kernel/git/davem/net-next.git cb8e59cc87201af93dfbb6c3dccc8fcad72a09c2
config: x86_64-allmodconfig (attached as .config)
compiler: clang version 11.0.0 (https://github.com/llvm/llvm-project ac47588bc4ff5927a01ed6fcd269ce86aba52a7c)

reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# install x86_64 cross compiling tool for clang build
# apt-get install binutils-x86-64-linux-gnu
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=x86_64

If you fix the issue, kindly add following tag as appropriate

All warnings (new ones prefixed by >>, old ones prefixed by <<):

>> drivers/net/phy/dp83869.c:103:18: warning: unused variable 'dp83869_internal_delay' [-Wunused-const-variable]

static const int dp83869_internal_delay[] = {250, 500, 750, 1000, 1250, 1500, ^
1 warning generated.

vim +/dp83869_internal_delay +103 drivers/net/phy/dp83869.c

102

 > 103	static const int dp83869_internal_delay[] = {250, 500, 750, 1000, 1250, 1500,

104 1750, 2000, 2250, 2500, 2750, 3000,
105 3250, 3500, 3750, 4000};
106

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all(a)lists.01.org