1 /* wd.c: A WD80x3 ethernet driver for linux. */
3 Written 1993-94 by Donald Becker.
5 Copyright 1993 United States Government as represented by the
6 Director, National Security Agency.
8 This software may be used and distributed according to the terms
9 of the GNU General Public License, incorporated herein by reference.
11 The author may be reached as becker@scyld.com, or C/O
12 Scyld Computing Corporation
13 410 Severn Ave., Suite 210
16 This is a driver for WD8003 and WD8013 "compatible" ethercards.
18 Thanks to Russ Nelson (nelson@crnwyr.com) for loaning me a WD8013.
22 Paul Gortmaker : multiple card support for module users, support
23 for non-standard memory sizes.
28 static const char version[] =
29 "wd.c:v1.10 9/23/94 Donald Becker (becker@cesdis.gsfc.nasa.gov)\n";
31 #include <linux/module.h>
32 #include <linux/kernel.h>
33 #include <linux/errno.h>
34 #include <linux/string.h>
35 #include <linux/init.h>
36 #include <linux/interrupt.h>
37 #include <linux/delay.h>
38 #include <linux/netdevice.h>
39 #include <linux/etherdevice.h>
42 #include <asm/system.h>
48 /* A zero-terminated list of I/O addresses to be probed. */
49 static unsigned int wd_portlist[] __initdata =
50 {0x300, 0x280, 0x380, 0x240, 0};
52 static int wd_probe1(struct net_device *dev, int ioaddr);
54 static int wd_open(struct net_device *dev);
55 static void wd_reset_8390(struct net_device *dev);
56 static void wd_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
58 static void wd_block_input(struct net_device *dev, int count,
59 struct sk_buff *skb, int ring_offset);
60 static void wd_block_output(struct net_device *dev, int count,
61 const unsigned char *buf, int start_page);
62 static int wd_close(struct net_device *dev);
65 #define WD_START_PG 0x00 /* First page of TX buffer */
66 #define WD03_STOP_PG 0x20 /* Last page +1 of RX ring */
67 #define WD13_STOP_PG 0x40 /* Last page +1 of RX ring */
69 #define WD_CMDREG 0 /* Offset to ASIC command register. */
70 #define WD_RESET 0x80 /* Board reset, in WD_CMDREG. */
71 #define WD_MEMENB 0x40 /* Enable the shared memory. */
72 #define WD_CMDREG5 5 /* Offset to 16-bit-only ASIC register 5. */
73 #define ISA16 0x80 /* Enable 16 bit access from the ISA bus. */
74 #define NIC16 0x40 /* Enable 16 bit access from the 8390. */
75 #define WD_NIC_OFFSET 16 /* Offset to the 8390 from the base_addr. */
76 #define WD_IO_EXTENT 32
79 /* Probe for the WD8003 and WD8013. These cards have the station
80 address PROM at I/O ports <base>+8 to <base>+13, with a checksum
81 following. A Soundblaster can have the same checksum as an WDethercard,
82 so we have an extra exclusionary check for it.
84 The wd_probe1() routine initializes the card and fills the
85 station address field. */
87 static int __init do_wd_probe(struct net_device *dev)
91 int base_addr = dev->base_addr;
93 int mem_start = dev->mem_start;
94 int mem_end = dev->mem_end;
96 if (base_addr > 0x1ff) { /* Check a user specified location. */
97 r = request_region(base_addr, WD_IO_EXTENT, "wd-probe");
100 i = wd_probe1(dev, base_addr);
102 release_region(base_addr, WD_IO_EXTENT);
107 else if (base_addr != 0) /* Don't probe at all. */
110 for (i = 0; wd_portlist[i]; i++) {
111 int ioaddr = wd_portlist[i];
112 r = request_region(ioaddr, WD_IO_EXTENT, "wd-probe");
115 if (wd_probe1(dev, ioaddr) == 0) {
119 release_region(ioaddr, WD_IO_EXTENT);
121 dev->mem_start = mem_start;
122 dev->mem_end = mem_end;
129 struct net_device * __init wd_probe(int unit)
131 struct net_device *dev = alloc_ei_netdev();
135 return ERR_PTR(-ENOMEM);
137 sprintf(dev->name, "eth%d", unit);
138 netdev_boot_setup_check(dev);
140 err = do_wd_probe(dev);
150 static int __init wd_probe1(struct net_device *dev, int ioaddr)
155 int ancient = 0; /* An old card without config registers. */
156 int word16 = 0; /* 0 = 8 bit, 1 = 16 bit */
157 const char *model_name;
158 static unsigned version_printed;
160 for (i = 0; i < 8; i++)
161 checksum += inb(ioaddr + 8 + i);
162 if (inb(ioaddr + 8) == 0xff /* Extra check to avoid soundcard. */
163 || inb(ioaddr + 9) == 0xff
164 || (checksum & 0xff) != 0xFF)
167 /* Check for semi-valid mem_start/end values if supplied. */
168 if ((dev->mem_start % 0x2000) || (dev->mem_end % 0x2000)) {
169 printk(KERN_WARNING "wd.c: user supplied mem_start or mem_end not on 8kB boundary - ignored.\n");
174 if (ei_debug && version_printed++ == 0)
177 printk("%s: WD80x3 at %#3x,", dev->name, ioaddr);
178 for (i = 0; i < 6; i++)
179 printk(" %2.2X", dev->dev_addr[i] = inb(ioaddr + 8 + i));
181 /* The following PureData probe code was contributed by
182 Mike Jagdis <jaggy@purplet.demon.co.uk>. Puredata does software
183 configuration differently from others so we have to check for them.
184 This detects an 8 bit, 16 bit or dumb (Toshiba, jumpered) card.
186 if (inb(ioaddr+0) == 'P' && inb(ioaddr+1) == 'D') {
187 unsigned char reg5 = inb(ioaddr+5);
189 switch (inb(ioaddr+2)) {
190 case 0x03: word16 = 0; model_name = "PDI8023-8"; break;
191 case 0x05: word16 = 0; model_name = "PDUC8023"; break;
192 case 0x0a: word16 = 1; model_name = "PDI8023-16"; break;
193 /* Either 0x01 (dumb) or they've released a new version. */
194 default: word16 = 0; model_name = "PDI8023"; break;
196 dev->mem_start = ((reg5 & 0x1c) + 0xc0) << 12;
197 dev->irq = (reg5 & 0xe0) == 0xe0 ? 10 : (reg5 >> 5) + 1;
198 } else { /* End of PureData probe */
199 /* This method of checking for a 16-bit board is borrowed from the
200 we.c driver. A simpler method is just to look in ASIC reg. 0x03.
201 I'm comparing the two method in alpha test to make certain they
202 return the same result. */
203 /* Check for the old 8 bit board - it has register 0/8 aliasing.
204 Do NOT check i>=6 here -- it hangs the old 8003 boards! */
205 for (i = 0; i < 6; i++)
206 if (inb(ioaddr+i) != inb(ioaddr+8+i))
210 model_name = "WD8003-old";
213 int tmp = inb(ioaddr+1); /* fiddle with 16bit bit */
214 outb( tmp ^ 0x01, ioaddr+1 ); /* attempt to clear 16bit bit */
215 if (((inb( ioaddr+1) & 0x01) == 0x01) /* A 16 bit card */
216 && (tmp & 0x01) == 0x01 ) { /* In a 16 slot. */
217 int asic_reg5 = inb(ioaddr+WD_CMDREG5);
218 /* Magic to set ASIC to word-wide mode. */
219 outb( NIC16 | (asic_reg5&0x1f), ioaddr+WD_CMDREG5);
221 model_name = "WD8013";
222 word16 = 1; /* We have a 16bit board here! */
224 model_name = "WD8003";
227 outb(tmp, ioaddr+1); /* Restore original reg1 value. */
229 #ifndef final_version
230 if ( !ancient && (inb(ioaddr+1) & 0x01) != (word16 & 0x01))
231 printk("\nWD80?3: Bus width conflict, %d (probe) != %d (reg report).",
232 word16 ? 16 : 8, (inb(ioaddr+1) & 0x01) ? 16 : 8);
236 #if defined(WD_SHMEM) && WD_SHMEM > 0x80000
237 /* Allow a compile-time override. */
238 dev->mem_start = WD_SHMEM;
240 if (dev->mem_start == 0) {
241 /* Sanity and old 8003 check */
242 int reg0 = inb(ioaddr);
243 if (reg0 == 0xff || reg0 == 0) {
244 /* Future plan: this could check a few likely locations first. */
245 dev->mem_start = 0xd0000;
246 printk(" assigning address %#lx", dev->mem_start);
248 int high_addr_bits = inb(ioaddr+WD_CMDREG5) & 0x1f;
249 /* Some boards don't have the register 5 -- it returns 0xff. */
250 if (high_addr_bits == 0x1f || word16 == 0)
251 high_addr_bits = 0x01;
252 dev->mem_start = ((reg0&0x3f) << 13) + (high_addr_bits << 19);
257 /* The 8390 isn't at the base address -- the ASIC regs are there! */
258 dev->base_addr = ioaddr+WD_NIC_OFFSET;
261 int irqmap[] = {9,3,5,7,10,11,15,4};
262 int reg1 = inb(ioaddr+1);
263 int reg4 = inb(ioaddr+4);
264 if (ancient || reg1 == 0xff) { /* Ack!! No way to read the IRQ! */
265 short nic_addr = ioaddr+WD_NIC_OFFSET;
266 unsigned long irq_mask;
268 /* We have an old-style ethercard that doesn't report its IRQ
269 line. Do autoirq to find the IRQ line. Note that this IS NOT
270 a reliable way to trigger an interrupt. */
271 outb_p(E8390_NODMA + E8390_STOP, nic_addr);
272 outb(0x00, nic_addr+EN0_IMR); /* Disable all intrs. */
274 irq_mask = probe_irq_on();
275 outb_p(0xff, nic_addr + EN0_IMR); /* Enable all interrupts. */
276 outb_p(0x00, nic_addr + EN0_RCNTLO);
277 outb_p(0x00, nic_addr + EN0_RCNTHI);
278 outb(E8390_RREAD+E8390_START, nic_addr); /* Trigger it... */
280 dev->irq = probe_irq_off(irq_mask);
282 outb_p(0x00, nic_addr+EN0_IMR); /* Mask all intrs. again. */
285 printk(" autoirq is %d", dev->irq);
287 dev->irq = word16 ? 10 : 5;
289 dev->irq = irqmap[((reg4 >> 5) & 0x03) + (reg1 & 0x04)];
290 } else if (dev->irq == 2) /* Fixup bogosity: IRQ2 is really IRQ9 */
293 /* Snarf the interrupt now. There's no point in waiting since we cannot
294 share and the board will usually be enabled. */
295 i = request_irq(dev->irq, ei_interrupt, 0, DRV_NAME, dev);
297 printk (" unable to get IRQ %d.\n", dev->irq);
301 /* OK, were are certain this is going to work. Setup the device. */
302 ei_status.name = model_name;
303 ei_status.word16 = word16;
304 ei_status.tx_start_page = WD_START_PG;
305 ei_status.rx_start_page = WD_START_PG + TX_PAGES;
307 /* Don't map in the shared memory until the board is actually opened. */
309 /* Some cards (eg WD8003EBT) can be jumpered for more (32k!) memory. */
310 if (dev->mem_end != 0) {
311 ei_status.stop_page = (dev->mem_end - dev->mem_start)/256;
312 ei_status.priv = dev->mem_end - dev->mem_start;
314 ei_status.stop_page = word16 ? WD13_STOP_PG : WD03_STOP_PG;
315 dev->mem_end = dev->mem_start + (ei_status.stop_page - WD_START_PG)*256;
316 ei_status.priv = (ei_status.stop_page - WD_START_PG)*256;
319 ei_status.mem = ioremap(dev->mem_start, ei_status.priv);
320 if (!ei_status.mem) {
321 free_irq(dev->irq, dev);
325 printk(" %s, IRQ %d, shared memory at %#lx-%#lx.\n",
326 model_name, dev->irq, dev->mem_start, dev->mem_end-1);
328 ei_status.reset_8390 = &wd_reset_8390;
329 ei_status.block_input = &wd_block_input;
330 ei_status.block_output = &wd_block_output;
331 ei_status.get_8390_hdr = &wd_get_8390_hdr;
332 dev->open = &wd_open;
333 dev->stop = &wd_close;
334 #ifdef CONFIG_NET_POLL_CONTROLLER
335 dev->poll_controller = ei_poll;
340 /* Enable interrupt generation on softconfig cards -- M.U */
341 /* .. but possibly potentially unsafe - Donald */
342 if (inb(ioaddr+14) & 0x20)
343 outb(inb(ioaddr+4)|0x80, ioaddr+4);
346 err = register_netdev(dev);
348 free_irq(dev->irq, dev);
353 wd_open(struct net_device *dev)
355 int ioaddr = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
357 /* Map in the shared memory. Always set register 0 last to remain
358 compatible with very old boards. */
359 ei_status.reg0 = ((dev->mem_start>>13) & 0x3f) | WD_MEMENB;
360 ei_status.reg5 = ((dev->mem_start>>19) & 0x1f) | NIC16;
362 if (ei_status.word16)
363 outb(ei_status.reg5, ioaddr+WD_CMDREG5);
364 outb(ei_status.reg0, ioaddr); /* WD_CMDREG */
371 wd_reset_8390(struct net_device *dev)
373 int wd_cmd_port = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
375 outb(WD_RESET, wd_cmd_port);
376 if (ei_debug > 1) printk("resetting the WD80x3 t=%lu...", jiffies);
379 /* Set up the ASIC registers, just in case something changed them. */
380 outb((((dev->mem_start>>13) & 0x3f)|WD_MEMENB), wd_cmd_port);
381 if (ei_status.word16)
382 outb(NIC16 | ((dev->mem_start>>19) & 0x1f), wd_cmd_port+WD_CMDREG5);
384 if (ei_debug > 1) printk("reset done\n");
388 /* Grab the 8390 specific header. Similar to the block_input routine, but
389 we don't need to be concerned with ring wrap as the header will be at
390 the start of a page, so we optimize accordingly. */
393 wd_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
396 int wd_cmdreg = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
397 void __iomem *hdr_start = ei_status.mem + ((ring_page - WD_START_PG)<<8);
399 /* We'll always get a 4 byte header read followed by a packet read, so
400 we enable 16 bit mode before the header, and disable after the body. */
401 if (ei_status.word16)
402 outb(ISA16 | ei_status.reg5, wd_cmdreg+WD_CMDREG5);
405 /* Officially this is what we are doing, but the readl() is faster */
406 /* unfortunately it isn't endian aware of the struct */
407 memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
408 hdr->count = le16_to_cpu(hdr->count);
410 ((unsigned int*)hdr)[0] = readl(hdr_start);
414 /* Block input and output are easy on shared memory ethercards, and trivial
415 on the Western digital card where there is no choice of how to do it.
416 The only complications are that the ring buffer wraps, and need to map
417 switch between 8- and 16-bit modes. */
420 wd_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
422 int wd_cmdreg = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
423 unsigned long offset = ring_offset - (WD_START_PG<<8);
424 void __iomem *xfer_start = ei_status.mem + offset;
426 if (offset + count > ei_status.priv) {
427 /* We must wrap the input move. */
428 int semi_count = ei_status.priv - offset;
429 memcpy_fromio(skb->data, xfer_start, semi_count);
431 memcpy_fromio(skb->data + semi_count, ei_status.mem + TX_PAGES * 256, count);
433 /* Packet is in one chunk -- we can copy + cksum. */
434 memcpy_fromio(skb->data, xfer_start, count);
437 /* Turn off 16 bit access so that reboot works. ISA brain-damage */
438 if (ei_status.word16)
439 outb(ei_status.reg5, wd_cmdreg+WD_CMDREG5);
443 wd_block_output(struct net_device *dev, int count, const unsigned char *buf,
446 int wd_cmdreg = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
447 void __iomem *shmem = ei_status.mem + ((start_page - WD_START_PG)<<8);
450 if (ei_status.word16) {
451 /* Turn on and off 16 bit access so that reboot works. */
452 outb(ISA16 | ei_status.reg5, wd_cmdreg+WD_CMDREG5);
453 memcpy_toio(shmem, buf, count);
454 outb(ei_status.reg5, wd_cmdreg+WD_CMDREG5);
456 memcpy_toio(shmem, buf, count);
461 wd_close(struct net_device *dev)
463 int wd_cmdreg = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
466 printk("%s: Shutting down ethercard.\n", dev->name);
469 /* Change from 16-bit to 8-bit shared memory so reboot works. */
470 if (ei_status.word16)
471 outb(ei_status.reg5, wd_cmdreg + WD_CMDREG5 );
473 /* And disable the shared memory. */
474 outb(ei_status.reg0 & ~WD_MEMENB, wd_cmdreg);
481 #define MAX_WD_CARDS 4 /* Max number of wd cards per module */
482 static struct net_device *dev_wd[MAX_WD_CARDS];
483 static int io[MAX_WD_CARDS];
484 static int irq[MAX_WD_CARDS];
485 static int mem[MAX_WD_CARDS];
486 static int mem_end[MAX_WD_CARDS]; /* for non std. mem size */
488 module_param_array(io, int, NULL, 0);
489 module_param_array(irq, int, NULL, 0);
490 module_param_array(mem, int, NULL, 0);
491 module_param_array(mem_end, int, NULL, 0);
492 MODULE_PARM_DESC(io, "I/O base address(es)");
493 MODULE_PARM_DESC(irq, "IRQ number(s) (ignored for PureData boards)");
494 MODULE_PARM_DESC(mem, "memory base address(es)(ignored for PureData boards)");
495 MODULE_PARM_DESC(mem_end, "memory end address(es)");
496 MODULE_DESCRIPTION("ISA Western Digital wd8003/wd8013 ; SMC Elite, Elite16 ethernet driver");
497 MODULE_LICENSE("GPL");
499 /* This is set up so that only a single autoprobe takes place per call.
500 ISA device autoprobes on a running machine are not recommended. */
502 int __init init_module(void)
504 struct net_device *dev;
505 int this_dev, found = 0;
507 for (this_dev = 0; this_dev < MAX_WD_CARDS; this_dev++) {
508 if (io[this_dev] == 0) {
509 if (this_dev != 0) break; /* only autoprobe 1st one */
510 printk(KERN_NOTICE "wd.c: Presently autoprobing (not recommended) for a single card.\n");
512 dev = alloc_ei_netdev();
515 dev->irq = irq[this_dev];
516 dev->base_addr = io[this_dev];
517 dev->mem_start = mem[this_dev];
518 dev->mem_end = mem_end[this_dev];
519 if (do_wd_probe(dev) == 0) {
520 dev_wd[found++] = dev;
524 printk(KERN_WARNING "wd.c: No wd80x3 card found (i/o = 0x%x).\n", io[this_dev]);
532 static void cleanup_card(struct net_device *dev)
534 free_irq(dev->irq, dev);
535 release_region(dev->base_addr - WD_NIC_OFFSET, WD_IO_EXTENT);
536 iounmap(ei_status.mem);
544 for (this_dev = 0; this_dev < MAX_WD_CARDS; this_dev++) {
545 struct net_device *dev = dev_wd[this_dev];
547 unregister_netdev(dev);