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 const struct net_device_ops wd_netdev_ops = {
152 .ndo_stop = wd_close,
153 .ndo_start_xmit = ei_start_xmit,
154 .ndo_tx_timeout = ei_tx_timeout,
155 .ndo_get_stats = ei_get_stats,
156 .ndo_set_multicast_list = ei_set_multicast_list,
157 .ndo_validate_addr = eth_validate_addr,
158 .ndo_set_mac_address = eth_mac_addr,
159 .ndo_change_mtu = eth_change_mtu,
160 #ifdef CONFIG_NET_POLL_CONTROLLER
161 .ndo_poll_controller = ei_poll,
165 static int __init wd_probe1(struct net_device *dev, int ioaddr)
170 int ancient = 0; /* An old card without config registers. */
171 int word16 = 0; /* 0 = 8 bit, 1 = 16 bit */
172 const char *model_name;
173 static unsigned version_printed;
175 for (i = 0; i < 8; i++)
176 checksum += inb(ioaddr + 8 + i);
177 if (inb(ioaddr + 8) == 0xff /* Extra check to avoid soundcard. */
178 || inb(ioaddr + 9) == 0xff
179 || (checksum & 0xff) != 0xFF)
182 /* Check for semi-valid mem_start/end values if supplied. */
183 if ((dev->mem_start % 0x2000) || (dev->mem_end % 0x2000)) {
184 printk(KERN_WARNING "wd.c: user supplied mem_start or mem_end not on 8kB boundary - ignored.\n");
189 if (ei_debug && version_printed++ == 0)
192 for (i = 0; i < 6; i++)
193 dev->dev_addr[i] = inb(ioaddr + 8 + i);
195 printk("%s: WD80x3 at %#3x, %pM",
196 dev->name, ioaddr, dev->dev_addr);
198 /* The following PureData probe code was contributed by
199 Mike Jagdis <jaggy@purplet.demon.co.uk>. Puredata does software
200 configuration differently from others so we have to check for them.
201 This detects an 8 bit, 16 bit or dumb (Toshiba, jumpered) card.
203 if (inb(ioaddr+0) == 'P' && inb(ioaddr+1) == 'D') {
204 unsigned char reg5 = inb(ioaddr+5);
206 switch (inb(ioaddr+2)) {
207 case 0x03: word16 = 0; model_name = "PDI8023-8"; break;
208 case 0x05: word16 = 0; model_name = "PDUC8023"; break;
209 case 0x0a: word16 = 1; model_name = "PDI8023-16"; break;
210 /* Either 0x01 (dumb) or they've released a new version. */
211 default: word16 = 0; model_name = "PDI8023"; break;
213 dev->mem_start = ((reg5 & 0x1c) + 0xc0) << 12;
214 dev->irq = (reg5 & 0xe0) == 0xe0 ? 10 : (reg5 >> 5) + 1;
215 } else { /* End of PureData probe */
216 /* This method of checking for a 16-bit board is borrowed from the
217 we.c driver. A simpler method is just to look in ASIC reg. 0x03.
218 I'm comparing the two method in alpha test to make certain they
219 return the same result. */
220 /* Check for the old 8 bit board - it has register 0/8 aliasing.
221 Do NOT check i>=6 here -- it hangs the old 8003 boards! */
222 for (i = 0; i < 6; i++)
223 if (inb(ioaddr+i) != inb(ioaddr+8+i))
227 model_name = "WD8003-old";
230 int tmp = inb(ioaddr+1); /* fiddle with 16bit bit */
231 outb( tmp ^ 0x01, ioaddr+1 ); /* attempt to clear 16bit bit */
232 if (((inb( ioaddr+1) & 0x01) == 0x01) /* A 16 bit card */
233 && (tmp & 0x01) == 0x01 ) { /* In a 16 slot. */
234 int asic_reg5 = inb(ioaddr+WD_CMDREG5);
235 /* Magic to set ASIC to word-wide mode. */
236 outb( NIC16 | (asic_reg5&0x1f), ioaddr+WD_CMDREG5);
238 model_name = "WD8013";
239 word16 = 1; /* We have a 16bit board here! */
241 model_name = "WD8003";
244 outb(tmp, ioaddr+1); /* Restore original reg1 value. */
246 #ifndef final_version
247 if ( !ancient && (inb(ioaddr+1) & 0x01) != (word16 & 0x01))
248 printk("\nWD80?3: Bus width conflict, %d (probe) != %d (reg report).",
249 word16 ? 16 : 8, (inb(ioaddr+1) & 0x01) ? 16 : 8);
253 #if defined(WD_SHMEM) && WD_SHMEM > 0x80000
254 /* Allow a compile-time override. */
255 dev->mem_start = WD_SHMEM;
257 if (dev->mem_start == 0) {
258 /* Sanity and old 8003 check */
259 int reg0 = inb(ioaddr);
260 if (reg0 == 0xff || reg0 == 0) {
261 /* Future plan: this could check a few likely locations first. */
262 dev->mem_start = 0xd0000;
263 printk(" assigning address %#lx", dev->mem_start);
265 int high_addr_bits = inb(ioaddr+WD_CMDREG5) & 0x1f;
266 /* Some boards don't have the register 5 -- it returns 0xff. */
267 if (high_addr_bits == 0x1f || word16 == 0)
268 high_addr_bits = 0x01;
269 dev->mem_start = ((reg0&0x3f) << 13) + (high_addr_bits << 19);
274 /* The 8390 isn't at the base address -- the ASIC regs are there! */
275 dev->base_addr = ioaddr+WD_NIC_OFFSET;
278 int irqmap[] = {9,3,5,7,10,11,15,4};
279 int reg1 = inb(ioaddr+1);
280 int reg4 = inb(ioaddr+4);
281 if (ancient || reg1 == 0xff) { /* Ack!! No way to read the IRQ! */
282 short nic_addr = ioaddr+WD_NIC_OFFSET;
283 unsigned long irq_mask;
285 /* We have an old-style ethercard that doesn't report its IRQ
286 line. Do autoirq to find the IRQ line. Note that this IS NOT
287 a reliable way to trigger an interrupt. */
288 outb_p(E8390_NODMA + E8390_STOP, nic_addr);
289 outb(0x00, nic_addr+EN0_IMR); /* Disable all intrs. */
291 irq_mask = probe_irq_on();
292 outb_p(0xff, nic_addr + EN0_IMR); /* Enable all interrupts. */
293 outb_p(0x00, nic_addr + EN0_RCNTLO);
294 outb_p(0x00, nic_addr + EN0_RCNTHI);
295 outb(E8390_RREAD+E8390_START, nic_addr); /* Trigger it... */
297 dev->irq = probe_irq_off(irq_mask);
299 outb_p(0x00, nic_addr+EN0_IMR); /* Mask all intrs. again. */
302 printk(" autoirq is %d", dev->irq);
304 dev->irq = word16 ? 10 : 5;
306 dev->irq = irqmap[((reg4 >> 5) & 0x03) + (reg1 & 0x04)];
307 } else if (dev->irq == 2) /* Fixup bogosity: IRQ2 is really IRQ9 */
310 /* Snarf the interrupt now. There's no point in waiting since we cannot
311 share and the board will usually be enabled. */
312 i = request_irq(dev->irq, ei_interrupt, 0, DRV_NAME, dev);
314 printk (" unable to get IRQ %d.\n", dev->irq);
318 /* OK, were are certain this is going to work. Setup the device. */
319 ei_status.name = model_name;
320 ei_status.word16 = word16;
321 ei_status.tx_start_page = WD_START_PG;
322 ei_status.rx_start_page = WD_START_PG + TX_PAGES;
324 /* Don't map in the shared memory until the board is actually opened. */
326 /* Some cards (eg WD8003EBT) can be jumpered for more (32k!) memory. */
327 if (dev->mem_end != 0) {
328 ei_status.stop_page = (dev->mem_end - dev->mem_start)/256;
329 ei_status.priv = dev->mem_end - dev->mem_start;
331 ei_status.stop_page = word16 ? WD13_STOP_PG : WD03_STOP_PG;
332 dev->mem_end = dev->mem_start + (ei_status.stop_page - WD_START_PG)*256;
333 ei_status.priv = (ei_status.stop_page - WD_START_PG)*256;
336 ei_status.mem = ioremap(dev->mem_start, ei_status.priv);
337 if (!ei_status.mem) {
338 free_irq(dev->irq, dev);
342 printk(" %s, IRQ %d, shared memory at %#lx-%#lx.\n",
343 model_name, dev->irq, dev->mem_start, dev->mem_end-1);
345 ei_status.reset_8390 = &wd_reset_8390;
346 ei_status.block_input = &wd_block_input;
347 ei_status.block_output = &wd_block_output;
348 ei_status.get_8390_hdr = &wd_get_8390_hdr;
350 dev->netdev_ops = &wd_netdev_ops;
354 /* Enable interrupt generation on softconfig cards -- M.U */
355 /* .. but possibly potentially unsafe - Donald */
356 if (inb(ioaddr+14) & 0x20)
357 outb(inb(ioaddr+4)|0x80, ioaddr+4);
360 err = register_netdev(dev);
362 free_irq(dev->irq, dev);
367 wd_open(struct net_device *dev)
369 int ioaddr = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
371 /* Map in the shared memory. Always set register 0 last to remain
372 compatible with very old boards. */
373 ei_status.reg0 = ((dev->mem_start>>13) & 0x3f) | WD_MEMENB;
374 ei_status.reg5 = ((dev->mem_start>>19) & 0x1f) | NIC16;
376 if (ei_status.word16)
377 outb(ei_status.reg5, ioaddr+WD_CMDREG5);
378 outb(ei_status.reg0, ioaddr); /* WD_CMDREG */
384 wd_reset_8390(struct net_device *dev)
386 int wd_cmd_port = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
388 outb(WD_RESET, wd_cmd_port);
389 if (ei_debug > 1) printk("resetting the WD80x3 t=%lu...", jiffies);
392 /* Set up the ASIC registers, just in case something changed them. */
393 outb((((dev->mem_start>>13) & 0x3f)|WD_MEMENB), wd_cmd_port);
394 if (ei_status.word16)
395 outb(NIC16 | ((dev->mem_start>>19) & 0x1f), wd_cmd_port+WD_CMDREG5);
397 if (ei_debug > 1) printk("reset done\n");
400 /* Grab the 8390 specific header. Similar to the block_input routine, but
401 we don't need to be concerned with ring wrap as the header will be at
402 the start of a page, so we optimize accordingly. */
405 wd_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
408 int wd_cmdreg = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
409 void __iomem *hdr_start = ei_status.mem + ((ring_page - WD_START_PG)<<8);
411 /* We'll always get a 4 byte header read followed by a packet read, so
412 we enable 16 bit mode before the header, and disable after the body. */
413 if (ei_status.word16)
414 outb(ISA16 | ei_status.reg5, wd_cmdreg+WD_CMDREG5);
417 /* Officially this is what we are doing, but the readl() is faster */
418 /* unfortunately it isn't endian aware of the struct */
419 memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
420 hdr->count = le16_to_cpu(hdr->count);
422 ((unsigned int*)hdr)[0] = readl(hdr_start);
426 /* Block input and output are easy on shared memory ethercards, and trivial
427 on the Western digital card where there is no choice of how to do it.
428 The only complications are that the ring buffer wraps, and need to map
429 switch between 8- and 16-bit modes. */
432 wd_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
434 int wd_cmdreg = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
435 unsigned long offset = ring_offset - (WD_START_PG<<8);
436 void __iomem *xfer_start = ei_status.mem + offset;
438 if (offset + count > ei_status.priv) {
439 /* We must wrap the input move. */
440 int semi_count = ei_status.priv - offset;
441 memcpy_fromio(skb->data, xfer_start, semi_count);
443 memcpy_fromio(skb->data + semi_count, ei_status.mem + TX_PAGES * 256, count);
445 /* Packet is in one chunk -- we can copy + cksum. */
446 memcpy_fromio(skb->data, xfer_start, count);
449 /* Turn off 16 bit access so that reboot works. ISA brain-damage */
450 if (ei_status.word16)
451 outb(ei_status.reg5, wd_cmdreg+WD_CMDREG5);
455 wd_block_output(struct net_device *dev, int count, const unsigned char *buf,
458 int wd_cmdreg = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
459 void __iomem *shmem = ei_status.mem + ((start_page - WD_START_PG)<<8);
462 if (ei_status.word16) {
463 /* Turn on and off 16 bit access so that reboot works. */
464 outb(ISA16 | ei_status.reg5, wd_cmdreg+WD_CMDREG5);
465 memcpy_toio(shmem, buf, count);
466 outb(ei_status.reg5, wd_cmdreg+WD_CMDREG5);
468 memcpy_toio(shmem, buf, count);
473 wd_close(struct net_device *dev)
475 int wd_cmdreg = dev->base_addr - WD_NIC_OFFSET; /* WD_CMDREG */
478 printk("%s: Shutting down ethercard.\n", dev->name);
481 /* Change from 16-bit to 8-bit shared memory so reboot works. */
482 if (ei_status.word16)
483 outb(ei_status.reg5, wd_cmdreg + WD_CMDREG5 );
485 /* And disable the shared memory. */
486 outb(ei_status.reg0 & ~WD_MEMENB, wd_cmdreg);
493 #define MAX_WD_CARDS 4 /* Max number of wd cards per module */
494 static struct net_device *dev_wd[MAX_WD_CARDS];
495 static int io[MAX_WD_CARDS];
496 static int irq[MAX_WD_CARDS];
497 static int mem[MAX_WD_CARDS];
498 static int mem_end[MAX_WD_CARDS]; /* for non std. mem size */
500 module_param_array(io, int, NULL, 0);
501 module_param_array(irq, int, NULL, 0);
502 module_param_array(mem, int, NULL, 0);
503 module_param_array(mem_end, int, NULL, 0);
504 MODULE_PARM_DESC(io, "I/O base address(es)");
505 MODULE_PARM_DESC(irq, "IRQ number(s) (ignored for PureData boards)");
506 MODULE_PARM_DESC(mem, "memory base address(es)(ignored for PureData boards)");
507 MODULE_PARM_DESC(mem_end, "memory end address(es)");
508 MODULE_DESCRIPTION("ISA Western Digital wd8003/wd8013 ; SMC Elite, Elite16 ethernet driver");
509 MODULE_LICENSE("GPL");
511 /* This is set up so that only a single autoprobe takes place per call.
512 ISA device autoprobes on a running machine are not recommended. */
514 int __init init_module(void)
516 struct net_device *dev;
517 int this_dev, found = 0;
519 for (this_dev = 0; this_dev < MAX_WD_CARDS; this_dev++) {
520 if (io[this_dev] == 0) {
521 if (this_dev != 0) break; /* only autoprobe 1st one */
522 printk(KERN_NOTICE "wd.c: Presently autoprobing (not recommended) for a single card.\n");
524 dev = alloc_ei_netdev();
527 dev->irq = irq[this_dev];
528 dev->base_addr = io[this_dev];
529 dev->mem_start = mem[this_dev];
530 dev->mem_end = mem_end[this_dev];
531 if (do_wd_probe(dev) == 0) {
532 dev_wd[found++] = dev;
536 printk(KERN_WARNING "wd.c: No wd80x3 card found (i/o = 0x%x).\n", io[this_dev]);
544 static void cleanup_card(struct net_device *dev)
546 free_irq(dev->irq, dev);
547 release_region(dev->base_addr - WD_NIC_OFFSET, WD_IO_EXTENT);
548 iounmap(ei_status.mem);
556 for (this_dev = 0; this_dev < MAX_WD_CARDS; this_dev++) {
557 struct net_device *dev = dev_wd[this_dev];
559 unregister_netdev(dev);