1 // SPDX-License-Identifier: GPL-2.0
3 * Opencore 10/100 ethernet mac driver
5 * Copyright (C) 2007-2008 Avionic Design Development GmbH
6 * Copyright (C) 2008-2009 Avionic Design GmbH
7 * Thierry Reding <thierry.reding@avionic-design.de>
8 * Copyright (C) 2010 Thomas Chou <thomas@wytron.com.tw>
9 * Copyright (C) 2016 Cadence Design Systems Inc.
14 #include <dm/platform_data/net_ethoc.h>
19 #include <asm/cache.h>
22 /* register offsets */
24 #define INT_SOURCE 0x04
29 #define PACKETLEN 0x18
31 #define TX_BD_NUM 0x20
32 #define CTRLMODER 0x24
34 #define MIICOMMAND 0x2c
35 #define MIIADDRESS 0x30
36 #define MIITX_DATA 0x34
37 #define MIIRX_DATA 0x38
38 #define MIISTATUS 0x3c
39 #define MAC_ADDR0 0x40
40 #define MAC_ADDR1 0x44
41 #define ETH_HASH0 0x48
42 #define ETH_HASH1 0x4c
43 #define ETH_TXCTRL 0x50
46 #define MODER_RXEN (1 << 0) /* receive enable */
47 #define MODER_TXEN (1 << 1) /* transmit enable */
48 #define MODER_NOPRE (1 << 2) /* no preamble */
49 #define MODER_BRO (1 << 3) /* broadcast address */
50 #define MODER_IAM (1 << 4) /* individual address mode */
51 #define MODER_PRO (1 << 5) /* promiscuous mode */
52 #define MODER_IFG (1 << 6) /* interframe gap for incoming frames */
53 #define MODER_LOOP (1 << 7) /* loopback */
54 #define MODER_NBO (1 << 8) /* no back-off */
55 #define MODER_EDE (1 << 9) /* excess defer enable */
56 #define MODER_FULLD (1 << 10) /* full duplex */
57 #define MODER_RESET (1 << 11) /* FIXME: reset (undocumented) */
58 #define MODER_DCRC (1 << 12) /* delayed CRC enable */
59 #define MODER_CRC (1 << 13) /* CRC enable */
60 #define MODER_HUGE (1 << 14) /* huge packets enable */
61 #define MODER_PAD (1 << 15) /* padding enabled */
62 #define MODER_RSM (1 << 16) /* receive small packets */
64 /* interrupt source and mask registers */
65 #define INT_MASK_TXF (1 << 0) /* transmit frame */
66 #define INT_MASK_TXE (1 << 1) /* transmit error */
67 #define INT_MASK_RXF (1 << 2) /* receive frame */
68 #define INT_MASK_RXE (1 << 3) /* receive error */
69 #define INT_MASK_BUSY (1 << 4)
70 #define INT_MASK_TXC (1 << 5) /* transmit control frame */
71 #define INT_MASK_RXC (1 << 6) /* receive control frame */
73 #define INT_MASK_TX (INT_MASK_TXF | INT_MASK_TXE)
74 #define INT_MASK_RX (INT_MASK_RXF | INT_MASK_RXE)
76 #define INT_MASK_ALL ( \
77 INT_MASK_TXF | INT_MASK_TXE | \
78 INT_MASK_RXF | INT_MASK_RXE | \
79 INT_MASK_TXC | INT_MASK_RXC | \
83 /* packet length register */
84 #define PACKETLEN_MIN(min) (((min) & 0xffff) << 16)
85 #define PACKETLEN_MAX(max) (((max) & 0xffff) << 0)
86 #define PACKETLEN_MIN_MAX(min, max) (PACKETLEN_MIN(min) | \
89 /* transmit buffer number register */
90 #define TX_BD_NUM_VAL(x) (((x) <= 0x80) ? (x) : 0x80)
92 /* control module mode register */
93 #define CTRLMODER_PASSALL (1 << 0) /* pass all receive frames */
94 #define CTRLMODER_RXFLOW (1 << 1) /* receive control flow */
95 #define CTRLMODER_TXFLOW (1 << 2) /* transmit control flow */
97 /* MII mode register */
98 #define MIIMODER_CLKDIV(x) ((x) & 0xfe) /* needs to be an even number */
99 #define MIIMODER_NOPRE (1 << 8) /* no preamble */
101 /* MII command register */
102 #define MIICOMMAND_SCAN (1 << 0) /* scan status */
103 #define MIICOMMAND_READ (1 << 1) /* read status */
104 #define MIICOMMAND_WRITE (1 << 2) /* write control data */
106 /* MII address register */
107 #define MIIADDRESS_FIAD(x) (((x) & 0x1f) << 0)
108 #define MIIADDRESS_RGAD(x) (((x) & 0x1f) << 8)
109 #define MIIADDRESS_ADDR(phy, reg) (MIIADDRESS_FIAD(phy) | \
110 MIIADDRESS_RGAD(reg))
112 /* MII transmit data register */
113 #define MIITX_DATA_VAL(x) ((x) & 0xffff)
115 /* MII receive data register */
116 #define MIIRX_DATA_VAL(x) ((x) & 0xffff)
118 /* MII status register */
119 #define MIISTATUS_LINKFAIL (1 << 0)
120 #define MIISTATUS_BUSY (1 << 1)
121 #define MIISTATUS_INVALID (1 << 2)
123 /* TX buffer descriptor */
124 #define TX_BD_CS (1 << 0) /* carrier sense lost */
125 #define TX_BD_DF (1 << 1) /* defer indication */
126 #define TX_BD_LC (1 << 2) /* late collision */
127 #define TX_BD_RL (1 << 3) /* retransmission limit */
128 #define TX_BD_RETRY_MASK (0x00f0)
129 #define TX_BD_RETRY(x) (((x) & 0x00f0) >> 4)
130 #define TX_BD_UR (1 << 8) /* transmitter underrun */
131 #define TX_BD_CRC (1 << 11) /* TX CRC enable */
132 #define TX_BD_PAD (1 << 12) /* pad enable */
133 #define TX_BD_WRAP (1 << 13)
134 #define TX_BD_IRQ (1 << 14) /* interrupt request enable */
135 #define TX_BD_READY (1 << 15) /* TX buffer ready */
136 #define TX_BD_LEN(x) (((x) & 0xffff) << 16)
137 #define TX_BD_LEN_MASK (0xffff << 16)
139 #define TX_BD_STATS (TX_BD_CS | TX_BD_DF | TX_BD_LC | \
140 TX_BD_RL | TX_BD_RETRY_MASK | TX_BD_UR)
142 /* RX buffer descriptor */
143 #define RX_BD_LC (1 << 0) /* late collision */
144 #define RX_BD_CRC (1 << 1) /* RX CRC error */
145 #define RX_BD_SF (1 << 2) /* short frame */
146 #define RX_BD_TL (1 << 3) /* too long */
147 #define RX_BD_DN (1 << 4) /* dribble nibble */
148 #define RX_BD_IS (1 << 5) /* invalid symbol */
149 #define RX_BD_OR (1 << 6) /* receiver overrun */
150 #define RX_BD_MISS (1 << 7)
151 #define RX_BD_CF (1 << 8) /* control frame */
152 #define RX_BD_WRAP (1 << 13)
153 #define RX_BD_IRQ (1 << 14) /* interrupt request enable */
154 #define RX_BD_EMPTY (1 << 15)
155 #define RX_BD_LEN(x) (((x) & 0xffff) << 16)
157 #define RX_BD_STATS (RX_BD_LC | RX_BD_CRC | RX_BD_SF | RX_BD_TL | \
158 RX_BD_DN | RX_BD_IS | RX_BD_OR | RX_BD_MISS)
160 #define ETHOC_BUFSIZ 1536
161 #define ETHOC_ZLEN 64
162 #define ETHOC_BD_BASE 0x400
163 #define ETHOC_TIMEOUT (HZ / 2)
164 #define ETHOC_MII_TIMEOUT (1 + (HZ / 5))
165 #define ETHOC_IOSIZE 0x54
168 * struct ethoc - driver-private device structure
169 * @num_tx: number of send buffers
170 * @cur_tx: last send buffer written
171 * @dty_tx: last buffer actually sent
172 * @num_rx: number of receive buffers
173 * @cur_rx: current receive buffer
181 void __iomem *iobase;
182 void __iomem *packet;
183 phys_addr_t packet_phys;
187 struct phy_device *phydev;
192 * struct ethoc_bd - buffer descriptor
193 * @stat: buffer statistics
194 * @addr: physical memory address
201 static inline u32 *ethoc_reg(struct ethoc *priv, size_t offset)
203 return priv->iobase + offset;
206 static inline u32 ethoc_read(struct ethoc *priv, size_t offset)
208 return readl(ethoc_reg(priv, offset));
211 static inline void ethoc_write(struct ethoc *priv, size_t offset, u32 data)
213 writel(data, ethoc_reg(priv, offset));
216 static inline void ethoc_read_bd(struct ethoc *priv, int index,
219 size_t offset = ETHOC_BD_BASE + (index * sizeof(struct ethoc_bd));
220 bd->stat = ethoc_read(priv, offset + 0);
221 bd->addr = ethoc_read(priv, offset + 4);
224 static inline void ethoc_write_bd(struct ethoc *priv, int index,
225 const struct ethoc_bd *bd)
227 size_t offset = ETHOC_BD_BASE + (index * sizeof(struct ethoc_bd));
228 ethoc_write(priv, offset + 0, bd->stat);
229 ethoc_write(priv, offset + 4, bd->addr);
232 static int ethoc_write_hwaddr_common(struct ethoc *priv, u8 *mac)
234 ethoc_write(priv, MAC_ADDR0, (mac[2] << 24) | (mac[3] << 16) |
235 (mac[4] << 8) | (mac[5] << 0));
236 ethoc_write(priv, MAC_ADDR1, (mac[0] << 8) | (mac[1] << 0));
240 static inline void ethoc_ack_irq(struct ethoc *priv, u32 mask)
242 ethoc_write(priv, INT_SOURCE, mask);
245 static inline void ethoc_enable_rx_and_tx(struct ethoc *priv)
247 u32 mode = ethoc_read(priv, MODER);
248 mode |= MODER_RXEN | MODER_TXEN;
249 ethoc_write(priv, MODER, mode);
252 static inline void ethoc_disable_rx_and_tx(struct ethoc *priv)
254 u32 mode = ethoc_read(priv, MODER);
255 mode &= ~(MODER_RXEN | MODER_TXEN);
256 ethoc_write(priv, MODER, mode);
259 static int ethoc_init_ring(struct ethoc *priv)
262 phys_addr_t addr = priv->packet_phys;
269 /* setup transmission buffers */
270 bd.stat = TX_BD_IRQ | TX_BD_CRC;
273 for (i = 0; i < priv->num_tx; i++) {
276 addr += PKTSIZE_ALIGN;
278 if (i == priv->num_tx - 1)
279 bd.stat |= TX_BD_WRAP;
281 ethoc_write_bd(priv, i, &bd);
284 bd.stat = RX_BD_EMPTY | RX_BD_IRQ;
286 for (i = 0; i < priv->num_rx; i++) {
289 addr += PKTSIZE_ALIGN;
291 bd.addr = virt_to_phys(net_rx_packets[i]);
293 if (i == priv->num_rx - 1)
294 bd.stat |= RX_BD_WRAP;
296 flush_dcache_range((ulong)net_rx_packets[i],
297 (ulong)net_rx_packets[i] + PKTSIZE_ALIGN);
298 ethoc_write_bd(priv, priv->num_tx + i, &bd);
304 static int ethoc_reset(struct ethoc *priv)
308 /* TODO: reset controller? */
310 ethoc_disable_rx_and_tx(priv);
312 /* TODO: setup registers */
314 /* enable FCS generation and automatic padding */
315 mode = ethoc_read(priv, MODER);
316 mode |= MODER_CRC | MODER_PAD;
317 ethoc_write(priv, MODER, mode);
319 /* set full-duplex mode */
320 mode = ethoc_read(priv, MODER);
322 ethoc_write(priv, MODER, mode);
323 ethoc_write(priv, IPGT, 0x15);
325 ethoc_ack_irq(priv, INT_MASK_ALL);
326 ethoc_enable_rx_and_tx(priv);
330 static int ethoc_init_common(struct ethoc *priv)
335 priv->num_rx = PKTBUFSRX;
336 ethoc_write(priv, TX_BD_NUM, priv->num_tx);
337 ethoc_init_ring(priv);
341 ret = phy_startup(priv->phydev);
343 printf("Could not initialize PHY %s\n",
344 priv->phydev->dev->name);
351 static void ethoc_stop_common(struct ethoc *priv)
353 ethoc_disable_rx_and_tx(priv);
355 phy_shutdown(priv->phydev);
359 static int ethoc_update_rx_stats(struct ethoc_bd *bd)
363 if (bd->stat & RX_BD_TL) {
364 debug("ETHOC: " "RX: frame too long\n");
368 if (bd->stat & RX_BD_SF) {
369 debug("ETHOC: " "RX: frame too short\n");
373 if (bd->stat & RX_BD_DN)
374 debug("ETHOC: " "RX: dribble nibble\n");
376 if (bd->stat & RX_BD_CRC) {
377 debug("ETHOC: " "RX: wrong CRC\n");
381 if (bd->stat & RX_BD_OR) {
382 debug("ETHOC: " "RX: overrun\n");
386 if (bd->stat & RX_BD_LC) {
387 debug("ETHOC: " "RX: late collision\n");
394 static int ethoc_rx_common(struct ethoc *priv, uchar **packetp)
397 u32 i = priv->cur_rx % priv->num_rx;
398 u32 entry = priv->num_tx + i;
400 ethoc_read_bd(priv, entry, &bd);
401 if (bd.stat & RX_BD_EMPTY)
404 debug("%s(): RX buffer %d, %x received\n",
405 __func__, priv->cur_rx, bd.stat);
406 if (ethoc_update_rx_stats(&bd) == 0) {
407 int size = bd.stat >> 16;
409 size -= 4; /* strip the CRC */
411 *packetp = priv->packet + entry * PKTSIZE_ALIGN;
413 *packetp = net_rx_packets[i];
420 static int ethoc_is_new_packet_received(struct ethoc *priv)
424 pending = ethoc_read(priv, INT_SOURCE);
425 ethoc_ack_irq(priv, pending);
426 if (pending & INT_MASK_BUSY)
427 debug("%s(): packet dropped\n", __func__);
428 if (pending & INT_MASK_RX) {
429 debug("%s(): rx irq\n", __func__);
436 static int ethoc_update_tx_stats(struct ethoc_bd *bd)
438 if (bd->stat & TX_BD_LC)
439 debug("ETHOC: " "TX: late collision\n");
441 if (bd->stat & TX_BD_RL)
442 debug("ETHOC: " "TX: retransmit limit\n");
444 if (bd->stat & TX_BD_UR)
445 debug("ETHOC: " "TX: underrun\n");
447 if (bd->stat & TX_BD_CS)
448 debug("ETHOC: " "TX: carrier sense lost\n");
453 static void ethoc_tx(struct ethoc *priv)
455 u32 entry = priv->dty_tx % priv->num_tx;
458 ethoc_read_bd(priv, entry, &bd);
459 if ((bd.stat & TX_BD_READY) == 0)
460 (void)ethoc_update_tx_stats(&bd);
463 static int ethoc_send_common(struct ethoc *priv, void *packet, int length)
470 entry = priv->cur_tx % priv->num_tx;
471 ethoc_read_bd(priv, entry, &bd);
472 if (unlikely(length < ETHOC_ZLEN))
473 bd.stat |= TX_BD_PAD;
475 bd.stat &= ~TX_BD_PAD;
478 void *p = priv->packet + entry * PKTSIZE_ALIGN;
480 memcpy(p, packet, length);
483 bd.addr = virt_to_phys(packet);
485 flush_dcache_range((ulong)packet, (ulong)packet + length);
486 bd.stat &= ~(TX_BD_STATS | TX_BD_LEN_MASK);
487 bd.stat |= TX_BD_LEN(length);
488 ethoc_write_bd(priv, entry, &bd);
491 bd.stat |= TX_BD_READY;
492 ethoc_write_bd(priv, entry, &bd);
494 /* wait for transfer to succeed */
495 tmo = get_timer(0) + 5 * CONFIG_SYS_HZ;
497 pending = ethoc_read(priv, INT_SOURCE);
498 ethoc_ack_irq(priv, pending & ~INT_MASK_RX);
499 if (pending & INT_MASK_BUSY)
500 debug("%s(): packet dropped\n", __func__);
502 if (pending & INT_MASK_TX) {
506 if (get_timer(0) >= tmo) {
507 debug("%s(): timed out\n", __func__);
512 debug("%s(): packet sent\n", __func__);
516 static int ethoc_free_pkt_common(struct ethoc *priv)
519 u32 i = priv->cur_rx % priv->num_rx;
520 u32 entry = priv->num_tx + i;
523 ethoc_read_bd(priv, entry, &bd);
526 src = priv->packet + entry * PKTSIZE_ALIGN;
528 src = net_rx_packets[i];
529 /* clear the buffer descriptor so it can be reused */
530 flush_dcache_range((ulong)src,
531 (ulong)src + PKTSIZE_ALIGN);
532 bd.stat &= ~RX_BD_STATS;
533 bd.stat |= RX_BD_EMPTY;
534 ethoc_write_bd(priv, entry, &bd);
542 static int ethoc_mdio_read(struct mii_dev *bus, int addr, int devad, int reg)
544 struct ethoc *priv = bus->priv;
547 ethoc_write(priv, MIIADDRESS, MIIADDRESS_ADDR(addr, reg));
548 ethoc_write(priv, MIICOMMAND, MIICOMMAND_READ);
550 rc = wait_for_bit_le32(ethoc_reg(priv, MIISTATUS),
551 MIISTATUS_BUSY, false, CONFIG_SYS_HZ, false);
554 u32 data = ethoc_read(priv, MIIRX_DATA);
556 /* reset MII command register */
557 ethoc_write(priv, MIICOMMAND, 0);
563 static int ethoc_mdio_write(struct mii_dev *bus, int addr, int devad, int reg,
566 struct ethoc *priv = bus->priv;
569 ethoc_write(priv, MIIADDRESS, MIIADDRESS_ADDR(addr, reg));
570 ethoc_write(priv, MIITX_DATA, val);
571 ethoc_write(priv, MIICOMMAND, MIICOMMAND_WRITE);
573 rc = wait_for_bit_le32(ethoc_reg(priv, MIISTATUS),
574 MIISTATUS_BUSY, false, CONFIG_SYS_HZ, false);
577 /* reset MII command register */
578 ethoc_write(priv, MIICOMMAND, 0);
583 static int ethoc_mdio_init(const char *name, struct ethoc *priv)
585 struct mii_dev *bus = mdio_alloc();
589 printf("Failed to allocate MDIO bus\n");
593 bus->read = ethoc_mdio_read;
594 bus->write = ethoc_mdio_write;
595 snprintf(bus->name, sizeof(bus->name), "%s", name);
598 ret = mdio_register(bus);
602 priv->bus = miiphy_get_dev_by_name(name);
606 static int ethoc_phy_init(struct ethoc *priv, void *dev)
608 struct phy_device *phydev;
609 int mask = 0xffffffff;
611 #ifdef CONFIG_PHY_ADDR
612 mask = 1 << CONFIG_PHY_ADDR;
615 phydev = phy_find_by_mask(priv->bus, mask, PHY_INTERFACE_MODE_MII);
619 phy_connect_dev(phydev, dev);
621 phydev->supported &= PHY_BASIC_FEATURES;
622 phydev->advertising = phydev->supported;
624 priv->phydev = phydev;
632 static inline int ethoc_mdio_init(const char *name, struct ethoc *priv)
637 static inline int ethoc_phy_init(struct ethoc *priv, void *dev)
646 static int ethoc_write_hwaddr(struct udevice *dev)
648 struct ethoc_eth_pdata *pdata = dev_get_platdata(dev);
649 struct ethoc *priv = dev_get_priv(dev);
650 u8 *mac = pdata->eth_pdata.enetaddr;
652 return ethoc_write_hwaddr_common(priv, mac);
655 static int ethoc_send(struct udevice *dev, void *packet, int length)
657 return ethoc_send_common(dev_get_priv(dev), packet, length);
660 static int ethoc_free_pkt(struct udevice *dev, uchar *packet, int length)
662 return ethoc_free_pkt_common(dev_get_priv(dev));
665 static int ethoc_recv(struct udevice *dev, int flags, uchar **packetp)
667 struct ethoc *priv = dev_get_priv(dev);
669 if (flags & ETH_RECV_CHECK_DEVICE)
670 if (!ethoc_is_new_packet_received(priv))
673 return ethoc_rx_common(priv, packetp);
676 static int ethoc_start(struct udevice *dev)
678 return ethoc_init_common(dev_get_priv(dev));
681 static void ethoc_stop(struct udevice *dev)
683 ethoc_stop_common(dev_get_priv(dev));
686 static int ethoc_ofdata_to_platdata(struct udevice *dev)
688 struct ethoc_eth_pdata *pdata = dev_get_platdata(dev);
691 pdata->eth_pdata.iobase = devfdt_get_addr(dev);
692 addr = devfdt_get_addr_index(dev, 1);
693 if (addr != FDT_ADDR_T_NONE)
694 pdata->packet_base = addr;
698 static int ethoc_probe(struct udevice *dev)
700 struct ethoc_eth_pdata *pdata = dev_get_platdata(dev);
701 struct ethoc *priv = dev_get_priv(dev);
703 priv->iobase = ioremap(pdata->eth_pdata.iobase, ETHOC_IOSIZE);
704 if (pdata->packet_base) {
705 priv->packet_phys = pdata->packet_base;
706 priv->packet = ioremap(pdata->packet_base,
707 (1 + PKTBUFSRX) * PKTSIZE_ALIGN);
710 ethoc_mdio_init(dev->name, priv);
711 ethoc_phy_init(priv, dev);
716 static int ethoc_remove(struct udevice *dev)
718 struct ethoc *priv = dev_get_priv(dev);
722 mdio_unregister(priv->bus);
723 mdio_free(priv->bus);
725 iounmap(priv->iobase);
729 static const struct eth_ops ethoc_ops = {
730 .start = ethoc_start,
734 .free_pkt = ethoc_free_pkt,
735 .write_hwaddr = ethoc_write_hwaddr,
738 static const struct udevice_id ethoc_ids[] = {
739 { .compatible = "opencores,ethoc" },
743 U_BOOT_DRIVER(ethoc) = {
746 .of_match = ethoc_ids,
747 .ofdata_to_platdata = ethoc_ofdata_to_platdata,
748 .probe = ethoc_probe,
749 .remove = ethoc_remove,
751 .priv_auto_alloc_size = sizeof(struct ethoc),
752 .platdata_auto_alloc_size = sizeof(struct ethoc_eth_pdata),
757 static int ethoc_init(struct eth_device *dev, bd_t *bd)
759 struct ethoc *priv = (struct ethoc *)dev->priv;
761 return ethoc_init_common(priv);
764 static int ethoc_write_hwaddr(struct eth_device *dev)
766 struct ethoc *priv = (struct ethoc *)dev->priv;
767 u8 *mac = dev->enetaddr;
769 return ethoc_write_hwaddr_common(priv, mac);
772 static int ethoc_send(struct eth_device *dev, void *packet, int length)
774 return ethoc_send_common(dev->priv, packet, length);
777 static void ethoc_halt(struct eth_device *dev)
779 ethoc_disable_rx_and_tx(dev->priv);
782 static int ethoc_recv(struct eth_device *dev)
784 struct ethoc *priv = (struct ethoc *)dev->priv;
787 if (!ethoc_is_new_packet_received(priv))
790 for (count = 0; count < PKTBUFSRX; ++count) {
792 int size = ethoc_rx_common(priv, &packetp);
797 net_process_received_packet(packetp, size);
798 ethoc_free_pkt_common(priv);
803 int ethoc_initialize(u8 dev_num, int base_addr)
806 struct eth_device *dev;
808 priv = malloc(sizeof(*priv));
811 dev = malloc(sizeof(*dev));
817 memset(dev, 0, sizeof(*dev));
819 dev->iobase = base_addr;
820 dev->init = ethoc_init;
821 dev->halt = ethoc_halt;
822 dev->send = ethoc_send;
823 dev->recv = ethoc_recv;
824 dev->write_hwaddr = ethoc_write_hwaddr;
825 sprintf(dev->name, "%s-%hu", "ETHOC", dev_num);
826 priv->iobase = ioremap(dev->iobase, ETHOC_IOSIZE);
830 ethoc_mdio_init(dev->name, priv);
831 ethoc_phy_init(priv, dev);