Re: [net-next PATCH v4 3/3] net: phy: add support for PHY package MMD read/write

From: Jakub Kicinski
Date: Mon Dec 11 2023 - 21:46:48 EST


Some nit picks since nobody has acked :(

On Thu, 7 Dec 2023 00:25:47 +0100 Christian Marangi wrote:
> +/**
> + * __phy_package_read_mmd - Convenience function for reading a register
> + * on an MMD on a given PHY using the PHY package base addr, added of

s/on an MMD/of an MMD/ ?
s/added of/added to/ ?

> + * the addr_offset value.
> + * @phydev: The phy_device struct
> + * @addr_offset: The offset to be added to PHY package base_addr
> + * @devad: The MMD to read from
> + * @regnum: The register on the MMD to read
> + *
> + * Same rules as for __phy_read();
> + *
> + * NOTE: It's assumed that the entire PHY package is either C22 or C45.

I'd try to make the headline shorter:

/**
* __phy_package_read_mmd - read MMD reg relative to PHY package base addr
* @phydev: The phy_device struct
* @addr_offset: The offset to be added to PHY package base_addr
* @devad: The MMD to read from
* @regnum: The register on the MMD to read
*
* Convenience helper for reading a register of an MMD on a given PHY
* using the PHY package base address. The base address is added to
* the addr_offset value.
*
* Same calling rules as for __phy_read();
*
* NOTE: It's assumed that the entire PHY package is either C22 or C45.
*/