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