phy.c 31.2 KB
Newer Older
S
Sergei Shtylyov 已提交
1
/* Framework for configuring and reading PHY devices
2 3 4 5 6
 * Based on code in sungem_phy.c and gianfar_phy.c
 *
 * Author: Andy Fleming
 *
 * Copyright (c) 2004 Freescale Semiconductor, Inc.
7
 * Copyright (c) 2006, 2007  Maciej W. Rozycki
8 9 10 11 12 13 14
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 *
 */
J
Joe Perches 已提交
15 16 17

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

18 19 20 21 22 23 24 25 26 27 28 29 30 31
#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>
32 33
#include <linux/timer.h>
#include <linux/workqueue.h>
34
#include <linux/mdio.h>
S
Sergei Shtylyov 已提交
35 36
#include <linux/io.h>
#include <linux/uaccess.h>
A
Arun Sharma 已提交
37
#include <linux/atomic.h>
S
Sergei Shtylyov 已提交
38

39 40
#include <asm/irq.h>

41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
static const char *phy_speed_to_str(int speed)
{
	switch (speed) {
	case SPEED_10:
		return "10Mbps";
	case SPEED_100:
		return "100Mbps";
	case SPEED_1000:
		return "1Gbps";
	case SPEED_2500:
		return "2.5Gbps";
	case SPEED_10000:
		return "10Gbps";
	case SPEED_UNKNOWN:
		return "Unknown";
	default:
		return "Unsupported (update phy.c)";
	}
}

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
#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(STARTING)
	PHY_STATE_STR(READY)
	PHY_STATE_STR(PENDING)
	PHY_STATE_STR(UP)
	PHY_STATE_STR(AN)
	PHY_STATE_STR(RUNNING)
	PHY_STATE_STR(NOLINK)
	PHY_STATE_STR(FORCING)
	PHY_STATE_STR(CHANGELINK)
	PHY_STATE_STR(HALTED)
	PHY_STATE_STR(RESUMING)
	}

	return NULL;
}


86 87 88
/**
 * phy_print_status - Convenience function to print out the current phy status
 * @phydev: the phy_device struct
A
Andy Fleming 已提交
89 90 91
 */
void phy_print_status(struct phy_device *phydev)
{
S
Sergei Shtylyov 已提交
92
	if (phydev->link) {
93
		netdev_info(phydev->attached_dev,
94 95
			"Link is Up - %s/%s - flow control %s\n",
			phy_speed_to_str(phydev->speed),
96 97
			DUPLEX_FULL == phydev->duplex ? "Full" : "Half",
			phydev->pause ? "rx/tx" : "off");
S
Sergei Shtylyov 已提交
98
	} else	{
99
		netdev_info(phydev->attached_dev, "Link is Down\n");
S
Sergei Shtylyov 已提交
100
	}
A
Andy Fleming 已提交
101 102
}
EXPORT_SYMBOL(phy_print_status);
103

104 105 106 107 108 109 110
/**
 * 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.
 *
111
 * Returns 0 on success or < 0 on error.
112
 */
113
static int phy_clear_interrupt(struct phy_device *phydev)
114 115
{
	if (phydev->drv->ack_interrupt)
116
		return phydev->drv->ack_interrupt(phydev);
117

118
	return 0;
119 120
}

121 122 123 124 125
/**
 * phy_config_interrupt - configure the PHY device for the requested interrupts
 * @phydev: the phy_device struct
 * @interrupts: interrupt flags to configure for this @phydev
 *
126
 * Returns 0 on success or < 0 on error.
127
 */
128
static int phy_config_interrupt(struct phy_device *phydev, u32 interrupts)
129 130 131
{
	phydev->interrupts = interrupts;
	if (phydev->drv->config_intr)
132
		return phydev->drv->config_intr(phydev);
133

134
	return 0;
135 136 137
}


138 139 140
/**
 * phy_aneg_done - return auto-negotiation status
 * @phydev: target phy_device struct
141
 *
142 143 144
 * 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.
145 146 147
 */
static inline int phy_aneg_done(struct phy_device *phydev)
{
148 149 150
	if (phydev->drv->aneg_done)
		return phydev->drv->aneg_done(phydev);

151
	return genphy_aneg_done(phydev);
152 153 154
}

/* A structure for mapping a particular speed and duplex
S
Sergei Shtylyov 已提交
155 156
 * combination to a particular SUPPORTED and ADVERTISED value
 */
157 158 159 160 161 162 163
struct phy_setting {
	int speed;
	int duplex;
	u32 setting;
};

/* A mapping of all SUPPORTED settings to speed/duplex */
164
static const struct phy_setting settings[] = {
165
	{
166 167 168 169 170 171 172 173 174 175 176
		.speed = SPEED_10000,
		.duplex = DUPLEX_FULL,
		.setting = SUPPORTED_10000baseKR_Full,
	},
	{
		.speed = SPEED_10000,
		.duplex = DUPLEX_FULL,
		.setting = SUPPORTED_10000baseKX4_Full,
	},
	{
		.speed = SPEED_10000,
177 178 179
		.duplex = DUPLEX_FULL,
		.setting = SUPPORTED_10000baseT_Full,
	},
180 181 182 183 184 185 186 187 188 189
	{
		.speed = SPEED_2500,
		.duplex = DUPLEX_FULL,
		.setting = SUPPORTED_2500baseX_Full,
	},
	{
		.speed = SPEED_1000,
		.duplex = DUPLEX_FULL,
		.setting = SUPPORTED_1000baseKX_Full,
	},
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
	{
		.speed = SPEED_1000,
		.duplex = DUPLEX_FULL,
		.setting = SUPPORTED_1000baseT_Full,
	},
	{
		.speed = SPEED_1000,
		.duplex = DUPLEX_HALF,
		.setting = SUPPORTED_1000baseT_Half,
	},
	{
		.speed = SPEED_100,
		.duplex = DUPLEX_FULL,
		.setting = SUPPORTED_100baseT_Full,
	},
	{
		.speed = SPEED_100,
		.duplex = DUPLEX_HALF,
		.setting = SUPPORTED_100baseT_Half,
	},
	{
		.speed = SPEED_10,
		.duplex = DUPLEX_FULL,
		.setting = SUPPORTED_10baseT_Full,
	},
	{
		.speed = SPEED_10,
		.duplex = DUPLEX_HALF,
		.setting = SUPPORTED_10baseT_Half,
	},
};

222
#define MAX_NUM_SETTINGS ARRAY_SIZE(settings)
223

224 225 226 227
/**
 * phy_find_setting - find a PHY settings array entry that matches speed & duplex
 * @speed: speed to match
 * @duplex: duplex to match
228
 *
229
 * Description: Searches the settings array for the setting which
230 231 232 233
 *   matches the desired speed and duplex, and returns the index
 *   of that setting.  Returns the index of the last setting if
 *   none of the others match.
 */
234
static inline unsigned int phy_find_setting(int speed, int duplex)
235
{
236
	unsigned int idx = 0;
237 238

	while (idx < ARRAY_SIZE(settings) &&
S
Sergei Shtylyov 已提交
239
	       (settings[idx].speed != speed || settings[idx].duplex != duplex))
240 241 242 243 244
		idx++;

	return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
}

245 246 247 248
/**
 * phy_find_valid - find a PHY setting that matches the requested features mask
 * @idx: The first index in settings[] to search
 * @features: A mask of the valid settings
249
 *
250
 * Description: Returns the index of the first valid setting less
251 252 253 254
 *   than or equal to the one pointed to by idx, as determined by
 *   the mask in features.  Returns the index of the last setting
 *   if nothing else matches.
 */
255
static inline unsigned int phy_find_valid(unsigned int idx, u32 features)
256 257 258 259 260 261 262
{
	while (idx < MAX_NUM_SETTINGS && !(settings[idx].setting & features))
		idx++;

	return idx < MAX_NUM_SETTINGS ? idx : MAX_NUM_SETTINGS - 1;
}

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
/**
 * 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.
 */
static inline bool phy_check_valid(int speed, int duplex, u32 features)
{
	unsigned int idx;

	idx = phy_find_valid(phy_find_setting(speed, duplex), features);

	return settings[idx].speed == speed && settings[idx].duplex == duplex &&
		(settings[idx].setting & features);
}

282 283 284
/**
 * phy_sanitize_settings - make sure the PHY is set to supported speed and duplex
 * @phydev: the target phy_device struct
285
 *
286
 * Description: Make sure the PHY is set to supported speeds and
287
 *   duplexes.  Drop down by one in this order:  1000/FULL,
288
 *   1000/HALF, 100/FULL, 100/HALF, 10/FULL, 10/HALF.
289
 */
290
static void phy_sanitize_settings(struct phy_device *phydev)
291 292
{
	u32 features = phydev->supported;
293
	unsigned int idx;
294 295 296

	/* Sanitize settings based on PHY capabilities */
	if ((features & SUPPORTED_Autoneg) == 0)
297
		phydev->autoneg = AUTONEG_DISABLE;
298 299 300 301 302 303 304 305

	idx = phy_find_valid(phy_find_setting(phydev->speed, phydev->duplex),
			features);

	phydev->speed = settings[idx].speed;
	phydev->duplex = settings[idx].duplex;
}

306 307 308 309
/**
 * phy_ethtool_sset - generic ethtool sset function, handles all the details
 * @phydev: target phy_device struct
 * @cmd: ethtool_cmd
310 311 312 313 314 315
 *
 * A few notes about parameter checking:
 * - 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
316
 *   care if ethtool tries to give us bad values.
317 318 319
 */
int phy_ethtool_sset(struct phy_device *phydev, struct ethtool_cmd *cmd)
{
320 321
	u32 speed = ethtool_cmd_speed(cmd);

322 323 324
	if (cmd->phy_address != phydev->addr)
		return -EINVAL;

S
Sergei Shtylyov 已提交
325
	/* We make sure that we don't pass unsupported values in to the PHY */
326 327 328 329 330 331 332 333 334
	cmd->advertising &= phydev->supported;

	/* 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;

335
	if (cmd->autoneg == AUTONEG_DISABLE &&
336 337 338
	    ((speed != SPEED_1000 &&
	      speed != SPEED_100 &&
	      speed != SPEED_10) ||
339 340
	     (cmd->duplex != DUPLEX_HALF &&
	      cmd->duplex != DUPLEX_FULL)))
341 342 343 344
		return -EINVAL;

	phydev->autoneg = cmd->autoneg;

345
	phydev->speed = speed;
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360

	phydev->advertising = cmd->advertising;

	if (AUTONEG_ENABLE == cmd->autoneg)
		phydev->advertising |= ADVERTISED_Autoneg;
	else
		phydev->advertising &= ~ADVERTISED_Autoneg;

	phydev->duplex = cmd->duplex;

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

	return 0;
}
K
Kumar Gala 已提交
361
EXPORT_SYMBOL(phy_ethtool_sset);
362 363 364 365 366 367

int phy_ethtool_gset(struct phy_device *phydev, struct ethtool_cmd *cmd)
{
	cmd->supported = phydev->supported;

	cmd->advertising = phydev->advertising;
368
	cmd->lp_advertising = phydev->lp_advertising;
369

370
	ethtool_cmd_speed_set(cmd, phydev->speed);
371
	cmd->duplex = phydev->duplex;
372 373 374 375
	if (phydev->interface == PHY_INTERFACE_MODE_MOCA)
		cmd->port = PORT_BNC;
	else
		cmd->port = PORT_MII;
376
	cmd->phy_address = phydev->addr;
377 378
	cmd->transceiver = phy_is_internal(phydev) ?
		XCVR_INTERNAL : XCVR_EXTERNAL;
379 380 381 382
	cmd->autoneg = phydev->autoneg;

	return 0;
}
K
Kumar Gala 已提交
383
EXPORT_SYMBOL(phy_ethtool_gset);
384

385 386 387
/**
 * phy_mii_ioctl - generic PHY MII ioctl interface
 * @phydev: the phy_device struct
R
Randy Dunlap 已提交
388
 * @ifr: &struct ifreq for socket ioctl's
389 390 391
 * @cmd: ioctl cmd to execute
 *
 * Note that this function is currently incompatible with the
392
 * PHYCONTROL layer.  It changes registers without regard to
393
 * current state.  Use at own risk.
394
 */
S
Sergei Shtylyov 已提交
395
int phy_mii_ioctl(struct phy_device *phydev, struct ifreq *ifr, int cmd)
396
{
397
	struct mii_ioctl_data *mii_data = if_mii(ifr);
398
	u16 val = mii_data->val_in;
399
	bool change_autoneg = false;
400 401 402 403

	switch (cmd) {
	case SIOCGMIIPHY:
		mii_data->phy_id = phydev->addr;
L
Lennert Buytenhek 已提交
404 405
		/* fall through */

406
	case SIOCGMIIREG:
407 408
		mii_data->val_out = mdiobus_read(phydev->bus, mii_data->phy_id,
						 mii_data->reg_num);
409
		return 0;
410 411 412

	case SIOCSMIIREG:
		if (mii_data->phy_id == phydev->addr) {
F
Florian Fainelli 已提交
413
			switch (mii_data->reg_num) {
414
			case MII_BMCR:
415 416 417
				if ((val & (BMCR_RESET | BMCR_ANENABLE)) == 0) {
					if (phydev->autoneg == AUTONEG_ENABLE)
						change_autoneg = true;
418
					phydev->autoneg = AUTONEG_DISABLE;
419 420 421 422 423 424 425 426 427 428 429 430 431
					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;
432
					phydev->autoneg = AUTONEG_ENABLE;
433
				}
434 435
				break;
			case MII_ADVERTISE:
436 437
				phydev->advertising = mii_adv_to_ethtool_adv_t(val);
				change_autoneg = true;
438 439 440 441 442 443 444
				break;
			default:
				/* do nothing */
				break;
			}
		}

445 446 447
		mdiobus_write(phydev->bus, mii_data->phy_id,
			      mii_data->reg_num, val);

448
		if (mii_data->reg_num == MII_BMCR &&
449
		    val & BMCR_RESET)
450
			return phy_init_hw(phydev);
451 452 453 454

		if (change_autoneg)
			return phy_start_aneg(phydev);

455
		return 0;
456

457 458 459 460 461
	case SIOCSHWTSTAMP:
		if (phydev->drv->hwtstamp)
			return phydev->drv->hwtstamp(phydev, ifr);
		/* fall through */

462
	default:
L
Lennert Buytenhek 已提交
463
		return -EOPNOTSUPP;
464 465
	}
}
D
Domen Puncer 已提交
466
EXPORT_SYMBOL(phy_mii_ioctl);
467

468 469 470
/**
 * phy_start_aneg - start auto-negotiation for this PHY device
 * @phydev: the phy_device struct
A
Andy Fleming 已提交
471
 *
472 473 474 475
 * 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 已提交
476 477 478 479 480
 */
int phy_start_aneg(struct phy_device *phydev)
{
	int err;

481
	mutex_lock(&phydev->lock);
A
Andy Fleming 已提交
482 483 484 485

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

486 487 488
	/* Invalidate LP advertising flags */
	phydev->lp_advertising = 0;

A
Andy Fleming 已提交
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
	err = phydev->drv->config_aneg(phydev);
	if (err < 0)
		goto out_unlock;

	if (phydev->state != PHY_HALTED) {
		if (AUTONEG_ENABLE == phydev->autoneg) {
			phydev->state = PHY_AN;
			phydev->link_timeout = PHY_AN_TIMEOUT;
		} else {
			phydev->state = PHY_FORCING;
			phydev->link_timeout = PHY_FORCE_TIMEOUT;
		}
	}

out_unlock:
504
	mutex_unlock(&phydev->lock);
A
Andy Fleming 已提交
505 506 507 508
	return err;
}
EXPORT_SYMBOL(phy_start_aneg);

509 510 511
/**
 * phy_start_machine - start PHY state machine tracking
 * @phydev: the phy_device struct
512
 *
513
 * Description: The PHY infrastructure can run a state machine
514 515
 *   which tracks whether the PHY is starting up, negotiating,
 *   etc.  This function starts the timer which tracks the state
516 517
 *   of the PHY.  If you want to maintain your own state machine,
 *   do not call this function.
518
 */
519
void phy_start_machine(struct phy_device *phydev)
520
{
521
	queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, HZ);
522 523
}

524 525 526
/**
 * phy_stop_machine - stop the PHY state machine tracking
 * @phydev: target phy_device struct
527
 *
528
 * Description: Stops the state machine timer, sets the state to UP
529
 *   (unless it wasn't up yet). This function must be called BEFORE
530 531 532 533
 *   phy_detach.
 */
void phy_stop_machine(struct phy_device *phydev)
{
534
	cancel_delayed_work_sync(&phydev->state_queue);
535

536
	mutex_lock(&phydev->lock);
537 538
	if (phydev->state > PHY_UP)
		phydev->state = PHY_UP;
539
	mutex_unlock(&phydev->lock);
540 541
}

542 543 544
/**
 * phy_error - enter HALTED state for this PHY device
 * @phydev: target phy_device struct
545 546 547 548 549 550
 *
 * 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 已提交
551
static void phy_error(struct phy_device *phydev)
552
{
553
	mutex_lock(&phydev->lock);
554
	phydev->state = PHY_HALTED;
555
	mutex_unlock(&phydev->lock);
556 557
}

558 559 560 561
/**
 * phy_interrupt - PHY interrupt handler
 * @irq: interrupt line
 * @phy_dat: phy_device pointer
A
Andy Fleming 已提交
562
 *
563
 * Description: When a PHY interrupt occurs, the handler disables
A
Andy Fleming 已提交
564 565
 * interrupts, and schedules a work task to clear the interrupt.
 */
566
static irqreturn_t phy_interrupt(int irq, void *phy_dat)
A
Andy Fleming 已提交
567 568 569
{
	struct phy_device *phydev = phy_dat;

570 571 572
	if (PHY_HALTED == phydev->state)
		return IRQ_NONE;		/* It can't be ours.  */

A
Andy Fleming 已提交
573 574 575
	/* The MDIO bus is not allowed to be written in interrupt
	 * context, so we need to disable the irq here.  A work
	 * queue will write the PHY to disable and clear the
S
Sergei Shtylyov 已提交
576 577
	 * interrupt, and then reenable the irq line.
	 */
A
Andy Fleming 已提交
578
	disable_irq_nosync(irq);
579
	atomic_inc(&phydev->irq_disable);
A
Andy Fleming 已提交
580

581
	queue_work(system_power_efficient_wq, &phydev->phy_queue);
A
Andy Fleming 已提交
582 583 584 585

	return IRQ_HANDLED;
}

586 587 588 589
/**
 * phy_enable_interrupts - Enable the interrupts from the PHY side
 * @phydev: target phy_device struct
 */
590
static int phy_enable_interrupts(struct phy_device *phydev)
591
{
S
Sergei Shtylyov 已提交
592
	int err = phy_clear_interrupt(phydev);
593

A
Andy Fleming 已提交
594 595
	if (err < 0)
		return err;
596

S
Sergei Shtylyov 已提交
597
	return phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED);
598 599
}

600 601 602 603
/**
 * phy_disable_interrupts - Disable the PHY interrupts from the PHY side
 * @phydev: target phy_device struct
 */
604
static int phy_disable_interrupts(struct phy_device *phydev)
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
{
	int err;

	/* Disable PHY interrupts */
	err = phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);
	if (err)
		goto phy_err;

	/* Clear the interrupt */
	err = phy_clear_interrupt(phydev);
	if (err)
		goto phy_err;

	return 0;

phy_err:
	phy_error(phydev);

	return err;
}
A
Andy Fleming 已提交
625

626 627 628
/**
 * phy_start_interrupts - request and enable interrupts for a PHY device
 * @phydev: target phy_device struct
A
Andy Fleming 已提交
629
 *
630 631
 * Description: Request the interrupt for the given PHY.
 *   If this fails, then we set irq to PHY_POLL.
A
Andy Fleming 已提交
632 633
 *   Otherwise, we enable the interrupts in the PHY.
 *   This should only be called with a valid IRQ number.
634
 *   Returns 0 on success or < 0 on error.
A
Andy Fleming 已提交
635 636 637
 */
int phy_start_interrupts(struct phy_device *phydev)
{
638
	atomic_set(&phydev->irq_disable, 0);
S
Sergei Shtylyov 已提交
639 640
	if (request_irq(phydev->irq, phy_interrupt, 0, "phy_interrupt",
			phydev) < 0) {
J
Joe Perches 已提交
641 642
		pr_warn("%s: Can't get IRQ %d (PHY)\n",
			phydev->bus->name, phydev->irq);
A
Andy Fleming 已提交
643 644 645 646
		phydev->irq = PHY_POLL;
		return 0;
	}

647
	return phy_enable_interrupts(phydev);
A
Andy Fleming 已提交
648 649 650
}
EXPORT_SYMBOL(phy_start_interrupts);

651 652 653 654
/**
 * phy_stop_interrupts - disable interrupts from a PHY device
 * @phydev: target phy_device struct
 */
A
Andy Fleming 已提交
655 656
int phy_stop_interrupts(struct phy_device *phydev)
{
S
Sergei Shtylyov 已提交
657
	int err = phy_disable_interrupts(phydev);
A
Andy Fleming 已提交
658 659 660 661

	if (err)
		phy_error(phydev);

662 663
	free_irq(phydev->irq, phydev);

S
Sergei Shtylyov 已提交
664
	/* Cannot call flush_scheduled_work() here as desired because
665 666 667
	 * of rtnl_lock(), but we do not really care about what would
	 * be done, except from enable_irq(), so cancel any work
	 * possibly pending and take care of the matter below.
668
	 */
669
	cancel_work_sync(&phydev->phy_queue);
S
Sergei Shtylyov 已提交
670
	/* If work indeed has been cancelled, disable_irq() will have
671 672 673 674 675
	 * been left unbalanced from phy_interrupt() and enable_irq()
	 * has to be called so that other devices on the line work.
	 */
	while (atomic_dec_return(&phydev->irq_disable) >= 0)
		enable_irq(phydev->irq);
A
Andy Fleming 已提交
676 677 678 679 680

	return err;
}
EXPORT_SYMBOL(phy_stop_interrupts);

681 682 683 684
/**
 * phy_change - Scheduled by the phy_interrupt/timer to handle PHY changes
 * @work: work_struct that describes the work to be done
 */
685
void phy_change(struct work_struct *work)
A
Andy Fleming 已提交
686
{
D
David Howells 已提交
687 688
	struct phy_device *phydev =
		container_of(work, struct phy_device, phy_queue);
A
Andy Fleming 已提交
689

690 691 692 693
	if (phydev->drv->did_interrupt &&
	    !phydev->drv->did_interrupt(phydev))
		goto ignore;

694
	if (phy_disable_interrupts(phydev))
A
Andy Fleming 已提交
695 696
		goto phy_err;

697
	mutex_lock(&phydev->lock);
A
Andy Fleming 已提交
698 699
	if ((PHY_RUNNING == phydev->state) || (PHY_NOLINK == phydev->state))
		phydev->state = PHY_CHANGELINK;
700
	mutex_unlock(&phydev->lock);
A
Andy Fleming 已提交
701

702
	atomic_dec(&phydev->irq_disable);
A
Andy Fleming 已提交
703 704 705
	enable_irq(phydev->irq);

	/* Reenable interrupts */
706 707
	if (PHY_HALTED != phydev->state &&
	    phy_config_interrupt(phydev, PHY_INTERRUPT_ENABLED))
A
Andy Fleming 已提交
708 709
		goto irq_enable_err;

710 711
	/* reschedule state queue work to run as soon as possible */
	cancel_delayed_work_sync(&phydev->state_queue);
712
	queue_delayed_work(system_power_efficient_wq, &phydev->state_queue, 0);
A
Andy Fleming 已提交
713 714
	return;

715 716 717 718 719
ignore:
	atomic_dec(&phydev->irq_disable);
	enable_irq(phydev->irq);
	return;

A
Andy Fleming 已提交
720 721
irq_enable_err:
	disable_irq(phydev->irq);
722
	atomic_inc(&phydev->irq_disable);
A
Andy Fleming 已提交
723 724 725 726
phy_err:
	phy_error(phydev);
}

727 728 729 730
/**
 * phy_stop - Bring down the PHY link, and stop checking the status
 * @phydev: target phy_device struct
 */
A
Andy Fleming 已提交
731 732
void phy_stop(struct phy_device *phydev)
{
733
	mutex_lock(&phydev->lock);
A
Andy Fleming 已提交
734 735 736 737

	if (PHY_HALTED == phydev->state)
		goto out_unlock;

738
	if (phy_interrupt_is_valid(phydev)) {
A
Andy Fleming 已提交
739 740 741
		/* Disable PHY Interrupts */
		phy_config_interrupt(phydev, PHY_INTERRUPT_DISABLED);

742 743 744
		/* Clear any pending interrupts */
		phy_clear_interrupt(phydev);
	}
A
Andy Fleming 已提交
745

746 747
	phydev->state = PHY_HALTED;

A
Andy Fleming 已提交
748
out_unlock:
749
	mutex_unlock(&phydev->lock);
750

S
Sergei Shtylyov 已提交
751
	/* Cannot call flush_scheduled_work() here as desired because
752 753 754
	 * of rtnl_lock(), but PHY_HALTED shall guarantee phy_change()
	 * will not reenable interrupts.
	 */
A
Andy Fleming 已提交
755
}
S
Sergei Shtylyov 已提交
756
EXPORT_SYMBOL(phy_stop);
A
Andy Fleming 已提交
757

758 759 760
/**
 * phy_start - start or restart a PHY device
 * @phydev: target phy_device struct
A
Andy Fleming 已提交
761
 *
762
 * Description: Indicates the attached device's readiness to
A
Andy Fleming 已提交
763 764 765 766 767 768 769
 *   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)
{
770 771 772
	bool do_resume = false;
	int err = 0;

773
	mutex_lock(&phydev->lock);
A
Andy Fleming 已提交
774 775

	switch (phydev->state) {
F
Florian Fainelli 已提交
776 777 778 779 780 781 782
	case PHY_STARTING:
		phydev->state = PHY_PENDING;
		break;
	case PHY_READY:
		phydev->state = PHY_UP;
		break;
	case PHY_HALTED:
783 784 785 786 787
		/* make sure interrupts are re-enabled for the PHY */
		err = phy_enable_interrupts(phydev);
		if (err < 0)
			break;

F
Florian Fainelli 已提交
788
		phydev->state = PHY_RESUMING;
789 790
		do_resume = true;
		break;
F
Florian Fainelli 已提交
791 792
	default:
		break;
A
Andy Fleming 已提交
793
	}
794
	mutex_unlock(&phydev->lock);
795 796 797 798

	/* if phy was suspended, bring the physical link up again */
	if (do_resume)
		phy_resume(phydev);
A
Andy Fleming 已提交
799 800
}
EXPORT_SYMBOL(phy_start);
801

802 803 804 805
/**
 * phy_state_machine - Handle the state machine
 * @work: work_struct that describes the work to be done
 */
806
void phy_state_machine(struct work_struct *work)
807
{
808
	struct delayed_work *dwork = to_delayed_work(work);
809
	struct phy_device *phydev =
810
			container_of(dwork, struct phy_device, state_queue);
811
	bool needs_aneg = false, do_suspend = false;
812
	enum phy_state old_state;
813
	int err = 0;
814
	int old_link;
815

816
	mutex_lock(&phydev->lock);
817

818 819
	old_state = phydev->state;

820 821 822
	if (phydev->drv->link_change_notify)
		phydev->drv->link_change_notify(phydev);

F
Florian Fainelli 已提交
823 824 825 826 827 828 829
	switch (phydev->state) {
	case PHY_DOWN:
	case PHY_STARTING:
	case PHY_READY:
	case PHY_PENDING:
		break;
	case PHY_UP:
830
		needs_aneg = true;
831

F
Florian Fainelli 已提交
832 833 834 835 836 837
		phydev->link_timeout = PHY_AN_TIMEOUT;

		break;
	case PHY_AN:
		err = phy_read_status(phydev);
		if (err < 0)
838
			break;
839

S
Sergei Shtylyov 已提交
840
		/* If the link is down, give up on negotiation for now */
F
Florian Fainelli 已提交
841 842 843 844 845 846
		if (!phydev->link) {
			phydev->state = PHY_NOLINK;
			netif_carrier_off(phydev->attached_dev);
			phydev->adjust_link(phydev->attached_dev);
			break;
		}
847

S
Sergei Shtylyov 已提交
848
		/* Check if negotiation is done.  Break if there's an error */
F
Florian Fainelli 已提交
849 850 851
		err = phy_aneg_done(phydev);
		if (err < 0)
			break;
852

F
Florian Fainelli 已提交
853 854 855 856 857
		/* If AN is done, we're running */
		if (err > 0) {
			phydev->state = PHY_RUNNING;
			netif_carrier_on(phydev->attached_dev);
			phydev->adjust_link(phydev->attached_dev);
858

859
		} else if (0 == phydev->link_timeout--)
860
			needs_aneg = true;
F
Florian Fainelli 已提交
861 862 863 864
		break;
	case PHY_NOLINK:
		err = phy_read_status(phydev);
		if (err)
865 866
			break;

F
Florian Fainelli 已提交
867
		if (phydev->link) {
868 869 870 871 872 873 874 875 876 877 878
			if (AUTONEG_ENABLE == phydev->autoneg) {
				err = phy_aneg_done(phydev);
				if (err < 0)
					break;

				if (!err) {
					phydev->state = PHY_AN;
					phydev->link_timeout = PHY_AN_TIMEOUT;
					break;
				}
			}
F
Florian Fainelli 已提交
879 880 881 882 883 884 885 886
			phydev->state = PHY_RUNNING;
			netif_carrier_on(phydev->attached_dev);
			phydev->adjust_link(phydev->attached_dev);
		}
		break;
	case PHY_FORCING:
		err = genphy_update_link(phydev);
		if (err)
887 888
			break;

F
Florian Fainelli 已提交
889 890 891 892 893
		if (phydev->link) {
			phydev->state = PHY_RUNNING;
			netif_carrier_on(phydev->attached_dev);
		} else {
			if (0 == phydev->link_timeout--)
894
				needs_aneg = true;
F
Florian Fainelli 已提交
895
		}
896

F
Florian Fainelli 已提交
897 898 899
		phydev->adjust_link(phydev->attached_dev);
		break;
	case PHY_RUNNING:
900 901
		/* Only register a CHANGE if we are polling or ignoring
		 * interrupts and link changed since latest checking.
F
Florian Fainelli 已提交
902
		 */
903 904 905 906 907 908 909 910 911
		if (!phy_interrupt_is_valid(phydev)) {
			old_link = phydev->link;
			err = phy_read_status(phydev);
			if (err)
				break;

			if (old_link != phydev->link)
				phydev->state = PHY_CHANGELINK;
		}
F
Florian Fainelli 已提交
912 913 914 915
		break;
	case PHY_CHANGELINK:
		err = phy_read_status(phydev);
		if (err)
916 917
			break;

F
Florian Fainelli 已提交
918 919 920 921 922 923 924
		if (phydev->link) {
			phydev->state = PHY_RUNNING;
			netif_carrier_on(phydev->attached_dev);
		} else {
			phydev->state = PHY_NOLINK;
			netif_carrier_off(phydev->attached_dev);
		}
925

F
Florian Fainelli 已提交
926
		phydev->adjust_link(phydev->attached_dev);
927

F
Florian Fainelli 已提交
928 929
		if (phy_interrupt_is_valid(phydev))
			err = phy_config_interrupt(phydev,
S
Sergei Shtylyov 已提交
930
						   PHY_INTERRUPT_ENABLED);
F
Florian Fainelli 已提交
931 932 933 934 935
		break;
	case PHY_HALTED:
		if (phydev->link) {
			phydev->link = 0;
			netif_carrier_off(phydev->attached_dev);
936
			phydev->adjust_link(phydev->attached_dev);
937
			do_suspend = true;
F
Florian Fainelli 已提交
938 939 940 941 942 943
		}
		break;
	case PHY_RESUMING:
		if (AUTONEG_ENABLE == phydev->autoneg) {
			err = phy_aneg_done(phydev);
			if (err < 0)
944 945
				break;

F
Florian Fainelli 已提交
946
			/* err > 0 if AN is done.
S
Sergei Shtylyov 已提交
947 948
			 * Otherwise, it's 0, and we're  still waiting for AN
			 */
F
Florian Fainelli 已提交
949
			if (err > 0) {
950 951 952 953 954 955 956
				err = phy_read_status(phydev);
				if (err)
					break;

				if (phydev->link) {
					phydev->state = PHY_RUNNING;
					netif_carrier_on(phydev->attached_dev);
S
Sergei Shtylyov 已提交
957
				} else	{
958
					phydev->state = PHY_NOLINK;
S
Sergei Shtylyov 已提交
959
				}
960
				phydev->adjust_link(phydev->attached_dev);
F
Florian Fainelli 已提交
961 962 963
			} else {
				phydev->state = PHY_AN;
				phydev->link_timeout = PHY_AN_TIMEOUT;
964
			}
F
Florian Fainelli 已提交
965 966 967 968 969 970 971 972
		} else {
			err = phy_read_status(phydev);
			if (err)
				break;

			if (phydev->link) {
				phydev->state = PHY_RUNNING;
				netif_carrier_on(phydev->attached_dev);
S
Sergei Shtylyov 已提交
973
			} else	{
F
Florian Fainelli 已提交
974
				phydev->state = PHY_NOLINK;
S
Sergei Shtylyov 已提交
975
			}
F
Florian Fainelli 已提交
976 977 978
			phydev->adjust_link(phydev->attached_dev);
		}
		break;
979 980
	}

981
	mutex_unlock(&phydev->lock);
982 983 984

	if (needs_aneg)
		err = phy_start_aneg(phydev);
985
	else if (do_suspend)
986 987
		phy_suspend(phydev);

988 989 990
	if (err < 0)
		phy_error(phydev);

991 992 993
	dev_dbg(&phydev->dev, "PHY state change %s -> %s\n",
		phy_state_to_str(old_state), phy_state_to_str(phydev->state));

994
	queue_delayed_work(system_power_efficient_wq, &phydev->state_queue,
S
Sergei Shtylyov 已提交
995
			   PHY_STATE_TIME * HZ);
996
}
997

998 999 1000 1001 1002 1003 1004 1005
void phy_mac_interrupt(struct phy_device *phydev, int new_link)
{
	cancel_work_sync(&phydev->phy_queue);
	phydev->link = new_link;
	schedule_work(&phydev->phy_queue);
}
EXPORT_SYMBOL(phy_mac_interrupt);

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
static inline void mmd_phy_indirect(struct mii_bus *bus, int prtad, int devad,
				    int addr)
{
	/* Write the desired MMD Devad */
	bus->write(bus, addr, MII_MMD_CTRL, devad);

	/* Write the desired MMD register address */
	bus->write(bus, addr, MII_MMD_DATA, prtad);

	/* Select the Function : DATA with no post increment */
	bus->write(bus, addr, MII_MMD_CTRL, (devad | MII_MMD_CTRL_NOINCR));
}

/**
 * phy_read_mmd_indirect - reads data from the MMD registers
1021
 * @phydev: The PHY device bus
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
 * @prtad: MMD Address
 * @devad: MMD DEVAD
 * @addr: PHY address on the MII bus
 *
 * Description: it reads data from the MMD registers (clause 22 to access to
 * clause 45) of the specified phy address.
 * To read these register we have:
 * 1) Write reg 13 // DEVAD
 * 2) Write reg 14 // MMD Address
 * 3) Write reg 13 // MMD Data Command for MMD DEVAD
 * 3) Read  reg 14 // Read MMD data
 */
1034
int phy_read_mmd_indirect(struct phy_device *phydev, int prtad,
1035
				 int devad, int addr)
1036
{
1037 1038
	struct phy_driver *phydrv = phydev->drv;
	int value = -1;
1039

1040 1041 1042 1043 1044 1045 1046 1047 1048
	if (phydrv->read_mmd_indirect == NULL) {
		mmd_phy_indirect(phydev->bus, prtad, devad, addr);

		/* Read the content of the MMD's selected register */
		value = phydev->bus->read(phydev->bus, addr, MII_MMD_DATA);
	} else {
		value = phydrv->read_mmd_indirect(phydev, prtad, devad, addr);
	}
	return value;
1049
}
1050
EXPORT_SYMBOL(phy_read_mmd_indirect);
1051 1052 1053

/**
 * phy_write_mmd_indirect - writes data to the MMD registers
1054
 * @phydev: The PHY device
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
 * @prtad: MMD Address
 * @devad: MMD DEVAD
 * @addr: PHY address on the MII bus
 * @data: data to write in the MMD register
 *
 * Description: Write data from the MMD registers of the specified
 * phy address.
 * To write these register we have:
 * 1) Write reg 13 // DEVAD
 * 2) Write reg 14 // MMD Address
 * 3) Write reg 13 // MMD Data Command for MMD DEVAD
 * 3) Write reg 14 // Write MMD data
 */
1068
void phy_write_mmd_indirect(struct phy_device *phydev, int prtad,
1069
				   int devad, int addr, u32 data)
1070
{
1071
	struct phy_driver *phydrv = phydev->drv;
1072

1073 1074 1075 1076 1077 1078 1079 1080
	if (phydrv->write_mmd_indirect == NULL) {
		mmd_phy_indirect(phydev->bus, prtad, devad, addr);

		/* Write the data into MMD's selected register */
		phydev->bus->write(phydev->bus, addr, MII_MMD_DATA, data);
	} else {
		phydrv->write_mmd_indirect(phydev, prtad, devad, addr, data);
	}
1081
}
1082
EXPORT_SYMBOL(phy_write_mmd_indirect);
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097

/**
 * 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)
{
	/* According to 802.3az,the EEE is supported only in full duplex-mode.
	 * Also EEE feature is active when core is operating with MII, GMII
1098 1099
	 * or RGMII (all kinds). Internal PHYs are also allowed to proceed and
	 * should return an error if they do not support EEE.
1100 1101 1102 1103
	 */
	if ((phydev->duplex == DUPLEX_FULL) &&
	    ((phydev->interface == PHY_INTERFACE_MODE_MII) ||
	    (phydev->interface == PHY_INTERFACE_MODE_GMII) ||
1104
	     phy_interface_is_rgmii(phydev) ||
1105
	     phy_is_internal(phydev))) {
1106 1107
		int eee_lp, eee_cap, eee_adv;
		u32 lp, cap, adv;
1108
		int status;
1109 1110 1111 1112 1113 1114 1115

		/* 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 */
1116
		eee_cap = phy_read_mmd_indirect(phydev, MDIO_PCS_EEE_ABLE,
1117
						MDIO_MMD_PCS, phydev->addr);
1118 1119
		if (eee_cap <= 0)
			goto eee_exit_err;
1120

1121
		cap = mmd_eee_cap_to_ethtool_sup_t(eee_cap);
1122
		if (!cap)
1123
			goto eee_exit_err;
1124 1125 1126 1127

		/* Check which link settings negotiated and verify it in
		 * the EEE advertising registers.
		 */
1128
		eee_lp = phy_read_mmd_indirect(phydev, MDIO_AN_EEE_LPABLE,
1129
					       MDIO_MMD_AN, phydev->addr);
1130 1131
		if (eee_lp <= 0)
			goto eee_exit_err;
1132

1133
		eee_adv = phy_read_mmd_indirect(phydev, MDIO_AN_EEE_ADV,
1134
						MDIO_MMD_AN, phydev->addr);
1135 1136
		if (eee_adv <= 0)
			goto eee_exit_err;
1137

1138 1139
		adv = mmd_eee_adv_to_ethtool_adv_t(eee_adv);
		lp = mmd_eee_adv_to_ethtool_adv_t(eee_lp);
1140
		if (!phy_check_valid(phydev->speed, phydev->duplex, lp & adv))
1141
			goto eee_exit_err;
1142 1143 1144 1145 1146

		if (clk_stop_enable) {
			/* Configure the PHY to stop receiving xMII
			 * clock while it is signaling LPI.
			 */
1147
			int val = phy_read_mmd_indirect(phydev, MDIO_CTRL1,
1148 1149 1150 1151 1152 1153
							MDIO_MMD_PCS,
							phydev->addr);
			if (val < 0)
				return val;

			val |= MDIO_PCS_CTRL1_CLKSTOP_EN;
1154 1155 1156
			phy_write_mmd_indirect(phydev, MDIO_CTRL1,
					       MDIO_MMD_PCS, phydev->addr,
					       val);
1157 1158
		}

1159
		return 0; /* EEE supported */
1160
	}
1161
eee_exit_err:
1162
	return -EPROTONOSUPPORT;
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
}
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)
{
1175
	return phy_read_mmd_indirect(phydev, MDIO_PCS_EEE_WK_ERR,
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
				     MDIO_MMD_PCS, phydev->addr);
}
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;

	/* Get Supported EEE */
1193
	val = phy_read_mmd_indirect(phydev, MDIO_PCS_EEE_ABLE,
1194 1195 1196
				    MDIO_MMD_PCS, phydev->addr);
	if (val < 0)
		return val;
1197
	data->supported = mmd_eee_cap_to_ethtool_sup_t(val);
1198 1199

	/* Get advertisement EEE */
1200
	val = phy_read_mmd_indirect(phydev, MDIO_AN_EEE_ADV,
1201 1202 1203
				    MDIO_MMD_AN, phydev->addr);
	if (val < 0)
		return val;
1204
	data->advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1205 1206

	/* Get LP advertisement EEE */
1207
	val = phy_read_mmd_indirect(phydev, MDIO_AN_EEE_LPABLE,
1208 1209 1210
				    MDIO_MMD_AN, phydev->addr);
	if (val < 0)
		return val;
1211
	data->lp_advertised = mmd_eee_adv_to_ethtool_adv_t(val);
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225

	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)
{
S
Sergei Shtylyov 已提交
1226
	int val = ethtool_adv_to_mmd_eee_adv_t(data->advertised);
1227

1228
	phy_write_mmd_indirect(phydev, MDIO_AN_EEE_ADV, MDIO_MMD_AN,
1229 1230 1231 1232 1233
			       phydev->addr, val);

	return 0;
}
EXPORT_SYMBOL(phy_ethtool_set_eee);
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249

int phy_ethtool_set_wol(struct phy_device *phydev, struct ethtool_wolinfo *wol)
{
	if (phydev->drv->set_wol)
		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)
{
	if (phydev->drv->get_wol)
		phydev->drv->get_wol(phydev, wol);
}
EXPORT_SYMBOL(phy_ethtool_get_wol);