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/bitmap.h>
  33 #include <linux/phy.h>
  34 #include <linux/phy_led_triggers.h>
  35 #include <linux/mdio.h>
  36 #include <linux/io.h>
  37 #include <linux/uaccess.h>
  38 #include <linux/of.h>
  39
  40 #include <asm/irq.h>
  41
  42 MODULE_DESCRIPTION("PHY library");
  43 MODULE_AUTHOR("Andy Fleming");
  44 MODULE_LICENSE("GPL");
  45
  46 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_features) __ro_after_init;
  47 EXPORT_SYMBOL_GPL(phy_basic_features);
  48
  49 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_basic_t1_features) __ro_after_init;
  50 EXPORT_SYMBOL_GPL(phy_basic_t1_features);
  51
  52 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_features) __ro_after_init;
  53 EXPORT_SYMBOL_GPL(phy_gbit_features);
  54
  55 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_fibre_features) __ro_after_init;
  56 EXPORT_SYMBOL_GPL(phy_gbit_fibre_features);
  57
  58 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_gbit_all_ports_features) __ro_after_init;
  59 EXPORT_SYMBOL_GPL(phy_gbit_all_ports_features);
  60
  61 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_features) __ro_after_init;
  62 EXPORT_SYMBOL_GPL(phy_10gbit_features);
  63
  64 static const int phy_basic_ports_array[] = {
  65         ETHTOOL_LINK_MODE_Autoneg_BIT,
  66         ETHTOOL_LINK_MODE_TP_BIT,
  67         ETHTOOL_LINK_MODE_MII_BIT,
  68 };
  69 EXPORT_SYMBOL_GPL(phy_basic_ports_array);
  70
  71 static const int phy_fibre_port_array[] = {
  72         ETHTOOL_LINK_MODE_FIBRE_BIT,
  73 };
  74 EXPORT_SYMBOL_GPL(phy_fibre_port_array);
  75
  76 static const int phy_all_ports_features_array[] = {
  77         ETHTOOL_LINK_MODE_Autoneg_BIT,
  78         ETHTOOL_LINK_MODE_TP_BIT,
  79         ETHTOOL_LINK_MODE_MII_BIT,
  80         ETHTOOL_LINK_MODE_FIBRE_BIT,
  81         ETHTOOL_LINK_MODE_AUI_BIT,
  82         ETHTOOL_LINK_MODE_BNC_BIT,
  83         ETHTOOL_LINK_MODE_Backplane_BIT,
  84 };
  85 EXPORT_SYMBOL_GPL(phy_all_ports_features_array);
  86
  87 const int phy_10_100_features_array[4] = {
  88         ETHTOOL_LINK_MODE_10baseT_Half_BIT,
  89         ETHTOOL_LINK_MODE_10baseT_Full_BIT,
  90         ETHTOOL_LINK_MODE_100baseT_Half_BIT,
  91         ETHTOOL_LINK_MODE_100baseT_Full_BIT,
  92 };
  93 EXPORT_SYMBOL_GPL(phy_10_100_features_array);
  94
  95 const int phy_basic_t1_features_array[2] = {
  96         ETHTOOL_LINK_MODE_TP_BIT,
  97         ETHTOOL_LINK_MODE_100baseT_Full_BIT,
  98 };
  99 EXPORT_SYMBOL_GPL(phy_basic_t1_features_array);
 100
 101 const int phy_gbit_features_array[2] = {
 102         ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
 103         ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
 104 };
 105 EXPORT_SYMBOL_GPL(phy_gbit_features_array);
 106
 107 const int phy_10gbit_features_array[1] = {
 108         ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
 109 };
 110 EXPORT_SYMBOL_GPL(phy_10gbit_features_array);
 111
 112 __ETHTOOL_DECLARE_LINK_MODE_MASK(phy_10gbit_full_features) __ro_after_init;
 113 EXPORT_SYMBOL_GPL(phy_10gbit_full_features);
 114
 115 static const int phy_10gbit_full_features_array[] = {
 116         ETHTOOL_LINK_MODE_10baseT_Full_BIT,
 117         ETHTOOL_LINK_MODE_100baseT_Full_BIT,
 118         ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
 119         ETHTOOL_LINK_MODE_10000baseT_Full_BIT,
 120 };
 121
 122 static void features_init(void)
 123 {
 124         /* 10/100 half/full*/
 125         linkmode_set_bit_array(phy_basic_ports_array,
 126                                ARRAY_SIZE(phy_basic_ports_array),
 127                                phy_basic_features);
 128         linkmode_set_bit_array(phy_10_100_features_array,
 129                                ARRAY_SIZE(phy_10_100_features_array),
 130                                phy_basic_features);
 131
 132         /* 100 full, TP */
 133         linkmode_set_bit_array(phy_basic_t1_features_array,
 134                                ARRAY_SIZE(phy_basic_t1_features_array),
 135                                phy_basic_t1_features);
 136
 137         /* 10/100 half/full + 1000 half/full */
 138         linkmode_set_bit_array(phy_basic_ports_array,
 139                                ARRAY_SIZE(phy_basic_ports_array),
 140                                phy_gbit_features);
 141         linkmode_set_bit_array(phy_10_100_features_array,
 142                                ARRAY_SIZE(phy_10_100_features_array),
 143                                phy_gbit_features);
 144         linkmode_set_bit_array(phy_gbit_features_array,
 145                                ARRAY_SIZE(phy_gbit_features_array),
 146                                phy_gbit_features);
 147
 148         /* 10/100 half/full + 1000 half/full + fibre*/
 149         linkmode_set_bit_array(phy_basic_ports_array,
 150                                ARRAY_SIZE(phy_basic_ports_array),
 151                                phy_gbit_fibre_features);
 152         linkmode_set_bit_array(phy_10_100_features_array,
 153                                ARRAY_SIZE(phy_10_100_features_array),
 154                                phy_gbit_fibre_features);
 155         linkmode_set_bit_array(phy_gbit_features_array,
 156                                ARRAY_SIZE(phy_gbit_features_array),
 157                                phy_gbit_fibre_features);
 158         linkmode_set_bit_array(phy_fibre_port_array,
 159                                ARRAY_SIZE(phy_fibre_port_array),
 160                                phy_gbit_fibre_features);
 161
 162         /* 10/100 half/full + 1000 half/full + TP/MII/FIBRE/AUI/BNC/Backplane*/
 163         linkmode_set_bit_array(phy_all_ports_features_array,
 164                                ARRAY_SIZE(phy_all_ports_features_array),
 165                                phy_gbit_all_ports_features);
 166         linkmode_set_bit_array(phy_10_100_features_array,
 167                                ARRAY_SIZE(phy_10_100_features_array),
 168                                phy_gbit_all_ports_features);
 169         linkmode_set_bit_array(phy_gbit_features_array,
 170                                ARRAY_SIZE(phy_gbit_features_array),
 171                                phy_gbit_all_ports_features);
 172
 173         /* 10/100 half/full + 1000 half/full + 10G full*/
 174         linkmode_set_bit_array(phy_all_ports_features_array,
 175                                ARRAY_SIZE(phy_all_ports_features_array),
 176                                phy_10gbit_features);
 177         linkmode_set_bit_array(phy_10_100_features_array,
 178                                ARRAY_SIZE(phy_10_100_features_array),
 179                                phy_10gbit_features);
 180         linkmode_set_bit_array(phy_gbit_features_array,
 181                                ARRAY_SIZE(phy_gbit_features_array),
 182                                phy_10gbit_features);
 183         linkmode_set_bit_array(phy_10gbit_features_array,
 184                                ARRAY_SIZE(phy_10gbit_features_array),
 185                                phy_10gbit_features);
 186
 187         /* 10/100/1000/10G full */
 188         linkmode_set_bit_array(phy_all_ports_features_array,
 189                                ARRAY_SIZE(phy_all_ports_features_array),
 190                                phy_10gbit_full_features);
 191         linkmode_set_bit_array(phy_10gbit_full_features_array,
 192                                ARRAY_SIZE(phy_10gbit_full_features_array),
 193                                phy_10gbit_full_features);
 194 }
 195
 196 void phy_device_free(struct phy_device *phydev)
 197 {
 198         put_device(&phydev->mdio.dev);
 199 }
 200 EXPORT_SYMBOL(phy_device_free);
 201
 202 static void phy_mdio_device_free(struct mdio_device *mdiodev)
 203 {
 204         struct phy_device *phydev;
 205
 206         phydev = container_of(mdiodev, struct phy_device, mdio);
 207         phy_device_free(phydev);
 208 }
 209
 210 static void phy_device_release(struct device *dev)
 211 {
 212         kfree(to_phy_device(dev));
 213 }
 214
 215 static void phy_mdio_device_remove(struct mdio_device *mdiodev)
 216 {
 217         struct phy_device *phydev;
 218
 219         phydev = container_of(mdiodev, struct phy_device, mdio);
 220         phy_device_remove(phydev);
 221 }
 222
 223 static struct phy_driver genphy_driver;
 224 extern struct phy_driver genphy_10g_driver;
 225
 226 static LIST_HEAD(phy_fixup_list);
 227 static DEFINE_MUTEX(phy_fixup_lock);
 228
 229 #ifdef CONFIG_PM
 230 static bool mdio_bus_phy_may_suspend(struct phy_device *phydev)
 231 {
 232         struct device_driver *drv = phydev->mdio.dev.driver;
 233         struct phy_driver *phydrv = to_phy_driver(drv);
 234         struct net_device *netdev = phydev->attached_dev;
 235
 236         if (!drv || !phydrv->suspend)
 237                 return false;
 238
 239         /* PHY not attached? May suspend if the PHY has not already been
 240          * suspended as part of a prior call to phy_disconnect() ->
 241          * phy_detach() -> phy_suspend() because the parent netdev might be the
 242          * MDIO bus driver and clock gated at this point.
 243          */
 244         if (!netdev)
 245                 return !phydev->suspended;
 246
 247         if (netdev->wol_enabled)
 248                 return false;
 249
 250         /* As long as not all affected network drivers support the
 251          * wol_enabled flag, let's check for hints that WoL is enabled.
 252          * Don't suspend PHY if the attached netdev parent may wake up.
 253          * The parent may point to a PCI device, as in tg3 driver.
 254          */
 255         if (netdev->dev.parent && device_may_wakeup(netdev->dev.parent))
 256                 return false;
 257
 258         /* Also don't suspend PHY if the netdev itself may wakeup. This
 259          * is the case for devices w/o underlaying pwr. mgmt. aware bus,
 260          * e.g. SoC devices.
 261          */
 262         if (device_may_wakeup(&netdev->dev))
 263                 return false;
 264
 265         return true;
 266 }
 267
 268 static int mdio_bus_phy_suspend(struct device *dev)
 269 {
 270         struct phy_device *phydev = to_phy_device(dev);
 271
 272         /* We must stop the state machine manually, otherwise it stops out of
 273          * control, possibly with the phydev->lock held. Upon resume, netdev
 274          * may call phy routines that try to grab the same lock, and that may
 275          * lead to a deadlock.
 276          */
 277         if (phydev->attached_dev && phydev->adjust_link)
 278                 phy_stop_machine(phydev);
 279
 280         if (!mdio_bus_phy_may_suspend(phydev))
 281                 return 0;
 282
 283         return phy_suspend(phydev);
 284 }
 285
 286 static int mdio_bus_phy_resume(struct device *dev)
 287 {
 288         struct phy_device *phydev = to_phy_device(dev);
 289         int ret;
 290
 291         if (!mdio_bus_phy_may_suspend(phydev))
 292                 goto no_resume;
 293
 294         ret = phy_resume(phydev);
 295         if (ret < 0)
 296                 return ret;
 297
 298 no_resume:
 299         if (phydev->attached_dev && phydev->adjust_link)
 300                 phy_start_machine(phydev);
 301
 302         return 0;
 303 }
 304
 305 static int mdio_bus_phy_restore(struct device *dev)
 306 {
 307         struct phy_device *phydev = to_phy_device(dev);
 308         struct net_device *netdev = phydev->attached_dev;
 309         int ret;
 310
 311         if (!netdev)
 312                 return 0;
 313
 314         ret = phy_init_hw(phydev);
 315         if (ret < 0)
 316                 return ret;
 317
 318         /* The PHY needs to renegotiate. */
 319         phydev->link = 0;
 320         phydev->state = PHY_UP;
 321
 322         phy_start_machine(phydev);
 323
 324         return 0;
 325 }
 326
 327 static const struct dev_pm_ops mdio_bus_phy_pm_ops = {
 328         .suspend = mdio_bus_phy_suspend,
 329         .resume = mdio_bus_phy_resume,
 330         .freeze = mdio_bus_phy_suspend,
 331         .thaw = mdio_bus_phy_resume,
 332         .restore = mdio_bus_phy_restore,
 333 };
 334
 335 #define MDIO_BUS_PHY_PM_OPS (&mdio_bus_phy_pm_ops)
 336
 337 #else
 338
 339 #define MDIO_BUS_PHY_PM_OPS NULL
 340
 341 #endif /* CONFIG_PM */
 342
 343 /**
 344  * phy_register_fixup - creates a new phy_fixup and adds it to the list
 345  * @bus_id: A string which matches phydev->mdio.dev.bus_id (or PHY_ANY_ID)
 346  * @phy_uid: Used to match against phydev->phy_id (the UID of the PHY)
 347  *      It can also be PHY_ANY_UID
 348  * @phy_uid_mask: Applied to phydev->phy_id and fixup->phy_uid before
 349  *      comparison
 350  * @run: The actual code to be run when a matching PHY is found
 351  */
 352 int phy_register_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask,
 353                        int (*run)(struct phy_device *))
 354 {
 355         struct phy_fixup *fixup = kzalloc(sizeof(*fixup), GFP_KERNEL);
 356
 357         if (!fixup)
 358                 return -ENOMEM;
 359
 360         strlcpy(fixup->bus_id, bus_id, sizeof(fixup->bus_id));
 361         fixup->phy_uid = phy_uid;
 362         fixup->phy_uid_mask = phy_uid_mask;
 363         fixup->run = run;
 364
 365         mutex_lock(&phy_fixup_lock);
 366         list_add_tail(&fixup->list, &phy_fixup_list);
 367         mutex_unlock(&phy_fixup_lock);
 368
 369         return 0;
 370 }
 371 EXPORT_SYMBOL(phy_register_fixup);
 372
 373 /* Registers a fixup to be run on any PHY with the UID in phy_uid */
 374 int phy_register_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask,
 375                                int (*run)(struct phy_device *))
 376 {
 377         return phy_register_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask, run);
 378 }
 379 EXPORT_SYMBOL(phy_register_fixup_for_uid);
 380
 381 /* Registers a fixup to be run on the PHY with id string bus_id */
 382 int phy_register_fixup_for_id(const char *bus_id,
 383                               int (*run)(struct phy_device *))
 384 {
 385         return phy_register_fixup(bus_id, PHY_ANY_UID, 0xffffffff, run);
 386 }
 387 EXPORT_SYMBOL(phy_register_fixup_for_id);
 388
 389 /**
 390  * phy_unregister_fixup - remove a phy_fixup from the list
 391  * @bus_id: A string matches fixup->bus_id (or PHY_ANY_ID) in phy_fixup_list
 392  * @phy_uid: A phy id matches fixup->phy_id (or PHY_ANY_UID) in phy_fixup_list
 393  * @phy_uid_mask: Applied to phy_uid and fixup->phy_uid before comparison
 394  */
 395 int phy_unregister_fixup(const char *bus_id, u32 phy_uid, u32 phy_uid_mask)
 396 {
 397         struct list_head *pos, *n;
 398         struct phy_fixup *fixup;
 399         int ret;
 400
 401         ret = -ENODEV;
 402
 403         mutex_lock(&phy_fixup_lock);
 404         list_for_each_safe(pos, n, &phy_fixup_list) {
 405                 fixup = list_entry(pos, struct phy_fixup, list);
 406
 407                 if ((!strcmp(fixup->bus_id, bus_id)) &&
 408                     ((fixup->phy_uid & phy_uid_mask) ==
 409                      (phy_uid & phy_uid_mask))) {
 410                         list_del(&fixup->list);
 411                         kfree(fixup);
 412                         ret = 0;
 413                         break;
 414                 }
 415         }
 416         mutex_unlock(&phy_fixup_lock);
 417
 418         return ret;
 419 }
 420 EXPORT_SYMBOL(phy_unregister_fixup);
 421
 422 /* Unregisters a fixup of any PHY with the UID in phy_uid */
 423 int phy_unregister_fixup_for_uid(u32 phy_uid, u32 phy_uid_mask)
 424 {
 425         return phy_unregister_fixup(PHY_ANY_ID, phy_uid, phy_uid_mask);
 426 }
 427 EXPORT_SYMBOL(phy_unregister_fixup_for_uid);
 428
 429 /* Unregisters a fixup of the PHY with id string bus_id */
 430 int phy_unregister_fixup_for_id(const char *bus_id)
 431 {
 432         return phy_unregister_fixup(bus_id, PHY_ANY_UID, 0xffffffff);
 433 }
 434 EXPORT_SYMBOL(phy_unregister_fixup_for_id);
 435
 436 /* Returns 1 if fixup matches phydev in bus_id and phy_uid.
 437  * Fixups can be set to match any in one or more fields.
 438  */
 439 static int phy_needs_fixup(struct phy_device *phydev, struct phy_fixup *fixup)
 440 {
 441         if (strcmp(fixup->bus_id, phydev_name(phydev)) != 0)
 442                 if (strcmp(fixup->bus_id, PHY_ANY_ID) != 0)
 443                         return 0;
 444
 445         if ((fixup->phy_uid & fixup->phy_uid_mask) !=
 446             (phydev->phy_id & fixup->phy_uid_mask))
 447                 if (fixup->phy_uid != PHY_ANY_UID)
 448                         return 0;
 449
 450         return 1;
 451 }
 452
 453 /* Runs any matching fixups for this phydev */
 454 static int phy_scan_fixups(struct phy_device *phydev)
 455 {
 456         struct phy_fixup *fixup;
 457
 458         mutex_lock(&phy_fixup_lock);
 459         list_for_each_entry(fixup, &phy_fixup_list, list) {
 460                 if (phy_needs_fixup(phydev, fixup)) {
 461                         int err = fixup->run(phydev);
 462
 463                         if (err < 0) {
 464                                 mutex_unlock(&phy_fixup_lock);
 465                                 return err;
 466                         }
 467                         phydev->has_fixups = true;
 468                 }
 469         }
 470         mutex_unlock(&phy_fixup_lock);
 471
 472         return 0;
 473 }
 474
 475 static int phy_bus_match(struct device *dev, struct device_driver *drv)
 476 {
 477         struct phy_device *phydev = to_phy_device(dev);
 478         struct phy_driver *phydrv = to_phy_driver(drv);
 479         const int num_ids = ARRAY_SIZE(phydev->c45_ids.device_ids);
 480         int i;
 481
 482         if (!(phydrv->mdiodrv.flags & MDIO_DEVICE_IS_PHY))
 483                 return 0;
 484
 485         if (phydrv->match_phy_device)
 486                 return phydrv->match_phy_device(phydev);
 487
 488         if (phydev->is_c45) {
 489                 for (i = 1; i < num_ids; i++) {
 490                         if (!(phydev->c45_ids.devices_in_package & (1 << i)))
 491                                 continue;
 492
 493                         if ((phydrv->phy_id & phydrv->phy_id_mask) ==
 494                             (phydev->c45_ids.device_ids[i] &
 495                              phydrv->phy_id_mask))
 496                                 return 1;
 497                 }
 498                 return 0;
 499         } else {
 500                 return (phydrv->phy_id & phydrv->phy_id_mask) ==
 501                         (phydev->phy_id & phydrv->phy_id_mask);
 502         }
 503 }
 504
 505 static ssize_t
 506 phy_id_show(struct device *dev, struct device_attribute *attr, char *buf)
 507 {
 508         struct phy_device *phydev = to_phy_device(dev);
 509
 510         return sprintf(buf, "0x%.8lx\n", (unsigned long)phydev->phy_id);
 511 }
 512 static DEVICE_ATTR_RO(phy_id);
 513
 514 static ssize_t
 515 phy_interface_show(struct device *dev, struct device_attribute *attr, char *buf)
 516 {
 517         struct phy_device *phydev = to_phy_device(dev);
 518         const char *mode = NULL;
 519
 520         if (phy_is_internal(phydev))
 521                 mode = "internal";
 522         else
 523                 mode = phy_modes(phydev->interface);
 524
 525         return sprintf(buf, "%s\n", mode);
 526 }
 527 static DEVICE_ATTR_RO(phy_interface);
 528
 529 static ssize_t
 530 phy_has_fixups_show(struct device *dev, struct device_attribute *attr,
 531                     char *buf)
 532 {
 533         struct phy_device *phydev = to_phy_device(dev);
 534
 535         return sprintf(buf, "%d\n", phydev->has_fixups);
 536 }
 537 static DEVICE_ATTR_RO(phy_has_fixups);
 538
 539 static struct attribute *phy_dev_attrs[] = {
 540         &dev_attr_phy_id.attr,
 541         &dev_attr_phy_interface.attr,
 542         &dev_attr_phy_has_fixups.attr,
 543         NULL,
 544 };
 545 ATTRIBUTE_GROUPS(phy_dev);
 546
 547 static const struct device_type mdio_bus_phy_type = {
 548         .name = "PHY",
 549         .groups = phy_dev_groups,
 550         .release = phy_device_release,
 551         .pm = MDIO_BUS_PHY_PM_OPS,
 552 };
 553
 554 struct phy_device *phy_device_create(struct mii_bus *bus, int addr, int phy_id,
 555                                      bool is_c45,
 556                                      struct phy_c45_device_ids *c45_ids)
 557 {
 558         struct phy_device *dev;
 559         struct mdio_device *mdiodev;
 560
 561         /* We allocate the device, and initialize the default values */
 562         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
 563         if (!dev)
 564                 return ERR_PTR(-ENOMEM);
 565
 566         mdiodev = &dev->mdio;
 567         mdiodev->dev.parent = &bus->dev;
 568         mdiodev->dev.bus = &mdio_bus_type;
 569         mdiodev->dev.type = &mdio_bus_phy_type;
 570         mdiodev->bus = bus;
 571         mdiodev->bus_match = phy_bus_match;
 572         mdiodev->addr = addr;
 573         mdiodev->flags = MDIO_DEVICE_FLAG_PHY;
 574         mdiodev->device_free = phy_mdio_device_free;
 575         mdiodev->device_remove = phy_mdio_device_remove;
 576
 577         dev->speed = 0;
 578         dev->duplex = -1;
 579         dev->pause = 0;
 580         dev->asym_pause = 0;
 581         dev->link = 0;
 582         dev->interface = PHY_INTERFACE_MODE_GMII;
 583
 584         dev->autoneg = AUTONEG_ENABLE;
 585
 586         dev->is_c45 = is_c45;
 587         dev->phy_id = phy_id;
 588         if (c45_ids)
 589                 dev->c45_ids = *c45_ids;
 590         dev->irq = bus->irq[addr];
 591         dev_set_name(&mdiodev->dev, PHY_ID_FMT, bus->id, addr);
 592
 593         dev->state = PHY_DOWN;
 594
 595         mutex_init(&dev->lock);
 596         INIT_DELAYED_WORK(&dev->state_queue, phy_state_machine);
 597
 598         /* Request the appropriate module unconditionally; don't
 599          * bother trying to do so only if it isn't already loaded,
 600          * because that gets complicated. A hotplug event would have
 601          * done an unconditional modprobe anyway.
 602          * We don't do normal hotplug because it won't work for MDIO
 603          * -- because it relies on the device staying around for long
 604          * enough for the driver to get loaded. With MDIO, the NIC
 605          * driver will get bored and give up as soon as it finds that
 606          * there's no driver _already_ loaded.
 607          */
 608         if (is_c45 && c45_ids) {
 609                 const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
 610                 int i;
 611
 612                 for (i = 1; i < num_ids; i++) {
 613                         if (!(c45_ids->devices_in_package & (1 << i)))
 614                                 continue;
 615
 616                         request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
 617                                        MDIO_ID_ARGS(c45_ids->device_ids[i]));
 618                 }
 619         } else {
 620                 request_module(MDIO_MODULE_PREFIX MDIO_ID_FMT,
 621                                MDIO_ID_ARGS(phy_id));
 622         }
 623
 624         device_initialize(&mdiodev->dev);
 625
 626         return dev;
 627 }
 628 EXPORT_SYMBOL(phy_device_create);
 629
 630 /* get_phy_c45_devs_in_pkg - reads a MMD's devices in package registers.
 631  * @bus: the target MII bus
 632  * @addr: PHY address on the MII bus
 633  * @dev_addr: MMD address in the PHY.
 634  * @devices_in_package: where to store the devices in package information.
 635  *
 636  * Description: reads devices in package registers of a MMD at @dev_addr
 637  * from PHY at @addr on @bus.
 638  *
 639  * Returns: 0 on success, -EIO on failure.
 640  */
 641 static int get_phy_c45_devs_in_pkg(struct mii_bus *bus, int addr, int dev_addr,
 642                                    u32 *devices_in_package)
 643 {
 644         int phy_reg, reg_addr;
 645
 646         reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS2;
 647         phy_reg = mdiobus_read(bus, addr, reg_addr);
 648         if (phy_reg < 0)
 649                 return -EIO;
 650         *devices_in_package = (phy_reg & 0xffff) << 16;
 651
 652         reg_addr = MII_ADDR_C45 | dev_addr << 16 | MDIO_DEVS1;
 653         phy_reg = mdiobus_read(bus, addr, reg_addr);
 654         if (phy_reg < 0)
 655                 return -EIO;
 656         *devices_in_package |= (phy_reg & 0xffff);
 657
 658         return 0;
 659 }
 660
 661 /**
 662  * get_phy_c45_ids - reads the specified addr for its 802.3-c45 IDs.
 663  * @bus: the target MII bus
 664  * @addr: PHY address on the MII bus
 665  * @phy_id: where to store the ID retrieved.
 666  * @c45_ids: where to store the c45 ID information.
 667  *
 668  *   If the PHY devices-in-package appears to be valid, it and the
 669  *   corresponding identifiers are stored in @c45_ids, zero is stored
 670  *   in @phy_id.  Otherwise 0xffffffff is stored in @phy_id.  Returns
 671  *   zero on success.
 672  *
 673  */
 674 static int get_phy_c45_ids(struct mii_bus *bus, int addr, u32 *phy_id,
 675                            struct phy_c45_device_ids *c45_ids) {
 676         int phy_reg;
 677         int i, reg_addr;
 678         const int num_ids = ARRAY_SIZE(c45_ids->device_ids);
 679         u32 *devs = &c45_ids->devices_in_package;
 680
 681         /* Find first non-zero Devices In package. Device zero is reserved
 682          * for 802.3 c45 complied PHYs, so don't probe it at first.
 683          */
 684         for (i = 1; i < num_ids && *devs == 0; i++) {
 685                 phy_reg = get_phy_c45_devs_in_pkg(bus, addr, i, devs);
 686                 if (phy_reg < 0)
 687                         return -EIO;
 688
 689                 if ((*devs & 0x1fffffff) == 0x1fffffff) {
 690                         /*  If mostly Fs, there is no device there,
 691                          *  then let's continue to probe more, as some
 692                          *  10G PHYs have zero Devices In package,
 693                          *  e.g. Cortina CS4315/CS4340 PHY.
 694                          */
 695                         phy_reg = get_phy_c45_devs_in_pkg(bus, addr, 0, devs);
 696                         if (phy_reg < 0)
 697                                 return -EIO;
 698                         /* no device there, let's get out of here */
 699                         if ((*devs & 0x1fffffff) == 0x1fffffff) {
 700                                 *phy_id = 0xffffffff;
 701                                 return 0;
 702                         } else {
 703                                 break;
 704                         }
 705                 }
 706         }
 707
 708         /* Now probe Device Identifiers for each device present. */
 709         for (i = 1; i < num_ids; i++) {
 710                 if (!(c45_ids->devices_in_package & (1 << i)))
 711                         continue;
 712
 713                 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID1;
 714                 phy_reg = mdiobus_read(bus, addr, reg_addr);
 715                 if (phy_reg < 0)
 716                         return -EIO;
 717                 c45_ids->device_ids[i] = (phy_reg & 0xffff) << 16;
 718
 719                 reg_addr = MII_ADDR_C45 | i << 16 | MII_PHYSID2;
 720                 phy_reg = mdiobus_read(bus, addr, reg_addr);
 721                 if (phy_reg < 0)
 722                         return -EIO;
 723                 c45_ids->device_ids[i] |= (phy_reg & 0xffff);
 724         }
 725         *phy_id = 0;
 726         return 0;
 727 }
 728
 729 /**
 730  * get_phy_id - reads the specified addr for its ID.
 731  * @bus: the target MII bus
 732  * @addr: PHY address on the MII bus
 733  * @phy_id: where to store the ID retrieved.
 734  * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
 735  * @c45_ids: where to store the c45 ID information.
 736  *
 737  * Description: In the case of a 802.3-c22 PHY, reads the ID registers
 738  *   of the PHY at @addr on the @bus, stores it in @phy_id and returns
 739  *   zero on success.
 740  *
 741  *   In the case of a 802.3-c45 PHY, get_phy_c45_ids() is invoked, and
 742  *   its return value is in turn returned.
 743  *
 744  */
 745 static int get_phy_id(struct mii_bus *bus, int addr, u32 *phy_id,
 746                       bool is_c45, struct phy_c45_device_ids *c45_ids)
 747 {
 748         int phy_reg;
 749
 750         if (is_c45)
 751                 return get_phy_c45_ids(bus, addr, phy_id, c45_ids);
 752
 753         /* Grab the bits from PHYIR1, and put them in the upper half */
 754         phy_reg = mdiobus_read(bus, addr, MII_PHYSID1);
 755         if (phy_reg < 0) {
 756                 /* if there is no device, return without an error so scanning
 757                  * the bus works properly
 758                  */
 759                 if (phy_reg == -EIO || phy_reg == -ENODEV) {
 760                         *phy_id = 0xffffffff;
 761                         return 0;
 762                 }
 763
 764                 return -EIO;
 765         }
 766
 767         *phy_id = (phy_reg & 0xffff) << 16;
 768
 769         /* Grab the bits from PHYIR2, and put them in the lower half */
 770         phy_reg = mdiobus_read(bus, addr, MII_PHYSID2);
 771         if (phy_reg < 0)
 772                 return -EIO;
 773
 774         *phy_id |= (phy_reg & 0xffff);
 775
 776         return 0;
 777 }
 778
 779 /**
 780  * get_phy_device - reads the specified PHY device and returns its @phy_device
 781  *                  struct
 782  * @bus: the target MII bus
 783  * @addr: PHY address on the MII bus
 784  * @is_c45: If true the PHY uses the 802.3 clause 45 protocol
 785  *
 786  * Description: Reads the ID registers of the PHY at @addr on the
 787  *   @bus, then allocates and returns the phy_device to represent it.
 788  */
 789 struct phy_device *get_phy_device(struct mii_bus *bus, int addr, bool is_c45)
 790 {
 791         struct phy_c45_device_ids c45_ids = {0};
 792         u32 phy_id = 0;
 793         int r;
 794
 795         r = get_phy_id(bus, addr, &phy_id, is_c45, &c45_ids);
 796         if (r)
 797                 return ERR_PTR(r);
 798
 799         /* If the phy_id is mostly Fs, there is no device there */
 800         if ((phy_id & 0x1fffffff) == 0x1fffffff)
 801                 return ERR_PTR(-ENODEV);
 802
 803         return phy_device_create(bus, addr, phy_id, is_c45, &c45_ids);
 804 }
 805 EXPORT_SYMBOL(get_phy_device);
 806
 807 /**
 808  * phy_device_register - Register the phy device on the MDIO bus
 809  * @phydev: phy_device structure to be added to the MDIO bus
 810  */
 811 int phy_device_register(struct phy_device *phydev)
 812 {
 813         int err;
 814
 815         err = mdiobus_register_device(&phydev->mdio);
 816         if (err)
 817                 return err;
 818
 819         /* Deassert the reset signal */
 820         phy_device_reset(phydev, 0);
 821
 822         /* Run all of the fixups for this PHY */
 823         err = phy_scan_fixups(phydev);
 824         if (err) {
 825                 pr_err("PHY %d failed to initialize\n", phydev->mdio.addr);
 826                 goto out;
 827         }
 828
 829         err = device_add(&phydev->mdio.dev);
 830         if (err) {
 831                 pr_err("PHY %d failed to add\n", phydev->mdio.addr);
 832                 goto out;
 833         }
 834
 835         return 0;
 836
 837  out:
 838         /* Assert the reset signal */
 839         phy_device_reset(phydev, 1);
 840
 841         mdiobus_unregister_device(&phydev->mdio);
 842         return err;
 843 }
 844 EXPORT_SYMBOL(phy_device_register);
 845
 846 /**
 847  * phy_device_remove - Remove a previously registered phy device from the MDIO bus
 848  * @phydev: phy_device structure to remove
 849  *
 850  * This doesn't free the phy_device itself, it merely reverses the effects
 851  * of phy_device_register(). Use phy_device_free() to free the device
 852  * after calling this function.
 853  */
 854 void phy_device_remove(struct phy_device *phydev)
 855 {
 856         device_del(&phydev->mdio.dev);
 857
 858         /* Assert the reset signal */
 859         phy_device_reset(phydev, 1);
 860
 861         mdiobus_unregister_device(&phydev->mdio);
 862 }
 863 EXPORT_SYMBOL(phy_device_remove);
 864
 865 /**
 866  * phy_find_first - finds the first PHY device on the bus
 867  * @bus: the target MII bus
 868  */
 869 struct phy_device *phy_find_first(struct mii_bus *bus)
 870 {
 871         struct phy_device *phydev;
 872         int addr;
 873
 874         for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
 875                 phydev = mdiobus_get_phy(bus, addr);
 876                 if (phydev)
 877                         return phydev;
 878         }
 879         return NULL;
 880 }
 881 EXPORT_SYMBOL(phy_find_first);
 882
 883 static void phy_link_change(struct phy_device *phydev, bool up, bool do_carrier)
 884 {
 885         struct net_device *netdev = phydev->attached_dev;
 886
 887         if (do_carrier) {
 888                 if (up)
 889                         netif_carrier_on(netdev);
 890                 else
 891                         netif_carrier_off(netdev);
 892         }
 893         phydev->adjust_link(netdev);
 894 }
 895
 896 /**
 897  * phy_prepare_link - prepares the PHY layer to monitor link status
 898  * @phydev: target phy_device struct
 899  * @handler: callback function for link status change notifications
 900  *
 901  * Description: Tells the PHY infrastructure to handle the
 902  *   gory details on monitoring link status (whether through
 903  *   polling or an interrupt), and to call back to the
 904  *   connected device driver when the link status changes.
 905  *   If you want to monitor your own link state, don't call
 906  *   this function.
 907  */
 908 static void phy_prepare_link(struct phy_device *phydev,
 909                              void (*handler)(struct net_device *))
 910 {
 911         phydev->adjust_link = handler;
 912 }
 913
 914 /**
 915  * phy_connect_direct - connect an ethernet device to a specific phy_device
 916  * @dev: the network device to connect
 917  * @phydev: the pointer to the phy device
 918  * @handler: callback function for state change notifications
 919  * @interface: PHY device's interface
 920  */
 921 int phy_connect_direct(struct net_device *dev, struct phy_device *phydev,
 922                        void (*handler)(struct net_device *),
 923                        phy_interface_t interface)
 924 {
 925         int rc;
 926
 927         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
 928         if (rc)
 929                 return rc;
 930
 931         phy_prepare_link(phydev, handler);
 932         phy_start_machine(phydev);
 933         if (phydev->irq > 0)
 934                 phy_start_interrupts(phydev);
 935
 936         return 0;
 937 }
 938 EXPORT_SYMBOL(phy_connect_direct);
 939
 940 /**
 941  * phy_connect - connect an ethernet device to a PHY device
 942  * @dev: the network device to connect
 943  * @bus_id: the id string of the PHY device to connect
 944  * @handler: callback function for state change notifications
 945  * @interface: PHY device's interface
 946  *
 947  * Description: Convenience function for connecting ethernet
 948  *   devices to PHY devices.  The default behavior is for
 949  *   the PHY infrastructure to handle everything, and only notify
 950  *   the connected driver when the link status changes.  If you
 951  *   don't want, or can't use the provided functionality, you may
 952  *   choose to call only the subset of functions which provide
 953  *   the desired functionality.
 954  */
 955 struct phy_device *phy_connect(struct net_device *dev, const char *bus_id,
 956                                void (*handler)(struct net_device *),
 957                                phy_interface_t interface)
 958 {
 959         struct phy_device *phydev;
 960         struct device *d;
 961         int rc;
 962
 963         /* Search the list of PHY devices on the mdio bus for the
 964          * PHY with the requested name
 965          */
 966         d = bus_find_device_by_name(&mdio_bus_type, NULL, bus_id);
 967         if (!d) {
 968                 pr_err("PHY %s not found\n", bus_id);
 969                 return ERR_PTR(-ENODEV);
 970         }
 971         phydev = to_phy_device(d);
 972
 973         rc = phy_connect_direct(dev, phydev, handler, interface);
 974         put_device(d);
 975         if (rc)
 976                 return ERR_PTR(rc);
 977
 978         return phydev;
 979 }
 980 EXPORT_SYMBOL(phy_connect);
 981
 982 /**
 983  * phy_disconnect - disable interrupts, stop state machine, and detach a PHY
 984  *                  device
 985  * @phydev: target phy_device struct
 986  */
 987 void phy_disconnect(struct phy_device *phydev)
 988 {
 989         if (phydev->irq > 0)
 990                 phy_stop_interrupts(phydev);
 991
 992         phy_stop_machine(phydev);
 993
 994         phydev->adjust_link = NULL;
 995
 996         phy_detach(phydev);
 997 }
 998 EXPORT_SYMBOL(phy_disconnect);
 999
1000 /**
1001  * phy_poll_reset - Safely wait until a PHY reset has properly completed
1002  * @phydev: The PHY device to poll
1003  *
1004  * Description: According to IEEE 802.3, Section 2, Subsection 22.2.4.1.1, as
1005  *   published in 2008, a PHY reset may take up to 0.5 seconds.  The MII BMCR
1006  *   register must be polled until the BMCR_RESET bit clears.
1007  *
1008  *   Furthermore, any attempts to write to PHY registers may have no effect
1009  *   or even generate MDIO bus errors until this is complete.
1010  *
1011  *   Some PHYs (such as the Marvell 88E1111) don't entirely conform to the
1012  *   standard and do not fully reset after the BMCR_RESET bit is set, and may
1013  *   even *REQUIRE* a soft-reset to properly restart autonegotiation.  In an
1014  *   effort to support such broken PHYs, this function is separate from the
1015  *   standard phy_init_hw() which will zero all the other bits in the BMCR
1016  *   and reapply all driver-specific and board-specific fixups.
1017  */
1018 static int phy_poll_reset(struct phy_device *phydev)
1019 {
1020         /* Poll until the reset bit clears (50ms per retry == 0.6 sec) */
1021         unsigned int retries = 12;
1022         int ret;
1023
1024         do {
1025                 msleep(50);
1026                 ret = phy_read(phydev, MII_BMCR);
1027                 if (ret < 0)
1028                         return ret;
1029         } while (ret & BMCR_RESET && --retries);
1030         if (ret & BMCR_RESET)
1031                 return -ETIMEDOUT;
1032
1033         /* Some chips (smsc911x) may still need up to another 1ms after the
1034          * BMCR_RESET bit is cleared before they are usable.
1035          */
1036         msleep(1);
1037         return 0;
1038 }
1039
1040 int phy_init_hw(struct phy_device *phydev)
1041 {
1042         int ret = 0;
1043
1044         /* Deassert the reset signal */
1045         phy_device_reset(phydev, 0);
1046
1047         if (!phydev->drv || !phydev->drv->config_init)
1048                 return 0;
1049
1050         if (phydev->drv->soft_reset)
1051                 ret = phydev->drv->soft_reset(phydev);
1052
1053         if (ret < 0)
1054                 return ret;
1055
1056         ret = phy_scan_fixups(phydev);
1057         if (ret < 0)
1058                 return ret;
1059
1060         return phydev->drv->config_init(phydev);
1061 }
1062 EXPORT_SYMBOL(phy_init_hw);
1063
1064 void phy_attached_info(struct phy_device *phydev)
1065 {
1066         phy_attached_print(phydev, NULL);
1067 }
1068 EXPORT_SYMBOL(phy_attached_info);
1069
1070 #define ATTACHED_FMT "attached PHY driver [%s] (mii_bus:phy_addr=%s, irq=%s)"
1071 void phy_attached_print(struct phy_device *phydev, const char *fmt, ...)
1072 {
1073         const char *drv_name = phydev->drv ? phydev->drv->name : "unbound";
1074         char *irq_str;
1075         char irq_num[8];
1076
1077         switch(phydev->irq) {
1078         case PHY_POLL:
1079                 irq_str = "POLL";
1080                 break;
1081         case PHY_IGNORE_INTERRUPT:
1082                 irq_str = "IGNORE";
1083                 break;
1084         default:
1085                 snprintf(irq_num, sizeof(irq_num), "%d", phydev->irq);
1086                 irq_str = irq_num;
1087                 break;
1088         }
1089
1090
1091         if (!fmt) {
1092                 phydev_info(phydev, ATTACHED_FMT "\n",
1093                          drv_name, phydev_name(phydev),
1094                          irq_str);
1095         } else {
1096                 va_list ap;
1097
1098                 phydev_info(phydev, ATTACHED_FMT,
1099                          drv_name, phydev_name(phydev),
1100                          irq_str);
1101
1102                 va_start(ap, fmt);
1103                 vprintk(fmt, ap);
1104                 va_end(ap);
1105         }
1106 }
1107 EXPORT_SYMBOL(phy_attached_print);
1108
1109 /**
1110  * phy_attach_direct - attach a network device to a given PHY device pointer
1111  * @dev: network device to attach
1112  * @phydev: Pointer to phy_device to attach
1113  * @flags: PHY device's dev_flags
1114  * @interface: PHY device's interface
1115  *
1116  * Description: Called by drivers to attach to a particular PHY
1117  *     device. The phy_device is found, and properly hooked up
1118  *     to the phy_driver.  If no driver is attached, then a
1119  *     generic driver is used.  The phy_device is given a ptr to
1120  *     the attaching device, and given a callback for link status
1121  *     change.  The phy_device is returned to the attaching driver.
1122  *     This function takes a reference on the phy device.
1123  */
1124 int phy_attach_direct(struct net_device *dev, struct phy_device *phydev,
1125                       u32 flags, phy_interface_t interface)
1126 {
1127         struct module *ndev_owner = dev->dev.parent->driver->owner;
1128         struct mii_bus *bus = phydev->mdio.bus;
1129         struct device *d = &phydev->mdio.dev;
1130         bool using_genphy = false;
1131         int err;
1132
1133         /* For Ethernet device drivers that register their own MDIO bus, we
1134          * will have bus->owner match ndev_mod, so we do not want to increment
1135          * our own module->refcnt here, otherwise we would not be able to
1136          * unload later on.
1137          */
1138         if (ndev_owner != bus->owner && !try_module_get(bus->owner)) {
1139                 dev_err(&dev->dev, "failed to get the bus module\n");
1140                 return -EIO;
1141         }
1142
1143         get_device(d);
1144
1145         /* Assume that if there is no driver, that it doesn't
1146          * exist, and we should use the genphy driver.
1147          */
1148         if (!d->driver) {
1149                 if (phydev->is_c45)
1150                         d->driver = &genphy_10g_driver.mdiodrv.driver;
1151                 else
1152                         d->driver = &genphy_driver.mdiodrv.driver;
1153
1154                 using_genphy = true;
1155         }
1156
1157         if (!try_module_get(d->driver->owner)) {
1158                 dev_err(&dev->dev, "failed to get the device driver module\n");
1159                 err = -EIO;
1160                 goto error_put_device;
1161         }
1162
1163         if (using_genphy) {
1164                 err = d->driver->probe(d);
1165                 if (err >= 0)
1166                         err = device_bind_driver(d);
1167
1168                 if (err)
1169                         goto error_module_put;
1170         }
1171
1172         if (phydev->attached_dev) {
1173                 dev_err(&dev->dev, "PHY already attached\n");
1174                 err = -EBUSY;
1175                 goto error;
1176         }
1177
1178         phydev->phy_link_change = phy_link_change;
1179         phydev->attached_dev = dev;
1180         dev->phydev = phydev;
1181
1182         /* Some Ethernet drivers try to connect to a PHY device before
1183          * calling register_netdevice() -> netdev_register_kobject() and
1184          * does the dev->dev.kobj initialization. Here we only check for
1185          * success which indicates that the network device kobject is
1186          * ready. Once we do that we still need to keep track of whether
1187          * links were successfully set up or not for phy_detach() to
1188          * remove them accordingly.
1189          */
1190         phydev->sysfs_links = false;
1191
1192         err = sysfs_create_link(&phydev->mdio.dev.kobj, &dev->dev.kobj,
1193                                 "attached_dev");
1194         if (!err) {
1195                 err = sysfs_create_link_nowarn(&dev->dev.kobj,
1196                                                &phydev->mdio.dev.kobj,
1197                                                "phydev");
1198                 if (err) {
1199                         dev_err(&dev->dev, "could not add device link to %s err %d\n",
1200                                 kobject_name(&phydev->mdio.dev.kobj),
1201                                 err);
1202                         /* non-fatal - some net drivers can use one netdevice
1203                          * with more then one phy
1204                          */
1205                 }
1206
1207                 phydev->sysfs_links = true;
1208         }
1209
1210         phydev->dev_flags = flags;
1211
1212         phydev->interface = interface;
1213
1214         phydev->state = PHY_READY;
1215
1216         /* Initial carrier state is off as the phy is about to be
1217          * (re)initialized.
1218          */
1219         netif_carrier_off(phydev->attached_dev);
1220
1221         /* Do initial configuration here, now that
1222          * we have certain key parameters
1223          * (dev_flags and interface)
1224          */
1225         err = phy_init_hw(phydev);
1226         if (err)
1227                 goto error;
1228
1229         phy_resume(phydev);
1230         phy_led_triggers_register(phydev);
1231
1232         return err;
1233
1234 error:
1235         /* phy_detach() does all of the cleanup below */
1236         phy_detach(phydev);
1237         return err;
1238
1239 error_module_put:
1240         module_put(d->driver->owner);
1241 error_put_device:
1242         put_device(d);
1243         if (ndev_owner != bus->owner)
1244                 module_put(bus->owner);
1245         return err;
1246 }
1247 EXPORT_SYMBOL(phy_attach_direct);
1248
1249 /**
1250  * phy_attach - attach a network device to a particular PHY device
1251  * @dev: network device to attach
1252  * @bus_id: Bus ID of PHY device to attach
1253  * @interface: PHY device's interface
1254  *
1255  * Description: Same as phy_attach_direct() except that a PHY bus_id
1256  *     string is passed instead of a pointer to a struct phy_device.
1257  */
1258 struct phy_device *phy_attach(struct net_device *dev, const char *bus_id,
1259                               phy_interface_t interface)
1260 {
1261         struct bus_type *bus = &mdio_bus_type;
1262         struct phy_device *phydev;
1263         struct device *d;
1264         int rc;
1265
1266         /* Search the list of PHY devices on the mdio bus for the
1267          * PHY with the requested name
1268          */
1269         d = bus_find_device_by_name(bus, NULL, bus_id);
1270         if (!d) {
1271                 pr_err("PHY %s not found\n", bus_id);
1272                 return ERR_PTR(-ENODEV);
1273         }
1274         phydev = to_phy_device(d);
1275
1276         rc = phy_attach_direct(dev, phydev, phydev->dev_flags, interface);
1277         put_device(d);
1278         if (rc)
1279                 return ERR_PTR(rc);
1280
1281         return phydev;
1282 }
1283 EXPORT_SYMBOL(phy_attach);
1284
1285 /**
1286  * phy_detach - detach a PHY device from its network device
1287  * @phydev: target phy_device struct
1288  *
1289  * This detaches the phy device from its network device and the phy
1290  * driver, and drops the reference count taken in phy_attach_direct().
1291  */
1292 void phy_detach(struct phy_device *phydev)
1293 {
1294         struct net_device *dev = phydev->attached_dev;
1295         struct module *ndev_owner = dev->dev.parent->driver->owner;
1296         struct mii_bus *bus;
1297
1298         if (phydev->sysfs_links) {
1299                 sysfs_remove_link(&dev->dev.kobj, "phydev");
1300                 sysfs_remove_link(&phydev->mdio.dev.kobj, "attached_dev");
1301         }
1302         phy_suspend(phydev);
1303         phydev->attached_dev->phydev = NULL;
1304         phydev->attached_dev = NULL;
1305         phydev->phylink = NULL;
1306
1307         phy_led_triggers_unregister(phydev);
1308
1309         module_put(phydev->mdio.dev.driver->owner);
1310
1311         /* If the device had no specific driver before (i.e. - it
1312          * was using the generic driver), we unbind the device
1313          * from the generic driver so that there's a chance a
1314          * real driver could be loaded
1315          */
1316         if (phydev->mdio.dev.driver == &genphy_10g_driver.mdiodrv.driver ||
1317             phydev->mdio.dev.driver == &genphy_driver.mdiodrv.driver)
1318                 device_release_driver(&phydev->mdio.dev);
1319
1320         /*
1321          * The phydev might go away on the put_device() below, so avoid
1322          * a use-after-free bug by reading the underlying bus first.
1323          */
1324         bus = phydev->mdio.bus;
1325
1326         put_device(&phydev->mdio.dev);
1327         if (ndev_owner != bus->owner)
1328                 module_put(bus->owner);
1329
1330         /* Assert the reset signal */
1331         phy_device_reset(phydev, 1);
1332 }
1333 EXPORT_SYMBOL(phy_detach);
1334
1335 int phy_suspend(struct phy_device *phydev)
1336 {
1337         struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1338         struct net_device *netdev = phydev->attached_dev;
1339         struct ethtool_wolinfo wol = { .cmd = ETHTOOL_GWOL };
1340         int ret = 0;
1341
1342         /* If the device has WOL enabled, we cannot suspend the PHY */
1343         phy_ethtool_get_wol(phydev, &wol);
1344         if (wol.wolopts || (netdev && netdev->wol_enabled))
1345                 return -EBUSY;
1346
1347         if (phydev->drv && phydrv->suspend)
1348                 ret = phydrv->suspend(phydev);
1349
1350         if (ret)
1351                 return ret;
1352
1353         phydev->suspended = true;
1354
1355         return ret;
1356 }
1357 EXPORT_SYMBOL(phy_suspend);
1358
1359 int __phy_resume(struct phy_device *phydev)
1360 {
1361         struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1362         int ret = 0;
1363
1364         WARN_ON(!mutex_is_locked(&phydev->lock));
1365
1366         if (phydev->drv && phydrv->resume)
1367                 ret = phydrv->resume(phydev);
1368
1369         if (ret)
1370                 return ret;
1371
1372         phydev->suspended = false;
1373
1374         return ret;
1375 }
1376 EXPORT_SYMBOL(__phy_resume);
1377
1378 int phy_resume(struct phy_device *phydev)
1379 {
1380         int ret;
1381
1382         mutex_lock(&phydev->lock);
1383         ret = __phy_resume(phydev);
1384         mutex_unlock(&phydev->lock);
1385
1386         return ret;
1387 }
1388 EXPORT_SYMBOL(phy_resume);
1389
1390 int phy_loopback(struct phy_device *phydev, bool enable)
1391 {
1392         struct phy_driver *phydrv = to_phy_driver(phydev->mdio.dev.driver);
1393         int ret = 0;
1394
1395         mutex_lock(&phydev->lock);
1396
1397         if (enable && phydev->loopback_enabled) {
1398                 ret = -EBUSY;
1399                 goto out;
1400         }
1401
1402         if (!enable && !phydev->loopback_enabled) {
1403                 ret = -EINVAL;
1404                 goto out;
1405         }
1406
1407         if (phydev->drv && phydrv->set_loopback)
1408                 ret = phydrv->set_loopback(phydev, enable);
1409         else
1410                 ret = -EOPNOTSUPP;
1411
1412         if (ret)
1413                 goto out;
1414
1415         phydev->loopback_enabled = enable;
1416
1417 out:
1418         mutex_unlock(&phydev->lock);
1419         return ret;
1420 }
1421 EXPORT_SYMBOL(phy_loopback);
1422
1423 /**
1424  * phy_reset_after_clk_enable - perform a PHY reset if needed
1425  * @phydev: target phy_device struct
1426  *
1427  * Description: Some PHYs are known to need a reset after their refclk was
1428  *   enabled. This function evaluates the flags and perform the reset if it's
1429  *   needed. Returns < 0 on error, 0 if the phy wasn't reset and 1 if the phy
1430  *   was reset.
1431  */
1432 int phy_reset_after_clk_enable(struct phy_device *phydev)
1433 {
1434         if (!phydev || !phydev->drv)
1435                 return -ENODEV;
1436
1437         if (phydev->drv->flags & PHY_RST_AFTER_CLK_EN) {
1438                 phy_device_reset(phydev, 1);
1439                 phy_device_reset(phydev, 0);
1440                 return 1;
1441         }
1442
1443         return 0;
1444 }
1445 EXPORT_SYMBOL(phy_reset_after_clk_enable);
1446
1447 /* Generic PHY support and helper functions */
1448
1449 /**
1450  * genphy_config_advert - sanitize and advertise auto-negotiation parameters
1451  * @phydev: target phy_device struct
1452  *
1453  * Description: Writes MII_ADVERTISE with the appropriate values,
1454  *   after sanitizing the values to make sure we only advertise
1455  *   what is supported.  Returns < 0 on error, 0 if the PHY's advertisement
1456  *   hasn't changed, and > 0 if it has changed.
1457  */
1458 static int genphy_config_advert(struct phy_device *phydev)
1459 {
1460         u32 advertise;
1461         int oldadv, adv, bmsr;
1462         int err, changed = 0;
1463
1464         /* Only allow advertising what this PHY supports */
1465         linkmode_and(phydev->advertising, phydev->advertising,
1466                      phydev->supported);
1467         if (!ethtool_convert_link_mode_to_legacy_u32(&advertise,
1468                                                      phydev->advertising))
1469                 phydev_warn(phydev, "PHY advertising (%*pb) more modes than genphy supports, some modes not advertised.\n",
1470                             __ETHTOOL_LINK_MODE_MASK_NBITS,
1471                             phydev->advertising);
1472
1473         /* Setup standard advertisement */
1474         adv = phy_read(phydev, MII_ADVERTISE);
1475         if (adv < 0)
1476                 return adv;
1477
1478         oldadv = adv;
1479         adv &= ~(ADVERTISE_ALL | ADVERTISE_100BASE4 | ADVERTISE_PAUSE_CAP |
1480                  ADVERTISE_PAUSE_ASYM);
1481         adv |= ethtool_adv_to_mii_adv_t(advertise);
1482
1483         if (adv != oldadv) {
1484                 err = phy_write(phydev, MII_ADVERTISE, adv);
1485
1486                 if (err < 0)
1487                         return err;
1488                 changed = 1;
1489         }
1490
1491         bmsr = phy_read(phydev, MII_BMSR);
1492         if (bmsr < 0)
1493                 return bmsr;
1494
1495         /* Per 802.3-2008, Section 22.2.4.2.16 Extended status all
1496          * 1000Mbits/sec capable PHYs shall have the BMSR_ESTATEN bit set to a
1497          * logical 1.
1498          */
1499         if (!(bmsr & BMSR_ESTATEN))
1500                 return changed;
1501
1502         /* Configure gigabit if it's supported */
1503         adv = phy_read(phydev, MII_CTRL1000);
1504         if (adv < 0)
1505                 return adv;
1506
1507         oldadv = adv;
1508         adv &= ~(ADVERTISE_1000FULL | ADVERTISE_1000HALF);
1509
1510         if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1511                               phydev->supported) ||
1512             linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1513                               phydev->supported))
1514                 adv |= ethtool_adv_to_mii_ctrl1000_t(advertise);
1515
1516         if (adv != oldadv)
1517                 changed = 1;
1518
1519         err = phy_write(phydev, MII_CTRL1000, adv);
1520         if (err < 0)
1521                 return err;
1522
1523         return changed;
1524 }
1525
1526 /**
1527  * genphy_config_eee_advert - disable unwanted eee mode advertisement
1528  * @phydev: target phy_device struct
1529  *
1530  * Description: Writes MDIO_AN_EEE_ADV after disabling unsupported energy
1531  *   efficent ethernet modes. Returns 0 if the PHY's advertisement hasn't
1532  *   changed, and 1 if it has changed.
1533  */
1534 static int genphy_config_eee_advert(struct phy_device *phydev)
1535 {
1536         int broken = phydev->eee_broken_modes;
1537         int old_adv, adv;
1538
1539         /* Nothing to disable */
1540         if (!broken)
1541                 return 0;
1542
1543         /* If the following call fails, we assume that EEE is not
1544          * supported by the phy. If we read 0, EEE is not advertised
1545          * In both case, we don't need to continue
1546          */
1547         adv = phy_read_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV);
1548         if (adv <= 0)
1549                 return 0;
1550
1551         old_adv = adv;
1552         adv &= ~broken;
1553
1554         /* Advertising remains unchanged with the broken mask */
1555         if (old_adv == adv)
1556                 return 0;
1557
1558         phy_write_mmd(phydev, MDIO_MMD_AN, MDIO_AN_EEE_ADV, adv);
1559
1560         return 1;
1561 }
1562
1563 /**
1564  * genphy_setup_forced - configures/forces speed/duplex from @phydev
1565  * @phydev: target phy_device struct
1566  *
1567  * Description: Configures MII_BMCR to force speed/duplex
1568  *   to the values in phydev. Assumes that the values are valid.
1569  *   Please see phy_sanitize_settings().
1570  */
1571 int genphy_setup_forced(struct phy_device *phydev)
1572 {
1573         u16 ctl = 0;
1574
1575         phydev->pause = 0;
1576         phydev->asym_pause = 0;
1577
1578         if (SPEED_1000 == phydev->speed)
1579                 ctl |= BMCR_SPEED1000;
1580         else if (SPEED_100 == phydev->speed)
1581                 ctl |= BMCR_SPEED100;
1582
1583         if (DUPLEX_FULL == phydev->duplex)
1584                 ctl |= BMCR_FULLDPLX;
1585
1586         return phy_modify(phydev, MII_BMCR,
1587                           ~(BMCR_LOOPBACK | BMCR_ISOLATE | BMCR_PDOWN), ctl);
1588 }
1589 EXPORT_SYMBOL(genphy_setup_forced);
1590
1591 /**
1592  * genphy_restart_aneg - Enable and Restart Autonegotiation
1593  * @phydev: target phy_device struct
1594  */
1595 int genphy_restart_aneg(struct phy_device *phydev)
1596 {
1597         /* Don't isolate the PHY if we're negotiating */
1598         return phy_modify(phydev, MII_BMCR, BMCR_ISOLATE,
1599                           BMCR_ANENABLE | BMCR_ANRESTART);
1600 }
1601 EXPORT_SYMBOL(genphy_restart_aneg);
1602
1603 /**
1604  * genphy_config_aneg - restart auto-negotiation or write BMCR
1605  * @phydev: target phy_device struct
1606  *
1607  * Description: If auto-negotiation is enabled, we configure the
1608  *   advertising, and then restart auto-negotiation.  If it is not
1609  *   enabled, then we write the BMCR.
1610  */
1611 int genphy_config_aneg(struct phy_device *phydev)
1612 {
1613         int err, changed;
1614
1615         changed = genphy_config_eee_advert(phydev);
1616
1617         if (AUTONEG_ENABLE != phydev->autoneg)
1618                 return genphy_setup_forced(phydev);
1619
1620         err = genphy_config_advert(phydev);
1621         if (err < 0) /* error */
1622                 return err;
1623
1624         changed |= err;
1625
1626         if (changed == 0) {
1627                 /* Advertisement hasn't changed, but maybe aneg was never on to
1628                  * begin with?  Or maybe phy was isolated?
1629                  */
1630                 int ctl = phy_read(phydev, MII_BMCR);
1631
1632                 if (ctl < 0)
1633                         return ctl;
1634
1635                 if (!(ctl & BMCR_ANENABLE) || (ctl & BMCR_ISOLATE))
1636                         changed = 1; /* do restart aneg */
1637         }
1638
1639         /* Only restart aneg if we are advertising something different
1640          * than we were before.
1641          */
1642         if (changed > 0)
1643                 return genphy_restart_aneg(phydev);
1644
1645         return 0;
1646 }
1647 EXPORT_SYMBOL(genphy_config_aneg);
1648
1649 /**
1650  * genphy_aneg_done - return auto-negotiation status
1651  * @phydev: target phy_device struct
1652  *
1653  * Description: Reads the status register and returns 0 either if
1654  *   auto-negotiation is incomplete, or if there was an error.
1655  *   Returns BMSR_ANEGCOMPLETE if auto-negotiation is done.
1656  */
1657 int genphy_aneg_done(struct phy_device *phydev)
1658 {
1659         int retval = phy_read(phydev, MII_BMSR);
1660
1661         return (retval < 0) ? retval : (retval & BMSR_ANEGCOMPLETE);
1662 }
1663 EXPORT_SYMBOL(genphy_aneg_done);
1664
1665 /**
1666  * genphy_update_link - update link status in @phydev
1667  * @phydev: target phy_device struct
1668  *
1669  * Description: Update the value in phydev->link to reflect the
1670  *   current link value.  In order to do this, we need to read
1671  *   the status register twice, keeping the second value.
1672  */
1673 int genphy_update_link(struct phy_device *phydev)
1674 {
1675         int status;
1676
1677         /* Do a fake read */
1678         status = phy_read(phydev, MII_BMSR);
1679         if (status < 0)
1680                 return status;
1681
1682         /* Read link and autonegotiation status */
1683         status = phy_read(phydev, MII_BMSR);
1684         if (status < 0)
1685                 return status;
1686
1687         if ((status & BMSR_LSTATUS) == 0)
1688                 phydev->link = 0;
1689         else
1690                 phydev->link = 1;
1691
1692         return 0;
1693 }
1694 EXPORT_SYMBOL(genphy_update_link);
1695
1696 /**
1697  * genphy_read_status - check the link status and update current link state
1698  * @phydev: target phy_device struct
1699  *
1700  * Description: Check the link, then figure out the current state
1701  *   by comparing what we advertise with what the link partner
1702  *   advertises.  Start by checking the gigabit possibilities,
1703  *   then move on to 10/100.
1704  */
1705 int genphy_read_status(struct phy_device *phydev)
1706 {
1707         int adv;
1708         int err;
1709         int lpa;
1710         int lpagb = 0;
1711         int common_adv;
1712         int common_adv_gb = 0;
1713
1714         /* Update the link, but return if there was an error */
1715         err = genphy_update_link(phydev);
1716         if (err)
1717                 return err;
1718
1719         linkmode_zero(phydev->lp_advertising);
1720
1721         if (AUTONEG_ENABLE == phydev->autoneg) {
1722                 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1723                                       phydev->supported) ||
1724                     linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1725                                       phydev->supported)) {
1726                         lpagb = phy_read(phydev, MII_STAT1000);
1727                         if (lpagb < 0)
1728                                 return lpagb;
1729
1730                         adv = phy_read(phydev, MII_CTRL1000);
1731                         if (adv < 0)
1732                                 return adv;
1733
1734                         if (lpagb & LPA_1000MSFAIL) {
1735                                 if (adv & CTL1000_ENABLE_MASTER)
1736                                         phydev_err(phydev, "Master/Slave resolution failed, maybe conflicting manual settings?\n");
1737                                 else
1738                                         phydev_err(phydev, "Master/Slave resolution failed\n");
1739                                 return -ENOLINK;
1740                         }
1741
1742                         mii_stat1000_mod_linkmode_lpa_t(phydev->lp_advertising,
1743                                                         lpagb);
1744                         common_adv_gb = lpagb & adv << 2;
1745                 }
1746
1747                 lpa = phy_read(phydev, MII_LPA);
1748                 if (lpa < 0)
1749                         return lpa;
1750
1751                 mii_lpa_mod_linkmode_lpa_t(phydev->lp_advertising, lpa);
1752
1753                 adv = phy_read(phydev, MII_ADVERTISE);
1754                 if (adv < 0)
1755                         return adv;
1756
1757                 common_adv = lpa & adv;
1758
1759                 phydev->speed = SPEED_10;
1760                 phydev->duplex = DUPLEX_HALF;
1761                 phydev->pause = 0;
1762                 phydev->asym_pause = 0;
1763
1764                 if (common_adv_gb & (LPA_1000FULL | LPA_1000HALF)) {
1765                         phydev->speed = SPEED_1000;
1766
1767                         if (common_adv_gb & LPA_1000FULL)
1768                                 phydev->duplex = DUPLEX_FULL;
1769                 } else if (common_adv & (LPA_100FULL | LPA_100HALF)) {
1770                         phydev->speed = SPEED_100;
1771
1772                         if (common_adv & LPA_100FULL)
1773                                 phydev->duplex = DUPLEX_FULL;
1774                 } else
1775                         if (common_adv & LPA_10FULL)
1776                                 phydev->duplex = DUPLEX_FULL;
1777
1778                 if (phydev->duplex == DUPLEX_FULL) {
1779                         phydev->pause = lpa & LPA_PAUSE_CAP ? 1 : 0;
1780                         phydev->asym_pause = lpa & LPA_PAUSE_ASYM ? 1 : 0;
1781                 }
1782         } else {
1783                 int bmcr = phy_read(phydev, MII_BMCR);
1784
1785                 if (bmcr < 0)
1786                         return bmcr;
1787
1788                 if (bmcr & BMCR_FULLDPLX)
1789                         phydev->duplex = DUPLEX_FULL;
1790                 else
1791                         phydev->duplex = DUPLEX_HALF;
1792
1793                 if (bmcr & BMCR_SPEED1000)
1794                         phydev->speed = SPEED_1000;
1795                 else if (bmcr & BMCR_SPEED100)
1796                         phydev->speed = SPEED_100;
1797                 else
1798                         phydev->speed = SPEED_10;
1799
1800                 phydev->pause = 0;
1801                 phydev->asym_pause = 0;
1802         }
1803
1804         return 0;
1805 }
1806 EXPORT_SYMBOL(genphy_read_status);
1807
1808 /**
1809  * genphy_soft_reset - software reset the PHY via BMCR_RESET bit
1810  * @phydev: target phy_device struct
1811  *
1812  * Description: Perform a software PHY reset using the standard
1813  * BMCR_RESET bit and poll for the reset bit to be cleared.
1814  *
1815  * Returns: 0 on success, < 0 on failure
1816  */
1817 int genphy_soft_reset(struct phy_device *phydev)
1818 {
1819         int ret;
1820
1821         ret = phy_write(phydev, MII_BMCR, BMCR_RESET);
1822         if (ret < 0)
1823                 return ret;
1824
1825         return phy_poll_reset(phydev);
1826 }
1827 EXPORT_SYMBOL(genphy_soft_reset);
1828
1829 int genphy_config_init(struct phy_device *phydev)
1830 {
1831         int val;
1832         __ETHTOOL_DECLARE_LINK_MODE_MASK(features) = { 0, };
1833
1834         linkmode_set_bit_array(phy_basic_ports_array,
1835                                ARRAY_SIZE(phy_basic_ports_array),
1836                                features);
1837         linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, features);
1838         linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, features);
1839
1840         /* Do we support autonegotiation? */
1841         val = phy_read(phydev, MII_BMSR);
1842         if (val < 0)
1843                 return val;
1844
1845         if (val & BMSR_ANEGCAPABLE)
1846                 linkmode_set_bit(ETHTOOL_LINK_MODE_Autoneg_BIT, features);
1847
1848         if (val & BMSR_100FULL)
1849                 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, features);
1850         if (val & BMSR_100HALF)
1851                 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT, features);
1852         if (val & BMSR_10FULL)
1853                 linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Full_BIT, features);
1854         if (val & BMSR_10HALF)
1855                 linkmode_set_bit(ETHTOOL_LINK_MODE_10baseT_Half_BIT, features);
1856
1857         if (val & BMSR_ESTATEN) {
1858                 val = phy_read(phydev, MII_ESTATUS);
1859                 if (val < 0)
1860                         return val;
1861
1862                 if (val & ESTATUS_1000_TFULL)
1863                         linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1864                                          features);
1865                 if (val & ESTATUS_1000_THALF)
1866                         linkmode_set_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1867                                          features);
1868         }
1869
1870         linkmode_and(phydev->supported, phydev->supported, features);
1871         linkmode_and(phydev->advertising, phydev->advertising, features);
1872
1873         return 0;
1874 }
1875 EXPORT_SYMBOL(genphy_config_init);
1876
1877 /* This is used for the phy device which doesn't support the MMD extended
1878  * register access, but it does have side effect when we are trying to access
1879  * the MMD register via indirect method.
1880  */
1881 int genphy_read_mmd_unsupported(struct phy_device *phdev, int devad, u16 regnum)
1882 {
1883         return -EOPNOTSUPP;
1884 }
1885 EXPORT_SYMBOL(genphy_read_mmd_unsupported);
1886
1887 int genphy_write_mmd_unsupported(struct phy_device *phdev, int devnum,
1888                                  u16 regnum, u16 val)
1889 {
1890         return -EOPNOTSUPP;
1891 }
1892 EXPORT_SYMBOL(genphy_write_mmd_unsupported);
1893
1894 int genphy_suspend(struct phy_device *phydev)
1895 {
1896         return phy_set_bits(phydev, MII_BMCR, BMCR_PDOWN);
1897 }
1898 EXPORT_SYMBOL(genphy_suspend);
1899
1900 int genphy_resume(struct phy_device *phydev)
1901 {
1902         return phy_clear_bits(phydev, MII_BMCR, BMCR_PDOWN);
1903 }
1904 EXPORT_SYMBOL(genphy_resume);
1905
1906 int genphy_loopback(struct phy_device *phydev, bool enable)
1907 {
1908         return phy_modify(phydev, MII_BMCR, BMCR_LOOPBACK,
1909                           enable ? BMCR_LOOPBACK : 0);
1910 }
1911 EXPORT_SYMBOL(genphy_loopback);
1912
1913 static int __set_phy_supported(struct phy_device *phydev, u32 max_speed)
1914 {
1915         switch (max_speed) {
1916         case SPEED_10:
1917                 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Half_BIT,
1918                                    phydev->supported);
1919                 linkmode_clear_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT,
1920                                    phydev->supported);
1921                 /* fall through */
1922         case SPEED_100:
1923                 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Half_BIT,
1924                                    phydev->supported);
1925                 linkmode_clear_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
1926                                    phydev->supported);
1927                 break;
1928         case SPEED_1000:
1929                 break;
1930         default:
1931                 return -ENOTSUPP;
1932         }
1933
1934         return 0;
1935 }
1936
1937 int phy_set_max_speed(struct phy_device *phydev, u32 max_speed)
1938 {
1939         int err;
1940
1941         err = __set_phy_supported(phydev, max_speed);
1942         if (err)
1943                 return err;
1944
1945         linkmode_copy(phydev->advertising, phydev->supported);
1946
1947         return 0;
1948 }
1949 EXPORT_SYMBOL(phy_set_max_speed);
1950
1951 /**
1952  * phy_remove_link_mode - Remove a supported link mode
1953  * @phydev: phy_device structure to remove link mode from
1954  * @link_mode: Link mode to be removed
1955  *
1956  * Description: Some MACs don't support all link modes which the PHY
1957  * does.  e.g. a 1G MAC often does not support 1000Half. Add a helper
1958  * to remove a link mode.
1959  */
1960 void phy_remove_link_mode(struct phy_device *phydev, u32 link_mode)
1961 {
1962         linkmode_clear_bit(link_mode, phydev->supported);
1963         linkmode_copy(phydev->advertising, phydev->supported);
1964 }
1965 EXPORT_SYMBOL(phy_remove_link_mode);
1966
1967 /**
1968  * phy_support_sym_pause - Enable support of symmetrical pause
1969  * @phydev: target phy_device struct
1970  *
1971  * Description: Called by the MAC to indicate is supports symmetrical
1972  * Pause, but not asym pause.
1973  */
1974 void phy_support_sym_pause(struct phy_device *phydev)
1975 {
1976         linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
1977         linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
1978         linkmode_copy(phydev->advertising, phydev->supported);
1979 }
1980 EXPORT_SYMBOL(phy_support_sym_pause);
1981
1982 /**
1983  * phy_support_asym_pause - Enable support of asym pause
1984  * @phydev: target phy_device struct
1985  *
1986  * Description: Called by the MAC to indicate is supports Asym Pause.
1987  */
1988 void phy_support_asym_pause(struct phy_device *phydev)
1989 {
1990         linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
1991         linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->supported);
1992         linkmode_copy(phydev->advertising, phydev->supported);
1993 }
1994 EXPORT_SYMBOL(phy_support_asym_pause);
1995
1996 /**
1997  * phy_set_sym_pause - Configure symmetric Pause
1998  * @phydev: target phy_device struct
1999  * @rx: Receiver Pause is supported
2000  * @tx: Transmit Pause is supported
2001  * @autoneg: Auto neg should be used
2002  *
2003  * Description: Configure advertised Pause support depending on if
2004  * receiver pause and pause auto neg is supported. Generally called
2005  * from the set_pauseparam .ndo.
2006  */
2007 void phy_set_sym_pause(struct phy_device *phydev, bool rx, bool tx,
2008                        bool autoneg)
2009 {
2010         linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->supported);
2011
2012         if (rx && tx && autoneg)
2013                 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2014                                  phydev->supported);
2015
2016         linkmode_copy(phydev->advertising, phydev->supported);
2017 }
2018 EXPORT_SYMBOL(phy_set_sym_pause);
2019
2020 /**
2021  * phy_set_asym_pause - Configure Pause and Asym Pause
2022  * @phydev: target phy_device struct
2023  * @rx: Receiver Pause is supported
2024  * @tx: Transmit Pause is supported
2025  *
2026  * Description: Configure advertised Pause support depending on if
2027  * transmit and receiver pause is supported. If there has been a
2028  * change in adverting, trigger a new autoneg. Generally called from
2029  * the set_pauseparam .ndo.
2030  */
2031 void phy_set_asym_pause(struct phy_device *phydev, bool rx, bool tx)
2032 {
2033         __ETHTOOL_DECLARE_LINK_MODE_MASK(oldadv);
2034
2035         linkmode_copy(oldadv, phydev->advertising);
2036
2037         linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2038                            phydev->advertising);
2039         linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2040                            phydev->advertising);
2041
2042         if (rx) {
2043                 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2044                                  phydev->advertising);
2045                 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2046                                  phydev->advertising);
2047         }
2048
2049         if (tx)
2050                 linkmode_change_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2051                                     phydev->advertising);
2052
2053         if (!linkmode_equal(oldadv, phydev->advertising) &&
2054             phydev->autoneg)
2055                 phy_start_aneg(phydev);
2056 }
2057 EXPORT_SYMBOL(phy_set_asym_pause);
2058
2059 /**
2060  * phy_validate_pause - Test if the PHY/MAC support the pause configuration
2061  * @phydev: phy_device struct
2062  * @pp: requested pause configuration
2063  *
2064  * Description: Test if the PHY/MAC combination supports the Pause
2065  * configuration the user is requesting. Returns True if it is
2066  * supported, false otherwise.
2067  */
2068 bool phy_validate_pause(struct phy_device *phydev,
2069                         struct ethtool_pauseparam *pp)
2070 {
2071         if (!linkmode_test_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2072                                phydev->supported) ||
2073             (!linkmode_test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2074                                 phydev->supported) &&
2075              pp->rx_pause != pp->tx_pause))
2076                 return false;
2077         return true;
2078 }
2079 EXPORT_SYMBOL(phy_validate_pause);
2080
2081 static void of_set_phy_supported(struct phy_device *phydev)
2082 {
2083         struct device_node *node = phydev->mdio.dev.of_node;
2084         u32 max_speed;
2085
2086         if (!IS_ENABLED(CONFIG_OF_MDIO))
2087                 return;
2088
2089         if (!node)
2090                 return;
2091
2092         if (!of_property_read_u32(node, "max-speed", &max_speed))
2093                 __set_phy_supported(phydev, max_speed);
2094 }
2095
2096 static void of_set_phy_eee_broken(struct phy_device *phydev)
2097 {
2098         struct device_node *node = phydev->mdio.dev.of_node;
2099         u32 broken = 0;
2100
2101         if (!IS_ENABLED(CONFIG_OF_MDIO))
2102                 return;
2103
2104         if (!node)
2105                 return;
2106
2107         if (of_property_read_bool(node, "eee-broken-100tx"))
2108                 broken |= MDIO_EEE_100TX;
2109         if (of_property_read_bool(node, "eee-broken-1000t"))
2110                 broken |= MDIO_EEE_1000T;
2111         if (of_property_read_bool(node, "eee-broken-10gt"))
2112                 broken |= MDIO_EEE_10GT;
2113         if (of_property_read_bool(node, "eee-broken-1000kx"))
2114                 broken |= MDIO_EEE_1000KX;
2115         if (of_property_read_bool(node, "eee-broken-10gkx4"))
2116                 broken |= MDIO_EEE_10GKX4;
2117         if (of_property_read_bool(node, "eee-broken-10gkr"))
2118                 broken |= MDIO_EEE_10GKR;
2119
2120         phydev->eee_broken_modes = broken;
2121 }
2122
2123 static bool phy_drv_supports_irq(struct phy_driver *phydrv)
2124 {
2125         return phydrv->config_intr && phydrv->ack_interrupt;
2126 }
2127
2128 /**
2129  * phy_probe - probe and init a PHY device
2130  * @dev: device to probe and init
2131  *
2132  * Description: Take care of setting up the phy_device structure,
2133  *   set the state to READY (the driver's init function should
2134  *   set it to STARTING if needed).
2135  */
2136 static int phy_probe(struct device *dev)
2137 {
2138         struct phy_device *phydev = to_phy_device(dev);
2139         struct device_driver *drv = phydev->mdio.dev.driver;
2140         struct phy_driver *phydrv = to_phy_driver(drv);
2141         u32 features;
2142         int err = 0;
2143
2144         phydev->drv = phydrv;
2145
2146         /* Disable the interrupt if the PHY doesn't support it
2147          * but the interrupt is still a valid one
2148          */
2149          if (!phy_drv_supports_irq(phydrv) && phy_interrupt_is_valid(phydev))
2150                 phydev->irq = PHY_POLL;
2151
2152         if (phydrv->flags & PHY_IS_INTERNAL)
2153                 phydev->is_internal = true;
2154
2155         mutex_lock(&phydev->lock);
2156
2157         /* Start out supporting everything. Eventually,
2158          * a controller will attach, and may modify one
2159          * or both of these values
2160          */
2161         ethtool_convert_link_mode_to_legacy_u32(&features, phydrv->features);
2162         linkmode_copy(phydev->supported, phydrv->features);
2163         of_set_phy_supported(phydev);
2164         linkmode_copy(phydev->advertising, phydev->supported);
2165
2166         /* Get the EEE modes we want to prohibit. We will ask
2167          * the PHY stop advertising these mode later on
2168          */
2169         of_set_phy_eee_broken(phydev);
2170
2171         /* The Pause Frame bits indicate that the PHY can support passing
2172          * pause frames. During autonegotiation, the PHYs will determine if
2173          * they should allow pause frames to pass.  The MAC driver should then
2174          * use that result to determine whether to enable flow control via
2175          * pause frames.
2176          *
2177          * Normally, PHY drivers should not set the Pause bits, and instead
2178          * allow phylib to do that.  However, there may be some situations
2179          * (e.g. hardware erratum) where the driver wants to set only one
2180          * of these bits.
2181          */
2182         if (test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydrv->features) ||
2183             test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydrv->features)) {
2184                 linkmode_clear_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2185                                    phydev->supported);
2186                 linkmode_clear_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2187                                    phydev->supported);
2188                 if (test_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydrv->features))
2189                         linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2190                                          phydev->supported);
2191                 if (test_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2192                              phydrv->features))
2193                         linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2194                                          phydev->supported);
2195         } else {
2196                 linkmode_set_bit(ETHTOOL_LINK_MODE_Pause_BIT,
2197                                  phydev->supported);
2198                 linkmode_set_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT,
2199                                  phydev->supported);
2200         }
2201
2202         /* Set the state to READY by default */
2203         phydev->state = PHY_READY;
2204
2205         if (phydev->drv->probe) {
2206                 /* Deassert the reset signal */
2207                 phy_device_reset(phydev, 0);
2208
2209                 err = phydev->drv->probe(phydev);
2210                 if (err) {
2211                         /* Assert the reset signal */
2212                         phy_device_reset(phydev, 1);
2213                 }
2214         }
2215
2216         mutex_unlock(&phydev->lock);
2217
2218         return err;
2219 }
2220
2221 static int phy_remove(struct device *dev)
2222 {
2223         struct phy_device *phydev = to_phy_device(dev);
2224
2225         cancel_delayed_work_sync(&phydev->state_queue);
2226
2227         mutex_lock(&phydev->lock);
2228         phydev->state = PHY_DOWN;
2229         mutex_unlock(&phydev->lock);
2230
2231         if (phydev->drv && phydev->drv->remove) {
2232                 phydev->drv->remove(phydev);
2233
2234                 /* Assert the reset signal */
2235                 phy_device_reset(phydev, 1);
2236         }
2237         phydev->drv = NULL;
2238
2239         return 0;
2240 }
2241
2242 /**
2243  * phy_driver_register - register a phy_driver with the PHY layer
2244  * @new_driver: new phy_driver to register
2245  * @owner: module owning this PHY
2246  */
2247 int phy_driver_register(struct phy_driver *new_driver, struct module *owner)
2248 {
2249         int retval;
2250
2251         new_driver->mdiodrv.flags |= MDIO_DEVICE_IS_PHY;
2252         new_driver->mdiodrv.driver.name = new_driver->name;
2253         new_driver->mdiodrv.driver.bus = &mdio_bus_type;
2254         new_driver->mdiodrv.driver.probe = phy_probe;
2255         new_driver->mdiodrv.driver.remove = phy_remove;
2256         new_driver->mdiodrv.driver.owner = owner;
2257
2258         /* The following works around an issue where the PHY driver doesn't bind
2259          * to the device, resulting in the genphy driver being used instead of
2260          * the dedicated driver. The root cause of the issue isn't known yet
2261          * and seems to be in the base driver core. Once this is fixed we may
2262          * remove this workaround.
2263          */
2264         new_driver->mdiodrv.driver.probe_type = PROBE_FORCE_SYNCHRONOUS;
2265
2266         retval = driver_register(&new_driver->mdiodrv.driver);
2267         if (retval) {
2268                 pr_err("%s: Error %d in registering driver\n",
2269                        new_driver->name, retval);
2270
2271                 return retval;
2272         }
2273
2274         pr_debug("%s: Registered new driver\n", new_driver->name);
2275
2276         return 0;
2277 }
2278 EXPORT_SYMBOL(phy_driver_register);
2279
2280 int phy_drivers_register(struct phy_driver *new_driver, int n,
2281                          struct module *owner)
2282 {
2283         int i, ret = 0;
2284
2285         for (i = 0; i < n; i++) {
2286                 ret = phy_driver_register(new_driver + i, owner);
2287                 if (ret) {
2288                         while (i-- > 0)
2289                                 phy_driver_unregister(new_driver + i);
2290                         break;
2291                 }
2292         }
2293         return ret;
2294 }
2295 EXPORT_SYMBOL(phy_drivers_register);
2296
2297 void phy_driver_unregister(struct phy_driver *drv)
2298 {
2299         driver_unregister(&drv->mdiodrv.driver);
2300 }
2301 EXPORT_SYMBOL(phy_driver_unregister);
2302
2303 void phy_drivers_unregister(struct phy_driver *drv, int n)
2304 {
2305         int i;
2306
2307         for (i = 0; i < n; i++)
2308                 phy_driver_unregister(drv + i);
2309 }
2310 EXPORT_SYMBOL(phy_drivers_unregister);
2311
2312 static struct phy_driver genphy_driver = {
2313         .phy_id         = 0xffffffff,
2314         .phy_id_mask    = 0xffffffff,
2315         .name           = "Generic PHY",
2316         .soft_reset     = genphy_no_soft_reset,
2317         .config_init    = genphy_config_init,
2318         .features       = PHY_GBIT_ALL_PORTS_FEATURES,
2319         .aneg_done      = genphy_aneg_done,
2320         .suspend        = genphy_suspend,
2321         .resume         = genphy_resume,
2322         .set_loopback   = genphy_loopback,
2323 };
2324
2325 static int __init phy_init(void)
2326 {
2327         int rc;
2328
2329         rc = mdio_bus_init();
2330         if (rc)
2331                 return rc;
2332
2333         features_init();
2334
2335         rc = phy_driver_register(&genphy_10g_driver, THIS_MODULE);
2336         if (rc)
2337                 goto err_10g;
2338
2339         rc = phy_driver_register(&genphy_driver, THIS_MODULE);
2340         if (rc) {
2341                 phy_driver_unregister(&genphy_10g_driver);
2342 err_10g:
2343                 mdio_bus_exit();
2344         }
2345
2346         return rc;
2347 }
2348
2349 static void __exit phy_exit(void)
2350 {
2351         phy_driver_unregister(&genphy_10g_driver);
2352         phy_driver_unregister(&genphy_driver);
2353         mdio_bus_exit();
2354 }
2355
2356 subsys_initcall(phy_init);
2357 module_exit(phy_exit);