1 // SPDX-License-Identifier: GPL-2.0+
3 * drivers/net/phy/smsc.c
7 * Author: Herbert Valerio Riedel
9 * Copyright (c) 2006 Herbert Valerio Riedel <hvr@gnu.org>
11 * Support added for SMSC LAN8187 and LAN8700 by steve.glendinning@shawell.net
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>
21 #include <linux/phy.h>
22 #include <linux/netdevice.h>
23 #include <linux/smscphy.h>
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
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
42 static struct smsc_hw_stat smsc_hw_stats[] = {
43 { "phy_symbol_errors", 26, 16},
46 struct smsc_phy_priv {
51 static int smsc_phy_ack_interrupt(struct phy_device *phydev)
53 int rc = phy_read(phydev, MII_LAN83C185_ISF);
55 return rc < 0 ? rc : 0;
58 static int smsc_phy_config_intr(struct phy_device *phydev)
60 struct smsc_phy_priv *priv = phydev->priv;
63 if (phydev->interrupts == PHY_INTERRUPT_ENABLED) {
64 rc = smsc_phy_ack_interrupt(phydev);
68 priv->intmask = MII_LAN83C185_ISF_INT4 | MII_LAN83C185_ISF_INT6;
69 if (priv->energy_enable)
70 priv->intmask |= MII_LAN83C185_ISF_INT7;
72 rc = phy_write(phydev, MII_LAN83C185_IM, priv->intmask);
76 rc = phy_write(phydev, MII_LAN83C185_IM, 0);
80 rc = smsc_phy_ack_interrupt(phydev);
83 return rc < 0 ? rc : 0;
86 static irqreturn_t smsc_phy_handle_interrupt(struct phy_device *phydev)
88 struct smsc_phy_priv *priv = phydev->priv;
91 irq_status = phy_read(phydev, MII_LAN83C185_ISF);
93 if (irq_status != -ENODEV)
99 if (!(irq_status & priv->intmask))
102 phy_trigger_machine(phydev);
107 static int smsc_phy_config_init(struct phy_device *phydev)
109 struct smsc_phy_priv *priv = phydev->priv;
112 if (!priv->energy_enable || phydev->irq != PHY_POLL)
115 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
120 /* Enable energy detect mode for this SMSC Transceivers */
121 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
122 rc | MII_LAN83C185_EDPWRDOWN);
126 static int smsc_phy_reset(struct phy_device *phydev)
128 int rc = phy_read(phydev, MII_LAN83C185_SPECIAL_MODES);
132 /* If the SMSC PHY is in power down mode, then set it
133 * in all capable mode before using it.
135 if ((rc & MII_LAN83C185_MODE_MASK) == MII_LAN83C185_MODE_POWERDOWN) {
136 /* set "all capable" mode */
137 rc |= MII_LAN83C185_MODE_ALL;
138 phy_write(phydev, MII_LAN83C185_SPECIAL_MODES, rc);
142 return genphy_soft_reset(phydev);
145 static int lan87xx_config_aneg(struct phy_device *phydev)
150 switch (phydev->mdix_ctrl) {
152 val = SPECIAL_CTRL_STS_OVRRD_AMDIX_;
155 val = SPECIAL_CTRL_STS_OVRRD_AMDIX_ |
156 SPECIAL_CTRL_STS_AMDIX_STATE_;
158 case ETH_TP_MDI_AUTO:
159 val = SPECIAL_CTRL_STS_AMDIX_ENABLE_;
162 return genphy_config_aneg(phydev);
165 rc = phy_read(phydev, SPECIAL_CTRL_STS);
169 rc &= ~(SPECIAL_CTRL_STS_OVRRD_AMDIX_ |
170 SPECIAL_CTRL_STS_AMDIX_ENABLE_ |
171 SPECIAL_CTRL_STS_AMDIX_STATE_);
173 phy_write(phydev, SPECIAL_CTRL_STS, rc);
175 phydev->mdix = phydev->mdix_ctrl;
176 return genphy_config_aneg(phydev);
179 static int lan95xx_config_aneg_ext(struct phy_device *phydev)
183 if (phydev->phy_id != 0x0007c0f0) /* not (LAN9500A or LAN9505A) */
184 return lan87xx_config_aneg(phydev);
186 /* Extend Manual AutoMDIX timer */
187 rc = phy_read(phydev, PHY_EDPD_CONFIG);
191 rc |= PHY_EDPD_CONFIG_EXT_CROSSOVER_;
192 phy_write(phydev, PHY_EDPD_CONFIG, rc);
193 return lan87xx_config_aneg(phydev);
197 * The LAN87xx suffers from rare absence of the ENERGYON-bit when Ethernet cable
198 * plugs in while LAN87xx is in Energy Detect Power-Down mode. This leads to
199 * unstable detection of plugging in Ethernet cable.
200 * This workaround disables Energy Detect Power-Down mode and waiting for
201 * response on link pulses to detect presence of plugged Ethernet cable.
202 * The Energy Detect Power-Down mode is enabled again in the end of procedure to
203 * save approximately 220 mW of power if cable is unplugged.
204 * The workaround is only applicable to poll mode. Energy Detect Power-Down may
205 * not be used in interrupt mode lest link change detection becomes unreliable.
207 static int lan87xx_read_status(struct phy_device *phydev)
209 struct smsc_phy_priv *priv = phydev->priv;
211 int err = genphy_read_status(phydev);
213 if (!phydev->link && priv->energy_enable && phydev->irq == PHY_POLL) {
214 /* Disable EDPD to wake up PHY */
215 int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
219 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
220 rc & ~MII_LAN83C185_EDPWRDOWN);
224 /* Wait max 640 ms to detect energy and the timeout is not
227 read_poll_timeout(phy_read, rc,
228 rc & MII_LAN83C185_ENERGYON || rc < 0,
229 10000, 640000, true, phydev,
230 MII_LAN83C185_CTRL_STATUS);
235 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
239 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
240 rc | MII_LAN83C185_EDPWRDOWN);
248 static int smsc_get_sset_count(struct phy_device *phydev)
250 return ARRAY_SIZE(smsc_hw_stats);
253 static void smsc_get_strings(struct phy_device *phydev, u8 *data)
257 for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++) {
258 strncpy(data + i * ETH_GSTRING_LEN,
259 smsc_hw_stats[i].string, ETH_GSTRING_LEN);
263 static u64 smsc_get_stat(struct phy_device *phydev, int i)
265 struct smsc_hw_stat stat = smsc_hw_stats[i];
269 val = phy_read(phydev, stat.reg);
278 static void smsc_get_stats(struct phy_device *phydev,
279 struct ethtool_stats *stats, u64 *data)
283 for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++)
284 data[i] = smsc_get_stat(phydev, i);
287 static int smsc_phy_probe(struct phy_device *phydev)
289 struct device *dev = &phydev->mdio.dev;
290 struct device_node *of_node = dev->of_node;
291 struct smsc_phy_priv *priv;
294 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
298 priv->energy_enable = true;
300 if (of_property_read_bool(of_node, "smsc,disable-energy-detect"))
301 priv->energy_enable = false;
305 /* Make clk optional to keep DTB backward compatibility. */
306 refclk = devm_clk_get_optional_enabled(dev, NULL);
308 return dev_err_probe(dev, PTR_ERR(refclk),
309 "Failed to request clock\n");
311 return clk_set_rate(refclk, 50 * 1000 * 1000);
314 static struct phy_driver smsc_phy_driver[] = {
316 .phy_id = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
317 .phy_id_mask = 0xfffffff0,
318 .name = "SMSC LAN83C185",
320 /* PHY_BASIC_FEATURES */
322 .probe = smsc_phy_probe,
324 /* basic functions */
325 .config_init = smsc_phy_config_init,
326 .soft_reset = smsc_phy_reset,
329 .config_intr = smsc_phy_config_intr,
330 .handle_interrupt = smsc_phy_handle_interrupt,
332 .suspend = genphy_suspend,
333 .resume = genphy_resume,
335 .phy_id = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
336 .phy_id_mask = 0xfffffff0,
337 .name = "SMSC LAN8187",
339 /* PHY_BASIC_FEATURES */
341 .probe = smsc_phy_probe,
343 /* basic functions */
344 .config_init = smsc_phy_config_init,
345 .soft_reset = smsc_phy_reset,
348 .config_intr = smsc_phy_config_intr,
349 .handle_interrupt = smsc_phy_handle_interrupt,
352 .get_sset_count = smsc_get_sset_count,
353 .get_strings = smsc_get_strings,
354 .get_stats = smsc_get_stats,
356 .suspend = genphy_suspend,
357 .resume = genphy_resume,
359 /* This covers internal PHY (phy_id: 0x0007C0C3) for
360 * LAN9500 (PID: 0x9500), LAN9514 (PID: 0xec00), LAN9505 (PID: 0x9505)
362 .phy_id = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
363 .phy_id_mask = 0xfffffff0,
364 .name = "SMSC LAN8700",
366 /* PHY_BASIC_FEATURES */
368 .probe = smsc_phy_probe,
370 /* basic functions */
371 .read_status = lan87xx_read_status,
372 .config_init = smsc_phy_config_init,
373 .soft_reset = smsc_phy_reset,
374 .config_aneg = lan87xx_config_aneg,
377 .config_intr = smsc_phy_config_intr,
378 .handle_interrupt = smsc_phy_handle_interrupt,
381 .get_sset_count = smsc_get_sset_count,
382 .get_strings = smsc_get_strings,
383 .get_stats = smsc_get_stats,
385 .suspend = genphy_suspend,
386 .resume = genphy_resume,
388 .phy_id = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
389 .phy_id_mask = 0xfffffff0,
390 .name = "SMSC LAN911x Internal PHY",
392 /* PHY_BASIC_FEATURES */
394 .probe = smsc_phy_probe,
397 .config_intr = smsc_phy_config_intr,
398 .handle_interrupt = smsc_phy_handle_interrupt,
400 .suspend = genphy_suspend,
401 .resume = genphy_resume,
403 /* This covers internal PHY (phy_id: 0x0007C0F0) for
404 * LAN9500A (PID: 0x9E00), LAN9505A (PID: 0x9E01)
406 .phy_id = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
407 .phy_id_mask = 0xfffffff0,
408 .name = "SMSC LAN8710/LAN8720",
410 /* PHY_BASIC_FEATURES */
412 .probe = smsc_phy_probe,
414 /* basic functions */
415 .read_status = lan87xx_read_status,
416 .config_init = smsc_phy_config_init,
417 .soft_reset = smsc_phy_reset,
418 .config_aneg = lan95xx_config_aneg_ext,
421 .config_intr = smsc_phy_config_intr,
422 .handle_interrupt = smsc_phy_handle_interrupt,
425 .get_sset_count = smsc_get_sset_count,
426 .get_strings = smsc_get_strings,
427 .get_stats = smsc_get_stats,
429 .suspend = genphy_suspend,
430 .resume = genphy_resume,
432 .phy_id = 0x0007c110,
433 .phy_id_mask = 0xfffffff0,
434 .name = "SMSC LAN8740",
436 /* PHY_BASIC_FEATURES */
437 .flags = PHY_RST_AFTER_CLK_EN,
439 .probe = smsc_phy_probe,
441 /* basic functions */
442 .read_status = lan87xx_read_status,
443 .config_init = smsc_phy_config_init,
444 .soft_reset = smsc_phy_reset,
447 .config_intr = smsc_phy_config_intr,
448 .handle_interrupt = smsc_phy_handle_interrupt,
451 .get_sset_count = smsc_get_sset_count,
452 .get_strings = smsc_get_strings,
453 .get_stats = smsc_get_stats,
455 .suspend = genphy_suspend,
456 .resume = genphy_resume,
458 .phy_id = 0x0007c130, /* 0x0007c130 and 0x0007c131 */
459 /* This mask (0xfffffff2) is to differentiate from
460 * LAN88xx (phy_id 0x0007c132)
461 * and allows future phy_id revisions.
463 .phy_id_mask = 0xfffffff2,
464 .name = "Microchip LAN8742",
466 /* PHY_BASIC_FEATURES */
467 .flags = PHY_RST_AFTER_CLK_EN,
469 .probe = smsc_phy_probe,
471 /* basic functions */
472 .read_status = lan87xx_read_status,
473 .config_init = smsc_phy_config_init,
474 .soft_reset = smsc_phy_reset,
477 .config_intr = smsc_phy_config_intr,
478 .handle_interrupt = smsc_phy_handle_interrupt,
481 .get_sset_count = smsc_get_sset_count,
482 .get_strings = smsc_get_strings,
483 .get_stats = smsc_get_stats,
485 .suspend = genphy_suspend,
486 .resume = genphy_resume,
489 module_phy_driver(smsc_phy_driver);
491 MODULE_DESCRIPTION("SMSC PHY driver");
492 MODULE_AUTHOR("Herbert Valerio Riedel");
493 MODULE_LICENSE("GPL");
495 static struct mdio_device_id __maybe_unused smsc_tbl[] = {
496 { 0x0007c0a0, 0xfffffff0 },
497 { 0x0007c0b0, 0xfffffff0 },
498 { 0x0007c0c0, 0xfffffff0 },
499 { 0x0007c0d0, 0xfffffff0 },
500 { 0x0007c0f0, 0xfffffff0 },
501 { 0x0007c110, 0xfffffff0 },
502 { 0x0007c130, 0xfffffff2 },
506 MODULE_DEVICE_TABLE(mdio, smsc_tbl);