]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - drivers/net/ethernet/broadcom/genet/bcmmii.c
Merge branch 'next/cleanup' into for-next
[karo-tx-linux.git] / drivers / net / ethernet / broadcom / genet / bcmmii.c
1 /*
2  * Broadcom GENET MDIO routines
3  *
4  * Copyright (c) 2014 Broadcom Corporation
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  */
10
11
12 #include <linux/types.h>
13 #include <linux/delay.h>
14 #include <linux/wait.h>
15 #include <linux/mii.h>
16 #include <linux/ethtool.h>
17 #include <linux/bitops.h>
18 #include <linux/netdevice.h>
19 #include <linux/platform_device.h>
20 #include <linux/phy.h>
21 #include <linux/phy_fixed.h>
22 #include <linux/brcmphy.h>
23 #include <linux/of.h>
24 #include <linux/of_net.h>
25 #include <linux/of_mdio.h>
26 #include <linux/platform_data/bcmgenet.h>
27
28 #include "bcmgenet.h"
29
30 /* read a value from the MII */
31 static int bcmgenet_mii_read(struct mii_bus *bus, int phy_id, int location)
32 {
33         int ret;
34         struct net_device *dev = bus->priv;
35         struct bcmgenet_priv *priv = netdev_priv(dev);
36         u32 reg;
37
38         bcmgenet_umac_writel(priv, (MDIO_RD | (phy_id << MDIO_PMD_SHIFT) |
39                              (location << MDIO_REG_SHIFT)), UMAC_MDIO_CMD);
40         /* Start MDIO transaction*/
41         reg = bcmgenet_umac_readl(priv, UMAC_MDIO_CMD);
42         reg |= MDIO_START_BUSY;
43         bcmgenet_umac_writel(priv, reg, UMAC_MDIO_CMD);
44         wait_event_timeout(priv->wq,
45                            !(bcmgenet_umac_readl(priv, UMAC_MDIO_CMD)
46                            & MDIO_START_BUSY),
47                            HZ / 100);
48         ret = bcmgenet_umac_readl(priv, UMAC_MDIO_CMD);
49
50         /* Some broken devices are known not to release the line during
51          * turn-around, e.g: Broadcom BCM53125 external switches, so check for
52          * that condition here and ignore the MDIO controller read failure
53          * indication.
54          */
55         if (!(bus->phy_ignore_ta_mask & 1 << phy_id) && (ret & MDIO_READ_FAIL))
56                 return -EIO;
57
58         return ret & 0xffff;
59 }
60
61 /* write a value to the MII */
62 static int bcmgenet_mii_write(struct mii_bus *bus, int phy_id,
63                               int location, u16 val)
64 {
65         struct net_device *dev = bus->priv;
66         struct bcmgenet_priv *priv = netdev_priv(dev);
67         u32 reg;
68
69         bcmgenet_umac_writel(priv, (MDIO_WR | (phy_id << MDIO_PMD_SHIFT) |
70                              (location << MDIO_REG_SHIFT) | (0xffff & val)),
71                              UMAC_MDIO_CMD);
72         reg = bcmgenet_umac_readl(priv, UMAC_MDIO_CMD);
73         reg |= MDIO_START_BUSY;
74         bcmgenet_umac_writel(priv, reg, UMAC_MDIO_CMD);
75         wait_event_timeout(priv->wq,
76                            !(bcmgenet_umac_readl(priv, UMAC_MDIO_CMD) &
77                            MDIO_START_BUSY),
78                            HZ / 100);
79
80         return 0;
81 }
82
83 /* setup netdev link state when PHY link status change and
84  * update UMAC and RGMII block when link up
85  */
86 void bcmgenet_mii_setup(struct net_device *dev)
87 {
88         struct bcmgenet_priv *priv = netdev_priv(dev);
89         struct phy_device *phydev = priv->phydev;
90         u32 reg, cmd_bits = 0;
91         bool status_changed = false;
92
93         if (priv->old_link != phydev->link) {
94                 status_changed = true;
95                 priv->old_link = phydev->link;
96         }
97
98         if (phydev->link) {
99                 /* check speed/duplex/pause changes */
100                 if (priv->old_speed != phydev->speed) {
101                         status_changed = true;
102                         priv->old_speed = phydev->speed;
103                 }
104
105                 if (priv->old_duplex != phydev->duplex) {
106                         status_changed = true;
107                         priv->old_duplex = phydev->duplex;
108                 }
109
110                 if (priv->old_pause != phydev->pause) {
111                         status_changed = true;
112                         priv->old_pause = phydev->pause;
113                 }
114
115                 /* done if nothing has changed */
116                 if (!status_changed)
117                         return;
118
119                 /* speed */
120                 if (phydev->speed == SPEED_1000)
121                         cmd_bits = UMAC_SPEED_1000;
122                 else if (phydev->speed == SPEED_100)
123                         cmd_bits = UMAC_SPEED_100;
124                 else
125                         cmd_bits = UMAC_SPEED_10;
126                 cmd_bits <<= CMD_SPEED_SHIFT;
127
128                 /* duplex */
129                 if (phydev->duplex != DUPLEX_FULL)
130                         cmd_bits |= CMD_HD_EN;
131
132                 /* pause capability */
133                 if (!phydev->pause)
134                         cmd_bits |= CMD_RX_PAUSE_IGNORE | CMD_TX_PAUSE_IGNORE;
135
136                 /*
137                  * Program UMAC and RGMII block based on established
138                  * link speed, duplex, and pause. The speed set in
139                  * umac->cmd tell RGMII block which clock to use for
140                  * transmit -- 25MHz(100Mbps) or 125MHz(1Gbps).
141                  * Receive clock is provided by the PHY.
142                  */
143                 reg = bcmgenet_ext_readl(priv, EXT_RGMII_OOB_CTRL);
144                 reg &= ~OOB_DISABLE;
145                 reg |= RGMII_LINK;
146                 bcmgenet_ext_writel(priv, reg, EXT_RGMII_OOB_CTRL);
147
148                 reg = bcmgenet_umac_readl(priv, UMAC_CMD);
149                 reg &= ~((CMD_SPEED_MASK << CMD_SPEED_SHIFT) |
150                                CMD_HD_EN |
151                                CMD_RX_PAUSE_IGNORE | CMD_TX_PAUSE_IGNORE);
152                 reg |= cmd_bits;
153                 bcmgenet_umac_writel(priv, reg, UMAC_CMD);
154         } else {
155                 /* done if nothing has changed */
156                 if (!status_changed)
157                         return;
158
159                 /* needed for MoCA fixed PHY to reflect correct link status */
160                 netif_carrier_off(dev);
161         }
162
163         phy_print_status(phydev);
164 }
165
166 static int bcmgenet_fixed_phy_link_update(struct net_device *dev,
167                                           struct fixed_phy_status *status)
168 {
169         if (dev && dev->phydev && status)
170                 status->link = dev->phydev->link;
171
172         return 0;
173 }
174
175 void bcmgenet_phy_power_set(struct net_device *dev, bool enable)
176 {
177         struct bcmgenet_priv *priv = netdev_priv(dev);
178         u32 reg = 0;
179
180         /* EXT_GPHY_CTRL is only valid for GENETv4 and onward */
181         if (!GENET_IS_V4(priv))
182                 return;
183
184         reg = bcmgenet_ext_readl(priv, EXT_GPHY_CTRL);
185         if (enable) {
186                 reg &= ~EXT_CK25_DIS;
187                 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
188                 mdelay(1);
189
190                 reg &= ~(EXT_CFG_IDDQ_BIAS | EXT_CFG_PWR_DOWN);
191                 reg |= EXT_GPHY_RESET;
192                 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
193                 mdelay(1);
194
195                 reg &= ~EXT_GPHY_RESET;
196         } else {
197                 reg |= EXT_CFG_IDDQ_BIAS | EXT_CFG_PWR_DOWN | EXT_GPHY_RESET;
198                 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
199                 mdelay(1);
200                 reg |= EXT_CK25_DIS;
201         }
202         bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
203         udelay(60);
204 }
205
206 static void bcmgenet_internal_phy_setup(struct net_device *dev)
207 {
208         struct bcmgenet_priv *priv = netdev_priv(dev);
209         u32 reg;
210
211         /* Power up PHY */
212         bcmgenet_phy_power_set(dev, true);
213         /* enable APD */
214         reg = bcmgenet_ext_readl(priv, EXT_EXT_PWR_MGMT);
215         reg |= EXT_PWR_DN_EN_LD;
216         bcmgenet_ext_writel(priv, reg, EXT_EXT_PWR_MGMT);
217 }
218
219 static void bcmgenet_moca_phy_setup(struct bcmgenet_priv *priv)
220 {
221         u32 reg;
222
223         /* Speed settings are set in bcmgenet_mii_setup() */
224         reg = bcmgenet_sys_readl(priv, SYS_PORT_CTRL);
225         reg |= LED_ACT_SOURCE_MAC;
226         bcmgenet_sys_writel(priv, reg, SYS_PORT_CTRL);
227
228         if (priv->hw_params->flags & GENET_HAS_MOCA_LINK_DET)
229                 fixed_phy_set_link_update(priv->phydev,
230                                           bcmgenet_fixed_phy_link_update);
231 }
232
233 int bcmgenet_mii_config(struct net_device *dev)
234 {
235         struct bcmgenet_priv *priv = netdev_priv(dev);
236         struct phy_device *phydev = priv->phydev;
237         struct device *kdev = &priv->pdev->dev;
238         const char *phy_name = NULL;
239         u32 id_mode_dis = 0;
240         u32 port_ctrl;
241         u32 reg;
242
243         priv->ext_phy = !priv->internal_phy &&
244                         (priv->phy_interface != PHY_INTERFACE_MODE_MOCA);
245
246         if (priv->internal_phy)
247                 priv->phy_interface = PHY_INTERFACE_MODE_NA;
248
249         switch (priv->phy_interface) {
250         case PHY_INTERFACE_MODE_NA:
251         case PHY_INTERFACE_MODE_MOCA:
252                 /* Irrespective of the actually configured PHY speed (100 or
253                  * 1000) GENETv4 only has an internal GPHY so we will just end
254                  * up masking the Gigabit features from what we support, not
255                  * switching to the EPHY
256                  */
257                 if (GENET_IS_V4(priv))
258                         port_ctrl = PORT_MODE_INT_GPHY;
259                 else
260                         port_ctrl = PORT_MODE_INT_EPHY;
261
262                 bcmgenet_sys_writel(priv, port_ctrl, SYS_PORT_CTRL);
263
264                 if (priv->internal_phy) {
265                         phy_name = "internal PHY";
266                         bcmgenet_internal_phy_setup(dev);
267                 } else if (priv->phy_interface == PHY_INTERFACE_MODE_MOCA) {
268                         phy_name = "MoCA";
269                         bcmgenet_moca_phy_setup(priv);
270                 }
271                 break;
272
273         case PHY_INTERFACE_MODE_MII:
274                 phy_name = "external MII";
275                 phydev->supported &= PHY_BASIC_FEATURES;
276                 bcmgenet_sys_writel(priv,
277                                     PORT_MODE_EXT_EPHY, SYS_PORT_CTRL);
278                 break;
279
280         case PHY_INTERFACE_MODE_REVMII:
281                 phy_name = "external RvMII";
282                 /* of_mdiobus_register took care of reading the 'max-speed'
283                  * PHY property for us, effectively limiting the PHY supported
284                  * capabilities, use that knowledge to also configure the
285                  * Reverse MII interface correctly.
286                  */
287                 if ((priv->phydev->supported & PHY_BASIC_FEATURES) ==
288                                 PHY_BASIC_FEATURES)
289                         port_ctrl = PORT_MODE_EXT_RVMII_25;
290                 else
291                         port_ctrl = PORT_MODE_EXT_RVMII_50;
292                 bcmgenet_sys_writel(priv, port_ctrl, SYS_PORT_CTRL);
293                 break;
294
295         case PHY_INTERFACE_MODE_RGMII:
296                 /* RGMII_NO_ID: TXC transitions at the same time as TXD
297                  *              (requires PCB or receiver-side delay)
298                  * RGMII:       Add 2ns delay on TXC (90 degree shift)
299                  *
300                  * ID is implicitly disabled for 100Mbps (RG)MII operation.
301                  */
302                 id_mode_dis = BIT(16);
303                 /* fall through */
304         case PHY_INTERFACE_MODE_RGMII_TXID:
305                 if (id_mode_dis)
306                         phy_name = "external RGMII (no delay)";
307                 else
308                         phy_name = "external RGMII (TX delay)";
309                 bcmgenet_sys_writel(priv,
310                                     PORT_MODE_EXT_GPHY, SYS_PORT_CTRL);
311                 break;
312         default:
313                 dev_err(kdev, "unknown phy mode: %d\n", priv->phy_interface);
314                 return -EINVAL;
315         }
316
317         /* This is an external PHY (xMII), so we need to enable the RGMII
318          * block for the interface to work
319          */
320         if (priv->ext_phy) {
321                 reg = bcmgenet_ext_readl(priv, EXT_RGMII_OOB_CTRL);
322                 reg |= RGMII_MODE_EN | id_mode_dis;
323                 bcmgenet_ext_writel(priv, reg, EXT_RGMII_OOB_CTRL);
324         }
325
326         dev_info_once(kdev, "configuring instance for %s\n", phy_name);
327
328         return 0;
329 }
330
331 int bcmgenet_mii_probe(struct net_device *dev)
332 {
333         struct bcmgenet_priv *priv = netdev_priv(dev);
334         struct device_node *dn = priv->pdev->dev.of_node;
335         struct phy_device *phydev;
336         u32 phy_flags;
337         int ret;
338
339         /* Communicate the integrated PHY revision */
340         phy_flags = priv->gphy_rev;
341
342         /* Initialize link state variables that bcmgenet_mii_setup() uses */
343         priv->old_link = -1;
344         priv->old_speed = -1;
345         priv->old_duplex = -1;
346         priv->old_pause = -1;
347
348         if (dn) {
349                 phydev = of_phy_connect(dev, priv->phy_dn, bcmgenet_mii_setup,
350                                         phy_flags, priv->phy_interface);
351                 if (!phydev) {
352                         pr_err("could not attach to PHY\n");
353                         return -ENODEV;
354                 }
355         } else {
356                 phydev = priv->phydev;
357                 phydev->dev_flags = phy_flags;
358
359                 ret = phy_connect_direct(dev, phydev, bcmgenet_mii_setup,
360                                          priv->phy_interface);
361                 if (ret) {
362                         pr_err("could not attach to PHY\n");
363                         return -ENODEV;
364                 }
365         }
366
367         priv->phydev = phydev;
368
369         /* Configure port multiplexer based on what the probed PHY device since
370          * reading the 'max-speed' property determines the maximum supported
371          * PHY speed which is needed for bcmgenet_mii_config() to configure
372          * things appropriately.
373          */
374         ret = bcmgenet_mii_config(dev);
375         if (ret) {
376                 phy_disconnect(priv->phydev);
377                 return ret;
378         }
379
380         phydev->advertising = phydev->supported;
381
382         /* The internal PHY has its link interrupts routed to the
383          * Ethernet MAC ISRs
384          */
385         if (priv->internal_phy)
386                 priv->mii_bus->irq[phydev->addr] = PHY_IGNORE_INTERRUPT;
387         else
388                 priv->mii_bus->irq[phydev->addr] = PHY_POLL;
389
390         return 0;
391 }
392
393 /* Workaround for integrated BCM7xxx Gigabit PHYs which have a problem with
394  * their internal MDIO management controller making them fail to successfully
395  * be read from or written to for the first transaction.  We insert a dummy
396  * BMSR read here to make sure that phy_get_device() and get_phy_id() can
397  * correctly read the PHY MII_PHYSID1/2 registers and successfully register a
398  * PHY device for this peripheral.
399  *
400  * Once the PHY driver is registered, we can workaround subsequent reads from
401  * there (e.g: during system-wide power management).
402  *
403  * bus->reset is invoked before mdiobus_scan during mdiobus_register and is
404  * therefore the right location to stick that workaround. Since we do not want
405  * to read from non-existing PHYs, we either use bus->phy_mask or do a manual
406  * Device Tree scan to limit the search area.
407  */
408 static int bcmgenet_mii_bus_reset(struct mii_bus *bus)
409 {
410         struct net_device *dev = bus->priv;
411         struct bcmgenet_priv *priv = netdev_priv(dev);
412         struct device_node *np = priv->mdio_dn;
413         struct device_node *child = NULL;
414         u32 read_mask = 0;
415         int addr = 0;
416
417         if (!np) {
418                 read_mask = 1 << priv->phy_addr;
419         } else {
420                 for_each_available_child_of_node(np, child) {
421                         addr = of_mdio_parse_addr(&dev->dev, child);
422                         if (addr < 0)
423                                 continue;
424
425                         read_mask |= 1 << addr;
426                 }
427         }
428
429         for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
430                 if (read_mask & 1 << addr) {
431                         dev_dbg(&dev->dev, "Workaround for PHY @ %d\n", addr);
432                         mdiobus_read(bus, addr, MII_BMSR);
433                 }
434         }
435
436         return 0;
437 }
438
439 static int bcmgenet_mii_alloc(struct bcmgenet_priv *priv)
440 {
441         struct mii_bus *bus;
442
443         if (priv->mii_bus)
444                 return 0;
445
446         priv->mii_bus = mdiobus_alloc();
447         if (!priv->mii_bus) {
448                 pr_err("failed to allocate\n");
449                 return -ENOMEM;
450         }
451
452         bus = priv->mii_bus;
453         bus->priv = priv->dev;
454         bus->name = "bcmgenet MII bus";
455         bus->parent = &priv->pdev->dev;
456         bus->read = bcmgenet_mii_read;
457         bus->write = bcmgenet_mii_write;
458         bus->reset = bcmgenet_mii_bus_reset;
459         snprintf(bus->id, MII_BUS_ID_SIZE, "%s-%d",
460                  priv->pdev->name, priv->pdev->id);
461
462         bus->irq = kcalloc(PHY_MAX_ADDR, sizeof(int), GFP_KERNEL);
463         if (!bus->irq) {
464                 mdiobus_free(priv->mii_bus);
465                 return -ENOMEM;
466         }
467
468         return 0;
469 }
470
471 static int bcmgenet_mii_of_init(struct bcmgenet_priv *priv)
472 {
473         struct device_node *dn = priv->pdev->dev.of_node;
474         struct device *kdev = &priv->pdev->dev;
475         const char *phy_mode_str = NULL;
476         struct phy_device *phydev = NULL;
477         char *compat;
478         int phy_mode;
479         int ret;
480
481         compat = kasprintf(GFP_KERNEL, "brcm,genet-mdio-v%d", priv->version);
482         if (!compat)
483                 return -ENOMEM;
484
485         priv->mdio_dn = of_find_compatible_node(dn, NULL, compat);
486         kfree(compat);
487         if (!priv->mdio_dn) {
488                 dev_err(kdev, "unable to find MDIO bus node\n");
489                 return -ENODEV;
490         }
491
492         ret = of_mdiobus_register(priv->mii_bus, priv->mdio_dn);
493         if (ret) {
494                 dev_err(kdev, "failed to register MDIO bus\n");
495                 return ret;
496         }
497
498         /* Fetch the PHY phandle */
499         priv->phy_dn = of_parse_phandle(dn, "phy-handle", 0);
500
501         /* In the case of a fixed PHY, the DT node associated
502          * to the PHY is the Ethernet MAC DT node.
503          */
504         if (!priv->phy_dn && of_phy_is_fixed_link(dn)) {
505                 ret = of_phy_register_fixed_link(dn);
506                 if (ret)
507                         return ret;
508
509                 priv->phy_dn = of_node_get(dn);
510         }
511
512         /* Get the link mode */
513         phy_mode = of_get_phy_mode(dn);
514         priv->phy_interface = phy_mode;
515
516         /* We need to specifically look up whether this PHY interface is internal
517          * or not *before* we even try to probe the PHY driver over MDIO as we
518          * may have shut down the internal PHY for power saving purposes.
519          */
520         if (phy_mode < 0) {
521                 ret = of_property_read_string(dn, "phy-mode", &phy_mode_str);
522                 if (ret < 0) {
523                         dev_err(kdev, "invalid PHY mode property\n");
524                         return ret;
525                 }
526
527                 priv->phy_interface = PHY_INTERFACE_MODE_NA;
528                 if (!strcasecmp(phy_mode_str, "internal"))
529                         priv->internal_phy = true;
530         }
531
532         /* Make sure we initialize MoCA PHYs with a link down */
533         if (phy_mode == PHY_INTERFACE_MODE_MOCA) {
534                 phydev = of_phy_find_device(dn);
535                 if (phydev)
536                         phydev->link = 0;
537         }
538
539         return 0;
540 }
541
542 static int bcmgenet_mii_pd_init(struct bcmgenet_priv *priv)
543 {
544         struct device *kdev = &priv->pdev->dev;
545         struct bcmgenet_platform_data *pd = kdev->platform_data;
546         struct mii_bus *mdio = priv->mii_bus;
547         struct phy_device *phydev;
548         int ret;
549
550         if (pd->phy_interface != PHY_INTERFACE_MODE_MOCA && pd->mdio_enabled) {
551                 /*
552                  * Internal or external PHY with MDIO access
553                  */
554                 if (pd->phy_address >= 0 && pd->phy_address < PHY_MAX_ADDR)
555                         mdio->phy_mask = ~(1 << pd->phy_address);
556                 else
557                         mdio->phy_mask = 0;
558
559                 ret = mdiobus_register(mdio);
560                 if (ret) {
561                         dev_err(kdev, "failed to register MDIO bus\n");
562                         return ret;
563                 }
564
565                 if (pd->phy_address >= 0 && pd->phy_address < PHY_MAX_ADDR)
566                         phydev = mdio->phy_map[pd->phy_address];
567                 else
568                         phydev = phy_find_first(mdio);
569
570                 if (!phydev) {
571                         dev_err(kdev, "failed to register PHY device\n");
572                         mdiobus_unregister(mdio);
573                         return -ENODEV;
574                 }
575         } else {
576                 /*
577                  * MoCA port or no MDIO access.
578                  * Use fixed PHY to represent the link layer.
579                  */
580                 struct fixed_phy_status fphy_status = {
581                         .link = 1,
582                         .speed = pd->phy_speed,
583                         .duplex = pd->phy_duplex,
584                         .pause = 0,
585                         .asym_pause = 0,
586                 };
587
588                 phydev = fixed_phy_register(PHY_POLL, &fphy_status, -1, NULL);
589                 if (!phydev || IS_ERR(phydev)) {
590                         dev_err(kdev, "failed to register fixed PHY device\n");
591                         return -ENODEV;
592                 }
593
594                 /* Make sure we initialize MoCA PHYs with a link down */
595                 phydev->link = 0;
596
597         }
598
599         priv->phydev = phydev;
600         priv->phy_interface = pd->phy_interface;
601
602         return 0;
603 }
604
605 static int bcmgenet_mii_bus_init(struct bcmgenet_priv *priv)
606 {
607         struct device_node *dn = priv->pdev->dev.of_node;
608
609         if (dn)
610                 return bcmgenet_mii_of_init(priv);
611         else
612                 return bcmgenet_mii_pd_init(priv);
613 }
614
615 int bcmgenet_mii_init(struct net_device *dev)
616 {
617         struct bcmgenet_priv *priv = netdev_priv(dev);
618         int ret;
619
620         ret = bcmgenet_mii_alloc(priv);
621         if (ret)
622                 return ret;
623
624         ret = bcmgenet_mii_bus_init(priv);
625         if (ret)
626                 goto out;
627
628         return 0;
629
630 out:
631         of_node_put(priv->phy_dn);
632         mdiobus_unregister(priv->mii_bus);
633         kfree(priv->mii_bus->irq);
634         mdiobus_free(priv->mii_bus);
635         return ret;
636 }
637
638 void bcmgenet_mii_exit(struct net_device *dev)
639 {
640         struct bcmgenet_priv *priv = netdev_priv(dev);
641
642         of_node_put(priv->phy_dn);
643         mdiobus_unregister(priv->mii_bus);
644         kfree(priv->mii_bus->irq);
645         mdiobus_free(priv->mii_bus);
646 }