Loading...
1/*
2 * drivers/net/phy/smsc.c
3 *
4 * Driver for SMSC PHYs
5 *
6 * Author: Herbert Valerio Riedel
7 *
8 * Copyright (c) 2006 Herbert Valerio Riedel <hvr@gnu.org>
9 *
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
14 *
15 * Support added for SMSC LAN8187 and LAN8700 by steve.glendinning@shawell.net
16 *
17 */
18
19#include <linux/kernel.h>
20#include <linux/module.h>
21#include <linux/mii.h>
22#include <linux/ethtool.h>
23#include <linux/of.h>
24#include <linux/phy.h>
25#include <linux/netdevice.h>
26#include <linux/smscphy.h>
27
28struct smsc_hw_stat {
29 const char *string;
30 u8 reg;
31 u8 bits;
32};
33
34static struct smsc_hw_stat smsc_hw_stats[] = {
35 { "phy_symbol_errors", 26, 16},
36};
37
38struct smsc_phy_priv {
39 bool energy_enable;
40};
41
42static int smsc_phy_config_intr(struct phy_device *phydev)
43{
44 int rc = phy_write (phydev, MII_LAN83C185_IM,
45 ((PHY_INTERRUPT_ENABLED == phydev->interrupts)
46 ? MII_LAN83C185_ISF_INT_PHYLIB_EVENTS
47 : 0));
48
49 return rc < 0 ? rc : 0;
50}
51
52static int smsc_phy_ack_interrupt(struct phy_device *phydev)
53{
54 int rc = phy_read (phydev, MII_LAN83C185_ISF);
55
56 return rc < 0 ? rc : 0;
57}
58
59static int smsc_phy_config_init(struct phy_device *phydev)
60{
61 struct smsc_phy_priv *priv = phydev->priv;
62
63 int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
64
65 if (rc < 0)
66 return rc;
67
68 if (priv->energy_enable) {
69 /* Enable energy detect mode for this SMSC Transceivers */
70 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
71 rc | MII_LAN83C185_EDPWRDOWN);
72 if (rc < 0)
73 return rc;
74 }
75
76 return smsc_phy_ack_interrupt(phydev);
77}
78
79static int smsc_phy_reset(struct phy_device *phydev)
80{
81 int rc = phy_read(phydev, MII_LAN83C185_SPECIAL_MODES);
82 if (rc < 0)
83 return rc;
84
85 /* If the SMSC PHY is in power down mode, then set it
86 * in all capable mode before using it.
87 */
88 if ((rc & MII_LAN83C185_MODE_MASK) == MII_LAN83C185_MODE_POWERDOWN) {
89 /* set "all capable" mode */
90 rc |= MII_LAN83C185_MODE_ALL;
91 phy_write(phydev, MII_LAN83C185_SPECIAL_MODES, rc);
92 }
93
94 /* reset the phy */
95 return genphy_soft_reset(phydev);
96}
97
98static int lan911x_config_init(struct phy_device *phydev)
99{
100 return smsc_phy_ack_interrupt(phydev);
101}
102
103/*
104 * The LAN87xx suffers from rare absence of the ENERGYON-bit when Ethernet cable
105 * plugs in while LAN87xx is in Energy Detect Power-Down mode. This leads to
106 * unstable detection of plugging in Ethernet cable.
107 * This workaround disables Energy Detect Power-Down mode and waiting for
108 * response on link pulses to detect presence of plugged Ethernet cable.
109 * The Energy Detect Power-Down mode is enabled again in the end of procedure to
110 * save approximately 220 mW of power if cable is unplugged.
111 */
112static int lan87xx_read_status(struct phy_device *phydev)
113{
114 struct smsc_phy_priv *priv = phydev->priv;
115
116 int err = genphy_read_status(phydev);
117
118 if (!phydev->link && priv->energy_enable) {
119 int i;
120
121 /* Disable EDPD to wake up PHY */
122 int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
123 if (rc < 0)
124 return rc;
125
126 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
127 rc & ~MII_LAN83C185_EDPWRDOWN);
128 if (rc < 0)
129 return rc;
130
131 /* Wait max 640 ms to detect energy */
132 for (i = 0; i < 64; i++) {
133 /* Sleep to allow link test pulses to be sent */
134 msleep(10);
135 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
136 if (rc < 0)
137 return rc;
138 if (rc & MII_LAN83C185_ENERGYON)
139 break;
140 }
141
142 /* Re-enable EDPD */
143 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
144 if (rc < 0)
145 return rc;
146
147 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
148 rc | MII_LAN83C185_EDPWRDOWN);
149 if (rc < 0)
150 return rc;
151 }
152
153 return err;
154}
155
156static int smsc_get_sset_count(struct phy_device *phydev)
157{
158 return ARRAY_SIZE(smsc_hw_stats);
159}
160
161static void smsc_get_strings(struct phy_device *phydev, u8 *data)
162{
163 int i;
164
165 for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++) {
166 strncpy(data + i * ETH_GSTRING_LEN,
167 smsc_hw_stats[i].string, ETH_GSTRING_LEN);
168 }
169}
170
171#ifndef UINT64_MAX
172#define UINT64_MAX (u64)(~((u64)0))
173#endif
174static u64 smsc_get_stat(struct phy_device *phydev, int i)
175{
176 struct smsc_hw_stat stat = smsc_hw_stats[i];
177 int val;
178 u64 ret;
179
180 val = phy_read(phydev, stat.reg);
181 if (val < 0)
182 ret = UINT64_MAX;
183 else
184 ret = val;
185
186 return ret;
187}
188
189static void smsc_get_stats(struct phy_device *phydev,
190 struct ethtool_stats *stats, u64 *data)
191{
192 int i;
193
194 for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++)
195 data[i] = smsc_get_stat(phydev, i);
196}
197
198static int smsc_phy_probe(struct phy_device *phydev)
199{
200 struct device *dev = &phydev->mdio.dev;
201 struct device_node *of_node = dev->of_node;
202 struct smsc_phy_priv *priv;
203
204 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
205 if (!priv)
206 return -ENOMEM;
207
208 priv->energy_enable = true;
209
210 if (of_property_read_bool(of_node, "smsc,disable-energy-detect"))
211 priv->energy_enable = false;
212
213 phydev->priv = priv;
214
215 return 0;
216}
217
218static struct phy_driver smsc_phy_driver[] = {
219{
220 .phy_id = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
221 .phy_id_mask = 0xfffffff0,
222 .name = "SMSC LAN83C185",
223
224 .features = PHY_BASIC_FEATURES,
225 .flags = PHY_HAS_INTERRUPT,
226
227 .probe = smsc_phy_probe,
228
229 /* basic functions */
230 .config_init = smsc_phy_config_init,
231 .soft_reset = smsc_phy_reset,
232
233 /* IRQ related */
234 .ack_interrupt = smsc_phy_ack_interrupt,
235 .config_intr = smsc_phy_config_intr,
236
237 .suspend = genphy_suspend,
238 .resume = genphy_resume,
239}, {
240 .phy_id = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
241 .phy_id_mask = 0xfffffff0,
242 .name = "SMSC LAN8187",
243
244 .features = PHY_BASIC_FEATURES,
245 .flags = PHY_HAS_INTERRUPT,
246
247 .probe = smsc_phy_probe,
248
249 /* basic functions */
250 .config_init = smsc_phy_config_init,
251 .soft_reset = smsc_phy_reset,
252
253 /* IRQ related */
254 .ack_interrupt = smsc_phy_ack_interrupt,
255 .config_intr = smsc_phy_config_intr,
256
257 /* Statistics */
258 .get_sset_count = smsc_get_sset_count,
259 .get_strings = smsc_get_strings,
260 .get_stats = smsc_get_stats,
261
262 .suspend = genphy_suspend,
263 .resume = genphy_resume,
264}, {
265 .phy_id = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
266 .phy_id_mask = 0xfffffff0,
267 .name = "SMSC LAN8700",
268
269 .features = PHY_BASIC_FEATURES,
270 .flags = PHY_HAS_INTERRUPT,
271
272 .probe = smsc_phy_probe,
273
274 /* basic functions */
275 .read_status = lan87xx_read_status,
276 .config_init = smsc_phy_config_init,
277 .soft_reset = smsc_phy_reset,
278
279 /* IRQ related */
280 .ack_interrupt = smsc_phy_ack_interrupt,
281 .config_intr = smsc_phy_config_intr,
282
283 /* Statistics */
284 .get_sset_count = smsc_get_sset_count,
285 .get_strings = smsc_get_strings,
286 .get_stats = smsc_get_stats,
287
288 .suspend = genphy_suspend,
289 .resume = genphy_resume,
290}, {
291 .phy_id = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
292 .phy_id_mask = 0xfffffff0,
293 .name = "SMSC LAN911x Internal PHY",
294
295 .features = PHY_BASIC_FEATURES,
296 .flags = PHY_HAS_INTERRUPT,
297
298 .probe = smsc_phy_probe,
299
300 /* basic functions */
301 .config_init = lan911x_config_init,
302
303 /* IRQ related */
304 .ack_interrupt = smsc_phy_ack_interrupt,
305 .config_intr = smsc_phy_config_intr,
306
307 .suspend = genphy_suspend,
308 .resume = genphy_resume,
309}, {
310 .phy_id = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
311 .phy_id_mask = 0xfffffff0,
312 .name = "SMSC LAN8710/LAN8720",
313
314 .features = PHY_BASIC_FEATURES,
315 .flags = PHY_HAS_INTERRUPT | PHY_RST_AFTER_CLK_EN,
316
317 .probe = smsc_phy_probe,
318
319 /* basic functions */
320 .read_status = lan87xx_read_status,
321 .config_init = smsc_phy_config_init,
322 .soft_reset = smsc_phy_reset,
323
324 /* IRQ related */
325 .ack_interrupt = smsc_phy_ack_interrupt,
326 .config_intr = smsc_phy_config_intr,
327
328 /* Statistics */
329 .get_sset_count = smsc_get_sset_count,
330 .get_strings = smsc_get_strings,
331 .get_stats = smsc_get_stats,
332
333 .suspend = genphy_suspend,
334 .resume = genphy_resume,
335}, {
336 .phy_id = 0x0007c110,
337 .phy_id_mask = 0xfffffff0,
338 .name = "SMSC LAN8740",
339
340 .features = PHY_BASIC_FEATURES,
341 .flags = PHY_HAS_INTERRUPT,
342
343 .probe = smsc_phy_probe,
344
345 /* basic functions */
346 .read_status = lan87xx_read_status,
347 .config_init = smsc_phy_config_init,
348 .soft_reset = smsc_phy_reset,
349
350 /* IRQ related */
351 .ack_interrupt = smsc_phy_ack_interrupt,
352 .config_intr = smsc_phy_config_intr,
353
354 /* Statistics */
355 .get_sset_count = smsc_get_sset_count,
356 .get_strings = smsc_get_strings,
357 .get_stats = smsc_get_stats,
358
359 .suspend = genphy_suspend,
360 .resume = genphy_resume,
361} };
362
363module_phy_driver(smsc_phy_driver);
364
365MODULE_DESCRIPTION("SMSC PHY driver");
366MODULE_AUTHOR("Herbert Valerio Riedel");
367MODULE_LICENSE("GPL");
368
369static struct mdio_device_id __maybe_unused smsc_tbl[] = {
370 { 0x0007c0a0, 0xfffffff0 },
371 { 0x0007c0b0, 0xfffffff0 },
372 { 0x0007c0c0, 0xfffffff0 },
373 { 0x0007c0d0, 0xfffffff0 },
374 { 0x0007c0f0, 0xfffffff0 },
375 { 0x0007c110, 0xfffffff0 },
376 { }
377};
378
379MODULE_DEVICE_TABLE(mdio, smsc_tbl);
1/*
2 * drivers/net/phy/smsc.c
3 *
4 * Driver for SMSC PHYs
5 *
6 * Author: Herbert Valerio Riedel
7 *
8 * Copyright (c) 2006 Herbert Valerio Riedel <hvr@gnu.org>
9 *
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
14 *
15 * Support added for SMSC LAN8187 and LAN8700 by steve.glendinning@shawell.net
16 *
17 */
18
19#include <linux/kernel.h>
20#include <linux/module.h>
21#include <linux/mii.h>
22#include <linux/ethtool.h>
23#include <linux/phy.h>
24#include <linux/netdevice.h>
25#include <linux/smscphy.h>
26
27static int smsc_phy_config_intr(struct phy_device *phydev)
28{
29 int rc = phy_write (phydev, MII_LAN83C185_IM,
30 ((PHY_INTERRUPT_ENABLED == phydev->interrupts)
31 ? MII_LAN83C185_ISF_INT_PHYLIB_EVENTS
32 : 0));
33
34 return rc < 0 ? rc : 0;
35}
36
37static int smsc_phy_ack_interrupt(struct phy_device *phydev)
38{
39 int rc = phy_read (phydev, MII_LAN83C185_ISF);
40
41 return rc < 0 ? rc : 0;
42}
43
44static int smsc_phy_config_init(struct phy_device *phydev)
45{
46 int rc = phy_read(phydev, MII_LAN83C185_SPECIAL_MODES);
47 if (rc < 0)
48 return rc;
49
50 /* If the SMSC PHY is in power down mode, then set it
51 * in all capable mode before using it.
52 */
53 if ((rc & MII_LAN83C185_MODE_MASK) == MII_LAN83C185_MODE_POWERDOWN) {
54 int timeout = 50000;
55
56 /* set "all capable" mode and reset the phy */
57 rc |= MII_LAN83C185_MODE_ALL;
58 phy_write(phydev, MII_LAN83C185_SPECIAL_MODES, rc);
59 phy_write(phydev, MII_BMCR, BMCR_RESET);
60
61 /* wait end of reset (max 500 ms) */
62 do {
63 udelay(10);
64 if (timeout-- == 0)
65 return -1;
66 rc = phy_read(phydev, MII_BMCR);
67 } while (rc & BMCR_RESET);
68 }
69
70 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
71 if (rc < 0)
72 return rc;
73
74 /* Enable energy detect mode for this SMSC Transceivers */
75 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
76 rc | MII_LAN83C185_EDPWRDOWN);
77 if (rc < 0)
78 return rc;
79
80 return smsc_phy_ack_interrupt (phydev);
81}
82
83static int lan911x_config_init(struct phy_device *phydev)
84{
85 return smsc_phy_ack_interrupt(phydev);
86}
87
88/*
89 * The LAN8710/LAN8720 requires a minimum of 2 link pulses within 64ms of each
90 * other in order to set the ENERGYON bit and exit EDPD mode. If a link partner
91 * does send the pulses within this interval, the PHY will remained powered
92 * down.
93 *
94 * This workaround will manually toggle the PHY on/off upon calls to read_status
95 * in order to generate link test pulses if the link is down. If a link partner
96 * is present, it will respond to the pulses, which will cause the ENERGYON bit
97 * to be set and will cause the EDPD mode to be exited.
98 */
99static int lan87xx_read_status(struct phy_device *phydev)
100{
101 int err = genphy_read_status(phydev);
102
103 if (!phydev->link) {
104 /* Disable EDPD to wake up PHY */
105 int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
106 if (rc < 0)
107 return rc;
108
109 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
110 rc & ~MII_LAN83C185_EDPWRDOWN);
111 if (rc < 0)
112 return rc;
113
114 /* Sleep 64 ms to allow ~5 link test pulses to be sent */
115 msleep(64);
116
117 /* Re-enable EDPD */
118 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
119 if (rc < 0)
120 return rc;
121
122 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
123 rc | MII_LAN83C185_EDPWRDOWN);
124 if (rc < 0)
125 return rc;
126 }
127
128 return err;
129}
130
131static struct phy_driver smsc_phy_driver[] = {
132{
133 .phy_id = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
134 .phy_id_mask = 0xfffffff0,
135 .name = "SMSC LAN83C185",
136
137 .features = (PHY_BASIC_FEATURES | SUPPORTED_Pause
138 | SUPPORTED_Asym_Pause),
139 .flags = PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
140
141 /* basic functions */
142 .config_aneg = genphy_config_aneg,
143 .read_status = genphy_read_status,
144 .config_init = smsc_phy_config_init,
145
146 /* IRQ related */
147 .ack_interrupt = smsc_phy_ack_interrupt,
148 .config_intr = smsc_phy_config_intr,
149
150 .suspend = genphy_suspend,
151 .resume = genphy_resume,
152
153 .driver = { .owner = THIS_MODULE, }
154}, {
155 .phy_id = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
156 .phy_id_mask = 0xfffffff0,
157 .name = "SMSC LAN8187",
158
159 .features = (PHY_BASIC_FEATURES | SUPPORTED_Pause
160 | SUPPORTED_Asym_Pause),
161 .flags = PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
162
163 /* basic functions */
164 .config_aneg = genphy_config_aneg,
165 .read_status = genphy_read_status,
166 .config_init = smsc_phy_config_init,
167
168 /* IRQ related */
169 .ack_interrupt = smsc_phy_ack_interrupt,
170 .config_intr = smsc_phy_config_intr,
171
172 .suspend = genphy_suspend,
173 .resume = genphy_resume,
174
175 .driver = { .owner = THIS_MODULE, }
176}, {
177 .phy_id = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
178 .phy_id_mask = 0xfffffff0,
179 .name = "SMSC LAN8700",
180
181 .features = (PHY_BASIC_FEATURES | SUPPORTED_Pause
182 | SUPPORTED_Asym_Pause),
183 .flags = PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
184
185 /* basic functions */
186 .config_aneg = genphy_config_aneg,
187 .read_status = genphy_read_status,
188 .config_init = smsc_phy_config_init,
189
190 /* IRQ related */
191 .ack_interrupt = smsc_phy_ack_interrupt,
192 .config_intr = smsc_phy_config_intr,
193
194 .suspend = genphy_suspend,
195 .resume = genphy_resume,
196
197 .driver = { .owner = THIS_MODULE, }
198}, {
199 .phy_id = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
200 .phy_id_mask = 0xfffffff0,
201 .name = "SMSC LAN911x Internal PHY",
202
203 .features = (PHY_BASIC_FEATURES | SUPPORTED_Pause
204 | SUPPORTED_Asym_Pause),
205 .flags = PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
206
207 /* basic functions */
208 .config_aneg = genphy_config_aneg,
209 .read_status = genphy_read_status,
210 .config_init = lan911x_config_init,
211
212 /* IRQ related */
213 .ack_interrupt = smsc_phy_ack_interrupt,
214 .config_intr = smsc_phy_config_intr,
215
216 .suspend = genphy_suspend,
217 .resume = genphy_resume,
218
219 .driver = { .owner = THIS_MODULE, }
220}, {
221 .phy_id = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
222 .phy_id_mask = 0xfffffff0,
223 .name = "SMSC LAN8710/LAN8720",
224
225 .features = (PHY_BASIC_FEATURES | SUPPORTED_Pause
226 | SUPPORTED_Asym_Pause),
227 .flags = PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
228
229 /* basic functions */
230 .config_aneg = genphy_config_aneg,
231 .read_status = lan87xx_read_status,
232 .config_init = smsc_phy_config_init,
233
234 /* IRQ related */
235 .ack_interrupt = smsc_phy_ack_interrupt,
236 .config_intr = smsc_phy_config_intr,
237
238 .suspend = genphy_suspend,
239 .resume = genphy_resume,
240
241 .driver = { .owner = THIS_MODULE, }
242} };
243
244static int __init smsc_init(void)
245{
246 return phy_drivers_register(smsc_phy_driver,
247 ARRAY_SIZE(smsc_phy_driver));
248}
249
250static void __exit smsc_exit(void)
251{
252 return phy_drivers_unregister(smsc_phy_driver,
253 ARRAY_SIZE(smsc_phy_driver));
254}
255
256MODULE_DESCRIPTION("SMSC PHY driver");
257MODULE_AUTHOR("Herbert Valerio Riedel");
258MODULE_LICENSE("GPL");
259
260module_init(smsc_init);
261module_exit(smsc_exit);
262
263static struct mdio_device_id __maybe_unused smsc_tbl[] = {
264 { 0x0007c0a0, 0xfffffff0 },
265 { 0x0007c0b0, 0xfffffff0 },
266 { 0x0007c0c0, 0xfffffff0 },
267 { 0x0007c0d0, 0xfffffff0 },
268 { 0x0007c0f0, 0xfffffff0 },
269 { }
270};
271
272MODULE_DEVICE_TABLE(mdio, smsc_tbl);