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