generic: make all phy drivers kernel 5.0 compatible
[openwrt/openwrt.git] / target / linux / generic / files / drivers / net / phy / mvswitch.c
1 /*
2 * Marvell 88E6060 switch driver
3 * Copyright (c) 2008 Felix Fietkau <nbd@nbd.name>
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License v2 as published by the
7 * Free Software Foundation
8 */
9 #include <linux/kernel.h>
10 #include <linux/string.h>
11 #include <linux/errno.h>
12 #include <linux/unistd.h>
13 #include <linux/slab.h>
14 #include <linux/interrupt.h>
15 #include <linux/init.h>
16 #include <linux/delay.h>
17 #include <linux/netdevice.h>
18 #include <linux/etherdevice.h>
19 #include <linux/skbuff.h>
20 #include <linux/spinlock.h>
21 #include <linux/mm.h>
22 #include <linux/module.h>
23 #include <linux/mii.h>
24 #include <linux/ethtool.h>
25 #include <linux/phy.h>
26 #include <linux/if_vlan.h>
27 #include <linux/version.h>
28
29 #include <asm/io.h>
30 #include <asm/irq.h>
31 #include <asm/uaccess.h>
32 #include "mvswitch.h"
33
34 /* Undefine this to use trailer mode instead.
35 * I don't know if header mode works with all chips */
36 #define HEADER_MODE 1
37
38 MODULE_DESCRIPTION("Marvell 88E6060 Switch driver");
39 MODULE_AUTHOR("Felix Fietkau");
40 MODULE_LICENSE("GPL");
41
42 #define MVSWITCH_MAGIC 0x88E6060
43
44 struct mvswitch_priv {
45 netdev_features_t orig_features;
46 u8 vlans[16];
47 };
48
49 #define to_mvsw(_phy) ((struct mvswitch_priv *) (_phy)->priv)
50
51 static inline u16
52 r16(struct phy_device *phydev, int addr, int reg)
53 {
54 struct mii_bus *bus = phydev->mdio.bus;
55
56 return bus->read(bus, addr, reg);
57 }
58
59 static inline void
60 w16(struct phy_device *phydev, int addr, int reg, u16 val)
61 {
62 struct mii_bus *bus = phydev->mdio.bus;
63
64 bus->write(bus, addr, reg, val);
65 }
66
67
68 static struct sk_buff *
69 mvswitch_mangle_tx(struct net_device *dev, struct sk_buff *skb)
70 {
71 struct mvswitch_priv *priv;
72 char *buf = NULL;
73 u16 vid;
74
75 priv = dev->phy_ptr;
76 if (unlikely(!priv))
77 goto error;
78
79 if (unlikely(skb->len < 16))
80 goto error;
81
82 #ifdef HEADER_MODE
83 if (__vlan_hwaccel_get_tag(skb, &vid))
84 goto error;
85
86 if (skb_cloned(skb) || (skb->len <= 62) || (skb_headroom(skb) < MV_HEADER_SIZE)) {
87 if (pskb_expand_head(skb, MV_HEADER_SIZE, (skb->len < 62 ? 62 - skb->len : 0), GFP_ATOMIC))
88 goto error_expand;
89 if (skb->len < 62)
90 skb->len = 62;
91 }
92 buf = skb_push(skb, MV_HEADER_SIZE);
93 #else
94 if (__vlan_get_tag(skb, &vid))
95 goto error;
96
97 if (unlikely((vid > 15 || !priv->vlans[vid])))
98 goto error;
99
100 if (skb->len <= 64) {
101 if (pskb_expand_head(skb, 0, 64 + MV_TRAILER_SIZE - skb->len, GFP_ATOMIC))
102 goto error_expand;
103
104 buf = skb->data + 64;
105 skb->len = 64 + MV_TRAILER_SIZE;
106 } else {
107 if (skb_cloned(skb) || unlikely(skb_tailroom(skb) < 4)) {
108 if (pskb_expand_head(skb, 0, 4, GFP_ATOMIC))
109 goto error_expand;
110 }
111 buf = skb_put(skb, 4);
112 }
113
114 /* move the ethernet header 4 bytes forward, overwriting the vlan tag */
115 memmove(skb->data + 4, skb->data, 12);
116 skb->data += 4;
117 skb->len -= 4;
118 skb->mac_header += 4;
119 #endif
120
121 if (!buf)
122 goto error;
123
124
125 #ifdef HEADER_MODE
126 /* prepend the tag */
127 *((__be16 *) buf) = cpu_to_be16(
128 ((vid << MV_HEADER_VLAN_S) & MV_HEADER_VLAN_M) |
129 ((priv->vlans[vid] << MV_HEADER_PORTS_S) & MV_HEADER_PORTS_M)
130 );
131 #else
132 /* append the tag */
133 *((__be32 *) buf) = cpu_to_be32((
134 (MV_TRAILER_OVERRIDE << MV_TRAILER_FLAGS_S) |
135 ((priv->vlans[vid] & MV_TRAILER_PORTS_M) << MV_TRAILER_PORTS_S)
136 ));
137 #endif
138
139 return skb;
140
141 error_expand:
142 if (net_ratelimit())
143 printk("%s: failed to expand/update skb for the switch\n", dev->name);
144
145 error:
146 /* any errors? drop the packet! */
147 dev_kfree_skb_any(skb);
148 return NULL;
149 }
150
151 static void
152 mvswitch_mangle_rx(struct net_device *dev, struct sk_buff *skb)
153 {
154 struct mvswitch_priv *priv;
155 unsigned char *buf;
156 int vlan = -1;
157 int i;
158
159 priv = dev->phy_ptr;
160 if (WARN_ON_ONCE(!priv))
161 return;
162
163 #ifdef HEADER_MODE
164 buf = skb->data;
165 skb_pull(skb, MV_HEADER_SIZE);
166 #else
167 buf = skb->data + skb->len - MV_TRAILER_SIZE;
168 if (buf[0] != 0x80)
169 return;
170 #endif
171
172 /* look for the vlan matching the incoming port */
173 for (i = 0; i < ARRAY_SIZE(priv->vlans); i++) {
174 if ((1 << buf[1]) & priv->vlans[i])
175 vlan = i;
176 }
177
178 if (vlan == -1)
179 return;
180
181 __vlan_hwaccel_put_tag(skb, htons(ETH_P_8021Q), vlan);
182 }
183
184
185 static int
186 mvswitch_wait_mask(struct phy_device *pdev, int addr, int reg, u16 mask, u16 val)
187 {
188 int i = 100;
189 u16 r;
190
191 do {
192 r = r16(pdev, addr, reg) & mask;
193 if (r == val)
194 return 0;
195 } while(--i > 0);
196 return -ETIMEDOUT;
197 }
198
199 static int
200 mvswitch_config_init(struct phy_device *pdev)
201 {
202 struct mvswitch_priv *priv = to_mvsw(pdev);
203 struct net_device *dev = pdev->attached_dev;
204 u8 vlmap = 0;
205 int i;
206
207 if (!dev)
208 return -EINVAL;
209
210 printk("%s: Marvell 88E6060 PHY driver attached.\n", dev->name);
211 #if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 0, 0)
212 linkmode_zero(pdev->supported);
213 linkmode_set_bit(ETHTOOL_LINK_MODE_100baseT_Full_BIT, pdev->supported);
214 linkmode_copy(pdev->advertising, pdev->supported);
215 #else
216 pdev->supported = ADVERTISED_100baseT_Full;
217 pdev->advertising = ADVERTISED_100baseT_Full;
218 #endif
219 dev->phy_ptr = priv;
220 pdev->irq = PHY_POLL;
221 #ifdef HEADER_MODE
222 dev->flags |= IFF_PROMISC;
223 #endif
224
225 /* initialize default vlans */
226 for (i = 0; i < MV_PORTS; i++)
227 priv->vlans[(i == MV_WANPORT ? 2 : 1)] |= (1 << i);
228
229 /* before entering reset, disable all ports */
230 for (i = 0; i < MV_PORTS; i++)
231 w16(pdev, MV_PORTREG(CONTROL, i), 0x00);
232
233 msleep(2); /* wait for the status change to settle in */
234
235 /* put the ATU in reset */
236 w16(pdev, MV_SWITCHREG(ATU_CTRL), MV_ATUCTL_RESET);
237
238 i = mvswitch_wait_mask(pdev, MV_SWITCHREG(ATU_CTRL), MV_ATUCTL_RESET, 0);
239 if (i < 0) {
240 printk("%s: Timeout waiting for the switch to reset.\n", dev->name);
241 return i;
242 }
243
244 /* set the ATU flags */
245 w16(pdev, MV_SWITCHREG(ATU_CTRL),
246 MV_ATUCTL_NO_LEARN |
247 MV_ATUCTL_ATU_1K |
248 MV_ATUCTL_AGETIME(MV_ATUCTL_AGETIME_MIN) /* minimum without disabling ageing */
249 );
250
251 /* initialize the cpu port */
252 w16(pdev, MV_PORTREG(CONTROL, MV_CPUPORT),
253 #ifdef HEADER_MODE
254 MV_PORTCTRL_HEADER |
255 #else
256 MV_PORTCTRL_RXTR |
257 MV_PORTCTRL_TXTR |
258 #endif
259 MV_PORTCTRL_ENABLED
260 );
261 /* wait for the phy change to settle in */
262 msleep(2);
263 for (i = 0; i < MV_PORTS; i++) {
264 u8 pvid = 0;
265 int j;
266
267 vlmap = 0;
268
269 /* look for the matching vlan */
270 for (j = 0; j < ARRAY_SIZE(priv->vlans); j++) {
271 if (priv->vlans[j] & (1 << i)) {
272 vlmap = priv->vlans[j];
273 pvid = j;
274 }
275 }
276 /* leave port unconfigured if it's not part of a vlan */
277 if (!vlmap)
278 continue;
279
280 /* add the cpu port to the allowed destinations list */
281 vlmap |= (1 << MV_CPUPORT);
282
283 /* take port out of its own vlan destination map */
284 vlmap &= ~(1 << i);
285
286 /* apply vlan settings */
287 w16(pdev, MV_PORTREG(VLANMAP, i),
288 MV_PORTVLAN_PORTS(vlmap) |
289 MV_PORTVLAN_ID(i)
290 );
291
292 /* re-enable port */
293 w16(pdev, MV_PORTREG(CONTROL, i),
294 MV_PORTCTRL_ENABLED
295 );
296 }
297
298 w16(pdev, MV_PORTREG(VLANMAP, MV_CPUPORT),
299 MV_PORTVLAN_ID(MV_CPUPORT)
300 );
301
302 /* set the port association vector */
303 for (i = 0; i <= MV_PORTS; i++) {
304 w16(pdev, MV_PORTREG(ASSOC, i),
305 MV_PORTASSOC_PORTS(1 << i)
306 );
307 }
308
309 /* init switch control */
310 w16(pdev, MV_SWITCHREG(CTRL),
311 MV_SWITCHCTL_MSIZE |
312 MV_SWITCHCTL_DROP
313 );
314
315 dev->eth_mangle_rx = mvswitch_mangle_rx;
316 dev->eth_mangle_tx = mvswitch_mangle_tx;
317 priv->orig_features = dev->features;
318
319 #ifdef HEADER_MODE
320 dev->priv_flags |= IFF_NO_IP_ALIGN;
321 dev->features |= NETIF_F_HW_VLAN_CTAG_RX | NETIF_F_HW_VLAN_CTAG_TX;
322 #else
323 dev->features |= NETIF_F_HW_VLAN_CTAG_RX;
324 #endif
325
326 return 0;
327 }
328
329 static int
330 mvswitch_read_status(struct phy_device *pdev)
331 {
332 pdev->speed = SPEED_100;
333 pdev->duplex = DUPLEX_FULL;
334 pdev->link = 1;
335
336 /* XXX ugly workaround: we can't force the switch
337 * to gracefully handle hosts moving from one port to another,
338 * so we have to regularly clear the ATU database */
339
340 /* wait for the ATU to become available */
341 mvswitch_wait_mask(pdev, MV_SWITCHREG(ATU_OP), MV_ATUOP_INPROGRESS, 0);
342
343 /* flush the ATU */
344 w16(pdev, MV_SWITCHREG(ATU_OP),
345 MV_ATUOP_INPROGRESS |
346 MV_ATUOP_FLUSH_ALL
347 );
348
349 /* wait for operation to complete */
350 mvswitch_wait_mask(pdev, MV_SWITCHREG(ATU_OP), MV_ATUOP_INPROGRESS, 0);
351
352 return 0;
353 }
354
355 static int
356 mvswitch_aneg_done(struct phy_device *phydev)
357 {
358 return 1; /* Return any positive value */
359 }
360
361 static int
362 mvswitch_config_aneg(struct phy_device *phydev)
363 {
364 return 0;
365 }
366
367 static void
368 mvswitch_detach(struct phy_device *pdev)
369 {
370 struct mvswitch_priv *priv = to_mvsw(pdev);
371 struct net_device *dev = pdev->attached_dev;
372
373 if (!dev)
374 return;
375
376 dev->phy_ptr = NULL;
377 dev->eth_mangle_rx = NULL;
378 dev->eth_mangle_tx = NULL;
379 dev->features = priv->orig_features;
380 dev->priv_flags &= ~IFF_NO_IP_ALIGN;
381 }
382
383 static void
384 mvswitch_remove(struct phy_device *pdev)
385 {
386 struct mvswitch_priv *priv = to_mvsw(pdev);
387
388 kfree(priv);
389 }
390
391 static int
392 mvswitch_probe(struct phy_device *pdev)
393 {
394 struct mvswitch_priv *priv;
395
396 priv = kzalloc(sizeof(struct mvswitch_priv), GFP_KERNEL);
397 if (priv == NULL)
398 return -ENOMEM;
399
400 pdev->priv = priv;
401
402 return 0;
403 }
404
405 static int
406 mvswitch_fixup(struct phy_device *dev)
407 {
408 struct mii_bus *bus = dev->mdio.bus;
409 u16 reg;
410
411 if (dev->mdio.addr != 0x10)
412 return 0;
413
414 reg = bus->read(bus, MV_PORTREG(IDENT, 0)) & MV_IDENT_MASK;
415 if (reg != MV_IDENT_VALUE)
416 return 0;
417
418 dev->phy_id = MVSWITCH_MAGIC;
419 return 0;
420 }
421
422
423 static struct phy_driver mvswitch_driver = {
424 .name = "Marvell 88E6060",
425 .phy_id = MVSWITCH_MAGIC,
426 .phy_id_mask = 0xffffffff,
427 .features = PHY_BASIC_FEATURES,
428 .probe = &mvswitch_probe,
429 .remove = &mvswitch_remove,
430 .detach = &mvswitch_detach,
431 .config_init = &mvswitch_config_init,
432 .config_aneg = &mvswitch_config_aneg,
433 .aneg_done = &mvswitch_aneg_done,
434 .read_status = &mvswitch_read_status,
435 };
436
437 static int __init
438 mvswitch_init(void)
439 {
440 phy_register_fixup_for_id(PHY_ANY_ID, mvswitch_fixup);
441 return phy_driver_register(&mvswitch_driver, THIS_MODULE);
442 }
443
444 static void __exit
445 mvswitch_exit(void)
446 {
447 phy_driver_unregister(&mvswitch_driver);
448 }
449
450 module_init(mvswitch_init);
451 module_exit(mvswitch_exit);