1 // SPDX-License-Identifier: GPL-2.0+
4 * This file is driver for Renesas Ethernet AVB.
6 * Copyright (C) 2015-2017 Renesas Electronics Corporation
8 * Based on the SuperH Ethernet driver.
19 #include <asm/cache.h>
20 #include <linux/delay.h>
21 #include <linux/mii.h>
27 #define RAVB_REG_CCC 0x000
28 #define RAVB_REG_DBAT 0x004
29 #define RAVB_REG_CSR 0x00C
30 #define RAVB_REG_APSR 0x08C
31 #define RAVB_REG_RCR 0x090
32 #define RAVB_REG_TGC 0x300
33 #define RAVB_REG_TCCR 0x304
34 #define RAVB_REG_RIC0 0x360
35 #define RAVB_REG_RIC1 0x368
36 #define RAVB_REG_RIC2 0x370
37 #define RAVB_REG_TIC 0x378
38 #define RAVB_REG_ECMR 0x500
39 #define RAVB_REG_RFLR 0x508
40 #define RAVB_REG_ECSIPR 0x518
41 #define RAVB_REG_PIR 0x520
42 #define RAVB_REG_GECMR 0x5b0
43 #define RAVB_REG_MAHR 0x5c0
44 #define RAVB_REG_MALR 0x5c8
46 #define CCC_OPC_CONFIG BIT(0)
47 #define CCC_OPC_OPERATION BIT(1)
48 #define CCC_BOC BIT(20)
50 #define CSR_OPS 0x0000000F
51 #define CSR_OPS_CONFIG BIT(1)
53 #define APSR_TDM BIT(14)
55 #define TCCR_TSRQ0 BIT(0)
57 #define RFLR_RFL_MIN 0x05EE
59 #define PIR_MDI BIT(3)
60 #define PIR_MDO BIT(2)
61 #define PIR_MMD BIT(1)
62 #define PIR_MDC BIT(0)
64 #define ECMR_TRCCM BIT(26)
65 #define ECMR_RZPF BIT(20)
66 #define ECMR_PFR BIT(18)
67 #define ECMR_RXF BIT(17)
68 #define ECMR_RE BIT(6)
69 #define ECMR_TE BIT(5)
70 #define ECMR_DM BIT(1)
71 #define ECMR_CHG_DM (ECMR_TRCCM | ECMR_RZPF | ECMR_PFR | ECMR_RXF)
74 #define RAVB_NUM_BASE_DESC 16
75 #define RAVB_NUM_TX_DESC 8
76 #define RAVB_NUM_RX_DESC 8
78 #define RAVB_TX_QUEUE_OFFSET 0
79 #define RAVB_RX_QUEUE_OFFSET 4
81 #define RAVB_DESC_DT(n) ((n) << 28)
82 #define RAVB_DESC_DT_FSINGLE RAVB_DESC_DT(0x7)
83 #define RAVB_DESC_DT_LINKFIX RAVB_DESC_DT(0x9)
84 #define RAVB_DESC_DT_EOS RAVB_DESC_DT(0xa)
85 #define RAVB_DESC_DT_FEMPTY RAVB_DESC_DT(0xc)
86 #define RAVB_DESC_DT_EEMPTY RAVB_DESC_DT(0x3)
87 #define RAVB_DESC_DT_MASK RAVB_DESC_DT(0xf)
89 #define RAVB_DESC_DS(n) (((n) & 0xfff) << 0)
90 #define RAVB_DESC_DS_MASK 0xfff
92 #define RAVB_RX_DESC_MSC_MC BIT(23)
93 #define RAVB_RX_DESC_MSC_CEEF BIT(22)
94 #define RAVB_RX_DESC_MSC_CRL BIT(21)
95 #define RAVB_RX_DESC_MSC_FRE BIT(20)
96 #define RAVB_RX_DESC_MSC_RTLF BIT(19)
97 #define RAVB_RX_DESC_MSC_RTSF BIT(18)
98 #define RAVB_RX_DESC_MSC_RFE BIT(17)
99 #define RAVB_RX_DESC_MSC_CRC BIT(16)
100 #define RAVB_RX_DESC_MSC_MASK (0xff << 16)
102 #define RAVB_RX_DESC_MSC_RX_ERR_MASK \
103 (RAVB_RX_DESC_MSC_CRC | RAVB_RX_DESC_MSC_RFE | RAVB_RX_DESC_MSC_RTLF | \
104 RAVB_RX_DESC_MSC_RTSF | RAVB_RX_DESC_MSC_CEEF)
106 #define RAVB_TX_TIMEOUT_MS 1000
114 struct ravb_desc data;
115 struct ravb_desc link;
117 u8 packet[PKTSIZE_ALIGN];
121 struct ravb_desc base_desc[RAVB_NUM_BASE_DESC];
122 struct ravb_desc tx_desc[RAVB_NUM_TX_DESC];
123 struct ravb_rxdesc rx_desc[RAVB_NUM_RX_DESC];
127 struct phy_device *phydev;
129 void __iomem *iobase;
131 struct gpio_desc reset_gpio;
134 static inline void ravb_flush_dcache(u32 addr, u32 len)
136 flush_dcache_range(addr, addr + len);
139 static inline void ravb_invalidate_dcache(u32 addr, u32 len)
141 u32 start = addr & ~((uintptr_t)ARCH_DMA_MINALIGN - 1);
142 u32 end = roundup(addr + len, ARCH_DMA_MINALIGN);
143 invalidate_dcache_range(start, end);
146 static int ravb_send(struct udevice *dev, void *packet, int len)
148 struct ravb_priv *eth = dev_get_priv(dev);
149 struct ravb_desc *desc = ð->tx_desc[eth->tx_desc_idx];
152 /* Update TX descriptor */
153 ravb_flush_dcache((uintptr_t)packet, len);
154 memset(desc, 0x0, sizeof(*desc));
155 desc->ctrl = RAVB_DESC_DT_FSINGLE | RAVB_DESC_DS(len);
156 desc->dptr = (uintptr_t)packet;
157 ravb_flush_dcache((uintptr_t)desc, sizeof(*desc));
159 /* Restart the transmitter if disabled */
160 if (!(readl(eth->iobase + RAVB_REG_TCCR) & TCCR_TSRQ0))
161 setbits_le32(eth->iobase + RAVB_REG_TCCR, TCCR_TSRQ0);
163 /* Wait until packet is transmitted */
164 start = get_timer(0);
165 while (get_timer(start) < RAVB_TX_TIMEOUT_MS) {
166 ravb_invalidate_dcache((uintptr_t)desc, sizeof(*desc));
167 if ((desc->ctrl & RAVB_DESC_DT_MASK) != RAVB_DESC_DT_FSINGLE)
172 if (get_timer(start) >= RAVB_TX_TIMEOUT_MS)
175 eth->tx_desc_idx = (eth->tx_desc_idx + 1) % (RAVB_NUM_TX_DESC - 1);
179 static int ravb_recv(struct udevice *dev, int flags, uchar **packetp)
181 struct ravb_priv *eth = dev_get_priv(dev);
182 struct ravb_rxdesc *desc = ð->rx_desc[eth->rx_desc_idx];
186 /* Check if the rx descriptor is ready */
187 ravb_invalidate_dcache((uintptr_t)desc, sizeof(*desc));
188 if ((desc->data.ctrl & RAVB_DESC_DT_MASK) == RAVB_DESC_DT_FEMPTY)
191 /* Check for errors */
192 if (desc->data.ctrl & RAVB_RX_DESC_MSC_RX_ERR_MASK) {
193 desc->data.ctrl &= ~RAVB_RX_DESC_MSC_MASK;
197 len = desc->data.ctrl & RAVB_DESC_DS_MASK;
198 packet = (u8 *)(uintptr_t)desc->data.dptr;
199 ravb_invalidate_dcache((uintptr_t)packet, len);
205 static int ravb_free_pkt(struct udevice *dev, uchar *packet, int length)
207 struct ravb_priv *eth = dev_get_priv(dev);
208 struct ravb_rxdesc *desc = ð->rx_desc[eth->rx_desc_idx];
210 /* Make current descriptor available again */
211 desc->data.ctrl = RAVB_DESC_DT_FEMPTY | RAVB_DESC_DS(PKTSIZE_ALIGN);
212 ravb_flush_dcache((uintptr_t)desc, sizeof(*desc));
214 /* Point to the next descriptor */
215 eth->rx_desc_idx = (eth->rx_desc_idx + 1) % RAVB_NUM_RX_DESC;
216 desc = ð->rx_desc[eth->rx_desc_idx];
217 ravb_invalidate_dcache((uintptr_t)desc, sizeof(*desc));
222 static int ravb_reset(struct udevice *dev)
224 struct ravb_priv *eth = dev_get_priv(dev);
226 /* Set config mode */
227 writel(CCC_OPC_CONFIG, eth->iobase + RAVB_REG_CCC);
229 /* Check the operating mode is changed to the config mode. */
230 return wait_for_bit_le32(eth->iobase + RAVB_REG_CSR,
231 CSR_OPS_CONFIG, true, 100, true);
234 static void ravb_base_desc_init(struct ravb_priv *eth)
236 const u32 desc_size = RAVB_NUM_BASE_DESC * sizeof(struct ravb_desc);
239 /* Initialize all descriptors */
240 memset(eth->base_desc, 0x0, desc_size);
242 for (i = 0; i < RAVB_NUM_BASE_DESC; i++)
243 eth->base_desc[i].ctrl = RAVB_DESC_DT_EOS;
245 ravb_flush_dcache((uintptr_t)eth->base_desc, desc_size);
247 /* Register the descriptor base address table */
248 writel((uintptr_t)eth->base_desc, eth->iobase + RAVB_REG_DBAT);
251 static void ravb_tx_desc_init(struct ravb_priv *eth)
253 const u32 desc_size = RAVB_NUM_TX_DESC * sizeof(struct ravb_desc);
256 /* Initialize all descriptors */
257 memset(eth->tx_desc, 0x0, desc_size);
258 eth->tx_desc_idx = 0;
260 for (i = 0; i < RAVB_NUM_TX_DESC; i++)
261 eth->tx_desc[i].ctrl = RAVB_DESC_DT_EEMPTY;
263 /* Mark the end of the descriptors */
264 eth->tx_desc[RAVB_NUM_TX_DESC - 1].ctrl = RAVB_DESC_DT_LINKFIX;
265 eth->tx_desc[RAVB_NUM_TX_DESC - 1].dptr = (uintptr_t)eth->tx_desc;
266 ravb_flush_dcache((uintptr_t)eth->tx_desc, desc_size);
268 /* Point the controller to the TX descriptor list. */
269 eth->base_desc[RAVB_TX_QUEUE_OFFSET].ctrl = RAVB_DESC_DT_LINKFIX;
270 eth->base_desc[RAVB_TX_QUEUE_OFFSET].dptr = (uintptr_t)eth->tx_desc;
271 ravb_flush_dcache((uintptr_t)ð->base_desc[RAVB_TX_QUEUE_OFFSET],
272 sizeof(struct ravb_desc));
275 static void ravb_rx_desc_init(struct ravb_priv *eth)
277 const u32 desc_size = RAVB_NUM_RX_DESC * sizeof(struct ravb_rxdesc);
280 /* Initialize all descriptors */
281 memset(eth->rx_desc, 0x0, desc_size);
282 eth->rx_desc_idx = 0;
284 for (i = 0; i < RAVB_NUM_RX_DESC; i++) {
285 eth->rx_desc[i].data.ctrl = RAVB_DESC_DT_EEMPTY |
286 RAVB_DESC_DS(PKTSIZE_ALIGN);
287 eth->rx_desc[i].data.dptr = (uintptr_t)eth->rx_desc[i].packet;
289 eth->rx_desc[i].link.ctrl = RAVB_DESC_DT_LINKFIX;
290 eth->rx_desc[i].link.dptr = (uintptr_t)ð->rx_desc[i + 1];
293 /* Mark the end of the descriptors */
294 eth->rx_desc[RAVB_NUM_RX_DESC - 1].link.ctrl = RAVB_DESC_DT_LINKFIX;
295 eth->rx_desc[RAVB_NUM_RX_DESC - 1].link.dptr = (uintptr_t)eth->rx_desc;
296 ravb_flush_dcache((uintptr_t)eth->rx_desc, desc_size);
298 /* Point the controller to the rx descriptor list */
299 eth->base_desc[RAVB_RX_QUEUE_OFFSET].ctrl = RAVB_DESC_DT_LINKFIX;
300 eth->base_desc[RAVB_RX_QUEUE_OFFSET].dptr = (uintptr_t)eth->rx_desc;
301 ravb_flush_dcache((uintptr_t)ð->base_desc[RAVB_RX_QUEUE_OFFSET],
302 sizeof(struct ravb_desc));
305 static int ravb_phy_config(struct udevice *dev)
307 struct ravb_priv *eth = dev_get_priv(dev);
308 struct eth_pdata *pdata = dev_get_platdata(dev);
309 struct phy_device *phydev;
310 int mask = 0xffffffff, reg;
312 if (dm_gpio_is_valid(ð->reset_gpio)) {
313 dm_gpio_set_value(ð->reset_gpio, 1);
315 dm_gpio_set_value(ð->reset_gpio, 0);
319 phydev = phy_find_by_mask(eth->bus, mask, pdata->phy_interface);
323 phy_connect_dev(phydev, dev);
325 eth->phydev = phydev;
327 phydev->supported &= SUPPORTED_100baseT_Full |
328 SUPPORTED_1000baseT_Full | SUPPORTED_Autoneg |
329 SUPPORTED_TP | SUPPORTED_MII | SUPPORTED_Pause |
330 SUPPORTED_Asym_Pause;
332 if (pdata->max_speed != 1000) {
333 phydev->supported &= ~SUPPORTED_1000baseT_Full;
334 reg = phy_read(phydev, -1, MII_CTRL1000);
335 reg &= ~(BIT(9) | BIT(8));
336 phy_write(phydev, -1, MII_CTRL1000, reg);
344 /* Set Mac address */
345 static int ravb_write_hwaddr(struct udevice *dev)
347 struct ravb_priv *eth = dev_get_priv(dev);
348 struct eth_pdata *pdata = dev_get_platdata(dev);
349 unsigned char *mac = pdata->enetaddr;
351 writel((mac[0] << 24) | (mac[1] << 16) | (mac[2] << 8) | mac[3],
352 eth->iobase + RAVB_REG_MAHR);
354 writel((mac[4] << 8) | mac[5], eth->iobase + RAVB_REG_MALR);
359 /* E-MAC init function */
360 static int ravb_mac_init(struct ravb_priv *eth)
362 /* Disable MAC Interrupt */
363 writel(0, eth->iobase + RAVB_REG_ECSIPR);
365 /* Recv frame limit set register */
366 writel(RFLR_RFL_MIN, eth->iobase + RAVB_REG_RFLR);
371 /* AVB-DMAC init function */
372 static int ravb_dmac_init(struct udevice *dev)
374 struct ravb_priv *eth = dev_get_priv(dev);
375 struct eth_pdata *pdata = dev_get_platdata(dev);
378 /* Set CONFIG mode */
379 ret = ravb_reset(dev);
383 /* Disable all interrupts */
384 writel(0, eth->iobase + RAVB_REG_RIC0);
385 writel(0, eth->iobase + RAVB_REG_RIC1);
386 writel(0, eth->iobase + RAVB_REG_RIC2);
387 writel(0, eth->iobase + RAVB_REG_TIC);
389 /* Set little endian */
390 clrbits_le32(eth->iobase + RAVB_REG_CCC, CCC_BOC);
393 writel(0x18000001, eth->iobase + RAVB_REG_RCR);
396 writel(0x00222210, eth->iobase + RAVB_REG_TGC);
398 /* Delay CLK: 2ns (not applicable on R-Car E3/D3) */
399 if ((rmobile_get_cpu_type() == RMOBILE_CPU_TYPE_R8A77990) ||
400 (rmobile_get_cpu_type() == RMOBILE_CPU_TYPE_R8A77995))
403 if ((pdata->phy_interface == PHY_INTERFACE_MODE_RGMII_ID) ||
404 (pdata->phy_interface == PHY_INTERFACE_MODE_RGMII_TXID))
405 writel(APSR_TDM, eth->iobase + RAVB_REG_APSR);
410 static int ravb_config(struct udevice *dev)
412 struct ravb_priv *eth = dev_get_priv(dev);
413 struct phy_device *phy = eth->phydev;
414 u32 mask = ECMR_CHG_DM | ECMR_RE | ECMR_TE;
417 /* Configure AVB-DMAC register */
420 /* Configure E-MAC registers */
422 ravb_write_hwaddr(dev);
424 ret = phy_startup(phy);
428 /* Set the transfer speed */
429 if (phy->speed == 100)
430 writel(0, eth->iobase + RAVB_REG_GECMR);
431 else if (phy->speed == 1000)
432 writel(1, eth->iobase + RAVB_REG_GECMR);
434 /* Check if full duplex mode is supported by the phy */
438 writel(mask, eth->iobase + RAVB_REG_ECMR);
440 phy->drv->writeext(phy, -1, 0x02, 0x08, (0x0f << 5) | 0x19);
445 static int ravb_start(struct udevice *dev)
447 struct ravb_priv *eth = dev_get_priv(dev);
450 ret = ravb_reset(dev);
454 ravb_base_desc_init(eth);
455 ravb_tx_desc_init(eth);
456 ravb_rx_desc_init(eth);
458 ret = ravb_config(dev);
462 /* Setting the control will start the AVB-DMAC process. */
463 writel(CCC_OPC_OPERATION, eth->iobase + RAVB_REG_CCC);
468 static void ravb_stop(struct udevice *dev)
470 struct ravb_priv *eth = dev_get_priv(dev);
472 phy_shutdown(eth->phydev);
476 static int ravb_probe(struct udevice *dev)
478 struct eth_pdata *pdata = dev_get_platdata(dev);
479 struct ravb_priv *eth = dev_get_priv(dev);
480 struct ofnode_phandle_args phandle_args;
481 struct mii_dev *mdiodev;
482 void __iomem *iobase;
485 iobase = map_physmem(pdata->iobase, 0x1000, MAP_NOCACHE);
486 eth->iobase = iobase;
488 ret = clk_get_by_index(dev, 0, ð->clk);
492 ret = dev_read_phandle_with_args(dev, "phy-handle", NULL, 0, 0, &phandle_args);
494 gpio_request_by_name_nodev(phandle_args.node, "reset-gpios", 0,
495 ð->reset_gpio, GPIOD_IS_OUT);
498 if (!dm_gpio_is_valid(ð->reset_gpio)) {
499 gpio_request_by_name(dev, "reset-gpios", 0, ð->reset_gpio,
503 mdiodev = mdio_alloc();
509 mdiodev->read = bb_miiphy_read;
510 mdiodev->write = bb_miiphy_write;
511 bb_miiphy_buses[0].priv = eth;
512 snprintf(mdiodev->name, sizeof(mdiodev->name), dev->name);
514 ret = mdio_register(mdiodev);
516 goto err_mdio_register;
518 eth->bus = miiphy_get_dev_by_name(dev->name);
521 ret = clk_enable(ð->clk);
523 goto err_mdio_register;
525 ret = ravb_reset(dev);
529 ret = ravb_phy_config(dev);
536 clk_disable(ð->clk);
540 unmap_physmem(eth->iobase, MAP_NOCACHE);
544 static int ravb_remove(struct udevice *dev)
546 struct ravb_priv *eth = dev_get_priv(dev);
548 clk_disable(ð->clk);
551 mdio_unregister(eth->bus);
553 if (dm_gpio_is_valid(ð->reset_gpio))
554 dm_gpio_free(dev, ð->reset_gpio);
555 unmap_physmem(eth->iobase, MAP_NOCACHE);
560 int ravb_bb_init(struct bb_miiphy_bus *bus)
565 int ravb_bb_mdio_active(struct bb_miiphy_bus *bus)
567 struct ravb_priv *eth = bus->priv;
569 setbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MMD);
574 int ravb_bb_mdio_tristate(struct bb_miiphy_bus *bus)
576 struct ravb_priv *eth = bus->priv;
578 clrbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MMD);
583 int ravb_bb_set_mdio(struct bb_miiphy_bus *bus, int v)
585 struct ravb_priv *eth = bus->priv;
588 setbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDO);
590 clrbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDO);
595 int ravb_bb_get_mdio(struct bb_miiphy_bus *bus, int *v)
597 struct ravb_priv *eth = bus->priv;
599 *v = (readl(eth->iobase + RAVB_REG_PIR) & PIR_MDI) >> 3;
604 int ravb_bb_set_mdc(struct bb_miiphy_bus *bus, int v)
606 struct ravb_priv *eth = bus->priv;
609 setbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDC);
611 clrbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDC);
616 int ravb_bb_delay(struct bb_miiphy_bus *bus)
623 struct bb_miiphy_bus bb_miiphy_buses[] = {
626 .init = ravb_bb_init,
627 .mdio_active = ravb_bb_mdio_active,
628 .mdio_tristate = ravb_bb_mdio_tristate,
629 .set_mdio = ravb_bb_set_mdio,
630 .get_mdio = ravb_bb_get_mdio,
631 .set_mdc = ravb_bb_set_mdc,
632 .delay = ravb_bb_delay,
635 int bb_miiphy_buses_num = ARRAY_SIZE(bb_miiphy_buses);
637 static const struct eth_ops ravb_ops = {
641 .free_pkt = ravb_free_pkt,
643 .write_hwaddr = ravb_write_hwaddr,
646 int ravb_ofdata_to_platdata(struct udevice *dev)
648 struct eth_pdata *pdata = dev_get_platdata(dev);
649 const char *phy_mode;
653 pdata->iobase = devfdt_get_addr(dev);
654 pdata->phy_interface = -1;
655 phy_mode = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), "phy-mode",
658 pdata->phy_interface = phy_get_interface_by_name(phy_mode);
659 if (pdata->phy_interface == -1) {
660 debug("%s: Invalid PHY interface '%s'\n", __func__, phy_mode);
664 pdata->max_speed = 1000;
665 cell = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), "max-speed", NULL);
667 pdata->max_speed = fdt32_to_cpu(*cell);
669 sprintf(bb_miiphy_buses[0].name, dev->name);
674 static const struct udevice_id ravb_ids[] = {
675 { .compatible = "renesas,etheravb-r8a7795" },
676 { .compatible = "renesas,etheravb-r8a7796" },
677 { .compatible = "renesas,etheravb-r8a77965" },
678 { .compatible = "renesas,etheravb-r8a77970" },
679 { .compatible = "renesas,etheravb-r8a77990" },
680 { .compatible = "renesas,etheravb-r8a77995" },
681 { .compatible = "renesas,etheravb-rcar-gen3" },
685 U_BOOT_DRIVER(eth_ravb) = {
688 .of_match = ravb_ids,
689 .ofdata_to_platdata = ravb_ofdata_to_platdata,
691 .remove = ravb_remove,
693 .priv_auto_alloc_size = sizeof(struct ravb_priv),
694 .platdata_auto_alloc_size = sizeof(struct eth_pdata),
695 .flags = DM_FLAG_ALLOC_PRIV_DMA,