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