xref: /linux/include/linux/phylink.h (revision 4b3fc475)
1 #ifndef NETDEV_PCS_H
2 #define NETDEV_PCS_H
3 
4 #include <linux/phy.h>
5 #include <linux/spinlock.h>
6 #include <linux/workqueue.h>
7 
8 struct device_node;
9 struct ethtool_cmd;
10 struct fwnode_handle;
11 struct net_device;
12 struct phylink;
13 
14 enum {
15 	MLO_PAUSE_NONE,
16 	MLO_PAUSE_RX = BIT(0),
17 	MLO_PAUSE_TX = BIT(1),
18 	MLO_PAUSE_TXRX_MASK = MLO_PAUSE_TX | MLO_PAUSE_RX,
19 	MLO_PAUSE_AN = BIT(2),
20 
21 	MLO_AN_PHY = 0,	/* Conventional PHY */
22 	MLO_AN_FIXED,	/* Fixed-link mode */
23 	MLO_AN_INBAND,	/* In-band protocol */
24 
25 	/* PCS "negotiation" mode.
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
31 	 * Additionally, this can be tested using bitmasks:
32 	 *  PHYLINK_PCS_NEG_INBAND - inband mode selected
33 	 *  PHYLINK_PCS_NEG_ENABLED - negotiation mode enabled
34 	 */
35 	PHYLINK_PCS_NEG_NONE = 0,
36 	PHYLINK_PCS_NEG_ENABLED = BIT(4),
37 	PHYLINK_PCS_NEG_OUTBAND = BIT(5),
38 	PHYLINK_PCS_NEG_INBAND = BIT(6),
39 	PHYLINK_PCS_NEG_INBAND_DISABLED = PHYLINK_PCS_NEG_INBAND,
40 	PHYLINK_PCS_NEG_INBAND_ENABLED = PHYLINK_PCS_NEG_INBAND |
41 					 PHYLINK_PCS_NEG_ENABLED,
42 
43 	/* MAC_SYM_PAUSE and MAC_ASYM_PAUSE are used when configuring our
44 	 * autonegotiation advertisement. They correspond to the PAUSE and
45 	 * ASM_DIR bits defined by 802.3, respectively.
46 	 *
47 	 * The following table lists the values of tx_pause and rx_pause which
48 	 * might be requested in mac_link_up. The exact values depend on either
49 	 * the results of autonegotation (if MLO_PAUSE_AN is set) or user
50 	 * configuration (if MLO_PAUSE_AN is not set).
51 	 *
52 	 * MAC_SYM_PAUSE MAC_ASYM_PAUSE MLO_PAUSE_AN tx_pause/rx_pause
53 	 * ============= ============== ============ ==================
54 	 *             0              0            0 0/0
55 	 *             0              0            1 0/0
56 	 *             0              1            0 0/0, 0/1, 1/0, 1/1
57 	 *             0              1            1 0/0,      1/0
58 	 *             1              0            0 0/0,           1/1
59 	 *             1              0            1 0/0,           1/1
60 	 *             1              1            0 0/0, 0/1, 1/0, 1/1
61 	 *             1              1            1 0/0, 0/1,      1/1
62 	 *
63 	 * If you set MAC_ASYM_PAUSE, the user may request any combination of
64 	 * tx_pause and rx_pause. You do not have to support these
65 	 * combinations.
66 	 *
67 	 * However, you should support combinations of tx_pause and rx_pause
68 	 * which might be the result of autonegotation. For example, don't set
69 	 * MAC_SYM_PAUSE unless your device can support tx_pause and rx_pause
70 	 * at the same time.
71 	 */
72 	MAC_SYM_PAUSE	= BIT(0),
73 	MAC_ASYM_PAUSE	= BIT(1),
74 	MAC_10HD	= BIT(2),
75 	MAC_10FD	= BIT(3),
76 	MAC_10		= MAC_10HD | MAC_10FD,
77 	MAC_100HD	= BIT(4),
78 	MAC_100FD	= BIT(5),
79 	MAC_100		= MAC_100HD | MAC_100FD,
80 	MAC_1000HD	= BIT(6),
81 	MAC_1000FD	= BIT(7),
82 	MAC_1000	= MAC_1000HD | MAC_1000FD,
83 	MAC_2500FD	= BIT(8),
84 	MAC_5000FD	= BIT(9),
85 	MAC_10000FD	= BIT(10),
86 	MAC_20000FD	= BIT(11),
87 	MAC_25000FD	= BIT(12),
88 	MAC_40000FD	= BIT(13),
89 	MAC_50000FD	= BIT(14),
90 	MAC_56000FD	= BIT(15),
91 	MAC_100000FD	= BIT(16),
92 	MAC_200000FD	= BIT(17),
93 	MAC_400000FD	= BIT(18),
94 };
95 
phylink_autoneg_inband(unsigned int mode)96 static inline bool phylink_autoneg_inband(unsigned int mode)
97 {
98 	return mode == MLO_AN_INBAND;
99 }
100 
101 /**
102  * struct phylink_link_state - link state structure
103  * @advertising: ethtool bitmask containing advertised link modes
104  * @lp_advertising: ethtool bitmask containing link partner advertised link
105  *   modes
106  * @interface: link &typedef phy_interface_t mode
107  * @speed: link speed, one of the SPEED_* constants.
108  * @duplex: link duplex mode, one of DUPLEX_* constants.
109  * @pause: link pause state, described by MLO_PAUSE_* constants.
110  * @rate_matching: rate matching being performed, one of the RATE_MATCH_*
111  *   constants. If rate matching is taking place, then the speed/duplex of
112  *   the medium link mode (@speed and @duplex) and the speed/duplex of the phy
113  *   interface mode (@interface) are different.
114  * @link: true if the link is up.
115  * @an_complete: true if autonegotiation has completed.
116  */
117 struct phylink_link_state {
118 	__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
119 	__ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
120 	phy_interface_t interface;
121 	int speed;
122 	int duplex;
123 	int pause;
124 	int rate_matching;
125 	unsigned int link:1;
126 	unsigned int an_complete:1;
127 };
128 
129 enum phylink_op_type {
130 	PHYLINK_NETDEV = 0,
131 	PHYLINK_DEV,
132 };
133 
134 /**
135  * struct phylink_config - PHYLINK configuration structure
136  * @dev: a pointer to a struct device associated with the MAC
137  * @type: operation type of PHYLINK instance
138  * @poll_fixed_state: if true, starts link_poll,
139  *		      if MAC link is at %MLO_AN_FIXED mode.
140  * @mac_managed_pm: if true, indicate the MAC driver is responsible for PHY PM.
141  * @mac_requires_rxc: if true, the MAC always requires a receive clock from PHY.
142  *                    The PHY driver should start the clock signal as soon as
143  *                    possible and avoid stopping it during suspend events.
144  * @default_an_inband: if true, defaults to MLO_AN_INBAND rather than
145  *		       MLO_AN_PHY. A fixed-link specification will override.
146  * @get_fixed_state: callback to execute to determine the fixed link state,
147  *		     if MAC link is at %MLO_AN_FIXED mode.
148  * @supported_interfaces: bitmap describing which PHY_INTERFACE_MODE_xxx
149  *                        are supported by the MAC/PCS.
150  * @mac_capabilities: MAC pause/speed/duplex capabilities.
151  */
152 struct phylink_config {
153 	struct device *dev;
154 	enum phylink_op_type type;
155 	bool poll_fixed_state;
156 	bool mac_managed_pm;
157 	bool mac_requires_rxc;
158 	bool default_an_inband;
159 	void (*get_fixed_state)(struct phylink_config *config,
160 				struct phylink_link_state *state);
161 	DECLARE_PHY_INTERFACE_MASK(supported_interfaces);
162 	unsigned long mac_capabilities;
163 };
164 
165 void phylink_limit_mac_speed(struct phylink_config *config, u32 max_speed);
166 
167 /**
168  * struct phylink_mac_ops - MAC operations structure.
169  * @mac_get_caps: Get MAC capabilities for interface mode.
170  * @mac_select_pcs: Select a PCS for the interface mode.
171  * @mac_prepare: prepare for a major reconfiguration of the interface.
172  * @mac_config: configure the MAC for the selected mode and state.
173  * @mac_finish: finish a major reconfiguration of the interface.
174  * @mac_link_down: take the link down.
175  * @mac_link_up: allow the link to come up.
176  *
177  * The individual methods are described more fully below.
178  */
179 struct phylink_mac_ops {
180 	unsigned long (*mac_get_caps)(struct phylink_config *config,
181 				      phy_interface_t interface);
182 	struct phylink_pcs *(*mac_select_pcs)(struct phylink_config *config,
183 					      phy_interface_t interface);
184 	int (*mac_prepare)(struct phylink_config *config, unsigned int mode,
185 			   phy_interface_t iface);
186 	void (*mac_config)(struct phylink_config *config, unsigned int mode,
187 			   const struct phylink_link_state *state);
188 	int (*mac_finish)(struct phylink_config *config, unsigned int mode,
189 			  phy_interface_t iface);
190 	void (*mac_link_down)(struct phylink_config *config, unsigned int mode,
191 			      phy_interface_t interface);
192 	void (*mac_link_up)(struct phylink_config *config,
193 			    struct phy_device *phy, unsigned int mode,
194 			    phy_interface_t interface, int speed, int duplex,
195 			    bool tx_pause, bool rx_pause);
196 };
197 
198 #if 0 /* For kernel-doc purposes only. */
199 /**
200  * mac_get_caps: Get MAC capabilities for interface mode.
201  * @config: a pointer to a &struct phylink_config.
202  * @interface: PHY interface mode.
203  *
204  * Optional method. When not provided, config->mac_capabilities will be used.
205  * When implemented, this returns the MAC capabilities for the specified
206  * interface mode where there is some special handling required by the MAC
207  * driver (e.g. not supporting half-duplex in certain interface modes.)
208  */
209 unsigned long mac_get_caps(struct phylink_config *config,
210 			   phy_interface_t interface);
211 /**
212  * mac_select_pcs: Select a PCS for the interface mode.
213  * @config: a pointer to a &struct phylink_config.
214  * @interface: PHY interface mode for PCS
215  *
216  * Return the &struct phylink_pcs for the specified interface mode, or
217  * NULL if none is required, or an error pointer on error.
218  *
219  * This must not modify any state. It is used to query which PCS should
220  * be used. Phylink will use this during validation to ensure that the
221  * configuration is valid, and when setting a configuration to internally
222  * set the PCS that will be used.
223  */
224 struct phylink_pcs *mac_select_pcs(struct phylink_config *config,
225 				   phy_interface_t interface);
226 
227 /**
228  * mac_prepare() - prepare to change the PHY interface mode
229  * @config: a pointer to a &struct phylink_config.
230  * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
231  * @iface: interface mode to switch to
232  *
233  * phylink will call this method at the beginning of a full initialisation
234  * of the link, which includes changing the interface mode or at initial
235  * startup time. It may be called for the current mode. The MAC driver
236  * should perform whatever actions are required, e.g. disabling the
237  * Serdes PHY.
238  *
239  * This will be the first call in the sequence:
240  * - mac_prepare()
241  * - mac_config()
242  * - pcs_config()
243  * - possible pcs_an_restart()
244  * - mac_finish()
245  *
246  * Returns zero on success, or negative errno on failure which will be
247  * reported to the kernel log.
248  */
249 int mac_prepare(struct phylink_config *config, unsigned int mode,
250 		phy_interface_t iface);
251 
252 /**
253  * mac_config() - configure the MAC for the selected mode and state
254  * @config: a pointer to a &struct phylink_config.
255  * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
256  * @state: a pointer to a &struct phylink_link_state.
257  *
258  * Note - not all members of @state are valid.  In particular,
259  * @state->lp_advertising, @state->link, @state->an_complete are never
260  * guaranteed to be correct, and so any mac_config() implementation must
261  * never reference these fields.
262  *
263  * This will only be called to reconfigure the MAC for a "major" change in
264  * e.g. interface mode. It will not be called for changes in speed, duplex
265  * or pause modes or to change the in-band advertisement.
266  *
267  * In all negotiation modes, as defined by @mode, @state->pause indicates the
268  * pause settings which should be applied as follows. If %MLO_PAUSE_AN is not
269  * set, %MLO_PAUSE_TX and %MLO_PAUSE_RX indicate whether the MAC should send
270  * pause frames and/or act on received pause frames respectively. Otherwise,
271  * the results of in-band negotiation/status from the MAC PCS should be used
272  * to control the MAC pause mode settings.
273  *
274  * The action performed depends on the currently selected mode:
275  *
276  * %MLO_AN_FIXED, %MLO_AN_PHY:
277  *   Configure for non-inband negotiation mode, where the link settings
278  *   are completely communicated via mac_link_up().  The physical link
279  *   protocol from the MAC is specified by @state->interface.
280  *
281  *   @state->advertising may be used, but is not required.
282  *
283  *   Older drivers (prior to the mac_link_up() change) may use @state->speed,
284  *   @state->duplex and @state->pause to configure the MAC, but this is
285  *   deprecated; such drivers should be converted to use mac_link_up().
286  *
287  *   Other members of @state must be ignored.
288  *
289  *   Valid state members: interface, advertising.
290  *   Deprecated state members: speed, duplex, pause.
291  *
292  * %MLO_AN_INBAND:
293  *   place the link in an inband negotiation mode (such as 802.3z
294  *   1000base-X or Cisco SGMII mode depending on the @state->interface
295  *   mode). In both cases, link state management (whether the link
296  *   is up or not) is performed by the MAC, and reported via the
297  *   pcs_get_state() callback. Changes in link state must be made
298  *   by calling phylink_mac_change().
299  *
300  *   Interface mode specific details are mentioned below.
301  *
302  *   If in 802.3z mode, the link speed is fixed, dependent on the
303  *   @state->interface. Duplex and pause modes are negotiated via
304  *   the in-band configuration word. Advertised pause modes are set
305  *   according to the @state->an_enabled and @state->advertising
306  *   flags. Beware of MACs which only support full duplex at gigabit
307  *   and higher speeds.
308  *
309  *   If in Cisco SGMII mode, the link speed and duplex mode are passed
310  *   in the serial bitstream 16-bit configuration word, and the MAC
311  *   should be configured to read these bits and acknowledge the
312  *   configuration word. Nothing is advertised by the MAC. The MAC is
313  *   responsible for reading the configuration word and configuring
314  *   itself accordingly.
315  *
316  *   Valid state members: interface, an_enabled, pause, advertising.
317  *
318  * Implementations are expected to update the MAC to reflect the
319  * requested settings - i.o.w., if nothing has changed between two
320  * calls, no action is expected.  If only flow control settings have
321  * changed, flow control should be updated *without* taking the link
322  * down.  This "update" behaviour is critical to avoid bouncing the
323  * link up status.
324  */
325 void mac_config(struct phylink_config *config, unsigned int mode,
326 		const struct phylink_link_state *state);
327 
328 /**
329  * mac_finish() - finish a to change the PHY interface mode
330  * @config: a pointer to a &struct phylink_config.
331  * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
332  * @iface: interface mode to switch to
333  *
334  * phylink will call this if it called mac_prepare() to allow the MAC to
335  * complete any necessary steps after the MAC and PCS have been configured
336  * for the @mode and @iface. E.g. a MAC driver may wish to re-enable the
337  * Serdes PHY here if it was previously disabled by mac_prepare().
338  *
339  * Returns zero on success, or negative errno on failure which will be
340  * reported to the kernel log.
341  */
342 int mac_finish(struct phylink_config *config, unsigned int mode,
343 		phy_interface_t iface);
344 
345 /**
346  * mac_link_down() - take the link down
347  * @config: a pointer to a &struct phylink_config.
348  * @mode: link autonegotiation mode
349  * @interface: link &typedef phy_interface_t mode
350  *
351  * If @mode is not an in-band negotiation mode (as defined by
352  * phylink_autoneg_inband()), force the link down and disable any
353  * Energy Efficient Ethernet MAC configuration. Interface type
354  * selection must be done in mac_config().
355  */
356 void mac_link_down(struct phylink_config *config, unsigned int mode,
357 		   phy_interface_t interface);
358 
359 /**
360  * mac_link_up() - allow the link to come up
361  * @config: a pointer to a &struct phylink_config.
362  * @phy: any attached phy
363  * @mode: link autonegotiation mode
364  * @interface: link &typedef phy_interface_t mode
365  * @speed: link speed
366  * @duplex: link duplex
367  * @tx_pause: link transmit pause enablement status
368  * @rx_pause: link receive pause enablement status
369  *
370  * Configure the MAC for an established link.
371  *
372  * @speed, @duplex, @tx_pause and @rx_pause indicate the finalised link
373  * settings, and should be used to configure the MAC block appropriately
374  * where these settings are not automatically conveyed from the PCS block,
375  * or if in-band negotiation (as defined by phylink_autoneg_inband(@mode))
376  * is disabled.
377  *
378  * Note that when 802.3z in-band negotiation is in use, it is possible
379  * that the user wishes to override the pause settings, and this should
380  * be allowed when considering the implementation of this method.
381  *
382  * If in-band negotiation mode is disabled, allow the link to come up. If
383  * @phy is non-%NULL, configure Energy Efficient Ethernet by calling
384  * phy_init_eee() and perform appropriate MAC configuration for EEE.
385  * Interface type selection must be done in mac_config().
386  */
387 void mac_link_up(struct phylink_config *config, struct phy_device *phy,
388 		 unsigned int mode, phy_interface_t interface,
389 		 int speed, int duplex, bool tx_pause, bool rx_pause);
390 #endif
391 
392 struct phylink_pcs_ops;
393 
394 /**
395  * struct phylink_pcs - PHYLINK PCS instance
396  * @ops: a pointer to the &struct phylink_pcs_ops structure
397  * @phylink: pointer to &struct phylink_config
398  * @neg_mode: provide PCS neg mode via "mode" argument
399  * @poll: poll the PCS for link changes
400  * @rxc_always_on: The MAC driver requires the reference clock
401  *                 to always be on. Standalone PCS drivers which
402  *                 do not have access to a PHY device can check
403  *                 this instead of PHY_F_RXC_ALWAYS_ON.
404  *
405  * This structure is designed to be embedded within the PCS private data,
406  * and will be passed between phylink and the PCS.
407  *
408  * The @phylink member is private to phylink and must not be touched by
409  * the PCS driver.
410  */
411 struct phylink_pcs {
412 	const struct phylink_pcs_ops *ops;
413 	struct phylink *phylink;
414 	bool neg_mode;
415 	bool poll;
416 	bool rxc_always_on;
417 };
418 
419 /**
420  * struct phylink_pcs_ops - MAC PCS operations structure.
421  * @pcs_validate: validate the link configuration.
422  * @pcs_enable: enable the PCS.
423  * @pcs_disable: disable the PCS.
424  * @pcs_pre_config: pre-mac_config method (for errata)
425  * @pcs_post_config: post-mac_config method (for arrata)
426  * @pcs_get_state: read the current MAC PCS link state from the hardware.
427  * @pcs_config: configure the MAC PCS for the selected mode and state.
428  * @pcs_an_restart: restart 802.3z BaseX autonegotiation.
429  * @pcs_link_up: program the PCS for the resolved link configuration
430  *               (where necessary).
431  * @pcs_pre_init: configure PCS components necessary for MAC hardware
432  *                initialization e.g. RX clock for stmmac.
433  */
434 struct phylink_pcs_ops {
435 	int (*pcs_validate)(struct phylink_pcs *pcs, unsigned long *supported,
436 			    const struct phylink_link_state *state);
437 	int (*pcs_enable)(struct phylink_pcs *pcs);
438 	void (*pcs_disable)(struct phylink_pcs *pcs);
439 	void (*pcs_pre_config)(struct phylink_pcs *pcs,
440 			       phy_interface_t interface);
441 	int (*pcs_post_config)(struct phylink_pcs *pcs,
442 			       phy_interface_t interface);
443 	void (*pcs_get_state)(struct phylink_pcs *pcs,
444 			      struct phylink_link_state *state);
445 	int (*pcs_config)(struct phylink_pcs *pcs, unsigned int neg_mode,
446 			  phy_interface_t interface,
447 			  const unsigned long *advertising,
448 			  bool permit_pause_to_mac);
449 	void (*pcs_an_restart)(struct phylink_pcs *pcs);
450 	void (*pcs_link_up)(struct phylink_pcs *pcs, unsigned int neg_mode,
451 			    phy_interface_t interface, int speed, int duplex);
452 	int (*pcs_pre_init)(struct phylink_pcs *pcs);
453 };
454 
455 #if 0 /* For kernel-doc purposes only. */
456 /**
457  * pcs_validate() - validate the link configuration.
458  * @pcs: a pointer to a &struct phylink_pcs.
459  * @supported: ethtool bitmask for supported link modes.
460  * @state: a const pointer to a &struct phylink_link_state.
461  *
462  * Validate the interface mode, and advertising's autoneg bit, removing any
463  * media ethtool link modes that would not be supportable from the supported
464  * mask. Phylink will propagate the changes to the advertising mask. See the
465  * &struct phylink_mac_ops validate() method.
466  *
467  * Returns -EINVAL if the interface mode/autoneg mode is not supported.
468  * Returns non-zero positive if the link state can be supported.
469  */
470 int pcs_validate(struct phylink_pcs *pcs, unsigned long *supported,
471 		 const struct phylink_link_state *state);
472 
473 /**
474  * pcs_enable() - enable the PCS.
475  * @pcs: a pointer to a &struct phylink_pcs.
476  */
477 int pcs_enable(struct phylink_pcs *pcs);
478 
479 /**
480  * pcs_disable() - disable the PCS.
481  * @pcs: a pointer to a &struct phylink_pcs.
482  */
483 void pcs_disable(struct phylink_pcs *pcs);
484 
485 /**
486  * pcs_get_state() - Read the current inband link state from the hardware
487  * @pcs: a pointer to a &struct phylink_pcs.
488  * @state: a pointer to a &struct phylink_link_state.
489  *
490  * Read the current inband link state from the MAC PCS, reporting the
491  * current speed in @state->speed, duplex mode in @state->duplex, pause
492  * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits,
493  * negotiation completion state in @state->an_complete, and link up state
494  * in @state->link. If possible, @state->lp_advertising should also be
495  * populated.
496  */
497 void pcs_get_state(struct phylink_pcs *pcs,
498 		   struct phylink_link_state *state);
499 
500 /**
501  * pcs_config() - Configure the PCS mode and advertisement
502  * @pcs: a pointer to a &struct phylink_pcs.
503  * @neg_mode: link negotiation mode (see below)
504  * @interface: interface mode to be used
505  * @advertising: adertisement ethtool link mode mask
506  * @permit_pause_to_mac: permit forwarding pause resolution to MAC
507  *
508  * Configure the PCS for the operating mode, the interface mode, and set
509  * the advertisement mask. @permit_pause_to_mac indicates whether the
510  * hardware may forward the pause mode resolution to the MAC.
511  *
512  * When operating in %MLO_AN_INBAND, inband should always be enabled,
513  * otherwise inband should be disabled.
514  *
515  * For SGMII, there is no advertisement from the MAC side, the PCS should
516  * be programmed to acknowledge the inband word from the PHY.
517  *
518  * For 1000BASE-X, the advertisement should be programmed into the PCS.
519  *
520  * For most 10GBASE-R, there is no advertisement.
521  *
522  * The %neg_mode argument should be tested via the phylink_mode_*() family of
523  * functions, or for PCS that set pcs->neg_mode true, should be tested
524  * against the PHYLINK_PCS_NEG_* definitions.
525  */
526 int pcs_config(struct phylink_pcs *pcs, unsigned int neg_mode,
527 	       phy_interface_t interface, const unsigned long *advertising,
528 	       bool permit_pause_to_mac);
529 
530 /**
531  * pcs_an_restart() - restart 802.3z BaseX autonegotiation
532  * @pcs: a pointer to a &struct phylink_pcs.
533  *
534  * When PCS ops are present, this overrides mac_an_restart() in &struct
535  * phylink_mac_ops.
536  */
537 void pcs_an_restart(struct phylink_pcs *pcs);
538 
539 /**
540  * pcs_link_up() - program the PCS for the resolved link configuration
541  * @pcs: a pointer to a &struct phylink_pcs.
542  * @neg_mode: link negotiation mode (see below)
543  * @interface: link &typedef phy_interface_t mode
544  * @speed: link speed
545  * @duplex: link duplex
546  *
547  * This call will be made just before mac_link_up() to inform the PCS of
548  * the resolved link parameters. For example, a PCS operating in SGMII
549  * mode without in-band AN needs to be manually configured for the link
550  * and duplex setting. Otherwise, this should be a no-op.
551  *
552  * The %mode argument should be tested via the phylink_mode_*() family of
553  * functions, or for PCS that set pcs->neg_mode true, should be tested
554  * against the PHYLINK_PCS_NEG_* definitions.
555  */
556 void pcs_link_up(struct phylink_pcs *pcs, unsigned int neg_mode,
557 		 phy_interface_t interface, int speed, int duplex);
558 
559 /**
560  * pcs_pre_init() - Configure PCS components necessary for MAC initialization
561  * @pcs: a pointer to a &struct phylink_pcs.
562  *
563  * This function can be called by MAC drivers through the
564  * phylink_pcs_pre_init() wrapper, before their hardware is initialized. It
565  * should not be called after the link is brought up, as reconfiguring the PCS
566  * at this point could break the link.
567  *
568  * Some MAC devices require specific hardware initialization to be performed by
569  * their associated PCS device before they can properly initialize their own
570  * hardware. An example of this is the initialization of stmmac controllers,
571  * which requires an active REF_CLK signal to be provided by the PHY/PCS.
572  *
573  * By calling phylink_pcs_pre_init(), MAC drivers can ensure that the PCS is
574  * setup in a way that allows for successful hardware initialization.
575  *
576  * The specific configuration performed by pcs_pre_init() is dependent on the
577  * model of PCS and the requirements of the MAC device attached to it. PCS
578  * driver authors should consider whether their target device is to be used in
579  * conjunction with a MAC device whose driver calls phylink_pcs_pre_init(). MAC
580  * driver authors should document their requirements for the PCS
581  * pre-initialization.
582  *
583  */
584 int pcs_pre_init(struct phylink_pcs *pcs);
585 
586 #endif
587 
588 struct phylink *phylink_create(struct phylink_config *,
589 			       const struct fwnode_handle *,
590 			       phy_interface_t,
591 			       const struct phylink_mac_ops *);
592 void phylink_destroy(struct phylink *);
593 bool phylink_expects_phy(struct phylink *pl);
594 
595 int phylink_connect_phy(struct phylink *, struct phy_device *);
596 int phylink_of_phy_connect(struct phylink *, struct device_node *, u32 flags);
597 int phylink_fwnode_phy_connect(struct phylink *pl,
598 			       const struct fwnode_handle *fwnode,
599 			       u32 flags);
600 void phylink_disconnect_phy(struct phylink *);
601 int phylink_set_fixed_link(struct phylink *,
602 			   const struct phylink_link_state *);
603 
604 void phylink_mac_change(struct phylink *, bool up);
605 void phylink_pcs_change(struct phylink_pcs *, bool up);
606 
607 int phylink_pcs_pre_init(struct phylink *pl, struct phylink_pcs *pcs);
608 
609 void phylink_start(struct phylink *);
610 void phylink_stop(struct phylink *);
611 
612 void phylink_suspend(struct phylink *pl, bool mac_wol);
613 void phylink_resume(struct phylink *pl);
614 
615 void phylink_ethtool_get_wol(struct phylink *, struct ethtool_wolinfo *);
616 int phylink_ethtool_set_wol(struct phylink *, struct ethtool_wolinfo *);
617 
618 int phylink_ethtool_ksettings_get(struct phylink *,
619 				  struct ethtool_link_ksettings *);
620 int phylink_ethtool_ksettings_set(struct phylink *,
621 				  const struct ethtool_link_ksettings *);
622 int phylink_ethtool_nway_reset(struct phylink *);
623 void phylink_ethtool_get_pauseparam(struct phylink *,
624 				    struct ethtool_pauseparam *);
625 int phylink_ethtool_set_pauseparam(struct phylink *,
626 				   struct ethtool_pauseparam *);
627 int phylink_get_eee_err(struct phylink *);
628 int phylink_init_eee(struct phylink *, bool);
629 int phylink_ethtool_get_eee(struct phylink *link, struct ethtool_keee *eee);
630 int phylink_ethtool_set_eee(struct phylink *link, struct ethtool_keee *eee);
631 int phylink_mii_ioctl(struct phylink *, struct ifreq *, int);
632 int phylink_speed_down(struct phylink *pl, bool sync);
633 int phylink_speed_up(struct phylink *pl);
634 
635 #define phylink_zero(bm) \
636 	bitmap_zero(bm, __ETHTOOL_LINK_MODE_MASK_NBITS)
637 #define __phylink_do_bit(op, bm, mode) \
638 	op(ETHTOOL_LINK_MODE_ ## mode ## _BIT, bm)
639 
640 #define phylink_set(bm, mode)	__phylink_do_bit(__set_bit, bm, mode)
641 #define phylink_clear(bm, mode)	__phylink_do_bit(__clear_bit, bm, mode)
642 #define phylink_test(bm, mode)	__phylink_do_bit(test_bit, bm, mode)
643 
644 void phylink_set_port_modes(unsigned long *bits);
645 
646 /**
647  * phylink_get_link_timer_ns - return the PCS link timer value
648  * @interface: link &typedef phy_interface_t mode
649  *
650  * Return the PCS link timer setting in nanoseconds for the PHY @interface
651  * mode, or -EINVAL if not appropriate.
652  */
phylink_get_link_timer_ns(phy_interface_t interface)653 static inline int phylink_get_link_timer_ns(phy_interface_t interface)
654 {
655 	switch (interface) {
656 	case PHY_INTERFACE_MODE_SGMII:
657 	case PHY_INTERFACE_MODE_QSGMII:
658 	case PHY_INTERFACE_MODE_USXGMII:
659 	case PHY_INTERFACE_MODE_10G_QXGMII:
660 		return 1600000;
661 
662 	case PHY_INTERFACE_MODE_1000BASEX:
663 	case PHY_INTERFACE_MODE_2500BASEX:
664 		return 10000000;
665 
666 	default:
667 		return -EINVAL;
668 	}
669 }
670 
671 void phylink_mii_c22_pcs_decode_state(struct phylink_link_state *state,
672 				      u16 bmsr, u16 lpa);
673 void phylink_mii_c22_pcs_get_state(struct mdio_device *pcs,
674 				   struct phylink_link_state *state);
675 int phylink_mii_c22_pcs_encode_advertisement(phy_interface_t interface,
676 					     const unsigned long *advertising);
677 int phylink_mii_c22_pcs_config(struct mdio_device *pcs,
678 			       phy_interface_t interface,
679 			       const unsigned long *advertising,
680 			       unsigned int neg_mode);
681 void phylink_mii_c22_pcs_an_restart(struct mdio_device *pcs);
682 
683 void phylink_resolve_c73(struct phylink_link_state *state);
684 
685 void phylink_mii_c45_pcs_get_state(struct mdio_device *pcs,
686 				   struct phylink_link_state *state);
687 
688 void phylink_decode_usxgmii_word(struct phylink_link_state *state,
689 				 uint16_t lpa);
690 #endif
691