common: Drop net.h from common header
[oweals/u-boot.git] / drivers / net / rtl8169.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * rtl8169.c : U-Boot driver for the RealTek RTL8169
4  *
5  * Masami Komiya (mkomiya@sonare.it)
6  *
7  * Most part is taken from r8169.c of etherboot
8  *
9  */
10
11 /**************************************************************************
12 *    r8169.c: Etherboot device driver for the RealTek RTL-8169 Gigabit
13 *    Written 2003 by Timothy Legge <tlegge@rogers.com>
14 *
15 *    Portions of this code based on:
16 *       r8169.c: A RealTek RTL-8169 Gigabit Ethernet driver
17 *               for Linux kernel 2.4.x.
18 *
19 *    Written 2002 ShuChen <shuchen@realtek.com.tw>
20 *         See Linux Driver for full information
21 *
22 *    Linux Driver Version 1.27a, 10.02.2002
23 *
24 *    Thanks to:
25 *       Jean Chen of RealTek Semiconductor Corp. for
26 *       providing the evaluation NIC used to develop
27 *       this driver.  RealTek's support for Etherboot
28 *       is appreciated.
29 *
30 *    REVISION HISTORY:
31 *    ================
32 *
33 *    v1.0       11-26-2003      timlegge        Initial port of Linux driver
34 *    v1.5       01-17-2004      timlegge        Initial driver output cleanup
35 *
36 *    Indent Options: indent -kr -i8
37 ***************************************************************************/
38 /*
39  * 26 August 2006 Mihai Georgian <u-boot@linuxnotincluded.org.uk>
40  * Modified to use le32_to_cpu and cpu_to_le32 properly
41  */
42 #include <common.h>
43 #include <cpu_func.h>
44 #include <dm.h>
45 #include <errno.h>
46 #include <malloc.h>
47 #include <memalign.h>
48 #include <net.h>
49 #ifndef CONFIG_DM_ETH
50 #include <netdev.h>
51 #endif
52 #include <asm/cache.h>
53 #include <asm/io.h>
54 #include <pci.h>
55
56 #undef DEBUG_RTL8169
57 #undef DEBUG_RTL8169_TX
58 #undef DEBUG_RTL8169_RX
59
60 #define drv_version "v1.5"
61 #define drv_date "01-17-2004"
62
63 static unsigned long ioaddr;
64
65 /* Condensed operations for readability. */
66 #define currticks()     get_timer(0)
67
68 /* media options */
69 #define MAX_UNITS 8
70 static int media[MAX_UNITS] = { -1, -1, -1, -1, -1, -1, -1, -1 };
71
72 /* MAC address length*/
73 #define MAC_ADDR_LEN    6
74
75 /* max supported gigabit ethernet frame size -- must be at least (dev->mtu+14+4).*/
76 #define MAX_ETH_FRAME_SIZE      1536
77
78 #define TX_FIFO_THRESH 256      /* In bytes */
79
80 #define RX_FIFO_THRESH  7       /* 7 means NO threshold, Rx buffer level before first PCI xfer.  */
81 #define RX_DMA_BURST    6       /* Maximum PCI burst, '6' is 1024 */
82 #define TX_DMA_BURST    6       /* Maximum PCI burst, '6' is 1024 */
83 #define EarlyTxThld     0x3F    /* 0x3F means NO early transmit */
84 #define RxPacketMaxSize 0x0800  /* Maximum size supported is 16K-1 */
85 #define InterFrameGap   0x03    /* 3 means InterFrameGap = the shortest one */
86
87 #define NUM_TX_DESC     1       /* Number of Tx descriptor registers */
88 #ifdef CONFIG_SYS_RX_ETH_BUFFER
89   #define NUM_RX_DESC   CONFIG_SYS_RX_ETH_BUFFER
90 #else
91   #define NUM_RX_DESC   4       /* Number of Rx descriptor registers */
92 #endif
93 #define RX_BUF_SIZE     1536    /* Rx Buffer size */
94 #define RX_BUF_LEN      8192
95
96 #define RTL_MIN_IO_SIZE 0x80
97 #define TX_TIMEOUT  (6*HZ)
98
99 /* write/read MMIO register. Notice: {read,write}[wl] do the necessary swapping */
100 #define RTL_W8(reg, val8)       writeb((val8), ioaddr + (reg))
101 #define RTL_W16(reg, val16)     writew((val16), ioaddr + (reg))
102 #define RTL_W32(reg, val32)     writel((val32), ioaddr + (reg))
103 #define RTL_R8(reg)             readb(ioaddr + (reg))
104 #define RTL_R16(reg)            readw(ioaddr + (reg))
105 #define RTL_R32(reg)            readl(ioaddr + (reg))
106
107 #define bus_to_phys(a)  pci_mem_to_phys((pci_dev_t)(unsigned long)dev->priv, \
108         (pci_addr_t)(unsigned long)a)
109 #define phys_to_bus(a)  pci_phys_to_mem((pci_dev_t)(unsigned long)dev->priv, \
110         (phys_addr_t)a)
111
112 enum RTL8169_registers {
113         MAC0 = 0,               /* Ethernet hardware address. */
114         MAR0 = 8,               /* Multicast filter. */
115         TxDescStartAddrLow = 0x20,
116         TxDescStartAddrHigh = 0x24,
117         TxHDescStartAddrLow = 0x28,
118         TxHDescStartAddrHigh = 0x2c,
119         FLASH = 0x30,
120         ERSR = 0x36,
121         ChipCmd = 0x37,
122         TxPoll = 0x38,
123         IntrMask = 0x3C,
124         IntrStatus = 0x3E,
125         TxConfig = 0x40,
126         RxConfig = 0x44,
127         RxMissed = 0x4C,
128         Cfg9346 = 0x50,
129         Config0 = 0x51,
130         Config1 = 0x52,
131         Config2 = 0x53,
132         Config3 = 0x54,
133         Config4 = 0x55,
134         Config5 = 0x56,
135         MultiIntr = 0x5C,
136         PHYAR = 0x60,
137         TBICSR = 0x64,
138         TBI_ANAR = 0x68,
139         TBI_LPAR = 0x6A,
140         PHYstatus = 0x6C,
141         RxMaxSize = 0xDA,
142         CPlusCmd = 0xE0,
143         RxDescStartAddrLow = 0xE4,
144         RxDescStartAddrHigh = 0xE8,
145         EarlyTxThres = 0xEC,
146         FuncEvent = 0xF0,
147         FuncEventMask = 0xF4,
148         FuncPresetState = 0xF8,
149         FuncForceEvent = 0xFC,
150 };
151
152 enum RTL8169_register_content {
153         /*InterruptStatusBits */
154         SYSErr = 0x8000,
155         PCSTimeout = 0x4000,
156         SWInt = 0x0100,
157         TxDescUnavail = 0x80,
158         RxFIFOOver = 0x40,
159         RxUnderrun = 0x20,
160         RxOverflow = 0x10,
161         TxErr = 0x08,
162         TxOK = 0x04,
163         RxErr = 0x02,
164         RxOK = 0x01,
165
166         /*RxStatusDesc */
167         RxRES = 0x00200000,
168         RxCRC = 0x00080000,
169         RxRUNT = 0x00100000,
170         RxRWT = 0x00400000,
171
172         /*ChipCmdBits */
173         CmdReset = 0x10,
174         CmdRxEnb = 0x08,
175         CmdTxEnb = 0x04,
176         RxBufEmpty = 0x01,
177
178         /*Cfg9346Bits */
179         Cfg9346_Lock = 0x00,
180         Cfg9346_Unlock = 0xC0,
181
182         /*rx_mode_bits */
183         AcceptErr = 0x20,
184         AcceptRunt = 0x10,
185         AcceptBroadcast = 0x08,
186         AcceptMulticast = 0x04,
187         AcceptMyPhys = 0x02,
188         AcceptAllPhys = 0x01,
189
190         /*RxConfigBits */
191         RxCfgFIFOShift = 13,
192         RxCfgDMAShift = 8,
193
194         /*TxConfigBits */
195         TxInterFrameGapShift = 24,
196         TxDMAShift = 8,         /* DMA burst value (0-7) is shift this many bits */
197
198         /*rtl8169_PHYstatus */
199         TBI_Enable = 0x80,
200         TxFlowCtrl = 0x40,
201         RxFlowCtrl = 0x20,
202         _1000bpsF = 0x10,
203         _100bps = 0x08,
204         _10bps = 0x04,
205         LinkStatus = 0x02,
206         FullDup = 0x01,
207
208         /*GIGABIT_PHY_registers */
209         PHY_CTRL_REG = 0,
210         PHY_STAT_REG = 1,
211         PHY_AUTO_NEGO_REG = 4,
212         PHY_1000_CTRL_REG = 9,
213
214         /*GIGABIT_PHY_REG_BIT */
215         PHY_Restart_Auto_Nego = 0x0200,
216         PHY_Enable_Auto_Nego = 0x1000,
217
218         /* PHY_STAT_REG = 1; */
219         PHY_Auto_Nego_Comp = 0x0020,
220
221         /* PHY_AUTO_NEGO_REG = 4; */
222         PHY_Cap_10_Half = 0x0020,
223         PHY_Cap_10_Full = 0x0040,
224         PHY_Cap_100_Half = 0x0080,
225         PHY_Cap_100_Full = 0x0100,
226
227         /* PHY_1000_CTRL_REG = 9; */
228         PHY_Cap_1000_Full = 0x0200,
229
230         PHY_Cap_Null = 0x0,
231
232         /*_MediaType*/
233         _10_Half = 0x01,
234         _10_Full = 0x02,
235         _100_Half = 0x04,
236         _100_Full = 0x08,
237         _1000_Full = 0x10,
238
239         /*_TBICSRBit*/
240         TBILinkOK = 0x02000000,
241 };
242
243 static struct {
244         const char *name;
245         u8 version;             /* depend on RTL8169 docs */
246         u32 RxConfigMask;       /* should clear the bits supported by this chip */
247 } rtl_chip_info[] = {
248         {"RTL-8169", 0x00, 0xff7e1880,},
249         {"RTL-8169", 0x04, 0xff7e1880,},
250         {"RTL-8169", 0x00, 0xff7e1880,},
251         {"RTL-8169s/8110s",     0x02, 0xff7e1880,},
252         {"RTL-8169s/8110s",     0x04, 0xff7e1880,},
253         {"RTL-8169sb/8110sb",   0x10, 0xff7e1880,},
254         {"RTL-8169sc/8110sc",   0x18, 0xff7e1880,},
255         {"RTL-8168b/8111sb",    0x30, 0xff7e1880,},
256         {"RTL-8168b/8111sb",    0x38, 0xff7e1880,},
257         {"RTL-8168c/8111c",     0x3c, 0xff7e1880,},
258         {"RTL-8168d/8111d",     0x28, 0xff7e1880,},
259         {"RTL-8168evl/8111evl", 0x2e, 0xff7e1880,},
260         {"RTL-8168/8111g",      0x4c, 0xff7e1880,},
261         {"RTL-8101e",           0x34, 0xff7e1880,},
262         {"RTL-8100e",           0x32, 0xff7e1880,},
263         {"RTL-8168h/8111h",     0x54, 0xff7e1880,},
264 };
265
266 enum _DescStatusBit {
267         OWNbit = 0x80000000,
268         EORbit = 0x40000000,
269         FSbit = 0x20000000,
270         LSbit = 0x10000000,
271 };
272
273 struct TxDesc {
274         u32 status;
275         u32 vlan_tag;
276         u32 buf_addr;
277         u32 buf_Haddr;
278 };
279
280 struct RxDesc {
281         u32 status;
282         u32 vlan_tag;
283         u32 buf_addr;
284         u32 buf_Haddr;
285 };
286
287 static unsigned char rxdata[RX_BUF_LEN];
288
289 #define RTL8169_DESC_SIZE 16
290
291 #if ARCH_DMA_MINALIGN > 256
292 #  define RTL8169_ALIGN ARCH_DMA_MINALIGN
293 #else
294 #  define RTL8169_ALIGN 256
295 #endif
296
297 /*
298  * Warn if the cache-line size is larger than the descriptor size. In such
299  * cases the driver will likely fail because the CPU needs to flush the cache
300  * when requeuing RX buffers, therefore descriptors written by the hardware
301  * may be discarded.
302  *
303  * This can be fixed by defining CONFIG_SYS_NONCACHED_MEMORY which will cause
304  * the driver to allocate descriptors from a pool of non-cached memory.
305  */
306 #if RTL8169_DESC_SIZE < ARCH_DMA_MINALIGN
307 #if !defined(CONFIG_SYS_NONCACHED_MEMORY) && \
308         !CONFIG_IS_ENABLED(SYS_DCACHE_OFF) && !defined(CONFIG_X86)
309 #warning cache-line size is larger than descriptor size
310 #endif
311 #endif
312
313 /*
314  * Create a static buffer of size RX_BUF_SZ for each TX Descriptor. All
315  * descriptors point to a part of this buffer.
316  */
317 DEFINE_ALIGN_BUFFER(u8, txb, NUM_TX_DESC * RX_BUF_SIZE, RTL8169_ALIGN);
318
319 /*
320  * Create a static buffer of size RX_BUF_SZ for each RX Descriptor. All
321  * descriptors point to a part of this buffer.
322  */
323 DEFINE_ALIGN_BUFFER(u8, rxb, NUM_RX_DESC * RX_BUF_SIZE, RTL8169_ALIGN);
324
325 struct rtl8169_private {
326         ulong iobase;
327         void *mmio_addr;        /* memory map physical address */
328         int chipset;
329         unsigned long cur_rx;   /* Index into the Rx descriptor buffer of next Rx pkt. */
330         unsigned long cur_tx;   /* Index into the Tx descriptor buffer of next Rx pkt. */
331         unsigned long dirty_tx;
332         struct TxDesc *TxDescArray;     /* Index of 256-alignment Tx Descriptor buffer */
333         struct RxDesc *RxDescArray;     /* Index of 256-alignment Rx Descriptor buffer */
334         unsigned char *RxBufferRings;   /* Index of Rx Buffer  */
335         unsigned char *RxBufferRing[NUM_RX_DESC];       /* Index of Rx Buffer array */
336         unsigned char *Tx_skbuff[NUM_TX_DESC];
337 } tpx;
338
339 static struct rtl8169_private *tpc;
340
341 static const unsigned int rtl8169_rx_config =
342     (RX_FIFO_THRESH << RxCfgFIFOShift) | (RX_DMA_BURST << RxCfgDMAShift);
343
344 static struct pci_device_id supported[] = {
345         { PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8167) },
346         { PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8168) },
347         { PCI_DEVICE(PCI_VENDOR_ID_REALTEK, 0x8169) },
348         {}
349 };
350
351 void mdio_write(int RegAddr, int value)
352 {
353         int i;
354
355         RTL_W32(PHYAR, 0x80000000 | (RegAddr & 0xFF) << 16 | value);
356         udelay(1000);
357
358         for (i = 2000; i > 0; i--) {
359                 /* Check if the RTL8169 has completed writing to the specified MII register */
360                 if (!(RTL_R32(PHYAR) & 0x80000000)) {
361                         break;
362                 } else {
363                         udelay(100);
364                 }
365         }
366 }
367
368 int mdio_read(int RegAddr)
369 {
370         int i, value = -1;
371
372         RTL_W32(PHYAR, 0x0 | (RegAddr & 0xFF) << 16);
373         udelay(1000);
374
375         for (i = 2000; i > 0; i--) {
376                 /* Check if the RTL8169 has completed retrieving data from the specified MII register */
377                 if (RTL_R32(PHYAR) & 0x80000000) {
378                         value = (int) (RTL_R32(PHYAR) & 0xFFFF);
379                         break;
380                 } else {
381                         udelay(100);
382                 }
383         }
384         return value;
385 }
386
387 static int rtl8169_init_board(unsigned long dev_iobase, const char *name)
388 {
389         int i;
390         u32 tmp;
391
392 #ifdef DEBUG_RTL8169
393         printf ("%s\n", __FUNCTION__);
394 #endif
395         ioaddr = dev_iobase;
396
397         /* Soft reset the chip. */
398         RTL_W8(ChipCmd, CmdReset);
399
400         /* Check that the chip has finished the reset. */
401         for (i = 1000; i > 0; i--)
402                 if ((RTL_R8(ChipCmd) & CmdReset) == 0)
403                         break;
404                 else
405                         udelay(10);
406
407         /* identify chip attached to board */
408         tmp = RTL_R32(TxConfig);
409         tmp = ((tmp & 0x7c000000) + ((tmp & 0x00800000) << 2)) >> 24;
410
411         for (i = ARRAY_SIZE(rtl_chip_info) - 1; i >= 0; i--){
412                 if (tmp == rtl_chip_info[i].version) {
413                         tpc->chipset = i;
414                         goto match;
415                 }
416         }
417
418         /* if unknown chip, assume array element #0, original RTL-8169 in this case */
419         printf("PCI device %s: unknown chip version, assuming RTL-8169\n",
420                name);
421         printf("PCI device: TxConfig = 0x%lX\n", (unsigned long) RTL_R32(TxConfig));
422         tpc->chipset = 0;
423
424 match:
425         return 0;
426 }
427
428 /*
429  * TX and RX descriptors are 16 bytes. This causes problems with the cache
430  * maintenance on CPUs where the cache-line size exceeds the size of these
431  * descriptors. What will happen is that when the driver receives a packet
432  * it will be immediately requeued for the hardware to reuse. The CPU will
433  * therefore need to flush the cache-line containing the descriptor, which
434  * will cause all other descriptors in the same cache-line to be flushed
435  * along with it. If one of those descriptors had been written to by the
436  * device those changes (and the associated packet) will be lost.
437  *
438  * To work around this, we make use of non-cached memory if available. If
439  * descriptors are mapped uncached there's no need to manually flush them
440  * or invalidate them.
441  *
442  * Note that this only applies to descriptors. The packet data buffers do
443  * not have the same constraints since they are 1536 bytes large, so they
444  * are unlikely to share cache-lines.
445  */
446 static void *rtl_alloc_descs(unsigned int num)
447 {
448         size_t size = num * RTL8169_DESC_SIZE;
449
450 #ifdef CONFIG_SYS_NONCACHED_MEMORY
451         return (void *)noncached_alloc(size, RTL8169_ALIGN);
452 #else
453         return memalign(RTL8169_ALIGN, size);
454 #endif
455 }
456
457 /*
458  * Cache maintenance functions. These are simple wrappers around the more
459  * general purpose flush_cache() and invalidate_dcache_range() functions.
460  */
461
462 static void rtl_inval_rx_desc(struct RxDesc *desc)
463 {
464 #ifndef CONFIG_SYS_NONCACHED_MEMORY
465         unsigned long start = (unsigned long)desc & ~(ARCH_DMA_MINALIGN - 1);
466         unsigned long end = ALIGN(start + sizeof(*desc), ARCH_DMA_MINALIGN);
467
468         invalidate_dcache_range(start, end);
469 #endif
470 }
471
472 static void rtl_flush_rx_desc(struct RxDesc *desc)
473 {
474 #ifndef CONFIG_SYS_NONCACHED_MEMORY
475         flush_cache((unsigned long)desc, sizeof(*desc));
476 #endif
477 }
478
479 static void rtl_inval_tx_desc(struct TxDesc *desc)
480 {
481 #ifndef CONFIG_SYS_NONCACHED_MEMORY
482         unsigned long start = (unsigned long)desc & ~(ARCH_DMA_MINALIGN - 1);
483         unsigned long end = ALIGN(start + sizeof(*desc), ARCH_DMA_MINALIGN);
484
485         invalidate_dcache_range(start, end);
486 #endif
487 }
488
489 static void rtl_flush_tx_desc(struct TxDesc *desc)
490 {
491 #ifndef CONFIG_SYS_NONCACHED_MEMORY
492         flush_cache((unsigned long)desc, sizeof(*desc));
493 #endif
494 }
495
496 static void rtl_inval_buffer(void *buf, size_t size)
497 {
498         unsigned long start = (unsigned long)buf & ~(ARCH_DMA_MINALIGN - 1);
499         unsigned long end = ALIGN(start + size, ARCH_DMA_MINALIGN);
500
501         invalidate_dcache_range(start, end);
502 }
503
504 static void rtl_flush_buffer(void *buf, size_t size)
505 {
506         flush_cache((unsigned long)buf, size);
507 }
508
509 /**************************************************************************
510 RECV - Receive a frame
511 ***************************************************************************/
512 #ifdef CONFIG_DM_ETH
513 static int rtl_recv_common(struct udevice *dev, unsigned long dev_iobase,
514                            uchar **packetp)
515 #else
516 static int rtl_recv_common(pci_dev_t dev, unsigned long dev_iobase,
517                            uchar **packetp)
518 #endif
519 {
520         /* return true if there's an ethernet packet ready to read */
521         /* nic->packet should contain data on return */
522         /* nic->packetlen should contain length of data */
523         int cur_rx;
524         int length = 0;
525
526 #ifdef DEBUG_RTL8169_RX
527         printf ("%s\n", __FUNCTION__);
528 #endif
529         ioaddr = dev_iobase;
530
531         cur_rx = tpc->cur_rx;
532
533         rtl_inval_rx_desc(&tpc->RxDescArray[cur_rx]);
534
535         if ((le32_to_cpu(tpc->RxDescArray[cur_rx].status) & OWNbit) == 0) {
536                 if (!(le32_to_cpu(tpc->RxDescArray[cur_rx].status) & RxRES)) {
537                         length = (int) (le32_to_cpu(tpc->RxDescArray[cur_rx].
538                                                 status) & 0x00001FFF) - 4;
539
540                         rtl_inval_buffer(tpc->RxBufferRing[cur_rx], length);
541                         memcpy(rxdata, tpc->RxBufferRing[cur_rx], length);
542
543                         if (cur_rx == NUM_RX_DESC - 1)
544                                 tpc->RxDescArray[cur_rx].status =
545                                         cpu_to_le32((OWNbit | EORbit) + RX_BUF_SIZE);
546                         else
547                                 tpc->RxDescArray[cur_rx].status =
548                                         cpu_to_le32(OWNbit + RX_BUF_SIZE);
549 #ifdef CONFIG_DM_ETH
550                         tpc->RxDescArray[cur_rx].buf_addr = cpu_to_le32(
551                                 dm_pci_mem_to_phys(dev,
552                                         (pci_addr_t)(unsigned long)
553                                         tpc->RxBufferRing[cur_rx]));
554 #else
555                         tpc->RxDescArray[cur_rx].buf_addr = cpu_to_le32(
556                                 pci_mem_to_phys(dev, (pci_addr_t)(unsigned long)
557                                 tpc->RxBufferRing[cur_rx]));
558 #endif
559                         rtl_flush_rx_desc(&tpc->RxDescArray[cur_rx]);
560 #ifdef CONFIG_DM_ETH
561                         *packetp = rxdata;
562 #else
563                         net_process_received_packet(rxdata, length);
564 #endif
565                 } else {
566                         puts("Error Rx");
567                         length = -EIO;
568                 }
569                 cur_rx = (cur_rx + 1) % NUM_RX_DESC;
570                 tpc->cur_rx = cur_rx;
571                 return length;
572
573         } else {
574                 ushort sts = RTL_R8(IntrStatus);
575                 RTL_W8(IntrStatus, sts & ~(TxErr | RxErr | SYSErr));
576                 udelay(100);    /* wait */
577         }
578         tpc->cur_rx = cur_rx;
579         return (0);             /* initially as this is called to flush the input */
580 }
581
582 #ifdef CONFIG_DM_ETH
583 int rtl8169_eth_recv(struct udevice *dev, int flags, uchar **packetp)
584 {
585         struct rtl8169_private *priv = dev_get_priv(dev);
586
587         return rtl_recv_common(dev, priv->iobase, packetp);
588 }
589 #else
590 static int rtl_recv(struct eth_device *dev)
591 {
592         return rtl_recv_common((pci_dev_t)(unsigned long)dev->priv,
593                                dev->iobase, NULL);
594 }
595 #endif /* nCONFIG_DM_ETH */
596
597 #define HZ 1000
598 /**************************************************************************
599 SEND - Transmit a frame
600 ***************************************************************************/
601 #ifdef CONFIG_DM_ETH
602 static int rtl_send_common(struct udevice *dev, unsigned long dev_iobase,
603                            void *packet, int length)
604 #else
605 static int rtl_send_common(pci_dev_t dev, unsigned long dev_iobase,
606                            void *packet, int length)
607 #endif
608 {
609         /* send the packet to destination */
610
611         u32 to;
612         u8 *ptxb;
613         int entry = tpc->cur_tx % NUM_TX_DESC;
614         u32 len = length;
615         int ret;
616
617 #ifdef DEBUG_RTL8169_TX
618         int stime = currticks();
619         printf ("%s\n", __FUNCTION__);
620         printf("sending %d bytes\n", len);
621 #endif
622
623         ioaddr = dev_iobase;
624
625         /* point to the current txb incase multiple tx_rings are used */
626         ptxb = tpc->Tx_skbuff[entry * MAX_ETH_FRAME_SIZE];
627         memcpy(ptxb, (char *)packet, (int)length);
628
629         while (len < ETH_ZLEN)
630                 ptxb[len++] = '\0';
631
632         rtl_flush_buffer(ptxb, ALIGN(len, RTL8169_ALIGN));
633
634         tpc->TxDescArray[entry].buf_Haddr = 0;
635 #ifdef CONFIG_DM_ETH
636         tpc->TxDescArray[entry].buf_addr = cpu_to_le32(
637                 dm_pci_mem_to_phys(dev, (pci_addr_t)(unsigned long)ptxb));
638 #else
639         tpc->TxDescArray[entry].buf_addr = cpu_to_le32(
640                 pci_mem_to_phys(dev, (pci_addr_t)(unsigned long)ptxb));
641 #endif
642         if (entry != (NUM_TX_DESC - 1)) {
643                 tpc->TxDescArray[entry].status =
644                         cpu_to_le32((OWNbit | FSbit | LSbit) |
645                                     ((len > ETH_ZLEN) ? len : ETH_ZLEN));
646         } else {
647                 tpc->TxDescArray[entry].status =
648                         cpu_to_le32((OWNbit | EORbit | FSbit | LSbit) |
649                                     ((len > ETH_ZLEN) ? len : ETH_ZLEN));
650         }
651         rtl_flush_tx_desc(&tpc->TxDescArray[entry]);
652         RTL_W8(TxPoll, 0x40);   /* set polling bit */
653
654         tpc->cur_tx++;
655         to = currticks() + TX_TIMEOUT;
656         do {
657                 rtl_inval_tx_desc(&tpc->TxDescArray[entry]);
658         } while ((le32_to_cpu(tpc->TxDescArray[entry].status) & OWNbit)
659                                 && (currticks() < to)); /* wait */
660
661         if (currticks() >= to) {
662 #ifdef DEBUG_RTL8169_TX
663                 puts("tx timeout/error\n");
664                 printf("%s elapsed time : %lu\n", __func__, currticks()-stime);
665 #endif
666                 ret = -ETIMEDOUT;
667         } else {
668 #ifdef DEBUG_RTL8169_TX
669                 puts("tx done\n");
670 #endif
671                 ret = 0;
672         }
673         /* Delay to make net console (nc) work properly */
674         udelay(20);
675         return ret;
676 }
677
678 #ifdef CONFIG_DM_ETH
679 int rtl8169_eth_send(struct udevice *dev, void *packet, int length)
680 {
681         struct rtl8169_private *priv = dev_get_priv(dev);
682
683         return rtl_send_common(dev, priv->iobase, packet, length);
684 }
685
686 #else
687 static int rtl_send(struct eth_device *dev, void *packet, int length)
688 {
689         return rtl_send_common((pci_dev_t)(unsigned long)dev->priv,
690                                dev->iobase, packet, length);
691 }
692 #endif
693
694 static void rtl8169_set_rx_mode(void)
695 {
696         u32 mc_filter[2];       /* Multicast hash filter */
697         int rx_mode;
698         u32 tmp = 0;
699
700 #ifdef DEBUG_RTL8169
701         printf ("%s\n", __FUNCTION__);
702 #endif
703
704         /* IFF_ALLMULTI */
705         /* Too many to filter perfectly -- accept all multicasts. */
706         rx_mode = AcceptBroadcast | AcceptMulticast | AcceptMyPhys;
707         mc_filter[1] = mc_filter[0] = 0xffffffff;
708
709         tmp = rtl8169_rx_config | rx_mode | (RTL_R32(RxConfig) &
710                                    rtl_chip_info[tpc->chipset].RxConfigMask);
711
712         RTL_W32(RxConfig, tmp);
713         RTL_W32(MAR0 + 0, mc_filter[0]);
714         RTL_W32(MAR0 + 4, mc_filter[1]);
715 }
716
717 #ifdef CONFIG_DM_ETH
718 static void rtl8169_hw_start(struct udevice *dev)
719 #else
720 static void rtl8169_hw_start(pci_dev_t dev)
721 #endif
722 {
723         u32 i;
724
725 #ifdef DEBUG_RTL8169
726         int stime = currticks();
727         printf ("%s\n", __FUNCTION__);
728 #endif
729
730 #if 0
731         /* Soft reset the chip. */
732         RTL_W8(ChipCmd, CmdReset);
733
734         /* Check that the chip has finished the reset. */
735         for (i = 1000; i > 0; i--) {
736                 if ((RTL_R8(ChipCmd) & CmdReset) == 0)
737                         break;
738                 else
739                         udelay(10);
740         }
741 #endif
742
743         RTL_W8(Cfg9346, Cfg9346_Unlock);
744
745         /* RTL-8169sb/8110sb or previous version */
746         if (tpc->chipset <= 5)
747                 RTL_W8(ChipCmd, CmdTxEnb | CmdRxEnb);
748
749         RTL_W8(EarlyTxThres, EarlyTxThld);
750
751         /* For gigabit rtl8169 */
752         RTL_W16(RxMaxSize, RxPacketMaxSize);
753
754         /* Set Rx Config register */
755         i = rtl8169_rx_config | (RTL_R32(RxConfig) &
756                                  rtl_chip_info[tpc->chipset].RxConfigMask);
757         RTL_W32(RxConfig, i);
758
759         /* Set DMA burst size and Interframe Gap Time */
760         RTL_W32(TxConfig, (TX_DMA_BURST << TxDMAShift) |
761                                 (InterFrameGap << TxInterFrameGapShift));
762
763
764         tpc->cur_rx = 0;
765
766 #ifdef CONFIG_DM_ETH
767         RTL_W32(TxDescStartAddrLow, dm_pci_mem_to_phys(dev,
768                         (pci_addr_t)(unsigned long)tpc->TxDescArray));
769 #else
770         RTL_W32(TxDescStartAddrLow, pci_mem_to_phys(dev,
771                         (pci_addr_t)(unsigned long)tpc->TxDescArray));
772 #endif
773         RTL_W32(TxDescStartAddrHigh, (unsigned long)0);
774 #ifdef CONFIG_DM_ETH
775         RTL_W32(RxDescStartAddrLow, dm_pci_mem_to_phys(
776                         dev, (pci_addr_t)(unsigned long)tpc->RxDescArray));
777 #else
778         RTL_W32(RxDescStartAddrLow, pci_mem_to_phys(
779                         dev, (pci_addr_t)(unsigned long)tpc->RxDescArray));
780 #endif
781         RTL_W32(RxDescStartAddrHigh, (unsigned long)0);
782
783         /* RTL-8169sc/8110sc or later version */
784         if (tpc->chipset > 5)
785                 RTL_W8(ChipCmd, CmdTxEnb | CmdRxEnb);
786
787         RTL_W8(Cfg9346, Cfg9346_Lock);
788         udelay(10);
789
790         RTL_W32(RxMissed, 0);
791
792         rtl8169_set_rx_mode();
793
794         /* no early-rx interrupts */
795         RTL_W16(MultiIntr, RTL_R16(MultiIntr) & 0xF000);
796
797 #ifdef DEBUG_RTL8169
798         printf("%s elapsed time : %lu\n", __func__, currticks()-stime);
799 #endif
800 }
801
802 #ifdef CONFIG_DM_ETH
803 static void rtl8169_init_ring(struct udevice *dev)
804 #else
805 static void rtl8169_init_ring(pci_dev_t dev)
806 #endif
807 {
808         int i;
809
810 #ifdef DEBUG_RTL8169
811         int stime = currticks();
812         printf ("%s\n", __FUNCTION__);
813 #endif
814
815         tpc->cur_rx = 0;
816         tpc->cur_tx = 0;
817         tpc->dirty_tx = 0;
818         memset(tpc->TxDescArray, 0x0, NUM_TX_DESC * sizeof(struct TxDesc));
819         memset(tpc->RxDescArray, 0x0, NUM_RX_DESC * sizeof(struct RxDesc));
820
821         for (i = 0; i < NUM_TX_DESC; i++) {
822                 tpc->Tx_skbuff[i] = &txb[i];
823         }
824
825         for (i = 0; i < NUM_RX_DESC; i++) {
826                 if (i == (NUM_RX_DESC - 1))
827                         tpc->RxDescArray[i].status =
828                                 cpu_to_le32((OWNbit | EORbit) + RX_BUF_SIZE);
829                 else
830                         tpc->RxDescArray[i].status =
831                                 cpu_to_le32(OWNbit + RX_BUF_SIZE);
832
833                 tpc->RxBufferRing[i] = &rxb[i * RX_BUF_SIZE];
834 #ifdef CONFIG_DM_ETH
835                 tpc->RxDescArray[i].buf_addr = cpu_to_le32(dm_pci_mem_to_phys(
836                         dev, (pci_addr_t)(unsigned long)tpc->RxBufferRing[i]));
837 #else
838                 tpc->RxDescArray[i].buf_addr = cpu_to_le32(pci_mem_to_phys(
839                         dev, (pci_addr_t)(unsigned long)tpc->RxBufferRing[i]));
840 #endif
841                 rtl_flush_rx_desc(&tpc->RxDescArray[i]);
842         }
843
844 #ifdef DEBUG_RTL8169
845         printf("%s elapsed time : %lu\n", __func__, currticks()-stime);
846 #endif
847 }
848
849 #ifdef CONFIG_DM_ETH
850 static void rtl8169_common_start(struct udevice *dev, unsigned char *enetaddr,
851                                  unsigned long dev_iobase)
852 #else
853 static void rtl8169_common_start(pci_dev_t dev, unsigned char *enetaddr,
854                                  unsigned long dev_iobase)
855 #endif
856 {
857         int i;
858
859 #ifdef DEBUG_RTL8169
860         int stime = currticks();
861         printf ("%s\n", __FUNCTION__);
862 #endif
863
864         ioaddr = dev_iobase;
865
866         rtl8169_init_ring(dev);
867         rtl8169_hw_start(dev);
868         /* Construct a perfect filter frame with the mac address as first match
869          * and broadcast for all others */
870         for (i = 0; i < 192; i++)
871                 txb[i] = 0xFF;
872
873         txb[0] = enetaddr[0];
874         txb[1] = enetaddr[1];
875         txb[2] = enetaddr[2];
876         txb[3] = enetaddr[3];
877         txb[4] = enetaddr[4];
878         txb[5] = enetaddr[5];
879
880 #ifdef DEBUG_RTL8169
881         printf("%s elapsed time : %lu\n", __func__, currticks()-stime);
882 #endif
883 }
884
885 #ifdef CONFIG_DM_ETH
886 static int rtl8169_eth_start(struct udevice *dev)
887 {
888         struct eth_pdata *plat = dev_get_platdata(dev);
889         struct rtl8169_private *priv = dev_get_priv(dev);
890
891         rtl8169_common_start(dev, plat->enetaddr, priv->iobase);
892
893         return 0;
894 }
895 #else
896 /**************************************************************************
897 RESET - Finish setting up the ethernet interface
898 ***************************************************************************/
899 static int rtl_reset(struct eth_device *dev, bd_t *bis)
900 {
901         rtl8169_common_start((pci_dev_t)(unsigned long)dev->priv,
902                              dev->enetaddr, dev->iobase);
903
904         return 0;
905 }
906 #endif /* nCONFIG_DM_ETH */
907
908 static void rtl_halt_common(unsigned long dev_iobase)
909 {
910         int i;
911
912 #ifdef DEBUG_RTL8169
913         printf ("%s\n", __FUNCTION__);
914 #endif
915
916         ioaddr = dev_iobase;
917
918         /* Stop the chip's Tx and Rx DMA processes. */
919         RTL_W8(ChipCmd, 0x00);
920
921         /* Disable interrupts by clearing the interrupt mask. */
922         RTL_W16(IntrMask, 0x0000);
923
924         RTL_W32(RxMissed, 0);
925
926         for (i = 0; i < NUM_RX_DESC; i++) {
927                 tpc->RxBufferRing[i] = NULL;
928         }
929 }
930
931 #ifdef CONFIG_DM_ETH
932 void rtl8169_eth_stop(struct udevice *dev)
933 {
934         struct rtl8169_private *priv = dev_get_priv(dev);
935
936         rtl_halt_common(priv->iobase);
937 }
938 #else
939 /**************************************************************************
940 HALT - Turn off ethernet interface
941 ***************************************************************************/
942 static void rtl_halt(struct eth_device *dev)
943 {
944         rtl_halt_common(dev->iobase);
945 }
946 #endif
947
948 #ifdef CONFIG_DM_ETH
949 static int rtl8169_write_hwaddr(struct udevice *dev)
950 {
951         struct eth_pdata *plat = dev_get_platdata(dev);
952         unsigned int i;
953
954         RTL_W8(Cfg9346, Cfg9346_Unlock);
955
956         for (i = 0; i < MAC_ADDR_LEN; i++)
957                 RTL_W8(MAC0 + i, plat->enetaddr[i]);
958
959         RTL_W8(Cfg9346, Cfg9346_Lock);
960
961         return 0;
962 }
963 #endif
964
965 /**************************************************************************
966 INIT - Look for an adapter, this routine's visible to the outside
967 ***************************************************************************/
968
969 #define board_found 1
970 #define valid_link 0
971 static int rtl_init(unsigned long dev_ioaddr, const char *name,
972                     unsigned char *enetaddr)
973 {
974         static int board_idx = -1;
975         int i, rc;
976         int option = -1, Cap10_100 = 0, Cap1000 = 0;
977
978 #ifdef DEBUG_RTL8169
979         printf ("%s\n", __FUNCTION__);
980 #endif
981         ioaddr = dev_ioaddr;
982
983         board_idx++;
984
985         /* point to private storage */
986         tpc = &tpx;
987
988         rc = rtl8169_init_board(ioaddr, name);
989         if (rc)
990                 return rc;
991
992         /* Get MAC address.  FIXME: read EEPROM */
993         for (i = 0; i < MAC_ADDR_LEN; i++)
994                 enetaddr[i] = RTL_R8(MAC0 + i);
995
996 #ifdef DEBUG_RTL8169
997         printf("chipset = %d\n", tpc->chipset);
998         printf("MAC Address");
999         for (i = 0; i < MAC_ADDR_LEN; i++)
1000                 printf(":%02x", enetaddr[i]);
1001         putc('\n');
1002 #endif
1003
1004 #ifdef DEBUG_RTL8169
1005         /* Print out some hardware info */
1006         printf("%s: at ioaddr 0x%lx\n", name, ioaddr);
1007 #endif
1008
1009         /* if TBI is not endbled */
1010         if (!(RTL_R8(PHYstatus) & TBI_Enable)) {
1011                 int val = mdio_read(PHY_AUTO_NEGO_REG);
1012
1013                 option = (board_idx >= MAX_UNITS) ? 0 : media[board_idx];
1014                 /* Force RTL8169 in 10/100/1000 Full/Half mode. */
1015                 if (option > 0) {
1016 #ifdef DEBUG_RTL8169
1017                         printf("%s: Force-mode Enabled.\n", name);
1018 #endif
1019                         Cap10_100 = 0, Cap1000 = 0;
1020                         switch (option) {
1021                         case _10_Half:
1022                                 Cap10_100 = PHY_Cap_10_Half;
1023                                 Cap1000 = PHY_Cap_Null;
1024                                 break;
1025                         case _10_Full:
1026                                 Cap10_100 = PHY_Cap_10_Full;
1027                                 Cap1000 = PHY_Cap_Null;
1028                                 break;
1029                         case _100_Half:
1030                                 Cap10_100 = PHY_Cap_100_Half;
1031                                 Cap1000 = PHY_Cap_Null;
1032                                 break;
1033                         case _100_Full:
1034                                 Cap10_100 = PHY_Cap_100_Full;
1035                                 Cap1000 = PHY_Cap_Null;
1036                                 break;
1037                         case _1000_Full:
1038                                 Cap10_100 = PHY_Cap_Null;
1039                                 Cap1000 = PHY_Cap_1000_Full;
1040                                 break;
1041                         default:
1042                                 break;
1043                         }
1044                         mdio_write(PHY_AUTO_NEGO_REG, Cap10_100 | (val & 0x1F));        /* leave PHY_AUTO_NEGO_REG bit4:0 unchanged */
1045                         mdio_write(PHY_1000_CTRL_REG, Cap1000);
1046                 } else {
1047 #ifdef DEBUG_RTL8169
1048                         printf("%s: Auto-negotiation Enabled.\n",
1049                                name);
1050 #endif
1051                         /* enable 10/100 Full/Half Mode, leave PHY_AUTO_NEGO_REG bit4:0 unchanged */
1052                         mdio_write(PHY_AUTO_NEGO_REG,
1053                                    PHY_Cap_10_Half | PHY_Cap_10_Full |
1054                                    PHY_Cap_100_Half | PHY_Cap_100_Full |
1055                                    (val & 0x1F));
1056
1057                         /* enable 1000 Full Mode */
1058                         mdio_write(PHY_1000_CTRL_REG, PHY_Cap_1000_Full);
1059
1060                 }
1061
1062                 /* Enable auto-negotiation and restart auto-nigotiation */
1063                 mdio_write(PHY_CTRL_REG,
1064                            PHY_Enable_Auto_Nego | PHY_Restart_Auto_Nego);
1065                 udelay(100);
1066
1067                 /* wait for auto-negotiation process */
1068                 for (i = 10000; i > 0; i--) {
1069                         /* check if auto-negotiation complete */
1070                         if (mdio_read(PHY_STAT_REG) & PHY_Auto_Nego_Comp) {
1071                                 udelay(100);
1072                                 option = RTL_R8(PHYstatus);
1073                                 if (option & _1000bpsF) {
1074 #ifdef DEBUG_RTL8169
1075                                         printf("%s: 1000Mbps Full-duplex operation.\n",
1076                                                name);
1077 #endif
1078                                 } else {
1079 #ifdef DEBUG_RTL8169
1080                                         printf("%s: %sMbps %s-duplex operation.\n",
1081                                                name,
1082                                                (option & _100bps) ? "100" :
1083                                                "10",
1084                                                (option & FullDup) ? "Full" :
1085                                                "Half");
1086 #endif
1087                                 }
1088                                 break;
1089                         } else {
1090                                 udelay(100);
1091                         }
1092                 }               /* end for-loop to wait for auto-negotiation process */
1093
1094         } else {
1095                 udelay(100);
1096 #ifdef DEBUG_RTL8169
1097                 printf
1098                     ("%s: 1000Mbps Full-duplex operation, TBI Link %s!\n",
1099                      name,
1100                      (RTL_R32(TBICSR) & TBILinkOK) ? "OK" : "Failed");
1101 #endif
1102         }
1103
1104
1105         tpc->RxDescArray = rtl_alloc_descs(NUM_RX_DESC);
1106         if (!tpc->RxDescArray)
1107                 return -ENOMEM;
1108
1109         tpc->TxDescArray = rtl_alloc_descs(NUM_TX_DESC);
1110         if (!tpc->TxDescArray)
1111                 return -ENOMEM;
1112
1113         return 0;
1114 }
1115
1116 #ifndef CONFIG_DM_ETH
1117 int rtl8169_initialize(bd_t *bis)
1118 {
1119         pci_dev_t devno;
1120         int card_number = 0;
1121         struct eth_device *dev;
1122         u32 iobase;
1123         int idx=0;
1124
1125         while(1){
1126                 unsigned int region;
1127                 u16 device;
1128                 int err;
1129
1130                 /* Find RTL8169 */
1131                 if ((devno = pci_find_devices(supported, idx++)) < 0)
1132                         break;
1133
1134                 pci_read_config_word(devno, PCI_DEVICE_ID, &device);
1135                 switch (device) {
1136                 case 0x8168:
1137                         region = 2;
1138                         break;
1139
1140                 default:
1141                         region = 1;
1142                         break;
1143                 }
1144
1145                 pci_read_config_dword(devno, PCI_BASE_ADDRESS_0 + (region * 4), &iobase);
1146                 iobase &= ~0xf;
1147
1148                 debug ("rtl8169: REALTEK RTL8169 @0x%x\n", iobase);
1149
1150                 dev = (struct eth_device *)malloc(sizeof *dev);
1151                 if (!dev) {
1152                         printf("Can not allocate memory of rtl8169\n");
1153                         break;
1154                 }
1155
1156                 memset(dev, 0, sizeof(*dev));
1157                 sprintf (dev->name, "RTL8169#%d", card_number);
1158
1159                 dev->priv = (void *)(unsigned long)devno;
1160                 dev->iobase = (int)pci_mem_to_phys(devno, iobase);
1161
1162                 dev->init = rtl_reset;
1163                 dev->halt = rtl_halt;
1164                 dev->send = rtl_send;
1165                 dev->recv = rtl_recv;
1166
1167                 err = rtl_init(dev->iobase, dev->name, dev->enetaddr);
1168                 if (err < 0) {
1169                         printf(pr_fmt("failed to initialize card: %d\n"), err);
1170                         free(dev);
1171                         continue;
1172                 }
1173
1174                 eth_register (dev);
1175
1176                 card_number++;
1177         }
1178         return card_number;
1179 }
1180 #endif
1181
1182 #ifdef CONFIG_DM_ETH
1183 static int rtl8169_eth_probe(struct udevice *dev)
1184 {
1185         struct pci_child_platdata *pplat = dev_get_parent_platdata(dev);
1186         struct rtl8169_private *priv = dev_get_priv(dev);
1187         struct eth_pdata *plat = dev_get_platdata(dev);
1188         u32 iobase;
1189         int region;
1190         int ret;
1191
1192         debug("rtl8169: REALTEK RTL8169 @0x%x\n", iobase);
1193         switch (pplat->device) {
1194         case 0x8168:
1195                 region = 2;
1196                 break;
1197         default:
1198                 region = 1;
1199                 break;
1200         }
1201         dm_pci_read_config32(dev, PCI_BASE_ADDRESS_0 + region * 4, &iobase);
1202         iobase &= ~0xf;
1203         priv->iobase = (int)dm_pci_mem_to_phys(dev, iobase);
1204
1205         ret = rtl_init(priv->iobase, dev->name, plat->enetaddr);
1206         if (ret < 0) {
1207                 printf(pr_fmt("failed to initialize card: %d\n"), ret);
1208                 return ret;
1209         }
1210
1211         return 0;
1212 }
1213
1214 static const struct eth_ops rtl8169_eth_ops = {
1215         .start  = rtl8169_eth_start,
1216         .send   = rtl8169_eth_send,
1217         .recv   = rtl8169_eth_recv,
1218         .stop   = rtl8169_eth_stop,
1219         .write_hwaddr = rtl8169_write_hwaddr,
1220 };
1221
1222 static const struct udevice_id rtl8169_eth_ids[] = {
1223         { .compatible = "realtek,rtl8169" },
1224         { }
1225 };
1226
1227 U_BOOT_DRIVER(eth_rtl8169) = {
1228         .name   = "eth_rtl8169",
1229         .id     = UCLASS_ETH,
1230         .of_match = rtl8169_eth_ids,
1231         .probe  = rtl8169_eth_probe,
1232         .ops    = &rtl8169_eth_ops,
1233         .priv_auto_alloc_size = sizeof(struct rtl8169_private),
1234         .platdata_auto_alloc_size = sizeof(struct eth_pdata),
1235 };
1236
1237 U_BOOT_PCI_DEVICE(eth_rtl8169, supported);
1238 #endif