include/linux/phylink.h

22 	MLO_AN_FIXED,	/* Fixed-link mode */
23 	MLO_AN_INBAND,	/* In-band protocol */
26 	 *  PHYLINK_PCS_NEG_NONE - protocol has no inband capability
27 	 *  PHYLINK_PCS_NEG_OUTBAND - some out of band or fixed link setting
28 	 *  PHYLINK_PCS_NEG_INBAND_DISABLED - inband mode disabled, e.g.
29 	 *				      1000base-X with autoneg off
30 	 *  PHYLINK_PCS_NEG_INBAND_ENABLED - inband mode enabled
32 	 *  PHYLINK_PCS_NEG_INBAND - inband mode selected
33 	 *  PHYLINK_PCS_NEG_ENABLED - negotiation mode enabled
37 	PHYLINK_PCS_NEG_OUTBAND = BIT(5),
78 	MAC_100FD	= BIT(5),
102  * struct phylink_link_state - link state structure
135  * struct phylink_config - PHYLINK configuration structure
163  * struct phylink_mac_ops - MAC operations structure.
193 #if 0 /* For kernel-doc purposes only. */
199  * Optional method. When not provided, config->mac_capabilities will be used.
202  * driver (e.g. not supporting half-duplex in certain interface modes.)
223  * mac_prepare() - prepare to change the PHY interface mode
235  * - mac_prepare()
236  * - mac_config()
237  * - pcs_config()
238  * - possible pcs_an_restart()
239  * - mac_finish()
248  * mac_config() - configure the MAC for the selected mode and state
253  * Note - not all members of @state are valid.  In particular,
254  * @state->lp_advertising, @state->link, @state->an_complete are never
260  * or pause modes or to change the in-band advertisement.
262  * In all negotiation modes, as defined by @mode, @state->pause indicates the
266  * the results of in-band negotiation/status from the MAC PCS should be used
272  *   Configure for non-inband negotiation mode, where the link settings
274  *   protocol from the MAC is specified by @state->interface.
276  *   @state->advertising may be used, but is not required.
278  *   Older drivers (prior to the mac_link_up() change) may use @state->speed,
279  *   @state->duplex and @state->pause to configure the MAC, but this is
289  *   1000base-X or Cisco SGMII mode depending on the @state->interface
298  *   @state->interface. Duplex and pause modes are negotiated via
299  *   the in-band configuration word. Advertised pause modes are set
300  *   according to the @state->an_enabled and @state->advertising
305  *   in the serial bitstream 16-bit configuration word, and the MAC
314  * requested settings - i.o.w., if nothing has changed between two
324  * mac_finish() - finish a to change the PHY interface mode
331  * for the @mode and @iface. E.g. a MAC driver may wish to re-enable the
341  * mac_link_down() - take the link down
346  * If @mode is not an in-band negotiation mode (as defined by
355  * mac_link_up() - allow the link to come up
370  * or if in-band negotiation (as defined by phylink_autoneg_inband(@mode))
373  * Note that when 802.3z in-band negotiation is in use, it is possible
377  * If in-band negotiation mode is disabled, allow the link to come up. If
378  * @phy is non-%NULL, configure Energy Efficient Ethernet by calling
390  * struct phylink_pcs - PHYLINK PCS instance
410  * struct phylink_pcs_ops - MAC PCS operations structure.
414  * @pcs_pre_config: pre-mac_config method (for errata)
415  * @pcs_post_config: post-mac_config method (for arrata)
442 #if 0 /* For kernel-doc purposes only. */
444  * pcs_validate() - validate the link configuration.
454  * Returns -EINVAL if the interface mode/autoneg mode is not supported.
455  * Returns non-zero positive if the link state can be supported.
461  * pcs_enable() - enable the PCS.
467  * pcs_disable() - disable the PCS.
473  * pcs_get_state() - Read the current inband link state from the hardware
478  * current speed in @state->speed, duplex mode in @state->duplex, pause
479  * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits,
480  * negotiation completion state in @state->an_complete, and link up state
481  * in @state->link. If possible, @state->lp_advertising should also be
491  * pcs_config() - Configure the PCS mode and advertisement
508  * For 1000BASE-X, the advertisement should be programmed into the PCS.
510  * For most 10GBASE-R, there is no advertisement.
513  * functions, or for PCS that set pcs->neg_mode true, should be tested
521  * pcs_an_restart() - restart 802.3z BaseX autonegotiation
530  * pcs_link_up() - program the PCS for the resolved link configuration
539  * mode without in-band AN needs to be manually configured for the link
540  * and duplex setting. Otherwise, this should be a no-op.
543  * functions, or for PCS that set pcs->neg_mode true, should be tested
605  * phylink_get_link_timer_ns - return the PCS link timer value
609  * mode, or -EINVAL if not appropriate.
624 		return -EINVAL;  in phylink_get_link_timer_ns()