xref: /linux-6.15/include/linux/phylink.h (revision cd3bc044)
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 
13 enum {
14 	MLO_PAUSE_NONE,
15 	MLO_PAUSE_RX = BIT(0),
16 	MLO_PAUSE_TX = BIT(1),
17 	MLO_PAUSE_TXRX_MASK = MLO_PAUSE_TX | MLO_PAUSE_RX,
18 	MLO_PAUSE_AN = BIT(2),
19 
20 	MLO_AN_PHY = 0,	/* Conventional PHY */
21 	MLO_AN_FIXED,	/* Fixed-link mode */
22 	MLO_AN_INBAND,	/* In-band protocol */
23 
24 	MAC_SYM_PAUSE	= BIT(0),
25 	MAC_ASYM_PAUSE	= BIT(1),
26 	MAC_10HD	= BIT(2),
27 	MAC_10FD	= BIT(3),
28 	MAC_10		= MAC_10HD | MAC_10FD,
29 	MAC_100HD	= BIT(4),
30 	MAC_100FD	= BIT(5),
31 	MAC_100		= MAC_100HD | MAC_100FD,
32 	MAC_1000HD	= BIT(6),
33 	MAC_1000FD	= BIT(7),
34 	MAC_1000	= MAC_1000HD | MAC_1000FD,
35 	MAC_2500FD	= BIT(8),
36 	MAC_5000FD	= BIT(9),
37 	MAC_10000FD	= BIT(10),
38 	MAC_20000FD	= BIT(11),
39 	MAC_25000FD	= BIT(12),
40 	MAC_40000FD	= BIT(13),
41 	MAC_50000FD	= BIT(14),
42 	MAC_56000FD	= BIT(15),
43 	MAC_100000FD	= BIT(16),
44 	MAC_200000FD	= BIT(17),
45 	MAC_400000FD	= BIT(18),
46 };
47 
48 static inline bool phylink_autoneg_inband(unsigned int mode)
49 {
50 	return mode == MLO_AN_INBAND;
51 }
52 
53 /**
54  * struct phylink_link_state - link state structure
55  * @advertising: ethtool bitmask containing advertised link modes
56  * @lp_advertising: ethtool bitmask containing link partner advertised link
57  *   modes
58  * @interface: link &typedef phy_interface_t mode
59  * @speed: link speed, one of the SPEED_* constants.
60  * @duplex: link duplex mode, one of DUPLEX_* constants.
61  * @pause: link pause state, described by MLO_PAUSE_* constants.
62  * @link: true if the link is up.
63  * @an_enabled: true if autonegotiation is enabled/desired.
64  * @an_complete: true if autonegotiation has completed.
65  */
66 struct phylink_link_state {
67 	__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
68 	__ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
69 	phy_interface_t interface;
70 	int speed;
71 	int duplex;
72 	int pause;
73 	unsigned int link:1;
74 	unsigned int an_enabled:1;
75 	unsigned int an_complete:1;
76 };
77 
78 enum phylink_op_type {
79 	PHYLINK_NETDEV = 0,
80 	PHYLINK_DEV,
81 };
82 
83 /**
84  * struct phylink_config - PHYLINK configuration structure
85  * @dev: a pointer to a struct device associated with the MAC
86  * @type: operation type of PHYLINK instance
87  * @legacy_pre_march2020: driver has not been updated for March 2020 updates
88  *	(See commit 7cceb599d15d ("net: phylink: avoid mac_config calls")
89  * @pcs_poll: MAC PCS cannot provide link change interrupt
90  * @poll_fixed_state: if true, starts link_poll,
91  *		      if MAC link is at %MLO_AN_FIXED mode.
92  * @ovr_an_inband: if true, override PCS to MLO_AN_INBAND
93  * @get_fixed_state: callback to execute to determine the fixed link state,
94  *		     if MAC link is at %MLO_AN_FIXED mode.
95  * @supported_interfaces: bitmap describing which PHY_INTERFACE_MODE_xxx
96  *                        are supported by the MAC/PCS.
97  * @mac_capabilities: MAC pause/speed/duplex capabilities.
98  */
99 struct phylink_config {
100 	struct device *dev;
101 	enum phylink_op_type type;
102 	bool legacy_pre_march2020;
103 	bool pcs_poll;
104 	bool poll_fixed_state;
105 	bool ovr_an_inband;
106 	void (*get_fixed_state)(struct phylink_config *config,
107 				struct phylink_link_state *state);
108 	DECLARE_PHY_INTERFACE_MASK(supported_interfaces);
109 	unsigned long mac_capabilities;
110 };
111 
112 /**
113  * struct phylink_mac_ops - MAC operations structure.
114  * @validate: Validate and update the link configuration.
115  * @mac_select_pcs: Select a PCS for the interface mode.
116  * @mac_pcs_get_state: Read the current link state from the hardware.
117  * @mac_prepare: prepare for a major reconfiguration of the interface.
118  * @mac_config: configure the MAC for the selected mode and state.
119  * @mac_finish: finish a major reconfiguration of the interface.
120  * @mac_an_restart: restart 802.3z BaseX autonegotiation.
121  * @mac_link_down: take the link down.
122  * @mac_link_up: allow the link to come up.
123  *
124  * The individual methods are described more fully below.
125  */
126 struct phylink_mac_ops {
127 	void (*validate)(struct phylink_config *config,
128 			 unsigned long *supported,
129 			 struct phylink_link_state *state);
130 	struct phylink_pcs *(*mac_select_pcs)(struct phylink_config *config,
131 					      phy_interface_t interface);
132 	void (*mac_pcs_get_state)(struct phylink_config *config,
133 				  struct phylink_link_state *state);
134 	int (*mac_prepare)(struct phylink_config *config, unsigned int mode,
135 			   phy_interface_t iface);
136 	void (*mac_config)(struct phylink_config *config, unsigned int mode,
137 			   const struct phylink_link_state *state);
138 	int (*mac_finish)(struct phylink_config *config, unsigned int mode,
139 			  phy_interface_t iface);
140 	void (*mac_an_restart)(struct phylink_config *config);
141 	void (*mac_link_down)(struct phylink_config *config, unsigned int mode,
142 			      phy_interface_t interface);
143 	void (*mac_link_up)(struct phylink_config *config,
144 			    struct phy_device *phy, unsigned int mode,
145 			    phy_interface_t interface, int speed, int duplex,
146 			    bool tx_pause, bool rx_pause);
147 };
148 
149 #if 0 /* For kernel-doc purposes only. */
150 /**
151  * validate - Validate and update the link configuration
152  * @config: a pointer to a &struct phylink_config.
153  * @supported: ethtool bitmask for supported link modes.
154  * @state: a pointer to a &struct phylink_link_state.
155  *
156  * Clear bits in the @supported and @state->advertising masks that
157  * are not supportable by the MAC.
158  *
159  * Note that the PHY may be able to transform from one connection
160  * technology to another, so, eg, don't clear 1000BaseX just
161  * because the MAC is unable to BaseX mode. This is more about
162  * clearing unsupported speeds and duplex settings. The port modes
163  * should not be cleared; phylink_set_port_modes() will help with this.
164  *
165  * If the @state->interface mode is %PHY_INTERFACE_MODE_1000BASEX
166  * or %PHY_INTERFACE_MODE_2500BASEX, select the appropriate mode
167  * based on @state->advertising and/or @state->speed and update
168  * @state->interface accordingly. See phylink_helper_basex_speed().
169  *
170  * When @config->supported_interfaces has been set, phylink will iterate
171  * over the supported interfaces to determine the full capability of the
172  * MAC. The validation function must not print errors if @state->interface
173  * is set to an unexpected value.
174  *
175  * When @config->supported_interfaces is empty, phylink will call this
176  * function with @state->interface set to %PHY_INTERFACE_MODE_NA, and
177  * expects the MAC driver to return all supported link modes.
178  *
179  * If the @state->interface mode is not supported, then the @supported
180  * mask must be cleared.
181  */
182 void validate(struct phylink_config *config, unsigned long *supported,
183 	      struct phylink_link_state *state);
184 /**
185  * mac_select_pcs: Select a PCS for the interface mode.
186  * @config: a pointer to a &struct phylink_config.
187  * @interface: PHY interface mode for PCS
188  *
189  * Return the &struct phylink_pcs for the specified interface mode, or
190  * NULL if none is required, or an error pointer on error.
191  *
192  * This must not modify any state. It is used to query which PCS should
193  * be used. Phylink will use this during validation to ensure that the
194  * configuration is valid, and when setting a configuration to internally
195  * set the PCS that will be used.
196  */
197 struct phylink_pcs *mac_select_pcs(struct phylink_config *config,
198 				   phy_interface_t interface);
199 
200 /**
201  * mac_pcs_get_state() - Read the current inband link state from the hardware
202  * @config: a pointer to a &struct phylink_config.
203  * @state: a pointer to a &struct phylink_link_state.
204  *
205  * Read the current inband link state from the MAC PCS, reporting the
206  * current speed in @state->speed, duplex mode in @state->duplex, pause
207  * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits,
208  * negotiation completion state in @state->an_complete, and link up state
209  * in @state->link. If possible, @state->lp_advertising should also be
210  * populated.
211  *
212  * Note: This is a legacy method. This function will not be called unless
213  * legacy_pre_march2020 is set in &struct phylink_config and there is no
214  * PCS attached.
215  */
216 void mac_pcs_get_state(struct phylink_config *config,
217 		       struct phylink_link_state *state);
218 
219 /**
220  * mac_prepare() - prepare to change the PHY interface mode
221  * @config: a pointer to a &struct phylink_config.
222  * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
223  * @iface: interface mode to switch to
224  *
225  * phylink will call this method at the beginning of a full initialisation
226  * of the link, which includes changing the interface mode or at initial
227  * startup time. It may be called for the current mode. The MAC driver
228  * should perform whatever actions are required, e.g. disabling the
229  * Serdes PHY.
230  *
231  * This will be the first call in the sequence:
232  * - mac_prepare()
233  * - mac_config()
234  * - pcs_config()
235  * - possible pcs_an_restart()
236  * - mac_finish()
237  *
238  * Returns zero on success, or negative errno on failure which will be
239  * reported to the kernel log.
240  */
241 int mac_prepare(struct phylink_config *config, unsigned int mode,
242 		phy_interface_t iface);
243 
244 /**
245  * mac_config() - configure the MAC for the selected mode and state
246  * @config: a pointer to a &struct phylink_config.
247  * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
248  * @state: a pointer to a &struct phylink_link_state.
249  *
250  * Note - not all members of @state are valid.  In particular,
251  * @state->lp_advertising, @state->link, @state->an_complete are never
252  * guaranteed to be correct, and so any mac_config() implementation must
253  * never reference these fields.
254  *
255  * Note: For legacy March 2020 drivers (drivers with legacy_pre_march2020 set
256  * in their &phylnk_config and which don't have a PCS), this function will be
257  * called on each link up event, and to also change the in-band advert. For
258  * non-legacy drivers, it will only be called to reconfigure the MAC for a
259  * "major" change in e.g. interface mode. It will not be called for changes
260  * in speed, duplex or pause modes or to change the in-band advertisement.
261  * In any case, it is strongly preferred that speed, duplex and pause settings
262  * are handled in the mac_link_up() method and not in this method.
263  *
264  * (this requires a rewrite - please refer to mac_link_up() for situations
265  *  where the PCS and MAC are not tightly integrated.)
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  *   mac_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_an_restart() - restart 802.3z BaseX autonegotiation
347  * @config: a pointer to a &struct phylink_config.
348  *
349  * Note: This is a legacy method. This function will not be called unless
350  * legacy_pre_march2020 is set in &struct phylink_config and there is no
351  * PCS attached.
352  */
353 void mac_an_restart(struct phylink_config *config);
354 
355 /**
356  * mac_link_down() - take the link down
357  * @config: a pointer to a &struct phylink_config.
358  * @mode: link autonegotiation mode
359  * @interface: link &typedef phy_interface_t mode
360  *
361  * If @mode is not an in-band negotiation mode (as defined by
362  * phylink_autoneg_inband()), force the link down and disable any
363  * Energy Efficient Ethernet MAC configuration. Interface type
364  * selection must be done in mac_config().
365  */
366 void mac_link_down(struct phylink_config *config, unsigned int mode,
367 		   phy_interface_t interface);
368 
369 /**
370  * mac_link_up() - allow the link to come up
371  * @config: a pointer to a &struct phylink_config.
372  * @phy: any attached phy
373  * @mode: link autonegotiation mode
374  * @interface: link &typedef phy_interface_t mode
375  * @speed: link speed
376  * @duplex: link duplex
377  * @tx_pause: link transmit pause enablement status
378  * @rx_pause: link receive pause enablement status
379  *
380  * Configure the MAC for an established link.
381  *
382  * @speed, @duplex, @tx_pause and @rx_pause indicate the finalised link
383  * settings, and should be used to configure the MAC block appropriately
384  * where these settings are not automatically conveyed from the PCS block,
385  * or if in-band negotiation (as defined by phylink_autoneg_inband(@mode))
386  * is disabled.
387  *
388  * Note that when 802.3z in-band negotiation is in use, it is possible
389  * that the user wishes to override the pause settings, and this should
390  * be allowed when considering the implementation of this method.
391  *
392  * If in-band negotiation mode is disabled, allow the link to come up. If
393  * @phy is non-%NULL, configure Energy Efficient Ethernet by calling
394  * phy_init_eee() and perform appropriate MAC configuration for EEE.
395  * Interface type selection must be done in mac_config().
396  */
397 void mac_link_up(struct phylink_config *config, struct phy_device *phy,
398 		 unsigned int mode, phy_interface_t interface,
399 		 int speed, int duplex, bool tx_pause, bool rx_pause);
400 #endif
401 
402 struct phylink_pcs_ops;
403 
404 /**
405  * struct phylink_pcs - PHYLINK PCS instance
406  * @ops: a pointer to the &struct phylink_pcs_ops structure
407  * @poll: poll the PCS for link changes
408  *
409  * This structure is designed to be embedded within the PCS private data,
410  * and will be passed between phylink and the PCS.
411  */
412 struct phylink_pcs {
413 	const struct phylink_pcs_ops *ops;
414 	bool poll;
415 };
416 
417 /**
418  * struct phylink_pcs_ops - MAC PCS operations structure.
419  * @pcs_validate: validate the link configuration.
420  * @pcs_get_state: read the current MAC PCS link state from the hardware.
421  * @pcs_config: configure the MAC PCS for the selected mode and state.
422  * @pcs_an_restart: restart 802.3z BaseX autonegotiation.
423  * @pcs_link_up: program the PCS for the resolved link configuration
424  *               (where necessary).
425  */
426 struct phylink_pcs_ops {
427 	int (*pcs_validate)(struct phylink_pcs *pcs, unsigned long *supported,
428 			    const struct phylink_link_state *state);
429 	void (*pcs_get_state)(struct phylink_pcs *pcs,
430 			      struct phylink_link_state *state);
431 	int (*pcs_config)(struct phylink_pcs *pcs, unsigned int mode,
432 			  phy_interface_t interface,
433 			  const unsigned long *advertising,
434 			  bool permit_pause_to_mac);
435 	void (*pcs_an_restart)(struct phylink_pcs *pcs);
436 	void (*pcs_link_up)(struct phylink_pcs *pcs, unsigned int mode,
437 			    phy_interface_t interface, int speed, int duplex);
438 };
439 
440 #if 0 /* For kernel-doc purposes only. */
441 /**
442  * pcs_validate() - validate the link configuration.
443  * @pcs: a pointer to a &struct phylink_pcs.
444  * @supported: ethtool bitmask for supported link modes.
445  * @state: a const pointer to a &struct phylink_link_state.
446  *
447  * Validate the interface mode, and advertising's autoneg bit, removing any
448  * media ethtool link modes that would not be supportable from the supported
449  * mask. Phylink will propagate the changes to the advertising mask. See the
450  * &struct phylink_mac_ops validate() method.
451  *
452  * Returns -EINVAL if the interface mode/autoneg mode is not supported.
453  * Returns non-zero positive if the link state can be supported.
454  */
455 int pcs_validate(struct phylink_pcs *pcs, unsigned long *supported,
456 		 const struct phylink_link_state *state);
457 
458 /**
459  * pcs_get_state() - Read the current inband link state from the hardware
460  * @pcs: a pointer to a &struct phylink_pcs.
461  * @state: a pointer to a &struct phylink_link_state.
462  *
463  * Read the current inband link state from the MAC PCS, reporting the
464  * current speed in @state->speed, duplex mode in @state->duplex, pause
465  * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits,
466  * negotiation completion state in @state->an_complete, and link up state
467  * in @state->link. If possible, @state->lp_advertising should also be
468  * populated.
469  *
470  * When present, this overrides mac_pcs_get_state() in &struct
471  * phylink_mac_ops.
472  */
473 void pcs_get_state(struct phylink_pcs *pcs,
474 		   struct phylink_link_state *state);
475 
476 /**
477  * pcs_config() - Configure the PCS mode and advertisement
478  * @pcs: a pointer to a &struct phylink_pcs.
479  * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
480  * @interface: interface mode to be used
481  * @advertising: adertisement ethtool link mode mask
482  * @permit_pause_to_mac: permit forwarding pause resolution to MAC
483  *
484  * Configure the PCS for the operating mode, the interface mode, and set
485  * the advertisement mask. @permit_pause_to_mac indicates whether the
486  * hardware may forward the pause mode resolution to the MAC.
487  *
488  * When operating in %MLO_AN_INBAND, inband should always be enabled,
489  * otherwise inband should be disabled.
490  *
491  * For SGMII, there is no advertisement from the MAC side, the PCS should
492  * be programmed to acknowledge the inband word from the PHY.
493  *
494  * For 1000BASE-X, the advertisement should be programmed into the PCS.
495  *
496  * For most 10GBASE-R, there is no advertisement.
497  */
498 int pcs_config(struct phylink_pcs *pcs, unsigned int mode,
499 	       phy_interface_t interface, const unsigned long *advertising,
500 	       bool permit_pause_to_mac);
501 
502 /**
503  * pcs_an_restart() - restart 802.3z BaseX autonegotiation
504  * @pcs: a pointer to a &struct phylink_pcs.
505  *
506  * When PCS ops are present, this overrides mac_an_restart() in &struct
507  * phylink_mac_ops.
508  */
509 void pcs_an_restart(struct phylink_pcs *pcs);
510 
511 /**
512  * pcs_link_up() - program the PCS for the resolved link configuration
513  * @pcs: a pointer to a &struct phylink_pcs.
514  * @mode: link autonegotiation mode
515  * @interface: link &typedef phy_interface_t mode
516  * @speed: link speed
517  * @duplex: link duplex
518  *
519  * This call will be made just before mac_link_up() to inform the PCS of
520  * the resolved link parameters. For example, a PCS operating in SGMII
521  * mode without in-band AN needs to be manually configured for the link
522  * and duplex setting. Otherwise, this should be a no-op.
523  */
524 void pcs_link_up(struct phylink_pcs *pcs, unsigned int mode,
525 		 phy_interface_t interface, int speed, int duplex);
526 #endif
527 
528 void phylink_get_linkmodes(unsigned long *linkmodes, phy_interface_t interface,
529 			   unsigned long mac_capabilities);
530 void phylink_generic_validate(struct phylink_config *config,
531 			      unsigned long *supported,
532 			      struct phylink_link_state *state);
533 
534 struct phylink *phylink_create(struct phylink_config *, struct fwnode_handle *,
535 			       phy_interface_t iface,
536 			       const struct phylink_mac_ops *mac_ops);
537 void phylink_set_pcs(struct phylink *, struct phylink_pcs *pcs);
538 void phylink_destroy(struct phylink *);
539 
540 int phylink_connect_phy(struct phylink *, struct phy_device *);
541 int phylink_of_phy_connect(struct phylink *, struct device_node *, u32 flags);
542 int phylink_fwnode_phy_connect(struct phylink *pl,
543 			       struct fwnode_handle *fwnode,
544 			       u32 flags);
545 void phylink_disconnect_phy(struct phylink *);
546 
547 void phylink_mac_change(struct phylink *, bool up);
548 
549 void phylink_start(struct phylink *);
550 void phylink_stop(struct phylink *);
551 
552 void phylink_suspend(struct phylink *pl, bool mac_wol);
553 void phylink_resume(struct phylink *pl);
554 
555 void phylink_ethtool_get_wol(struct phylink *, struct ethtool_wolinfo *);
556 int phylink_ethtool_set_wol(struct phylink *, struct ethtool_wolinfo *);
557 
558 int phylink_ethtool_ksettings_get(struct phylink *,
559 				  struct ethtool_link_ksettings *);
560 int phylink_ethtool_ksettings_set(struct phylink *,
561 				  const struct ethtool_link_ksettings *);
562 int phylink_ethtool_nway_reset(struct phylink *);
563 void phylink_ethtool_get_pauseparam(struct phylink *,
564 				    struct ethtool_pauseparam *);
565 int phylink_ethtool_set_pauseparam(struct phylink *,
566 				   struct ethtool_pauseparam *);
567 int phylink_get_eee_err(struct phylink *);
568 int phylink_init_eee(struct phylink *, bool);
569 int phylink_ethtool_get_eee(struct phylink *, struct ethtool_eee *);
570 int phylink_ethtool_set_eee(struct phylink *, struct ethtool_eee *);
571 int phylink_mii_ioctl(struct phylink *, struct ifreq *, int);
572 int phylink_speed_down(struct phylink *pl, bool sync);
573 int phylink_speed_up(struct phylink *pl);
574 
575 #define phylink_zero(bm) \
576 	bitmap_zero(bm, __ETHTOOL_LINK_MODE_MASK_NBITS)
577 #define __phylink_do_bit(op, bm, mode) \
578 	op(ETHTOOL_LINK_MODE_ ## mode ## _BIT, bm)
579 
580 #define phylink_set(bm, mode)	__phylink_do_bit(__set_bit, bm, mode)
581 #define phylink_clear(bm, mode)	__phylink_do_bit(__clear_bit, bm, mode)
582 #define phylink_test(bm, mode)	__phylink_do_bit(test_bit, bm, mode)
583 
584 void phylink_set_port_modes(unsigned long *bits);
585 void phylink_set_10g_modes(unsigned long *mask);
586 void phylink_helper_basex_speed(struct phylink_link_state *state);
587 
588 void phylink_mii_c22_pcs_decode_state(struct phylink_link_state *state,
589 				      u16 bmsr, u16 lpa);
590 void phylink_mii_c22_pcs_get_state(struct mdio_device *pcs,
591 				   struct phylink_link_state *state);
592 int phylink_mii_c22_pcs_encode_advertisement(phy_interface_t interface,
593 					     const unsigned long *advertising);
594 int phylink_mii_c22_pcs_config(struct mdio_device *pcs, unsigned int mode,
595 			       phy_interface_t interface,
596 			       const unsigned long *advertising);
597 void phylink_mii_c22_pcs_an_restart(struct mdio_device *pcs);
598 
599 void phylink_mii_c45_pcs_get_state(struct mdio_device *pcs,
600 				   struct phylink_link_state *state);
601 
602 void phylink_decode_usxgmii_word(struct phylink_link_state *state,
603 				 uint16_t lpa);
604 #endif
605