1 // SPDX-License-Identifier: GPL-2.0+
3 * Faraday FTGMAC100 Ethernet
5 * (C) Copyright 2009 Faraday Technology
8 * (C) Copyright 2010 Andes Technology
11 * Copyright (C) 2018, IBM Corporation.
23 #include <asm/cache.h>
24 #include <dm/device_compat.h>
25 #include <linux/bitops.h>
27 #include <linux/iopoll.h>
28 #include <linux/printk.h>
29 #include <linux/bitfield.h>
31 #include "ftgmac100.h"
33 /* Min frame ethernet frame size without FCS */
36 /* Receive Buffer Size Register - HW default is 0x640 */
37 #define FTGMAC100_RBSR_DEFAULT 0x640
39 /* PKTBUFSTX/PKTBUFSRX must both be power of 2 */
40 #define PKTBUFSTX 4 /* must be power of 2 */
42 /* Timeout for transmit */
43 #define FTGMAC100_TX_TIMEOUT_MS 1000
45 /* Timeout for a mdio read/write operation */
46 #define FTGMAC100_MDIO_TIMEOUT_USEC 10000
49 * MDC clock cycle threshold
51 * 20us * 100 = 2ms > (1 / 2.5Mhz) * 0x34
53 #define MDC_CYCTHR 0x34
56 * ftgmac100 model variants
58 enum ftgmac100_model {
59 FTGMAC100_MODEL_FARADAY,
60 FTGMAC100_MODEL_ASPEED,
61 FTGMAC100_MODEL_ASPEED_AST2700,
64 union ftgmac100_dma_addr {
73 * struct ftgmac100_data - private data for the FTGMAC100 driver
75 * @iobase: The base address of the hardware registers
76 * @txdes: The array of transmit descriptors
77 * @rxdes: The array of receive descriptors
78 * @tx_index: Transmit descriptor index in @txdes
79 * @rx_index: Receive descriptor index in @rxdes
80 * @phy_addr: The PHY interface address to use
81 * @phydev: The PHY device backing the MAC
83 * @phy_mode: The mode of the PHY interface (rgmii, rmii, ...)
84 * @max_speed: Maximum speed of Ethernet connection supported by MAC
85 * @clks: The bulk of clocks assigned to the device in the DT
86 * @rxdes0_edorr_mask: The bit number identifying the end of the RX ring buffer
87 * @txdes0_edotr_mask: The bit number identifying the end of the TX ring buffer
89 struct ftgmac100_data {
90 struct ftgmac100 *iobase;
92 struct ftgmac100_txdes txdes[PKTBUFSTX] __aligned(ARCH_DMA_MINALIGN);
93 struct ftgmac100_rxdes rxdes[PKTBUFSRX] __aligned(ARCH_DMA_MINALIGN);
98 struct phy_device *phydev;
103 struct clk_bulk clks;
104 struct reset_ctl *reset_ctl;
106 /* End of RX/TX ring buffer bits. Depend on model */
107 u32 rxdes0_edorr_mask;
108 u32 txdes0_edotr_mask;
114 * struct mii_bus functions
116 static int ftgmac100_mdio_read(struct mii_dev *bus, int phy_addr, int dev_addr,
119 struct ftgmac100_data *priv = bus->priv;
120 struct ftgmac100 *ftgmac100 = priv->iobase;
125 phycr = FTGMAC100_PHYCR_MDC_CYCTHR(MDC_CYCTHR) |
126 FTGMAC100_PHYCR_PHYAD(phy_addr) |
127 FTGMAC100_PHYCR_REGAD(reg_addr) |
128 FTGMAC100_PHYCR_MIIRD;
129 writel(phycr, &ftgmac100->phycr);
131 ret = readl_poll_timeout(&ftgmac100->phycr, phycr,
132 !(phycr & FTGMAC100_PHYCR_MIIRD),
133 FTGMAC100_MDIO_TIMEOUT_USEC);
135 pr_err("%s: mdio read failed (phy:%d reg:%x)\n",
136 bus->name, phy_addr, reg_addr);
140 data = readl(&ftgmac100->phydata);
142 return FTGMAC100_PHYDATA_MIIRDATA(data);
145 static int ftgmac100_mdio_write(struct mii_dev *bus, int phy_addr, int dev_addr,
146 int reg_addr, u16 value)
148 struct ftgmac100_data *priv = bus->priv;
149 struct ftgmac100 *ftgmac100 = priv->iobase;
154 phycr = FTGMAC100_PHYCR_MDC_CYCTHR(MDC_CYCTHR) |
155 FTGMAC100_PHYCR_PHYAD(phy_addr) |
156 FTGMAC100_PHYCR_REGAD(reg_addr) |
157 FTGMAC100_PHYCR_MIIWR;
158 data = FTGMAC100_PHYDATA_MIIWDATA(value);
160 writel(data, &ftgmac100->phydata);
161 writel(phycr, &ftgmac100->phycr);
163 ret = readl_poll_timeout(&ftgmac100->phycr, phycr,
164 !(phycr & FTGMAC100_PHYCR_MIIWR),
165 FTGMAC100_MDIO_TIMEOUT_USEC);
167 pr_err("%s: mdio write failed (phy:%d reg:%x)\n",
168 bus->name, phy_addr, reg_addr);
174 static int ftgmac100_mdio_init(struct udevice *dev)
176 struct ftgmac100_data *priv = dev_get_priv(dev);
184 bus->read = ftgmac100_mdio_read;
185 bus->write = ftgmac100_mdio_write;
188 ret = mdio_register_seq(bus, dev_seq(dev));
199 static int ftgmac100_phy_adjust_link(struct ftgmac100_data *priv)
201 struct ftgmac100 *ftgmac100 = priv->iobase;
202 struct phy_device *phydev = priv->phydev;
205 if (!phydev->link && priv->phy_mode != PHY_INTERFACE_MODE_NCSI) {
206 dev_err(phydev->dev, "No link\n");
210 /* read MAC control register and clear related bits */
211 maccr = readl(&ftgmac100->maccr) &
212 ~(FTGMAC100_MACCR_GIGA_MODE |
213 FTGMAC100_MACCR_FAST_MODE |
214 FTGMAC100_MACCR_FULLDUP);
216 if (phy_interface_is_rgmii(phydev) && phydev->speed == 1000)
217 maccr |= FTGMAC100_MACCR_GIGA_MODE;
219 if (phydev->speed == 100)
220 maccr |= FTGMAC100_MACCR_FAST_MODE;
223 maccr |= FTGMAC100_MACCR_FULLDUP;
225 /* update MII config into maccr */
226 writel(maccr, &ftgmac100->maccr);
231 static int ftgmac100_phy_init(struct udevice *dev)
233 struct ftgmac100_data *priv = dev_get_priv(dev);
234 struct phy_device *phydev;
237 if (IS_ENABLED(CONFIG_DM_MDIO) && priv->phy_mode != PHY_INTERFACE_MODE_NCSI)
238 phydev = dm_eth_phy_connect(dev);
240 phydev = phy_connect(priv->bus, priv->phy_addr, dev, priv->phy_mode);
245 if (priv->phy_mode != PHY_INTERFACE_MODE_NCSI)
246 phydev->supported &= PHY_GBIT_FEATURES;
247 if (priv->max_speed) {
248 ret = phy_set_supported(phydev, priv->max_speed);
252 phydev->advertising = phydev->supported;
253 priv->phydev = phydev;
262 static void ftgmac100_reset(struct ftgmac100_data *priv)
264 struct ftgmac100 *ftgmac100 = priv->iobase;
266 debug("%s()\n", __func__);
268 setbits_le32(&ftgmac100->maccr, FTGMAC100_MACCR_SW_RST);
270 while (readl(&ftgmac100->maccr) & FTGMAC100_MACCR_SW_RST)
277 static int ftgmac100_set_mac(struct ftgmac100_data *priv,
278 const unsigned char *mac)
280 struct ftgmac100 *ftgmac100 = priv->iobase;
281 unsigned int maddr = mac[0] << 8 | mac[1];
282 unsigned int laddr = mac[2] << 24 | mac[3] << 16 | mac[4] << 8 | mac[5];
284 debug("%s(%x %x)\n", __func__, maddr, laddr);
286 writel(maddr, &ftgmac100->mac_madr);
287 writel(laddr, &ftgmac100->mac_ladr);
295 static int ftgmac100_get_mac(struct ftgmac100_data *priv,
298 struct ftgmac100 *ftgmac100 = priv->iobase;
299 unsigned int maddr = readl(&ftgmac100->mac_madr);
300 unsigned int laddr = readl(&ftgmac100->mac_ladr);
302 debug("%s(%x %x)\n", __func__, maddr, laddr);
304 mac[0] = (maddr >> 8) & 0xff;
305 mac[1] = maddr & 0xff;
306 mac[2] = (laddr >> 24) & 0xff;
307 mac[3] = (laddr >> 16) & 0xff;
308 mac[4] = (laddr >> 8) & 0xff;
309 mac[5] = laddr & 0xff;
315 * disable transmitter, receiver
317 static void ftgmac100_stop(struct udevice *dev)
319 struct ftgmac100_data *priv = dev_get_priv(dev);
320 struct ftgmac100 *ftgmac100 = priv->iobase;
322 debug("%s()\n", __func__);
324 writel(0, &ftgmac100->maccr);
326 if (priv->phy_mode != PHY_INTERFACE_MODE_NCSI)
327 phy_shutdown(priv->phydev);
330 static int ftgmac100_start(struct udevice *dev)
332 struct eth_pdata *plat = dev_get_plat(dev);
333 struct ftgmac100_data *priv = dev_get_priv(dev);
334 struct ftgmac100 *ftgmac100 = priv->iobase;
335 union ftgmac100_dma_addr dma_addr = {.hi = 0, .lo = 0};
336 struct phy_device *phydev = priv->phydev;
337 unsigned int maccr, dblac, desc_size;
342 debug("%s()\n", __func__);
344 ftgmac100_reset(priv);
346 /* set the ethernet address */
347 ftgmac100_set_mac(priv, plat->enetaddr);
349 /* disable all interrupts */
350 writel(0, &ftgmac100->ier);
352 /* initialize descriptors */
356 for (i = 0; i < PKTBUFSTX; i++) {
357 priv->txdes[i].txdes2 = 0;
358 priv->txdes[i].txdes3 = 0;
359 priv->txdes[i].txdes0 = 0;
361 priv->txdes[PKTBUFSTX - 1].txdes0 = priv->txdes0_edotr_mask;
363 start = ((ulong)&priv->txdes[0]) & ~(ARCH_DMA_MINALIGN - 1);
364 end = start + roundup(sizeof(priv->txdes), ARCH_DMA_MINALIGN);
365 flush_dcache_range(start, end);
367 for (i = 0; i < PKTBUFSRX; i++) {
368 unsigned int ip_align = 0;
370 dma_addr.addr = (dma_addr_t)net_rx_packets[i];
371 priv->rxdes[i].rxdes2 = FIELD_PREP(FTGMAC100_RXDES2_RXBUF_BADR_HI, dma_addr.hi);
372 /* For IP alignment */
373 if ((dma_addr.lo & (PKTALIGN - 1)) == 0)
375 priv->rxdes[i].rxdes3 = dma_addr.lo + ip_align;
376 priv->rxdes[i].rxdes0 = 0;
378 priv->rxdes[PKTBUFSRX - 1].rxdes0 = priv->rxdes0_edorr_mask;
380 start = ((ulong)&priv->rxdes[0]) & ~(ARCH_DMA_MINALIGN - 1);
381 end = start + roundup(sizeof(priv->rxdes), ARCH_DMA_MINALIGN);
382 flush_dcache_range(start, end);
385 dma_addr.addr = (dma_addr_t)priv->txdes;
386 writel(dma_addr.lo, &ftgmac100->txr_badr);
387 writel(dma_addr.hi, &ftgmac100->txr_badr_hi);
390 dma_addr.addr = (dma_addr_t)priv->rxdes;
391 writel(dma_addr.lo, &ftgmac100->rxr_badr);
392 writel(dma_addr.hi, &ftgmac100->rxr_badr_hi);
394 /* Configure TX/RX decsriptor size
395 * This size is calculated based on cache line.
397 desc_size = ARCH_DMA_MINALIGN / FTGMAC100_DESC_UNIT;
398 /* The descriptor size is at least 2 descriptor units. */
401 dblac = readl(&ftgmac100->dblac) & ~GENMASK(19, 12);
402 dblac |= FTGMAC100_DBLAC_RXDES_SIZE(desc_size) | FTGMAC100_DBLAC_TXDES_SIZE(desc_size);
403 writel(dblac, &ftgmac100->dblac);
405 /* poll receive descriptor automatically */
406 writel(FTGMAC100_APTC_RXPOLL_CNT(1), &ftgmac100->aptc);
408 /* config receive buffer size register */
409 writel(FTGMAC100_RBSR_SIZE(FTGMAC100_RBSR_DEFAULT), &ftgmac100->rbsr);
411 /* enable transmitter, receiver */
412 maccr = FTGMAC100_MACCR_TXMAC_EN |
413 FTGMAC100_MACCR_RXMAC_EN |
414 FTGMAC100_MACCR_TXDMA_EN |
415 FTGMAC100_MACCR_RXDMA_EN |
416 FTGMAC100_MACCR_CRC_APD |
417 FTGMAC100_MACCR_FULLDUP |
418 FTGMAC100_MACCR_RX_RUNT |
419 FTGMAC100_MACCR_RX_BROADPKT;
421 if (priv->is_ast2700 && (priv->phydev->interface == PHY_INTERFACE_MODE_RMII ||
422 priv->phydev->interface == PHY_INTERFACE_MODE_NCSI))
423 maccr |= FTGMAC100_MACCR_RMII_ENABLE;
425 writel(maccr, &ftgmac100->maccr);
427 ret = phy_startup(phydev);
429 dev_err(phydev->dev, "Could not start PHY\n");
433 ret = ftgmac100_phy_adjust_link(priv);
435 dev_err(phydev->dev, "Could not adjust link\n");
439 printf("%s: link up, %d Mbps %s-duplex mac:%pM\n", phydev->dev->name,
440 phydev->speed, phydev->duplex ? "full" : "half", plat->enetaddr);
445 static int ftgmac100_free_pkt(struct udevice *dev, uchar *packet, int length)
447 struct ftgmac100_data *priv = dev_get_priv(dev);
448 struct ftgmac100_rxdes *curr_des = &priv->rxdes[priv->rx_index];
449 ulong des_start = ((ulong)curr_des) & ~(ARCH_DMA_MINALIGN - 1);
450 ulong des_end = des_start +
451 roundup(sizeof(*curr_des), ARCH_DMA_MINALIGN);
454 * Make sure there are no stale data in write-back over this area, which
455 * might get written into the memory while the ftgmac100 also writes
456 * into the same memory area.
458 flush_dcache_range((ulong)net_rx_packets[priv->rx_index],
459 (ulong)net_rx_packets[priv->rx_index] + PKTSIZE_ALIGN);
461 /* Release buffer to DMA and flush descriptor */
462 curr_des->rxdes0 &= ~FTGMAC100_RXDES0_RXPKT_RDY;
463 flush_dcache_range(des_start, des_end);
465 /* Move to next descriptor */
466 priv->rx_index = (priv->rx_index + 1) % PKTBUFSRX;
472 * Get a data block via Ethernet
474 static int ftgmac100_recv(struct udevice *dev, int flags, uchar **packetp)
476 struct ftgmac100_data *priv = dev_get_priv(dev);
477 struct ftgmac100_rxdes *curr_des = &priv->rxdes[priv->rx_index];
478 unsigned short rxlen;
479 ulong des_start = ((ulong)curr_des) & ~(ARCH_DMA_MINALIGN - 1);
480 ulong des_end = des_start +
481 roundup(sizeof(*curr_des), ARCH_DMA_MINALIGN);
482 union ftgmac100_dma_addr data_start = { .lo = 0, .hi = 0 };
485 data_start.hi = FIELD_GET(FTGMAC100_RXDES2_RXBUF_BADR_HI, curr_des->rxdes2);
486 data_start.lo = curr_des->rxdes3;
487 invalidate_dcache_range(des_start, des_end);
489 if (!(curr_des->rxdes0 & FTGMAC100_RXDES0_RXPKT_RDY))
492 if (curr_des->rxdes0 & (FTGMAC100_RXDES0_RX_ERR |
493 FTGMAC100_RXDES0_CRC_ERR |
494 FTGMAC100_RXDES0_FTL |
495 FTGMAC100_RXDES0_RUNT |
496 FTGMAC100_RXDES0_RX_ODD_NB)) {
500 rxlen = FTGMAC100_RXDES0_VDBC(curr_des->rxdes0);
502 debug("%s(): RX buffer %d, %x received\n",
503 __func__, priv->rx_index, rxlen);
505 /* Invalidate received data */
506 data_end = data_start.addr + roundup(rxlen, ARCH_DMA_MINALIGN);
507 invalidate_dcache_range(data_start.addr, data_end);
508 *packetp = (uchar *)data_start.addr;
513 static u32 ftgmac100_read_txdesc(const void *desc)
515 const struct ftgmac100_txdes *txdes = desc;
516 ulong des_start = ((ulong)txdes) & ~(ARCH_DMA_MINALIGN - 1);
517 ulong des_end = des_start + roundup(sizeof(*txdes), ARCH_DMA_MINALIGN);
519 invalidate_dcache_range(des_start, des_end);
521 return txdes->txdes0;
524 BUILD_WAIT_FOR_BIT(ftgmac100_txdone, u32, ftgmac100_read_txdesc)
527 * Send a data block via Ethernet
529 static int ftgmac100_send(struct udevice *dev, void *packet, int length)
531 struct ftgmac100_data *priv = dev_get_priv(dev);
532 struct ftgmac100 *ftgmac100 = priv->iobase;
533 struct ftgmac100_txdes *curr_des = &priv->txdes[priv->tx_index];
534 union ftgmac100_dma_addr dma_addr;
535 ulong des_start = ((ulong)curr_des) & ~(ARCH_DMA_MINALIGN - 1);
536 ulong des_end = des_start +
537 roundup(sizeof(*curr_des), ARCH_DMA_MINALIGN);
542 invalidate_dcache_range(des_start, des_end);
544 if (curr_des->txdes0 & FTGMAC100_TXDES0_TXDMA_OWN) {
545 dev_err(dev, "no TX descriptor available\n");
549 debug("%s(%x, %x)\n", __func__, (int)packet, length);
551 length = (length < ETH_ZLEN) ? ETH_ZLEN : length;
553 dma_addr.addr = (dma_addr_t)packet;
554 curr_des->txdes2 = FIELD_PREP(FTGMAC100_TXDES2_TXBUF_BADR_HI, dma_addr.hi);
555 curr_des->txdes3 = dma_addr.lo;
557 /* Flush data to be sent */
558 data_start = (ulong)dma_addr.addr;
559 data_end = data_start + roundup(length, ARCH_DMA_MINALIGN);
560 flush_dcache_range(data_start, data_end);
562 /* Only one segment on TXBUF */
563 curr_des->txdes0 &= priv->txdes0_edotr_mask;
564 curr_des->txdes0 |= FTGMAC100_TXDES0_FTS |
565 FTGMAC100_TXDES0_LTS |
566 FTGMAC100_TXDES0_TXBUF_SIZE(length) |
567 FTGMAC100_TXDES0_TXDMA_OWN ;
569 /* Flush modified buffer descriptor */
570 flush_dcache_range(des_start, des_end);
573 writel(1, &ftgmac100->txpd);
575 rc = wait_for_bit_ftgmac100_txdone(curr_des,
576 FTGMAC100_TXDES0_TXDMA_OWN, false,
577 FTGMAC100_TX_TIMEOUT_MS, true);
581 debug("%s(): packet sent\n", __func__);
583 /* Move to next descriptor */
584 priv->tx_index = (priv->tx_index + 1) % PKTBUFSTX;
589 static int ftgmac100_write_hwaddr(struct udevice *dev)
591 struct eth_pdata *pdata = dev_get_plat(dev);
592 struct ftgmac100_data *priv = dev_get_priv(dev);
594 return ftgmac100_set_mac(priv, pdata->enetaddr);
597 static int ftgmac_read_hwaddr(struct udevice *dev)
599 struct eth_pdata *pdata = dev_get_plat(dev);
600 struct ftgmac100_data *priv = dev_get_priv(dev);
602 return ftgmac100_get_mac(priv, pdata->enetaddr);
605 static int ftgmac100_of_to_plat(struct udevice *dev)
607 struct eth_pdata *pdata = dev_get_plat(dev);
608 struct ftgmac100_data *priv = dev_get_priv(dev);
610 pdata->iobase = dev_read_addr(dev);
612 pdata->phy_interface = dev_read_phy_mode(dev);
613 if (pdata->phy_interface == PHY_INTERFACE_MODE_NA)
616 pdata->max_speed = dev_read_u32_default(dev, "max-speed", 0);
618 if (dev_get_driver_data(dev) == FTGMAC100_MODEL_ASPEED) {
619 priv->rxdes0_edorr_mask = BIT(30);
620 priv->txdes0_edotr_mask = BIT(30);
621 priv->is_ast2700 = false;
622 } else if (dev_get_driver_data(dev) == FTGMAC100_MODEL_ASPEED_AST2700) {
623 priv->rxdes0_edorr_mask = BIT(30);
624 priv->txdes0_edotr_mask = BIT(30);
625 priv->is_ast2700 = true;
627 priv->rxdes0_edorr_mask = BIT(15);
628 priv->txdes0_edotr_mask = BIT(15);
631 priv->reset_ctl = devm_reset_control_get_optional(dev, NULL);
633 return clk_get_bulk(dev, &priv->clks);
636 static int ftgmac100_probe(struct udevice *dev)
638 struct eth_pdata *pdata = dev_get_plat(dev);
639 struct ftgmac100_data *priv = dev_get_priv(dev);
642 priv->iobase = (struct ftgmac100 *)pdata->iobase;
643 priv->phy_mode = pdata->phy_interface;
644 priv->max_speed = pdata->max_speed;
647 if (dev_read_bool(dev, "use-ncsi"))
648 priv->phy_mode = PHY_INTERFACE_MODE_NCSI;
650 #ifdef CONFIG_PHY_ADDR
651 priv->phy_addr = CONFIG_PHY_ADDR;
654 ret = clk_enable_bulk(&priv->clks);
658 if (priv->reset_ctl) {
659 ret = reset_deassert(priv->reset_ctl);
665 * If DM MDIO is enabled, the MDIO bus will be initialized later in
668 if (priv->phy_mode != PHY_INTERFACE_MODE_NCSI &&
669 !IS_ENABLED(CONFIG_DM_MDIO)) {
670 ret = ftgmac100_mdio_init(dev);
672 dev_err(dev, "Failed to initialize mdiobus: %d\n", ret);
677 ret = ftgmac100_phy_init(dev);
679 dev_err(dev, "Failed to initialize PHY: %d\n", ret);
683 ftgmac_read_hwaddr(dev);
687 clk_release_bulk(&priv->clks);
692 static int ftgmac100_remove(struct udevice *dev)
694 struct ftgmac100_data *priv = dev_get_priv(dev);
697 mdio_unregister(priv->bus);
698 mdio_free(priv->bus);
700 reset_assert(priv->reset_ctl);
701 clk_release_bulk(&priv->clks);
706 static const struct eth_ops ftgmac100_ops = {
707 .start = ftgmac100_start,
708 .send = ftgmac100_send,
709 .recv = ftgmac100_recv,
710 .stop = ftgmac100_stop,
711 .free_pkt = ftgmac100_free_pkt,
712 .write_hwaddr = ftgmac100_write_hwaddr,
715 static const struct udevice_id ftgmac100_ids[] = {
716 { .compatible = "faraday,ftgmac100", .data = FTGMAC100_MODEL_FARADAY },
717 { .compatible = "aspeed,ast2500-mac", .data = FTGMAC100_MODEL_ASPEED },
718 { .compatible = "aspeed,ast2600-mac", .data = FTGMAC100_MODEL_ASPEED },
719 { .compatible = "aspeed,ast2700-mac", .data = FTGMAC100_MODEL_ASPEED_AST2700 },
723 U_BOOT_DRIVER(ftgmac100) = {
726 .of_match = ftgmac100_ids,
727 .of_to_plat = ftgmac100_of_to_plat,
728 .probe = ftgmac100_probe,
729 .remove = ftgmac100_remove,
730 .ops = &ftgmac100_ops,
731 .priv_auto = sizeof(struct ftgmac100_data),
732 .plat_auto = sizeof(struct eth_pdata),
733 .flags = DM_FLAG_ALLOC_PRIV_DMA,