phy.c 31.7 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0+
S
Sergei Shtylyov 已提交
2
/* Framework for configuring and reading PHY devices
3 4 5 6 7
 * Based on code in sungem_phy.c and gianfar_phy.c
 *
 * Author: Andy Fleming
 *
 * Copyright (c) 2004 Freescale Semiconductor, Inc.
8
 * Copyright (c) 2006, 2007  Maciej W. Rozycki
9
 */
J
Joe Perches 已提交
10

11 12 13 14 15 16 17 18 19 20 21 22 23 24
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/errno.h>
#include <linux/unistd.h>
#include <linux/interrupt.h>
#include <linux/delay.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/skbuff.h>
#include <linux/mm.h>
#include <linux/module.h>
#include <linux/mii.h>
#include <linux/ethtool.h>
#include <linux/phy.h>
25
#include <linux/phy_led_triggers.h>
26
#include <linux/workqueue.h>
27
#include <linux/mdio.h>
S
Sergei Shtylyov 已提交
28 29
#include <linux/io.h>
#include <linux/uaccess.h>
A
Arun Sharma 已提交
30
#include <linux/atomic.h>
S
Sergei Shtylyov 已提交
31

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
#define PHY_STATE_STR(_state)			\
	case PHY_##_state:			\
		return __stringify(_state);	\

static const char *phy_state_to_str(enum phy_state st)
{
	switch (st) {
	PHY_STATE_STR(DOWN)
	PHY_STATE_STR(READY)
	PHY_STATE_STR(UP)
	PHY_STATE_STR(RUNNING)
	PHY_STATE_STR(NOLINK)
	PHY_STATE_STR(FORCING)
	PHY_STATE_STR(HALTED)
	PHY_STATE_STR(RESUMING)
	}

	return NULL;
}

52 53 54 55 56 57 58 59 60 61 62
static void phy_link_up(struct phy_device *phydev)
{
	phydev->phy_link_change(phydev, true, true);
	phy_led_trigger_change_speed(phydev);
}

static void phy_link_down(struct phy_device *phydev, bool do_carrier)
{
	phydev->phy_link_change(phydev, false, do_carrier);
	phy_led_trigger_change_speed(phydev);
}
63

64 65 66
/**
 * phy_print_status - Convenience function to print out the current phy status
 * @phydev: the phy_device struct
A
Andy Fleming 已提交
67 68 69
 */
void phy_print_status(struct phy_device *phydev)
{
S
Sergei Shtylyov 已提交
70
	if (phydev->link) {
71
		netdev_info(phydev->attached_dev,
72 73
			"Link is Up - %s/%s - flow control %s\n",
			phy_speed_to_str(phydev->speed),
74
			phy_duplex_to_str(phydev->duplex),
75
			phydev->pause ? "rx/tx" : "off");
S
Sergei Shtylyov 已提交
76
	} else	{
77
		netdev_info(phydev->attached_dev, "Link is Down\n");
S
Sergei Shtylyov 已提交
78
	}
A
Andy Fleming 已提交
79 80
}
EXPORT_SYMBOL(phy_print_status);
81

82 83 84 85 86 87 88
/**
 * phy_clear_interrupt - Ack the phy device's interrupt
 * @phydev: the phy_device struct
 *
 * If the @phydev driver has an ack_interrupt function, call it to
 * ack and clear the phy device's interrupt.
 *
89
 * Returns 0 on success or < 0 on error.
90
 */
91
static int phy_clear_interrupt(struct phy_device *phydev)
92 93
{
	if (phydev->drv->ack_interrupt)
94
		return phydev->drv->ack_interrupt(phydev);
95

96
	return 0;
97 98
}

99 100 101 102 103
/**
 * phy_config_interrupt - configure the PHY device for the requested interrupts
 * @phydev: the phy_device struct
 * @interrupts: interrupt flags to configure for this @phydev
 *
104
 * Returns 0 on success or < 0 on error.
105
 */
106
static int phy_config_interrupt(struct phy_device *phydev, bool interrupts)
107
{
108
	phydev->interrupts = interrupts ? 1 : 0;
109
	if (phydev->drv->config_intr)
110
		return phydev->drv->config_intr(phydev);
111

112
	return 0;
113 114
}

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
/**
 * phy_restart_aneg - restart auto-negotiation
 * @phydev: target phy_device struct
 *
 * Restart the autonegotiation on @phydev.  Returns >= 0 on success or
 * negative errno on error.
 */
int phy_restart_aneg(struct phy_device *phydev)
{
	int ret;

	if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
		ret = genphy_c45_restart_aneg(phydev);
	else
		ret = genphy_restart_aneg(phydev);

	return ret;
}
EXPORT_SYMBOL_GPL(phy_restart_aneg);
134

135 136 137
/**
 * phy_aneg_done - return auto-negotiation status
 * @phydev: target phy_device struct
138
 *
139 140 141
 * Description: Return the auto-negotiation status from this @phydev
 * Returns > 0 on success or < 0 on error. 0 means that auto-negotiation
 * is still pending.
142
 */
143
int phy_aneg_done(struct phy_device *phydev)
144
{
145
	if (phydev->drv && phydev->drv->aneg_done)
146
		return phydev->drv->aneg_done(phydev);
147 148 149 150
	else if (phydev->is_c45)
		return genphy_c45_aneg_done(phydev);
	else
		return genphy_aneg_done(phydev);
151
}
152
EXPORT_SYMBOL(phy_aneg_done);
153

154
/**
155 156 157 158
 * phy_find_valid - find a PHY setting that matches the requested parameters
 * @speed: desired speed
 * @duplex: desired duplex
 * @supported: mask of supported link modes
159
 *
160 161 162 163 164 165
 * Locate a supported phy setting that is, in priority order:
 * - an exact match for the specified speed and duplex mode
 * - a match for the specified speed, or slower speed
 * - the slowest supported speed
 * Returns the matched phy_setting entry, or %NULL if no supported phy
 * settings were found.
166
 */
167
static const struct phy_setting *
168
phy_find_valid(int speed, int duplex, unsigned long *supported)
169
{
170
	return phy_lookup_setting(speed, duplex, supported, false);
171 172
}

173 174 175 176 177 178 179 180 181 182 183 184 185 186
/**
 * phy_supported_speeds - return all speeds currently supported by a phy device
 * @phy: The phy device to return supported speeds of.
 * @speeds: buffer to store supported speeds in.
 * @size:   size of speeds buffer.
 *
 * Description: Returns the number of supported speeds, and fills the speeds
 * buffer with the supported speeds. If speeds buffer is too small to contain
 * all currently supported speeds, will return as many speeds as can fit.
 */
unsigned int phy_supported_speeds(struct phy_device *phy,
				  unsigned int *speeds,
				  unsigned int size)
{
187
	return phy_speeds(speeds, size, phy->supported);
188 189
}

190 191 192 193 194 195 196 197 198
/**
 * phy_check_valid - check if there is a valid PHY setting which matches
 *		     speed, duplex, and feature mask
 * @speed: speed to match
 * @duplex: duplex to match
 * @features: A mask of the valid settings
 *
 * Description: Returns true if there is a valid setting, false otherwise.
 */
199 200
static inline bool phy_check_valid(int speed, int duplex,
				   unsigned long *features)
201
{
202
	return !!phy_lookup_setting(speed, duplex, features, true);
203 204
}

205 206 207
/**
 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
 * @phydev: the target phy_device struct
208
 *
209
 * Description: Make sure the PHY is set to supported speeds and
210
 *   duplexes.  Drop down by one in this order:  1000/FULL,
211
 *   1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
212
 */
213
static void phy_sanitize_settings(struct phy_device *phydev)
214
{
215
	const struct phy_setting *setting;
216 217

	/* Sanitize settings based on PHY capabilities */
218
	if (linkmode_test_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, phydev->supported))
219
		phydev->autoneg = AUTONEG_DISABLE;
220

221 222
	setting = phy_find_valid(phydev->speed, phydev->duplex,
				 phydev->supported);
223 224 225 226 227 228 229 230
	if (setting) {
		phydev->speed = setting->speed;
		phydev->duplex = setting->duplex;
	} else {
		/* We failed to find anything (no supported speeds?) */
		phydev->speed = SPEED_UNKNOWN;
		phydev->duplex = DUPLEX_UNKNOWN;
	}
231 232
}

233 234 235 236
/**
 * phy_ethtool_sset - generic ethtool sset function, handles all the details
 * @phydev: target phy_device struct
 * @cmd: ethtool_cmd
237 238
 *
 * A few notes about parameter checking:
239
 *
240 241 242 243
 * - We don't set port or transceiver, so we don't care what they
 *   were set to.
 * - phy_start_aneg() will make sure forced settings are sane, and
 *   choose the next best ones from the ones selected, so we don't
244
 *   care if ethtool tries to give us bad values.
245 246 247
 */
int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
{
248
	__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
249 250
	u32 speed = ethtool_cmd_speed(cmd);

A
Andrew Lunn 已提交
251
	if (cmd->phy_address != phydev->mdio.addr)
252 253
		return -EINVAL;

S
Sergei Shtylyov 已提交
254
	/* We make sure that we don't pass unsupported values in to the PHY */
255 256
	ethtool_convert_legacy_u32_to_link_mode(advertising, cmd->advertising);
	linkmode_and(advertising, advertising, phydev->supported);
257 258 259 260 261 262 263 264

	/* Verify the settings we care about. */
	if (cmd->autoneg != AUTONEG_ENABLE && cmd->autoneg != AUTONEG_DISABLE)
		return -EINVAL;

	if (cmd->autoneg == AUTONEG_ENABLE && cmd->advertising == 0)
		return -EINVAL;

265
	if (cmd->autoneg == AUTONEG_DISABLE &&
266 267 268
	    ((speed != SPEED_1000 &&
	      speed != SPEED_100 &&
	      speed != SPEED_10) ||
269 270
	     (cmd->duplex != DUPLEX_HALF &&
	      cmd->duplex != DUPLEX_FULL)))
271 272 273 274
		return -EINVAL;

	phydev->autoneg = cmd->autoneg;

275
	phydev->speed = speed;
276

277
	linkmode_copy(phydev->advertising, advertising);
278 279

	if (AUTONEG_ENABLE == cmd->autoneg)
280 281
		linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
				 phydev->advertising);
282
	else
283 284
		linkmode_clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
				   phydev->advertising);
285 286 287

	phydev->duplex = cmd->duplex;

288
	phydev->mdix_ctrl = cmd->eth_tp_mdix_ctrl;
289

290 291 292 293 294
	/* Restart the PHY */
	phy_start_aneg(phydev);

	return 0;
}
K
Kumar Gala 已提交
295
EXPORT_SYMBOL(phy_ethtool_sset);
296

297 298 299
int phy_ethtool_ksettings_set(struct phy_device *phydev,
			      const struct ethtool_link_ksettings *cmd)
{
300
	__ETHTOOL_DECLARE_LINK_MODE_MASK(advertising);
301 302 303 304 305 306 307
	u8 autoneg = cmd->base.autoneg;
	u8 duplex = cmd->base.duplex;
	u32 speed = cmd->base.speed;

	if (cmd->base.phy_address != phydev->mdio.addr)
		return -EINVAL;

308
	linkmode_copy(advertising, cmd->link_modes.advertising);
309 310

	/* We make sure that we don't pass unsupported values in to the PHY */
311
	linkmode_and(advertising, advertising, phydev->supported);
312 313 314 315 316

	/* Verify the settings we care about. */
	if (autoneg != AUTONEG_ENABLE && autoneg != AUTONEG_DISABLE)
		return -EINVAL;

317
	if (autoneg == AUTONEG_ENABLE && linkmode_empty(advertising))
318 319 320 321 322 323 324 325 326 327 328 329 330 331
		return -EINVAL;

	if (autoneg == AUTONEG_DISABLE &&
	    ((speed != SPEED_1000 &&
	      speed != SPEED_100 &&
	      speed != SPEED_10) ||
	     (duplex != DUPLEX_HALF &&
	      duplex != DUPLEX_FULL)))
		return -EINVAL;

	phydev->autoneg = autoneg;

	phydev->speed = speed;

332
	linkmode_copy(phydev->advertising, advertising);
333 334

	if (autoneg == AUTONEG_ENABLE)
335 336
		linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
				 phydev->advertising);
337
	else
338 339
		linkmode_clear_bit(ETHTOOL_LINK_MODE_Autoneg_BIT,
				   phydev->advertising);
340 341 342

	phydev->duplex = duplex;

343
	phydev->mdix_ctrl = cmd->base.eth_tp_mdix_ctrl;
344 345 346 347 348 349 350 351

	/* Restart the PHY */
	phy_start_aneg(phydev);

	return 0;
}
EXPORT_SYMBOL(phy_ethtool_ksettings_set);

352 353
void phy_ethtool_ksettings_get(struct phy_device *phydev,
			       struct ethtool_link_ksettings *cmd)
354
{
355 356
	linkmode_copy(cmd->link_modes.supported, phydev->supported);
	linkmode_copy(cmd->link_modes.advertising, phydev->advertising);
357
	linkmode_copy(cmd->link_modes.lp_advertising, phydev->lp_advertising);
358 359 360 361 362 363 364

	cmd->base.speed = phydev->speed;
	cmd->base.duplex = phydev->duplex;
	if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
		cmd->base.port = PORT_BNC;
	else
		cmd->base.port = PORT_MII;
365 366
	cmd->base.transceiver = phy_is_internal(phydev) ?
				XCVR_INTERNAL : XCVR_EXTERNAL;
367 368
	cmd->base.phy_address = phydev->mdio.addr;
	cmd->base.autoneg = phydev->autoneg;
369 370
	cmd->base.eth_tp_mdix_ctrl = phydev->mdix_ctrl;
	cmd->base.eth_tp_mdix = phydev->mdix;
371 372
}
EXPORT_SYMBOL(phy_ethtool_ksettings_get);
373

374 375 376
/**
 * phy_mii_ioctl - generic PHY MII ioctl interface
 * @phydev: the phy_device struct
R
Randy Dunlap 已提交
377
 * @ifr: &struct ifreq for socket ioctl's
378 379 380
 * @cmd: ioctl cmd to execute
 *
 * Note that this function is currently incompatible with the
381
 * PHYCONTROL layer.  It changes registers without regard to
382
 * current state.  Use at own risk.
383
 */
S
Sergei Shtylyov 已提交
384
int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
385
{
386
	struct mii_ioctl_data *mii_data = if_mii(ifr);
387
	u16 val = mii_data->val_in;
388
	bool change_autoneg = false;
389 390 391

	switch (cmd) {
	case SIOCGMIIPHY:
A
Andrew Lunn 已提交
392
		mii_data->phy_id = phydev->mdio.addr;
L
Lennert Buytenhek 已提交
393 394
		/* fall through */

395
	case SIOCGMIIREG:
A
Andrew Lunn 已提交
396 397
		mii_data->val_out = mdiobus_read(phydev->mdio.bus,
						 mii_data->phy_id,
398
						 mii_data->reg_num);
399
		return 0;
400 401

	case SIOCSMIIREG:
A
Andrew Lunn 已提交
402
		if (mii_data->phy_id == phydev->mdio.addr) {
F
Florian Fainelli 已提交
403
			switch (mii_data->reg_num) {
404
			case MII_BMCR:
405 406 407
				if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
					if (phydev->autoneg == AUTONEG_ENABLE)
						change_autoneg = true;
408
					phydev->autoneg = AUTONEG_DISABLE;
409 410 411 412 413 414 415 416 417 418 419 420 421
					if (val & BMCR_FULLDPLX)
						phydev->duplex = DUPLEX_FULL;
					else
						phydev->duplex = DUPLEX_HALF;
					if (val & BMCR_SPEED1000)
						phydev->speed = SPEED_1000;
					else if (val & BMCR_SPEED100)
						phydev->speed = SPEED_100;
					else phydev->speed = SPEED_10;
				}
				else {
					if (phydev->autoneg == AUTONEG_DISABLE)
						change_autoneg = true;
422
					phydev->autoneg = AUTONEG_ENABLE;
423
				}
424 425
				break;
			case MII_ADVERTISE:
426 427
				mii_adv_mod_linkmode_adv_t(phydev->advertising,
							   val);
428
				change_autoneg = true;
429 430 431 432 433 434 435
				break;
			default:
				/* do nothing */
				break;
			}
		}

A
Andrew Lunn 已提交
436
		mdiobus_write(phydev->mdio.bus, mii_data->phy_id,
437 438
			      mii_data->reg_num, val);

A
Andrew Lunn 已提交
439
		if (mii_data->phy_id == phydev->mdio.addr &&
440
		    mii_data->reg_num == MII_BMCR &&
441
		    val & BMCR_RESET)
442
			return phy_init_hw(phydev);
443 444 445 446

		if (change_autoneg)
			return phy_start_aneg(phydev);

447
		return 0;
448

449
	case SIOCSHWTSTAMP:
F
Florian Fainelli 已提交
450
		if (phydev->drv && phydev->drv->hwtstamp)
451 452 453
			return phydev->drv->hwtstamp(phydev, ifr);
		/* fall through */

454
	default:
L
Lennert Buytenhek 已提交
455
		return -EOPNOTSUPP;
456 457
	}
}
D
Domen Puncer 已提交
458
EXPORT_SYMBOL(phy_mii_ioctl);
459

460 461 462 463 464 465 466 467 468 469 470 471
static void phy_queue_state_machine(struct phy_device *phydev,
				    unsigned int secs)
{
	mod_delayed_work(system_power_efficient_wq, &phydev->state_queue,
			 secs * HZ);
}

static void phy_trigger_machine(struct phy_device *phydev)
{
	phy_queue_state_machine(phydev, 0);
}

472 473 474 475
static int phy_config_aneg(struct phy_device *phydev)
{
	if (phydev->drv->config_aneg)
		return phydev->drv->config_aneg(phydev);
476 477 478 479 480 481 482 483

	/* Clause 45 PHYs that don't implement Clause 22 registers are not
	 * allowed to call genphy_config_aneg()
	 */
	if (phydev->is_c45 && !(phydev->c45_ids.devices_in_package & BIT(0)))
		return -EOPNOTSUPP;

	return genphy_config_aneg(phydev);
484 485
}

486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
/**
 * phy_check_link_status - check link status and set state accordingly
 * @phydev: the phy_device struct
 *
 * Description: Check for link and whether autoneg was triggered / is running
 * and set state accordingly
 */
static int phy_check_link_status(struct phy_device *phydev)
{
	int err;

	WARN_ON(!mutex_is_locked(&phydev->lock));

	err = phy_read_status(phydev);
	if (err)
		return err;

	if (phydev->link && phydev->state != PHY_RUNNING) {
		phydev->state = PHY_RUNNING;
		phy_link_up(phydev);
	} else if (!phydev->link && phydev->state != PHY_NOLINK) {
		phydev->state = PHY_NOLINK;
		phy_link_down(phydev, true);
	}

	return 0;
}

514
/**
515
 * phy_start_aneg - start auto-negotiation for this PHY device
516
 * @phydev: the phy_device struct
A
Andy Fleming 已提交
517
 *
518 519 520 521
 * Description: Sanitizes the settings (if we're not autonegotiating
 *   them), and then calls the driver's config_aneg function.
 *   If the PHYCONTROL Layer is operating, we change the state to
 *   reflect the beginning of Auto-negotiation or forcing.
A
Andy Fleming 已提交
522
 */
523
int phy_start_aneg(struct phy_device *phydev)
A
Andy Fleming 已提交
524 525 526
{
	int err;

F
Florian Fainelli 已提交
527 528 529
	if (!phydev->drv)
		return -EIO;

530
	mutex_lock(&phydev->lock);
A
Andy Fleming 已提交
531 532 533 534

	if (AUTONEG_DISABLE == phydev->autoneg)
		phy_sanitize_settings(phydev);

535
	/* Invalidate LP advertising flags */
536
	linkmode_zero(phydev->lp_advertising);
537

538
	err = phy_config_aneg(phydev);
A
Andy Fleming 已提交
539 540 541
	if (err < 0)
		goto out_unlock;

542
	if (phy_is_started(phydev)) {
543 544 545 546 547 548
		if (phydev->autoneg == AUTONEG_ENABLE) {
			err = phy_check_link_status(phydev);
		} else {
			phydev->state = PHY_FORCING;
			phydev->link_timeout = PHY_FORCE_TIMEOUT;
		}
A
Andy Fleming 已提交
549 550 551
	}

out_unlock:
552
	mutex_unlock(&phydev->lock);
553

A
Andy Fleming 已提交
554 555 556 557
	return err;
}
EXPORT_SYMBOL(phy_start_aneg);

558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
static int phy_poll_aneg_done(struct phy_device *phydev)
{
	unsigned int retries = 100;
	int ret;

	do {
		msleep(100);
		ret = phy_aneg_done(phydev);
	} while (!ret && --retries);

	if (!ret)
		return -ETIMEDOUT;

	return ret < 0 ? ret : 0;
}

/**
 * phy_speed_down - set speed to lowest speed supported by both link partners
 * @phydev: the phy_device struct
 * @sync: perform action synchronously
 *
 * Description: Typically used to save energy when waiting for a WoL packet
 *
 * WARNING: Setting sync to false may cause the system being unable to suspend
 * in case the PHY generates an interrupt when finishing the autonegotiation.
 * This interrupt may wake up the system immediately after suspend.
 * Therefore use sync = false only if you're sure it's safe with the respective
 * network chip.
 */
int phy_speed_down(struct phy_device *phydev, bool sync)
{
589 590
	__ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
	__ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
591 592 593 594 595
	int ret;

	if (phydev->autoneg != AUTONEG_ENABLE)
		return 0;

596
	linkmode_copy(adv_old, phydev->advertising);
597
	linkmode_copy(adv, phydev->lp_advertising);
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
	linkmode_and(adv, adv, phydev->supported);

	if (linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, adv) ||
	    linkmode_test_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, adv)) {
		linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
				   phydev->advertising);
		linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
				   phydev->advertising);
		linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
				   phydev->advertising);
		linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
				   phydev->advertising);
	} else if (linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
				     adv) ||
		   linkmode_test_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
				     adv)) {
		linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
				   phydev->advertising);
		linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
				   phydev->advertising);
	}
619

620
	if (linkmode_equal(phydev->advertising, adv_old))
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
		return 0;

	ret = phy_config_aneg(phydev);
	if (ret)
		return ret;

	return sync ? phy_poll_aneg_done(phydev) : 0;
}
EXPORT_SYMBOL_GPL(phy_speed_down);

/**
 * phy_speed_up - (re)set advertised speeds to all supported speeds
 * @phydev: the phy_device struct
 *
 * Description: Used to revert the effect of phy_speed_down
 */
int phy_speed_up(struct phy_device *phydev)
{
639 640 641 642 643 644 645
	__ETHTOOL_DECLARE_LINK_MODE_MASK(all_speeds) = { 0, };
	__ETHTOOL_DECLARE_LINK_MODE_MASK(not_speeds);
	__ETHTOOL_DECLARE_LINK_MODE_MASK(supported);
	__ETHTOOL_DECLARE_LINK_MODE_MASK(adv_old);
	__ETHTOOL_DECLARE_LINK_MODE_MASK(speeds);

	linkmode_copy(adv_old, phydev->advertising);
646 647 648 649

	if (phydev->autoneg != AUTONEG_ENABLE)
		return 0;

650 651 652 653 654 655
	linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, all_speeds);
	linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, all_speeds);
	linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, all_speeds);
	linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, all_speeds);
	linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT, all_speeds);
	linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT, all_speeds);
656

657 658 659 660 661 662
	linkmode_andnot(not_speeds, adv_old, all_speeds);
	linkmode_copy(supported, phydev->supported);
	linkmode_and(speeds, supported, all_speeds);
	linkmode_or(phydev->advertising, not_speeds, speeds);

	if (linkmode_equal(phydev->advertising, adv_old))
663 664 665 666 667 668
		return 0;

	return phy_config_aneg(phydev);
}
EXPORT_SYMBOL_GPL(phy_speed_up);

669 670 671
/**
 * phy_start_machine - start PHY state machine tracking
 * @phydev: the phy_device struct
672
 *
673
 * Description: The PHY infrastructure can run a state machine
674
 *   which tracks whether the PHY is starting up, negotiating,
675 676
 *   etc.  This function starts the delayed workqueue which tracks
 *   the state of the PHY. If you want to maintain your own state machine,
677
 *   do not call this function.
678
 */
679
void phy_start_machine(struct phy_device *phydev)
680
{
681
	phy_trigger_machine(phydev);
682
}
683
EXPORT_SYMBOL_GPL(phy_start_machine);
684

685 686 687
/**
 * phy_stop_machine - stop the PHY state machine tracking
 * @phydev: target phy_device struct
688
 *
689 690 691
 * Description: Stops the state machine delayed workqueue, sets the
 *   state to UP (unless it wasn't up yet). This function must be
 *   called BEFORE phy_detach.
692 693 694
 */
void phy_stop_machine(struct phy_device *phydev)
{
695
	cancel_delayed_work_sync(&phydev->state_queue);
696

697
	mutex_lock(&phydev->lock);
698
	if (phy_is_started(phydev))
699
		phydev->state = PHY_UP;
700
	mutex_unlock(&phydev->lock);
701 702
}

703 704 705
/**
 * phy_error - enter HALTED state for this PHY device
 * @phydev: target phy_device struct
706 707 708 709 710 711
 *
 * Moves the PHY to the HALTED state in response to a read
 * or write error, and tells the controller the link is down.
 * Must not be called from interrupt context, or while the
 * phydev->lock is held.
 */
A
Andy Fleming 已提交
712
static void phy_error(struct phy_device *phydev)
713
{
714 715
	WARN_ON(1);

716
	mutex_lock(&phydev->lock);
717
	phydev->state = PHY_HALTED;
718
	mutex_unlock(&phydev->lock);
719

720
	phy_trigger_machine(phydev);
721 722
}

723 724 725 726 727 728 729 730 731 732 733
/**
 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
 * @phydev: target phy_device struct
 */
static int phy_disable_interrupts(struct phy_device *phydev)
{
	int err;

	/* Disable PHY interrupts */
	err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
	if (err)
734
		return err;
735 736

	/* Clear the interrupt */
737
	return phy_clear_interrupt(phydev);
738 739 740
}

/**
741 742 743 744 745
 * phy_interrupt - PHY interrupt handler
 * @irq: interrupt line
 * @phy_dat: phy_device pointer
 *
 * Description: Handle PHY interrupt
746
 */
747
static irqreturn_t phy_interrupt(int irq, void *phy_dat)
748
{
749
	struct phy_device *phydev = phy_dat;
750

751 752
	if (phydev->drv->did_interrupt && !phydev->drv->did_interrupt(phydev))
		return IRQ_NONE;
753 754

	/* reschedule state queue work to run as soon as possible */
755
	phy_trigger_machine(phydev);
756

757
	if (phy_clear_interrupt(phydev))
758 759 760 761 762 763 764 765
		goto phy_err;
	return IRQ_HANDLED;

phy_err:
	phy_error(phydev);
	return IRQ_NONE;
}

766 767 768 769
/**
 * phy_enable_interrupts - Enable the interrupts from the PHY side
 * @phydev: target phy_device struct
 */
770
static int phy_enable_interrupts(struct phy_device *phydev)
771
{
S
Sergei Shtylyov 已提交
772
	int err = phy_clear_interrupt(phydev);
773

A
Andy Fleming 已提交
774 775
	if (err < 0)
		return err;
776

S
Sergei Shtylyov 已提交
777
	return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
778 779
}

780
/**
781
 * phy_request_interrupt - request interrupt for a PHY device
782
 * @phydev: target phy_device struct
A
Andy Fleming 已提交
783
 *
784 785
 * Description: Request the interrupt for the given PHY.
 *   If this fails, then we set irq to PHY_POLL.
A
Andy Fleming 已提交
786 787
 *   This should only be called with a valid IRQ number.
 */
788
void phy_request_interrupt(struct phy_device *phydev)
A
Andy Fleming 已提交
789
{
790 791 792 793 794 795 796 797
	int err;

	err = request_threaded_irq(phydev->irq, NULL, phy_interrupt,
				   IRQF_ONESHOT | IRQF_SHARED,
				   phydev_name(phydev), phydev);
	if (err) {
		phydev_warn(phydev, "Error %d requesting IRQ %d, falling back to polling\n",
			    err, phydev->irq);
A
Andy Fleming 已提交
798 799 800
		phydev->irq = PHY_POLL;
	}
}
801
EXPORT_SYMBOL(phy_request_interrupt);
A
Andy Fleming 已提交
802

803 804 805 806
/**
 * phy_stop - Bring down the PHY link, and stop checking the status
 * @phydev: target phy_device struct
 */
A
Andy Fleming 已提交
807 808
void phy_stop(struct phy_device *phydev)
{
809
	if (!phy_is_started(phydev)) {
810 811 812 813
		WARN(1, "called from state %s\n",
		     phy_state_to_str(phydev->state));
		return;
	}
A
Andy Fleming 已提交
814

815 816
	mutex_lock(&phydev->lock);

817 818
	if (phy_interrupt_is_valid(phydev))
		phy_disable_interrupts(phydev);
A
Andy Fleming 已提交
819

820 821
	phydev->state = PHY_HALTED;

822
	mutex_unlock(&phydev->lock);
823

824
	phy_state_machine(&phydev->state_queue.work);
825
	phy_stop_machine(phydev);
826

S
Sergei Shtylyov 已提交
827
	/* Cannot call flush_scheduled_work() here as desired because
828
	 * of rtnl_lock(), but PHY_HALTED shall guarantee irq handler
829 830
	 * will not reenable interrupts.
	 */
A
Andy Fleming 已提交
831
}
S
Sergei Shtylyov 已提交
832
EXPORT_SYMBOL(phy_stop);
A
Andy Fleming 已提交
833

834 835 836
/**
 * phy_start - start or restart a PHY device
 * @phydev: target phy_device struct
A
Andy Fleming 已提交
837
 *
838
 * Description: Indicates the attached device's readiness to
A
Andy Fleming 已提交
839 840 841 842 843 844 845
 *   handle PHY-related work.  Used during startup to start the
 *   PHY, and after a call to phy_stop() to resume operation.
 *   Also used to indicate the MDIO bus has cleared an error
 *   condition.
 */
void phy_start(struct phy_device *phydev)
{
846
	int err;
847

848
	mutex_lock(&phydev->lock);
A
Andy Fleming 已提交
849

850 851 852 853 854 855
	if (phydev->state != PHY_READY && phydev->state != PHY_HALTED) {
		WARN(1, "called from state %s\n",
		     phy_state_to_str(phydev->state));
		goto out;
	}

856 857
	/* if phy was suspended, bring the physical link up again */
	__phy_resume(phydev);
858

859 860 861 862 863
	/* make sure interrupts are enabled for the PHY */
	if (phy_interrupt_is_valid(phydev)) {
		err = phy_enable_interrupts(phydev);
		if (err < 0)
			goto out;
A
Andy Fleming 已提交
864
	}
865 866 867 868 869 870 871

	if (phydev->state == PHY_READY)
		phydev->state = PHY_UP;
	else
		phydev->state = PHY_RESUMING;

	phy_start_machine(phydev);
872
out:
873
	mutex_unlock(&phydev->lock);
A
Andy Fleming 已提交
874 875
}
EXPORT_SYMBOL(phy_start);
876

877 878 879 880
/**
 * phy_state_machine - Handle the state machine
 * @work: work_struct that describes the work to be done
 */
881
void phy_state_machine(struct work_struct *work)
882
{
883
	struct delayed_work *dwork = to_delayed_work(work);
884
	struct phy_device *phydev =
885
			container_of(dwork, struct phy_device, state_queue);
886
	bool needs_aneg = false, do_suspend = false;
887
	enum phy_state old_state;
888 889
	int err = 0;

890
	mutex_lock(&phydev->lock);
891

892 893
	old_state = phydev->state;

F
Florian Fainelli 已提交
894
	if (phydev->drv && phydev->drv->link_change_notify)
895 896
		phydev->drv->link_change_notify(phydev);

F
Florian Fainelli 已提交
897 898 899 900 901
	switch (phydev->state) {
	case PHY_DOWN:
	case PHY_READY:
		break;
	case PHY_UP:
902
		needs_aneg = true;
903

F
Florian Fainelli 已提交
904 905
		break;
	case PHY_NOLINK:
906 907 908
	case PHY_RUNNING:
	case PHY_RESUMING:
		err = phy_check_link_status(phydev);
F
Florian Fainelli 已提交
909 910 911 912
		break;
	case PHY_FORCING:
		err = genphy_update_link(phydev);
		if (err)
913 914
			break;

F
Florian Fainelli 已提交
915 916
		if (phydev->link) {
			phydev->state = PHY_RUNNING;
917
			phy_link_up(phydev);
F
Florian Fainelli 已提交
918 919
		} else {
			if (0 == phydev->link_timeout--)
920
				needs_aneg = true;
921
			phy_link_down(phydev, false);
F
Florian Fainelli 已提交
922 923 924 925 926
		}
		break;
	case PHY_HALTED:
		if (phydev->link) {
			phydev->link = 0;
927
			phy_link_down(phydev, true);
928
			do_suspend = true;
F
Florian Fainelli 已提交
929 930
		}
		break;
931 932
	}

933
	mutex_unlock(&phydev->lock);
934 935

	if (needs_aneg)
936
		err = phy_start_aneg(phydev);
937
	else if (do_suspend)
938 939
		phy_suspend(phydev);

940 941 942
	if (err < 0)
		phy_error(phydev);

943 944 945 946
	if (old_state != phydev->state)
		phydev_dbg(phydev, "PHY state change %s -> %s\n",
			   phy_state_to_str(old_state),
			   phy_state_to_str(phydev->state));
947

948 949
	/* Only re-schedule a PHY state machine change if we are polling the
	 * PHY, if PHY_IGNORE_INTERRUPT is set, then we will be moving
950 951 952 953 954
	 * between states from phy_mac_interrupt().
	 *
	 * In state PHY_HALTED the PHY gets suspended, so rescheduling the
	 * state machine would be pointless and possibly error prone when
	 * called from phy_disconnect() synchronously.
955
	 */
956
	mutex_lock(&phydev->lock);
957
	if (phy_polling_mode(phydev) && phy_is_started(phydev))
958
		phy_queue_state_machine(phydev, PHY_STATE_TIME);
959
	mutex_unlock(&phydev->lock);
960
}
961

962 963 964 965
/**
 * phy_mac_interrupt - MAC says the link has changed
 * @phydev: phy_device struct with changed link
 *
966 967
 * The MAC layer is able to indicate there has been a change in the PHY link
 * status. Trigger the state machine and work a work queue.
968
 */
969
void phy_mac_interrupt(struct phy_device *phydev)
970
{
971
	/* Trigger a state machine change */
972
	phy_trigger_machine(phydev);
973 974 975
}
EXPORT_SYMBOL(phy_mac_interrupt);

976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
static void mmd_eee_adv_to_linkmode(unsigned long *advertising, u16 eee_adv)
{
	linkmode_zero(advertising);

	if (eee_adv & MDIO_EEE_100TX)
		linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
				 advertising);
	if (eee_adv & MDIO_EEE_1000T)
		linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
				 advertising);
	if (eee_adv & MDIO_EEE_10GT)
		linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
				 advertising);
	if (eee_adv & MDIO_EEE_1000KX)
		linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseKX_Full_BIT,
				 advertising);
	if (eee_adv & MDIO_EEE_10GKX4)
		linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKX4_Full_BIT,
				 advertising);
	if (eee_adv & MDIO_EEE_10GKR)
		linkmode_set_bit(ETHTOOL_LINK_MODE_10000baseKR_Full_BIT,
				 advertising);
}

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
/**
 * phy_init_eee - init and check the EEE feature
 * @phydev: target phy_device struct
 * @clk_stop_enable: PHY may stop the clock during LPI
 *
 * Description: it checks if the Energy-Efficient Ethernet (EEE)
 * is supported by looking at the MMD registers 3.20 and 7.60/61
 * and it programs the MMD register 3.0 setting the "Clock stop enable"
 * bit if required.
 */
int phy_init_eee(struct phy_device *phydev, bool clk_stop_enable)
{
F
Florian Fainelli 已提交
1012 1013 1014
	if (!phydev->drv)
		return -EIO;

1015 1016
	/* According to 802.3az,the EEE is supported only in full duplex-mode.
	 */
1017
	if (phydev->duplex == DUPLEX_FULL) {
1018 1019 1020
		__ETHTOOL_DECLARE_LINK_MODE_MASK(common);
		__ETHTOOL_DECLARE_LINK_MODE_MASK(lp);
		__ETHTOOL_DECLARE_LINK_MODE_MASK(adv);
1021
		int eee_lp, eee_cap, eee_adv;
1022
		int status;
1023
		u32 cap;
1024 1025 1026 1027 1028 1029 1030

		/* Read phy status to properly get the right settings */
		status = phy_read_status(phydev);
		if (status)
			return status;

		/* First check if the EEE ability is supported */
1031
		eee_cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1032 1033
		if (eee_cap <= 0)
			goto eee_exit_err;
1034

1035
		cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1036
		if (!cap)
1037
			goto eee_exit_err;
1038 1039 1040 1041

		/* Check which link settings negotiated and verify it in
		 * the EEE advertising registers.
		 */
1042
		eee_lp = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1043 1044
		if (eee_lp <= 0)
			goto eee_exit_err;
1045

1046
		eee_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1047 1048
		if (eee_adv <= 0)
			goto eee_exit_err;
1049

1050 1051 1052 1053 1054
		mmd_eee_adv_to_linkmode(adv, eee_adv);
		mmd_eee_adv_to_linkmode(lp, eee_lp);
		linkmode_and(common, adv, lp);

		if (!phy_check_valid(phydev->speed, phydev->duplex, common))
1055
			goto eee_exit_err;
1056

1057
		if (clk_stop_enable)
1058 1059 1060
			/* Configure the PHY to stop receiving xMII
			 * clock while it is signaling LPI.
			 */
1061 1062
			phy_set_bits_mmd(phydev, MDIO_MMD_PCS, MDIO_CTRL1,
					 MDIO_PCS_CTRL1_CLKSTOP_EN);
1063

1064
		return 0; /* EEE supported */
1065
	}
1066
eee_exit_err:
1067
	return -EPROTONOSUPPORT;
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
}
EXPORT_SYMBOL(phy_init_eee);

/**
 * phy_get_eee_err - report the EEE wake error count
 * @phydev: target phy_device struct
 *
 * Description: it is to report the number of time where the PHY
 * failed to complete its normal wake sequence.
 */
int phy_get_eee_err(struct phy_device *phydev)
{
F
Florian Fainelli 已提交
1080 1081 1082
	if (!phydev->drv)
		return -EIO;

1083
	return phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_WK_ERR);
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
}
EXPORT_SYMBOL(phy_get_eee_err);

/**
 * phy_ethtool_get_eee - get EEE supported and status
 * @phydev: target phy_device struct
 * @data: ethtool_eee data
 *
 * Description: it reportes the Supported/Advertisement/LP Advertisement
 * capabilities.
 */
int phy_ethtool_get_eee(struct phy_device *phydev, struct ethtool_eee *data)
{
	int val;

F
Florian Fainelli 已提交
1099 1100 1101
	if (!phydev->drv)
		return -EIO;

1102
	/* Get Supported EEE */
1103
	val = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
1104 1105
	if (val < 0)
		return val;
1106
	data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1107 1108

	/* Get advertisement EEE */
1109
	val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1110 1111
	if (val < 0)
		return val;
1112
	data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1113
	data->eee_enabled = !!data->advertised;
1114 1115

	/* Get LP advertisement EEE */
1116
	val = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_LPABLE);
1117 1118
	if (val < 0)
		return val;
1119
	data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1120

1121 1122
	data->eee_active = !!(data->advertised & data->lp_advertised);

1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
	return 0;
}
EXPORT_SYMBOL(phy_ethtool_get_eee);

/**
 * phy_ethtool_set_eee - set EEE supported and status
 * @phydev: target phy_device struct
 * @data: ethtool_eee data
 *
 * Description: it is to program the Advertisement EEE register.
 */
int phy_ethtool_set_eee(struct phy_device *phydev, struct ethtool_eee *data)
{
1136
	int cap, old_adv, adv = 0, ret;
1137

F
Florian Fainelli 已提交
1138 1139 1140
	if (!phydev->drv)
		return -EIO;

1141 1142 1143 1144
	/* Get Supported EEE */
	cap = phy_read_mmd(phydev, MDIO_MMD_PCS, MDIO_PCS_EEE_ABLE);
	if (cap < 0)
		return cap;
1145

1146 1147 1148 1149
	old_adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
	if (old_adv < 0)
		return old_adv;

1150 1151 1152 1153 1154 1155
	if (data->eee_enabled) {
		adv = !data->advertised ? cap :
		      ethtool_adv_to_mmd_eee_adv_t(data->advertised) & cap;
		/* Mask prohibited EEE modes */
		adv &= ~phydev->eee_broken_modes;
	}
1156

1157 1158 1159 1160 1161 1162 1163 1164
	if (old_adv != adv) {
		ret = phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
		if (ret < 0)
			return ret;

		/* Restart autonegotiation so the new modes get sent to the
		 * link partner.
		 */
1165
		ret = phy_restart_aneg(phydev);
1166 1167 1168 1169 1170
		if (ret < 0)
			return ret;
	}

	return 0;
1171 1172
}
EXPORT_SYMBOL(phy_ethtool_set_eee);
1173 1174 1175

int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
{
F
Florian Fainelli 已提交
1176
	if (phydev->drv && phydev->drv->set_wol)
1177 1178 1179 1180 1181 1182 1183 1184
		return phydev->drv->set_wol(phydev, wol);

	return -EOPNOTSUPP;
}
EXPORT_SYMBOL(phy_ethtool_set_wol);

void phy_ethtool_get_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
{
F
Florian Fainelli 已提交
1185
	if (phydev->drv && phydev->drv->get_wol)
1186 1187 1188
		phydev->drv->get_wol(phydev, wol);
}
EXPORT_SYMBOL(phy_ethtool_get_wol);
1189 1190 1191 1192 1193 1194 1195 1196 1197

int phy_ethtool_get_link_ksettings(struct net_device *ndev,
				   struct ethtool_link_ksettings *cmd)
{
	struct phy_device *phydev = ndev->phydev;

	if (!phydev)
		return -ENODEV;

1198 1199 1200
	phy_ethtool_ksettings_get(phydev, cmd);

	return 0;
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
}
EXPORT_SYMBOL(phy_ethtool_get_link_ksettings);

int phy_ethtool_set_link_ksettings(struct net_device *ndev,
				   const struct ethtool_link_ksettings *cmd)
{
	struct phy_device *phydev = ndev->phydev;

	if (!phydev)
		return -ENODEV;

	return phy_ethtool_ksettings_set(phydev, cmd);
}
EXPORT_SYMBOL(phy_ethtool_set_link_ksettings);
1215 1216 1217 1218 1219 1220 1221 1222

int phy_ethtool_nway_reset(struct net_device *ndev)
{
	struct phy_device *phydev = ndev->phydev;

	if (!phydev)
		return -ENODEV;

F
Florian Fainelli 已提交
1223 1224 1225
	if (!phydev->drv)
		return -EIO;

1226
	return phy_restart_aneg(phydev);
1227 1228
}
EXPORT_SYMBOL(phy_ethtool_nway_reset);