1 /* ne2.c: A NE/2 Ethernet Driver for Linux. */
3 Based on the NE2000 driver written by Donald Becker (1992-94).
4 modified by Wim Dumon (Apr 1996)
6 This software may be used and distributed according to the terms
7 of the GNU Public License, incorporated herein by reference.
9 The author may be reached as wimpie@linux.cc.kuleuven.ac.be
11 Currently supported: NE/2
12 This patch was never tested on other MCA-ethernet adapters, but it
13 might work. Just give it a try and let me know if you have problems.
14 Also mail me if it really works, please!
17 Mon Feb 3 16:26:02 MET 1997
18 - adapted the driver to work with the 2.1.25 kernel
19 - multiple ne2 support (untested)
20 - module support (untested)
22 Fri Aug 28 00:18:36 CET 1998 (David Weinehall)
23 - fixed a few minor typos
24 - made the MODULE_PARM conditional (it only works with the v2.1.x kernels)
25 - fixed the module support (Now it's working...)
27 Mon Sep 7 19:01:44 CET 1998 (David Weinehall)
28 - added support for Arco Electronics AE/2-card (experimental)
30 Mon Sep 14 09:53:42 CET 1998 (David Weinehall)
31 - added support for Compex ENET-16MC/P (experimental)
33 Tue Sep 15 16:21:12 CET 1998 (David Weinehall, Magnus Jonsson, Tomas Ogren)
34 - Miscellaneous bugfixes
36 Tue Sep 19 16:21:12 CET 1998 (Magnus Jonsson)
39 Wed Sep 23 14:33:34 CET 1998 (David Weinehall)
40 - Restructuring and rewriting for v2.1.x compliance
42 Wed Oct 14 17:19:21 CET 1998 (David Weinehall)
43 - Added code that unregisters irq and proc-info
46 Mon Nov 16 15:28:23 CET 1998 (Wim Dumon)
47 - pass 'dev' as last parameter of request_irq in stead of 'NULL'
51 This is alpha-test software. It is not guaranteed to work. As a
52 matter of fact, I'm quite sure there are *LOTS* of bugs in here. I
53 would like to hear from you if you use this driver, even if it works.
54 If it doesn't work, be sure to send me a mail with the problems !
57 static const char *version
= "ne2.c:v0.91 Nov 16 1998 Wim Dumon <wimpie@kotnet.org>\n";
59 #include <linux/module.h>
60 #include <linux/version.h>
62 #include <linux/kernel.h>
63 #include <linux/sched.h>
64 #include <linux/types.h>
65 #include <linux/fcntl.h>
66 #include <linux/interrupt.h>
67 #include <linux/ptrace.h>
68 #include <linux/ioport.h>
70 #include <linux/malloc.h>
71 #include <linux/string.h>
72 #include <asm/system.h>
73 #include <asm/bitops.h>
76 #include <linux/errno.h>
77 #include <linux/init.h>
78 #include <linux/mca.h>
80 #include <linux/netdevice.h>
81 #include <linux/etherdevice.h>
82 #include <linux/skbuff.h>
87 /* Some defines that people can play with if so inclined. */
89 /* Do we perform extra sanity checks on stuff ? */
90 /* #define NE_SANITY_CHECK */
92 /* Do we implement the read before write bugfix ? */
93 /* #define NE_RW_BUGFIX */
95 /* Do we have a non std. amount of memory? (in units of 256 byte pages) */
96 /* #define PACKETBUF_MEMSIZE 0x40 */
99 /* ---- No user-serviceable parts below ---- */
101 #define NE_BASE (dev->base_addr)
103 #define NE_DATAPORT 0x10 /* NatSemi-defined port window offset. */
104 #define NE_RESET 0x20 /* Issue a read to reset, a write to clear. */
105 #define NE_IO_EXTENT 0x30
107 #define NE1SM_START_PG 0x20 /* First page of TX buffer */
108 #define NE1SM_STOP_PG 0x40 /* Last page +1 of RX ring */
109 #define NESM_START_PG 0x40 /* First page of TX buffer */
110 #define NESM_STOP_PG 0x80 /* Last page +1 of RX ring */
112 /* From the .ADF file: */
113 static unsigned int addresses
[7] __initdata
=
114 {0x1000, 0x2020, 0x8020, 0xa0a0, 0xb0b0, 0xc0c0, 0xc3d0};
115 static int irqs
[4] __initdata
= {3, 4, 5, 9};
117 struct ne2_adapters_t
{
122 static struct ne2_adapters_t ne2_adapters
[] __initdata
= {
123 { 0x6354, "Arco Ethernet Adapter AE/2" },
124 { 0x70DE, "Compex ENET-16 MC/P" },
125 { 0x7154, "Novell Ethernet Adapter NE/2" },
129 extern int netcard_probe(struct net_device
*dev
);
131 static int ne2_probe1(struct net_device
*dev
, int slot
);
133 static int ne_open(struct net_device
*dev
);
134 static int ne_close(struct net_device
*dev
);
136 static void ne_reset_8390(struct net_device
*dev
);
137 static void ne_get_8390_hdr(struct net_device
*dev
, struct e8390_pkt_hdr
*hdr
,
139 static void ne_block_input(struct net_device
*dev
, int count
,
140 struct sk_buff
*skb
, int ring_offset
);
141 static void ne_block_output(struct net_device
*dev
, const int count
,
142 const unsigned char *buf
, const int start_page
);
146 * Note that at boot, this probe only picks up one card at a time.
149 int __init
ne2_probe(struct net_device
*dev
)
151 static int current_mca_slot
= -1;
153 int adapter_found
= 0;
155 SET_MODULE_OWNER(dev
);
157 /* Do not check any supplied i/o locations.
158 POS registers usually don't fail :) */
160 /* MCA cards have POS registers.
161 Autodetecting MCA cards is extremely simple.
162 Just search for the card. */
164 for(i
= 0; (ne2_adapters
[i
].name
!= NULL
) && !adapter_found
; i
++) {
166 mca_find_unused_adapter(ne2_adapters
[i
].id
, 0);
168 if((current_mca_slot
!= MCA_NOTFOUND
) && !adapter_found
) {
169 mca_set_adapter_name(current_mca_slot
,
170 ne2_adapters
[i
].name
);
171 mca_mark_as_used(current_mca_slot
);
173 return ne2_probe1(dev
, current_mca_slot
);
180 static int ne2_procinfo(char *buf
, int slot
, struct net_device
*dev
)
184 len
+= sprintf(buf
+len
, "The NE/2 Ethernet Adapter\n" );
185 len
+= sprintf(buf
+len
, "Driver written by Wim Dumon ");
186 len
+= sprintf(buf
+len
, "<wimpie@kotnet.org>\n");
187 len
+= sprintf(buf
+len
, "Modified by ");
188 len
+= sprintf(buf
+len
, "David Weinehall <tao@acc.umu.se>\n");
189 len
+= sprintf(buf
+len
, "and by Magnus Jonsson <bigfoot@acc.umu.se>\n");
190 len
+= sprintf(buf
+len
, "Based on the original NE2000 drivers\n" );
191 len
+= sprintf(buf
+len
, "Base IO: %#x\n", (unsigned int)dev
->base_addr
);
192 len
+= sprintf(buf
+len
, "IRQ : %d\n", dev
->irq
);
194 #define HW_ADDR(i) dev->dev_addr[i]
195 len
+= sprintf(buf
+len
, "HW addr : %x:%x:%x:%x:%x:%x\n",
196 HW_ADDR(0), HW_ADDR(1), HW_ADDR(2),
197 HW_ADDR(3), HW_ADDR(4), HW_ADDR(5) );
203 static int __init
ne2_probe1(struct net_device
*dev
, int slot
)
205 int i
, base_addr
, irq
, retval
;
207 unsigned char SA_prom
[32];
208 const char *name
= "NE/2";
209 int start_page
, stop_page
;
210 static unsigned version_printed
;
212 if (ei_debug
&& version_printed
++ == 0)
215 printk("NE/2 ethercard found in slot %d:", slot
);
217 /* Read base IO and IRQ from the POS-registers */
218 POS
= mca_read_stored_pos(slot
, 2);
220 printk(" disabled.\n");
225 /* printk("Halleluja sdog, als er na de pijl een 1 staat is 1 - 1 == 0"
226 " en zou het moeten werken -> %d\n", i);
227 The above line was for remote testing, thanx to sdog ... */
228 base_addr
= addresses
[i
- 1];
229 irq
= irqs
[(POS
& 0x60)>>5];
231 if (!request_region(base_addr
, NE_IO_EXTENT
, dev
->name
))
235 printk("POS info : pos 2 = %#x ; base = %#x ; irq = %ld\n", POS
,
240 /* Reset the card the way they do it in the Crynwr packet driver */
242 outb(0x0, base_addr
+ NE_RESET
);
243 inb(base_addr
+ NE_RESET
);
244 outb(0x21, base_addr
+ NE_CMD
);
245 if (inb(base_addr
+ NE_CMD
) != 0x21) {
246 printk("NE/2 adapter not responding\n");
251 /* In the crynwr sources they do a RAM-test here. I skip it. I suppose
252 my RAM is okay. Suppose your memory is broken. Then this test
253 should fail and you won't be able to use your card. But if I do not
254 test, you won't be able to use your card, neither. So this test
257 #else /* _I_ never tested it this way .. Go ahead and try ...*/
258 /* Reset card. Who knows what dain-bramaged state it was left in. */
260 unsigned long reset_start_time
= jiffies
;
262 /* DON'T change these to inb_p/outb_p or reset will fail on
264 outb(inb(base_addr
+ NE_RESET
), base_addr
+ NE_RESET
);
266 while ((inb_p(base_addr
+ EN0_ISR
) & ENISR_RESET
) == 0)
267 if (jiffies
- reset_start_time
> 2*HZ
/100) {
268 printk(" not found (no reset ack).\n");
273 outb_p(0xff, base_addr
+ EN0_ISR
); /* Ack all intr. */
278 /* Read the 16 bytes of station address PROM.
279 We must first initialize registers, similar to
280 NS8390_init(eifdev, 0).
281 We can't reliably read the SAPROM address without this.
282 (I learned the hard way!). */
285 unsigned char value
, offset
;
288 {E8390_NODMA
+E8390_PAGE0
+E8390_STOP
, E8390_CMD
},
289 {0x49, EN0_DCFG
}, /* Set WORD-wide (0x49) access. */
290 {0x00, EN0_RCNTLO
}, /* Clear the count regs. */
292 {0x00, EN0_IMR
}, /* Mask completion irq. */
294 {E8390_RXOFF
, EN0_RXCR
}, /* 0x20 Set to monitor */
295 {E8390_TXOFF
, EN0_TXCR
}, /* 0x02 and loopback mode. */
298 {0x00, EN0_RSARLO
}, /* DMA starting at 0x0000. */
300 {E8390_RREAD
+E8390_START
, E8390_CMD
},
303 for (i
= 0; i
< sizeof(program_seq
)/sizeof(program_seq
[0]); i
++)
304 outb_p(program_seq
[i
].value
, base_addr
+
305 program_seq
[i
].offset
);
308 for(i
= 0; i
< 6 /*sizeof(SA_prom)*/; i
+=1) {
309 SA_prom
[i
] = inb(base_addr
+ NE_DATAPORT
);
312 start_page
= NESM_START_PG
;
313 stop_page
= NESM_STOP_PG
;
317 /* Snarf the interrupt now. There's no point in waiting since we cannot
318 share and the board will usually be enabled. */
319 retval
= request_irq(dev
->irq
, ei_interrupt
, 0, dev
->name
, dev
);
321 printk (" unable to get IRQ %d (irqval=%d).\n",
326 dev
->base_addr
= base_addr
;
328 /* Allocate dev->priv and fill in 8390 specific dev fields. */
329 if (ethdev_init(dev
)) {
330 printk (" unable to get memory for dev->priv.\n");
331 free_irq(dev
->irq
, dev
);
336 for(i
= 0; i
< ETHER_ADDR_LEN
; i
++) {
337 printk(" %2.2x", SA_prom
[i
]);
338 dev
->dev_addr
[i
] = SA_prom
[i
];
341 printk("\n%s: %s found at %#x, using IRQ %d.\n",
342 dev
->name
, name
, base_addr
, dev
->irq
);
344 mca_set_adapter_procfn(slot
, (MCA_ProcFn
) ne2_procinfo
, dev
);
346 ei_status
.name
= name
;
347 ei_status
.tx_start_page
= start_page
;
348 ei_status
.stop_page
= stop_page
;
349 ei_status
.word16
= (2 == 2);
351 ei_status
.rx_start_page
= start_page
+ TX_PAGES
;
352 #ifdef PACKETBUF_MEMSIZE
353 /* Allow the packet buffer size to be overridden by know-it-alls. */
354 ei_status
.stop_page
= ei_status
.tx_start_page
+ PACKETBUF_MEMSIZE
;
357 ei_status
.reset_8390
= &ne_reset_8390
;
358 ei_status
.block_input
= &ne_block_input
;
359 ei_status
.block_output
= &ne_block_output
;
360 ei_status
.get_8390_hdr
= &ne_get_8390_hdr
;
362 ei_status
.priv
= slot
;
364 dev
->open
= &ne_open
;
365 dev
->stop
= &ne_close
;
369 release_region(base_addr
, NE_IO_EXTENT
);
373 static int ne_open(struct net_device
*dev
)
379 static int ne_close(struct net_device
*dev
)
382 printk("%s: Shutting down ethercard.\n", dev
->name
);
387 /* Hard reset the card. This used to pause for the same period that a
388 8390 reset command required, but that shouldn't be necessary. */
389 static void ne_reset_8390(struct net_device
*dev
)
391 unsigned long reset_start_time
= jiffies
;
394 printk("resetting the 8390 t=%ld...", jiffies
);
396 /* DON'T change these to inb_p/outb_p or reset will fail on clones. */
397 outb(inb(NE_BASE
+ NE_RESET
), NE_BASE
+ NE_RESET
);
400 ei_status
.dmaing
= 0;
402 /* This check _should_not_ be necessary, omit eventually. */
403 while ((inb_p(NE_BASE
+EN0_ISR
) & ENISR_RESET
) == 0)
404 if (jiffies
- reset_start_time
> 2*HZ
/100) {
405 printk("%s: ne_reset_8390() did not complete.\n",
409 outb_p(ENISR_RESET
, NE_BASE
+ EN0_ISR
); /* Ack intr. */
412 /* Grab the 8390 specific header. Similar to the block_input routine, but
413 we don't need to be concerned with ring wrap as the header will be at
414 the start of a page, so we optimize accordingly. */
416 static void ne_get_8390_hdr(struct net_device
*dev
, struct e8390_pkt_hdr
*hdr
,
420 int nic_base
= dev
->base_addr
;
422 /* This *shouldn't* happen.
423 If it does, it's the last thing you'll see */
424 if (ei_status
.dmaing
) {
425 printk("%s: DMAing conflict in ne_get_8390_hdr "
426 "[DMAstat:%d][irqlock:%d].\n",
427 dev
->name
, ei_status
.dmaing
, ei_status
.irqlock
);
431 ei_status
.dmaing
|= 0x01;
432 outb_p(E8390_NODMA
+E8390_PAGE0
+E8390_START
, nic_base
+ NE_CMD
);
433 outb_p(sizeof(struct e8390_pkt_hdr
), nic_base
+ EN0_RCNTLO
);
434 outb_p(0, nic_base
+ EN0_RCNTHI
);
435 outb_p(0, nic_base
+ EN0_RSARLO
); /* On page boundary */
436 outb_p(ring_page
, nic_base
+ EN0_RSARHI
);
437 outb_p(E8390_RREAD
+E8390_START
, nic_base
+ NE_CMD
);
439 if (ei_status
.word16
)
440 insw(NE_BASE
+ NE_DATAPORT
, hdr
,
441 sizeof(struct e8390_pkt_hdr
)>>1);
443 insb(NE_BASE
+ NE_DATAPORT
, hdr
,
444 sizeof(struct e8390_pkt_hdr
));
446 outb_p(ENISR_RDC
, nic_base
+ EN0_ISR
); /* Ack intr. */
447 ei_status
.dmaing
&= ~0x01;
450 /* Block input and output, similar to the Crynwr packet driver. If you
451 are porting to a new ethercard, look at the packet driver source for
452 hints. The NEx000 doesn't share the on-board packet memory -- you have
453 to put the packet out through the "remote DMA" dataport using outb. */
455 static void ne_block_input(struct net_device
*dev
, int count
, struct sk_buff
*skb
,
458 #ifdef NE_SANITY_CHECK
459 int xfer_count
= count
;
461 int nic_base
= dev
->base_addr
;
462 char *buf
= skb
->data
;
464 /* This *shouldn't* happen.
465 If it does, it's the last thing you'll see */
466 if (ei_status
.dmaing
) {
467 printk("%s: DMAing conflict in ne_block_input "
468 "[DMAstat:%d][irqlock:%d].\n",
469 dev
->name
, ei_status
.dmaing
, ei_status
.irqlock
);
472 ei_status
.dmaing
|= 0x01;
473 outb_p(E8390_NODMA
+E8390_PAGE0
+E8390_START
, nic_base
+ NE_CMD
);
474 outb_p(count
& 0xff, nic_base
+ EN0_RCNTLO
);
475 outb_p(count
>> 8, nic_base
+ EN0_RCNTHI
);
476 outb_p(ring_offset
& 0xff, nic_base
+ EN0_RSARLO
);
477 outb_p(ring_offset
>> 8, nic_base
+ EN0_RSARHI
);
478 outb_p(E8390_RREAD
+E8390_START
, nic_base
+ NE_CMD
);
479 if (ei_status
.word16
) {
480 insw(NE_BASE
+ NE_DATAPORT
,buf
,count
>>1);
482 buf
[count
-1] = inb(NE_BASE
+ NE_DATAPORT
);
483 #ifdef NE_SANITY_CHECK
488 insb(NE_BASE
+ NE_DATAPORT
, buf
, count
);
491 #ifdef NE_SANITY_CHECK
492 /* This was for the ALPHA version only, but enough people have
493 been encountering problems so it is still here. If you see
494 this message you either 1) have a slightly incompatible clone
495 or 2) have noise/speed problems with your bus. */
496 if (ei_debug
> 1) { /* DMA termination address check... */
497 int addr
, tries
= 20;
499 /* DON'T check for 'inb_p(EN0_ISR) & ENISR_RDC' here
500 -- it's broken for Rx on some cards! */
501 int high
= inb_p(nic_base
+ EN0_RSARHI
);
502 int low
= inb_p(nic_base
+ EN0_RSARLO
);
503 addr
= (high
<< 8) + low
;
504 if (((ring_offset
+ xfer_count
) & 0xff) == low
)
506 } while (--tries
> 0);
508 printk("%s: RX transfer address mismatch,"
509 "%#4.4x (expected) vs. %#4.4x (actual).\n",
510 dev
->name
, ring_offset
+ xfer_count
, addr
);
513 outb_p(ENISR_RDC
, nic_base
+ EN0_ISR
); /* Ack intr. */
514 ei_status
.dmaing
&= ~0x01;
517 static void ne_block_output(struct net_device
*dev
, int count
,
518 const unsigned char *buf
, const int start_page
)
520 int nic_base
= NE_BASE
;
521 unsigned long dma_start
;
522 #ifdef NE_SANITY_CHECK
526 /* Round the count up for word writes. Do we need to do this?
527 What effect will an odd byte count have on the 8390?
528 I should check someday. */
529 if (ei_status
.word16
&& (count
& 0x01))
532 /* This *shouldn't* happen.
533 If it does, it's the last thing you'll see */
534 if (ei_status
.dmaing
) {
535 printk("%s: DMAing conflict in ne_block_output."
536 "[DMAstat:%d][irqlock:%d]\n",
537 dev
->name
, ei_status
.dmaing
, ei_status
.irqlock
);
540 ei_status
.dmaing
|= 0x01;
541 /* We should already be in page 0, but to be safe... */
542 outb_p(E8390_PAGE0
+E8390_START
+E8390_NODMA
, nic_base
+ NE_CMD
);
544 #ifdef NE_SANITY_CHECK
548 #ifdef NE8390_RW_BUGFIX
549 /* Handle the read-before-write bug the same way as the
550 Crynwr packet driver -- the NatSemi method doesn't work.
551 Actually this doesn't always work either, but if you have
552 problems with your NEx000 this is better than nothing! */
553 outb_p(0x42, nic_base
+ EN0_RCNTLO
);
554 outb_p(0x00, nic_base
+ EN0_RCNTHI
);
555 outb_p(0x42, nic_base
+ EN0_RSARLO
);
556 outb_p(0x00, nic_base
+ EN0_RSARHI
);
557 outb_p(E8390_RREAD
+E8390_START
, nic_base
+ NE_CMD
);
558 /* Make certain that the dummy read has occurred. */
564 outb_p(ENISR_RDC
, nic_base
+ EN0_ISR
);
566 /* Now the normal output. */
567 outb_p(count
& 0xff, nic_base
+ EN0_RCNTLO
);
568 outb_p(count
>> 8, nic_base
+ EN0_RCNTHI
);
569 outb_p(0x00, nic_base
+ EN0_RSARLO
);
570 outb_p(start_page
, nic_base
+ EN0_RSARHI
);
572 outb_p(E8390_RWRITE
+E8390_START
, nic_base
+ NE_CMD
);
573 if (ei_status
.word16
) {
574 outsw(NE_BASE
+ NE_DATAPORT
, buf
, count
>>1);
576 outsb(NE_BASE
+ NE_DATAPORT
, buf
, count
);
581 #ifdef NE_SANITY_CHECK
582 /* This was for the ALPHA version only, but enough people have
583 been encountering problems so it is still here. */
585 if (ei_debug
> 1) { /* DMA termination address check... */
586 int addr
, tries
= 20;
588 int high
= inb_p(nic_base
+ EN0_RSARHI
);
589 int low
= inb_p(nic_base
+ EN0_RSARLO
);
590 addr
= (high
<< 8) + low
;
591 if ((start_page
<< 8) + count
== addr
)
593 } while (--tries
> 0);
595 printk("%s: Tx packet transfer address mismatch,"
596 "%#4.4x (expected) vs. %#4.4x (actual).\n",
597 dev
->name
, (start_page
<< 8) + count
, addr
);
604 while ((inb_p(nic_base
+ EN0_ISR
) & ENISR_RDC
) == 0)
605 if (jiffies
- dma_start
> 2*HZ
/100) { /* 20ms */
606 printk("%s: timeout waiting for Tx RDC.\n", dev
->name
);
612 outb_p(ENISR_RDC
, nic_base
+ EN0_ISR
); /* Ack intr. */
613 ei_status
.dmaing
&= ~0x01;
619 #define MAX_NE_CARDS 4 /* Max number of NE cards per module */
620 static struct net_device dev_ne
[MAX_NE_CARDS
];
621 static int io
[MAX_NE_CARDS
];
622 static int irq
[MAX_NE_CARDS
];
623 static int bad
[MAX_NE_CARDS
]; /* 0xbad = bad sig or no reset ack */
626 MODULE_PARM(io
, "1-" __MODULE_STRING(MAX_NE_CARDS
) "i");
627 MODULE_PARM(irq
, "1-" __MODULE_STRING(MAX_NE_CARDS
) "i");
628 MODULE_PARM(bad
, "1-" __MODULE_STRING(MAX_NE_CARDS
) "i");
631 /* Module code fixed by David Weinehall */
633 int init_module(void)
635 int this_dev
, found
= 0;
637 for (this_dev
= 0; this_dev
< MAX_NE_CARDS
; this_dev
++) {
638 struct net_device
*dev
= &dev_ne
[this_dev
];
639 dev
->irq
= irq
[this_dev
];
640 dev
->mem_end
= bad
[this_dev
];
641 dev
->base_addr
= io
[this_dev
];
642 dev
->init
= ne2_probe
;
643 if (register_netdev(dev
) != 0) {
644 if (found
!= 0) return 0; /* Got at least one. */
646 printk(KERN_WARNING
"ne2.c: No NE/2 card found.\n");
654 void cleanup_module(void)
658 for (this_dev
= 0; this_dev
< MAX_NE_CARDS
; this_dev
++) {
659 struct net_device
*dev
= &dev_ne
[this_dev
];
660 if (dev
->priv
!= NULL
) {
661 mca_mark_as_unused(ei_status
.priv
);
662 mca_set_adapter_procfn( ei_status
.priv
, NULL
, NULL
);
664 free_irq(dev
->irq
, dev
);
665 release_region(dev
->base_addr
, NE_IO_EXTENT
);
666 unregister_netdev(dev
);
674 * compile-command: "gcc -DKERNEL -Wall -O6 -fomit-frame-pointer -I/usr/src/linux/net/tcp -c ne2.c"
676 * kept-new-versions: 5