Merge remote-tracking branch 'cleancache/linux-next'
[linux-2.6/next.git] / drivers / net / smc-ultra.c
blob235a3c6c9f915d38ae78433ac1b9237930b5edd7
1 /* smc-ultra.c: A SMC Ultra ethernet driver for linux. */
2 /*
3 This is a driver for the SMC Ultra and SMC EtherEZ ISA ethercards.
5 Written 1993-1998 by Donald Becker.
7 Copyright 1993 United States Government as represented by the
8 Director, National Security Agency.
10 This software may be used and distributed according to the terms
11 of the GNU General Public License, incorporated herein by reference.
13 The author may be reached as becker@scyld.com, or C/O
14 Scyld Computing Corporation
15 410 Severn Ave., Suite 210
16 Annapolis MD 21403
18 This driver uses the cards in the 8390-compatible mode.
19 Most of the run-time complexity is handled by the generic code in
20 8390.c. The code in this file is responsible for
22 ultra_probe() Detecting and initializing the card.
23 ultra_probe1()
24 ultra_probe_isapnp()
26 ultra_open() The card-specific details of starting, stopping
27 ultra_reset_8390() and resetting the 8390 NIC core.
28 ultra_close()
30 ultra_block_input() Routines for reading and writing blocks of
31 ultra_block_output() packet buffer memory.
32 ultra_pio_input()
33 ultra_pio_output()
35 This driver enables the shared memory only when doing the actual data
36 transfers to avoid a bug in early version of the card that corrupted
37 data transferred by a AHA1542.
39 This driver now supports the programmed-I/O (PIO) data transfer mode of
40 the EtherEZ. It does not use the non-8390-compatible "Altego" mode.
41 That support (if available) is in smc-ez.c.
43 Changelog:
45 Paul Gortmaker : multiple card support for module users.
46 Donald Becker : 4/17/96 PIO support, minor potential problems avoided.
47 Donald Becker : 6/6/96 correctly set auto-wrap bit.
48 Alexander Sotirov : 1/20/01 Added support for ISAPnP cards
50 Note about the ISA PnP support:
52 This driver can not autoprobe for more than one SMC EtherEZ PnP card.
53 You have to configure the second card manually through the /proc/isapnp
54 interface and then load the module with an explicit io=0x___ option.
57 static const char version[] =
58 "smc-ultra.c:v2.02 2/3/98 Donald Becker (becker@cesdis.gsfc.nasa.gov)\n";
60 #include <linux/module.h>
61 #include <linux/kernel.h>
62 #include <linux/errno.h>
63 #include <linux/string.h>
64 #include <linux/init.h>
65 #include <linux/isapnp.h>
66 #include <linux/netdevice.h>
67 #include <linux/etherdevice.h>
69 #include <asm/io.h>
70 #include <asm/irq.h>
71 #include <asm/system.h>
73 #include "8390.h"
75 #define DRV_NAME "smc-ultra"
77 /* A zero-terminated list of I/O addresses to be probed. */
78 static unsigned int ultra_portlist[] __initdata =
79 {0x200, 0x220, 0x240, 0x280, 0x300, 0x340, 0x380, 0};
81 static int ultra_probe1(struct net_device *dev, int ioaddr);
83 #ifdef __ISAPNP__
84 static int ultra_probe_isapnp(struct net_device *dev);
85 #endif
87 static int ultra_open(struct net_device *dev);
88 static void ultra_reset_8390(struct net_device *dev);
89 static void ultra_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
90 int ring_page);
91 static void ultra_block_input(struct net_device *dev, int count,
92 struct sk_buff *skb, int ring_offset);
93 static void ultra_block_output(struct net_device *dev, int count,
94 const unsigned char *buf, const int start_page);
95 static void ultra_pio_get_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
96 int ring_page);
97 static void ultra_pio_input(struct net_device *dev, int count,
98 struct sk_buff *skb, int ring_offset);
99 static void ultra_pio_output(struct net_device *dev, int count,
100 const unsigned char *buf, const int start_page);
101 static int ultra_close_card(struct net_device *dev);
103 #ifdef __ISAPNP__
104 static struct isapnp_device_id ultra_device_ids[] __initdata = {
105 { ISAPNP_VENDOR('S','M','C'), ISAPNP_FUNCTION(0x8416),
106 ISAPNP_VENDOR('S','M','C'), ISAPNP_FUNCTION(0x8416),
107 (long) "SMC EtherEZ (8416)" },
108 { } /* terminate list */
111 MODULE_DEVICE_TABLE(isapnp, ultra_device_ids);
112 #endif
115 #define START_PG 0x00 /* First page of TX buffer */
117 #define ULTRA_CMDREG 0 /* Offset to ASIC command register. */
118 #define ULTRA_RESET 0x80 /* Board reset, in ULTRA_CMDREG. */
119 #define ULTRA_MEMENB 0x40 /* Enable the shared memory. */
120 #define IOPD 0x02 /* I/O Pipe Data (16 bits), PIO operation. */
121 #define IOPA 0x07 /* I/O Pipe Address for PIO operation. */
122 #define ULTRA_NIC_OFFSET 16 /* NIC register offset from the base_addr. */
123 #define ULTRA_IO_EXTENT 32
124 #define EN0_ERWCNT 0x08 /* Early receive warning count. */
126 #ifdef CONFIG_NET_POLL_CONTROLLER
127 static void ultra_poll(struct net_device *dev)
129 disable_irq(dev->irq);
130 ei_interrupt(dev->irq, dev);
131 enable_irq(dev->irq);
133 #endif
134 /* Probe for the Ultra. This looks like a 8013 with the station
135 address PROM at I/O ports <base>+8 to <base>+13, with a checksum
136 following.
139 static int __init do_ultra_probe(struct net_device *dev)
141 int i;
142 int base_addr = dev->base_addr;
143 int irq = dev->irq;
145 if (base_addr > 0x1ff) /* Check a single specified location. */
146 return ultra_probe1(dev, base_addr);
147 else if (base_addr != 0) /* Don't probe at all. */
148 return -ENXIO;
150 #ifdef __ISAPNP__
151 /* Look for any installed ISAPnP cards */
152 if (isapnp_present() && (ultra_probe_isapnp(dev) == 0))
153 return 0;
154 #endif
156 for (i = 0; ultra_portlist[i]; i++) {
157 dev->irq = irq;
158 if (ultra_probe1(dev, ultra_portlist[i]) == 0)
159 return 0;
162 return -ENODEV;
165 #ifndef MODULE
166 struct net_device * __init ultra_probe(int unit)
168 struct net_device *dev = alloc_ei_netdev();
169 int err;
171 if (!dev)
172 return ERR_PTR(-ENOMEM);
174 sprintf(dev->name, "eth%d", unit);
175 netdev_boot_setup_check(dev);
177 err = do_ultra_probe(dev);
178 if (err)
179 goto out;
180 return dev;
181 out:
182 free_netdev(dev);
183 return ERR_PTR(err);
185 #endif
187 static const struct net_device_ops ultra_netdev_ops = {
188 .ndo_open = ultra_open,
189 .ndo_stop = ultra_close_card,
191 .ndo_start_xmit = ei_start_xmit,
192 .ndo_tx_timeout = ei_tx_timeout,
193 .ndo_get_stats = ei_get_stats,
194 .ndo_set_multicast_list = ei_set_multicast_list,
195 .ndo_validate_addr = eth_validate_addr,
196 .ndo_set_mac_address = eth_mac_addr,
197 .ndo_change_mtu = eth_change_mtu,
198 #ifdef CONFIG_NET_POLL_CONTROLLER
199 .ndo_poll_controller = ultra_poll,
200 #endif
203 static int __init ultra_probe1(struct net_device *dev, int ioaddr)
205 int i, retval;
206 int checksum = 0;
207 const char *model_name;
208 unsigned char eeprom_irq = 0;
209 static unsigned version_printed;
210 /* Values from various config regs. */
211 unsigned char num_pages, irqreg, addr, piomode;
212 unsigned char idreg = inb(ioaddr + 7);
213 unsigned char reg4 = inb(ioaddr + 4) & 0x7f;
215 if (!request_region(ioaddr, ULTRA_IO_EXTENT, DRV_NAME))
216 return -EBUSY;
218 /* Check the ID nibble. */
219 if ((idreg & 0xF0) != 0x20 /* SMC Ultra */
220 && (idreg & 0xF0) != 0x40) { /* SMC EtherEZ */
221 retval = -ENODEV;
222 goto out;
225 /* Select the station address register set. */
226 outb(reg4, ioaddr + 4);
228 for (i = 0; i < 8; i++)
229 checksum += inb(ioaddr + 8 + i);
230 if ((checksum & 0xff) != 0xFF) {
231 retval = -ENODEV;
232 goto out;
235 if (ei_debug && version_printed++ == 0)
236 printk(version);
238 model_name = (idreg & 0xF0) == 0x20 ? "SMC Ultra" : "SMC EtherEZ";
240 for (i = 0; i < 6; i++)
241 dev->dev_addr[i] = inb(ioaddr + 8 + i);
243 printk("%s: %s at %#3x, %pM", dev->name, model_name,
244 ioaddr, dev->dev_addr);
246 /* Switch from the station address to the alternate register set and
247 read the useful registers there. */
248 outb(0x80 | reg4, ioaddr + 4);
250 /* Enabled FINE16 mode to avoid BIOS ROM width mismatches @ reboot. */
251 outb(0x80 | inb(ioaddr + 0x0c), ioaddr + 0x0c);
252 piomode = inb(ioaddr + 0x8);
253 addr = inb(ioaddr + 0xb);
254 irqreg = inb(ioaddr + 0xd);
256 /* Switch back to the station address register set so that the MS-DOS driver
257 can find the card after a warm boot. */
258 outb(reg4, ioaddr + 4);
260 if (dev->irq < 2) {
261 unsigned char irqmap[] = {0, 9, 3, 5, 7, 10, 11, 15};
262 int irq;
264 /* The IRQ bits are split. */
265 irq = irqmap[((irqreg & 0x40) >> 4) + ((irqreg & 0x0c) >> 2)];
267 if (irq == 0) {
268 printk(", failed to detect IRQ line.\n");
269 retval = -EAGAIN;
270 goto out;
272 dev->irq = irq;
273 eeprom_irq = 1;
276 /* The 8390 isn't at the base address, so fake the offset */
277 dev->base_addr = ioaddr+ULTRA_NIC_OFFSET;
280 static const int addr_tbl[4] = {
281 0x0C0000, 0x0E0000, 0xFC0000, 0xFE0000
283 static const short num_pages_tbl[4] = {
284 0x20, 0x40, 0x80, 0xff
287 dev->mem_start = ((addr & 0x0f) << 13) + addr_tbl[(addr >> 6) & 3] ;
288 num_pages = num_pages_tbl[(addr >> 4) & 3];
291 ei_status.name = model_name;
292 ei_status.word16 = 1;
293 ei_status.tx_start_page = START_PG;
294 ei_status.rx_start_page = START_PG + TX_PAGES;
295 ei_status.stop_page = num_pages;
297 ei_status.mem = ioremap(dev->mem_start, (ei_status.stop_page - START_PG)*256);
298 if (!ei_status.mem) {
299 printk(", failed to ioremap.\n");
300 retval = -ENOMEM;
301 goto out;
304 dev->mem_end = dev->mem_start + (ei_status.stop_page - START_PG)*256;
306 if (piomode) {
307 printk(",%s IRQ %d programmed-I/O mode.\n",
308 eeprom_irq ? "EEPROM" : "assigned ", dev->irq);
309 ei_status.block_input = &ultra_pio_input;
310 ei_status.block_output = &ultra_pio_output;
311 ei_status.get_8390_hdr = &ultra_pio_get_hdr;
312 } else {
313 printk(",%s IRQ %d memory %#lx-%#lx.\n", eeprom_irq ? "" : "assigned ",
314 dev->irq, dev->mem_start, dev->mem_end-1);
315 ei_status.block_input = &ultra_block_input;
316 ei_status.block_output = &ultra_block_output;
317 ei_status.get_8390_hdr = &ultra_get_8390_hdr;
319 ei_status.reset_8390 = &ultra_reset_8390;
321 dev->netdev_ops = &ultra_netdev_ops;
322 NS8390_init(dev, 0);
324 retval = register_netdev(dev);
325 if (retval)
326 goto out;
327 return 0;
328 out:
329 release_region(ioaddr, ULTRA_IO_EXTENT);
330 return retval;
333 #ifdef __ISAPNP__
334 static int __init ultra_probe_isapnp(struct net_device *dev)
336 int i;
338 for (i = 0; ultra_device_ids[i].vendor != 0; i++) {
339 struct pnp_dev *idev = NULL;
341 while ((idev = pnp_find_dev(NULL,
342 ultra_device_ids[i].vendor,
343 ultra_device_ids[i].function,
344 idev))) {
345 /* Avoid already found cards from previous calls */
346 if (pnp_device_attach(idev) < 0)
347 continue;
348 if (pnp_activate_dev(idev) < 0) {
349 __again:
350 pnp_device_detach(idev);
351 continue;
353 /* if no io and irq, search for next */
354 if (!pnp_port_valid(idev, 0) || !pnp_irq_valid(idev, 0))
355 goto __again;
356 /* found it */
357 dev->base_addr = pnp_port_start(idev, 0);
358 dev->irq = pnp_irq(idev, 0);
359 printk(KERN_INFO "smc-ultra.c: ISAPnP reports %s at i/o %#lx, irq %d.\n",
360 (char *) ultra_device_ids[i].driver_data,
361 dev->base_addr, dev->irq);
362 if (ultra_probe1(dev, dev->base_addr) != 0) { /* Shouldn't happen. */
363 printk(KERN_ERR "smc-ultra.c: Probe of ISAPnP card at %#lx failed.\n", dev->base_addr);
364 pnp_device_detach(idev);
365 return -ENXIO;
367 ei_status.priv = (unsigned long)idev;
368 break;
370 if (!idev)
371 continue;
372 return 0;
375 return -ENODEV;
377 #endif
379 static int
380 ultra_open(struct net_device *dev)
382 int retval;
383 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
384 unsigned char irq2reg[] = {0, 0, 0x04, 0x08, 0, 0x0C, 0, 0x40,
385 0, 0x04, 0x44, 0x48, 0, 0, 0, 0x4C, };
387 retval = request_irq(dev->irq, ei_interrupt, 0, dev->name, dev);
388 if (retval)
389 return retval;
391 outb(0x00, ioaddr); /* Disable shared memory for safety. */
392 outb(0x80, ioaddr + 5);
393 /* Set the IRQ line. */
394 outb(inb(ioaddr + 4) | 0x80, ioaddr + 4);
395 outb((inb(ioaddr + 13) & ~0x4C) | irq2reg[dev->irq], ioaddr + 13);
396 outb(inb(ioaddr + 4) & 0x7f, ioaddr + 4);
398 if (ei_status.block_input == &ultra_pio_input) {
399 outb(0x11, ioaddr + 6); /* Enable interrupts and PIO. */
400 outb(0x01, ioaddr + 0x19); /* Enable ring read auto-wrap. */
401 } else
402 outb(0x01, ioaddr + 6); /* Enable interrupts and memory. */
403 /* Set the early receive warning level in window 0 high enough not
404 to receive ERW interrupts. */
405 outb_p(E8390_NODMA+E8390_PAGE0, dev->base_addr);
406 outb(0xff, dev->base_addr + EN0_ERWCNT);
407 ei_open(dev);
408 return 0;
411 static void
412 ultra_reset_8390(struct net_device *dev)
414 int cmd_port = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC base addr */
416 outb(ULTRA_RESET, cmd_port);
417 if (ei_debug > 1) printk("resetting Ultra, t=%ld...", jiffies);
418 ei_status.txing = 0;
420 outb(0x00, cmd_port); /* Disable shared memory for safety. */
421 outb(0x80, cmd_port + 5);
422 if (ei_status.block_input == &ultra_pio_input)
423 outb(0x11, cmd_port + 6); /* Enable interrupts and PIO. */
424 else
425 outb(0x01, cmd_port + 6); /* Enable interrupts and memory. */
427 if (ei_debug > 1) printk("reset done\n");
430 /* Grab the 8390 specific header. Similar to the block_input routine, but
431 we don't need to be concerned with ring wrap as the header will be at
432 the start of a page, so we optimize accordingly. */
434 static void
435 ultra_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
437 void __iomem *hdr_start = ei_status.mem + ((ring_page - START_PG)<<8);
439 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET); /* shmem on */
440 #ifdef __BIG_ENDIAN
441 /* Officially this is what we are doing, but the readl() is faster */
442 /* unfortunately it isn't endian aware of the struct */
443 memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
444 hdr->count = le16_to_cpu(hdr->count);
445 #else
446 ((unsigned int*)hdr)[0] = readl(hdr_start);
447 #endif
448 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* shmem off */
451 /* Block input and output are easy on shared memory ethercards, the only
452 complication is when the ring buffer wraps. */
454 static void
455 ultra_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
457 void __iomem *xfer_start = ei_status.mem + ring_offset - (START_PG<<8);
459 /* Enable shared memory. */
460 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET);
462 if (ring_offset + count > ei_status.stop_page*256) {
463 /* We must wrap the input move. */
464 int semi_count = ei_status.stop_page*256 - ring_offset;
465 memcpy_fromio(skb->data, xfer_start, semi_count);
466 count -= semi_count;
467 memcpy_fromio(skb->data + semi_count, ei_status.mem + TX_PAGES * 256, count);
468 } else {
469 memcpy_fromio(skb->data, xfer_start, count);
472 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* Disable memory. */
475 static void
476 ultra_block_output(struct net_device *dev, int count, const unsigned char *buf,
477 int start_page)
479 void __iomem *shmem = ei_status.mem + ((start_page - START_PG)<<8);
481 /* Enable shared memory. */
482 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET);
484 memcpy_toio(shmem, buf, count);
486 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* Disable memory. */
489 /* The identical operations for programmed I/O cards.
490 The PIO model is trivial to use: the 16 bit start address is written
491 byte-sequentially to IOPA, with no intervening I/O operations, and the
492 data is read or written to the IOPD data port.
493 The only potential complication is that the address register is shared
494 and must be always be rewritten between each read/write direction change.
495 This is no problem for us, as the 8390 code ensures that we are single
496 threaded. */
497 static void ultra_pio_get_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
498 int ring_page)
500 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
501 outb(0x00, ioaddr + IOPA); /* Set the address, LSB first. */
502 outb(ring_page, ioaddr + IOPA);
503 insw(ioaddr + IOPD, hdr, sizeof(struct e8390_pkt_hdr)>>1);
506 static void ultra_pio_input(struct net_device *dev, int count,
507 struct sk_buff *skb, int ring_offset)
509 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
510 char *buf = skb->data;
512 /* For now set the address again, although it should already be correct. */
513 outb(ring_offset, ioaddr + IOPA); /* Set the address, LSB first. */
514 outb(ring_offset >> 8, ioaddr + IOPA);
515 /* We know skbuffs are padded to at least word alignment. */
516 insw(ioaddr + IOPD, buf, (count+1)>>1);
519 static void ultra_pio_output(struct net_device *dev, int count,
520 const unsigned char *buf, const int start_page)
522 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
523 outb(0x00, ioaddr + IOPA); /* Set the address, LSB first. */
524 outb(start_page, ioaddr + IOPA);
525 /* An extra odd byte is OK here as well. */
526 outsw(ioaddr + IOPD, buf, (count+1)>>1);
529 static int
530 ultra_close_card(struct net_device *dev)
532 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* CMDREG */
534 netif_stop_queue(dev);
536 if (ei_debug > 1)
537 printk("%s: Shutting down ethercard.\n", dev->name);
539 outb(0x00, ioaddr + 6); /* Disable interrupts. */
540 free_irq(dev->irq, dev);
542 NS8390_init(dev, 0);
544 /* We should someday disable shared memory and change to 8-bit mode
545 "just in case"... */
547 return 0;
551 #ifdef MODULE
552 #define MAX_ULTRA_CARDS 4 /* Max number of Ultra cards per module */
553 static struct net_device *dev_ultra[MAX_ULTRA_CARDS];
554 static int io[MAX_ULTRA_CARDS];
555 static int irq[MAX_ULTRA_CARDS];
557 module_param_array(io, int, NULL, 0);
558 module_param_array(irq, int, NULL, 0);
559 MODULE_PARM_DESC(io, "I/O base address(es)");
560 MODULE_PARM_DESC(irq, "IRQ number(s) (assigned)");
561 MODULE_DESCRIPTION("SMC Ultra/EtherEZ ISA/PnP Ethernet driver");
562 MODULE_LICENSE("GPL");
564 /* This is set up so that only a single autoprobe takes place per call.
565 ISA device autoprobes on a running machine are not recommended. */
566 int __init
567 init_module(void)
569 struct net_device *dev;
570 int this_dev, found = 0;
572 for (this_dev = 0; this_dev < MAX_ULTRA_CARDS; this_dev++) {
573 if (io[this_dev] == 0) {
574 if (this_dev != 0) break; /* only autoprobe 1st one */
575 printk(KERN_NOTICE "smc-ultra.c: Presently autoprobing (not recommended) for a single card.\n");
577 dev = alloc_ei_netdev();
578 if (!dev)
579 break;
580 dev->irq = irq[this_dev];
581 dev->base_addr = io[this_dev];
582 if (do_ultra_probe(dev) == 0) {
583 dev_ultra[found++] = dev;
584 continue;
586 free_netdev(dev);
587 printk(KERN_WARNING "smc-ultra.c: No SMC Ultra card found (i/o = 0x%x).\n", io[this_dev]);
588 break;
590 if (found)
591 return 0;
592 return -ENXIO;
595 static void cleanup_card(struct net_device *dev)
597 /* NB: ultra_close_card() does free_irq */
598 #ifdef __ISAPNP__
599 struct pnp_dev *idev = (struct pnp_dev *)ei_status.priv;
600 if (idev)
601 pnp_device_detach(idev);
602 #endif
603 release_region(dev->base_addr - ULTRA_NIC_OFFSET, ULTRA_IO_EXTENT);
604 iounmap(ei_status.mem);
607 void __exit
608 cleanup_module(void)
610 int this_dev;
612 for (this_dev = 0; this_dev < MAX_ULTRA_CARDS; this_dev++) {
613 struct net_device *dev = dev_ultra[this_dev];
614 if (dev) {
615 unregister_netdev(dev);
616 cleanup_card(dev);
617 free_netdev(dev);
621 #endif /* MODULE */