phylink.h

  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#include <net/eee.h>
  9
 10struct device_node;
 11struct ethtool_cmd;
 12struct fwnode_handle;
 13struct net_device;
 14struct phylink;
 15
 16enum {
 17	MLO_PAUSE_NONE,
 18	MLO_PAUSE_RX = BIT(0),
 19	MLO_PAUSE_TX = BIT(1),
 20	MLO_PAUSE_TXRX_MASK = MLO_PAUSE_TX | MLO_PAUSE_RX,
 21	MLO_PAUSE_AN = BIT(2),
 22
 23	MLO_AN_PHY = 0,	/* Conventional PHY */
 24	MLO_AN_FIXED,	/* Fixed-link mode */
 25	MLO_AN_INBAND,	/* In-band protocol */
 26
 27	/* PCS "negotiation" mode.
 28	 *  PHYLINK_PCS_NEG_NONE - protocol has no inband capability
 29	 *  PHYLINK_PCS_NEG_OUTBAND - some out of band or fixed link setting
 30	 *  PHYLINK_PCS_NEG_INBAND_DISABLED - inband mode disabled, e.g.
 31	 *				      1000base-X with autoneg off
 32	 *  PHYLINK_PCS_NEG_INBAND_ENABLED - inband mode enabled
 33	 * Additionally, this can be tested using bitmasks:
 34	 *  PHYLINK_PCS_NEG_INBAND - inband mode selected
 35	 *  PHYLINK_PCS_NEG_ENABLED - negotiation mode enabled
 36	 */
 37	PHYLINK_PCS_NEG_NONE = 0,
 38	PHYLINK_PCS_NEG_ENABLED = BIT(4),
 39	PHYLINK_PCS_NEG_OUTBAND = BIT(5),
 40	PHYLINK_PCS_NEG_INBAND = BIT(6),
 41	PHYLINK_PCS_NEG_INBAND_DISABLED = PHYLINK_PCS_NEG_INBAND,
 42	PHYLINK_PCS_NEG_INBAND_ENABLED = PHYLINK_PCS_NEG_INBAND |
 43					 PHYLINK_PCS_NEG_ENABLED,
 44
 45	/* MAC_SYM_PAUSE and MAC_ASYM_PAUSE are used when configuring our
 46	 * autonegotiation advertisement. They correspond to the PAUSE and
 47	 * ASM_DIR bits defined by 802.3, respectively.
 48	 *
 49	 * The following table lists the values of tx_pause and rx_pause which
 50	 * might be requested in mac_link_up. The exact values depend on either
 51	 * the results of autonegotation (if MLO_PAUSE_AN is set) or user
 52	 * configuration (if MLO_PAUSE_AN is not set).
 53	 *
 54	 * MAC_SYM_PAUSE MAC_ASYM_PAUSE MLO_PAUSE_AN tx_pause/rx_pause
 55	 * ============= ============== ============ ==================
 56	 *             0              0            0 0/0
 57	 *             0              0            1 0/0
 58	 *             0              1            0 0/0, 0/1, 1/0, 1/1
 59	 *             0              1            1 0/0,      1/0
 60	 *             1              0            0 0/0,           1/1
 61	 *             1              0            1 0/0,           1/1
 62	 *             1              1            0 0/0, 0/1, 1/0, 1/1
 63	 *             1              1            1 0/0, 0/1,      1/1
 64	 *
 65	 * If you set MAC_ASYM_PAUSE, the user may request any combination of
 66	 * tx_pause and rx_pause. You do not have to support these
 67	 * combinations.
 68	 *
 69	 * However, you should support combinations of tx_pause and rx_pause
 70	 * which might be the result of autonegotation. For example, don't set
 71	 * MAC_SYM_PAUSE unless your device can support tx_pause and rx_pause
 72	 * at the same time.
 73	 */
 74	MAC_SYM_PAUSE	= BIT(0),
 75	MAC_ASYM_PAUSE	= BIT(1),
 76	MAC_10HD	= BIT(2),
 77	MAC_10FD	= BIT(3),
 78	MAC_10		= MAC_10HD | MAC_10FD,
 79	MAC_100HD	= BIT(4),
 80	MAC_100FD	= BIT(5),
 81	MAC_100		= MAC_100HD | MAC_100FD,
 82	MAC_1000HD	= BIT(6),
 83	MAC_1000FD	= BIT(7),
 84	MAC_1000	= MAC_1000HD | MAC_1000FD,
 85	MAC_2500FD	= BIT(8),
 86	MAC_5000FD	= BIT(9),
 87	MAC_10000FD	= BIT(10),
 88	MAC_20000FD	= BIT(11),
 89	MAC_25000FD	= BIT(12),
 90	MAC_40000FD	= BIT(13),
 91	MAC_50000FD	= BIT(14),
 92	MAC_56000FD	= BIT(15),
 93	MAC_100000FD	= BIT(16),
 94	MAC_200000FD	= BIT(17),
 95	MAC_400000FD	= BIT(18),
 96};
 97
 98static inline bool phylink_autoneg_inband(unsigned int mode)
 99{
100	return mode == MLO_AN_INBAND;
101}
102
103/**
104 * struct phylink_link_state - link state structure
105 * @advertising: ethtool bitmask containing advertised link modes
106 * @lp_advertising: ethtool bitmask containing link partner advertised link
107 *   modes
108 * @interface: link &typedef phy_interface_t mode
109 * @speed: link speed, one of the SPEED_* constants.
110 * @duplex: link duplex mode, one of DUPLEX_* constants.
111 * @pause: link pause state, described by MLO_PAUSE_* constants.
112 * @rate_matching: rate matching being performed, one of the RATE_MATCH_*
113 *   constants. If rate matching is taking place, then the speed/duplex of
114 *   the medium link mode (@speed and @duplex) and the speed/duplex of the phy
115 *   interface mode (@interface) are different.
116 * @link: true if the link is up.
117 * @an_complete: true if autonegotiation has completed.
118 */
119struct phylink_link_state {
120	__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
121	__ETHTOOL_DECLARE_LINK_MODE_MASK(lp_advertising);
122	phy_interface_t interface;
123	int speed;
124	int duplex;
125	int pause;
126	int rate_matching;
127	unsigned int link:1;
128	unsigned int an_complete:1;
129};
130
131enum phylink_op_type {
132	PHYLINK_NETDEV = 0,
133	PHYLINK_DEV,
134};
135
136/**
137 * struct phylink_config - PHYLINK configuration structure
138 * @dev: a pointer to a struct device associated with the MAC
139 * @type: operation type of PHYLINK instance
140 * @poll_fixed_state: if true, starts link_poll,
141 *		      if MAC link is at %MLO_AN_FIXED mode.
142 * @mac_managed_pm: if true, indicate the MAC driver is responsible for PHY PM.
143 * @mac_requires_rxc: if true, the MAC always requires a receive clock from PHY.
144 *                    The PHY driver should start the clock signal as soon as
145 *                    possible and avoid stopping it during suspend events.
146 * @default_an_inband: if true, defaults to MLO_AN_INBAND rather than
147 *		       MLO_AN_PHY. A fixed-link specification will override.
148 * @eee_rx_clk_stop_enable: if true, PHY can stop the receive clock during LPI
149 * @get_fixed_state: callback to execute to determine the fixed link state,
150 *		     if MAC link is at %MLO_AN_FIXED mode.
151 * @supported_interfaces: bitmap describing which PHY_INTERFACE_MODE_xxx
152 *                        are supported by the MAC/PCS.
153 * @lpi_interfaces: bitmap describing which PHY interface modes can support
154 *		    LPI signalling.
155 * @mac_capabilities: MAC pause/speed/duplex capabilities.
156 * @lpi_capabilities: MAC speeds which can support LPI signalling
157 * @lpi_timer_default: Default EEE LPI timer setting.
158 * @eee_enabled_default: If set, EEE will be enabled by phylink at creation time
159 * @wol_phy_legacy: Use Wake-on-Lan with PHY even if phy_can_wakeup() is false
160 * @wol_phy_speed_ctrl: Use phy speed control on suspend/resume
161 * @wol_mac_support: Bitmask of MAC supported %WAKE_* options
162 */
163struct phylink_config {
164	struct device *dev;
165	enum phylink_op_type type;
166	bool poll_fixed_state;
167	bool mac_managed_pm;
168	bool mac_requires_rxc;
169	bool default_an_inband;
170	bool eee_rx_clk_stop_enable;
171	void (*get_fixed_state)(struct phylink_config *config,
172				struct phylink_link_state *state);
173	DECLARE_PHY_INTERFACE_MASK(supported_interfaces);
174	DECLARE_PHY_INTERFACE_MASK(lpi_interfaces);
175	unsigned long mac_capabilities;
176	unsigned long lpi_capabilities;
177	u32 lpi_timer_default;
178	bool eee_enabled_default;
179
180	/* Wake-on-Lan support */
181	bool wol_phy_legacy;
182	bool wol_phy_speed_ctrl;
183	u32 wol_mac_support;
184};
185
186void phylink_limit_mac_speed(struct phylink_config *config, u32 max_speed);
187
188/**
189 * struct phylink_mac_ops - MAC operations structure.
190 * @mac_get_caps: Get MAC capabilities for interface mode.
191 * @mac_select_pcs: Select a PCS for the interface mode.
192 * @mac_prepare: prepare for a major reconfiguration of the interface.
193 * @mac_config: configure the MAC for the selected mode and state.
194 * @mac_finish: finish a major reconfiguration of the interface.
195 * @mac_link_down: take the link down.
196 * @mac_link_up: allow the link to come up.
197 * @mac_disable_tx_lpi: disable LPI.
198 * @mac_enable_tx_lpi: enable and configure LPI.
199 * @mac_wol_set: configure Wake-on-Lan settings at the MAC.
200 *
201 * The individual methods are described more fully below.
202 */
203struct phylink_mac_ops {
204	unsigned long (*mac_get_caps)(struct phylink_config *config,
205				      phy_interface_t interface);
206	struct phylink_pcs *(*mac_select_pcs)(struct phylink_config *config,
207					      phy_interface_t interface);
208	int (*mac_prepare)(struct phylink_config *config, unsigned int mode,
209			   phy_interface_t iface);
210	void (*mac_config)(struct phylink_config *config, unsigned int mode,
211			   const struct phylink_link_state *state);
212	int (*mac_finish)(struct phylink_config *config, unsigned int mode,
213			  phy_interface_t iface);
214	void (*mac_link_down)(struct phylink_config *config, unsigned int mode,
215			      phy_interface_t interface);
216	void (*mac_link_up)(struct phylink_config *config,
217			    struct phy_device *phy, unsigned int mode,
218			    phy_interface_t interface, int speed, int duplex,
219			    bool tx_pause, bool rx_pause);
220	void (*mac_disable_tx_lpi)(struct phylink_config *config);
221	int (*mac_enable_tx_lpi)(struct phylink_config *config, u32 timer,
222				 bool tx_clk_stop);
223
224	int (*mac_wol_set)(struct phylink_config *config, u32 wolopts,
225			   const u8 *sopass);
226};
227
228#if 0 /* For kernel-doc purposes only. */
229/**
230 * mac_get_caps: Get MAC capabilities for interface mode.
231 * @config: a pointer to a &struct phylink_config.
232 * @interface: PHY interface mode.
233 *
234 * Optional method. When not provided, config->mac_capabilities will be used.
235 * When implemented, this returns the MAC capabilities for the specified
236 * interface mode where there is some special handling required by the MAC
237 * driver (e.g. not supporting half-duplex in certain interface modes.)
238 */
239unsigned long mac_get_caps(struct phylink_config *config,
240			   phy_interface_t interface);
241/**
242 * mac_select_pcs: Select a PCS for the interface mode.
243 * @config: a pointer to a &struct phylink_config.
244 * @interface: PHY interface mode for PCS
245 *
246 * Return the &struct phylink_pcs for the specified interface mode, or
247 * NULL if none is required, or an error pointer on error.
248 *
249 * This must not modify any state. It is used to query which PCS should
250 * be used. Phylink will use this during validation to ensure that the
251 * configuration is valid, and when setting a configuration to internally
252 * set the PCS that will be used.
253 */
254struct phylink_pcs *mac_select_pcs(struct phylink_config *config,
255				   phy_interface_t interface);
256
257/**
258 * mac_prepare() - prepare to change the PHY interface mode
259 * @config: a pointer to a &struct phylink_config.
260 * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
261 * @iface: interface mode to switch to
262 *
263 * phylink will call this method at the beginning of a full initialisation
264 * of the link, which includes changing the interface mode or at initial
265 * startup time. It may be called for the current mode. The MAC driver
266 * should perform whatever actions are required, e.g. disabling the
267 * Serdes PHY.
268 *
269 * This will be the first call in the sequence:
270 * - mac_prepare()
271 * - mac_config()
272 * - pcs_config()
273 * - possible pcs_an_restart()
274 * - mac_finish()
275 *
276 * Returns zero on success, or negative errno on failure which will be
277 * reported to the kernel log.
278 */
279int mac_prepare(struct phylink_config *config, unsigned int mode,
280		phy_interface_t iface);
281
282/**
283 * mac_config() - configure the MAC for the selected mode and state
284 * @config: a pointer to a &struct phylink_config.
285 * @mode: one of %MLO_AN_FIXED, %MLO_AN_PHY, %MLO_AN_INBAND.
286 * @state: a pointer to a &struct phylink_link_state.
287 *
288 * Note - not all members of @state are valid.  In particular,
289 * @state->lp_advertising, @state->link, @state->an_complete are never
290 * guaranteed to be correct, and so any mac_config() implementation must
291 * never reference these fields.
292 *
293 * This will only be called to reconfigure the MAC for a "major" change in
294 * e.g. interface mode. It will not be called for changes in speed, duplex
295 * or pause modes or to change the in-band advertisement.
296 *
297 * In all negotiation modes, as defined by @mode, @state->pause indicates the
298 * pause settings which should be applied as follows. If %MLO_PAUSE_AN is not
299 * set, %MLO_PAUSE_TX and %MLO_PAUSE_RX indicate whether the MAC should send
300 * pause frames and/or act on received pause frames respectively. Otherwise,
301 * the results of in-band negotiation/status from the MAC PCS should be used
302 * to control the MAC pause mode settings.
303 *
304 * The action performed depends on the currently selected mode:
305 *
306 * %MLO_AN_FIXED, %MLO_AN_PHY:
307 *   Configure for non-inband negotiation mode, where the link settings
308 *   are completely communicated via mac_link_up().  The physical link
309 *   protocol from the MAC is specified by @state->interface.
310 *
311 *   @state->advertising may be used, but is not required.
312 *
313 *   Older drivers (prior to the mac_link_up() change) may use @state->speed,
314 *   @state->duplex and @state->pause to configure the MAC, but this is
315 *   deprecated; such drivers should be converted to use mac_link_up().
316 *
317 *   Other members of @state must be ignored.
318 *
319 *   Valid state members: interface, advertising.
320 *   Deprecated state members: speed, duplex, pause.
321 *
322 * %MLO_AN_INBAND:
323 *   place the link in an inband negotiation mode (such as 802.3z
324 *   1000base-X or Cisco SGMII mode depending on the @state->interface
325 *   mode). In both cases, link state management (whether the link
326 *   is up or not) is performed by the MAC, and reported via the
327 *   pcs_get_state() callback. Changes in link state must be made
328 *   by calling phylink_mac_change().
329 *
330 *   Interface mode specific details are mentioned below.
331 *
332 *   If in 802.3z mode, the link speed is fixed, dependent on the
333 *   @state->interface. Duplex and pause modes are negotiated via
334 *   the in-band configuration word. Advertised pause modes are set
335 *   according to @state->advertising. Beware of MACs which only
336 *   support full duplex at gigabit 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, 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 */
354void 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 */
371int mac_finish(struct phylink_config *config, unsigned int mode,
372		phy_interface_t iface);
373
374/**
375 * mac_link_down() - notification that the link has gone down
376 * @config: a pointer to a &struct phylink_config.
377 * @mode: link autonegotiation mode
378 * @interface: link &typedef phy_interface_t mode
379 *
380 * Notifies the MAC that the link has gone down. This will not be called
381 * unless mac_link_up() has been previously called.
382 *
383 * The MAC should stop processing packets for transmission and reception.
384 * phylink will have called netif_carrier_off() to notify the networking
385 * stack that the link has gone down, so MAC drivers should not make this
386 * call.
387 *
388 * If @mode is %MLO_AN_INBAND, then this function must not prevent the
389 * link coming up.
390 */
391void mac_link_down(struct phylink_config *config, unsigned int mode,
392		   phy_interface_t interface);
393
394/**
395 * mac_link_up() - notification that the link has come up
396 * @config: a pointer to a &struct phylink_config.
397 * @phy: any attached phy (deprecated - please use LPI interfaces)
398 * @mode: link autonegotiation mode
399 * @interface: link &typedef phy_interface_t mode
400 * @speed: link speed
401 * @duplex: link duplex
402 * @tx_pause: link transmit pause enablement status
403 * @rx_pause: link receive pause enablement status
404 *
405 * Notifies the MAC that the link has come up, and the parameters of the
406 * link as seen from the MACs point of view. If mac_link_up() has been
407 * called previously, there will be an intervening call to mac_link_down()
408 * before this method will be subsequently called.
409 *
410 * @speed, @duplex, @tx_pause and @rx_pause indicate the finalised link
411 * settings, and should be used to configure the MAC block appropriately
412 * where these settings are not automatically conveyed from the PCS block,
413 * or if in-band negotiation (as defined by phylink_autoneg_inband(@mode))
414 * is disabled.
415 *
416 * Note that when 802.3z in-band negotiation is in use, it is possible
417 * that the user wishes to override the pause settings, and this should
418 * be allowed when considering the implementation of this method.
419 *
420 * Once configured, the MAC may begin to process packets for transmission
421 * and reception.
422 *
423 * Interface type selection must be done in mac_config().
424 */
425void mac_link_up(struct phylink_config *config, struct phy_device *phy,
426		 unsigned int mode, phy_interface_t interface,
427		 int speed, int duplex, bool tx_pause, bool rx_pause);
428
429/**
430 * mac_disable_tx_lpi() - disable LPI generation at the MAC
431 * @config: a pointer to a &struct phylink_config.
432 *
433 * Disable generation of LPI at the MAC, effectively preventing the MAC
434 * from indicating that it is idle.
435 */
436void mac_disable_tx_lpi(struct phylink_config *config);
437
438/**
439 * mac_enable_tx_lpi() - configure and enable LPI generation at the MAC
440 * @config: a pointer to a &struct phylink_config.
441 * @timer: LPI timeout in microseconds.
442 * @tx_clk_stop: allow xMII transmit clock to be stopped during LPI
443 *
444 * Configure the LPI timeout accordingly. This will only be called when
445 * the link is already up, to cater for situations where the hardware
446 * needs to be programmed according to the link speed.
447 *
448 * Enable LPI generation at the MAC, and configure whether the xMII transmit
449 * clock may be stopped.
450 *
451 * Returns: 0 on success. Please consult with rmk before returning an error.
452 */
453int mac_enable_tx_lpi(struct phylink_config *config, u32 timer,
454		      bool tx_clk_stop);
455
456/**
457 * mac_wol_set() - configure the Wake-on-Lan parameters
458 * @config: a pointer to a &struct phylink_config.
459 * @wolopts: Bitmask of %WAKE_* flags for enabled Wake-On-Lan modes.
460 * @sopass: SecureOn(tm) password; meaningful only for %WAKE_MAGICSECURE
461 *
462 * Enable the specified Wake-on-Lan options at the MAC. Options that the
463 * PHY can handle will have been removed from @wolopts.
464 *
465 * The presence of this method enables phylink-managed WoL support.
466 *
467 * Returns: 0 on success.
468 */
469int (*mac_wol_set)(struct phylink_config *config, u32 wolopts,
470		   const u8 *sopass);
471#endif
472
473struct phylink_pcs_ops;
474
475/**
476 * struct phylink_pcs - PHYLINK PCS instance
477 * @supported_interfaces: describing which PHY_INTERFACE_MODE_xxx
478 *                        are supported by this PCS.
479 * @ops: a pointer to the &struct phylink_pcs_ops structure
480 * @phylink: pointer to &struct phylink_config
481 * @poll: poll the PCS for link changes
482 * @rxc_always_on: The MAC driver requires the reference clock
483 *                 to always be on. Standalone PCS drivers which
484 *                 do not have access to a PHY device can check
485 *                 this instead of PHY_F_RXC_ALWAYS_ON.
486 *
487 * This structure is designed to be embedded within the PCS private data,
488 * and will be passed between phylink and the PCS.
489 *
490 * The @phylink member is private to phylink and must not be touched by
491 * the PCS driver.
492 */
493struct phylink_pcs {
494	DECLARE_PHY_INTERFACE_MASK(supported_interfaces);
495	const struct phylink_pcs_ops *ops;
496	struct phylink *phylink;
497	bool poll;
498	bool rxc_always_on;
499};
500
501/**
502 * struct phylink_pcs_ops - MAC PCS operations structure.
503 * @pcs_validate: validate the link configuration.
504 * @pcs_inband_caps: query inband support for interface mode.
505 * @pcs_enable: enable the PCS.
506 * @pcs_disable: disable the PCS.
507 * @pcs_pre_config: pre-mac_config method (for errata)
508 * @pcs_post_config: post-mac_config method (for arrata)
509 * @pcs_get_state: read the current MAC PCS link state from the hardware.
510 * @pcs_config: configure the MAC PCS for the selected mode and state.
511 * @pcs_an_restart: restart 802.3z BaseX autonegotiation.
512 * @pcs_link_up: program the PCS for the resolved link configuration
513 *               (where necessary).
514 * @pcs_disable_eee: optional notification to PCS that EEE has been disabled
515 *		     at the MAC.
516 * @pcs_enable_eee: optional notification to PCS that EEE will be enabled at
517 *		    the MAC.
518 * @pcs_pre_init: configure PCS components necessary for MAC hardware
519 *                initialization e.g. RX clock for stmmac.
520 */
521struct phylink_pcs_ops {
522	int (*pcs_validate)(struct phylink_pcs *pcs, unsigned long *supported,
523			    const struct phylink_link_state *state);
524	unsigned int (*pcs_inband_caps)(struct phylink_pcs *pcs,
525					phy_interface_t interface);
526	int (*pcs_enable)(struct phylink_pcs *pcs);
527	void (*pcs_disable)(struct phylink_pcs *pcs);
528	void (*pcs_pre_config)(struct phylink_pcs *pcs,
529			       phy_interface_t interface);
530	int (*pcs_post_config)(struct phylink_pcs *pcs,
531			       phy_interface_t interface);
532	void (*pcs_get_state)(struct phylink_pcs *pcs, unsigned int neg_mode,
533			      struct phylink_link_state *state);
534	int (*pcs_config)(struct phylink_pcs *pcs, unsigned int neg_mode,
535			  phy_interface_t interface,
536			  const unsigned long *advertising,
537			  bool permit_pause_to_mac);
538	void (*pcs_an_restart)(struct phylink_pcs *pcs);
539	void (*pcs_link_up)(struct phylink_pcs *pcs, unsigned int neg_mode,
540			    phy_interface_t interface, int speed, int duplex);
541	void (*pcs_disable_eee)(struct phylink_pcs *pcs);
542	void (*pcs_enable_eee)(struct phylink_pcs *pcs);
543	int (*pcs_pre_init)(struct phylink_pcs *pcs);
544};
545
546#if 0 /* For kernel-doc purposes only. */
547/**
548 * pcs_validate() - validate the link configuration.
549 * @pcs: a pointer to a &struct phylink_pcs.
550 * @supported: ethtool bitmask for supported link modes.
551 * @state: a const pointer to a &struct phylink_link_state.
552 *
553 * Validate the interface mode, and advertising's autoneg bit, removing any
554 * media ethtool link modes that would not be supportable from the supported
555 * mask. Phylink will propagate the changes to the advertising mask. See the
556 * &struct phylink_mac_ops validate() method.
557 *
558 * Returns -EINVAL if the interface mode/autoneg mode is not supported.
559 * Returns non-zero positive if the link state can be supported.
560 */
561int pcs_validate(struct phylink_pcs *pcs, unsigned long *supported,
562		 const struct phylink_link_state *state);
563
564/**
565 * pcs_inband_caps - query PCS in-band capabilities for interface mode.
566 * @pcs: a pointer to a &struct phylink_pcs.
567 * @interface: interface mode to be queried
568 *
569 * Returns zero if it is unknown what in-band signalling is supported by the
570 * PHY (e.g. because the PHY driver doesn't implement the method.) Otherwise,
571 * returns a bit mask of the LINK_INBAND_* values from
572 * &enum link_inband_signalling to describe which inband modes are supported
573 * for this interface mode.
574 */
575unsigned int pcs_inband_caps(struct phylink_pcs *pcs,
576			     phy_interface_t interface);
577
578/**
579 * pcs_enable() - enable the PCS.
580 * @pcs: a pointer to a &struct phylink_pcs.
581 */
582int pcs_enable(struct phylink_pcs *pcs);
583
584/**
585 * pcs_disable() - disable the PCS.
586 * @pcs: a pointer to a &struct phylink_pcs.
587 */
588void pcs_disable(struct phylink_pcs *pcs);
589
590/**
591 * pcs_get_state() - Read the current inband link state from the hardware
592 * @pcs: a pointer to a &struct phylink_pcs.
593 * @neg_mode: link negotiation mode (PHYLINK_PCS_NEG_xxx)
594 * @state: a pointer to a &struct phylink_link_state.
595 *
596 * Read the current inband link state from the MAC PCS, reporting the
597 * current speed in @state->speed, duplex mode in @state->duplex, pause
598 * mode in @state->pause using the %MLO_PAUSE_RX and %MLO_PAUSE_TX bits,
599 * negotiation completion state in @state->an_complete, and link up state
600 * in @state->link. If possible, @state->lp_advertising should also be
601 * populated.
602 *
603 * Note that the @neg_mode parameter is always the PHYLINK_PCS_NEG_xxx
604 * state, not MLO_AN_xxx.
605 */
606void pcs_get_state(struct phylink_pcs *pcs, unsigned int neg_mode,
607		   struct phylink_link_state *state);
608
609/**
610 * pcs_config() - Configure the PCS mode and advertisement
611 * @pcs: a pointer to a &struct phylink_pcs.
612 * @neg_mode: link negotiation mode (see below)
613 * @interface: interface mode to be used
614 * @advertising: adertisement ethtool link mode mask
615 * @permit_pause_to_mac: permit forwarding pause resolution to MAC
616 *
617 * Configure the PCS for the operating mode, the interface mode, and set
618 * the advertisement mask. @permit_pause_to_mac indicates whether the
619 * hardware may forward the pause mode resolution to the MAC.
620 *
621 * When operating in %MLO_AN_INBAND, inband should always be enabled,
622 * otherwise inband should be disabled.
623 *
624 * For SGMII, there is no advertisement from the MAC side, the PCS should
625 * be programmed to acknowledge the inband word from the PHY.
626 *
627 * For 1000BASE-X, the advertisement should be programmed into the PCS.
628 *
629 * For most 10GBASE-R, there is no advertisement.
630 *
631 * The %neg_mode argument should be tested via the phylink_mode_*() family of
632 * functions, or for PCS that set pcs->neg_mode true, should be tested
633 * against the PHYLINK_PCS_NEG_* definitions.
634 *
635 * pcs_config() will be called when configuration of the PCS is required
636 * or when the advertisement is possibly updated. It must not unnecessarily
637 * disrupt an established link.
638 *
639 * When an autonegotiation restart is required for 802.3z modes, .pcs_config()
640 * should return a positive non-zero integer (e.g. 1) to indicate to phylink
641 * to call the pcs_an_restart() method.
642 */
643int pcs_config(struct phylink_pcs *pcs, unsigned int neg_mode,
644	       phy_interface_t interface, const unsigned long *advertising,
645	       bool permit_pause_to_mac);
646
647/**
648 * pcs_an_restart() - restart 802.3z BaseX autonegotiation
649 * @pcs: a pointer to a &struct phylink_pcs.
650 *
651 * When PCS ops are present, this overrides mac_an_restart() in &struct
652 * phylink_mac_ops.
653 */
654void pcs_an_restart(struct phylink_pcs *pcs);
655
656/**
657 * pcs_link_up() - program the PCS for the resolved link configuration
658 * @pcs: a pointer to a &struct phylink_pcs.
659 * @neg_mode: link negotiation mode (see below)
660 * @interface: link &typedef phy_interface_t mode
661 * @speed: link speed
662 * @duplex: link duplex
663 *
664 * This call will be made just before mac_link_up() to inform the PCS of
665 * the resolved link parameters. For example, a PCS operating in SGMII
666 * mode without in-band AN needs to be manually configured for the link
667 * and duplex setting. Otherwise, this should be a no-op.
668 *
669 * The %mode argument should be tested via the phylink_mode_*() family of
670 * functions, or for PCS that set pcs->neg_mode true, should be tested
671 * against the PHYLINK_PCS_NEG_* definitions.
672 */
673void pcs_link_up(struct phylink_pcs *pcs, unsigned int neg_mode,
674		 phy_interface_t interface, int speed, int duplex);
675
676/**
677 * pcs_disable_eee() - Disable EEE at the PCS
678 * @pcs: a pointer to a &struct phylink_pcs
679 *
680 * Optional method informing the PCS that EEE has been disabled at the MAC.
681 */
682void pcs_disable_eee(struct phylink_pcs *pcs);
683
684/**
685 * pcs_enable_eee() - Enable EEE at the PCS
686 * @pcs: a pointer to a &struct phylink_pcs
687 *
688 * Optional method informing the PCS that EEE is about to be enabled at the MAC.
689 */
690void pcs_enable_eee(struct phylink_pcs *pcs);
691
692/**
693 * pcs_pre_init() - Configure PCS components necessary for MAC initialization
694 * @pcs: a pointer to a &struct phylink_pcs.
695 *
696 * This function can be called by MAC drivers through the
697 * phylink_pcs_pre_init() wrapper, before their hardware is initialized. It
698 * should not be called after the link is brought up, as reconfiguring the PCS
699 * at this point could break the link.
700 *
701 * Some MAC devices require specific hardware initialization to be performed by
702 * their associated PCS device before they can properly initialize their own
703 * hardware. An example of this is the initialization of stmmac controllers,
704 * which requires an active REF_CLK signal to be provided by the PHY/PCS.
705 *
706 * By calling phylink_pcs_pre_init(), MAC drivers can ensure that the PCS is
707 * setup in a way that allows for successful hardware initialization.
708 *
709 * The specific configuration performed by pcs_pre_init() is dependent on the
710 * model of PCS and the requirements of the MAC device attached to it. PCS
711 * driver authors should consider whether their target device is to be used in
712 * conjunction with a MAC device whose driver calls phylink_pcs_pre_init(). MAC
713 * driver authors should document their requirements for the PCS
714 * pre-initialization.
715 *
716 */
717int pcs_pre_init(struct phylink_pcs *pcs);
718
719#endif
720
721struct phylink *phylink_create(struct phylink_config *,
722			       const struct fwnode_handle *,
723			       phy_interface_t,
724			       const struct phylink_mac_ops *);
725void phylink_destroy(struct phylink *);
726bool phylink_expects_phy(struct phylink *pl);
727
728int phylink_connect_phy(struct phylink *, struct phy_device *);
729int phylink_of_phy_connect(struct phylink *, struct device_node *, u32 flags);
730int phylink_fwnode_phy_connect(struct phylink *pl,
731			       const struct fwnode_handle *fwnode,
732			       u32 flags);
733void phylink_disconnect_phy(struct phylink *);
734int phylink_set_fixed_link(struct phylink *,
735			   const struct phylink_link_state *);
736
737void phylink_mac_change(struct phylink *, bool up);
738void phylink_pcs_change(struct phylink_pcs *, bool up);
739
740int phylink_pcs_pre_init(struct phylink *pl, struct phylink_pcs *pcs);
741
742void phylink_start(struct phylink *);
743void phylink_stop(struct phylink *);
744
745void phylink_rx_clk_stop_block(struct phylink *);
746void phylink_rx_clk_stop_unblock(struct phylink *);
747
748void phylink_suspend(struct phylink *pl, bool mac_wol);
749void phylink_prepare_resume(struct phylink *pl);
750void phylink_resume(struct phylink *pl);
751
752void phylink_ethtool_get_wol(struct phylink *, struct ethtool_wolinfo *);
753int phylink_ethtool_set_wol(struct phylink *, struct ethtool_wolinfo *);
754
755int phylink_ethtool_ksettings_get(struct phylink *,
756				  struct ethtool_link_ksettings *);
757int phylink_ethtool_ksettings_set(struct phylink *,
758				  const struct ethtool_link_ksettings *);
759int phylink_ethtool_nway_reset(struct phylink *);
760void phylink_ethtool_get_pauseparam(struct phylink *,
761				    struct ethtool_pauseparam *);
762int phylink_ethtool_set_pauseparam(struct phylink *,
763				   struct ethtool_pauseparam *);
764int phylink_get_eee_err(struct phylink *);
765int phylink_ethtool_get_eee(struct phylink *link, struct ethtool_keee *eee);
766int phylink_ethtool_set_eee(struct phylink *link, struct ethtool_keee *eee);
767int phylink_mii_ioctl(struct phylink *, struct ifreq *, int);
768int phylink_speed_down(struct phylink *pl, bool sync);
769int phylink_speed_up(struct phylink *pl);
770
771#define phylink_zero(bm) \
772	bitmap_zero(bm, __ETHTOOL_LINK_MODE_MASK_NBITS)
773#define __phylink_do_bit(op, bm, mode) \
774	op(ETHTOOL_LINK_MODE_ ## mode ## _BIT, bm)
775
776#define phylink_set(bm, mode)	__phylink_do_bit(__set_bit, bm, mode)
777#define phylink_clear(bm, mode)	__phylink_do_bit(__clear_bit, bm, mode)
778#define phylink_test(bm, mode)	__phylink_do_bit(test_bit, bm, mode)
779
780void phylink_set_port_modes(unsigned long *bits);
781
782/**
783 * phylink_get_link_timer_ns - return the PCS link timer value
784 * @interface: link &typedef phy_interface_t mode
785 *
786 * Return the PCS link timer setting in nanoseconds for the PHY @interface
787 * mode, or -EINVAL if not appropriate.
788 */
789static inline int phylink_get_link_timer_ns(phy_interface_t interface)
790{
791	switch (interface) {
792	case PHY_INTERFACE_MODE_SGMII:
793	case PHY_INTERFACE_MODE_QSGMII:
794	case PHY_INTERFACE_MODE_USXGMII:
795	case PHY_INTERFACE_MODE_10G_QXGMII:
796		return 1600000;
797
798	case PHY_INTERFACE_MODE_1000BASEX:
799	case PHY_INTERFACE_MODE_2500BASEX:
800		return 10000000;
801
802	default:
803		return -EINVAL;
804	}
805}
806
807/**
808 * phylink_mac_implements_lpi() - determine if MAC implements LPI ops
809 * @ops: phylink_mac_ops structure
810 *
811 * Returns true if the phylink MAC operations structure indicates that the
812 * LPI operations have been implemented, false otherwise.
813 */
814static inline bool phylink_mac_implements_lpi(const struct phylink_mac_ops *ops)
815{
816	return ops && ops->mac_disable_tx_lpi && ops->mac_enable_tx_lpi;
817}
818
819void phylink_mii_c22_pcs_decode_state(struct phylink_link_state *state,
820				      unsigned int neg_mode, u16 bmsr, u16 lpa);
821void phylink_mii_c22_pcs_get_state(struct mdio_device *pcs,
822				   unsigned int neg_mode,
823				   struct phylink_link_state *state);
824int phylink_mii_c22_pcs_encode_advertisement(phy_interface_t interface,
825					     const unsigned long *advertising);
826int phylink_mii_c22_pcs_config(struct mdio_device *pcs,
827			       phy_interface_t interface,
828			       const unsigned long *advertising,
829			       unsigned int neg_mode);
830void phylink_mii_c22_pcs_an_restart(struct mdio_device *pcs);
831
832void phylink_resolve_c73(struct phylink_link_state *state);
833
834void phylink_mii_c45_pcs_get_state(struct mdio_device *pcs,
835				   struct phylink_link_state *state);
836
837void phylink_decode_usxgmii_word(struct phylink_link_state *state,
838				 uint16_t lpa);
839#endif