drivers/net/pcnet.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2002 Wolfgang Grandegger, wg@denx.de.
   4  *
   5  * This driver for AMD PCnet network controllers is derived from the
   6  * Linux driver pcnet32.c written 1996-1999 by Thomas Bogendoerfer.
   7  */
   8
   9 #include <common.h>
  10 #include <cpu_func.h>
  11 #include <log.h>
  12 #include <malloc.h>
  13 #include <memalign.h>
  14 #include <net.h>
  15 #include <netdev.h>
  16 #include <asm/cache.h>
  17 #include <asm/io.h>
  18 #include <pci.h>
  19 #include <linux/delay.h>
  20
  21 #define PCNET_DEBUG_LEVEL       0       /* 0=off, 1=init, 2=rx/tx */
  22
  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)
  27
  28 /*
  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).
  32  */
  33 #define PCNET_LOG_TX_BUFFERS    0
  34 #define PCNET_LOG_RX_BUFFERS    2
  35
  36 #define TX_RING_SIZE            (1 << (PCNET_LOG_TX_BUFFERS))
  37 #define TX_RING_LEN_BITS        ((PCNET_LOG_TX_BUFFERS) << 12)
  38
  39 #define RX_RING_SIZE            (1 << (PCNET_LOG_RX_BUFFERS))
  40 #define RX_RING_LEN_BITS        ((PCNET_LOG_RX_BUFFERS) << 4)
  41
  42 #define PKT_BUF_SZ              1544
  43
  44 /* The PCNET Rx and Tx ring descriptors. */
  45 struct pcnet_rx_head {
  46         u32 base;
  47         s16 buf_length;
  48         s16 status;
  49         u32 msg_length;
  50         u32 reserved;
  51 };
  52
  53 struct pcnet_tx_head {
  54         u32 base;
  55         s16 length;
  56         s16 status;
  57         u32 misc;
  58         u32 reserved;
  59 };
  60
  61 /* The PCNET 32-Bit initialization block, described in databook. */
  62 struct pcnet_init_block {
  63         u16 mode;
  64         u16 tlen_rlen;
  65         u8 phys_addr[6];
  66         u16 reserved;
  67         u32 filter[2];
  68         /* Receive and transmit ring base, along with extra bits. */
  69         u32 rx_ring;
  70         u32 tx_ring;
  71         u32 reserved2;
  72 };
  73
  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);
  79
  80 struct pcnet_priv {
  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;
  85         pci_dev_t dev;
  86         int cur_rx;
  87         int cur_tx;
  88 };
  89
  90 /* Offsets from base I/O address for WIO mode */
  91 #define PCNET_RDP               0x10
  92 #define PCNET_RAP               0x12
  93 #define PCNET_RESET             0x14
  94 #define PCNET_BDP               0x16
  95
  96 static u16 pcnet_read_csr(struct eth_device *dev, int index)
  97 {
  98         void __iomem *base = (void __iomem *)dev->iobase;
  99
 100         writew(index, base + PCNET_RAP);
 101         return readw(base + PCNET_RDP);
 102 }
 103
 104 static void pcnet_write_csr(struct eth_device *dev, int index, u16 val)
 105 {
 106         void __iomem *base = (void __iomem *)dev->iobase;
 107
 108         writew(index, base + PCNET_RAP);
 109         writew(val, base + PCNET_RDP);
 110 }
 111
 112 static u16 pcnet_read_bcr(struct eth_device *dev, int index)
 113 {
 114         void __iomem *base = (void __iomem *)dev->iobase;
 115
 116         writew(index, base + PCNET_RAP);
 117         return readw(base + PCNET_BDP);
 118 }
 119
 120 static void pcnet_write_bcr(struct eth_device *dev, int index, u16 val)
 121 {
 122         void __iomem *base = (void __iomem *)dev->iobase;
 123
 124         writew(index, base + PCNET_RAP);
 125         writew(val, base + PCNET_BDP);
 126 }
 127
 128 static void pcnet_reset(struct eth_device *dev)
 129 {
 130         void __iomem *base = (void __iomem *)dev->iobase;
 131
 132         readw(base + PCNET_RESET);
 133 }
 134
 135 static int pcnet_check(struct eth_device *dev)
 136 {
 137         void __iomem *base = (void __iomem *)dev->iobase;
 138
 139         writew(88, base + PCNET_RAP);
 140         return readw(base + PCNET_RAP) == 88;
 141 }
 142
 143 static inline pci_addr_t pcnet_virt_to_mem(struct pcnet_priv *lp, void *addr)
 144 {
 145         void *virt_addr = addr;
 146
 147         return pci_virt_to_mem(lp->dev, virt_addr);
 148 }
 149
 150 static struct pci_device_id supported[] = {
 151         { PCI_DEVICE(PCI_VENDOR_ID_AMD, PCI_DEVICE_ID_AMD_LANCE) },
 152         {}
 153 };
 154
 155 static int pcnet_probe(struct eth_device *dev, bd_t *bis, int dev_nr)
 156 {
 157         int chip_version;
 158         char *chipname;
 159         int i;
 160
 161         /* Reset the PCnet controller */
 162         pcnet_reset(dev);
 163
 164         /* Check if register access is working */
 165         if (pcnet_read_csr(dev, 0) != 4 || !pcnet_check(dev)) {
 166                 printf("%s: CSR register access check failed\n", dev->name);
 167                 return -1;
 168         }
 169
 170         /* Identify the chip */
 171         chip_version =
 172                 pcnet_read_csr(dev, 88) | (pcnet_read_csr(dev, 89) << 16);
 173         if ((chip_version & 0xfff) != 0x003)
 174                 return -1;
 175         chip_version = (chip_version >> 12) & 0xffff;
 176         switch (chip_version) {
 177         case 0x2621:
 178                 chipname = "PCnet/PCI II 79C970A";      /* PCI */
 179                 break;
 180         case 0x2625:
 181                 chipname = "PCnet/FAST III 79C973";     /* PCI */
 182                 break;
 183         case 0x2627:
 184                 chipname = "PCnet/FAST III 79C975";     /* PCI */
 185                 break;
 186         default:
 187                 printf("%s: PCnet version %#x not supported\n",
 188                        dev->name, chip_version);
 189                 return -1;
 190         }
 191
 192         PCNET_DEBUG1("AMD %s\n", chipname);
 193
 194         /*
 195          * In most chips, after a chip reset, the ethernet address is read from
 196          * the station address PROM at the base address and programmed into the
 197          * "Physical Address Registers" CSR12-14.
 198          */
 199         for (i = 0; i < 3; i++) {
 200                 unsigned int val;
 201
 202                 val = pcnet_read_csr(dev, i + 12) & 0x0ffff;
 203                 /* There may be endianness issues here. */
 204                 dev->enetaddr[2 * i] = val & 0x0ff;
 205                 dev->enetaddr[2 * i + 1] = (val >> 8) & 0x0ff;
 206         }
 207
 208         return 0;
 209 }
 210
 211 static int pcnet_init(struct eth_device *dev, bd_t *bis)
 212 {
 213         struct pcnet_priv *lp = dev->priv;
 214         struct pcnet_uncached_priv *uc;
 215         int i, val;
 216         unsigned long addr;
 217
 218         PCNET_DEBUG1("%s: pcnet_init...\n", dev->name);
 219
 220         /* Switch pcnet to 32bit mode */
 221         pcnet_write_bcr(dev, 20, 2);
 222
 223         /* Set/reset autoselect bit */
 224         val = pcnet_read_bcr(dev, 2) & ~2;
 225         val |= 2;
 226         pcnet_write_bcr(dev, 2, val);
 227
 228         /* Enable auto negotiate, setup, disable fd */
 229         val = pcnet_read_bcr(dev, 32) & ~0x98;
 230         val |= 0x20;
 231         pcnet_write_bcr(dev, 32, val);
 232
 233         /*
 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.
 240          */
 241         val = pcnet_read_bcr(dev, 18);
 242         val |= 1 << 11;
 243         pcnet_write_bcr(dev, 18, val);
 244         val = pcnet_read_csr(dev, 80);
 245         val |= 0x3 << 10;
 246         pcnet_write_csr(dev, 80, val);
 247
 248         uc = lp->uc;
 249
 250         uc->init_block.mode = cpu_to_le16(0x0000);
 251         uc->init_block.filter[0] = 0x00000000;
 252         uc->init_block.filter[1] = 0x00000000;
 253
 254         /*
 255          * Initialize the Rx ring.
 256          */
 257         lp->cur_rx = 0;
 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);
 263                 PCNET_DEBUG1
 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);
 267         }
 268
 269         /*
 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.
 272          */
 273         lp->cur_tx = 0;
 274         for (i = 0; i < TX_RING_SIZE; i++) {
 275                 uc->tx_ring[i].base = 0;
 276                 uc->tx_ring[i].status = 0;
 277         }
 278
 279         /*
 280          * Setup Init Block.
 281          */
 282         PCNET_DEBUG1("Init block at 0x%p: MAC", &lp->uc->init_block);
 283
 284         for (i = 0; i < 6; i++) {
 285                 lp->uc->init_block.phys_addr[i] = dev->enetaddr[i];
 286                 PCNET_DEBUG1(" %02x", lp->uc->init_block.phys_addr[i]);
 287         }
 288
 289         uc->init_block.tlen_rlen = cpu_to_le16(TX_RING_LEN_BITS |
 290                                                RX_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);
 295
 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);
 299
 300         /*
 301          * Tell the controller where the Init Block is located.
 302          */
 303         barrier();
 304         addr = pcnet_virt_to_mem(lp, &lp->uc->init_block);
 305         pcnet_write_csr(dev, 1, addr & 0xffff);
 306         pcnet_write_csr(dev, 2, (addr >> 16) & 0xffff);
 307
 308         pcnet_write_csr(dev, 4, 0x0915);
 309         pcnet_write_csr(dev, 0, 0x0001);        /* start */
 310
 311         /* Wait for Init Done bit */
 312         for (i = 10000; i > 0; i--) {
 313                 if (pcnet_read_csr(dev, 0) & 0x0100)
 314                         break;
 315                 udelay(10);
 316         }
 317         if (i <= 0) {
 318                 printf("%s: TIMEOUT: controller init failed\n", dev->name);
 319                 pcnet_reset(dev);
 320                 return -1;
 321         }
 322
 323         /*
 324          * Finally start network controller operation.
 325          */
 326         pcnet_write_csr(dev, 0, 0x0002);
 327
 328         return 0;
 329 }
 330
 331 static int pcnet_send(struct eth_device *dev, void *packet, int pkt_len)
 332 {
 333         struct pcnet_priv *lp = dev->priv;
 334         int i, status;
 335         u32 addr;
 336         struct pcnet_tx_head *entry = &lp->uc->tx_ring[lp->cur_tx];
 337
 338         PCNET_DEBUG2("Tx%d: %d bytes from 0x%p ", lp->cur_tx, pkt_len,
 339                      packet);
 340
 341         flush_dcache_range((unsigned long)packet,
 342                            (unsigned long)packet + pkt_len);
 343
 344         /* Wait for completion by testing the OWN bit */
 345         for (i = 1000; i > 0; i--) {
 346                 status = readw(&entry->status);
 347                 if ((status & 0x8000) == 0)
 348                         break;
 349                 udelay(100);
 350                 PCNET_DEBUG2(".");
 351         }
 352         if (i <= 0) {
 353                 printf("%s: TIMEOUT: Tx%d failed (status = 0x%x)\n",
 354                        dev->name, lp->cur_tx, status);
 355                 pkt_len = 0;
 356                 goto failure;
 357         }
 358
 359         /*
 360          * Setup Tx ring. Caution: the write order is important here,
 361          * set the status with the "ownership" bits last.
 362          */
 363         addr = pcnet_virt_to_mem(lp, packet);
 364         writew(-pkt_len, &entry->length);
 365         writel(0, &entry->misc);
 366         writel(addr, &entry->base);
 367         writew(0x8300, &entry->status);
 368
 369         /* Trigger an immediate send poll. */
 370         pcnet_write_csr(dev, 0, 0x0008);
 371
 372       failure:
 373         if (++lp->cur_tx >= TX_RING_SIZE)
 374                 lp->cur_tx = 0;
 375
 376         PCNET_DEBUG2("done\n");
 377         return pkt_len;
 378 }
 379
 380 static int pcnet_recv (struct eth_device *dev)
 381 {
 382         struct pcnet_priv *lp = dev->priv;
 383         struct pcnet_rx_head *entry;
 384         unsigned char *buf;
 385         int pkt_len = 0;
 386         u16 status, err_status;
 387
 388         while (1) {
 389                 entry = &lp->uc->rx_ring[lp->cur_rx];
 390                 /*
 391                  * If we own the next entry, it's a new packet. Send it up.
 392                  */
 393                 status = readw(&entry->status);
 394                 if ((status & 0x8000) != 0)
 395                         break;
 396                 err_status = status >> 8;
 397
 398                 if (err_status != 0x03) {       /* There was an error. */
 399                         printf("%s: Rx%d", dev->name, lp->cur_rx);
 400                         PCNET_DEBUG1(" (status=0x%x)", err_status);
 401                         if (err_status & 0x20)
 402                                 printf(" Frame");
 403                         if (err_status & 0x10)
 404                                 printf(" Overflow");
 405                         if (err_status & 0x08)
 406                                 printf(" CRC");
 407                         if (err_status & 0x04)
 408                                 printf(" Fifo");
 409                         printf(" Error\n");
 410                         status &= 0x03ff;
 411
 412                 } else {
 413                         pkt_len = (readl(&entry->msg_length) & 0xfff) - 4;
 414                         if (pkt_len < 60) {
 415                                 printf("%s: Rx%d: invalid packet length %d\n",
 416                                        dev->name, lp->cur_rx, pkt_len);
 417                         } else {
 418                                 buf = lp->rx_buf[lp->cur_rx];
 419                                 invalidate_dcache_range((unsigned long)buf,
 420                                         (unsigned long)buf + pkt_len);
 421                                 net_process_received_packet(buf, pkt_len);
 422                                 PCNET_DEBUG2("Rx%d: %d bytes from 0x%p\n",
 423                                              lp->cur_rx, pkt_len, buf);
 424                         }
 425                 }
 426
 427                 status |= 0x8000;
 428                 writew(status, &entry->status);
 429
 430                 if (++lp->cur_rx >= RX_RING_SIZE)
 431                         lp->cur_rx = 0;
 432         }
 433         return pkt_len;
 434 }
 435
 436 static void pcnet_halt(struct eth_device *dev)
 437 {
 438         int i;
 439
 440         PCNET_DEBUG1("%s: pcnet_halt...\n", dev->name);
 441
 442         /* Reset the PCnet controller */
 443         pcnet_reset(dev);
 444
 445         /* Wait for Stop bit */
 446         for (i = 1000; i > 0; i--) {
 447                 if (pcnet_read_csr(dev, 0) & 0x4)
 448                         break;
 449                 udelay(10);
 450         }
 451         if (i <= 0)
 452                 printf("%s: TIMEOUT: controller reset failed\n", dev->name);
 453 }
 454
 455 int pcnet_initialize(bd_t *bis)
 456 {
 457         pci_dev_t devbusfn;
 458         struct eth_device *dev;
 459         struct pcnet_priv *lp;
 460         u16 command, status;
 461         int dev_nr = 0;
 462         u32 bar;
 463
 464         PCNET_DEBUG1("\npcnet_initialize...\n");
 465
 466         for (dev_nr = 0; ; dev_nr++) {
 467                 /*
 468                  * Find the PCnet PCI device(s).
 469                  */
 470                 devbusfn = pci_find_devices(supported, dev_nr);
 471                 if (devbusfn < 0)
 472                         break;
 473
 474                 /*
 475                  * Allocate and pre-fill the device structure.
 476                  */
 477                 dev = calloc(1, sizeof(*dev));
 478                 if (!dev) {
 479                         printf("pcnet: Can not allocate memory\n");
 480                         break;
 481                 }
 482
 483                 /*
 484                  * We only maintain one structure because the drivers will
 485                  * never be used concurrently. In 32bit mode the RX and TX
 486                  * ring entries must be aligned on 16-byte boundaries.
 487                  */
 488                 lp = malloc_cache_aligned(sizeof(*lp));
 489                 lp->uc = map_physmem((phys_addr_t)&lp->ucp,
 490                                      sizeof(lp->ucp), MAP_NOCACHE);
 491                 lp->dev = devbusfn;
 492                 flush_dcache_range((unsigned long)lp,
 493                                    (unsigned long)lp + sizeof(*lp));
 494                 dev->priv = lp;
 495                 sprintf(dev->name, "pcnet#%d", dev_nr);
 496
 497                 /*
 498                  * Setup the PCI device.
 499                  */
 500                 pci_read_config_dword(devbusfn, PCI_BASE_ADDRESS_1, &bar);
 501                 dev->iobase = pci_mem_to_phys(devbusfn, bar);
 502                 dev->iobase &= ~0xf;
 503
 504                 PCNET_DEBUG1("%s: devbusfn=0x%x iobase=0x%lx: ",
 505                              dev->name, devbusfn, (unsigned long)dev->iobase);
 506
 507                 command = PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER;
 508                 pci_write_config_word(devbusfn, PCI_COMMAND, command);
 509                 pci_read_config_word(devbusfn, PCI_COMMAND, &status);
 510                 if ((status & command) != command) {
 511                         printf("%s: Couldn't enable IO access or Bus Mastering\n",
 512                                dev->name);
 513                         free(dev);
 514                         continue;
 515                 }
 516
 517                 pci_write_config_byte(devbusfn, PCI_LATENCY_TIMER, 0x40);
 518
 519                 /*
 520                  * Probe the PCnet chip.
 521                  */
 522                 if (pcnet_probe(dev, bis, dev_nr) < 0) {
 523                         free(dev);
 524                         continue;
 525                 }
 526
 527                 /*
 528                  * Setup device structure and register the driver.
 529                  */
 530                 dev->init = pcnet_init;
 531                 dev->halt = pcnet_halt;
 532                 dev->send = pcnet_send;
 533                 dev->recv = pcnet_recv;
 534
 535                 eth_register(dev);
 536         }
 537
 538         udelay(10 * 1000);
 539
 540         return dev_nr;
 541 }