1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2002 Wolfgang Grandegger, wg@denx.de.
5 * This driver for AMD PCnet network controllers is derived from the
6 * Linux driver pcnet32.c written 1996-1999 by Thomas Bogendoerfer.
16 #include <asm/cache.h>
19 #include <linux/delay.h>
21 #define PCNET_DEBUG_LEVEL 0 /* 0=off, 1=init, 2=rx/tx */
23 #define PCNET_DEBUG1(fmt,args...) \
24 debug_cond(PCNET_DEBUG_LEVEL > 0, fmt ,##args)
25 #define PCNET_DEBUG2(fmt,args...) \
26 debug_cond(PCNET_DEBUG_LEVEL > 1, fmt ,##args)
29 * Set the number of Tx and Rx buffers, using Log_2(# buffers).
30 * Reasonable default values are 4 Tx buffers, and 16 Rx buffers.
31 * That translates to 2 (4 == 2^^2) and 4 (16 == 2^^4).
33 #define PCNET_LOG_TX_BUFFERS 0
34 #define PCNET_LOG_RX_BUFFERS 2
36 #define TX_RING_SIZE (1 << (PCNET_LOG_TX_BUFFERS))
37 #define TX_RING_LEN_BITS ((PCNET_LOG_TX_BUFFERS) << 12)
39 #define RX_RING_SIZE (1 << (PCNET_LOG_RX_BUFFERS))
40 #define RX_RING_LEN_BITS ((PCNET_LOG_RX_BUFFERS) << 4)
42 #define PKT_BUF_SZ 1544
44 /* The PCNET Rx and Tx ring descriptors. */
45 struct pcnet_rx_head {
53 struct pcnet_tx_head {
61 /* The PCNET 32-Bit initialization block, described in databook. */
62 struct pcnet_init_block {
68 /* Receive and transmit ring base, along with extra bits. */
74 struct pcnet_uncached_priv {
75 struct pcnet_rx_head rx_ring[RX_RING_SIZE];
76 struct pcnet_tx_head tx_ring[TX_RING_SIZE];
77 struct pcnet_init_block init_block;
78 } __aligned(ARCH_DMA_MINALIGN);
81 struct pcnet_uncached_priv ucp;
82 /* Receive Buffer space */
83 unsigned char rx_buf[RX_RING_SIZE][PKT_BUF_SZ + 4];
84 struct pcnet_uncached_priv *uc;
94 /* Offsets from base I/O address for WIO mode */
95 #define PCNET_RDP 0x10
96 #define PCNET_RAP 0x12
97 #define PCNET_RESET 0x14
98 #define PCNET_BDP 0x16
100 static u16 pcnet_read_csr(struct pcnet_priv *lp, int index)
102 writew(index, lp->iobase + PCNET_RAP);
103 return readw(lp->iobase + PCNET_RDP);
106 static void pcnet_write_csr(struct pcnet_priv *lp, int index, u16 val)
108 writew(index, lp->iobase + PCNET_RAP);
109 writew(val, lp->iobase + PCNET_RDP);
112 static u16 pcnet_read_bcr(struct pcnet_priv *lp, int index)
114 writew(index, lp->iobase + PCNET_RAP);
115 return readw(lp->iobase + PCNET_BDP);
118 static void pcnet_write_bcr(struct pcnet_priv *lp, int index, u16 val)
120 writew(index, lp->iobase + PCNET_RAP);
121 writew(val, lp->iobase + PCNET_BDP);
124 static void pcnet_reset(struct pcnet_priv *lp)
126 readw(lp->iobase + PCNET_RESET);
129 static int pcnet_check(struct pcnet_priv *lp)
131 writew(88, lp->iobase + PCNET_RAP);
132 return readw(lp->iobase + PCNET_RAP) == 88;
135 static inline pci_addr_t pcnet_virt_to_mem(struct pcnet_priv *lp, void *addr)
137 void *virt_addr = addr;
139 return pci_virt_to_mem(lp->dev, virt_addr);
142 static struct pci_device_id supported[] = {
143 { PCI_DEVICE(PCI_VENDOR_ID_AMD, PCI_DEVICE_ID_AMD_LANCE) },
147 static int pcnet_probe_common(struct pcnet_priv *lp)
153 /* Reset the PCnet controller */
156 /* Check if register access is working */
157 if (pcnet_read_csr(lp, 0) != 4 || !pcnet_check(lp)) {
158 printf("%s: CSR register access check failed\n", lp->name);
162 /* Identify the chip */
163 chip_version = pcnet_read_csr(lp, 88) | (pcnet_read_csr(lp, 89) << 16);
164 if ((chip_version & 0xfff) != 0x003)
166 chip_version = (chip_version >> 12) & 0xffff;
167 switch (chip_version) {
169 chipname = "PCnet/PCI II 79C970A"; /* PCI */
172 chipname = "PCnet/FAST III 79C973"; /* PCI */
175 chipname = "PCnet/FAST III 79C975"; /* PCI */
178 printf("%s: PCnet version %#x not supported\n",
179 lp->name, chip_version);
183 PCNET_DEBUG1("AMD %s\n", chipname);
186 * In most chips, after a chip reset, the ethernet address is read from
187 * the station address PROM at the base address and programmed into the
188 * "Physical Address Registers" CSR12-14.
190 for (i = 0; i < 3; i++) {
193 val = pcnet_read_csr(lp, i + 12) & 0x0ffff;
194 /* There may be endianness issues here. */
195 lp->enetaddr[2 * i] = val & 0x0ff;
196 lp->enetaddr[2 * i + 1] = (val >> 8) & 0x0ff;
202 static int pcnet_init_common(struct pcnet_priv *lp)
204 struct pcnet_uncached_priv *uc;
208 PCNET_DEBUG1("%s: %s...\n", lp->name, __func__);
210 /* Switch pcnet to 32bit mode */
211 pcnet_write_bcr(lp, 20, 2);
213 /* Set/reset autoselect bit */
214 val = pcnet_read_bcr(lp, 2) & ~2;
216 pcnet_write_bcr(lp, 2, val);
218 /* Enable auto negotiate, setup, disable fd */
219 val = pcnet_read_bcr(lp, 32) & ~0x98;
221 pcnet_write_bcr(lp, 32, val);
224 * Enable NOUFLO on supported controllers, with the transmit
225 * start point set to the full packet. This will cause entire
226 * packets to be buffered by the ethernet controller before
227 * transmission, eliminating underflows which are common on
228 * slower devices. Controllers which do not support NOUFLO will
229 * simply be left with a larger transmit FIFO threshold.
231 val = pcnet_read_bcr(lp, 18);
233 pcnet_write_bcr(lp, 18, val);
234 val = pcnet_read_csr(lp, 80);
236 pcnet_write_csr(lp, 80, val);
240 uc->init_block.mode = cpu_to_le16(0x0000);
241 uc->init_block.filter[0] = 0x00000000;
242 uc->init_block.filter[1] = 0x00000000;
245 * Initialize the Rx ring.
248 for (i = 0; i < RX_RING_SIZE; i++) {
249 addr = pcnet_virt_to_mem(lp, lp->rx_buf[i]);
250 uc->rx_ring[i].base = cpu_to_le32(addr);
251 uc->rx_ring[i].buf_length = cpu_to_le16(-PKT_BUF_SZ);
252 uc->rx_ring[i].status = cpu_to_le16(0x8000);
254 ("Rx%d: base=0x%x buf_length=0x%hx status=0x%hx\n", i,
255 uc->rx_ring[i].base, uc->rx_ring[i].buf_length,
256 uc->rx_ring[i].status);
260 * Initialize the Tx ring. The Tx buffer address is filled in as
261 * needed, but we do need to clear the upper ownership bit.
264 for (i = 0; i < TX_RING_SIZE; i++) {
265 uc->tx_ring[i].base = 0;
266 uc->tx_ring[i].status = 0;
272 PCNET_DEBUG1("Init block at 0x%p: MAC", &lp->uc->init_block);
274 for (i = 0; i < 6; i++) {
275 lp->uc->init_block.phys_addr[i] = lp->enetaddr[i];
276 PCNET_DEBUG1(" %02x", lp->uc->init_block.phys_addr[i]);
279 uc->init_block.tlen_rlen = cpu_to_le16(TX_RING_LEN_BITS |
281 addr = pcnet_virt_to_mem(lp, uc->rx_ring);
282 uc->init_block.rx_ring = cpu_to_le32(addr);
283 addr = pcnet_virt_to_mem(lp, uc->tx_ring);
284 uc->init_block.tx_ring = cpu_to_le32(addr);
286 PCNET_DEBUG1("\ntlen_rlen=0x%x rx_ring=0x%x tx_ring=0x%x\n",
287 uc->init_block.tlen_rlen,
288 uc->init_block.rx_ring, uc->init_block.tx_ring);
291 * Tell the controller where the Init Block is located.
294 addr = pcnet_virt_to_mem(lp, &lp->uc->init_block);
295 pcnet_write_csr(lp, 1, addr & 0xffff);
296 pcnet_write_csr(lp, 2, (addr >> 16) & 0xffff);
298 pcnet_write_csr(lp, 4, 0x0915);
299 pcnet_write_csr(lp, 0, 0x0001); /* start */
301 /* Wait for Init Done bit */
302 for (i = 10000; i > 0; i--) {
303 if (pcnet_read_csr(lp, 0) & 0x0100)
308 printf("%s: TIMEOUT: controller init failed\n", lp->name);
314 * Finally start network controller operation.
316 pcnet_write_csr(lp, 0, 0x0002);
321 static int pcnet_send_common(struct pcnet_priv *lp, void *packet, int pkt_len)
325 struct pcnet_tx_head *entry = &lp->uc->tx_ring[lp->cur_tx];
327 PCNET_DEBUG2("Tx%d: %d bytes from 0x%p ", lp->cur_tx, pkt_len,
330 flush_dcache_range((unsigned long)packet,
331 (unsigned long)packet + pkt_len);
333 /* Wait for completion by testing the OWN bit */
334 for (i = 1000; i > 0; i--) {
335 status = readw(&entry->status);
336 if ((status & 0x8000) == 0)
342 printf("%s: TIMEOUT: Tx%d failed (status = 0x%x)\n",
343 lp->name, lp->cur_tx, status);
349 * Setup Tx ring. Caution: the write order is important here,
350 * set the status with the "ownership" bits last.
352 addr = pcnet_virt_to_mem(lp, packet);
353 writew(-pkt_len, &entry->length);
354 writel(0, &entry->misc);
355 writel(addr, &entry->base);
356 writew(0x8300, &entry->status);
358 /* Trigger an immediate send poll. */
359 pcnet_write_csr(lp, 0, 0x0008);
362 if (++lp->cur_tx >= TX_RING_SIZE)
365 PCNET_DEBUG2("done\n");
369 static int pcnet_recv_common(struct pcnet_priv *lp, unsigned char **bufp)
371 struct pcnet_rx_head *entry;
376 entry = &lp->uc->rx_ring[lp->cur_rx];
378 * If we own the next entry, it's a new packet. Send it up.
380 lp->status = readw(&entry->status);
381 if ((lp->status & 0x8000) != 0)
383 err_status = lp->status >> 8;
385 if (err_status != 0x03) { /* There was an error. */
386 printf("%s: Rx%d", lp->name, lp->cur_rx);
387 PCNET_DEBUG1(" (status=0x%x)", err_status);
388 if (err_status & 0x20)
390 if (err_status & 0x10)
392 if (err_status & 0x08)
394 if (err_status & 0x04)
397 lp->status &= 0x03ff;
401 pkt_len = (readl(&entry->msg_length) & 0xfff) - 4;
403 printf("%s: Rx%d: invalid packet length %d\n",
404 lp->name, lp->cur_rx, pkt_len);
408 *bufp = lp->rx_buf[lp->cur_rx];
409 invalidate_dcache_range((unsigned long)*bufp,
410 (unsigned long)*bufp + pkt_len);
412 PCNET_DEBUG2("Rx%d: %d bytes from 0x%p\n",
413 lp->cur_rx, pkt_len, buf);
418 static void pcnet_free_pkt_common(struct pcnet_priv *lp, unsigned int len)
420 struct pcnet_rx_head *entry;
422 entry = &lp->uc->rx_ring[lp->cur_rx];
424 lp->status |= 0x8000;
425 writew(lp->status, &entry->status);
427 if (++lp->cur_rx >= RX_RING_SIZE)
431 static void pcnet_halt_common(struct pcnet_priv *lp)
435 PCNET_DEBUG1("%s: %s...\n", lp->name, __func__);
437 /* Reset the PCnet controller */
440 /* Wait for Stop bit */
441 for (i = 1000; i > 0; i--) {
442 if (pcnet_read_csr(lp, 0) & 0x4)
447 printf("%s: TIMEOUT: controller reset failed\n", lp->name);
450 static int pcnet_init(struct eth_device *dev, bd_t *bis)
452 struct pcnet_priv *lp = dev->priv;
454 return pcnet_init_common(lp);
457 static int pcnet_send(struct eth_device *dev, void *packet, int pkt_len)
459 struct pcnet_priv *lp = dev->priv;
461 return pcnet_send_common(lp, packet, pkt_len);
464 static int pcnet_recv(struct eth_device *dev)
466 struct pcnet_priv *lp = dev->priv;
470 ret = pcnet_recv_common(lp, &packet);
472 net_process_received_packet(packet, ret);
474 pcnet_free_pkt_common(lp, ret);
479 static void pcnet_halt(struct eth_device *dev)
481 struct pcnet_priv *lp = dev->priv;
483 pcnet_halt_common(lp);
486 int pcnet_initialize(bd_t *bis)
489 struct eth_device *dev;
490 struct pcnet_priv *lp;
495 PCNET_DEBUG1("\n%s...\n", __func__);
497 for (dev_nr = 0; ; dev_nr++) {
499 * Find the PCnet PCI device(s).
501 devbusfn = pci_find_devices(supported, dev_nr);
506 * Allocate and pre-fill the device structure.
508 dev = calloc(1, sizeof(*dev));
510 printf("pcnet: Can not allocate memory\n");
515 * We only maintain one structure because the drivers will
516 * never be used concurrently. In 32bit mode the RX and TX
517 * ring entries must be aligned on 16-byte boundaries.
519 lp = malloc_cache_aligned(sizeof(*lp));
520 lp->uc = map_physmem((phys_addr_t)&lp->ucp,
521 sizeof(lp->ucp), MAP_NOCACHE);
523 flush_dcache_range((unsigned long)lp,
524 (unsigned long)lp + sizeof(*lp));
526 sprintf(dev->name, "pcnet#%d", dev_nr);
527 lp->name = dev->name;
528 lp->enetaddr = dev->enetaddr;
531 * Setup the PCI device.
533 pci_read_config_dword(devbusfn, PCI_BASE_ADDRESS_1, &bar);
534 lp->iobase = (void *)(pci_mem_to_phys(devbusfn, bar) & ~0xf);
536 PCNET_DEBUG1("%s: devbusfn=0x%x iobase=0x%p: ",
537 lp->name, devbusfn, lp->iobase);
539 command = PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER;
540 pci_write_config_word(devbusfn, PCI_COMMAND, command);
541 pci_read_config_word(devbusfn, PCI_COMMAND, &status);
542 if ((status & command) != command) {
543 printf("%s: Couldn't enable IO access or Bus Mastering\n",
549 pci_write_config_byte(devbusfn, PCI_LATENCY_TIMER, 0x40);
552 * Probe the PCnet chip.
554 if (pcnet_probe_common(lp) < 0) {
560 * Setup device structure and register the driver.
562 dev->init = pcnet_init;
563 dev->halt = pcnet_halt;
564 dev->send = pcnet_send;
565 dev->recv = pcnet_recv;