phy_device.c 29.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*
 * drivers/net/phy/phy_device.c
 *
 * Framework for finding and configuring PHYs.
 * 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 已提交
17 18 19

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
#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>

#include <asm/io.h>
#include <asm/irq.h>
#include <asm/uaccess.h>

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

45 46
void phy_device_free(struct phy_device *phydev)
{
47
	put_device(&phydev->dev);
48
}
49
EXPORT_SYMBOL(phy_device_free);
50 51 52

static void phy_device_release(struct device *dev)
{
53
	kfree(to_phy_device(dev));
54 55
}

56 57 58 59
static struct phy_driver genphy_driver;
extern int mdio_bus_init(void);
extern void mdio_bus_exit(void);

60 61 62
static LIST_HEAD(phy_fixup_list);
static DEFINE_MUTEX(phy_fixup_lock);

63 64 65
static int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
			     u32 flags, phy_interface_t interface);

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
/*
 * Creates a new phy_fixup and adds it to the list
 * @bus_id: A string which matches phydev->dev.bus_id (or PHY_ANY_ID)
 * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
 * 	It can also be PHY_ANY_UID
 * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
 * 	comparison
 * @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,
		int (*run)(struct phy_device *))
{
	struct phy_fixup *fixup;

	fixup = kzalloc(sizeof(struct phy_fixup), GFP_KERNEL);
	if (!fixup)
		return -ENOMEM;

84
	strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
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
	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,
		int (*run)(struct phy_device *))
{
	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,
		int (*run)(struct phy_device *))
{
	return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
}
EXPORT_SYMBOL(phy_register_fixup_for_id);

/*
 * Returns 1 if fixup matches phydev in bus_id and phy_uid.
 * 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)
{
119
	if (strcmp(fixup->bus_id, dev_name(&phydev->dev)) != 0)
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
		if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
			return 0;

	if ((fixup->phy_uid & fixup->phy_uid_mask) !=
			(phydev->phy_id & fixup->phy_uid_mask))
		if (fixup->phy_uid != PHY_ANY_UID)
			return 0;

	return 1;
}

/* Runs any matching fixups for this phydev */
int phy_scan_fixups(struct phy_device *phydev)
{
	struct phy_fixup *fixup;

	mutex_lock(&phy_fixup_lock);
	list_for_each_entry(fixup, &phy_fixup_list, list) {
		if (phy_needs_fixup(phydev, fixup)) {
			int err;

			err = fixup->run(phydev);

J
Jiri Slaby 已提交
143 144
			if (err < 0) {
				mutex_unlock(&phy_fixup_lock);
145
				return err;
J
Jiri Slaby 已提交
146
			}
147 148 149 150 151 152 153 154
		}
	}
	mutex_unlock(&phy_fixup_lock);

	return 0;
}
EXPORT_SYMBOL(phy_scan_fixups);

155 156
struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
			bool is_c45, struct phy_c45_device_ids *c45_ids)
157 158
{
	struct phy_device *dev;
159

160 161
	/* We allocate the device, and initialize the
	 * default values */
162
	dev = kzalloc(sizeof(*dev), GFP_KERNEL);
163 164 165 166

	if (NULL == dev)
		return (struct phy_device*) PTR_ERR((void*)-ENOMEM);

167 168
	dev->dev.release = phy_device_release;

169 170 171 172
	dev->speed = 0;
	dev->duplex = -1;
	dev->pause = dev->asym_pause = 0;
	dev->link = 1;
173
	dev->interface = PHY_INTERFACE_MODE_GMII;
174 175 176

	dev->autoneg = AUTONEG_ENABLE;

177
	dev->is_c45 = is_c45;
178 179
	dev->addr = addr;
	dev->phy_id = phy_id;
180 181
	if (c45_ids)
		dev->c45_ids = *c45_ids;
182
	dev->bus = bus;
183 184 185 186
	dev->dev.parent = bus->parent;
	dev->dev.bus = &mdio_bus_type;
	dev->irq = bus->irq != NULL ? bus->irq[addr] : PHY_POLL;
	dev_set_name(&dev->dev, PHY_ID_FMT, bus->id, addr);
187 188 189

	dev->state = PHY_DOWN;

190
	mutex_init(&dev->lock);
191
	INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
192
	INIT_WORK(&dev->phy_queue, phy_change);
193

194 195 196 197 198 199 200 201 202 203 204
	/* Request the appropriate module unconditionally; don't
	   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. */
	request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));

205 206
	device_initialize(&dev->dev);

207 208
	return dev;
}
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
EXPORT_SYMBOL(phy_device_create);

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

	/* Find first non-zero Devices In package.  Device
	 * zero is reserved, so don't probe it.
	 */
	for (i = 1;
	     i < num_ids && c45_ids->devices_in_package == 0;
	     i++) {
		reg_addr = MII_ADDR_C45 | i << 16 | 6;
		phy_reg = mdiobus_read(bus, addr, reg_addr);
		if (phy_reg < 0)
			return -EIO;
		c45_ids->devices_in_package = (phy_reg & 0xffff) << 16;

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

		/* If mostly Fs, there is no device there,
		 * let's get out of here.
		 */
		if ((c45_ids->devices_in_package & 0x1fffffff) == 0x1fffffff) {
			*phy_id = 0xffffffff;
			return 0;
		}
	}

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

278
/**
279
 * get_phy_id - reads the specified addr for its ID.
280 281
 * @bus: the target MII bus
 * @addr: PHY address on the MII bus
282
 * @phy_id: where to store the ID retrieved.
283 284 285 286 287 288 289 290 291
 * @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.
292 293
 *
 */
294 295
static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
		      bool is_c45, struct phy_c45_device_ids *c45_ids)
296 297 298
{
	int phy_reg;

299 300 301
	if (is_c45)
		return get_phy_c45_ids(bus, addr, phy_id, c45_ids);

302 303
	/* Grab the bits from PHYIR1, and put them
	 * in the upper half */
304
	phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
305 306

	if (phy_reg < 0)
307
		return -EIO;
308

309
	*phy_id = (phy_reg & 0xffff) << 16;
310 311

	/* Grab the bits from PHYIR2, and put them in the lower half */
312
	phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
313 314

	if (phy_reg < 0)
315 316 317 318 319 320 321 322 323 324 325
		return -EIO;

	*phy_id |= (phy_reg & 0xffff);

	return 0;
}

/**
 * get_phy_device - reads the specified PHY device and returns its @phy_device struct
 * @bus: the target MII bus
 * @addr: PHY address on the MII bus
326
 * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
327 328 329 330
 *
 * Description: Reads the ID registers of the PHY at @addr on the
 *   @bus, then allocates and returns the phy_device to represent it.
 */
331
struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
332
{
333
	struct phy_c45_device_ids c45_ids = {0};
334 335
	struct phy_device *dev = NULL;
	u32 phy_id = 0;
336
	int r;
337

338
	r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
339 340
	if (r)
		return ERR_PTR(r);
341

342 343 344 345
	/* If the phy_id is mostly Fs, there is no device there */
	if ((phy_id & 0x1fffffff) == 0x1fffffff)
		return NULL;

346
	dev = phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
347 348 349

	return dev;
}
350 351 352 353
EXPORT_SYMBOL(get_phy_device);

/**
 * phy_device_register - Register the phy device on the MDIO bus
354
 * @phydev: phy_device structure to be added to the MDIO bus
355 356 357 358 359 360 361 362 363 364 365 366
 */
int phy_device_register(struct phy_device *phydev)
{
	int err;

	/* Don't register a phy if one is already registered at this
	 * address */
	if (phydev->bus->phy_map[phydev->addr])
		return -EINVAL;
	phydev->bus->phy_map[phydev->addr] = phydev;

	/* Run all of the fixups for this PHY */
367 368 369 370 371
	err = phy_init_hw(phydev);
	if (err) {
		pr_err("PHY %d failed to initialize\n", phydev->addr);
		goto out;
	}
372

373
	err = device_add(&phydev->dev);
374
	if (err) {
375
		pr_err("PHY %d failed to add\n", phydev->addr);
376 377 378 379 380 381 382 383 384 385
		goto out;
	}

	return 0;

 out:
	phydev->bus->phy_map[phydev->addr] = NULL;
	return err;
}
EXPORT_SYMBOL(phy_device_register);
386

J
Jiri Pirko 已提交
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
/**
 * 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)
{
	int addr;

	for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
		if (bus->phy_map[addr])
			return bus->phy_map[addr];
	}
	return NULL;
}
EXPORT_SYMBOL(phy_find_first);

403 404 405 406
/**
 * phy_prepare_link - prepares the PHY layer to monitor link status
 * @phydev: target phy_device struct
 * @handler: callback function for link status change notifications
407
 *
408
 * Description: Tells the PHY infrastructure to handle the
409 410 411 412
 *   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
413 414
 *   this function.
 */
415
static void phy_prepare_link(struct phy_device *phydev,
416 417 418 419 420
		void (*handler)(struct net_device *))
{
	phydev->adjust_link = handler;
}

421 422 423 424 425 426 427 428
/**
 * 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,
429
		       void (*handler)(struct net_device *),
430 431 432 433
		       phy_interface_t interface)
{
	int rc;

434
	rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
435 436 437 438 439 440 441 442 443 444 445 446
	if (rc)
		return rc;

	phy_prepare_link(phydev, handler);
	phy_start_machine(phydev, NULL);
	if (phydev->irq > 0)
		phy_start_interrupts(phydev);

	return 0;
}
EXPORT_SYMBOL(phy_connect_direct);

447 448 449
/**
 * phy_connect - connect an ethernet device to a PHY device
 * @dev: the network device to connect
450
 * @bus_id: the id string of the PHY device to connect
451 452
 * @handler: callback function for state change notifications
 * @interface: PHY device's interface
A
Andy Fleming 已提交
453
 *
454
 * Description: Convenience function for connecting ethernet
A
Andy Fleming 已提交
455 456 457 458 459 460 461
 *   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.
 */
462
struct phy_device * phy_connect(struct net_device *dev, const char *bus_id,
463
		void (*handler)(struct net_device *),
R
Randy Dunlap 已提交
464
		phy_interface_t interface)
A
Andy Fleming 已提交
465 466
{
	struct phy_device *phydev;
467 468
	struct device *d;
	int rc;
A
Andy Fleming 已提交
469

470 471 472 473 474 475 476 477
	/* Search the list of PHY devices on the mdio bus for the
	 * PHY with the requested name */
	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 已提交
478

479
	rc = phy_connect_direct(dev, phydev, handler, interface);
480 481
	if (rc)
		return ERR_PTR(rc);
A
Andy Fleming 已提交
482 483 484 485 486

	return phydev;
}
EXPORT_SYMBOL(phy_connect);

487 488 489 490
/**
 * phy_disconnect - disable interrupts, stop state machine, and detach a PHY device
 * @phydev: target phy_device struct
 */
A
Andy Fleming 已提交
491 492 493 494 495 496 497 498 499 500 501 502 503
void phy_disconnect(struct phy_device *phydev)
{
	if (phydev->irq > 0)
		phy_stop_interrupts(phydev);

	phy_stop_machine(phydev);
	
	phydev->adjust_link = NULL;

	phy_detach(phydev);
}
EXPORT_SYMBOL(phy_disconnect);

504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
/**
 * 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;

	/*
	 * Some chips (smsc911x) may still need up to another 1ms after the
	 * BMCR_RESET bit is cleared before they are usable.
	 */
	msleep(1);
	return 0;
}

545 546 547 548 549 550 551
int phy_init_hw(struct phy_device *phydev)
{
	int ret;

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

552 553 554 555 556 557 558 559
	ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
	if (ret < 0)
		return ret;

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

560 561 562 563 564 565
	ret = phy_scan_fixups(phydev);
	if (ret < 0)
		return ret;

	return phydev->drv->config_init(phydev);
}
566
EXPORT_SYMBOL(phy_init_hw);
567

568
/**
569
 * phy_attach_direct - attach a network device to a given PHY device pointer
570
 * @dev: network device to attach
571
 * @phydev: Pointer to phy_device to attach
572 573
 * @flags: PHY device's dev_flags
 * @interface: PHY device's interface
A
Andy Fleming 已提交
574
 *
575
 * Description: Called by drivers to attach to a particular PHY
A
Andy Fleming 已提交
576 577 578 579
 *     device. The phy_device is found, and properly hooked up
 *     to the phy_driver.  If no driver is attached, then the
 *     genphy_driver is used.  The phy_device is given a ptr to
 *     the attaching device, and given a callback for link status
580
 *     change.  The phy_device is returned to the attaching driver.
A
Andy Fleming 已提交
581
 */
582 583
static int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
			     u32 flags, phy_interface_t interface)
A
Andy Fleming 已提交
584
{
585
	struct device *d = &phydev->dev;
586
	int err;
A
Andy Fleming 已提交
587 588 589 590

	/* Assume that if there is no driver, that it doesn't
	 * exist, and we should use the genphy driver. */
	if (NULL == d->driver) {
591 592 593 594 595
		if (phydev->is_c45) {
			pr_err("No driver for phy %x\n", phydev->phy_id);
			return -ENODEV;
		}

A
Andy Fleming 已提交
596 597 598
		d->driver = &genphy_driver.driver;

		err = d->driver->probe(d);
599 600
		if (err >= 0)
			err = device_bind_driver(d);
A
Andy Fleming 已提交
601

602
		if (err)
603
			return err;
A
Andy Fleming 已提交
604 605 606
	}

	if (phydev->attached_dev) {
607 608
		dev_err(&dev->dev, "PHY already attached\n");
		return -EBUSY;
A
Andy Fleming 已提交
609 610 611
	}

	phydev->attached_dev = dev;
612
	dev->phydev = phydev;
A
Andy Fleming 已提交
613 614 615

	phydev->dev_flags = flags;

616 617
	phydev->interface = interface;

618 619
	phydev->state = PHY_READY;

620 621 622
	/* Do initial configuration here, now that
	 * we have certain key parameters
	 * (dev_flags and interface) */
623 624 625 626 627
	err = phy_init_hw(phydev);
	if (err)
		phy_detach(phydev);

	return err;
628 629 630 631 632 633 634 635 636 637 638 639
}

/**
 * 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.
 */
struct phy_device *phy_attach(struct net_device *dev,
640
		const char *bus_id, phy_interface_t interface)
641 642 643 644 645 646 647 648 649 650 651 652
{
	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
	 * PHY with the requested name */
	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);
653
	}
654 655
	phydev = to_phy_device(d);

656
	rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
657 658
	if (rc)
		return ERR_PTR(rc);
659

A
Andy Fleming 已提交
660 661 662 663
	return phydev;
}
EXPORT_SYMBOL(phy_attach);

664 665 666 667
/**
 * phy_detach - detach a PHY device from its network device
 * @phydev: target phy_device struct
 */
A
Andy Fleming 已提交
668 669
void phy_detach(struct phy_device *phydev)
{
670
	phydev->attached_dev->phydev = NULL;
A
Andy Fleming 已提交
671 672 673 674 675 676
	phydev->attached_dev = NULL;

	/* 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
	 * real driver could be loaded */
677
	if (phydev->dev.driver == &genphy_driver.driver)
A
Andy Fleming 已提交
678 679 680 681
		device_release_driver(&phydev->dev);
}
EXPORT_SYMBOL(phy_detach);

682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
int phy_suspend(struct phy_device *phydev)
{
	struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
	struct ethtool_wolinfo wol;

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

	if (phydrv->suspend)
		return phydrv->suspend(phydev);
	return 0;
}

int phy_resume(struct phy_device *phydev)
{
	struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);

	if (phydrv->resume)
		return phydrv->resume(phydev);
	return 0;
}
A
Andy Fleming 已提交
706

707 708
/* Generic PHY support and helper functions */

709
/**
L
Lucas De Marchi 已提交
710
 * genphy_config_advert - sanitize and advertise auto-negotiation parameters
711
 * @phydev: target phy_device struct
712
 *
713
 * Description: Writes MII_ADVERTISE with the appropriate values,
714
 *   after sanitizing the values to make sure we only advertise
715 716
 *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
 *   hasn't changed, and > 0 if it has changed.
717
 */
718
static int genphy_config_advert(struct phy_device *phydev)
719 720
{
	u32 advertise;
721 722
	int oldadv, adv;
	int err, changed = 0;
723 724 725 726 727 728 729

	/* Only allow advertising what
	 * this PHY supports */
	phydev->advertising &= phydev->supported;
	advertise = phydev->advertising;

	/* Setup standard advertisement */
730
	oldadv = adv = phy_read(phydev, MII_ADVERTISE);
731 732 733 734

	if (adv < 0)
		return adv;

735
	adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
736
		 ADVERTISE_PAUSE_ASYM);
737
	adv |= ethtool_adv_to_mii_adv_t(advertise);
738

739 740
	if (adv != oldadv) {
		err = phy_write(phydev, MII_ADVERTISE, adv);
741

742 743 744 745
		if (err < 0)
			return err;
		changed = 1;
	}
746 747 748 749

	/* Configure gigabit if it's supported */
	if (phydev->supported & (SUPPORTED_1000baseT_Half |
				SUPPORTED_1000baseT_Full)) {
750
		oldadv = adv = phy_read(phydev, MII_CTRL1000);
751 752 753 754 755

		if (adv < 0)
			return adv;

		adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
756
		adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
757

758 759 760 761 762 763 764
		if (adv != oldadv) {
			err = phy_write(phydev, MII_CTRL1000, adv);

			if (err < 0)
				return err;
			changed = 1;
		}
765 766
	}

767
	return changed;
768 769
}

770 771 772
/**
 * genphy_setup_forced - configures/forces speed/duplex from @phydev
 * @phydev: target phy_device struct
773
 *
774
 * Description: Configures MII_BMCR to force speed/duplex
775
 *   to the values in phydev. Assumes that the values are valid.
776 777
 *   Please see phy_sanitize_settings().
 */
778
int genphy_setup_forced(struct phy_device *phydev)
779
{
780
	int err;
781
	int ctl = 0;
782 783 784 785 786 787 788 789 790 791 792

	phydev->pause = phydev->asym_pause = 0;

	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;
	
793
	err = phy_write(phydev, MII_BMCR, ctl);
794

795
	return err;
796
}
797
EXPORT_SYMBOL(genphy_setup_forced);
798

799 800 801 802
/**
 * genphy_restart_aneg - Enable and Restart Autonegotiation
 * @phydev: target phy_device struct
 */
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
int genphy_restart_aneg(struct phy_device *phydev)
{
	int ctl;

	ctl = phy_read(phydev, MII_BMCR);

	if (ctl < 0)
		return ctl;

	ctl |= (BMCR_ANENABLE | BMCR_ANRESTART);

	/* Don't isolate the PHY if we're negotiating */
	ctl &= ~(BMCR_ISOLATE);

	ctl = phy_write(phydev, MII_BMCR, ctl);

	return ctl;
}
A
Adrian Bunk 已提交
821
EXPORT_SYMBOL(genphy_restart_aneg);
822 823


824 825 826
/**
 * genphy_config_aneg - restart auto-negotiation or write BMCR
 * @phydev: target phy_device struct
827
 *
828
 * Description: If auto-negotiation is enabled, we configure the
829
 *   advertising, and then restart auto-negotiation.  If it is not
830
 *   enabled, then we write the BMCR.
831 832 833
 */
int genphy_config_aneg(struct phy_device *phydev)
{
834
	int result;
835

836 837
	if (AUTONEG_ENABLE != phydev->autoneg)
		return genphy_setup_forced(phydev);
838

839
	result = genphy_config_advert(phydev);
840

841 842 843 844
	if (result < 0) /* error */
		return result;

	if (result == 0) {
L
Lucas De Marchi 已提交
845
		/* Advertisement hasn't changed, but maybe aneg was never on to
846 847 848 849 850 851 852 853 854 855 856 857 858 859
		 * begin with?  Or maybe phy was isolated? */
		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
	 * than we were before.	 */
	if (result > 0)
		result = genphy_restart_aneg(phydev);
860

861
	return result;
862 863 864
}
EXPORT_SYMBOL(genphy_config_aneg);

865 866 867
/**
 * genphy_update_link - update link status in @phydev
 * @phydev: target phy_device struct
868
 *
869
 * Description: Update the value in phydev->link to reflect the
870
 *   current link value.  In order to do this, we need to read
871
 *   the status register twice, keeping the second value.
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
 */
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;
}
896
EXPORT_SYMBOL(genphy_update_link);
897

898 899 900
/**
 * genphy_read_status - check the link status and update current link state
 * @phydev: target phy_device struct
901
 *
902
 * Description: Check the link, then figure out the current state
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
 *   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;

	/* Update the link, but return if there
	 * was an error */
	err = genphy_update_link(phydev);
	if (err)
		return err;

920 921
	phydev->lp_advertising = 0;

922 923 924 925 926 927 928 929 930 931 932 933 934
	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;

935 936
			phydev->lp_advertising =
				mii_stat1000_to_ethtool_lpa_t(lpagb);
937 938 939 940 941 942 943 944
			lpagb &= adv << 2;
		}

		lpa = phy_read(phydev, MII_LPA);

		if (lpa < 0)
			return lpa;

945 946
		phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);

947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
		adv = phy_read(phydev, MII_ADVERTISE);

		if (adv < 0)
			return adv;

		lpa &= adv;

		phydev->speed = SPEED_10;
		phydev->duplex = DUPLEX_HALF;
		phydev->pause = phydev->asym_pause = 0;

		if (lpagb & (LPA_1000FULL | LPA_1000HALF)) {
			phydev->speed = SPEED_1000;

			if (lpagb & LPA_1000FULL)
				phydev->duplex = DUPLEX_FULL;
		} else if (lpa & (LPA_100FULL | LPA_100HALF)) {
			phydev->speed = SPEED_100;
			
			if (lpa & LPA_100FULL)
				phydev->duplex = DUPLEX_FULL;
		} else
			if (lpa & LPA_10FULL)
				phydev->duplex = DUPLEX_FULL;

		if (phydev->duplex == DUPLEX_FULL){
			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);
		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;

		phydev->pause = phydev->asym_pause = 0;
	}

	return 0;
}
EXPORT_SYMBOL(genphy_read_status);

static int genphy_config_init(struct phy_device *phydev)
{
1002
	int val;
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
	u32 features;

	/* For now, I'll claim that the generic driver supports
	 * all possible port types */
	features = (SUPPORTED_TP | SUPPORTED_MII
			| SUPPORTED_AUI | SUPPORTED_FIBRE |
			SUPPORTED_BNC);

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

	phydev->supported = features;
	phydev->advertising = features;

	return 0;
}
G
Giuseppe Cavallaro 已提交
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
int genphy_suspend(struct phy_device *phydev)
{
	int value;

	mutex_lock(&phydev->lock);

	value = phy_read(phydev, MII_BMCR);
	phy_write(phydev, MII_BMCR, (value | BMCR_PDOWN));

	mutex_unlock(&phydev->lock);

	return 0;
}
EXPORT_SYMBOL(genphy_suspend);
1060

G
Giuseppe Cavallaro 已提交
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074
int genphy_resume(struct phy_device *phydev)
{
	int value;

	mutex_lock(&phydev->lock);

	value = phy_read(phydev, MII_BMCR);
	phy_write(phydev, MII_BMCR, (value & ~BMCR_PDOWN));

	mutex_unlock(&phydev->lock);

	return 0;
}
EXPORT_SYMBOL(genphy_resume);
1075

1076 1077 1078
/**
 * phy_probe - probe and init a PHY device
 * @dev: device to probe and init
1079
 *
1080
 * Description: Take care of setting up the phy_device structure,
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
 *   set the state to READY (the driver's init function should
 *   set it to STARTING if needed).
 */
static int phy_probe(struct device *dev)
{
	struct phy_device *phydev;
	struct phy_driver *phydrv;
	struct device_driver *drv;
	int err = 0;

	phydev = to_phy_device(dev);

1093
	drv = phydev->dev.driver;
1094 1095 1096
	phydrv = to_phy_driver(drv);
	phydev->drv = phydrv;

1097 1098 1099 1100 1101
	/* Disable the interrupt if the PHY doesn't support it
	 * but the interrupt is still a valid one
	 */
	if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
			phy_interrupt_is_valid(phydev))
1102 1103
		phydev->irq = PHY_POLL;

1104 1105 1106
	if (phydrv->flags & PHY_IS_INTERNAL)
		phydev->is_internal = true;

1107
	mutex_lock(&phydev->lock);
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120

	/* Start out supporting everything. Eventually,
	 * a controller will attach, and may modify one
	 * or both of these values */
	phydev->supported = phydrv->features;
	phydev->advertising = phydrv->features;

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

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

1121
	mutex_unlock(&phydev->lock);
1122 1123

	return err;
1124

1125 1126 1127 1128 1129 1130 1131 1132
}

static int phy_remove(struct device *dev)
{
	struct phy_device *phydev;

	phydev = to_phy_device(dev);

1133
	mutex_lock(&phydev->lock);
1134
	phydev->state = PHY_DOWN;
1135
	mutex_unlock(&phydev->lock);
1136 1137 1138 1139 1140 1141 1142 1143

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

	return 0;
}

1144 1145 1146 1147
/**
 * phy_driver_register - register a phy_driver with the PHY layer
 * @new_driver: new phy_driver to register
 */
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
int phy_driver_register(struct phy_driver *new_driver)
{
	int retval;

	new_driver->driver.name = new_driver->name;
	new_driver->driver.bus = &mdio_bus_type;
	new_driver->driver.probe = phy_probe;
	new_driver->driver.remove = phy_remove;

	retval = driver_register(&new_driver->driver);

	if (retval) {
J
Joe Perches 已提交
1160 1161
		pr_err("%s: Error %d in registering driver\n",
		       new_driver->name, retval);
1162 1163 1164 1165

		return retval;
	}

1166
	pr_debug("%s: Registered new driver\n", new_driver->name);
1167 1168 1169 1170 1171

	return 0;
}
EXPORT_SYMBOL(phy_driver_register);

1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
int phy_drivers_register(struct phy_driver *new_driver, int n)
{
	int i, ret = 0;

	for (i = 0; i < n; i++) {
		ret = phy_driver_register(new_driver + i);
		if (ret) {
			while (i-- > 0)
				phy_driver_unregister(new_driver + i);
			break;
		}
	}
	return ret;
}
EXPORT_SYMBOL(phy_drivers_register);

1188 1189 1190 1191 1192 1193
void phy_driver_unregister(struct phy_driver *drv)
{
	driver_unregister(&drv->driver);
}
EXPORT_SYMBOL(phy_driver_unregister);

1194 1195 1196 1197 1198 1199 1200 1201 1202
void phy_drivers_unregister(struct phy_driver *drv, int n)
{
	int i;
	for (i = 0; i < n; i++) {
		phy_driver_unregister(drv + i);
	}
}
EXPORT_SYMBOL(phy_drivers_unregister);

A
Andy Fleming 已提交
1203 1204 1205 1206 1207 1208 1209 1210
static struct phy_driver genphy_driver = {
	.phy_id		= 0xffffffff,
	.phy_id_mask	= 0xffffffff,
	.name		= "Generic PHY",
	.config_init	= genphy_config_init,
	.features	= 0,
	.config_aneg	= genphy_config_aneg,
	.read_status	= genphy_read_status,
G
Giuseppe Cavallaro 已提交
1211 1212
	.suspend	= genphy_suspend,
	.resume		= genphy_resume,
A
Andy Fleming 已提交
1213 1214
	.driver		= {.owner= THIS_MODULE, },
};
1215

1216
static int __init phy_init(void)
1217
{
1218 1219 1220 1221
	int rc;

	rc = mdio_bus_init();
	if (rc)
A
Andy Fleming 已提交
1222
		return rc;
1223

A
Andy Fleming 已提交
1224 1225 1226
	rc = phy_driver_register(&genphy_driver);
	if (rc)
		mdio_bus_exit();
1227 1228

	return rc;
1229 1230
}

1231
static void __exit phy_exit(void)
1232 1233
{
	phy_driver_unregister(&genphy_driver);
A
Andy Fleming 已提交
1234
	mdio_bus_exit();
1235 1236
}

A
Andy Fleming 已提交
1237
subsys_initcall(phy_init);
1238
module_exit(phy_exit);