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@smsc.com
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
26#define MII_LAN83C185_ISF 29 /* Interrupt Source Flags */
27#define MII_LAN83C185_IM 30 /* Interrupt Mask */
28#define MII_LAN83C185_CTRL_STATUS 17 /* Mode/Status Register */
29
30#define MII_LAN83C185_ISF_INT1 (1<<1) /* Auto-Negotiation Page Received */
31#define MII_LAN83C185_ISF_INT2 (1<<2) /* Parallel Detection Fault */
32#define MII_LAN83C185_ISF_INT3 (1<<3) /* Auto-Negotiation LP Ack */
33#define MII_LAN83C185_ISF_INT4 (1<<4) /* Link Down */
34#define MII_LAN83C185_ISF_INT5 (1<<5) /* Remote Fault Detected */
35#define MII_LAN83C185_ISF_INT6 (1<<6) /* Auto-Negotiation complete */
36#define MII_LAN83C185_ISF_INT7 (1<<7) /* ENERGYON */
37
38#define MII_LAN83C185_ISF_INT_ALL (0x0e)
39
40#define MII_LAN83C185_ISF_INT_PHYLIB_EVENTS \
41 (MII_LAN83C185_ISF_INT6 | MII_LAN83C185_ISF_INT4 | \
42 MII_LAN83C185_ISF_INT7)
43
44#define MII_LAN83C185_EDPWRDOWN (1 << 13) /* EDPWRDOWN */
45
46static int smsc_phy_config_intr(struct phy_device *phydev)
47{
48 int rc = phy_write (phydev, MII_LAN83C185_IM,
49 ((PHY_INTERRUPT_ENABLED == phydev->interrupts)
50 ? MII_LAN83C185_ISF_INT_PHYLIB_EVENTS
51 : 0));
52
53 return rc < 0 ? rc : 0;
54}
55
56static int smsc_phy_ack_interrupt(struct phy_device *phydev)
57{
58 int rc = phy_read (phydev, MII_LAN83C185_ISF);
59
60 return rc < 0 ? rc : 0;
61}
62
63static int smsc_phy_config_init(struct phy_device *phydev)
64{
65 int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
66 if (rc < 0)
67 return rc;
68
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 return smsc_phy_ack_interrupt (phydev);
76}
77
78static int lan911x_config_init(struct phy_device *phydev)
79{
80 return smsc_phy_ack_interrupt(phydev);
81}
82
83static struct phy_driver lan83c185_driver = {
84 .phy_id = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
85 .phy_id_mask = 0xfffffff0,
86 .name = "SMSC LAN83C185",
87
88 .features = (PHY_BASIC_FEATURES | SUPPORTED_Pause
89 | SUPPORTED_Asym_Pause),
90 .flags = PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
91
92 /* basic functions */
93 .config_aneg = genphy_config_aneg,
94 .read_status = genphy_read_status,
95 .config_init = smsc_phy_config_init,
96
97 /* IRQ related */
98 .ack_interrupt = smsc_phy_ack_interrupt,
99 .config_intr = smsc_phy_config_intr,
100
101 .suspend = genphy_suspend,
102 .resume = genphy_resume,
103
104 .driver = { .owner = THIS_MODULE, }
105};
106
107static struct phy_driver lan8187_driver = {
108 .phy_id = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
109 .phy_id_mask = 0xfffffff0,
110 .name = "SMSC LAN8187",
111
112 .features = (PHY_BASIC_FEATURES | SUPPORTED_Pause
113 | SUPPORTED_Asym_Pause),
114 .flags = PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
115
116 /* basic functions */
117 .config_aneg = genphy_config_aneg,
118 .read_status = genphy_read_status,
119 .config_init = smsc_phy_config_init,
120
121 /* IRQ related */
122 .ack_interrupt = smsc_phy_ack_interrupt,
123 .config_intr = smsc_phy_config_intr,
124
125 .suspend = genphy_suspend,
126 .resume = genphy_resume,
127
128 .driver = { .owner = THIS_MODULE, }
129};
130
131static struct phy_driver lan8700_driver = {
132 .phy_id = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
133 .phy_id_mask = 0xfffffff0,
134 .name = "SMSC LAN8700",
135
136 .features = (PHY_BASIC_FEATURES | SUPPORTED_Pause
137 | SUPPORTED_Asym_Pause),
138 .flags = PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
139
140 /* basic functions */
141 .config_aneg = genphy_config_aneg,
142 .read_status = genphy_read_status,
143 .config_init = smsc_phy_config_init,
144
145 /* IRQ related */
146 .ack_interrupt = smsc_phy_ack_interrupt,
147 .config_intr = smsc_phy_config_intr,
148
149 .suspend = genphy_suspend,
150 .resume = genphy_resume,
151
152 .driver = { .owner = THIS_MODULE, }
153};
154
155static struct phy_driver lan911x_int_driver = {
156 .phy_id = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
157 .phy_id_mask = 0xfffffff0,
158 .name = "SMSC LAN911x Internal PHY",
159
160 .features = (PHY_BASIC_FEATURES | SUPPORTED_Pause
161 | SUPPORTED_Asym_Pause),
162 .flags = PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
163
164 /* basic functions */
165 .config_aneg = genphy_config_aneg,
166 .read_status = genphy_read_status,
167 .config_init = lan911x_config_init,
168
169 /* IRQ related */
170 .ack_interrupt = smsc_phy_ack_interrupt,
171 .config_intr = smsc_phy_config_intr,
172
173 .suspend = genphy_suspend,
174 .resume = genphy_resume,
175
176 .driver = { .owner = THIS_MODULE, }
177};
178
179static struct phy_driver lan8710_driver = {
180 .phy_id = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
181 .phy_id_mask = 0xfffffff0,
182 .name = "SMSC LAN8710/LAN8720",
183
184 .features = (PHY_BASIC_FEATURES | SUPPORTED_Pause
185 | SUPPORTED_Asym_Pause),
186 .flags = PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
187
188 /* basic functions */
189 .config_aneg = genphy_config_aneg,
190 .read_status = genphy_read_status,
191 .config_init = smsc_phy_config_init,
192
193 /* IRQ related */
194 .ack_interrupt = smsc_phy_ack_interrupt,
195 .config_intr = smsc_phy_config_intr,
196
197 .suspend = genphy_suspend,
198 .resume = genphy_resume,
199
200 .driver = { .owner = THIS_MODULE, }
201};
202
203static int __init smsc_init(void)
204{
205 int ret;
206
207 ret = phy_driver_register (&lan83c185_driver);
208 if (ret)
209 goto err1;
210
211 ret = phy_driver_register (&lan8187_driver);
212 if (ret)
213 goto err2;
214
215 ret = phy_driver_register (&lan8700_driver);
216 if (ret)
217 goto err3;
218
219 ret = phy_driver_register (&lan911x_int_driver);
220 if (ret)
221 goto err4;
222
223 ret = phy_driver_register (&lan8710_driver);
224 if (ret)
225 goto err5;
226
227 return 0;
228
229err5:
230 phy_driver_unregister (&lan911x_int_driver);
231err4:
232 phy_driver_unregister (&lan8700_driver);
233err3:
234 phy_driver_unregister (&lan8187_driver);
235err2:
236 phy_driver_unregister (&lan83c185_driver);
237err1:
238 return ret;
239}
240
241static void __exit smsc_exit(void)
242{
243 phy_driver_unregister (&lan8710_driver);
244 phy_driver_unregister (&lan911x_int_driver);
245 phy_driver_unregister (&lan8700_driver);
246 phy_driver_unregister (&lan8187_driver);
247 phy_driver_unregister (&lan83c185_driver);
248}
249
250MODULE_DESCRIPTION("SMSC PHY driver");
251MODULE_AUTHOR("Herbert Valerio Riedel");
252MODULE_LICENSE("GPL");
253
254module_init(smsc_init);
255module_exit(smsc_exit);
256
257static struct mdio_device_id __maybe_unused smsc_tbl[] = {
258 { 0x0007c0a0, 0xfffffff0 },
259 { 0x0007c0b0, 0xfffffff0 },
260 { 0x0007c0c0, 0xfffffff0 },
261 { 0x0007c0d0, 0xfffffff0 },
262 { 0x0007c0f0, 0xfffffff0 },
263 { }
264};
265
266MODULE_DEVICE_TABLE(mdio, smsc_tbl);
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/kernel.h>
16#include <linux/module.h>
17#include <linux/mii.h>
18#include <linux/ethtool.h>
19#include <linux/of.h>
20#include <linux/phy.h>
21#include <linux/netdevice.h>
22#include <linux/smscphy.h>
23
24struct smsc_hw_stat {
25 const char *string;
26 u8 reg;
27 u8 bits;
28};
29
30static struct smsc_hw_stat smsc_hw_stats[] = {
31 { "phy_symbol_errors", 26, 16},
32};
33
34struct smsc_phy_priv {
35 bool energy_enable;
36};
37
38static int smsc_phy_config_intr(struct phy_device *phydev)
39{
40 int rc = phy_write (phydev, MII_LAN83C185_IM,
41 ((PHY_INTERRUPT_ENABLED == phydev->interrupts)
42 ? MII_LAN83C185_ISF_INT_PHYLIB_EVENTS
43 : 0));
44
45 return rc < 0 ? rc : 0;
46}
47
48static int smsc_phy_ack_interrupt(struct phy_device *phydev)
49{
50 int rc = phy_read (phydev, MII_LAN83C185_ISF);
51
52 return rc < 0 ? rc : 0;
53}
54
55static int smsc_phy_config_init(struct phy_device *phydev)
56{
57 struct smsc_phy_priv *priv = phydev->priv;
58
59 int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
60
61 if (rc < 0)
62 return rc;
63
64 if (priv->energy_enable) {
65 /* Enable energy detect mode for this SMSC Transceivers */
66 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
67 rc | MII_LAN83C185_EDPWRDOWN);
68 if (rc < 0)
69 return rc;
70 }
71
72 return smsc_phy_ack_interrupt(phydev);
73}
74
75static int smsc_phy_reset(struct phy_device *phydev)
76{
77 int rc = phy_read(phydev, MII_LAN83C185_SPECIAL_MODES);
78 if (rc < 0)
79 return rc;
80
81 /* If the SMSC PHY is in power down mode, then set it
82 * in all capable mode before using it.
83 */
84 if ((rc & MII_LAN83C185_MODE_MASK) == MII_LAN83C185_MODE_POWERDOWN) {
85 /* set "all capable" mode */
86 rc |= MII_LAN83C185_MODE_ALL;
87 phy_write(phydev, MII_LAN83C185_SPECIAL_MODES, rc);
88 }
89
90 /* reset the phy */
91 return genphy_soft_reset(phydev);
92}
93
94static int lan911x_config_init(struct phy_device *phydev)
95{
96 return smsc_phy_ack_interrupt(phydev);
97}
98
99/*
100 * The LAN87xx suffers from rare absence of the ENERGYON-bit when Ethernet cable
101 * plugs in while LAN87xx is in Energy Detect Power-Down mode. This leads to
102 * unstable detection of plugging in Ethernet cable.
103 * This workaround disables Energy Detect Power-Down mode and waiting for
104 * response on link pulses to detect presence of plugged Ethernet cable.
105 * The Energy Detect Power-Down mode is enabled again in the end of procedure to
106 * save approximately 220 mW of power if cable is unplugged.
107 */
108static int lan87xx_read_status(struct phy_device *phydev)
109{
110 struct smsc_phy_priv *priv = phydev->priv;
111
112 int err = genphy_read_status(phydev);
113
114 if (!phydev->link && priv->energy_enable) {
115 /* Disable EDPD to wake up PHY */
116 int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
117 if (rc < 0)
118 return rc;
119
120 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
121 rc & ~MII_LAN83C185_EDPWRDOWN);
122 if (rc < 0)
123 return rc;
124
125 /* Wait max 640 ms to detect energy and the timeout is not
126 * an actual error.
127 */
128 read_poll_timeout(phy_read, rc,
129 rc & MII_LAN83C185_ENERGYON || rc < 0,
130 10000, 640000, true, phydev,
131 MII_LAN83C185_CTRL_STATUS);
132 if (rc < 0)
133 return rc;
134
135 /* Re-enable EDPD */
136 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
137 if (rc < 0)
138 return rc;
139
140 rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
141 rc | MII_LAN83C185_EDPWRDOWN);
142 if (rc < 0)
143 return rc;
144 }
145
146 return err;
147}
148
149static int smsc_get_sset_count(struct phy_device *phydev)
150{
151 return ARRAY_SIZE(smsc_hw_stats);
152}
153
154static void smsc_get_strings(struct phy_device *phydev, u8 *data)
155{
156 int i;
157
158 for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++) {
159 strncpy(data + i * ETH_GSTRING_LEN,
160 smsc_hw_stats[i].string, ETH_GSTRING_LEN);
161 }
162}
163
164static u64 smsc_get_stat(struct phy_device *phydev, int i)
165{
166 struct smsc_hw_stat stat = smsc_hw_stats[i];
167 int val;
168 u64 ret;
169
170 val = phy_read(phydev, stat.reg);
171 if (val < 0)
172 ret = U64_MAX;
173 else
174 ret = val;
175
176 return ret;
177}
178
179static void smsc_get_stats(struct phy_device *phydev,
180 struct ethtool_stats *stats, u64 *data)
181{
182 int i;
183
184 for (i = 0; i < ARRAY_SIZE(smsc_hw_stats); i++)
185 data[i] = smsc_get_stat(phydev, i);
186}
187
188static int smsc_phy_probe(struct phy_device *phydev)
189{
190 struct device *dev = &phydev->mdio.dev;
191 struct device_node *of_node = dev->of_node;
192 struct smsc_phy_priv *priv;
193
194 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
195 if (!priv)
196 return -ENOMEM;
197
198 priv->energy_enable = true;
199
200 if (of_property_read_bool(of_node, "smsc,disable-energy-detect"))
201 priv->energy_enable = false;
202
203 phydev->priv = priv;
204
205 return 0;
206}
207
208static struct phy_driver smsc_phy_driver[] = {
209{
210 .phy_id = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
211 .phy_id_mask = 0xfffffff0,
212 .name = "SMSC LAN83C185",
213
214 /* PHY_BASIC_FEATURES */
215
216 .probe = smsc_phy_probe,
217
218 /* basic functions */
219 .config_init = smsc_phy_config_init,
220 .soft_reset = smsc_phy_reset,
221
222 /* IRQ related */
223 .ack_interrupt = smsc_phy_ack_interrupt,
224 .config_intr = smsc_phy_config_intr,
225
226 .suspend = genphy_suspend,
227 .resume = genphy_resume,
228}, {
229 .phy_id = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
230 .phy_id_mask = 0xfffffff0,
231 .name = "SMSC LAN8187",
232
233 /* PHY_BASIC_FEATURES */
234
235 .probe = smsc_phy_probe,
236
237 /* basic functions */
238 .config_init = smsc_phy_config_init,
239 .soft_reset = smsc_phy_reset,
240
241 /* IRQ related */
242 .ack_interrupt = smsc_phy_ack_interrupt,
243 .config_intr = smsc_phy_config_intr,
244
245 /* Statistics */
246 .get_sset_count = smsc_get_sset_count,
247 .get_strings = smsc_get_strings,
248 .get_stats = smsc_get_stats,
249
250 .suspend = genphy_suspend,
251 .resume = genphy_resume,
252}, {
253 .phy_id = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
254 .phy_id_mask = 0xfffffff0,
255 .name = "SMSC LAN8700",
256
257 /* PHY_BASIC_FEATURES */
258
259 .probe = smsc_phy_probe,
260
261 /* basic functions */
262 .read_status = lan87xx_read_status,
263 .config_init = smsc_phy_config_init,
264 .soft_reset = smsc_phy_reset,
265
266 /* IRQ related */
267 .ack_interrupt = smsc_phy_ack_interrupt,
268 .config_intr = smsc_phy_config_intr,
269
270 /* Statistics */
271 .get_sset_count = smsc_get_sset_count,
272 .get_strings = smsc_get_strings,
273 .get_stats = smsc_get_stats,
274
275 .suspend = genphy_suspend,
276 .resume = genphy_resume,
277}, {
278 .phy_id = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
279 .phy_id_mask = 0xfffffff0,
280 .name = "SMSC LAN911x Internal PHY",
281
282 /* PHY_BASIC_FEATURES */
283
284 .probe = smsc_phy_probe,
285
286 /* basic functions */
287 .config_init = lan911x_config_init,
288
289 /* IRQ related */
290 .ack_interrupt = smsc_phy_ack_interrupt,
291 .config_intr = smsc_phy_config_intr,
292
293 .suspend = genphy_suspend,
294 .resume = genphy_resume,
295}, {
296 .phy_id = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
297 .phy_id_mask = 0xfffffff0,
298 .name = "SMSC LAN8710/LAN8720",
299
300 /* PHY_BASIC_FEATURES */
301 .flags = PHY_RST_AFTER_CLK_EN,
302
303 .probe = smsc_phy_probe,
304
305 /* basic functions */
306 .read_status = lan87xx_read_status,
307 .config_init = smsc_phy_config_init,
308 .soft_reset = smsc_phy_reset,
309
310 /* IRQ related */
311 .ack_interrupt = smsc_phy_ack_interrupt,
312 .config_intr = smsc_phy_config_intr,
313
314 /* Statistics */
315 .get_sset_count = smsc_get_sset_count,
316 .get_strings = smsc_get_strings,
317 .get_stats = smsc_get_stats,
318
319 .suspend = genphy_suspend,
320 .resume = genphy_resume,
321}, {
322 .phy_id = 0x0007c110,
323 .phy_id_mask = 0xfffffff0,
324 .name = "SMSC LAN8740",
325
326 /* PHY_BASIC_FEATURES */
327 .flags = PHY_RST_AFTER_CLK_EN,
328
329 .probe = smsc_phy_probe,
330
331 /* basic functions */
332 .read_status = lan87xx_read_status,
333 .config_init = smsc_phy_config_init,
334 .soft_reset = smsc_phy_reset,
335
336 /* IRQ related */
337 .ack_interrupt = smsc_phy_ack_interrupt,
338 .config_intr = smsc_phy_config_intr,
339
340 /* Statistics */
341 .get_sset_count = smsc_get_sset_count,
342 .get_strings = smsc_get_strings,
343 .get_stats = smsc_get_stats,
344
345 .suspend = genphy_suspend,
346 .resume = genphy_resume,
347} };
348
349module_phy_driver(smsc_phy_driver);
350
351MODULE_DESCRIPTION("SMSC PHY driver");
352MODULE_AUTHOR("Herbert Valerio Riedel");
353MODULE_LICENSE("GPL");
354
355static struct mdio_device_id __maybe_unused smsc_tbl[] = {
356 { 0x0007c0a0, 0xfffffff0 },
357 { 0x0007c0b0, 0xfffffff0 },
358 { 0x0007c0c0, 0xfffffff0 },
359 { 0x0007c0d0, 0xfffffff0 },
360 { 0x0007c0f0, 0xfffffff0 },
361 { 0x0007c110, 0xfffffff0 },
362 { }
363};
364
365MODULE_DEVICE_TABLE(mdio, smsc_tbl);