Pileus Git - ~andy/linux/blob - drivers/net/phy/phy_device.c

   1 /* Framework for finding and configuring PHYs.
   2  * Also contains generic PHY driver
   3  *
   4  * Author: Andy Fleming
   5  *
   6  * Copyright (c) 2004 Freescale Semiconductor, Inc.
   7  *
   8  * This program is free software; you can redistribute  it and/or modify it
   9  * under  the terms of  the GNU General  Public License as published by the
  10  * Free Software Foundation;  either version 2 of the  License, or (at your
  11  * option) any later version.
  12  *
  13  */
  14
  15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  16
  17 #include <linux/kernel.h>
  18 #include <linux/string.h>
  19 #include <linux/errno.h>
  20 #include <linux/unistd.h>
  21 #include <linux/slab.h>
  22 #include <linux/interrupt.h>
  23 #include <linux/init.h>
  24 #include <linux/delay.h>
  25 #include <linux/netdevice.h>
  26 #include <linux/etherdevice.h>
  27 #include <linux/skbuff.h>
  28 #include <linux/mm.h>
  29 #include <linux/module.h>
  30 #include <linux/mii.h>
  31 #include <linux/ethtool.h>
  32 #include <linux/phy.h>
  33 #include <linux/mdio.h>
  34 #include <linux/io.h>
  35 #include <linux/uaccess.h>
  36
  37 #include <asm/irq.h>
  38
  39 MODULE_DESCRIPTION("PHY library");
  40 MODULE_AUTHOR("Andy Fleming");
  41 MODULE_LICENSE("GPL");
  42
  43 void phy_device_free(struct phy_device *phydev)
  44 {
  45         put_device(&phydev->dev);
  46 }
  47 EXPORT_SYMBOL(phy_device_free);
  48
  49 static void phy_device_release(struct device *dev)
  50 {
  51         kfree(to_phy_device(dev));
  52 }
  53
  54 enum genphy_driver {
  55         GENPHY_DRV_1G,
  56         GENPHY_DRV_10G,
  57         GENPHY_DRV_MAX
  58 };
  59
  60 static struct phy_driver genphy_driver[GENPHY_DRV_MAX];
  61
  62 static LIST_HEAD(phy_fixup_list);
  63 static DEFINE_MUTEX(phy_fixup_lock);
  64
  65 /**
  66  * phy_register_fixup - creates a new phy_fixup and adds it to the list
  67  * @bus_id: A string which matches phydev->dev.bus_id (or PHY_ANY_ID)
  68  * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
  69  *      It can also be PHY_ANY_UID
  70  * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
  71  *      comparison
  72  * @run: The actual code to be run when a matching PHY is found
  73  */
  74 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
  75                        int (*run)(struct phy_device *))
  76 {
  77         struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
  78
  79         if (!fixup)
  80                 return -ENOMEM;
  81
  82         strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
  83         fixup->phy_uid = phy_uid;
  84         fixup->phy_uid_mask = phy_uid_mask;
  85         fixup->run = run;
  86
  87         mutex_lock(&phy_fixup_lock);
  88         list_add_tail(&fixup->list, &phy_fixup_list);
  89         mutex_unlock(&phy_fixup_lock);
  90
  91         return 0;
  92 }
  93 EXPORT_SYMBOL(phy_register_fixup);
  94
  95 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
  96 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
  97                                int (*run)(struct phy_device *))
  98 {
  99         return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
 100 }
 101 EXPORT_SYMBOL(phy_register_fixup_for_uid);
 102
 103 /* Registers a fixup to be run on the PHY with id string bus_id */
 104 int phy_register_fixup_for_id(const char *bus_id,
 105                               int (*run)(struct phy_device *))
 106 {
 107         return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
 108 }
 109 EXPORT_SYMBOL(phy_register_fixup_for_id);
 110
 111 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
 112  * Fixups can be set to match any in one or more fields.
 113  */
 114 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
 115 {
 116         if (strcmp(fixup->bus_id, dev_name(&phydev->dev)) != 0)
 117                 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
 118                         return 0;
 119
 120         if ((fixup->phy_uid & fixup->phy_uid_mask) !=
 121             (phydev->phy_id & fixup->phy_uid_mask))
 122                 if (fixup->phy_uid != PHY_ANY_UID)
 123                         return 0;
 124
 125         return 1;
 126 }
 127
 128 /* Runs any matching fixups for this phydev */
 129 static int phy_scan_fixups(struct phy_device *phydev)
 130 {
 131         struct phy_fixup *fixup;
 132
 133         mutex_lock(&phy_fixup_lock);
 134         list_for_each_entry(fixup, &phy_fixup_list, list) {
 135                 if (phy_needs_fixup(phydev, fixup)) {
 136                         int err = fixup->run(phydev);
 137
 138                         if (err < 0) {
 139                                 mutex_unlock(&phy_fixup_lock);
 140                                 return err;
 141                         }
 142                 }
 143         }
 144         mutex_unlock(&phy_fixup_lock);
 145
 146         return 0;
 147 }
 148
 149 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
 150                                      bool is_c45,
 151                                      struct phy_c45_device_ids *c45_ids)
 152 {
 153         struct phy_device *dev;
 154
 155         /* We allocate the device, and initialize the default values */
 156         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 157         if (NULL == dev)
 158                 return (struct phy_device *)PTR_ERR((void *)-ENOMEM);
 159
 160         dev->dev.release = phy_device_release;
 161
 162         dev->speed = 0;
 163         dev->duplex = -1;
 164         dev->pause = 0;
 165         dev->asym_pause = 0;
 166         dev->link = 1;
 167         dev->interface = PHY_INTERFACE_MODE_GMII;
 168
 169         dev->autoneg = AUTONEG_ENABLE;
 170
 171         dev->is_c45 = is_c45;
 172         dev->addr = addr;
 173         dev->phy_id = phy_id;
 174         if (c45_ids)
 175                 dev->c45_ids = *c45_ids;
 176         dev->bus = bus;
 177         dev->dev.parent = bus->parent;
 178         dev->dev.bus = &mdio_bus_type;
 179         dev->irq = bus->irq != NULL ? bus->irq[addr] : PHY_POLL;
 180         dev_set_name(&dev->dev, PHY_ID_FMT, bus->id, addr);
 181
 182         dev->state = PHY_DOWN;
 183
 184         mutex_init(&dev->lock);
 185         INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
 186         INIT_WORK(&dev->phy_queue, phy_change);
 187
 188         /* Request the appropriate module unconditionally; don't
 189          * bother trying to do so only if it isn't already loaded,
 190          * because that gets complicated. A hotplug event would have
 191          * done an unconditional modprobe anyway.
 192          * We don't do normal hotplug because it won't work for MDIO
 193          * -- because it relies on the device staying around for long
 194          * enough for the driver to get loaded. With MDIO, the NIC
 195          * driver will get bored and give up as soon as it finds that
 196          * there's no driver _already_ loaded.
 197          */
 198         request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT, MDIO_ID_ARGS(phy_id));
 199
 200         device_initialize(&dev->dev);
 201
 202         return dev;
 203 }
 204 EXPORT_SYMBOL(phy_device_create);
 205
 206 /**
 207  * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
 208  * @bus: the target MII bus
 209  * @addr: PHY address on the MII bus
 210  * @phy_id: where to store the ID retrieved.
 211  * @c45_ids: where to store the c45 ID information.
 212  *
 213  *   If the PHY devices-in-package appears to be valid, it and the
 214  *   corresponding identifiers are stored in @c45_ids, zero is stored
 215  *   in @phy_id.  Otherwise 0xffffffff is stored in @phy_id.  Returns
 216  *   zero on success.
 217  *
 218  */
 219 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
 220                            struct phy_c45_device_ids *c45_ids) {
 221         int phy_reg;
 222         int i, reg_addr;
 223         const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
 224
 225         /* Find first non-zero Devices In package.  Device
 226          * zero is reserved, so don't probe it.
 227          */
 228         for (i = 1;
 229              i < num_ids && c45_ids->devices_in_package == 0;
 230              i++) {
 231                 reg_addr = MII_ADDR_C45 | i << 16 | 6;
 232                 phy_reg = mdiobus_read(bus, addr, reg_addr);
 233                 if (phy_reg < 0)
 234                         return -EIO;
 235                 c45_ids->devices_in_package = (phy_reg & 0xffff) << 16;
 236
 237                 reg_addr = MII_ADDR_C45 | i << 16 | 5;
 238                 phy_reg = mdiobus_read(bus, addr, reg_addr);
 239                 if (phy_reg < 0)
 240                         return -EIO;
 241                 c45_ids->devices_in_package |= (phy_reg & 0xffff);
 242
 243                 /* If mostly Fs, there is no device there,
 244                  * let's get out of here.
 245                  */
 246                 if ((c45_ids->devices_in_package & 0x1fffffff) == 0x1fffffff) {
 247                         *phy_id = 0xffffffff;
 248                         return 0;
 249                 }
 250         }
 251
 252         /* Now probe Device Identifiers for each device present. */
 253         for (i = 1; i < num_ids; i++) {
 254                 if (!(c45_ids->devices_in_package & (1 << i)))
 255                         continue;
 256
 257                 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
 258                 phy_reg = mdiobus_read(bus, addr, reg_addr);
 259                 if (phy_reg < 0)
 260                         return -EIO;
 261                 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
 262
 263                 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
 264                 phy_reg = mdiobus_read(bus, addr, reg_addr);
 265                 if (phy_reg < 0)
 266                         return -EIO;
 267                 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
 268         }
 269         *phy_id = 0;
 270         return 0;
 271 }
 272
 273 /**
 274  * get_phy_id - reads the specified addr for its ID.
 275  * @bus: the target MII bus
 276  * @addr: PHY address on the MII bus
 277  * @phy_id: where to store the ID retrieved.
 278  * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
 279  * @c45_ids: where to store the c45 ID information.
 280  *
 281  * Description: In the case of a 802.3-c22 PHY, reads the ID registers
 282  *   of the PHY at @addr on the @bus, stores it in @phy_id and returns
 283  *   zero on success.
 284  *
 285  *   In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
 286  *   its return value is in turn returned.
 287  *
 288  */
 289 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
 290                       bool is_c45, struct phy_c45_device_ids *c45_ids)
 291 {
 292         int phy_reg;
 293
 294         if (is_c45)
 295                 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
 296
 297         /* Grab the bits from PHYIR1, and put them in the upper half */
 298         phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
 299         if (phy_reg < 0)
 300                 return -EIO;
 301
 302         *phy_id = (phy_reg & 0xffff) << 16;
 303
 304         /* Grab the bits from PHYIR2, and put them in the lower half */
 305         phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
 306         if (phy_reg < 0)
 307                 return -EIO;
 308
 309         *phy_id |= (phy_reg & 0xffff);
 310
 311         return 0;
 312 }
 313
 314 /**
 315  * get_phy_device - reads the specified PHY device and returns its @phy_device
 316  *                  struct
 317  * @bus: the target MII bus
 318  * @addr: PHY address on the MII bus
 319  * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
 320  *
 321  * Description: Reads the ID registers of the PHY at @addr on the
 322  *   @bus, then allocates and returns the phy_device to represent it.
 323  */
 324 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
 325 {
 326         struct phy_c45_device_ids c45_ids = {0};
 327         u32 phy_id = 0;
 328         int r;
 329
 330         r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
 331         if (r)
 332                 return ERR_PTR(r);
 333
 334         /* If the phy_id is mostly Fs, there is no device there */
 335         if ((phy_id & 0x1fffffff) == 0x1fffffff)
 336                 return NULL;
 337
 338         return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
 339 }
 340 EXPORT_SYMBOL(get_phy_device);
 341
 342 /**
 343  * phy_device_register - Register the phy device on the MDIO bus
 344  * @phydev: phy_device structure to be added to the MDIO bus
 345  */
 346 int phy_device_register(struct phy_device *phydev)
 347 {
 348         int err;
 349
 350         /* Don't register a phy if one is already registered at this address */
 351         if (phydev->bus->phy_map[phydev->addr])
 352                 return -EINVAL;
 353         phydev->bus->phy_map[phydev->addr] = phydev;
 354
 355         /* Run all of the fixups for this PHY */
 356         err = phy_init_hw(phydev);
 357         if (err) {
 358                 pr_err("PHY %d failed to initialize\n", phydev->addr);
 359                 goto out;
 360         }
 361
 362         err = device_add(&phydev->dev);
 363         if (err) {
 364                 pr_err("PHY %d failed to add\n", phydev->addr);
 365                 goto out;
 366         }
 367
 368         return 0;
 369
 370  out:
 371         phydev->bus->phy_map[phydev->addr] = NULL;
 372         return err;
 373 }
 374 EXPORT_SYMBOL(phy_device_register);
 375
 376 /**
 377  * phy_find_first - finds the first PHY device on the bus
 378  * @bus: the target MII bus
 379  */
 380 struct phy_device *phy_find_first(struct mii_bus *bus)
 381 {
 382         int addr;
 383
 384         for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
 385                 if (bus->phy_map[addr])
 386                         return bus->phy_map[addr];
 387         }
 388         return NULL;
 389 }
 390 EXPORT_SYMBOL(phy_find_first);
 391
 392 /**
 393  * phy_prepare_link - prepares the PHY layer to monitor link status
 394  * @phydev: target phy_device struct
 395  * @handler: callback function for link status change notifications
 396  *
 397  * Description: Tells the PHY infrastructure to handle the
 398  *   gory details on monitoring link status (whether through
 399  *   polling or an interrupt), and to call back to the
 400  *   connected device driver when the link status changes.
 401  *   If you want to monitor your own link state, don't call
 402  *   this function.
 403  */
 404 static void phy_prepare_link(struct phy_device *phydev,
 405                              void (*handler)(struct net_device *))
 406 {
 407         phydev->adjust_link = handler;
 408 }
 409
 410 /**
 411  * phy_connect_direct - connect an ethernet device to a specific phy_device
 412  * @dev: the network device to connect
 413  * @phydev: the pointer to the phy device
 414  * @handler: callback function for state change notifications
 415  * @interface: PHY device's interface
 416  */
 417 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
 418                        void (*handler)(struct net_device *),
 419                        phy_interface_t interface)
 420 {
 421         int rc;
 422
 423         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
 424         if (rc)
 425                 return rc;
 426
 427         phy_prepare_link(phydev, handler);
 428         phy_start_machine(phydev);
 429         if (phydev->irq > 0)
 430                 phy_start_interrupts(phydev);
 431
 432         return 0;
 433 }
 434 EXPORT_SYMBOL(phy_connect_direct);
 435
 436 /**
 437  * phy_connect - connect an ethernet device to a PHY device
 438  * @dev: the network device to connect
 439  * @bus_id: the id string of the PHY device to connect
 440  * @handler: callback function for state change notifications
 441  * @interface: PHY device's interface
 442  *
 443  * Description: Convenience function for connecting ethernet
 444  *   devices to PHY devices.  The default behavior is for
 445  *   the PHY infrastructure to handle everything, and only notify
 446  *   the connected driver when the link status changes.  If you
 447  *   don't want, or can't use the provided functionality, you may
 448  *   choose to call only the subset of functions which provide
 449  *   the desired functionality.
 450  */
 451 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
 452                                void (*handler)(struct net_device *),
 453                                phy_interface_t interface)
 454 {
 455         struct phy_device *phydev;
 456         struct device *d;
 457         int rc;
 458
 459         /* Search the list of PHY devices on the mdio bus for the
 460          * PHY with the requested name
 461          */
 462         d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
 463         if (!d) {
 464                 pr_err("PHY %s not found\n", bus_id);
 465                 return ERR_PTR(-ENODEV);
 466         }
 467         phydev = to_phy_device(d);
 468
 469         rc = phy_connect_direct(dev, phydev, handler, interface);
 470         if (rc)
 471                 return ERR_PTR(rc);
 472
 473         return phydev;
 474 }
 475 EXPORT_SYMBOL(phy_connect);
 476
 477 /**
 478  * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
 479  *                  device
 480  * @phydev: target phy_device struct
 481  */
 482 void phy_disconnect(struct phy_device *phydev)
 483 {
 484         if (phydev->irq > 0)
 485                 phy_stop_interrupts(phydev);
 486
 487         phy_stop_machine(phydev);
 488
 489         phydev->adjust_link = NULL;
 490
 491         phy_detach(phydev);
 492 }
 493 EXPORT_SYMBOL(phy_disconnect);
 494
 495 /**
 496  * phy_poll_reset - Safely wait until a PHY reset has properly completed
 497  * @phydev: The PHY device to poll
 498  *
 499  * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
 500  *   published in 2008, a PHY reset may take up to 0.5 seconds.  The MII BMCR
 501  *   register must be polled until the BMCR_RESET bit clears.
 502  *
 503  *   Furthermore, any attempts to write to PHY registers may have no effect
 504  *   or even generate MDIO bus errors until this is complete.
 505  *
 506  *   Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
 507  *   standard and do not fully reset after the BMCR_RESET bit is set, and may
 508  *   even *REQUIRE* a soft-reset to properly restart autonegotiation.  In an
 509  *   effort to support such broken PHYs, this function is separate from the
 510  *   standard phy_init_hw() which will zero all the other bits in the BMCR
 511  *   and reapply all driver-specific and board-specific fixups.
 512  */
 513 static int phy_poll_reset(struct phy_device *phydev)
 514 {
 515         /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
 516         unsigned int retries = 12;
 517         int ret;
 518
 519         do {
 520                 msleep(50);
 521                 ret = phy_read(phydev, MII_BMCR);
 522                 if (ret < 0)
 523                         return ret;
 524         } while (ret & BMCR_RESET && --retries);
 525         if (ret & BMCR_RESET)
 526                 return -ETIMEDOUT;
 527
 528         /* Some chips (smsc911x) may still need up to another 1ms after the
 529          * BMCR_RESET bit is cleared before they are usable.
 530          */
 531         msleep(1);
 532         return 0;
 533 }
 534
 535 int phy_init_hw(struct phy_device *phydev)
 536 {
 537         int ret;
 538
 539         if (!phydev->drv || !phydev->drv->config_init)
 540                 return 0;
 541
 542         ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
 543         if (ret < 0)
 544                 return ret;
 545
 546         ret = phy_poll_reset(phydev);
 547         if (ret < 0)
 548                 return ret;
 549
 550         ret = phy_scan_fixups(phydev);
 551         if (ret < 0)
 552                 return ret;
 553
 554         return phydev->drv->config_init(phydev);
 555 }
 556 EXPORT_SYMBOL(phy_init_hw);
 557
 558 /**
 559  * phy_attach_direct - attach a network device to a given PHY device pointer
 560  * @dev: network device to attach
 561  * @phydev: Pointer to phy_device to attach
 562  * @flags: PHY device's dev_flags
 563  * @interface: PHY device's interface
 564  *
 565  * Description: Called by drivers to attach to a particular PHY
 566  *     device. The phy_device is found, and properly hooked up
 567  *     to the phy_driver.  If no driver is attached, then a
 568  *     generic driver is used.  The phy_device is given a ptr to
 569  *     the attaching device, and given a callback for link status
 570  *     change.  The phy_device is returned to the attaching driver.
 571  */
 572 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
 573                       u32 flags, phy_interface_t interface)
 574 {
 575         struct device *d = &phydev->dev;
 576         int err;
 577
 578         /* Assume that if there is no driver, that it doesn't
 579          * exist, and we should use the genphy driver.
 580          */
 581         if (NULL == d->driver) {
 582                 if (phydev->is_c45)
 583                         d->driver = &genphy_driver[GENPHY_DRV_10G].driver;
 584                 else
 585                         d->driver = &genphy_driver[GENPHY_DRV_1G].driver;
 586
 587                 err = d->driver->probe(d);
 588                 if (err >= 0)
 589                         err = device_bind_driver(d);
 590
 591                 if (err)
 592                         return err;
 593         }
 594
 595         if (phydev->attached_dev) {
 596                 dev_err(&dev->dev, "PHY already attached\n");
 597                 return -EBUSY;
 598         }
 599
 600         phydev->attached_dev = dev;
 601         dev->phydev = phydev;
 602
 603         phydev->dev_flags = flags;
 604
 605         phydev->interface = interface;
 606
 607         phydev->state = PHY_READY;
 608
 609         /* Do initial configuration here, now that
 610          * we have certain key parameters
 611          * (dev_flags and interface)
 612          */
 613         err = phy_init_hw(phydev);
 614         if (err)
 615                 phy_detach(phydev);
 616
 617         phy_resume(phydev);
 618
 619         return err;
 620 }
 621 EXPORT_SYMBOL(phy_attach_direct);
 622
 623 /**
 624  * phy_attach - attach a network device to a particular PHY device
 625  * @dev: network device to attach
 626  * @bus_id: Bus ID of PHY device to attach
 627  * @interface: PHY device's interface
 628  *
 629  * Description: Same as phy_attach_direct() except that a PHY bus_id
 630  *     string is passed instead of a pointer to a struct phy_device.
 631  */
 632 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
 633                               phy_interface_t interface)
 634 {
 635         struct bus_type *bus = &mdio_bus_type;
 636         struct phy_device *phydev;
 637         struct device *d;
 638         int rc;
 639
 640         /* Search the list of PHY devices on the mdio bus for the
 641          * PHY with the requested name
 642          */
 643         d = bus_find_device_by_name(bus, NULL, bus_id);
 644         if (!d) {
 645                 pr_err("PHY %s not found\n", bus_id);
 646                 return ERR_PTR(-ENODEV);
 647         }
 648         phydev = to_phy_device(d);
 649
 650         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
 651         if (rc)
 652                 return ERR_PTR(rc);
 653
 654         return phydev;
 655 }
 656 EXPORT_SYMBOL(phy_attach);
 657
 658 /**
 659  * phy_detach - detach a PHY device from its network device
 660  * @phydev: target phy_device struct
 661  */
 662 void phy_detach(struct phy_device *phydev)
 663 {
 664         int i;
 665         phydev->attached_dev->phydev = NULL;
 666         phydev->attached_dev = NULL;
 667         phy_suspend(phydev);
 668
 669         /* If the device had no specific driver before (i.e. - it
 670          * was using the generic driver), we unbind the device
 671          * from the generic driver so that there's a chance a
 672          * real driver could be loaded
 673          */
 674         for (i = 0; i < ARRAY_SIZE(genphy_driver); i++) {
 675                 if (phydev->dev.driver == &genphy_driver[i].driver) {
 676                         device_release_driver(&phydev->dev);
 677                         break;
 678                 }
 679         }
 680 }
 681 EXPORT_SYMBOL(phy_detach);
 682
 683 int phy_suspend(struct phy_device *phydev)
 684 {
 685         struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
 686         struct ethtool_wolinfo wol;
 687
 688         /* If the device has WOL enabled, we cannot suspend the PHY */
 689         wol.cmd = ETHTOOL_GWOL;
 690         phy_ethtool_get_wol(phydev, &wol);
 691         if (wol.wolopts)
 692                 return -EBUSY;
 693
 694         if (phydrv->suspend)
 695                 return phydrv->suspend(phydev);
 696         return 0;
 697 }
 698
 699 int phy_resume(struct phy_device *phydev)
 700 {
 701         struct phy_driver *phydrv = to_phy_driver(phydev->dev.driver);
 702
 703         if (phydrv->resume)
 704                 return phydrv->resume(phydev);
 705         return 0;
 706 }
 707
 708 /* Generic PHY support and helper functions */
 709
 710 /**
 711  * genphy_config_advert - sanitize and advertise auto-negotiation parameters
 712  * @phydev: target phy_device struct
 713  *
 714  * Description: Writes MII_ADVERTISE with the appropriate values,
 715  *   after sanitizing the values to make sure we only advertise
 716  *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
 717  *   hasn't changed, and > 0 if it has changed.
 718  */
 719 static int genphy_config_advert(struct phy_device *phydev)
 720 {
 721         u32 advertise;
 722         int oldadv, adv, bmsr;
 723         int err, changed = 0;
 724
 725         /* Only allow advertising what this PHY supports */
 726         phydev->advertising &= phydev->supported;
 727         advertise = phydev->advertising;
 728
 729         /* Setup standard advertisement */
 730         adv = phy_read(phydev, MII_ADVERTISE);
 731         if (adv < 0)
 732                 return adv;
 733
 734         oldadv = 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         if (adv != oldadv) {
 740                 err = phy_write(phydev, MII_ADVERTISE, adv);
 741
 742                 if (err < 0)
 743                         return err;
 744                 changed = 1;
 745         }
 746
 747         bmsr = phy_read(phydev, MII_BMSR);
 748         if (bmsr < 0)
 749                 return bmsr;
 750
 751         /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
 752          * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
 753          * logical 1.
 754          */
 755         if (!(bmsr & BMSR_ESTATEN))
 756                 return changed;
 757
 758         /* Configure gigabit if it's supported */
 759         adv = phy_read(phydev, MII_CTRL1000);
 760         if (adv < 0)
 761                 return adv;
 762
 763         oldadv = adv;
 764         adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
 765
 766         if (phydev->supported & (SUPPORTED_1000baseT_Half |
 767                                  SUPPORTED_1000baseT_Full)) {
 768                 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
 769                 if (adv != oldadv)
 770                         changed = 1;
 771         }
 772
 773         err = phy_write(phydev, MII_CTRL1000, adv);
 774         if (err < 0)
 775                 return err;
 776
 777         return changed;
 778 }
 779
 780 /**
 781  * genphy_setup_forced - configures/forces speed/duplex from @phydev
 782  * @phydev: target phy_device struct
 783  *
 784  * Description: Configures MII_BMCR to force speed/duplex
 785  *   to the values in phydev. Assumes that the values are valid.
 786  *   Please see phy_sanitize_settings().
 787  */
 788 int genphy_setup_forced(struct phy_device *phydev)
 789 {
 790         int ctl = 0;
 791
 792         phydev->pause = 0;
 793         phydev->asym_pause = 0;
 794
 795         if (SPEED_1000 == phydev->speed)
 796                 ctl |= BMCR_SPEED1000;
 797         else if (SPEED_100 == phydev->speed)
 798                 ctl |= BMCR_SPEED100;
 799
 800         if (DUPLEX_FULL == phydev->duplex)
 801                 ctl |= BMCR_FULLDPLX;
 802
 803         return phy_write(phydev, MII_BMCR, ctl);
 804 }
 805 EXPORT_SYMBOL(genphy_setup_forced);
 806
 807 /**
 808  * genphy_restart_aneg - Enable and Restart Autonegotiation
 809  * @phydev: target phy_device struct
 810  */
 811 int genphy_restart_aneg(struct phy_device *phydev)
 812 {
 813         int ctl = phy_read(phydev, MII_BMCR);
 814
 815         if (ctl < 0)
 816                 return ctl;
 817
 818         ctl |= BMCR_ANENABLE | BMCR_ANRESTART;
 819
 820         /* Don't isolate the PHY if we're negotiating */
 821         ctl &= ~BMCR_ISOLATE;
 822
 823         return phy_write(phydev, MII_BMCR, ctl);
 824 }
 825 EXPORT_SYMBOL(genphy_restart_aneg);
 826
 827 /**
 828  * genphy_config_aneg - restart auto-negotiation or write BMCR
 829  * @phydev: target phy_device struct
 830  *
 831  * Description: If auto-negotiation is enabled, we configure the
 832  *   advertising, and then restart auto-negotiation.  If it is not
 833  *   enabled, then we write the BMCR.
 834  */
 835 int genphy_config_aneg(struct phy_device *phydev)
 836 {
 837         int result;
 838
 839         if (AUTONEG_ENABLE != phydev->autoneg)
 840                 return genphy_setup_forced(phydev);
 841
 842         result = genphy_config_advert(phydev);
 843         if (result < 0) /* error */
 844                 return result;
 845         if (result == 0) {
 846                 /* Advertisement hasn't changed, but maybe aneg was never on to
 847                  * begin with?  Or maybe phy was isolated?
 848                  */
 849                 int ctl = phy_read(phydev, MII_BMCR);
 850
 851                 if (ctl < 0)
 852                         return ctl;
 853
 854                 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
 855                         result = 1; /* do restart aneg */
 856         }
 857
 858         /* Only restart aneg if we are advertising something different
 859          * than we were before.
 860          */
 861         if (result > 0)
 862                 result = genphy_restart_aneg(phydev);
 863
 864         return result;
 865 }
 866 EXPORT_SYMBOL(genphy_config_aneg);
 867
 868 static int gen10g_config_aneg(struct phy_device *phydev)
 869 {
 870         return 0;
 871 }
 872
 873 /**
 874  * genphy_update_link - update link status in @phydev
 875  * @phydev: target phy_device struct
 876  *
 877  * Description: Update the value in phydev->link to reflect the
 878  *   current link value.  In order to do this, we need to read
 879  *   the status register twice, keeping the second value.
 880  */
 881 int genphy_update_link(struct phy_device *phydev)
 882 {
 883         int status;
 884
 885         /* Do a fake read */
 886         status = phy_read(phydev, MII_BMSR);
 887         if (status < 0)
 888                 return status;
 889
 890         /* Read link and autonegotiation status */
 891         status = phy_read(phydev, MII_BMSR);
 892         if (status < 0)
 893                 return status;
 894
 895         if ((status & BMSR_LSTATUS) == 0)
 896                 phydev->link = 0;
 897         else
 898                 phydev->link = 1;
 899
 900         return 0;
 901 }
 902 EXPORT_SYMBOL(genphy_update_link);
 903
 904 /**
 905  * genphy_read_status - check the link status and update current link state
 906  * @phydev: target phy_device struct
 907  *
 908  * Description: Check the link, then figure out the current state
 909  *   by comparing what we advertise with what the link partner
 910  *   advertises.  Start by checking the gigabit possibilities,
 911  *   then move on to 10/100.
 912  */
 913 int genphy_read_status(struct phy_device *phydev)
 914 {
 915         int adv;
 916         int err;
 917         int lpa;
 918         int lpagb = 0;
 919
 920         /* Update the link, but return if there was an error */
 921         err = genphy_update_link(phydev);
 922         if (err)
 923                 return err;
 924
 925         phydev->lp_advertising = 0;
 926
 927         if (AUTONEG_ENABLE == phydev->autoneg) {
 928                 if (phydev->supported & (SUPPORTED_1000baseT_Half
 929                                         | SUPPORTED_1000baseT_Full)) {
 930                         lpagb = phy_read(phydev, MII_STAT1000);
 931                         if (lpagb < 0)
 932                                 return lpagb;
 933
 934                         adv = phy_read(phydev, MII_CTRL1000);
 935                         if (adv < 0)
 936                                 return adv;
 937
 938                         phydev->lp_advertising =
 939                                 mii_stat1000_to_ethtool_lpa_t(lpagb);
 940                         lpagb &= adv << 2;
 941                 }
 942
 943                 lpa = phy_read(phydev, MII_LPA);
 944                 if (lpa < 0)
 945                         return lpa;
 946
 947                 phydev->lp_advertising |= mii_lpa_to_ethtool_lpa_t(lpa);
 948
 949                 adv = phy_read(phydev, MII_ADVERTISE);
 950                 if (adv < 0)
 951                         return adv;
 952
 953                 lpa &= adv;
 954
 955                 phydev->speed = SPEED_10;
 956                 phydev->duplex = DUPLEX_HALF;
 957                 phydev->pause = 0;
 958                 phydev->asym_pause = 0;
 959
 960                 if (lpagb & (LPA_1000FULL | LPA_1000HALF)) {
 961                         phydev->speed = SPEED_1000;
 962
 963                         if (lpagb & LPA_1000FULL)
 964                                 phydev->duplex = DUPLEX_FULL;
 965                 } else if (lpa & (LPA_100FULL | LPA_100HALF)) {
 966                         phydev->speed = SPEED_100;
 967
 968                         if (lpa & LPA_100FULL)
 969                                 phydev->duplex = DUPLEX_FULL;
 970                 } else
 971                         if (lpa & LPA_10FULL)
 972                                 phydev->duplex = DUPLEX_FULL;
 973
 974                 if (phydev->duplex == DUPLEX_FULL) {
 975                         phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
 976                         phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
 977                 }
 978         } else {
 979                 int bmcr = phy_read(phydev, MII_BMCR);
 980
 981                 if (bmcr < 0)
 982                         return bmcr;
 983
 984                 if (bmcr & BMCR_FULLDPLX)
 985                         phydev->duplex = DUPLEX_FULL;
 986                 else
 987                         phydev->duplex = DUPLEX_HALF;
 988
 989                 if (bmcr & BMCR_SPEED1000)
 990                         phydev->speed = SPEED_1000;
 991                 else if (bmcr & BMCR_SPEED100)
 992                         phydev->speed = SPEED_100;
 993                 else
 994                         phydev->speed = SPEED_10;
 995
 996                 phydev->pause = 0;
 997                 phydev->asym_pause = 0;
 998         }
 999
1000         return 0;
1001 }
1002 EXPORT_SYMBOL(genphy_read_status);
1003
1004 static int gen10g_read_status(struct phy_device *phydev)
1005 {
1006         int devad, reg;
1007         u32 mmd_mask = phydev->c45_ids.devices_in_package;
1008
1009         phydev->link = 1;
1010
1011         /* For now just lie and say it's 10G all the time */
1012         phydev->speed = SPEED_10000;
1013         phydev->duplex = DUPLEX_FULL;
1014
1015         for (devad = 0; mmd_mask; devad++, mmd_mask = mmd_mask >> 1) {
1016                 if (!(mmd_mask & 1))
1017                         continue;
1018
1019                 /* Read twice because link state is latched and a
1020                  * read moves the current state into the register
1021                  */
1022                 phy_read_mmd(phydev, devad, MDIO_STAT1);
1023                 reg = phy_read_mmd(phydev, devad, MDIO_STAT1);
1024                 if (reg < 0 || !(reg & MDIO_STAT1_LSTATUS))
1025                         phydev->link = 0;
1026         }
1027
1028         return 0;
1029 }
1030
1031 static int genphy_config_init(struct phy_device *phydev)
1032 {
1033         int val;
1034         u32 features;
1035
1036         /* For now, I'll claim that the generic driver supports
1037          * all possible port types
1038          */
1039         features = (SUPPORTED_TP | SUPPORTED_MII
1040                         | SUPPORTED_AUI | SUPPORTED_FIBRE |
1041                         SUPPORTED_BNC);
1042
1043         /* Do we support autonegotiation? */
1044         val = phy_read(phydev, MII_BMSR);
1045         if (val < 0)
1046                 return val;
1047
1048         if (val & BMSR_ANEGCAPABLE)
1049                 features |= SUPPORTED_Autoneg;
1050
1051         if (val & BMSR_100FULL)
1052                 features |= SUPPORTED_100baseT_Full;
1053         if (val & BMSR_100HALF)
1054                 features |= SUPPORTED_100baseT_Half;
1055         if (val & BMSR_10FULL)
1056                 features |= SUPPORTED_10baseT_Full;
1057         if (val & BMSR_10HALF)
1058                 features |= SUPPORTED_10baseT_Half;
1059
1060         if (val & BMSR_ESTATEN) {
1061                 val = phy_read(phydev, MII_ESTATUS);
1062                 if (val < 0)
1063                         return val;
1064
1065                 if (val & ESTATUS_1000_TFULL)
1066                         features |= SUPPORTED_1000baseT_Full;
1067                 if (val & ESTATUS_1000_THALF)
1068                         features |= SUPPORTED_1000baseT_Half;
1069         }
1070
1071         phydev->supported = features;
1072         phydev->advertising = features;
1073
1074         return 0;
1075 }
1076
1077 static int gen10g_config_init(struct phy_device *phydev)
1078 {
1079         /* Temporarily just say we support everything */
1080         phydev->supported = SUPPORTED_10000baseT_Full;
1081         phydev->advertising = SUPPORTED_10000baseT_Full;
1082
1083         return 0;
1084 }
1085
1086 int genphy_suspend(struct phy_device *phydev)
1087 {
1088         int value;
1089
1090         mutex_lock(&phydev->lock);
1091
1092         value = phy_read(phydev, MII_BMCR);
1093         phy_write(phydev, MII_BMCR, value | BMCR_PDOWN);
1094
1095         mutex_unlock(&phydev->lock);
1096
1097         return 0;
1098 }
1099 EXPORT_SYMBOL(genphy_suspend);
1100
1101 static int gen10g_suspend(struct phy_device *phydev)
1102 {
1103         return 0;
1104 }
1105
1106 int genphy_resume(struct phy_device *phydev)
1107 {
1108         int value;
1109
1110         mutex_lock(&phydev->lock);
1111
1112         value = phy_read(phydev, MII_BMCR);
1113         phy_write(phydev, MII_BMCR, value & ~BMCR_PDOWN);
1114
1115         mutex_unlock(&phydev->lock);
1116
1117         return 0;
1118 }
1119 EXPORT_SYMBOL(genphy_resume);
1120
1121 static int gen10g_resume(struct phy_device *phydev)
1122 {
1123         return 0;
1124 }
1125
1126 /**
1127  * phy_probe - probe and init a PHY device
1128  * @dev: device to probe and init
1129  *
1130  * Description: Take care of setting up the phy_device structure,
1131  *   set the state to READY (the driver's init function should
1132  *   set it to STARTING if needed).
1133  */
1134 static int phy_probe(struct device *dev)
1135 {
1136         struct phy_device *phydev = to_phy_device(dev);
1137         struct device_driver *drv = phydev->dev.driver;
1138         struct phy_driver *phydrv = to_phy_driver(drv);
1139         int err = 0;
1140
1141         phydev->drv = phydrv;
1142
1143         /* Disable the interrupt if the PHY doesn't support it
1144          * but the interrupt is still a valid one
1145          */
1146         if (!(phydrv->flags & PHY_HAS_INTERRUPT) &&
1147             phy_interrupt_is_valid(phydev))
1148                 phydev->irq = PHY_POLL;
1149
1150         if (phydrv->flags & PHY_IS_INTERNAL)
1151                 phydev->is_internal = true;
1152
1153         mutex_lock(&phydev->lock);
1154
1155         /* Start out supporting everything. Eventually,
1156          * a controller will attach, and may modify one
1157          * or both of these values
1158          */
1159         phydev->supported = phydrv->features;
1160         phydev->advertising = phydrv->features;
1161
1162         /* Set the state to READY by default */
1163         phydev->state = PHY_READY;
1164
1165         if (phydev->drv->probe)
1166                 err = phydev->drv->probe(phydev);
1167
1168         mutex_unlock(&phydev->lock);
1169
1170         return err;
1171 }
1172
1173 static int phy_remove(struct device *dev)
1174 {
1175         struct phy_device *phydev = to_phy_device(dev);
1176
1177         mutex_lock(&phydev->lock);
1178         phydev->state = PHY_DOWN;
1179         mutex_unlock(&phydev->lock);
1180
1181         if (phydev->drv->remove)
1182                 phydev->drv->remove(phydev);
1183         phydev->drv = NULL;
1184
1185         return 0;
1186 }
1187
1188 /**
1189  * phy_driver_register - register a phy_driver with the PHY layer
1190  * @new_driver: new phy_driver to register
1191  */
1192 int phy_driver_register(struct phy_driver *new_driver)
1193 {
1194         int retval;
1195
1196         new_driver->driver.name = new_driver->name;
1197         new_driver->driver.bus = &mdio_bus_type;
1198         new_driver->driver.probe = phy_probe;
1199         new_driver->driver.remove = phy_remove;
1200
1201         retval = driver_register(&new_driver->driver);
1202         if (retval) {
1203                 pr_err("%s: Error %d in registering driver\n",
1204                        new_driver->name, retval);
1205
1206                 return retval;
1207         }
1208
1209         pr_debug("%s: Registered new driver\n", new_driver->name);
1210
1211         return 0;
1212 }
1213 EXPORT_SYMBOL(phy_driver_register);
1214
1215 int phy_drivers_register(struct phy_driver *new_driver, int n)
1216 {
1217         int i, ret = 0;
1218
1219         for (i = 0; i < n; i++) {
1220                 ret = phy_driver_register(new_driver + i);
1221                 if (ret) {
1222                         while (i-- > 0)
1223                                 phy_driver_unregister(new_driver + i);
1224                         break;
1225                 }
1226         }
1227         return ret;
1228 }
1229 EXPORT_SYMBOL(phy_drivers_register);
1230
1231 void phy_driver_unregister(struct phy_driver *drv)
1232 {
1233         driver_unregister(&drv->driver);
1234 }
1235 EXPORT_SYMBOL(phy_driver_unregister);
1236
1237 void phy_drivers_unregister(struct phy_driver *drv, int n)
1238 {
1239         int i;
1240
1241         for (i = 0; i < n; i++)
1242                 phy_driver_unregister(drv + i);
1243 }
1244 EXPORT_SYMBOL(phy_drivers_unregister);
1245
1246 static struct phy_driver genphy_driver[] = {
1247 {
1248         .phy_id         = 0xffffffff,
1249         .phy_id_mask    = 0xffffffff,
1250         .name           = "Generic PHY",
1251         .config_init    = genphy_config_init,
1252         .features       = 0,
1253         .config_aneg    = genphy_config_aneg,
1254         .read_status    = genphy_read_status,
1255         .suspend        = genphy_suspend,
1256         .resume         = genphy_resume,
1257         .driver         = { .owner = THIS_MODULE, },
1258 }, {
1259         .phy_id         = 0xffffffff,
1260         .phy_id_mask    = 0xffffffff,
1261         .name           = "Generic 10G PHY",
1262         .config_init    = gen10g_config_init,
1263         .features       = 0,
1264         .config_aneg    = gen10g_config_aneg,
1265         .read_status    = gen10g_read_status,
1266         .suspend        = gen10g_suspend,
1267         .resume         = gen10g_resume,
1268         .driver         = {.owner = THIS_MODULE, },
1269 } };
1270
1271 static int __init phy_init(void)
1272 {
1273         int rc;
1274
1275         rc = mdio_bus_init();
1276         if (rc)
1277                 return rc;
1278
1279         rc = phy_drivers_register(genphy_driver,
1280                                   ARRAY_SIZE(genphy_driver));
1281         if (rc)
1282                 mdio_bus_exit();
1283
1284         return rc;
1285 }
1286
1287 static void __exit phy_exit(void)
1288 {
1289         phy_drivers_unregister(genphy_driver,
1290                                ARRAY_SIZE(genphy_driver));
1291         mdio_bus_exit();
1292 }
1293
1294 subsys_initcall(phy_init);
1295 module_exit(phy_exit);