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.
18 #include <asm/cache.h>
19 #include <linux/mii.h>
25 #define RAVB_REG_CCC 0x000
26 #define RAVB_REG_DBAT 0x004
27 #define RAVB_REG_CSR 0x00C
28 #define RAVB_REG_APSR 0x08C
29 #define RAVB_REG_RCR 0x090
30 #define RAVB_REG_TGC 0x300
31 #define RAVB_REG_TCCR 0x304
32 #define RAVB_REG_RIC0 0x360
33 #define RAVB_REG_RIC1 0x368
34 #define RAVB_REG_RIC2 0x370
35 #define RAVB_REG_TIC 0x378
36 #define RAVB_REG_ECMR 0x500
37 #define RAVB_REG_RFLR 0x508
38 #define RAVB_REG_ECSIPR 0x518
39 #define RAVB_REG_PIR 0x520
40 #define RAVB_REG_GECMR 0x5b0
41 #define RAVB_REG_MAHR 0x5c0
42 #define RAVB_REG_MALR 0x5c8
44 #define CCC_OPC_CONFIG BIT(0)
45 #define CCC_OPC_OPERATION BIT(1)
46 #define CCC_BOC BIT(20)
48 #define CSR_OPS 0x0000000F
49 #define CSR_OPS_CONFIG BIT(1)
51 #define APSR_TDM BIT(14)
53 #define TCCR_TSRQ0 BIT(0)
55 #define RFLR_RFL_MIN 0x05EE
57 #define PIR_MDI BIT(3)
58 #define PIR_MDO BIT(2)
59 #define PIR_MMD BIT(1)
60 #define PIR_MDC BIT(0)
62 #define ECMR_TRCCM BIT(26)
63 #define ECMR_RZPF BIT(20)
64 #define ECMR_PFR BIT(18)
65 #define ECMR_RXF BIT(17)
66 #define ECMR_RE BIT(6)
67 #define ECMR_TE BIT(5)
68 #define ECMR_DM BIT(1)
69 #define ECMR_CHG_DM (ECMR_TRCCM | ECMR_RZPF | ECMR_PFR | ECMR_RXF)
72 #define RAVB_NUM_BASE_DESC 16
73 #define RAVB_NUM_TX_DESC 8
74 #define RAVB_NUM_RX_DESC 8
76 #define RAVB_TX_QUEUE_OFFSET 0
77 #define RAVB_RX_QUEUE_OFFSET 4
79 #define RAVB_DESC_DT(n) ((n) << 28)
80 #define RAVB_DESC_DT_FSINGLE RAVB_DESC_DT(0x7)
81 #define RAVB_DESC_DT_LINKFIX RAVB_DESC_DT(0x9)
82 #define RAVB_DESC_DT_EOS RAVB_DESC_DT(0xa)
83 #define RAVB_DESC_DT_FEMPTY RAVB_DESC_DT(0xc)
84 #define RAVB_DESC_DT_EEMPTY RAVB_DESC_DT(0x3)
85 #define RAVB_DESC_DT_MASK RAVB_DESC_DT(0xf)
87 #define RAVB_DESC_DS(n) (((n) & 0xfff) << 0)
88 #define RAVB_DESC_DS_MASK 0xfff
90 #define RAVB_RX_DESC_MSC_MC BIT(23)
91 #define RAVB_RX_DESC_MSC_CEEF BIT(22)
92 #define RAVB_RX_DESC_MSC_CRL BIT(21)
93 #define RAVB_RX_DESC_MSC_FRE BIT(20)
94 #define RAVB_RX_DESC_MSC_RTLF BIT(19)
95 #define RAVB_RX_DESC_MSC_RTSF BIT(18)
96 #define RAVB_RX_DESC_MSC_RFE BIT(17)
97 #define RAVB_RX_DESC_MSC_CRC BIT(16)
98 #define RAVB_RX_DESC_MSC_MASK (0xff << 16)
100 #define RAVB_RX_DESC_MSC_RX_ERR_MASK \
101 (RAVB_RX_DESC_MSC_CRC | RAVB_RX_DESC_MSC_RFE | RAVB_RX_DESC_MSC_RTLF | \
102 RAVB_RX_DESC_MSC_RTSF | RAVB_RX_DESC_MSC_CEEF)
104 #define RAVB_TX_TIMEOUT_MS 1000
112 struct ravb_desc data;
113 struct ravb_desc link;
115 u8 packet[PKTSIZE_ALIGN];
119 struct ravb_desc base_desc[RAVB_NUM_BASE_DESC];
120 struct ravb_desc tx_desc[RAVB_NUM_TX_DESC];
121 struct ravb_rxdesc rx_desc[RAVB_NUM_RX_DESC];
125 struct phy_device *phydev;
127 void __iomem *iobase;
129 struct gpio_desc reset_gpio;
132 static inline void ravb_flush_dcache(u32 addr, u32 len)
134 flush_dcache_range(addr, addr + len);
137 static inline void ravb_invalidate_dcache(u32 addr, u32 len)
139 u32 start = addr & ~((uintptr_t)ARCH_DMA_MINALIGN - 1);
140 u32 end = roundup(addr + len, ARCH_DMA_MINALIGN);
141 invalidate_dcache_range(start, end);
144 static int ravb_send(struct udevice *dev, void *packet, int len)
146 struct ravb_priv *eth = dev_get_priv(dev);
147 struct ravb_desc *desc = ð->tx_desc[eth->tx_desc_idx];
150 /* Update TX descriptor */
151 ravb_flush_dcache((uintptr_t)packet, len);
152 memset(desc, 0x0, sizeof(*desc));
153 desc->ctrl = RAVB_DESC_DT_FSINGLE | RAVB_DESC_DS(len);
154 desc->dptr = (uintptr_t)packet;
155 ravb_flush_dcache((uintptr_t)desc, sizeof(*desc));
157 /* Restart the transmitter if disabled */
158 if (!(readl(eth->iobase + RAVB_REG_TCCR) & TCCR_TSRQ0))
159 setbits_le32(eth->iobase + RAVB_REG_TCCR, TCCR_TSRQ0);
161 /* Wait until packet is transmitted */
162 start = get_timer(0);
163 while (get_timer(start) < RAVB_TX_TIMEOUT_MS) {
164 ravb_invalidate_dcache((uintptr_t)desc, sizeof(*desc));
165 if ((desc->ctrl & RAVB_DESC_DT_MASK) != RAVB_DESC_DT_FSINGLE)
170 if (get_timer(start) >= RAVB_TX_TIMEOUT_MS)
173 eth->tx_desc_idx = (eth->tx_desc_idx + 1) % (RAVB_NUM_TX_DESC - 1);
177 static int ravb_recv(struct udevice *dev, int flags, uchar **packetp)
179 struct ravb_priv *eth = dev_get_priv(dev);
180 struct ravb_rxdesc *desc = ð->rx_desc[eth->rx_desc_idx];
184 /* Check if the rx descriptor is ready */
185 ravb_invalidate_dcache((uintptr_t)desc, sizeof(*desc));
186 if ((desc->data.ctrl & RAVB_DESC_DT_MASK) == RAVB_DESC_DT_FEMPTY)
189 /* Check for errors */
190 if (desc->data.ctrl & RAVB_RX_DESC_MSC_RX_ERR_MASK) {
191 desc->data.ctrl &= ~RAVB_RX_DESC_MSC_MASK;
195 len = desc->data.ctrl & RAVB_DESC_DS_MASK;
196 packet = (u8 *)(uintptr_t)desc->data.dptr;
197 ravb_invalidate_dcache((uintptr_t)packet, len);
203 static int ravb_free_pkt(struct udevice *dev, uchar *packet, int length)
205 struct ravb_priv *eth = dev_get_priv(dev);
206 struct ravb_rxdesc *desc = ð->rx_desc[eth->rx_desc_idx];
208 /* Make current descriptor available again */
209 desc->data.ctrl = RAVB_DESC_DT_FEMPTY | RAVB_DESC_DS(PKTSIZE_ALIGN);
210 ravb_flush_dcache((uintptr_t)desc, sizeof(*desc));
212 /* Point to the next descriptor */
213 eth->rx_desc_idx = (eth->rx_desc_idx + 1) % RAVB_NUM_RX_DESC;
214 desc = ð->rx_desc[eth->rx_desc_idx];
215 ravb_invalidate_dcache((uintptr_t)desc, sizeof(*desc));
220 static int ravb_reset(struct udevice *dev)
222 struct ravb_priv *eth = dev_get_priv(dev);
224 /* Set config mode */
225 writel(CCC_OPC_CONFIG, eth->iobase + RAVB_REG_CCC);
227 /* Check the operating mode is changed to the config mode. */
228 return wait_for_bit_le32(eth->iobase + RAVB_REG_CSR,
229 CSR_OPS_CONFIG, true, 100, true);
232 static void ravb_base_desc_init(struct ravb_priv *eth)
234 const u32 desc_size = RAVB_NUM_BASE_DESC * sizeof(struct ravb_desc);
237 /* Initialize all descriptors */
238 memset(eth->base_desc, 0x0, desc_size);
240 for (i = 0; i < RAVB_NUM_BASE_DESC; i++)
241 eth->base_desc[i].ctrl = RAVB_DESC_DT_EOS;
243 ravb_flush_dcache((uintptr_t)eth->base_desc, desc_size);
245 /* Register the descriptor base address table */
246 writel((uintptr_t)eth->base_desc, eth->iobase + RAVB_REG_DBAT);
249 static void ravb_tx_desc_init(struct ravb_priv *eth)
251 const u32 desc_size = RAVB_NUM_TX_DESC * sizeof(struct ravb_desc);
254 /* Initialize all descriptors */
255 memset(eth->tx_desc, 0x0, desc_size);
256 eth->tx_desc_idx = 0;
258 for (i = 0; i < RAVB_NUM_TX_DESC; i++)
259 eth->tx_desc[i].ctrl = RAVB_DESC_DT_EEMPTY;
261 /* Mark the end of the descriptors */
262 eth->tx_desc[RAVB_NUM_TX_DESC - 1].ctrl = RAVB_DESC_DT_LINKFIX;
263 eth->tx_desc[RAVB_NUM_TX_DESC - 1].dptr = (uintptr_t)eth->tx_desc;
264 ravb_flush_dcache((uintptr_t)eth->tx_desc, desc_size);
266 /* Point the controller to the TX descriptor list. */
267 eth->base_desc[RAVB_TX_QUEUE_OFFSET].ctrl = RAVB_DESC_DT_LINKFIX;
268 eth->base_desc[RAVB_TX_QUEUE_OFFSET].dptr = (uintptr_t)eth->tx_desc;
269 ravb_flush_dcache((uintptr_t)ð->base_desc[RAVB_TX_QUEUE_OFFSET],
270 sizeof(struct ravb_desc));
273 static void ravb_rx_desc_init(struct ravb_priv *eth)
275 const u32 desc_size = RAVB_NUM_RX_DESC * sizeof(struct ravb_rxdesc);
278 /* Initialize all descriptors */
279 memset(eth->rx_desc, 0x0, desc_size);
280 eth->rx_desc_idx = 0;
282 for (i = 0; i < RAVB_NUM_RX_DESC; i++) {
283 eth->rx_desc[i].data.ctrl = RAVB_DESC_DT_EEMPTY |
284 RAVB_DESC_DS(PKTSIZE_ALIGN);
285 eth->rx_desc[i].data.dptr = (uintptr_t)eth->rx_desc[i].packet;
287 eth->rx_desc[i].link.ctrl = RAVB_DESC_DT_LINKFIX;
288 eth->rx_desc[i].link.dptr = (uintptr_t)ð->rx_desc[i + 1];
291 /* Mark the end of the descriptors */
292 eth->rx_desc[RAVB_NUM_RX_DESC - 1].link.ctrl = RAVB_DESC_DT_LINKFIX;
293 eth->rx_desc[RAVB_NUM_RX_DESC - 1].link.dptr = (uintptr_t)eth->rx_desc;
294 ravb_flush_dcache((uintptr_t)eth->rx_desc, desc_size);
296 /* Point the controller to the rx descriptor list */
297 eth->base_desc[RAVB_RX_QUEUE_OFFSET].ctrl = RAVB_DESC_DT_LINKFIX;
298 eth->base_desc[RAVB_RX_QUEUE_OFFSET].dptr = (uintptr_t)eth->rx_desc;
299 ravb_flush_dcache((uintptr_t)ð->base_desc[RAVB_RX_QUEUE_OFFSET],
300 sizeof(struct ravb_desc));
303 static int ravb_phy_config(struct udevice *dev)
305 struct ravb_priv *eth = dev_get_priv(dev);
306 struct eth_pdata *pdata = dev_get_platdata(dev);
307 struct phy_device *phydev;
308 int mask = 0xffffffff, reg;
310 if (dm_gpio_is_valid(ð->reset_gpio)) {
311 dm_gpio_set_value(ð->reset_gpio, 1);
313 dm_gpio_set_value(ð->reset_gpio, 0);
317 phydev = phy_find_by_mask(eth->bus, mask, pdata->phy_interface);
321 phy_connect_dev(phydev, dev);
323 eth->phydev = phydev;
325 phydev->supported &= SUPPORTED_100baseT_Full |
326 SUPPORTED_1000baseT_Full | SUPPORTED_Autoneg |
327 SUPPORTED_TP | SUPPORTED_MII | SUPPORTED_Pause |
328 SUPPORTED_Asym_Pause;
330 if (pdata->max_speed != 1000) {
331 phydev->supported &= ~SUPPORTED_1000baseT_Full;
332 reg = phy_read(phydev, -1, MII_CTRL1000);
333 reg &= ~(BIT(9) | BIT(8));
334 phy_write(phydev, -1, MII_CTRL1000, reg);
342 /* Set Mac address */
343 static int ravb_write_hwaddr(struct udevice *dev)
345 struct ravb_priv *eth = dev_get_priv(dev);
346 struct eth_pdata *pdata = dev_get_platdata(dev);
347 unsigned char *mac = pdata->enetaddr;
349 writel((mac[0] << 24) | (mac[1] << 16) | (mac[2] << 8) | mac[3],
350 eth->iobase + RAVB_REG_MAHR);
352 writel((mac[4] << 8) | mac[5], eth->iobase + RAVB_REG_MALR);
357 /* E-MAC init function */
358 static int ravb_mac_init(struct ravb_priv *eth)
360 /* Disable MAC Interrupt */
361 writel(0, eth->iobase + RAVB_REG_ECSIPR);
363 /* Recv frame limit set register */
364 writel(RFLR_RFL_MIN, eth->iobase + RAVB_REG_RFLR);
369 /* AVB-DMAC init function */
370 static int ravb_dmac_init(struct udevice *dev)
372 struct ravb_priv *eth = dev_get_priv(dev);
373 struct eth_pdata *pdata = dev_get_platdata(dev);
376 /* Set CONFIG mode */
377 ret = ravb_reset(dev);
381 /* Disable all interrupts */
382 writel(0, eth->iobase + RAVB_REG_RIC0);
383 writel(0, eth->iobase + RAVB_REG_RIC1);
384 writel(0, eth->iobase + RAVB_REG_RIC2);
385 writel(0, eth->iobase + RAVB_REG_TIC);
387 /* Set little endian */
388 clrbits_le32(eth->iobase + RAVB_REG_CCC, CCC_BOC);
391 writel(0x18000001, eth->iobase + RAVB_REG_RCR);
394 writel(0x00222210, eth->iobase + RAVB_REG_TGC);
396 /* Delay CLK: 2ns (not applicable on R-Car E3/D3) */
397 if ((rmobile_get_cpu_type() == RMOBILE_CPU_TYPE_R8A77990) ||
398 (rmobile_get_cpu_type() == RMOBILE_CPU_TYPE_R8A77995))
401 if ((pdata->phy_interface == PHY_INTERFACE_MODE_RGMII_ID) ||
402 (pdata->phy_interface == PHY_INTERFACE_MODE_RGMII_TXID))
403 writel(APSR_TDM, eth->iobase + RAVB_REG_APSR);
408 static int ravb_config(struct udevice *dev)
410 struct ravb_priv *eth = dev_get_priv(dev);
411 struct phy_device *phy = eth->phydev;
412 u32 mask = ECMR_CHG_DM | ECMR_RE | ECMR_TE;
415 /* Configure AVB-DMAC register */
418 /* Configure E-MAC registers */
420 ravb_write_hwaddr(dev);
422 ret = phy_startup(phy);
426 /* Set the transfer speed */
427 if (phy->speed == 100)
428 writel(0, eth->iobase + RAVB_REG_GECMR);
429 else if (phy->speed == 1000)
430 writel(1, eth->iobase + RAVB_REG_GECMR);
432 /* Check if full duplex mode is supported by the phy */
436 writel(mask, eth->iobase + RAVB_REG_ECMR);
438 phy->drv->writeext(phy, -1, 0x02, 0x08, (0x0f << 5) | 0x19);
443 static int ravb_start(struct udevice *dev)
445 struct ravb_priv *eth = dev_get_priv(dev);
448 ret = ravb_reset(dev);
452 ravb_base_desc_init(eth);
453 ravb_tx_desc_init(eth);
454 ravb_rx_desc_init(eth);
456 ret = ravb_config(dev);
460 /* Setting the control will start the AVB-DMAC process. */
461 writel(CCC_OPC_OPERATION, eth->iobase + RAVB_REG_CCC);
466 static void ravb_stop(struct udevice *dev)
468 struct ravb_priv *eth = dev_get_priv(dev);
470 phy_shutdown(eth->phydev);
474 static int ravb_probe(struct udevice *dev)
476 struct eth_pdata *pdata = dev_get_platdata(dev);
477 struct ravb_priv *eth = dev_get_priv(dev);
478 struct ofnode_phandle_args phandle_args;
479 struct mii_dev *mdiodev;
480 void __iomem *iobase;
483 iobase = map_physmem(pdata->iobase, 0x1000, MAP_NOCACHE);
484 eth->iobase = iobase;
486 ret = clk_get_by_index(dev, 0, ð->clk);
490 ret = dev_read_phandle_with_args(dev, "phy-handle", NULL, 0, 0, &phandle_args);
492 gpio_request_by_name_nodev(phandle_args.node, "reset-gpios", 0,
493 ð->reset_gpio, GPIOD_IS_OUT);
496 if (!dm_gpio_is_valid(ð->reset_gpio)) {
497 gpio_request_by_name(dev, "reset-gpios", 0, ð->reset_gpio,
501 mdiodev = mdio_alloc();
507 mdiodev->read = bb_miiphy_read;
508 mdiodev->write = bb_miiphy_write;
509 bb_miiphy_buses[0].priv = eth;
510 snprintf(mdiodev->name, sizeof(mdiodev->name), dev->name);
512 ret = mdio_register(mdiodev);
514 goto err_mdio_register;
516 eth->bus = miiphy_get_dev_by_name(dev->name);
519 ret = clk_enable(ð->clk);
521 goto err_mdio_register;
523 ret = ravb_reset(dev);
527 ret = ravb_phy_config(dev);
534 clk_disable(ð->clk);
538 unmap_physmem(eth->iobase, MAP_NOCACHE);
542 static int ravb_remove(struct udevice *dev)
544 struct ravb_priv *eth = dev_get_priv(dev);
546 clk_disable(ð->clk);
549 mdio_unregister(eth->bus);
551 if (dm_gpio_is_valid(ð->reset_gpio))
552 dm_gpio_free(dev, ð->reset_gpio);
553 unmap_physmem(eth->iobase, MAP_NOCACHE);
558 int ravb_bb_init(struct bb_miiphy_bus *bus)
563 int ravb_bb_mdio_active(struct bb_miiphy_bus *bus)
565 struct ravb_priv *eth = bus->priv;
567 setbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MMD);
572 int ravb_bb_mdio_tristate(struct bb_miiphy_bus *bus)
574 struct ravb_priv *eth = bus->priv;
576 clrbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MMD);
581 int ravb_bb_set_mdio(struct bb_miiphy_bus *bus, int v)
583 struct ravb_priv *eth = bus->priv;
586 setbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDO);
588 clrbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDO);
593 int ravb_bb_get_mdio(struct bb_miiphy_bus *bus, int *v)
595 struct ravb_priv *eth = bus->priv;
597 *v = (readl(eth->iobase + RAVB_REG_PIR) & PIR_MDI) >> 3;
602 int ravb_bb_set_mdc(struct bb_miiphy_bus *bus, int v)
604 struct ravb_priv *eth = bus->priv;
607 setbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDC);
609 clrbits_le32(eth->iobase + RAVB_REG_PIR, PIR_MDC);
614 int ravb_bb_delay(struct bb_miiphy_bus *bus)
621 struct bb_miiphy_bus bb_miiphy_buses[] = {
624 .init = ravb_bb_init,
625 .mdio_active = ravb_bb_mdio_active,
626 .mdio_tristate = ravb_bb_mdio_tristate,
627 .set_mdio = ravb_bb_set_mdio,
628 .get_mdio = ravb_bb_get_mdio,
629 .set_mdc = ravb_bb_set_mdc,
630 .delay = ravb_bb_delay,
633 int bb_miiphy_buses_num = ARRAY_SIZE(bb_miiphy_buses);
635 static const struct eth_ops ravb_ops = {
639 .free_pkt = ravb_free_pkt,
641 .write_hwaddr = ravb_write_hwaddr,
644 int ravb_ofdata_to_platdata(struct udevice *dev)
646 struct eth_pdata *pdata = dev_get_platdata(dev);
647 const char *phy_mode;
651 pdata->iobase = devfdt_get_addr(dev);
652 pdata->phy_interface = -1;
653 phy_mode = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), "phy-mode",
656 pdata->phy_interface = phy_get_interface_by_name(phy_mode);
657 if (pdata->phy_interface == -1) {
658 debug("%s: Invalid PHY interface '%s'\n", __func__, phy_mode);
662 pdata->max_speed = 1000;
663 cell = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), "max-speed", NULL);
665 pdata->max_speed = fdt32_to_cpu(*cell);
667 sprintf(bb_miiphy_buses[0].name, dev->name);
672 static const struct udevice_id ravb_ids[] = {
673 { .compatible = "renesas,etheravb-r8a7795" },
674 { .compatible = "renesas,etheravb-r8a7796" },
675 { .compatible = "renesas,etheravb-r8a77965" },
676 { .compatible = "renesas,etheravb-r8a77970" },
677 { .compatible = "renesas,etheravb-r8a77990" },
678 { .compatible = "renesas,etheravb-r8a77995" },
679 { .compatible = "renesas,etheravb-rcar-gen3" },
683 U_BOOT_DRIVER(eth_ravb) = {
686 .of_match = ravb_ids,
687 .ofdata_to_platdata = ravb_ofdata_to_platdata,
689 .remove = ravb_remove,
691 .priv_auto_alloc_size = sizeof(struct ravb_priv),
692 .platdata_auto_alloc_size = sizeof(struct eth_pdata),
693 .flags = DM_FLAG_ALLOC_PRIV_DMA,