1 /* ne-h8300.c: A NE2000 clone on H8/300 driver for linux. */
4 Written 1992-94 by Donald Becker.
6 Copyright 1993 United States Government as represented by the
7 Director, National Security Agency.
9 This software may be used and distributed according to the terms
10 of the GNU General Public License, incorporated herein by reference.
12 The author may be reached as becker@scyld.com, or C/O
13 Scyld Computing Corporation, 410 Severn Ave., Suite 210, Annapolis MD 21403
16 Yoshinori Sato <ysato@users.sourceforge.jp>
19 static const char version1[] =
20 "ne-h8300.c:v1.00 2004/04/11 ysato\n";
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/errno.h>
25 #include <linux/init.h>
26 #include <linux/interrupt.h>
27 #include <linux/delay.h>
28 #include <linux/netdevice.h>
29 #include <linux/etherdevice.h>
30 #include <linux/jiffies.h>
32 #include <asm/system.h>
36 #define EI_SHIFT(x) (ei_local->reg_offset[x])
40 #define DRV_NAME "ne-h8300"
42 /* Some defines that people can play with if so inclined. */
44 /* Do we perform extra sanity checks on stuff ? */
45 /* #define NE_SANITY_CHECK */
47 /* Do we implement the read before write bugfix ? */
48 /* #define NE_RW_BUGFIX */
50 /* Do we have a non std. amount of memory? (in units of 256 byte pages) */
51 /* #define PACKETBUF_MEMSIZE 0x40 */
53 /* A zero-terminated list of I/O addresses to be probed at boot. */
55 /* ---- No user-serviceable parts below ---- */
57 static const char version[] =
58 "8390.c:v1.10cvs 9/23/94 Donald Becker (becker@cesdis.gsfc.nasa.gov)\n";
62 #define NE_BASE (dev->base_addr)
64 #define NE_DATAPORT (ei_status.word16?0x20:0x10) /* NatSemi-defined port window offset. */
65 #define NE_RESET (ei_status.word16?0x3f:0x1f) /* Issue a read to reset, a write to clear. */
66 #define NE_IO_EXTENT (ei_status.word16?0x40:0x20)
68 #define NESM_START_PG 0x40 /* First page of TX buffer */
69 #define NESM_STOP_PG 0x80 /* Last page +1 of RX ring */
71 static int ne_probe1(struct net_device *dev, int ioaddr);
73 static int ne_open(struct net_device *dev);
74 static int ne_close(struct net_device *dev);
76 static void ne_reset_8390(struct net_device *dev);
77 static void ne_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
79 static void ne_block_input(struct net_device *dev, int count,
80 struct sk_buff *skb, int ring_offset);
81 static void ne_block_output(struct net_device *dev, const int count,
82 const unsigned char *buf, const int start_page);
85 static u32 reg_offset[16];
87 static int __init init_reg_offset(struct net_device *dev,unsigned long base_addr)
89 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
91 unsigned char bus_width;
93 bus_width = *(volatile unsigned char *)ABWCR;
94 bus_width &= 1 << ((base_addr >> 21) & 7);
96 for (i = 0; i < sizeof(reg_offset) / sizeof(u32); i++)
98 reg_offset[i] = i * 2 + 1;
102 ei_local->reg_offset = reg_offset;
106 static int __initdata h8300_ne_count = 0;
107 #ifdef CONFIG_H8300H_H8MAX
108 static unsigned long __initdata h8300_ne_base[] = { 0x800600 };
109 static int h8300_ne_irq[] = {EXT_IRQ4};
111 #ifdef CONFIG_H8300H_AKI3068NET
112 static unsigned long __initdata h8300_ne_base[] = { 0x200000 };
113 static int h8300_ne_irq[] = {EXT_IRQ5};
116 static inline int init_dev(struct net_device *dev)
118 if (h8300_ne_count < (sizeof(h8300_ne_base) / sizeof(unsigned long))) {
119 dev->base_addr = h8300_ne_base[h8300_ne_count];
120 dev->irq = h8300_ne_irq[h8300_ne_count];
127 /* Probe for various non-shared-memory ethercards.
129 NEx000-clone boards have a Station Address PROM (SAPROM) in the packet
130 buffer memory space. NE2000 clones have 0x57,0x57 in bytes 0x0e,0x0f of
131 the SAPROM, while other supposed NE2000 clones must be detected by their
134 Reading the SAPROM from a word-wide card with the 8390 set in byte-wide
135 mode results in doubled values, which can be detected and compensated for.
137 The probe is also responsible for initializing the card and filling
138 in the 'dev' and 'ei_status' structures.
140 We use the minimum memory size for some ethercard product lines, iff we can't
141 distinguish models. You can increase the packet buffer size by setting
142 PACKETBUF_MEMSIZE. Reported Cabletron packet buffer locations are:
143 E1010 starts at 0x100 and ends at 0x2000.
144 E1010-x starts at 0x100 and ends at 0x8000. ("-x" means "more memory")
145 E2010 starts at 0x100 and ends at 0x4000.
146 E2010-x starts at 0x100 and ends at 0xffff. */
148 static int __init do_ne_probe(struct net_device *dev)
150 unsigned int base_addr = dev->base_addr;
152 SET_MODULE_OWNER(dev);
154 /* First check any supplied i/o locations. User knows best. <cough> */
155 if (base_addr > 0x1ff) /* Check a single specified location. */
156 return ne_probe1(dev, base_addr);
157 else if (base_addr != 0) /* Don't probe at all. */
163 static void cleanup_card(struct net_device *dev)
165 free_irq(dev->irq, dev);
166 release_region(dev->base_addr, NE_IO_EXTENT);
170 struct net_device * __init ne_probe(int unit)
172 struct net_device *dev = ____alloc_ei_netdev(0);
176 return ERR_PTR(-ENOMEM);
179 return ERR_PTR(-ENODEV);
181 sprintf(dev->name, "eth%d", unit);
182 netdev_boot_setup_check(dev);
184 err = init_reg_offset(dev, dev->base_addr);
188 err = do_ne_probe(dev);
198 static int __init ne_probe1(struct net_device *dev, int ioaddr)
201 unsigned char SA_prom[16];
203 const char *name = NULL;
204 int start_page, stop_page;
206 static unsigned version_printed;
207 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
208 unsigned char bus_width;
210 if (!request_region(ioaddr, NE_IO_EXTENT, DRV_NAME))
213 reg0 = inb_p(ioaddr);
219 /* Do a preliminary verification that we have a 8390. */
222 outb_p(E8390_NODMA+E8390_PAGE1+E8390_STOP, ioaddr + E8390_CMD);
223 regd = inb_p(ioaddr + EI_SHIFT(0x0d));
224 outb_p(0xff, ioaddr + EI_SHIFT(0x0d));
225 outb_p(E8390_NODMA+E8390_PAGE0, ioaddr + E8390_CMD);
226 inb_p(ioaddr + EN0_COUNTER0); /* Clear the counter by reading. */
227 if (inb_p(ioaddr + EN0_COUNTER0) != 0) {
228 outb_p(reg0, ioaddr + EI_SHIFT(0));
229 outb_p(regd, ioaddr + EI_SHIFT(0x0d)); /* Restore the old values. */
235 if (ei_debug && version_printed++ == 0)
236 printk(KERN_INFO "%s", version1);
238 printk(KERN_INFO "NE*000 ethercard probe at %08x:", ioaddr);
240 /* Read the 16 bytes of station address PROM.
241 We must first initialize registers, similar to NS8390_init(eifdev, 0).
242 We can't reliably read the SAPROM address without this.
243 (I learned the hard way!). */
245 struct {unsigned char value, offset; } program_seq[] =
247 {E8390_NODMA+E8390_PAGE0+E8390_STOP, E8390_CMD}, /* Select page 0*/
248 {0x48, EN0_DCFG}, /* Set byte-wide (0x48) access. */
249 {0x00, EN0_RCNTLO}, /* Clear the count regs. */
251 {0x00, EN0_IMR}, /* Mask completion irq. */
253 {E8390_RXOFF, EN0_RXCR}, /* 0x20 Set to monitor */
254 {E8390_TXOFF, EN0_TXCR}, /* 0x02 and loopback mode. */
257 {0x00, EN0_RSARLO}, /* DMA starting at 0x0000. */
259 {E8390_RREAD+E8390_START, E8390_CMD},
262 for (i = 0; i < sizeof(program_seq)/sizeof(program_seq[0]); i++)
263 outb_p(program_seq[i].value, ioaddr + program_seq[i].offset);
266 bus_width = *(volatile unsigned char *)ABWCR;
267 bus_width &= 1 << ((ioaddr >> 21) & 7);
268 ei_status.word16 = (bus_width == 0); /* temporary setting */
269 for(i = 0; i < 16 /*sizeof(SA_prom)*/; i++) {
270 SA_prom[i] = inb_p(ioaddr + NE_DATAPORT);
271 inb_p(ioaddr + NE_DATAPORT); /* dummy read */
274 start_page = NESM_START_PG;
275 stop_page = NESM_STOP_PG;
280 outb_p(0x49, ioaddr + EN0_DCFG);
282 /* Set up the rest of the parameters. */
283 name = (wordlength == 2) ? "NE2000" : "NE1000";
286 printk(" failed to detect IRQ line.\n");
291 /* Snarf the interrupt now. There's no point in waiting since we cannot
292 share and the board will usually be enabled. */
293 ret = request_irq(dev->irq, __ei_interrupt, 0, name, dev);
295 printk (" unable to get IRQ %d (errno=%d).\n", dev->irq, ret);
299 dev->base_addr = ioaddr;
301 for(i = 0; i < ETHER_ADDR_LEN; i++) {
302 printk(" %2.2x", SA_prom[i]);
303 dev->dev_addr[i] = SA_prom[i];
306 printk("\n%s: %s found at %#x, using IRQ %d.\n",
307 dev->name, name, ioaddr, dev->irq);
309 ei_status.name = name;
310 ei_status.tx_start_page = start_page;
311 ei_status.stop_page = stop_page;
312 ei_status.word16 = (wordlength == 2);
314 ei_status.rx_start_page = start_page + TX_PAGES;
315 #ifdef PACKETBUF_MEMSIZE
316 /* Allow the packet buffer size to be overridden by know-it-alls. */
317 ei_status.stop_page = ei_status.tx_start_page + PACKETBUF_MEMSIZE;
320 ei_status.reset_8390 = &ne_reset_8390;
321 ei_status.block_input = &ne_block_input;
322 ei_status.block_output = &ne_block_output;
323 ei_status.get_8390_hdr = &ne_get_8390_hdr;
325 dev->open = &ne_open;
326 dev->stop = &ne_close;
327 #ifdef CONFIG_NET_POLL_CONTROLLER
328 dev->poll_controller = __ei_poll;
330 __NS8390_init(dev, 0);
332 ret = register_netdev(dev);
337 free_irq(dev->irq, dev);
339 release_region(ioaddr, NE_IO_EXTENT);
343 static int ne_open(struct net_device *dev)
349 static int ne_close(struct net_device *dev)
352 printk(KERN_DEBUG "%s: Shutting down ethercard.\n", dev->name);
357 /* Hard reset the card. This used to pause for the same period that a
358 8390 reset command required, but that shouldn't be necessary. */
360 static void ne_reset_8390(struct net_device *dev)
362 unsigned long reset_start_time = jiffies;
363 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
366 printk(KERN_DEBUG "resetting the 8390 t=%ld...", jiffies);
368 /* DON'T change these to inb_p/outb_p or reset will fail on clones. */
369 outb(inb(NE_BASE + NE_RESET), NE_BASE + NE_RESET);
372 ei_status.dmaing = 0;
374 /* This check _should_not_ be necessary, omit eventually. */
375 while ((inb_p(NE_BASE+EN0_ISR) & ENISR_RESET) == 0)
376 if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
377 printk(KERN_WARNING "%s: ne_reset_8390() did not complete.\n", dev->name);
380 outb_p(ENISR_RESET, NE_BASE + EN0_ISR); /* Ack intr. */
383 /* Grab the 8390 specific header. Similar to the block_input routine, but
384 we don't need to be concerned with ring wrap as the header will be at
385 the start of a page, so we optimize accordingly. */
387 static void ne_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
389 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
390 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
392 if (ei_status.dmaing)
394 printk(KERN_EMERG "%s: DMAing conflict in ne_get_8390_hdr "
395 "[DMAstat:%d][irqlock:%d].\n",
396 dev->name, ei_status.dmaing, ei_status.irqlock);
400 ei_status.dmaing |= 0x01;
401 outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, NE_BASE + NE_CMD);
402 outb_p(sizeof(struct e8390_pkt_hdr), NE_BASE + EN0_RCNTLO);
403 outb_p(0, NE_BASE + EN0_RCNTHI);
404 outb_p(0, NE_BASE + EN0_RSARLO); /* On page boundary */
405 outb_p(ring_page, NE_BASE + EN0_RSARHI);
406 outb_p(E8390_RREAD+E8390_START, NE_BASE + NE_CMD);
408 if (ei_status.word16) {
410 unsigned short *p = (unsigned short *)hdr;
411 for (len = sizeof(struct e8390_pkt_hdr)>>1; len > 0; len--)
412 *p++ = inw(NE_BASE + NE_DATAPORT);
414 insb(NE_BASE + NE_DATAPORT, hdr, sizeof(struct e8390_pkt_hdr));
416 outb_p(ENISR_RDC, NE_BASE + EN0_ISR); /* Ack intr. */
417 ei_status.dmaing &= ~0x01;
419 le16_to_cpus(&hdr->count);
422 /* Block input and output, similar to the Crynwr packet driver. If you
423 are porting to a new ethercard, look at the packet driver source for hints.
424 The NEx000 doesn't share the on-board packet memory -- you have to put
425 the packet out through the "remote DMA" dataport using outb. */
427 static void ne_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
429 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
430 #ifdef NE_SANITY_CHECK
431 int xfer_count = count;
433 char *buf = skb->data;
435 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
436 if (ei_status.dmaing)
438 printk(KERN_EMERG "%s: DMAing conflict in ne_block_input "
439 "[DMAstat:%d][irqlock:%d].\n",
440 dev->name, ei_status.dmaing, ei_status.irqlock);
443 ei_status.dmaing |= 0x01;
444 outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, NE_BASE + NE_CMD);
445 outb_p(count & 0xff, NE_BASE + EN0_RCNTLO);
446 outb_p(count >> 8, NE_BASE + EN0_RCNTHI);
447 outb_p(ring_offset & 0xff, NE_BASE + EN0_RSARLO);
448 outb_p(ring_offset >> 8, NE_BASE + EN0_RSARHI);
449 outb_p(E8390_RREAD+E8390_START, NE_BASE + NE_CMD);
450 if (ei_status.word16)
453 unsigned short *p = (unsigned short *)buf;
454 for (len = count>>1; len > 0; len--)
455 *p++ = inw(NE_BASE + NE_DATAPORT);
458 buf[count-1] = inb(NE_BASE + NE_DATAPORT);
459 #ifdef NE_SANITY_CHECK
464 insb(NE_BASE + NE_DATAPORT, buf, count);
467 #ifdef NE_SANITY_CHECK
468 /* This was for the ALPHA version only, but enough people have
469 been encountering problems so it is still here. If you see
470 this message you either 1) have a slightly incompatible clone
471 or 2) have noise/speed problems with your bus. */
475 /* DMA termination address check... */
476 int addr, tries = 20;
478 /* DON'T check for 'inb_p(EN0_ISR) & ENISR_RDC' here
479 -- it's broken for Rx on some cards! */
480 int high = inb_p(NE_BASE + EN0_RSARHI);
481 int low = inb_p(NE_BASE + EN0_RSARLO);
482 addr = (high << 8) + low;
483 if (((ring_offset + xfer_count) & 0xff) == low)
485 } while (--tries > 0);
487 printk(KERN_WARNING "%s: RX transfer address mismatch,"
488 "%#4.4x (expected) vs. %#4.4x (actual).\n",
489 dev->name, ring_offset + xfer_count, addr);
492 outb_p(ENISR_RDC, NE_BASE + EN0_ISR); /* Ack intr. */
493 ei_status.dmaing &= ~0x01;
496 static void ne_block_output(struct net_device *dev, int count,
497 const unsigned char *buf, const int start_page)
499 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
500 unsigned long dma_start;
501 #ifdef NE_SANITY_CHECK
505 /* Round the count up for word writes. Do we need to do this?
506 What effect will an odd byte count have on the 8390?
507 I should check someday. */
509 if (ei_status.word16 && (count & 0x01))
512 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
513 if (ei_status.dmaing)
515 printk(KERN_EMERG "%s: DMAing conflict in ne_block_output."
516 "[DMAstat:%d][irqlock:%d]\n",
517 dev->name, ei_status.dmaing, ei_status.irqlock);
520 ei_status.dmaing |= 0x01;
521 /* We should already be in page 0, but to be safe... */
522 outb_p(E8390_PAGE0+E8390_START+E8390_NODMA, NE_BASE + NE_CMD);
524 #ifdef NE_SANITY_CHECK
528 #ifdef NE8390_RW_BUGFIX
529 /* Handle the read-before-write bug the same way as the
530 Crynwr packet driver -- the NatSemi method doesn't work.
531 Actually this doesn't always work either, but if you have
532 problems with your NEx000 this is better than nothing! */
534 outb_p(0x42, NE_BASE + EN0_RCNTLO);
535 outb_p(0x00, NE_BASE + EN0_RCNTHI);
536 outb_p(0x42, NE_BASE + EN0_RSARLO);
537 outb_p(0x00, NE_BASE + EN0_RSARHI);
538 outb_p(E8390_RREAD+E8390_START, NE_BASE + NE_CMD);
539 /* Make certain that the dummy read has occurred. */
543 outb_p(ENISR_RDC, NE_BASE + EN0_ISR);
545 /* Now the normal output. */
546 outb_p(count & 0xff, NE_BASE + EN0_RCNTLO);
547 outb_p(count >> 8, NE_BASE + EN0_RCNTHI);
548 outb_p(0x00, NE_BASE + EN0_RSARLO);
549 outb_p(start_page, NE_BASE + EN0_RSARHI);
551 outb_p(E8390_RWRITE+E8390_START, NE_BASE + NE_CMD);
552 if (ei_status.word16) {
554 unsigned short *p = (unsigned short *)buf;
555 for (len = count>>1; len > 0; len--)
556 outw(*p++, NE_BASE + NE_DATAPORT);
558 outsb(NE_BASE + NE_DATAPORT, buf, count);
563 #ifdef NE_SANITY_CHECK
564 /* This was for the ALPHA version only, but enough people have
565 been encountering problems so it is still here. */
569 /* DMA termination address check... */
570 int addr, tries = 20;
572 int high = inb_p(NE_BASE + EN0_RSARHI);
573 int low = inb_p(NE_BASE + EN0_RSARLO);
574 addr = (high << 8) + low;
575 if ((start_page << 8) + count == addr)
577 } while (--tries > 0);
581 printk(KERN_WARNING "%s: Tx packet transfer address mismatch,"
582 "%#4.4x (expected) vs. %#4.4x (actual).\n",
583 dev->name, (start_page << 8) + count, addr);
590 while ((inb_p(NE_BASE + EN0_ISR) & ENISR_RDC) == 0)
591 if (time_after(jiffies, dma_start + 2*HZ/100)) { /* 20ms */
592 printk(KERN_WARNING "%s: timeout waiting for Tx RDC.\n", dev->name);
594 __NS8390_init(dev,1);
598 outb_p(ENISR_RDC, NE_BASE + EN0_ISR); /* Ack intr. */
599 ei_status.dmaing &= ~0x01;
605 #define MAX_NE_CARDS 1 /* Max number of NE cards per module */
606 static struct net_device *dev_ne[MAX_NE_CARDS];
607 static int io[MAX_NE_CARDS];
608 static int irq[MAX_NE_CARDS];
609 static int bad[MAX_NE_CARDS]; /* 0xbad = bad sig or no reset ack */
611 module_param_array(io, int, NULL, 0);
612 module_param_array(irq, int, NULL, 0);
613 module_param_array(bad, int, NULL, 0);
614 MODULE_PARM_DESC(io, "I/O base address(es)");
615 MODULE_PARM_DESC(irq, "IRQ number(s)");
616 MODULE_DESCRIPTION("H8/300 NE2000 Ethernet driver");
617 MODULE_LICENSE("GPL");
619 /* This is set up so that no ISA autoprobe takes place. We can't guarantee
620 that the ne2k probe is the last 8390 based probe to take place (as it
621 is at boot) and so the probe will get confused by any other 8390 cards.
622 ISA device autoprobes on a running machine are not recommended anyway. */
624 int init_module(void)
626 int this_dev, found = 0;
629 for (this_dev = 0; this_dev < MAX_NE_CARDS; this_dev++) {
630 struct net_device *dev = ____alloc_ei_netdev(0);
634 dev->irq = irq[this_dev];
635 dev->mem_end = bad[this_dev];
636 dev->base_addr = io[this_dev];
638 dev->base_addr = h8300_ne_base[this_dev];
639 dev->irq = h8300_ne_irq[this_dev];
641 err = init_reg_offset(dev, dev->base_addr);
643 if (do_ne_probe(dev) == 0) {
644 dev_ne[found++] = dev;
651 if (io[this_dev] != 0)
652 printk(KERN_WARNING "ne.c: No NE*000 card found at i/o = %#x\n", dev->base_addr);
654 printk(KERN_NOTICE "ne.c: You must supply \"io=0xNNN\" value(s) for ISA cards.\n");
662 void cleanup_module(void)
666 for (this_dev = 0; this_dev < MAX_NE_CARDS; this_dev++) {
667 struct net_device *dev = dev_ne[this_dev];
669 unregister_netdev(dev);