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