2 * Broadcom GENET MDIO routines
4 * Copyright (c) 2014-2017 Broadcom
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.
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>
24 #include <linux/of_net.h>
25 #include <linux/of_mdio.h>
26 #include <linux/platform_data/bcmgenet.h>
27 #include <linux/platform_data/mdio-bcm-unimac.h>
31 /* setup netdev link state when PHY link status change and
32 * update UMAC and RGMII block when link up
34 void bcmgenet_mii_setup(struct net_device *dev)
36 struct bcmgenet_priv *priv = netdev_priv(dev);
37 struct phy_device *phydev = dev->phydev;
38 u32 reg, cmd_bits = 0;
39 bool status_changed = false;
41 if (priv->old_link != phydev->link) {
42 status_changed = true;
43 priv->old_link = phydev->link;
47 /* check speed/duplex/pause changes */
48 if (priv->old_speed != phydev->speed) {
49 status_changed = true;
50 priv->old_speed = phydev->speed;
53 if (priv->old_duplex != phydev->duplex) {
54 status_changed = true;
55 priv->old_duplex = phydev->duplex;
58 if (priv->old_pause != phydev->pause) {
59 status_changed = true;
60 priv->old_pause = phydev->pause;
63 /* done if nothing has changed */
68 if (phydev->speed == SPEED_1000)
69 cmd_bits = UMAC_SPEED_1000;
70 else if (phydev->speed == SPEED_100)
71 cmd_bits = UMAC_SPEED_100;
73 cmd_bits = UMAC_SPEED_10;
74 cmd_bits <<= CMD_SPEED_SHIFT;
77 if (phydev->duplex != DUPLEX_FULL)
78 cmd_bits |= CMD_HD_EN;
80 /* pause capability */
82 cmd_bits |= CMD_RX_PAUSE_IGNORE | CMD_TX_PAUSE_IGNORE;
85 * Program UMAC and RGMII block based on established
86 * link speed, duplex, and pause. The speed set in
87 * umac->cmd tell RGMII block which clock to use for
88 * transmit -- 25MHz(100Mbps) or 125MHz(1Gbps).
89 * Receive clock is provided by the PHY.
91 reg = bcmgenet_ext_readl(priv, EXT_RGMII_OOB_CTRL);
94 bcmgenet_ext_writel(priv, reg, EXT_RGMII_OOB_CTRL);
96 reg = bcmgenet_umac_readl(priv, UMAC_CMD);
97 reg &= ~((CMD_SPEED_MASK << CMD_SPEED_SHIFT) |
99 CMD_RX_PAUSE_IGNORE | CMD_TX_PAUSE_IGNORE);
101 bcmgenet_umac_writel(priv, reg, UMAC_CMD);
103 /* done if nothing has changed */
107 /* needed for MoCA fixed PHY to reflect correct link status */
108 netif_carrier_off(dev);
111 phy_print_status(phydev);
115 static int bcmgenet_fixed_phy_link_update(struct net_device *dev,
116 struct fixed_phy_status *status)
118 struct bcmgenet_priv *priv;
121 if (dev && dev->phydev && status) {
122 priv = netdev_priv(dev);
123 reg = bcmgenet_umac_readl(priv, UMAC_MODE);
124 status->link = !!(reg & MODE_LINK_STATUS);
130 void bcmgenet_phy_power_set(struct net_device *dev, bool enable)
132 struct bcmgenet_priv *priv = netdev_priv(dev);
135 /* EXT_GPHY_CTRL is only valid for GENETv4 and onward */
136 if (GENET_IS_V4(priv)) {
137 reg = bcmgenet_ext_readl(priv, EXT_GPHY_CTRL);
139 reg &= ~EXT_CK25_DIS;
140 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
143 reg &= ~(EXT_CFG_IDDQ_BIAS | EXT_CFG_PWR_DOWN);
144 reg |= EXT_GPHY_RESET;
145 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
148 reg &= ~EXT_GPHY_RESET;
150 reg |= EXT_CFG_IDDQ_BIAS | EXT_CFG_PWR_DOWN |
152 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
156 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
163 static void bcmgenet_moca_phy_setup(struct bcmgenet_priv *priv)
167 if (!GENET_IS_V5(priv)) {
168 /* Speed settings are set in bcmgenet_mii_setup() */
169 reg = bcmgenet_sys_readl(priv, SYS_PORT_CTRL);
170 reg |= LED_ACT_SOURCE_MAC;
171 bcmgenet_sys_writel(priv, reg, SYS_PORT_CTRL);
174 if (priv->hw_params->flags & GENET_HAS_MOCA_LINK_DET)
175 fixed_phy_set_link_update(priv->dev->phydev,
176 bcmgenet_fixed_phy_link_update);
179 int bcmgenet_mii_config(struct net_device *dev, bool init)
181 struct bcmgenet_priv *priv = netdev_priv(dev);
182 struct phy_device *phydev = dev->phydev;
183 struct device *kdev = &priv->pdev->dev;
184 const char *phy_name = NULL;
191 /* MAC clocking workaround during reset of umac state machines */
192 reg = bcmgenet_umac_readl(priv, UMAC_CMD);
193 if (reg & CMD_SW_RESET) {
194 /* An MII PHY must be isolated to prevent TXC contention */
195 if (priv->phy_interface == PHY_INTERFACE_MODE_MII) {
196 ret = phy_read(phydev, MII_BMCR);
199 ret = phy_write(phydev, MII_BMCR,
200 bmcr | BMCR_ISOLATE);
203 netdev_err(dev, "failed to isolate PHY\n");
207 /* Switch MAC clocking to RGMII generated clock */
208 bcmgenet_sys_writel(priv, PORT_MODE_EXT_GPHY, SYS_PORT_CTRL);
209 /* Ensure 5 clks with Rx disabled
210 * followed by 5 clks with Reset asserted
213 reg &= ~(CMD_SW_RESET | CMD_LCL_LOOP_EN);
214 bcmgenet_umac_writel(priv, reg, UMAC_CMD);
215 /* Ensure 5 more clocks before Rx is enabled */
219 priv->ext_phy = !priv->internal_phy &&
220 (priv->phy_interface != PHY_INTERFACE_MODE_MOCA);
222 switch (priv->phy_interface) {
223 case PHY_INTERFACE_MODE_INTERNAL:
224 case PHY_INTERFACE_MODE_MOCA:
225 /* Irrespective of the actually configured PHY speed (100 or
226 * 1000) GENETv4 only has an internal GPHY so we will just end
227 * up masking the Gigabit features from what we support, not
228 * switching to the EPHY
230 if (GENET_IS_V4(priv))
231 port_ctrl = PORT_MODE_INT_GPHY;
233 port_ctrl = PORT_MODE_INT_EPHY;
235 bcmgenet_sys_writel(priv, port_ctrl, SYS_PORT_CTRL);
237 if (priv->internal_phy) {
238 phy_name = "internal PHY";
239 } else if (priv->phy_interface == PHY_INTERFACE_MODE_MOCA) {
241 bcmgenet_moca_phy_setup(priv);
245 case PHY_INTERFACE_MODE_MII:
246 phy_name = "external MII";
247 phydev->supported &= PHY_BASIC_FEATURES;
248 bcmgenet_sys_writel(priv,
249 PORT_MODE_EXT_EPHY, SYS_PORT_CTRL);
250 /* Restore the MII PHY after isolation */
252 phy_write(phydev, MII_BMCR, bmcr);
255 case PHY_INTERFACE_MODE_REVMII:
256 phy_name = "external RvMII";
257 /* of_mdiobus_register took care of reading the 'max-speed'
258 * PHY property for us, effectively limiting the PHY supported
259 * capabilities, use that knowledge to also configure the
260 * Reverse MII interface correctly.
262 if (dev->phydev->supported & PHY_1000BT_FEATURES)
263 port_ctrl = PORT_MODE_EXT_RVMII_50;
265 port_ctrl = PORT_MODE_EXT_RVMII_25;
266 bcmgenet_sys_writel(priv, port_ctrl, SYS_PORT_CTRL);
269 case PHY_INTERFACE_MODE_RGMII:
270 /* RGMII_NO_ID: TXC transitions at the same time as TXD
271 * (requires PCB or receiver-side delay)
272 * RGMII: Add 2ns delay on TXC (90 degree shift)
274 * ID is implicitly disabled for 100Mbps (RG)MII operation.
276 id_mode_dis = BIT(16);
278 case PHY_INTERFACE_MODE_RGMII_TXID:
280 phy_name = "external RGMII (no delay)";
282 phy_name = "external RGMII (TX delay)";
283 bcmgenet_sys_writel(priv,
284 PORT_MODE_EXT_GPHY, SYS_PORT_CTRL);
287 dev_err(kdev, "unknown phy mode: %d\n", priv->phy_interface);
291 /* This is an external PHY (xMII), so we need to enable the RGMII
292 * block for the interface to work
295 reg = bcmgenet_ext_readl(priv, EXT_RGMII_OOB_CTRL);
297 if (GENET_IS_V1(priv) || GENET_IS_V2(priv) || GENET_IS_V3(priv))
298 reg |= RGMII_MODE_EN_V123;
300 reg |= RGMII_MODE_EN;
301 bcmgenet_ext_writel(priv, reg, EXT_RGMII_OOB_CTRL);
305 dev_info(kdev, "configuring instance for %s\n", phy_name);
310 int bcmgenet_mii_probe(struct net_device *dev)
312 struct bcmgenet_priv *priv = netdev_priv(dev);
313 struct device_node *dn = priv->pdev->dev.of_node;
314 struct phy_device *phydev;
318 /* Communicate the integrated PHY revision */
319 if (priv->internal_phy)
320 phy_flags = priv->gphy_rev;
322 /* Initialize link state variables that bcmgenet_mii_setup() uses */
324 priv->old_speed = -1;
325 priv->old_duplex = -1;
326 priv->old_pause = -1;
329 phydev = of_phy_connect(dev, priv->phy_dn, bcmgenet_mii_setup,
330 phy_flags, priv->phy_interface);
332 pr_err("could not attach to PHY\n");
336 phydev = dev->phydev;
337 phydev->dev_flags = phy_flags;
339 ret = phy_connect_direct(dev, phydev, bcmgenet_mii_setup,
340 priv->phy_interface);
342 pr_err("could not attach to PHY\n");
347 /* Configure port multiplexer based on what the probed PHY device since
348 * reading the 'max-speed' property determines the maximum supported
349 * PHY speed which is needed for bcmgenet_mii_config() to configure
350 * things appropriately.
352 ret = bcmgenet_mii_config(dev, true);
354 phy_disconnect(dev->phydev);
358 phydev->advertising = phydev->supported;
360 /* The internal PHY has its link interrupts routed to the
361 * Ethernet MAC ISRs. On GENETv5 there is a hardware issue
362 * that prevents the signaling of link UP interrupts when
363 * the link operates at 10Mbps, so fallback to polling for
364 * those versions of GENET.
366 if (priv->internal_phy && !GENET_IS_V5(priv))
367 dev->phydev->irq = PHY_IGNORE_INTERRUPT;
372 static struct device_node *bcmgenet_mii_of_find_mdio(struct bcmgenet_priv *priv)
374 struct device_node *dn = priv->pdev->dev.of_node;
375 struct device *kdev = &priv->pdev->dev;
378 compat = kasprintf(GFP_KERNEL, "brcm,genet-mdio-v%d", priv->version);
382 priv->mdio_dn = of_get_compatible_child(dn, compat);
384 if (!priv->mdio_dn) {
385 dev_err(kdev, "unable to find MDIO bus node\n");
389 return priv->mdio_dn;
392 static void bcmgenet_mii_pdata_init(struct bcmgenet_priv *priv,
393 struct unimac_mdio_pdata *ppd)
395 struct device *kdev = &priv->pdev->dev;
396 struct bcmgenet_platform_data *pd = kdev->platform_data;
398 if (pd->phy_interface != PHY_INTERFACE_MODE_MOCA && pd->mdio_enabled) {
400 * Internal or external PHY with MDIO access
402 if (pd->phy_address >= 0 && pd->phy_address < PHY_MAX_ADDR)
403 ppd->phy_mask = 1 << pd->phy_address;
409 static int bcmgenet_mii_wait(void *wait_func_data)
411 struct bcmgenet_priv *priv = wait_func_data;
413 wait_event_timeout(priv->wq,
414 !(bcmgenet_umac_readl(priv, UMAC_MDIO_CMD)
420 static int bcmgenet_mii_register(struct bcmgenet_priv *priv)
422 struct platform_device *pdev = priv->pdev;
423 struct bcmgenet_platform_data *pdata = pdev->dev.platform_data;
424 struct device_node *dn = pdev->dev.of_node;
425 struct unimac_mdio_pdata ppd;
426 struct platform_device *ppdev;
427 struct resource *pres, res;
430 pres = platform_get_resource(pdev, IORESOURCE_MEM, 0);
432 dev_err(&pdev->dev, "Invalid resource\n");
435 memset(&res, 0, sizeof(res));
436 memset(&ppd, 0, sizeof(ppd));
438 ppd.wait_func = bcmgenet_mii_wait;
439 ppd.wait_func_data = priv;
440 ppd.bus_name = "bcmgenet MII bus";
442 /* Unimac MDIO bus controller starts at UniMAC offset + MDIO_CMD
443 * and is 2 * 32-bits word long, 8 bytes total.
445 res.start = pres->start + GENET_UMAC_OFF + UMAC_MDIO_CMD;
446 res.end = res.start + 8;
447 res.flags = IORESOURCE_MEM;
450 id = of_alias_get_id(dn, "eth");
454 ppdev = platform_device_alloc(UNIMAC_MDIO_DRV_NAME, id);
458 /* Retain this platform_device pointer for later cleanup */
459 priv->mii_pdev = ppdev;
460 ppdev->dev.parent = &pdev->dev;
461 ppdev->dev.of_node = bcmgenet_mii_of_find_mdio(priv);
463 bcmgenet_mii_pdata_init(priv, &ppd);
465 ret = platform_device_add_resources(ppdev, &res, 1);
469 ret = platform_device_add_data(ppdev, &ppd, sizeof(ppd));
473 ret = platform_device_add(ppdev);
479 platform_device_put(ppdev);
483 static int bcmgenet_mii_of_init(struct bcmgenet_priv *priv)
485 struct device_node *dn = priv->pdev->dev.of_node;
486 struct device *kdev = &priv->pdev->dev;
487 struct phy_device *phydev;
491 /* Fetch the PHY phandle */
492 priv->phy_dn = of_parse_phandle(dn, "phy-handle", 0);
494 /* In the case of a fixed PHY, the DT node associated
495 * to the PHY is the Ethernet MAC DT node.
497 if (!priv->phy_dn && of_phy_is_fixed_link(dn)) {
498 ret = of_phy_register_fixed_link(dn);
502 priv->phy_dn = of_node_get(dn);
505 /* Get the link mode */
506 phy_mode = of_get_phy_mode(dn);
508 dev_err(kdev, "invalid PHY mode property\n");
512 priv->phy_interface = phy_mode;
514 /* We need to specifically look up whether this PHY interface is internal
515 * or not *before* we even try to probe the PHY driver over MDIO as we
516 * may have shut down the internal PHY for power saving purposes.
518 if (priv->phy_interface == PHY_INTERFACE_MODE_INTERNAL)
519 priv->internal_phy = true;
521 /* Make sure we initialize MoCA PHYs with a link down */
522 if (phy_mode == PHY_INTERFACE_MODE_MOCA) {
523 phydev = of_phy_find_device(dn);
526 put_device(&phydev->mdio.dev);
533 static int bcmgenet_mii_pd_init(struct bcmgenet_priv *priv)
535 struct device *kdev = &priv->pdev->dev;
536 struct bcmgenet_platform_data *pd = kdev->platform_data;
537 char phy_name[MII_BUS_ID_SIZE + 3];
538 char mdio_bus_id[MII_BUS_ID_SIZE];
539 struct phy_device *phydev;
541 snprintf(mdio_bus_id, MII_BUS_ID_SIZE, "%s-%d",
542 UNIMAC_MDIO_DRV_NAME, priv->pdev->id);
544 if (pd->phy_interface != PHY_INTERFACE_MODE_MOCA && pd->mdio_enabled) {
545 snprintf(phy_name, MII_BUS_ID_SIZE, PHY_ID_FMT,
546 mdio_bus_id, pd->phy_address);
549 * Internal or external PHY with MDIO access
551 phydev = phy_attach(priv->dev, phy_name, pd->phy_interface);
553 dev_err(kdev, "failed to register PHY device\n");
558 * MoCA port or no MDIO access.
559 * Use fixed PHY to represent the link layer.
561 struct fixed_phy_status fphy_status = {
563 .speed = pd->phy_speed,
564 .duplex = pd->phy_duplex,
569 phydev = fixed_phy_register(PHY_POLL, &fphy_status, -1, NULL);
570 if (!phydev || IS_ERR(phydev)) {
571 dev_err(kdev, "failed to register fixed PHY device\n");
575 /* Make sure we initialize MoCA PHYs with a link down */
580 priv->phy_interface = pd->phy_interface;
585 static int bcmgenet_mii_bus_init(struct bcmgenet_priv *priv)
587 struct device_node *dn = priv->pdev->dev.of_node;
590 return bcmgenet_mii_of_init(priv);
592 return bcmgenet_mii_pd_init(priv);
595 int bcmgenet_mii_init(struct net_device *dev)
597 struct bcmgenet_priv *priv = netdev_priv(dev);
600 ret = bcmgenet_mii_register(priv);
604 ret = bcmgenet_mii_bus_init(priv);
611 bcmgenet_mii_exit(dev);
615 void bcmgenet_mii_exit(struct net_device *dev)
617 struct bcmgenet_priv *priv = netdev_priv(dev);
618 struct device_node *dn = priv->pdev->dev.of_node;
620 if (of_phy_is_fixed_link(dn))
621 of_phy_deregister_fixed_link(dn);
622 of_node_put(priv->phy_dn);
623 clk_prepare_enable(priv->clk);
624 platform_device_unregister(priv->mii_pdev);
625 clk_disable_unprepare(priv->clk);