[PATCH net-next] net: phy: improve rgmii_clock() documentation

[PATCH net-next] net: phy: improve rgmii_clock() documentation

[Russell King (Oracle)]

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.

Signed-off-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>
---
 include/linux/phy.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/include/linux/phy.h b/include/linux/phy.h
index e194dad1623d..802f3015f235 100644
--- a/include/linux/phy.h
+++ b/include/linux/phy.h
@@ -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
  */
-- 
2.30.2

Re: [PATCH net-next] net: phy: improve rgmii_clock() documentation

[Andrew Lunn]

On Thu, Jun 12, 2025 at 04:21:04PM +0100, Russell King (Oracle) 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.
> 
> Signed-off-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>

Reviewed-by: Andrew Lunn <andrew@lunn.ch>

    Andrew

Re: [PATCH net-next] net: phy: improve rgmii_clock() documentation

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

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.
> 
> Signed-off-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>
> 
> [...]

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!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html