1 /* smc-ultra.c: A SMC Ultra ethernet driver for linux. */
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
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.
26 ultra_open() The card-specific details of starting, stopping
27 ultra_reset_8390() and resetting the 8390 NIC core.
30 ultra_block_input() Routines for reading and writing blocks of
31 ultra_block_output() packet buffer memory.
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.
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/config.h>
61 #include <linux/module.h>
62 #include <linux/kernel.h>
63 #include <linux/errno.h>
64 #include <linux/string.h>
65 #include <linux/init.h>
66 #include <linux/isapnp.h>
67 #include <linux/netdevice.h>
68 #include <linux/etherdevice.h>
72 #include <asm/system.h>
76 #define DRV_NAME "smc-ultra"
78 /* A zero-terminated list of I/O addresses to be probed. */
79 static unsigned int ultra_portlist[] __initdata =
80 {0x200, 0x220, 0x240, 0x280, 0x300, 0x340, 0x380, 0};
82 static int ultra_probe1(struct net_device *dev, int ioaddr);
85 static int ultra_probe_isapnp(struct net_device *dev);
88 static int ultra_open(struct net_device *dev);
89 static void ultra_reset_8390(struct net_device *dev);
90 static void ultra_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
92 static void ultra_block_input(struct net_device *dev, int count,
93 struct sk_buff *skb, int ring_offset);
94 static void ultra_block_output(struct net_device *dev, int count,
95 const unsigned char *buf, const int start_page);
96 static void ultra_pio_get_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
98 static void ultra_pio_input(struct net_device *dev, int count,
99 struct sk_buff *skb, int ring_offset);
100 static void ultra_pio_output(struct net_device *dev, int count,
101 const unsigned char *buf, const int start_page);
102 static int ultra_close_card(struct net_device *dev);
105 static struct isapnp_device_id ultra_device_ids[] __initdata = {
106 { ISAPNP_VENDOR('S','M','C'), ISAPNP_FUNCTION(0x8416),
107 ISAPNP_VENDOR('S','M','C'), ISAPNP_FUNCTION(0x8416),
108 (long) "SMC EtherEZ (8416)" },
109 { } /* terminate list */
112 MODULE_DEVICE_TABLE(isapnp, ultra_device_ids);
116 #define START_PG 0x00 /* First page of TX buffer */
118 #define ULTRA_CMDREG 0 /* Offset to ASIC command register. */
119 #define ULTRA_RESET 0x80 /* Board reset, in ULTRA_CMDREG. */
120 #define ULTRA_MEMENB 0x40 /* Enable the shared memory. */
121 #define IOPD 0x02 /* I/O Pipe Data (16 bits), PIO operation. */
122 #define IOPA 0x07 /* I/O Pipe Address for PIO operation. */
123 #define ULTRA_NIC_OFFSET 16 /* NIC register offset from the base_addr. */
124 #define ULTRA_IO_EXTENT 32
125 #define EN0_ERWCNT 0x08 /* Early receive warning count. */
127 #ifdef CONFIG_NET_POLL_CONTROLLER
128 static void ultra_poll(struct net_device *dev)
130 disable_irq(dev->irq);
131 ei_interrupt(dev->irq, dev, NULL);
132 enable_irq(dev->irq);
135 /* Probe for the Ultra. This looks like a 8013 with the station
136 address PROM at I/O ports <base>+8 to <base>+13, with a checksum
140 static int __init do_ultra_probe(struct net_device *dev)
143 int base_addr = dev->base_addr;
146 SET_MODULE_OWNER(dev);
148 #ifdef CONFIG_NET_POLL_CONTROLLER
149 dev->poll_controller = &ultra_poll;
151 if (base_addr > 0x1ff) /* Check a single specified location. */
152 return ultra_probe1(dev, base_addr);
153 else if (base_addr != 0) /* Don't probe at all. */
157 /* Look for any installed ISAPnP cards */
158 if (isapnp_present() && (ultra_probe_isapnp(dev) == 0))
162 for (i = 0; ultra_portlist[i]; i++) {
164 if (ultra_probe1(dev, ultra_portlist[i]) == 0)
171 static void cleanup_card(struct net_device *dev)
173 /* NB: ultra_close_card() does free_irq */
175 struct pnp_dev *idev = (struct pnp_dev *)ei_status.priv;
177 pnp_device_detach(idev);
179 release_region(dev->base_addr - ULTRA_NIC_OFFSET, ULTRA_IO_EXTENT);
180 iounmap(ei_status.mem);
184 struct net_device * __init ultra_probe(int unit)
186 struct net_device *dev = alloc_ei_netdev();
190 return ERR_PTR(-ENOMEM);
192 sprintf(dev->name, "eth%d", unit);
193 netdev_boot_setup_check(dev);
195 err = do_ultra_probe(dev);
205 static int __init ultra_probe1(struct net_device *dev, int ioaddr)
209 const char *model_name;
210 unsigned char eeprom_irq = 0;
211 static unsigned version_printed;
212 /* Values from various config regs. */
213 unsigned char num_pages, irqreg, addr, piomode;
214 unsigned char idreg = inb(ioaddr + 7);
215 unsigned char reg4 = inb(ioaddr + 4) & 0x7f;
217 if (!request_region(ioaddr, ULTRA_IO_EXTENT, DRV_NAME))
220 /* Check the ID nibble. */
221 if ((idreg & 0xF0) != 0x20 /* SMC Ultra */
222 && (idreg & 0xF0) != 0x40) { /* SMC EtherEZ */
227 /* Select the station address register set. */
228 outb(reg4, ioaddr + 4);
230 for (i = 0; i < 8; i++)
231 checksum += inb(ioaddr + 8 + i);
232 if ((checksum & 0xff) != 0xFF) {
237 if (ei_debug && version_printed++ == 0)
240 model_name = (idreg & 0xF0) == 0x20 ? "SMC Ultra" : "SMC EtherEZ";
242 printk("%s: %s at %#3x,", dev->name, model_name, ioaddr);
244 for (i = 0; i < 6; i++)
245 printk(" %2.2X", dev->dev_addr[i] = inb(ioaddr + 8 + i));
247 /* Switch from the station address to the alternate register set and
248 read the useful registers there. */
249 outb(0x80 | reg4, ioaddr + 4);
251 /* Enabled FINE16 mode to avoid BIOS ROM width mismatches @ reboot. */
252 outb(0x80 | inb(ioaddr + 0x0c), ioaddr + 0x0c);
253 piomode = inb(ioaddr + 0x8);
254 addr = inb(ioaddr + 0xb);
255 irqreg = inb(ioaddr + 0xd);
257 /* Switch back to the station address register set so that the MS-DOS driver
258 can find the card after a warm boot. */
259 outb(reg4, ioaddr + 4);
262 unsigned char irqmap[] = {0, 9, 3, 5, 7, 10, 11, 15};
265 /* The IRQ bits are split. */
266 irq = irqmap[((irqreg & 0x40) >> 4) + ((irqreg & 0x0c) >> 2)];
269 printk(", failed to detect IRQ line.\n");
277 /* The 8390 isn't at the base address, so fake the offset */
278 dev->base_addr = ioaddr+ULTRA_NIC_OFFSET;
281 int addr_tbl[4] = {0x0C0000, 0x0E0000, 0xFC0000, 0xFE0000};
282 short num_pages_tbl[4] = {0x20, 0x40, 0x80, 0xff};
284 dev->mem_start = ((addr & 0x0f) << 13) + addr_tbl[(addr >> 6) & 3] ;
285 num_pages = num_pages_tbl[(addr >> 4) & 3];
288 ei_status.name = model_name;
289 ei_status.word16 = 1;
290 ei_status.tx_start_page = START_PG;
291 ei_status.rx_start_page = START_PG + TX_PAGES;
292 ei_status.stop_page = num_pages;
294 ei_status.mem = ioremap(dev->mem_start, (ei_status.stop_page - START_PG)*256);
295 if (!ei_status.mem) {
296 printk(", failed to ioremap.\n");
301 dev->mem_end = dev->mem_start + (ei_status.stop_page - START_PG)*256;
304 printk(",%s IRQ %d programmed-I/O mode.\n",
305 eeprom_irq ? "EEPROM" : "assigned ", dev->irq);
306 ei_status.block_input = &ultra_pio_input;
307 ei_status.block_output = &ultra_pio_output;
308 ei_status.get_8390_hdr = &ultra_pio_get_hdr;
310 printk(",%s IRQ %d memory %#lx-%#lx.\n", eeprom_irq ? "" : "assigned ",
311 dev->irq, dev->mem_start, dev->mem_end-1);
312 ei_status.block_input = &ultra_block_input;
313 ei_status.block_output = &ultra_block_output;
314 ei_status.get_8390_hdr = &ultra_get_8390_hdr;
316 ei_status.reset_8390 = &ultra_reset_8390;
317 dev->open = &ultra_open;
318 dev->stop = &ultra_close_card;
319 #ifdef CONFIG_NET_POLL_CONTROLLER
320 dev->poll_controller = ei_poll;
324 retval = register_netdev(dev);
329 release_region(ioaddr, ULTRA_IO_EXTENT);
334 static int __init ultra_probe_isapnp(struct net_device *dev)
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,
345 /* Avoid already found cards from previous calls */
346 if (pnp_device_attach(idev) < 0)
348 if (pnp_activate_dev(idev) < 0) {
350 pnp_device_detach(idev);
353 /* if no io and irq, search for next */
354 if (!pnp_port_valid(idev, 0) || !pnp_irq_valid(idev, 0))
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);
367 ei_status.priv = (unsigned long)idev;
380 ultra_open(struct net_device *dev)
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);
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. */
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);
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);
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. */
425 outb(0x01, cmd_port + 6); /* Enable interrupts and memory. */
427 if (ei_debug > 1) printk("reset done\n");
431 /* Grab the 8390 specific header. Similar to the block_input routine, but
432 we don't need to be concerned with ring wrap as the header will be at
433 the start of a page, so we optimize accordingly. */
436 ultra_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
438 void __iomem *hdr_start = ei_status.mem + ((ring_page - START_PG)<<8);
440 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET); /* shmem on */
442 /* Officially this is what we are doing, but the readl() is faster */
443 /* unfortunately it isn't endian aware of the struct */
444 memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
445 hdr->count = le16_to_cpu(hdr->count);
447 ((unsigned int*)hdr)[0] = readl(hdr_start);
449 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* shmem off */
452 /* Block input and output are easy on shared memory ethercards, the only
453 complication is when the ring buffer wraps. */
456 ultra_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
458 void __iomem *xfer_start = ei_status.mem + ring_offset - (START_PG<<8);
460 /* Enable shared memory. */
461 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET);
463 if (ring_offset + count > ei_status.stop_page*256) {
464 /* We must wrap the input move. */
465 int semi_count = ei_status.stop_page*256 - ring_offset;
466 memcpy_fromio(skb->data, xfer_start, semi_count);
468 memcpy_fromio(skb->data + semi_count, ei_status.mem + TX_PAGES * 256, count);
470 /* Packet is in one chunk -- we can copy + cksum. */
471 eth_io_copy_and_sum(skb, xfer_start, count, 0);
474 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* Disable memory. */
478 ultra_block_output(struct net_device *dev, int count, const unsigned char *buf,
481 void __iomem *shmem = ei_status.mem + ((start_page - START_PG)<<8);
483 /* Enable shared memory. */
484 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET);
486 memcpy_toio(shmem, buf, count);
488 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* Disable memory. */
491 /* The identical operations for programmed I/O cards.
492 The PIO model is trivial to use: the 16 bit start address is written
493 byte-sequentially to IOPA, with no intervening I/O operations, and the
494 data is read or written to the IOPD data port.
495 The only potential complication is that the address register is shared
496 and must be always be rewritten between each read/write direction change.
497 This is no problem for us, as the 8390 code ensures that we are single
499 static void ultra_pio_get_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
502 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
503 outb(0x00, ioaddr + IOPA); /* Set the address, LSB first. */
504 outb(ring_page, ioaddr + IOPA);
505 insw(ioaddr + IOPD, hdr, sizeof(struct e8390_pkt_hdr)>>1);
508 static void ultra_pio_input(struct net_device *dev, int count,
509 struct sk_buff *skb, int ring_offset)
511 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
512 char *buf = skb->data;
514 /* For now set the address again, although it should already be correct. */
515 outb(ring_offset, ioaddr + IOPA); /* Set the address, LSB first. */
516 outb(ring_offset >> 8, ioaddr + IOPA);
517 /* We know skbuffs are padded to at least word alignment. */
518 insw(ioaddr + IOPD, buf, (count+1)>>1);
521 static void ultra_pio_output(struct net_device *dev, int count,
522 const unsigned char *buf, const int start_page)
524 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
525 outb(0x00, ioaddr + IOPA); /* Set the address, LSB first. */
526 outb(start_page, ioaddr + IOPA);
527 /* An extra odd byte is OK here as well. */
528 outsw(ioaddr + IOPD, buf, (count+1)>>1);
532 ultra_close_card(struct net_device *dev)
534 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* CMDREG */
536 netif_stop_queue(dev);
539 printk("%s: Shutting down ethercard.\n", dev->name);
541 outb(0x00, ioaddr + 6); /* Disable interrupts. */
542 free_irq(dev->irq, dev);
546 /* We should someday disable shared memory and change to 8-bit mode
554 #define MAX_ULTRA_CARDS 4 /* Max number of Ultra cards per module */
555 static struct net_device *dev_ultra[MAX_ULTRA_CARDS];
556 static int io[MAX_ULTRA_CARDS];
557 static int irq[MAX_ULTRA_CARDS];
559 module_param_array(io, int, NULL, 0);
560 module_param_array(irq, int, NULL, 0);
561 MODULE_PARM_DESC(io, "I/O base address(es)");
562 MODULE_PARM_DESC(irq, "IRQ number(s) (assigned)");
563 MODULE_DESCRIPTION("SMC Ultra/EtherEZ ISA/PnP Ethernet driver");
564 MODULE_LICENSE("GPL");
566 /* This is set up so that only a single autoprobe takes place per call.
567 ISA device autoprobes on a running machine are not recommended. */
571 struct net_device *dev;
572 int this_dev, found = 0;
574 for (this_dev = 0; this_dev < MAX_ULTRA_CARDS; this_dev++) {
575 if (io[this_dev] == 0) {
576 if (this_dev != 0) break; /* only autoprobe 1st one */
577 printk(KERN_NOTICE "smc-ultra.c: Presently autoprobing (not recommended) for a single card.\n");
579 dev = alloc_ei_netdev();
582 dev->irq = irq[this_dev];
583 dev->base_addr = io[this_dev];
584 if (do_ultra_probe(dev) == 0) {
585 dev_ultra[found++] = dev;
589 printk(KERN_WARNING "smc-ultra.c: No SMC Ultra card found (i/o = 0x%x).\n", io[this_dev]);
602 for (this_dev = 0; this_dev < MAX_ULTRA_CARDS; this_dev++) {
603 struct net_device *dev = dev_ultra[this_dev];
605 unregister_netdev(dev);