blob: 2e0afad089f8e03aa17469cd36b7285f1b691819 [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
Simon Glass63334482019-11-14 12:57:39 -070071#include <cpu_func.h>
Marek Vasut922a9ca2020-05-09 22:34:44 +020072#include <dm.h>
Simon Glass0f2af882020-05-10 11:40:05 -060073#include <log.h>
wdenk0260cd62004-01-02 15:01:32 +000074#include <malloc.h>
75#include <net.h>
Ben Warren65b86232008-08-31 21:41:08 -070076#include <netdev.h>
wdenk0260cd62004-01-02 15:01:32 +000077#include <asm/io.h>
78#include <pci.h>
Simon Glass4dcacfc2020-05-10 11:40:13 -060079#include <linux/bitops.h>
Simon Glassdbd79542020-05-10 11:40:11 -060080#include <linux/delay.h>
Simon Glass0f2af882020-05-10 11:40:05 -060081#include <linux/types.h>
wdenk0260cd62004-01-02 15:01:32 +000082
Shinya Kuribayashifad82ef2008-01-16 16:11:14 +090083#define RTL_TIMEOUT 100000
wdenk0260cd62004-01-02 15:01:32 +000084
Marek Vasut278734b2020-04-12 23:01:45 +020085/* PCI Tuning Parameters */
86/* Threshold is bytes transferred to chip before transmission starts. */
wdenkbc01dd52004-01-02 16:05:07 +000087#define TX_FIFO_THRESH 256 /* In bytes, rounded down to 32 byte units. */
88#define RX_FIFO_THRESH 4 /* Rx buffer level before first PCI xfer. */
89#define RX_DMA_BURST 4 /* Maximum PCI burst, '4' is 256 bytes */
90#define TX_DMA_BURST 4 /* Calculate as 16<<val. */
91#define NUM_TX_DESC 4 /* Number of Tx descriptor registers. */
wdenk0260cd62004-01-02 15:01:32 +000092#define TX_BUF_SIZE ETH_FRAME_LEN /* FCS is added by the chip */
93#define RX_BUF_LEN_IDX 0 /* 0, 1, 2 is allowed - 8,16,32K rx buffer */
94#define RX_BUF_LEN (8192 << RX_BUF_LEN_IDX)
95
Wolfgang Denkd7bffbc2011-11-05 05:13:03 +000096#define DEBUG_TX 0 /* set to 1 to enable debug code */
97#define DEBUG_RX 0 /* set to 1 to enable debug code */
wdenk0260cd62004-01-02 15:01:32 +000098
Marek Vasut922a9ca2020-05-09 22:34:44 +020099#define bus_to_phys(devno, a) dm_pci_mem_to_phys((devno), (a))
100#define phys_to_bus(devno, a) dm_pci_phys_to_mem((devno), (a))
wdenk0260cd62004-01-02 15:01:32 +0000101
102/* Symbolic offsets to registers. */
Marek Vasut230d9822020-04-12 20:47:26 +0200103/* Ethernet hardware address. */
104#define RTL_REG_MAC0 0x00
105/* Multicast filter. */
106#define RTL_REG_MAR0 0x08
107/* Transmit status (four 32bit registers). */
108#define RTL_REG_TXSTATUS0 0x10
109/* Tx descriptors (also four 32bit). */
110#define RTL_REG_TXADDR0 0x20
111#define RTL_REG_RXBUF 0x30
112#define RTL_REG_RXEARLYCNT 0x34
113#define RTL_REG_RXEARLYSTATUS 0x36
114#define RTL_REG_CHIPCMD 0x37
115#define RTL_REG_CHIPCMD_CMDRESET BIT(4)
116#define RTL_REG_CHIPCMD_CMDRXENB BIT(3)
117#define RTL_REG_CHIPCMD_CMDTXENB BIT(2)
118#define RTL_REG_CHIPCMD_RXBUFEMPTY BIT(0)
119#define RTL_REG_RXBUFPTR 0x38
120#define RTL_REG_RXBUFADDR 0x3A
121#define RTL_REG_INTRMASK 0x3C
122#define RTL_REG_INTRSTATUS 0x3E
123#define RTL_REG_INTRSTATUS_PCIERR BIT(15)
124#define RTL_REG_INTRSTATUS_PCSTIMEOUT BIT(14)
125#define RTL_REG_INTRSTATUS_CABLELENCHANGE BIT(13)
126#define RTL_REG_INTRSTATUS_RXFIFOOVER BIT(6)
127#define RTL_REG_INTRSTATUS_RXUNDERRUN BIT(5)
128#define RTL_REG_INTRSTATUS_RXOVERFLOW BIT(4)
129#define RTL_REG_INTRSTATUS_TXERR BIT(3)
130#define RTL_REG_INTRSTATUS_TXOK BIT(2)
131#define RTL_REG_INTRSTATUS_RXERR BIT(1)
132#define RTL_REG_INTRSTATUS_RXOK BIT(0)
133#define RTL_REG_TXCONFIG 0x40
134#define RTL_REG_RXCONFIG 0x44
135#define RTL_REG_RXCONFIG_RXCFGWRAP BIT(7)
136#define RTL_REG_RXCONFIG_ACCEPTERR BIT(5)
137#define RTL_REG_RXCONFIG_ACCEPTRUNT BIT(4)
138#define RTL_REG_RXCONFIG_ACCEPTBROADCAST BIT(3)
139#define RTL_REG_RXCONFIG_ACCEPTMULTICAST BIT(2)
140#define RTL_REG_RXCONFIG_ACCEPTMYPHYS BIT(1)
141#define RTL_REG_RXCONFIG_ACCEPTALLPHYS BIT(0)
142/* general-purpose counter. */
143#define RTL_REG_TIMER 0x48
144/* 24 bits valid, write clears. */
145#define RTL_REG_RXMISSED 0x4C
146#define RTL_REG_CFG9346 0x50
147#define RTL_REG_CONFIG0 0x51
148#define RTL_REG_CONFIG1 0x52
149/* intr if gp counter reaches this value */
150#define RTL_REG_TIMERINTRREG 0x54
151#define RTL_REG_MEDIASTATUS 0x58
152#define RTL_REG_MEDIASTATUS_MSRTXFLOWENABLE BIT(7)
153#define RTL_REG_MEDIASTATUS_MSRRXFLOWENABLE BIT(6)
154#define RTL_REG_MEDIASTATUS_MSRSPEED10 BIT(3)
155#define RTL_REG_MEDIASTATUS_MSRLINKFAIL BIT(2)
156#define RTL_REG_MEDIASTATUS_MSRRXPAUSEFLAG BIT(1)
157#define RTL_REG_MEDIASTATUS_MSRTXPAUSEFLAG BIT(0)
158#define RTL_REG_CONFIG3 0x59
159#define RTL_REG_MULTIINTR 0x5C
160/* revision of the RTL8139 chip */
161#define RTL_REG_REVISIONID 0x5E
162#define RTL_REG_TXSUMMARY 0x60
163#define RTL_REG_MII_BMCR 0x62
164#define RTL_REG_MII_BMSR 0x64
165#define RTL_REG_NWAYADVERT 0x66
166#define RTL_REG_NWAYLPAR 0x68
167#define RTL_REG_NWAYEXPANSION 0x6A
168#define RTL_REG_DISCONNECTCNT 0x6C
169#define RTL_REG_FALSECARRIERCNT 0x6E
170#define RTL_REG_NWAYTESTREG 0x70
171/* packet received counter */
172#define RTL_REG_RXCNT 0x72
173/* chip status and configuration register */
174#define RTL_REG_CSCR 0x74
175#define RTL_REG_PHYPARM1 0x78
176#define RTL_REG_TWISTERPARM 0x7c
177/* undocumented */
178#define RTL_REG_PHYPARM2 0x80
179/*
180 * from 0x84 onwards are a number of power management/wakeup frame
181 * definitions we will probably never need to know about.
182 */
wdenk0260cd62004-01-02 15:01:32 +0000183
Marek Vasut230d9822020-04-12 20:47:26 +0200184#define RTL_STS_RXMULTICAST BIT(15)
185#define RTL_STS_RXPHYSICAL BIT(14)
186#define RTL_STS_RXBROADCAST BIT(13)
187#define RTL_STS_RXBADSYMBOL BIT(5)
188#define RTL_STS_RXRUNT BIT(4)
189#define RTL_STS_RXTOOLONG BIT(3)
190#define RTL_STS_RXCRCERR BIT(2)
191#define RTL_STS_RXBADALIGN BIT(1)
192#define RTL_STS_RXSTATUSOK BIT(0)
wdenk0260cd62004-01-02 15:01:32 +0000193
Marek Vasut775b0672020-05-09 22:34:39 +0200194struct rtl8139_priv {
Marek Vasut922a9ca2020-05-09 22:34:44 +0200195 struct udevice *devno;
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200196 unsigned int rxstatus;
Marek Vasut775b0672020-05-09 22:34:39 +0200197 unsigned int cur_rx;
198 unsigned int cur_tx;
199 unsigned long ioaddr;
Marek Vasut775b0672020-05-09 22:34:39 +0200200 unsigned char enetaddr[6];
201};
wdenk0260cd62004-01-02 15:01:32 +0000202
203/* The RTL8139 can only transmit from a contiguous, aligned memory block. */
Marek Vasut278734b2020-04-12 23:01:45 +0200204static unsigned char tx_buffer[TX_BUF_SIZE] __aligned(4);
205static unsigned char rx_ring[RX_BUF_LEN + 16] __aligned(4);
wdenk0260cd62004-01-02 15:01:32 +0000206
wdenk0260cd62004-01-02 15:01:32 +0000207/* Serial EEPROM section. */
208
209/* EEPROM_Ctrl bits. */
wdenkbc01dd52004-01-02 16:05:07 +0000210#define EE_SHIFT_CLK 0x04 /* EEPROM shift clock. */
211#define EE_CS 0x08 /* EEPROM chip select. */
212#define EE_DATA_WRITE 0x02 /* EEPROM chip data in. */
213#define EE_WRITE_0 0x00
214#define EE_WRITE_1 0x02
215#define EE_DATA_READ 0x01 /* EEPROM chip data out. */
wdenk0260cd62004-01-02 15:01:32 +0000216#define EE_ENB (0x80 | EE_CS)
217
wdenk0260cd62004-01-02 15:01:32 +0000218/* The EEPROM commands include the alway-set leading bit. */
Marek Vasut230d9822020-04-12 20:47:26 +0200219#define EE_WRITE_CMD 5
220#define EE_READ_CMD 6
221#define EE_ERASE_CMD 7
wdenk0260cd62004-01-02 15:01:32 +0000222
Marek Vasuta7c12952020-05-09 22:34:40 +0200223static void rtl8139_eeprom_delay(struct rtl8139_priv *priv)
Marek Vasut77676d52020-04-12 21:20:31 +0200224{
225 /*
226 * Delay between EEPROM clock transitions.
227 * No extra delay is needed with 33MHz PCI, but 66MHz may change this.
228 */
Marek Vasuta7c12952020-05-09 22:34:40 +0200229 inl(priv->ioaddr + RTL_REG_CFG9346);
Marek Vasut77676d52020-04-12 21:20:31 +0200230}
231
Marek Vasut775b0672020-05-09 22:34:39 +0200232static int rtl8139_read_eeprom(struct rtl8139_priv *priv,
Marek Vasut68261942020-05-09 22:34:37 +0200233 unsigned int location, unsigned int addr_len)
wdenk0260cd62004-01-02 15:01:32 +0000234{
Marek Vasut298b3de2020-04-12 21:28:30 +0200235 unsigned int read_cmd = location | (EE_READ_CMD << addr_len);
Marek Vasut775b0672020-05-09 22:34:39 +0200236 uintptr_t ee_addr = priv->ioaddr + RTL_REG_CFG9346;
wdenk0260cd62004-01-02 15:01:32 +0000237 unsigned int retval = 0;
Marek Vasut298b3de2020-04-12 21:28:30 +0200238 u8 dataval;
239 int i;
wdenk0260cd62004-01-02 15:01:32 +0000240
241 outb(EE_ENB & ~EE_CS, ee_addr);
242 outb(EE_ENB, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200243 rtl8139_eeprom_delay(priv);
wdenk0260cd62004-01-02 15:01:32 +0000244
245 /* Shift the read command bits out. */
246 for (i = 4 + addr_len; i >= 0; i--) {
Marek Vasut298b3de2020-04-12 21:28:30 +0200247 dataval = (read_cmd & BIT(i)) ? EE_DATA_WRITE : 0;
wdenk0260cd62004-01-02 15:01:32 +0000248 outb(EE_ENB | dataval, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200249 rtl8139_eeprom_delay(priv);
wdenk0260cd62004-01-02 15:01:32 +0000250 outb(EE_ENB | dataval | EE_SHIFT_CLK, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200251 rtl8139_eeprom_delay(priv);
wdenk0260cd62004-01-02 15:01:32 +0000252 }
Marek Vasut298b3de2020-04-12 21:28:30 +0200253
wdenk0260cd62004-01-02 15:01:32 +0000254 outb(EE_ENB, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200255 rtl8139_eeprom_delay(priv);
wdenk0260cd62004-01-02 15:01:32 +0000256
257 for (i = 16; i > 0; i--) {
258 outb(EE_ENB | EE_SHIFT_CLK, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200259 rtl8139_eeprom_delay(priv);
Marek Vasut298b3de2020-04-12 21:28:30 +0200260 retval <<= 1;
261 retval |= inb(ee_addr) & EE_DATA_READ;
wdenk0260cd62004-01-02 15:01:32 +0000262 outb(EE_ENB, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200263 rtl8139_eeprom_delay(priv);
wdenk0260cd62004-01-02 15:01:32 +0000264 }
265
266 /* Terminate the EEPROM access. */
267 outb(~EE_CS, ee_addr);
Marek Vasuta7c12952020-05-09 22:34:40 +0200268 rtl8139_eeprom_delay(priv);
Marek Vasut298b3de2020-04-12 21:28:30 +0200269
wdenk0260cd62004-01-02 15:01:32 +0000270 return retval;
271}
272
273static const unsigned int rtl8139_rx_config =
274 (RX_BUF_LEN_IDX << 11) |
275 (RX_FIFO_THRESH << 13) |
276 (RX_DMA_BURST << 8);
277
Marek Vasut775b0672020-05-09 22:34:39 +0200278static void rtl8139_set_rx_mode(struct rtl8139_priv *priv)
Marek Vasute07aa6d2020-04-12 21:35:12 +0200279{
wdenk0260cd62004-01-02 15:01:32 +0000280 /* !IFF_PROMISC */
Marek Vasute07aa6d2020-04-12 21:35:12 +0200281 unsigned int rx_mode = RTL_REG_RXCONFIG_ACCEPTBROADCAST |
282 RTL_REG_RXCONFIG_ACCEPTMULTICAST |
283 RTL_REG_RXCONFIG_ACCEPTMYPHYS;
wdenk0260cd62004-01-02 15:01:32 +0000284
Marek Vasut775b0672020-05-09 22:34:39 +0200285 outl(rtl8139_rx_config | rx_mode, priv->ioaddr + RTL_REG_RXCONFIG);
wdenk0260cd62004-01-02 15:01:32 +0000286
Marek Vasut775b0672020-05-09 22:34:39 +0200287 outl(0xffffffff, priv->ioaddr + RTL_REG_MAR0 + 0);
288 outl(0xffffffff, priv->ioaddr + RTL_REG_MAR0 + 4);
wdenk0260cd62004-01-02 15:01:32 +0000289}
290
Marek Vasut775b0672020-05-09 22:34:39 +0200291static void rtl8139_hw_reset(struct rtl8139_priv *priv)
wdenk0260cd62004-01-02 15:01:32 +0000292{
Marek Vasuta51de2b2020-04-12 21:41:56 +0200293 u8 reg;
wdenk0260cd62004-01-02 15:01:32 +0000294 int i;
295
Marek Vasut775b0672020-05-09 22:34:39 +0200296 outb(RTL_REG_CHIPCMD_CMDRESET, priv->ioaddr + RTL_REG_CHIPCMD);
wdenk0260cd62004-01-02 15:01:32 +0000297
wdenk0260cd62004-01-02 15:01:32 +0000298 /* Give the chip 10ms to finish the reset. */
Marek Vasuta51de2b2020-04-12 21:41:56 +0200299 for (i = 0; i < 100; i++) {
Marek Vasut775b0672020-05-09 22:34:39 +0200300 reg = inb(priv->ioaddr + RTL_REG_CHIPCMD);
Marek Vasuta51de2b2020-04-12 21:41:56 +0200301 if (!(reg & RTL_REG_CHIPCMD_CMDRESET))
Marek Vasut230d9822020-04-12 20:47:26 +0200302 break;
Marek Vasuta51de2b2020-04-12 21:41:56 +0200303
304 udelay(100);
wdenk0260cd62004-01-02 15:01:32 +0000305 }
Marek Vasut0b9aab82020-04-12 22:58:27 +0200306}
307
Marek Vasut775b0672020-05-09 22:34:39 +0200308static void rtl8139_reset(struct rtl8139_priv *priv)
Marek Vasut0b9aab82020-04-12 22:58:27 +0200309{
310 int i;
311
Marek Vasut775b0672020-05-09 22:34:39 +0200312 priv->cur_rx = 0;
313 priv->cur_tx = 0;
wdenk0260cd62004-01-02 15:01:32 +0000314
Marek Vasut775b0672020-05-09 22:34:39 +0200315 rtl8139_hw_reset(priv);
wdenk0260cd62004-01-02 15:01:32 +0000316
317 for (i = 0; i < ETH_ALEN; i++)
Marek Vasut775b0672020-05-09 22:34:39 +0200318 outb(priv->enetaddr[i], priv->ioaddr + RTL_REG_MAC0 + i);
wdenk0260cd62004-01-02 15:01:32 +0000319
320 /* Must enable Tx/Rx before setting transfer thresholds! */
Marek Vasut230d9822020-04-12 20:47:26 +0200321 outb(RTL_REG_CHIPCMD_CMDRXENB | RTL_REG_CHIPCMD_CMDTXENB,
Marek Vasut775b0672020-05-09 22:34:39 +0200322 priv->ioaddr + RTL_REG_CHIPCMD);
Marek Vasuta51de2b2020-04-12 21:41:56 +0200323
Marek Vasut6e61bf52020-04-12 21:30:38 +0200324 /* accept no frames yet! */
Marek Vasut775b0672020-05-09 22:34:39 +0200325 outl(rtl8139_rx_config, priv->ioaddr + RTL_REG_RXCONFIG);
326 outl((TX_DMA_BURST << 8) | 0x03000000, priv->ioaddr + RTL_REG_TXCONFIG);
wdenk0260cd62004-01-02 15:01:32 +0000327
Marek Vasuta51de2b2020-04-12 21:41:56 +0200328 /*
329 * The Linux driver changes RTL_REG_CONFIG1 here to use a different
330 * LED pattern for half duplex or full/autodetect duplex (for
331 * full/autodetect, the outputs are TX/RX, Link10/100, FULL, while
332 * for half duplex it uses TX/RX, Link100, Link10). This is messy,
333 * because it doesn't match the inscription on the mounting bracket.
334 * It should not be changed from the configuration EEPROM default,
335 * because the card manufacturer should have set that to match the
336 * card.
337 */
338 debug_cond(DEBUG_RX, "rx ring address is %p\n", rx_ring);
wdenk0260cd62004-01-02 15:01:32 +0000339
Shinya Kuribayashiec450fe2008-01-16 16:12:26 +0900340 flush_cache((unsigned long)rx_ring, RX_BUF_LEN);
Marek Vasut775b0672020-05-09 22:34:39 +0200341 outl(phys_to_bus(priv->devno, (int)rx_ring), priv->ioaddr + RTL_REG_RXBUF);
wdenk0260cd62004-01-02 15:01:32 +0000342
Marek Vasuta51de2b2020-04-12 21:41:56 +0200343 /*
344 * If we add multicast support, the RTL_REG_MAR0 register would have
345 * to be initialized to 0xffffffffffffffff (two 32 bit accesses).
346 * Etherboot only needs broadcast (for ARP/RARP/BOOTP/DHCP) and
347 * unicast.
348 */
Marek Vasut230d9822020-04-12 20:47:26 +0200349 outb(RTL_REG_CHIPCMD_CMDRXENB | RTL_REG_CHIPCMD_CMDTXENB,
Marek Vasut775b0672020-05-09 22:34:39 +0200350 priv->ioaddr + RTL_REG_CHIPCMD);
wdenk0260cd62004-01-02 15:01:32 +0000351
Marek Vasut775b0672020-05-09 22:34:39 +0200352 outl(rtl8139_rx_config, priv->ioaddr + RTL_REG_RXCONFIG);
wdenk0260cd62004-01-02 15:01:32 +0000353
354 /* Start the chip's Tx and Rx process. */
Marek Vasut775b0672020-05-09 22:34:39 +0200355 outl(0, priv->ioaddr + RTL_REG_RXMISSED);
wdenk0260cd62004-01-02 15:01:32 +0000356
Marek Vasut775b0672020-05-09 22:34:39 +0200357 rtl8139_set_rx_mode(priv);
wdenk0260cd62004-01-02 15:01:32 +0000358
359 /* Disable all known interrupts by setting the interrupt mask. */
Marek Vasut775b0672020-05-09 22:34:39 +0200360 outw(0, priv->ioaddr + RTL_REG_INTRMASK);
wdenk0260cd62004-01-02 15:01:32 +0000361}
362
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200363static int rtl8139_send_common(struct rtl8139_priv *priv,
364 void *packet, int length)
wdenk0260cd62004-01-02 15:01:32 +0000365{
wdenk0260cd62004-01-02 15:01:32 +0000366 unsigned int len = length;
Marek Vasutfbead9a2020-04-12 22:40:45 +0200367 unsigned long txstatus;
368 unsigned int status;
Shinya Kuribayashifad82ef2008-01-16 16:11:14 +0900369 int i = 0;
wdenk0260cd62004-01-02 15:01:32 +0000370
Marek Vasutfbead9a2020-04-12 22:40:45 +0200371 memcpy(tx_buffer, packet, length);
wdenk0260cd62004-01-02 15:01:32 +0000372
Wolfgang Denkd7bffbc2011-11-05 05:13:03 +0000373 debug_cond(DEBUG_TX, "sending %d bytes\n", len);
wdenk0260cd62004-01-02 15:01:32 +0000374
Marek Vasutfbead9a2020-04-12 22:40:45 +0200375 /*
376 * Note: RTL8139 doesn't auto-pad, send minimum payload (another 4
377 * bytes are sent automatically for the FCS, totalling to 64 bytes).
378 */
379 while (len < ETH_ZLEN)
wdenk0260cd62004-01-02 15:01:32 +0000380 tx_buffer[len++] = '\0';
wdenk0260cd62004-01-02 15:01:32 +0000381
Shinya Kuribayashiec450fe2008-01-16 16:12:26 +0900382 flush_cache((unsigned long)tx_buffer, length);
Marek Vasut775b0672020-05-09 22:34:39 +0200383 outl(phys_to_bus(priv->devno, (unsigned long)tx_buffer),
384 priv->ioaddr + RTL_REG_TXADDR0 + priv->cur_tx * 4);
Marek Vasutfbead9a2020-04-12 22:40:45 +0200385 outl(((TX_FIFO_THRESH << 11) & 0x003f0000) | len,
Marek Vasut775b0672020-05-09 22:34:39 +0200386 priv->ioaddr + RTL_REG_TXSTATUS0 + priv->cur_tx * 4);
wdenk0260cd62004-01-02 15:01:32 +0000387
wdenk0260cd62004-01-02 15:01:32 +0000388 do {
Marek Vasut775b0672020-05-09 22:34:39 +0200389 status = inw(priv->ioaddr + RTL_REG_INTRSTATUS);
Marek Vasut230d9822020-04-12 20:47:26 +0200390 /*
391 * Only acknlowledge interrupt sources we can properly
392 * handle here - the RTL_REG_INTRSTATUS_RXOVERFLOW/
393 * RTL_REG_INTRSTATUS_RXFIFOOVER MUST be handled in the
Marek Vasut60992ef2020-04-12 22:43:16 +0200394 * rtl8139_recv() function.
Marek Vasut230d9822020-04-12 20:47:26 +0200395 */
Marek Vasutfbead9a2020-04-12 22:40:45 +0200396 status &= RTL_REG_INTRSTATUS_TXOK | RTL_REG_INTRSTATUS_TXERR |
397 RTL_REG_INTRSTATUS_PCIERR;
Marek Vasut775b0672020-05-09 22:34:39 +0200398 outw(status, priv->ioaddr + RTL_REG_INTRSTATUS);
Marek Vasutfbead9a2020-04-12 22:40:45 +0200399 if (status)
Marek Vasut230d9822020-04-12 20:47:26 +0200400 break;
Marek Vasutfbead9a2020-04-12 22:40:45 +0200401
Shinya Kuribayashifad82ef2008-01-16 16:11:14 +0900402 udelay(10);
403 } while (i++ < RTL_TIMEOUT);
wdenk0260cd62004-01-02 15:01:32 +0000404
Marek Vasut775b0672020-05-09 22:34:39 +0200405 txstatus = inl(priv->ioaddr + RTL_REG_TXSTATUS0 + priv->cur_tx * 4);
wdenk0260cd62004-01-02 15:01:32 +0000406
Marek Vasutfbead9a2020-04-12 22:40:45 +0200407 if (!(status & RTL_REG_INTRSTATUS_TXOK)) {
Wolfgang Denkd7bffbc2011-11-05 05:13:03 +0000408 debug_cond(DEBUG_TX,
Marek Vasutfbead9a2020-04-12 22:40:45 +0200409 "tx timeout/error (%d usecs), status %hX txstatus %lX\n",
410 10 * i, status, txstatus);
Wolfgang Denkd7bffbc2011-11-05 05:13:03 +0000411
Marek Vasut775b0672020-05-09 22:34:39 +0200412 rtl8139_reset(priv);
wdenk0260cd62004-01-02 15:01:32 +0000413
414 return 0;
415 }
Marek Vasutfbead9a2020-04-12 22:40:45 +0200416
Marek Vasut775b0672020-05-09 22:34:39 +0200417 priv->cur_tx = (priv->cur_tx + 1) % NUM_TX_DESC;
Marek Vasutfbead9a2020-04-12 22:40:45 +0200418
419 debug_cond(DEBUG_TX, "tx done, status %hX txstatus %lX\n",
420 status, txstatus);
421
422 return length;
wdenk0260cd62004-01-02 15:01:32 +0000423}
424
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200425static int rtl8139_recv_common(struct rtl8139_priv *priv, unsigned char *rxdata,
426 uchar **packetp)
wdenk0260cd62004-01-02 15:01:32 +0000427{
Marek Vasut60992ef2020-04-12 22:43:16 +0200428 const unsigned int rxstat = RTL_REG_INTRSTATUS_RXFIFOOVER |
429 RTL_REG_INTRSTATUS_RXOVERFLOW |
430 RTL_REG_INTRSTATUS_RXOK;
wdenk0260cd62004-01-02 15:01:32 +0000431 unsigned int rx_size, rx_status;
Marek Vasut60992ef2020-04-12 22:43:16 +0200432 unsigned int ring_offs;
Marek Vasut60992ef2020-04-12 22:43:16 +0200433 int length = 0;
wdenk0260cd62004-01-02 15:01:32 +0000434
Marek Vasut775b0672020-05-09 22:34:39 +0200435 if (inb(priv->ioaddr + RTL_REG_CHIPCMD) & RTL_REG_CHIPCMD_RXBUFEMPTY)
wdenk0260cd62004-01-02 15:01:32 +0000436 return 0;
wdenk0260cd62004-01-02 15:01:32 +0000437
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200438 priv->rxstatus = inw(priv->ioaddr + RTL_REG_INTRSTATUS);
wdenk0260cd62004-01-02 15:01:32 +0000439 /* See below for the rest of the interrupt acknowledges. */
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200440 outw(priv->rxstatus & ~rxstat, priv->ioaddr + RTL_REG_INTRSTATUS);
wdenk0260cd62004-01-02 15:01:32 +0000441
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200442 debug_cond(DEBUG_RX, "%s: int %hX ", __func__, priv->rxstatus);
wdenk0260cd62004-01-02 15:01:32 +0000443
Marek Vasut775b0672020-05-09 22:34:39 +0200444 ring_offs = priv->cur_rx % RX_BUF_LEN;
Shinya Kuribayashiec450fe2008-01-16 16:12:26 +0900445 /* ring_offs is guaranteed being 4-byte aligned */
Shinya Kuribayashia466d552008-01-16 16:13:31 +0900446 rx_status = le32_to_cpu(*(unsigned int *)(rx_ring + ring_offs));
wdenk0260cd62004-01-02 15:01:32 +0000447 rx_size = rx_status >> 16;
448 rx_status &= 0xffff;
449
Marek Vasut230d9822020-04-12 20:47:26 +0200450 if ((rx_status & (RTL_STS_RXBADSYMBOL | RTL_STS_RXRUNT |
451 RTL_STS_RXTOOLONG | RTL_STS_RXCRCERR |
452 RTL_STS_RXBADALIGN)) ||
Marek Vasut60992ef2020-04-12 22:43:16 +0200453 (rx_size < ETH_ZLEN) ||
454 (rx_size > ETH_FRAME_LEN + 4)) {
Maxim Uvarov73b447f2023-12-26 21:46:15 +0600455 debug("rx error %hX\n", rx_status);
Marek Vasut60992ef2020-04-12 22:43:16 +0200456 /* this clears all interrupts still pending */
Marek Vasut775b0672020-05-09 22:34:39 +0200457 rtl8139_reset(priv);
wdenk0260cd62004-01-02 15:01:32 +0000458 return 0;
459 }
460
461 /* Received a good packet */
462 length = rx_size - 4; /* no one cares about the FCS */
Marek Vasut60992ef2020-04-12 22:43:16 +0200463 if (ring_offs + 4 + rx_size - 4 > RX_BUF_LEN) {
Marek Vasut60992ef2020-04-12 22:43:16 +0200464 int semi_count = RX_BUF_LEN - ring_offs - 4;
wdenk0260cd62004-01-02 15:01:32 +0000465
466 memcpy(rxdata, rx_ring + ring_offs + 4, semi_count);
Marek Vasut60992ef2020-04-12 22:43:16 +0200467 memcpy(&rxdata[semi_count], rx_ring,
468 rx_size - 4 - semi_count);
wdenk0260cd62004-01-02 15:01:32 +0000469
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200470 *packetp = rxdata;
Wolfgang Denkd7bffbc2011-11-05 05:13:03 +0000471 debug_cond(DEBUG_RX, "rx packet %d+%d bytes",
Marek Vasut60992ef2020-04-12 22:43:16 +0200472 semi_count, rx_size - 4 - semi_count);
wdenk0260cd62004-01-02 15:01:32 +0000473 } else {
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200474 *packetp = rx_ring + ring_offs + 4;
Marek Vasut60992ef2020-04-12 22:43:16 +0200475 debug_cond(DEBUG_RX, "rx packet %d bytes", rx_size - 4);
wdenk0260cd62004-01-02 15:01:32 +0000476 }
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200477
478 return length;
479}
480
481static int rtl8139_free_pkt_common(struct rtl8139_priv *priv, unsigned int len)
482{
483 const unsigned int rxstat = RTL_REG_INTRSTATUS_RXFIFOOVER |
484 RTL_REG_INTRSTATUS_RXOVERFLOW |
485 RTL_REG_INTRSTATUS_RXOK;
486 unsigned int rx_size = len + 4;
487
Shinya Kuribayashiec450fe2008-01-16 16:12:26 +0900488 flush_cache((unsigned long)rx_ring, RX_BUF_LEN);
wdenk0260cd62004-01-02 15:01:32 +0000489
Marek Vasut775b0672020-05-09 22:34:39 +0200490 priv->cur_rx = ROUND(priv->cur_rx + rx_size + 4, 4);
491 outw(priv->cur_rx - 16, priv->ioaddr + RTL_REG_RXBUFPTR);
Marek Vasut60992ef2020-04-12 22:43:16 +0200492 /*
493 * See RTL8139 Programming Guide V0.1 for the official handling of
494 * Rx overflow situations. The document itself contains basically
495 * no usable information, except for a few exception handling rules.
496 */
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200497 outw(priv->rxstatus & rxstat, priv->ioaddr + RTL_REG_INTRSTATUS);
Marek Vasut60992ef2020-04-12 22:43:16 +0200498
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200499 return 0;
wdenk0260cd62004-01-02 15:01:32 +0000500}
501
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200502static int rtl8139_init_common(struct rtl8139_priv *priv)
Marek Vasut5cf25852020-04-12 23:12:11 +0200503{
Marek Vasut5cf25852020-04-12 23:12:11 +0200504 u8 reg;
505
Marek Vasut5cf25852020-04-12 23:12:11 +0200506 /* Bring the chip out of low-power mode. */
Marek Vasut775b0672020-05-09 22:34:39 +0200507 outb(0x00, priv->ioaddr + RTL_REG_CONFIG1);
Marek Vasut5cf25852020-04-12 23:12:11 +0200508
Marek Vasut775b0672020-05-09 22:34:39 +0200509 rtl8139_reset(priv);
Marek Vasut5cf25852020-04-12 23:12:11 +0200510
Marek Vasut775b0672020-05-09 22:34:39 +0200511 reg = inb(priv->ioaddr + RTL_REG_MEDIASTATUS);
Marek Vasut5cf25852020-04-12 23:12:11 +0200512 if (reg & RTL_REG_MEDIASTATUS_MSRLINKFAIL) {
513 printf("Cable not connected or other link failure\n");
514 return -1;
515 }
516
517 return 0;
518}
519
Marek Vasutd9dd2a82020-05-09 22:34:41 +0200520static void rtl8139_stop_common(struct rtl8139_priv *priv)
wdenk0260cd62004-01-02 15:01:32 +0000521{
Marek Vasut775b0672020-05-09 22:34:39 +0200522 rtl8139_hw_reset(priv);
wdenk0260cd62004-01-02 15:01:32 +0000523}
Marek Vasut5cf25852020-04-12 23:12:11 +0200524
Marek Vasutfce51f22020-05-09 22:34:43 +0200525static void rtl8139_get_hwaddr(struct rtl8139_priv *priv)
526{
527 unsigned short *ap = (unsigned short *)priv->enetaddr;
528 int i, addr_len;
529
530 /* Bring the chip out of low-power mode. */
531 outb(0x00, priv->ioaddr + RTL_REG_CONFIG1);
532
533 addr_len = rtl8139_read_eeprom(priv, 0, 8) == 0x8129 ? 8 : 6;
534 for (i = 0; i < 3; i++)
535 *ap++ = le16_to_cpu(rtl8139_read_eeprom(priv, i + 7, addr_len));
536}
537
Marek Vasut66ed9fc2020-05-09 22:34:35 +0200538static void rtl8139_name(char *str, int card_number)
539{
540 sprintf(str, "RTL8139#%u", card_number);
541}
542
Marek Vasut5cf25852020-04-12 23:12:11 +0200543static struct pci_device_id supported[] = {
Marek Vasutac3f0002020-05-09 22:34:42 +0200544 { PCI_DEVICE(PCI_VENDOR_ID_REALTEK, PCI_DEVICE_ID_REALTEK_8139) },
545 { PCI_DEVICE(PCI_VENDOR_ID_DLINK, PCI_DEVICE_ID_DLINK_8139) },
Marek Vasut5cf25852020-04-12 23:12:11 +0200546 { }
547};
548
Marek Vasut922a9ca2020-05-09 22:34:44 +0200549static int rtl8139_start(struct udevice *dev)
550{
Simon Glassfa20e932020-12-03 16:55:20 -0700551 struct eth_pdata *plat = dev_get_plat(dev);
Marek Vasut922a9ca2020-05-09 22:34:44 +0200552 struct rtl8139_priv *priv = dev_get_priv(dev);
553
554 memcpy(priv->enetaddr, plat->enetaddr, sizeof(plat->enetaddr));
555
556 return rtl8139_init_common(priv);
557}
558
559static void rtl8139_stop(struct udevice *dev)
560{
561 struct rtl8139_priv *priv = dev_get_priv(dev);
562
563 rtl8139_stop_common(priv);
564}
565
566static int rtl8139_send(struct udevice *dev, void *packet, int length)
567{
568 struct rtl8139_priv *priv = dev_get_priv(dev);
569 int ret;
570
571 ret = rtl8139_send_common(priv, packet, length);
572
573 return ret ? 0 : -ETIMEDOUT;
574}
575
576static int rtl8139_recv(struct udevice *dev, int flags, uchar **packetp)
577{
578 struct rtl8139_priv *priv = dev_get_priv(dev);
579 static unsigned char rxdata[RX_BUF_LEN];
580
581 return rtl8139_recv_common(priv, rxdata, packetp);
582}
583
584static int rtl8139_free_pkt(struct udevice *dev, uchar *packet, int length)
585{
586 struct rtl8139_priv *priv = dev_get_priv(dev);
587
588 rtl8139_free_pkt_common(priv, length);
589
590 return 0;
591}
592
593static int rtl8139_write_hwaddr(struct udevice *dev)
594{
Simon Glassfa20e932020-12-03 16:55:20 -0700595 struct eth_pdata *plat = dev_get_plat(dev);
Marek Vasut922a9ca2020-05-09 22:34:44 +0200596 struct rtl8139_priv *priv = dev_get_priv(dev);
597
598 memcpy(priv->enetaddr, plat->enetaddr, sizeof(plat->enetaddr));
599
600 rtl8139_reset(priv);
601
602 return 0;
603}
604
605static int rtl8139_read_rom_hwaddr(struct udevice *dev)
606{
607 struct rtl8139_priv *priv = dev_get_priv(dev);
608
609 rtl8139_get_hwaddr(priv);
610
611 return 0;
612}
613
614static int rtl8139_bind(struct udevice *dev)
615{
616 static int card_number;
617 char name[16];
618
619 rtl8139_name(name, card_number++);
620
621 return device_set_name(dev, name);
622}
623
624static int rtl8139_probe(struct udevice *dev)
625{
Simon Glassfa20e932020-12-03 16:55:20 -0700626 struct eth_pdata *plat = dev_get_plat(dev);
Marek Vasut922a9ca2020-05-09 22:34:44 +0200627 struct rtl8139_priv *priv = dev_get_priv(dev);
628 u32 iobase;
629
630 dm_pci_read_config32(dev, PCI_BASE_ADDRESS_1, &iobase);
631 iobase &= ~0xf;
632
633 debug("rtl8139: REALTEK RTL8139 @0x%x\n", iobase);
634
635 priv->devno = dev;
636 priv->ioaddr = (unsigned long)bus_to_phys(dev, iobase);
637
638 rtl8139_get_hwaddr(priv);
639 memcpy(plat->enetaddr, priv->enetaddr, sizeof(priv->enetaddr));
640
641 dm_pci_write_config8(dev, PCI_LATENCY_TIMER, 0x20);
642
643 return 0;
644}
645
646static const struct eth_ops rtl8139_ops = {
647 .start = rtl8139_start,
648 .send = rtl8139_send,
649 .recv = rtl8139_recv,
650 .stop = rtl8139_stop,
651 .free_pkt = rtl8139_free_pkt,
652 .write_hwaddr = rtl8139_write_hwaddr,
653 .read_rom_hwaddr = rtl8139_read_rom_hwaddr,
654};
655
656U_BOOT_DRIVER(eth_rtl8139) = {
657 .name = "eth_rtl8139",
658 .id = UCLASS_ETH,
659 .bind = rtl8139_bind,
660 .probe = rtl8139_probe,
661 .ops = &rtl8139_ops,
Simon Glass8a2b47f2020-12-03 16:55:17 -0700662 .priv_auto = sizeof(struct rtl8139_priv),
Simon Glass71fa5b42020-12-03 16:55:18 -0700663 .plat_auto = sizeof(struct eth_pdata),
Marek Vasut922a9ca2020-05-09 22:34:44 +0200664};
665
666U_BOOT_PCI_DEVICE(eth_rtl8139, supported);