drivers/net/phy/smsc.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * drivers/net/phy/smsc.c
   4  *
   5  * Driver for SMSC PHYs
   6  *
   7  * Author: Herbert Valerio Riedel
   8  *
   9  * Copyright (c) 2006 Herbert Valerio Riedel <hvr@gnu.org>
  10  *
  11  * Support added for SMSC LAN8187 and LAN8700 by steve.glendinning@shawell.net
  12  *
  13  */
  14
  15 #include <linux/clk.h>
  16 #include <linux/kernel.h>
  17 #include <linux/module.h>
  18 #include <linux/mii.h>
  19 #include <linux/ethtool.h>
  20 #include <linux/of.h>
  21 #include <linux/phy.h>
  22 #include <linux/netdevice.h>
  23 #include <linux/smscphy.h>
  24
  25 /* Vendor-specific PHY Definitions */
  26 /* EDPD NLP / crossover time configuration */
  27 #define PHY_EDPD_CONFIG                 16
  28 #define PHY_EDPD_CONFIG_EXT_CROSSOVER_  0x0001
  29
  30 /* Control/Status Indication Register */
  31 #define SPECIAL_CTRL_STS                27
  32 #define SPECIAL_CTRL_STS_OVRRD_AMDIX_   0x8000
  33 #define SPECIAL_CTRL_STS_AMDIX_ENABLE_  0x4000
  34 #define SPECIAL_CTRL_STS_AMDIX_STATE_   0x2000
  35
  36 struct smsc_hw_stat {
  37         const char *string;
  38         u8 reg;
  39         u8 bits;
  40 };
  41
  42 static struct smsc_hw_stat smsc_hw_stats[] = {
  43         { "phy_symbol_errors", 26, 16},
  44 };
  45
  46 struct smsc_phy_priv {
  47         bool energy_enable;
  48         struct clk *refclk;
  49 };
  50
  51 static int smsc_phy_ack_interrupt(struct phy_device *phydev)
  52 {
  53         int rc = phy_read(phydev, MII_LAN83C185_ISF);
  54
  55         return rc < 0 ? rc : 0;
  56 }
  57
  58 static int smsc_phy_config_intr(struct phy_device *phydev)
  59 {
  60         struct smsc_phy_priv *priv = phydev->priv;
  61         u16 intmask = 0;
  62         int rc;
  63
  64         if (phydev->interrupts == PHY_INTERRUPT_ENABLED) {
  65                 rc = smsc_phy_ack_interrupt(phydev);
  66                 if (rc)
  67                         return rc;
  68
  69                 intmask = MII_LAN83C185_ISF_INT4 | MII_LAN83C185_ISF_INT6;
  70                 if (priv->energy_enable)
  71                         intmask |= MII_LAN83C185_ISF_INT7;
  72                 rc = phy_write(phydev, MII_LAN83C185_IM, intmask);
  73         } else {
  74                 rc = phy_write(phydev, MII_LAN83C185_IM, intmask);
  75                 if (rc)
  76                         return rc;
  77
  78                 rc = smsc_phy_ack_interrupt(phydev);
  79         }
  80
  81         return rc < 0 ? rc : 0;
  82 }
  83
  84 static irqreturn_t smsc_phy_handle_interrupt(struct phy_device *phydev)
  85 {
  86         int irq_status, irq_enabled;
  87
  88         irq_enabled = phy_read(phydev, MII_LAN83C185_IM);
  89         if (irq_enabled < 0) {
  90                 phy_error(phydev);
  91                 return IRQ_NONE;
  92         }
  93
  94         irq_status = phy_read(phydev, MII_LAN83C185_ISF);
  95         if (irq_status < 0) {
  96                 phy_error(phydev);
  97                 return IRQ_NONE;
  98         }
  99
 100         if (!(irq_status & irq_enabled))
 101                 return IRQ_NONE;
 102
 103         phy_trigger_machine(phydev);
 104
 105         return IRQ_HANDLED;
 106 }
 107
 108 static int smsc_phy_config_init(struct phy_device *phydev)
 109 {
 110         struct smsc_phy_priv *priv = phydev->priv;
 111         int rc;
 112
 113         if (!priv->energy_enable)
 114                 return 0;
 115
 116         rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
 117
 118         if (rc < 0)
 119                 return rc;
 120
 121         /* Enable energy detect mode for this SMSC Transceivers */
 122         rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
 123                        rc | MII_LAN83C185_EDPWRDOWN);
 124         if (rc < 0)
 125                 return rc;
 126
 127         return smsc_phy_ack_interrupt(phydev);
 128 }
 129
 130 static int smsc_phy_reset(struct phy_device *phydev)
 131 {
 132         int rc = phy_read(phydev, MII_LAN83C185_SPECIAL_MODES);
 133         if (rc < 0)
 134                 return rc;
 135
 136         /* If the SMSC PHY is in power down mode, then set it
 137          * in all capable mode before using it.
 138          */
 139         if ((rc & MII_LAN83C185_MODE_MASK) == MII_LAN83C185_MODE_POWERDOWN) {
 140                 /* set "all capable" mode */
 141                 rc |= MII_LAN83C185_MODE_ALL;
 142                 phy_write(phydev, MII_LAN83C185_SPECIAL_MODES, rc);
 143         }
 144
 145         /* reset the phy */
 146         return genphy_soft_reset(phydev);
 147 }
 148
 149 static int lan911x_config_init(struct phy_device *phydev)
 150 {
 151         return smsc_phy_ack_interrupt(phydev);
 152 }
 153
 154 static int lan87xx_config_aneg(struct phy_device *phydev)
 155 {
 156         int rc;
 157         int val;
 158
 159         switch (phydev->mdix_ctrl) {
 160         case ETH_TP_MDI:
 161                 val = SPECIAL_CTRL_STS_OVRRD_AMDIX_;
 162                 break;
 163         case ETH_TP_MDI_X:
 164                 val = SPECIAL_CTRL_STS_OVRRD_AMDIX_ |
 165                         SPECIAL_CTRL_STS_AMDIX_STATE_;
 166                 break;
 167         case ETH_TP_MDI_AUTO:
 168                 val = SPECIAL_CTRL_STS_AMDIX_ENABLE_;
 169                 break;
 170         default:
 171                 return genphy_config_aneg(phydev);
 172         }
 173
 174         rc = phy_read(phydev, SPECIAL_CTRL_STS);
 175         if (rc < 0)
 176                 return rc;
 177
 178         rc &= ~(SPECIAL_CTRL_STS_OVRRD_AMDIX_ |
 179                 SPECIAL_CTRL_STS_AMDIX_ENABLE_ |
 180                 SPECIAL_CTRL_STS_AMDIX_STATE_);
 181         rc |= val;
 182         phy_write(phydev, SPECIAL_CTRL_STS, rc);
 183
 184         phydev->mdix = phydev->mdix_ctrl;
 185         return genphy_config_aneg(phydev);
 186 }
 187
 188 static int lan95xx_config_aneg_ext(struct phy_device *phydev)
 189 {
 190         int rc;
 191
 192         if (phydev->phy_id != 0x0007c0f0) /* not (LAN9500A or LAN9505A) */
 193                 return lan87xx_config_aneg(phydev);
 194
 195         /* Extend Manual AutoMDIX timer */
 196         rc = phy_read(phydev, PHY_EDPD_CONFIG);
 197         if (rc < 0)
 198                 return rc;
 199
 200         rc |= PHY_EDPD_CONFIG_EXT_CROSSOVER_;
 201         phy_write(phydev, PHY_EDPD_CONFIG, rc);
 202         return lan87xx_config_aneg(phydev);
 203 }
 204
 205 /*
 206  * The LAN87xx suffers from rare absence of the ENERGYON-bit when Ethernet cable
 207  * plugs in while LAN87xx is in Energy Detect Power-Down mode. This leads to
 208  * unstable detection of plugging in Ethernet cable.
 209  * This workaround disables Energy Detect Power-Down mode and waiting for
 210  * response on link pulses to detect presence of plugged Ethernet cable.
 211  * The Energy Detect Power-Down mode is enabled again in the end of procedure to
 212  * save approximately 220 mW of power if cable is unplugged.
 213  */
 214 static int lan87xx_read_status(struct phy_device *phydev)
 215 {
 216         struct smsc_phy_priv *priv = phydev->priv;
 217
 218         int err = genphy_read_status(phydev);
 219
 220         if (!phydev->link && priv->energy_enable) {
 221                 int energy_detected;
 222
 223                 /* Disable EDPD to wake up PHY */
 224                 int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
 225                 if (rc < 0)
 226                         return rc;
 227
 228                 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
 229                                rc & ~MII_LAN83C185_EDPWRDOWN);
 230                 if (rc < 0)
 231                         return rc;
 232
 233                 /* Wait max 1500 ms to detect energy and the timeout is not
 234                  * an actual error.
 235                  */
 236                 read_poll_timeout(phy_read, rc,
 237                                   rc & MII_LAN83C185_ENERGYON || rc < 0,
 238                                   150000, 1500000, true, phydev,
 239                                   MII_LAN83C185_CTRL_STATUS);
 240                 if (rc < 0)
 241                         return rc;
 242
 243                 /* Re-enable EDPD */
 244                 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
 245                 if (rc < 0)
 246                         return rc;
 247
 248                 energy_detected = !!(rc & MII_LAN83C185_ENERGYON);
 249
 250                 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
 251                                rc | MII_LAN83C185_EDPWRDOWN);
 252                 if (rc < 0)
 253                         return rc;
 254
 255                 /* Save CPU and power by deferring the next poll */
 256                 if (!energy_detected)
 257                         msleep(2000);
 258         }
 259
 260         return err;
 261 }
 262
 263 static int smsc_get_sset_count(struct phy_device *phydev)
 264 {
 265         return ARRAY_SIZE(smsc_hw_stats);
 266 }
 267
 268 static void smsc_get_strings(struct phy_device *phydev, u8 *data)
 269 {
 270         int i;
 271
 272         for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++) {
 273                 strncpy(data + i * ETH_GSTRING_LEN,
 274                        smsc_hw_stats[i].string, ETH_GSTRING_LEN);
 275         }
 276 }
 277
 278 static u64 smsc_get_stat(struct phy_device *phydev, int i)
 279 {
 280         struct smsc_hw_stat stat = smsc_hw_stats[i];
 281         int val;
 282         u64 ret;
 283
 284         val = phy_read(phydev, stat.reg);
 285         if (val < 0)
 286                 ret = U64_MAX;
 287         else
 288                 ret = val;
 289
 290         return ret;
 291 }
 292
 293 static void smsc_get_stats(struct phy_device *phydev,
 294                            struct ethtool_stats *stats, u64 *data)
 295 {
 296         int i;
 297
 298         for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++)
 299                 data[i] = smsc_get_stat(phydev, i);
 300 }
 301
 302 static void smsc_phy_remove(struct phy_device *phydev)
 303 {
 304         struct smsc_phy_priv *priv = phydev->priv;
 305
 306         clk_disable_unprepare(priv->refclk);
 307         clk_put(priv->refclk);
 308 }
 309
 310 static int smsc_phy_probe(struct phy_device *phydev)
 311 {
 312         struct device *dev = &phydev->mdio.dev;
 313         struct device_node *of_node = dev->of_node;
 314         struct smsc_phy_priv *priv;
 315         int ret;
 316
 317         priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 318         if (!priv)
 319                 return -ENOMEM;
 320
 321         priv->energy_enable = true;
 322
 323         if (of_property_read_bool(of_node, "smsc,disable-energy-detect"))
 324                 priv->energy_enable = false;
 325
 326         phydev->priv = priv;
 327
 328         /* Make clk optional to keep DTB backward compatibility. */
 329         priv->refclk = clk_get_optional(dev, NULL);
 330         if (IS_ERR(priv->refclk))
 331                 return dev_err_probe(dev, PTR_ERR(priv->refclk),
 332                                      "Failed to request clock\n");
 333
 334         ret = clk_prepare_enable(priv->refclk);
 335         if (ret)
 336                 return ret;
 337
 338         ret = clk_set_rate(priv->refclk, 50 * 1000 * 1000);
 339         if (ret) {
 340                 clk_disable_unprepare(priv->refclk);
 341                 return ret;
 342         }
 343
 344         return 0;
 345 }
 346
 347 static struct phy_driver smsc_phy_driver[] = {
 348 {
 349         .phy_id         = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
 350         .phy_id_mask    = 0xfffffff0,
 351         .name           = "SMSC LAN83C185",
 352
 353         /* PHY_BASIC_FEATURES */
 354
 355         .probe          = smsc_phy_probe,
 356
 357         /* basic functions */
 358         .config_init    = smsc_phy_config_init,
 359         .soft_reset     = smsc_phy_reset,
 360
 361         /* IRQ related */
 362         .config_intr    = smsc_phy_config_intr,
 363         .handle_interrupt = smsc_phy_handle_interrupt,
 364
 365         .suspend        = genphy_suspend,
 366         .resume         = genphy_resume,
 367 }, {
 368         .phy_id         = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
 369         .phy_id_mask    = 0xfffffff0,
 370         .name           = "SMSC LAN8187",
 371
 372         /* PHY_BASIC_FEATURES */
 373
 374         .probe          = smsc_phy_probe,
 375
 376         /* basic functions */
 377         .config_init    = smsc_phy_config_init,
 378         .soft_reset     = smsc_phy_reset,
 379
 380         /* IRQ related */
 381         .config_intr    = smsc_phy_config_intr,
 382         .handle_interrupt = smsc_phy_handle_interrupt,
 383
 384         /* Statistics */
 385         .get_sset_count = smsc_get_sset_count,
 386         .get_strings    = smsc_get_strings,
 387         .get_stats      = smsc_get_stats,
 388
 389         .suspend        = genphy_suspend,
 390         .resume         = genphy_resume,
 391 }, {
 392         /* This covers internal PHY (phy_id: 0x0007C0C3) for
 393          * LAN9500 (PID: 0x9500), LAN9514 (PID: 0xec00), LAN9505 (PID: 0x9505)
 394          */
 395         .phy_id         = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
 396         .phy_id_mask    = 0xfffffff0,
 397         .name           = "SMSC LAN8700",
 398
 399         /* PHY_BASIC_FEATURES */
 400
 401         .probe          = smsc_phy_probe,
 402
 403         /* basic functions */
 404         .read_status    = lan87xx_read_status,
 405         .config_init    = smsc_phy_config_init,
 406         .soft_reset     = smsc_phy_reset,
 407         .config_aneg    = lan87xx_config_aneg,
 408
 409         /* IRQ related */
 410         .config_intr    = smsc_phy_config_intr,
 411         .handle_interrupt = smsc_phy_handle_interrupt,
 412
 413         /* Statistics */
 414         .get_sset_count = smsc_get_sset_count,
 415         .get_strings    = smsc_get_strings,
 416         .get_stats      = smsc_get_stats,
 417
 418         .suspend        = genphy_suspend,
 419         .resume         = genphy_resume,
 420 }, {
 421         .phy_id         = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
 422         .phy_id_mask    = 0xfffffff0,
 423         .name           = "SMSC LAN911x Internal PHY",
 424
 425         /* PHY_BASIC_FEATURES */
 426
 427         .probe          = smsc_phy_probe,
 428
 429         /* basic functions */
 430         .config_init    = lan911x_config_init,
 431
 432         /* IRQ related */
 433         .config_intr    = smsc_phy_config_intr,
 434         .handle_interrupt = smsc_phy_handle_interrupt,
 435
 436         .suspend        = genphy_suspend,
 437         .resume         = genphy_resume,
 438 }, {
 439         /* This covers internal PHY (phy_id: 0x0007C0F0) for
 440          * LAN9500A (PID: 0x9E00), LAN9505A (PID: 0x9E01)
 441          */
 442         .phy_id         = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
 443         .phy_id_mask    = 0xfffffff0,
 444         .name           = "SMSC LAN8710/LAN8720",
 445
 446         /* PHY_BASIC_FEATURES */
 447
 448         .probe          = smsc_phy_probe,
 449         .remove         = smsc_phy_remove,
 450
 451         /* basic functions */
 452         .read_status    = lan87xx_read_status,
 453         .config_init    = smsc_phy_config_init,
 454         .soft_reset     = smsc_phy_reset,
 455         .config_aneg    = lan95xx_config_aneg_ext,
 456
 457         /* IRQ related */
 458         .config_intr    = smsc_phy_config_intr,
 459         .handle_interrupt = smsc_phy_handle_interrupt,
 460
 461         /* Statistics */
 462         .get_sset_count = smsc_get_sset_count,
 463         .get_strings    = smsc_get_strings,
 464         .get_stats      = smsc_get_stats,
 465
 466         .suspend        = genphy_suspend,
 467         .resume         = genphy_resume,
 468 }, {
 469         .phy_id         = 0x0007c110,
 470         .phy_id_mask    = 0xfffffff0,
 471         .name           = "SMSC LAN8740",
 472
 473         /* PHY_BASIC_FEATURES */
 474         .flags          = PHY_RST_AFTER_CLK_EN,
 475
 476         .probe          = smsc_phy_probe,
 477
 478         /* basic functions */
 479         .read_status    = lan87xx_read_status,
 480         .config_init    = smsc_phy_config_init,
 481         .soft_reset     = smsc_phy_reset,
 482
 483         /* IRQ related */
 484         .config_intr    = smsc_phy_config_intr,
 485         .handle_interrupt = smsc_phy_handle_interrupt,
 486
 487         /* Statistics */
 488         .get_sset_count = smsc_get_sset_count,
 489         .get_strings    = smsc_get_strings,
 490         .get_stats      = smsc_get_stats,
 491
 492         .suspend        = genphy_suspend,
 493         .resume         = genphy_resume,
 494 } };
 495
 496 module_phy_driver(smsc_phy_driver);
 497
 498 MODULE_DESCRIPTION("SMSC PHY driver");
 499 MODULE_AUTHOR("Herbert Valerio Riedel");
 500 MODULE_LICENSE("GPL");
 501
 502 static struct mdio_device_id __maybe_unused smsc_tbl[] = {
 503         { 0x0007c0a0, 0xfffffff0 },
 504         { 0x0007c0b0, 0xfffffff0 },
 505         { 0x0007c0c0, 0xfffffff0 },
 506         { 0x0007c0d0, 0xfffffff0 },
 507         { 0x0007c0f0, 0xfffffff0 },
 508         { 0x0007c110, 0xfffffff0 },
 509         { }
 510 };
 511
 512 MODULE_DEVICE_TABLE(mdio, smsc_tbl);