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>
71 #include <asm/system.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);
84 static int ultra_probe_isapnp(struct net_device *dev);
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,
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,
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);
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);
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, NULL);
131 enable_irq(dev->irq);
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
139 static int __init do_ultra_probe(struct net_device *dev)
142 int base_addr = dev->base_addr;
145 SET_MODULE_OWNER(dev);
147 #ifdef CONFIG_NET_POLL_CONTROLLER
148 dev->poll_controller = &ultra_poll;
150 if (base_addr > 0x1ff) /* Check a single specified location. */
151 return ultra_probe1(dev, base_addr);
152 else if (base_addr != 0) /* Don't probe at all. */
156 /* Look for any installed ISAPnP cards */
157 if (isapnp_present() && (ultra_probe_isapnp(dev) == 0))
161 for (i = 0; ultra_portlist[i]; i++) {
163 if (ultra_probe1(dev, ultra_portlist[i]) == 0)
170 static void cleanup_card(struct net_device *dev)
172 /* NB: ultra_close_card() does free_irq */
174 struct pnp_dev *idev = (struct pnp_dev *)ei_status.priv;
176 pnp_device_detach(idev);
178 release_region(dev->base_addr - ULTRA_NIC_OFFSET, ULTRA_IO_EXTENT);
182 struct net_device * __init ultra_probe(int unit)
184 struct net_device *dev = alloc_ei_netdev();
188 return ERR_PTR(-ENOMEM);
190 sprintf(dev->name, "eth%d", unit);
191 netdev_boot_setup_check(dev);
193 err = do_ultra_probe(dev);
196 err = register_netdev(dev);
208 static int __init ultra_probe1(struct net_device *dev, int ioaddr)
212 const char *model_name;
213 unsigned char eeprom_irq = 0;
214 static unsigned version_printed;
215 /* Values from various config regs. */
216 unsigned char num_pages, irqreg, addr, piomode;
217 unsigned char idreg = inb(ioaddr + 7);
218 unsigned char reg4 = inb(ioaddr + 4) & 0x7f;
220 if (!request_region(ioaddr, ULTRA_IO_EXTENT, DRV_NAME))
223 /* Check the ID nibble. */
224 if ((idreg & 0xF0) != 0x20 /* SMC Ultra */
225 && (idreg & 0xF0) != 0x40) { /* SMC EtherEZ */
230 /* Select the station address register set. */
231 outb(reg4, ioaddr + 4);
233 for (i = 0; i < 8; i++)
234 checksum += inb(ioaddr + 8 + i);
235 if ((checksum & 0xff) != 0xFF) {
240 if (ei_debug && version_printed++ == 0)
243 model_name = (idreg & 0xF0) == 0x20 ? "SMC Ultra" : "SMC EtherEZ";
245 printk("%s: %s at %#3x,", dev->name, model_name, ioaddr);
247 for (i = 0; i < 6; i++)
248 printk(" %2.2X", dev->dev_addr[i] = inb(ioaddr + 8 + i));
250 /* Switch from the station address to the alternate register set and
251 read the useful registers there. */
252 outb(0x80 | reg4, ioaddr + 4);
254 /* Enabled FINE16 mode to avoid BIOS ROM width mismatches @ reboot. */
255 outb(0x80 | inb(ioaddr + 0x0c), ioaddr + 0x0c);
256 piomode = inb(ioaddr + 0x8);
257 addr = inb(ioaddr + 0xb);
258 irqreg = inb(ioaddr + 0xd);
260 /* Switch back to the station address register set so that the MS-DOS driver
261 can find the card after a warm boot. */
262 outb(reg4, ioaddr + 4);
265 unsigned char irqmap[] = {0, 9, 3, 5, 7, 10, 11, 15};
268 /* The IRQ bits are split. */
269 irq = irqmap[((irqreg & 0x40) >> 4) + ((irqreg & 0x0c) >> 2)];
272 printk(", failed to detect IRQ line.\n");
280 /* The 8390 isn't at the base address, so fake the offset */
281 dev->base_addr = ioaddr+ULTRA_NIC_OFFSET;
284 int addr_tbl[4] = {0x0C0000, 0x0E0000, 0xFC0000, 0xFE0000};
285 short num_pages_tbl[4] = {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.rmem_start = dev->mem_start + TX_PAGES*256;
298 dev->mem_end = ei_status.rmem_end
299 = dev->mem_start + (ei_status.stop_page - START_PG)*256;
302 printk(",%s IRQ %d programmed-I/O mode.\n",
303 eeprom_irq ? "EEPROM" : "assigned ", dev->irq);
304 ei_status.block_input = &ultra_pio_input;
305 ei_status.block_output = &ultra_pio_output;
306 ei_status.get_8390_hdr = &ultra_pio_get_hdr;
308 printk(",%s IRQ %d memory %#lx-%#lx.\n", eeprom_irq ? "" : "assigned ",
309 dev->irq, dev->mem_start, dev->mem_end-1);
310 ei_status.block_input = &ultra_block_input;
311 ei_status.block_output = &ultra_block_output;
312 ei_status.get_8390_hdr = &ultra_get_8390_hdr;
314 ei_status.reset_8390 = &ultra_reset_8390;
315 dev->open = &ultra_open;
316 dev->stop = &ultra_close_card;
317 #ifdef CONFIG_NET_POLL_CONTROLLER
318 dev->poll_controller = ei_poll;
324 release_region(ioaddr, ULTRA_IO_EXTENT);
329 static int __init ultra_probe_isapnp(struct net_device *dev)
333 for (i = 0; ultra_device_ids[i].vendor != 0; i++) {
334 struct pnp_dev *idev = NULL;
336 while ((idev = pnp_find_dev(NULL,
337 ultra_device_ids[i].vendor,
338 ultra_device_ids[i].function,
340 /* Avoid already found cards from previous calls */
341 if (pnp_device_attach(idev) < 0)
343 if (pnp_activate_dev(idev) < 0) {
345 pnp_device_detach(idev);
348 /* if no io and irq, search for next */
349 if (!pnp_port_valid(idev, 0) || !pnp_irq_valid(idev, 0))
352 dev->base_addr = pnp_port_start(idev, 0);
353 dev->irq = pnp_irq(idev, 0);
354 printk(KERN_INFO "smc-ultra.c: ISAPnP reports %s at i/o %#lx, irq %d.\n",
355 (char *) ultra_device_ids[i].driver_data,
356 dev->base_addr, dev->irq);
357 if (ultra_probe1(dev, dev->base_addr) != 0) { /* Shouldn't happen. */
358 printk(KERN_ERR "smc-ultra.c: Probe of ISAPnP card at %#lx failed.\n", dev->base_addr);
359 pnp_device_detach(idev);
362 ei_status.priv = (unsigned long)idev;
375 ultra_open(struct net_device *dev)
378 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
379 unsigned char irq2reg[] = {0, 0, 0x04, 0x08, 0, 0x0C, 0, 0x40,
380 0, 0x04, 0x44, 0x48, 0, 0, 0, 0x4C, };
382 retval = request_irq(dev->irq, ei_interrupt, 0, dev->name, dev);
386 outb(0x00, ioaddr); /* Disable shared memory for safety. */
387 outb(0x80, ioaddr + 5);
388 /* Set the IRQ line. */
389 outb(inb(ioaddr + 4) | 0x80, ioaddr + 4);
390 outb((inb(ioaddr + 13) & ~0x4C) | irq2reg[dev->irq], ioaddr + 13);
391 outb(inb(ioaddr + 4) & 0x7f, ioaddr + 4);
393 if (ei_status.block_input == &ultra_pio_input) {
394 outb(0x11, ioaddr + 6); /* Enable interrupts and PIO. */
395 outb(0x01, ioaddr + 0x19); /* Enable ring read auto-wrap. */
397 outb(0x01, ioaddr + 6); /* Enable interrupts and memory. */
398 /* Set the early receive warning level in window 0 high enough not
399 to receive ERW interrupts. */
400 outb_p(E8390_NODMA+E8390_PAGE0, dev->base_addr);
401 outb(0xff, dev->base_addr + EN0_ERWCNT);
407 ultra_reset_8390(struct net_device *dev)
409 int cmd_port = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC base addr */
411 outb(ULTRA_RESET, cmd_port);
412 if (ei_debug > 1) printk("resetting Ultra, t=%ld...", jiffies);
415 outb(0x00, cmd_port); /* Disable shared memory for safety. */
416 outb(0x80, cmd_port + 5);
417 if (ei_status.block_input == &ultra_pio_input)
418 outb(0x11, cmd_port + 6); /* Enable interrupts and PIO. */
420 outb(0x01, cmd_port + 6); /* Enable interrupts and memory. */
422 if (ei_debug > 1) printk("reset done\n");
426 /* Grab the 8390 specific header. Similar to the block_input routine, but
427 we don't need to be concerned with ring wrap as the header will be at
428 the start of a page, so we optimize accordingly. */
431 ultra_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
433 unsigned long hdr_start = dev->mem_start + ((ring_page - START_PG)<<8);
435 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET); /* shmem on */
437 /* Officially this is what we are doing, but the readl() is faster */
438 /* unfortunately it isn't endian aware of the struct */
439 isa_memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
440 hdr->count = le16_to_cpu(hdr->count);
442 ((unsigned int*)hdr)[0] = isa_readl(hdr_start);
444 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* shmem off */
447 /* Block input and output are easy on shared memory ethercards, the only
448 complication is when the ring buffer wraps. */
451 ultra_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
453 unsigned long xfer_start = dev->mem_start + ring_offset - (START_PG<<8);
455 /* Enable shared memory. */
456 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET);
458 if (xfer_start + count > ei_status.rmem_end) {
459 /* We must wrap the input move. */
460 int semi_count = ei_status.rmem_end - xfer_start;
461 isa_memcpy_fromio(skb->data, xfer_start, semi_count);
463 isa_memcpy_fromio(skb->data + semi_count, ei_status.rmem_start, count);
465 /* Packet is in one chunk -- we can copy + cksum. */
466 isa_eth_io_copy_and_sum(skb, xfer_start, count, 0);
469 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* Disable memory. */
473 ultra_block_output(struct net_device *dev, int count, const unsigned char *buf,
476 unsigned long shmem = dev->mem_start + ((start_page - START_PG)<<8);
478 /* Enable shared memory. */
479 outb(ULTRA_MEMENB, dev->base_addr - ULTRA_NIC_OFFSET);
481 isa_memcpy_toio(shmem, buf, count);
483 outb(0x00, dev->base_addr - ULTRA_NIC_OFFSET); /* Disable memory. */
486 /* The identical operations for programmed I/O cards.
487 The PIO model is trivial to use: the 16 bit start address is written
488 byte-sequentially to IOPA, with no intervening I/O operations, and the
489 data is read or written to the IOPD data port.
490 The only potential complication is that the address register is shared
491 and must be always be rewritten between each read/write direction change.
492 This is no problem for us, as the 8390 code ensures that we are single
494 static void ultra_pio_get_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
497 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
498 outb(0x00, ioaddr + IOPA); /* Set the address, LSB first. */
499 outb(ring_page, ioaddr + IOPA);
500 insw(ioaddr + IOPD, hdr, sizeof(struct e8390_pkt_hdr)>>1);
503 static void ultra_pio_input(struct net_device *dev, int count,
504 struct sk_buff *skb, int ring_offset)
506 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
507 char *buf = skb->data;
509 /* For now set the address again, although it should already be correct. */
510 outb(ring_offset, ioaddr + IOPA); /* Set the address, LSB first. */
511 outb(ring_offset >> 8, ioaddr + IOPA);
512 /* We know skbuffs are padded to at least word alignment. */
513 insw(ioaddr + IOPD, buf, (count+1)>>1);
516 static void ultra_pio_output(struct net_device *dev, int count,
517 const unsigned char *buf, const int start_page)
519 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
520 outb(0x00, ioaddr + IOPA); /* Set the address, LSB first. */
521 outb(start_page, ioaddr + IOPA);
522 /* An extra odd byte is OK here as well. */
523 outsw(ioaddr + IOPD, buf, (count+1)>>1);
527 ultra_close_card(struct net_device *dev)
529 int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* CMDREG */
531 netif_stop_queue(dev);
534 printk("%s: Shutting down ethercard.\n", dev->name);
536 outb(0x00, ioaddr + 6); /* Disable interrupts. */
537 free_irq(dev->irq, dev);
541 /* We should someday disable shared memory and change to 8-bit mode
549 #define MAX_ULTRA_CARDS 4 /* Max number of Ultra cards per module */
550 static struct net_device *dev_ultra[MAX_ULTRA_CARDS];
551 static int io[MAX_ULTRA_CARDS];
552 static int irq[MAX_ULTRA_CARDS];
554 module_param_array(io, int, NULL, 0);
555 module_param_array(irq, int, NULL, 0);
556 MODULE_PARM_DESC(io, "I/O base address(es)");
557 MODULE_PARM_DESC(irq, "IRQ number(s) (assigned)");
558 MODULE_DESCRIPTION("SMC Ultra/EtherEZ ISA/PnP Ethernet driver");
559 MODULE_LICENSE("GPL");
561 /* This is set up so that only a single autoprobe takes place per call.
562 ISA device autoprobes on a running machine are not recommended. */
566 struct net_device *dev;
567 int this_dev, found = 0;
569 for (this_dev = 0; this_dev < MAX_ULTRA_CARDS; this_dev++) {
570 if (io[this_dev] == 0) {
571 if (this_dev != 0) break; /* only autoprobe 1st one */
572 printk(KERN_NOTICE "smc-ultra.c: Presently autoprobing (not recommended) for a single card.\n");
574 dev = alloc_ei_netdev();
577 dev->irq = irq[this_dev];
578 dev->base_addr = io[this_dev];
579 if (do_ultra_probe(dev) == 0) {
580 if (register_netdev(dev) == 0) {
581 dev_ultra[found++] = dev;
587 printk(KERN_WARNING "smc-ultra.c: No SMC Ultra card found (i/o = 0x%x).\n", io[this_dev]);
600 for (this_dev = 0; this_dev < MAX_ULTRA_CARDS; this_dev++) {
601 struct net_device *dev = dev_ultra[this_dev];
603 unregister_netdev(dev);