Add support the Korina (IDT RC32434) Ethernet MAC
[linux-2.6.git] / 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  *      Additional explanation of problems with locking by Alan Cox:
148  *
149  *      "The author (me) didn't use spin_lock_irqsave because the slowness of the
150  *      card means that approach caused horrible problems like losing serial data
151  *      at 38400 baud on some chips. Remember many 8390 nics on PCI were ISA
152  *      chips with FPGA front ends.
153  *      
154  *      Ok the logic behind the 8390 is very simple:
155  *      
156  *      Things to know
157  *              - IRQ delivery is asynchronous to the PCI bus
158  *              - Blocking the local CPU IRQ via spin locks was too slow
159  *              - The chip has register windows needing locking work
160  *      
161  *      So the path was once (I say once as people appear to have changed it
162  *      in the mean time and it now looks rather bogus if the changes to use
163  *      disable_irq_nosync_irqsave are disabling the local IRQ)
164  *      
165  *      
166  *              Take the page lock
167  *              Mask the IRQ on chip
168  *              Disable the IRQ (but not mask locally- someone seems to have
169  *                      broken this with the lock validator stuff)
170  *                      [This must be _nosync as the page lock may otherwise
171  *                              deadlock us]
172  *              Drop the page lock and turn IRQs back on
173  *              
174  *              At this point an existing IRQ may still be running but we can't
175  *              get a new one
176  *      
177  *              Take the lock (so we know the IRQ has terminated) but don't mask
178  *      the IRQs on the processor
179  *              Set irqlock [for debug]
180  *      
181  *              Transmit (slow as ****)
182  *      
183  *              re-enable the IRQ
184  *      
185  *      
186  *      We have to use disable_irq because otherwise you will get delayed
187  *      interrupts on the APIC bus deadlocking the transmit path.
188  *      
189  *      Quite hairy but the chip simply wasn't designed for SMP and you can't
190  *      even ACK an interrupt without risking corrupting other parallel
191  *      activities on the chip." [lkml, 25 Jul 2007]
192  */
193
194
195
196 /**
197  * ei_open - Open/initialize the board.
198  * @dev: network device to initialize
199  *
200  * This routine goes all-out, setting everything
201  * up anew at each open, even though many of these registers should only
202  * need to be set once at boot.
203  */
204 static int __ei_open(struct net_device *dev)
205 {
206         unsigned long flags;
207         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
208
209         /* The card I/O part of the driver (e.g. 3c503) can hook a Tx timeout
210             wrapper that does e.g. media check & then calls ei_tx_timeout. */
211         if (dev->tx_timeout == NULL)
212                  dev->tx_timeout = ei_tx_timeout;
213         if (dev->watchdog_timeo <= 0)
214                  dev->watchdog_timeo = TX_TIMEOUT;
215
216         /*
217          *      Grab the page lock so we own the register set, then call
218          *      the init function.
219          */
220
221         spin_lock_irqsave(&ei_local->page_lock, flags);
222         __NS8390_init(dev, 1);
223         /* Set the flag before we drop the lock, That way the IRQ arrives
224            after its set and we get no silly warnings */
225         netif_start_queue(dev);
226         spin_unlock_irqrestore(&ei_local->page_lock, flags);
227         ei_local->irqlock = 0;
228         return 0;
229 }
230
231 /**
232  * ei_close - shut down network device
233  * @dev: network device to close
234  *
235  * Opposite of ei_open(). Only used when "ifconfig <devname> down" is done.
236  */
237 static int __ei_close(struct net_device *dev)
238 {
239         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
240         unsigned long flags;
241
242         /*
243          *      Hold the page lock during close
244          */
245
246         spin_lock_irqsave(&ei_local->page_lock, flags);
247         __NS8390_init(dev, 0);
248         spin_unlock_irqrestore(&ei_local->page_lock, flags);
249         netif_stop_queue(dev);
250         return 0;
251 }
252
253 /**
254  * ei_tx_timeout - handle transmit time out condition
255  * @dev: network device which has apparently fallen asleep
256  *
257  * Called by kernel when device never acknowledges a transmit has
258  * completed (or failed) - i.e. never posted a Tx related interrupt.
259  */
260
261 static void ei_tx_timeout(struct net_device *dev)
262 {
263         unsigned long e8390_base = dev->base_addr;
264         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
265         int txsr, isr, tickssofar = jiffies - dev->trans_start;
266         unsigned long flags;
267
268         ei_local->stat.tx_errors++;
269
270         spin_lock_irqsave(&ei_local->page_lock, flags);
271         txsr = ei_inb(e8390_base+EN0_TSR);
272         isr = ei_inb(e8390_base+EN0_ISR);
273         spin_unlock_irqrestore(&ei_local->page_lock, flags);
274
275         printk(KERN_DEBUG "%s: Tx timed out, %s TSR=%#2x, ISR=%#2x, t=%d.\n",
276                 dev->name, (txsr & ENTSR_ABT) ? "excess collisions." :
277                 (isr) ? "lost interrupt?" : "cable problem?", txsr, isr, tickssofar);
278
279         if (!isr && !ei_local->stat.tx_packets)
280         {
281                 /* The 8390 probably hasn't gotten on the cable yet. */
282                 ei_local->interface_num ^= 1;   /* Try a different xcvr.  */
283         }
284
285         /* Ugly but a reset can be slow, yet must be protected */
286
287         disable_irq_nosync_lockdep(dev->irq);
288         spin_lock(&ei_local->page_lock);
289
290         /* Try to restart the card.  Perhaps the user has fixed something. */
291         ei_reset_8390(dev);
292         __NS8390_init(dev, 1);
293
294         spin_unlock(&ei_local->page_lock);
295         enable_irq_lockdep(dev->irq);
296         netif_wake_queue(dev);
297 }
298
299 /**
300  * ei_start_xmit - begin packet transmission
301  * @skb: packet to be sent
302  * @dev: network device to which packet is sent
303  *
304  * Sends a packet to an 8390 network device.
305  */
306
307 static int ei_start_xmit(struct sk_buff *skb, struct net_device *dev)
308 {
309         unsigned long e8390_base = dev->base_addr;
310         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
311         int send_length = skb->len, output_page;
312         unsigned long flags;
313         char buf[ETH_ZLEN];
314         char *data = skb->data;
315
316         if (skb->len < ETH_ZLEN) {
317                 memset(buf, 0, ETH_ZLEN);       /* more efficient than doing just the needed bits */
318                 memcpy(buf, data, skb->len);
319                 send_length = ETH_ZLEN;
320                 data = buf;
321         }
322
323         /* Mask interrupts from the ethercard.
324            SMP: We have to grab the lock here otherwise the IRQ handler
325            on another CPU can flip window and race the IRQ mask set. We end
326            up trashing the mcast filter not disabling irqs if we don't lock */
327
328         spin_lock_irqsave(&ei_local->page_lock, flags);
329         ei_outb_p(0x00, e8390_base + EN0_IMR);
330         spin_unlock_irqrestore(&ei_local->page_lock, flags);
331
332
333         /*
334          *      Slow phase with lock held.
335          */
336
337         disable_irq_nosync_lockdep_irqsave(dev->irq, &flags);
338
339         spin_lock(&ei_local->page_lock);
340
341         ei_local->irqlock = 1;
342
343         /*
344          * We have two Tx slots available for use. Find the first free
345          * slot, and then perform some sanity checks. With two Tx bufs,
346          * you get very close to transmitting back-to-back packets. With
347          * only one Tx buf, the transmitter sits idle while you reload the
348          * card, leaving a substantial gap between each transmitted packet.
349          */
350
351         if (ei_local->tx1 == 0)
352         {
353                 output_page = ei_local->tx_start_page;
354                 ei_local->tx1 = send_length;
355                 if (ei_debug  &&  ei_local->tx2 > 0)
356                         printk(KERN_DEBUG "%s: idle transmitter tx2=%d, lasttx=%d, txing=%d.\n",
357                                 dev->name, ei_local->tx2, ei_local->lasttx, ei_local->txing);
358         }
359         else if (ei_local->tx2 == 0)
360         {
361                 output_page = ei_local->tx_start_page + TX_PAGES/2;
362                 ei_local->tx2 = send_length;
363                 if (ei_debug  &&  ei_local->tx1 > 0)
364                         printk(KERN_DEBUG "%s: idle transmitter, tx1=%d, lasttx=%d, txing=%d.\n",
365                                 dev->name, ei_local->tx1, ei_local->lasttx, ei_local->txing);
366         }
367         else
368         {       /* We should never get here. */
369                 if (ei_debug)
370                         printk(KERN_DEBUG "%s: No Tx buffers free! tx1=%d tx2=%d last=%d\n",
371                                 dev->name, ei_local->tx1, ei_local->tx2, ei_local->lasttx);
372                 ei_local->irqlock = 0;
373                 netif_stop_queue(dev);
374                 ei_outb_p(ENISR_ALL, e8390_base + EN0_IMR);
375                 spin_unlock(&ei_local->page_lock);
376                 enable_irq_lockdep_irqrestore(dev->irq, &flags);
377                 ei_local->stat.tx_errors++;
378                 return 1;
379         }
380
381         /*
382          * Okay, now upload the packet and trigger a send if the transmitter
383          * isn't already sending. If it is busy, the interrupt handler will
384          * trigger the send later, upon receiving a Tx done interrupt.
385          */
386
387         ei_block_output(dev, send_length, data, output_page);
388
389         if (! ei_local->txing)
390         {
391                 ei_local->txing = 1;
392                 NS8390_trigger_send(dev, send_length, output_page);
393                 dev->trans_start = jiffies;
394                 if (output_page == ei_local->tx_start_page)
395                 {
396                         ei_local->tx1 = -1;
397                         ei_local->lasttx = -1;
398                 }
399                 else
400                 {
401                         ei_local->tx2 = -1;
402                         ei_local->lasttx = -2;
403                 }
404         }
405         else ei_local->txqueue++;
406
407         if (ei_local->tx1  &&  ei_local->tx2)
408                 netif_stop_queue(dev);
409         else
410                 netif_start_queue(dev);
411
412         /* Turn 8390 interrupts back on. */
413         ei_local->irqlock = 0;
414         ei_outb_p(ENISR_ALL, e8390_base + EN0_IMR);
415
416         spin_unlock(&ei_local->page_lock);
417         enable_irq_lockdep_irqrestore(dev->irq, &flags);
418
419         dev_kfree_skb (skb);
420         ei_local->stat.tx_bytes += send_length;
421
422         return 0;
423 }
424
425 /**
426  * ei_interrupt - handle the interrupts from an 8390
427  * @irq: interrupt number
428  * @dev_id: a pointer to the net_device
429  *
430  * Handle the ether interface interrupts. We pull packets from
431  * the 8390 via the card specific functions and fire them at the networking
432  * stack. We also handle transmit completions and wake the transmit path if
433  * necessary. We also update the counters and do other housekeeping as
434  * needed.
435  */
436
437 static irqreturn_t __ei_interrupt(int irq, void *dev_id)
438 {
439         struct net_device *dev = dev_id;
440         unsigned long e8390_base = dev->base_addr;
441         int interrupts, nr_serviced = 0;
442         struct ei_device *ei_local = netdev_priv(dev);
443
444         /*
445          *      Protect the irq test too.
446          */
447
448         spin_lock(&ei_local->page_lock);
449
450         if (ei_local->irqlock)
451         {
452 #if 1 /* This might just be an interrupt for a PCI device sharing this line */
453                 /* The "irqlock" check is only for testing. */
454                 printk(ei_local->irqlock
455                            ? "%s: Interrupted while interrupts are masked! isr=%#2x imr=%#2x.\n"
456                            : "%s: Reentering the interrupt handler! isr=%#2x imr=%#2x.\n",
457                            dev->name, ei_inb_p(e8390_base + EN0_ISR),
458                            ei_inb_p(e8390_base + EN0_IMR));
459 #endif
460                 spin_unlock(&ei_local->page_lock);
461                 return IRQ_NONE;
462         }
463
464         /* Change to page 0 and read the intr status reg. */
465         ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base + E8390_CMD);
466         if (ei_debug > 3)
467                 printk(KERN_DEBUG "%s: interrupt(isr=%#2.2x).\n", dev->name,
468                            ei_inb_p(e8390_base + EN0_ISR));
469
470         /* !!Assumption!! -- we stay in page 0.  Don't break this. */
471         while ((interrupts = ei_inb_p(e8390_base + EN0_ISR)) != 0
472                    && ++nr_serviced < MAX_SERVICE)
473         {
474                 if (!netif_running(dev)) {
475                         printk(KERN_WARNING "%s: interrupt from stopped card\n", dev->name);
476                         /* rmk - acknowledge the interrupts */
477                         ei_outb_p(interrupts, e8390_base + EN0_ISR);
478                         interrupts = 0;
479                         break;
480                 }
481                 if (interrupts & ENISR_OVER)
482                         ei_rx_overrun(dev);
483                 else if (interrupts & (ENISR_RX+ENISR_RX_ERR))
484                 {
485                         /* Got a good (?) packet. */
486                         ei_receive(dev);
487                 }
488                 /* Push the next to-transmit packet through. */
489                 if (interrupts & ENISR_TX)
490                         ei_tx_intr(dev);
491                 else if (interrupts & ENISR_TX_ERR)
492                         ei_tx_err(dev);
493
494                 if (interrupts & ENISR_COUNTERS)
495                 {
496                         ei_local->stat.rx_frame_errors += ei_inb_p(e8390_base + EN0_COUNTER0);
497                         ei_local->stat.rx_crc_errors   += ei_inb_p(e8390_base + EN0_COUNTER1);
498                         ei_local->stat.rx_missed_errors+= ei_inb_p(e8390_base + EN0_COUNTER2);
499                         ei_outb_p(ENISR_COUNTERS, e8390_base + EN0_ISR); /* Ack intr. */
500                 }
501
502                 /* Ignore any RDC interrupts that make it back to here. */
503                 if (interrupts & ENISR_RDC)
504                 {
505                         ei_outb_p(ENISR_RDC, e8390_base + EN0_ISR);
506                 }
507
508                 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base + E8390_CMD);
509         }
510
511         if (interrupts && ei_debug)
512         {
513                 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base + E8390_CMD);
514                 if (nr_serviced >= MAX_SERVICE)
515                 {
516                         /* 0xFF is valid for a card removal */
517                         if(interrupts!=0xFF)
518                                 printk(KERN_WARNING "%s: Too much work at interrupt, status %#2.2x\n",
519                                    dev->name, interrupts);
520                         ei_outb_p(ENISR_ALL, e8390_base + EN0_ISR); /* Ack. most intrs. */
521                 } else {
522                         printk(KERN_WARNING "%s: unknown interrupt %#2x\n", dev->name, interrupts);
523                         ei_outb_p(0xff, e8390_base + EN0_ISR); /* Ack. all intrs. */
524                 }
525         }
526         spin_unlock(&ei_local->page_lock);
527         return IRQ_RETVAL(nr_serviced > 0);
528 }
529
530 #ifdef CONFIG_NET_POLL_CONTROLLER
531 static void __ei_poll(struct net_device *dev)
532 {
533         disable_irq_lockdep(dev->irq);
534         __ei_interrupt(dev->irq, dev);
535         enable_irq_lockdep(dev->irq);
536 }
537 #endif
538
539 /**
540  * ei_tx_err - handle transmitter error
541  * @dev: network device which threw the exception
542  *
543  * A transmitter error has happened. Most likely excess collisions (which
544  * is a fairly normal condition). If the error is one where the Tx will
545  * have been aborted, we try and send another one right away, instead of
546  * letting the failed packet sit and collect dust in the Tx buffer. This
547  * is a much better solution as it avoids kernel based Tx timeouts, and
548  * an unnecessary card reset.
549  *
550  * Called with lock held.
551  */
552
553 static void ei_tx_err(struct net_device *dev)
554 {
555         unsigned long e8390_base = dev->base_addr;
556         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
557         unsigned char txsr = ei_inb_p(e8390_base+EN0_TSR);
558         unsigned char tx_was_aborted = txsr & (ENTSR_ABT+ENTSR_FU);
559
560 #ifdef VERBOSE_ERROR_DUMP
561         printk(KERN_DEBUG "%s: transmitter error (%#2x): ", dev->name, txsr);
562         if (txsr & ENTSR_ABT)
563                 printk("excess-collisions ");
564         if (txsr & ENTSR_ND)
565                 printk("non-deferral ");
566         if (txsr & ENTSR_CRS)
567                 printk("lost-carrier ");
568         if (txsr & ENTSR_FU)
569                 printk("FIFO-underrun ");
570         if (txsr & ENTSR_CDH)
571                 printk("lost-heartbeat ");
572         printk("\n");
573 #endif
574
575         ei_outb_p(ENISR_TX_ERR, e8390_base + EN0_ISR); /* Ack intr. */
576
577         if (tx_was_aborted)
578                 ei_tx_intr(dev);
579         else
580         {
581                 ei_local->stat.tx_errors++;
582                 if (txsr & ENTSR_CRS) ei_local->stat.tx_carrier_errors++;
583                 if (txsr & ENTSR_CDH) ei_local->stat.tx_heartbeat_errors++;
584                 if (txsr & ENTSR_OWC) ei_local->stat.tx_window_errors++;
585         }
586 }
587
588 /**
589  * ei_tx_intr - transmit interrupt handler
590  * @dev: network device for which tx intr is handled
591  *
592  * We have finished a transmit: check for errors and then trigger the next
593  * packet to be sent. Called with lock held.
594  */
595
596 static void ei_tx_intr(struct net_device *dev)
597 {
598         unsigned long e8390_base = dev->base_addr;
599         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
600         int status = ei_inb(e8390_base + EN0_TSR);
601
602         ei_outb_p(ENISR_TX, e8390_base + EN0_ISR); /* Ack intr. */
603
604         /*
605          * There are two Tx buffers, see which one finished, and trigger
606          * the send of another one if it exists.
607          */
608         ei_local->txqueue--;
609
610         if (ei_local->tx1 < 0)
611         {
612                 if (ei_local->lasttx != 1 && ei_local->lasttx != -1)
613                         printk(KERN_ERR "%s: bogus last_tx_buffer %d, tx1=%d.\n",
614                                 ei_local->name, ei_local->lasttx, ei_local->tx1);
615                 ei_local->tx1 = 0;
616                 if (ei_local->tx2 > 0)
617                 {
618                         ei_local->txing = 1;
619                         NS8390_trigger_send(dev, ei_local->tx2, ei_local->tx_start_page + 6);
620                         dev->trans_start = jiffies;
621                         ei_local->tx2 = -1,
622                         ei_local->lasttx = 2;
623                 }
624                 else ei_local->lasttx = 20, ei_local->txing = 0;
625         }
626         else if (ei_local->tx2 < 0)
627         {
628                 if (ei_local->lasttx != 2  &&  ei_local->lasttx != -2)
629                         printk("%s: bogus last_tx_buffer %d, tx2=%d.\n",
630                                 ei_local->name, ei_local->lasttx, ei_local->tx2);
631                 ei_local->tx2 = 0;
632                 if (ei_local->tx1 > 0)
633                 {
634                         ei_local->txing = 1;
635                         NS8390_trigger_send(dev, ei_local->tx1, ei_local->tx_start_page);
636                         dev->trans_start = jiffies;
637                         ei_local->tx1 = -1;
638                         ei_local->lasttx = 1;
639                 }
640                 else
641                         ei_local->lasttx = 10, ei_local->txing = 0;
642         }
643 //      else printk(KERN_WARNING "%s: unexpected TX-done interrupt, lasttx=%d.\n",
644 //                      dev->name, ei_local->lasttx);
645
646         /* Minimize Tx latency: update the statistics after we restart TXing. */
647         if (status & ENTSR_COL)
648                 ei_local->stat.collisions++;
649         if (status & ENTSR_PTX)
650                 ei_local->stat.tx_packets++;
651         else
652         {
653                 ei_local->stat.tx_errors++;
654                 if (status & ENTSR_ABT)
655                 {
656                         ei_local->stat.tx_aborted_errors++;
657                         ei_local->stat.collisions += 16;
658                 }
659                 if (status & ENTSR_CRS)
660                         ei_local->stat.tx_carrier_errors++;
661                 if (status & ENTSR_FU)
662                         ei_local->stat.tx_fifo_errors++;
663                 if (status & ENTSR_CDH)
664                         ei_local->stat.tx_heartbeat_errors++;
665                 if (status & ENTSR_OWC)
666                         ei_local->stat.tx_window_errors++;
667         }
668         netif_wake_queue(dev);
669 }
670
671 /**
672  * ei_receive - receive some packets
673  * @dev: network device with which receive will be run
674  *
675  * We have a good packet(s), get it/them out of the buffers.
676  * Called with lock held.
677  */
678
679 static void ei_receive(struct net_device *dev)
680 {
681         unsigned long e8390_base = dev->base_addr;
682         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
683         unsigned char rxing_page, this_frame, next_frame;
684         unsigned short current_offset;
685         int rx_pkt_count = 0;
686         struct e8390_pkt_hdr rx_frame;
687         int num_rx_pages = ei_local->stop_page-ei_local->rx_start_page;
688
689         while (++rx_pkt_count < 10)
690         {
691                 int pkt_len, pkt_stat;
692
693                 /* Get the rx page (incoming packet pointer). */
694                 ei_outb_p(E8390_NODMA+E8390_PAGE1, e8390_base + E8390_CMD);
695                 rxing_page = ei_inb_p(e8390_base + EN1_CURPAG);
696                 ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base + E8390_CMD);
697
698                 /* Remove one frame from the ring.  Boundary is always a page behind. */
699                 this_frame = ei_inb_p(e8390_base + EN0_BOUNDARY) + 1;
700                 if (this_frame >= ei_local->stop_page)
701                         this_frame = ei_local->rx_start_page;
702
703                 /* Someday we'll omit the previous, iff we never get this message.
704                    (There is at least one clone claimed to have a problem.)
705
706                    Keep quiet if it looks like a card removal. One problem here
707                    is that some clones crash in roughly the same way.
708                  */
709                 if (ei_debug > 0  &&  this_frame != ei_local->current_page && (this_frame!=0x0 || rxing_page!=0xFF))
710                         printk(KERN_ERR "%s: mismatched read page pointers %2x vs %2x.\n",
711                                    dev->name, this_frame, ei_local->current_page);
712
713                 if (this_frame == rxing_page)   /* Read all the frames? */
714                         break;                          /* Done for now */
715
716                 current_offset = this_frame << 8;
717                 ei_get_8390_hdr(dev, &rx_frame, this_frame);
718
719                 pkt_len = rx_frame.count - sizeof(struct e8390_pkt_hdr);
720                 pkt_stat = rx_frame.status;
721
722                 next_frame = this_frame + 1 + ((pkt_len+4)>>8);
723
724                 /* Check for bogosity warned by 3c503 book: the status byte is never
725                    written.  This happened a lot during testing! This code should be
726                    cleaned up someday. */
727                 if (rx_frame.next != next_frame
728                         && rx_frame.next != next_frame + 1
729                         && rx_frame.next != next_frame - num_rx_pages
730                         && rx_frame.next != next_frame + 1 - num_rx_pages) {
731                         ei_local->current_page = rxing_page;
732                         ei_outb(ei_local->current_page-1, e8390_base+EN0_BOUNDARY);
733                         ei_local->stat.rx_errors++;
734                         continue;
735                 }
736
737                 if (pkt_len < 60  ||  pkt_len > 1518)
738                 {
739                         if (ei_debug)
740                                 printk(KERN_DEBUG "%s: bogus packet size: %d, status=%#2x nxpg=%#2x.\n",
741                                            dev->name, rx_frame.count, rx_frame.status,
742                                            rx_frame.next);
743                         ei_local->stat.rx_errors++;
744                         ei_local->stat.rx_length_errors++;
745                 }
746                  else if ((pkt_stat & 0x0F) == ENRSR_RXOK)
747                 {
748                         struct sk_buff *skb;
749
750                         skb = dev_alloc_skb(pkt_len+2);
751                         if (skb == NULL)
752                         {
753                                 if (ei_debug > 1)
754                                         printk(KERN_DEBUG "%s: Couldn't allocate a sk_buff of size %d.\n",
755                                                    dev->name, pkt_len);
756                                 ei_local->stat.rx_dropped++;
757                                 break;
758                         }
759                         else
760                         {
761                                 skb_reserve(skb,2);     /* IP headers on 16 byte boundaries */
762                                 skb_put(skb, pkt_len);  /* Make room */
763                                 ei_block_input(dev, pkt_len, skb, current_offset + sizeof(rx_frame));
764                                 skb->protocol=eth_type_trans(skb,dev);
765                                 netif_rx(skb);
766                                 dev->last_rx = jiffies;
767                                 ei_local->stat.rx_packets++;
768                                 ei_local->stat.rx_bytes += pkt_len;
769                                 if (pkt_stat & ENRSR_PHY)
770                                         ei_local->stat.multicast++;
771                         }
772                 }
773                 else
774                 {
775                         if (ei_debug)
776                                 printk(KERN_DEBUG "%s: bogus packet: status=%#2x nxpg=%#2x size=%d\n",
777                                            dev->name, rx_frame.status, rx_frame.next,
778                                            rx_frame.count);
779                         ei_local->stat.rx_errors++;
780                         /* NB: The NIC counts CRC, frame and missed errors. */
781                         if (pkt_stat & ENRSR_FO)
782                                 ei_local->stat.rx_fifo_errors++;
783                 }
784                 next_frame = rx_frame.next;
785
786                 /* This _should_ never happen: it's here for avoiding bad clones. */
787                 if (next_frame >= ei_local->stop_page) {
788                         printk("%s: next frame inconsistency, %#2x\n", dev->name,
789                                    next_frame);
790                         next_frame = ei_local->rx_start_page;
791                 }
792                 ei_local->current_page = next_frame;
793                 ei_outb_p(next_frame-1, e8390_base+EN0_BOUNDARY);
794         }
795
796         /* We used to also ack ENISR_OVER here, but that would sometimes mask
797            a real overrun, leaving the 8390 in a stopped state with rec'vr off. */
798         ei_outb_p(ENISR_RX+ENISR_RX_ERR, e8390_base+EN0_ISR);
799         return;
800 }
801
802 /**
803  * ei_rx_overrun - handle receiver overrun
804  * @dev: network device which threw exception
805  *
806  * We have a receiver overrun: we have to kick the 8390 to get it started
807  * again. Problem is that you have to kick it exactly as NS prescribes in
808  * the updated datasheets, or "the NIC may act in an unpredictable manner."
809  * This includes causing "the NIC to defer indefinitely when it is stopped
810  * on a busy network."  Ugh.
811  * Called with lock held. Don't call this with the interrupts off or your
812  * computer will hate you - it takes 10ms or so.
813  */
814
815 static void ei_rx_overrun(struct net_device *dev)
816 {
817         unsigned long e8390_base = dev->base_addr;
818         unsigned char was_txing, must_resend = 0;
819         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
820
821         /*
822          * Record whether a Tx was in progress and then issue the
823          * stop command.
824          */
825         was_txing = ei_inb_p(e8390_base+E8390_CMD) & E8390_TRANS;
826         ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD);
827
828         if (ei_debug > 1)
829                 printk(KERN_DEBUG "%s: Receiver overrun.\n", dev->name);
830         ei_local->stat.rx_over_errors++;
831
832         /*
833          * Wait a full Tx time (1.2ms) + some guard time, NS says 1.6ms total.
834          * Early datasheets said to poll the reset bit, but now they say that
835          * it "is not a reliable indicator and subsequently should be ignored."
836          * We wait at least 10ms.
837          */
838
839         mdelay(10);
840
841         /*
842          * Reset RBCR[01] back to zero as per magic incantation.
843          */
844         ei_outb_p(0x00, e8390_base+EN0_RCNTLO);
845         ei_outb_p(0x00, e8390_base+EN0_RCNTHI);
846
847         /*
848          * See if any Tx was interrupted or not. According to NS, this
849          * step is vital, and skipping it will cause no end of havoc.
850          */
851
852         if (was_txing)
853         {
854                 unsigned char tx_completed = ei_inb_p(e8390_base+EN0_ISR) & (ENISR_TX+ENISR_TX_ERR);
855                 if (!tx_completed)
856                         must_resend = 1;
857         }
858
859         /*
860          * Have to enter loopback mode and then restart the NIC before
861          * you are allowed to slurp packets up off the ring.
862          */
863         ei_outb_p(E8390_TXOFF, e8390_base + EN0_TXCR);
864         ei_outb_p(E8390_NODMA + E8390_PAGE0 + E8390_START, e8390_base + E8390_CMD);
865
866         /*
867          * Clear the Rx ring of all the debris, and ack the interrupt.
868          */
869         ei_receive(dev);
870         ei_outb_p(ENISR_OVER, e8390_base+EN0_ISR);
871
872         /*
873          * Leave loopback mode, and resend any packet that got stopped.
874          */
875         ei_outb_p(E8390_TXCONFIG, e8390_base + EN0_TXCR);
876         if (must_resend)
877                 ei_outb_p(E8390_NODMA + E8390_PAGE0 + E8390_START + E8390_TRANS, e8390_base + E8390_CMD);
878 }
879
880 /*
881  *      Collect the stats. This is called unlocked and from several contexts.
882  */
883
884 static struct net_device_stats *get_stats(struct net_device *dev)
885 {
886         unsigned long ioaddr = dev->base_addr;
887         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
888         unsigned long flags;
889
890         /* If the card is stopped, just return the present stats. */
891         if (!netif_running(dev))
892                 return &ei_local->stat;
893
894         spin_lock_irqsave(&ei_local->page_lock,flags);
895         /* Read the counter registers, assuming we are in page 0. */
896         ei_local->stat.rx_frame_errors += ei_inb_p(ioaddr + EN0_COUNTER0);
897         ei_local->stat.rx_crc_errors   += ei_inb_p(ioaddr + EN0_COUNTER1);
898         ei_local->stat.rx_missed_errors+= ei_inb_p(ioaddr + EN0_COUNTER2);
899         spin_unlock_irqrestore(&ei_local->page_lock, flags);
900
901         return &ei_local->stat;
902 }
903
904 /*
905  * Form the 64 bit 8390 multicast table from the linked list of addresses
906  * associated with this dev structure.
907  */
908
909 static inline void make_mc_bits(u8 *bits, struct net_device *dev)
910 {
911         struct dev_mc_list *dmi;
912
913         for (dmi=dev->mc_list; dmi; dmi=dmi->next)
914         {
915                 u32 crc;
916                 if (dmi->dmi_addrlen != ETH_ALEN)
917                 {
918                         printk(KERN_INFO "%s: invalid multicast address length given.\n", dev->name);
919                         continue;
920                 }
921                 crc = ether_crc(ETH_ALEN, dmi->dmi_addr);
922                 /*
923                  * The 8390 uses the 6 most significant bits of the
924                  * CRC to index the multicast table.
925                  */
926                 bits[crc>>29] |= (1<<((crc>>26)&7));
927         }
928 }
929
930 /**
931  * do_set_multicast_list - set/clear multicast filter
932  * @dev: net device for which multicast filter is adjusted
933  *
934  *      Set or clear the multicast filter for this adaptor. May be called
935  *      from a BH in 2.1.x. Must be called with lock held.
936  */
937
938 static void do_set_multicast_list(struct net_device *dev)
939 {
940         unsigned long e8390_base = dev->base_addr;
941         int i;
942         struct ei_device *ei_local = (struct ei_device*)netdev_priv(dev);
943
944         if (!(dev->flags&(IFF_PROMISC|IFF_ALLMULTI)))
945         {
946                 memset(ei_local->mcfilter, 0, 8);
947                 if (dev->mc_list)
948                         make_mc_bits(ei_local->mcfilter, dev);
949         }
950         else
951                 memset(ei_local->mcfilter, 0xFF, 8);    /* mcast set to accept-all */
952
953         /*
954          * DP8390 manuals don't specify any magic sequence for altering
955          * the multicast regs on an already running card. To be safe, we
956          * ensure multicast mode is off prior to loading up the new hash
957          * table. If this proves to be not enough, we can always resort
958          * to stopping the NIC, loading the table and then restarting.
959          *
960          * Bug Alert!  The MC regs on the SMC 83C690 (SMC Elite and SMC
961          * Elite16) appear to be write-only. The NS 8390 data sheet lists
962          * them as r/w so this is a bug.  The SMC 83C790 (SMC Ultra and
963          * Ultra32 EISA) appears to have this bug fixed.
964          */
965
966         if (netif_running(dev))
967                 ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR);
968         ei_outb_p(E8390_NODMA + E8390_PAGE1, e8390_base + E8390_CMD);
969         for(i = 0; i < 8; i++)
970         {
971                 ei_outb_p(ei_local->mcfilter[i], e8390_base + EN1_MULT_SHIFT(i));
972 #ifndef BUG_83C690
973                 if(ei_inb_p(e8390_base + EN1_MULT_SHIFT(i))!=ei_local->mcfilter[i])
974                         printk(KERN_ERR "Multicast filter read/write mismap %d\n",i);
975 #endif
976         }
977         ei_outb_p(E8390_NODMA + E8390_PAGE0, e8390_base + E8390_CMD);
978
979         if(dev->flags&IFF_PROMISC)
980                 ei_outb_p(E8390_RXCONFIG | 0x18, e8390_base + EN0_RXCR);
981         else if(dev->flags&IFF_ALLMULTI || dev->mc_list)
982                 ei_outb_p(E8390_RXCONFIG | 0x08, e8390_base + EN0_RXCR);
983         else
984                 ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR);
985  }
986
987 /*
988  *      Called without lock held. This is invoked from user context and may
989  *      be parallel to just about everything else. Its also fairly quick and
990  *      not called too often. Must protect against both bh and irq users
991  */
992
993 static void set_multicast_list(struct net_device *dev)
994 {
995         unsigned long flags;
996         struct ei_device *ei_local = (struct ei_device*)netdev_priv(dev);
997
998         spin_lock_irqsave(&ei_local->page_lock, flags);
999         do_set_multicast_list(dev);
1000         spin_unlock_irqrestore(&ei_local->page_lock, flags);
1001 }
1002
1003 /**
1004  * ethdev_setup - init rest of 8390 device struct
1005  * @dev: network device structure to init
1006  *
1007  * Initialize the rest of the 8390 device structure.  Do NOT __init
1008  * this, as it is used by 8390 based modular drivers too.
1009  */
1010
1011 static void ethdev_setup(struct net_device *dev)
1012 {
1013         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
1014         if (ei_debug > 1)
1015                 printk(version);
1016
1017         dev->hard_start_xmit = &ei_start_xmit;
1018         dev->get_stats  = get_stats;
1019         dev->set_multicast_list = &set_multicast_list;
1020
1021         ether_setup(dev);
1022
1023         spin_lock_init(&ei_local->page_lock);
1024 }
1025
1026 /**
1027  * alloc_ei_netdev - alloc_etherdev counterpart for 8390
1028  * @size: extra bytes to allocate
1029  *
1030  * Allocate 8390-specific net_device.
1031  */
1032 static struct net_device *____alloc_ei_netdev(int size)
1033 {
1034         return alloc_netdev(sizeof(struct ei_device) + size, "eth%d",
1035                                 ethdev_setup);
1036 }
1037
1038
1039
1040
1041 /* This page of functions should be 8390 generic */
1042 /* Follow National Semi's recommendations for initializing the "NIC". */
1043
1044 /**
1045  * NS8390_init - initialize 8390 hardware
1046  * @dev: network device to initialize
1047  * @startp: boolean.  non-zero value to initiate chip processing
1048  *
1049  *      Must be called with lock held.
1050  */
1051
1052 static void __NS8390_init(struct net_device *dev, int startp)
1053 {
1054         unsigned long e8390_base = dev->base_addr;
1055         struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
1056         int i;
1057         int endcfg = ei_local->word16
1058             ? (0x48 | ENDCFG_WTS | (ei_local->bigendian ? ENDCFG_BOS : 0))
1059             : 0x48;
1060
1061         if(sizeof(struct e8390_pkt_hdr)!=4)
1062                 panic("8390.c: header struct mispacked\n");
1063         /* Follow National Semi's recommendations for initing the DP83902. */
1064         ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD); /* 0x21 */
1065         ei_outb_p(endcfg, e8390_base + EN0_DCFG);       /* 0x48 or 0x49 */
1066         /* Clear the remote byte count registers. */
1067         ei_outb_p(0x00,  e8390_base + EN0_RCNTLO);
1068         ei_outb_p(0x00,  e8390_base + EN0_RCNTHI);
1069         /* Set to monitor and loopback mode -- this is vital!. */
1070         ei_outb_p(E8390_RXOFF, e8390_base + EN0_RXCR); /* 0x20 */
1071         ei_outb_p(E8390_TXOFF, e8390_base + EN0_TXCR); /* 0x02 */
1072         /* Set the transmit page and receive ring. */
1073         ei_outb_p(ei_local->tx_start_page, e8390_base + EN0_TPSR);
1074         ei_local->tx1 = ei_local->tx2 = 0;
1075         ei_outb_p(ei_local->rx_start_page, e8390_base + EN0_STARTPG);
1076         ei_outb_p(ei_local->stop_page-1, e8390_base + EN0_BOUNDARY);    /* 3c503 says 0x3f,NS0x26*/
1077         ei_local->current_page = ei_local->rx_start_page;               /* assert boundary+1 */
1078         ei_outb_p(ei_local->stop_page, e8390_base + EN0_STOPPG);
1079         /* Clear the pending interrupts and mask. */
1080         ei_outb_p(0xFF, e8390_base + EN0_ISR);
1081         ei_outb_p(0x00,  e8390_base + EN0_IMR);
1082
1083         /* Copy the station address into the DS8390 registers. */
1084
1085         ei_outb_p(E8390_NODMA + E8390_PAGE1 + E8390_STOP, e8390_base+E8390_CMD); /* 0x61 */
1086         for(i = 0; i < 6; i++)
1087         {
1088                 ei_outb_p(dev->dev_addr[i], e8390_base + EN1_PHYS_SHIFT(i));
1089                 if (ei_debug > 1 && ei_inb_p(e8390_base + EN1_PHYS_SHIFT(i))!=dev->dev_addr[i])
1090                         printk(KERN_ERR "Hw. address read/write mismap %d\n",i);
1091         }
1092
1093         ei_outb_p(ei_local->rx_start_page, e8390_base + EN1_CURPAG);
1094         ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_STOP, e8390_base+E8390_CMD);
1095
1096         netif_start_queue(dev);
1097         ei_local->tx1 = ei_local->tx2 = 0;
1098         ei_local->txing = 0;
1099
1100         if (startp)
1101         {
1102                 ei_outb_p(0xff,  e8390_base + EN0_ISR);
1103                 ei_outb_p(ENISR_ALL,  e8390_base + EN0_IMR);
1104                 ei_outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, e8390_base+E8390_CMD);
1105                 ei_outb_p(E8390_TXCONFIG, e8390_base + EN0_TXCR); /* xmit on. */
1106                 /* 3c503 TechMan says rxconfig only after the NIC is started. */
1107                 ei_outb_p(E8390_RXCONFIG, e8390_base + EN0_RXCR); /* rx on,  */
1108                 do_set_multicast_list(dev);     /* (re)load the mcast table */
1109         }
1110 }
1111
1112 /* Trigger a transmit start, assuming the length is valid.
1113    Always called with the page lock held */
1114
1115 static void NS8390_trigger_send(struct net_device *dev, unsigned int length,
1116                                                                 int start_page)
1117 {
1118         unsigned long e8390_base = dev->base_addr;
1119         struct ei_device *ei_local __attribute((unused)) = (struct ei_device *) netdev_priv(dev);
1120
1121         ei_outb_p(E8390_NODMA+E8390_PAGE0, e8390_base+E8390_CMD);
1122
1123         if (ei_inb_p(e8390_base + E8390_CMD) & E8390_TRANS)
1124         {
1125                 printk(KERN_WARNING "%s: trigger_send() called with the transmitter busy.\n",
1126                         dev->name);
1127                 return;
1128         }
1129         ei_outb_p(length & 0xff, e8390_base + EN0_TCNTLO);
1130         ei_outb_p(length >> 8, e8390_base + EN0_TCNTHI);
1131         ei_outb_p(start_page, e8390_base + EN0_TPSR);
1132         ei_outb_p(E8390_NODMA+E8390_TRANS+E8390_START, e8390_base+E8390_CMD);
1133 }