1 // SPDX-License-Identifier: GPL-2.0-only
2 /*******************************************************************************
3 STMMAC Ethernet Driver -- MDIO bus implementation
4 Provides Bus interface for MII registers
6 Copyright (C) 2007-2009 STMicroelectronics Ltd
9 Author: Carl Shaw <carl.shaw@st.com>
10 Maintainer: Giuseppe Cavallaro <peppe.cavallaro@st.com>
11 *******************************************************************************/
13 #include <linux/gpio/consumer.h>
15 #include <linux/iopoll.h>
16 #include <linux/mii.h>
17 #include <linux/of_mdio.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/phy.h>
20 #include <linux/property.h>
21 #include <linux/slab.h>
26 #define MII_BUSY 0x00000001
27 #define MII_WRITE 0x00000002
28 #define MII_DATA_MASK GENMASK(15, 0)
31 #define MII_GMAC4_GOC_SHIFT 2
32 #define MII_GMAC4_REG_ADDR_SHIFT 16
33 #define MII_GMAC4_WRITE (1 << MII_GMAC4_GOC_SHIFT)
34 #define MII_GMAC4_READ (3 << MII_GMAC4_GOC_SHIFT)
35 #define MII_GMAC4_C45E BIT(1)
38 #define MII_XGMAC_SADDR BIT(18)
39 #define MII_XGMAC_CMD_SHIFT 16
40 #define MII_XGMAC_WRITE (1 << MII_XGMAC_CMD_SHIFT)
41 #define MII_XGMAC_READ (3 << MII_XGMAC_CMD_SHIFT)
42 #define MII_XGMAC_BUSY BIT(22)
43 #define MII_XGMAC_MAX_C22ADDR 3
44 #define MII_XGMAC_C22P_MASK GENMASK(MII_XGMAC_MAX_C22ADDR, 0)
45 #define MII_XGMAC_PA_SHIFT 16
46 #define MII_XGMAC_DA_SHIFT 21
48 static void stmmac_xgmac2_c45_format(struct stmmac_priv *priv, int phyaddr,
49 int devad, int phyreg, u32 *hw_addr)
53 /* Set port as Clause 45 */
54 tmp = readl(priv->ioaddr + XGMAC_MDIO_C22P);
56 writel(tmp, priv->ioaddr + XGMAC_MDIO_C22P);
58 *hw_addr = (phyaddr << MII_XGMAC_PA_SHIFT) | (phyreg & 0xffff);
59 *hw_addr |= devad << MII_XGMAC_DA_SHIFT;
62 static void stmmac_xgmac2_c22_format(struct stmmac_priv *priv, int phyaddr,
63 int phyreg, u32 *hw_addr)
67 if (priv->synopsys_id < DWXGMAC_CORE_2_20) {
68 /* Until ver 2.20 XGMAC does not support C22 addr >= 4. Those
69 * bits above bit 3 of XGMAC_MDIO_C22P register are reserved.
71 tmp = readl(priv->ioaddr + XGMAC_MDIO_C22P);
72 tmp &= ~MII_XGMAC_C22P_MASK;
74 /* Set port as Clause 22 */
76 writel(tmp, priv->ioaddr + XGMAC_MDIO_C22P);
78 *hw_addr = (phyaddr << MII_XGMAC_PA_SHIFT) | (phyreg & 0x1f);
81 static int stmmac_xgmac2_mdio_read(struct stmmac_priv *priv, u32 addr,
84 unsigned int mii_address = priv->hw->mii.addr;
85 unsigned int mii_data = priv->hw->mii.data;
89 ret = pm_runtime_resume_and_get(priv->device);
93 /* Wait until any existing MII operation is complete */
94 if (readl_poll_timeout(priv->ioaddr + mii_data, tmp,
95 !(tmp & MII_XGMAC_BUSY), 100, 10000)) {
97 goto err_disable_clks;
100 value |= (priv->clk_csr << priv->hw->mii.clk_csr_shift)
101 & priv->hw->mii.clk_csr_mask;
102 value |= MII_XGMAC_READ;
104 /* Wait until any existing MII operation is complete */
105 if (readl_poll_timeout(priv->ioaddr + mii_data, tmp,
106 !(tmp & MII_XGMAC_BUSY), 100, 10000)) {
108 goto err_disable_clks;
111 /* Set the MII address register to read */
112 writel(addr, priv->ioaddr + mii_address);
113 writel(value, priv->ioaddr + mii_data);
115 /* Wait until any existing MII operation is complete */
116 if (readl_poll_timeout(priv->ioaddr + mii_data, tmp,
117 !(tmp & MII_XGMAC_BUSY), 100, 10000)) {
119 goto err_disable_clks;
122 /* Read the data from the MII data register */
123 ret = (int)readl(priv->ioaddr + mii_data) & GENMASK(15, 0);
126 pm_runtime_put(priv->device);
131 static int stmmac_xgmac2_mdio_read_c22(struct mii_bus *bus, int phyaddr,
134 struct net_device *ndev = bus->priv;
135 struct stmmac_priv *priv;
138 priv = netdev_priv(ndev);
140 /* Until ver 2.20 XGMAC does not support C22 addr >= 4 */
141 if (priv->synopsys_id < DWXGMAC_CORE_2_20 &&
142 phyaddr > MII_XGMAC_MAX_C22ADDR)
145 stmmac_xgmac2_c22_format(priv, phyaddr, phyreg, &addr);
147 return stmmac_xgmac2_mdio_read(priv, addr, MII_XGMAC_BUSY);
150 static int stmmac_xgmac2_mdio_read_c45(struct mii_bus *bus, int phyaddr,
151 int devad, int phyreg)
153 struct net_device *ndev = bus->priv;
154 struct stmmac_priv *priv;
157 priv = netdev_priv(ndev);
159 stmmac_xgmac2_c45_format(priv, phyaddr, devad, phyreg, &addr);
161 return stmmac_xgmac2_mdio_read(priv, addr, MII_XGMAC_BUSY);
164 static int stmmac_xgmac2_mdio_write(struct stmmac_priv *priv, u32 addr,
165 u32 value, u16 phydata)
167 unsigned int mii_address = priv->hw->mii.addr;
168 unsigned int mii_data = priv->hw->mii.data;
172 ret = pm_runtime_resume_and_get(priv->device);
176 /* Wait until any existing MII operation is complete */
177 if (readl_poll_timeout(priv->ioaddr + mii_data, tmp,
178 !(tmp & MII_XGMAC_BUSY), 100, 10000)) {
180 goto err_disable_clks;
183 value |= (priv->clk_csr << priv->hw->mii.clk_csr_shift)
184 & priv->hw->mii.clk_csr_mask;
186 value |= MII_XGMAC_WRITE;
188 /* Wait until any existing MII operation is complete */
189 if (readl_poll_timeout(priv->ioaddr + mii_data, tmp,
190 !(tmp & MII_XGMAC_BUSY), 100, 10000)) {
192 goto err_disable_clks;
195 /* Set the MII address register to write */
196 writel(addr, priv->ioaddr + mii_address);
197 writel(value, priv->ioaddr + mii_data);
199 /* Wait until any existing MII operation is complete */
200 ret = readl_poll_timeout(priv->ioaddr + mii_data, tmp,
201 !(tmp & MII_XGMAC_BUSY), 100, 10000);
204 pm_runtime_put(priv->device);
209 static int stmmac_xgmac2_mdio_write_c22(struct mii_bus *bus, int phyaddr,
210 int phyreg, u16 phydata)
212 struct net_device *ndev = bus->priv;
213 struct stmmac_priv *priv;
216 priv = netdev_priv(ndev);
218 /* Until ver 2.20 XGMAC does not support C22 addr >= 4 */
219 if (priv->synopsys_id < DWXGMAC_CORE_2_20 &&
220 phyaddr > MII_XGMAC_MAX_C22ADDR)
223 stmmac_xgmac2_c22_format(priv, phyaddr, phyreg, &addr);
225 return stmmac_xgmac2_mdio_write(priv, addr,
226 MII_XGMAC_BUSY | MII_XGMAC_SADDR, phydata);
229 static int stmmac_xgmac2_mdio_write_c45(struct mii_bus *bus, int phyaddr,
230 int devad, int phyreg, u16 phydata)
232 struct net_device *ndev = bus->priv;
233 struct stmmac_priv *priv;
236 priv = netdev_priv(ndev);
238 stmmac_xgmac2_c45_format(priv, phyaddr, devad, phyreg, &addr);
240 return stmmac_xgmac2_mdio_write(priv, addr, MII_XGMAC_BUSY,
244 static int stmmac_mdio_read(struct stmmac_priv *priv, int data, u32 value)
246 unsigned int mii_address = priv->hw->mii.addr;
247 unsigned int mii_data = priv->hw->mii.data;
250 if (readl_poll_timeout(priv->ioaddr + mii_address, v, !(v & MII_BUSY),
254 writel(data, priv->ioaddr + mii_data);
255 writel(value, priv->ioaddr + mii_address);
257 if (readl_poll_timeout(priv->ioaddr + mii_address, v, !(v & MII_BUSY),
261 /* Read the data from the MII data register */
262 return readl(priv->ioaddr + mii_data) & MII_DATA_MASK;
266 * stmmac_mdio_read_c22
267 * @bus: points to the mii_bus structure
270 * Description: it reads data from the MII register from within the phy device.
271 * For the 7111 GMAC, we must set the bit 0 in the MII address register while
272 * accessing the PHY registers.
273 * Fortunately, it seems this has no drawback for the 7109 MAC.
275 static int stmmac_mdio_read_c22(struct mii_bus *bus, int phyaddr, int phyreg)
277 struct net_device *ndev = bus->priv;
278 struct stmmac_priv *priv = netdev_priv(ndev);
279 u32 value = MII_BUSY;
282 data = pm_runtime_resume_and_get(priv->device);
286 value |= (phyaddr << priv->hw->mii.addr_shift)
287 & priv->hw->mii.addr_mask;
288 value |= (phyreg << priv->hw->mii.reg_shift) & priv->hw->mii.reg_mask;
289 value |= (priv->clk_csr << priv->hw->mii.clk_csr_shift)
290 & priv->hw->mii.clk_csr_mask;
291 if (priv->plat->has_gmac4)
292 value |= MII_GMAC4_READ;
294 data = stmmac_mdio_read(priv, data, value);
296 pm_runtime_put(priv->device);
302 * stmmac_mdio_read_c45
303 * @bus: points to the mii_bus structure
305 * @devad: device address to read
307 * Description: it reads data from the MII register from within the phy device.
308 * For the 7111 GMAC, we must set the bit 0 in the MII address register while
309 * accessing the PHY registers.
310 * Fortunately, it seems this has no drawback for the 7109 MAC.
312 static int stmmac_mdio_read_c45(struct mii_bus *bus, int phyaddr, int devad,
315 struct net_device *ndev = bus->priv;
316 struct stmmac_priv *priv = netdev_priv(ndev);
317 u32 value = MII_BUSY;
320 data = pm_runtime_get_sync(priv->device);
322 pm_runtime_put_noidle(priv->device);
326 value |= (phyaddr << priv->hw->mii.addr_shift)
327 & priv->hw->mii.addr_mask;
328 value |= (phyreg << priv->hw->mii.reg_shift) & priv->hw->mii.reg_mask;
329 value |= (priv->clk_csr << priv->hw->mii.clk_csr_shift)
330 & priv->hw->mii.clk_csr_mask;
331 value |= MII_GMAC4_READ;
332 value |= MII_GMAC4_C45E;
333 value &= ~priv->hw->mii.reg_mask;
334 value |= (devad << priv->hw->mii.reg_shift) & priv->hw->mii.reg_mask;
336 data |= phyreg << MII_GMAC4_REG_ADDR_SHIFT;
338 data = stmmac_mdio_read(priv, data, value);
340 pm_runtime_put(priv->device);
345 static int stmmac_mdio_write(struct stmmac_priv *priv, int data, u32 value)
347 unsigned int mii_address = priv->hw->mii.addr;
348 unsigned int mii_data = priv->hw->mii.data;
351 /* Wait until any existing MII operation is complete */
352 if (readl_poll_timeout(priv->ioaddr + mii_address, v, !(v & MII_BUSY),
356 /* Set the MII address register to write */
357 writel(data, priv->ioaddr + mii_data);
358 writel(value, priv->ioaddr + mii_address);
360 /* Wait until any existing MII operation is complete */
361 return readl_poll_timeout(priv->ioaddr + mii_address, v,
362 !(v & MII_BUSY), 100, 10000);
366 * stmmac_mdio_write_c22
367 * @bus: points to the mii_bus structure
371 * Description: it writes the data into the MII register from within the device.
373 static int stmmac_mdio_write_c22(struct mii_bus *bus, int phyaddr, int phyreg,
376 struct net_device *ndev = bus->priv;
377 struct stmmac_priv *priv = netdev_priv(ndev);
378 int ret, data = phydata;
379 u32 value = MII_BUSY;
381 ret = pm_runtime_resume_and_get(priv->device);
385 value |= (phyaddr << priv->hw->mii.addr_shift)
386 & priv->hw->mii.addr_mask;
387 value |= (phyreg << priv->hw->mii.reg_shift) & priv->hw->mii.reg_mask;
389 value |= (priv->clk_csr << priv->hw->mii.clk_csr_shift)
390 & priv->hw->mii.clk_csr_mask;
391 if (priv->plat->has_gmac4)
392 value |= MII_GMAC4_WRITE;
396 ret = stmmac_mdio_write(priv, data, value);
398 pm_runtime_put(priv->device);
404 * stmmac_mdio_write_c45
405 * @bus: points to the mii_bus structure
408 * @devad: device address to read
410 * Description: it writes the data into the MII register from within the device.
412 static int stmmac_mdio_write_c45(struct mii_bus *bus, int phyaddr,
413 int devad, int phyreg, u16 phydata)
415 struct net_device *ndev = bus->priv;
416 struct stmmac_priv *priv = netdev_priv(ndev);
417 int ret, data = phydata;
418 u32 value = MII_BUSY;
420 ret = pm_runtime_get_sync(priv->device);
422 pm_runtime_put_noidle(priv->device);
426 value |= (phyaddr << priv->hw->mii.addr_shift)
427 & priv->hw->mii.addr_mask;
428 value |= (phyreg << priv->hw->mii.reg_shift) & priv->hw->mii.reg_mask;
430 value |= (priv->clk_csr << priv->hw->mii.clk_csr_shift)
431 & priv->hw->mii.clk_csr_mask;
433 value |= MII_GMAC4_WRITE;
434 value |= MII_GMAC4_C45E;
435 value &= ~priv->hw->mii.reg_mask;
436 value |= (devad << priv->hw->mii.reg_shift) & priv->hw->mii.reg_mask;
438 data |= phyreg << MII_GMAC4_REG_ADDR_SHIFT;
440 ret = stmmac_mdio_write(priv, data, value);
442 pm_runtime_put(priv->device);
449 * @bus: points to the mii_bus structure
450 * Description: reset the MII bus
452 int stmmac_mdio_reset(struct mii_bus *bus)
454 #if IS_ENABLED(CONFIG_STMMAC_PLATFORM)
455 struct net_device *ndev = bus->priv;
456 struct stmmac_priv *priv = netdev_priv(ndev);
457 unsigned int mii_address = priv->hw->mii.addr;
460 if (priv->device->of_node) {
461 struct gpio_desc *reset_gpio;
462 u32 delays[3] = { 0, 0, 0 };
464 reset_gpio = devm_gpiod_get_optional(priv->device,
467 if (IS_ERR(reset_gpio))
468 return PTR_ERR(reset_gpio);
470 device_property_read_u32_array(priv->device,
471 "snps,reset-delays-us",
472 delays, ARRAY_SIZE(delays));
475 msleep(DIV_ROUND_UP(delays[0], 1000));
477 gpiod_set_value_cansleep(reset_gpio, 1);
479 msleep(DIV_ROUND_UP(delays[1], 1000));
481 gpiod_set_value_cansleep(reset_gpio, 0);
483 msleep(DIV_ROUND_UP(delays[2], 1000));
487 /* This is a workaround for problems with the STE101P PHY.
488 * It doesn't complete its reset until at least one clock cycle
489 * on MDC, so perform a dummy mdio read. To be updated for GMAC4
492 if (!priv->plat->has_gmac4)
493 writel(0, priv->ioaddr + mii_address);
498 int stmmac_pcs_setup(struct net_device *ndev)
500 struct dw_xpcs *xpcs = NULL;
501 struct stmmac_priv *priv;
505 priv = netdev_priv(ndev);
506 mode = priv->plat->phy_interface;
508 if (priv->plat->pcs_init) {
509 ret = priv->plat->pcs_init(priv);
510 } else if (priv->plat->mdio_bus_data &&
511 priv->plat->mdio_bus_data->has_xpcs) {
512 /* Try to probe the XPCS by scanning all addresses */
513 for (addr = 0; addr < PHY_MAX_ADDR; addr++) {
514 xpcs = xpcs_create_mdiodev(priv->mii, addr, mode);
526 dev_warn(priv->device, "No xPCS found\n");
530 priv->hw->xpcs = xpcs;
535 void stmmac_pcs_clean(struct net_device *ndev)
537 struct stmmac_priv *priv = netdev_priv(ndev);
539 if (priv->plat->pcs_exit)
540 priv->plat->pcs_exit(priv);
545 xpcs_destroy(priv->hw->xpcs);
546 priv->hw->xpcs = NULL;
550 * stmmac_mdio_register
551 * @ndev: net device structure
552 * Description: it registers the MII bus
554 int stmmac_mdio_register(struct net_device *ndev)
557 struct mii_bus *new_bus;
558 struct stmmac_priv *priv = netdev_priv(ndev);
559 struct stmmac_mdio_bus_data *mdio_bus_data = priv->plat->mdio_bus_data;
560 struct device_node *mdio_node = priv->plat->mdio_node;
561 struct device *dev = ndev->dev.parent;
562 struct fwnode_handle *fixed_node;
563 struct fwnode_handle *fwnode;
564 int addr, found, max_addr;
569 new_bus = mdiobus_alloc();
573 if (mdio_bus_data->irqs)
574 memcpy(new_bus->irq, mdio_bus_data->irqs, sizeof(new_bus->irq));
576 new_bus->name = "stmmac";
578 if (priv->plat->has_xgmac) {
579 new_bus->read = &stmmac_xgmac2_mdio_read_c22;
580 new_bus->write = &stmmac_xgmac2_mdio_write_c22;
581 new_bus->read_c45 = &stmmac_xgmac2_mdio_read_c45;
582 new_bus->write_c45 = &stmmac_xgmac2_mdio_write_c45;
584 if (priv->synopsys_id < DWXGMAC_CORE_2_20) {
585 /* Right now only C22 phys are supported */
586 max_addr = MII_XGMAC_MAX_C22ADDR + 1;
588 /* Check if DT specified an unsupported phy addr */
589 if (priv->plat->phy_addr > MII_XGMAC_MAX_C22ADDR)
590 dev_err(dev, "Unsupported phy_addr (max=%d)\n",
591 MII_XGMAC_MAX_C22ADDR);
593 /* XGMAC version 2.20 onwards support 32 phy addr */
594 max_addr = PHY_MAX_ADDR;
597 new_bus->read = &stmmac_mdio_read_c22;
598 new_bus->write = &stmmac_mdio_write_c22;
599 if (priv->plat->has_gmac4) {
600 new_bus->read_c45 = &stmmac_mdio_read_c45;
601 new_bus->write_c45 = &stmmac_mdio_write_c45;
604 max_addr = PHY_MAX_ADDR;
607 if (mdio_bus_data->needs_reset)
608 new_bus->reset = &stmmac_mdio_reset;
610 snprintf(new_bus->id, MII_BUS_ID_SIZE, "%s-%x",
611 new_bus->name, priv->plat->bus_id);
612 new_bus->priv = ndev;
613 new_bus->phy_mask = mdio_bus_data->phy_mask;
614 new_bus->parent = priv->device;
616 err = of_mdiobus_register(new_bus, mdio_node);
617 if (err == -ENODEV) {
619 dev_info(dev, "MDIO bus is disabled\n");
620 goto bus_register_fail;
622 dev_err_probe(dev, err, "Cannot register the MDIO bus\n");
623 goto bus_register_fail;
626 /* Looks like we need a dummy read for XGMAC only and C45 PHYs */
627 if (priv->plat->has_xgmac)
628 stmmac_xgmac2_mdio_read_c45(new_bus, 0, 0, 0);
630 /* If fixed-link is set, skip PHY scanning */
631 fwnode = priv->plat->port_node;
633 fwnode = dev_fwnode(priv->device);
636 fixed_node = fwnode_get_named_child_node(fwnode, "fixed-link");
638 fwnode_handle_put(fixed_node);
639 goto bus_register_done;
643 if (priv->plat->phy_node || mdio_node)
644 goto bus_register_done;
647 for (addr = 0; addr < max_addr; addr++) {
648 struct phy_device *phydev = mdiobus_get_phy(new_bus, addr);
654 * If an IRQ was provided to be assigned after
655 * the bus probe, do it here.
657 if (!mdio_bus_data->irqs &&
658 (mdio_bus_data->probed_phy_irq > 0)) {
659 new_bus->irq[addr] = mdio_bus_data->probed_phy_irq;
660 phydev->irq = mdio_bus_data->probed_phy_irq;
664 * If we're going to bind the MAC to this PHY bus,
665 * and no PHY number was provided to the MAC,
666 * use the one probed here.
668 if (priv->plat->phy_addr == -1)
669 priv->plat->phy_addr = addr;
671 phy_attached_info(phydev);
675 if (!found && !mdio_node) {
676 dev_warn(dev, "No PHY found\n");
687 mdiobus_unregister(new_bus);
689 mdiobus_free(new_bus);
694 * stmmac_mdio_unregister
695 * @ndev: net device structure
696 * Description: it unregisters the MII bus
698 int stmmac_mdio_unregister(struct net_device *ndev)
700 struct stmmac_priv *priv = netdev_priv(ndev);
705 mdiobus_unregister(priv->mii);
706 priv->mii->priv = NULL;
707 mdiobus_free(priv->mii);