Skip to contentSkip to conversation

net: phy: improve rgmii_clock() documentation

PATCH Applied Russell King (Oracle) 3 participants 3 messages Jun 12, 2025 – Jun 14, 2025

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

PATCH 1/1 net: phy: improve rgmii_clock() documentation

Improve the rgmii_clock() documentation to indicate that it can also be used for MII, GMII and RMII modes as well as RGMII as the required clock rates are identical, but note that it won't error out for 1G speeds for MII and RMII.

---
 include/linux/phy.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
include/linux/phy.h +4 -2
index e194dad1623d..802f3015f235 100644
@@ -269,8 +269,10 @@ 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.
+ * Description: maps RGMII supported link speeds into the clock rates.
+ * This can also be used for MII, GMII, and RMII interface modes as the
+ * clock rates are indentical, but the caller must be aware that errors
+ * for unsupported clock rates will not be signalled.
  *
  * Returns: clock rate or negative errno
  */
Signature · 1 line
2.30.2
#2 lore raw
In reply to Russell King (Oracle)
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:

Hello:

This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:

Quoted 8 lines · On Thu, 12 Jun 2025 16:21:04 +0100 you wrote:

Improve the rgmii_clock() documentation to indicate that it can also be used for MII, GMII and RMII modes as well as RGMII as the required clock rates are identical, but note that it won't error out for 1G speeds for MII and RMII.

[...]

Here is the summary with links:
- [net-next] net: phy: improve rgmii_clock() documentation

    https://git.kernel.org/netdev/net-next/c/91695b859263

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html