blob: d8f24ec81a2f743058953445765a56950c379c30 [file] [log] [blame]
Marek Vasut7f532562020-04-12 23:49:25 +02001// SPDX-License-Identifier: GPL-2.0
wdenk0260cd62004-01-02 15:01:32 +00002/*
3 * rtl8139.c : U-Boot driver for the RealTek RTL8139
4 *
5 * Masami Komiya (mkomiya@sonare.it)
6 *
7 * Most part is taken from rtl8139.c of etherboot
8 *
9 */
10
11/* rtl8139.c - etherboot driver for the Realtek 8139 chipset
Marek Vasut278734b2020-04-12 23:01:45 +020012 *
13 * ported from the linux driver written by Donald Becker
14 * by Rainer Bawidamann (Rainer.Bawidamann@informatik.uni-ulm.de) 1999
15 *
Marek Vasut278734b2020-04-12 23:01:45 +020016 * changes to the original driver:
17 * - removed support for interrupts, switching to polling mode (yuck!)
18 * - removed support for the 8129 chip (external MII)
19 */
wdenk0260cd62004-01-02 15:01:32 +000020
21/*********************************************************************/
22/* Revision History */
23/*********************************************************************/
24
25/*
Marek Vasut278734b2020-04-12 23:01:45 +020026 * 28 Dec 2002 ken_yap@users.sourceforge.net (Ken Yap)
27 * Put in virt_to_bus calls to allow Etherboot relocation.
28 *
29 * 06 Apr 2001 ken_yap@users.sourceforge.net (Ken Yap)
30 * Following email from Hyun-Joon Cha, added a disable routine, otherwise
31 * NIC remains live and can crash the kernel later.
32 *
33 * 4 Feb 2000 espenlaub@informatik.uni-ulm.de (Klaus Espenlaub)
34 * Shuffled things around, removed the leftovers from the 8129 support
35 * that was in the Linux driver and added a bit more 8139 definitions.
36 * Moved the 8K receive buffer to a fixed, available address outside the
37 * 0x98000-0x9ffff range. This is a bit of a hack, but currently the only
38 * way to make room for the Etherboot features that need substantial amounts
39 * of code like the ANSI console support. Currently the buffer is just below
40 * 0x10000, so this even conforms to the tagged boot image specification,
41 * which reserves the ranges 0x00000-0x10000 and 0x98000-0xA0000. My
42 * interpretation of this "reserved" is that Etherboot may do whatever it
43 * likes, as long as its environment is kept intact (like the BIOS
44 * variables). Hopefully fixed rtl8139_recv() once and for all. The symptoms
45 * were that if Etherboot was left at the boot menu for several minutes, the
46 * first eth_poll failed. Seems like I am the only person who does this.
47 * First of all I fixed the debugging code and then set out for a long bug
48 * hunting session. It took me about a week full time work - poking around
49 * various places in the driver, reading Don Becker's and Jeff Garzik's Linux
50 * driver and even the FreeBSD driver (what a piece of crap!) - and
51 * eventually spotted the nasty thing: the transmit routine was acknowledging
52 * each and every interrupt pending, including the RxOverrun and RxFIFIOver
53 * interrupts. This confused the RTL8139 thoroughly. It destroyed the
54 * Rx ring contents by dumping the 2K FIFO contents right where we wanted to
55 * get the next packet. Oh well, what fun.
56 *
57 * 18 Jan 2000 mdc@thinguin.org (Marty Connor)
58 * Drastically simplified error handling. Basically, if any error
59 * in transmission or reception occurs, the card is reset.
60 * Also, pointed all transmit descriptors to the same buffer to
61 * save buffer space. This should decrease driver size and avoid
62 * corruption because of exceeding 32K during runtime.
63 *
64 * 28 Jul 1999 (Matthias Meixner - meixner@rbg.informatik.tu-darmstadt.de)
65 * rtl8139_recv was quite broken: it used the RxOK interrupt flag instead
66 * of the RxBufferEmpty flag which often resulted in very bad
67 * transmission performace - below 1kBytes/s.
68 *
69 */
wdenk0260cd62004-01-02 15:01:32 +000070
71#include <common.h>
Simon Glass63334482019-11-14 12:57:39 -070072#include <cpu_func.h>
Marek Vasut922a9ca2020-05-09 22:34:44 +020073#include <dm.h>
Simon Glass0f2af882020-05-10 11:40:05 -060074#include <log.h>
wdenk0260cd62004-01-02 15:01:32 +000075#include <malloc.h>
76#include <net.h>
Ben Warren65b86232008-08-31 21:41:08 -070077#include <netdev.h>
wdenk0260cd62004-01-02 15:01:32 +000078#include <asm/io.h>
79#include <pci.h>
Simon Glass4dcacfc2020-05-10 11:40:13 -060080#include <linux/bitops.h>
Simon Glassdbd79542020-05-10 11:40:11 -060081#include <linux/delay.h>
Simon Glass0f2af882020-05-10 11:40:05 -060082#include <linux/types.h>
wdenk0260cd62004-01-02 15:01:32 +000083
Shinya Kuribayashifad82ef2008-01-16 16:11:14 +090084#define RTL_TIMEOUT 100000
wdenk0260cd62004-01-02 15:01:32 +000085
Marek Vasut278734b2020-04-12 23:01:45 +020086/* PCI Tuning Parameters */
87/* Threshold is bytes transferred to chip before transmission starts. */
wdenkbc01dd52004-01-02 16:05:07 +000088#define TX_FIFO_THRESH 256 /* In bytes, rounded down to 32 byte units. */
89#define RX_FIFO_THRESH 4 /* Rx buffer level before first PCI xfer. */
90#define RX_DMA_BURST 4 /* Maximum PCI burst, '4' is 256 bytes */
91#define TX_DMA_BURST 4 /* Calculate as 16<<val. */
92#define NUM_TX_DESC 4 /* Number of Tx descriptor registers. */
wdenk0260cd62004-01-02 15:01:32 +000093#define TX_BUF_SIZE ETH_FRAME_LEN /* FCS is added by the chip */
94#define RX_BUF_LEN_IDX 0 /* 0, 1, 2 is allowed - 8,16,32K rx buffer */
95#define RX_BUF_LEN (8192 << RX_BUF_LEN_IDX)
96
Wolfgang Denkd7bffbc2011-11-05 05:13:03 +000097#define DEBUG_TX 0 /* set to 1 to enable debug code */
98#define DEBUG_RX 0 /* set to 1 to enable debug code */
wdenk0260cd62004-01-02 15:01:32 +000099
Marek Vasut922a9ca2020-05-09 22:34:44 +0200100#define bus_to_phys(devno, a) dm_pci_mem_to_phys((devno), (a))
101#define phys_to_bus(devno, a) dm_pci_phys_to_mem((devno), (a))
wdenk0260cd62004-01-02 15:01:32 +0000102
103/* Symbolic offsets to registers. */
Marek Vasut230d9822020-04-12 20:47:26 +0200104/* Ethernet hardware address. */
105#define RTL_REG_MAC0 0x00
106/* Multicast filter. */
107#define RTL_REG_MAR0 0x08
108/* Transmit status (four 32bit registers). */
109#define RTL_REG_TXSTATUS0 0x10
110/* Tx descriptors (also four 32bit). */
111#define RTL_REG_TXADDR0 0x20
112#define RTL_REG_RXBUF 0x30
113#define RTL_REG_RXEARLYCNT 0x34
114#define RTL_REG_RXEARLYSTATUS 0x36
115#define RTL_REG_CHIPCMD 0x37
116#define RTL_REG_CHIPCMD_CMDRESET BIT(4)
117#define RTL_REG_CHIPCMD_CMDRXENB BIT(3)
118#define RTL_REG_CHIPCMD_CMDTXENB BIT(2)
119#define RTL_REG_CHIPCMD_RXBUFEMPTY BIT(0)
120#define RTL_REG_RXBUFPTR 0x38
121#define RTL_REG_RXBUFADDR 0x3A
122#define RTL_REG_INTRMASK 0x3C
123#define RTL_REG_INTRSTATUS 0x3E
124#define RTL_REG_INTRSTATUS_PCIERR BIT(15)
125#define RTL_REG_INTRSTATUS_PCSTIMEOUT BIT(14)
126#define RTL_REG_INTRSTATUS_CABLELENCHANGE BIT(13)
127#define RTL_REG_INTRSTATUS_RXFIFOOVER BIT(6)
128#define RTL_REG_INTRSTATUS_RXUNDERRUN BIT(5)
129#define RTL_REG_INTRSTATUS_RXOVERFLOW BIT(4)
130#define RTL_REG_INTRSTATUS_TXERR BIT(3)
131#define RTL_REG_INTRSTATUS_TXOK BIT(2)
132#define RTL_REG_INTRSTATUS_RXERR BIT(1)
133#define RTL_REG_INTRSTATUS_RXOK BIT(0)
134#define RTL_REG_TXCONFIG 0x40
135#define RTL_REG_RXCONFIG 0x44
136#define RTL_REG_RXCONFIG_RXCFGWRAP BIT(7)
137#define RTL_REG_RXCONFIG_ACCEPTERR BIT(5)
138#define RTL_REG_RXCONFIG_ACCEPTRUNT BIT(4)
139#define RTL_REG_RXCONFIG_ACCEPTBROADCAST BIT(3)
140#define RTL_REG_RXCONFIG_ACCEPTMULTICAST BIT(2)
141#define RTL_REG_RXCONFIG_ACCEPTMYPHYS BIT(1)
142#define RTL_REG_RXCONFIG_ACCEPTALLPHYS BIT(0)
143/* general-purpose counter. */
144#define RTL_REG_TIMER 0x48
145/* 24 bits valid, write clears. */
146#define RTL_REG_RXMISSED 0x4C
147#define RTL_REG_CFG9346 0x50
148#define RTL_REG_CONFIG0 0x51
149#define RTL_REG_CONFIG1 0x52
150/* intr if gp counter reaches this value */
151#define RTL_REG_TIMERINTRREG 0x54
152#define RTL_REG_MEDIASTATUS 0x58
153#define RTL_REG_MEDIASTATUS_MSRTXFLOWENABLE BIT(7)
154#define RTL_REG_MEDIASTATUS_MSRRXFLOWENABLE BIT(6)
155#define RTL_REG_MEDIASTATUS_MSRSPEED10 BIT(3)
156#define RTL_REG_MEDIASTATUS_MSRLINKFAIL BIT(2)
157#define RTL_REG_MEDIASTATUS_MSRRXPAUSEFLAG BIT(1)
158#define RTL_REG_MEDIASTATUS_MSRTXPAUSEFLAG BIT(0)
159#define RTL_REG_CONFIG3 0x59
160#define RTL_REG_MULTIINTR 0x5C
161/* revision of the RTL8139 chip */
162#define RTL_REG_REVISIONID 0x5E
163#define RTL_REG_TXSUMMARY 0x60
164#define RTL_REG_MII_BMCR 0x62
165#define RTL_REG_MII_BMSR 0x64
166#define RTL_REG_NWAYADVERT 0x66
167#define RTL_REG_NWAYLPAR 0x68
168#define RTL_REG_NWAYEXPANSION 0x6A
169#define RTL_REG_DISCONNECTCNT 0x6C
170#define RTL_REG_FALSECARRIERCNT 0x6E
171#define RTL_REG_NWAYTESTREG 0x70
172/* packet received counter */
173#define RTL_REG_RXCNT 0x72
174/* chip status and configuration register */
175#define RTL_REG_CSCR 0x74
176#define RTL_REG_PHYPARM1 0x78
177#define RTL_REG_TWISTERPARM 0x7c
178/* undocumented */
179#define RTL_REG_PHYPARM2 0x80
180/*
181 * from 0x84 onwards are a number of power management/wakeup frame
182 * definitions we will probably never need to know about.
183 */
wdenk0260cd62004-01-02 15:01:32 +0000184
Marek Vasut230d9822020-04-12 20:47:26 +0200185#define RTL_STS_RXMULTICAST BIT(15)
186#define RTL_STS_RXPHYSICAL BIT(14)
187#define RTL_STS_RXBROADCAST BIT(13)
188#define RTL_STS_RXBADSYMBOL BIT(5)
189#define RTL_STS_RXRUNT BIT(4)
190#define RTL_STS_RXTOOLONG BIT(3)
191#define RTL_STS_RXCRCERR BIT(2)
192#define RTL_STS_RXBADALIGN BIT(1)
193#define RTL_STS_RXSTATUSOK BIT(0)
wdenk0260cd62004-01-02 15:01:32 +0000194
Marek Vasut775b0672020-05-09 22:34:39 +0200195struct rtl8139_priv {
Marek Vasut922a9ca2020-05-09 22:34:44 +0200196 struct udevice *devno;
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200197 unsigned int rxstatus;
Marek Vasut775b0672020-05-09 22:34:39 +0200198 unsigned int cur_rx;
199 unsigned int cur_tx;
200 unsigned long ioaddr;
Marek Vasut775b0672020-05-09 22:34:39 +0200201 unsigned char enetaddr[6];
202};
wdenk0260cd62004-01-02 15:01:32 +0000203
204/* The RTL8139 can only transmit from a contiguous, aligned memory block. */
Marek Vasut278734b2020-04-12 23:01:45 +0200205static unsigned char tx_buffer[TX_BUF_SIZE] __aligned(4);
206static unsigned char rx_ring[RX_BUF_LEN + 16] __aligned(4);
wdenk0260cd62004-01-02 15:01:32 +0000207
wdenk0260cd62004-01-02 15:01:32 +0000208/* Serial EEPROM section. */
209
210/* EEPROM_Ctrl bits. */
wdenkbc01dd52004-01-02 16:05:07 +0000211#define EE_SHIFT_CLK 0x04 /* EEPROM shift clock. */
212#define EE_CS 0x08 /* EEPROM chip select. */
213#define EE_DATA_WRITE 0x02 /* EEPROM chip data in. */
214#define EE_WRITE_0 0x00
215#define EE_WRITE_1 0x02
216#define EE_DATA_READ 0x01 /* EEPROM chip data out. */
wdenk0260cd62004-01-02 15:01:32 +0000217#define EE_ENB (0x80 | EE_CS)
218
wdenk0260cd62004-01-02 15:01:32 +0000219/* The EEPROM commands include the alway-set leading bit. */
Marek Vasut230d9822020-04-12 20:47:26 +0200220#define EE_WRITE_CMD 5
221#define EE_READ_CMD 6
222#define EE_ERASE_CMD 7
wdenk0260cd62004-01-02 15:01:32 +0000223
Marek Vasuta7c12952020-05-09 22:34:40 +0200224static void rtl8139_eeprom_delay(struct rtl8139_priv *priv)
Marek Vasut77676d52020-04-12 21:20:31 +0200225{
226 /*
227 * Delay between EEPROM clock transitions.
228 * No extra delay is needed with 33MHz PCI, but 66MHz may change this.
229 */
Marek Vasuta7c12952020-05-09 22:34:40 +0200230 inl(priv->ioaddr + RTL_REG_CFG9346);
Marek Vasut77676d52020-04-12 21:20:31 +0200231}
232
Marek Vasut775b0672020-05-09 22:34:39 +0200233static int rtl8139_read_eeprom(struct rtl8139_priv *priv,
Marek Vasut68261942020-05-09 22:34:37 +0200234 unsigned int location, unsigned int addr_len)
wdenk0260cd62004-01-02 15:01:32 +0000235{
Marek Vasut298b3de2020-04-12 21:28:30 +0200236 unsigned int read_cmd = location | (EE_READ_CMD << addr_len);
Marek Vasut775b0672020-05-09 22:34:39 +0200237 uintptr_t ee_addr = priv->ioaddr + RTL_REG_CFG9346;
wdenk0260cd62004-01-02 15:01:32 +0000238 unsigned int retval = 0;
Marek Vasut298b3de2020-04-12 21:28:30 +0200239 u8 dataval;
240 int i;
wdenk0260cd62004-01-02 15:01:32 +0000241
242 outb(EE_ENB & ~EE_CS, ee_addr);
243 outb(EE_ENB, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200244 rtl8139_eeprom_delay(priv);
wdenk0260cd62004-01-02 15:01:32 +0000245
246 /* Shift the read command bits out. */
247 for (i = 4 + addr_len; i >= 0; i--) {
Marek Vasut298b3de2020-04-12 21:28:30 +0200248 dataval = (read_cmd & BIT(i)) ? EE_DATA_WRITE : 0;
wdenk0260cd62004-01-02 15:01:32 +0000249 outb(EE_ENB | dataval, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200250 rtl8139_eeprom_delay(priv);
wdenk0260cd62004-01-02 15:01:32 +0000251 outb(EE_ENB | dataval | EE_SHIFT_CLK, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200252 rtl8139_eeprom_delay(priv);
wdenk0260cd62004-01-02 15:01:32 +0000253 }
Marek Vasut298b3de2020-04-12 21:28:30 +0200254
wdenk0260cd62004-01-02 15:01:32 +0000255 outb(EE_ENB, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200256 rtl8139_eeprom_delay(priv);
wdenk0260cd62004-01-02 15:01:32 +0000257
258 for (i = 16; i > 0; i--) {
259 outb(EE_ENB | EE_SHIFT_CLK, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200260 rtl8139_eeprom_delay(priv);
Marek Vasut298b3de2020-04-12 21:28:30 +0200261 retval <<= 1;
262 retval |= inb(ee_addr) & EE_DATA_READ;
wdenk0260cd62004-01-02 15:01:32 +0000263 outb(EE_ENB, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200264 rtl8139_eeprom_delay(priv);
wdenk0260cd62004-01-02 15:01:32 +0000265 }
266
267 /* Terminate the EEPROM access. */
268 outb(~EE_CS, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200269 rtl8139_eeprom_delay(priv);
Marek Vasut298b3de2020-04-12 21:28:30 +0200270
wdenk0260cd62004-01-02 15:01:32 +0000271 return retval;
272}
273
274static const unsigned int rtl8139_rx_config =
275 (RX_BUF_LEN_IDX << 11) |
276 (RX_FIFO_THRESH << 13) |
277 (RX_DMA_BURST << 8);
278
Marek Vasut775b0672020-05-09 22:34:39 +0200279static void rtl8139_set_rx_mode(struct rtl8139_priv *priv)
Marek Vasute07aa6d2020-04-12 21:35:12 +0200280{
wdenk0260cd62004-01-02 15:01:32 +0000281 /* !IFF_PROMISC */
Marek Vasute07aa6d2020-04-12 21:35:12 +0200282 unsigned int rx_mode = RTL_REG_RXCONFIG_ACCEPTBROADCAST |
283 RTL_REG_RXCONFIG_ACCEPTMULTICAST |
284 RTL_REG_RXCONFIG_ACCEPTMYPHYS;
wdenk0260cd62004-01-02 15:01:32 +0000285
Marek Vasut775b0672020-05-09 22:34:39 +0200286 outl(rtl8139_rx_config | rx_mode, priv->ioaddr + RTL_REG_RXCONFIG);
wdenk0260cd62004-01-02 15:01:32 +0000287
Marek Vasut775b0672020-05-09 22:34:39 +0200288 outl(0xffffffff, priv->ioaddr + RTL_REG_MAR0 + 0);
289 outl(0xffffffff, priv->ioaddr + RTL_REG_MAR0 + 4);
wdenk0260cd62004-01-02 15:01:32 +0000290}
291
Marek Vasut775b0672020-05-09 22:34:39 +0200292static void rtl8139_hw_reset(struct rtl8139_priv *priv)
wdenk0260cd62004-01-02 15:01:32 +0000293{
Marek Vasuta51de2b2020-04-12 21:41:56 +0200294 u8 reg;
wdenk0260cd62004-01-02 15:01:32 +0000295 int i;
296
Marek Vasut775b0672020-05-09 22:34:39 +0200297 outb(RTL_REG_CHIPCMD_CMDRESET, priv->ioaddr + RTL_REG_CHIPCMD);
wdenk0260cd62004-01-02 15:01:32 +0000298
wdenk0260cd62004-01-02 15:01:32 +0000299 /* Give the chip 10ms to finish the reset. */
Marek Vasuta51de2b2020-04-12 21:41:56 +0200300 for (i = 0; i < 100; i++) {
Marek Vasut775b0672020-05-09 22:34:39 +0200301 reg = inb(priv->ioaddr + RTL_REG_CHIPCMD);
Marek Vasuta51de2b2020-04-12 21:41:56 +0200302 if (!(reg & RTL_REG_CHIPCMD_CMDRESET))
Marek Vasut230d9822020-04-12 20:47:26 +0200303 break;
Marek Vasuta51de2b2020-04-12 21:41:56 +0200304
305 udelay(100);
wdenk0260cd62004-01-02 15:01:32 +0000306 }
Marek Vasut0b9aab82020-04-12 22:58:27 +0200307}
308
Marek Vasut775b0672020-05-09 22:34:39 +0200309static void rtl8139_reset(struct rtl8139_priv *priv)
Marek Vasut0b9aab82020-04-12 22:58:27 +0200310{
311 int i;
312
Marek Vasut775b0672020-05-09 22:34:39 +0200313 priv->cur_rx = 0;
314 priv->cur_tx = 0;
wdenk0260cd62004-01-02 15:01:32 +0000315
Marek Vasut775b0672020-05-09 22:34:39 +0200316 rtl8139_hw_reset(priv);
wdenk0260cd62004-01-02 15:01:32 +0000317
318 for (i = 0; i < ETH_ALEN; i++)
Marek Vasut775b0672020-05-09 22:34:39 +0200319 outb(priv->enetaddr[i], priv->ioaddr + RTL_REG_MAC0 + i);
wdenk0260cd62004-01-02 15:01:32 +0000320
321 /* Must enable Tx/Rx before setting transfer thresholds! */
Marek Vasut230d9822020-04-12 20:47:26 +0200322 outb(RTL_REG_CHIPCMD_CMDRXENB | RTL_REG_CHIPCMD_CMDTXENB,
Marek Vasut775b0672020-05-09 22:34:39 +0200323 priv->ioaddr + RTL_REG_CHIPCMD);
Marek Vasuta51de2b2020-04-12 21:41:56 +0200324
Marek Vasut6e61bf52020-04-12 21:30:38 +0200325 /* accept no frames yet! */
Marek Vasut775b0672020-05-09 22:34:39 +0200326 outl(rtl8139_rx_config, priv->ioaddr + RTL_REG_RXCONFIG);
327 outl((TX_DMA_BURST << 8) | 0x03000000, priv->ioaddr + RTL_REG_TXCONFIG);
wdenk0260cd62004-01-02 15:01:32 +0000328
Marek Vasuta51de2b2020-04-12 21:41:56 +0200329 /*
330 * The Linux driver changes RTL_REG_CONFIG1 here to use a different
331 * LED pattern for half duplex or full/autodetect duplex (for
332 * full/autodetect, the outputs are TX/RX, Link10/100, FULL, while
333 * for half duplex it uses TX/RX, Link100, Link10). This is messy,
334 * because it doesn't match the inscription on the mounting bracket.
335 * It should not be changed from the configuration EEPROM default,
336 * because the card manufacturer should have set that to match the
337 * card.
338 */
339 debug_cond(DEBUG_RX, "rx ring address is %p\n", rx_ring);
wdenk0260cd62004-01-02 15:01:32 +0000340
Shinya Kuribayashiec450fe2008-01-16 16:12:26 +0900341 flush_cache((unsigned long)rx_ring, RX_BUF_LEN);
Marek Vasut775b0672020-05-09 22:34:39 +0200342 outl(phys_to_bus(priv->devno, (int)rx_ring), priv->ioaddr + RTL_REG_RXBUF);
wdenk0260cd62004-01-02 15:01:32 +0000343
Marek Vasuta51de2b2020-04-12 21:41:56 +0200344 /*
345 * If we add multicast support, the RTL_REG_MAR0 register would have
346 * to be initialized to 0xffffffffffffffff (two 32 bit accesses).
347 * Etherboot only needs broadcast (for ARP/RARP/BOOTP/DHCP) and
348 * unicast.
349 */
Marek Vasut230d9822020-04-12 20:47:26 +0200350 outb(RTL_REG_CHIPCMD_CMDRXENB | RTL_REG_CHIPCMD_CMDTXENB,
Marek Vasut775b0672020-05-09 22:34:39 +0200351 priv->ioaddr + RTL_REG_CHIPCMD);
wdenk0260cd62004-01-02 15:01:32 +0000352
Marek Vasut775b0672020-05-09 22:34:39 +0200353 outl(rtl8139_rx_config, priv->ioaddr + RTL_REG_RXCONFIG);
wdenk0260cd62004-01-02 15:01:32 +0000354
355 /* Start the chip's Tx and Rx process. */
Marek Vasut775b0672020-05-09 22:34:39 +0200356 outl(0, priv->ioaddr + RTL_REG_RXMISSED);
wdenk0260cd62004-01-02 15:01:32 +0000357
Marek Vasut775b0672020-05-09 22:34:39 +0200358 rtl8139_set_rx_mode(priv);
wdenk0260cd62004-01-02 15:01:32 +0000359
360 /* Disable all known interrupts by setting the interrupt mask. */
Marek Vasut775b0672020-05-09 22:34:39 +0200361 outw(0, priv->ioaddr + RTL_REG_INTRMASK);
wdenk0260cd62004-01-02 15:01:32 +0000362}
363
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200364static int rtl8139_send_common(struct rtl8139_priv *priv,
365 void *packet, int length)
wdenk0260cd62004-01-02 15:01:32 +0000366{
wdenk0260cd62004-01-02 15:01:32 +0000367 unsigned int len = length;
Marek Vasutfbead9a2020-04-12 22:40:45 +0200368 unsigned long txstatus;
369 unsigned int status;
Shinya Kuribayashifad82ef2008-01-16 16:11:14 +0900370 int i = 0;
wdenk0260cd62004-01-02 15:01:32 +0000371
Marek Vasutfbead9a2020-04-12 22:40:45 +0200372 memcpy(tx_buffer, packet, length);
wdenk0260cd62004-01-02 15:01:32 +0000373
Wolfgang Denkd7bffbc2011-11-05 05:13:03 +0000374 debug_cond(DEBUG_TX, "sending %d bytes\n", len);
wdenk0260cd62004-01-02 15:01:32 +0000375
Marek Vasutfbead9a2020-04-12 22:40:45 +0200376 /*
377 * Note: RTL8139 doesn't auto-pad, send minimum payload (another 4
378 * bytes are sent automatically for the FCS, totalling to 64 bytes).
379 */
380 while (len < ETH_ZLEN)
wdenk0260cd62004-01-02 15:01:32 +0000381 tx_buffer[len++] = '\0';
wdenk0260cd62004-01-02 15:01:32 +0000382
Shinya Kuribayashiec450fe2008-01-16 16:12:26 +0900383 flush_cache((unsigned long)tx_buffer, length);
Marek Vasut775b0672020-05-09 22:34:39 +0200384 outl(phys_to_bus(priv->devno, (unsigned long)tx_buffer),
385 priv->ioaddr + RTL_REG_TXADDR0 + priv->cur_tx * 4);
Marek Vasutfbead9a2020-04-12 22:40:45 +0200386 outl(((TX_FIFO_THRESH << 11) & 0x003f0000) | len,
Marek Vasut775b0672020-05-09 22:34:39 +0200387 priv->ioaddr + RTL_REG_TXSTATUS0 + priv->cur_tx * 4);
wdenk0260cd62004-01-02 15:01:32 +0000388
wdenk0260cd62004-01-02 15:01:32 +0000389 do {
Marek Vasut775b0672020-05-09 22:34:39 +0200390 status = inw(priv->ioaddr + RTL_REG_INTRSTATUS);
Marek Vasut230d9822020-04-12 20:47:26 +0200391 /*
392 * Only acknlowledge interrupt sources we can properly
393 * handle here - the RTL_REG_INTRSTATUS_RXOVERFLOW/
394 * RTL_REG_INTRSTATUS_RXFIFOOVER MUST be handled in the
Marek Vasut60992ef2020-04-12 22:43:16 +0200395 * rtl8139_recv() function.
Marek Vasut230d9822020-04-12 20:47:26 +0200396 */
Marek Vasutfbead9a2020-04-12 22:40:45 +0200397 status &= RTL_REG_INTRSTATUS_TXOK | RTL_REG_INTRSTATUS_TXERR |
398 RTL_REG_INTRSTATUS_PCIERR;
Marek Vasut775b0672020-05-09 22:34:39 +0200399 outw(status, priv->ioaddr + RTL_REG_INTRSTATUS);
Marek Vasutfbead9a2020-04-12 22:40:45 +0200400 if (status)
Marek Vasut230d9822020-04-12 20:47:26 +0200401 break;
Marek Vasutfbead9a2020-04-12 22:40:45 +0200402
Shinya Kuribayashifad82ef2008-01-16 16:11:14 +0900403 udelay(10);
404 } while (i++ < RTL_TIMEOUT);
wdenk0260cd62004-01-02 15:01:32 +0000405
Marek Vasut775b0672020-05-09 22:34:39 +0200406 txstatus = inl(priv->ioaddr + RTL_REG_TXSTATUS0 + priv->cur_tx * 4);
wdenk0260cd62004-01-02 15:01:32 +0000407
Marek Vasutfbead9a2020-04-12 22:40:45 +0200408 if (!(status & RTL_REG_INTRSTATUS_TXOK)) {
Wolfgang Denkd7bffbc2011-11-05 05:13:03 +0000409 debug_cond(DEBUG_TX,
Marek Vasutfbead9a2020-04-12 22:40:45 +0200410 "tx timeout/error (%d usecs), status %hX txstatus %lX\n",
411 10 * i, status, txstatus);
Wolfgang Denkd7bffbc2011-11-05 05:13:03 +0000412
Marek Vasut775b0672020-05-09 22:34:39 +0200413 rtl8139_reset(priv);
wdenk0260cd62004-01-02 15:01:32 +0000414
415 return 0;
416 }
Marek Vasutfbead9a2020-04-12 22:40:45 +0200417
Marek Vasut775b0672020-05-09 22:34:39 +0200418 priv->cur_tx = (priv->cur_tx + 1) % NUM_TX_DESC;
Marek Vasutfbead9a2020-04-12 22:40:45 +0200419
420 debug_cond(DEBUG_TX, "tx done, status %hX txstatus %lX\n",
421 status, txstatus);
422
423 return length;
wdenk0260cd62004-01-02 15:01:32 +0000424}
425
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200426static int rtl8139_recv_common(struct rtl8139_priv *priv, unsigned char *rxdata,
427 uchar **packetp)
wdenk0260cd62004-01-02 15:01:32 +0000428{
Marek Vasut60992ef2020-04-12 22:43:16 +0200429 const unsigned int rxstat = RTL_REG_INTRSTATUS_RXFIFOOVER |
430 RTL_REG_INTRSTATUS_RXOVERFLOW |
431 RTL_REG_INTRSTATUS_RXOK;
wdenk0260cd62004-01-02 15:01:32 +0000432 unsigned int rx_size, rx_status;
Marek Vasut60992ef2020-04-12 22:43:16 +0200433 unsigned int ring_offs;
Marek Vasut60992ef2020-04-12 22:43:16 +0200434 int length = 0;
wdenk0260cd62004-01-02 15:01:32 +0000435
Marek Vasut775b0672020-05-09 22:34:39 +0200436 if (inb(priv->ioaddr + RTL_REG_CHIPCMD) & RTL_REG_CHIPCMD_RXBUFEMPTY)
wdenk0260cd62004-01-02 15:01:32 +0000437 return 0;
wdenk0260cd62004-01-02 15:01:32 +0000438
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200439 priv->rxstatus = inw(priv->ioaddr + RTL_REG_INTRSTATUS);
wdenk0260cd62004-01-02 15:01:32 +0000440 /* See below for the rest of the interrupt acknowledges. */
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200441 outw(priv->rxstatus & ~rxstat, priv->ioaddr + RTL_REG_INTRSTATUS);
wdenk0260cd62004-01-02 15:01:32 +0000442
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200443 debug_cond(DEBUG_RX, "%s: int %hX ", __func__, priv->rxstatus);
wdenk0260cd62004-01-02 15:01:32 +0000444
Marek Vasut775b0672020-05-09 22:34:39 +0200445 ring_offs = priv->cur_rx % RX_BUF_LEN;
Shinya Kuribayashiec450fe2008-01-16 16:12:26 +0900446 /* ring_offs is guaranteed being 4-byte aligned */
Shinya Kuribayashia466d552008-01-16 16:13:31 +0900447 rx_status = le32_to_cpu(*(unsigned int *)(rx_ring + ring_offs));
wdenk0260cd62004-01-02 15:01:32 +0000448 rx_size = rx_status >> 16;
449 rx_status &= 0xffff;
450
Marek Vasut230d9822020-04-12 20:47:26 +0200451 if ((rx_status & (RTL_STS_RXBADSYMBOL | RTL_STS_RXRUNT |
452 RTL_STS_RXTOOLONG | RTL_STS_RXCRCERR |
453 RTL_STS_RXBADALIGN)) ||
Marek Vasut60992ef2020-04-12 22:43:16 +0200454 (rx_size < ETH_ZLEN) ||
455 (rx_size > ETH_FRAME_LEN + 4)) {
Maxim Uvarov73b447f2023-12-26 21:46:15 +0600456 debug("rx error %hX\n", rx_status);
Marek Vasut60992ef2020-04-12 22:43:16 +0200457 /* this clears all interrupts still pending */
Marek Vasut775b0672020-05-09 22:34:39 +0200458 rtl8139_reset(priv);
wdenk0260cd62004-01-02 15:01:32 +0000459 return 0;
460 }
461
462 /* Received a good packet */
463 length = rx_size - 4; /* no one cares about the FCS */
Marek Vasut60992ef2020-04-12 22:43:16 +0200464 if (ring_offs + 4 + rx_size - 4 > RX_BUF_LEN) {
Marek Vasut60992ef2020-04-12 22:43:16 +0200465 int semi_count = RX_BUF_LEN - ring_offs - 4;
wdenk0260cd62004-01-02 15:01:32 +0000466
467 memcpy(rxdata, rx_ring + ring_offs + 4, semi_count);
Marek Vasut60992ef2020-04-12 22:43:16 +0200468 memcpy(&rxdata[semi_count], rx_ring,
469 rx_size - 4 - semi_count);
wdenk0260cd62004-01-02 15:01:32 +0000470
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200471 *packetp = rxdata;
Wolfgang Denkd7bffbc2011-11-05 05:13:03 +0000472 debug_cond(DEBUG_RX, "rx packet %d+%d bytes",
Marek Vasut60992ef2020-04-12 22:43:16 +0200473 semi_count, rx_size - 4 - semi_count);
wdenk0260cd62004-01-02 15:01:32 +0000474 } else {
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200475 *packetp = rx_ring + ring_offs + 4;
Marek Vasut60992ef2020-04-12 22:43:16 +0200476 debug_cond(DEBUG_RX, "rx packet %d bytes", rx_size - 4);
wdenk0260cd62004-01-02 15:01:32 +0000477 }
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200478
479 return length;
480}
481
482static int rtl8139_free_pkt_common(struct rtl8139_priv *priv, unsigned int len)
483{
484 const unsigned int rxstat = RTL_REG_INTRSTATUS_RXFIFOOVER |
485 RTL_REG_INTRSTATUS_RXOVERFLOW |
486 RTL_REG_INTRSTATUS_RXOK;
487 unsigned int rx_size = len + 4;
488
Shinya Kuribayashiec450fe2008-01-16 16:12:26 +0900489 flush_cache((unsigned long)rx_ring, RX_BUF_LEN);
wdenk0260cd62004-01-02 15:01:32 +0000490
Marek Vasut775b0672020-05-09 22:34:39 +0200491 priv->cur_rx = ROUND(priv->cur_rx + rx_size + 4, 4);
492 outw(priv->cur_rx - 16, priv->ioaddr + RTL_REG_RXBUFPTR);
Marek Vasut60992ef2020-04-12 22:43:16 +0200493 /*
494 * See RTL8139 Programming Guide V0.1 for the official handling of
495 * Rx overflow situations. The document itself contains basically
496 * no usable information, except for a few exception handling rules.
497 */
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200498 outw(priv->rxstatus & rxstat, priv->ioaddr + RTL_REG_INTRSTATUS);
Marek Vasut60992ef2020-04-12 22:43:16 +0200499
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200500 return 0;
wdenk0260cd62004-01-02 15:01:32 +0000501}
502
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200503static int rtl8139_init_common(struct rtl8139_priv *priv)
Marek Vasut5cf25852020-04-12 23:12:11 +0200504{
Marek Vasut5cf25852020-04-12 23:12:11 +0200505 u8 reg;
506
Marek Vasut5cf25852020-04-12 23:12:11 +0200507 /* Bring the chip out of low-power mode. */
Marek Vasut775b0672020-05-09 22:34:39 +0200508 outb(0x00, priv->ioaddr + RTL_REG_CONFIG1);
Marek Vasut5cf25852020-04-12 23:12:11 +0200509
Marek Vasut775b0672020-05-09 22:34:39 +0200510 rtl8139_reset(priv);
Marek Vasut5cf25852020-04-12 23:12:11 +0200511
Marek Vasut775b0672020-05-09 22:34:39 +0200512 reg = inb(priv->ioaddr + RTL_REG_MEDIASTATUS);
Marek Vasut5cf25852020-04-12 23:12:11 +0200513 if (reg & RTL_REG_MEDIASTATUS_MSRLINKFAIL) {
514 printf("Cable not connected or other link failure\n");
515 return -1;
516 }
517
518 return 0;
519}
520
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200521static void rtl8139_stop_common(struct rtl8139_priv *priv)
wdenk0260cd62004-01-02 15:01:32 +0000522{
Marek Vasut775b0672020-05-09 22:34:39 +0200523 rtl8139_hw_reset(priv);
wdenk0260cd62004-01-02 15:01:32 +0000524}
Marek Vasut5cf25852020-04-12 23:12:11 +0200525
Marek Vasutfce51f22020-05-09 22:34:43 +0200526static void rtl8139_get_hwaddr(struct rtl8139_priv *priv)
527{
528 unsigned short *ap = (unsigned short *)priv->enetaddr;
529 int i, addr_len;
530
531 /* Bring the chip out of low-power mode. */
532 outb(0x00, priv->ioaddr + RTL_REG_CONFIG1);
533
534 addr_len = rtl8139_read_eeprom(priv, 0, 8) == 0x8129 ? 8 : 6;
535 for (i = 0; i < 3; i++)
536 *ap++ = le16_to_cpu(rtl8139_read_eeprom(priv, i + 7, addr_len));
537}
538
Marek Vasut66ed9fc2020-05-09 22:34:35 +0200539static void rtl8139_name(char *str, int card_number)
540{
541 sprintf(str, "RTL8139#%u", card_number);
542}
543
Marek Vasut5cf25852020-04-12 23:12:11 +0200544static struct pci_device_id supported[] = {
Marek Vasutac3f0002020-05-09 22:34:42 +0200545 { PCI_DEVICE(PCI_VENDOR_ID_REALTEK, PCI_DEVICE_ID_REALTEK_8139) },
546 { PCI_DEVICE(PCI_VENDOR_ID_DLINK, PCI_DEVICE_ID_DLINK_8139) },
Marek Vasut5cf25852020-04-12 23:12:11 +0200547 { }
548};
549
Marek Vasut922a9ca2020-05-09 22:34:44 +0200550static int rtl8139_start(struct udevice *dev)
551{
Simon Glassfa20e932020-12-03 16:55:20 -0700552 struct eth_pdata *plat = dev_get_plat(dev);
Marek Vasut922a9ca2020-05-09 22:34:44 +0200553 struct rtl8139_priv *priv = dev_get_priv(dev);
554
555 memcpy(priv->enetaddr, plat->enetaddr, sizeof(plat->enetaddr));
556
557 return rtl8139_init_common(priv);
558}
559
560static void rtl8139_stop(struct udevice *dev)
561{
562 struct rtl8139_priv *priv = dev_get_priv(dev);
563
564 rtl8139_stop_common(priv);
565}
566
567static int rtl8139_send(struct udevice *dev, void *packet, int length)
568{
569 struct rtl8139_priv *priv = dev_get_priv(dev);
570 int ret;
571
572 ret = rtl8139_send_common(priv, packet, length);
573
574 return ret ? 0 : -ETIMEDOUT;
575}
576
577static int rtl8139_recv(struct udevice *dev, int flags, uchar **packetp)
578{
579 struct rtl8139_priv *priv = dev_get_priv(dev);
580 static unsigned char rxdata[RX_BUF_LEN];
581
582 return rtl8139_recv_common(priv, rxdata, packetp);
583}
584
585static int rtl8139_free_pkt(struct udevice *dev, uchar *packet, int length)
586{
587 struct rtl8139_priv *priv = dev_get_priv(dev);
588
589 rtl8139_free_pkt_common(priv, length);
590
591 return 0;
592}
593
594static int rtl8139_write_hwaddr(struct udevice *dev)
595{
Simon Glassfa20e932020-12-03 16:55:20 -0700596 struct eth_pdata *plat = dev_get_plat(dev);
Marek Vasut922a9ca2020-05-09 22:34:44 +0200597 struct rtl8139_priv *priv = dev_get_priv(dev);
598
599 memcpy(priv->enetaddr, plat->enetaddr, sizeof(plat->enetaddr));
600
601 rtl8139_reset(priv);
602
603 return 0;
604}
605
606static int rtl8139_read_rom_hwaddr(struct udevice *dev)
607{
608 struct rtl8139_priv *priv = dev_get_priv(dev);
609
610 rtl8139_get_hwaddr(priv);
611
612 return 0;
613}
614
615static int rtl8139_bind(struct udevice *dev)
616{
617 static int card_number;
618 char name[16];
619
620 rtl8139_name(name, card_number++);
621
622 return device_set_name(dev, name);
623}
624
625static int rtl8139_probe(struct udevice *dev)
626{
Simon Glassfa20e932020-12-03 16:55:20 -0700627 struct eth_pdata *plat = dev_get_plat(dev);
Marek Vasut922a9ca2020-05-09 22:34:44 +0200628 struct rtl8139_priv *priv = dev_get_priv(dev);
629 u32 iobase;
630
631 dm_pci_read_config32(dev, PCI_BASE_ADDRESS_1, &iobase);
632 iobase &= ~0xf;
633
634 debug("rtl8139: REALTEK RTL8139 @0x%x\n", iobase);
635
636 priv->devno = dev;
637 priv->ioaddr = (unsigned long)bus_to_phys(dev, iobase);
638
639 rtl8139_get_hwaddr(priv);
640 memcpy(plat->enetaddr, priv->enetaddr, sizeof(priv->enetaddr));
641
642 dm_pci_write_config8(dev, PCI_LATENCY_TIMER, 0x20);
643
644 return 0;
645}
646
647static const struct eth_ops rtl8139_ops = {
648 .start = rtl8139_start,
649 .send = rtl8139_send,
650 .recv = rtl8139_recv,
651 .stop = rtl8139_stop,
652 .free_pkt = rtl8139_free_pkt,
653 .write_hwaddr = rtl8139_write_hwaddr,
654 .read_rom_hwaddr = rtl8139_read_rom_hwaddr,
655};
656
657U_BOOT_DRIVER(eth_rtl8139) = {
658 .name = "eth_rtl8139",
659 .id = UCLASS_ETH,
660 .bind = rtl8139_bind,
661 .probe = rtl8139_probe,
662 .ops = &rtl8139_ops,
Simon Glass8a2b47f2020-12-03 16:55:17 -0700663 .priv_auto = sizeof(struct rtl8139_priv),
Simon Glass71fa5b42020-12-03 16:55:18 -0700664 .plat_auto = sizeof(struct eth_pdata),
Marek Vasut922a9ca2020-05-09 22:34:44 +0200665};
666
667U_BOOT_PCI_DEVICE(eth_rtl8139, supported);