1 // SPDX-License-Identifier: GPL-2.0+
3 * MediaTek ethernet IP driver for U-Boot
5 * Copyright (C) 2018 Stefan Roese <sr@denx.de>
7 * This code is mostly based on the code extracted from this MediaTek
10 * https://github.com/MediaTek-Labs/linkit-smart-uboot.git
12 * I was not able to find a specific license or other developers
13 * copyrights here, so I can't add them here.
24 #include <linux/bitfield.h>
25 #include <linux/err.h>
27 /* Ethernet frame engine register */
28 #define PDMA_RELATED 0x0800
30 #define TX_BASE_PTR0 (PDMA_RELATED + 0x000)
31 #define TX_MAX_CNT0 (PDMA_RELATED + 0x004)
32 #define TX_CTX_IDX0 (PDMA_RELATED + 0x008)
33 #define TX_DTX_IDX0 (PDMA_RELATED + 0x00c)
35 #define RX_BASE_PTR0 (PDMA_RELATED + 0x100)
36 #define RX_MAX_CNT0 (PDMA_RELATED + 0x104)
37 #define RX_CALC_IDX0 (PDMA_RELATED + 0x108)
39 #define PDMA_GLO_CFG (PDMA_RELATED + 0x204)
40 #define PDMA_RST_IDX (PDMA_RELATED + 0x208)
41 #define DLY_INT_CFG (PDMA_RELATED + 0x20c)
43 #define SDM_RELATED 0x0c00
45 #define SDM_MAC_ADRL (SDM_RELATED + 0x0c) /* MAC address LSB */
46 #define SDM_MAC_ADRH (SDM_RELATED + 0x10) /* MAC Address MSB */
48 #define RST_DTX_IDX0 BIT(0)
49 #define RST_DRX_IDX0 BIT(16)
51 #define TX_DMA_EN BIT(0)
52 #define TX_DMA_BUSY BIT(1)
53 #define RX_DMA_EN BIT(2)
54 #define RX_DMA_BUSY BIT(3)
55 #define TX_WB_DDONE BIT(6)
57 /* Ethernet switch register */
58 #define MT7628_SWITCH_FCT0 0x0008
59 #define MT7628_SWITCH_PFC1 0x0014
60 #define MT7628_SWITCH_FPA 0x0084
61 #define MT7628_SWITCH_SOCPC 0x008c
62 #define MT7628_SWITCH_POC0 0x0090
63 #define MT7628_SWITCH_POC2 0x0098
64 #define MT7628_SWITCH_SGC 0x009c
65 #define MT7628_SWITCH_PCR0 0x00c0
66 #define PCR0_PHY_ADDR GENMASK(4, 0)
67 #define PCR0_PHY_REG GENMASK(12, 8)
68 #define PCR0_WT_PHY_CMD BIT(13)
69 #define PCR0_RD_PHY_CMD BIT(14)
70 #define PCR0_WT_DATA GENMASK(31, 16)
72 #define MT7628_SWITCH_PCR1 0x00c4
73 #define PCR1_WT_DONE BIT(0)
74 #define PCR1_RD_RDY BIT(1)
75 #define PCR1_RD_DATA GENMASK(31, 16)
77 #define MT7628_SWITCH_FPA1 0x00c8
78 #define MT7628_SWITCH_FCT2 0x00cc
79 #define MT7628_SWITCH_SGC2 0x00e4
80 #define MT7628_SWITCH_BMU_CTRL 0x0110
83 #define RX_DMA_DONE BIT(31)
84 #define RX_DMA_LSO BIT(30)
85 #define RX_DMA_PLEN0 GENMASK(29, 16)
86 #define RX_DMA_TAG BIT(15)
93 } __packed __aligned(4);
95 #define TX_DMA_PLEN0 GENMASK(29, 16)
96 #define TX_DMA_LS1 BIT(14)
97 #define TX_DMA_LS0 BIT(30)
98 #define TX_DMA_DONE BIT(31)
100 #define TX_DMA_INS_VLAN_MT7621 BIT(16)
101 #define TX_DMA_INS_VLAN BIT(7)
102 #define TX_DMA_INS_PPPOE BIT(12)
103 #define TX_DMA_PN GENMASK(26, 24)
110 } __packed __aligned(4);
112 #define NUM_RX_DESC 256
113 #define NUM_TX_DESC 4
115 #define PADDING_LENGTH 60
117 #define MTK_QDMA_PAGE_SIZE 2048
119 #define CONFIG_MDIO_TIMEOUT 100
120 #define CONFIG_DMA_STOP_TIMEOUT 100
121 #define CONFIG_TX_DMA_TIMEOUT 100
123 #define LINK_DELAY_TIME 500 /* 500 ms */
124 #define LINK_TIMEOUT 10000 /* 10 seconds */
126 struct mt7628_eth_dev {
127 void __iomem *base; /* frame engine base address */
128 void __iomem *eth_sw_base; /* switch base address */
132 struct fe_tx_dma *tx_ring;
133 struct fe_rx_dma *rx_ring;
135 u8 *rx_buf[NUM_RX_DESC];
137 /* Point to the next RXD DMA wants to use in RXD Ring0 */
139 /* Point to the next TXD in TXD Ring0 CPU wants to use */
142 struct reset_ctl rst_ephy;
145 static int mdio_wait_read(struct mt7628_eth_dev *priv, u32 mask, bool mask_set)
147 void __iomem *base = priv->eth_sw_base;
150 ret = wait_for_bit_le32(base + MT7628_SWITCH_PCR1, mask, mask_set,
151 CONFIG_MDIO_TIMEOUT, false);
153 printf("MDIO operation timeout!\n");
160 static int mii_mgr_read(struct mt7628_eth_dev *priv,
161 u32 phy_addr, u32 phy_register, u32 *read_data)
163 void __iomem *base = priv->eth_sw_base;
168 /* Make sure previous read operation is complete */
169 ret = mdio_wait_read(priv, PCR1_RD_RDY, false);
173 writel(PCR0_RD_PHY_CMD |
174 FIELD_PREP(PCR0_PHY_REG, phy_register) |
175 FIELD_PREP(PCR0_PHY_ADDR, phy_addr),
176 base + MT7628_SWITCH_PCR0);
178 /* Make sure previous read operation is complete */
179 ret = mdio_wait_read(priv, PCR1_RD_RDY, true);
183 status = readl(base + MT7628_SWITCH_PCR1);
184 *read_data = FIELD_GET(PCR1_RD_DATA, status);
189 static int mii_mgr_write(struct mt7628_eth_dev *priv,
190 u32 phy_addr, u32 phy_register, u32 write_data)
192 void __iomem *base = priv->eth_sw_base;
196 /* Make sure previous write operation is complete */
197 ret = mdio_wait_read(priv, PCR1_WT_DONE, false);
201 data = FIELD_PREP(PCR0_WT_DATA, write_data) |
202 FIELD_PREP(PCR0_PHY_REG, phy_register) |
203 FIELD_PREP(PCR0_PHY_ADDR, phy_addr) |
205 writel(data, base + MT7628_SWITCH_PCR0);
207 return mdio_wait_read(priv, PCR1_WT_DONE, true);
210 static int mt7628_mdio_read(struct mii_dev *bus, int addr, int devad, int reg)
215 ret = mii_mgr_read(bus->priv, addr, reg, &val);
222 static int mt7628_mdio_write(struct mii_dev *bus, int addr, int devad, int reg,
225 return mii_mgr_write(bus->priv, addr, reg, value);
228 static void mt7628_ephy_init(struct mt7628_eth_dev *priv)
232 mii_mgr_write(priv, 0, 31, 0x2000); /* change G2 page */
233 mii_mgr_write(priv, 0, 26, 0x0000);
235 for (i = 0; i < 5; i++) {
236 mii_mgr_write(priv, i, 31, 0x8000); /* change L0 page */
237 mii_mgr_write(priv, i, 0, 0x3100);
240 mii_mgr_write(priv, i, 30, 0xa000);
241 mii_mgr_write(priv, i, 31, 0xa000); /* change L2 page */
242 mii_mgr_write(priv, i, 16, 0x0606);
243 mii_mgr_write(priv, i, 23, 0x0f0e);
244 mii_mgr_write(priv, i, 24, 0x1610);
245 mii_mgr_write(priv, i, 30, 0x1f15);
246 mii_mgr_write(priv, i, 28, 0x6111);
249 /* 100Base AOI setting */
250 mii_mgr_write(priv, 0, 31, 0x5000); /* change G5 page */
251 mii_mgr_write(priv, 0, 19, 0x004a);
252 mii_mgr_write(priv, 0, 20, 0x015a);
253 mii_mgr_write(priv, 0, 21, 0x00ee);
254 mii_mgr_write(priv, 0, 22, 0x0033);
255 mii_mgr_write(priv, 0, 23, 0x020a);
256 mii_mgr_write(priv, 0, 24, 0x0000);
257 mii_mgr_write(priv, 0, 25, 0x024a);
258 mii_mgr_write(priv, 0, 26, 0x035a);
259 mii_mgr_write(priv, 0, 27, 0x02ee);
260 mii_mgr_write(priv, 0, 28, 0x0233);
261 mii_mgr_write(priv, 0, 29, 0x000a);
262 mii_mgr_write(priv, 0, 30, 0x0000);
264 /* Fix EPHY idle state abnormal behavior */
265 mii_mgr_write(priv, 0, 31, 0x4000); /* change G4 page */
266 mii_mgr_write(priv, 0, 29, 0x000d);
267 mii_mgr_write(priv, 0, 30, 0x0500);
270 static void rt305x_esw_init(struct mt7628_eth_dev *priv)
272 void __iomem *base = priv->eth_sw_base;
275 * FC_RLS_TH=200, FC_SET_TH=160
276 * DROP_RLS=120, DROP_SET_TH=80
278 writel(0xc8a07850, base + MT7628_SWITCH_FCT0);
279 writel(0x00000000, base + MT7628_SWITCH_SGC2);
280 writel(0x00405555, base + MT7628_SWITCH_PFC1);
281 writel(0x00007f7f, base + MT7628_SWITCH_POC0);
282 writel(0x00007f7f, base + MT7628_SWITCH_POC2); /* disable VLAN */
283 writel(0x0002500c, base + MT7628_SWITCH_FCT2);
284 /* hashing algorithm=XOR48, aging interval=300sec */
285 writel(0x0008a301, base + MT7628_SWITCH_SGC);
286 writel(0x02404040, base + MT7628_SWITCH_SOCPC);
288 /* Ext PHY Addr=0x1f */
289 writel(0x3f502b28, base + MT7628_SWITCH_FPA1);
290 writel(0x00000000, base + MT7628_SWITCH_FPA);
291 /* 1us cycle number=125 (FE's clock=125Mhz) */
292 writel(0x7d000000, base + MT7628_SWITCH_BMU_CTRL);
295 reset_assert(&priv->rst_ephy);
296 reset_deassert(&priv->rst_ephy);
299 mt7628_ephy_init(priv);
302 static void eth_dma_start(struct mt7628_eth_dev *priv)
304 void __iomem *base = priv->base;
306 setbits_le32(base + PDMA_GLO_CFG, TX_WB_DDONE | RX_DMA_EN | TX_DMA_EN);
309 static void eth_dma_stop(struct mt7628_eth_dev *priv)
311 void __iomem *base = priv->base;
314 clrbits_le32(base + PDMA_GLO_CFG, TX_WB_DDONE | RX_DMA_EN | TX_DMA_EN);
316 /* Wait for DMA to stop */
317 ret = wait_for_bit_le32(base + PDMA_GLO_CFG,
318 RX_DMA_BUSY | TX_DMA_BUSY, false,
319 CONFIG_DMA_STOP_TIMEOUT, false);
321 printf("DMA stop timeout error!\n");
324 static int mt7628_eth_write_hwaddr(struct udevice *dev)
326 struct mt7628_eth_dev *priv = dev_get_priv(dev);
327 void __iomem *base = priv->base;
328 u8 *addr = ((struct eth_pdata *)dev_get_platdata(dev))->enetaddr;
331 /* Set MAC address. */
333 val = (val << 8) | addr[1];
334 writel(val, base + SDM_MAC_ADRH);
337 val = (val << 8) | addr[3];
338 val = (val << 8) | addr[4];
339 val = (val << 8) | addr[5];
340 writel(val, base + SDM_MAC_ADRL);
345 static int mt7628_eth_send(struct udevice *dev, void *packet, int length)
347 struct mt7628_eth_dev *priv = dev_get_priv(dev);
348 void __iomem *base = priv->base;
353 idx = priv->tx_dma_idx;
355 /* Pad message to a minimum length */
356 if (length < PADDING_LENGTH) {
357 char *p = (char *)packet;
359 for (i = 0; i < PADDING_LENGTH - length; i++)
361 length = PADDING_LENGTH;
364 /* Check if buffer is ready for next TX DMA */
365 ret = wait_for_bit_le32(&priv->tx_ring[idx].txd2, TX_DMA_DONE, true,
366 CONFIG_TX_DMA_TIMEOUT, false);
368 printf("TX: DMA still busy on buffer %d\n", idx);
372 flush_dcache_range((u32)packet, (u32)packet + length);
374 priv->tx_ring[idx].txd1 = CPHYSADDR(packet);
375 priv->tx_ring[idx].txd2 &= ~TX_DMA_PLEN0;
376 priv->tx_ring[idx].txd2 |= FIELD_PREP(TX_DMA_PLEN0, length);
377 priv->tx_ring[idx].txd2 &= ~TX_DMA_DONE;
379 idx = (idx + 1) % NUM_TX_DESC;
381 /* Make sure the writes executed at this place */
383 writel(idx, base + TX_CTX_IDX0);
385 priv->tx_dma_idx = idx;
390 static int mt7628_eth_recv(struct udevice *dev, int flags, uchar **packetp)
392 struct mt7628_eth_dev *priv = dev_get_priv(dev);
397 idx = priv->rx_dma_idx;
399 rxd_info = priv->rx_ring[idx].rxd2;
400 if ((rxd_info & RX_DMA_DONE) == 0)
403 length = FIELD_GET(RX_DMA_PLEN0, priv->rx_ring[idx].rxd2);
404 if (length == 0 || length > MTK_QDMA_PAGE_SIZE) {
405 printf("%s: invalid length (%d bytes)\n", __func__, length);
409 *packetp = priv->rx_buf[idx];
410 invalidate_dcache_range((u32)*packetp, (u32)*packetp + length);
412 priv->rx_ring[idx].rxd4 = 0;
413 priv->rx_ring[idx].rxd2 = RX_DMA_LSO;
415 /* Make sure the writes executed at this place */
421 static int mt7628_eth_free_pkt(struct udevice *dev, uchar *packet, int length)
423 struct mt7628_eth_dev *priv = dev_get_priv(dev);
424 void __iomem *base = priv->base;
427 idx = priv->rx_dma_idx;
429 /* Move point to next RXD which wants to alloc */
430 writel(idx, base + RX_CALC_IDX0);
432 /* Update to Next packet point that was received */
433 idx = (idx + 1) % NUM_RX_DESC;
435 priv->rx_dma_idx = idx;
440 static int phy_link_up(struct mt7628_eth_dev *priv)
444 mii_mgr_read(priv, 0x00, MII_BMSR, &val);
445 return !!(val & BMSR_LSTATUS);
448 static int mt7628_eth_start(struct udevice *dev)
450 struct mt7628_eth_dev *priv = dev_get_priv(dev);
451 void __iomem *base = priv->base;
452 uchar packet[MTK_QDMA_PAGE_SIZE];
456 for (i = 0; i < NUM_RX_DESC; i++) {
457 memset((void *)&priv->rx_ring[i], 0, sizeof(priv->rx_ring[0]));
458 priv->rx_ring[i].rxd2 |= RX_DMA_LSO;
459 priv->rx_ring[i].rxd1 = CPHYSADDR(priv->rx_buf[i]);
462 for (i = 0; i < NUM_TX_DESC; i++) {
463 memset((void *)&priv->tx_ring[i], 0, sizeof(priv->tx_ring[0]));
464 priv->tx_ring[i].txd2 = TX_DMA_LS0 | TX_DMA_DONE;
465 priv->tx_ring[i].txd4 = FIELD_PREP(TX_DMA_PN, 1);
468 priv->rx_dma_idx = 0;
469 priv->tx_dma_idx = 0;
471 /* Make sure the writes executed at this place */
474 /* disable delay interrupt */
475 writel(0, base + DLY_INT_CFG);
477 clrbits_le32(base + PDMA_GLO_CFG, 0xffff0000);
479 /* Tell the adapter where the TX/RX rings are located. */
480 writel(CPHYSADDR(&priv->rx_ring[0]), base + RX_BASE_PTR0);
481 writel(CPHYSADDR((u32)&priv->tx_ring[0]), base + TX_BASE_PTR0);
483 writel(NUM_RX_DESC, base + RX_MAX_CNT0);
484 writel(NUM_TX_DESC, base + TX_MAX_CNT0);
486 writel(priv->tx_dma_idx, base + TX_CTX_IDX0);
487 writel(RST_DTX_IDX0, base + PDMA_RST_IDX);
489 writel(NUM_RX_DESC - 1, base + RX_CALC_IDX0);
490 writel(RST_DRX_IDX0, base + PDMA_RST_IDX);
492 /* Make sure the writes executed at this place */
496 /* Check if link is not up yet */
497 if (!phy_link_up(priv)) {
498 /* Wait for link to come up */
500 printf("Waiting for link to come up .");
501 for (i = 0; i < (LINK_TIMEOUT / LINK_DELAY_TIME); i++) {
502 mdelay(LINK_DELAY_TIME);
503 if (phy_link_up(priv)) {
504 mdelay(100); /* Ensure all is ready */
511 if (phy_link_up(priv))
514 printf(" timeout! Trying anyways\n");
518 * The integrated switch seems to queue some received ethernet
519 * packets in some FIFO. Lets read the already queued packets
520 * out by using the receive routine, so that these old messages
521 * are dropped before the new xfer starts.
523 packetp = &packet[0];
524 while (mt7628_eth_recv(dev, 0, &packetp) != -EAGAIN)
525 mt7628_eth_free_pkt(dev, packetp, 0);
530 static void mt7628_eth_stop(struct udevice *dev)
532 struct mt7628_eth_dev *priv = dev_get_priv(dev);
537 static int mt7628_eth_probe(struct udevice *dev)
539 struct mt7628_eth_dev *priv = dev_get_priv(dev);
544 /* Save frame-engine base address for later use */
545 priv->base = dev_remap_addr_index(dev, 0);
546 if (IS_ERR(priv->base))
547 return PTR_ERR(priv->base);
549 /* Save switch base address for later use */
550 priv->eth_sw_base = dev_remap_addr_index(dev, 1);
551 if (IS_ERR(priv->eth_sw_base))
552 return PTR_ERR(priv->eth_sw_base);
554 /* Reset controller */
555 ret = reset_get_by_name(dev, "ephy", &priv->rst_ephy);
557 pr_err("unable to find reset controller for ethernet PHYs\n");
561 /* Put rx and tx rings into KSEG1 area (uncached) */
562 priv->tx_ring = (struct fe_tx_dma *)
563 KSEG1ADDR(memalign(ARCH_DMA_MINALIGN,
564 sizeof(*priv->tx_ring) * NUM_TX_DESC));
565 priv->rx_ring = (struct fe_rx_dma *)
566 KSEG1ADDR(memalign(ARCH_DMA_MINALIGN,
567 sizeof(*priv->rx_ring) * NUM_RX_DESC));
569 for (i = 0; i < NUM_RX_DESC; i++)
570 priv->rx_buf[i] = memalign(PKTALIGN, MTK_QDMA_PAGE_SIZE);
574 printf("Failed to allocate MDIO bus\n");
578 bus->read = mt7628_mdio_read;
579 bus->write = mt7628_mdio_write;
580 snprintf(bus->name, sizeof(bus->name), dev->name);
581 bus->priv = (void *)priv;
583 ret = mdio_register(bus);
587 /* Switch configuration */
588 rt305x_esw_init(priv);
593 static const struct eth_ops mt7628_eth_ops = {
594 .start = mt7628_eth_start,
595 .send = mt7628_eth_send,
596 .recv = mt7628_eth_recv,
597 .free_pkt = mt7628_eth_free_pkt,
598 .stop = mt7628_eth_stop,
599 .write_hwaddr = mt7628_eth_write_hwaddr,
602 static const struct udevice_id mt7628_eth_ids[] = {
603 { .compatible = "mediatek,mt7628-eth" },
607 U_BOOT_DRIVER(mt7628_eth) = {
608 .name = "mt7628_eth",
610 .of_match = mt7628_eth_ids,
611 .probe = mt7628_eth_probe,
612 .ops = &mt7628_eth_ops,
613 .priv_auto_alloc_size = sizeof(struct mt7628_eth_dev),
614 .platdata_auto_alloc_size = sizeof(struct eth_pdata),