Linux Audio

Check our new training course

Loading...
Note: File does not exist in v3.1.
   1// SPDX-License-Identifier: GPL-2.0
   2/*
   3 * phylink models the MAC to optional PHY connection, supporting
   4 * technologies such as SFP cages where the PHY is hot-pluggable.
   5 *
   6 * Copyright (C) 2015 Russell King
   7 */
   8#include <linux/acpi.h>
   9#include <linux/ethtool.h>
  10#include <linux/export.h>
  11#include <linux/gpio/consumer.h>
  12#include <linux/netdevice.h>
  13#include <linux/of.h>
  14#include <linux/of_mdio.h>
  15#include <linux/phy.h>
  16#include <linux/phy_fixed.h>
  17#include <linux/phylink.h>
  18#include <linux/rtnetlink.h>
  19#include <linux/spinlock.h>
  20#include <linux/timer.h>
  21#include <linux/workqueue.h>
  22
  23#include "sfp.h"
  24#include "swphy.h"
  25
  26#define SUPPORTED_INTERFACES \
  27	(SUPPORTED_TP | SUPPORTED_MII | SUPPORTED_FIBRE | \
  28	 SUPPORTED_BNC | SUPPORTED_AUI | SUPPORTED_Backplane)
  29#define ADVERTISED_INTERFACES \
  30	(ADVERTISED_TP | ADVERTISED_MII | ADVERTISED_FIBRE | \
  31	 ADVERTISED_BNC | ADVERTISED_AUI | ADVERTISED_Backplane)
  32
  33enum {
  34	PHYLINK_DISABLE_STOPPED,
  35	PHYLINK_DISABLE_LINK,
  36	PHYLINK_DISABLE_MAC_WOL,
  37};
  38
  39/**
  40 * struct phylink - internal data type for phylink
  41 */
  42struct phylink {
  43	/* private: */
  44	struct net_device *netdev;
  45	const struct phylink_mac_ops *mac_ops;
  46	const struct phylink_pcs_ops *pcs_ops;
  47	struct phylink_config *config;
  48	struct phylink_pcs *pcs;
  49	struct device *dev;
  50	unsigned int old_link_state:1;
  51
  52	unsigned long phylink_disable_state; /* bitmask of disables */
  53	struct phy_device *phydev;
  54	phy_interface_t link_interface;	/* PHY_INTERFACE_xxx */
  55	u8 cfg_link_an_mode;		/* MLO_AN_xxx */
  56	u8 cur_link_an_mode;
  57	u8 link_port;			/* The current non-phy ethtool port */
  58	__ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
  59
  60	/* The link configuration settings */
  61	struct phylink_link_state link_config;
  62
  63	/* The current settings */
  64	phy_interface_t cur_interface;
  65
  66	struct gpio_desc *link_gpio;
  67	unsigned int link_irq;
  68	struct timer_list link_poll;
  69	void (*get_fixed_state)(struct net_device *dev,
  70				struct phylink_link_state *s);
  71
  72	struct mutex state_mutex;
  73	struct phylink_link_state phy_state;
  74	struct work_struct resolve;
  75
  76	bool mac_link_dropped;
  77
  78	struct sfp_bus *sfp_bus;
  79	bool sfp_may_have_phy;
  80	__ETHTOOL_DECLARE_LINK_MODE_MASK(sfp_support);
  81	u8 sfp_port;
  82};
  83
  84#define phylink_printk(level, pl, fmt, ...) \
  85	do { \
  86		if ((pl)->config->type == PHYLINK_NETDEV) \
  87			netdev_printk(level, (pl)->netdev, fmt, ##__VA_ARGS__); \
  88		else if ((pl)->config->type == PHYLINK_DEV) \
  89			dev_printk(level, (pl)->dev, fmt, ##__VA_ARGS__); \
  90	} while (0)
  91
  92#define phylink_err(pl, fmt, ...) \
  93	phylink_printk(KERN_ERR, pl, fmt, ##__VA_ARGS__)
  94#define phylink_warn(pl, fmt, ...) \
  95	phylink_printk(KERN_WARNING, pl, fmt, ##__VA_ARGS__)
  96#define phylink_info(pl, fmt, ...) \
  97	phylink_printk(KERN_INFO, pl, fmt, ##__VA_ARGS__)
  98#if defined(CONFIG_DYNAMIC_DEBUG)
  99#define phylink_dbg(pl, fmt, ...) \
 100do {									\
 101	if ((pl)->config->type == PHYLINK_NETDEV)			\
 102		netdev_dbg((pl)->netdev, fmt, ##__VA_ARGS__);		\
 103	else if ((pl)->config->type == PHYLINK_DEV)			\
 104		dev_dbg((pl)->dev, fmt, ##__VA_ARGS__);			\
 105} while (0)
 106#elif defined(DEBUG)
 107#define phylink_dbg(pl, fmt, ...)					\
 108	phylink_printk(KERN_DEBUG, pl, fmt, ##__VA_ARGS__)
 109#else
 110#define phylink_dbg(pl, fmt, ...)					\
 111({									\
 112	if (0)								\
 113		phylink_printk(KERN_DEBUG, pl, fmt, ##__VA_ARGS__);	\
 114})
 115#endif
 116
 117/**
 118 * phylink_set_port_modes() - set the port type modes in the ethtool mask
 119 * @mask: ethtool link mode mask
 120 *
 121 * Sets all the port type modes in the ethtool mask.  MAC drivers should
 122 * use this in their 'validate' callback.
 123 */
 124void phylink_set_port_modes(unsigned long *mask)
 125{
 126	phylink_set(mask, TP);
 127	phylink_set(mask, AUI);
 128	phylink_set(mask, MII);
 129	phylink_set(mask, FIBRE);
 130	phylink_set(mask, BNC);
 131	phylink_set(mask, Backplane);
 132}
 133EXPORT_SYMBOL_GPL(phylink_set_port_modes);
 134
 135static int phylink_is_empty_linkmode(const unsigned long *linkmode)
 136{
 137	__ETHTOOL_DECLARE_LINK_MODE_MASK(tmp) = { 0, };
 138
 139	phylink_set_port_modes(tmp);
 140	phylink_set(tmp, Autoneg);
 141	phylink_set(tmp, Pause);
 142	phylink_set(tmp, Asym_Pause);
 143
 144	return linkmode_subset(linkmode, tmp);
 145}
 146
 147static const char *phylink_an_mode_str(unsigned int mode)
 148{
 149	static const char *modestr[] = {
 150		[MLO_AN_PHY] = "phy",
 151		[MLO_AN_FIXED] = "fixed",
 152		[MLO_AN_INBAND] = "inband",
 153	};
 154
 155	return mode < ARRAY_SIZE(modestr) ? modestr[mode] : "unknown";
 156}
 157
 158static int phylink_validate(struct phylink *pl, unsigned long *supported,
 159			    struct phylink_link_state *state)
 160{
 161	pl->mac_ops->validate(pl->config, supported, state);
 162
 163	return phylink_is_empty_linkmode(supported) ? -EINVAL : 0;
 164}
 165
 166static int phylink_parse_fixedlink(struct phylink *pl,
 167				   struct fwnode_handle *fwnode)
 168{
 169	struct fwnode_handle *fixed_node;
 170	const struct phy_setting *s;
 171	struct gpio_desc *desc;
 172	u32 speed;
 173	int ret;
 174
 175	fixed_node = fwnode_get_named_child_node(fwnode, "fixed-link");
 176	if (fixed_node) {
 177		ret = fwnode_property_read_u32(fixed_node, "speed", &speed);
 178
 179		pl->link_config.speed = speed;
 180		pl->link_config.duplex = DUPLEX_HALF;
 181
 182		if (fwnode_property_read_bool(fixed_node, "full-duplex"))
 183			pl->link_config.duplex = DUPLEX_FULL;
 184
 185		/* We treat the "pause" and "asym-pause" terminology as
 186		 * defining the link partner's ability.
 187		 */
 188		if (fwnode_property_read_bool(fixed_node, "pause"))
 189			__set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
 190				  pl->link_config.lp_advertising);
 191		if (fwnode_property_read_bool(fixed_node, "asym-pause"))
 192			__set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
 193				  pl->link_config.lp_advertising);
 194
 195		if (ret == 0) {
 196			desc = fwnode_gpiod_get_index(fixed_node, "link", 0,
 197						      GPIOD_IN, "?");
 198
 199			if (!IS_ERR(desc))
 200				pl->link_gpio = desc;
 201			else if (desc == ERR_PTR(-EPROBE_DEFER))
 202				ret = -EPROBE_DEFER;
 203		}
 204		fwnode_handle_put(fixed_node);
 205
 206		if (ret)
 207			return ret;
 208	} else {
 209		u32 prop[5];
 210
 211		ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
 212						     NULL, 0);
 213		if (ret != ARRAY_SIZE(prop)) {
 214			phylink_err(pl, "broken fixed-link?\n");
 215			return -EINVAL;
 216		}
 217
 218		ret = fwnode_property_read_u32_array(fwnode, "fixed-link",
 219						     prop, ARRAY_SIZE(prop));
 220		if (!ret) {
 221			pl->link_config.duplex = prop[1] ?
 222						DUPLEX_FULL : DUPLEX_HALF;
 223			pl->link_config.speed = prop[2];
 224			if (prop[3])
 225				__set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
 226					  pl->link_config.lp_advertising);
 227			if (prop[4])
 228				__set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
 229					  pl->link_config.lp_advertising);
 230		}
 231	}
 232
 233	if (pl->link_config.speed > SPEED_1000 &&
 234	    pl->link_config.duplex != DUPLEX_FULL)
 235		phylink_warn(pl, "fixed link specifies half duplex for %dMbps link?\n",
 236			     pl->link_config.speed);
 237
 238	bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
 239	linkmode_copy(pl->link_config.advertising, pl->supported);
 240	phylink_validate(pl, pl->supported, &pl->link_config);
 241
 242	s = phy_lookup_setting(pl->link_config.speed, pl->link_config.duplex,
 243			       pl->supported, true);
 244	linkmode_zero(pl->supported);
 245	phylink_set(pl->supported, MII);
 246	phylink_set(pl->supported, Pause);
 247	phylink_set(pl->supported, Asym_Pause);
 248	phylink_set(pl->supported, Autoneg);
 249	if (s) {
 250		__set_bit(s->bit, pl->supported);
 251		__set_bit(s->bit, pl->link_config.lp_advertising);
 252	} else {
 253		phylink_warn(pl, "fixed link %s duplex %dMbps not recognised\n",
 254			     pl->link_config.duplex == DUPLEX_FULL ? "full" : "half",
 255			     pl->link_config.speed);
 256	}
 257
 258	linkmode_and(pl->link_config.advertising, pl->link_config.advertising,
 259		     pl->supported);
 260
 261	pl->link_config.link = 1;
 262	pl->link_config.an_complete = 1;
 263
 264	return 0;
 265}
 266
 267static int phylink_parse_mode(struct phylink *pl, struct fwnode_handle *fwnode)
 268{
 269	struct fwnode_handle *dn;
 270	const char *managed;
 271
 272	dn = fwnode_get_named_child_node(fwnode, "fixed-link");
 273	if (dn || fwnode_property_present(fwnode, "fixed-link"))
 274		pl->cfg_link_an_mode = MLO_AN_FIXED;
 275	fwnode_handle_put(dn);
 276
 277	if ((fwnode_property_read_string(fwnode, "managed", &managed) == 0 &&
 278	     strcmp(managed, "in-band-status") == 0) ||
 279	    pl->config->ovr_an_inband) {
 280		if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
 281			phylink_err(pl,
 282				    "can't use both fixed-link and in-band-status\n");
 283			return -EINVAL;
 284		}
 285
 286		linkmode_zero(pl->supported);
 287		phylink_set(pl->supported, MII);
 288		phylink_set(pl->supported, Autoneg);
 289		phylink_set(pl->supported, Asym_Pause);
 290		phylink_set(pl->supported, Pause);
 291		pl->link_config.an_enabled = true;
 292		pl->cfg_link_an_mode = MLO_AN_INBAND;
 293
 294		switch (pl->link_config.interface) {
 295		case PHY_INTERFACE_MODE_SGMII:
 296		case PHY_INTERFACE_MODE_QSGMII:
 297			phylink_set(pl->supported, 10baseT_Half);
 298			phylink_set(pl->supported, 10baseT_Full);
 299			phylink_set(pl->supported, 100baseT_Half);
 300			phylink_set(pl->supported, 100baseT_Full);
 301			phylink_set(pl->supported, 1000baseT_Half);
 302			phylink_set(pl->supported, 1000baseT_Full);
 303			break;
 304
 305		case PHY_INTERFACE_MODE_1000BASEX:
 306			phylink_set(pl->supported, 1000baseX_Full);
 307			break;
 308
 309		case PHY_INTERFACE_MODE_2500BASEX:
 310			phylink_set(pl->supported, 2500baseX_Full);
 311			break;
 312
 313		case PHY_INTERFACE_MODE_5GBASER:
 314			phylink_set(pl->supported, 5000baseT_Full);
 315			break;
 316
 317		case PHY_INTERFACE_MODE_25GBASER:
 318			phylink_set(pl->supported, 25000baseCR_Full);
 319			phylink_set(pl->supported, 25000baseKR_Full);
 320			phylink_set(pl->supported, 25000baseSR_Full);
 321			fallthrough;
 322		case PHY_INTERFACE_MODE_USXGMII:
 323		case PHY_INTERFACE_MODE_10GKR:
 324		case PHY_INTERFACE_MODE_10GBASER:
 325			phylink_set(pl->supported, 10baseT_Half);
 326			phylink_set(pl->supported, 10baseT_Full);
 327			phylink_set(pl->supported, 100baseT_Half);
 328			phylink_set(pl->supported, 100baseT_Full);
 329			phylink_set(pl->supported, 1000baseT_Half);
 330			phylink_set(pl->supported, 1000baseT_Full);
 331			phylink_set(pl->supported, 1000baseX_Full);
 332			phylink_set(pl->supported, 1000baseKX_Full);
 333			phylink_set(pl->supported, 2500baseT_Full);
 334			phylink_set(pl->supported, 2500baseX_Full);
 335			phylink_set(pl->supported, 5000baseT_Full);
 336			phylink_set(pl->supported, 10000baseT_Full);
 337			phylink_set(pl->supported, 10000baseKR_Full);
 338			phylink_set(pl->supported, 10000baseKX4_Full);
 339			phylink_set(pl->supported, 10000baseCR_Full);
 340			phylink_set(pl->supported, 10000baseSR_Full);
 341			phylink_set(pl->supported, 10000baseLR_Full);
 342			phylink_set(pl->supported, 10000baseLRM_Full);
 343			phylink_set(pl->supported, 10000baseER_Full);
 344			break;
 345
 346		case PHY_INTERFACE_MODE_XLGMII:
 347			phylink_set(pl->supported, 25000baseCR_Full);
 348			phylink_set(pl->supported, 25000baseKR_Full);
 349			phylink_set(pl->supported, 25000baseSR_Full);
 350			phylink_set(pl->supported, 40000baseKR4_Full);
 351			phylink_set(pl->supported, 40000baseCR4_Full);
 352			phylink_set(pl->supported, 40000baseSR4_Full);
 353			phylink_set(pl->supported, 40000baseLR4_Full);
 354			phylink_set(pl->supported, 50000baseCR2_Full);
 355			phylink_set(pl->supported, 50000baseKR2_Full);
 356			phylink_set(pl->supported, 50000baseSR2_Full);
 357			phylink_set(pl->supported, 50000baseKR_Full);
 358			phylink_set(pl->supported, 50000baseSR_Full);
 359			phylink_set(pl->supported, 50000baseCR_Full);
 360			phylink_set(pl->supported, 50000baseLR_ER_FR_Full);
 361			phylink_set(pl->supported, 50000baseDR_Full);
 362			phylink_set(pl->supported, 100000baseKR4_Full);
 363			phylink_set(pl->supported, 100000baseSR4_Full);
 364			phylink_set(pl->supported, 100000baseCR4_Full);
 365			phylink_set(pl->supported, 100000baseLR4_ER4_Full);
 366			phylink_set(pl->supported, 100000baseKR2_Full);
 367			phylink_set(pl->supported, 100000baseSR2_Full);
 368			phylink_set(pl->supported, 100000baseCR2_Full);
 369			phylink_set(pl->supported, 100000baseLR2_ER2_FR2_Full);
 370			phylink_set(pl->supported, 100000baseDR2_Full);
 371			break;
 372
 373		default:
 374			phylink_err(pl,
 375				    "incorrect link mode %s for in-band status\n",
 376				    phy_modes(pl->link_config.interface));
 377			return -EINVAL;
 378		}
 379
 380		linkmode_copy(pl->link_config.advertising, pl->supported);
 381
 382		if (phylink_validate(pl, pl->supported, &pl->link_config)) {
 383			phylink_err(pl,
 384				    "failed to validate link configuration for in-band status\n");
 385			return -EINVAL;
 386		}
 387
 388		/* Check if MAC/PCS also supports Autoneg. */
 389		pl->link_config.an_enabled = phylink_test(pl->supported, Autoneg);
 390	}
 391
 392	return 0;
 393}
 394
 395static void phylink_apply_manual_flow(struct phylink *pl,
 396				      struct phylink_link_state *state)
 397{
 398	/* If autoneg is disabled, pause AN is also disabled */
 399	if (!state->an_enabled)
 400		state->pause &= ~MLO_PAUSE_AN;
 401
 402	/* Manual configuration of pause modes */
 403	if (!(pl->link_config.pause & MLO_PAUSE_AN))
 404		state->pause = pl->link_config.pause;
 405}
 406
 407static void phylink_resolve_flow(struct phylink_link_state *state)
 408{
 409	bool tx_pause, rx_pause;
 410
 411	state->pause = MLO_PAUSE_NONE;
 412	if (state->duplex == DUPLEX_FULL) {
 413		linkmode_resolve_pause(state->advertising,
 414				       state->lp_advertising,
 415				       &tx_pause, &rx_pause);
 416		if (tx_pause)
 417			state->pause |= MLO_PAUSE_TX;
 418		if (rx_pause)
 419			state->pause |= MLO_PAUSE_RX;
 420	}
 421}
 422
 423static void phylink_mac_config(struct phylink *pl,
 424			       const struct phylink_link_state *state)
 425{
 426	phylink_dbg(pl,
 427		    "%s: mode=%s/%s/%s/%s adv=%*pb pause=%02x link=%u an=%u\n",
 428		    __func__, phylink_an_mode_str(pl->cur_link_an_mode),
 429		    phy_modes(state->interface),
 430		    phy_speed_to_str(state->speed),
 431		    phy_duplex_to_str(state->duplex),
 432		    __ETHTOOL_LINK_MODE_MASK_NBITS, state->advertising,
 433		    state->pause, state->link, state->an_enabled);
 434
 435	pl->mac_ops->mac_config(pl->config, pl->cur_link_an_mode, state);
 436}
 437
 438static void phylink_mac_pcs_an_restart(struct phylink *pl)
 439{
 440	if (pl->link_config.an_enabled &&
 441	    phy_interface_mode_is_8023z(pl->link_config.interface) &&
 442	    phylink_autoneg_inband(pl->cur_link_an_mode)) {
 443		if (pl->pcs_ops)
 444			pl->pcs_ops->pcs_an_restart(pl->pcs);
 445		else
 446			pl->mac_ops->mac_an_restart(pl->config);
 447	}
 448}
 449
 450static void phylink_major_config(struct phylink *pl, bool restart,
 451				  const struct phylink_link_state *state)
 452{
 453	int err;
 454
 455	phylink_dbg(pl, "major config %s\n", phy_modes(state->interface));
 456
 457	if (pl->mac_ops->mac_prepare) {
 458		err = pl->mac_ops->mac_prepare(pl->config, pl->cur_link_an_mode,
 459					       state->interface);
 460		if (err < 0) {
 461			phylink_err(pl, "mac_prepare failed: %pe\n",
 462				    ERR_PTR(err));
 463			return;
 464		}
 465	}
 466
 467	phylink_mac_config(pl, state);
 468
 469	if (pl->pcs_ops) {
 470		err = pl->pcs_ops->pcs_config(pl->pcs, pl->cur_link_an_mode,
 471					      state->interface,
 472					      state->advertising,
 473					      !!(pl->link_config.pause &
 474						 MLO_PAUSE_AN));
 475		if (err < 0)
 476			phylink_err(pl, "pcs_config failed: %pe\n",
 477				    ERR_PTR(err));
 478		if (err > 0)
 479			restart = true;
 480	}
 481	if (restart)
 482		phylink_mac_pcs_an_restart(pl);
 483
 484	if (pl->mac_ops->mac_finish) {
 485		err = pl->mac_ops->mac_finish(pl->config, pl->cur_link_an_mode,
 486					      state->interface);
 487		if (err < 0)
 488			phylink_err(pl, "mac_finish failed: %pe\n",
 489				    ERR_PTR(err));
 490	}
 491}
 492
 493/*
 494 * Reconfigure for a change of inband advertisement.
 495 * If we have a separate PCS, we only need to call its pcs_config() method,
 496 * and then restart AN if it indicates something changed. Otherwise, we do
 497 * the full MAC reconfiguration.
 498 */
 499static int phylink_change_inband_advert(struct phylink *pl)
 500{
 501	int ret;
 502
 503	if (test_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state))
 504		return 0;
 505
 506	if (!pl->pcs_ops) {
 507		/* Legacy method */
 508		phylink_mac_config(pl, &pl->link_config);
 509		phylink_mac_pcs_an_restart(pl);
 510		return 0;
 511	}
 512
 513	phylink_dbg(pl, "%s: mode=%s/%s adv=%*pb pause=%02x\n", __func__,
 514		    phylink_an_mode_str(pl->cur_link_an_mode),
 515		    phy_modes(pl->link_config.interface),
 516		    __ETHTOOL_LINK_MODE_MASK_NBITS, pl->link_config.advertising,
 517		    pl->link_config.pause);
 518
 519	/* Modern PCS-based method; update the advert at the PCS, and
 520	 * restart negotiation if the pcs_config() helper indicates that
 521	 * the programmed advertisement has changed.
 522	 */
 523	ret = pl->pcs_ops->pcs_config(pl->pcs, pl->cur_link_an_mode,
 524				      pl->link_config.interface,
 525				      pl->link_config.advertising,
 526				      !!(pl->link_config.pause & MLO_PAUSE_AN));
 527	if (ret < 0)
 528		return ret;
 529
 530	if (ret > 0)
 531		phylink_mac_pcs_an_restart(pl);
 532
 533	return 0;
 534}
 535
 536static void phylink_mac_pcs_get_state(struct phylink *pl,
 537				      struct phylink_link_state *state)
 538{
 539	linkmode_copy(state->advertising, pl->link_config.advertising);
 540	linkmode_zero(state->lp_advertising);
 541	state->interface = pl->link_config.interface;
 542	state->an_enabled = pl->link_config.an_enabled;
 543	state->speed = SPEED_UNKNOWN;
 544	state->duplex = DUPLEX_UNKNOWN;
 545	state->pause = MLO_PAUSE_NONE;
 546	state->an_complete = 0;
 547	state->link = 1;
 548
 549	if (pl->pcs_ops)
 550		pl->pcs_ops->pcs_get_state(pl->pcs, state);
 551	else if (pl->mac_ops->mac_pcs_get_state)
 552		pl->mac_ops->mac_pcs_get_state(pl->config, state);
 553	else
 554		state->link = 0;
 555}
 556
 557/* The fixed state is... fixed except for the link state,
 558 * which may be determined by a GPIO or a callback.
 559 */
 560static void phylink_get_fixed_state(struct phylink *pl,
 561				    struct phylink_link_state *state)
 562{
 563	*state = pl->link_config;
 564	if (pl->config->get_fixed_state)
 565		pl->config->get_fixed_state(pl->config, state);
 566	else if (pl->link_gpio)
 567		state->link = !!gpiod_get_value_cansleep(pl->link_gpio);
 568
 569	phylink_resolve_flow(state);
 570}
 571
 572static void phylink_mac_initial_config(struct phylink *pl, bool force_restart)
 573{
 574	struct phylink_link_state link_state;
 575
 576	switch (pl->cur_link_an_mode) {
 577	case MLO_AN_PHY:
 578		link_state = pl->phy_state;
 579		break;
 580
 581	case MLO_AN_FIXED:
 582		phylink_get_fixed_state(pl, &link_state);
 583		break;
 584
 585	case MLO_AN_INBAND:
 586		link_state = pl->link_config;
 587		if (link_state.interface == PHY_INTERFACE_MODE_SGMII)
 588			link_state.pause = MLO_PAUSE_NONE;
 589		break;
 590
 591	default: /* can't happen */
 592		return;
 593	}
 594
 595	link_state.link = false;
 596
 597	phylink_apply_manual_flow(pl, &link_state);
 598	phylink_major_config(pl, force_restart, &link_state);
 599}
 600
 601static const char *phylink_pause_to_str(int pause)
 602{
 603	switch (pause & MLO_PAUSE_TXRX_MASK) {
 604	case MLO_PAUSE_TX | MLO_PAUSE_RX:
 605		return "rx/tx";
 606	case MLO_PAUSE_TX:
 607		return "tx";
 608	case MLO_PAUSE_RX:
 609		return "rx";
 610	default:
 611		return "off";
 612	}
 613}
 614
 615static void phylink_link_up(struct phylink *pl,
 616			    struct phylink_link_state link_state)
 617{
 618	struct net_device *ndev = pl->netdev;
 619
 620	pl->cur_interface = link_state.interface;
 621
 622	if (pl->pcs_ops && pl->pcs_ops->pcs_link_up)
 623		pl->pcs_ops->pcs_link_up(pl->pcs, pl->cur_link_an_mode,
 624					 pl->cur_interface,
 625					 link_state.speed, link_state.duplex);
 626
 627	pl->mac_ops->mac_link_up(pl->config, pl->phydev,
 628				 pl->cur_link_an_mode, pl->cur_interface,
 629				 link_state.speed, link_state.duplex,
 630				 !!(link_state.pause & MLO_PAUSE_TX),
 631				 !!(link_state.pause & MLO_PAUSE_RX));
 632
 633	if (ndev)
 634		netif_carrier_on(ndev);
 635
 636	phylink_info(pl,
 637		     "Link is Up - %s/%s - flow control %s\n",
 638		     phy_speed_to_str(link_state.speed),
 639		     phy_duplex_to_str(link_state.duplex),
 640		     phylink_pause_to_str(link_state.pause));
 641}
 642
 643static void phylink_link_down(struct phylink *pl)
 644{
 645	struct net_device *ndev = pl->netdev;
 646
 647	if (ndev)
 648		netif_carrier_off(ndev);
 649	pl->mac_ops->mac_link_down(pl->config, pl->cur_link_an_mode,
 650				   pl->cur_interface);
 651	phylink_info(pl, "Link is Down\n");
 652}
 653
 654static void phylink_resolve(struct work_struct *w)
 655{
 656	struct phylink *pl = container_of(w, struct phylink, resolve);
 657	struct phylink_link_state link_state;
 658	struct net_device *ndev = pl->netdev;
 659	bool mac_config = false;
 660	bool cur_link_state;
 661
 662	mutex_lock(&pl->state_mutex);
 663	if (pl->netdev)
 664		cur_link_state = netif_carrier_ok(ndev);
 665	else
 666		cur_link_state = pl->old_link_state;
 667
 668	if (pl->phylink_disable_state) {
 669		pl->mac_link_dropped = false;
 670		link_state.link = false;
 671	} else if (pl->mac_link_dropped) {
 672		link_state.link = false;
 673	} else {
 674		switch (pl->cur_link_an_mode) {
 675		case MLO_AN_PHY:
 676			link_state = pl->phy_state;
 677			phylink_apply_manual_flow(pl, &link_state);
 678			mac_config = link_state.link;
 679			break;
 680
 681		case MLO_AN_FIXED:
 682			phylink_get_fixed_state(pl, &link_state);
 683			mac_config = link_state.link;
 684			break;
 685
 686		case MLO_AN_INBAND:
 687			phylink_mac_pcs_get_state(pl, &link_state);
 688
 689			/* If we have a phy, the "up" state is the union of
 690			 * both the PHY and the MAC
 691			 */
 692			if (pl->phydev)
 693				link_state.link &= pl->phy_state.link;
 694
 695			/* Only update if the PHY link is up */
 696			if (pl->phydev && pl->phy_state.link) {
 697				link_state.interface = pl->phy_state.interface;
 698
 699				/* If we have a PHY, we need to update with
 700				 * the PHY flow control bits.
 701				 */
 702				link_state.pause = pl->phy_state.pause;
 703				mac_config = true;
 704			}
 705			phylink_apply_manual_flow(pl, &link_state);
 706			break;
 707		}
 708	}
 709
 710	if (mac_config) {
 711		if (link_state.interface != pl->link_config.interface) {
 712			/* The interface has changed, force the link down and
 713			 * then reconfigure.
 714			 */
 715			if (cur_link_state) {
 716				phylink_link_down(pl);
 717				cur_link_state = false;
 718			}
 719			phylink_major_config(pl, false, &link_state);
 720			pl->link_config.interface = link_state.interface;
 721		} else if (!pl->pcs_ops) {
 722			/* The interface remains unchanged, only the speed,
 723			 * duplex or pause settings have changed. Call the
 724			 * old mac_config() method to configure the MAC/PCS
 725			 * only if we do not have a PCS installed (an
 726			 * unconverted user.)
 727			 */
 728			phylink_mac_config(pl, &link_state);
 729		}
 730	}
 731
 732	if (link_state.link != cur_link_state) {
 733		pl->old_link_state = link_state.link;
 734		if (!link_state.link)
 735			phylink_link_down(pl);
 736		else
 737			phylink_link_up(pl, link_state);
 738	}
 739	if (!link_state.link && pl->mac_link_dropped) {
 740		pl->mac_link_dropped = false;
 741		queue_work(system_power_efficient_wq, &pl->resolve);
 742	}
 743	mutex_unlock(&pl->state_mutex);
 744}
 745
 746static void phylink_run_resolve(struct phylink *pl)
 747{
 748	if (!pl->phylink_disable_state)
 749		queue_work(system_power_efficient_wq, &pl->resolve);
 750}
 751
 752static void phylink_run_resolve_and_disable(struct phylink *pl, int bit)
 753{
 754	unsigned long state = pl->phylink_disable_state;
 755
 756	set_bit(bit, &pl->phylink_disable_state);
 757	if (state == 0) {
 758		queue_work(system_power_efficient_wq, &pl->resolve);
 759		flush_work(&pl->resolve);
 760	}
 761}
 762
 763static void phylink_fixed_poll(struct timer_list *t)
 764{
 765	struct phylink *pl = container_of(t, struct phylink, link_poll);
 766
 767	mod_timer(t, jiffies + HZ);
 768
 769	phylink_run_resolve(pl);
 770}
 771
 772static const struct sfp_upstream_ops sfp_phylink_ops;
 773
 774static int phylink_register_sfp(struct phylink *pl,
 775				struct fwnode_handle *fwnode)
 776{
 777	struct sfp_bus *bus;
 778	int ret;
 779
 780	if (!fwnode)
 781		return 0;
 782
 783	bus = sfp_bus_find_fwnode(fwnode);
 784	if (IS_ERR(bus)) {
 785		ret = PTR_ERR(bus);
 786		phylink_err(pl, "unable to attach SFP bus: %d\n", ret);
 787		return ret;
 788	}
 789
 790	pl->sfp_bus = bus;
 791
 792	ret = sfp_bus_add_upstream(bus, pl, &sfp_phylink_ops);
 793	sfp_bus_put(bus);
 794
 795	return ret;
 796}
 797
 798/**
 799 * phylink_create() - create a phylink instance
 800 * @config: a pointer to the target &struct phylink_config
 801 * @fwnode: a pointer to a &struct fwnode_handle describing the network
 802 *	interface
 803 * @iface: the desired link mode defined by &typedef phy_interface_t
 804 * @mac_ops: a pointer to a &struct phylink_mac_ops for the MAC.
 805 *
 806 * Create a new phylink instance, and parse the link parameters found in @np.
 807 * This will parse in-band modes, fixed-link or SFP configuration.
 808 *
 809 * Note: the rtnl lock must not be held when calling this function.
 810 *
 811 * Returns a pointer to a &struct phylink, or an error-pointer value. Users
 812 * must use IS_ERR() to check for errors from this function.
 813 */
 814struct phylink *phylink_create(struct phylink_config *config,
 815			       struct fwnode_handle *fwnode,
 816			       phy_interface_t iface,
 817			       const struct phylink_mac_ops *mac_ops)
 818{
 819	struct phylink *pl;
 820	int ret;
 821
 822	pl = kzalloc(sizeof(*pl), GFP_KERNEL);
 823	if (!pl)
 824		return ERR_PTR(-ENOMEM);
 825
 826	mutex_init(&pl->state_mutex);
 827	INIT_WORK(&pl->resolve, phylink_resolve);
 828
 829	pl->config = config;
 830	if (config->type == PHYLINK_NETDEV) {
 831		pl->netdev = to_net_dev(config->dev);
 832	} else if (config->type == PHYLINK_DEV) {
 833		pl->dev = config->dev;
 834	} else {
 835		kfree(pl);
 836		return ERR_PTR(-EINVAL);
 837	}
 838
 839	pl->phy_state.interface = iface;
 840	pl->link_interface = iface;
 841	if (iface == PHY_INTERFACE_MODE_MOCA)
 842		pl->link_port = PORT_BNC;
 843	else
 844		pl->link_port = PORT_MII;
 845	pl->link_config.interface = iface;
 846	pl->link_config.pause = MLO_PAUSE_AN;
 847	pl->link_config.speed = SPEED_UNKNOWN;
 848	pl->link_config.duplex = DUPLEX_UNKNOWN;
 849	pl->link_config.an_enabled = true;
 850	pl->mac_ops = mac_ops;
 851	__set_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
 852	timer_setup(&pl->link_poll, phylink_fixed_poll, 0);
 853
 854	bitmap_fill(pl->supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
 855	linkmode_copy(pl->link_config.advertising, pl->supported);
 856	phylink_validate(pl, pl->supported, &pl->link_config);
 857
 858	ret = phylink_parse_mode(pl, fwnode);
 859	if (ret < 0) {
 860		kfree(pl);
 861		return ERR_PTR(ret);
 862	}
 863
 864	if (pl->cfg_link_an_mode == MLO_AN_FIXED) {
 865		ret = phylink_parse_fixedlink(pl, fwnode);
 866		if (ret < 0) {
 867			kfree(pl);
 868			return ERR_PTR(ret);
 869		}
 870	}
 871
 872	pl->cur_link_an_mode = pl->cfg_link_an_mode;
 873
 874	ret = phylink_register_sfp(pl, fwnode);
 875	if (ret < 0) {
 876		kfree(pl);
 877		return ERR_PTR(ret);
 878	}
 879
 880	return pl;
 881}
 882EXPORT_SYMBOL_GPL(phylink_create);
 883
 884/**
 885 * phylink_set_pcs() - set the current PCS for phylink to use
 886 * @pl: a pointer to a &struct phylink returned from phylink_create()
 887 * @pcs: a pointer to the &struct phylink_pcs
 888 *
 889 * Bind the MAC PCS to phylink.  This may be called after phylink_create(),
 890 * in mac_prepare() or mac_config() methods if it is desired to dynamically
 891 * change the PCS.
 892 *
 893 * Please note that there are behavioural changes with the mac_config()
 894 * callback if a PCS is present (denoting a newer setup) so removing a PCS
 895 * is not supported, and if a PCS is going to be used, it must be registered
 896 * by calling phylink_set_pcs() at the latest in the first mac_config() call.
 897 */
 898void phylink_set_pcs(struct phylink *pl, struct phylink_pcs *pcs)
 899{
 900	pl->pcs = pcs;
 901	pl->pcs_ops = pcs->ops;
 902}
 903EXPORT_SYMBOL_GPL(phylink_set_pcs);
 904
 905/**
 906 * phylink_destroy() - cleanup and destroy the phylink instance
 907 * @pl: a pointer to a &struct phylink returned from phylink_create()
 908 *
 909 * Destroy a phylink instance. Any PHY that has been attached must have been
 910 * cleaned up via phylink_disconnect_phy() prior to calling this function.
 911 *
 912 * Note: the rtnl lock must not be held when calling this function.
 913 */
 914void phylink_destroy(struct phylink *pl)
 915{
 916	sfp_bus_del_upstream(pl->sfp_bus);
 917	if (pl->link_gpio)
 918		gpiod_put(pl->link_gpio);
 919
 920	cancel_work_sync(&pl->resolve);
 921	kfree(pl);
 922}
 923EXPORT_SYMBOL_GPL(phylink_destroy);
 924
 925static void phylink_phy_change(struct phy_device *phydev, bool up)
 926{
 927	struct phylink *pl = phydev->phylink;
 928	bool tx_pause, rx_pause;
 929
 930	phy_get_pause(phydev, &tx_pause, &rx_pause);
 931
 932	mutex_lock(&pl->state_mutex);
 933	pl->phy_state.speed = phydev->speed;
 934	pl->phy_state.duplex = phydev->duplex;
 935	pl->phy_state.pause = MLO_PAUSE_NONE;
 936	if (tx_pause)
 937		pl->phy_state.pause |= MLO_PAUSE_TX;
 938	if (rx_pause)
 939		pl->phy_state.pause |= MLO_PAUSE_RX;
 940	pl->phy_state.interface = phydev->interface;
 941	pl->phy_state.link = up;
 942	mutex_unlock(&pl->state_mutex);
 943
 944	phylink_run_resolve(pl);
 945
 946	phylink_dbg(pl, "phy link %s %s/%s/%s\n", up ? "up" : "down",
 947		    phy_modes(phydev->interface),
 948		    phy_speed_to_str(phydev->speed),
 949		    phy_duplex_to_str(phydev->duplex));
 950}
 951
 952static int phylink_bringup_phy(struct phylink *pl, struct phy_device *phy,
 953			       phy_interface_t interface)
 954{
 955	struct phylink_link_state config;
 956	__ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
 957	char *irq_str;
 958	int ret;
 959
 960	/*
 961	 * This is the new way of dealing with flow control for PHYs,
 962	 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
 963	 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
 964	 * using our validate call to the MAC, we rely upon the MAC
 965	 * clearing the bits from both supported and advertising fields.
 966	 */
 967	phy_support_asym_pause(phy);
 968
 969	memset(&config, 0, sizeof(config));
 970	linkmode_copy(supported, phy->supported);
 971	linkmode_copy(config.advertising, phy->advertising);
 972
 973	/* Clause 45 PHYs switch their Serdes lane between several different
 974	 * modes, normally 10GBASE-R, SGMII. Some use 2500BASE-X for 2.5G
 975	 * speeds. We really need to know which interface modes the PHY and
 976	 * MAC supports to properly work out which linkmodes can be supported.
 977	 */
 978	if (phy->is_c45 &&
 979	    interface != PHY_INTERFACE_MODE_RXAUI &&
 980	    interface != PHY_INTERFACE_MODE_XAUI &&
 981	    interface != PHY_INTERFACE_MODE_USXGMII)
 982		config.interface = PHY_INTERFACE_MODE_NA;
 983	else
 984		config.interface = interface;
 985
 986	ret = phylink_validate(pl, supported, &config);
 987	if (ret) {
 988		phylink_warn(pl, "validation of %s with support %*pb and advertisement %*pb failed: %d\n",
 989			     phy_modes(config.interface),
 990			     __ETHTOOL_LINK_MODE_MASK_NBITS, phy->supported,
 991			     __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising,
 992			     ret);
 993		return ret;
 994	}
 995
 996	phy->phylink = pl;
 997	phy->phy_link_change = phylink_phy_change;
 998
 999	irq_str = phy_attached_info_irq(phy);
1000	phylink_info(pl,
1001		     "PHY [%s] driver [%s] (irq=%s)\n",
1002		     dev_name(&phy->mdio.dev), phy->drv->name, irq_str);
1003	kfree(irq_str);
1004
1005	mutex_lock(&phy->lock);
1006	mutex_lock(&pl->state_mutex);
1007	pl->phydev = phy;
1008	pl->phy_state.interface = interface;
1009	pl->phy_state.pause = MLO_PAUSE_NONE;
1010	pl->phy_state.speed = SPEED_UNKNOWN;
1011	pl->phy_state.duplex = DUPLEX_UNKNOWN;
1012	linkmode_copy(pl->supported, supported);
1013	linkmode_copy(pl->link_config.advertising, config.advertising);
1014
1015	/* Restrict the phy advertisement according to the MAC support. */
1016	linkmode_copy(phy->advertising, config.advertising);
1017	mutex_unlock(&pl->state_mutex);
1018	mutex_unlock(&phy->lock);
1019
1020	phylink_dbg(pl,
1021		    "phy: setting supported %*pb advertising %*pb\n",
1022		    __ETHTOOL_LINK_MODE_MASK_NBITS, pl->supported,
1023		    __ETHTOOL_LINK_MODE_MASK_NBITS, phy->advertising);
1024
1025	if (phy_interrupt_is_valid(phy))
1026		phy_request_interrupt(phy);
1027
1028	return 0;
1029}
1030
1031static int phylink_attach_phy(struct phylink *pl, struct phy_device *phy,
1032			      phy_interface_t interface)
1033{
1034	if (WARN_ON(pl->cfg_link_an_mode == MLO_AN_FIXED ||
1035		    (pl->cfg_link_an_mode == MLO_AN_INBAND &&
1036		     phy_interface_mode_is_8023z(interface))))
1037		return -EINVAL;
1038
1039	if (pl->phydev)
1040		return -EBUSY;
1041
1042	return phy_attach_direct(pl->netdev, phy, 0, interface);
1043}
1044
1045/**
1046 * phylink_connect_phy() - connect a PHY to the phylink instance
1047 * @pl: a pointer to a &struct phylink returned from phylink_create()
1048 * @phy: a pointer to a &struct phy_device.
1049 *
1050 * Connect @phy to the phylink instance specified by @pl by calling
1051 * phy_attach_direct(). Configure the @phy according to the MAC driver's
1052 * capabilities, start the PHYLIB state machine and enable any interrupts
1053 * that the PHY supports.
1054 *
1055 * This updates the phylink's ethtool supported and advertising link mode
1056 * masks.
1057 *
1058 * Returns 0 on success or a negative errno.
1059 */
1060int phylink_connect_phy(struct phylink *pl, struct phy_device *phy)
1061{
1062	int ret;
1063
1064	/* Use PHY device/driver interface */
1065	if (pl->link_interface == PHY_INTERFACE_MODE_NA) {
1066		pl->link_interface = phy->interface;
1067		pl->link_config.interface = pl->link_interface;
1068	}
1069
1070	ret = phylink_attach_phy(pl, phy, pl->link_interface);
1071	if (ret < 0)
1072		return ret;
1073
1074	ret = phylink_bringup_phy(pl, phy, pl->link_config.interface);
1075	if (ret)
1076		phy_detach(phy);
1077
1078	return ret;
1079}
1080EXPORT_SYMBOL_GPL(phylink_connect_phy);
1081
1082/**
1083 * phylink_of_phy_connect() - connect the PHY specified in the DT mode.
1084 * @pl: a pointer to a &struct phylink returned from phylink_create()
1085 * @dn: a pointer to a &struct device_node.
1086 * @flags: PHY-specific flags to communicate to the PHY device driver
1087 *
1088 * Connect the phy specified in the device node @dn to the phylink instance
1089 * specified by @pl. Actions specified in phylink_connect_phy() will be
1090 * performed.
1091 *
1092 * Returns 0 on success or a negative errno.
1093 */
1094int phylink_of_phy_connect(struct phylink *pl, struct device_node *dn,
1095			   u32 flags)
1096{
1097	return phylink_fwnode_phy_connect(pl, of_fwnode_handle(dn), flags);
1098}
1099EXPORT_SYMBOL_GPL(phylink_of_phy_connect);
1100
1101/**
1102 * phylink_fwnode_phy_connect() - connect the PHY specified in the fwnode.
1103 * @pl: a pointer to a &struct phylink returned from phylink_create()
1104 * @fwnode: a pointer to a &struct fwnode_handle.
1105 * @flags: PHY-specific flags to communicate to the PHY device driver
1106 *
1107 * Connect the phy specified @fwnode to the phylink instance specified
1108 * by @pl.
1109 *
1110 * Returns 0 on success or a negative errno.
1111 */
1112int phylink_fwnode_phy_connect(struct phylink *pl,
1113			       struct fwnode_handle *fwnode,
1114			       u32 flags)
1115{
1116	struct fwnode_handle *phy_fwnode;
1117	struct phy_device *phy_dev;
1118	int ret;
1119
1120	/* Fixed links and 802.3z are handled without needing a PHY */
1121	if (pl->cfg_link_an_mode == MLO_AN_FIXED ||
1122	    (pl->cfg_link_an_mode == MLO_AN_INBAND &&
1123	     phy_interface_mode_is_8023z(pl->link_interface)))
1124		return 0;
1125
1126	phy_fwnode = fwnode_get_phy_node(fwnode);
1127	if (IS_ERR(phy_fwnode)) {
1128		if (pl->cfg_link_an_mode == MLO_AN_PHY)
1129			return -ENODEV;
1130		return 0;
1131	}
1132
1133	phy_dev = fwnode_phy_find_device(phy_fwnode);
1134	/* We're done with the phy_node handle */
1135	fwnode_handle_put(phy_fwnode);
1136	if (!phy_dev)
1137		return -ENODEV;
1138
1139	ret = phy_attach_direct(pl->netdev, phy_dev, flags,
1140				pl->link_interface);
1141	if (ret) {
1142		phy_device_free(phy_dev);
1143		return ret;
1144	}
1145
1146	ret = phylink_bringup_phy(pl, phy_dev, pl->link_config.interface);
1147	if (ret)
1148		phy_detach(phy_dev);
1149
1150	return ret;
1151}
1152EXPORT_SYMBOL_GPL(phylink_fwnode_phy_connect);
1153
1154/**
1155 * phylink_disconnect_phy() - disconnect any PHY attached to the phylink
1156 *   instance.
1157 * @pl: a pointer to a &struct phylink returned from phylink_create()
1158 *
1159 * Disconnect any current PHY from the phylink instance described by @pl.
1160 */
1161void phylink_disconnect_phy(struct phylink *pl)
1162{
1163	struct phy_device *phy;
1164
1165	ASSERT_RTNL();
1166
1167	phy = pl->phydev;
1168	if (phy) {
1169		mutex_lock(&phy->lock);
1170		mutex_lock(&pl->state_mutex);
1171		pl->phydev = NULL;
1172		mutex_unlock(&pl->state_mutex);
1173		mutex_unlock(&phy->lock);
1174		flush_work(&pl->resolve);
1175
1176		phy_disconnect(phy);
1177	}
1178}
1179EXPORT_SYMBOL_GPL(phylink_disconnect_phy);
1180
1181/**
1182 * phylink_mac_change() - notify phylink of a change in MAC state
1183 * @pl: a pointer to a &struct phylink returned from phylink_create()
1184 * @up: indicates whether the link is currently up.
1185 *
1186 * The MAC driver should call this driver when the state of its link
1187 * changes (eg, link failure, new negotiation results, etc.)
1188 */
1189void phylink_mac_change(struct phylink *pl, bool up)
1190{
1191	if (!up)
1192		pl->mac_link_dropped = true;
1193	phylink_run_resolve(pl);
1194	phylink_dbg(pl, "mac link %s\n", up ? "up" : "down");
1195}
1196EXPORT_SYMBOL_GPL(phylink_mac_change);
1197
1198static irqreturn_t phylink_link_handler(int irq, void *data)
1199{
1200	struct phylink *pl = data;
1201
1202	phylink_run_resolve(pl);
1203
1204	return IRQ_HANDLED;
1205}
1206
1207/**
1208 * phylink_start() - start a phylink instance
1209 * @pl: a pointer to a &struct phylink returned from phylink_create()
1210 *
1211 * Start the phylink instance specified by @pl, configuring the MAC for the
1212 * desired link mode(s) and negotiation style. This should be called from the
1213 * network device driver's &struct net_device_ops ndo_open() method.
1214 */
1215void phylink_start(struct phylink *pl)
1216{
1217	bool poll = false;
1218
1219	ASSERT_RTNL();
1220
1221	phylink_info(pl, "configuring for %s/%s link mode\n",
1222		     phylink_an_mode_str(pl->cur_link_an_mode),
1223		     phy_modes(pl->link_config.interface));
1224
1225	/* Always set the carrier off */
1226	if (pl->netdev)
1227		netif_carrier_off(pl->netdev);
1228
1229	/* Apply the link configuration to the MAC when starting. This allows
1230	 * a fixed-link to start with the correct parameters, and also
1231	 * ensures that we set the appropriate advertisement for Serdes links.
1232	 *
1233	 * Restart autonegotiation if using 802.3z to ensure that the link
1234	 * parameters are properly negotiated.  This is necessary for DSA
1235	 * switches using 802.3z negotiation to ensure they see our modes.
1236	 */
1237	phylink_mac_initial_config(pl, true);
1238
1239	clear_bit(PHYLINK_DISABLE_STOPPED, &pl->phylink_disable_state);
1240	phylink_run_resolve(pl);
1241
1242	if (pl->cfg_link_an_mode == MLO_AN_FIXED && pl->link_gpio) {
1243		int irq = gpiod_to_irq(pl->link_gpio);
1244
1245		if (irq > 0) {
1246			if (!request_irq(irq, phylink_link_handler,
1247					 IRQF_TRIGGER_RISING |
1248					 IRQF_TRIGGER_FALLING,
1249					 "netdev link", pl))
1250				pl->link_irq = irq;
1251			else
1252				irq = 0;
1253		}
1254		if (irq <= 0)
1255			poll = true;
1256	}
1257
1258	switch (pl->cfg_link_an_mode) {
1259	case MLO_AN_FIXED:
1260		poll |= pl->config->poll_fixed_state;
1261		break;
1262	case MLO_AN_INBAND:
1263		poll |= pl->config->pcs_poll;
1264		if (pl->pcs)
1265			poll |= pl->pcs->poll;
1266		break;
1267	}
1268	if (poll)
1269		mod_timer(&pl->link_poll, jiffies + HZ);
1270	if (pl->phydev)
1271		phy_start(pl->phydev);
1272	if (pl->sfp_bus)
1273		sfp_upstream_start(pl->sfp_bus);
1274}
1275EXPORT_SYMBOL_GPL(phylink_start);
1276
1277/**
1278 * phylink_stop() - stop a phylink instance
1279 * @pl: a pointer to a &struct phylink returned from phylink_create()
1280 *
1281 * Stop the phylink instance specified by @pl. This should be called from the
1282 * network device driver's &struct net_device_ops ndo_stop() method.  The
1283 * network device's carrier state should not be changed prior to calling this
1284 * function.
1285 *
1286 * This will synchronously bring down the link if the link is not already
1287 * down (in other words, it will trigger a mac_link_down() method call.)
1288 */
1289void phylink_stop(struct phylink *pl)
1290{
1291	ASSERT_RTNL();
1292
1293	if (pl->sfp_bus)
1294		sfp_upstream_stop(pl->sfp_bus);
1295	if (pl->phydev)
1296		phy_stop(pl->phydev);
1297	del_timer_sync(&pl->link_poll);
1298	if (pl->link_irq) {
1299		free_irq(pl->link_irq, pl);
1300		pl->link_irq = 0;
1301	}
1302
1303	phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_STOPPED);
1304}
1305EXPORT_SYMBOL_GPL(phylink_stop);
1306
1307/**
1308 * phylink_suspend() - handle a network device suspend event
1309 * @pl: a pointer to a &struct phylink returned from phylink_create()
1310 * @mac_wol: true if the MAC needs to receive packets for Wake-on-Lan
1311 *
1312 * Handle a network device suspend event. There are several cases:
1313 * - If Wake-on-Lan is not active, we can bring down the link between
1314 *   the MAC and PHY by calling phylink_stop().
1315 * - If Wake-on-Lan is active, and being handled only by the PHY, we
1316 *   can also bring down the link between the MAC and PHY.
1317 * - If Wake-on-Lan is active, but being handled by the MAC, the MAC
1318 *   still needs to receive packets, so we can not bring the link down.
1319 */
1320void phylink_suspend(struct phylink *pl, bool mac_wol)
1321{
1322	ASSERT_RTNL();
1323
1324	if (mac_wol && (!pl->netdev || pl->netdev->wol_enabled)) {
1325		/* Wake-on-Lan enabled, MAC handling */
1326		mutex_lock(&pl->state_mutex);
1327
1328		/* Stop the resolver bringing the link up */
1329		__set_bit(PHYLINK_DISABLE_MAC_WOL, &pl->phylink_disable_state);
1330
1331		/* Disable the carrier, to prevent transmit timeouts,
1332		 * but one would hope all packets have been sent. This
1333		 * also means phylink_resolve() will do nothing.
1334		 */
1335		netif_carrier_off(pl->netdev);
1336
1337		/* We do not call mac_link_down() here as we want the
1338		 * link to remain up to receive the WoL packets.
1339		 */
1340		mutex_unlock(&pl->state_mutex);
1341	} else {
1342		phylink_stop(pl);
1343	}
1344}
1345EXPORT_SYMBOL_GPL(phylink_suspend);
1346
1347/**
1348 * phylink_resume() - handle a network device resume event
1349 * @pl: a pointer to a &struct phylink returned from phylink_create()
1350 *
1351 * Undo the effects of phylink_suspend(), returning the link to an
1352 * operational state.
1353 */
1354void phylink_resume(struct phylink *pl)
1355{
1356	ASSERT_RTNL();
1357
1358	if (test_bit(PHYLINK_DISABLE_MAC_WOL, &pl->phylink_disable_state)) {
1359		/* Wake-on-Lan enabled, MAC handling */
1360
1361		/* Call mac_link_down() so we keep the overall state balanced.
1362		 * Do this under the state_mutex lock for consistency. This
1363		 * will cause a "Link Down" message to be printed during
1364		 * resume, which is harmless - the true link state will be
1365		 * printed when we run a resolve.
1366		 */
1367		mutex_lock(&pl->state_mutex);
1368		phylink_link_down(pl);
1369		mutex_unlock(&pl->state_mutex);
1370
1371		/* Re-apply the link parameters so that all the settings get
1372		 * restored to the MAC.
1373		 */
1374		phylink_mac_initial_config(pl, true);
1375
1376		/* Re-enable and re-resolve the link parameters */
1377		clear_bit(PHYLINK_DISABLE_MAC_WOL, &pl->phylink_disable_state);
1378		phylink_run_resolve(pl);
1379	} else {
1380		phylink_start(pl);
1381	}
1382}
1383EXPORT_SYMBOL_GPL(phylink_resume);
1384
1385/**
1386 * phylink_ethtool_get_wol() - get the wake on lan parameters for the PHY
1387 * @pl: a pointer to a &struct phylink returned from phylink_create()
1388 * @wol: a pointer to &struct ethtool_wolinfo to hold the read parameters
1389 *
1390 * Read the wake on lan parameters from the PHY attached to the phylink
1391 * instance specified by @pl. If no PHY is currently attached, report no
1392 * support for wake on lan.
1393 */
1394void phylink_ethtool_get_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1395{
1396	ASSERT_RTNL();
1397
1398	wol->supported = 0;
1399	wol->wolopts = 0;
1400
1401	if (pl->phydev)
1402		phy_ethtool_get_wol(pl->phydev, wol);
1403}
1404EXPORT_SYMBOL_GPL(phylink_ethtool_get_wol);
1405
1406/**
1407 * phylink_ethtool_set_wol() - set wake on lan parameters
1408 * @pl: a pointer to a &struct phylink returned from phylink_create()
1409 * @wol: a pointer to &struct ethtool_wolinfo for the desired parameters
1410 *
1411 * Set the wake on lan parameters for the PHY attached to the phylink
1412 * instance specified by @pl. If no PHY is attached, returns %EOPNOTSUPP
1413 * error.
1414 *
1415 * Returns zero on success or negative errno code.
1416 */
1417int phylink_ethtool_set_wol(struct phylink *pl, struct ethtool_wolinfo *wol)
1418{
1419	int ret = -EOPNOTSUPP;
1420
1421	ASSERT_RTNL();
1422
1423	if (pl->phydev)
1424		ret = phy_ethtool_set_wol(pl->phydev, wol);
1425
1426	return ret;
1427}
1428EXPORT_SYMBOL_GPL(phylink_ethtool_set_wol);
1429
1430static void phylink_merge_link_mode(unsigned long *dst, const unsigned long *b)
1431{
1432	__ETHTOOL_DECLARE_LINK_MODE_MASK(mask);
1433
1434	linkmode_zero(mask);
1435	phylink_set_port_modes(mask);
1436
1437	linkmode_and(dst, dst, mask);
1438	linkmode_or(dst, dst, b);
1439}
1440
1441static void phylink_get_ksettings(const struct phylink_link_state *state,
1442				  struct ethtool_link_ksettings *kset)
1443{
1444	phylink_merge_link_mode(kset->link_modes.advertising, state->advertising);
1445	linkmode_copy(kset->link_modes.lp_advertising, state->lp_advertising);
1446	kset->base.speed = state->speed;
1447	kset->base.duplex = state->duplex;
1448	kset->base.autoneg = state->an_enabled ? AUTONEG_ENABLE :
1449				AUTONEG_DISABLE;
1450}
1451
1452/**
1453 * phylink_ethtool_ksettings_get() - get the current link settings
1454 * @pl: a pointer to a &struct phylink returned from phylink_create()
1455 * @kset: a pointer to a &struct ethtool_link_ksettings to hold link settings
1456 *
1457 * Read the current link settings for the phylink instance specified by @pl.
1458 * This will be the link settings read from the MAC, PHY or fixed link
1459 * settings depending on the current negotiation mode.
1460 */
1461int phylink_ethtool_ksettings_get(struct phylink *pl,
1462				  struct ethtool_link_ksettings *kset)
1463{
1464	struct phylink_link_state link_state;
1465
1466	ASSERT_RTNL();
1467
1468	if (pl->phydev)
1469		phy_ethtool_ksettings_get(pl->phydev, kset);
1470	else
1471		kset->base.port = pl->link_port;
1472
1473	linkmode_copy(kset->link_modes.supported, pl->supported);
1474
1475	switch (pl->cur_link_an_mode) {
1476	case MLO_AN_FIXED:
1477		/* We are using fixed settings. Report these as the
1478		 * current link settings - and note that these also
1479		 * represent the supported speeds/duplex/pause modes.
1480		 */
1481		phylink_get_fixed_state(pl, &link_state);
1482		phylink_get_ksettings(&link_state, kset);
1483		break;
1484
1485	case MLO_AN_INBAND:
1486		/* If there is a phy attached, then use the reported
1487		 * settings from the phy with no modification.
1488		 */
1489		if (pl->phydev)
1490			break;
1491
1492		phylink_mac_pcs_get_state(pl, &link_state);
1493
1494		/* The MAC is reporting the link results from its own PCS
1495		 * layer via in-band status. Report these as the current
1496		 * link settings.
1497		 */
1498		phylink_get_ksettings(&link_state, kset);
1499		break;
1500	}
1501
1502	return 0;
1503}
1504EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_get);
1505
1506/**
1507 * phylink_ethtool_ksettings_set() - set the link settings
1508 * @pl: a pointer to a &struct phylink returned from phylink_create()
1509 * @kset: a pointer to a &struct ethtool_link_ksettings for the desired modes
1510 */
1511int phylink_ethtool_ksettings_set(struct phylink *pl,
1512				  const struct ethtool_link_ksettings *kset)
1513{
1514	__ETHTOOL_DECLARE_LINK_MODE_MASK(support);
1515	struct phylink_link_state config;
1516	const struct phy_setting *s;
1517
1518	ASSERT_RTNL();
1519
1520	if (pl->phydev) {
1521		/* We can rely on phylib for this update; we also do not need
1522		 * to update the pl->link_config settings:
1523		 * - the configuration returned via ksettings_get() will come
1524		 *   from phylib whenever a PHY is present.
1525		 * - link_config.interface will be updated by the PHY calling
1526		 *   back via phylink_phy_change() and a subsequent resolve.
1527		 * - initial link configuration for PHY mode comes from the
1528		 *   last phy state updated via phylink_phy_change().
1529		 * - other configuration changes (e.g. pause modes) are
1530		 *   performed directly via phylib.
1531		 * - if in in-band mode with a PHY, the link configuration
1532		 *   is passed on the link from the PHY, and all of
1533		 *   link_config.{speed,duplex,an_enabled,pause} are not used.
1534		 * - the only possible use would be link_config.advertising
1535		 *   pause modes when in 1000base-X mode with a PHY, but in
1536		 *   the presence of a PHY, this should not be changed as that
1537		 *   should be determined from the media side advertisement.
1538		 */
1539		return phy_ethtool_ksettings_set(pl->phydev, kset);
1540	}
1541
1542	linkmode_copy(support, pl->supported);
1543	config = pl->link_config;
1544	config.an_enabled = kset->base.autoneg == AUTONEG_ENABLE;
1545
1546	/* Mask out unsupported advertisements, and force the autoneg bit */
1547	linkmode_and(config.advertising, kset->link_modes.advertising,
1548		     support);
1549	linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, config.advertising,
1550			 config.an_enabled);
1551
1552	/* FIXME: should we reject autoneg if phy/mac does not support it? */
1553	switch (kset->base.autoneg) {
1554	case AUTONEG_DISABLE:
1555		/* Autonegotiation disabled, select a suitable speed and
1556		 * duplex.
1557		 */
1558		s = phy_lookup_setting(kset->base.speed, kset->base.duplex,
1559				       support, false);
1560		if (!s)
1561			return -EINVAL;
1562
1563		/* If we have a fixed link, refuse to change link parameters.
1564		 * If the link parameters match, accept them but do nothing.
1565		 */
1566		if (pl->cur_link_an_mode == MLO_AN_FIXED) {
1567			if (s->speed != pl->link_config.speed ||
1568			    s->duplex != pl->link_config.duplex)
1569				return -EINVAL;
1570			return 0;
1571		}
1572
1573		config.speed = s->speed;
1574		config.duplex = s->duplex;
1575		break;
1576
1577	case AUTONEG_ENABLE:
1578		/* If we have a fixed link, allow autonegotiation (since that
1579		 * is our default case) but do not allow the advertisement to
1580		 * be changed. If the advertisement matches, simply return.
1581		 */
1582		if (pl->cur_link_an_mode == MLO_AN_FIXED) {
1583			if (!linkmode_equal(config.advertising,
1584					    pl->link_config.advertising))
1585				return -EINVAL;
1586			return 0;
1587		}
1588
1589		config.speed = SPEED_UNKNOWN;
1590		config.duplex = DUPLEX_UNKNOWN;
1591		break;
1592
1593	default:
1594		return -EINVAL;
1595	}
1596
1597	/* We have ruled out the case with a PHY attached, and the
1598	 * fixed-link cases.  All that is left are in-band links.
1599	 */
1600	if (phylink_validate(pl, support, &config))
1601		return -EINVAL;
1602
1603	/* If autonegotiation is enabled, we must have an advertisement */
1604	if (config.an_enabled && phylink_is_empty_linkmode(config.advertising))
1605		return -EINVAL;
1606
1607	/* If this link is with an SFP, ensure that changes to advertised modes
1608	 * also cause the associated interface to be selected such that the
1609	 * link can be configured correctly.
1610	 */
1611	if (pl->sfp_port && pl->sfp_bus) {
1612		config.interface = sfp_select_interface(pl->sfp_bus,
1613							config.advertising);
1614		if (config.interface == PHY_INTERFACE_MODE_NA) {
1615			phylink_err(pl,
1616				    "selection of interface failed, advertisement %*pb\n",
1617				    __ETHTOOL_LINK_MODE_MASK_NBITS,
1618				    config.advertising);
1619			return -EINVAL;
1620		}
1621
1622		/* Revalidate with the selected interface */
1623		linkmode_copy(support, pl->supported);
1624		if (phylink_validate(pl, support, &config)) {
1625			phylink_err(pl, "validation of %s/%s with support %*pb failed\n",
1626				    phylink_an_mode_str(pl->cur_link_an_mode),
1627				    phy_modes(config.interface),
1628				    __ETHTOOL_LINK_MODE_MASK_NBITS, support);
1629			return -EINVAL;
1630		}
1631	}
1632
1633	mutex_lock(&pl->state_mutex);
1634	pl->link_config.speed = config.speed;
1635	pl->link_config.duplex = config.duplex;
1636	pl->link_config.an_enabled = config.an_enabled;
1637
1638	if (pl->link_config.interface != config.interface) {
1639		/* The interface changed, e.g. 1000base-X <-> 2500base-X */
1640		/* We need to force the link down, then change the interface */
1641		if (pl->old_link_state) {
1642			phylink_link_down(pl);
1643			pl->old_link_state = false;
1644		}
1645		if (!test_bit(PHYLINK_DISABLE_STOPPED,
1646			      &pl->phylink_disable_state))
1647			phylink_major_config(pl, false, &config);
1648		pl->link_config.interface = config.interface;
1649		linkmode_copy(pl->link_config.advertising, config.advertising);
1650	} else if (!linkmode_equal(pl->link_config.advertising,
1651				   config.advertising)) {
1652		linkmode_copy(pl->link_config.advertising, config.advertising);
1653		phylink_change_inband_advert(pl);
1654	}
1655	mutex_unlock(&pl->state_mutex);
1656
1657	return 0;
1658}
1659EXPORT_SYMBOL_GPL(phylink_ethtool_ksettings_set);
1660
1661/**
1662 * phylink_ethtool_nway_reset() - restart negotiation
1663 * @pl: a pointer to a &struct phylink returned from phylink_create()
1664 *
1665 * Restart negotiation for the phylink instance specified by @pl. This will
1666 * cause any attached phy to restart negotiation with the link partner, and
1667 * if the MAC is in a BaseX mode, the MAC will also be requested to restart
1668 * negotiation.
1669 *
1670 * Returns zero on success, or negative error code.
1671 */
1672int phylink_ethtool_nway_reset(struct phylink *pl)
1673{
1674	int ret = 0;
1675
1676	ASSERT_RTNL();
1677
1678	if (pl->phydev)
1679		ret = phy_restart_aneg(pl->phydev);
1680	phylink_mac_pcs_an_restart(pl);
1681
1682	return ret;
1683}
1684EXPORT_SYMBOL_GPL(phylink_ethtool_nway_reset);
1685
1686/**
1687 * phylink_ethtool_get_pauseparam() - get the current pause parameters
1688 * @pl: a pointer to a &struct phylink returned from phylink_create()
1689 * @pause: a pointer to a &struct ethtool_pauseparam
1690 */
1691void phylink_ethtool_get_pauseparam(struct phylink *pl,
1692				    struct ethtool_pauseparam *pause)
1693{
1694	ASSERT_RTNL();
1695
1696	pause->autoneg = !!(pl->link_config.pause & MLO_PAUSE_AN);
1697	pause->rx_pause = !!(pl->link_config.pause & MLO_PAUSE_RX);
1698	pause->tx_pause = !!(pl->link_config.pause & MLO_PAUSE_TX);
1699}
1700EXPORT_SYMBOL_GPL(phylink_ethtool_get_pauseparam);
1701
1702/**
1703 * phylink_ethtool_set_pauseparam() - set the current pause parameters
1704 * @pl: a pointer to a &struct phylink returned from phylink_create()
1705 * @pause: a pointer to a &struct ethtool_pauseparam
1706 */
1707int phylink_ethtool_set_pauseparam(struct phylink *pl,
1708				   struct ethtool_pauseparam *pause)
1709{
1710	struct phylink_link_state *config = &pl->link_config;
1711	bool manual_changed;
1712	int pause_state;
1713
1714	ASSERT_RTNL();
1715
1716	if (pl->cur_link_an_mode == MLO_AN_FIXED)
1717		return -EOPNOTSUPP;
1718
1719	if (!phylink_test(pl->supported, Pause) &&
1720	    !phylink_test(pl->supported, Asym_Pause))
1721		return -EOPNOTSUPP;
1722
1723	if (!phylink_test(pl->supported, Asym_Pause) &&
1724	    !pause->autoneg && pause->rx_pause != pause->tx_pause)
1725		return -EINVAL;
1726
1727	pause_state = 0;
1728	if (pause->autoneg)
1729		pause_state |= MLO_PAUSE_AN;
1730	if (pause->rx_pause)
1731		pause_state |= MLO_PAUSE_RX;
1732	if (pause->tx_pause)
1733		pause_state |= MLO_PAUSE_TX;
1734
1735	mutex_lock(&pl->state_mutex);
1736	/*
1737	 * See the comments for linkmode_set_pause(), wrt the deficiencies
1738	 * with the current implementation.  A solution to this issue would
1739	 * be:
1740	 * ethtool  Local device
1741	 *  rx  tx  Pause AsymDir
1742	 *  0   0   0     0
1743	 *  1   0   1     1
1744	 *  0   1   0     1
1745	 *  1   1   1     1
1746	 * and then use the ethtool rx/tx enablement status to mask the
1747	 * rx/tx pause resolution.
1748	 */
1749	linkmode_set_pause(config->advertising, pause->tx_pause,
1750			   pause->rx_pause);
1751
1752	manual_changed = (config->pause ^ pause_state) & MLO_PAUSE_AN ||
1753			 (!(pause_state & MLO_PAUSE_AN) &&
1754			   (config->pause ^ pause_state) & MLO_PAUSE_TXRX_MASK);
1755
1756	config->pause = pause_state;
1757
1758	/* Update our in-band advertisement, triggering a renegotiation if
1759	 * the advertisement changed.
1760	 */
1761	if (!pl->phydev)
1762		phylink_change_inband_advert(pl);
1763
1764	mutex_unlock(&pl->state_mutex);
1765
1766	/* If we have a PHY, a change of the pause frame advertisement will
1767	 * cause phylib to renegotiate (if AN is enabled) which will in turn
1768	 * call our phylink_phy_change() and trigger a resolve.  Note that
1769	 * we can't hold our state mutex while calling phy_set_asym_pause().
1770	 */
1771	if (pl->phydev)
1772		phy_set_asym_pause(pl->phydev, pause->rx_pause,
1773				   pause->tx_pause);
1774
1775	/* If the manual pause settings changed, make sure we trigger a
1776	 * resolve to update their state; we can not guarantee that the
1777	 * link will cycle.
1778	 */
1779	if (manual_changed) {
1780		pl->mac_link_dropped = true;
1781		phylink_run_resolve(pl);
1782	}
1783
1784	return 0;
1785}
1786EXPORT_SYMBOL_GPL(phylink_ethtool_set_pauseparam);
1787
1788/**
1789 * phylink_get_eee_err() - read the energy efficient ethernet error
1790 *   counter
1791 * @pl: a pointer to a &struct phylink returned from phylink_create().
1792 *
1793 * Read the Energy Efficient Ethernet error counter from the PHY associated
1794 * with the phylink instance specified by @pl.
1795 *
1796 * Returns positive error counter value, or negative error code.
1797 */
1798int phylink_get_eee_err(struct phylink *pl)
1799{
1800	int ret = 0;
1801
1802	ASSERT_RTNL();
1803
1804	if (pl->phydev)
1805		ret = phy_get_eee_err(pl->phydev);
1806
1807	return ret;
1808}
1809EXPORT_SYMBOL_GPL(phylink_get_eee_err);
1810
1811/**
1812 * phylink_init_eee() - init and check the EEE features
1813 * @pl: a pointer to a &struct phylink returned from phylink_create()
1814 * @clk_stop_enable: allow PHY to stop receive clock
1815 *
1816 * Must be called either with RTNL held or within mac_link_up()
1817 */
1818int phylink_init_eee(struct phylink *pl, bool clk_stop_enable)
1819{
1820	int ret = -EOPNOTSUPP;
1821
1822	if (pl->phydev)
1823		ret = phy_init_eee(pl->phydev, clk_stop_enable);
1824
1825	return ret;
1826}
1827EXPORT_SYMBOL_GPL(phylink_init_eee);
1828
1829/**
1830 * phylink_ethtool_get_eee() - read the energy efficient ethernet parameters
1831 * @pl: a pointer to a &struct phylink returned from phylink_create()
1832 * @eee: a pointer to a &struct ethtool_eee for the read parameters
1833 */
1834int phylink_ethtool_get_eee(struct phylink *pl, struct ethtool_eee *eee)
1835{
1836	int ret = -EOPNOTSUPP;
1837
1838	ASSERT_RTNL();
1839
1840	if (pl->phydev)
1841		ret = phy_ethtool_get_eee(pl->phydev, eee);
1842
1843	return ret;
1844}
1845EXPORT_SYMBOL_GPL(phylink_ethtool_get_eee);
1846
1847/**
1848 * phylink_ethtool_set_eee() - set the energy efficient ethernet parameters
1849 * @pl: a pointer to a &struct phylink returned from phylink_create()
1850 * @eee: a pointer to a &struct ethtool_eee for the desired parameters
1851 */
1852int phylink_ethtool_set_eee(struct phylink *pl, struct ethtool_eee *eee)
1853{
1854	int ret = -EOPNOTSUPP;
1855
1856	ASSERT_RTNL();
1857
1858	if (pl->phydev)
1859		ret = phy_ethtool_set_eee(pl->phydev, eee);
1860
1861	return ret;
1862}
1863EXPORT_SYMBOL_GPL(phylink_ethtool_set_eee);
1864
1865/* This emulates MII registers for a fixed-mode phy operating as per the
1866 * passed in state. "aneg" defines if we report negotiation is possible.
1867 *
1868 * FIXME: should deal with negotiation state too.
1869 */
1870static int phylink_mii_emul_read(unsigned int reg,
1871				 struct phylink_link_state *state)
1872{
1873	struct fixed_phy_status fs;
1874	unsigned long *lpa = state->lp_advertising;
1875	int val;
1876
1877	fs.link = state->link;
1878	fs.speed = state->speed;
1879	fs.duplex = state->duplex;
1880	fs.pause = test_bit(ETHTOOL_LINK_MODE_Pause_BIT, lpa);
1881	fs.asym_pause = test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, lpa);
1882
1883	val = swphy_read_reg(reg, &fs);
1884	if (reg == MII_BMSR) {
1885		if (!state->an_complete)
1886			val &= ~BMSR_ANEGCOMPLETE;
1887	}
1888	return val;
1889}
1890
1891static int phylink_phy_read(struct phylink *pl, unsigned int phy_id,
1892			    unsigned int reg)
1893{
1894	struct phy_device *phydev = pl->phydev;
1895	int prtad, devad;
1896
1897	if (mdio_phy_id_is_c45(phy_id)) {
1898		prtad = mdio_phy_id_prtad(phy_id);
1899		devad = mdio_phy_id_devad(phy_id);
1900		devad = mdiobus_c45_addr(devad, reg);
1901	} else if (phydev->is_c45) {
1902		switch (reg) {
1903		case MII_BMCR:
1904		case MII_BMSR:
1905		case MII_PHYSID1:
1906		case MII_PHYSID2:
1907			devad = __ffs(phydev->c45_ids.mmds_present);
1908			break;
1909		case MII_ADVERTISE:
1910		case MII_LPA:
1911			if (!(phydev->c45_ids.mmds_present & MDIO_DEVS_AN))
1912				return -EINVAL;
1913			devad = MDIO_MMD_AN;
1914			if (reg == MII_ADVERTISE)
1915				reg = MDIO_AN_ADVERTISE;
1916			else
1917				reg = MDIO_AN_LPA;
1918			break;
1919		default:
1920			return -EINVAL;
1921		}
1922		prtad = phy_id;
1923		devad = mdiobus_c45_addr(devad, reg);
1924	} else {
1925		prtad = phy_id;
1926		devad = reg;
1927	}
1928	return mdiobus_read(pl->phydev->mdio.bus, prtad, devad);
1929}
1930
1931static int phylink_phy_write(struct phylink *pl, unsigned int phy_id,
1932			     unsigned int reg, unsigned int val)
1933{
1934	struct phy_device *phydev = pl->phydev;
1935	int prtad, devad;
1936
1937	if (mdio_phy_id_is_c45(phy_id)) {
1938		prtad = mdio_phy_id_prtad(phy_id);
1939		devad = mdio_phy_id_devad(phy_id);
1940		devad = mdiobus_c45_addr(devad, reg);
1941	} else if (phydev->is_c45) {
1942		switch (reg) {
1943		case MII_BMCR:
1944		case MII_BMSR:
1945		case MII_PHYSID1:
1946		case MII_PHYSID2:
1947			devad = __ffs(phydev->c45_ids.mmds_present);
1948			break;
1949		case MII_ADVERTISE:
1950		case MII_LPA:
1951			if (!(phydev->c45_ids.mmds_present & MDIO_DEVS_AN))
1952				return -EINVAL;
1953			devad = MDIO_MMD_AN;
1954			if (reg == MII_ADVERTISE)
1955				reg = MDIO_AN_ADVERTISE;
1956			else
1957				reg = MDIO_AN_LPA;
1958			break;
1959		default:
1960			return -EINVAL;
1961		}
1962		prtad = phy_id;
1963		devad = mdiobus_c45_addr(devad, reg);
1964	} else {
1965		prtad = phy_id;
1966		devad = reg;
1967	}
1968
1969	return mdiobus_write(phydev->mdio.bus, prtad, devad, val);
1970}
1971
1972static int phylink_mii_read(struct phylink *pl, unsigned int phy_id,
1973			    unsigned int reg)
1974{
1975	struct phylink_link_state state;
1976	int val = 0xffff;
1977
1978	switch (pl->cur_link_an_mode) {
1979	case MLO_AN_FIXED:
1980		if (phy_id == 0) {
1981			phylink_get_fixed_state(pl, &state);
1982			val = phylink_mii_emul_read(reg, &state);
1983		}
1984		break;
1985
1986	case MLO_AN_PHY:
1987		return -EOPNOTSUPP;
1988
1989	case MLO_AN_INBAND:
1990		if (phy_id == 0) {
1991			phylink_mac_pcs_get_state(pl, &state);
1992			val = phylink_mii_emul_read(reg, &state);
1993		}
1994		break;
1995	}
1996
1997	return val & 0xffff;
1998}
1999
2000static int phylink_mii_write(struct phylink *pl, unsigned int phy_id,
2001			     unsigned int reg, unsigned int val)
2002{
2003	switch (pl->cur_link_an_mode) {
2004	case MLO_AN_FIXED:
2005		break;
2006
2007	case MLO_AN_PHY:
2008		return -EOPNOTSUPP;
2009
2010	case MLO_AN_INBAND:
2011		break;
2012	}
2013
2014	return 0;
2015}
2016
2017/**
2018 * phylink_mii_ioctl() - generic mii ioctl interface
2019 * @pl: a pointer to a &struct phylink returned from phylink_create()
2020 * @ifr: a pointer to a &struct ifreq for socket ioctls
2021 * @cmd: ioctl cmd to execute
2022 *
2023 * Perform the specified MII ioctl on the PHY attached to the phylink instance
2024 * specified by @pl. If no PHY is attached, emulate the presence of the PHY.
2025 *
2026 * Returns: zero on success or negative error code.
2027 *
2028 * %SIOCGMIIPHY:
2029 *  read register from the current PHY.
2030 * %SIOCGMIIREG:
2031 *  read register from the specified PHY.
2032 * %SIOCSMIIREG:
2033 *  set a register on the specified PHY.
2034 */
2035int phylink_mii_ioctl(struct phylink *pl, struct ifreq *ifr, int cmd)
2036{
2037	struct mii_ioctl_data *mii = if_mii(ifr);
2038	int  ret;
2039
2040	ASSERT_RTNL();
2041
2042	if (pl->phydev) {
2043		/* PHYs only exist for MLO_AN_PHY and SGMII */
2044		switch (cmd) {
2045		case SIOCGMIIPHY:
2046			mii->phy_id = pl->phydev->mdio.addr;
2047			fallthrough;
2048
2049		case SIOCGMIIREG:
2050			ret = phylink_phy_read(pl, mii->phy_id, mii->reg_num);
2051			if (ret >= 0) {
2052				mii->val_out = ret;
2053				ret = 0;
2054			}
2055			break;
2056
2057		case SIOCSMIIREG:
2058			ret = phylink_phy_write(pl, mii->phy_id, mii->reg_num,
2059						mii->val_in);
2060			break;
2061
2062		default:
2063			ret = phy_mii_ioctl(pl->phydev, ifr, cmd);
2064			break;
2065		}
2066	} else {
2067		switch (cmd) {
2068		case SIOCGMIIPHY:
2069			mii->phy_id = 0;
2070			fallthrough;
2071
2072		case SIOCGMIIREG:
2073			ret = phylink_mii_read(pl, mii->phy_id, mii->reg_num);
2074			if (ret >= 0) {
2075				mii->val_out = ret;
2076				ret = 0;
2077			}
2078			break;
2079
2080		case SIOCSMIIREG:
2081			ret = phylink_mii_write(pl, mii->phy_id, mii->reg_num,
2082						mii->val_in);
2083			break;
2084
2085		default:
2086			ret = -EOPNOTSUPP;
2087			break;
2088		}
2089	}
2090
2091	return ret;
2092}
2093EXPORT_SYMBOL_GPL(phylink_mii_ioctl);
2094
2095/**
2096 * phylink_speed_down() - set the non-SFP PHY to lowest speed supported by both
2097 *   link partners
2098 * @pl: a pointer to a &struct phylink returned from phylink_create()
2099 * @sync: perform action synchronously
2100 *
2101 * If we have a PHY that is not part of a SFP module, then set the speed
2102 * as described in the phy_speed_down() function. Please see this function
2103 * for a description of the @sync parameter.
2104 *
2105 * Returns zero if there is no PHY, otherwise as per phy_speed_down().
2106 */
2107int phylink_speed_down(struct phylink *pl, bool sync)
2108{
2109	int ret = 0;
2110
2111	ASSERT_RTNL();
2112
2113	if (!pl->sfp_bus && pl->phydev)
2114		ret = phy_speed_down(pl->phydev, sync);
2115
2116	return ret;
2117}
2118EXPORT_SYMBOL_GPL(phylink_speed_down);
2119
2120/**
2121 * phylink_speed_up() - restore the advertised speeds prior to the call to
2122 *   phylink_speed_down()
2123 * @pl: a pointer to a &struct phylink returned from phylink_create()
2124 *
2125 * If we have a PHY that is not part of a SFP module, then restore the
2126 * PHY speeds as per phy_speed_up().
2127 *
2128 * Returns zero if there is no PHY, otherwise as per phy_speed_up().
2129 */
2130int phylink_speed_up(struct phylink *pl)
2131{
2132	int ret = 0;
2133
2134	ASSERT_RTNL();
2135
2136	if (!pl->sfp_bus && pl->phydev)
2137		ret = phy_speed_up(pl->phydev);
2138
2139	return ret;
2140}
2141EXPORT_SYMBOL_GPL(phylink_speed_up);
2142
2143static void phylink_sfp_attach(void *upstream, struct sfp_bus *bus)
2144{
2145	struct phylink *pl = upstream;
2146
2147	pl->netdev->sfp_bus = bus;
2148}
2149
2150static void phylink_sfp_detach(void *upstream, struct sfp_bus *bus)
2151{
2152	struct phylink *pl = upstream;
2153
2154	pl->netdev->sfp_bus = NULL;
2155}
2156
2157static int phylink_sfp_config(struct phylink *pl, u8 mode,
2158			      const unsigned long *supported,
2159			      const unsigned long *advertising)
2160{
2161	__ETHTOOL_DECLARE_LINK_MODE_MASK(support1);
2162	__ETHTOOL_DECLARE_LINK_MODE_MASK(support);
2163	struct phylink_link_state config;
2164	phy_interface_t iface;
2165	bool changed;
2166	int ret;
2167
2168	linkmode_copy(support, supported);
2169
2170	memset(&config, 0, sizeof(config));
2171	linkmode_copy(config.advertising, advertising);
2172	config.interface = PHY_INTERFACE_MODE_NA;
2173	config.speed = SPEED_UNKNOWN;
2174	config.duplex = DUPLEX_UNKNOWN;
2175	config.pause = MLO_PAUSE_AN;
2176	config.an_enabled = pl->link_config.an_enabled;
2177
2178	/* Ignore errors if we're expecting a PHY to attach later */
2179	ret = phylink_validate(pl, support, &config);
2180	if (ret) {
2181		phylink_err(pl, "validation with support %*pb failed: %d\n",
2182			    __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
2183		return ret;
2184	}
2185
2186	iface = sfp_select_interface(pl->sfp_bus, config.advertising);
2187	if (iface == PHY_INTERFACE_MODE_NA) {
2188		phylink_err(pl,
2189			    "selection of interface failed, advertisement %*pb\n",
2190			    __ETHTOOL_LINK_MODE_MASK_NBITS, config.advertising);
2191		return -EINVAL;
2192	}
2193
2194	config.interface = iface;
2195	linkmode_copy(support1, support);
2196	ret = phylink_validate(pl, support1, &config);
2197	if (ret) {
2198		phylink_err(pl, "validation of %s/%s with support %*pb failed: %d\n",
2199			    phylink_an_mode_str(mode),
2200			    phy_modes(config.interface),
2201			    __ETHTOOL_LINK_MODE_MASK_NBITS, support, ret);
2202		return ret;
2203	}
2204
2205	phylink_dbg(pl, "requesting link mode %s/%s with support %*pb\n",
2206		    phylink_an_mode_str(mode), phy_modes(config.interface),
2207		    __ETHTOOL_LINK_MODE_MASK_NBITS, support);
2208
2209	if (phy_interface_mode_is_8023z(iface) && pl->phydev)
2210		return -EINVAL;
2211
2212	changed = !linkmode_equal(pl->supported, support) ||
2213		  !linkmode_equal(pl->link_config.advertising,
2214				  config.advertising);
2215	if (changed) {
2216		linkmode_copy(pl->supported, support);
2217		linkmode_copy(pl->link_config.advertising, config.advertising);
2218	}
2219
2220	if (pl->cur_link_an_mode != mode ||
2221	    pl->link_config.interface != config.interface) {
2222		pl->link_config.interface = config.interface;
2223		pl->cur_link_an_mode = mode;
2224
2225		changed = true;
2226
2227		phylink_info(pl, "switched to %s/%s link mode\n",
2228			     phylink_an_mode_str(mode),
2229			     phy_modes(config.interface));
2230	}
2231
2232	pl->link_port = pl->sfp_port;
2233
2234	if (changed && !test_bit(PHYLINK_DISABLE_STOPPED,
2235				 &pl->phylink_disable_state))
2236		phylink_mac_initial_config(pl, false);
2237
2238	return ret;
2239}
2240
2241static int phylink_sfp_module_insert(void *upstream,
2242				     const struct sfp_eeprom_id *id)
2243{
2244	struct phylink *pl = upstream;
2245	unsigned long *support = pl->sfp_support;
2246
2247	ASSERT_RTNL();
2248
2249	linkmode_zero(support);
2250	sfp_parse_support(pl->sfp_bus, id, support);
2251	pl->sfp_port = sfp_parse_port(pl->sfp_bus, id, support);
2252
2253	/* If this module may have a PHY connecting later, defer until later */
2254	pl->sfp_may_have_phy = sfp_may_have_phy(pl->sfp_bus, id);
2255	if (pl->sfp_may_have_phy)
2256		return 0;
2257
2258	return phylink_sfp_config(pl, MLO_AN_INBAND, support, support);
2259}
2260
2261static int phylink_sfp_module_start(void *upstream)
2262{
2263	struct phylink *pl = upstream;
2264
2265	/* If this SFP module has a PHY, start the PHY now. */
2266	if (pl->phydev) {
2267		phy_start(pl->phydev);
2268		return 0;
2269	}
2270
2271	/* If the module may have a PHY but we didn't detect one we
2272	 * need to configure the MAC here.
2273	 */
2274	if (!pl->sfp_may_have_phy)
2275		return 0;
2276
2277	return phylink_sfp_config(pl, MLO_AN_INBAND,
2278				  pl->sfp_support, pl->sfp_support);
2279}
2280
2281static void phylink_sfp_module_stop(void *upstream)
2282{
2283	struct phylink *pl = upstream;
2284
2285	/* If this SFP module has a PHY, stop it. */
2286	if (pl->phydev)
2287		phy_stop(pl->phydev);
2288}
2289
2290static void phylink_sfp_link_down(void *upstream)
2291{
2292	struct phylink *pl = upstream;
2293
2294	ASSERT_RTNL();
2295
2296	phylink_run_resolve_and_disable(pl, PHYLINK_DISABLE_LINK);
2297}
2298
2299static void phylink_sfp_link_up(void *upstream)
2300{
2301	struct phylink *pl = upstream;
2302
2303	ASSERT_RTNL();
2304
2305	clear_bit(PHYLINK_DISABLE_LINK, &pl->phylink_disable_state);
2306	phylink_run_resolve(pl);
2307}
2308
2309/* The Broadcom BCM84881 in the Methode DM7052 is unable to provide a SGMII
2310 * or 802.3z control word, so inband will not work.
2311 */
2312static bool phylink_phy_no_inband(struct phy_device *phy)
2313{
2314	return phy->is_c45 &&
2315		(phy->c45_ids.device_ids[1] & 0xfffffff0) == 0xae025150;
2316}
2317
2318static int phylink_sfp_connect_phy(void *upstream, struct phy_device *phy)
2319{
2320	struct phylink *pl = upstream;
2321	phy_interface_t interface;
2322	u8 mode;
2323	int ret;
2324
2325	/*
2326	 * This is the new way of dealing with flow control for PHYs,
2327	 * as described by Timur Tabi in commit 529ed1275263 ("net: phy:
2328	 * phy drivers should not set SUPPORTED_[Asym_]Pause") except
2329	 * using our validate call to the MAC, we rely upon the MAC
2330	 * clearing the bits from both supported and advertising fields.
2331	 */
2332	phy_support_asym_pause(phy);
2333
2334	if (phylink_phy_no_inband(phy))
2335		mode = MLO_AN_PHY;
2336	else
2337		mode = MLO_AN_INBAND;
2338
2339	/* Do the initial configuration */
2340	ret = phylink_sfp_config(pl, mode, phy->supported, phy->advertising);
2341	if (ret < 0)
2342		return ret;
2343
2344	interface = pl->link_config.interface;
2345	ret = phylink_attach_phy(pl, phy, interface);
2346	if (ret < 0)
2347		return ret;
2348
2349	ret = phylink_bringup_phy(pl, phy, interface);
2350	if (ret)
2351		phy_detach(phy);
2352
2353	return ret;
2354}
2355
2356static void phylink_sfp_disconnect_phy(void *upstream)
2357{
2358	phylink_disconnect_phy(upstream);
2359}
2360
2361static const struct sfp_upstream_ops sfp_phylink_ops = {
2362	.attach = phylink_sfp_attach,
2363	.detach = phylink_sfp_detach,
2364	.module_insert = phylink_sfp_module_insert,
2365	.module_start = phylink_sfp_module_start,
2366	.module_stop = phylink_sfp_module_stop,
2367	.link_up = phylink_sfp_link_up,
2368	.link_down = phylink_sfp_link_down,
2369	.connect_phy = phylink_sfp_connect_phy,
2370	.disconnect_phy = phylink_sfp_disconnect_phy,
2371};
2372
2373/* Helpers for MAC drivers */
2374
2375/**
2376 * phylink_helper_basex_speed() - 1000BaseX/2500BaseX helper
2377 * @state: a pointer to a &struct phylink_link_state
2378 *
2379 * Inspect the interface mode, advertising mask or forced speed and
2380 * decide whether to run at 2.5Gbit or 1Gbit appropriately, switching
2381 * the interface mode to suit.  @state->interface is appropriately
2382 * updated, and the advertising mask has the "other" baseX_Full flag
2383 * cleared.
2384 */
2385void phylink_helper_basex_speed(struct phylink_link_state *state)
2386{
2387	if (phy_interface_mode_is_8023z(state->interface)) {
2388		bool want_2500 = state->an_enabled ?
2389			phylink_test(state->advertising, 2500baseX_Full) :
2390			state->speed == SPEED_2500;
2391
2392		if (want_2500) {
2393			phylink_clear(state->advertising, 1000baseX_Full);
2394			state->interface = PHY_INTERFACE_MODE_2500BASEX;
2395		} else {
2396			phylink_clear(state->advertising, 2500baseX_Full);
2397			state->interface = PHY_INTERFACE_MODE_1000BASEX;
2398		}
2399	}
2400}
2401EXPORT_SYMBOL_GPL(phylink_helper_basex_speed);
2402
2403static void phylink_decode_c37_word(struct phylink_link_state *state,
2404				    uint16_t config_reg, int speed)
2405{
2406	bool tx_pause, rx_pause;
2407	int fd_bit;
2408
2409	if (speed == SPEED_2500)
2410		fd_bit = ETHTOOL_LINK_MODE_2500baseX_Full_BIT;
2411	else
2412		fd_bit = ETHTOOL_LINK_MODE_1000baseX_Full_BIT;
2413
2414	mii_lpa_mod_linkmode_x(state->lp_advertising, config_reg, fd_bit);
2415
2416	if (linkmode_test_bit(fd_bit, state->advertising) &&
2417	    linkmode_test_bit(fd_bit, state->lp_advertising)) {
2418		state->speed = speed;
2419		state->duplex = DUPLEX_FULL;
2420	} else {
2421		/* negotiation failure */
2422		state->link = false;
2423	}
2424
2425	linkmode_resolve_pause(state->advertising, state->lp_advertising,
2426			       &tx_pause, &rx_pause);
2427
2428	if (tx_pause)
2429		state->pause |= MLO_PAUSE_TX;
2430	if (rx_pause)
2431		state->pause |= MLO_PAUSE_RX;
2432}
2433
2434static void phylink_decode_sgmii_word(struct phylink_link_state *state,
2435				      uint16_t config_reg)
2436{
2437	if (!(config_reg & LPA_SGMII_LINK)) {
2438		state->link = false;
2439		return;
2440	}
2441
2442	switch (config_reg & LPA_SGMII_SPD_MASK) {
2443	case LPA_SGMII_10:
2444		state->speed = SPEED_10;
2445		break;
2446	case LPA_SGMII_100:
2447		state->speed = SPEED_100;
2448		break;
2449	case LPA_SGMII_1000:
2450		state->speed = SPEED_1000;
2451		break;
2452	default:
2453		state->link = false;
2454		return;
2455	}
2456	if (config_reg & LPA_SGMII_FULL_DUPLEX)
2457		state->duplex = DUPLEX_FULL;
2458	else
2459		state->duplex = DUPLEX_HALF;
2460}
2461
2462/**
2463 * phylink_decode_usxgmii_word() - decode the USXGMII word from a MAC PCS
2464 * @state: a pointer to a struct phylink_link_state.
2465 * @lpa: a 16 bit value which stores the USXGMII auto-negotiation word
2466 *
2467 * Helper for MAC PCS supporting the USXGMII protocol and the auto-negotiation
2468 * code word.  Decode the USXGMII code word and populate the corresponding fields
2469 * (speed, duplex) into the phylink_link_state structure.
2470 */
2471void phylink_decode_usxgmii_word(struct phylink_link_state *state,
2472				 uint16_t lpa)
2473{
2474	switch (lpa & MDIO_USXGMII_SPD_MASK) {
2475	case MDIO_USXGMII_10:
2476		state->speed = SPEED_10;
2477		break;
2478	case MDIO_USXGMII_100:
2479		state->speed = SPEED_100;
2480		break;
2481	case MDIO_USXGMII_1000:
2482		state->speed = SPEED_1000;
2483		break;
2484	case MDIO_USXGMII_2500:
2485		state->speed = SPEED_2500;
2486		break;
2487	case MDIO_USXGMII_5000:
2488		state->speed = SPEED_5000;
2489		break;
2490	case MDIO_USXGMII_10G:
2491		state->speed = SPEED_10000;
2492		break;
2493	default:
2494		state->link = false;
2495		return;
2496	}
2497
2498	if (lpa & MDIO_USXGMII_FULL_DUPLEX)
2499		state->duplex = DUPLEX_FULL;
2500	else
2501		state->duplex = DUPLEX_HALF;
2502}
2503EXPORT_SYMBOL_GPL(phylink_decode_usxgmii_word);
2504
2505/**
2506 * phylink_mii_c22_pcs_get_state() - read the MAC PCS state
2507 * @pcs: a pointer to a &struct mdio_device.
2508 * @state: a pointer to a &struct phylink_link_state.
2509 *
2510 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
2511 * clause 37 negotiation and/or SGMII control.
2512 *
2513 * Read the MAC PCS state from the MII device configured in @config and
2514 * parse the Clause 37 or Cisco SGMII link partner negotiation word into
2515 * the phylink @state structure. This is suitable to be directly plugged
2516 * into the mac_pcs_get_state() member of the struct phylink_mac_ops
2517 * structure.
2518 */
2519void phylink_mii_c22_pcs_get_state(struct mdio_device *pcs,
2520				   struct phylink_link_state *state)
2521{
2522	struct mii_bus *bus = pcs->bus;
2523	int addr = pcs->addr;
2524	int bmsr, lpa;
2525
2526	bmsr = mdiobus_read(bus, addr, MII_BMSR);
2527	lpa = mdiobus_read(bus, addr, MII_LPA);
2528	if (bmsr < 0 || lpa < 0) {
2529		state->link = false;
2530		return;
2531	}
2532
2533	state->link = !!(bmsr & BMSR_LSTATUS);
2534	state->an_complete = !!(bmsr & BMSR_ANEGCOMPLETE);
2535	if (!state->link)
2536		return;
2537
2538	switch (state->interface) {
2539	case PHY_INTERFACE_MODE_1000BASEX:
2540		phylink_decode_c37_word(state, lpa, SPEED_1000);
2541		break;
2542
2543	case PHY_INTERFACE_MODE_2500BASEX:
2544		phylink_decode_c37_word(state, lpa, SPEED_2500);
2545		break;
2546
2547	case PHY_INTERFACE_MODE_SGMII:
2548	case PHY_INTERFACE_MODE_QSGMII:
2549		phylink_decode_sgmii_word(state, lpa);
2550		break;
2551
2552	default:
2553		state->link = false;
2554		break;
2555	}
2556}
2557EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_get_state);
2558
2559/**
2560 * phylink_mii_c22_pcs_set_advertisement() - configure the clause 37 PCS
2561 *	advertisement
2562 * @pcs: a pointer to a &struct mdio_device.
2563 * @interface: the PHY interface mode being configured
2564 * @advertising: the ethtool advertisement mask
2565 *
2566 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
2567 * clause 37 negotiation and/or SGMII control.
2568 *
2569 * Configure the clause 37 PCS advertisement as specified by @state. This
2570 * does not trigger a renegotiation; phylink will do that via the
2571 * mac_an_restart() method of the struct phylink_mac_ops structure.
2572 *
2573 * Returns negative error code on failure to configure the advertisement,
2574 * zero if no change has been made, or one if the advertisement has changed.
2575 */
2576int phylink_mii_c22_pcs_set_advertisement(struct mdio_device *pcs,
2577					  phy_interface_t interface,
2578					  const unsigned long *advertising)
2579{
2580	struct mii_bus *bus = pcs->bus;
2581	int addr = pcs->addr;
2582	int val, ret;
2583	u16 adv;
2584
2585	switch (interface) {
2586	case PHY_INTERFACE_MODE_1000BASEX:
2587	case PHY_INTERFACE_MODE_2500BASEX:
2588		adv = ADVERTISE_1000XFULL;
2589		if (linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2590				      advertising))
2591			adv |= ADVERTISE_1000XPAUSE;
2592		if (linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2593				      advertising))
2594			adv |= ADVERTISE_1000XPSE_ASYM;
2595
2596		val = mdiobus_read(bus, addr, MII_ADVERTISE);
2597		if (val < 0)
2598			return val;
2599
2600		if (val == adv)
2601			return 0;
2602
2603		ret = mdiobus_write(bus, addr, MII_ADVERTISE, adv);
2604		if (ret < 0)
2605			return ret;
2606
2607		return 1;
2608
2609	case PHY_INTERFACE_MODE_SGMII:
2610		val = mdiobus_read(bus, addr, MII_ADVERTISE);
2611		if (val < 0)
2612			return val;
2613
2614		if (val == 0x0001)
2615			return 0;
2616
2617		ret = mdiobus_write(bus, addr, MII_ADVERTISE, 0x0001);
2618		if (ret < 0)
2619			return ret;
2620
2621		return 1;
2622
2623	default:
2624		/* Nothing to do for other modes */
2625		return 0;
2626	}
2627}
2628EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_set_advertisement);
2629
2630/**
2631 * phylink_mii_c22_pcs_config() - configure clause 22 PCS
2632 * @pcs: a pointer to a &struct mdio_device.
2633 * @mode: link autonegotiation mode
2634 * @interface: the PHY interface mode being configured
2635 * @advertising: the ethtool advertisement mask
2636 *
2637 * Configure a Clause 22 PCS PHY with the appropriate negotiation
2638 * parameters for the @mode, @interface and @advertising parameters.
2639 * Returns negative error number on failure, zero if the advertisement
2640 * has not changed, or positive if there is a change.
2641 */
2642int phylink_mii_c22_pcs_config(struct mdio_device *pcs, unsigned int mode,
2643			       phy_interface_t interface,
2644			       const unsigned long *advertising)
2645{
2646	bool changed;
2647	u16 bmcr;
2648	int ret;
2649
2650	ret = phylink_mii_c22_pcs_set_advertisement(pcs, interface,
2651						    advertising);
2652	if (ret < 0)
2653		return ret;
2654
2655	changed = ret > 0;
2656
2657	/* Ensure ISOLATE bit is disabled */
2658	bmcr = mode == MLO_AN_INBAND ? BMCR_ANENABLE : 0;
2659	ret = mdiobus_modify(pcs->bus, pcs->addr, MII_BMCR,
2660			     BMCR_ANENABLE | BMCR_ISOLATE, bmcr);
2661	if (ret < 0)
2662		return ret;
2663
2664	return changed ? 1 : 0;
2665}
2666EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_config);
2667
2668/**
2669 * phylink_mii_c22_pcs_an_restart() - restart 802.3z autonegotiation
2670 * @pcs: a pointer to a &struct mdio_device.
2671 *
2672 * Helper for MAC PCS supporting the 802.3 clause 22 register set for
2673 * clause 37 negotiation.
2674 *
2675 * Restart the clause 37 negotiation with the link partner. This is
2676 * suitable to be directly plugged into the mac_pcs_get_state() member
2677 * of the struct phylink_mac_ops structure.
2678 */
2679void phylink_mii_c22_pcs_an_restart(struct mdio_device *pcs)
2680{
2681	struct mii_bus *bus = pcs->bus;
2682	int val, addr = pcs->addr;
2683
2684	val = mdiobus_read(bus, addr, MII_BMCR);
2685	if (val >= 0) {
2686		val |= BMCR_ANRESTART;
2687
2688		mdiobus_write(bus, addr, MII_BMCR, val);
2689	}
2690}
2691EXPORT_SYMBOL_GPL(phylink_mii_c22_pcs_an_restart);
2692
2693void phylink_mii_c45_pcs_get_state(struct mdio_device *pcs,
2694				   struct phylink_link_state *state)
2695{
2696	struct mii_bus *bus = pcs->bus;
2697	int addr = pcs->addr;
2698	int stat;
2699
2700	stat = mdiobus_c45_read(bus, addr, MDIO_MMD_PCS, MDIO_STAT1);
2701	if (stat < 0) {
2702		state->link = false;
2703		return;
2704	}
2705
2706	state->link = !!(stat & MDIO_STAT1_LSTATUS);
2707	if (!state->link)
2708		return;
2709
2710	switch (state->interface) {
2711	case PHY_INTERFACE_MODE_10GBASER:
2712		state->speed = SPEED_10000;
2713		state->duplex = DUPLEX_FULL;
2714		break;
2715
2716	default:
2717		break;
2718	}
2719}
2720EXPORT_SYMBOL_GPL(phylink_mii_c45_pcs_get_state);
2721
2722MODULE_LICENSE("GPL v2");