phy_device.c 42.3 KB
Newer Older
S
Sergei Shtylyov 已提交
1
/* Framework for finding and configuring PHYs.
2 3 4 5 6 7 8 9 10 11 12 13
 * Also contains generic PHY driver
 *
 * Author: Andy Fleming
 *
 * Copyright (c) 2004 Freescale Semiconductor, Inc.
 *
 * 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 已提交
14 15 16

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/errno.h>
#include <linux/unistd.h>
#include <linux/slab.h>
#include <linux/interrupt.h>
#include <linux/init.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>
A
Andy Fleming 已提交
33
#include <linux/mdio.h>
S
Sergei Shtylyov 已提交
34 35
#include <linux/io.h>
#include <linux/uaccess.h>
36
#include <linux/of.h>
37 38 39

#include <asm/irq.h>

40 41 42 43
MODULE_DESCRIPTION("PHY library");
MODULE_AUTHOR("Andy Fleming");
MODULE_LICENSE("GPL");

44 45
void phy_device_free(struct phy_device *phydev)
{
A
Andrew Lunn 已提交
46
	put_device(&phydev->mdio.dev);
47
}
48
EXPORT_SYMBOL(phy_device_free);
49

50 51 52 53 54 55 56 57
static void phy_mdio_device_free(struct mdio_device *mdiodev)
{
	struct phy_device *phydev;

	phydev = container_of(mdiodev, struct phy_device, mdio);
	phy_device_free(phydev);
}

58 59
static void phy_device_release(struct device *dev)
{
60
	kfree(to_phy_device(dev));
61 62
}

63 64 65 66 67 68 69 70
static void phy_mdio_device_remove(struct mdio_device *mdiodev)
{
	struct phy_device *phydev;

	phydev = container_of(mdiodev, struct phy_device, mdio);
	phy_device_remove(phydev);
}

71 72
enum genphy_driver {
	GENPHY_DRV_1G,
A
Andy Fleming 已提交
73
	GENPHY_DRV_10G,
74 75 76 77
	GENPHY_DRV_MAX
};

static struct phy_driver genphy_driver[GENPHY_DRV_MAX];
78

79 80 81
static LIST_HEAD(phy_fixup_list);
static DEFINE_MUTEX(phy_fixup_lock);

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
#ifdef CONFIG_PM
static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
{
	struct device_driver *drv = phydev->mdio.dev.driver;
	struct phy_driver *phydrv = to_phy_driver(drv);
	struct net_device *netdev = phydev->attached_dev;

	if (!drv || !phydrv->suspend)
		return false;

	/* PHY not attached? May suspend if the PHY has not already been
	 * suspended as part of a prior call to phy_disconnect() ->
	 * phy_detach() -> phy_suspend() because the parent netdev might be the
	 * MDIO bus driver and clock gated at this point.
	 */
	if (!netdev)
		return !phydev->suspended;

	/* Don't suspend PHY if the attached netdev parent may wakeup.
	 * The parent may point to a PCI device, as in tg3 driver.
	 */
	if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
		return false;

	/* Also don't suspend PHY if the netdev itself may wakeup. This
	 * is the case for devices w/o underlaying pwr. mgmt. aware bus,
	 * e.g. SoC devices.
	 */
	if (device_may_wakeup(&netdev->dev))
		return false;

	return true;
}

static int mdio_bus_phy_suspend(struct device *dev)
{
	struct phy_device *phydev = to_phy_device(dev);

	/* We must stop the state machine manually, otherwise it stops out of
	 * control, possibly with the phydev->lock held. Upon resume, netdev
	 * may call phy routines that try to grab the same lock, and that may
	 * lead to a deadlock.
	 */
	if (phydev->attached_dev && phydev->adjust_link)
		phy_stop_machine(phydev);

	if (!mdio_bus_phy_may_suspend(phydev))
		return 0;

	return phy_suspend(phydev);
}

static int mdio_bus_phy_resume(struct device *dev)
{
	struct phy_device *phydev = to_phy_device(dev);
	int ret;

	if (!mdio_bus_phy_may_suspend(phydev))
		goto no_resume;

	ret = phy_resume(phydev);
	if (ret < 0)
		return ret;

no_resume:
	if (phydev->attached_dev && phydev->adjust_link)
		phy_start_machine(phydev);

	return 0;
}

static int mdio_bus_phy_restore(struct device *dev)
{
	struct phy_device *phydev = to_phy_device(dev);
	struct net_device *netdev = phydev->attached_dev;
	int ret;

	if (!netdev)
		return 0;

	ret = phy_init_hw(phydev);
	if (ret < 0)
		return ret;

	/* The PHY needs to renegotiate. */
	phydev->link = 0;
	phydev->state = PHY_UP;

	phy_start_machine(phydev);

	return 0;
}

static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
	.suspend = mdio_bus_phy_suspend,
	.resume = mdio_bus_phy_resume,
	.freeze = mdio_bus_phy_suspend,
	.thaw = mdio_bus_phy_resume,
	.restore = mdio_bus_phy_restore,
};

#define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)

#else

#define MDIO_BUS_PHY_PM_OPS NULL

#endif /* CONFIG_PM */

S
Sergei Shtylyov 已提交
191 192
/**
 * phy_register_fixup - creates a new phy_fixup and adds it to the list
A
Andrew Lunn 已提交
193
 * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
194
 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
S
Sergei Shtylyov 已提交
195
 *	It can also be PHY_ANY_UID
196
 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
S
Sergei Shtylyov 已提交
197
 *	comparison
198 199 200
 * @run: The actual code to be run when a matching PHY is found
 */
int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
S
Sergei Shtylyov 已提交
201
		       int (*run)(struct phy_device *))
202
{
S
Sergei Shtylyov 已提交
203
	struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
204 205 206 207

	if (!fixup)
		return -ENOMEM;

208
	strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
209 210 211 212 213 214 215 216 217 218 219 220 221 222
	fixup->phy_uid = phy_uid;
	fixup->phy_uid_mask = phy_uid_mask;
	fixup->run = run;

	mutex_lock(&phy_fixup_lock);
	list_add_tail(&fixup->list, &phy_fixup_list);
	mutex_unlock(&phy_fixup_lock);

	return 0;
}
EXPORT_SYMBOL(phy_register_fixup);

/* Registers a fixup to be run on any PHY with the UID in phy_uid */
int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
S
Sergei Shtylyov 已提交
223
			       int (*run)(struct phy_device *))
224 225 226 227 228 229 230
{
	return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
}
EXPORT_SYMBOL(phy_register_fixup_for_uid);

/* Registers a fixup to be run on the PHY with id string bus_id */
int phy_register_fixup_for_id(const char *bus_id,
S
Sergei Shtylyov 已提交
231
			      int (*run)(struct phy_device *))
232 233 234 235 236
{
	return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
}
EXPORT_SYMBOL(phy_register_fixup_for_id);

S
Sergei Shtylyov 已提交
237
/* Returns 1 if fixup matches phydev in bus_id and phy_uid.
238 239 240 241
 * Fixups can be set to match any in one or more fields.
 */
static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
{
A
Andrew Lunn 已提交
242
	if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
243 244 245 246
		if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
			return 0;

	if ((fixup->phy_uid & fixup->phy_uid_mask) !=
S
Sergei Shtylyov 已提交
247
	    (phydev->phy_id & fixup->phy_uid_mask))
248 249 250 251 252 253 254
		if (fixup->phy_uid != PHY_ANY_UID)
			return 0;

	return 1;
}

/* Runs any matching fixups for this phydev */
255
static int phy_scan_fixups(struct phy_device *phydev)
256 257 258 259 260 261
{
	struct phy_fixup *fixup;

	mutex_lock(&phy_fixup_lock);
	list_for_each_entry(fixup, &phy_fixup_list, list) {
		if (phy_needs_fixup(phydev, fixup)) {
S
Sergei Shtylyov 已提交
262
			int err = fixup->run(phydev);
263

J
Jiri Slaby 已提交
264 265
			if (err < 0) {
				mutex_unlock(&phy_fixup_lock);
266
				return err;
J
Jiri Slaby 已提交
267
			}
268
			phydev->has_fixups = true;
269 270 271 272 273 274 275
		}
	}
	mutex_unlock(&phy_fixup_lock);

	return 0;
}

276 277 278 279 280 281 282
static int phy_bus_match(struct device *dev, struct device_driver *drv)
{
	struct phy_device *phydev = to_phy_device(dev);
	struct phy_driver *phydrv = to_phy_driver(drv);
	const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
	int i;

283 284 285
	if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
		return 0;

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
	if (phydrv->match_phy_device)
		return phydrv->match_phy_device(phydev);

	if (phydev->is_c45) {
		for (i = 1; i < num_ids; i++) {
			if (!(phydev->c45_ids.devices_in_package & (1 << i)))
				continue;

			if ((phydrv->phy_id & phydrv->phy_id_mask) ==
			    (phydev->c45_ids.device_ids[i] &
			     phydrv->phy_id_mask))
				return 1;
		}
		return 0;
	} else {
		return (phydrv->phy_id & phydrv->phy_id_mask) ==
			(phydev->phy_id & phydrv->phy_id_mask);
	}
}

306
struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
S
Sergei Shtylyov 已提交
307 308
				     bool is_c45,
				     struct phy_c45_device_ids *c45_ids)
309 310
{
	struct phy_device *dev;
A
Andrew Lunn 已提交
311
	struct mdio_device *mdiodev;
312

S
Sergei Shtylyov 已提交
313
	/* We allocate the device, and initialize the default values */
314
	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
S
Sergei Shtylyov 已提交
315
	if (!dev)
316
		return ERR_PTR(-ENOMEM);
317

A
Andrew Lunn 已提交
318 319 320 321 322
	mdiodev = &dev->mdio;
	mdiodev->dev.release = phy_device_release;
	mdiodev->dev.parent = &bus->dev;
	mdiodev->dev.bus = &mdio_bus_type;
	mdiodev->bus = bus;
323
	mdiodev->pm_ops = MDIO_BUS_PHY_PM_OPS;
324
	mdiodev->bus_match = phy_bus_match;
A
Andrew Lunn 已提交
325
	mdiodev->addr = addr;
326
	mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
327 328
	mdiodev->device_free = phy_mdio_device_free;
	mdiodev->device_remove = phy_mdio_device_remove;
329

330 331
	dev->speed = 0;
	dev->duplex = -1;
S
Sergei Shtylyov 已提交
332 333
	dev->pause = 0;
	dev->asym_pause = 0;
334
	dev->link = 1;
335
	dev->interface = PHY_INTERFACE_MODE_GMII;
336 337 338

	dev->autoneg = AUTONEG_ENABLE;

339
	dev->is_c45 = is_c45;
340
	dev->phy_id = phy_id;
341 342
	if (c45_ids)
		dev->c45_ids = *c45_ids;
343
	dev->irq = bus->irq[addr];
A
Andrew Lunn 已提交
344
	dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
345 346 347

	dev->state = PHY_DOWN;

348
	mutex_init(&dev->lock);
349
	INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
350
	INIT_WORK(&dev->phy_queue, phy_change);
351

352
	/* Request the appropriate module unconditionally; don't
S
Sergei Shtylyov 已提交
353 354 355 356 357 358 359 360 361
	 * bother trying to do so only if it isn't already loaded,
	 * because that gets complicated. A hotplug event would have
	 * done an unconditional modprobe anyway.
	 * We don't do normal hotplug because it won't work for MDIO
	 * -- because it relies on the device staying around for long
	 * enough for the driver to get loaded. With MDIO, the NIC
	 * driver will get bored and give up as soon as it finds that
	 * there's no driver _already_ loaded.
	 */
362 363
	request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));

A
Andrew Lunn 已提交
364
	device_initialize(&mdiodev->dev);
365

366 367
	return dev;
}
368 369
EXPORT_SYMBOL(phy_device_create);

370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
/* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
 * @bus: the target MII bus
 * @addr: PHY address on the MII bus
 * @dev_addr: MMD address in the PHY.
 * @devices_in_package: where to store the devices in package information.
 *
 * Description: reads devices in package registers of a MMD at @dev_addr
 * from PHY at @addr on @bus.
 *
 * Returns: 0 on success, -EIO on failure.
 */
static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
				   u32 *devices_in_package)
{
	int phy_reg, reg_addr;

	reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
	phy_reg = mdiobus_read(bus, addr, reg_addr);
	if (phy_reg < 0)
		return -EIO;
	*devices_in_package = (phy_reg & 0xffff) << 16;

	reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
	phy_reg = mdiobus_read(bus, addr, reg_addr);
	if (phy_reg < 0)
		return -EIO;
	*devices_in_package |= (phy_reg & 0xffff);

	return 0;
}

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
/**
 * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
 * @bus: the target MII bus
 * @addr: PHY address on the MII bus
 * @phy_id: where to store the ID retrieved.
 * @c45_ids: where to store the c45 ID information.
 *
 *   If the PHY devices-in-package appears to be valid, it and the
 *   corresponding identifiers are stored in @c45_ids, zero is stored
 *   in @phy_id.  Otherwise 0xffffffff is stored in @phy_id.  Returns
 *   zero on success.
 *
 */
static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
			   struct phy_c45_device_ids *c45_ids) {
	int phy_reg;
	int i, reg_addr;
	const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
419
	u32 *devs = &c45_ids->devices_in_package;
420

421 422
	/* Find first non-zero Devices In package. Device zero is reserved
	 * for 802.3 c45 complied PHYs, so don't probe it at first.
423
	 */
424 425
	for (i = 1; i < num_ids && *devs == 0; i++) {
		phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
426 427 428
		if (phy_reg < 0)
			return -EIO;

429 430 431 432 433 434 435 436 437 438 439
		if ((*devs & 0x1fffffff) == 0x1fffffff) {
			/*  If mostly Fs, there is no device there,
			 *  then let's continue to probe more, as some
			 *  10G PHYs have zero Devices In package,
			 *  e.g. Cortina CS4315/CS4340 PHY.
			 */
			phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
			if (phy_reg < 0)
				return -EIO;
			/* no device there, let's get out of here */
			if ((*devs & 0x1fffffff) == 0x1fffffff) {
440 441
				*phy_id = 0xffffffff;
				return 0;
442 443
			} else {
				break;
444
			}
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
		}
	}

	/* Now probe Device Identifiers for each device present. */
	for (i = 1; i < num_ids; i++) {
		if (!(c45_ids->devices_in_package & (1 << i)))
			continue;

		reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
		phy_reg = mdiobus_read(bus, addr, reg_addr);
		if (phy_reg < 0)
			return -EIO;
		c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;

		reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
		phy_reg = mdiobus_read(bus, addr, reg_addr);
		if (phy_reg < 0)
			return -EIO;
		c45_ids->device_ids[i] |= (phy_reg & 0xffff);
	}
	*phy_id = 0;
	return 0;
}
468

469
/**
470
 * get_phy_id - reads the specified addr for its ID.
471 472
 * @bus: the target MII bus
 * @addr: PHY address on the MII bus
473
 * @phy_id: where to store the ID retrieved.
474 475 476 477 478 479 480 481 482
 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
 * @c45_ids: where to store the c45 ID information.
 *
 * Description: In the case of a 802.3-c22 PHY, reads the ID registers
 *   of the PHY at @addr on the @bus, stores it in @phy_id and returns
 *   zero on success.
 *
 *   In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
 *   its return value is in turn returned.
483 484
 *
 */
485 486
static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
		      bool is_c45, struct phy_c45_device_ids *c45_ids)
487 488 489
{
	int phy_reg;

490 491 492
	if (is_c45)
		return get_phy_c45_ids(bus, addr, phy_id, c45_ids);

S
Sergei Shtylyov 已提交
493
	/* Grab the bits from PHYIR1, and put them in the upper half */
494
	phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
495
	if (phy_reg < 0)
496
		return -EIO;
497

498
	*phy_id = (phy_reg & 0xffff) << 16;
499 500

	/* Grab the bits from PHYIR2, and put them in the lower half */
501
	phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
502
	if (phy_reg < 0)
503 504 505 506 507 508 509 510
		return -EIO;

	*phy_id |= (phy_reg & 0xffff);

	return 0;
}

/**
S
Sergei Shtylyov 已提交
511 512
 * get_phy_device - reads the specified PHY device and returns its @phy_device
 *		    struct
513 514
 * @bus: the target MII bus
 * @addr: PHY address on the MII bus
515
 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
516 517 518 519
 *
 * Description: Reads the ID registers of the PHY at @addr on the
 *   @bus, then allocates and returns the phy_device to represent it.
 */
520
struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
521
{
522
	struct phy_c45_device_ids c45_ids = {0};
523
	u32 phy_id = 0;
524
	int r;
525

526
	r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
527 528
	if (r)
		return ERR_PTR(r);
529

530 531
	/* If the phy_id is mostly Fs, there is no device there */
	if ((phy_id & 0x1fffffff) == 0x1fffffff)
532
		return ERR_PTR(-ENODEV);
533

534
	return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
535
}
536 537
EXPORT_SYMBOL(get_phy_device);

538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
static ssize_t
phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	struct phy_device *phydev = to_phy_device(dev);

	return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
}
static DEVICE_ATTR_RO(phy_id);

static ssize_t
phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
{
	struct phy_device *phydev = to_phy_device(dev);
	const char *mode = NULL;

	if (phy_is_internal(phydev))
		mode = "internal";
	else
		mode = phy_modes(phydev->interface);

	return sprintf(buf, "%s\n", mode);
}
static DEVICE_ATTR_RO(phy_interface);

static ssize_t
phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
		    char *buf)
{
	struct phy_device *phydev = to_phy_device(dev);

	return sprintf(buf, "%d\n", phydev->has_fixups);
}
static DEVICE_ATTR_RO(phy_has_fixups);

static struct attribute *phy_dev_attrs[] = {
	&dev_attr_phy_id.attr,
	&dev_attr_phy_interface.attr,
	&dev_attr_phy_has_fixups.attr,
	NULL,
};
ATTRIBUTE_GROUPS(phy_dev);

580 581
/**
 * phy_device_register - Register the phy device on the MDIO bus
582
 * @phydev: phy_device structure to be added to the MDIO bus
583 584 585 586 587
 */
int phy_device_register(struct phy_device *phydev)
{
	int err;

588 589 590
	err = mdiobus_register_device(&phydev->mdio);
	if (err)
		return err;
591 592

	/* Run all of the fixups for this PHY */
593
	err = phy_scan_fixups(phydev);
594
	if (err) {
A
Andrew Lunn 已提交
595
		pr_err("PHY %d failed to initialize\n", phydev->mdio.addr);
596 597
		goto out;
	}
598

599 600
	phydev->mdio.dev.groups = phy_dev_groups;

A
Andrew Lunn 已提交
601
	err = device_add(&phydev->mdio.dev);
602
	if (err) {
A
Andrew Lunn 已提交
603
		pr_err("PHY %d failed to add\n", phydev->mdio.addr);
604 605 606 607 608 609
		goto out;
	}

	return 0;

 out:
610
	mdiobus_unregister_device(&phydev->mdio);
611 612 613
	return err;
}
EXPORT_SYMBOL(phy_device_register);
614

R
Russell King 已提交
615 616 617 618 619 620 621 622 623 624
/**
 * phy_device_remove - Remove a previously registered phy device from the MDIO bus
 * @phydev: phy_device structure to remove
 *
 * This doesn't free the phy_device itself, it merely reverses the effects
 * of phy_device_register(). Use phy_device_free() to free the device
 * after calling this function.
 */
void phy_device_remove(struct phy_device *phydev)
{
A
Andrew Lunn 已提交
625
	device_del(&phydev->mdio.dev);
626
	mdiobus_unregister_device(&phydev->mdio);
R
Russell King 已提交
627 628 629
}
EXPORT_SYMBOL(phy_device_remove);

J
Jiri Pirko 已提交
630 631 632 633 634 635
/**
 * phy_find_first - finds the first PHY device on the bus
 * @bus: the target MII bus
 */
struct phy_device *phy_find_first(struct mii_bus *bus)
{
636
	struct phy_device *phydev;
J
Jiri Pirko 已提交
637 638 639
	int addr;

	for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
640 641 642
		phydev = mdiobus_get_phy(bus, addr);
		if (phydev)
			return phydev;
J
Jiri Pirko 已提交
643 644 645 646 647
	}
	return NULL;
}
EXPORT_SYMBOL(phy_find_first);

648 649 650 651
/**
 * phy_prepare_link - prepares the PHY layer to monitor link status
 * @phydev: target phy_device struct
 * @handler: callback function for link status change notifications
652
 *
653
 * Description: Tells the PHY infrastructure to handle the
654 655 656 657
 *   gory details on monitoring link status (whether through
 *   polling or an interrupt), and to call back to the
 *   connected device driver when the link status changes.
 *   If you want to monitor your own link state, don't call
658 659
 *   this function.
 */
660
static void phy_prepare_link(struct phy_device *phydev,
S
Sergei Shtylyov 已提交
661
			     void (*handler)(struct net_device *))
662 663 664 665
{
	phydev->adjust_link = handler;
}

666 667 668 669 670 671 672 673
/**
 * phy_connect_direct - connect an ethernet device to a specific phy_device
 * @dev: the network device to connect
 * @phydev: the pointer to the phy device
 * @handler: callback function for state change notifications
 * @interface: PHY device's interface
 */
int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
674
		       void (*handler)(struct net_device *),
675 676 677 678
		       phy_interface_t interface)
{
	int rc;

679
	rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
680 681 682 683
	if (rc)
		return rc;

	phy_prepare_link(phydev, handler);
684
	phy_start_machine(phydev);
685 686 687 688 689 690 691
	if (phydev->irq > 0)
		phy_start_interrupts(phydev);

	return 0;
}
EXPORT_SYMBOL(phy_connect_direct);

692 693 694
/**
 * phy_connect - connect an ethernet device to a PHY device
 * @dev: the network device to connect
695
 * @bus_id: the id string of the PHY device to connect
696 697
 * @handler: callback function for state change notifications
 * @interface: PHY device's interface
A
Andy Fleming 已提交
698
 *
699
 * Description: Convenience function for connecting ethernet
A
Andy Fleming 已提交
700 701 702 703 704 705 706
 *   devices to PHY devices.  The default behavior is for
 *   the PHY infrastructure to handle everything, and only notify
 *   the connected driver when the link status changes.  If you
 *   don't want, or can't use the provided functionality, you may
 *   choose to call only the subset of functions which provide
 *   the desired functionality.
 */
F
Florian Fainelli 已提交
707
struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
S
Sergei Shtylyov 已提交
708 709
			       void (*handler)(struct net_device *),
			       phy_interface_t interface)
A
Andy Fleming 已提交
710 711
{
	struct phy_device *phydev;
712 713
	struct device *d;
	int rc;
A
Andy Fleming 已提交
714

715
	/* Search the list of PHY devices on the mdio bus for the
S
Sergei Shtylyov 已提交
716 717
	 * PHY with the requested name
	 */
718 719 720 721 722 723
	d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
	if (!d) {
		pr_err("PHY %s not found\n", bus_id);
		return ERR_PTR(-ENODEV);
	}
	phydev = to_phy_device(d);
A
Andy Fleming 已提交
724

725
	rc = phy_connect_direct(dev, phydev, handler, interface);
J
Johan Hovold 已提交
726
	put_device(d);
727 728
	if (rc)
		return ERR_PTR(rc);
A
Andy Fleming 已提交
729 730 731 732 733

	return phydev;
}
EXPORT_SYMBOL(phy_connect);

734
/**
S
Sergei Shtylyov 已提交
735 736
 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
 *		    device
737 738
 * @phydev: target phy_device struct
 */
A
Andy Fleming 已提交
739 740 741 742 743 744
void phy_disconnect(struct phy_device *phydev)
{
	if (phydev->irq > 0)
		phy_stop_interrupts(phydev);

	phy_stop_machine(phydev);
F
Florian Fainelli 已提交
745

A
Andy Fleming 已提交
746 747 748 749 750 751
	phydev->adjust_link = NULL;

	phy_detach(phydev);
}
EXPORT_SYMBOL(phy_disconnect);

752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
/**
 * phy_poll_reset - Safely wait until a PHY reset has properly completed
 * @phydev: The PHY device to poll
 *
 * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
 *   published in 2008, a PHY reset may take up to 0.5 seconds.  The MII BMCR
 *   register must be polled until the BMCR_RESET bit clears.
 *
 *   Furthermore, any attempts to write to PHY registers may have no effect
 *   or even generate MDIO bus errors until this is complete.
 *
 *   Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
 *   standard and do not fully reset after the BMCR_RESET bit is set, and may
 *   even *REQUIRE* a soft-reset to properly restart autonegotiation.  In an
 *   effort to support such broken PHYs, this function is separate from the
 *   standard phy_init_hw() which will zero all the other bits in the BMCR
 *   and reapply all driver-specific and board-specific fixups.
 */
static int phy_poll_reset(struct phy_device *phydev)
{
	/* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
	unsigned int retries = 12;
	int ret;

	do {
		msleep(50);
		ret = phy_read(phydev, MII_BMCR);
		if (ret < 0)
			return ret;
	} while (ret & BMCR_RESET && --retries);
	if (ret & BMCR_RESET)
		return -ETIMEDOUT;

S
Sergei Shtylyov 已提交
785
	/* Some chips (smsc911x) may still need up to another 1ms after the
786 787 788 789 790 791
	 * BMCR_RESET bit is cleared before they are usable.
	 */
	msleep(1);
	return 0;
}

792 793
int phy_init_hw(struct phy_device *phydev)
{
794
	int ret = 0;
795 796 797 798

	if (!phydev->drv || !phydev->drv->config_init)
		return 0;

799 800 801 802 803
	if (phydev->drv->soft_reset)
		ret = phydev->drv->soft_reset(phydev);
	else
		ret = genphy_soft_reset(phydev);

804 805 806
	if (ret < 0)
		return ret;

807 808 809 810 811 812
	ret = phy_scan_fixups(phydev);
	if (ret < 0)
		return ret;

	return phydev->drv->config_init(phydev);
}
813
EXPORT_SYMBOL(phy_init_hw);
814

815 816 817 818 819 820 821 822 823 824
void phy_attached_info(struct phy_device *phydev)
{
	phy_attached_print(phydev, NULL);
}
EXPORT_SYMBOL(phy_attached_info);

#define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%d)"
void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
{
	if (!fmt) {
A
Andrew Lunn 已提交
825
		dev_info(&phydev->mdio.dev, ATTACHED_FMT "\n",
826 827 828 829 830
			 phydev->drv->name, phydev_name(phydev),
			 phydev->irq);
	} else {
		va_list ap;

A
Andrew Lunn 已提交
831
		dev_info(&phydev->mdio.dev, ATTACHED_FMT,
832 833 834 835 836 837 838 839 840 841
			 phydev->drv->name, phydev_name(phydev),
			 phydev->irq);

		va_start(ap, fmt);
		vprintk(fmt, ap);
		va_end(ap);
	}
}
EXPORT_SYMBOL(phy_attached_print);

842
/**
843
 * phy_attach_direct - attach a network device to a given PHY device pointer
844
 * @dev: network device to attach
845
 * @phydev: Pointer to phy_device to attach
846 847
 * @flags: PHY device's dev_flags
 * @interface: PHY device's interface
A
Andy Fleming 已提交
848
 *
849
 * Description: Called by drivers to attach to a particular PHY
A
Andy Fleming 已提交
850
 *     device. The phy_device is found, and properly hooked up
851 852
 *     to the phy_driver.  If no driver is attached, then a
 *     generic driver is used.  The phy_device is given a ptr to
A
Andy Fleming 已提交
853
 *     the attaching device, and given a callback for link status
854
 *     change.  The phy_device is returned to the attaching driver.
855
 *     This function takes a reference on the phy device.
A
Andy Fleming 已提交
856
 */
857 858
int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
		      u32 flags, phy_interface_t interface)
A
Andy Fleming 已提交
859
{
A
Andrew Lunn 已提交
860 861
	struct mii_bus *bus = phydev->mdio.bus;
	struct device *d = &phydev->mdio.dev;
862
	int err;
A
Andy Fleming 已提交
863

R
Russell King 已提交
864 865 866 867 868
	if (!try_module_get(bus->owner)) {
		dev_err(&dev->dev, "failed to get the bus module\n");
		return -EIO;
	}

869 870
	get_device(d);

A
Andy Fleming 已提交
871
	/* Assume that if there is no driver, that it doesn't
S
Sergei Shtylyov 已提交
872 873
	 * exist, and we should use the genphy driver.
	 */
S
Sergei Shtylyov 已提交
874
	if (!d->driver) {
875
		if (phydev->is_c45)
876 877
			d->driver =
				&genphy_driver[GENPHY_DRV_10G].mdiodrv.driver;
878
		else
879 880
			d->driver =
				&genphy_driver[GENPHY_DRV_1G].mdiodrv.driver;
A
Andy Fleming 已提交
881 882

		err = d->driver->probe(d);
883 884
		if (err >= 0)
			err = device_bind_driver(d);
A
Andy Fleming 已提交
885

886
		if (err)
R
Russell King 已提交
887
			goto error;
A
Andy Fleming 已提交
888 889 890
	}

	if (phydev->attached_dev) {
891
		dev_err(&dev->dev, "PHY already attached\n");
R
Russell King 已提交
892 893
		err = -EBUSY;
		goto error;
894 895
	}

A
Andy Fleming 已提交
896
	phydev->attached_dev = dev;
897
	dev->phydev = phydev;
A
Andy Fleming 已提交
898 899 900

	phydev->dev_flags = flags;

901 902
	phydev->interface = interface;

903 904
	phydev->state = PHY_READY;

905 906 907 908 909
	/* Initial carrier state is off as the phy is about to be
	 * (re)initialized.
	 */
	netif_carrier_off(phydev->attached_dev);

910 911
	/* Do initial configuration here, now that
	 * we have certain key parameters
S
Sergei Shtylyov 已提交
912 913
	 * (dev_flags and interface)
	 */
914 915 916
	err = phy_init_hw(phydev);
	if (err)
		phy_detach(phydev);
917 918
	else
		phy_resume(phydev);
919

920
	return err;
R
Russell King 已提交
921 922

error:
923
	put_device(d);
R
Russell King 已提交
924 925
	module_put(bus->owner);
	return err;
926
}
927
EXPORT_SYMBOL(phy_attach_direct);
928 929 930 931 932 933 934 935 936 937

/**
 * phy_attach - attach a network device to a particular PHY device
 * @dev: network device to attach
 * @bus_id: Bus ID of PHY device to attach
 * @interface: PHY device's interface
 *
 * Description: Same as phy_attach_direct() except that a PHY bus_id
 *     string is passed instead of a pointer to a struct phy_device.
 */
S
Sergei Shtylyov 已提交
938 939
struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
			      phy_interface_t interface)
940 941 942 943 944 945 946
{
	struct bus_type *bus = &mdio_bus_type;
	struct phy_device *phydev;
	struct device *d;
	int rc;

	/* Search the list of PHY devices on the mdio bus for the
S
Sergei Shtylyov 已提交
947 948
	 * PHY with the requested name
	 */
949 950 951 952
	d = bus_find_device_by_name(bus, NULL, bus_id);
	if (!d) {
		pr_err("PHY %s not found\n", bus_id);
		return ERR_PTR(-ENODEV);
953
	}
954 955
	phydev = to_phy_device(d);

956
	rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
J
Johan Hovold 已提交
957
	put_device(d);
958 959
	if (rc)
		return ERR_PTR(rc);
960

A
Andy Fleming 已提交
961 962 963 964
	return phydev;
}
EXPORT_SYMBOL(phy_attach);

965 966 967
/**
 * phy_detach - detach a PHY device from its network device
 * @phydev: target phy_device struct
968 969 970
 *
 * This detaches the phy device from its network device and the phy
 * driver, and drops the reference count taken in phy_attach_direct().
971
 */
A
Andy Fleming 已提交
972 973
void phy_detach(struct phy_device *phydev)
{
R
Russell King 已提交
974
	struct mii_bus *bus;
975
	int i;
976

977
	phydev->attached_dev->phydev = NULL;
A
Andy Fleming 已提交
978
	phydev->attached_dev = NULL;
979
	phy_suspend(phydev);
A
Andy Fleming 已提交
980 981 982 983

	/* If the device had no specific driver before (i.e. - it
	 * was using the generic driver), we unbind the device
	 * from the generic driver so that there's a chance a
S
Sergei Shtylyov 已提交
984 985
	 * real driver could be loaded
	 */
986
	for (i = 0; i < ARRAY_SIZE(genphy_driver); i++) {
987 988
		if (phydev->mdio.dev.driver ==
		    &genphy_driver[i].mdiodrv.driver) {
A
Andrew Lunn 已提交
989
			device_release_driver(&phydev->mdio.dev);
990 991 992
			break;
		}
	}
R
Russell King 已提交
993

994 995 996 997
	/*
	 * The phydev might go away on the put_device() below, so avoid
	 * a use-after-free bug by reading the underlying bus first.
	 */
A
Andrew Lunn 已提交
998
	bus = phydev->mdio.bus;
R
Russell King 已提交
999

A
Andrew Lunn 已提交
1000
	put_device(&phydev->mdio.dev);
R
Russell King 已提交
1001
	module_put(bus->owner);
A
Andy Fleming 已提交
1002 1003 1004
}
EXPORT_SYMBOL(phy_detach);

1005 1006
int phy_suspend(struct phy_device *phydev)
{
A
Andrew Lunn 已提交
1007
	struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1008
	struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1009
	int ret = 0;
1010 1011 1012 1013 1014 1015 1016

	/* If the device has WOL enabled, we cannot suspend the PHY */
	phy_ethtool_get_wol(phydev, &wol);
	if (wol.wolopts)
		return -EBUSY;

	if (phydrv->suspend)
1017 1018 1019 1020 1021 1022 1023 1024
		ret = phydrv->suspend(phydev);

	if (ret)
		return ret;

	phydev->suspended = true;

	return ret;
1025
}
1026
EXPORT_SYMBOL(phy_suspend);
1027 1028 1029

int phy_resume(struct phy_device *phydev)
{
A
Andrew Lunn 已提交
1030
	struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1031
	int ret = 0;
1032 1033

	if (phydrv->resume)
1034 1035 1036 1037 1038 1039 1040 1041
		ret = phydrv->resume(phydev);

	if (ret)
		return ret;

	phydev->suspended = false;

	return ret;
1042
}
1043
EXPORT_SYMBOL(phy_resume);
A
Andy Fleming 已提交
1044

1045 1046
/* Generic PHY support and helper functions */

1047
/**
L
Lucas De Marchi 已提交
1048
 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1049
 * @phydev: target phy_device struct
1050
 *
1051
 * Description: Writes MII_ADVERTISE with the appropriate values,
1052
 *   after sanitizing the values to make sure we only advertise
1053 1054
 *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
 *   hasn't changed, and > 0 if it has changed.
1055
 */
1056
static int genphy_config_advert(struct phy_device *phydev)
1057 1058
{
	u32 advertise;
1059
	int oldadv, adv, bmsr;
1060
	int err, changed = 0;
1061

S
Sergei Shtylyov 已提交
1062
	/* Only allow advertising what this PHY supports */
1063 1064 1065 1066
	phydev->advertising &= phydev->supported;
	advertise = phydev->advertising;

	/* Setup standard advertisement */
S
Sergei Shtylyov 已提交
1067
	adv = phy_read(phydev, MII_ADVERTISE);
1068 1069 1070
	if (adv < 0)
		return adv;

S
Sergei Shtylyov 已提交
1071
	oldadv = adv;
1072
	adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
1073
		 ADVERTISE_PAUSE_ASYM);
1074
	adv |= ethtool_adv_to_mii_adv_t(advertise);
1075

1076 1077
	if (adv != oldadv) {
		err = phy_write(phydev, MII_ADVERTISE, adv);
1078

1079 1080 1081 1082
		if (err < 0)
			return err;
		changed = 1;
	}
1083

1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
	bmsr = phy_read(phydev, MII_BMSR);
	if (bmsr < 0)
		return bmsr;

	/* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
	 * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
	 * logical 1.
	 */
	if (!(bmsr & BMSR_ESTATEN))
		return changed;

1095
	/* Configure gigabit if it's supported */
1096 1097 1098 1099 1100 1101 1102
	adv = phy_read(phydev, MII_CTRL1000);
	if (adv < 0)
		return adv;

	oldadv = adv;
	adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);

1103
	if (phydev->supported & (SUPPORTED_1000baseT_Half |
S
Sergei Shtylyov 已提交
1104
				 SUPPORTED_1000baseT_Full)) {
1105
		adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
1106 1107
	}

1108 1109 1110
	if (adv != oldadv)
		changed = 1;

1111 1112 1113 1114
	err = phy_write(phydev, MII_CTRL1000, adv);
	if (err < 0)
		return err;

1115
	return changed;
1116 1117
}

1118 1119 1120
/**
 * genphy_setup_forced - configures/forces speed/duplex from @phydev
 * @phydev: target phy_device struct
1121
 *
1122
 * Description: Configures MII_BMCR to force speed/duplex
1123
 *   to the values in phydev. Assumes that the values are valid.
1124 1125
 *   Please see phy_sanitize_settings().
 */
1126
int genphy_setup_forced(struct phy_device *phydev)
1127
{
1128
	int ctl = phy_read(phydev, MII_BMCR);
1129

1130
	ctl &= BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN;
S
Sergei Shtylyov 已提交
1131 1132
	phydev->pause = 0;
	phydev->asym_pause = 0;
1133 1134 1135 1136 1137 1138 1139 1140

	if (SPEED_1000 == phydev->speed)
		ctl |= BMCR_SPEED1000;
	else if (SPEED_100 == phydev->speed)
		ctl |= BMCR_SPEED100;

	if (DUPLEX_FULL == phydev->duplex)
		ctl |= BMCR_FULLDPLX;
F
Florian Fainelli 已提交
1141

1142
	return phy_write(phydev, MII_BMCR, ctl);
1143
}
1144
EXPORT_SYMBOL(genphy_setup_forced);
1145

1146 1147 1148 1149
/**
 * genphy_restart_aneg - Enable and Restart Autonegotiation
 * @phydev: target phy_device struct
 */
1150 1151
int genphy_restart_aneg(struct phy_device *phydev)
{
S
Sergei Shtylyov 已提交
1152
	int ctl = phy_read(phydev, MII_BMCR);
1153 1154 1155 1156

	if (ctl < 0)
		return ctl;

S
Sergei Shtylyov 已提交
1157
	ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
1158 1159

	/* Don't isolate the PHY if we're negotiating */
S
Sergei Shtylyov 已提交
1160
	ctl &= ~BMCR_ISOLATE;
1161

S
Sergei Shtylyov 已提交
1162
	return phy_write(phydev, MII_BMCR, ctl);
1163
}
A
Adrian Bunk 已提交
1164
EXPORT_SYMBOL(genphy_restart_aneg);
1165

1166 1167 1168
/**
 * genphy_config_aneg - restart auto-negotiation or write BMCR
 * @phydev: target phy_device struct
1169
 *
1170
 * Description: If auto-negotiation is enabled, we configure the
1171
 *   advertising, and then restart auto-negotiation.  If it is not
1172
 *   enabled, then we write the BMCR.
1173 1174 1175
 */
int genphy_config_aneg(struct phy_device *phydev)
{
1176
	int result;
1177

1178 1179
	if (AUTONEG_ENABLE != phydev->autoneg)
		return genphy_setup_forced(phydev);
1180

1181 1182 1183 1184
	result = genphy_config_advert(phydev);
	if (result < 0) /* error */
		return result;
	if (result == 0) {
L
Lucas De Marchi 已提交
1185
		/* Advertisement hasn't changed, but maybe aneg was never on to
S
Sergei Shtylyov 已提交
1186 1187
		 * begin with?  Or maybe phy was isolated?
		 */
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
		int ctl = phy_read(phydev, MII_BMCR);

		if (ctl < 0)
			return ctl;

		if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
			result = 1; /* do restart aneg */
	}

	/* Only restart aneg if we are advertising something different
S
Sergei Shtylyov 已提交
1198 1199
	 * than we were before.
	 */
1200 1201
	if (result > 0)
		result = genphy_restart_aneg(phydev);
1202

1203
	return result;
1204 1205 1206
}
EXPORT_SYMBOL(genphy_config_aneg);

1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
/**
 * genphy_aneg_done - return auto-negotiation status
 * @phydev: target phy_device struct
 *
 * Description: Reads the status register and returns 0 either if
 *   auto-negotiation is incomplete, or if there was an error.
 *   Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
 */
int genphy_aneg_done(struct phy_device *phydev)
{
	int retval = phy_read(phydev, MII_BMSR);

	return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
}
EXPORT_SYMBOL(genphy_aneg_done);

S
stephen hemminger 已提交
1223
static int gen10g_config_aneg(struct phy_device *phydev)
A
Andy Fleming 已提交
1224 1225 1226 1227
{
	return 0;
}

1228 1229 1230
/**
 * genphy_update_link - update link status in @phydev
 * @phydev: target phy_device struct
1231
 *
1232
 * Description: Update the value in phydev->link to reflect the
1233
 *   current link value.  In order to do this, we need to read
1234
 *   the status register twice, keeping the second value.
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
 */
int genphy_update_link(struct phy_device *phydev)
{
	int status;

	/* Do a fake read */
	status = phy_read(phydev, MII_BMSR);
	if (status < 0)
		return status;

	/* Read link and autonegotiation status */
	status = phy_read(phydev, MII_BMSR);
	if (status < 0)
		return status;

	if ((status & BMSR_LSTATUS) == 0)
		phydev->link = 0;
	else
		phydev->link = 1;

	return 0;
}
1257
EXPORT_SYMBOL(genphy_update_link);
1258

1259 1260 1261
/**
 * genphy_read_status - check the link status and update current link state
 * @phydev: target phy_device struct
1262
 *
1263
 * Description: Check the link, then figure out the current state
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273
 *   by comparing what we advertise with what the link partner
 *   advertises.  Start by checking the gigabit possibilities,
 *   then move on to 10/100.
 */
int genphy_read_status(struct phy_device *phydev)
{
	int adv;
	int err;
	int lpa;
	int lpagb = 0;
1274 1275
	int common_adv;
	int common_adv_gb = 0;
1276

S
Sergei Shtylyov 已提交
1277
	/* Update the link, but return if there was an error */
1278 1279 1280 1281
	err = genphy_update_link(phydev);
	if (err)
		return err;

1282 1283
	phydev->lp_advertising = 0;

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
	if (AUTONEG_ENABLE == phydev->autoneg) {
		if (phydev->supported & (SUPPORTED_1000baseT_Half
					| SUPPORTED_1000baseT_Full)) {
			lpagb = phy_read(phydev, MII_STAT1000);
			if (lpagb < 0)
				return lpagb;

			adv = phy_read(phydev, MII_CTRL1000);
			if (adv < 0)
				return adv;

1295 1296
			phydev->lp_advertising =
				mii_stat1000_to_ethtool_lpa_t(lpagb);
1297
			common_adv_gb = lpagb & adv << 2;
1298 1299 1300 1301 1302 1303
		}

		lpa = phy_read(phydev, MII_LPA);
		if (lpa < 0)
			return lpa;

1304 1305
		phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);

1306 1307 1308 1309
		adv = phy_read(phydev, MII_ADVERTISE);
		if (adv < 0)
			return adv;

1310
		common_adv = lpa & adv;
1311 1312 1313

		phydev->speed = SPEED_10;
		phydev->duplex = DUPLEX_HALF;
S
Sergei Shtylyov 已提交
1314 1315
		phydev->pause = 0;
		phydev->asym_pause = 0;
1316

1317
		if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
1318 1319
			phydev->speed = SPEED_1000;

1320
			if (common_adv_gb & LPA_1000FULL)
1321
				phydev->duplex = DUPLEX_FULL;
1322
		} else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
1323
			phydev->speed = SPEED_100;
F
Florian Fainelli 已提交
1324

1325
			if (common_adv & LPA_100FULL)
1326 1327
				phydev->duplex = DUPLEX_FULL;
		} else
1328
			if (common_adv & LPA_10FULL)
1329 1330
				phydev->duplex = DUPLEX_FULL;

F
Florian Fainelli 已提交
1331
		if (phydev->duplex == DUPLEX_FULL) {
1332 1333 1334 1335 1336
			phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
			phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
		}
	} else {
		int bmcr = phy_read(phydev, MII_BMCR);
S
Sergei Shtylyov 已提交
1337

1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352
		if (bmcr < 0)
			return bmcr;

		if (bmcr & BMCR_FULLDPLX)
			phydev->duplex = DUPLEX_FULL;
		else
			phydev->duplex = DUPLEX_HALF;

		if (bmcr & BMCR_SPEED1000)
			phydev->speed = SPEED_1000;
		else if (bmcr & BMCR_SPEED100)
			phydev->speed = SPEED_100;
		else
			phydev->speed = SPEED_10;

S
Sergei Shtylyov 已提交
1353 1354
		phydev->pause = 0;
		phydev->asym_pause = 0;
1355 1356 1357 1358 1359 1360
	}

	return 0;
}
EXPORT_SYMBOL(genphy_read_status);

S
stephen hemminger 已提交
1361
static int gen10g_read_status(struct phy_device *phydev)
A
Andy Fleming 已提交
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387
{
	int devad, reg;
	u32 mmd_mask = phydev->c45_ids.devices_in_package;

	phydev->link = 1;

	/* For now just lie and say it's 10G all the time */
	phydev->speed = SPEED_10000;
	phydev->duplex = DUPLEX_FULL;

	for (devad = 0; mmd_mask; devad++, mmd_mask = mmd_mask >> 1) {
		if (!(mmd_mask & 1))
			continue;

		/* Read twice because link state is latched and a
		 * read moves the current state into the register
		 */
		phy_read_mmd(phydev, devad, MDIO_STAT1);
		reg = phy_read_mmd(phydev, devad, MDIO_STAT1);
		if (reg < 0 || !(reg & MDIO_STAT1_LSTATUS))
			phydev->link = 0;
	}

	return 0;
}

1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
/**
 * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
 * @phydev: target phy_device struct
 *
 * Description: Perform a software PHY reset using the standard
 * BMCR_RESET bit and poll for the reset bit to be cleared.
 *
 * Returns: 0 on success, < 0 on failure
 */
int genphy_soft_reset(struct phy_device *phydev)
{
	int ret;

	ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
	if (ret < 0)
		return ret;

	return phy_poll_reset(phydev);
}
EXPORT_SYMBOL(genphy_soft_reset);

1409
int genphy_config_init(struct phy_device *phydev)
1410
{
1411
	int val;
1412 1413 1414 1415
	u32 features;

	features = (SUPPORTED_TP | SUPPORTED_MII
			| SUPPORTED_AUI | SUPPORTED_FIBRE |
1416
			SUPPORTED_BNC | SUPPORTED_Pause | SUPPORTED_Asym_Pause);
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445

	/* Do we support autonegotiation? */
	val = phy_read(phydev, MII_BMSR);
	if (val < 0)
		return val;

	if (val & BMSR_ANEGCAPABLE)
		features |= SUPPORTED_Autoneg;

	if (val & BMSR_100FULL)
		features |= SUPPORTED_100baseT_Full;
	if (val & BMSR_100HALF)
		features |= SUPPORTED_100baseT_Half;
	if (val & BMSR_10FULL)
		features |= SUPPORTED_10baseT_Full;
	if (val & BMSR_10HALF)
		features |= SUPPORTED_10baseT_Half;

	if (val & BMSR_ESTATEN) {
		val = phy_read(phydev, MII_ESTATUS);
		if (val < 0)
			return val;

		if (val & ESTATUS_1000_TFULL)
			features |= SUPPORTED_1000baseT_Full;
		if (val & ESTATUS_1000_THALF)
			features |= SUPPORTED_1000baseT_Half;
	}

1446 1447
	phydev->supported &= features;
	phydev->advertising &= features;
1448 1449 1450

	return 0;
}
A
Andy Fleming 已提交
1451

1452 1453 1454 1455 1456
static int gen10g_soft_reset(struct phy_device *phydev)
{
	/* Do nothing for now */
	return 0;
}
1457
EXPORT_SYMBOL(genphy_config_init);
1458

A
Andy Fleming 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467
static int gen10g_config_init(struct phy_device *phydev)
{
	/* Temporarily just say we support everything */
	phydev->supported = SUPPORTED_10000baseT_Full;
	phydev->advertising = SUPPORTED_10000baseT_Full;

	return 0;
}

G
Giuseppe Cavallaro 已提交
1468 1469 1470 1471 1472 1473 1474
int genphy_suspend(struct phy_device *phydev)
{
	int value;

	mutex_lock(&phydev->lock);

	value = phy_read(phydev, MII_BMCR);
S
Sergei Shtylyov 已提交
1475
	phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
G
Giuseppe Cavallaro 已提交
1476 1477 1478 1479 1480 1481

	mutex_unlock(&phydev->lock);

	return 0;
}
EXPORT_SYMBOL(genphy_suspend);
1482

S
stephen hemminger 已提交
1483
static int gen10g_suspend(struct phy_device *phydev)
A
Andy Fleming 已提交
1484 1485 1486 1487
{
	return 0;
}

G
Giuseppe Cavallaro 已提交
1488 1489 1490 1491 1492 1493 1494
int genphy_resume(struct phy_device *phydev)
{
	int value;

	mutex_lock(&phydev->lock);

	value = phy_read(phydev, MII_BMCR);
S
Sergei Shtylyov 已提交
1495
	phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
G
Giuseppe Cavallaro 已提交
1496 1497 1498 1499 1500 1501

	mutex_unlock(&phydev->lock);

	return 0;
}
EXPORT_SYMBOL(genphy_resume);
1502

S
stephen hemminger 已提交
1503
static int gen10g_resume(struct phy_device *phydev)
A
Andy Fleming 已提交
1504 1505 1506 1507
{
	return 0;
}

1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
static int __set_phy_supported(struct phy_device *phydev, u32 max_speed)
{
	/* The default values for phydev->supported are provided by the PHY
	 * driver "features" member, we want to reset to sane defaults first
	 * before supporting higher speeds.
	 */
	phydev->supported &= PHY_DEFAULT_FEATURES;

	switch (max_speed) {
	default:
		return -ENOTSUPP;
	case SPEED_1000:
		phydev->supported |= PHY_1000BT_FEATURES;
		/* fall through */
	case SPEED_100:
		phydev->supported |= PHY_100BT_FEATURES;
		/* fall through */
	case SPEED_10:
		phydev->supported |= PHY_10BT_FEATURES;
	}

	return 0;
}

int phy_set_max_speed(struct phy_device *phydev, u32 max_speed)
{
	int err;

	err = __set_phy_supported(phydev, max_speed);
	if (err)
		return err;

	phydev->advertising = phydev->supported;

	return 0;
}
EXPORT_SYMBOL(phy_set_max_speed);

1546 1547
static void of_set_phy_supported(struct phy_device *phydev)
{
A
Andrew Lunn 已提交
1548
	struct device_node *node = phydev->mdio.dev.of_node;
1549 1550 1551 1552 1553 1554 1555 1556
	u32 max_speed;

	if (!IS_ENABLED(CONFIG_OF_MDIO))
		return;

	if (!node)
		return;

1557 1558
	if (!of_property_read_u32(node, "max-speed", &max_speed))
		__set_phy_supported(phydev, max_speed);
1559 1560
}

1561 1562 1563
/**
 * phy_probe - probe and init a PHY device
 * @dev: device to probe and init
1564
 *
1565
 * Description: Take care of setting up the phy_device structure,
1566 1567 1568 1569 1570
 *   set the state to READY (the driver's init function should
 *   set it to STARTING if needed).
 */
static int phy_probe(struct device *dev)
{
S
Sergei Shtylyov 已提交
1571
	struct phy_device *phydev = to_phy_device(dev);
A
Andrew Lunn 已提交
1572
	struct device_driver *drv = phydev->mdio.dev.driver;
S
Sergei Shtylyov 已提交
1573
	struct phy_driver *phydrv = to_phy_driver(drv);
1574 1575 1576 1577
	int err = 0;

	phydev->drv = phydrv;

1578 1579 1580 1581
	/* Disable the interrupt if the PHY doesn't support it
	 * but the interrupt is still a valid one
	 */
	if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
S
Sergei Shtylyov 已提交
1582
	    phy_interrupt_is_valid(phydev))
1583 1584
		phydev->irq = PHY_POLL;

1585 1586 1587
	if (phydrv->flags & PHY_IS_INTERNAL)
		phydev->is_internal = true;

1588
	mutex_lock(&phydev->lock);
1589 1590 1591

	/* Start out supporting everything. Eventually,
	 * a controller will attach, and may modify one
S
Sergei Shtylyov 已提交
1592 1593
	 * or both of these values
	 */
1594
	phydev->supported = phydrv->features;
1595 1596
	of_set_phy_supported(phydev);
	phydev->advertising = phydev->supported;
1597 1598 1599 1600 1601 1602 1603

	/* Set the state to READY by default */
	phydev->state = PHY_READY;

	if (phydev->drv->probe)
		err = phydev->drv->probe(phydev);

1604
	mutex_unlock(&phydev->lock);
1605 1606 1607 1608 1609 1610

	return err;
}

static int phy_remove(struct device *dev)
{
S
Sergei Shtylyov 已提交
1611
	struct phy_device *phydev = to_phy_device(dev);
1612

1613
	mutex_lock(&phydev->lock);
1614
	phydev->state = PHY_DOWN;
1615
	mutex_unlock(&phydev->lock);
1616 1617 1618 1619 1620 1621 1622 1623

	if (phydev->drv->remove)
		phydev->drv->remove(phydev);
	phydev->drv = NULL;

	return 0;
}

1624 1625 1626
/**
 * phy_driver_register - register a phy_driver with the PHY layer
 * @new_driver: new phy_driver to register
1627
 * @owner: module owning this PHY
1628
 */
1629
int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
1630 1631 1632
{
	int retval;

1633 1634 1635 1636 1637 1638
	new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
	new_driver->mdiodrv.driver.name = new_driver->name;
	new_driver->mdiodrv.driver.bus = &mdio_bus_type;
	new_driver->mdiodrv.driver.probe = phy_probe;
	new_driver->mdiodrv.driver.remove = phy_remove;
	new_driver->mdiodrv.driver.owner = owner;
1639

1640
	retval = driver_register(&new_driver->mdiodrv.driver);
1641
	if (retval) {
J
Joe Perches 已提交
1642 1643
		pr_err("%s: Error %d in registering driver\n",
		       new_driver->name, retval);
1644 1645 1646 1647

		return retval;
	}

1648
	pr_debug("%s: Registered new driver\n", new_driver->name);
1649 1650 1651 1652 1653

	return 0;
}
EXPORT_SYMBOL(phy_driver_register);

1654 1655
int phy_drivers_register(struct phy_driver *new_driver, int n,
			 struct module *owner)
1656 1657 1658 1659
{
	int i, ret = 0;

	for (i = 0; i < n; i++) {
1660
		ret = phy_driver_register(new_driver + i, owner);
1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
		if (ret) {
			while (i-- > 0)
				phy_driver_unregister(new_driver + i);
			break;
		}
	}
	return ret;
}
EXPORT_SYMBOL(phy_drivers_register);

1671 1672
void phy_driver_unregister(struct phy_driver *drv)
{
1673
	driver_unregister(&drv->mdiodrv.driver);
1674 1675 1676
}
EXPORT_SYMBOL(phy_driver_unregister);

1677 1678 1679
void phy_drivers_unregister(struct phy_driver *drv, int n)
{
	int i;
S
Sergei Shtylyov 已提交
1680 1681

	for (i = 0; i < n; i++)
1682 1683 1684 1685
		phy_driver_unregister(drv + i);
}
EXPORT_SYMBOL(phy_drivers_unregister);

1686 1687
static struct phy_driver genphy_driver[] = {
{
A
Andy Fleming 已提交
1688 1689 1690
	.phy_id		= 0xffffffff,
	.phy_id_mask	= 0xffffffff,
	.name		= "Generic PHY",
1691
	.soft_reset	= genphy_soft_reset,
A
Andy Fleming 已提交
1692
	.config_init	= genphy_config_init,
1693 1694 1695
	.features	= PHY_GBIT_FEATURES | SUPPORTED_MII |
			  SUPPORTED_AUI | SUPPORTED_FIBRE |
			  SUPPORTED_BNC,
A
Andy Fleming 已提交
1696
	.config_aneg	= genphy_config_aneg,
1697
	.aneg_done	= genphy_aneg_done,
A
Andy Fleming 已提交
1698
	.read_status	= genphy_read_status,
G
Giuseppe Cavallaro 已提交
1699 1700
	.suspend	= genphy_suspend,
	.resume		= genphy_resume,
A
Andy Fleming 已提交
1701 1702 1703 1704
}, {
	.phy_id         = 0xffffffff,
	.phy_id_mask    = 0xffffffff,
	.name           = "Generic 10G PHY",
1705
	.soft_reset	= gen10g_soft_reset,
A
Andy Fleming 已提交
1706 1707 1708 1709 1710 1711
	.config_init    = gen10g_config_init,
	.features       = 0,
	.config_aneg    = gen10g_config_aneg,
	.read_status    = gen10g_read_status,
	.suspend        = gen10g_suspend,
	.resume         = gen10g_resume,
1712
} };
1713

1714
static int __init phy_init(void)
1715
{
1716 1717 1718 1719
	int rc;

	rc = mdio_bus_init();
	if (rc)
A
Andy Fleming 已提交
1720
		return rc;
1721

1722
	rc = phy_drivers_register(genphy_driver,
1723
				  ARRAY_SIZE(genphy_driver), THIS_MODULE);
A
Andy Fleming 已提交
1724 1725
	if (rc)
		mdio_bus_exit();
1726 1727

	return rc;
1728 1729
}

1730
static void __exit phy_exit(void)
1731
{
1732 1733
	phy_drivers_unregister(genphy_driver,
			       ARRAY_SIZE(genphy_driver));
A
Andy Fleming 已提交
1734
	mdio_bus_exit();
1735 1736
}

A
Andy Fleming 已提交
1737
subsys_initcall(phy_init);
1738
module_exit(phy_exit);