include/linux/phylink.h

21 	MLO_AN_FIXED,	/* Fixed-link mode */
22 	MLO_AN_INBAND,	/* In-band protocol */
31  * struct phylink_link_state - link state structure
36  * @speed: link speed, one of the SPEED_* constants.
47 	int speed;  member
61  * struct phylink_config - PHYLINK configuration structure
80  * struct phylink_mac_ops - MAC operations structure.
82  * @mac_pcs_get_state: Read the current link state from the hardware.
109 			    phy_interface_t interface, int speed, int duplex,
113 #if 0 /* For kernel-doc purposes only. */
115  * validate - Validate and update the link configuration
120  * Clear bits in the @supported and @state->advertising masks that
129  * If the @state->interface mode is %PHY_INTERFACE_MODE_1000BASEX
131  * based on @state->advertising and/or @state->speed and update
132  * @state->interface accordingly. See phylink_helper_basex_speed().
134  * When @state->interface is %PHY_INTERFACE_MODE_NA, phylink expects the
137  * If the @state->interface mode is not supported, then the @supported
144  * mac_pcs_get_state() - Read the current inband link state from the hardware
148  * Read the current inband link state from the MAC PCS, reporting the
149  * current speed in @state->speed, duplex mode in @state->duplex, pause
150  * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits,
151  * negotiation completion state in @state->an_complete, and link up state
152  * in @state->link. If possible, @state->lp_advertising should also be
159  * mac_prepare() - prepare to change the PHY interface mode
166  * startup time. It may be called for the current mode. The MAC driver
171  * - mac_prepare()
172  * - mac_config()
173  * - pcs_config()
174  * - possible pcs_an_restart()
175  * - mac_finish()
184  * mac_config() - configure the MAC for the selected mode and state
189  * Note - not all members of @state are valid.  In particular,
190  * @state->lp_advertising, @state->link, @state->an_complete are never
194  * (this requires a rewrite - please refer to mac_link_up() for situations
197  * In all negotiation modes, as defined by @mode, @state->pause indicates the
201  * the results of in-band negotiation/status from the MAC PCS should be used
207  *   Configure for non-inband negotiation mode, where the link settings
209  *   protocol from the MAC is specified by @state->interface.
211  *   @state->advertising may be used, but is not required.
213  *   Older drivers (prior to the mac_link_up() change) may use @state->speed,
214  *   @state->duplex and @state->pause to configure the MAC, but this is
220  *   Deprecated state members: speed, duplex, pause.
224  *   1000base-X or Cisco SGMII mode depending on the @state->interface
232  *   If in 802.3z mode, the link speed is fixed, dependent on the
233  *   @state->interface. Duplex and pause modes are negotiated via
234  *   the in-band configuration word. Advertised pause modes are set
235  *   according to the @state->an_enabled and @state->advertising
239  *   If in Cisco SGMII mode, the link speed and duplex mode are passed
240  *   in the serial bitstream 16-bit configuration word, and the MAC
249  * requested settings - i.o.w., if nothing has changed between two
259  * mac_finish() - finish a to change the PHY interface mode
266  * for the @mode and @iface. E.g. a MAC driver may wish to re-enable the
276  * mac_an_restart() - restart 802.3z BaseX autonegotiation
282  * mac_link_down() - take the link down
287  * If @mode is not an in-band negotiation mode (as defined by
296  * mac_link_up() - allow the link to come up
301  * @speed: link speed
308  * @speed, @duplex, @tx_pause and @rx_pause indicate the finalised link
311  * or if in-band negotiation (as defined by phylink_autoneg_inband(@mode))
314  * Note that when 802.3z in-band negotiation is in use, it is possible
318  * If in-band negotiation mode is disabled, allow the link to come up. If
319  * @phy is non-%NULL, configure Energy Efficient Ethernet by calling
325 		 int speed, int duplex, bool tx_pause, bool rx_pause);
331  * struct phylink_pcs - PHYLINK PCS instance
344  * struct phylink_pcs_ops - MAC PCS operations structure.
345  * @pcs_get_state: read the current MAC PCS link state from the hardware.
360 			    phy_interface_t interface, int speed, int duplex);
363 #if 0 /* For kernel-doc purposes only. */
365  * pcs_get_state() - Read the current inband link state from the hardware
369  * Read the current inband link state from the MAC PCS, reporting the
370  * current speed in @state->speed, duplex mode in @state->duplex, pause
371  * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits,
372  * negotiation completion state in @state->an_complete, and link up state
373  * in @state->link. If possible, @state->lp_advertising should also be
383  * pcs_config() - Configure the PCS mode and advertisement
400  * For 1000BASE-X, the advertisement should be programmed into the PCS.
402  * For most 10GBASE-R, there is no advertisement.
409  * pcs_an_restart() - restart 802.3z BaseX autonegotiation
418  * pcs_link_up() - program the PCS for the resolved link configuration
422  * @speed: link speed
427  * mode without in-band AN needs to be manually configured for the link
428  * and duplex setting. Otherwise, this should be a no-op.
431 		 phy_interface_t interface, int speed, int duplex);