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 < ARRAY_SIZE(reg_offset); 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 < ARRAY_SIZE(h8300_ne_base)) {
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 /* First check any supplied i/o locations. User knows best. <cough> */
153 if (base_addr > 0x1ff) /* Check a single specified location. */
154 return ne_probe1(dev, base_addr);
155 else if (base_addr != 0) /* Don't probe at all. */
161 static void cleanup_card(struct net_device *dev)
163 free_irq(dev->irq, dev);
164 release_region(dev->base_addr, NE_IO_EXTENT);
168 struct net_device * __init ne_probe(int unit)
170 struct net_device *dev = alloc_ei_netdev();
174 return ERR_PTR(-ENOMEM);
177 return ERR_PTR(-ENODEV);
179 sprintf(dev->name, "eth%d", unit);
180 netdev_boot_setup_check(dev);
182 err = init_reg_offset(dev, dev->base_addr);
186 err = do_ne_probe(dev);
196 static const struct net_device_ops ne_netdev_ops = {
198 .ndo_stop = ne_close,
200 .ndo_start_xmit = ei_start_xmit,
201 .ndo_tx_timeout = ei_tx_timeout,
202 .ndo_get_stats = ei_get_stats,
203 .ndo_set_multicast_list = ei_set_multicast_list,
204 .ndo_validate_addr = eth_validate_addr,
205 .ndo_change_mtu = eth_change_mtu,
206 #ifdef CONFIG_NET_POLL_CONTROLLER
207 .ndo_poll_controller = ei_poll,
211 static int __init ne_probe1(struct net_device *dev, int ioaddr)
214 unsigned char SA_prom[16];
216 const char *name = NULL;
217 int start_page, stop_page;
219 static unsigned version_printed;
220 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
221 unsigned char bus_width;
223 if (!request_region(ioaddr, NE_IO_EXTENT, DRV_NAME))
226 reg0 = inb_p(ioaddr);
232 /* Do a preliminary verification that we have a 8390. */
235 outb_p(E8390_NODMA+E8390_PAGE1+E8390_STOP, ioaddr + E8390_CMD);
236 regd = inb_p(ioaddr + EI_SHIFT(0x0d));
237 outb_p(0xff, ioaddr + EI_SHIFT(0x0d));
238 outb_p(E8390_NODMA+E8390_PAGE0, ioaddr + E8390_CMD);
239 inb_p(ioaddr + EN0_COUNTER0); /* Clear the counter by reading. */
240 if (inb_p(ioaddr + EN0_COUNTER0) != 0) {
241 outb_p(reg0, ioaddr + EI_SHIFT(0));
242 outb_p(regd, ioaddr + EI_SHIFT(0x0d)); /* Restore the old values. */
248 if (ei_debug && version_printed++ == 0)
249 printk(KERN_INFO "%s", version1);
251 printk(KERN_INFO "NE*000 ethercard probe at %08x:", ioaddr);
253 /* Read the 16 bytes of station address PROM.
254 We must first initialize registers, similar to NS8390_init(eifdev, 0).
255 We can't reliably read the SAPROM address without this.
256 (I learned the hard way!). */
258 struct {unsigned char value, offset; } program_seq[] =
260 {E8390_NODMA+E8390_PAGE0+E8390_STOP, E8390_CMD}, /* Select page 0*/
261 {0x48, EN0_DCFG}, /* Set byte-wide (0x48) access. */
262 {0x00, EN0_RCNTLO}, /* Clear the count regs. */
264 {0x00, EN0_IMR}, /* Mask completion irq. */
266 {E8390_RXOFF, EN0_RXCR}, /* 0x20 Set to monitor */
267 {E8390_TXOFF, EN0_TXCR}, /* 0x02 and loopback mode. */
270 {0x00, EN0_RSARLO}, /* DMA starting at 0x0000. */
272 {E8390_RREAD+E8390_START, E8390_CMD},
275 for (i = 0; i < ARRAY_SIZE(program_seq); i++)
276 outb_p(program_seq[i].value, ioaddr + program_seq[i].offset);
279 bus_width = *(volatile unsigned char *)ABWCR;
280 bus_width &= 1 << ((ioaddr >> 21) & 7);
281 ei_status.word16 = (bus_width == 0); /* temporary setting */
282 for(i = 0; i < 16 /*sizeof(SA_prom)*/; i++) {
283 SA_prom[i] = inb_p(ioaddr + NE_DATAPORT);
284 inb_p(ioaddr + NE_DATAPORT); /* dummy read */
287 start_page = NESM_START_PG;
288 stop_page = NESM_STOP_PG;
293 outb_p(0x49, ioaddr + EN0_DCFG);
295 /* Set up the rest of the parameters. */
296 name = (wordlength == 2) ? "NE2000" : "NE1000";
299 printk(" failed to detect IRQ line.\n");
304 /* Snarf the interrupt now. There's no point in waiting since we cannot
305 share and the board will usually be enabled. */
306 ret = request_irq(dev->irq, __ei_interrupt, 0, name, dev);
308 printk (" unable to get IRQ %d (errno=%d).\n", dev->irq, ret);
312 dev->base_addr = ioaddr;
314 for(i = 0; i < ETHER_ADDR_LEN; i++)
315 dev->dev_addr[i] = SA_prom[i];
316 printk(" %pM\n", dev->dev_addr);
318 printk("%s: %s found at %#x, using IRQ %d.\n",
319 dev->name, name, ioaddr, dev->irq);
321 ei_status.name = name;
322 ei_status.tx_start_page = start_page;
323 ei_status.stop_page = stop_page;
324 ei_status.word16 = (wordlength == 2);
326 ei_status.rx_start_page = start_page + TX_PAGES;
327 #ifdef PACKETBUF_MEMSIZE
328 /* Allow the packet buffer size to be overridden by know-it-alls. */
329 ei_status.stop_page = ei_status.tx_start_page + PACKETBUF_MEMSIZE;
332 ei_status.reset_8390 = &ne_reset_8390;
333 ei_status.block_input = &ne_block_input;
334 ei_status.block_output = &ne_block_output;
335 ei_status.get_8390_hdr = &ne_get_8390_hdr;
338 dev->netdev_ops = &ne_netdev_ops;
340 __NS8390_init(dev, 0);
342 ret = register_netdev(dev);
347 free_irq(dev->irq, dev);
349 release_region(ioaddr, NE_IO_EXTENT);
353 static int ne_open(struct net_device *dev)
359 static int ne_close(struct net_device *dev)
362 printk(KERN_DEBUG "%s: Shutting down ethercard.\n", dev->name);
367 /* Hard reset the card. This used to pause for the same period that a
368 8390 reset command required, but that shouldn't be necessary. */
370 static void ne_reset_8390(struct net_device *dev)
372 unsigned long reset_start_time = jiffies;
373 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
376 printk(KERN_DEBUG "resetting the 8390 t=%ld...", jiffies);
378 /* DON'T change these to inb_p/outb_p or reset will fail on clones. */
379 outb(inb(NE_BASE + NE_RESET), NE_BASE + NE_RESET);
382 ei_status.dmaing = 0;
384 /* This check _should_not_ be necessary, omit eventually. */
385 while ((inb_p(NE_BASE+EN0_ISR) & ENISR_RESET) == 0)
386 if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
387 printk(KERN_WARNING "%s: ne_reset_8390() did not complete.\n", dev->name);
390 outb_p(ENISR_RESET, NE_BASE + EN0_ISR); /* Ack intr. */
393 /* Grab the 8390 specific header. Similar to the block_input routine, but
394 we don't need to be concerned with ring wrap as the header will be at
395 the start of a page, so we optimize accordingly. */
397 static void ne_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
399 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
400 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
402 if (ei_status.dmaing)
404 printk(KERN_EMERG "%s: DMAing conflict in ne_get_8390_hdr "
405 "[DMAstat:%d][irqlock:%d].\n",
406 dev->name, ei_status.dmaing, ei_status.irqlock);
410 ei_status.dmaing |= 0x01;
411 outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, NE_BASE + NE_CMD);
412 outb_p(sizeof(struct e8390_pkt_hdr), NE_BASE + EN0_RCNTLO);
413 outb_p(0, NE_BASE + EN0_RCNTHI);
414 outb_p(0, NE_BASE + EN0_RSARLO); /* On page boundary */
415 outb_p(ring_page, NE_BASE + EN0_RSARHI);
416 outb_p(E8390_RREAD+E8390_START, NE_BASE + NE_CMD);
418 if (ei_status.word16) {
420 unsigned short *p = (unsigned short *)hdr;
421 for (len = sizeof(struct e8390_pkt_hdr)>>1; len > 0; len--)
422 *p++ = inw(NE_BASE + NE_DATAPORT);
424 insb(NE_BASE + NE_DATAPORT, hdr, sizeof(struct e8390_pkt_hdr));
426 outb_p(ENISR_RDC, NE_BASE + EN0_ISR); /* Ack intr. */
427 ei_status.dmaing &= ~0x01;
429 le16_to_cpus(&hdr->count);
432 /* Block input and output, similar to the Crynwr packet driver. If you
433 are porting to a new ethercard, look at the packet driver source for hints.
434 The NEx000 doesn't share the on-board packet memory -- you have to put
435 the packet out through the "remote DMA" dataport using outb. */
437 static void ne_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
439 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
440 #ifdef NE_SANITY_CHECK
441 int xfer_count = count;
443 char *buf = skb->data;
445 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
446 if (ei_status.dmaing)
448 printk(KERN_EMERG "%s: DMAing conflict in ne_block_input "
449 "[DMAstat:%d][irqlock:%d].\n",
450 dev->name, ei_status.dmaing, ei_status.irqlock);
453 ei_status.dmaing |= 0x01;
454 outb_p(E8390_NODMA+E8390_PAGE0+E8390_START, NE_BASE + NE_CMD);
455 outb_p(count & 0xff, NE_BASE + EN0_RCNTLO);
456 outb_p(count >> 8, NE_BASE + EN0_RCNTHI);
457 outb_p(ring_offset & 0xff, NE_BASE + EN0_RSARLO);
458 outb_p(ring_offset >> 8, NE_BASE + EN0_RSARHI);
459 outb_p(E8390_RREAD+E8390_START, NE_BASE + NE_CMD);
460 if (ei_status.word16)
463 unsigned short *p = (unsigned short *)buf;
464 for (len = count>>1; len > 0; len--)
465 *p++ = inw(NE_BASE + NE_DATAPORT);
468 buf[count-1] = inb(NE_BASE + NE_DATAPORT);
469 #ifdef NE_SANITY_CHECK
474 insb(NE_BASE + NE_DATAPORT, buf, count);
477 #ifdef NE_SANITY_CHECK
478 /* This was for the ALPHA version only, but enough people have
479 been encountering problems so it is still here. If you see
480 this message you either 1) have a slightly incompatible clone
481 or 2) have noise/speed problems with your bus. */
485 /* DMA termination address check... */
486 int addr, tries = 20;
488 /* DON'T check for 'inb_p(EN0_ISR) & ENISR_RDC' here
489 -- it's broken for Rx on some cards! */
490 int high = inb_p(NE_BASE + EN0_RSARHI);
491 int low = inb_p(NE_BASE + EN0_RSARLO);
492 addr = (high << 8) + low;
493 if (((ring_offset + xfer_count) & 0xff) == low)
495 } while (--tries > 0);
497 printk(KERN_WARNING "%s: RX transfer address mismatch,"
498 "%#4.4x (expected) vs. %#4.4x (actual).\n",
499 dev->name, ring_offset + xfer_count, addr);
502 outb_p(ENISR_RDC, NE_BASE + EN0_ISR); /* Ack intr. */
503 ei_status.dmaing &= ~0x01;
506 static void ne_block_output(struct net_device *dev, int count,
507 const unsigned char *buf, const int start_page)
509 struct ei_device *ei_local = (struct ei_device *) netdev_priv(dev);
510 unsigned long dma_start;
511 #ifdef NE_SANITY_CHECK
515 /* Round the count up for word writes. Do we need to do this?
516 What effect will an odd byte count have on the 8390?
517 I should check someday. */
519 if (ei_status.word16 && (count & 0x01))
522 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
523 if (ei_status.dmaing)
525 printk(KERN_EMERG "%s: DMAing conflict in ne_block_output."
526 "[DMAstat:%d][irqlock:%d]\n",
527 dev->name, ei_status.dmaing, ei_status.irqlock);
530 ei_status.dmaing |= 0x01;
531 /* We should already be in page 0, but to be safe... */
532 outb_p(E8390_PAGE0+E8390_START+E8390_NODMA, NE_BASE + NE_CMD);
534 #ifdef NE_SANITY_CHECK
538 #ifdef NE8390_RW_BUGFIX
539 /* Handle the read-before-write bug the same way as the
540 Crynwr packet driver -- the NatSemi method doesn't work.
541 Actually this doesn't always work either, but if you have
542 problems with your NEx000 this is better than nothing! */
544 outb_p(0x42, NE_BASE + EN0_RCNTLO);
545 outb_p(0x00, NE_BASE + EN0_RCNTHI);
546 outb_p(0x42, NE_BASE + EN0_RSARLO);
547 outb_p(0x00, NE_BASE + EN0_RSARHI);
548 outb_p(E8390_RREAD+E8390_START, NE_BASE + NE_CMD);
549 /* Make certain that the dummy read has occurred. */
553 outb_p(ENISR_RDC, NE_BASE + EN0_ISR);
555 /* Now the normal output. */
556 outb_p(count & 0xff, NE_BASE + EN0_RCNTLO);
557 outb_p(count >> 8, NE_BASE + EN0_RCNTHI);
558 outb_p(0x00, NE_BASE + EN0_RSARLO);
559 outb_p(start_page, NE_BASE + EN0_RSARHI);
561 outb_p(E8390_RWRITE+E8390_START, NE_BASE + NE_CMD);
562 if (ei_status.word16) {
564 unsigned short *p = (unsigned short *)buf;
565 for (len = count>>1; len > 0; len--)
566 outw(*p++, NE_BASE + NE_DATAPORT);
568 outsb(NE_BASE + NE_DATAPORT, buf, count);
573 #ifdef NE_SANITY_CHECK
574 /* This was for the ALPHA version only, but enough people have
575 been encountering problems so it is still here. */
579 /* DMA termination address check... */
580 int addr, tries = 20;
582 int high = inb_p(NE_BASE + EN0_RSARHI);
583 int low = inb_p(NE_BASE + EN0_RSARLO);
584 addr = (high << 8) + low;
585 if ((start_page << 8) + count == addr)
587 } while (--tries > 0);
591 printk(KERN_WARNING "%s: Tx packet transfer address mismatch,"
592 "%#4.4x (expected) vs. %#4.4x (actual).\n",
593 dev->name, (start_page << 8) + count, addr);
600 while ((inb_p(NE_BASE + EN0_ISR) & ENISR_RDC) == 0)
601 if (time_after(jiffies, dma_start + 2*HZ/100)) { /* 20ms */
602 printk(KERN_WARNING "%s: timeout waiting for Tx RDC.\n", dev->name);
604 __NS8390_init(dev,1);
608 outb_p(ENISR_RDC, NE_BASE + EN0_ISR); /* Ack intr. */
609 ei_status.dmaing &= ~0x01;
615 #define MAX_NE_CARDS 1 /* Max number of NE cards per module */
616 static struct net_device *dev_ne[MAX_NE_CARDS];
617 static int io[MAX_NE_CARDS];
618 static int irq[MAX_NE_CARDS];
619 static int bad[MAX_NE_CARDS]; /* 0xbad = bad sig or no reset ack */
621 module_param_array(io, int, NULL, 0);
622 module_param_array(irq, int, NULL, 0);
623 module_param_array(bad, int, NULL, 0);
624 MODULE_PARM_DESC(io, "I/O base address(es)");
625 MODULE_PARM_DESC(irq, "IRQ number(s)");
626 MODULE_DESCRIPTION("H8/300 NE2000 Ethernet driver");
627 MODULE_LICENSE("GPL");
629 /* This is set up so that no ISA autoprobe takes place. We can't guarantee
630 that the ne2k probe is the last 8390 based probe to take place (as it
631 is at boot) and so the probe will get confused by any other 8390 cards.
632 ISA device autoprobes on a running machine are not recommended anyway. */
634 int init_module(void)
636 int this_dev, found = 0;
639 for (this_dev = 0; this_dev < MAX_NE_CARDS; this_dev++) {
640 struct net_device *dev = alloc_ei_netdev();
644 dev->irq = irq[this_dev];
645 dev->mem_end = bad[this_dev];
646 dev->base_addr = io[this_dev];
648 dev->base_addr = h8300_ne_base[this_dev];
649 dev->irq = h8300_ne_irq[this_dev];
651 err = init_reg_offset(dev, dev->base_addr);
653 if (do_ne_probe(dev) == 0) {
654 dev_ne[found++] = dev;
661 if (io[this_dev] != 0)
662 printk(KERN_WARNING "ne.c: No NE*000 card found at i/o = %#x\n", dev->base_addr);
664 printk(KERN_NOTICE "ne.c: You must supply \"io=0xNNN\" value(s) for ISA cards.\n");
672 void cleanup_module(void)
676 for (this_dev = 0; this_dev < MAX_NE_CARDS; this_dev++) {
677 struct net_device *dev = dev_ne[this_dev];
679 unregister_netdev(dev);