Merge tag 'u-boot-imx-20191009' of https://gitlab.denx.de/u-boot/custodians/u-boot-imx
[oweals/u-boot.git] / drivers / net / macb.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (C) 2005-2006 Atmel Corporation
4  */
5 #include <common.h>
6 #include <clk.h>
7 #include <dm.h>
8
9 /*
10  * The u-boot networking stack is a little weird.  It seems like the
11  * networking core allocates receive buffers up front without any
12  * regard to the hardware that's supposed to actually receive those
13  * packets.
14  *
15  * The MACB receives packets into 128-byte receive buffers, so the
16  * buffers allocated by the core isn't very practical to use.  We'll
17  * allocate our own, but we need one such buffer in case a packet
18  * wraps around the DMA ring so that we have to copy it.
19  *
20  * Therefore, define CONFIG_SYS_RX_ETH_BUFFER to 1 in the board-specific
21  * configuration header.  This way, the core allocates one RX buffer
22  * and one TX buffer, each of which can hold a ethernet packet of
23  * maximum size.
24  *
25  * For some reason, the networking core unconditionally specifies a
26  * 32-byte packet "alignment" (which really should be called
27  * "padding").  MACB shouldn't need that, but we'll refrain from any
28  * core modifications here...
29  */
30
31 #include <net.h>
32 #ifndef CONFIG_DM_ETH
33 #include <netdev.h>
34 #endif
35 #include <malloc.h>
36 #include <miiphy.h>
37
38 #include <linux/mii.h>
39 #include <asm/io.h>
40 #include <asm/dma-mapping.h>
41 #include <asm/arch/clk.h>
42 #include <linux/errno.h>
43
44 #include "macb.h"
45
46 DECLARE_GLOBAL_DATA_PTR;
47
48 /*
49  * These buffer sizes must be power of 2 and divisible
50  * by RX_BUFFER_MULTIPLE
51  */
52 #define MACB_RX_BUFFER_SIZE             128
53 #define GEM_RX_BUFFER_SIZE              2048
54 #define RX_BUFFER_MULTIPLE              64
55
56 #define MACB_RX_RING_SIZE               32
57 #define MACB_TX_RING_SIZE               16
58
59 #define MACB_TX_TIMEOUT         1000
60 #define MACB_AUTONEG_TIMEOUT    5000000
61
62 #ifdef CONFIG_MACB_ZYNQ
63 /* INCR4 AHB bursts */
64 #define MACB_ZYNQ_GEM_DMACR_BLENGTH             0x00000004
65 /* Use full configured addressable space (8 Kb) */
66 #define MACB_ZYNQ_GEM_DMACR_RXSIZE              0x00000300
67 /* Use full configured addressable space (4 Kb) */
68 #define MACB_ZYNQ_GEM_DMACR_TXSIZE              0x00000400
69 /* Set RXBUF with use of 128 byte */
70 #define MACB_ZYNQ_GEM_DMACR_RXBUF               0x00020000
71 #define MACB_ZYNQ_GEM_DMACR_INIT \
72                                 (MACB_ZYNQ_GEM_DMACR_BLENGTH | \
73                                 MACB_ZYNQ_GEM_DMACR_RXSIZE | \
74                                 MACB_ZYNQ_GEM_DMACR_TXSIZE | \
75                                 MACB_ZYNQ_GEM_DMACR_RXBUF)
76 #endif
77
78 struct macb_dma_desc {
79         u32     addr;
80         u32     ctrl;
81 };
82
83 #define DMA_DESC_BYTES(n)       (n * sizeof(struct macb_dma_desc))
84 #define MACB_TX_DMA_DESC_SIZE   (DMA_DESC_BYTES(MACB_TX_RING_SIZE))
85 #define MACB_RX_DMA_DESC_SIZE   (DMA_DESC_BYTES(MACB_RX_RING_SIZE))
86 #define MACB_TX_DUMMY_DMA_DESC_SIZE     (DMA_DESC_BYTES(1))
87
88 #define RXBUF_FRMLEN_MASK       0x00000fff
89 #define TXBUF_FRMLEN_MASK       0x000007ff
90
91 struct macb_device {
92         void                    *regs;
93
94         bool                    is_big_endian;
95
96         const struct macb_config *config;
97
98         unsigned int            rx_tail;
99         unsigned int            tx_head;
100         unsigned int            tx_tail;
101         unsigned int            next_rx_tail;
102         bool                    wrapped;
103
104         void                    *rx_buffer;
105         void                    *tx_buffer;
106         struct macb_dma_desc    *rx_ring;
107         struct macb_dma_desc    *tx_ring;
108         size_t                  rx_buffer_size;
109
110         unsigned long           rx_buffer_dma;
111         unsigned long           rx_ring_dma;
112         unsigned long           tx_ring_dma;
113
114         struct macb_dma_desc    *dummy_desc;
115         unsigned long           dummy_desc_dma;
116
117         const struct device     *dev;
118 #ifndef CONFIG_DM_ETH
119         struct eth_device       netdev;
120 #endif
121         unsigned short          phy_addr;
122         struct mii_dev          *bus;
123 #ifdef CONFIG_PHYLIB
124         struct phy_device       *phydev;
125 #endif
126
127 #ifdef CONFIG_DM_ETH
128 #ifdef CONFIG_CLK
129         unsigned long           pclk_rate;
130 #endif
131         phy_interface_t         phy_interface;
132 #endif
133 };
134
135 struct macb_config {
136         unsigned int            dma_burst_length;
137
138         int                     (*clk_init)(struct udevice *dev, ulong rate);
139 };
140
141 #ifndef CONFIG_DM_ETH
142 #define to_macb(_nd) container_of(_nd, struct macb_device, netdev)
143 #endif
144
145 static int macb_is_gem(struct macb_device *macb)
146 {
147         return MACB_BFEXT(IDNUM, macb_readl(macb, MID)) >= 0x2;
148 }
149
150 #ifndef cpu_is_sama5d2
151 #define cpu_is_sama5d2() 0
152 #endif
153
154 #ifndef cpu_is_sama5d4
155 #define cpu_is_sama5d4() 0
156 #endif
157
158 static int gem_is_gigabit_capable(struct macb_device *macb)
159 {
160         /*
161          * The GEM controllers embedded in SAMA5D2 and SAMA5D4 are
162          * configured to support only 10/100.
163          */
164         return macb_is_gem(macb) && !cpu_is_sama5d2() && !cpu_is_sama5d4();
165 }
166
167 static void macb_mdio_write(struct macb_device *macb, u8 reg, u16 value)
168 {
169         unsigned long netctl;
170         unsigned long netstat;
171         unsigned long frame;
172
173         netctl = macb_readl(macb, NCR);
174         netctl |= MACB_BIT(MPE);
175         macb_writel(macb, NCR, netctl);
176
177         frame = (MACB_BF(SOF, 1)
178                  | MACB_BF(RW, 1)
179                  | MACB_BF(PHYA, macb->phy_addr)
180                  | MACB_BF(REGA, reg)
181                  | MACB_BF(CODE, 2)
182                  | MACB_BF(DATA, value));
183         macb_writel(macb, MAN, frame);
184
185         do {
186                 netstat = macb_readl(macb, NSR);
187         } while (!(netstat & MACB_BIT(IDLE)));
188
189         netctl = macb_readl(macb, NCR);
190         netctl &= ~MACB_BIT(MPE);
191         macb_writel(macb, NCR, netctl);
192 }
193
194 static u16 macb_mdio_read(struct macb_device *macb, u8 reg)
195 {
196         unsigned long netctl;
197         unsigned long netstat;
198         unsigned long frame;
199
200         netctl = macb_readl(macb, NCR);
201         netctl |= MACB_BIT(MPE);
202         macb_writel(macb, NCR, netctl);
203
204         frame = (MACB_BF(SOF, 1)
205                  | MACB_BF(RW, 2)
206                  | MACB_BF(PHYA, macb->phy_addr)
207                  | MACB_BF(REGA, reg)
208                  | MACB_BF(CODE, 2));
209         macb_writel(macb, MAN, frame);
210
211         do {
212                 netstat = macb_readl(macb, NSR);
213         } while (!(netstat & MACB_BIT(IDLE)));
214
215         frame = macb_readl(macb, MAN);
216
217         netctl = macb_readl(macb, NCR);
218         netctl &= ~MACB_BIT(MPE);
219         macb_writel(macb, NCR, netctl);
220
221         return MACB_BFEXT(DATA, frame);
222 }
223
224 void __weak arch_get_mdio_control(const char *name)
225 {
226         return;
227 }
228
229 #if defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
230
231 int macb_miiphy_read(struct mii_dev *bus, int phy_adr, int devad, int reg)
232 {
233         u16 value = 0;
234 #ifdef CONFIG_DM_ETH
235         struct udevice *dev = eth_get_dev_by_name(bus->name);
236         struct macb_device *macb = dev_get_priv(dev);
237 #else
238         struct eth_device *dev = eth_get_dev_by_name(bus->name);
239         struct macb_device *macb = to_macb(dev);
240 #endif
241
242         if (macb->phy_addr != phy_adr)
243                 return -1;
244
245         arch_get_mdio_control(bus->name);
246         value = macb_mdio_read(macb, reg);
247
248         return value;
249 }
250
251 int macb_miiphy_write(struct mii_dev *bus, int phy_adr, int devad, int reg,
252                       u16 value)
253 {
254 #ifdef CONFIG_DM_ETH
255         struct udevice *dev = eth_get_dev_by_name(bus->name);
256         struct macb_device *macb = dev_get_priv(dev);
257 #else
258         struct eth_device *dev = eth_get_dev_by_name(bus->name);
259         struct macb_device *macb = to_macb(dev);
260 #endif
261
262         if (macb->phy_addr != phy_adr)
263                 return -1;
264
265         arch_get_mdio_control(bus->name);
266         macb_mdio_write(macb, reg, value);
267
268         return 0;
269 }
270 #endif
271
272 #define RX      1
273 #define TX      0
274 static inline void macb_invalidate_ring_desc(struct macb_device *macb, bool rx)
275 {
276         if (rx)
277                 invalidate_dcache_range(macb->rx_ring_dma,
278                         ALIGN(macb->rx_ring_dma + MACB_RX_DMA_DESC_SIZE,
279                               PKTALIGN));
280         else
281                 invalidate_dcache_range(macb->tx_ring_dma,
282                         ALIGN(macb->tx_ring_dma + MACB_TX_DMA_DESC_SIZE,
283                               PKTALIGN));
284 }
285
286 static inline void macb_flush_ring_desc(struct macb_device *macb, bool rx)
287 {
288         if (rx)
289                 flush_dcache_range(macb->rx_ring_dma, macb->rx_ring_dma +
290                                    ALIGN(MACB_RX_DMA_DESC_SIZE, PKTALIGN));
291         else
292                 flush_dcache_range(macb->tx_ring_dma, macb->tx_ring_dma +
293                                    ALIGN(MACB_TX_DMA_DESC_SIZE, PKTALIGN));
294 }
295
296 static inline void macb_flush_rx_buffer(struct macb_device *macb)
297 {
298         flush_dcache_range(macb->rx_buffer_dma, macb->rx_buffer_dma +
299                            ALIGN(macb->rx_buffer_size * MACB_RX_RING_SIZE,
300                                  PKTALIGN));
301 }
302
303 static inline void macb_invalidate_rx_buffer(struct macb_device *macb)
304 {
305         invalidate_dcache_range(macb->rx_buffer_dma, macb->rx_buffer_dma +
306                                 ALIGN(macb->rx_buffer_size * MACB_RX_RING_SIZE,
307                                       PKTALIGN));
308 }
309
310 #if defined(CONFIG_CMD_NET)
311
312 static int _macb_send(struct macb_device *macb, const char *name, void *packet,
313                       int length)
314 {
315         unsigned long paddr, ctrl;
316         unsigned int tx_head = macb->tx_head;
317         int i;
318
319         paddr = dma_map_single(packet, length, DMA_TO_DEVICE);
320
321         ctrl = length & TXBUF_FRMLEN_MASK;
322         ctrl |= MACB_BIT(TX_LAST);
323         if (tx_head == (MACB_TX_RING_SIZE - 1)) {
324                 ctrl |= MACB_BIT(TX_WRAP);
325                 macb->tx_head = 0;
326         } else {
327                 macb->tx_head++;
328         }
329
330         macb->tx_ring[tx_head].ctrl = ctrl;
331         macb->tx_ring[tx_head].addr = paddr;
332         barrier();
333         macb_flush_ring_desc(macb, TX);
334         /* Do we need check paddr and length is dcache line aligned? */
335         flush_dcache_range(paddr, paddr + ALIGN(length, ARCH_DMA_MINALIGN));
336         macb_writel(macb, NCR, MACB_BIT(TE) | MACB_BIT(RE) | MACB_BIT(TSTART));
337
338         /*
339          * I guess this is necessary because the networking core may
340          * re-use the transmit buffer as soon as we return...
341          */
342         for (i = 0; i <= MACB_TX_TIMEOUT; i++) {
343                 barrier();
344                 macb_invalidate_ring_desc(macb, TX);
345                 ctrl = macb->tx_ring[tx_head].ctrl;
346                 if (ctrl & MACB_BIT(TX_USED))
347                         break;
348                 udelay(1);
349         }
350
351         dma_unmap_single(packet, length, paddr);
352
353         if (i <= MACB_TX_TIMEOUT) {
354                 if (ctrl & MACB_BIT(TX_UNDERRUN))
355                         printf("%s: TX underrun\n", name);
356                 if (ctrl & MACB_BIT(TX_BUF_EXHAUSTED))
357                         printf("%s: TX buffers exhausted in mid frame\n", name);
358         } else {
359                 printf("%s: TX timeout\n", name);
360         }
361
362         /* No one cares anyway */
363         return 0;
364 }
365
366 static void reclaim_rx_buffers(struct macb_device *macb,
367                                unsigned int new_tail)
368 {
369         unsigned int i;
370
371         i = macb->rx_tail;
372
373         macb_invalidate_ring_desc(macb, RX);
374         while (i > new_tail) {
375                 macb->rx_ring[i].addr &= ~MACB_BIT(RX_USED);
376                 i++;
377                 if (i > MACB_RX_RING_SIZE)
378                         i = 0;
379         }
380
381         while (i < new_tail) {
382                 macb->rx_ring[i].addr &= ~MACB_BIT(RX_USED);
383                 i++;
384         }
385
386         barrier();
387         macb_flush_ring_desc(macb, RX);
388         macb->rx_tail = new_tail;
389 }
390
391 static int _macb_recv(struct macb_device *macb, uchar **packetp)
392 {
393         unsigned int next_rx_tail = macb->next_rx_tail;
394         void *buffer;
395         int length;
396         u32 status;
397
398         macb->wrapped = false;
399         for (;;) {
400                 macb_invalidate_ring_desc(macb, RX);
401
402                 if (!(macb->rx_ring[next_rx_tail].addr & MACB_BIT(RX_USED)))
403                         return -EAGAIN;
404
405                 status = macb->rx_ring[next_rx_tail].ctrl;
406                 if (status & MACB_BIT(RX_SOF)) {
407                         if (next_rx_tail != macb->rx_tail)
408                                 reclaim_rx_buffers(macb, next_rx_tail);
409                         macb->wrapped = false;
410                 }
411
412                 if (status & MACB_BIT(RX_EOF)) {
413                         buffer = macb->rx_buffer +
414                                 macb->rx_buffer_size * macb->rx_tail;
415                         length = status & RXBUF_FRMLEN_MASK;
416
417                         macb_invalidate_rx_buffer(macb);
418                         if (macb->wrapped) {
419                                 unsigned int headlen, taillen;
420
421                                 headlen = macb->rx_buffer_size *
422                                         (MACB_RX_RING_SIZE - macb->rx_tail);
423                                 taillen = length - headlen;
424                                 memcpy((void *)net_rx_packets[0],
425                                        buffer, headlen);
426                                 memcpy((void *)net_rx_packets[0] + headlen,
427                                        macb->rx_buffer, taillen);
428                                 *packetp = (void *)net_rx_packets[0];
429                         } else {
430                                 *packetp = buffer;
431                         }
432
433                         if (++next_rx_tail >= MACB_RX_RING_SIZE)
434                                 next_rx_tail = 0;
435                         macb->next_rx_tail = next_rx_tail;
436                         return length;
437                 } else {
438                         if (++next_rx_tail >= MACB_RX_RING_SIZE) {
439                                 macb->wrapped = true;
440                                 next_rx_tail = 0;
441                         }
442                 }
443                 barrier();
444         }
445 }
446
447 static void macb_phy_reset(struct macb_device *macb, const char *name)
448 {
449         int i;
450         u16 status, adv;
451
452         adv = ADVERTISE_CSMA | ADVERTISE_ALL;
453         macb_mdio_write(macb, MII_ADVERTISE, adv);
454         printf("%s: Starting autonegotiation...\n", name);
455         macb_mdio_write(macb, MII_BMCR, (BMCR_ANENABLE
456                                          | BMCR_ANRESTART));
457
458         for (i = 0; i < MACB_AUTONEG_TIMEOUT / 100; i++) {
459                 status = macb_mdio_read(macb, MII_BMSR);
460                 if (status & BMSR_ANEGCOMPLETE)
461                         break;
462                 udelay(100);
463         }
464
465         if (status & BMSR_ANEGCOMPLETE)
466                 printf("%s: Autonegotiation complete\n", name);
467         else
468                 printf("%s: Autonegotiation timed out (status=0x%04x)\n",
469                        name, status);
470 }
471
472 static int macb_phy_find(struct macb_device *macb, const char *name)
473 {
474         int i;
475         u16 phy_id;
476
477         /* Search for PHY... */
478         for (i = 0; i < 32; i++) {
479                 macb->phy_addr = i;
480                 phy_id = macb_mdio_read(macb, MII_PHYSID1);
481                 if (phy_id != 0xffff) {
482                         printf("%s: PHY present at %d\n", name, i);
483                         return 0;
484                 }
485         }
486
487         /* PHY isn't up to snuff */
488         printf("%s: PHY not found\n", name);
489
490         return -ENODEV;
491 }
492
493 /**
494  * macb_linkspd_cb - Linkspeed change callback function
495  * @dev/@regs:  MACB udevice (DM version) or
496  *              Base Register of MACB devices (non-DM version)
497  * @speed:      Linkspeed
498  * Returns 0 when operation success and negative errno number
499  * when operation failed.
500  */
501 #ifdef CONFIG_DM_ETH
502 static int macb_sifive_clk_init(struct udevice *dev, ulong rate)
503 {
504         fdt_addr_t addr;
505         void *gemgxl_regs;
506
507         addr = dev_read_addr_index(dev, 1);
508         if (addr == FDT_ADDR_T_NONE)
509                 return -ENODEV;
510
511         gemgxl_regs = (void __iomem *)addr;
512         if (!gemgxl_regs)
513                 return -ENODEV;
514
515         /*
516          * SiFive GEMGXL TX clock operation mode:
517          *
518          * 0 = GMII mode. Use 125 MHz gemgxlclk from PRCI in TX logic
519          *     and output clock on GMII output signal GTX_CLK
520          * 1 = MII mode. Use MII input signal TX_CLK in TX logic
521          */
522         writel(rate != 125000000, gemgxl_regs);
523         return 0;
524 }
525
526 int __weak macb_linkspd_cb(struct udevice *dev, unsigned int speed)
527 {
528 #ifdef CONFIG_CLK
529         struct macb_device *macb = dev_get_priv(dev);
530         struct clk tx_clk;
531         ulong rate;
532         int ret;
533
534         switch (speed) {
535         case _10BASET:
536                 rate = 2500000;         /* 2.5 MHz */
537                 break;
538         case _100BASET:
539                 rate = 25000000;        /* 25 MHz */
540                 break;
541         case _1000BASET:
542                 rate = 125000000;       /* 125 MHz */
543                 break;
544         default:
545                 /* does not change anything */
546                 return 0;
547         }
548
549         if (macb->config->clk_init)
550                 return macb->config->clk_init(dev, rate);
551
552         /*
553          * "tx_clk" is an optional clock source for MACB.
554          * Ignore if it does not exist in DT.
555          */
556         ret = clk_get_by_name(dev, "tx_clk", &tx_clk);
557         if (ret)
558                 return 0;
559
560         if (tx_clk.dev) {
561                 ret = clk_set_rate(&tx_clk, rate);
562                 if (ret)
563                         return ret;
564         }
565 #endif
566
567         return 0;
568 }
569 #else
570 int __weak macb_linkspd_cb(void *regs, unsigned int speed)
571 {
572         return 0;
573 }
574 #endif
575
576 #ifdef CONFIG_DM_ETH
577 static int macb_phy_init(struct udevice *dev, const char *name)
578 #else
579 static int macb_phy_init(struct macb_device *macb, const char *name)
580 #endif
581 {
582 #ifdef CONFIG_DM_ETH
583         struct macb_device *macb = dev_get_priv(dev);
584 #endif
585         u32 ncfgr;
586         u16 phy_id, status, adv, lpa;
587         int media, speed, duplex;
588         int ret;
589         int i;
590
591         arch_get_mdio_control(name);
592         /* Auto-detect phy_addr */
593         ret = macb_phy_find(macb, name);
594         if (ret)
595                 return ret;
596
597         /* Check if the PHY is up to snuff... */
598         phy_id = macb_mdio_read(macb, MII_PHYSID1);
599         if (phy_id == 0xffff) {
600                 printf("%s: No PHY present\n", name);
601                 return -ENODEV;
602         }
603
604 #ifdef CONFIG_PHYLIB
605 #ifdef CONFIG_DM_ETH
606         macb->phydev = phy_connect(macb->bus, macb->phy_addr, dev,
607                              macb->phy_interface);
608 #else
609         /* need to consider other phy interface mode */
610         macb->phydev = phy_connect(macb->bus, macb->phy_addr, &macb->netdev,
611                              PHY_INTERFACE_MODE_RGMII);
612 #endif
613         if (!macb->phydev) {
614                 printf("phy_connect failed\n");
615                 return -ENODEV;
616         }
617
618         phy_config(macb->phydev);
619 #endif
620
621         status = macb_mdio_read(macb, MII_BMSR);
622         if (!(status & BMSR_LSTATUS)) {
623                 /* Try to re-negotiate if we don't have link already. */
624                 macb_phy_reset(macb, name);
625
626                 for (i = 0; i < MACB_AUTONEG_TIMEOUT / 100; i++) {
627                         status = macb_mdio_read(macb, MII_BMSR);
628                         if (status & BMSR_LSTATUS) {
629                                 /*
630                                  * Delay a bit after the link is established,
631                                  * so that the next xfer does not fail
632                                  */
633                                 mdelay(10);
634                                 break;
635                         }
636                         udelay(100);
637                 }
638         }
639
640         if (!(status & BMSR_LSTATUS)) {
641                 printf("%s: link down (status: 0x%04x)\n",
642                        name, status);
643                 return -ENETDOWN;
644         }
645
646         /* First check for GMAC and that it is GiB capable */
647         if (gem_is_gigabit_capable(macb)) {
648                 lpa = macb_mdio_read(macb, MII_STAT1000);
649
650                 if (lpa & (LPA_1000FULL | LPA_1000HALF | LPA_1000XFULL |
651                                         LPA_1000XHALF)) {
652                         duplex = ((lpa & (LPA_1000FULL | LPA_1000XFULL)) ?
653                                         1 : 0);
654
655                         printf("%s: link up, 1000Mbps %s-duplex (lpa: 0x%04x)\n",
656                                name,
657                                duplex ? "full" : "half",
658                                lpa);
659
660                         ncfgr = macb_readl(macb, NCFGR);
661                         ncfgr &= ~(MACB_BIT(SPD) | MACB_BIT(FD));
662                         ncfgr |= GEM_BIT(GBE);
663
664                         if (duplex)
665                                 ncfgr |= MACB_BIT(FD);
666
667                         macb_writel(macb, NCFGR, ncfgr);
668
669 #ifdef CONFIG_DM_ETH
670                         ret = macb_linkspd_cb(dev, _1000BASET);
671 #else
672                         ret = macb_linkspd_cb(macb->regs, _1000BASET);
673 #endif
674                         if (ret)
675                                 return ret;
676
677                         return 0;
678                 }
679         }
680
681         /* fall back for EMAC checking */
682         adv = macb_mdio_read(macb, MII_ADVERTISE);
683         lpa = macb_mdio_read(macb, MII_LPA);
684         media = mii_nway_result(lpa & adv);
685         speed = (media & (ADVERTISE_100FULL | ADVERTISE_100HALF)
686                  ? 1 : 0);
687         duplex = (media & ADVERTISE_FULL) ? 1 : 0;
688         printf("%s: link up, %sMbps %s-duplex (lpa: 0x%04x)\n",
689                name,
690                speed ? "100" : "10",
691                duplex ? "full" : "half",
692                lpa);
693
694         ncfgr = macb_readl(macb, NCFGR);
695         ncfgr &= ~(MACB_BIT(SPD) | MACB_BIT(FD) | GEM_BIT(GBE));
696         if (speed) {
697                 ncfgr |= MACB_BIT(SPD);
698 #ifdef CONFIG_DM_ETH
699                 ret = macb_linkspd_cb(dev, _100BASET);
700 #else
701                 ret = macb_linkspd_cb(macb->regs, _100BASET);
702 #endif
703         } else {
704 #ifdef CONFIG_DM_ETH
705                 ret = macb_linkspd_cb(dev, _10BASET);
706 #else
707                 ret = macb_linkspd_cb(macb->regs, _10BASET);
708 #endif
709         }
710
711         if (ret)
712                 return ret;
713
714         if (duplex)
715                 ncfgr |= MACB_BIT(FD);
716         macb_writel(macb, NCFGR, ncfgr);
717
718         return 0;
719 }
720
721 static int gmac_init_multi_queues(struct macb_device *macb)
722 {
723         int i, num_queues = 1;
724         u32 queue_mask;
725
726         /* bit 0 is never set but queue 0 always exists */
727         queue_mask = gem_readl(macb, DCFG6) & 0xff;
728         queue_mask |= 0x1;
729
730         for (i = 1; i < MACB_MAX_QUEUES; i++)
731                 if (queue_mask & (1 << i))
732                         num_queues++;
733
734         macb->dummy_desc->ctrl = MACB_BIT(TX_USED);
735         macb->dummy_desc->addr = 0;
736         flush_dcache_range(macb->dummy_desc_dma, macb->dummy_desc_dma +
737                         ALIGN(MACB_TX_DUMMY_DMA_DESC_SIZE, PKTALIGN));
738
739         for (i = 1; i < num_queues; i++)
740                 gem_writel_queue_TBQP(macb, macb->dummy_desc_dma, i - 1);
741
742         return 0;
743 }
744
745 static void gmac_configure_dma(struct macb_device *macb)
746 {
747         u32 buffer_size;
748         u32 dmacfg;
749
750         buffer_size = macb->rx_buffer_size / RX_BUFFER_MULTIPLE;
751         dmacfg = gem_readl(macb, DMACFG) & ~GEM_BF(RXBS, -1L);
752         dmacfg |= GEM_BF(RXBS, buffer_size);
753
754         if (macb->config->dma_burst_length)
755                 dmacfg = GEM_BFINS(FBLDO,
756                                    macb->config->dma_burst_length, dmacfg);
757
758         dmacfg |= GEM_BIT(TXPBMS) | GEM_BF(RXBMS, -1L);
759         dmacfg &= ~GEM_BIT(ENDIA_PKT);
760
761         if (macb->is_big_endian)
762                 dmacfg |= GEM_BIT(ENDIA_DESC); /* CPU in big endian */
763         else
764                 dmacfg &= ~GEM_BIT(ENDIA_DESC);
765
766         dmacfg &= ~GEM_BIT(ADDR64);
767         gem_writel(macb, DMACFG, dmacfg);
768 }
769
770 #ifdef CONFIG_DM_ETH
771 static int _macb_init(struct udevice *dev, const char *name)
772 #else
773 static int _macb_init(struct macb_device *macb, const char *name)
774 #endif
775 {
776 #ifdef CONFIG_DM_ETH
777         struct macb_device *macb = dev_get_priv(dev);
778 #endif
779         unsigned long paddr;
780         int ret;
781         int i;
782
783         /*
784          * macb_halt should have been called at some point before now,
785          * so we'll assume the controller is idle.
786          */
787
788         /* initialize DMA descriptors */
789         paddr = macb->rx_buffer_dma;
790         for (i = 0; i < MACB_RX_RING_SIZE; i++) {
791                 if (i == (MACB_RX_RING_SIZE - 1))
792                         paddr |= MACB_BIT(RX_WRAP);
793                 macb->rx_ring[i].addr = paddr;
794                 macb->rx_ring[i].ctrl = 0;
795                 paddr += macb->rx_buffer_size;
796         }
797         macb_flush_ring_desc(macb, RX);
798         macb_flush_rx_buffer(macb);
799
800         for (i = 0; i < MACB_TX_RING_SIZE; i++) {
801                 macb->tx_ring[i].addr = 0;
802                 if (i == (MACB_TX_RING_SIZE - 1))
803                         macb->tx_ring[i].ctrl = MACB_BIT(TX_USED) |
804                                 MACB_BIT(TX_WRAP);
805                 else
806                         macb->tx_ring[i].ctrl = MACB_BIT(TX_USED);
807         }
808         macb_flush_ring_desc(macb, TX);
809
810         macb->rx_tail = 0;
811         macb->tx_head = 0;
812         macb->tx_tail = 0;
813         macb->next_rx_tail = 0;
814
815 #ifdef CONFIG_MACB_ZYNQ
816         macb_writel(macb, DMACFG, MACB_ZYNQ_GEM_DMACR_INIT);
817 #endif
818
819         macb_writel(macb, RBQP, macb->rx_ring_dma);
820         macb_writel(macb, TBQP, macb->tx_ring_dma);
821
822         if (macb_is_gem(macb)) {
823                 /* Initialize DMA properties */
824                 gmac_configure_dma(macb);
825                 /* Check the multi queue and initialize the queue for tx */
826                 gmac_init_multi_queues(macb);
827
828                 /*
829                  * When the GMAC IP with GE feature, this bit is used to
830                  * select interface between RGMII and GMII.
831                  * When the GMAC IP without GE feature, this bit is used
832                  * to select interface between RMII and MII.
833                  */
834 #ifdef CONFIG_DM_ETH
835                 if ((macb->phy_interface == PHY_INTERFACE_MODE_RMII) ||
836                     (macb->phy_interface == PHY_INTERFACE_MODE_RGMII))
837                         gem_writel(macb, USRIO, GEM_BIT(RGMII));
838                 else
839                         gem_writel(macb, USRIO, 0);
840
841                 if (macb->phy_interface == PHY_INTERFACE_MODE_SGMII) {
842                         unsigned int ncfgr = macb_readl(macb, NCFGR);
843
844                         ncfgr |= GEM_BIT(SGMIIEN) | GEM_BIT(PCSSEL);
845                         macb_writel(macb, NCFGR, ncfgr);
846                 }
847 #else
848 #if defined(CONFIG_RGMII) || defined(CONFIG_RMII)
849                 gem_writel(macb, USRIO, GEM_BIT(RGMII));
850 #else
851                 gem_writel(macb, USRIO, 0);
852 #endif
853 #endif
854         } else {
855         /* choose RMII or MII mode. This depends on the board */
856 #ifdef CONFIG_DM_ETH
857 #ifdef CONFIG_AT91FAMILY
858                 if (macb->phy_interface == PHY_INTERFACE_MODE_RMII) {
859                         macb_writel(macb, USRIO,
860                                     MACB_BIT(RMII) | MACB_BIT(CLKEN));
861                 } else {
862                         macb_writel(macb, USRIO, MACB_BIT(CLKEN));
863                 }
864 #else
865                 if (macb->phy_interface == PHY_INTERFACE_MODE_RMII)
866                         macb_writel(macb, USRIO, 0);
867                 else
868                         macb_writel(macb, USRIO, MACB_BIT(MII));
869 #endif
870 #else
871 #ifdef CONFIG_RMII
872 #ifdef CONFIG_AT91FAMILY
873         macb_writel(macb, USRIO, MACB_BIT(RMII) | MACB_BIT(CLKEN));
874 #else
875         macb_writel(macb, USRIO, 0);
876 #endif
877 #else
878 #ifdef CONFIG_AT91FAMILY
879         macb_writel(macb, USRIO, MACB_BIT(CLKEN));
880 #else
881         macb_writel(macb, USRIO, MACB_BIT(MII));
882 #endif
883 #endif /* CONFIG_RMII */
884 #endif
885         }
886
887 #ifdef CONFIG_DM_ETH
888         ret = macb_phy_init(dev, name);
889 #else
890         ret = macb_phy_init(macb, name);
891 #endif
892         if (ret)
893                 return ret;
894
895         /* Enable TX and RX */
896         macb_writel(macb, NCR, MACB_BIT(TE) | MACB_BIT(RE));
897
898         return 0;
899 }
900
901 static void _macb_halt(struct macb_device *macb)
902 {
903         u32 ncr, tsr;
904
905         /* Halt the controller and wait for any ongoing transmission to end. */
906         ncr = macb_readl(macb, NCR);
907         ncr |= MACB_BIT(THALT);
908         macb_writel(macb, NCR, ncr);
909
910         do {
911                 tsr = macb_readl(macb, TSR);
912         } while (tsr & MACB_BIT(TGO));
913
914         /* Disable TX and RX, and clear statistics */
915         macb_writel(macb, NCR, MACB_BIT(CLRSTAT));
916 }
917
918 static int _macb_write_hwaddr(struct macb_device *macb, unsigned char *enetaddr)
919 {
920         u32 hwaddr_bottom;
921         u16 hwaddr_top;
922
923         /* set hardware address */
924         hwaddr_bottom = enetaddr[0] | enetaddr[1] << 8 |
925                         enetaddr[2] << 16 | enetaddr[3] << 24;
926         macb_writel(macb, SA1B, hwaddr_bottom);
927         hwaddr_top = enetaddr[4] | enetaddr[5] << 8;
928         macb_writel(macb, SA1T, hwaddr_top);
929         return 0;
930 }
931
932 static u32 macb_mdc_clk_div(int id, struct macb_device *macb)
933 {
934         u32 config;
935 #if defined(CONFIG_DM_ETH) && defined(CONFIG_CLK)
936         unsigned long macb_hz = macb->pclk_rate;
937 #else
938         unsigned long macb_hz = get_macb_pclk_rate(id);
939 #endif
940
941         if (macb_hz < 20000000)
942                 config = MACB_BF(CLK, MACB_CLK_DIV8);
943         else if (macb_hz < 40000000)
944                 config = MACB_BF(CLK, MACB_CLK_DIV16);
945         else if (macb_hz < 80000000)
946                 config = MACB_BF(CLK, MACB_CLK_DIV32);
947         else
948                 config = MACB_BF(CLK, MACB_CLK_DIV64);
949
950         return config;
951 }
952
953 static u32 gem_mdc_clk_div(int id, struct macb_device *macb)
954 {
955         u32 config;
956
957 #if defined(CONFIG_DM_ETH) && defined(CONFIG_CLK)
958         unsigned long macb_hz = macb->pclk_rate;
959 #else
960         unsigned long macb_hz = get_macb_pclk_rate(id);
961 #endif
962
963         if (macb_hz < 20000000)
964                 config = GEM_BF(CLK, GEM_CLK_DIV8);
965         else if (macb_hz < 40000000)
966                 config = GEM_BF(CLK, GEM_CLK_DIV16);
967         else if (macb_hz < 80000000)
968                 config = GEM_BF(CLK, GEM_CLK_DIV32);
969         else if (macb_hz < 120000000)
970                 config = GEM_BF(CLK, GEM_CLK_DIV48);
971         else if (macb_hz < 160000000)
972                 config = GEM_BF(CLK, GEM_CLK_DIV64);
973         else if (macb_hz < 240000000)
974                 config = GEM_BF(CLK, GEM_CLK_DIV96);
975         else if (macb_hz < 320000000)
976                 config = GEM_BF(CLK, GEM_CLK_DIV128);
977         else
978                 config = GEM_BF(CLK, GEM_CLK_DIV224);
979
980         return config;
981 }
982
983 /*
984  * Get the DMA bus width field of the network configuration register that we
985  * should program. We find the width from decoding the design configuration
986  * register to find the maximum supported data bus width.
987  */
988 static u32 macb_dbw(struct macb_device *macb)
989 {
990         switch (GEM_BFEXT(DBWDEF, gem_readl(macb, DCFG1))) {
991         case 4:
992                 return GEM_BF(DBW, GEM_DBW128);
993         case 2:
994                 return GEM_BF(DBW, GEM_DBW64);
995         case 1:
996         default:
997                 return GEM_BF(DBW, GEM_DBW32);
998         }
999 }
1000
1001 static void _macb_eth_initialize(struct macb_device *macb)
1002 {
1003         int id = 0;     /* This is not used by functions we call */
1004         u32 ncfgr;
1005
1006         if (macb_is_gem(macb))
1007                 macb->rx_buffer_size = GEM_RX_BUFFER_SIZE;
1008         else
1009                 macb->rx_buffer_size = MACB_RX_BUFFER_SIZE;
1010
1011         /* TODO: we need check the rx/tx_ring_dma is dcache line aligned */
1012         macb->rx_buffer = dma_alloc_coherent(macb->rx_buffer_size *
1013                                              MACB_RX_RING_SIZE,
1014                                              &macb->rx_buffer_dma);
1015         macb->rx_ring = dma_alloc_coherent(MACB_RX_DMA_DESC_SIZE,
1016                                            &macb->rx_ring_dma);
1017         macb->tx_ring = dma_alloc_coherent(MACB_TX_DMA_DESC_SIZE,
1018                                            &macb->tx_ring_dma);
1019         macb->dummy_desc = dma_alloc_coherent(MACB_TX_DUMMY_DMA_DESC_SIZE,
1020                                            &macb->dummy_desc_dma);
1021
1022         /*
1023          * Do some basic initialization so that we at least can talk
1024          * to the PHY
1025          */
1026         if (macb_is_gem(macb)) {
1027                 ncfgr = gem_mdc_clk_div(id, macb);
1028                 ncfgr |= macb_dbw(macb);
1029         } else {
1030                 ncfgr = macb_mdc_clk_div(id, macb);
1031         }
1032
1033         macb_writel(macb, NCFGR, ncfgr);
1034 }
1035
1036 #ifndef CONFIG_DM_ETH
1037 static int macb_send(struct eth_device *netdev, void *packet, int length)
1038 {
1039         struct macb_device *macb = to_macb(netdev);
1040
1041         return _macb_send(macb, netdev->name, packet, length);
1042 }
1043
1044 static int macb_recv(struct eth_device *netdev)
1045 {
1046         struct macb_device *macb = to_macb(netdev);
1047         uchar *packet;
1048         int length;
1049
1050         macb->wrapped = false;
1051         for (;;) {
1052                 macb->next_rx_tail = macb->rx_tail;
1053                 length = _macb_recv(macb, &packet);
1054                 if (length >= 0) {
1055                         net_process_received_packet(packet, length);
1056                         reclaim_rx_buffers(macb, macb->next_rx_tail);
1057                 } else {
1058                         return length;
1059                 }
1060         }
1061 }
1062
1063 static int macb_init(struct eth_device *netdev, bd_t *bd)
1064 {
1065         struct macb_device *macb = to_macb(netdev);
1066
1067         return _macb_init(macb, netdev->name);
1068 }
1069
1070 static void macb_halt(struct eth_device *netdev)
1071 {
1072         struct macb_device *macb = to_macb(netdev);
1073
1074         return _macb_halt(macb);
1075 }
1076
1077 static int macb_write_hwaddr(struct eth_device *netdev)
1078 {
1079         struct macb_device *macb = to_macb(netdev);
1080
1081         return _macb_write_hwaddr(macb, netdev->enetaddr);
1082 }
1083
1084 int macb_eth_initialize(int id, void *regs, unsigned int phy_addr)
1085 {
1086         struct macb_device *macb;
1087         struct eth_device *netdev;
1088
1089         macb = malloc(sizeof(struct macb_device));
1090         if (!macb) {
1091                 printf("Error: Failed to allocate memory for MACB%d\n", id);
1092                 return -1;
1093         }
1094         memset(macb, 0, sizeof(struct macb_device));
1095
1096         netdev = &macb->netdev;
1097
1098         macb->regs = regs;
1099         macb->phy_addr = phy_addr;
1100
1101         if (macb_is_gem(macb))
1102                 sprintf(netdev->name, "gmac%d", id);
1103         else
1104                 sprintf(netdev->name, "macb%d", id);
1105
1106         netdev->init = macb_init;
1107         netdev->halt = macb_halt;
1108         netdev->send = macb_send;
1109         netdev->recv = macb_recv;
1110         netdev->write_hwaddr = macb_write_hwaddr;
1111
1112         _macb_eth_initialize(macb);
1113
1114         eth_register(netdev);
1115
1116 #if defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
1117         int retval;
1118         struct mii_dev *mdiodev = mdio_alloc();
1119         if (!mdiodev)
1120                 return -ENOMEM;
1121         strncpy(mdiodev->name, netdev->name, MDIO_NAME_LEN);
1122         mdiodev->read = macb_miiphy_read;
1123         mdiodev->write = macb_miiphy_write;
1124
1125         retval = mdio_register(mdiodev);
1126         if (retval < 0)
1127                 return retval;
1128         macb->bus = miiphy_get_dev_by_name(netdev->name);
1129 #endif
1130         return 0;
1131 }
1132 #endif /* !CONFIG_DM_ETH */
1133
1134 #ifdef CONFIG_DM_ETH
1135
1136 static int macb_start(struct udevice *dev)
1137 {
1138         return _macb_init(dev, dev->name);
1139 }
1140
1141 static int macb_send(struct udevice *dev, void *packet, int length)
1142 {
1143         struct macb_device *macb = dev_get_priv(dev);
1144
1145         return _macb_send(macb, dev->name, packet, length);
1146 }
1147
1148 static int macb_recv(struct udevice *dev, int flags, uchar **packetp)
1149 {
1150         struct macb_device *macb = dev_get_priv(dev);
1151
1152         macb->next_rx_tail = macb->rx_tail;
1153         macb->wrapped = false;
1154
1155         return _macb_recv(macb, packetp);
1156 }
1157
1158 static int macb_free_pkt(struct udevice *dev, uchar *packet, int length)
1159 {
1160         struct macb_device *macb = dev_get_priv(dev);
1161
1162         reclaim_rx_buffers(macb, macb->next_rx_tail);
1163
1164         return 0;
1165 }
1166
1167 static void macb_stop(struct udevice *dev)
1168 {
1169         struct macb_device *macb = dev_get_priv(dev);
1170
1171         _macb_halt(macb);
1172 }
1173
1174 static int macb_write_hwaddr(struct udevice *dev)
1175 {
1176         struct eth_pdata *plat = dev_get_platdata(dev);
1177         struct macb_device *macb = dev_get_priv(dev);
1178
1179         return _macb_write_hwaddr(macb, plat->enetaddr);
1180 }
1181
1182 static const struct eth_ops macb_eth_ops = {
1183         .start  = macb_start,
1184         .send   = macb_send,
1185         .recv   = macb_recv,
1186         .stop   = macb_stop,
1187         .free_pkt       = macb_free_pkt,
1188         .write_hwaddr   = macb_write_hwaddr,
1189 };
1190
1191 #ifdef CONFIG_CLK
1192 static int macb_enable_clk(struct udevice *dev)
1193 {
1194         struct macb_device *macb = dev_get_priv(dev);
1195         struct clk clk;
1196         ulong clk_rate;
1197         int ret;
1198
1199         ret = clk_get_by_index(dev, 0, &clk);
1200         if (ret)
1201                 return -EINVAL;
1202
1203         /*
1204          * If clock driver didn't support enable or disable then
1205          * we get -ENOSYS from clk_enable(). To handle this, we
1206          * don't fail for ret == -ENOSYS.
1207          */
1208         ret = clk_enable(&clk);
1209         if (ret && ret != -ENOSYS)
1210                 return ret;
1211
1212         clk_rate = clk_get_rate(&clk);
1213         if (!clk_rate)
1214                 return -EINVAL;
1215
1216         macb->pclk_rate = clk_rate;
1217
1218         return 0;
1219 }
1220 #endif
1221
1222 static const struct macb_config default_gem_config = {
1223         .dma_burst_length = 16,
1224         .clk_init = NULL,
1225 };
1226
1227 static int macb_eth_probe(struct udevice *dev)
1228 {
1229         struct eth_pdata *pdata = dev_get_platdata(dev);
1230         struct macb_device *macb = dev_get_priv(dev);
1231         const char *phy_mode;
1232         int ret;
1233
1234         phy_mode = fdt_getprop(gd->fdt_blob, dev_of_offset(dev), "phy-mode",
1235                                NULL);
1236         if (phy_mode)
1237                 macb->phy_interface = phy_get_interface_by_name(phy_mode);
1238         if (macb->phy_interface == -1) {
1239                 debug("%s: Invalid PHY interface '%s'\n", __func__, phy_mode);
1240                 return -EINVAL;
1241         }
1242
1243         macb->regs = (void *)pdata->iobase;
1244
1245         macb->is_big_endian = (cpu_to_be32(0x12345678) == 0x12345678);
1246
1247         macb->config = (struct macb_config *)dev_get_driver_data(dev);
1248         if (!macb->config)
1249                 macb->config = &default_gem_config;
1250
1251 #ifdef CONFIG_CLK
1252         ret = macb_enable_clk(dev);
1253         if (ret)
1254                 return ret;
1255 #endif
1256
1257         _macb_eth_initialize(macb);
1258
1259 #if defined(CONFIG_CMD_MII) || defined(CONFIG_PHYLIB)
1260         macb->bus = mdio_alloc();
1261         if (!macb->bus)
1262                 return -ENOMEM;
1263         strncpy(macb->bus->name, dev->name, MDIO_NAME_LEN);
1264         macb->bus->read = macb_miiphy_read;
1265         macb->bus->write = macb_miiphy_write;
1266
1267         ret = mdio_register(macb->bus);
1268         if (ret < 0)
1269                 return ret;
1270         macb->bus = miiphy_get_dev_by_name(dev->name);
1271 #endif
1272
1273         return 0;
1274 }
1275
1276 static int macb_eth_remove(struct udevice *dev)
1277 {
1278         struct macb_device *macb = dev_get_priv(dev);
1279
1280 #ifdef CONFIG_PHYLIB
1281         free(macb->phydev);
1282 #endif
1283         mdio_unregister(macb->bus);
1284         mdio_free(macb->bus);
1285
1286         return 0;
1287 }
1288
1289 /**
1290  * macb_late_eth_ofdata_to_platdata
1291  * @dev:        udevice struct
1292  * Returns 0 when operation success and negative errno number
1293  * when operation failed.
1294  */
1295 int __weak macb_late_eth_ofdata_to_platdata(struct udevice *dev)
1296 {
1297         return 0;
1298 }
1299
1300 static int macb_eth_ofdata_to_platdata(struct udevice *dev)
1301 {
1302         struct eth_pdata *pdata = dev_get_platdata(dev);
1303
1304         pdata->iobase = (phys_addr_t)dev_remap_addr(dev);
1305         if (!pdata->iobase)
1306                 return -EINVAL;
1307
1308         return macb_late_eth_ofdata_to_platdata(dev);
1309 }
1310
1311 static const struct macb_config sama5d4_config = {
1312         .dma_burst_length = 4,
1313         .clk_init = NULL,
1314 };
1315
1316 static const struct macb_config sifive_config = {
1317         .dma_burst_length = 16,
1318         .clk_init = macb_sifive_clk_init,
1319 };
1320
1321 static const struct udevice_id macb_eth_ids[] = {
1322         { .compatible = "cdns,macb" },
1323         { .compatible = "cdns,at91sam9260-macb" },
1324         { .compatible = "cdns,sam9x60-macb" },
1325         { .compatible = "atmel,sama5d2-gem" },
1326         { .compatible = "atmel,sama5d3-gem" },
1327         { .compatible = "atmel,sama5d4-gem", .data = (ulong)&sama5d4_config },
1328         { .compatible = "cdns,zynq-gem" },
1329         { .compatible = "sifive,fu540-c000-gem",
1330           .data = (ulong)&sifive_config },
1331         { }
1332 };
1333
1334 U_BOOT_DRIVER(eth_macb) = {
1335         .name   = "eth_macb",
1336         .id     = UCLASS_ETH,
1337         .of_match = macb_eth_ids,
1338         .ofdata_to_platdata = macb_eth_ofdata_to_platdata,
1339         .probe  = macb_eth_probe,
1340         .remove = macb_eth_remove,
1341         .ops    = &macb_eth_ops,
1342         .priv_auto_alloc_size = sizeof(struct macb_device),
1343         .platdata_auto_alloc_size = sizeof(struct eth_pdata),
1344 };
1345 #endif
1346
1347 #endif