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;
64 if (phydev->interrupts == PHY_INTERRUPT_ENABLED) {
65 rc = smsc_phy_ack_interrupt(phydev);
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);
74 rc = phy_write(phydev, MII_LAN83C185_IM, intmask);
78 rc = smsc_phy_ack_interrupt(phydev);
81 return rc < 0 ? rc : 0;
84 static irqreturn_t smsc_phy_handle_interrupt(struct phy_device *phydev)
86 int irq_status, irq_enabled;
88 irq_enabled = phy_read(phydev, MII_LAN83C185_IM);
89 if (irq_enabled < 0) {
94 irq_status = phy_read(phydev, MII_LAN83C185_ISF);
100 if (!(irq_status & irq_enabled))
103 phy_trigger_machine(phydev);
108 static int smsc_phy_config_init(struct phy_device *phydev)
110 struct smsc_phy_priv *priv = phydev->priv;
113 if (!priv->energy_enable)
116 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
121 /* Enable energy detect mode for this SMSC Transceivers */
122 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
123 rc | MII_LAN83C185_EDPWRDOWN);
127 return smsc_phy_ack_interrupt(phydev);
130 static int smsc_phy_reset(struct phy_device *phydev)
132 int rc = phy_read(phydev, MII_LAN83C185_SPECIAL_MODES);
136 /* If the SMSC PHY is in power down mode, then set it
137 * in all capable mode before using it.
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);
146 return genphy_soft_reset(phydev);
149 static int lan911x_config_init(struct phy_device *phydev)
151 return smsc_phy_ack_interrupt(phydev);
154 static int lan87xx_config_aneg(struct phy_device *phydev)
159 switch (phydev->mdix_ctrl) {
161 val = SPECIAL_CTRL_STS_OVRRD_AMDIX_;
164 val = SPECIAL_CTRL_STS_OVRRD_AMDIX_ |
165 SPECIAL_CTRL_STS_AMDIX_STATE_;
167 case ETH_TP_MDI_AUTO:
168 val = SPECIAL_CTRL_STS_AMDIX_ENABLE_;
171 return genphy_config_aneg(phydev);
174 rc = phy_read(phydev, SPECIAL_CTRL_STS);
178 rc &= ~(SPECIAL_CTRL_STS_OVRRD_AMDIX_ |
179 SPECIAL_CTRL_STS_AMDIX_ENABLE_ |
180 SPECIAL_CTRL_STS_AMDIX_STATE_);
182 phy_write(phydev, SPECIAL_CTRL_STS, rc);
184 phydev->mdix = phydev->mdix_ctrl;
185 return genphy_config_aneg(phydev);
188 static int lan87xx_config_aneg_ext(struct phy_device *phydev)
192 /* Extend Manual AutoMDIX timer */
193 rc = phy_read(phydev, PHY_EDPD_CONFIG);
197 rc |= PHY_EDPD_CONFIG_EXT_CROSSOVER_;
198 phy_write(phydev, PHY_EDPD_CONFIG, rc);
199 return lan87xx_config_aneg(phydev);
203 * The LAN87xx suffers from rare absence of the ENERGYON-bit when Ethernet cable
204 * plugs in while LAN87xx is in Energy Detect Power-Down mode. This leads to
205 * unstable detection of plugging in Ethernet cable.
206 * This workaround disables Energy Detect Power-Down mode and waiting for
207 * response on link pulses to detect presence of plugged Ethernet cable.
208 * The Energy Detect Power-Down mode is enabled again in the end of procedure to
209 * save approximately 220 mW of power if cable is unplugged.
211 static int lan87xx_read_status(struct phy_device *phydev)
213 struct smsc_phy_priv *priv = phydev->priv;
215 int err = genphy_read_status(phydev);
217 if (!phydev->link && priv->energy_enable) {
218 /* Disable EDPD to wake up PHY */
219 int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
223 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
224 rc & ~MII_LAN83C185_EDPWRDOWN);
228 /* Wait max 640 ms to detect energy and the timeout is not
231 read_poll_timeout(phy_read, rc,
232 rc & MII_LAN83C185_ENERGYON || rc < 0,
233 10000, 640000, true, phydev,
234 MII_LAN83C185_CTRL_STATUS);
239 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
243 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
244 rc | MII_LAN83C185_EDPWRDOWN);
252 static int smsc_get_sset_count(struct phy_device *phydev)
254 return ARRAY_SIZE(smsc_hw_stats);
257 static void smsc_get_strings(struct phy_device *phydev, u8 *data)
261 for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++) {
262 strncpy(data + i * ETH_GSTRING_LEN,
263 smsc_hw_stats[i].string, ETH_GSTRING_LEN);
267 static u64 smsc_get_stat(struct phy_device *phydev, int i)
269 struct smsc_hw_stat stat = smsc_hw_stats[i];
273 val = phy_read(phydev, stat.reg);
282 static void smsc_get_stats(struct phy_device *phydev,
283 struct ethtool_stats *stats, u64 *data)
287 for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++)
288 data[i] = smsc_get_stat(phydev, i);
291 static void smsc_phy_remove(struct phy_device *phydev)
293 struct smsc_phy_priv *priv = phydev->priv;
295 clk_disable_unprepare(priv->refclk);
296 clk_put(priv->refclk);
299 static int smsc_phy_probe(struct phy_device *phydev)
301 struct device *dev = &phydev->mdio.dev;
302 struct device_node *of_node = dev->of_node;
303 struct smsc_phy_priv *priv;
306 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
310 priv->energy_enable = true;
312 if (of_property_read_bool(of_node, "smsc,disable-energy-detect"))
313 priv->energy_enable = false;
317 /* Make clk optional to keep DTB backward compatibility. */
318 priv->refclk = clk_get_optional(dev, NULL);
319 if (IS_ERR(priv->refclk))
320 return dev_err_probe(dev, PTR_ERR(priv->refclk),
321 "Failed to request clock\n");
323 ret = clk_prepare_enable(priv->refclk);
327 ret = clk_set_rate(priv->refclk, 50 * 1000 * 1000);
329 clk_disable_unprepare(priv->refclk);
336 static struct phy_driver smsc_phy_driver[] = {
338 .phy_id = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
339 .phy_id_mask = 0xfffffff0,
340 .name = "SMSC LAN83C185",
342 /* PHY_BASIC_FEATURES */
344 .probe = smsc_phy_probe,
346 /* basic functions */
347 .config_init = smsc_phy_config_init,
348 .soft_reset = smsc_phy_reset,
351 .config_intr = smsc_phy_config_intr,
352 .handle_interrupt = smsc_phy_handle_interrupt,
354 .suspend = genphy_suspend,
355 .resume = genphy_resume,
357 .phy_id = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
358 .phy_id_mask = 0xfffffff0,
359 .name = "SMSC LAN8187",
361 /* PHY_BASIC_FEATURES */
363 .probe = smsc_phy_probe,
365 /* basic functions */
366 .config_init = smsc_phy_config_init,
367 .soft_reset = smsc_phy_reset,
370 .config_intr = smsc_phy_config_intr,
371 .handle_interrupt = smsc_phy_handle_interrupt,
374 .get_sset_count = smsc_get_sset_count,
375 .get_strings = smsc_get_strings,
376 .get_stats = smsc_get_stats,
378 .suspend = genphy_suspend,
379 .resume = genphy_resume,
381 /* This covers internal PHY (phy_id: 0x0007C0C3) for
382 * LAN9500 (PID: 0x9500), LAN9514 (PID: 0xec00), LAN9505 (PID: 0x9505)
384 .phy_id = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
385 .phy_id_mask = 0xfffffff0,
386 .name = "SMSC LAN8700",
388 /* PHY_BASIC_FEATURES */
390 .probe = smsc_phy_probe,
392 /* basic functions */
393 .read_status = lan87xx_read_status,
394 .config_init = smsc_phy_config_init,
395 .soft_reset = smsc_phy_reset,
396 .config_aneg = lan87xx_config_aneg,
399 .config_intr = smsc_phy_config_intr,
400 .handle_interrupt = smsc_phy_handle_interrupt,
403 .get_sset_count = smsc_get_sset_count,
404 .get_strings = smsc_get_strings,
405 .get_stats = smsc_get_stats,
407 .suspend = genphy_suspend,
408 .resume = genphy_resume,
410 .phy_id = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
411 .phy_id_mask = 0xfffffff0,
412 .name = "SMSC LAN911x Internal PHY",
414 /* PHY_BASIC_FEATURES */
416 .probe = smsc_phy_probe,
418 /* basic functions */
419 .config_init = lan911x_config_init,
422 .config_intr = smsc_phy_config_intr,
423 .handle_interrupt = smsc_phy_handle_interrupt,
425 .suspend = genphy_suspend,
426 .resume = genphy_resume,
428 /* This covers internal PHY (phy_id: 0x0007C0F0) for
429 * LAN9500A (PID: 0x9E00), LAN9505A (PID: 0x9E01)
431 .phy_id = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
432 .phy_id_mask = 0xfffffff0,
433 .name = "SMSC LAN8710/LAN8720",
435 /* PHY_BASIC_FEATURES */
437 .probe = smsc_phy_probe,
438 .remove = smsc_phy_remove,
440 /* basic functions */
441 .read_status = lan87xx_read_status,
442 .config_init = smsc_phy_config_init,
443 .soft_reset = smsc_phy_reset,
444 .config_aneg = lan87xx_config_aneg_ext,
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 = 0x0007c110,
459 .phy_id_mask = 0xfffffff0,
460 .name = "SMSC LAN8740",
462 /* PHY_BASIC_FEATURES */
463 .flags = PHY_RST_AFTER_CLK_EN,
465 .probe = smsc_phy_probe,
467 /* basic functions */
468 .read_status = lan87xx_read_status,
469 .config_init = smsc_phy_config_init,
470 .soft_reset = smsc_phy_reset,
473 .config_intr = smsc_phy_config_intr,
474 .handle_interrupt = smsc_phy_handle_interrupt,
477 .get_sset_count = smsc_get_sset_count,
478 .get_strings = smsc_get_strings,
479 .get_stats = smsc_get_stats,
481 .suspend = genphy_suspend,
482 .resume = genphy_resume,
485 module_phy_driver(smsc_phy_driver);
487 MODULE_DESCRIPTION("SMSC PHY driver");
488 MODULE_AUTHOR("Herbert Valerio Riedel");
489 MODULE_LICENSE("GPL");
491 static struct mdio_device_id __maybe_unused smsc_tbl[] = {
492 { 0x0007c0a0, 0xfffffff0 },
493 { 0x0007c0b0, 0xfffffff0 },
494 { 0x0007c0c0, 0xfffffff0 },
495 { 0x0007c0d0, 0xfffffff0 },
496 { 0x0007c0f0, 0xfffffff0 },
497 { 0x0007c110, 0xfffffff0 },
501 MODULE_DEVICE_TABLE(mdio, smsc_tbl);