1// SPDX-License-Identifier: GPL-2.0+
   2/* Framework for configuring and reading PHY devices
   3 * Based on code in sungem_phy.c and gianfar_phy.c
   4 *
   5 * Author: Andy Fleming
   6 *
   7 * Copyright (c) 2004 Freescale Semiconductor, Inc.
   8 * Copyright (c) 2006, 2007  Maciej W. Rozycki
   9 */
  10
  11#include <linux/kernel.h>
  12#include <linux/string.h>
  13#include <linux/errno.h>
  14#include <linux/unistd.h>
  15#include <linux/interrupt.h>
  16#include <linux/delay.h>
  17#include <linux/netdevice.h>
  18#include <linux/netlink.h>
  19#include <linux/etherdevice.h>
  20#include <linux/skbuff.h>
  21#include <linux/mm.h>
  22#include <linux/module.h>
  23#include <linux/mii.h>
  24#include <linux/ethtool.h>
  25#include <linux/ethtool_netlink.h>
  26#include <linux/phy.h>
  27#include <linux/phy_led_triggers.h>
  28#include <linux/sfp.h>
  29#include <linux/workqueue.h>
  30#include <linux/mdio.h>
  31#include <linux/io.h>
  32#include <linux/uaccess.h>
  33#include <linux/atomic.h>
  34#include <linux/suspend.h>
  35#include <net/netlink.h>
  36#include <net/genetlink.h>
  37#include <net/sock.h>
  38
  39#define PHY_STATE_TIME	HZ
  40
  41#define PHY_STATE_STR(_state)			\
  42	case PHY_##_state:			\
  43		return __stringify(_state);	\
  44
  45static const char *phy_state_to_str(enum phy_state st)
  46{
  47	switch (st) {
  48	PHY_STATE_STR(DOWN)
  49	PHY_STATE_STR(READY)
  50	PHY_STATE_STR(UP)
  51	PHY_STATE_STR(RUNNING)
  52	PHY_STATE_STR(NOLINK)
  53	PHY_STATE_STR(CABLETEST)
  54	PHY_STATE_STR(HALTED)
  55	PHY_STATE_STR(ERROR)
  56	}
  57
  58	return NULL;
  59}
  60
  61static void phy_process_state_change(struct phy_device *phydev,
  62				     enum phy_state old_state)
  63{
  64	if (old_state != phydev->state) {
  65		phydev_dbg(phydev, "PHY state change %s -> %s\n",
  66			   phy_state_to_str(old_state),
  67			   phy_state_to_str(phydev->state));
  68		if (phydev->drv && phydev->drv->link_change_notify)
  69			phydev->drv->link_change_notify(phydev);
  70	}
  71}
  72
  73static void phy_link_up(struct phy_device *phydev)
  74{
  75	phydev->phy_link_change(phydev, true);
  76	phy_led_trigger_change_speed(phydev);
  77}
  78
  79static void phy_link_down(struct phy_device *phydev)
  80{
  81	phydev->phy_link_change(phydev, false);
  82	phy_led_trigger_change_speed(phydev);
  83	WRITE_ONCE(phydev->link_down_events, phydev->link_down_events + 1);
  84}
  85
  86static const char *phy_pause_str(struct phy_device *phydev)
  87{
  88	bool local_pause, local_asym_pause;
  89
  90	if (phydev->autoneg == AUTONEG_DISABLE)
  91		goto no_pause;
  92
  93	local_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
  94					phydev->advertising);
  95	local_asym_pause = linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
  96					     phydev->advertising);
  97
  98	if (local_pause && phydev->pause)
  99		return "rx/tx";
 100
 101	if (local_asym_pause && phydev->asym_pause) {
 102		if (local_pause)
 103			return "rx";
 104		if (phydev->pause)
 105			return "tx";
 106	}
 107
 108no_pause:
 109	return "off";
 110}
 111
 112/**
 113 * phy_print_status - Convenience function to print out the current phy status
 114 * @phydev: the phy_device struct
 115 */
 116void phy_print_status(struct phy_device *phydev)
 117{
 118	if (phydev->link) {
 119		netdev_info(phydev->attached_dev,
 120			"Link is Up - %s/%s %s- flow control %s\n",
 121			phy_speed_to_str(phydev->speed),
 122			phy_duplex_to_str(phydev->duplex),
 123			phydev->downshifted_rate ? "(downshifted) " : "",
 124			phy_pause_str(phydev));
 125	} else	{
 126		netdev_info(phydev->attached_dev, "Link is Down\n");
 127	}
 128}
 129EXPORT_SYMBOL(phy_print_status);
 130
 131/**
 132 * phy_get_rate_matching - determine if rate matching is supported
 133 * @phydev: The phy device to return rate matching for
 134 * @iface: The interface mode to use
 135 *
 136 * This determines the type of rate matching (if any) that @phy supports
 137 * using @iface. @iface may be %PHY_INTERFACE_MODE_NA to determine if any
 138 * interface supports rate matching.
 139 *
 140 * Return: The type of rate matching @phy supports for @iface, or
 141 *         %RATE_MATCH_NONE.
 142 */
 143int phy_get_rate_matching(struct phy_device *phydev,
 144			  phy_interface_t iface)
 145{
 146	int ret = RATE_MATCH_NONE;
 147
 148	if (phydev->drv->get_rate_matching) {
 149		mutex_lock(&phydev->lock);
 150		ret = phydev->drv->get_rate_matching(phydev, iface);
 151		mutex_unlock(&phydev->lock);
 152	}
 153
 154	return ret;
 155}
 156EXPORT_SYMBOL_GPL(phy_get_rate_matching);
 157
 158/**
 159 * phy_config_interrupt - configure the PHY device for the requested interrupts
 160 * @phydev: the phy_device struct
 161 * @interrupts: interrupt flags to configure for this @phydev
 162 *
 163 * Returns 0 on success or < 0 on error.
 164 */
 165static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
 166{
 167	phydev->interrupts = interrupts ? 1 : 0;
 168	if (phydev->drv->config_intr)
 169		return phydev->drv->config_intr(phydev);
 170
 171	return 0;
 172}
 173
 174/**
 175 * phy_restart_aneg - restart auto-negotiation
 176 * @phydev: target phy_device struct
 177 *
 178 * Restart the autonegotiation on @phydev.  Returns >= 0 on success or
 179 * negative errno on error.
 180 */
 181int phy_restart_aneg(struct phy_device *phydev)
 182{
 183	int ret;
 184
 185	if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
 186		ret = genphy_c45_restart_aneg(phydev);
 187	else
 188		ret = genphy_restart_aneg(phydev);
 189
 190	return ret;
 191}
 192EXPORT_SYMBOL_GPL(phy_restart_aneg);
 193
 194/**
 195 * phy_aneg_done - return auto-negotiation status
 196 * @phydev: target phy_device struct
 197 *
 198 * Description: Return the auto-negotiation status from this @phydev
 199 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
 200 * is still pending.
 201 */
 202int phy_aneg_done(struct phy_device *phydev)
 203{
 204	if (phydev->drv && phydev->drv->aneg_done)
 205		return phydev->drv->aneg_done(phydev);
 206	else if (phydev->is_c45)
 207		return genphy_c45_aneg_done(phydev);
 208	else
 209		return genphy_aneg_done(phydev);
 210}
 211EXPORT_SYMBOL(phy_aneg_done);
 212
 213/**
 214 * phy_find_valid - find a PHY setting that matches the requested parameters
 215 * @speed: desired speed
 216 * @duplex: desired duplex
 217 * @supported: mask of supported link modes
 218 *
 219 * Locate a supported phy setting that is, in priority order:
 220 * - an exact match for the specified speed and duplex mode
 221 * - a match for the specified speed, or slower speed
 222 * - the slowest supported speed
 223 * Returns the matched phy_setting entry, or %NULL if no supported phy
 224 * settings were found.
 225 */
 226static const struct phy_setting *
 227phy_find_valid(int speed, int duplex, unsigned long *supported)
 228{
 229	return phy_lookup_setting(speed, duplex, supported, false);
 230}
 231
 232/**
 233 * phy_supported_speeds - return all speeds currently supported by a phy device
 234 * @phy: The phy device to return supported speeds of.
 235 * @speeds: buffer to store supported speeds in.
 236 * @size:   size of speeds buffer.
 237 *
 238 * Description: Returns the number of supported speeds, and fills the speeds
 239 * buffer with the supported speeds. If speeds buffer is too small to contain
 240 * all currently supported speeds, will return as many speeds as can fit.
 241 */
 242unsigned int phy_supported_speeds(struct phy_device *phy,
 243				  unsigned int *speeds,
 244				  unsigned int size)
 245{
 246	return phy_speeds(speeds, size, phy->supported);
 247}
 248
 249/**
 250 * phy_check_valid - check if there is a valid PHY setting which matches
 251 *		     speed, duplex, and feature mask
 252 * @speed: speed to match
 253 * @duplex: duplex to match
 254 * @features: A mask of the valid settings
 255 *
 256 * Description: Returns true if there is a valid setting, false otherwise.
 257 */
 258bool phy_check_valid(int speed, int duplex, unsigned long *features)
 259{
 260	return !!phy_lookup_setting(speed, duplex, features, true);
 261}
 262EXPORT_SYMBOL(phy_check_valid);
 263
 264/**
 265 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
 266 * @phydev: the target phy_device struct
 267 *
 268 * Description: Make sure the PHY is set to supported speeds and
 269 *   duplexes.  Drop down by one in this order:  1000/FULL,
 270 *   1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
 271 */
 272static void phy_sanitize_settings(struct phy_device *phydev)
 273{
 274	const struct phy_setting *setting;
 275
 276	setting = phy_find_valid(phydev->speed, phydev->duplex,
 277				 phydev->supported);
 278	if (setting) {
 279		phydev->speed = setting->speed;
 280		phydev->duplex = setting->duplex;
 281	} else {
 282		/* We failed to find anything (no supported speeds?) */
 283		phydev->speed = SPEED_UNKNOWN;
 284		phydev->duplex = DUPLEX_UNKNOWN;
 285	}
 286}
 287
 288void phy_ethtool_ksettings_get(struct phy_device *phydev,
 289			       struct ethtool_link_ksettings *cmd)
 290{
 291	mutex_lock(&phydev->lock);
 292	linkmode_copy(cmd->link_modes.supported, phydev->supported);
 293	linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
 294	linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
 295
 296	cmd->base.speed = phydev->speed;
 297	cmd->base.duplex = phydev->duplex;
 298	cmd->base.master_slave_cfg = phydev->master_slave_get;
 299	cmd->base.master_slave_state = phydev->master_slave_state;
 300	cmd->base.rate_matching = phydev->rate_matching;
 301	if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
 302		cmd->base.port = PORT_BNC;
 303	else
 304		cmd->base.port = phydev->port;
 305	cmd->base.transceiver = phy_is_internal(phydev) ?
 306				XCVR_INTERNAL : XCVR_EXTERNAL;
 307	cmd->base.phy_address = phydev->mdio.addr;
 308	cmd->base.autoneg = phydev->autoneg;
 309	cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
 310	cmd->base.eth_tp_mdix = phydev->mdix;
 311	mutex_unlock(&phydev->lock);
 312}
 313EXPORT_SYMBOL(phy_ethtool_ksettings_get);
 314
 315/**
 316 * phy_mii_ioctl - generic PHY MII ioctl interface
 317 * @phydev: the phy_device struct
 318 * @ifr: &struct ifreq for socket ioctl's
 319 * @cmd: ioctl cmd to execute
 320 *
 321 * Note that this function is currently incompatible with the
 322 * PHYCONTROL layer.  It changes registers without regard to
 323 * current state.  Use at own risk.
 324 */
 325int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
 326{
 327	struct mii_ioctl_data *mii_data = if_mii(ifr);
 328	struct kernel_hwtstamp_config kernel_cfg;
 329	struct netlink_ext_ack extack = {};
 330	u16 val = mii_data->val_in;
 331	bool change_autoneg = false;
 332	struct hwtstamp_config cfg;
 333	int prtad, devad;
 334	int ret;
 335
 336	switch (cmd) {
 337	case SIOCGMIIPHY:
 338		mii_data->phy_id = phydev->mdio.addr;
 339		fallthrough;
 340
 341	case SIOCGMIIREG:
 342		if (mdio_phy_id_is_c45(mii_data->phy_id)) {
 343			prtad = mdio_phy_id_prtad(mii_data->phy_id);
 344			devad = mdio_phy_id_devad(mii_data->phy_id);
 345			mii_data->val_out = mdiobus_c45_read(
 346				phydev->mdio.bus, prtad, devad,
 347				mii_data->reg_num);
 348		} else {
 349			mii_data->val_out = mdiobus_read(
 350				phydev->mdio.bus, mii_data->phy_id,
 351				mii_data->reg_num);
 352		}
 353		return 0;
 354
 355	case SIOCSMIIREG:
 356		if (mdio_phy_id_is_c45(mii_data->phy_id)) {
 357			prtad = mdio_phy_id_prtad(mii_data->phy_id);
 358			devad = mdio_phy_id_devad(mii_data->phy_id);
 359		} else {
 360			prtad = mii_data->phy_id;
 361			devad = mii_data->reg_num;
 362		}
 363		if (prtad == phydev->mdio.addr) {
 364			switch (devad) {
 365			case MII_BMCR:
 366				if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
 367					if (phydev->autoneg == AUTONEG_ENABLE)
 368						change_autoneg = true;
 369					phydev->autoneg = AUTONEG_DISABLE;
 370					if (val & BMCR_FULLDPLX)
 371						phydev->duplex = DUPLEX_FULL;
 372					else
 373						phydev->duplex = DUPLEX_HALF;
 374					if (val & BMCR_SPEED1000)
 375						phydev->speed = SPEED_1000;
 376					else if (val & BMCR_SPEED100)
 377						phydev->speed = SPEED_100;
 378					else phydev->speed = SPEED_10;
 379				} else {
 380					if (phydev->autoneg == AUTONEG_DISABLE)
 381						change_autoneg = true;
 382					phydev->autoneg = AUTONEG_ENABLE;
 383				}
 384				break;
 385			case MII_ADVERTISE:
 386				mii_adv_mod_linkmode_adv_t(phydev->advertising,
 387							   val);
 388				change_autoneg = true;
 389				break;
 390			case MII_CTRL1000:
 391				mii_ctrl1000_mod_linkmode_adv_t(phydev->advertising,
 392							        val);
 393				change_autoneg = true;
 394				break;
 395			default:
 396				/* do nothing */
 397				break;
 398			}
 399		}
 400
 401		if (mdio_phy_id_is_c45(mii_data->phy_id))
 402			mdiobus_c45_write(phydev->mdio.bus, prtad, devad,
 403					  mii_data->reg_num, val);
 404		else
 405			mdiobus_write(phydev->mdio.bus, prtad, devad, val);
 406
 407		if (prtad == phydev->mdio.addr &&
 408		    devad == MII_BMCR &&
 409		    val & BMCR_RESET)
 410			return phy_init_hw(phydev);
 411
 412		if (change_autoneg)
 413			return phy_start_aneg(phydev);
 414
 415		return 0;
 416
 417	case SIOCSHWTSTAMP:
 418		if (phydev->mii_ts && phydev->mii_ts->hwtstamp) {
 419			if (copy_from_user(&cfg, ifr->ifr_data, sizeof(cfg)))
 420				return -EFAULT;
 421
 422			hwtstamp_config_to_kernel(&kernel_cfg, &cfg);
 423			ret = phydev->mii_ts->hwtstamp(phydev->mii_ts, &kernel_cfg, &extack);
 424			if (ret)
 425				return ret;
 426
 427			hwtstamp_config_from_kernel(&cfg, &kernel_cfg);
 428			if (copy_to_user(ifr->ifr_data, &cfg, sizeof(cfg)))
 429				return -EFAULT;
 430
 431			return 0;
 432		}
 433		fallthrough;
 434
 435	default:
 436		return -EOPNOTSUPP;
 437	}
 438}
 439EXPORT_SYMBOL(phy_mii_ioctl);
 440
 441/**
 442 * phy_do_ioctl - generic ndo_eth_ioctl implementation
 443 * @dev: the net_device struct
 444 * @ifr: &struct ifreq for socket ioctl's
 445 * @cmd: ioctl cmd to execute
 446 */
 447int phy_do_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
 448{
 449	if (!dev->phydev)
 450		return -ENODEV;
 451
 452	return phy_mii_ioctl(dev->phydev, ifr, cmd);
 453}
 454EXPORT_SYMBOL(phy_do_ioctl);
 455
 456/**
 457 * phy_do_ioctl_running - generic ndo_eth_ioctl implementation but test first
 458 *
 459 * @dev: the net_device struct
 460 * @ifr: &struct ifreq for socket ioctl's
 461 * @cmd: ioctl cmd to execute
 462 *
 463 * Same as phy_do_ioctl, but ensures that net_device is running before
 464 * handling the ioctl.
 465 */
 466int phy_do_ioctl_running(struct net_device *dev, struct ifreq *ifr, int cmd)
 467{
 468	if (!netif_running(dev))
 469		return -ENODEV;
 470
 471	return phy_do_ioctl(dev, ifr, cmd);
 472}
 473EXPORT_SYMBOL(phy_do_ioctl_running);
 474
 475/**
 476 * __phy_hwtstamp_get - Get hardware timestamping configuration from PHY
 477 *
 478 * @phydev: the PHY device structure
 479 * @config: structure holding the timestamping configuration
 480 *
 481 * Query the PHY device for its current hardware timestamping configuration.
 482 */
 483int __phy_hwtstamp_get(struct phy_device *phydev,
 484		       struct kernel_hwtstamp_config *config)
 485{
 486	if (!phydev)
 487		return -ENODEV;
 488
 489	return -EOPNOTSUPP;
 490}
 491
 492/**
 493 * __phy_hwtstamp_set - Modify PHY hardware timestamping configuration
 494 *
 495 * @phydev: the PHY device structure
 496 * @config: structure holding the timestamping configuration
 497 * @extack: netlink extended ack structure, for error reporting
 498 */
 499int __phy_hwtstamp_set(struct phy_device *phydev,
 500		       struct kernel_hwtstamp_config *config,
 501		       struct netlink_ext_ack *extack)
 502{
 503	if (!phydev)
 504		return -ENODEV;
 505
 506	if (phydev->mii_ts && phydev->mii_ts->hwtstamp)
 507		return phydev->mii_ts->hwtstamp(phydev->mii_ts, config, extack);
 508
 509	return -EOPNOTSUPP;
 510}
 511
 512/**
 513 * phy_queue_state_machine - Trigger the state machine to run soon
 514 *
 515 * @phydev: the phy_device struct
 516 * @jiffies: Run the state machine after these jiffies
 517 */
 518void phy_queue_state_machine(struct phy_device *phydev, unsigned long jiffies)
 519{
 520	mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
 521			 jiffies);
 522}
 523EXPORT_SYMBOL(phy_queue_state_machine);
 524
 525/**
 526 * phy_trigger_machine - Trigger the state machine to run now
 527 *
 528 * @phydev: the phy_device struct
 529 */
 530void phy_trigger_machine(struct phy_device *phydev)
 531{
 532	phy_queue_state_machine(phydev, 0);
 533}
 534EXPORT_SYMBOL(phy_trigger_machine);
 535
 536static void phy_abort_cable_test(struct phy_device *phydev)
 537{
 538	int err;
 539
 540	ethnl_cable_test_finished(phydev);
 541
 542	err = phy_init_hw(phydev);
 543	if (err)
 544		phydev_err(phydev, "Error while aborting cable test");
 545}
 546
 547/**
 548 * phy_ethtool_get_strings - Get the statistic counter names
 549 *
 550 * @phydev: the phy_device struct
 551 * @data: Where to put the strings
 552 */
 553int phy_ethtool_get_strings(struct phy_device *phydev, u8 *data)
 554{
 555	if (!phydev->drv)
 556		return -EIO;
 557
 558	mutex_lock(&phydev->lock);
 559	phydev->drv->get_strings(phydev, data);
 560	mutex_unlock(&phydev->lock);
 561
 562	return 0;
 563}
 564EXPORT_SYMBOL(phy_ethtool_get_strings);
 565
 566/**
 567 * phy_ethtool_get_sset_count - Get the number of statistic counters
 568 *
 569 * @phydev: the phy_device struct
 570 */
 571int phy_ethtool_get_sset_count(struct phy_device *phydev)
 572{
 573	int ret;
 574
 575	if (!phydev->drv)
 576		return -EIO;
 577
 578	if (phydev->drv->get_sset_count &&
 579	    phydev->drv->get_strings &&
 580	    phydev->drv->get_stats) {
 581		mutex_lock(&phydev->lock);
 582		ret = phydev->drv->get_sset_count(phydev);
 583		mutex_unlock(&phydev->lock);
 584
 585		return ret;
 586	}
 587
 588	return -EOPNOTSUPP;
 589}
 590EXPORT_SYMBOL(phy_ethtool_get_sset_count);
 591
 592/**
 593 * phy_ethtool_get_stats - Get the statistic counters
 594 *
 595 * @phydev: the phy_device struct
 596 * @stats: What counters to get
 597 * @data: Where to store the counters
 598 */
 599int phy_ethtool_get_stats(struct phy_device *phydev,
 600			  struct ethtool_stats *stats, u64 *data)
 601{
 602	if (!phydev->drv)
 603		return -EIO;
 604
 605	mutex_lock(&phydev->lock);
 606	phydev->drv->get_stats(phydev, stats, data);
 607	mutex_unlock(&phydev->lock);
 608
 609	return 0;
 610}
 611EXPORT_SYMBOL(phy_ethtool_get_stats);
 612
 613/**
 614 * phy_ethtool_get_plca_cfg - Get PLCA RS configuration
 615 * @phydev: the phy_device struct
 616 * @plca_cfg: where to store the retrieved configuration
 617 *
 618 * Retrieve the PLCA configuration from the PHY. Return 0 on success or a
 619 * negative value if an error occurred.
 620 */
 621int phy_ethtool_get_plca_cfg(struct phy_device *phydev,
 622			     struct phy_plca_cfg *plca_cfg)
 623{
 624	int ret;
 625
 626	if (!phydev->drv) {
 627		ret = -EIO;
 628		goto out;
 629	}
 630
 631	if (!phydev->drv->get_plca_cfg) {
 632		ret = -EOPNOTSUPP;
 633		goto out;
 634	}
 635
 636	mutex_lock(&phydev->lock);
 637	ret = phydev->drv->get_plca_cfg(phydev, plca_cfg);
 638
 639	mutex_unlock(&phydev->lock);
 640out:
 641	return ret;
 642}
 643
 644/**
 645 * plca_check_valid - Check PLCA configuration before enabling
 646 * @phydev: the phy_device struct
 647 * @plca_cfg: current PLCA configuration
 648 * @extack: extack for reporting useful error messages
 649 *
 650 * Checks whether the PLCA and PHY configuration are consistent and it is safe
 651 * to enable PLCA. Returns 0 on success or a negative value if the PLCA or PHY
 652 * configuration is not consistent.
 653 */
 654static int plca_check_valid(struct phy_device *phydev,
 655			    const struct phy_plca_cfg *plca_cfg,
 656			    struct netlink_ext_ack *extack)
 657{
 658	int ret = 0;
 659
 660	if (!linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT1S_P2MP_Half_BIT,
 661			       phydev->advertising)) {
 662		ret = -EOPNOTSUPP;
 663		NL_SET_ERR_MSG(extack,
 664			       "Point to Multi-Point mode is not enabled");
 665	} else if (plca_cfg->node_id >= 255) {
 666		NL_SET_ERR_MSG(extack, "PLCA node ID is not set");
 667		ret = -EINVAL;
 668	}
 669
 670	return ret;
 671}
 672
 673/**
 674 * phy_ethtool_set_plca_cfg - Set PLCA RS configuration
 675 * @phydev: the phy_device struct
 676 * @plca_cfg: new PLCA configuration to apply
 677 * @extack: extack for reporting useful error messages
 678 *
 679 * Sets the PLCA configuration in the PHY. Return 0 on success or a
 680 * negative value if an error occurred.
 681 */
 682int phy_ethtool_set_plca_cfg(struct phy_device *phydev,
 683			     const struct phy_plca_cfg *plca_cfg,
 684			     struct netlink_ext_ack *extack)
 685{
 686	struct phy_plca_cfg *curr_plca_cfg;
 687	int ret;
 688
 689	if (!phydev->drv) {
 690		ret = -EIO;
 691		goto out;
 692	}
 693
 694	if (!phydev->drv->set_plca_cfg ||
 695	    !phydev->drv->get_plca_cfg) {
 696		ret = -EOPNOTSUPP;
 697		goto out;
 698	}
 699
 700	curr_plca_cfg = kmalloc(sizeof(*curr_plca_cfg), GFP_KERNEL);
 701	if (!curr_plca_cfg) {
 702		ret = -ENOMEM;
 703		goto out;
 704	}
 705
 706	mutex_lock(&phydev->lock);
 707
 708	ret = phydev->drv->get_plca_cfg(phydev, curr_plca_cfg);
 709	if (ret)
 710		goto out_drv;
 711
 712	if (curr_plca_cfg->enabled < 0 && plca_cfg->enabled >= 0) {
 713		NL_SET_ERR_MSG(extack,
 714			       "PHY does not support changing the PLCA 'enable' attribute");
 715		ret = -EINVAL;
 716		goto out_drv;
 717	}
 718
 719	if (curr_plca_cfg->node_id < 0 && plca_cfg->node_id >= 0) {
 720		NL_SET_ERR_MSG(extack,
 721			       "PHY does not support changing the PLCA 'local node ID' attribute");
 722		ret = -EINVAL;
 723		goto out_drv;
 724	}
 725
 726	if (curr_plca_cfg->node_cnt < 0 && plca_cfg->node_cnt >= 0) {
 727		NL_SET_ERR_MSG(extack,
 728			       "PHY does not support changing the PLCA 'node count' attribute");
 729		ret = -EINVAL;
 730		goto out_drv;
 731	}
 732
 733	if (curr_plca_cfg->to_tmr < 0 && plca_cfg->to_tmr >= 0) {
 734		NL_SET_ERR_MSG(extack,
 735			       "PHY does not support changing the PLCA 'TO timer' attribute");
 736		ret = -EINVAL;
 737		goto out_drv;
 738	}
 739
 740	if (curr_plca_cfg->burst_cnt < 0 && plca_cfg->burst_cnt >= 0) {
 741		NL_SET_ERR_MSG(extack,
 742			       "PHY does not support changing the PLCA 'burst count' attribute");
 743		ret = -EINVAL;
 744		goto out_drv;
 745	}
 746
 747	if (curr_plca_cfg->burst_tmr < 0 && plca_cfg->burst_tmr >= 0) {
 748		NL_SET_ERR_MSG(extack,
 749			       "PHY does not support changing the PLCA 'burst timer' attribute");
 750		ret = -EINVAL;
 751		goto out_drv;
 752	}
 753
 754	// if enabling PLCA, perform a few sanity checks
 755	if (plca_cfg->enabled > 0) {
 756		// allow setting node_id concurrently with enabled
 757		if (plca_cfg->node_id >= 0)
 758			curr_plca_cfg->node_id = plca_cfg->node_id;
 759
 760		ret = plca_check_valid(phydev, curr_plca_cfg, extack);
 761		if (ret)
 762			goto out_drv;
 763	}
 764
 765	ret = phydev->drv->set_plca_cfg(phydev, plca_cfg);
 766
 767out_drv:
 768	kfree(curr_plca_cfg);
 769	mutex_unlock(&phydev->lock);
 770out:
 771	return ret;
 772}
 773
 774/**
 775 * phy_ethtool_get_plca_status - Get PLCA RS status information
 776 * @phydev: the phy_device struct
 777 * @plca_st: where to store the retrieved status information
 778 *
 779 * Retrieve the PLCA status information from the PHY. Return 0 on success or a
 780 * negative value if an error occurred.
 781 */
 782int phy_ethtool_get_plca_status(struct phy_device *phydev,
 783				struct phy_plca_status *plca_st)
 784{
 785	int ret;
 786
 787	if (!phydev->drv) {
 788		ret = -EIO;
 789		goto out;
 790	}
 791
 792	if (!phydev->drv->get_plca_status) {
 793		ret = -EOPNOTSUPP;
 794		goto out;
 795	}
 796
 797	mutex_lock(&phydev->lock);
 798	ret = phydev->drv->get_plca_status(phydev, plca_st);
 799
 800	mutex_unlock(&phydev->lock);
 801out:
 802	return ret;
 803}
 804
 805/**
 806 * phy_start_cable_test - Start a cable test
 807 *
 808 * @phydev: the phy_device struct
 809 * @extack: extack for reporting useful error messages
 810 */
 811int phy_start_cable_test(struct phy_device *phydev,
 812			 struct netlink_ext_ack *extack)
 813{
 814	struct net_device *dev = phydev->attached_dev;
 815	int err = -ENOMEM;
 816
 817	if (!(phydev->drv &&
 818	      phydev->drv->cable_test_start &&
 819	      phydev->drv->cable_test_get_status)) {
 820		NL_SET_ERR_MSG(extack,
 821			       "PHY driver does not support cable testing");
 822		return -EOPNOTSUPP;
 823	}
 824
 825	mutex_lock(&phydev->lock);
 826	if (phydev->state == PHY_CABLETEST) {
 827		NL_SET_ERR_MSG(extack,
 828			       "PHY already performing a test");
 829		err = -EBUSY;
 830		goto out;
 831	}
 832
 833	if (phydev->state < PHY_UP ||
 834	    phydev->state > PHY_CABLETEST) {
 835		NL_SET_ERR_MSG(extack,
 836			       "PHY not configured. Try setting interface up");
 837		err = -EBUSY;
 838		goto out;
 839	}
 840
 841	err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_NTF);
 842	if (err)
 843		goto out;
 844
 845	/* Mark the carrier down until the test is complete */
 846	phy_link_down(phydev);
 847
 848	netif_testing_on(dev);
 849	err = phydev->drv->cable_test_start(phydev);
 850	if (err) {
 851		netif_testing_off(dev);
 852		phy_link_up(phydev);
 853		goto out_free;
 854	}
 855
 856	phydev->state = PHY_CABLETEST;
 857
 858	if (phy_polling_mode(phydev))
 859		phy_trigger_machine(phydev);
 860
 861	mutex_unlock(&phydev->lock);
 862
 863	return 0;
 864
 865out_free:
 866	ethnl_cable_test_free(phydev);
 867out:
 868	mutex_unlock(&phydev->lock);
 869
 870	return err;
 871}
 872EXPORT_SYMBOL(phy_start_cable_test);
 873
 874/**
 875 * phy_start_cable_test_tdr - Start a raw TDR cable test
 876 *
 877 * @phydev: the phy_device struct
 878 * @extack: extack for reporting useful error messages
 879 * @config: Configuration of the test to run
 880 */
 881int phy_start_cable_test_tdr(struct phy_device *phydev,
 882			     struct netlink_ext_ack *extack,
 883			     const struct phy_tdr_config *config)
 884{
 885	struct net_device *dev = phydev->attached_dev;
 886	int err = -ENOMEM;
 887
 888	if (!(phydev->drv &&
 889	      phydev->drv->cable_test_tdr_start &&
 890	      phydev->drv->cable_test_get_status)) {
 891		NL_SET_ERR_MSG(extack,
 892			       "PHY driver does not support cable test TDR");
 893		return -EOPNOTSUPP;
 894	}
 895
 896	mutex_lock(&phydev->lock);
 897	if (phydev->state == PHY_CABLETEST) {
 898		NL_SET_ERR_MSG(extack,
 899			       "PHY already performing a test");
 900		err = -EBUSY;
 901		goto out;
 902	}
 903
 904	if (phydev->state < PHY_UP ||
 905	    phydev->state > PHY_CABLETEST) {
 906		NL_SET_ERR_MSG(extack,
 907			       "PHY not configured. Try setting interface up");
 908		err = -EBUSY;
 909		goto out;
 910	}
 911
 912	err = ethnl_cable_test_alloc(phydev, ETHTOOL_MSG_CABLE_TEST_TDR_NTF);
 913	if (err)
 914		goto out;
 915
 916	/* Mark the carrier down until the test is complete */
 917	phy_link_down(phydev);
 918
 919	netif_testing_on(dev);
 920	err = phydev->drv->cable_test_tdr_start(phydev, config);
 921	if (err) {
 922		netif_testing_off(dev);
 923		phy_link_up(phydev);
 924		goto out_free;
 925	}
 926
 927	phydev->state = PHY_CABLETEST;
 928
 929	if (phy_polling_mode(phydev))
 930		phy_trigger_machine(phydev);
 931
 932	mutex_unlock(&phydev->lock);
 933
 934	return 0;
 935
 936out_free:
 937	ethnl_cable_test_free(phydev);
 938out:
 939	mutex_unlock(&phydev->lock);
 940
 941	return err;
 942}
 943EXPORT_SYMBOL(phy_start_cable_test_tdr);
 944
 945int phy_config_aneg(struct phy_device *phydev)
 946{
 947	if (phydev->drv->config_aneg)
 948		return phydev->drv->config_aneg(phydev);
 949
 950	/* Clause 45 PHYs that don't implement Clause 22 registers are not
 951	 * allowed to call genphy_config_aneg()
 952	 */
 953	if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
 954		return genphy_c45_config_aneg(phydev);
 955
 956	return genphy_config_aneg(phydev);
 957}
 958EXPORT_SYMBOL(phy_config_aneg);
 959
 960/**
 961 * phy_check_link_status - check link status and set state accordingly
 962 * @phydev: the phy_device struct
 963 *
 964 * Description: Check for link and whether autoneg was triggered / is running
 965 * and set state accordingly
 966 */
 967static int phy_check_link_status(struct phy_device *phydev)
 968{
 969	int err;
 970
 971	lockdep_assert_held(&phydev->lock);
 972
 973	/* Keep previous state if loopback is enabled because some PHYs
 974	 * report that Link is Down when loopback is enabled.
 975	 */
 976	if (phydev->loopback_enabled)
 977		return 0;
 978
 979	err = phy_read_status(phydev);
 980	if (err)
 981		return err;
 982
 983	if (phydev->link && phydev->state != PHY_RUNNING) {
 984		phy_check_downshift(phydev);
 985		phydev->state = PHY_RUNNING;
 
 
 
 
 
 
 
 986		phy_link_up(phydev);
 987	} else if (!phydev->link && phydev->state != PHY_NOLINK) {
 988		phydev->state = PHY_NOLINK;
 
 989		phy_link_down(phydev);
 990	}
 991
 992	return 0;
 993}
 994
 995/**
 996 * _phy_start_aneg - start auto-negotiation for this PHY device
 997 * @phydev: the phy_device struct
 998 *
 999 * Description: Sanitizes the settings (if we're not autonegotiating
1000 *   them), and then calls the driver's config_aneg function.
1001 *   If the PHYCONTROL Layer is operating, we change the state to
1002 *   reflect the beginning of Auto-negotiation or forcing.
1003 */
1004int _phy_start_aneg(struct phy_device *phydev)
1005{
1006	int err;
1007
1008	lockdep_assert_held(&phydev->lock);
1009
1010	if (!phydev->drv)
1011		return -EIO;
1012
1013	if (AUTONEG_DISABLE == phydev->autoneg)
1014		phy_sanitize_settings(phydev);
1015
1016	err = phy_config_aneg(phydev);
1017	if (err < 0)
1018		return err;
1019
1020	if (phy_is_started(phydev))
1021		err = phy_check_link_status(phydev);
1022
1023	return err;
1024}
1025EXPORT_SYMBOL(_phy_start_aneg);
1026
1027/**
1028 * phy_start_aneg - start auto-negotiation for this PHY device
1029 * @phydev: the phy_device struct
1030 *
1031 * Description: Sanitizes the settings (if we're not autonegotiating
1032 *   them), and then calls the driver's config_aneg function.
1033 *   If the PHYCONTROL Layer is operating, we change the state to
1034 *   reflect the beginning of Auto-negotiation or forcing.
1035 */
1036int phy_start_aneg(struct phy_device *phydev)
1037{
1038	int err;
1039
1040	mutex_lock(&phydev->lock);
1041	err = _phy_start_aneg(phydev);
1042	mutex_unlock(&phydev->lock);
1043
1044	return err;
1045}
1046EXPORT_SYMBOL(phy_start_aneg);
1047
1048static int phy_poll_aneg_done(struct phy_device *phydev)
1049{
1050	unsigned int retries = 100;
1051	int ret;
1052
1053	do {
1054		msleep(100);
1055		ret = phy_aneg_done(phydev);
1056	} while (!ret && --retries);
1057
1058	if (!ret)
1059		return -ETIMEDOUT;
1060
1061	return ret < 0 ? ret : 0;
1062}
1063
1064int phy_ethtool_ksettings_set(struct phy_device *phydev,
1065			      const struct ethtool_link_ksettings *cmd)
1066{
1067	__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
1068	u8 autoneg = cmd->base.autoneg;
1069	u8 duplex = cmd->base.duplex;
1070	u32 speed = cmd->base.speed;
1071
1072	if (cmd->base.phy_address != phydev->mdio.addr)
1073		return -EINVAL;
1074
1075	linkmode_copy(advertising, cmd->link_modes.advertising);
1076
1077	/* We make sure that we don't pass unsupported values in to the PHY */
1078	linkmode_and(advertising, advertising, phydev->supported);
1079
1080	/* Verify the settings we care about. */
1081	if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
1082		return -EINVAL;
1083
1084	if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
1085		return -EINVAL;
1086
1087	if (autoneg == AUTONEG_DISABLE &&
1088	    ((speed != SPEED_1000 &&
1089	      speed != SPEED_100 &&
1090	      speed != SPEED_10) ||
1091	     (duplex != DUPLEX_HALF &&
1092	      duplex != DUPLEX_FULL)))
1093		return -EINVAL;
1094
1095	mutex_lock(&phydev->lock);
1096	phydev->autoneg = autoneg;
1097
1098	if (autoneg == AUTONEG_DISABLE) {
1099		phydev->speed = speed;
1100		phydev->duplex = duplex;
1101	}
1102
1103	linkmode_copy(phydev->advertising, advertising);
1104
1105	linkmode_mod_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
1106			 phydev->advertising, autoneg == AUTONEG_ENABLE);
1107
1108	phydev->master_slave_set = cmd->base.master_slave_cfg;
1109	phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
1110
1111	/* Restart the PHY */
1112	if (phy_is_started(phydev)) {
1113		phydev->state = PHY_UP;
1114		phy_trigger_machine(phydev);
1115	} else {
1116		_phy_start_aneg(phydev);
1117	}
1118
1119	mutex_unlock(&phydev->lock);
1120	return 0;
1121}
1122EXPORT_SYMBOL(phy_ethtool_ksettings_set);
1123
1124/**
1125 * phy_speed_down - set speed to lowest speed supported by both link partners
1126 * @phydev: the phy_device struct
1127 * @sync: perform action synchronously
1128 *
1129 * Description: Typically used to save energy when waiting for a WoL packet
1130 *
1131 * WARNING: Setting sync to false may cause the system being unable to suspend
1132 * in case the PHY generates an interrupt when finishing the autonegotiation.
1133 * This interrupt may wake up the system immediately after suspend.
1134 * Therefore use sync = false only if you're sure it's safe with the respective
1135 * network chip.
1136 */
1137int phy_speed_down(struct phy_device *phydev, bool sync)
1138{
1139	__ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
1140	int ret = 0;
1141
1142	mutex_lock(&phydev->lock);
1143
1144	if (phydev->autoneg != AUTONEG_ENABLE)
1145		goto out;
1146
1147	linkmode_copy(adv_tmp, phydev->advertising);
1148
1149	ret = phy_speed_down_core(phydev);
1150	if (ret)
1151		goto out;
1152
1153	linkmode_copy(phydev->adv_old, adv_tmp);
1154
1155	if (linkmode_equal(phydev->advertising, adv_tmp)) {
1156		ret = 0;
1157		goto out;
1158	}
1159
1160	ret = phy_config_aneg(phydev);
1161	if (ret)
1162		goto out;
1163
1164	ret = sync ? phy_poll_aneg_done(phydev) : 0;
1165out:
1166	mutex_unlock(&phydev->lock);
1167
1168	return ret;
1169}
1170EXPORT_SYMBOL_GPL(phy_speed_down);
1171
1172/**
1173 * phy_speed_up - (re)set advertised speeds to all supported speeds
1174 * @phydev: the phy_device struct
1175 *
1176 * Description: Used to revert the effect of phy_speed_down
1177 */
1178int phy_speed_up(struct phy_device *phydev)
1179{
1180	__ETHTOOL_DECLARE_LINK_MODE_MASK(adv_tmp);
1181	int ret = 0;
1182
1183	mutex_lock(&phydev->lock);
1184
1185	if (phydev->autoneg != AUTONEG_ENABLE)
1186		goto out;
1187
1188	if (linkmode_empty(phydev->adv_old))
1189		goto out;
1190
1191	linkmode_copy(adv_tmp, phydev->advertising);
1192	linkmode_copy(phydev->advertising, phydev->adv_old);
1193	linkmode_zero(phydev->adv_old);
1194
1195	if (linkmode_equal(phydev->advertising, adv_tmp))
1196		goto out;
1197
1198	ret = phy_config_aneg(phydev);
1199out:
1200	mutex_unlock(&phydev->lock);
1201
1202	return ret;
1203}
1204EXPORT_SYMBOL_GPL(phy_speed_up);
1205
1206/**
1207 * phy_start_machine - start PHY state machine tracking
1208 * @phydev: the phy_device struct
1209 *
1210 * Description: The PHY infrastructure can run a state machine
1211 *   which tracks whether the PHY is starting up, negotiating,
1212 *   etc.  This function starts the delayed workqueue which tracks
1213 *   the state of the PHY. If you want to maintain your own state machine,
1214 *   do not call this function.
1215 */
1216void phy_start_machine(struct phy_device *phydev)
1217{
1218	phy_trigger_machine(phydev);
1219}
1220EXPORT_SYMBOL_GPL(phy_start_machine);
1221
1222/**
1223 * phy_stop_machine - stop the PHY state machine tracking
1224 * @phydev: target phy_device struct
1225 *
1226 * Description: Stops the state machine delayed workqueue, sets the
1227 *   state to UP (unless it wasn't up yet). This function must be
1228 *   called BEFORE phy_detach.
1229 */
1230void phy_stop_machine(struct phy_device *phydev)
1231{
1232	cancel_delayed_work_sync(&phydev->state_queue);
1233
1234	mutex_lock(&phydev->lock);
1235	if (phy_is_started(phydev))
1236		phydev->state = PHY_UP;
1237	mutex_unlock(&phydev->lock);
1238}
1239
1240static void phy_process_error(struct phy_device *phydev)
1241{
1242	/* phydev->lock must be held for the state change to be safe */
1243	if (!mutex_is_locked(&phydev->lock))
1244		phydev_err(phydev, "PHY-device data unsafe context\n");
1245
1246	phydev->state = PHY_ERROR;
1247
1248	phy_trigger_machine(phydev);
1249}
1250
1251static void phy_error_precise(struct phy_device *phydev,
1252			      const void *func, int err)
1253{
1254	WARN(1, "%pS: returned: %d\n", func, err);
1255	phy_process_error(phydev);
1256}
1257
1258/**
1259 * phy_error - enter ERROR state for this PHY device
1260 * @phydev: target phy_device struct
1261 *
1262 * Moves the PHY to the ERROR state in response to a read
1263 * or write error, and tells the controller the link is down.
1264 * Must be called with phydev->lock held.
1265 */
1266void phy_error(struct phy_device *phydev)
1267{
1268	WARN_ON(1);
1269	phy_process_error(phydev);
1270}
1271EXPORT_SYMBOL(phy_error);
1272
1273/**
1274 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
1275 * @phydev: target phy_device struct
1276 */
1277int phy_disable_interrupts(struct phy_device *phydev)
1278{
1279	/* Disable PHY interrupts */
1280	return phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
1281}
1282
1283/**
1284 * phy_interrupt - PHY interrupt handler
1285 * @irq: interrupt line
1286 * @phy_dat: phy_device pointer
1287 *
1288 * Description: Handle PHY interrupt
1289 */
1290static irqreturn_t phy_interrupt(int irq, void *phy_dat)
1291{
1292	struct phy_device *phydev = phy_dat;
1293	struct phy_driver *drv = phydev->drv;
1294	irqreturn_t ret;
1295
1296	/* Wakeup interrupts may occur during a system sleep transition.
1297	 * Postpone handling until the PHY has resumed.
1298	 */
1299	if (IS_ENABLED(CONFIG_PM_SLEEP) && phydev->irq_suspended) {
1300		struct net_device *netdev = phydev->attached_dev;
1301
1302		if (netdev) {
1303			struct device *parent = netdev->dev.parent;
1304
1305			if (netdev->wol_enabled)
1306				pm_system_wakeup();
1307			else if (device_may_wakeup(&netdev->dev))
1308				pm_wakeup_dev_event(&netdev->dev, 0, true);
1309			else if (parent && device_may_wakeup(parent))
1310				pm_wakeup_dev_event(parent, 0, true);
1311		}
1312
1313		phydev->irq_rerun = 1;
1314		disable_irq_nosync(irq);
1315		return IRQ_HANDLED;
1316	}
1317
1318	mutex_lock(&phydev->lock);
1319	ret = drv->handle_interrupt(phydev);
1320	mutex_unlock(&phydev->lock);
1321
1322	return ret;
1323}
1324
1325/**
1326 * phy_enable_interrupts - Enable the interrupts from the PHY side
1327 * @phydev: target phy_device struct
1328 */
1329static int phy_enable_interrupts(struct phy_device *phydev)
1330{
1331	return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
1332}
1333
1334/**
1335 * phy_request_interrupt - request and enable interrupt for a PHY device
1336 * @phydev: target phy_device struct
1337 *
1338 * Description: Request and enable the interrupt for the given PHY.
1339 *   If this fails, then we set irq to PHY_POLL.
1340 *   This should only be called with a valid IRQ number.
1341 */
1342void phy_request_interrupt(struct phy_device *phydev)
1343{
1344	int err;
1345
1346	err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
1347				   IRQF_ONESHOT | IRQF_SHARED,
1348				   phydev_name(phydev), phydev);
1349	if (err) {
1350		phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
1351			    err, phydev->irq);
1352		phydev->irq = PHY_POLL;
1353	} else {
1354		if (phy_enable_interrupts(phydev)) {
1355			phydev_warn(phydev, "Can't enable interrupt, falling back to polling\n");
1356			phy_free_interrupt(phydev);
1357			phydev->irq = PHY_POLL;
1358		}
1359	}
1360}
1361EXPORT_SYMBOL(phy_request_interrupt);
1362
1363/**
1364 * phy_free_interrupt - disable and free interrupt for a PHY device
1365 * @phydev: target phy_device struct
1366 *
1367 * Description: Disable and free the interrupt for the given PHY.
1368 *   This should only be called with a valid IRQ number.
1369 */
1370void phy_free_interrupt(struct phy_device *phydev)
1371{
1372	phy_disable_interrupts(phydev);
1373	free_irq(phydev->irq, phydev);
1374}
1375EXPORT_SYMBOL(phy_free_interrupt);
1376
1377enum phy_state_work {
1378	PHY_STATE_WORK_NONE,
1379	PHY_STATE_WORK_ANEG,
1380	PHY_STATE_WORK_SUSPEND,
1381};
1382
1383static enum phy_state_work _phy_state_machine(struct phy_device *phydev)
1384{
1385	enum phy_state_work state_work = PHY_STATE_WORK_NONE;
1386	struct net_device *dev = phydev->attached_dev;
1387	enum phy_state old_state = phydev->state;
1388	const void *func = NULL;
1389	bool finished = false;
1390	int err = 0;
1391
1392	switch (phydev->state) {
1393	case PHY_DOWN:
1394	case PHY_READY:
1395		break;
1396	case PHY_UP:
1397		state_work = PHY_STATE_WORK_ANEG;
1398		break;
1399	case PHY_NOLINK:
1400	case PHY_RUNNING:
1401		err = phy_check_link_status(phydev);
1402		func = &phy_check_link_status;
1403		break;
1404	case PHY_CABLETEST:
1405		err = phydev->drv->cable_test_get_status(phydev, &finished);
1406		if (err) {
1407			phy_abort_cable_test(phydev);
1408			netif_testing_off(dev);
1409			state_work = PHY_STATE_WORK_ANEG;
1410			phydev->state = PHY_UP;
1411			break;
1412		}
1413
1414		if (finished) {
1415			ethnl_cable_test_finished(phydev);
1416			netif_testing_off(dev);
1417			state_work = PHY_STATE_WORK_ANEG;
1418			phydev->state = PHY_UP;
1419		}
1420		break;
1421	case PHY_HALTED:
1422	case PHY_ERROR:
1423		if (phydev->link) {
1424			phydev->link = 0;
1425			phy_link_down(phydev);
1426		}
1427		state_work = PHY_STATE_WORK_SUSPEND;
1428		break;
1429	}
1430
1431	if (state_work == PHY_STATE_WORK_ANEG) {
1432		err = _phy_start_aneg(phydev);
1433		func = &_phy_start_aneg;
1434	}
1435
1436	if (err == -ENODEV)
1437		return state_work;
1438
1439	if (err < 0)
1440		phy_error_precise(phydev, func, err);
1441
1442	phy_process_state_change(phydev, old_state);
1443
1444	/* Only re-schedule a PHY state machine change if we are polling the
1445	 * PHY, if PHY_MAC_INTERRUPT is set, then we will be moving
1446	 * between states from phy_mac_interrupt().
1447	 *
1448	 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
1449	 * state machine would be pointless and possibly error prone when
1450	 * called from phy_disconnect() synchronously.
1451	 */
1452	if (phy_polling_mode(phydev) && phy_is_started(phydev))
1453		phy_queue_state_machine(phydev, PHY_STATE_TIME);
1454
1455	return state_work;
1456}
1457
1458/* unlocked part of the PHY state machine */
1459static void _phy_state_machine_post_work(struct phy_device *phydev,
1460					 enum phy_state_work state_work)
1461{
1462	if (state_work == PHY_STATE_WORK_SUSPEND)
1463		phy_suspend(phydev);
1464}
1465
1466/**
1467 * phy_state_machine - Handle the state machine
1468 * @work: work_struct that describes the work to be done
1469 */
1470void phy_state_machine(struct work_struct *work)
1471{
1472	struct delayed_work *dwork = to_delayed_work(work);
1473	struct phy_device *phydev =
1474			container_of(dwork, struct phy_device, state_queue);
1475	enum phy_state_work state_work;
1476
1477	mutex_lock(&phydev->lock);
1478	state_work = _phy_state_machine(phydev);
1479	mutex_unlock(&phydev->lock);
1480
1481	_phy_state_machine_post_work(phydev, state_work);
1482}
1483
1484/**
1485 * phy_stop - Bring down the PHY link, and stop checking the status
1486 * @phydev: target phy_device struct
1487 */
1488void phy_stop(struct phy_device *phydev)
1489{
1490	struct net_device *dev = phydev->attached_dev;
1491	enum phy_state_work state_work;
1492	enum phy_state old_state;
1493
1494	if (!phy_is_started(phydev) && phydev->state != PHY_DOWN &&
1495	    phydev->state != PHY_ERROR) {
1496		WARN(1, "called from state %s\n",
1497		     phy_state_to_str(phydev->state));
1498		return;
1499	}
1500
1501	mutex_lock(&phydev->lock);
1502	old_state = phydev->state;
1503
1504	if (phydev->state == PHY_CABLETEST) {
1505		phy_abort_cable_test(phydev);
1506		netif_testing_off(dev);
1507	}
1508
1509	if (phydev->sfp_bus)
1510		sfp_upstream_stop(phydev->sfp_bus);
1511
1512	phydev->state = PHY_HALTED;
1513	phy_process_state_change(phydev, old_state);
1514
1515	state_work = _phy_state_machine(phydev);
1516	mutex_unlock(&phydev->lock);
1517
1518	_phy_state_machine_post_work(phydev, state_work);
1519	phy_stop_machine(phydev);
1520
1521	/* Cannot call flush_scheduled_work() here as desired because
1522	 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
1523	 * will not reenable interrupts.
1524	 */
1525}
1526EXPORT_SYMBOL(phy_stop);
1527
1528/**
1529 * phy_start - start or restart a PHY device
1530 * @phydev: target phy_device struct
1531 *
1532 * Description: Indicates the attached device's readiness to
1533 *   handle PHY-related work.  Used during startup to start the
1534 *   PHY, and after a call to phy_stop() to resume operation.
1535 *   Also used to indicate the MDIO bus has cleared an error
1536 *   condition.
1537 */
1538void phy_start(struct phy_device *phydev)
1539{
1540	mutex_lock(&phydev->lock);
1541
1542	if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
1543		WARN(1, "called from state %s\n",
1544		     phy_state_to_str(phydev->state));
1545		goto out;
1546	}
1547
1548	if (phydev->sfp_bus)
1549		sfp_upstream_start(phydev->sfp_bus);
1550
1551	/* if phy was suspended, bring the physical link up again */
1552	__phy_resume(phydev);
1553
1554	phydev->state = PHY_UP;
1555
1556	phy_start_machine(phydev);
1557out:
1558	mutex_unlock(&phydev->lock);
1559}
1560EXPORT_SYMBOL(phy_start);
1561
1562/**
1563 * phy_mac_interrupt - MAC says the link has changed
1564 * @phydev: phy_device struct with changed link
1565 *
1566 * The MAC layer is able to indicate there has been a change in the PHY link
1567 * status. Trigger the state machine and work a work queue.
1568 */
1569void phy_mac_interrupt(struct phy_device *phydev)
1570{
1571	/* Trigger a state machine change */
1572	phy_trigger_machine(phydev);
1573}
1574EXPORT_SYMBOL(phy_mac_interrupt);
1575
1576/**
1577 * phy_init_eee - init and check the EEE feature
1578 * @phydev: target phy_device struct
1579 * @clk_stop_enable: PHY may stop the clock during LPI
1580 *
1581 * Description: it checks if the Energy-Efficient Ethernet (EEE)
1582 * is supported by looking at the MMD registers 3.20 and 7.60/61
1583 * and it programs the MMD register 3.0 setting the "Clock stop enable"
1584 * bit if required.
1585 */
1586int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
1587{
1588	int ret;
1589
1590	if (!phydev->drv)
1591		return -EIO;
1592
1593	ret = genphy_c45_eee_is_active(phydev, NULL, NULL, NULL);
1594	if (ret < 0)
1595		return ret;
1596	if (!ret)
1597		return -EPROTONOSUPPORT;
1598
1599	if (clk_stop_enable)
1600		/* Configure the PHY to stop receiving xMII
1601		 * clock while it is signaling LPI.
1602		 */
1603		ret = phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
1604				       MDIO_PCS_CTRL1_CLKSTOP_EN);
1605
1606	return ret < 0 ? ret : 0;
1607}
1608EXPORT_SYMBOL(phy_init_eee);
1609
1610/**
1611 * phy_get_eee_err - report the EEE wake error count
1612 * @phydev: target phy_device struct
1613 *
1614 * Description: it is to report the number of time where the PHY
1615 * failed to complete its normal wake sequence.
1616 */
1617int phy_get_eee_err(struct phy_device *phydev)
1618{
1619	int ret;
1620
1621	if (!phydev->drv)
1622		return -EIO;
1623
1624	mutex_lock(&phydev->lock);
1625	ret = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1626	mutex_unlock(&phydev->lock);
1627
1628	return ret;
1629}
1630EXPORT_SYMBOL(phy_get_eee_err);
1631
1632/**
1633 * phy_ethtool_get_eee - get EEE supported and status
1634 * @phydev: target phy_device struct
1635 * @data: ethtool_eee data
1636 *
1637 * Description: it reportes the Supported/Advertisement/LP Advertisement
1638 * capabilities.
1639 */
1640int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
1641{
1642	int ret;
1643
1644	if (!phydev->drv)
1645		return -EIO;
1646
1647	mutex_lock(&phydev->lock);
1648	ret = genphy_c45_ethtool_get_eee(phydev, data);
 
1649	mutex_unlock(&phydev->lock);
1650
1651	return ret;
1652}
1653EXPORT_SYMBOL(phy_ethtool_get_eee);
1654
1655/**
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1656 * phy_ethtool_set_eee - set EEE supported and status
1657 * @phydev: target phy_device struct
1658 * @data: ethtool_eee data
1659 *
1660 * Description: it is to program the Advertisement EEE register.
1661 */
1662int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
1663{
1664	int ret;
1665
1666	if (!phydev->drv)
1667		return -EIO;
1668
1669	mutex_lock(&phydev->lock);
1670	ret = genphy_c45_ethtool_set_eee(phydev, data);
 
 
 
 
 
1671	mutex_unlock(&phydev->lock);
1672
1673	return ret;
1674}
1675EXPORT_SYMBOL(phy_ethtool_set_eee);
1676
1677/**
1678 * phy_ethtool_set_wol - Configure Wake On LAN
1679 *
1680 * @phydev: target phy_device struct
1681 * @wol: Configuration requested
1682 */
1683int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1684{
1685	int ret;
1686
1687	if (phydev->drv && phydev->drv->set_wol) {
1688		mutex_lock(&phydev->lock);
1689		ret = phydev->drv->set_wol(phydev, wol);
1690		mutex_unlock(&phydev->lock);
1691
1692		return ret;
1693	}
1694
1695	return -EOPNOTSUPP;
1696}
1697EXPORT_SYMBOL(phy_ethtool_set_wol);
1698
1699/**
1700 * phy_ethtool_get_wol - Get the current Wake On LAN configuration
1701 *
1702 * @phydev: target phy_device struct
1703 * @wol: Store the current configuration here
1704 */
1705void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
1706{
1707	if (phydev->drv && phydev->drv->get_wol) {
1708		mutex_lock(&phydev->lock);
1709		phydev->drv->get_wol(phydev, wol);
1710		mutex_unlock(&phydev->lock);
1711	}
1712}
1713EXPORT_SYMBOL(phy_ethtool_get_wol);
1714
1715int phy_ethtool_get_link_ksettings(struct net_device *ndev,
1716				   struct ethtool_link_ksettings *cmd)
1717{
1718	struct phy_device *phydev = ndev->phydev;
1719
1720	if (!phydev)
1721		return -ENODEV;
1722
1723	phy_ethtool_ksettings_get(phydev, cmd);
1724
1725	return 0;
1726}
1727EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);
1728
1729int phy_ethtool_set_link_ksettings(struct net_device *ndev,
1730				   const struct ethtool_link_ksettings *cmd)
1731{
1732	struct phy_device *phydev = ndev->phydev;
1733
1734	if (!phydev)
1735		return -ENODEV;
1736
1737	return phy_ethtool_ksettings_set(phydev, cmd);
1738}
1739EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1740
1741/**
1742 * phy_ethtool_nway_reset - Restart auto negotiation
1743 * @ndev: Network device to restart autoneg for
1744 */
1745int phy_ethtool_nway_reset(struct net_device *ndev)
1746{
1747	struct phy_device *phydev = ndev->phydev;
1748	int ret;
1749
1750	if (!phydev)
1751		return -ENODEV;
1752
1753	if (!phydev->drv)
1754		return -EIO;
1755
1756	mutex_lock(&phydev->lock);
1757	ret = phy_restart_aneg(phydev);
1758	mutex_unlock(&phydev->lock);
1759
1760	return ret;
1761}
1762EXPORT_SYMBOL(phy_ethtool_nway_reset);