1 // SPDX-License-Identifier: GPL-2.0-only
3 * Broadcom GENET MDIO routines
5 * Copyright (c) 2014-2024 Broadcom
8 #include <linux/acpi.h>
9 #include <linux/types.h>
10 #include <linux/delay.h>
11 #include <linux/wait.h>
12 #include <linux/mii.h>
13 #include <linux/ethtool.h>
14 #include <linux/bitops.h>
15 #include <linux/netdevice.h>
16 #include <linux/platform_device.h>
17 #include <linux/phy.h>
18 #include <linux/phy_fixed.h>
19 #include <linux/brcmphy.h>
21 #include <linux/of_net.h>
22 #include <linux/of_mdio.h>
23 #include <linux/platform_data/bcmgenet.h>
24 #include <linux/platform_data/mdio-bcm-unimac.h>
28 static void bcmgenet_mac_config(struct net_device *dev)
30 struct bcmgenet_priv *priv = netdev_priv(dev);
31 struct phy_device *phydev = dev->phydev;
32 u32 reg, cmd_bits = 0;
36 if (phydev->speed == SPEED_1000)
37 cmd_bits = CMD_SPEED_1000;
38 else if (phydev->speed == SPEED_100)
39 cmd_bits = CMD_SPEED_100;
41 cmd_bits = CMD_SPEED_10;
42 cmd_bits <<= CMD_SPEED_SHIFT;
45 if (phydev->duplex != DUPLEX_FULL) {
46 cmd_bits |= CMD_HD_EN |
47 CMD_RX_PAUSE_IGNORE | CMD_TX_PAUSE_IGNORE;
49 /* pause capability defaults to Symmetric */
50 if (priv->autoneg_pause) {
51 bool tx_pause = 0, rx_pause = 0;
54 phy_get_pause(phydev, &tx_pause, &rx_pause);
57 cmd_bits |= CMD_TX_PAUSE_IGNORE;
59 cmd_bits |= CMD_RX_PAUSE_IGNORE;
64 cmd_bits |= CMD_RX_PAUSE_IGNORE;
66 cmd_bits |= CMD_TX_PAUSE_IGNORE;
69 /* Program UMAC and RGMII block based on established
70 * link speed, duplex, and pause. The speed set in
71 * umac->cmd tell RGMII block which clock to use for
72 * transmit -- 25MHz(100Mbps) or 125MHz(1Gbps).
73 * Receive clock is provided by the PHY.
75 reg = bcmgenet_ext_readl(priv, EXT_RGMII_OOB_CTRL);
77 bcmgenet_ext_writel(priv, reg, EXT_RGMII_OOB_CTRL);
79 spin_lock_bh(&priv->reg_lock);
80 reg = bcmgenet_umac_readl(priv, UMAC_CMD);
81 reg &= ~((CMD_SPEED_MASK << CMD_SPEED_SHIFT) |
83 CMD_RX_PAUSE_IGNORE | CMD_TX_PAUSE_IGNORE);
85 if (reg & CMD_SW_RESET) {
87 bcmgenet_umac_writel(priv, reg, UMAC_CMD);
89 reg |= CMD_TX_EN | CMD_RX_EN;
91 bcmgenet_umac_writel(priv, reg, UMAC_CMD);
92 spin_unlock_bh(&priv->reg_lock);
94 active = phy_init_eee(phydev, 0) >= 0;
95 bcmgenet_eee_enable_set(dev,
96 priv->eee.eee_enabled && active,
97 priv->eee.tx_lpi_enabled);
100 /* setup netdev link state when PHY link status change and
101 * update UMAC and RGMII block when link up
103 void bcmgenet_mii_setup(struct net_device *dev)
105 struct bcmgenet_priv *priv = netdev_priv(dev);
106 struct phy_device *phydev = dev->phydev;
110 bcmgenet_mac_config(dev);
112 reg = bcmgenet_ext_readl(priv, EXT_RGMII_OOB_CTRL);
114 bcmgenet_ext_writel(priv, reg, EXT_RGMII_OOB_CTRL);
117 phy_print_status(phydev);
121 static int bcmgenet_fixed_phy_link_update(struct net_device *dev,
122 struct fixed_phy_status *status)
124 struct bcmgenet_priv *priv;
127 if (dev && dev->phydev && status) {
128 priv = netdev_priv(dev);
129 reg = bcmgenet_umac_readl(priv, UMAC_MODE);
130 status->link = !!(reg & MODE_LINK_STATUS);
136 void bcmgenet_phy_pause_set(struct net_device *dev, bool rx, bool tx)
138 struct phy_device *phydev = dev->phydev;
140 linkmode_mod_bit(ETHTOOL_LINK_MODE_Pause_BIT, phydev->advertising, rx);
141 linkmode_mod_bit(ETHTOOL_LINK_MODE_Asym_Pause_BIT, phydev->advertising,
143 phy_start_aneg(phydev);
145 mutex_lock(&phydev->lock);
147 bcmgenet_mac_config(dev);
148 mutex_unlock(&phydev->lock);
151 void bcmgenet_phy_power_set(struct net_device *dev, bool enable)
153 struct bcmgenet_priv *priv = netdev_priv(dev);
156 /* EXT_GPHY_CTRL is only valid for GENETv4 and onward */
157 if (GENET_IS_V4(priv) || priv->ephy_16nm) {
158 reg = bcmgenet_ext_readl(priv, EXT_GPHY_CTRL);
160 reg &= ~EXT_CK25_DIS;
161 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
164 reg &= ~(EXT_CFG_IDDQ_BIAS | EXT_CFG_PWR_DOWN |
165 EXT_CFG_IDDQ_GLOBAL_PWR);
166 reg |= EXT_GPHY_RESET;
167 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
170 reg &= ~EXT_GPHY_RESET;
172 reg |= EXT_CFG_IDDQ_BIAS | EXT_CFG_PWR_DOWN |
173 EXT_GPHY_RESET | EXT_CFG_IDDQ_GLOBAL_PWR;
174 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
178 bcmgenet_ext_writel(priv, reg, EXT_GPHY_CTRL);
185 static void bcmgenet_moca_phy_setup(struct bcmgenet_priv *priv)
187 if (priv->hw_params->flags & GENET_HAS_MOCA_LINK_DET)
188 fixed_phy_set_link_update(priv->dev->phydev,
189 bcmgenet_fixed_phy_link_update);
192 int bcmgenet_mii_config(struct net_device *dev, bool init)
194 struct bcmgenet_priv *priv = netdev_priv(dev);
195 struct phy_device *phydev = dev->phydev;
196 struct device *kdev = &priv->pdev->dev;
197 const char *phy_name = NULL;
202 switch (priv->phy_interface) {
203 case PHY_INTERFACE_MODE_INTERNAL:
204 phy_name = "internal PHY";
206 case PHY_INTERFACE_MODE_MOCA:
207 /* Irrespective of the actually configured PHY speed (100 or
208 * 1000) GENETv4 only has an internal GPHY so we will just end
209 * up masking the Gigabit features from what we support, not
210 * switching to the EPHY
212 if (GENET_IS_V4(priv))
213 port_ctrl = PORT_MODE_INT_GPHY;
215 port_ctrl = PORT_MODE_INT_EPHY;
219 if (!GENET_IS_V5(priv))
220 port_ctrl |= LED_ACT_SOURCE_MAC;
221 bcmgenet_moca_phy_setup(priv);
225 case PHY_INTERFACE_MODE_MII:
226 phy_name = "external MII";
227 phy_set_max_speed(phydev, SPEED_100);
228 port_ctrl = PORT_MODE_EXT_EPHY;
231 case PHY_INTERFACE_MODE_REVMII:
232 phy_name = "external RvMII";
233 /* of_mdiobus_register took care of reading the 'max-speed'
234 * PHY property for us, effectively limiting the PHY supported
235 * capabilities, use that knowledge to also configure the
236 * Reverse MII interface correctly.
238 if (linkmode_test_bit(ETHTOOL_LINK_MODE_1000baseT_Full_BIT,
239 dev->phydev->supported))
240 port_ctrl = PORT_MODE_EXT_RVMII_50;
242 port_ctrl = PORT_MODE_EXT_RVMII_25;
245 case PHY_INTERFACE_MODE_RGMII:
246 /* RGMII_NO_ID: TXC transitions at the same time as TXD
247 * (requires PCB or receiver-side delay)
249 * ID is implicitly disabled for 100Mbps (RG)MII operation.
251 phy_name = "external RGMII (no delay)";
252 id_mode_dis = BIT(16);
253 port_ctrl = PORT_MODE_EXT_GPHY;
256 case PHY_INTERFACE_MODE_RGMII_TXID:
257 /* RGMII_TXID: Add 2ns delay on TXC (90 degree shift) */
258 phy_name = "external RGMII (TX delay)";
259 port_ctrl = PORT_MODE_EXT_GPHY;
262 case PHY_INTERFACE_MODE_RGMII_RXID:
263 phy_name = "external RGMII (RX delay)";
264 port_ctrl = PORT_MODE_EXT_GPHY;
267 dev_err(kdev, "unknown phy mode: %d\n", priv->phy_interface);
271 bcmgenet_sys_writel(priv, port_ctrl, SYS_PORT_CTRL);
273 priv->ext_phy = !priv->internal_phy &&
274 (priv->phy_interface != PHY_INTERFACE_MODE_MOCA);
276 /* This is an external PHY (xMII), so we need to enable the RGMII
277 * block for the interface to work, unconditionally clear the
278 * Out-of-band disable since we do not need it.
280 mutex_lock(&phydev->lock);
281 reg = bcmgenet_ext_readl(priv, EXT_RGMII_OOB_CTRL);
286 if (GENET_IS_V1(priv) || GENET_IS_V2(priv) || GENET_IS_V3(priv))
287 reg |= RGMII_MODE_EN_V123;
289 reg |= RGMII_MODE_EN;
291 bcmgenet_ext_writel(priv, reg, EXT_RGMII_OOB_CTRL);
292 mutex_unlock(&phydev->lock);
295 dev_info(kdev, "configuring instance for %s\n", phy_name);
300 int bcmgenet_mii_probe(struct net_device *dev)
302 struct bcmgenet_priv *priv = netdev_priv(dev);
303 struct device *kdev = &priv->pdev->dev;
304 struct device_node *dn = kdev->of_node;
305 phy_interface_t phy_iface = priv->phy_interface;
306 struct phy_device *phydev;
307 u32 phy_flags = PHY_BRCM_AUTO_PWRDWN_ENABLE |
308 PHY_BRCM_DIS_TXCRXC_NOENRGY |
309 PHY_BRCM_IDDQ_SUSPEND;
312 /* Communicate the integrated PHY revision */
313 if (priv->internal_phy)
314 phy_flags = priv->gphy_rev;
316 /* This is an ugly quirk but we have not been correctly interpreting
317 * the phy_interface values and we have done that across different
318 * drivers, so at least we are consistent in our mistakes.
320 * When the Generic PHY driver is in use either the PHY has been
321 * strapped or programmed correctly by the boot loader so we should
322 * stick to our incorrect interpretation since we have validated it.
324 * Now when a dedicated PHY driver is in use, we need to reverse the
325 * meaning of the phy_interface_mode values to something that the PHY
326 * driver will interpret and act on such that we have two mistakes
327 * canceling themselves so to speak. We only do this for the two
328 * modes that GENET driver officially supports on Broadcom STB chips:
329 * PHY_INTERFACE_MODE_RGMII and PHY_INTERFACE_MODE_RGMII_TXID. Other
330 * modes are not *officially* supported with the boot loader and the
331 * scripted environment generating Device Tree blobs for those
334 * Note that internal PHY, MoCA and fixed-link configurations are not
335 * affected because they use different phy_interface_t values or the
336 * Generic PHY driver.
338 switch (priv->phy_interface) {
339 case PHY_INTERFACE_MODE_RGMII:
340 phy_iface = PHY_INTERFACE_MODE_RGMII_ID;
342 case PHY_INTERFACE_MODE_RGMII_TXID:
343 phy_iface = PHY_INTERFACE_MODE_RGMII_RXID;
350 phydev = of_phy_connect(dev, priv->phy_dn, bcmgenet_mii_setup,
351 phy_flags, phy_iface);
353 pr_err("could not attach to PHY\n");
357 if (has_acpi_companion(kdev)) {
358 char mdio_bus_id[MII_BUS_ID_SIZE];
359 struct mii_bus *unimacbus;
361 snprintf(mdio_bus_id, MII_BUS_ID_SIZE, "%s-%d",
362 UNIMAC_MDIO_DRV_NAME, priv->pdev->id);
364 unimacbus = mdio_find_bus(mdio_bus_id);
366 pr_err("Unable to find mii\n");
369 phydev = phy_find_first(unimacbus);
370 put_device(&unimacbus->dev);
372 pr_err("Unable to find PHY\n");
376 phydev = dev->phydev;
378 phydev->dev_flags = phy_flags;
380 ret = phy_connect_direct(dev, phydev, bcmgenet_mii_setup,
383 pr_err("could not attach to PHY\n");
388 /* Configure port multiplexer based on what the probed PHY device since
389 * reading the 'max-speed' property determines the maximum supported
390 * PHY speed which is needed for bcmgenet_mii_config() to configure
391 * things appropriately.
393 ret = bcmgenet_mii_config(dev, true);
395 phy_disconnect(dev->phydev);
399 /* The internal PHY has its link interrupts routed to the
400 * Ethernet MAC ISRs. On GENETv5 there is a hardware issue
401 * that prevents the signaling of link UP interrupts when
402 * the link operates at 10Mbps, so fallback to polling for
403 * those versions of GENET.
405 if (priv->internal_phy && !GENET_IS_V5(priv))
406 dev->phydev->irq = PHY_MAC_INTERRUPT;
408 /* Indicate that the MAC is responsible for PHY PM */
409 dev->phydev->mac_managed_pm = true;
414 static struct device_node *bcmgenet_mii_of_find_mdio(struct bcmgenet_priv *priv)
416 struct device_node *dn = priv->pdev->dev.of_node;
417 struct device *kdev = &priv->pdev->dev;
420 compat = kasprintf(GFP_KERNEL, "brcm,genet-mdio-v%d", priv->version);
424 priv->mdio_dn = of_get_compatible_child(dn, compat);
426 if (!priv->mdio_dn) {
427 dev_err(kdev, "unable to find MDIO bus node\n");
431 return priv->mdio_dn;
434 static void bcmgenet_mii_pdata_init(struct bcmgenet_priv *priv,
435 struct unimac_mdio_pdata *ppd)
437 struct device *kdev = &priv->pdev->dev;
438 struct bcmgenet_platform_data *pd = kdev->platform_data;
440 if (pd->phy_interface != PHY_INTERFACE_MODE_MOCA && pd->mdio_enabled) {
442 * Internal or external PHY with MDIO access
444 if (pd->phy_address >= 0 && pd->phy_address < PHY_MAX_ADDR)
445 ppd->phy_mask = 1 << pd->phy_address;
451 static int bcmgenet_mii_wait(void *wait_func_data)
453 struct bcmgenet_priv *priv = wait_func_data;
455 wait_event_timeout(priv->wq,
456 !(bcmgenet_umac_readl(priv, UMAC_MDIO_CMD)
462 static int bcmgenet_mii_register(struct bcmgenet_priv *priv)
464 struct platform_device *pdev = priv->pdev;
465 struct bcmgenet_platform_data *pdata = pdev->dev.platform_data;
466 struct device_node *dn = pdev->dev.of_node;
467 struct unimac_mdio_pdata ppd;
468 struct platform_device *ppdev;
469 struct resource *pres, res;
472 pres = platform_get_resource(pdev, IORESOURCE_MEM, 0);
474 dev_err(&pdev->dev, "Invalid resource\n");
477 memset(&res, 0, sizeof(res));
478 memset(&ppd, 0, sizeof(ppd));
480 ppd.wait_func = bcmgenet_mii_wait;
481 ppd.wait_func_data = priv;
482 ppd.bus_name = "bcmgenet MII bus";
483 /* Pass a reference to our "main" clock which is used for MDIO
488 /* Unimac MDIO bus controller starts at UniMAC offset + MDIO_CMD
489 * and is 2 * 32-bits word long, 8 bytes total.
491 res.start = pres->start + GENET_UMAC_OFF + UMAC_MDIO_CMD;
492 res.end = res.start + 8;
493 res.flags = IORESOURCE_MEM;
496 id = of_alias_get_id(dn, "eth");
500 ppdev = platform_device_alloc(UNIMAC_MDIO_DRV_NAME, id);
504 /* Retain this platform_device pointer for later cleanup */
505 priv->mii_pdev = ppdev;
506 ppdev->dev.parent = &pdev->dev;
508 ppdev->dev.of_node = bcmgenet_mii_of_find_mdio(priv);
510 bcmgenet_mii_pdata_init(priv, &ppd);
514 ret = platform_device_add_resources(ppdev, &res, 1);
518 ret = platform_device_add_data(ppdev, &ppd, sizeof(ppd));
522 ret = platform_device_add(ppdev);
528 platform_device_put(ppdev);
532 static int bcmgenet_phy_interface_init(struct bcmgenet_priv *priv)
534 struct device *kdev = &priv->pdev->dev;
535 int phy_mode = device_get_phy_mode(kdev);
538 dev_err(kdev, "invalid PHY mode property\n");
542 priv->phy_interface = phy_mode;
544 /* We need to specifically look up whether this PHY interface is
545 * internal or not *before* we even try to probe the PHY driver
546 * over MDIO as we may have shut down the internal PHY for power
549 if (priv->phy_interface == PHY_INTERFACE_MODE_INTERNAL)
550 priv->internal_phy = true;
555 static int bcmgenet_mii_of_init(struct bcmgenet_priv *priv)
557 struct device_node *dn = priv->pdev->dev.of_node;
558 struct phy_device *phydev;
561 /* Fetch the PHY phandle */
562 priv->phy_dn = of_parse_phandle(dn, "phy-handle", 0);
564 /* In the case of a fixed PHY, the DT node associated
565 * to the PHY is the Ethernet MAC DT node.
567 if (!priv->phy_dn && of_phy_is_fixed_link(dn)) {
568 ret = of_phy_register_fixed_link(dn);
572 priv->phy_dn = of_node_get(dn);
575 /* Get the link mode */
576 ret = bcmgenet_phy_interface_init(priv);
580 /* Make sure we initialize MoCA PHYs with a link down */
581 if (priv->phy_interface == PHY_INTERFACE_MODE_MOCA) {
582 phydev = of_phy_find_device(dn);
585 put_device(&phydev->mdio.dev);
592 static int bcmgenet_mii_pd_init(struct bcmgenet_priv *priv)
594 struct device *kdev = &priv->pdev->dev;
595 struct bcmgenet_platform_data *pd = kdev->platform_data;
596 char phy_name[MII_BUS_ID_SIZE + 3];
597 char mdio_bus_id[MII_BUS_ID_SIZE];
598 struct phy_device *phydev;
600 snprintf(mdio_bus_id, MII_BUS_ID_SIZE, "%s-%d",
601 UNIMAC_MDIO_DRV_NAME, priv->pdev->id);
603 if (pd->phy_interface != PHY_INTERFACE_MODE_MOCA && pd->mdio_enabled) {
604 snprintf(phy_name, MII_BUS_ID_SIZE, PHY_ID_FMT,
605 mdio_bus_id, pd->phy_address);
608 * Internal or external PHY with MDIO access
610 phydev = phy_attach(priv->dev, phy_name, pd->phy_interface);
611 if (IS_ERR(phydev)) {
612 dev_err(kdev, "failed to register PHY device\n");
613 return PTR_ERR(phydev);
617 * MoCA port or no MDIO access.
618 * Use fixed PHY to represent the link layer.
620 struct fixed_phy_status fphy_status = {
622 .speed = pd->phy_speed,
623 .duplex = pd->phy_duplex,
628 phydev = fixed_phy_register(PHY_POLL, &fphy_status, NULL);
629 if (IS_ERR(phydev)) {
630 dev_err(kdev, "failed to register fixed PHY device\n");
631 return PTR_ERR(phydev);
634 /* Make sure we initialize MoCA PHYs with a link down */
639 priv->phy_interface = pd->phy_interface;
644 static int bcmgenet_mii_bus_init(struct bcmgenet_priv *priv)
646 struct device *kdev = &priv->pdev->dev;
647 struct device_node *dn = kdev->of_node;
650 return bcmgenet_mii_of_init(priv);
651 else if (has_acpi_companion(kdev))
652 return bcmgenet_phy_interface_init(priv);
654 return bcmgenet_mii_pd_init(priv);
657 int bcmgenet_mii_init(struct net_device *dev)
659 struct bcmgenet_priv *priv = netdev_priv(dev);
662 ret = bcmgenet_mii_register(priv);
666 ret = bcmgenet_mii_bus_init(priv);
673 bcmgenet_mii_exit(dev);
677 void bcmgenet_mii_exit(struct net_device *dev)
679 struct bcmgenet_priv *priv = netdev_priv(dev);
680 struct device_node *dn = priv->pdev->dev.of_node;
682 if (of_phy_is_fixed_link(dn))
683 of_phy_deregister_fixed_link(dn);
684 of_node_put(priv->phy_dn);
685 platform_device_unregister(priv->mii_pdev);