1 /* 8390.c: A general NS8390 ethernet driver core for linux. */
3 Written 1992-94 by Donald Becker.
5 Copyright 1993 United States Government as represented by the
6 Director, National Security Agency.
8 This software may be used and distributed according to the terms
9 of the GNU General Public License, incorporated herein by reference.
11 The author may be reached as becker@scyld.com, or C/O
12 Scyld Computing Corporation
13 410 Severn Ave., Suite 210
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.
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
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
49 The National Semiconductor LAN Databook, and the 3Com 3c503 databook.
53 #include <linux/module.h>
54 #include <linux/kernel.h>
55 #include <linux/jiffies.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>
64 #include <linux/delay.h>
65 #include <linux/errno.h>
66 #include <linux/fcntl.h>
68 #include <linux/interrupt.h>
69 #include <linux/init.h>
70 #include <linux/crc32.h>
72 #include <linux/netdevice.h>
73 #include <linux/etherdevice.h>
80 /* These are the operational function interfaces to board-specific
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,
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.
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)
103 /* use 0 for production, 1 for verification, >2 for debug */
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 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);
115 /* Routines generic to NS8390-based boards. */
116 static void NS8390_trigger_send(struct net_device *dev, unsigned int length,
118 static void do_set_multicast_list(struct net_device *dev);
119 static void __NS8390_init(struct net_device *dev, int startp);
122 * SMP and the 8390 setup.
124 * The 8390 isnt exactly designed to be multithreaded on RX/TX. There is
125 * a page register that controls bank and packet buffer access. We guard
126 * this with ei_local->page_lock. Nobody should assume or set the page other
127 * than zero when the lock is not held. Lock holders must restore page 0
128 * before unlocking. Even pure readers must take the lock to protect in
131 * To make life difficult the chip can also be very slow. We therefore can't
132 * just use spinlocks. For the longer lockups we disable the irq the device
133 * sits on and hold the lock. We must hold the lock because there is a dual
134 * processor case other than interrupts (get stats/set multicast list in
135 * parallel with each other and transmit).
137 * Note: in theory we can just disable the irq on the card _but_ there is
138 * a latency on SMP irq delivery. So we can easily go "disable irq" "sync irqs"
139 * enter lock, take the queued irq. So we waddle instead of flying.
141 * Finally by special arrangement for the purpose of being generally
142 * annoying the transmit function is called bh atomic. That places
143 * restrictions on the user context callers as disable_irq won't save
146 * Additional explanation of problems with locking by Alan Cox:
148 * "The author (me) didn't use spin_lock_irqsave because the slowness of the
149 * card means that approach caused horrible problems like losing serial data
150 * at 38400 baud on some chips. Remember many 8390 nics on PCI were ISA
151 * chips with FPGA front ends.
153 * Ok the logic behind the 8390 is very simple:
156 * - IRQ delivery is asynchronous to the PCI bus
157 * - Blocking the local CPU IRQ via spin locks was too slow
158 * - The chip has register windows needing locking work
160 * So the path was once (I say once as people appear to have changed it
161 * in the mean time and it now looks rather bogus if the changes to use
162 * disable_irq_nosync_irqsave are disabling the local IRQ)
166 * Mask the IRQ on chip
167 * Disable the IRQ (but not mask locally- someone seems to have
168 * broken this with the lock validator stuff)
169 * [This must be _nosync as the page lock may otherwise
171 * Drop the page lock and turn IRQs back on
173 * At this point an existing IRQ may still be running but we can't
176 * Take the lock (so we know the IRQ has terminated) but don't mask
177 * the IRQs on the processor
178 * Set irqlock [for debug]
180 * Transmit (slow as ****)
185 * We have to use disable_irq because otherwise you will get delayed
186 * interrupts on the APIC bus deadlocking the transmit path.
188 * Quite hairy but the chip simply wasn't designed for SMP and you can't
189 * even ACK an interrupt without risking corrupting other parallel
190 * activities on the chip." [lkml, 25 Jul 2007]
196 * ei_open - Open/initialize the board.
197 * @dev: network device to initialize
199 * This routine goes all-out, setting everything
200 * up anew at each open, even though many of these registers should only
201 * need to be set once at boot.
203 static int __ei_open(struct net_device *dev)
206 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
208 /* The card I/O part of the driver (e.g. 3c503) can hook a Tx timeout
209 wrapper that does e.g. media check & then calls ei_tx_timeout. */
210 #ifdef CONFIG_COMPAT_NET_DEV_OPS
211 if (dev->tx_timeout == NULL)
212 dev->tx_timeout = ei_tx_timeout;
214 if (dev->watchdog_timeo <= 0)
215 dev->watchdog_timeo = TX_TIMEOUT;
218 * Grab the page lock so we own the register set, then call
222 spin_lock_irqsave(&ei_local->page_lock, flags);
223 __NS8390_init(dev, 1);
224 /* Set the flag before we drop the lock, That way the IRQ arrives
225 after its set and we get no silly warnings */
226 netif_start_queue(dev);
227 spin_unlock_irqrestore(&ei_local->page_lock, flags);
228 ei_local->irqlock = 0;
233 * ei_close - shut down network device
234 * @dev: network device to close
236 * Opposite of ei_open(). Only used when "ifconfig <devname> down" is done.
238 static int __ei_close(struct net_device *dev)
240 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
244 * Hold the page lock during close
247 spin_lock_irqsave(&ei_local->page_lock, flags);
248 __NS8390_init(dev, 0);
249 spin_unlock_irqrestore(&ei_local->page_lock, flags);
250 netif_stop_queue(dev);
255 * ei_tx_timeout - handle transmit time out condition
256 * @dev: network device which has apparently fallen asleep
258 * Called by kernel when device never acknowledges a transmit has
259 * completed (or failed) - i.e. never posted a Tx related interrupt.
262 void ei_tx_timeout(struct net_device *dev)
264 unsigned long e8390_base = dev->base_addr;
265 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
266 int txsr, isr, tickssofar = jiffies - dev->trans_start;
269 dev->stats.tx_errors++;
271 spin_lock_irqsave(&ei_local->page_lock, flags);
272 txsr = ei_inb(e8390_base+EN0_TSR);
273 isr = ei_inb(e8390_base+EN0_ISR);
274 spin_unlock_irqrestore(&ei_local->page_lock, flags);
276 printk(KERN_DEBUG "%s: Tx timed out, %s TSR=%#2x, ISR=%#2x, t=%d.\n",
277 dev->name, (txsr & ENTSR_ABT) ? "excess collisions." :
278 (isr) ? "lost interrupt?" : "cable problem?", txsr, isr, tickssofar);
280 if (!isr && !dev->stats.tx_packets)
282 /* The 8390 probably hasn't gotten on the cable yet. */
283 ei_local->interface_num ^= 1; /* Try a different xcvr. */
286 /* Ugly but a reset can be slow, yet must be protected */
288 disable_irq_nosync_lockdep(dev->irq);
289 spin_lock(&ei_local->page_lock);
291 /* Try to restart the card. Perhaps the user has fixed something. */
293 __NS8390_init(dev, 1);
295 spin_unlock(&ei_local->page_lock);
296 enable_irq_lockdep(dev->irq);
297 netif_wake_queue(dev);
299 EXPORT_SYMBOL_GPL(ei_tx_timeout);
302 * ei_start_xmit - begin packet transmission
303 * @skb: packet to be sent
304 * @dev: network device to which packet is sent
306 * Sends a packet to an 8390 network device.
309 int ei_start_xmit(struct sk_buff *skb, struct net_device *dev)
311 unsigned long e8390_base = dev->base_addr;
312 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
313 int send_length = skb->len, output_page;
316 char *data = skb->data;
318 if (skb->len < ETH_ZLEN) {
319 memset(buf, 0, ETH_ZLEN); /* more efficient than doing just the needed bits */
320 memcpy(buf, data, skb->len);
321 send_length = ETH_ZLEN;
325 /* Mask interrupts from the ethercard.
326 SMP: We have to grab the lock here otherwise the IRQ handler
327 on another CPU can flip window and race the IRQ mask set. We end
328 up trashing the mcast filter not disabling irqs if we don't lock */
330 spin_lock_irqsave(&ei_local->page_lock, flags);
331 ei_outb_p(0x00, e8390_base + EN0_IMR);
332 spin_unlock_irqrestore(&ei_local->page_lock, flags);
336 * Slow phase with lock held.
339 disable_irq_nosync_lockdep_irqsave(dev->irq, &flags);
341 spin_lock(&ei_local->page_lock);
343 ei_local->irqlock = 1;
346 * We have two Tx slots available for use. Find the first free
347 * slot, and then perform some sanity checks. With two Tx bufs,
348 * you get very close to transmitting back-to-back packets. With
349 * only one Tx buf, the transmitter sits idle while you reload the
350 * card, leaving a substantial gap between each transmitted packet.
353 if (ei_local->tx1 == 0)
355 output_page = ei_local->tx_start_page;
356 ei_local->tx1 = send_length;
357 if (ei_debug && ei_local->tx2 > 0)
358 printk(KERN_DEBUG "%s: idle transmitter tx2=%d, lasttx=%d, txing=%d.\n",
359 dev->name, ei_local->tx2, ei_local->lasttx, ei_local->txing);
361 else if (ei_local->tx2 == 0)
363 output_page = ei_local->tx_start_page + TX_PAGES/2;
364 ei_local->tx2 = send_length;
365 if (ei_debug && ei_local->tx1 > 0)
366 printk(KERN_DEBUG "%s: idle transmitter, tx1=%d, lasttx=%d, txing=%d.\n",
367 dev->name, ei_local->tx1, ei_local->lasttx, ei_local->txing);
370 { /* We should never get here. */
372 printk(KERN_DEBUG "%s: No Tx buffers free! tx1=%d tx2=%d last=%d\n",
373 dev->name, ei_local->tx1, ei_local->tx2, ei_local->lasttx);
374 ei_local->irqlock = 0;
375 netif_stop_queue(dev);
376 ei_outb_p(ENISR_ALL, e8390_base + EN0_IMR);
377 spin_unlock(&ei_local->page_lock);
378 enable_irq_lockdep_irqrestore(dev->irq, &flags);
379 dev->stats.tx_errors++;
384 * Okay, now upload the packet and trigger a send if the transmitter
385 * isn't already sending. If it is busy, the interrupt handler will
386 * trigger the send later, upon receiving a Tx done interrupt.
389 ei_block_output(dev, send_length, data, output_page);
391 if (! ei_local->txing)
394 NS8390_trigger_send(dev, send_length, output_page);
395 dev->trans_start = jiffies;
396 if (output_page == ei_local->tx_start_page)
399 ei_local->lasttx = -1;
404 ei_local->lasttx = -2;
407 else ei_local->txqueue++;
409 if (ei_local->tx1 && ei_local->tx2)
410 netif_stop_queue(dev);
412 netif_start_queue(dev);
414 /* Turn 8390 interrupts back on. */
415 ei_local->irqlock = 0;
416 ei_outb_p(ENISR_ALL, e8390_base + EN0_IMR);
418 spin_unlock(&ei_local->page_lock);
419 enable_irq_lockdep_irqrestore(dev->irq, &flags);
422 dev->stats.tx_bytes += send_length;
426 EXPORT_SYMBOL_GPL(ei_start_xmit);
429 * ei_interrupt - handle the interrupts from an 8390
430 * @irq: interrupt number
431 * @dev_id: a pointer to the net_device
433 * Handle the ether interface interrupts. We pull packets from
434 * the 8390 via the card specific functions and fire them at the networking
435 * stack. We also handle transmit completions and wake the transmit path if
436 * necessary. We also update the counters and do other housekeeping as
440 static irqreturn_t __ei_interrupt(int irq, void *dev_id)
442 struct net_device *dev = dev_id;
443 unsigned long e8390_base = dev->base_addr;
444 int interrupts, nr_serviced = 0;
445 struct ei_device *ei_local = netdev_priv(dev);
448 * Protect the irq test too.
451 spin_lock(&ei_local->page_lock);
453 if (ei_local->irqlock)
455 #if 1 /* This might just be an interrupt for a PCI device sharing this line */
456 /* The "irqlock" check is only for testing. */
457 printk(ei_local->irqlock
458 ? "%s: Interrupted while interrupts are masked! isr=%#2x imr=%#2x.\n"
459 : "%s: Reentering the interrupt handler! isr=%#2x imr=%#2x.\n",
460 dev->name, ei_inb_p(e8390_base + EN0_ISR),
461 ei_inb_p(e8390_base + EN0_IMR));
463 spin_unlock(&ei_local->page_lock);
467 /* Change to page 0 and read the intr status reg. */
468 ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base + E8390_CMD);
470 printk(KERN_DEBUG "%s: interrupt(isr=%#2.2x).\n", dev->name,
471 ei_inb_p(e8390_base + EN0_ISR));
473 /* !!Assumption!! -- we stay in page 0. Don't break this. */
474 while ((interrupts = ei_inb_p(e8390_base + EN0_ISR)) != 0
475 && ++nr_serviced < MAX_SERVICE)
477 if (!netif_running(dev)) {
478 printk(KERN_WARNING "%s: interrupt from stopped card\n", dev->name);
479 /* rmk - acknowledge the interrupts */
480 ei_outb_p(interrupts, e8390_base + EN0_ISR);
484 if (interrupts & ENISR_OVER)
486 else if (interrupts & (ENISR_RX+ENISR_RX_ERR))
488 /* Got a good (?) packet. */
491 /* Push the next to-transmit packet through. */
492 if (interrupts & ENISR_TX)
494 else if (interrupts & ENISR_TX_ERR)
497 if (interrupts & ENISR_COUNTERS)
499 dev->stats.rx_frame_errors += ei_inb_p(e8390_base + EN0_COUNTER0);
500 dev->stats.rx_crc_errors += ei_inb_p(e8390_base + EN0_COUNTER1);
501 dev->stats.rx_missed_errors+= ei_inb_p(e8390_base + EN0_COUNTER2);
502 ei_outb_p(ENISR_COUNTERS, e8390_base + EN0_ISR); /* Ack intr. */
505 /* Ignore any RDC interrupts that make it back to here. */
506 if (interrupts & ENISR_RDC)
508 ei_outb_p(ENISR_RDC, e8390_base + EN0_ISR);
511 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base + E8390_CMD);
514 if (interrupts && ei_debug)
516 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base + E8390_CMD);
517 if (nr_serviced >= MAX_SERVICE)
519 /* 0xFF is valid for a card removal */
521 printk(KERN_WARNING "%s: Too much work at interrupt, status %#2.2x\n",
522 dev->name, interrupts);
523 ei_outb_p(ENISR_ALL, e8390_base + EN0_ISR); /* Ack. most intrs. */
525 printk(KERN_WARNING "%s: unknown interrupt %#2x\n", dev->name, interrupts);
526 ei_outb_p(0xff, e8390_base + EN0_ISR); /* Ack. all intrs. */
529 spin_unlock(&ei_local->page_lock);
530 return IRQ_RETVAL(nr_serviced > 0);
533 #ifdef CONFIG_NET_POLL_CONTROLLER
534 static void __ei_poll(struct net_device *dev)
536 disable_irq(dev->irq);
537 __ei_interrupt(dev->irq, dev);
538 enable_irq(dev->irq);
543 * ei_tx_err - handle transmitter error
544 * @dev: network device which threw the exception
546 * A transmitter error has happened. Most likely excess collisions (which
547 * is a fairly normal condition). If the error is one where the Tx will
548 * have been aborted, we try and send another one right away, instead of
549 * letting the failed packet sit and collect dust in the Tx buffer. This
550 * is a much better solution as it avoids kernel based Tx timeouts, and
551 * an unnecessary card reset.
553 * Called with lock held.
556 static void ei_tx_err(struct net_device *dev)
558 unsigned long e8390_base = dev->base_addr;
559 /* ei_local is used on some platforms via the EI_SHIFT macro */
560 struct ei_device *ei_local __maybe_unused = netdev_priv(dev);
561 unsigned char txsr = ei_inb_p(e8390_base+EN0_TSR);
562 unsigned char tx_was_aborted = txsr & (ENTSR_ABT+ENTSR_FU);
564 #ifdef VERBOSE_ERROR_DUMP
565 printk(KERN_DEBUG "%s: transmitter error (%#2x): ", dev->name, txsr);
566 if (txsr & ENTSR_ABT)
567 printk("excess-collisions ");
569 printk("non-deferral ");
570 if (txsr & ENTSR_CRS)
571 printk("lost-carrier ");
573 printk("FIFO-underrun ");
574 if (txsr & ENTSR_CDH)
575 printk("lost-heartbeat ");
579 ei_outb_p(ENISR_TX_ERR, e8390_base + EN0_ISR); /* Ack intr. */
585 dev->stats.tx_errors++;
586 if (txsr & ENTSR_CRS) dev->stats.tx_carrier_errors++;
587 if (txsr & ENTSR_CDH) dev->stats.tx_heartbeat_errors++;
588 if (txsr & ENTSR_OWC) dev->stats.tx_window_errors++;
593 * ei_tx_intr - transmit interrupt handler
594 * @dev: network device for which tx intr is handled
596 * We have finished a transmit: check for errors and then trigger the next
597 * packet to be sent. Called with lock held.
600 static void ei_tx_intr(struct net_device *dev)
602 unsigned long e8390_base = dev->base_addr;
603 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
604 int status = ei_inb(e8390_base + EN0_TSR);
606 ei_outb_p(ENISR_TX, e8390_base + EN0_ISR); /* Ack intr. */
609 * There are two Tx buffers, see which one finished, and trigger
610 * the send of another one if it exists.
614 if (ei_local->tx1 < 0)
616 if (ei_local->lasttx != 1 && ei_local->lasttx != -1)
617 printk(KERN_ERR "%s: bogus last_tx_buffer %d, tx1=%d.\n",
618 ei_local->name, ei_local->lasttx, ei_local->tx1);
620 if (ei_local->tx2 > 0)
623 NS8390_trigger_send(dev, ei_local->tx2, ei_local->tx_start_page + 6);
624 dev->trans_start = jiffies;
626 ei_local->lasttx = 2;
628 else ei_local->lasttx = 20, ei_local->txing = 0;
630 else if (ei_local->tx2 < 0)
632 if (ei_local->lasttx != 2 && ei_local->lasttx != -2)
633 printk("%s: bogus last_tx_buffer %d, tx2=%d.\n",
634 ei_local->name, ei_local->lasttx, ei_local->tx2);
636 if (ei_local->tx1 > 0)
639 NS8390_trigger_send(dev, ei_local->tx1, ei_local->tx_start_page);
640 dev->trans_start = jiffies;
642 ei_local->lasttx = 1;
645 ei_local->lasttx = 10, ei_local->txing = 0;
647 // else printk(KERN_WARNING "%s: unexpected TX-done interrupt, lasttx=%d.\n",
648 // dev->name, ei_local->lasttx);
650 /* Minimize Tx latency: update the statistics after we restart TXing. */
651 if (status & ENTSR_COL)
652 dev->stats.collisions++;
653 if (status & ENTSR_PTX)
654 dev->stats.tx_packets++;
657 dev->stats.tx_errors++;
658 if (status & ENTSR_ABT)
660 dev->stats.tx_aborted_errors++;
661 dev->stats.collisions += 16;
663 if (status & ENTSR_CRS)
664 dev->stats.tx_carrier_errors++;
665 if (status & ENTSR_FU)
666 dev->stats.tx_fifo_errors++;
667 if (status & ENTSR_CDH)
668 dev->stats.tx_heartbeat_errors++;
669 if (status & ENTSR_OWC)
670 dev->stats.tx_window_errors++;
672 netif_wake_queue(dev);
676 * ei_receive - receive some packets
677 * @dev: network device with which receive will be run
679 * We have a good packet(s), get it/them out of the buffers.
680 * Called with lock held.
683 static void ei_receive(struct net_device *dev)
685 unsigned long e8390_base = dev->base_addr;
686 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
687 unsigned char rxing_page, this_frame, next_frame;
688 unsigned short current_offset;
689 int rx_pkt_count = 0;
690 struct e8390_pkt_hdr rx_frame;
691 int num_rx_pages = ei_local->stop_page-ei_local->rx_start_page;
693 while (++rx_pkt_count < 10)
695 int pkt_len, pkt_stat;
697 /* Get the rx page (incoming packet pointer). */
698 ei_outb_p(E8390_NODMA+E8390_PAGE1, e8390_base + E8390_CMD);
699 rxing_page = ei_inb_p(e8390_base + EN1_CURPAG);
700 ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base + E8390_CMD);
702 /* Remove one frame from the ring. Boundary is always a page behind. */
703 this_frame = ei_inb_p(e8390_base + EN0_BOUNDARY) + 1;
704 if (this_frame >= ei_local->stop_page)
705 this_frame = ei_local->rx_start_page;
707 /* Someday we'll omit the previous, iff we never get this message.
708 (There is at least one clone claimed to have a problem.)
710 Keep quiet if it looks like a card removal. One problem here
711 is that some clones crash in roughly the same way.
713 if (ei_debug > 0 && this_frame != ei_local->current_page && (this_frame!=0x0 || rxing_page!=0xFF))
714 printk(KERN_ERR "%s: mismatched read page pointers %2x vs %2x.\n",
715 dev->name, this_frame, ei_local->current_page);
717 if (this_frame == rxing_page) /* Read all the frames? */
718 break; /* Done for now */
720 current_offset = this_frame << 8;
721 ei_get_8390_hdr(dev, &rx_frame, this_frame);
723 pkt_len = rx_frame.count - sizeof(struct e8390_pkt_hdr);
724 pkt_stat = rx_frame.status;
726 next_frame = this_frame + 1 + ((pkt_len+4)>>8);
728 /* Check for bogosity warned by 3c503 book: the status byte is never
729 written. This happened a lot during testing! This code should be
730 cleaned up someday. */
731 if (rx_frame.next != next_frame
732 && rx_frame.next != next_frame + 1
733 && rx_frame.next != next_frame - num_rx_pages
734 && rx_frame.next != next_frame + 1 - num_rx_pages) {
735 ei_local->current_page = rxing_page;
736 ei_outb(ei_local->current_page-1, e8390_base+EN0_BOUNDARY);
737 dev->stats.rx_errors++;
741 if (pkt_len < 60 || pkt_len > 1518)
744 printk(KERN_DEBUG "%s: bogus packet size: %d, status=%#2x nxpg=%#2x.\n",
745 dev->name, rx_frame.count, rx_frame.status,
747 dev->stats.rx_errors++;
748 dev->stats.rx_length_errors++;
750 else if ((pkt_stat & 0x0F) == ENRSR_RXOK)
754 skb = dev_alloc_skb(pkt_len+2);
758 printk(KERN_DEBUG "%s: Couldn't allocate a sk_buff of size %d.\n",
760 dev->stats.rx_dropped++;
765 skb_reserve(skb,2); /* IP headers on 16 byte boundaries */
766 skb_put(skb, pkt_len); /* Make room */
767 ei_block_input(dev, pkt_len, skb, current_offset + sizeof(rx_frame));
768 skb->protocol=eth_type_trans(skb,dev);
770 dev->stats.rx_packets++;
771 dev->stats.rx_bytes += pkt_len;
772 if (pkt_stat & ENRSR_PHY)
773 dev->stats.multicast++;
779 printk(KERN_DEBUG "%s: bogus packet: status=%#2x nxpg=%#2x size=%d\n",
780 dev->name, rx_frame.status, rx_frame.next,
782 dev->stats.rx_errors++;
783 /* NB: The NIC counts CRC, frame and missed errors. */
784 if (pkt_stat & ENRSR_FO)
785 dev->stats.rx_fifo_errors++;
787 next_frame = rx_frame.next;
789 /* This _should_ never happen: it's here for avoiding bad clones. */
790 if (next_frame >= ei_local->stop_page) {
791 printk("%s: next frame inconsistency, %#2x\n", dev->name,
793 next_frame = ei_local->rx_start_page;
795 ei_local->current_page = next_frame;
796 ei_outb_p(next_frame-1, e8390_base+EN0_BOUNDARY);
799 /* We used to also ack ENISR_OVER here, but that would sometimes mask
800 a real overrun, leaving the 8390 in a stopped state with rec'vr off. */
801 ei_outb_p(ENISR_RX+ENISR_RX_ERR, e8390_base+EN0_ISR);
806 * ei_rx_overrun - handle receiver overrun
807 * @dev: network device which threw exception
809 * We have a receiver overrun: we have to kick the 8390 to get it started
810 * again. Problem is that you have to kick it exactly as NS prescribes in
811 * the updated datasheets, or "the NIC may act in an unpredictable manner."
812 * This includes causing "the NIC to defer indefinitely when it is stopped
813 * on a busy network." Ugh.
814 * Called with lock held. Don't call this with the interrupts off or your
815 * computer will hate you - it takes 10ms or so.
818 static void ei_rx_overrun(struct net_device *dev)
820 unsigned long e8390_base = dev->base_addr;
821 unsigned char was_txing, must_resend = 0;
822 /* ei_local is used on some platforms via the EI_SHIFT macro */
823 struct ei_device *ei_local __maybe_unused = netdev_priv(dev);
826 * Record whether a Tx was in progress and then issue the
829 was_txing = ei_inb_p(e8390_base+E8390_CMD) & E8390_TRANS;
830 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD);
833 printk(KERN_DEBUG "%s: Receiver overrun.\n", dev->name);
834 dev->stats.rx_over_errors++;
837 * Wait a full Tx time (1.2ms) + some guard time, NS says 1.6ms total.
838 * Early datasheets said to poll the reset bit, but now they say that
839 * it "is not a reliable indicator and subsequently should be ignored."
840 * We wait at least 10ms.
846 * Reset RBCR[01] back to zero as per magic incantation.
848 ei_outb_p(0x00, e8390_base+EN0_RCNTLO);
849 ei_outb_p(0x00, e8390_base+EN0_RCNTHI);
852 * See if any Tx was interrupted or not. According to NS, this
853 * step is vital, and skipping it will cause no end of havoc.
858 unsigned char tx_completed = ei_inb_p(e8390_base+EN0_ISR) & (ENISR_TX+ENISR_TX_ERR);
864 * Have to enter loopback mode and then restart the NIC before
865 * you are allowed to slurp packets up off the ring.
867 ei_outb_p(E8390_TXOFF, e8390_base + EN0_TXCR);
868 ei_outb_p(E8390_NODMA + E8390_PAGE0 + E8390_START, e8390_base + E8390_CMD);
871 * Clear the Rx ring of all the debris, and ack the interrupt.
874 ei_outb_p(ENISR_OVER, e8390_base+EN0_ISR);
877 * Leave loopback mode, and resend any packet that got stopped.
879 ei_outb_p(E8390_TXCONFIG, e8390_base + EN0_TXCR);
881 ei_outb_p(E8390_NODMA + E8390_PAGE0 + E8390_START + E8390_TRANS, e8390_base + E8390_CMD);
885 * Collect the stats. This is called unlocked and from several contexts.
888 struct net_device_stats *ei_get_stats(struct net_device *dev)
890 unsigned long ioaddr = dev->base_addr;
891 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
894 /* If the card is stopped, just return the present stats. */
895 if (!netif_running(dev))
898 spin_lock_irqsave(&ei_local->page_lock,flags);
899 /* Read the counter registers, assuming we are in page 0. */
900 dev->stats.rx_frame_errors += ei_inb_p(ioaddr + EN0_COUNTER0);
901 dev->stats.rx_crc_errors += ei_inb_p(ioaddr + EN0_COUNTER1);
902 dev->stats.rx_missed_errors+= ei_inb_p(ioaddr + EN0_COUNTER2);
903 spin_unlock_irqrestore(&ei_local->page_lock, flags);
907 EXPORT_SYMBOL_GPL(ei_get_stats);
910 * Form the 64 bit 8390 multicast table from the linked list of addresses
911 * associated with this dev structure.
914 static inline void make_mc_bits(u8 *bits, struct net_device *dev)
916 struct dev_mc_list *dmi;
918 for (dmi=dev->mc_list; dmi; dmi=dmi->next)
921 if (dmi->dmi_addrlen != ETH_ALEN)
923 printk(KERN_INFO "%s: invalid multicast address length given.\n", dev->name);
926 crc = ether_crc(ETH_ALEN, dmi->dmi_addr);
928 * The 8390 uses the 6 most significant bits of the
929 * CRC to index the multicast table.
931 bits[crc>>29] |= (1<<((crc>>26)&7));
936 * do_set_multicast_list - set/clear multicast filter
937 * @dev: net device for which multicast filter is adjusted
939 * Set or clear the multicast filter for this adaptor. May be called
940 * from a BH in 2.1.x. Must be called with lock held.
943 static void do_set_multicast_list(struct net_device *dev)
945 unsigned long e8390_base = dev->base_addr;
947 struct ei_device *ei_local = (struct ei_device*)netdev_priv(dev);
949 if (!(dev->flags&(IFF_PROMISC|IFF_ALLMULTI)))
951 memset(ei_local->mcfilter, 0, 8);
953 make_mc_bits(ei_local->mcfilter, dev);
956 memset(ei_local->mcfilter, 0xFF, 8); /* mcast set to accept-all */
959 * DP8390 manuals don't specify any magic sequence for altering
960 * the multicast regs on an already running card. To be safe, we
961 * ensure multicast mode is off prior to loading up the new hash
962 * table. If this proves to be not enough, we can always resort
963 * to stopping the NIC, loading the table and then restarting.
965 * Bug Alert! The MC regs on the SMC 83C690 (SMC Elite and SMC
966 * Elite16) appear to be write-only. The NS 8390 data sheet lists
967 * them as r/w so this is a bug. The SMC 83C790 (SMC Ultra and
968 * Ultra32 EISA) appears to have this bug fixed.
971 if (netif_running(dev))
972 ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR);
973 ei_outb_p(E8390_NODMA + E8390_PAGE1, e8390_base + E8390_CMD);
974 for(i = 0; i < 8; i++)
976 ei_outb_p(ei_local->mcfilter[i], e8390_base + EN1_MULT_SHIFT(i));
978 if(ei_inb_p(e8390_base + EN1_MULT_SHIFT(i))!=ei_local->mcfilter[i])
979 printk(KERN_ERR "Multicast filter read/write mismap %d\n",i);
982 ei_outb_p(E8390_NODMA + E8390_PAGE0, e8390_base + E8390_CMD);
984 if(dev->flags&IFF_PROMISC)
985 ei_outb_p(E8390_RXCONFIG | 0x18, e8390_base + EN0_RXCR);
986 else if(dev->flags&IFF_ALLMULTI || dev->mc_list)
987 ei_outb_p(E8390_RXCONFIG | 0x08, e8390_base + EN0_RXCR);
989 ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR);
993 * Called without lock held. This is invoked from user context and may
994 * be parallel to just about everything else. Its also fairly quick and
995 * not called too often. Must protect against both bh and irq users
998 void ei_set_multicast_list(struct net_device *dev)
1000 unsigned long flags;
1001 struct ei_device *ei_local = (struct ei_device*)netdev_priv(dev);
1003 spin_lock_irqsave(&ei_local->page_lock, flags);
1004 do_set_multicast_list(dev);
1005 spin_unlock_irqrestore(&ei_local->page_lock, flags);
1007 EXPORT_SYMBOL_GPL(ei_set_multicast_list);
1010 * ethdev_setup - init rest of 8390 device struct
1011 * @dev: network device structure to init
1013 * Initialize the rest of the 8390 device structure. Do NOT __init
1014 * this, as it is used by 8390 based modular drivers too.
1017 static void ethdev_setup(struct net_device *dev)
1019 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
1023 #ifdef CONFIG_COMPAT_NET_DEV_OPS
1024 dev->hard_start_xmit = ei_start_xmit;
1025 dev->get_stats = ei_get_stats;
1026 dev->set_multicast_list = ei_set_multicast_list;
1030 spin_lock_init(&ei_local->page_lock);
1034 * alloc_ei_netdev - alloc_etherdev counterpart for 8390
1035 * @size: extra bytes to allocate
1037 * Allocate 8390-specific net_device.
1039 static struct net_device *____alloc_ei_netdev(int size)
1041 return alloc_netdev(sizeof(struct ei_device) + size, "eth%d",
1048 /* This page of functions should be 8390 generic */
1049 /* Follow National Semi's recommendations for initializing the "NIC". */
1052 * NS8390_init - initialize 8390 hardware
1053 * @dev: network device to initialize
1054 * @startp: boolean. non-zero value to initiate chip processing
1056 * Must be called with lock held.
1059 static void __NS8390_init(struct net_device *dev, int startp)
1061 unsigned long e8390_base = dev->base_addr;
1062 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
1064 int endcfg = ei_local->word16
1065 ? (0x48 | ENDCFG_WTS | (ei_local->bigendian ? ENDCFG_BOS : 0))
1068 if(sizeof(struct e8390_pkt_hdr)!=4)
1069 panic("8390.c: header struct mispacked\n");
1070 /* Follow National Semi's recommendations for initing the DP83902. */
1071 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD); /* 0x21 */
1072 ei_outb_p(endcfg, e8390_base + EN0_DCFG); /* 0x48 or 0x49 */
1073 /* Clear the remote byte count registers. */
1074 ei_outb_p(0x00, e8390_base + EN0_RCNTLO);
1075 ei_outb_p(0x00, e8390_base + EN0_RCNTHI);
1076 /* Set to monitor and loopback mode -- this is vital!. */
1077 ei_outb_p(E8390_RXOFF, e8390_base + EN0_RXCR); /* 0x20 */
1078 ei_outb_p(E8390_TXOFF, e8390_base + EN0_TXCR); /* 0x02 */
1079 /* Set the transmit page and receive ring. */
1080 ei_outb_p(ei_local->tx_start_page, e8390_base + EN0_TPSR);
1081 ei_local->tx1 = ei_local->tx2 = 0;
1082 ei_outb_p(ei_local->rx_start_page, e8390_base + EN0_STARTPG);
1083 ei_outb_p(ei_local->stop_page-1, e8390_base + EN0_BOUNDARY); /* 3c503 says 0x3f,NS0x26*/
1084 ei_local->current_page = ei_local->rx_start_page; /* assert boundary+1 */
1085 ei_outb_p(ei_local->stop_page, e8390_base + EN0_STOPPG);
1086 /* Clear the pending interrupts and mask. */
1087 ei_outb_p(0xFF, e8390_base + EN0_ISR);
1088 ei_outb_p(0x00, e8390_base + EN0_IMR);
1090 /* Copy the station address into the DS8390 registers. */
1092 ei_outb_p(E8390_NODMA + E8390_PAGE1 + E8390_STOP, e8390_base+E8390_CMD); /* 0x61 */
1093 for(i = 0; i < 6; i++)
1095 ei_outb_p(dev->dev_addr[i], e8390_base + EN1_PHYS_SHIFT(i));
1096 if (ei_debug > 1 && ei_inb_p(e8390_base + EN1_PHYS_SHIFT(i))!=dev->dev_addr[i])
1097 printk(KERN_ERR "Hw. address read/write mismap %d\n",i);
1100 ei_outb_p(ei_local->rx_start_page, e8390_base + EN1_CURPAG);
1101 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD);
1103 netif_start_queue(dev);
1104 ei_local->tx1 = ei_local->tx2 = 0;
1105 ei_local->txing = 0;
1109 ei_outb_p(0xff, e8390_base + EN0_ISR);
1110 ei_outb_p(ENISR_ALL, e8390_base + EN0_IMR);
1111 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base+E8390_CMD);
1112 ei_outb_p(E8390_TXCONFIG, e8390_base + EN0_TXCR); /* xmit on. */
1113 /* 3c503 TechMan says rxconfig only after the NIC is started. */
1114 ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR); /* rx on, */
1115 do_set_multicast_list(dev); /* (re)load the mcast table */
1119 /* Trigger a transmit start, assuming the length is valid.
1120 Always called with the page lock held */
1122 static void NS8390_trigger_send(struct net_device *dev, unsigned int length,
1125 unsigned long e8390_base = dev->base_addr;
1126 struct ei_device *ei_local __attribute((unused)) = (struct ei_device *) netdev_priv(dev);
1128 ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base+E8390_CMD);
1130 if (ei_inb_p(e8390_base + E8390_CMD) & E8390_TRANS)
1132 printk(KERN_WARNING "%s: trigger_send() called with the transmitter busy.\n",
1136 ei_outb_p(length & 0xff, e8390_base + EN0_TCNTLO);
1137 ei_outb_p(length >> 8, e8390_base + EN0_TCNTHI);
1138 ei_outb_p(start_page, e8390_base + EN0_TPSR);
1139 ei_outb_p(E8390_NODMA+E8390_TRANS+E8390_START, e8390_base+E8390_CMD);