2 * Amiga Linux/68k 8390 based PCMCIA Ethernet Driver for the Amiga 1200
4 * (C) Copyright 1997 Alain Malek
5 * (Alain.Malek@cryogen.com)
7 * ----------------------------------------------------------------------------
9 * This program is based on
11 * ne.c: A general non-shared-memory NS8390 ethernet driver for linux
12 * Written 1992-94 by Donald Becker.
14 * 8390.c: A general NS8390 ethernet driver core for linux.
15 * Written 1992-94 by Donald Becker.
17 * cnetdevice: A Sana-II ethernet driver for AmigaOS
18 * Written by Bruce Abbott (bhabbott@inhb.co.nz)
20 * ----------------------------------------------------------------------------
22 * This file is subject to the terms and conditions of the GNU General Public
23 * License. See the file COPYING in the main directory of the Linux
24 * distribution for more details.
26 * ----------------------------------------------------------------------------
31 #include <linux/module.h>
32 #include <linux/kernel.h>
33 #include <linux/errno.h>
34 #include <linux/pci.h>
35 #include <linux/init.h>
36 #include <linux/delay.h>
37 #include <linux/netdevice.h>
38 #include <linux/etherdevice.h>
39 #include <linux/jiffies.h>
41 #include <asm/system.h>
43 #include <asm/setup.h>
44 #include <asm/amigaints.h>
45 #include <asm/amigahw.h>
46 #include <asm/amigayle.h>
47 #include <asm/amipcmcia.h>
51 /* ---- No user-serviceable parts below ---- */
53 #define DRV_NAME "apne"
55 #define NE_BASE (dev->base_addr)
57 #define NE_DATAPORT 0x10 /* NatSemi-defined port window offset. */
58 #define NE_RESET 0x1f /* Issue a read to reset, a write to clear. */
59 #define NE_IO_EXTENT 0x20
61 #define NE_EN0_ISR 0x07
62 #define NE_EN0_DCFG 0x0e
64 #define NE_EN0_RSARLO 0x08
65 #define NE_EN0_RSARHI 0x09
66 #define NE_EN0_RCNTLO 0x0a
67 #define NE_EN0_RXCR 0x0c
68 #define NE_EN0_TXCR 0x0d
69 #define NE_EN0_RCNTHI 0x0b
70 #define NE_EN0_IMR 0x0f
72 #define NE1SM_START_PG 0x20 /* First page of TX buffer */
73 #define NE1SM_STOP_PG 0x40 /* Last page +1 of RX ring */
74 #define NESM_START_PG 0x40 /* First page of TX buffer */
75 #define NESM_STOP_PG 0x80 /* Last page +1 of RX ring */
78 struct net_device * __init apne_probe(int unit);
79 static int apne_probe1(struct net_device *dev, int ioaddr);
81 static int apne_open(struct net_device *dev);
82 static int apne_close(struct net_device *dev);
84 static void apne_reset_8390(struct net_device *dev);
85 static void apne_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
87 static void apne_block_input(struct net_device *dev, int count,
88 struct sk_buff *skb, int ring_offset);
89 static void apne_block_output(struct net_device *dev, const int count,
90 const unsigned char *buf, const int start_page);
91 static irqreturn_t apne_interrupt(int irq, void *dev_id);
93 static int init_pcmcia(void);
95 /* IO base address used for nic */
100 use MANUAL_CONFIG and MANUAL_OFFSET for enabling IO by hand
101 you can find the values to use by looking at the cnet.device
102 config file example (the default values are for the CNET40BC card)
106 #define MANUAL_CONFIG 0x20
107 #define MANUAL_OFFSET 0x3f8
109 #define MANUAL_HWADDR0 0x00
110 #define MANUAL_HWADDR1 0x12
111 #define MANUAL_HWADDR2 0x34
112 #define MANUAL_HWADDR3 0x56
113 #define MANUAL_HWADDR4 0x78
114 #define MANUAL_HWADDR5 0x9a
117 static const char version[] =
118 "apne.c:v1.1 7/10/98 Alain Malek (Alain.Malek@cryogen.ch)\n";
120 static int apne_owned; /* signal if card already owned */
122 struct net_device * __init apne_probe(int unit)
124 struct net_device *dev;
125 #ifndef MANUAL_CONFIG
131 return ERR_PTR(-ENODEV);
133 if ( !(AMIGAHW_PRESENT(PCMCIA)) )
134 return ERR_PTR(-ENODEV);
136 printk("Looking for PCMCIA ethernet card : ");
138 /* check if a card is inserted */
139 if (!(PCMCIA_INSERTED)) {
140 printk("NO PCMCIA card inserted\n");
141 return ERR_PTR(-ENODEV);
144 dev = alloc_ei_netdev();
146 return ERR_PTR(-ENOMEM);
148 sprintf(dev->name, "eth%d", unit);
149 netdev_boot_setup_check(dev);
152 /* disable pcmcia irq for readtuple */
153 pcmcia_disable_irq();
155 #ifndef MANUAL_CONFIG
156 if ((pcmcia_copy_tuple(CISTPL_FUNCID, tuple, 8) < 3) ||
157 (tuple[2] != CISTPL_FUNCID_NETWORK)) {
158 printk("not an ethernet card\n");
159 /* XXX: shouldn't we re-enable irq here? */
161 return ERR_PTR(-ENODEV);
165 printk("ethernet PCMCIA card inserted\n");
167 if (!init_pcmcia()) {
168 /* XXX: shouldn't we re-enable irq here? */
170 return ERR_PTR(-ENODEV);
173 if (!request_region(IOBASE, 0x20, DRV_NAME)) {
175 return ERR_PTR(-EBUSY);
178 err = apne_probe1(dev, IOBASE);
180 release_region(IOBASE, 0x20);
184 err = register_netdev(dev);
188 pcmcia_disable_irq();
189 free_irq(IRQ_AMIGA_PORTS, dev);
191 release_region(IOBASE, 0x20);
196 static int __init apne_probe1(struct net_device *dev, int ioaddr)
199 unsigned char SA_prom[32];
201 const char *name = NULL;
202 int start_page, stop_page;
203 #ifndef MANUAL_HWADDR0
206 static unsigned version_printed;
207 DECLARE_MAC_BUF(mac);
209 if (ei_debug && version_printed++ == 0)
212 printk("PCMCIA NE*000 ethercard probe");
214 /* Reset card. Who knows what dain-bramaged state it was left in. */
215 { unsigned long reset_start_time = jiffies;
217 outb(inb(ioaddr + NE_RESET), ioaddr + NE_RESET);
219 while ((inb(ioaddr + NE_EN0_ISR) & ENISR_RESET) == 0)
220 if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
221 printk(" not found (no reset ack).\n");
225 outb(0xff, ioaddr + NE_EN0_ISR); /* Ack all intr. */
228 #ifndef MANUAL_HWADDR0
230 /* Read the 16 bytes of station address PROM.
231 We must first initialize registers, similar to NS8390_init(eifdev, 0).
232 We can't reliably read the SAPROM address without this.
233 (I learned the hard way!). */
235 struct {unsigned long value, offset; } program_seq[] = {
236 {E8390_NODMA+E8390_PAGE0+E8390_STOP, NE_CMD}, /* Select page 0*/
237 {0x48, NE_EN0_DCFG}, /* Set byte-wide (0x48) access. */
238 {0x00, NE_EN0_RCNTLO}, /* Clear the count regs. */
239 {0x00, NE_EN0_RCNTHI},
240 {0x00, NE_EN0_IMR}, /* Mask completion irq. */
242 {E8390_RXOFF, NE_EN0_RXCR}, /* 0x20 Set to monitor */
243 {E8390_TXOFF, NE_EN0_TXCR}, /* 0x02 and loopback mode. */
245 {0x00, NE_EN0_RCNTHI},
246 {0x00, NE_EN0_RSARLO}, /* DMA starting at 0x0000. */
247 {0x00, NE_EN0_RSARHI},
248 {E8390_RREAD+E8390_START, NE_CMD},
250 for (i = 0; i < ARRAY_SIZE(program_seq); i++) {
251 outb(program_seq[i].value, ioaddr + program_seq[i].offset);
255 for(i = 0; i < 32 /*sizeof(SA_prom)*/; i+=2) {
256 SA_prom[i] = inb(ioaddr + NE_DATAPORT);
257 SA_prom[i+1] = inb(ioaddr + NE_DATAPORT);
258 if (SA_prom[i] != SA_prom[i+1])
262 /* At this point, wordlength *only* tells us if the SA_prom is doubled
263 up or not because some broken PCI cards don't respect the byte-wide
264 request in program_seq above, and hence don't have doubled up values.
265 These broken cards would otherwise be detected as an ne1000. */
268 for (i = 0; i < 16; i++)
269 SA_prom[i] = SA_prom[i+i];
271 if (wordlength == 2) {
272 /* We must set the 8390 for word mode. */
273 outb(0x49, ioaddr + NE_EN0_DCFG);
274 start_page = NESM_START_PG;
275 stop_page = NESM_STOP_PG;
277 start_page = NE1SM_START_PG;
278 stop_page = NE1SM_STOP_PG;
281 neX000 = (SA_prom[14] == 0x57 && SA_prom[15] == 0x57);
282 ctron = (SA_prom[0] == 0x00 && SA_prom[1] == 0x00 && SA_prom[2] == 0x1d);
284 /* Set up the rest of the parameters. */
286 name = (wordlength == 2) ? "NE2000" : "NE1000";
288 name = (wordlength == 2) ? "Ctron-8" : "Ctron-16";
290 stop_page = (wordlength == 2) ? 0x40 : 0x20;
292 printk(" not found.\n");
299 /* We must set the 8390 for word mode. */
300 outb(0x49, ioaddr + NE_EN0_DCFG);
301 start_page = NESM_START_PG;
302 stop_page = NESM_STOP_PG;
304 SA_prom[0] = MANUAL_HWADDR0;
305 SA_prom[1] = MANUAL_HWADDR1;
306 SA_prom[2] = MANUAL_HWADDR2;
307 SA_prom[3] = MANUAL_HWADDR3;
308 SA_prom[4] = MANUAL_HWADDR4;
309 SA_prom[5] = MANUAL_HWADDR5;
313 dev->base_addr = ioaddr;
314 dev->irq = IRQ_AMIGA_PORTS;
316 /* Install the Interrupt handler */
317 i = request_irq(dev->irq, apne_interrupt, IRQF_SHARED, DRV_NAME, dev);
320 for(i = 0; i < ETHER_ADDR_LEN; i++)
321 dev->dev_addr[i] = SA_prom[i];
323 printk(" %s\n", print_mac(mac, dev->dev_addr));
325 printk("%s: %s found.\n", dev->name, name);
327 ei_status.name = name;
328 ei_status.tx_start_page = start_page;
329 ei_status.stop_page = stop_page;
330 ei_status.word16 = (wordlength == 2);
332 ei_status.rx_start_page = start_page + TX_PAGES;
334 ei_status.reset_8390 = &apne_reset_8390;
335 ei_status.block_input = &apne_block_input;
336 ei_status.block_output = &apne_block_output;
337 ei_status.get_8390_hdr = &apne_get_8390_hdr;
338 dev->open = &apne_open;
339 dev->stop = &apne_close;
340 #ifdef CONFIG_NET_POLL_CONTROLLER
341 dev->poll_controller = ei_poll;
345 pcmcia_ack_int(pcmcia_get_intreq()); /* ack PCMCIA int req */
354 apne_open(struct net_device *dev)
361 apne_close(struct net_device *dev)
364 printk("%s: Shutting down ethercard.\n", dev->name);
369 /* Hard reset the card. This used to pause for the same period that a
370 8390 reset command required, but that shouldn't be necessary. */
372 apne_reset_8390(struct net_device *dev)
374 unsigned long reset_start_time = jiffies;
378 if (ei_debug > 1) printk("resetting the 8390 t=%ld...", jiffies);
380 outb(inb(NE_BASE + NE_RESET), NE_BASE + NE_RESET);
383 ei_status.dmaing = 0;
385 /* This check _should_not_ be necessary, omit eventually. */
386 while ((inb(NE_BASE+NE_EN0_ISR) & ENISR_RESET) == 0)
387 if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
388 printk("%s: ne_reset_8390() did not complete.\n", dev->name);
391 outb(ENISR_RESET, NE_BASE + NE_EN0_ISR); /* Ack intr. */
394 /* Grab the 8390 specific header. Similar to the block_input routine, but
395 we don't need to be concerned with ring wrap as the header will be at
396 the start of a page, so we optimize accordingly. */
399 apne_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
402 int nic_base = dev->base_addr;
407 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
408 if (ei_status.dmaing) {
409 printk("%s: DMAing conflict in ne_get_8390_hdr "
410 "[DMAstat:%d][irqlock:%d][intr:%d].\n",
411 dev->name, ei_status.dmaing, ei_status.irqlock, dev->irq);
415 ei_status.dmaing |= 0x01;
416 outb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
417 outb(ENISR_RDC, nic_base + NE_EN0_ISR);
418 outb(sizeof(struct e8390_pkt_hdr), nic_base + NE_EN0_RCNTLO);
419 outb(0, nic_base + NE_EN0_RCNTHI);
420 outb(0, nic_base + NE_EN0_RSARLO); /* On page boundary */
421 outb(ring_page, nic_base + NE_EN0_RSARHI);
422 outb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
424 if (ei_status.word16) {
426 for(cnt = 0; cnt < (sizeof(struct e8390_pkt_hdr)>>1); cnt++)
427 *ptrs++ = inw(NE_BASE + NE_DATAPORT);
430 for(cnt = 0; cnt < sizeof(struct e8390_pkt_hdr); cnt++)
431 *ptrc++ = inb(NE_BASE + NE_DATAPORT);
434 outb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
435 ei_status.dmaing &= ~0x01;
437 le16_to_cpus(&hdr->count);
440 /* Block input and output, similar to the Crynwr packet driver. If you
441 are porting to a new ethercard, look at the packet driver source for hints.
442 The NEx000 doesn't share the on-board packet memory -- you have to put
443 the packet out through the "remote DMA" dataport using outb. */
446 apne_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
448 int nic_base = dev->base_addr;
449 char *buf = skb->data;
454 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
455 if (ei_status.dmaing) {
456 printk("%s: DMAing conflict in ne_block_input "
457 "[DMAstat:%d][irqlock:%d][intr:%d].\n",
458 dev->name, ei_status.dmaing, ei_status.irqlock, dev->irq);
461 ei_status.dmaing |= 0x01;
462 outb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
463 outb(ENISR_RDC, nic_base + NE_EN0_ISR);
464 outb(count & 0xff, nic_base + NE_EN0_RCNTLO);
465 outb(count >> 8, nic_base + NE_EN0_RCNTHI);
466 outb(ring_offset & 0xff, nic_base + NE_EN0_RSARLO);
467 outb(ring_offset >> 8, nic_base + NE_EN0_RSARHI);
468 outb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
469 if (ei_status.word16) {
471 for (cnt = 0; cnt < (count>>1); cnt++)
472 *ptrs++ = inw(NE_BASE + NE_DATAPORT);
474 buf[count-1] = inb(NE_BASE + NE_DATAPORT);
478 for (cnt = 0; cnt < count; cnt++)
479 *ptrc++ = inb(NE_BASE + NE_DATAPORT);
482 outb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
483 ei_status.dmaing &= ~0x01;
487 apne_block_output(struct net_device *dev, int count,
488 const unsigned char *buf, const int start_page)
490 int nic_base = NE_BASE;
491 unsigned long dma_start;
496 /* Round the count up for word writes. Do we need to do this?
497 What effect will an odd byte count have on the 8390?
498 I should check someday. */
499 if (ei_status.word16 && (count & 0x01))
502 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
503 if (ei_status.dmaing) {
504 printk("%s: DMAing conflict in ne_block_output."
505 "[DMAstat:%d][irqlock:%d][intr:%d]\n",
506 dev->name, ei_status.dmaing, ei_status.irqlock, dev->irq);
509 ei_status.dmaing |= 0x01;
510 /* We should already be in page 0, but to be safe... */
511 outb(E8390_PAGE0+E8390_START+E8390_NODMA, nic_base + NE_CMD);
513 outb(ENISR_RDC, nic_base + NE_EN0_ISR);
515 /* Now the normal output. */
516 outb(count & 0xff, nic_base + NE_EN0_RCNTLO);
517 outb(count >> 8, nic_base + NE_EN0_RCNTHI);
518 outb(0x00, nic_base + NE_EN0_RSARLO);
519 outb(start_page, nic_base + NE_EN0_RSARHI);
521 outb(E8390_RWRITE+E8390_START, nic_base + NE_CMD);
522 if (ei_status.word16) {
524 for (cnt = 0; cnt < count>>1; cnt++)
525 outw(*ptrs++, NE_BASE+NE_DATAPORT);
528 for (cnt = 0; cnt < count; cnt++)
529 outb(*ptrc++, NE_BASE + NE_DATAPORT);
534 while ((inb(NE_BASE + NE_EN0_ISR) & ENISR_RDC) == 0)
535 if (time_after(jiffies, dma_start + 2*HZ/100)) { /* 20ms */
536 printk("%s: timeout waiting for Tx RDC.\n", dev->name);
537 apne_reset_8390(dev);
542 outb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
543 ei_status.dmaing &= ~0x01;
547 static irqreturn_t apne_interrupt(int irq, void *dev_id)
549 unsigned char pcmcia_intreq;
551 if (!(gayle.inten & GAYLE_IRQ_IRQ))
554 pcmcia_intreq = pcmcia_get_intreq();
556 if (!(pcmcia_intreq & GAYLE_IRQ_IRQ)) {
557 pcmcia_ack_int(pcmcia_intreq);
561 printk("pcmcia intreq = %x\n", pcmcia_intreq);
562 pcmcia_disable_irq(); /* to get rid of the sti() within ei_interrupt */
563 ei_interrupt(irq, dev_id);
564 pcmcia_ack_int(pcmcia_get_intreq());
570 static struct net_device *apne_dev;
572 int __init init_module(void)
574 apne_dev = apne_probe(-1);
575 if (IS_ERR(apne_dev))
576 return PTR_ERR(apne_dev);
580 void __exit cleanup_module(void)
582 unregister_netdev(apne_dev);
584 pcmcia_disable_irq();
586 free_irq(IRQ_AMIGA_PORTS, apne_dev);
590 release_region(IOBASE, 0x20);
592 free_netdev(apne_dev);
597 static int init_pcmcia(void)
600 #ifndef MANUAL_CONFIG
607 pcmcia_program_voltage(PCMCIA_0V);
608 pcmcia_access_speed(PCMCIA_SPEED_250NS);
609 pcmcia_write_enable();
612 config = MANUAL_CONFIG;
614 /* get and write config byte to enable IO port */
616 if (pcmcia_copy_tuple(CISTPL_CFTABLE_ENTRY, tuple, 32) < 3)
619 config = tuple[2] & 0x3f;
622 offset = MANUAL_OFFSET;
624 if (pcmcia_copy_tuple(CISTPL_CONFIG, tuple, 32) < 6)
627 offset_len = (tuple[2] & 0x3) + 1;
629 while(offset_len--) {
630 offset = (offset << 8) | tuple[4+offset_len];
634 out_8(GAYLE_ATTRIBUTE+offset, config);
639 MODULE_LICENSE("GPL");