On 23.05.24 16:40, Stefan Kerkmann wrote:
> This is a port of linux commit 4069a572d423b73919ae40a500dfc4b10f8a6f32
> ("net: phy: Document core PHY structures"), that copies the Doxygen
> comments for the PHY structure where applicable.
>
> Signed-off-by: Stefan Kerkmann <s.kerkmann@xxxxxxxxxxxxxx>
Reviewed-by: Ahmad Fatoum <a.fatoum@xxxxxxxxxxxxxx>
> ---
> include/linux/phy.h | 20 +++++++++++---------
> 1 file changed, 11 insertions(+), 9 deletions(-)
>
> diff --git a/include/linux/phy.h b/include/linux/phy.h
> index a6b96a5984..ef25dec033 100644
> --- a/include/linux/phy.h
> +++ b/include/linux/phy.h
> @@ -280,36 +280,38 @@ struct phy_driver {
> */
> int (*soft_reset)(struct phy_device *phydev);
>
> - /*
> - * Called to initialize the PHY,
> + /**
> + * @config_init: Called to initialize the PHY,
> * including after a reset
> */
> int (*config_init)(struct phy_device *phydev);
>
> - /*
> - * Called during discovery. Used to set
> + /**
> + * @probe: Called during discovery. Used to set
> * up device-specific structures, if any
> */
> int (*probe)(struct phy_device *phydev);
>
> - /*
> - * Configures the advertisement and resets
> + /**
> + * @config_aneg: Configures the advertisement and resets
> * autonegotiation if phydev->autoneg is on,
> * forces the speed to the current settings in phydev
> * if phydev->autoneg is off
> */
> int (*config_aneg)(struct phy_device *phydev);
>
> - /* Determines the auto negotiation result */
> + /** @aneg_done: Determines the auto negotiation result */
> int (*aneg_done)(struct phy_device *phydev);
>
> - /* Determines the negotiated speed and duplex */
> + /** @read_status: Determines the negotiated speed and duplex */
> int (*read_status)(struct phy_device *phydev);
>
> - /* Clears up any memory if needed */
> + /** @remove: Clears up any memory if needed */
> void (*remove)(struct phy_device *phydev);
>
> + /** @read_page: Return the current PHY register page number */
> int (*read_page)(struct phy_device *phydev);
> + /** @write_page: Set the current PHY register page number */
> int (*write_page)(struct phy_device *phydev, int page);
>
> struct driver drv;
>
--
Pengutronix e.K. | |
Steuerwalder Str. 21 | http://www.pengutronix.de/ |
31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
