Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 32e454ef authored by Russell King's avatar Russell King Committed by David S. Miller
Browse files

net: phylink: further documentation clarifications 



Clarify the validate() behaviour in a few cases which weren't mentioned
in the documentation, but which are necessary for users to get the
correct behaviour.

Signed-off-by: default avatarRussell King <rmk+kernel@armlinux.org.uk>
Reviewed-by: default avatarAndrew Lunn <andrew@lunn.ch>
Reviewed-by: default avatarFlorian Fainelli <f.fainelli@gmail.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 337d1727

include/linux/phylink.h

+9 −2
Original line number Diff line number Diff line
@@ -93,12 +93,19 @@ struct phylink_mac_ops { 
 * Note that the PHY may be able to transform from one connection

 * technology to another, so, eg, don't clear 1000BaseX just

 * because the MAC is unable to BaseX mode. This is more about

 * clearing unsupported speeds and duplex settings.

 * clearing unsupported speeds and duplex settings. The port modes

 * should not be cleared; phylink_set_port_modes() will help with this.

 *

 * If the @state->interface mode is %PHY_INTERFACE_MODE_1000BASEX

 * or %PHY_INTERFACE_MODE_2500BASEX, select the appropriate mode

 * based on @state->advertising and/or @state->speed and update

 * @state->interface accordingly.

 * @state->interface accordingly. See phylink_helper_basex_speed().

 *

 * When @state->interface is %PHY_INTERFACE_MODE_NA, phylink expects the

 * MAC driver to return all supported link modes.

 *

 * If the @state->interface mode is not supported, then the @supported

 * mask must be cleared.

 */

void validate(struct net_device *ndev, unsigned long *supported,

	      struct phylink_link_state *state);