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                 /* Disable EDPD to wake up PHY */
 222                 int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
 223                 if (rc < 0)
 224                         return rc;
 225
 226                 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
 227                                rc & ~MII_LAN83C185_EDPWRDOWN);
 228                 if (rc < 0)
 229                         return rc;
 230
 231                 /* Wait max 640 ms to detect energy and the timeout is not
 232                  * an actual error.
 233                  */
 234                 read_poll_timeout(phy_read, rc,
 235                                   rc & MII_LAN83C185_ENERGYON || rc < 0,
 236                                   10000, 640000, true, phydev,
 237                                   MII_LAN83C185_CTRL_STATUS);
 238                 if (rc < 0)
 239                         return rc;
 240
 241                 /* Re-enable EDPD */
 242                 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
 243                 if (rc < 0)
 244                         return rc;
 245
 246                 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
 247                                rc | MII_LAN83C185_EDPWRDOWN);
 248                 if (rc < 0)
 249                         return rc;
 250         }
 251
 252         return err;
 253 }
 254
 255 static int smsc_get_sset_count(struct phy_device *phydev)
 256 {
 257         return ARRAY_SIZE(smsc_hw_stats);
 258 }
 259
 260 static void smsc_get_strings(struct phy_device *phydev, u8 *data)
 261 {
 262         int i;
 263
 264         for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++) {
 265                 strncpy(data + i * ETH_GSTRING_LEN,
 266                        smsc_hw_stats[i].string, ETH_GSTRING_LEN);
 267         }
 268 }
 269
 270 static u64 smsc_get_stat(struct phy_device *phydev, int i)
 271 {
 272         struct smsc_hw_stat stat = smsc_hw_stats[i];
 273         int val;
 274         u64 ret;
 275
 276         val = phy_read(phydev, stat.reg);
 277         if (val < 0)
 278                 ret = U64_MAX;
 279         else
 280                 ret = val;
 281
 282         return ret;
 283 }
 284
 285 static void smsc_get_stats(struct phy_device *phydev,
 286                            struct ethtool_stats *stats, u64 *data)
 287 {
 288         int i;
 289
 290         for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++)
 291                 data[i] = smsc_get_stat(phydev, i);
 292 }
 293
 294 static void smsc_phy_remove(struct phy_device *phydev)
 295 {
 296         struct smsc_phy_priv *priv = phydev->priv;
 297
 298         clk_disable_unprepare(priv->refclk);
 299         clk_put(priv->refclk);
 300 }
 301
 302 static int smsc_phy_probe(struct phy_device *phydev)
 303 {
 304         struct device *dev = &phydev->mdio.dev;
 305         struct device_node *of_node = dev->of_node;
 306         struct smsc_phy_priv *priv;
 307         int ret;
 308
 309         priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 310         if (!priv)
 311                 return -ENOMEM;
 312
 313         priv->energy_enable = true;
 314
 315         if (of_property_read_bool(of_node, "smsc,disable-energy-detect"))
 316                 priv->energy_enable = false;
 317
 318         phydev->priv = priv;
 319
 320         /* Make clk optional to keep DTB backward compatibility. */
 321         priv->refclk = clk_get_optional(dev, NULL);
 322         if (IS_ERR(priv->refclk))
 323                 return dev_err_probe(dev, PTR_ERR(priv->refclk),
 324                                      "Failed to request clock\n");
 325
 326         ret = clk_prepare_enable(priv->refclk);
 327         if (ret)
 328                 return ret;
 329
 330         ret = clk_set_rate(priv->refclk, 50 * 1000 * 1000);
 331         if (ret) {
 332                 clk_disable_unprepare(priv->refclk);
 333                 return ret;
 334         }
 335
 336         return 0;
 337 }
 338
 339 static struct phy_driver smsc_phy_driver[] = {
 340 {
 341         .phy_id         = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
 342         .phy_id_mask    = 0xfffffff0,
 343         .name           = "SMSC LAN83C185",
 344
 345         /* PHY_BASIC_FEATURES */
 346
 347         .probe          = smsc_phy_probe,
 348
 349         /* basic functions */
 350         .config_init    = smsc_phy_config_init,
 351         .soft_reset     = smsc_phy_reset,
 352
 353         /* IRQ related */
 354         .config_intr    = smsc_phy_config_intr,
 355         .handle_interrupt = smsc_phy_handle_interrupt,
 356
 357         .suspend        = genphy_suspend,
 358         .resume         = genphy_resume,
 359 }, {
 360         .phy_id         = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
 361         .phy_id_mask    = 0xfffffff0,
 362         .name           = "SMSC LAN8187",
 363
 364         /* PHY_BASIC_FEATURES */
 365
 366         .probe          = smsc_phy_probe,
 367
 368         /* basic functions */
 369         .config_init    = smsc_phy_config_init,
 370         .soft_reset     = smsc_phy_reset,
 371
 372         /* IRQ related */
 373         .config_intr    = smsc_phy_config_intr,
 374         .handle_interrupt = smsc_phy_handle_interrupt,
 375
 376         /* Statistics */
 377         .get_sset_count = smsc_get_sset_count,
 378         .get_strings    = smsc_get_strings,
 379         .get_stats      = smsc_get_stats,
 380
 381         .suspend        = genphy_suspend,
 382         .resume         = genphy_resume,
 383 }, {
 384         /* This covers internal PHY (phy_id: 0x0007C0C3) for
 385          * LAN9500 (PID: 0x9500), LAN9514 (PID: 0xec00), LAN9505 (PID: 0x9505)
 386          */
 387         .phy_id         = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
 388         .phy_id_mask    = 0xfffffff0,
 389         .name           = "SMSC LAN8700",
 390
 391         /* PHY_BASIC_FEATURES */
 392
 393         .probe          = smsc_phy_probe,
 394
 395         /* basic functions */
 396         .read_status    = lan87xx_read_status,
 397         .config_init    = smsc_phy_config_init,
 398         .soft_reset     = smsc_phy_reset,
 399         .config_aneg    = lan87xx_config_aneg,
 400
 401         /* IRQ related */
 402         .config_intr    = smsc_phy_config_intr,
 403         .handle_interrupt = smsc_phy_handle_interrupt,
 404
 405         /* Statistics */
 406         .get_sset_count = smsc_get_sset_count,
 407         .get_strings    = smsc_get_strings,
 408         .get_stats      = smsc_get_stats,
 409
 410         .suspend        = genphy_suspend,
 411         .resume         = genphy_resume,
 412 }, {
 413         .phy_id         = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
 414         .phy_id_mask    = 0xfffffff0,
 415         .name           = "SMSC LAN911x Internal PHY",
 416
 417         /* PHY_BASIC_FEATURES */
 418
 419         .probe          = smsc_phy_probe,
 420
 421         /* basic functions */
 422         .config_init    = lan911x_config_init,
 423
 424         /* IRQ related */
 425         .config_intr    = smsc_phy_config_intr,
 426         .handle_interrupt = smsc_phy_handle_interrupt,
 427
 428         .suspend        = genphy_suspend,
 429         .resume         = genphy_resume,
 430 }, {
 431         /* This covers internal PHY (phy_id: 0x0007C0F0) for
 432          * LAN9500A (PID: 0x9E00), LAN9505A (PID: 0x9E01)
 433          */
 434         .phy_id         = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
 435         .phy_id_mask    = 0xfffffff0,
 436         .name           = "SMSC LAN8710/LAN8720",
 437
 438         /* PHY_BASIC_FEATURES */
 439
 440         .probe          = smsc_phy_probe,
 441         .remove         = smsc_phy_remove,
 442
 443         /* basic functions */
 444         .read_status    = lan87xx_read_status,
 445         .config_init    = smsc_phy_config_init,
 446         .soft_reset     = smsc_phy_reset,
 447         .config_aneg    = lan95xx_config_aneg_ext,
 448
 449         /* IRQ related */
 450         .config_intr    = smsc_phy_config_intr,
 451         .handle_interrupt = smsc_phy_handle_interrupt,
 452
 453         /* Statistics */
 454         .get_sset_count = smsc_get_sset_count,
 455         .get_strings    = smsc_get_strings,
 456         .get_stats      = smsc_get_stats,
 457
 458         .suspend        = genphy_suspend,
 459         .resume         = genphy_resume,
 460 }, {
 461         .phy_id         = 0x0007c110,
 462         .phy_id_mask    = 0xfffffff0,
 463         .name           = "SMSC LAN8740",
 464
 465         /* PHY_BASIC_FEATURES */
 466         .flags          = PHY_RST_AFTER_CLK_EN,
 467
 468         .probe          = smsc_phy_probe,
 469
 470         /* basic functions */
 471         .read_status    = lan87xx_read_status,
 472         .config_init    = smsc_phy_config_init,
 473         .soft_reset     = smsc_phy_reset,
 474
 475         /* IRQ related */
 476         .config_intr    = smsc_phy_config_intr,
 477         .handle_interrupt = smsc_phy_handle_interrupt,
 478
 479         /* Statistics */
 480         .get_sset_count = smsc_get_sset_count,
 481         .get_strings    = smsc_get_strings,
 482         .get_stats      = smsc_get_stats,
 483
 484         .suspend        = genphy_suspend,
 485         .resume         = genphy_resume,
 486 } };
 487
 488 module_phy_driver(smsc_phy_driver);
 489
 490 MODULE_DESCRIPTION("SMSC PHY driver");
 491 MODULE_AUTHOR("Herbert Valerio Riedel");
 492 MODULE_LICENSE("GPL");
 493
 494 static struct mdio_device_id __maybe_unused smsc_tbl[] = {
 495         { 0x0007c0a0, 0xfffffff0 },
 496         { 0x0007c0b0, 0xfffffff0 },
 497         { 0x0007c0c0, 0xfffffff0 },
 498         { 0x0007c0d0, 0xfffffff0 },
 499         { 0x0007c0f0, 0xfffffff0 },
 500         { 0x0007c110, 0xfffffff0 },
 501         { }
 502 };
 503
 504 MODULE_DEVICE_TABLE(mdio, smsc_tbl);