1 /* 3c503.c: A shared-memory NS8390 ethernet driver for linux. */
3 Written 1992-94 by Donald Becker.
5 Copyright 1993 United States Government as represented by the
6 Director, National Security Agency. This software may be used and
7 distributed according to the terms of the GNU General Public License,
8 incorporated herein by reference.
10 The author may be reached as becker@scyld.com, or C/O
11 Scyld Computing Corporation
12 410 Severn Ave., Suite 210
16 This driver should work with the 3c503 and 3c503/16. It should be used
17 in shared memory mode for best performance, although it may also work
18 in programmed-I/O mode.
21 EtherLink II Technical Reference Manual,
22 EtherLink II/16 Technical Reference Manual Supplement,
23 3Com Corporation, 5400 Bayfront Plaza, Santa Clara CA 95052-8145
25 The Crynwr 3c503 packet driver.
29 Paul Gortmaker : add support for the 2nd 8kB of RAM on 16 bit cards.
30 Paul Gortmaker : multiple card support for module users.
31 rjohnson@analogic.com : Fix up PIO interface for efficient operation.
32 Jeff Garzik : ethtool support
36 #define DRV_NAME "3c503"
37 #define DRV_VERSION "1.10a"
38 #define DRV_RELDATE "11/17/2001"
41 static const char version[] =
42 DRV_NAME ".c:v" DRV_VERSION " " DRV_RELDATE " Donald Becker (becker@scyld.com)\n";
44 #include <linux/module.h>
45 #include <linux/kernel.h>
46 #include <linux/errno.h>
47 #include <linux/string.h>
48 #include <linux/delay.h>
49 #include <linux/netdevice.h>
50 #include <linux/etherdevice.h>
51 #include <linux/init.h>
52 #include <linux/ethtool.h>
54 #include <asm/uaccess.h>
56 #include <asm/system.h>
57 #include <asm/byteorder.h>
63 static int el2_pio_probe(struct net_device *dev);
64 static int el2_probe1(struct net_device *dev, int ioaddr);
66 /* A zero-terminated list of I/O addresses to be probed in PIO mode. */
67 static unsigned int netcard_portlist[] __initdata =
68 { 0x300,0x310,0x330,0x350,0x250,0x280,0x2a0,0x2e0,0};
70 #define EL2_IO_EXTENT 16
72 static int el2_open(struct net_device *dev);
73 static int el2_close(struct net_device *dev);
74 static void el2_reset_8390(struct net_device *dev);
75 static void el2_init_card(struct net_device *dev);
76 static void el2_block_output(struct net_device *dev, int count,
77 const unsigned char *buf, int start_page);
78 static void el2_block_input(struct net_device *dev, int count, struct sk_buff *skb,
80 static void el2_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
82 static const struct ethtool_ops netdev_ethtool_ops;
85 /* This routine probes for a memory-mapped 3c503 board by looking for
86 the "location register" at the end of the jumpered boot PROM space.
87 This works even if a PROM isn't there.
89 If the ethercard isn't found there is an optional probe for
90 ethercard jumpered to programmed-I/O mode.
92 static int __init do_el2_probe(struct net_device *dev)
94 int *addr, addrs[] = { 0xddffe, 0xd9ffe, 0xcdffe, 0xc9ffe, 0};
95 int base_addr = dev->base_addr;
98 if (base_addr > 0x1ff) /* Check a single specified location. */
99 return el2_probe1(dev, base_addr);
100 else if (base_addr != 0) /* Don't probe at all. */
103 for (addr = addrs; *addr; addr++) {
104 void __iomem *p = ioremap(*addr, 1);
110 base_bits = readb(p);
112 i = ffs(base_bits) - 1;
113 if (i == -1 || base_bits != (1 << i))
115 if (el2_probe1(dev, netcard_portlist[i]) == 0)
119 #if ! defined(no_probe_nonshared_memory)
120 return el2_pio_probe(dev);
126 /* Try all of the locations that aren't obviously empty. This touches
127 a lot of locations, and is much riskier than the code above. */
129 el2_pio_probe(struct net_device *dev)
132 int base_addr = dev->base_addr;
135 if (base_addr > 0x1ff) /* Check a single specified location. */
136 return el2_probe1(dev, base_addr);
137 else if (base_addr != 0) /* Don't probe at all. */
140 for (i = 0; netcard_portlist[i]; i++) {
141 if (el2_probe1(dev, netcard_portlist[i]) == 0)
150 struct net_device * __init el2_probe(int unit)
152 struct net_device *dev = alloc_eip_netdev();
156 return ERR_PTR(-ENOMEM);
158 sprintf(dev->name, "eth%d", unit);
159 netdev_boot_setup_check(dev);
161 err = do_el2_probe(dev);
171 /* Probe for the Etherlink II card at I/O port base IOADDR,
172 returning non-zero on success. If found, set the station
173 address and memory parameters in DEVICE. */
175 el2_probe1(struct net_device *dev, int ioaddr)
177 int i, iobase_reg, membase_reg, saved_406, wordlength, retval;
178 static unsigned version_printed;
179 unsigned long vendor_id;
181 if (!request_region(ioaddr, EL2_IO_EXTENT, DRV_NAME))
184 if (!request_region(ioaddr + 0x400, 8, DRV_NAME)) {
189 /* Reset and/or avoid any lurking NE2000 */
190 if (inb(ioaddr + 0x408) == 0xff) {
196 /* We verify that it's a 3C503 board by checking the first three octets
197 of its ethernet address. */
198 iobase_reg = inb(ioaddr+0x403);
199 membase_reg = inb(ioaddr+0x404);
200 /* ASIC location registers should be 0 or have only a single bit set. */
201 if ( (iobase_reg & (iobase_reg - 1))
202 || (membase_reg & (membase_reg - 1))) {
206 saved_406 = inb_p(ioaddr + 0x406);
207 outb_p(ECNTRL_RESET|ECNTRL_THIN, ioaddr + 0x406); /* Reset it... */
208 outb_p(ECNTRL_THIN, ioaddr + 0x406);
209 /* Map the station addr PROM into the lower I/O ports. We now check
210 for both the old and new 3Com prefix */
211 outb(ECNTRL_SAPROM|ECNTRL_THIN, ioaddr + 0x406);
212 vendor_id = inb(ioaddr)*0x10000 + inb(ioaddr + 1)*0x100 + inb(ioaddr + 2);
213 if ((vendor_id != OLD_3COM_ID) && (vendor_id != NEW_3COM_ID)) {
214 /* Restore the register we frobbed. */
215 outb(saved_406, ioaddr + 0x406);
220 if (ei_debug && version_printed++ == 0)
223 dev->base_addr = ioaddr;
225 printk("%s: 3c503 at i/o base %#3x, node ", dev->name, ioaddr);
227 /* Retrieve and print the ethernet address. */
228 for (i = 0; i < 6; i++)
229 dev->dev_addr[i] = inb(ioaddr + i);
230 printk("%pM", dev->dev_addr);
232 /* Map the 8390 back into the window. */
233 outb(ECNTRL_THIN, ioaddr + 0x406);
235 /* Check for EL2/16 as described in tech. man. */
236 outb_p(E8390_PAGE0, ioaddr + E8390_CMD);
237 outb_p(0, ioaddr + EN0_DCFG);
238 outb_p(E8390_PAGE2, ioaddr + E8390_CMD);
239 wordlength = inb_p(ioaddr + EN0_DCFG) & ENDCFG_WTS;
240 outb_p(E8390_PAGE0, ioaddr + E8390_CMD);
242 /* Probe for, turn on and clear the board's shared memory. */
243 if (ei_debug > 2) printk(" memory jumpers %2.2x ", membase_reg);
244 outb(EGACFR_NORM, ioaddr + 0x405); /* Enable RAM */
246 /* This should be probed for (or set via an ioctl()) at run-time.
247 Right now we use a sleazy hack to pass in the interface number
248 at boot-time via the low bits of the mem_end field. That value is
249 unused, and the low bits would be discarded even if it was used. */
250 #if defined(EI8390_THICK) || defined(EL2_AUI)
251 ei_status.interface_num = 1;
253 ei_status.interface_num = dev->mem_end & 0xf;
255 printk(", using %sternal xcvr.\n", ei_status.interface_num == 0 ? "in" : "ex");
257 if ((membase_reg & 0xf0) == 0) {
259 ei_status.name = "3c503-PIO";
260 ei_status.mem = NULL;
262 dev->mem_start = ((membase_reg & 0xc0) ? 0xD8000 : 0xC8000) +
263 ((membase_reg & 0xA0) ? 0x4000 : 0);
264 #define EL2_MEMSIZE (EL2_MB1_STOP_PG - EL2_MB1_START_PG)*256
265 ei_status.mem = ioremap(dev->mem_start, EL2_MEMSIZE);
268 /* This has never found an error, but someone might care.
269 Note that it only tests the 2nd 8kB on 16kB 3c503/16
270 cards between card addr. 0x2000 and 0x3fff. */
271 { /* Check the card's memory. */
272 void __iomem *mem_base = ei_status.mem;
273 unsigned int test_val = 0xbbadf00d;
274 writel(0xba5eba5e, mem_base);
275 for (i = sizeof(test_val); i < EL2_MEMSIZE; i+=sizeof(test_val)) {
276 writel(test_val, mem_base + i);
277 if (readl(mem_base) != 0xba5eba5e
278 || readl(mem_base + i) != test_val) {
279 printk("3c503: memory failure or memory address conflict.\n");
281 ei_status.name = "3c503-PIO";
283 ei_status.mem = NULL;
286 test_val += 0x55555555;
287 writel(0, mem_base + i);
290 #endif /* EL2MEMTEST */
293 dev->mem_end = dev->mem_start + EL2_MEMSIZE;
295 if (wordlength) { /* No Tx pages to skip over to get to Rx */
297 ei_status.name = "3c503/16";
299 ei_status.priv = TX_PAGES * 256;
300 ei_status.name = "3c503";
305 Divide up the memory on the card. This is the same regardless of
306 whether shared-mem or PIO is used. For 16 bit cards (16kB RAM),
307 we use the entire 8k of bank1 for an Rx ring. We only use 3k
308 of the bank0 for 2 full size Tx packet slots. For 8 bit cards,
309 (8kB RAM) we use 3kB of bank1 for two Tx slots, and the remaining
310 5kB for an Rx ring. */
313 ei_status.tx_start_page = EL2_MB0_START_PG;
314 ei_status.rx_start_page = EL2_MB1_START_PG;
316 ei_status.tx_start_page = EL2_MB1_START_PG;
317 ei_status.rx_start_page = EL2_MB1_START_PG + TX_PAGES;
320 /* Finish setting the board's parameters. */
321 ei_status.stop_page = EL2_MB1_STOP_PG;
322 ei_status.word16 = wordlength;
323 ei_status.reset_8390 = &el2_reset_8390;
324 ei_status.get_8390_hdr = &el2_get_8390_hdr;
325 ei_status.block_input = &el2_block_input;
326 ei_status.block_output = &el2_block_output;
330 else if (dev->irq > 5 && dev->irq != 9) {
331 printk("3c503: configured interrupt %d invalid, will use autoIRQ.\n",
336 ei_status.saved_irq = dev->irq;
338 dev->open = &el2_open;
339 dev->stop = &el2_close;
340 dev->ethtool_ops = &netdev_ethtool_ops;
341 #ifdef CONFIG_NET_POLL_CONTROLLER
342 dev->poll_controller = eip_poll;
345 retval = register_netdev(dev);
350 printk("%s: %s - %dkB RAM, 8kB shared mem window at %#6lx-%#6lx.\n",
351 dev->name, ei_status.name, (wordlength+1)<<3,
352 dev->mem_start, dev->mem_end-1);
356 ei_status.tx_start_page = EL2_MB1_START_PG;
357 ei_status.rx_start_page = EL2_MB1_START_PG + TX_PAGES;
358 printk("\n%s: %s, %dkB RAM, using programmed I/O (REJUMPER for SHARED MEMORY).\n",
359 dev->name, ei_status.name, (wordlength+1)<<3);
361 release_region(ioaddr + 0x400, 8);
364 release_region(ioaddr + 0x400, 8);
366 release_region(ioaddr, EL2_IO_EXTENT);
371 el2_open(struct net_device *dev)
373 int retval = -EAGAIN;
376 int irqlist[] = {5, 9, 3, 4, 0};
379 outb(EGACFR_NORM, E33G_GACFR); /* Enable RAM and interrupts. */
381 if (request_irq (*irqp, NULL, 0, "bogus", dev) != -EBUSY) {
382 /* Twinkle the interrupt, and check if it's seen. */
383 unsigned long cookie = probe_irq_on();
384 outb_p(0x04 << ((*irqp == 9) ? 2 : *irqp), E33G_IDCFR);
385 outb_p(0x00, E33G_IDCFR);
386 if (*irqp == probe_irq_off(cookie) /* It's a good IRQ line! */
387 && ((retval = request_irq(dev->irq = *irqp,
388 eip_interrupt, 0, dev->name, dev)) == 0))
393 outb(EGACFR_IRQOFF, E33G_GACFR); /* disable interrupts. */
397 if ((retval = request_irq(dev->irq, eip_interrupt, 0, dev->name, dev))) {
408 el2_close(struct net_device *dev)
410 free_irq(dev->irq, dev);
411 dev->irq = ei_status.saved_irq;
412 outb(EGACFR_IRQOFF, E33G_GACFR); /* disable interrupts. */
418 /* This is called whenever we have a unrecoverable failure:
420 Bad ring buffer packet header
423 el2_reset_8390(struct net_device *dev)
426 printk("%s: Resetting the 3c503 board...", dev->name);
427 printk("%#lx=%#02x %#lx=%#02x %#lx=%#02x...", E33G_IDCFR, inb(E33G_IDCFR),
428 E33G_CNTRL, inb(E33G_CNTRL), E33G_GACFR, inb(E33G_GACFR));
430 outb_p(ECNTRL_RESET|ECNTRL_THIN, E33G_CNTRL);
432 outb_p(ei_status.interface_num==0 ? ECNTRL_THIN : ECNTRL_AUI, E33G_CNTRL);
434 if (ei_debug > 1) printk("done\n");
437 /* Initialize the 3c503 GA registers after a reset. */
439 el2_init_card(struct net_device *dev)
441 /* Unmap the station PROM and select the DIX or BNC connector. */
442 outb_p(ei_status.interface_num==0 ? ECNTRL_THIN : ECNTRL_AUI, E33G_CNTRL);
444 /* Set ASIC copy of rx's first and last+1 buffer pages */
445 /* These must be the same as in the 8390. */
446 outb(ei_status.rx_start_page, E33G_STARTPG);
447 outb(ei_status.stop_page, E33G_STOPPG);
449 /* Point the vector pointer registers somewhere ?harmless?. */
450 outb(0xff, E33G_VP2); /* Point at the ROM restart location 0xffff0 */
451 outb(0xff, E33G_VP1);
452 outb(0x00, E33G_VP0);
453 /* Turn off all interrupts until we're opened. */
454 outb_p(0x00, dev->base_addr + EN0_IMR);
455 /* Enable IRQs iff started. */
456 outb(EGACFR_NORM, E33G_GACFR);
458 /* Set the interrupt line. */
459 outb_p((0x04 << (dev->irq == 9 ? 2 : dev->irq)), E33G_IDCFR);
460 outb_p((WRD_COUNT << 1), E33G_DRQCNT); /* Set burst size to 8 */
461 outb_p(0x20, E33G_DMAAH); /* Put a valid addr in the GA DMA */
462 outb_p(0x00, E33G_DMAAL);
463 return; /* We always succeed */
467 * Either use the shared memory (if enabled on the board) or put the packet
468 * out through the ASIC FIFO.
471 el2_block_output(struct net_device *dev, int count,
472 const unsigned char *buf, int start_page)
474 unsigned short int *wrd;
475 int boguscount; /* timeout counter */
476 unsigned short word; /* temporary for better machine code */
477 void __iomem *base = ei_status.mem;
479 if (ei_status.word16) /* Tx packets go into bank 0 on EL2/16 card */
480 outb(EGACFR_RSEL|EGACFR_TCM, E33G_GACFR);
482 outb(EGACFR_NORM, E33G_GACFR);
484 if (base) { /* Shared memory transfer */
485 memcpy_toio(base + ((start_page - ei_status.tx_start_page) << 8),
487 outb(EGACFR_NORM, E33G_GACFR); /* Back to bank1 in case on bank0 */
492 * No shared memory, put the packet out the other way.
493 * Set up then start the internal memory transfer to Tx Start Page
496 word = (unsigned short)start_page;
497 outb(word&0xFF, E33G_DMAAH);
498 outb(word>>8, E33G_DMAAL);
500 outb_p((ei_status.interface_num ? ECNTRL_AUI : ECNTRL_THIN ) | ECNTRL_OUTPUT
501 | ECNTRL_START, E33G_CNTRL);
504 * Here I am going to write data to the FIFO as quickly as possible.
505 * Note that E33G_FIFOH is defined incorrectly. It is really
506 * E33G_FIFOL, the lowest port address for both the byte and
507 * word write. Variable 'count' is NOT checked. Caller must supply a
508 * valid count. Note that I may write a harmless extra byte to the
509 * 8390 if the byte-count was not even.
511 wrd = (unsigned short int *) buf;
512 count = (count + 1) >> 1;
516 while ((inb(E33G_STATUS) & ESTAT_DPRDY) == 0)
520 printk("%s: FIFO blocked in el2_block_output.\n", dev->name);
525 if(count > WRD_COUNT)
527 outsw(E33G_FIFOH, wrd, WRD_COUNT);
533 outsw(E33G_FIFOH, wrd, count);
538 outb_p(ei_status.interface_num==0 ? ECNTRL_THIN : ECNTRL_AUI, E33G_CNTRL);
542 /* Read the 4 byte, page aligned 8390 specific header. */
544 el2_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
547 void __iomem *base = ei_status.mem;
550 if (base) { /* Use the shared memory. */
551 void __iomem *hdr_start = base + ((ring_page - EL2_MB1_START_PG)<<8);
552 memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
553 hdr->count = le16_to_cpu(hdr->count);
558 * No shared memory, use programmed I/O.
561 word = (unsigned short)ring_page;
562 outb(word&0xFF, E33G_DMAAH);
563 outb(word>>8, E33G_DMAAL);
565 outb_p((ei_status.interface_num == 0 ? ECNTRL_THIN : ECNTRL_AUI) | ECNTRL_INPUT
566 | ECNTRL_START, E33G_CNTRL);
568 while ((inb(E33G_STATUS) & ESTAT_DPRDY) == 0)
572 printk("%s: FIFO blocked in el2_get_8390_hdr.\n", dev->name);
573 memset(hdr, 0x00, sizeof(struct e8390_pkt_hdr));
578 insw(E33G_FIFOH, hdr, (sizeof(struct e8390_pkt_hdr))>> 1);
580 outb_p(ei_status.interface_num == 0 ? ECNTRL_THIN : ECNTRL_AUI, E33G_CNTRL);
585 el2_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
588 void __iomem *base = ei_status.mem;
589 unsigned short int *buf;
592 /* Maybe enable shared memory just be to be safe... nahh.*/
593 if (base) { /* Use the shared memory. */
594 ring_offset -= (EL2_MB1_START_PG<<8);
595 if (ring_offset + count > EL2_MEMSIZE) {
596 /* We must wrap the input move. */
597 int semi_count = EL2_MEMSIZE - ring_offset;
598 memcpy_fromio(skb->data, base + ring_offset, semi_count);
600 memcpy_fromio(skb->data + semi_count, base + ei_status.priv, count);
602 memcpy_fromio(skb->data, base + ring_offset, count);
608 * No shared memory, use programmed I/O.
610 word = (unsigned short) ring_offset;
611 outb(word>>8, E33G_DMAAH);
612 outb(word&0xFF, E33G_DMAAL);
614 outb_p((ei_status.interface_num == 0 ? ECNTRL_THIN : ECNTRL_AUI) | ECNTRL_INPUT
615 | ECNTRL_START, E33G_CNTRL);
618 * Here I also try to get data as fast as possible. I am betting that I
619 * can read one extra byte without clobbering anything in the kernel because
620 * this would only occur on an odd byte-count and allocation of skb->data
621 * is word-aligned. Variable 'count' is NOT checked. Caller must check
623 * [This is currently quite safe.... but if one day the 3c503 explodes
624 * you know where to come looking ;)]
627 buf = (unsigned short int *) skb->data;
628 count = (count + 1) >> 1;
632 while ((inb(E33G_STATUS) & ESTAT_DPRDY) == 0)
636 printk("%s: FIFO blocked in el2_block_input.\n", dev->name);
641 if(count > WRD_COUNT)
643 insw(E33G_FIFOH, buf, WRD_COUNT);
649 insw(E33G_FIFOH, buf, count);
654 outb_p(ei_status.interface_num == 0 ? ECNTRL_THIN : ECNTRL_AUI, E33G_CNTRL);
659 static void netdev_get_drvinfo(struct net_device *dev,
660 struct ethtool_drvinfo *info)
662 strcpy(info->driver, DRV_NAME);
663 strcpy(info->version, DRV_VERSION);
664 sprintf(info->bus_info, "ISA 0x%lx", dev->base_addr);
667 static const struct ethtool_ops netdev_ethtool_ops = {
668 .get_drvinfo = netdev_get_drvinfo,
672 #define MAX_EL2_CARDS 4 /* Max number of EL2 cards per module */
674 static struct net_device *dev_el2[MAX_EL2_CARDS];
675 static int io[MAX_EL2_CARDS];
676 static int irq[MAX_EL2_CARDS];
677 static int xcvr[MAX_EL2_CARDS]; /* choose int. or ext. xcvr */
678 module_param_array(io, int, NULL, 0);
679 module_param_array(irq, int, NULL, 0);
680 module_param_array(xcvr, int, NULL, 0);
681 MODULE_PARM_DESC(io, "I/O base address(es)");
682 MODULE_PARM_DESC(irq, "IRQ number(s) (assigned)");
683 MODULE_PARM_DESC(xcvr, "transceiver(s) (0=internal, 1=external)");
684 MODULE_DESCRIPTION("3Com ISA EtherLink II, II/16 (3c503, 3c503/16) driver");
685 MODULE_LICENSE("GPL");
687 /* This is set up so that only a single autoprobe takes place per call.
688 ISA device autoprobes on a running machine are not recommended. */
692 struct net_device *dev;
693 int this_dev, found = 0;
695 for (this_dev = 0; this_dev < MAX_EL2_CARDS; this_dev++) {
696 if (io[this_dev] == 0) {
697 if (this_dev != 0) break; /* only autoprobe 1st one */
698 printk(KERN_NOTICE "3c503.c: Presently autoprobing (not recommended) for a single card.\n");
700 dev = alloc_eip_netdev();
703 dev->irq = irq[this_dev];
704 dev->base_addr = io[this_dev];
705 dev->mem_end = xcvr[this_dev]; /* low 4bits = xcvr sel. */
706 if (do_el2_probe(dev) == 0) {
707 dev_el2[found++] = dev;
711 printk(KERN_WARNING "3c503.c: No 3c503 card found (i/o = 0x%x).\n", io[this_dev]);
719 static void cleanup_card(struct net_device *dev)
721 /* NB: el2_close() handles free_irq */
722 release_region(dev->base_addr, EL2_IO_EXTENT);
724 iounmap(ei_status.mem);
732 for (this_dev = 0; this_dev < MAX_EL2_CARDS; this_dev++) {
733 struct net_device *dev = dev_el2[this_dev];
735 unregister_netdev(dev);