drivers/net/lib8390.c

   1 /* 8390.c: A general NS8390 ethernet driver core for linux. */
   2 /*
   3         Written 1992-94 by Donald Becker.
   4
   5         Copyright 1993 United States Government as represented by the
   6         Director, National Security Agency.
   7
   8         This software may be used and distributed according to the terms
   9         of the GNU General Public License, incorporated herein by reference.
  10
  11         The author may be reached as becker@scyld.com, or C/O
  12         Scyld Computing Corporation
  13         410 Severn Ave., Suite 210
  14         Annapolis MD 21403
  15
  16
  17   This is the chip-specific code for many 8390-based ethernet adaptors.
  18   This is not a complete driver, it must be combined with board-specific
  19   code such as ne.c, wd.c, 3c503.c, etc.
  20
  21   Seeing how at least eight drivers use this code, (not counting the
  22   PCMCIA ones either) it is easy to break some card by what seems like
  23   a simple innocent change. Please contact me or Donald if you think
  24   you have found something that needs changing. -- PG
  25
  26
  27   Changelog:
  28
  29   Paul Gortmaker        : remove set_bit lock, other cleanups.
  30   Paul Gortmaker        : add ei_get_8390_hdr() so we can pass skb's to
  31                           ei_block_input() for eth_io_copy_and_sum().
  32   Paul Gortmaker        : exchange static int ei_pingpong for a #define,
  33                           also add better Tx error handling.
  34   Paul Gortmaker        : rewrite Rx overrun handling as per NS specs.
  35   Alexey Kuznetsov      : use the 8390's six bit hash multicast filter.
  36   Paul Gortmaker        : tweak ANK's above multicast changes a bit.
  37   Paul Gortmaker        : update packet statistics for v2.1.x
  38   Alan Cox              : support arbitary stupid port mappings on the
  39                           68K Macintosh. Support >16bit I/O spaces
  40   Paul Gortmaker        : add kmod support for auto-loading of the 8390
  41                           module by all drivers that require it.
  42   Alan Cox              : Spinlocking work, added 'BUG_83C690'
  43   Paul Gortmaker        : Separate out Tx timeout code from Tx path.
  44   Paul Gortmaker        : Remove old unused single Tx buffer code.
  45   Hayato Fujiwara       : Add m32r support.
  46   Paul Gortmaker        : use skb_padto() instead of stack scratch area
  47
  48   Sources:
  49   The National Semiconductor LAN Databook, and the 3Com 3c503 databook.
  50
  51   */
  52
  53 #include <linux/module.h>
  54 #include <linux/kernel.h>
  55 #include <linux/jiffies.h>
  56 #include <linux/fs.h>
  57 #include <linux/types.h>
  58 #include <linux/string.h>
  59 #include <linux/bitops.h>
  60 #include <asm/system.h>
  61 #include <asm/uaccess.h>
  62 #include <asm/io.h>
  63 #include <asm/irq.h>
  64 #include <linux/delay.h>
  65 #include <linux/errno.h>
  66 #include <linux/fcntl.h>
  67 #include <linux/in.h>
  68 #include <linux/interrupt.h>
  69 #include <linux/init.h>
  70 #include <linux/crc32.h>
  71
  72 #include <linux/netdevice.h>
  73 #include <linux/etherdevice.h>
  74
  75 #define NS8390_CORE
  76 #include "8390.h"
  77
  78 #define BUG_83C690
  79
  80 /* These are the operational function interfaces to board-specific
  81    routines.
  82         void reset_8390(struct net_device *dev)
  83                 Resets the board associated with DEV, including a hardware reset of
  84                 the 8390.  This is only called when there is a transmit timeout, and
  85                 it is always followed by 8390_init().
  86         void block_output(struct net_device *dev, int count, const unsigned char *buf,
  87                                           int start_page)
  88                 Write the COUNT bytes of BUF to the packet buffer at START_PAGE.  The
  89                 "page" value uses the 8390's 256-byte pages.
  90         void get_8390_hdr(struct net_device *dev, struct e8390_hdr *hdr, int ring_page)
  91                 Read the 4 byte, page aligned 8390 header. *If* there is a
  92                 subsequent read, it will be of the rest of the packet.
  93         void block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
  94                 Read COUNT bytes from the packet buffer into the skb data area. Start
  95                 reading from RING_OFFSET, the address as the 8390 sees it.  This will always
  96                 follow the read of the 8390 header.
  97 */
  98 #define ei_reset_8390 (ei_local->reset_8390)
  99 #define ei_block_output (ei_local->block_output)
 100 #define ei_block_input (ei_local->block_input)
 101 #define ei_get_8390_hdr (ei_local->get_8390_hdr)
 102
 103 /* use 0 for production, 1 for verification, >2 for debug */
 104 #ifndef ei_debug
 105 int ei_debug = 1;
 106 #endif
 107
 108 /* Index to functions. */
 109 static void ei_tx_intr(struct net_device *dev);
 110 static void ei_tx_err(struct net_device *dev);
 111 static void ei_tx_timeout(struct net_device *dev);
 112 static void ei_receive(struct net_device *dev);
 113 static void ei_rx_overrun(struct net_device *dev);
 114
 115 /* Routines generic to NS8390-based boards. */
 116 static void NS8390_trigger_send(struct net_device *dev, unsigned int length,
 117                                                                 int start_page);
 118 static void set_multicast_list(struct net_device *dev);
 119 static void do_set_multicast_list(struct net_device *dev);
 120 static void __NS8390_init(struct net_device *dev, int startp);
 121
 122 /*
 123  *      SMP and the 8390 setup.
 124  *
 125  *      The 8390 isnt exactly designed to be multithreaded on RX/TX. There is
 126  *      a page register that controls bank and packet buffer access. We guard
 127  *      this with ei_local->page_lock. Nobody should assume or set the page other
 128  *      than zero when the lock is not held. Lock holders must restore page 0
 129  *      before unlocking. Even pure readers must take the lock to protect in
 130  *      page 0.
 131  *
 132  *      To make life difficult the chip can also be very slow. We therefore can't
 133  *      just use spinlocks. For the longer lockups we disable the irq the device
 134  *      sits on and hold the lock. We must hold the lock because there is a dual
 135  *      processor case other than interrupts (get stats/set multicast list in
 136  *      parallel with each other and transmit).
 137  *
 138  *      Note: in theory we can just disable the irq on the card _but_ there is
 139  *      a latency on SMP irq delivery. So we can easily go "disable irq" "sync irqs"
 140  *      enter lock, take the queued irq. So we waddle instead of flying.
 141  *
 142  *      Finally by special arrangement for the purpose of being generally
 143  *      annoying the transmit function is called bh atomic. That places
 144  *      restrictions on the user context callers as disable_irq won't save
 145  *      them.
 146  */
 147
 148
 149
 150 /**
 151  * ei_open - Open/initialize the board.
 152  * @dev: network device to initialize
 153  *
 154  * This routine goes all-out, setting everything
 155  * up anew at each open, even though many of these registers should only
 156  * need to be set once at boot.
 157  */
 158 static int __ei_open(struct net_device *dev)
 159 {
 160         unsigned long flags;
 161         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
 162
 163         /* The card I/O part of the driver (e.g. 3c503) can hook a Tx timeout
 164             wrapper that does e.g. media check & then calls ei_tx_timeout. */
 165         if (dev->tx_timeout == NULL)
 166                  dev->tx_timeout = ei_tx_timeout;
 167         if (dev->watchdog_timeo <= 0)
 168                  dev->watchdog_timeo = TX_TIMEOUT;
 169
 170         /*
 171          *      Grab the page lock so we own the register set, then call
 172          *      the init function.
 173          */
 174
 175         spin_lock_irqsave(&ei_local->page_lock, flags);
 176         __NS8390_init(dev, 1);
 177         /* Set the flag before we drop the lock, That way the IRQ arrives
 178            after its set and we get no silly warnings */
 179         netif_start_queue(dev);
 180         spin_unlock_irqrestore(&ei_local->page_lock, flags);
 181         ei_local->irqlock = 0;
 182         return 0;
 183 }
 184
 185 /**
 186  * ei_close - shut down network device
 187  * @dev: network device to close
 188  *
 189  * Opposite of ei_open(). Only used when "ifconfig <devname> down" is done.
 190  */
 191 static int __ei_close(struct net_device *dev)
 192 {
 193         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
 194         unsigned long flags;
 195
 196         /*
 197          *      Hold the page lock during close
 198          */
 199
 200         spin_lock_irqsave(&ei_local->page_lock, flags);
 201         __NS8390_init(dev, 0);
 202         spin_unlock_irqrestore(&ei_local->page_lock, flags);
 203         netif_stop_queue(dev);
 204         return 0;
 205 }
 206
 207 /**
 208  * ei_tx_timeout - handle transmit time out condition
 209  * @dev: network device which has apparently fallen asleep
 210  *
 211  * Called by kernel when device never acknowledges a transmit has
 212  * completed (or failed) - i.e. never posted a Tx related interrupt.
 213  */
 214
 215 static void ei_tx_timeout(struct net_device *dev)
 216 {
 217         unsigned long e8390_base = dev->base_addr;
 218         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
 219         int txsr, isr, tickssofar = jiffies - dev->trans_start;
 220         unsigned long flags;
 221
 222 #if defined(CONFIG_M32R) && defined(CONFIG_SMP)
 223         unsigned long icucr;
 224
 225         local_irq_save(flags);
 226         icucr = inl(M32R_ICU_CR1_PORTL);
 227         icucr |= M32R_ICUCR_ISMOD11;
 228         outl(icucr, M32R_ICU_CR1_PORTL);
 229         local_irq_restore(flags);
 230 #endif
 231         ei_local->stat.tx_errors++;
 232
 233         spin_lock_irqsave(&ei_local->page_lock, flags);
 234         txsr = ei_inb(e8390_base+EN0_TSR);
 235         isr = ei_inb(e8390_base+EN0_ISR);
 236         spin_unlock_irqrestore(&ei_local->page_lock, flags);
 237
 238         printk(KERN_DEBUG "%s: Tx timed out, %s TSR=%#2x, ISR=%#2x, t=%d.\n",
 239                 dev->name, (txsr & ENTSR_ABT) ? "excess collisions." :
 240                 (isr) ? "lost interrupt?" : "cable problem?", txsr, isr, tickssofar);
 241
 242         if (!isr && !ei_local->stat.tx_packets)
 243         {
 244                 /* The 8390 probably hasn't gotten on the cable yet. */
 245                 ei_local->interface_num ^= 1;   /* Try a different xcvr.  */
 246         }
 247
 248         /* Ugly but a reset can be slow, yet must be protected */
 249
 250         disable_irq_nosync_lockdep(dev->irq);
 251         spin_lock(&ei_local->page_lock);
 252
 253         /* Try to restart the card.  Perhaps the user has fixed something. */
 254         ei_reset_8390(dev);
 255         __NS8390_init(dev, 1);
 256
 257         spin_unlock(&ei_local->page_lock);
 258         enable_irq_lockdep(dev->irq);
 259         netif_wake_queue(dev);
 260 }
 261
 262 /**
 263  * ei_start_xmit - begin packet transmission
 264  * @skb: packet to be sent
 265  * @dev: network device to which packet is sent
 266  *
 267  * Sends a packet to an 8390 network device.
 268  */
 269
 270 static int ei_start_xmit(struct sk_buff *skb, struct net_device *dev)
 271 {
 272         unsigned long e8390_base = dev->base_addr;
 273         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
 274         int send_length = skb->len, output_page;
 275         unsigned long flags;
 276         char buf[ETH_ZLEN];
 277         char *data = skb->data;
 278
 279         if (skb->len < ETH_ZLEN) {
 280                 memset(buf, 0, ETH_ZLEN);       /* more efficient than doing just the needed bits */
 281                 memcpy(buf, data, skb->len);
 282                 send_length = ETH_ZLEN;
 283                 data = buf;
 284         }
 285
 286         /* Mask interrupts from the ethercard.
 287            SMP: We have to grab the lock here otherwise the IRQ handler
 288            on another CPU can flip window and race the IRQ mask set. We end
 289            up trashing the mcast filter not disabling irqs if we don't lock */
 290
 291         spin_lock_irqsave(&ei_local->page_lock, flags);
 292         ei_outb_p(0x00, e8390_base + EN0_IMR);
 293         spin_unlock_irqrestore(&ei_local->page_lock, flags);
 294
 295
 296         /*
 297          *      Slow phase with lock held.
 298          */
 299
 300         disable_irq_nosync_lockdep_irqsave(dev->irq, &flags);
 301
 302         spin_lock(&ei_local->page_lock);
 303
 304         ei_local->irqlock = 1;
 305
 306         /*
 307          * We have two Tx slots available for use. Find the first free
 308          * slot, and then perform some sanity checks. With two Tx bufs,
 309          * you get very close to transmitting back-to-back packets. With
 310          * only one Tx buf, the transmitter sits idle while you reload the
 311          * card, leaving a substantial gap between each transmitted packet.
 312          */
 313
 314         if (ei_local->tx1 == 0)
 315         {
 316                 output_page = ei_local->tx_start_page;
 317                 ei_local->tx1 = send_length;
 318                 if (ei_debug  &&  ei_local->tx2 > 0)
 319                         printk(KERN_DEBUG "%s: idle transmitter tx2=%d, lasttx=%d, txing=%d.\n",
 320                                 dev->name, ei_local->tx2, ei_local->lasttx, ei_local->txing);
 321         }
 322         else if (ei_local->tx2 == 0)
 323         {
 324                 output_page = ei_local->tx_start_page + TX_PAGES/2;
 325                 ei_local->tx2 = send_length;
 326                 if (ei_debug  &&  ei_local->tx1 > 0)
 327                         printk(KERN_DEBUG "%s: idle transmitter, tx1=%d, lasttx=%d, txing=%d.\n",
 328                                 dev->name, ei_local->tx1, ei_local->lasttx, ei_local->txing);
 329         }
 330         else
 331         {       /* We should never get here. */
 332                 if (ei_debug)
 333                         printk(KERN_DEBUG "%s: No Tx buffers free! tx1=%d tx2=%d last=%d\n",
 334                                 dev->name, ei_local->tx1, ei_local->tx2, ei_local->lasttx);
 335                 ei_local->irqlock = 0;
 336                 netif_stop_queue(dev);
 337                 ei_outb_p(ENISR_ALL, e8390_base + EN0_IMR);
 338                 spin_unlock(&ei_local->page_lock);
 339                 enable_irq_lockdep_irqrestore(dev->irq, &flags);
 340                 ei_local->stat.tx_errors++;
 341                 return 1;
 342         }
 343
 344         /*
 345          * Okay, now upload the packet and trigger a send if the transmitter
 346          * isn't already sending. If it is busy, the interrupt handler will
 347          * trigger the send later, upon receiving a Tx done interrupt.
 348          */
 349
 350         ei_block_output(dev, send_length, data, output_page);
 351
 352         if (! ei_local->txing)
 353         {
 354                 ei_local->txing = 1;
 355                 NS8390_trigger_send(dev, send_length, output_page);
 356                 dev->trans_start = jiffies;
 357                 if (output_page == ei_local->tx_start_page)
 358                 {
 359                         ei_local->tx1 = -1;
 360                         ei_local->lasttx = -1;
 361                 }
 362                 else
 363                 {
 364                         ei_local->tx2 = -1;
 365                         ei_local->lasttx = -2;
 366                 }
 367         }
 368         else ei_local->txqueue++;
 369
 370         if (ei_local->tx1  &&  ei_local->tx2)
 371                 netif_stop_queue(dev);
 372         else
 373                 netif_start_queue(dev);
 374
 375         /* Turn 8390 interrupts back on. */
 376         ei_local->irqlock = 0;
 377         ei_outb_p(ENISR_ALL, e8390_base + EN0_IMR);
 378
 379         spin_unlock(&ei_local->page_lock);
 380         enable_irq_lockdep_irqrestore(dev->irq, &flags);
 381
 382         dev_kfree_skb (skb);
 383         ei_local->stat.tx_bytes += send_length;
 384
 385         return 0;
 386 }
 387
 388 /**
 389  * ei_interrupt - handle the interrupts from an 8390
 390  * @irq: interrupt number
 391  * @dev_id: a pointer to the net_device
 392  *
 393  * Handle the ether interface interrupts. We pull packets from
 394  * the 8390 via the card specific functions and fire them at the networking
 395  * stack. We also handle transmit completions and wake the transmit path if
 396  * necessary. We also update the counters and do other housekeeping as
 397  * needed.
 398  */
 399
 400 static irqreturn_t __ei_interrupt(int irq, void *dev_id)
 401 {
 402         struct net_device *dev = dev_id;
 403         unsigned long e8390_base = dev->base_addr;
 404         int interrupts, nr_serviced = 0;
 405         struct ei_device *ei_local = netdev_priv(dev);
 406
 407         /*
 408          *      Protect the irq test too.
 409          */
 410
 411         spin_lock(&ei_local->page_lock);
 412
 413         if (ei_local->irqlock)
 414         {
 415 #if 1 /* This might just be an interrupt for a PCI device sharing this line */
 416                 /* The "irqlock" check is only for testing. */
 417                 printk(ei_local->irqlock
 418                            ? "%s: Interrupted while interrupts are masked! isr=%#2x imr=%#2x.\n"
 419                            : "%s: Reentering the interrupt handler! isr=%#2x imr=%#2x.\n",
 420                            dev->name, ei_inb_p(e8390_base + EN0_ISR),
 421                            ei_inb_p(e8390_base + EN0_IMR));
 422 #endif
 423                 spin_unlock(&ei_local->page_lock);
 424                 return IRQ_NONE;
 425         }
 426
 427         /* Change to page 0 and read the intr status reg. */
 428         ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base + E8390_CMD);
 429         if (ei_debug > 3)
 430                 printk(KERN_DEBUG "%s: interrupt(isr=%#2.2x).\n", dev->name,
 431                            ei_inb_p(e8390_base + EN0_ISR));
 432
 433         /* !!Assumption!! -- we stay in page 0.  Don't break this. */
 434         while ((interrupts = ei_inb_p(e8390_base + EN0_ISR)) != 0
 435                    && ++nr_serviced < MAX_SERVICE)
 436         {
 437                 if (!netif_running(dev)) {
 438                         printk(KERN_WARNING "%s: interrupt from stopped card\n", dev->name);
 439                         /* rmk - acknowledge the interrupts */
 440                         ei_outb_p(interrupts, e8390_base + EN0_ISR);
 441                         interrupts = 0;
 442                         break;
 443                 }
 444                 if (interrupts & ENISR_OVER)
 445                         ei_rx_overrun(dev);
 446                 else if (interrupts & (ENISR_RX+ENISR_RX_ERR))
 447                 {
 448                         /* Got a good (?) packet. */
 449                         ei_receive(dev);
 450                 }
 451                 /* Push the next to-transmit packet through. */
 452                 if (interrupts & ENISR_TX)
 453                         ei_tx_intr(dev);
 454                 else if (interrupts & ENISR_TX_ERR)
 455                         ei_tx_err(dev);
 456
 457                 if (interrupts & ENISR_COUNTERS)
 458                 {
 459                         ei_local->stat.rx_frame_errors += ei_inb_p(e8390_base + EN0_COUNTER0);
 460                         ei_local->stat.rx_crc_errors   += ei_inb_p(e8390_base + EN0_COUNTER1);
 461                         ei_local->stat.rx_missed_errors+= ei_inb_p(e8390_base + EN0_COUNTER2);
 462                         ei_outb_p(ENISR_COUNTERS, e8390_base + EN0_ISR); /* Ack intr. */
 463                 }
 464
 465                 /* Ignore any RDC interrupts that make it back to here. */
 466                 if (interrupts & ENISR_RDC)
 467                 {
 468                         ei_outb_p(ENISR_RDC, e8390_base + EN0_ISR);
 469                 }
 470
 471                 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base + E8390_CMD);
 472         }
 473
 474         if (interrupts && ei_debug)
 475         {
 476                 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base + E8390_CMD);
 477                 if (nr_serviced >= MAX_SERVICE)
 478                 {
 479                         /* 0xFF is valid for a card removal */
 480                         if(interrupts!=0xFF)
 481                                 printk(KERN_WARNING "%s: Too much work at interrupt, status %#2.2x\n",
 482                                    dev->name, interrupts);
 483                         ei_outb_p(ENISR_ALL, e8390_base + EN0_ISR); /* Ack. most intrs. */
 484                 } else {
 485                         printk(KERN_WARNING "%s: unknown interrupt %#2x\n", dev->name, interrupts);
 486                         ei_outb_p(0xff, e8390_base + EN0_ISR); /* Ack. all intrs. */
 487                 }
 488         }
 489         spin_unlock(&ei_local->page_lock);
 490         return IRQ_RETVAL(nr_serviced > 0);
 491 }
 492
 493 #ifdef CONFIG_NET_POLL_CONTROLLER
 494 static void __ei_poll(struct net_device *dev)
 495 {
 496         disable_irq_lockdep(dev->irq);
 497         __ei_interrupt(dev->irq, dev);
 498         enable_irq_lockdep(dev->irq);
 499 }
 500 #endif
 501
 502 /**
 503  * ei_tx_err - handle transmitter error
 504  * @dev: network device which threw the exception
 505  *
 506  * A transmitter error has happened. Most likely excess collisions (which
 507  * is a fairly normal condition). If the error is one where the Tx will
 508  * have been aborted, we try and send another one right away, instead of
 509  * letting the failed packet sit and collect dust in the Tx buffer. This
 510  * is a much better solution as it avoids kernel based Tx timeouts, and
 511  * an unnecessary card reset.
 512  *
 513  * Called with lock held.
 514  */
 515
 516 static void ei_tx_err(struct net_device *dev)
 517 {
 518         unsigned long e8390_base = dev->base_addr;
 519         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
 520         unsigned char txsr = ei_inb_p(e8390_base+EN0_TSR);
 521         unsigned char tx_was_aborted = txsr & (ENTSR_ABT+ENTSR_FU);
 522
 523 #ifdef VERBOSE_ERROR_DUMP
 524         printk(KERN_DEBUG "%s: transmitter error (%#2x): ", dev->name, txsr);
 525         if (txsr & ENTSR_ABT)
 526                 printk("excess-collisions ");
 527         if (txsr & ENTSR_ND)
 528                 printk("non-deferral ");
 529         if (txsr & ENTSR_CRS)
 530                 printk("lost-carrier ");
 531         if (txsr & ENTSR_FU)
 532                 printk("FIFO-underrun ");
 533         if (txsr & ENTSR_CDH)
 534                 printk("lost-heartbeat ");
 535         printk("\n");
 536 #endif
 537
 538         ei_outb_p(ENISR_TX_ERR, e8390_base + EN0_ISR); /* Ack intr. */
 539
 540         if (tx_was_aborted)
 541                 ei_tx_intr(dev);
 542         else
 543         {
 544                 ei_local->stat.tx_errors++;
 545                 if (txsr & ENTSR_CRS) ei_local->stat.tx_carrier_errors++;
 546                 if (txsr & ENTSR_CDH) ei_local->stat.tx_heartbeat_errors++;
 547                 if (txsr & ENTSR_OWC) ei_local->stat.tx_window_errors++;
 548         }
 549 }
 550
 551 /**
 552  * ei_tx_intr - transmit interrupt handler
 553  * @dev: network device for which tx intr is handled
 554  *
 555  * We have finished a transmit: check for errors and then trigger the next
 556  * packet to be sent. Called with lock held.
 557  */
 558
 559 static void ei_tx_intr(struct net_device *dev)
 560 {
 561         unsigned long e8390_base = dev->base_addr;
 562         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
 563         int status = ei_inb(e8390_base + EN0_TSR);
 564
 565         ei_outb_p(ENISR_TX, e8390_base + EN0_ISR); /* Ack intr. */
 566
 567         /*
 568          * There are two Tx buffers, see which one finished, and trigger
 569          * the send of another one if it exists.
 570          */
 571         ei_local->txqueue--;
 572
 573         if (ei_local->tx1 < 0)
 574         {
 575                 if (ei_local->lasttx != 1 && ei_local->lasttx != -1)
 576                         printk(KERN_ERR "%s: bogus last_tx_buffer %d, tx1=%d.\n",
 577                                 ei_local->name, ei_local->lasttx, ei_local->tx1);
 578                 ei_local->tx1 = 0;
 579                 if (ei_local->tx2 > 0)
 580                 {
 581                         ei_local->txing = 1;
 582                         NS8390_trigger_send(dev, ei_local->tx2, ei_local->tx_start_page + 6);
 583                         dev->trans_start = jiffies;
 584                         ei_local->tx2 = -1,
 585                         ei_local->lasttx = 2;
 586                 }
 587                 else ei_local->lasttx = 20, ei_local->txing = 0;
 588         }
 589         else if (ei_local->tx2 < 0)
 590         {
 591                 if (ei_local->lasttx != 2  &&  ei_local->lasttx != -2)
 592                         printk("%s: bogus last_tx_buffer %d, tx2=%d.\n",
 593                                 ei_local->name, ei_local->lasttx, ei_local->tx2);
 594                 ei_local->tx2 = 0;
 595                 if (ei_local->tx1 > 0)
 596                 {
 597                         ei_local->txing = 1;
 598                         NS8390_trigger_send(dev, ei_local->tx1, ei_local->tx_start_page);
 599                         dev->trans_start = jiffies;
 600                         ei_local->tx1 = -1;
 601                         ei_local->lasttx = 1;
 602                 }
 603                 else
 604                         ei_local->lasttx = 10, ei_local->txing = 0;
 605         }
 606 //      else printk(KERN_WARNING "%s: unexpected TX-done interrupt, lasttx=%d.\n",
 607 //                      dev->name, ei_local->lasttx);
 608
 609         /* Minimize Tx latency: update the statistics after we restart TXing. */
 610         if (status & ENTSR_COL)
 611                 ei_local->stat.collisions++;
 612         if (status & ENTSR_PTX)
 613                 ei_local->stat.tx_packets++;
 614         else
 615         {
 616                 ei_local->stat.tx_errors++;
 617                 if (status & ENTSR_ABT)
 618                 {
 619                         ei_local->stat.tx_aborted_errors++;
 620                         ei_local->stat.collisions += 16;
 621                 }
 622                 if (status & ENTSR_CRS)
 623                         ei_local->stat.tx_carrier_errors++;
 624                 if (status & ENTSR_FU)
 625                         ei_local->stat.tx_fifo_errors++;
 626                 if (status & ENTSR_CDH)
 627                         ei_local->stat.tx_heartbeat_errors++;
 628                 if (status & ENTSR_OWC)
 629                         ei_local->stat.tx_window_errors++;
 630         }
 631         netif_wake_queue(dev);
 632 }
 633
 634 /**
 635  * ei_receive - receive some packets
 636  * @dev: network device with which receive will be run
 637  *
 638  * We have a good packet(s), get it/them out of the buffers.
 639  * Called with lock held.
 640  */
 641
 642 static void ei_receive(struct net_device *dev)
 643 {
 644         unsigned long e8390_base = dev->base_addr;
 645         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
 646         unsigned char rxing_page, this_frame, next_frame;
 647         unsigned short current_offset;
 648         int rx_pkt_count = 0;
 649         struct e8390_pkt_hdr rx_frame;
 650         int num_rx_pages = ei_local->stop_page-ei_local->rx_start_page;
 651
 652         while (++rx_pkt_count < 10)
 653         {
 654                 int pkt_len, pkt_stat;
 655
 656                 /* Get the rx page (incoming packet pointer). */
 657                 ei_outb_p(E8390_NODMA+E8390_PAGE1, e8390_base + E8390_CMD);
 658                 rxing_page = ei_inb_p(e8390_base + EN1_CURPAG);
 659                 ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base + E8390_CMD);
 660
 661                 /* Remove one frame from the ring.  Boundary is always a page behind. */
 662                 this_frame = ei_inb_p(e8390_base + EN0_BOUNDARY) + 1;
 663                 if (this_frame >= ei_local->stop_page)
 664                         this_frame = ei_local->rx_start_page;
 665
 666                 /* Someday we'll omit the previous, iff we never get this message.
 667                    (There is at least one clone claimed to have a problem.)
 668
 669                    Keep quiet if it looks like a card removal. One problem here
 670                    is that some clones crash in roughly the same way.
 671                  */
 672                 if (ei_debug > 0  &&  this_frame != ei_local->current_page && (this_frame!=0x0 || rxing_page!=0xFF))
 673                         printk(KERN_ERR "%s: mismatched read page pointers %2x vs %2x.\n",
 674                                    dev->name, this_frame, ei_local->current_page);
 675
 676                 if (this_frame == rxing_page)   /* Read all the frames? */
 677                         break;                          /* Done for now */
 678
 679                 current_offset = this_frame << 8;
 680                 ei_get_8390_hdr(dev, &rx_frame, this_frame);
 681
 682                 pkt_len = rx_frame.count - sizeof(struct e8390_pkt_hdr);
 683                 pkt_stat = rx_frame.status;
 684
 685                 next_frame = this_frame + 1 + ((pkt_len+4)>>8);
 686
 687                 /* Check for bogosity warned by 3c503 book: the status byte is never
 688                    written.  This happened a lot during testing! This code should be
 689                    cleaned up someday. */
 690                 if (rx_frame.next != next_frame
 691                         && rx_frame.next != next_frame + 1
 692                         && rx_frame.next != next_frame - num_rx_pages
 693                         && rx_frame.next != next_frame + 1 - num_rx_pages) {
 694                         ei_local->current_page = rxing_page;
 695                         ei_outb(ei_local->current_page-1, e8390_base+EN0_BOUNDARY);
 696                         ei_local->stat.rx_errors++;
 697                         continue;
 698                 }
 699
 700                 if (pkt_len < 60  ||  pkt_len > 1518)
 701                 {
 702                         if (ei_debug)
 703                                 printk(KERN_DEBUG "%s: bogus packet size: %d, status=%#2x nxpg=%#2x.\n",
 704                                            dev->name, rx_frame.count, rx_frame.status,
 705                                            rx_frame.next);
 706                         ei_local->stat.rx_errors++;
 707                         ei_local->stat.rx_length_errors++;
 708                 }
 709                  else if ((pkt_stat & 0x0F) == ENRSR_RXOK)
 710                 {
 711                         struct sk_buff *skb;
 712
 713                         skb = dev_alloc_skb(pkt_len+2);
 714                         if (skb == NULL)
 715                         {
 716                                 if (ei_debug > 1)
 717                                         printk(KERN_DEBUG "%s: Couldn't allocate a sk_buff of size %d.\n",
 718                                                    dev->name, pkt_len);
 719                                 ei_local->stat.rx_dropped++;
 720                                 break;
 721                         }
 722                         else
 723                         {
 724                                 skb_reserve(skb,2);     /* IP headers on 16 byte boundaries */
 725                                 skb->dev = dev;
 726                                 skb_put(skb, pkt_len);  /* Make room */
 727                                 ei_block_input(dev, pkt_len, skb, current_offset + sizeof(rx_frame));
 728                                 skb->protocol=eth_type_trans(skb,dev);
 729                                 netif_rx(skb);
 730                                 dev->last_rx = jiffies;
 731                                 ei_local->stat.rx_packets++;
 732                                 ei_local->stat.rx_bytes += pkt_len;
 733                                 if (pkt_stat & ENRSR_PHY)
 734                                         ei_local->stat.multicast++;
 735                         }
 736                 }
 737                 else
 738                 {
 739                         if (ei_debug)
 740                                 printk(KERN_DEBUG "%s: bogus packet: status=%#2x nxpg=%#2x size=%d\n",
 741                                            dev->name, rx_frame.status, rx_frame.next,
 742                                            rx_frame.count);
 743                         ei_local->stat.rx_errors++;
 744                         /* NB: The NIC counts CRC, frame and missed errors. */
 745                         if (pkt_stat & ENRSR_FO)
 746                                 ei_local->stat.rx_fifo_errors++;
 747                 }
 748                 next_frame = rx_frame.next;
 749
 750                 /* This _should_ never happen: it's here for avoiding bad clones. */
 751                 if (next_frame >= ei_local->stop_page) {
 752                         printk("%s: next frame inconsistency, %#2x\n", dev->name,
 753                                    next_frame);
 754                         next_frame = ei_local->rx_start_page;
 755                 }
 756                 ei_local->current_page = next_frame;
 757                 ei_outb_p(next_frame-1, e8390_base+EN0_BOUNDARY);
 758         }
 759
 760         /* We used to also ack ENISR_OVER here, but that would sometimes mask
 761            a real overrun, leaving the 8390 in a stopped state with rec'vr off. */
 762         ei_outb_p(ENISR_RX+ENISR_RX_ERR, e8390_base+EN0_ISR);
 763         return;
 764 }
 765
 766 /**
 767  * ei_rx_overrun - handle receiver overrun
 768  * @dev: network device which threw exception
 769  *
 770  * We have a receiver overrun: we have to kick the 8390 to get it started
 771  * again. Problem is that you have to kick it exactly as NS prescribes in
 772  * the updated datasheets, or "the NIC may act in an unpredictable manner."
 773  * This includes causing "the NIC to defer indefinitely when it is stopped
 774  * on a busy network."  Ugh.
 775  * Called with lock held. Don't call this with the interrupts off or your
 776  * computer will hate you - it takes 10ms or so.
 777  */
 778
 779 static void ei_rx_overrun(struct net_device *dev)
 780 {
 781         unsigned long e8390_base = dev->base_addr;
 782         unsigned char was_txing, must_resend = 0;
 783         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
 784
 785         /*
 786          * Record whether a Tx was in progress and then issue the
 787          * stop command.
 788          */
 789         was_txing = ei_inb_p(e8390_base+E8390_CMD) & E8390_TRANS;
 790         ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD);
 791
 792         if (ei_debug > 1)
 793                 printk(KERN_DEBUG "%s: Receiver overrun.\n", dev->name);
 794         ei_local->stat.rx_over_errors++;
 795
 796         /*
 797          * Wait a full Tx time (1.2ms) + some guard time, NS says 1.6ms total.
 798          * Early datasheets said to poll the reset bit, but now they say that
 799          * it "is not a reliable indicator and subsequently should be ignored."
 800          * We wait at least 10ms.
 801          */
 802
 803         mdelay(10);
 804
 805         /*
 806          * Reset RBCR[01] back to zero as per magic incantation.
 807          */
 808         ei_outb_p(0x00, e8390_base+EN0_RCNTLO);
 809         ei_outb_p(0x00, e8390_base+EN0_RCNTHI);
 810
 811         /*
 812          * See if any Tx was interrupted or not. According to NS, this
 813          * step is vital, and skipping it will cause no end of havoc.
 814          */
 815
 816         if (was_txing)
 817         {
 818                 unsigned char tx_completed = ei_inb_p(e8390_base+EN0_ISR) & (ENISR_TX+ENISR_TX_ERR);
 819                 if (!tx_completed)
 820                         must_resend = 1;
 821         }
 822
 823         /*
 824          * Have to enter loopback mode and then restart the NIC before
 825          * you are allowed to slurp packets up off the ring.
 826          */
 827         ei_outb_p(E8390_TXOFF, e8390_base + EN0_TXCR);
 828         ei_outb_p(E8390_NODMA + E8390_PAGE0 + E8390_START, e8390_base + E8390_CMD);
 829
 830         /*
 831          * Clear the Rx ring of all the debris, and ack the interrupt.
 832          */
 833         ei_receive(dev);
 834         ei_outb_p(ENISR_OVER, e8390_base+EN0_ISR);
 835
 836         /*
 837          * Leave loopback mode, and resend any packet that got stopped.
 838          */
 839         ei_outb_p(E8390_TXCONFIG, e8390_base + EN0_TXCR);
 840         if (must_resend)
 841                 ei_outb_p(E8390_NODMA + E8390_PAGE0 + E8390_START + E8390_TRANS, e8390_base + E8390_CMD);
 842 }
 843
 844 /*
 845  *      Collect the stats. This is called unlocked and from several contexts.
 846  */
 847
 848 static struct net_device_stats *get_stats(struct net_device *dev)
 849 {
 850         unsigned long ioaddr = dev->base_addr;
 851         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
 852         unsigned long flags;
 853
 854         /* If the card is stopped, just return the present stats. */
 855         if (!netif_running(dev))
 856                 return &ei_local->stat;
 857
 858         spin_lock_irqsave(&ei_local->page_lock,flags);
 859         /* Read the counter registers, assuming we are in page 0. */
 860         ei_local->stat.rx_frame_errors += ei_inb_p(ioaddr + EN0_COUNTER0);
 861         ei_local->stat.rx_crc_errors   += ei_inb_p(ioaddr + EN0_COUNTER1);
 862         ei_local->stat.rx_missed_errors+= ei_inb_p(ioaddr + EN0_COUNTER2);
 863         spin_unlock_irqrestore(&ei_local->page_lock, flags);
 864
 865         return &ei_local->stat;
 866 }
 867
 868 /*
 869  * Form the 64 bit 8390 multicast table from the linked list of addresses
 870  * associated with this dev structure.
 871  */
 872
 873 static inline void make_mc_bits(u8 *bits, struct net_device *dev)
 874 {
 875         struct dev_mc_list *dmi;
 876
 877         for (dmi=dev->mc_list; dmi; dmi=dmi->next)
 878         {
 879                 u32 crc;
 880                 if (dmi->dmi_addrlen != ETH_ALEN)
 881                 {
 882                         printk(KERN_INFO "%s: invalid multicast address length given.\n", dev->name);
 883                         continue;
 884                 }
 885                 crc = ether_crc(ETH_ALEN, dmi->dmi_addr);
 886                 /*
 887                  * The 8390 uses the 6 most significant bits of the
 888                  * CRC to index the multicast table.
 889                  */
 890                 bits[crc>>29] |= (1<<((crc>>26)&7));
 891         }
 892 }
 893
 894 /**
 895  * do_set_multicast_list - set/clear multicast filter
 896  * @dev: net device for which multicast filter is adjusted
 897  *
 898  *      Set or clear the multicast filter for this adaptor. May be called
 899  *      from a BH in 2.1.x. Must be called with lock held.
 900  */
 901
 902 static void do_set_multicast_list(struct net_device *dev)
 903 {
 904         unsigned long e8390_base = dev->base_addr;
 905         int i;
 906         struct ei_device *ei_local = (struct ei_device*)netdev_priv(dev);
 907
 908         if (!(dev->flags&(IFF_PROMISC|IFF_ALLMULTI)))
 909         {
 910                 memset(ei_local->mcfilter, 0, 8);
 911                 if (dev->mc_list)
 912                         make_mc_bits(ei_local->mcfilter, dev);
 913         }
 914         else
 915                 memset(ei_local->mcfilter, 0xFF, 8);    /* mcast set to accept-all */
 916
 917         /*
 918          * DP8390 manuals don't specify any magic sequence for altering
 919          * the multicast regs on an already running card. To be safe, we
 920          * ensure multicast mode is off prior to loading up the new hash
 921          * table. If this proves to be not enough, we can always resort
 922          * to stopping the NIC, loading the table and then restarting.
 923          *
 924          * Bug Alert!  The MC regs on the SMC 83C690 (SMC Elite and SMC
 925          * Elite16) appear to be write-only. The NS 8390 data sheet lists
 926          * them as r/w so this is a bug.  The SMC 83C790 (SMC Ultra and
 927          * Ultra32 EISA) appears to have this bug fixed.
 928          */
 929
 930         if (netif_running(dev))
 931                 ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR);
 932         ei_outb_p(E8390_NODMA + E8390_PAGE1, e8390_base + E8390_CMD);
 933         for(i = 0; i < 8; i++)
 934         {
 935                 ei_outb_p(ei_local->mcfilter[i], e8390_base + EN1_MULT_SHIFT(i));
 936 #ifndef BUG_83C690
 937                 if(ei_inb_p(e8390_base + EN1_MULT_SHIFT(i))!=ei_local->mcfilter[i])
 938                         printk(KERN_ERR "Multicast filter read/write mismap %d\n",i);
 939 #endif
 940         }
 941         ei_outb_p(E8390_NODMA + E8390_PAGE0, e8390_base + E8390_CMD);
 942
 943         if(dev->flags&IFF_PROMISC)
 944                 ei_outb_p(E8390_RXCONFIG | 0x18, e8390_base + EN0_RXCR);
 945         else if(dev->flags&IFF_ALLMULTI || dev->mc_list)
 946                 ei_outb_p(E8390_RXCONFIG | 0x08, e8390_base + EN0_RXCR);
 947         else
 948                 ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR);
 949  }
 950
 951 /*
 952  *      Called without lock held. This is invoked from user context and may
 953  *      be parallel to just about everything else. Its also fairly quick and
 954  *      not called too often. Must protect against both bh and irq users
 955  */
 956
 957 static void set_multicast_list(struct net_device *dev)
 958 {
 959         unsigned long flags;
 960         struct ei_device *ei_local = (struct ei_device*)netdev_priv(dev);
 961
 962         spin_lock_irqsave(&ei_local->page_lock, flags);
 963         do_set_multicast_list(dev);
 964         spin_unlock_irqrestore(&ei_local->page_lock, flags);
 965 }
 966
 967 /**
 968  * ethdev_setup - init rest of 8390 device struct
 969  * @dev: network device structure to init
 970  *
 971  * Initialize the rest of the 8390 device structure.  Do NOT __init
 972  * this, as it is used by 8390 based modular drivers too.
 973  */
 974
 975 static void ethdev_setup(struct net_device *dev)
 976 {
 977         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
 978         if (ei_debug > 1)
 979                 printk(version);
 980
 981         dev->hard_start_xmit = &ei_start_xmit;
 982         dev->get_stats  = get_stats;
 983         dev->set_multicast_list = &set_multicast_list;
 984
 985         ether_setup(dev);
 986
 987         spin_lock_init(&ei_local->page_lock);
 988 }
 989
 990 /**
 991  * alloc_ei_netdev - alloc_etherdev counterpart for 8390
 992  * @size: extra bytes to allocate
 993  *
 994  * Allocate 8390-specific net_device.
 995  */
 996 static struct net_device *____alloc_ei_netdev(int size)
 997 {
 998         return alloc_netdev(sizeof(struct ei_device) + size, "eth%d",
 999                                 ethdev_setup);
1000 }
1001
1002
1003
1004
1005 /* This page of functions should be 8390 generic */
1006 /* Follow National Semi's recommendations for initializing the "NIC". */
1007
1008 /**
1009  * NS8390_init - initialize 8390 hardware
1010  * @dev: network device to initialize
1011  * @startp: boolean.  non-zero value to initiate chip processing
1012  *
1013  *      Must be called with lock held.
1014  */
1015
1016 static void __NS8390_init(struct net_device *dev, int startp)
1017 {
1018         unsigned long e8390_base = dev->base_addr;
1019         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
1020         int i;
1021         int endcfg = ei_local->word16
1022             ? (0x48 | ENDCFG_WTS | (ei_local->bigendian ? ENDCFG_BOS : 0))
1023             : 0x48;
1024
1025         if(sizeof(struct e8390_pkt_hdr)!=4)
1026                 panic("8390.c: header struct mispacked\n");
1027         /* Follow National Semi's recommendations for initing the DP83902. */
1028         ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD); /* 0x21 */
1029         ei_outb_p(endcfg, e8390_base + EN0_DCFG);       /* 0x48 or 0x49 */
1030         /* Clear the remote byte count registers. */
1031         ei_outb_p(0x00,  e8390_base + EN0_RCNTLO);
1032         ei_outb_p(0x00,  e8390_base + EN0_RCNTHI);
1033         /* Set to monitor and loopback mode -- this is vital!. */
1034         ei_outb_p(E8390_RXOFF, e8390_base + EN0_RXCR); /* 0x20 */
1035         ei_outb_p(E8390_TXOFF, e8390_base + EN0_TXCR); /* 0x02 */
1036         /* Set the transmit page and receive ring. */
1037         ei_outb_p(ei_local->tx_start_page, e8390_base + EN0_TPSR);
1038         ei_local->tx1 = ei_local->tx2 = 0;
1039         ei_outb_p(ei_local->rx_start_page, e8390_base + EN0_STARTPG);
1040         ei_outb_p(ei_local->stop_page-1, e8390_base + EN0_BOUNDARY);    /* 3c503 says 0x3f,NS0x26*/
1041         ei_local->current_page = ei_local->rx_start_page;               /* assert boundary+1 */
1042         ei_outb_p(ei_local->stop_page, e8390_base + EN0_STOPPG);
1043         /* Clear the pending interrupts and mask. */
1044         ei_outb_p(0xFF, e8390_base + EN0_ISR);
1045         ei_outb_p(0x00,  e8390_base + EN0_IMR);
1046
1047         /* Copy the station address into the DS8390 registers. */
1048
1049         ei_outb_p(E8390_NODMA + E8390_PAGE1 + E8390_STOP, e8390_base+E8390_CMD); /* 0x61 */
1050         for(i = 0; i < 6; i++)
1051         {
1052                 ei_outb_p(dev->dev_addr[i], e8390_base + EN1_PHYS_SHIFT(i));
1053                 if (ei_debug > 1 && ei_inb_p(e8390_base + EN1_PHYS_SHIFT(i))!=dev->dev_addr[i])
1054                         printk(KERN_ERR "Hw. address read/write mismap %d\n",i);
1055         }
1056
1057         ei_outb_p(ei_local->rx_start_page, e8390_base + EN1_CURPAG);
1058         ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD);
1059
1060         netif_start_queue(dev);
1061         ei_local->tx1 = ei_local->tx2 = 0;
1062         ei_local->txing = 0;
1063
1064         if (startp)
1065         {
1066                 ei_outb_p(0xff,  e8390_base + EN0_ISR);
1067                 ei_outb_p(ENISR_ALL,  e8390_base + EN0_IMR);
1068                 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base+E8390_CMD);
1069                 ei_outb_p(E8390_TXCONFIG, e8390_base + EN0_TXCR); /* xmit on. */
1070                 /* 3c503 TechMan says rxconfig only after the NIC is started. */
1071                 ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR); /* rx on,  */
1072                 do_set_multicast_list(dev);     /* (re)load the mcast table */
1073         }
1074 }
1075
1076 /* Trigger a transmit start, assuming the length is valid.
1077    Always called with the page lock held */
1078
1079 static void NS8390_trigger_send(struct net_device *dev, unsigned int length,
1080                                                                 int start_page)
1081 {
1082         unsigned long e8390_base = dev->base_addr;
1083         struct ei_device *ei_local __attribute((unused)) = (struct ei_device *) netdev_priv(dev);
1084
1085         ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base+E8390_CMD);
1086
1087         if (ei_inb_p(e8390_base + E8390_CMD) & E8390_TRANS)
1088         {
1089                 printk(KERN_WARNING "%s: trigger_send() called with the transmitter busy.\n",
1090                         dev->name);
1091                 return;
1092         }
1093         ei_outb_p(length & 0xff, e8390_base + EN0_TCNTLO);
1094         ei_outb_p(length >> 8, e8390_base + EN0_TCNTHI);
1095         ei_outb_p(start_page, e8390_base + EN0_TPSR);
1096         ei_outb_p(E8390_NODMA+E8390_TRANS+E8390_START, e8390_base+E8390_CMD);
1097 }