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.
17 #include <asm/cache.h>
20 #include <linux/delay.h>
22 #define PCNET_DEBUG_LEVEL 0 /* 0=off, 1=init, 2=rx/tx */
24 #define PCNET_DEBUG1(fmt,args...) \
25 debug_cond(PCNET_DEBUG_LEVEL > 0, fmt ,##args)
26 #define PCNET_DEBUG2(fmt,args...) \
27 debug_cond(PCNET_DEBUG_LEVEL > 1, fmt ,##args)
30 * Set the number of Tx and Rx buffers, using Log_2(# buffers).
31 * Reasonable default values are 4 Tx buffers, and 16 Rx buffers.
32 * That translates to 2 (4 == 2^^2) and 4 (16 == 2^^4).
34 #define PCNET_LOG_TX_BUFFERS 0
35 #define PCNET_LOG_RX_BUFFERS 2
37 #define TX_RING_SIZE (1 << (PCNET_LOG_TX_BUFFERS))
38 #define TX_RING_LEN_BITS ((PCNET_LOG_TX_BUFFERS) << 12)
40 #define RX_RING_SIZE (1 << (PCNET_LOG_RX_BUFFERS))
41 #define RX_RING_LEN_BITS ((PCNET_LOG_RX_BUFFERS) << 4)
43 #define PKT_BUF_SZ 1544
45 /* The PCNET Rx and Tx ring descriptors. */
46 struct pcnet_rx_head {
54 struct pcnet_tx_head {
62 /* The PCNET 32-Bit initialization block, described in databook. */
63 struct pcnet_init_block {
69 /* Receive and transmit ring base, along with extra bits. */
75 struct pcnet_uncached_priv {
76 struct pcnet_rx_head rx_ring[RX_RING_SIZE];
77 struct pcnet_tx_head tx_ring[TX_RING_SIZE];
78 struct pcnet_init_block init_block;
79 } __aligned(ARCH_DMA_MINALIGN);
82 struct pcnet_uncached_priv ucp;
83 /* Receive Buffer space */
84 unsigned char rx_buf[RX_RING_SIZE][PKT_BUF_SZ + 4];
85 struct pcnet_uncached_priv *uc;
100 /* Offsets from base I/O address for WIO mode */
101 #define PCNET_RDP 0x10
102 #define PCNET_RAP 0x12
103 #define PCNET_RESET 0x14
104 #define PCNET_BDP 0x16
106 static u16 pcnet_read_csr(struct pcnet_priv *lp, int index)
108 writew(index, lp->iobase + PCNET_RAP);
109 return readw(lp->iobase + PCNET_RDP);
112 static void pcnet_write_csr(struct pcnet_priv *lp, int index, u16 val)
114 writew(index, lp->iobase + PCNET_RAP);
115 writew(val, lp->iobase + PCNET_RDP);
118 static u16 pcnet_read_bcr(struct pcnet_priv *lp, int index)
120 writew(index, lp->iobase + PCNET_RAP);
121 return readw(lp->iobase + PCNET_BDP);
124 static void pcnet_write_bcr(struct pcnet_priv *lp, int index, u16 val)
126 writew(index, lp->iobase + PCNET_RAP);
127 writew(val, lp->iobase + PCNET_BDP);
130 static void pcnet_reset(struct pcnet_priv *lp)
132 readw(lp->iobase + PCNET_RESET);
135 static int pcnet_check(struct pcnet_priv *lp)
137 writew(88, lp->iobase + PCNET_RAP);
138 return readw(lp->iobase + PCNET_RAP) == 88;
141 static inline pci_addr_t pcnet_virt_to_mem(struct pcnet_priv *lp, void *addr)
143 void *virt_addr = addr;
146 return dm_pci_virt_to_mem(lp->dev, virt_addr);
148 return pci_virt_to_mem(lp->dev, virt_addr);
152 static struct pci_device_id supported[] = {
153 { PCI_DEVICE(PCI_VENDOR_ID_AMD, PCI_DEVICE_ID_AMD_LANCE) },
157 static int pcnet_probe_common(struct pcnet_priv *lp)
163 /* Reset the PCnet controller */
166 /* Check if register access is working */
167 if (pcnet_read_csr(lp, 0) != 4 || !pcnet_check(lp)) {
168 printf("%s: CSR register access check failed\n", lp->name);
172 /* Identify the chip */
173 chip_version = pcnet_read_csr(lp, 88) | (pcnet_read_csr(lp, 89) << 16);
174 if ((chip_version & 0xfff) != 0x003)
176 chip_version = (chip_version >> 12) & 0xffff;
177 switch (chip_version) {
179 chipname = "PCnet/PCI II 79C970A"; /* PCI */
182 chipname = "PCnet/FAST III 79C973"; /* PCI */
185 chipname = "PCnet/FAST III 79C975"; /* PCI */
188 printf("%s: PCnet version %#x not supported\n",
189 lp->name, chip_version);
193 PCNET_DEBUG1("AMD %s\n", chipname);
196 * In most chips, after a chip reset, the ethernet address is read from
197 * the station address PROM at the base address and programmed into the
198 * "Physical Address Registers" CSR12-14.
200 for (i = 0; i < 3; i++) {
203 val = pcnet_read_csr(lp, i + 12) & 0x0ffff;
204 /* There may be endianness issues here. */
205 lp->enetaddr[2 * i] = val & 0x0ff;
206 lp->enetaddr[2 * i + 1] = (val >> 8) & 0x0ff;
212 static int pcnet_init_common(struct pcnet_priv *lp)
214 struct pcnet_uncached_priv *uc;
218 PCNET_DEBUG1("%s: %s...\n", lp->name, __func__);
220 /* Switch pcnet to 32bit mode */
221 pcnet_write_bcr(lp, 20, 2);
223 /* Set/reset autoselect bit */
224 val = pcnet_read_bcr(lp, 2) & ~2;
226 pcnet_write_bcr(lp, 2, val);
228 /* Enable auto negotiate, setup, disable fd */
229 val = pcnet_read_bcr(lp, 32) & ~0x98;
231 pcnet_write_bcr(lp, 32, val);
234 * Enable NOUFLO on supported controllers, with the transmit
235 * start point set to the full packet. This will cause entire
236 * packets to be buffered by the ethernet controller before
237 * transmission, eliminating underflows which are common on
238 * slower devices. Controllers which do not support NOUFLO will
239 * simply be left with a larger transmit FIFO threshold.
241 val = pcnet_read_bcr(lp, 18);
243 pcnet_write_bcr(lp, 18, val);
244 val = pcnet_read_csr(lp, 80);
246 pcnet_write_csr(lp, 80, val);
250 uc->init_block.mode = cpu_to_le16(0x0000);
251 uc->init_block.filter[0] = 0x00000000;
252 uc->init_block.filter[1] = 0x00000000;
255 * Initialize the Rx ring.
258 for (i = 0; i < RX_RING_SIZE; i++) {
259 addr = pcnet_virt_to_mem(lp, lp->rx_buf[i]);
260 uc->rx_ring[i].base = cpu_to_le32(addr);
261 uc->rx_ring[i].buf_length = cpu_to_le16(-PKT_BUF_SZ);
262 uc->rx_ring[i].status = cpu_to_le16(0x8000);
264 ("Rx%d: base=0x%x buf_length=0x%hx status=0x%hx\n", i,
265 uc->rx_ring[i].base, uc->rx_ring[i].buf_length,
266 uc->rx_ring[i].status);
270 * Initialize the Tx ring. The Tx buffer address is filled in as
271 * needed, but we do need to clear the upper ownership bit.
274 for (i = 0; i < TX_RING_SIZE; i++) {
275 uc->tx_ring[i].base = 0;
276 uc->tx_ring[i].status = 0;
282 PCNET_DEBUG1("Init block at 0x%p: MAC", &lp->uc->init_block);
284 for (i = 0; i < 6; i++) {
285 lp->uc->init_block.phys_addr[i] = lp->enetaddr[i];
286 PCNET_DEBUG1(" %02x", lp->uc->init_block.phys_addr[i]);
289 uc->init_block.tlen_rlen = cpu_to_le16(TX_RING_LEN_BITS |
291 addr = pcnet_virt_to_mem(lp, uc->rx_ring);
292 uc->init_block.rx_ring = cpu_to_le32(addr);
293 addr = pcnet_virt_to_mem(lp, uc->tx_ring);
294 uc->init_block.tx_ring = cpu_to_le32(addr);
296 PCNET_DEBUG1("\ntlen_rlen=0x%x rx_ring=0x%x tx_ring=0x%x\n",
297 uc->init_block.tlen_rlen,
298 uc->init_block.rx_ring, uc->init_block.tx_ring);
301 * Tell the controller where the Init Block is located.
304 addr = pcnet_virt_to_mem(lp, &lp->uc->init_block);
305 pcnet_write_csr(lp, 1, addr & 0xffff);
306 pcnet_write_csr(lp, 2, (addr >> 16) & 0xffff);
308 pcnet_write_csr(lp, 4, 0x0915);
309 pcnet_write_csr(lp, 0, 0x0001); /* start */
311 /* Wait for Init Done bit */
312 for (i = 10000; i > 0; i--) {
313 if (pcnet_read_csr(lp, 0) & 0x0100)
318 printf("%s: TIMEOUT: controller init failed\n", lp->name);
324 * Finally start network controller operation.
326 pcnet_write_csr(lp, 0, 0x0002);
331 static int pcnet_send_common(struct pcnet_priv *lp, void *packet, int pkt_len)
335 struct pcnet_tx_head *entry = &lp->uc->tx_ring[lp->cur_tx];
337 PCNET_DEBUG2("Tx%d: %d bytes from 0x%p ", lp->cur_tx, pkt_len,
340 flush_dcache_range((unsigned long)packet,
341 (unsigned long)packet + pkt_len);
343 /* Wait for completion by testing the OWN bit */
344 for (i = 1000; i > 0; i--) {
345 status = readw(&entry->status);
346 if ((status & 0x8000) == 0)
352 printf("%s: TIMEOUT: Tx%d failed (status = 0x%x)\n",
353 lp->name, lp->cur_tx, status);
359 * Setup Tx ring. Caution: the write order is important here,
360 * set the status with the "ownership" bits last.
362 addr = pcnet_virt_to_mem(lp, packet);
363 writew(-pkt_len, &entry->length);
364 writel(0, &entry->misc);
365 writel(addr, &entry->base);
366 writew(0x8300, &entry->status);
368 /* Trigger an immediate send poll. */
369 pcnet_write_csr(lp, 0, 0x0008);
372 if (++lp->cur_tx >= TX_RING_SIZE)
375 PCNET_DEBUG2("done\n");
379 static int pcnet_recv_common(struct pcnet_priv *lp, unsigned char **bufp)
381 struct pcnet_rx_head *entry;
386 entry = &lp->uc->rx_ring[lp->cur_rx];
388 * If we own the next entry, it's a new packet. Send it up.
390 lp->status = readw(&entry->status);
391 if ((lp->status & 0x8000) != 0)
393 err_status = lp->status >> 8;
395 if (err_status != 0x03) { /* There was an error. */
396 printf("%s: Rx%d", lp->name, lp->cur_rx);
397 PCNET_DEBUG1(" (status=0x%x)", err_status);
398 if (err_status & 0x20)
400 if (err_status & 0x10)
402 if (err_status & 0x08)
404 if (err_status & 0x04)
407 lp->status &= 0x03ff;
411 pkt_len = (readl(&entry->msg_length) & 0xfff) - 4;
413 printf("%s: Rx%d: invalid packet length %d\n",
414 lp->name, lp->cur_rx, pkt_len);
418 *bufp = lp->rx_buf[lp->cur_rx];
419 invalidate_dcache_range((unsigned long)*bufp,
420 (unsigned long)*bufp + pkt_len);
422 PCNET_DEBUG2("Rx%d: %d bytes from 0x%p\n",
423 lp->cur_rx, pkt_len, buf);
428 static void pcnet_free_pkt_common(struct pcnet_priv *lp, unsigned int len)
430 struct pcnet_rx_head *entry;
432 entry = &lp->uc->rx_ring[lp->cur_rx];
434 lp->status |= 0x8000;
435 writew(lp->status, &entry->status);
437 if (++lp->cur_rx >= RX_RING_SIZE)
441 static void pcnet_halt_common(struct pcnet_priv *lp)
445 PCNET_DEBUG1("%s: %s...\n", lp->name, __func__);
447 /* Reset the PCnet controller */
450 /* Wait for Stop bit */
451 for (i = 1000; i > 0; i--) {
452 if (pcnet_read_csr(lp, 0) & 0x4)
457 printf("%s: TIMEOUT: controller reset failed\n", lp->name);
460 #ifndef CONFIG_DM_ETH
461 static int pcnet_init(struct eth_device *dev, struct bd_info *bis)
463 struct pcnet_priv *lp = dev->priv;
465 return pcnet_init_common(lp);
468 static int pcnet_send(struct eth_device *dev, void *packet, int pkt_len)
470 struct pcnet_priv *lp = dev->priv;
472 return pcnet_send_common(lp, packet, pkt_len);
475 static int pcnet_recv(struct eth_device *dev)
477 struct pcnet_priv *lp = dev->priv;
481 ret = pcnet_recv_common(lp, &packet);
483 net_process_received_packet(packet, ret);
485 pcnet_free_pkt_common(lp, ret);
490 static void pcnet_halt(struct eth_device *dev)
492 struct pcnet_priv *lp = dev->priv;
494 pcnet_halt_common(lp);
497 int pcnet_initialize(struct bd_info *bis)
500 struct eth_device *dev;
501 struct pcnet_priv *lp;
506 PCNET_DEBUG1("\n%s...\n", __func__);
508 for (dev_nr = 0; ; dev_nr++) {
510 * Find the PCnet PCI device(s).
512 devbusfn = pci_find_devices(supported, dev_nr);
517 * Allocate and pre-fill the device structure.
519 dev = calloc(1, sizeof(*dev));
521 printf("pcnet: Can not allocate memory\n");
526 * We only maintain one structure because the drivers will
527 * never be used concurrently. In 32bit mode the RX and TX
528 * ring entries must be aligned on 16-byte boundaries.
530 lp = malloc_cache_aligned(sizeof(*lp));
531 lp->uc = map_physmem((phys_addr_t)&lp->ucp,
532 sizeof(lp->ucp), MAP_NOCACHE);
534 flush_dcache_range((unsigned long)lp,
535 (unsigned long)lp + sizeof(*lp));
537 sprintf(dev->name, "pcnet#%d", dev_nr);
538 lp->name = dev->name;
539 lp->enetaddr = dev->enetaddr;
542 * Setup the PCI device.
544 pci_read_config_dword(devbusfn, PCI_BASE_ADDRESS_1, &bar);
545 lp->iobase = (void *)(pci_mem_to_phys(devbusfn, bar) & ~0xf);
547 PCNET_DEBUG1("%s: devbusfn=0x%x iobase=0x%p: ",
548 lp->name, devbusfn, lp->iobase);
550 command = PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER;
551 pci_write_config_word(devbusfn, PCI_COMMAND, command);
552 pci_read_config_word(devbusfn, PCI_COMMAND, &status);
553 if ((status & command) != command) {
554 printf("%s: Couldn't enable IO access or Bus Mastering\n",
560 pci_write_config_byte(devbusfn, PCI_LATENCY_TIMER, 0x40);
563 * Probe the PCnet chip.
565 if (pcnet_probe_common(lp) < 0) {
571 * Setup device structure and register the driver.
573 dev->init = pcnet_init;
574 dev->halt = pcnet_halt;
575 dev->send = pcnet_send;
576 dev->recv = pcnet_recv;
586 static int pcnet_start(struct udevice *dev)
588 struct eth_pdata *plat = dev_get_platdata(dev);
589 struct pcnet_priv *priv = dev_get_priv(dev);
591 memcpy(priv->enetaddr, plat->enetaddr, sizeof(plat->enetaddr));
593 return pcnet_init_common(priv);
596 static void pcnet_stop(struct udevice *dev)
598 struct pcnet_priv *priv = dev_get_priv(dev);
600 pcnet_halt_common(priv);
603 static int pcnet_send(struct udevice *dev, void *packet, int length)
605 struct pcnet_priv *priv = dev_get_priv(dev);
608 ret = pcnet_send_common(priv, packet, length);
610 return ret ? 0 : -ETIMEDOUT;
613 static int pcnet_recv(struct udevice *dev, int flags, uchar **packetp)
615 struct pcnet_priv *priv = dev_get_priv(dev);
617 return pcnet_recv_common(priv, packetp);
620 static int pcnet_free_pkt(struct udevice *dev, uchar *packet, int length)
622 struct pcnet_priv *priv = dev_get_priv(dev);
624 pcnet_free_pkt_common(priv, length);
629 static int pcnet_bind(struct udevice *dev)
631 static int card_number;
634 sprintf(name, "pcnet#%u", card_number++);
636 return device_set_name(dev, name);
639 static int pcnet_probe(struct udevice *dev)
641 struct eth_pdata *plat = dev_get_platdata(dev);
642 struct pcnet_priv *lp = dev_get_priv(dev);
647 dm_pci_read_config32(dev, PCI_BASE_ADDRESS_1, &iobase);
650 lp->uc = map_physmem((phys_addr_t)&lp->ucp,
651 sizeof(lp->ucp), MAP_NOCACHE);
653 lp->name = dev->name;
654 lp->enetaddr = plat->enetaddr;
655 lp->iobase = (void *)dm_pci_mem_to_phys(dev, iobase);
657 flush_dcache_range((unsigned long)lp,
658 (unsigned long)lp + sizeof(*lp));
660 command = PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER;
661 dm_pci_write_config16(dev, PCI_COMMAND, command);
662 dm_pci_read_config16(dev, PCI_COMMAND, &status);
663 if ((status & command) != command) {
664 printf("%s: Couldn't enable IO access or Bus Mastering\n",
669 dm_pci_write_config8(dev, PCI_LATENCY_TIMER, 0x20);
671 ret = pcnet_probe_common(lp);
678 static const struct eth_ops pcnet_ops = {
679 .start = pcnet_start,
683 .free_pkt = pcnet_free_pkt,
686 U_BOOT_DRIVER(eth_pcnet) = {
690 .probe = pcnet_probe,
692 .priv_auto_alloc_size = sizeof(struct pcnet_priv),
693 .platdata_auto_alloc_size = sizeof(struct eth_pdata),
694 .flags = DM_UC_FLAG_ALLOC_PRIV_DMA,
697 U_BOOT_PCI_DEVICE(eth_pcnet, supported);