[RFC,net-next,v6,04/15] net: phy: Add helper for mapping RGMII link speed to clock rate

Commit Message

Jan Petrous via B4 Relay Nov. 24, 2024, 10:42 p.m. UTC

From: "Jan Petrous (OSS)" <[e-mail]>

The RGMII interface supports three data rates: 10/100 Mbps
and 1 Gbps. These speeds correspond to clock frequencies
of 2.5/25 MHz and 125 MHz, respectively.

Many Ethernet drivers, including glues in stmmac, follow
a similar pattern of converting RGMII speed to clock frequency.

To simplify code, define the helper rgmii_clock(speed)
to convert connection speed to clock frequency.

Suggested-by: Russell King (Oracle) <[e-mail]>
Reviewed-by: Andrew Lunn <[e-mail]>
Reviewed-by: Russell King (Oracle) <[e-mail]>
Signed-off-by: Jan Petrous (OSS) <[e-mail]>
---
 include/linux/phy.h | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

Patch

diff --git a/include/linux/phy.h b/include/linux/phy.h
index 77c6d6451638..9d0717ccd5c0 100644
--- a/include/linux/phy.h
+++ b/include/linux/phy.h
@@ -298,6 +298,29 @@  static inline const char *phy_modes(phy_interface_t interface)
 	}
 }
 
+/**
+ * rgmii_clock - map link speed to the clock rate
+ * @speed: link speed value
+ *
+ * Description: maps RGMII supported link speeds
+ * into the clock rates.
+ *
+ * Returns: clock rate or negative errno
+ */
+static inline long rgmii_clock(int speed)
+{
+	switch (speed) {
+	case SPEED_10:
+		return 2500000;
+	case SPEED_100:
+		return 25000000;
+	case SPEED_1000:
+		return 125000000;
+	default:
+		return -EINVAL;
+	}
+}
+
 #define PHY_INIT_TIMEOUT	100000
 #define PHY_FORCE_TIMEOUT	10