Commit 35b862ea authored by Russell King (Oracle)'s avatar Russell King (Oracle) Committed by Paolo Abeni
Browse files

net: phylink: expand on .pcs_config() method documentation 



Expand on the requirements of the .pcs_config() method documentation,
specifically mentioning that it should cause minimal disruption to
an established link, and that it should return a positive non-zero
value when requiring the .pcs_an_restart() method to be called.

Signed-off-by: default avatarRussell King (Oracle) <rmk+kernel@armlinux.org.uk>
Link: https://patch.msgid.link/E1trb24-005oVq-Is@rmk-PC.armlinux.org.uk


Signed-off-by: default avatarPaolo Abeni <pabeni@redhat.com>
parent a07f23ad

include/linux/phylink.h

+8 −0
Original line number Diff line number Diff line
@@ -595,6 +595,14 @@ void pcs_get_state(struct phylink_pcs *pcs, unsigned int neg_mode, 
 * The %neg_mode argument should be tested via the phylink_mode_*() family of

 * functions, or for PCS that set pcs->neg_mode true, should be tested

 * against the PHYLINK_PCS_NEG_* definitions.

 *

 * pcs_config() will be called when configuration of the PCS is required

 * or when the advertisement is possibly updated. It must not unnecessarily

 * disrupt an established link.

 *

 * When an autonegotiation restart is required for 802.3z modes, .pcs_config()

 * should return a positive non-zero integer (e.g. 1) to indicate to phylink

 * to call the pcs_an_restart() method.

 */

int pcs_config(struct phylink_pcs *pcs, unsigned int neg_mode,

	       phy_interface_t interface, const unsigned long *advertising,