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/mii.h>
26 #define RAVB_REG_CCC 0x000
27 #define RAVB_REG_DBAT 0x004
28 #define RAVB_REG_CSR 0x00C
29 #define RAVB_REG_APSR 0x08C
30 #define RAVB_REG_RCR 0x090
31 #define RAVB_REG_TGC 0x300
32 #define RAVB_REG_TCCR 0x304
33 #define RAVB_REG_RIC0 0x360
34 #define RAVB_REG_RIC1 0x368
35 #define RAVB_REG_RIC2 0x370
36 #define RAVB_REG_TIC 0x378
37 #define RAVB_REG_ECMR 0x500
38 #define RAVB_REG_RFLR 0x508
39 #define RAVB_REG_ECSIPR 0x518
40 #define RAVB_REG_PIR 0x520
41 #define RAVB_REG_GECMR 0x5b0
42 #define RAVB_REG_MAHR 0x5c0
43 #define RAVB_REG_MALR 0x5c8
45 #define CCC_OPC_CONFIG BIT(0)
46 #define CCC_OPC_OPERATION BIT(1)
47 #define CCC_BOC BIT(20)
49 #define CSR_OPS 0x0000000F
50 #define CSR_OPS_CONFIG BIT(1)
52 #define APSR_TDM BIT(14)
54 #define TCCR_TSRQ0 BIT(0)
56 #define RFLR_RFL_MIN 0x05EE
58 #define PIR_MDI BIT(3)
59 #define PIR_MDO BIT(2)
60 #define PIR_MMD BIT(1)
61 #define PIR_MDC BIT(0)
63 #define ECMR_TRCCM BIT(26)
64 #define ECMR_RZPF BIT(20)
65 #define ECMR_PFR BIT(18)
66 #define ECMR_RXF BIT(17)
67 #define ECMR_RE BIT(6)
68 #define ECMR_TE BIT(5)
69 #define ECMR_DM BIT(1)
70 #define ECMR_CHG_DM (ECMR_TRCCM | ECMR_RZPF | ECMR_PFR | ECMR_RXF)
73 #define RAVB_NUM_BASE_DESC 16
74 #define RAVB_NUM_TX_DESC 8
75 #define RAVB_NUM_RX_DESC 8
77 #define RAVB_TX_QUEUE_OFFSET 0
78 #define RAVB_RX_QUEUE_OFFSET 4
80 #define RAVB_DESC_DT(n) ((n) << 28)
81 #define RAVB_DESC_DT_FSINGLE RAVB_DESC_DT(0x7)
82 #define RAVB_DESC_DT_LINKFIX RAVB_DESC_DT(0x9)
83 #define RAVB_DESC_DT_EOS RAVB_DESC_DT(0xa)
84 #define RAVB_DESC_DT_FEMPTY RAVB_DESC_DT(0xc)
85 #define RAVB_DESC_DT_EEMPTY RAVB_DESC_DT(0x3)
86 #define RAVB_DESC_DT_MASK RAVB_DESC_DT(0xf)
88 #define RAVB_DESC_DS(n) (((n) & 0xfff) << 0)
89 #define RAVB_DESC_DS_MASK 0xfff
91 #define RAVB_RX_DESC_MSC_MC BIT(23)
92 #define RAVB_RX_DESC_MSC_CEEF BIT(22)
93 #define RAVB_RX_DESC_MSC_CRL BIT(21)
94 #define RAVB_RX_DESC_MSC_FRE BIT(20)
95 #define RAVB_RX_DESC_MSC_RTLF BIT(19)
96 #define RAVB_RX_DESC_MSC_RTSF BIT(18)
97 #define RAVB_RX_DESC_MSC_RFE BIT(17)
98 #define RAVB_RX_DESC_MSC_CRC BIT(16)
99 #define RAVB_RX_DESC_MSC_MASK (0xff << 16)
101 #define RAVB_RX_DESC_MSC_RX_ERR_MASK \
102 (RAVB_RX_DESC_MSC_CRC | RAVB_RX_DESC_MSC_RFE | RAVB_RX_DESC_MSC_RTLF | \
103 RAVB_RX_DESC_MSC_RTSF | RAVB_RX_DESC_MSC_CEEF)
105 #define RAVB_TX_TIMEOUT_MS 1000
113 struct ravb_desc data;
114 struct ravb_desc link;
116 u8 packet[PKTSIZE_ALIGN];
120 struct ravb_desc base_desc[RAVB_NUM_BASE_DESC];
121 struct ravb_desc tx_desc[RAVB_NUM_TX_DESC];
122 struct ravb_rxdesc rx_desc[RAVB_NUM_RX_DESC];
126 struct phy_device *phydev;
128 void __iomem *iobase;
130 struct gpio_desc reset_gpio;
133 static inline void ravb_flush_dcache(u32 addr, u32 len)
135 flush_dcache_range(addr, addr + len);
138 static inline void ravb_invalidate_dcache(u32 addr, u32 len)
140 u32 start = addr & ~((uintptr_t)ARCH_DMA_MINALIGN - 1);
141 u32 end = roundup(addr + len, ARCH_DMA_MINALIGN);
142 invalidate_dcache_range(start, end);
145 static int ravb_send(struct udevice *dev, void *packet, int len)
147 struct ravb_priv *eth = dev_get_priv(dev);
148 struct ravb_desc *desc = ð->tx_desc[eth->tx_desc_idx];
151 /* Update TX descriptor */
152 ravb_flush_dcache((uintptr_t)packet, len);
153 memset(desc, 0x0, sizeof(*desc));
154 desc->ctrl = RAVB_DESC_DT_FSINGLE | RAVB_DESC_DS(len);
155 desc->dptr = (uintptr_t)packet;
156 ravb_flush_dcache((uintptr_t)desc, sizeof(*desc));
158 /* Restart the transmitter if disabled */
159 if (!(readl(eth->iobase + RAVB_REG_TCCR) & TCCR_TSRQ0))
160 setbits_le32(eth->iobase + RAVB_REG_TCCR, TCCR_TSRQ0);
162 /* Wait until packet is transmitted */
163 start = get_timer(0);
164 while (get_timer(start) < RAVB_TX_TIMEOUT_MS) {
165 ravb_invalidate_dcache((uintptr_t)desc, sizeof(*desc));
166 if ((desc->ctrl & RAVB_DESC_DT_MASK) != RAVB_DESC_DT_FSINGLE)
171 if (get_timer(start) >= RAVB_TX_TIMEOUT_MS)
174 eth->tx_desc_idx = (eth->tx_desc_idx + 1) % (RAVB_NUM_TX_DESC - 1);
178 static int ravb_recv(struct udevice *dev, int flags, uchar **packetp)
180 struct ravb_priv *eth = dev_get_priv(dev);
181 struct ravb_rxdesc *desc = ð->rx_desc[eth->rx_desc_idx];
185 /* Check if the rx descriptor is ready */
186 ravb_invalidate_dcache((uintptr_t)desc, sizeof(*desc));
187 if ((desc->data.ctrl & RAVB_DESC_DT_MASK) == RAVB_DESC_DT_FEMPTY)
190 /* Check for errors */
191 if (desc->data.ctrl & RAVB_RX_DESC_MSC_RX_ERR_MASK) {
192 desc->data.ctrl &= ~RAVB_RX_DESC_MSC_MASK;
196 len = desc->data.ctrl & RAVB_DESC_DS_MASK;
197 packet = (u8 *)(uintptr_t)desc->data.dptr;
198 ravb_invalidate_dcache((uintptr_t)packet, len);
204 static int ravb_free_pkt(struct udevice *dev, uchar *packet, int length)
206 struct ravb_priv *eth = dev_get_priv(dev);
207 struct ravb_rxdesc *desc = ð->rx_desc[eth->rx_desc_idx];
209 /* Make current descriptor available again */
210 desc->data.ctrl = RAVB_DESC_DT_FEMPTY | RAVB_DESC_DS(PKTSIZE_ALIGN);
211 ravb_flush_dcache((uintptr_t)desc, sizeof(*desc));
213 /* Point to the next descriptor */
214 eth->rx_desc_idx = (eth->rx_desc_idx + 1) % RAVB_NUM_RX_DESC;
215 desc = ð->rx_desc[eth->rx_desc_idx];
216 ravb_invalidate_dcache((uintptr_t)desc, sizeof(*desc));
221 static int ravb_reset(struct udevice *dev)
223 struct ravb_priv *eth = dev_get_priv(dev);
225 /* Set config mode */
226 writel(CCC_OPC_CONFIG, eth->iobase + RAVB_REG_CCC);
228 /* Check the operating mode is changed to the config mode. */
229 return wait_for_bit_le32(eth->iobase + RAVB_REG_CSR,
230 CSR_OPS_CONFIG, true, 100, true);
233 static void ravb_base_desc_init(struct ravb_priv *eth)
235 const u32 desc_size = RAVB_NUM_BASE_DESC * sizeof(struct ravb_desc);
238 /* Initialize all descriptors */
239 memset(eth->base_desc, 0x0, desc_size);
241 for (i = 0; i < RAVB_NUM_BASE_DESC; i++)
242 eth->base_desc[i].ctrl = RAVB_DESC_DT_EOS;
244 ravb_flush_dcache((uintptr_t)eth->base_desc, desc_size);
246 /* Register the descriptor base address table */
247 writel((uintptr_t)eth->base_desc, eth->iobase + RAVB_REG_DBAT);
250 static void ravb_tx_desc_init(struct ravb_priv *eth)
252 const u32 desc_size = RAVB_NUM_TX_DESC * sizeof(struct ravb_desc);
255 /* Initialize all descriptors */
256 memset(eth->tx_desc, 0x0, desc_size);
257 eth->tx_desc_idx = 0;
259 for (i = 0; i < RAVB_NUM_TX_DESC; i++)
260 eth->tx_desc[i].ctrl = RAVB_DESC_DT_EEMPTY;
262 /* Mark the end of the descriptors */
263 eth->tx_desc[RAVB_NUM_TX_DESC - 1].ctrl = RAVB_DESC_DT_LINKFIX;
264 eth->tx_desc[RAVB_NUM_TX_DESC - 1].dptr = (uintptr_t)eth->tx_desc;
265 ravb_flush_dcache((uintptr_t)eth->tx_desc, desc_size);
267 /* Point the controller to the TX descriptor list. */
268 eth->base_desc[RAVB_TX_QUEUE_OFFSET].ctrl = RAVB_DESC_DT_LINKFIX;
269 eth->base_desc[RAVB_TX_QUEUE_OFFSET].dptr = (uintptr_t)eth->tx_desc;
270 ravb_flush_dcache((uintptr_t)ð->base_desc[RAVB_TX_QUEUE_OFFSET],
271 sizeof(struct ravb_desc));
274 static void ravb_rx_desc_init(struct ravb_priv *eth)
276 const u32 desc_size = RAVB_NUM_RX_DESC * sizeof(struct ravb_rxdesc);
279 /* Initialize all descriptors */
280 memset(eth->rx_desc, 0x0, desc_size);
281 eth->rx_desc_idx = 0;
283 for (i = 0; i < RAVB_NUM_RX_DESC; i++) {
284 eth->rx_desc[i].data.ctrl = RAVB_DESC_DT_EEMPTY |
285 RAVB_DESC_DS(PKTSIZE_ALIGN);
286 eth->rx_desc[i].data.dptr = (uintptr_t)eth->rx_desc[i].packet;
288 eth->rx_desc[i].link.ctrl = RAVB_DESC_DT_LINKFIX;
289 eth->rx_desc[i].link.dptr = (uintptr_t)ð->rx_desc[i + 1];
292 /* Mark the end of the descriptors */
293 eth->rx_desc[RAVB_NUM_RX_DESC - 1].link.ctrl = RAVB_DESC_DT_LINKFIX;
294 eth->rx_desc[RAVB_NUM_RX_DESC - 1].link.dptr = (uintptr_t)eth->rx_desc;
295 ravb_flush_dcache((uintptr_t)eth->rx_desc, desc_size);
297 /* Point the controller to the rx descriptor list */
298 eth->base_desc[RAVB_RX_QUEUE_OFFSET].ctrl = RAVB_DESC_DT_LINKFIX;
299 eth->base_desc[RAVB_RX_QUEUE_OFFSET].dptr = (uintptr_t)eth->rx_desc;
300 ravb_flush_dcache((uintptr_t)ð->base_desc[RAVB_RX_QUEUE_OFFSET],
301 sizeof(struct ravb_desc));
304 static int ravb_phy_config(struct udevice *dev)
306 struct ravb_priv *eth = dev_get_priv(dev);
307 struct eth_pdata *pdata = dev_get_platdata(dev);
308 struct phy_device *phydev;
309 int mask = 0xffffffff, reg;
311 if (dm_gpio_is_valid(ð->reset_gpio)) {
312 dm_gpio_set_value(ð->reset_gpio, 1);
314 dm_gpio_set_value(ð->reset_gpio, 0);
318 phydev = phy_find_by_mask(eth->bus, mask, pdata->phy_interface);
322 phy_connect_dev(phydev, dev);
324 eth->phydev = phydev;
326 phydev->supported &= SUPPORTED_100baseT_Full |
327 SUPPORTED_1000baseT_Full | SUPPORTED_Autoneg |
328 SUPPORTED_TP | SUPPORTED_MII | SUPPORTED_Pause |
329 SUPPORTED_Asym_Pause;
331 if (pdata->max_speed != 1000) {
332 phydev->supported &= ~SUPPORTED_1000baseT_Full;
333 reg = phy_read(phydev, -1, MII_CTRL1000);
334 reg &= ~(BIT(9) | BIT(8));
335 phy_write(phydev, -1, MII_CTRL1000, reg);
343 /* Set Mac address */
344 static int ravb_write_hwaddr(struct udevice *dev)
346 struct ravb_priv *eth = dev_get_priv(dev);
347 struct eth_pdata *pdata = dev_get_platdata(dev);
348 unsigned char *mac = pdata->enetaddr;
350 writel((mac[0] << 24) | (mac[1] << 16) | (mac[2] << 8) | mac[3],
351 eth->iobase + RAVB_REG_MAHR);
353 writel((mac[4] << 8) | mac[5], eth->iobase + RAVB_REG_MALR);
358 /* E-MAC init function */
359 static int ravb_mac_init(struct ravb_priv *eth)
361 /* Disable MAC Interrupt */
362 writel(0, eth->iobase + RAVB_REG_ECSIPR);
364 /* Recv frame limit set register */
365 writel(RFLR_RFL_MIN, eth->iobase + RAVB_REG_RFLR);
370 /* AVB-DMAC init function */
371 static int ravb_dmac_init(struct udevice *dev)
373 struct ravb_priv *eth = dev_get_priv(dev);
374 struct eth_pdata *pdata = dev_get_platdata(dev);
377 /* Set CONFIG mode */
378 ret = ravb_reset(dev);
382 /* Disable all interrupts */
383 writel(0, eth->iobase + RAVB_REG_RIC0);
384 writel(0, eth->iobase + RAVB_REG_RIC1);
385 writel(0, eth->iobase + RAVB_REG_RIC2);
386 writel(0, eth->iobase + RAVB_REG_TIC);
388 /* Set little endian */
389 clrbits_le32(eth->iobase + RAVB_REG_CCC, CCC_BOC);
392 writel(0x18000001, eth->iobase + RAVB_REG_RCR);
395 writel(0x00222210, eth->iobase + RAVB_REG_TGC);
397 /* Delay CLK: 2ns (not applicable on R-Car E3/D3) */
398 if ((rmobile_get_cpu_type() == RMOBILE_CPU_TYPE_R8A77990) ||
399 (rmobile_get_cpu_type() == RMOBILE_CPU_TYPE_R8A77995))
402 if ((pdata->phy_interface == PHY_INTERFACE_MODE_RGMII_ID) ||
403 (pdata->phy_interface == PHY_INTERFACE_MODE_RGMII_TXID))
404 writel(APSR_TDM, eth->iobase + RAVB_REG_APSR);
409 static int ravb_config(struct udevice *dev)
411 struct ravb_priv *eth = dev_get_priv(dev);
412 struct phy_device *phy = eth->phydev;
413 u32 mask = ECMR_CHG_DM | ECMR_RE | ECMR_TE;
416 /* Configure AVB-DMAC register */
419 /* Configure E-MAC registers */
421 ravb_write_hwaddr(dev);
423 ret = phy_startup(phy);
427 /* Set the transfer speed */
428 if (phy->speed == 100)
429 writel(0, eth->iobase + RAVB_REG_GECMR);
430 else if (phy->speed == 1000)
431 writel(1, eth->iobase + RAVB_REG_GECMR);
433 /* Check if full duplex mode is supported by the phy */
437 writel(mask, eth->iobase + RAVB_REG_ECMR);
439 phy->drv->writeext(phy, -1, 0x02, 0x08, (0x0f << 5) | 0x19);
444 static int ravb_start(struct udevice *dev)
446 struct ravb_priv *eth = dev_get_priv(dev);
449 ret = ravb_reset(dev);
453 ravb_base_desc_init(eth);
454 ravb_tx_desc_init(eth);
455 ravb_rx_desc_init(eth);
457 ret = ravb_config(dev);
461 /* Setting the control will start the AVB-DMAC process. */
462 writel(CCC_OPC_OPERATION, eth->iobase + RAVB_REG_CCC);
467 static void ravb_stop(struct udevice *dev)
469 struct ravb_priv *eth = dev_get_priv(dev);
471 phy_shutdown(eth->phydev);
475 static int ravb_probe(struct udevice *dev)
477 struct eth_pdata *pdata = dev_get_platdata(dev);
478 struct ravb_priv *eth = dev_get_priv(dev);
479 struct ofnode_phandle_args phandle_args;
480 struct mii_dev *mdiodev;
481 void __iomem *iobase;
484 iobase = map_physmem(pdata->iobase, 0x1000, MAP_NOCACHE);
485 eth->iobase = iobase;
487 ret = clk_get_by_index(dev, 0, ð->clk);
491 ret = dev_read_phandle_with_args(dev, "phy-handle", NULL, 0, 0, &phandle_args);
493 gpio_request_by_name_nodev(phandle_args.node, "reset-gpios", 0,
494 ð->reset_gpio, GPIOD_IS_OUT);
497 if (!dm_gpio_is_valid(ð->reset_gpio)) {
498 gpio_request_by_name(dev, "reset-gpios", 0, ð->reset_gpio,
502 mdiodev = mdio_alloc();
508 mdiodev->read = bb_miiphy_read;
509 mdiodev->write = bb_miiphy_write;
510 bb_miiphy_buses[0].priv = eth;
511 snprintf(mdiodev->name, sizeof(mdiodev->name), dev->name);
513 ret = mdio_register(mdiodev);
515 goto err_mdio_register;
517 eth->bus = miiphy_get_dev_by_name(dev->name);
520 ret = clk_enable(ð->clk);
522 goto err_mdio_register;
524 ret = ravb_reset(dev);
528 ret = ravb_phy_config(dev);
535 clk_disable(ð->clk);
539 unmap_physmem(eth->iobase, MAP_NOCACHE);
543 static int ravb_remove(struct udevice *dev)
545 struct ravb_priv *eth = dev_get_priv(dev);
547 clk_disable(ð->clk);
550 mdio_unregister(eth->bus);
552 if (dm_gpio_is_valid(ð->reset_gpio))
553 dm_gpio_free(dev, ð->reset_gpio);
554 unmap_physmem(eth->iobase, MAP_NOCACHE);
559 int ravb_bb_init(struct bb_miiphy_bus *bus)
564 int ravb_bb_mdio_active(struct bb_miiphy_bus *bus)
566 struct ravb_priv *eth = bus->priv;
568 setbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MMD);
573 int ravb_bb_mdio_tristate(struct bb_miiphy_bus *bus)
575 struct ravb_priv *eth = bus->priv;
577 clrbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MMD);
582 int ravb_bb_set_mdio(struct bb_miiphy_bus *bus, int v)
584 struct ravb_priv *eth = bus->priv;
587 setbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDO);
589 clrbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDO);
594 int ravb_bb_get_mdio(struct bb_miiphy_bus *bus, int *v)
596 struct ravb_priv *eth = bus->priv;
598 *v = (readl(eth->iobase + RAVB_REG_PIR) & PIR_MDI) >> 3;
603 int ravb_bb_set_mdc(struct bb_miiphy_bus *bus, int v)
605 struct ravb_priv *eth = bus->priv;
608 setbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDC);
610 clrbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDC);
615 int ravb_bb_delay(struct bb_miiphy_bus *bus)
622 struct bb_miiphy_bus bb_miiphy_buses[] = {
625 .init = ravb_bb_init,
626 .mdio_active = ravb_bb_mdio_active,
627 .mdio_tristate = ravb_bb_mdio_tristate,
628 .set_mdio = ravb_bb_set_mdio,
629 .get_mdio = ravb_bb_get_mdio,
630 .set_mdc = ravb_bb_set_mdc,
631 .delay = ravb_bb_delay,
634 int bb_miiphy_buses_num = ARRAY_SIZE(bb_miiphy_buses);
636 static const struct eth_ops ravb_ops = {
640 .free_pkt = ravb_free_pkt,
642 .write_hwaddr = ravb_write_hwaddr,
645 int ravb_ofdata_to_platdata(struct udevice *dev)
647 struct eth_pdata *pdata = dev_get_platdata(dev);
648 const char *phy_mode;
652 pdata->iobase = devfdt_get_addr(dev);
653 pdata->phy_interface = -1;
654 phy_mode = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), "phy-mode",
657 pdata->phy_interface = phy_get_interface_by_name(phy_mode);
658 if (pdata->phy_interface == -1) {
659 debug("%s: Invalid PHY interface '%s'\n", __func__, phy_mode);
663 pdata->max_speed = 1000;
664 cell = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), "max-speed", NULL);
666 pdata->max_speed = fdt32_to_cpu(*cell);
668 sprintf(bb_miiphy_buses[0].name, dev->name);
673 static const struct udevice_id ravb_ids[] = {
674 { .compatible = "renesas,etheravb-r8a7795" },
675 { .compatible = "renesas,etheravb-r8a7796" },
676 { .compatible = "renesas,etheravb-r8a77965" },
677 { .compatible = "renesas,etheravb-r8a77970" },
678 { .compatible = "renesas,etheravb-r8a77990" },
679 { .compatible = "renesas,etheravb-r8a77995" },
680 { .compatible = "renesas,etheravb-rcar-gen3" },
684 U_BOOT_DRIVER(eth_ravb) = {
687 .of_match = ravb_ids,
688 .ofdata_to_platdata = ravb_ofdata_to_platdata,
690 .remove = ravb_remove,
692 .priv_auto_alloc_size = sizeof(struct ravb_priv),
693 .platdata_auto_alloc_size = sizeof(struct eth_pdata),
694 .flags = DM_FLAG_ALLOC_PRIV_DMA,