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