- pre6:
[davej-history.git] / drivers / net / apne.c
blobfe24effde169ca9b065d9a2e0512c621c31cc688
1 /*
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/sched.h>
34 #include <linux/errno.h>
35 #include <linux/pci.h>
36 #include <linux/init.h>
37 #include <linux/delay.h>
38 #include <asm/system.h>
39 #include <asm/io.h>
41 #include <linux/netdevice.h>
42 #include <linux/etherdevice.h>
44 #include <asm/setup.h>
45 #include <asm/amigaints.h>
46 #include <asm/amigahw.h>
47 #include <asm/amigayle.h>
48 #include <asm/amipcmcia.h>
50 #include "8390.h"
52 /* ---- No user-serviceable parts below ---- */
54 #define NE_BASE (dev->base_addr)
55 #define NE_CMD 0x00
56 #define NE_DATAPORT 0x10 /* NatSemi-defined port window offset. */
57 #define NE_RESET 0x1f+GAYLE_ODD /* Issue a read to reset, a write to clear. */
58 #define NE_IO_EXTENT 0x20
60 #define NE_EN0_ISR 0x07+GAYLE_ODD
61 #define NE_EN0_DCFG 0x0e
63 #define NE_EN0_RSARLO 0x08
64 #define NE_EN0_RSARHI 0x09+GAYLE_ODD
65 #define NE_EN0_RCNTLO 0x0a
66 #define NE_EN0_RXCR 0x0c
67 #define NE_EN0_TXCR 0x0d+GAYLE_ODD
68 #define NE_EN0_RCNTHI 0x0b+GAYLE_ODD
69 #define NE_EN0_IMR 0x0f+GAYLE_ODD
71 #define NE1SM_START_PG 0x20 /* First page of TX buffer */
72 #define NE1SM_STOP_PG 0x40 /* Last page +1 of RX ring */
73 #define NESM_START_PG 0x40 /* First page of TX buffer */
74 #define NESM_STOP_PG 0x80 /* Last page +1 of RX ring */
77 int apne_probe(struct net_device *dev);
78 static int apne_probe1(struct net_device *dev, int ioaddr);
80 static int apne_open(struct net_device *dev);
81 static int apne_close(struct net_device *dev);
83 static void apne_reset_8390(struct net_device *dev);
84 static void apne_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr,
85 int ring_page);
86 static void apne_block_input(struct net_device *dev, int count,
87 struct sk_buff *skb, int ring_offset);
88 static void apne_block_output(struct net_device *dev, const int count,
89 const unsigned char *buf, const int start_page);
90 static void apne_interrupt(int irq, void *dev_id, struct pt_regs *regs);
92 static int init_pcmcia(void);
94 /* IO base address used for nic */
96 #define IOBASE 0x300
99 use MANUAL_CONFIG and MANUAL_OFFSET for enabling IO by hand
100 you can find the values to use by looking at the cnet.device
101 config file example (the default values are for the CNET40BC card)
105 #define MANUAL_CONFIG 0x20
106 #define MANUAL_OFFSET 0x3f8
108 #define MANUAL_HWADDR0 0x00
109 #define MANUAL_HWADDR1 0x12
110 #define MANUAL_HWADDR2 0x34
111 #define MANUAL_HWADDR3 0x56
112 #define MANUAL_HWADDR4 0x78
113 #define MANUAL_HWADDR5 0x9a
116 #define WORDSWAP(a) ( (((a)>>8)&0xff) | ((a)<<8) )
119 static const char *version =
120 "apne.c:v1.1 7/10/98 Alain Malek (Alain.Malek@cryogen.ch)\n";
122 static int apne_owned = 0; /* signal if card already owned */
124 int __init apne_probe(struct net_device *dev)
126 #ifndef MANUAL_CONFIG
127 char tuple[8];
128 #endif
130 if (apne_owned)
131 return -ENODEV;
133 SET_MODULE_OWNER(dev);
135 if ( !(AMIGAHW_PRESENT(PCMCIA)) )
136 return (-ENODEV);
138 printk("Looking for PCMCIA ethernet card : ");
140 /* check if a card is inserted */
141 if (!(PCMCIA_INSERTED)) {
142 printk("NO PCMCIA card inserted\n");
143 return (-ENODEV);
146 /* disable pcmcia irq for readtuple */
147 pcmcia_disable_irq();
149 #ifndef MANUAL_CONFIG
150 if ((pcmcia_copy_tuple(CISTPL_FUNCID, tuple, 8) < 3) ||
151 (tuple[2] != CISTPL_FUNCID_NETWORK)) {
152 printk("not an ethernet card\n");
153 return (-ENODEV);
155 #endif
157 printk("ethernet PCMCIA card inserted\n");
159 if (init_pcmcia())
160 return apne_probe1(dev, IOBASE+GAYLE_IO);
161 else
162 return (-ENODEV);
166 static int __init apne_probe1(struct net_device *dev, int ioaddr)
168 int i;
169 unsigned char SA_prom[32];
170 int wordlength = 2;
171 const char *name = NULL;
172 int start_page, stop_page;
173 #ifndef MANUAL_HWADDR0
174 int neX000, ctron;
175 #endif
176 static unsigned version_printed = 0;
177 static u32 pcmcia_offsets[16]={
178 0, 1+GAYLE_ODD, 2, 3+GAYLE_ODD,
179 4, 5+GAYLE_ODD, 6, 7+GAYLE_ODD,
180 8, 9+GAYLE_ODD, 0xa, 0xb+GAYLE_ODD,
181 0xc, 0xd+GAYLE_ODD, 0xe, 0xf+GAYLE_ODD };
183 if (ei_debug && version_printed++ == 0)
184 printk(version);
186 printk("PCMCIA NE*000 ethercard probe");
188 /* Reset card. Who knows what dain-bramaged state it was left in. */
189 { unsigned long reset_start_time = jiffies;
191 writeb(readb(ioaddr + NE_RESET), ioaddr + NE_RESET);
193 while ((readb(ioaddr + NE_EN0_ISR) & ENISR_RESET) == 0)
194 if (jiffies - reset_start_time > 2*HZ/100) {
195 printk(" not found (no reset ack).\n");
196 return -ENODEV;
199 writeb(0xff, ioaddr + NE_EN0_ISR); /* Ack all intr. */
202 #ifndef MANUAL_HWADDR0
204 /* Read the 16 bytes of station address PROM.
205 We must first initialize registers, similar to NS8390_init(eifdev, 0).
206 We can't reliably read the SAPROM address without this.
207 (I learned the hard way!). */
209 struct {unsigned long value, offset; } program_seq[] = {
210 {E8390_NODMA+E8390_PAGE0+E8390_STOP, NE_CMD}, /* Select page 0*/
211 {0x48, NE_EN0_DCFG}, /* Set byte-wide (0x48) access. */
212 {0x00, NE_EN0_RCNTLO}, /* Clear the count regs. */
213 {0x00, NE_EN0_RCNTHI},
214 {0x00, NE_EN0_IMR}, /* Mask completion irq. */
215 {0xFF, NE_EN0_ISR},
216 {E8390_RXOFF, NE_EN0_RXCR}, /* 0x20 Set to monitor */
217 {E8390_TXOFF, NE_EN0_TXCR}, /* 0x02 and loopback mode. */
218 {32, NE_EN0_RCNTLO},
219 {0x00, NE_EN0_RCNTHI},
220 {0x00, NE_EN0_RSARLO}, /* DMA starting at 0x0000. */
221 {0x00, NE_EN0_RSARHI},
222 {E8390_RREAD+E8390_START, NE_CMD},
224 for (i = 0; i < sizeof(program_seq)/sizeof(program_seq[0]); i++) {
225 writeb(program_seq[i].value, ioaddr + program_seq[i].offset);
229 for(i = 0; i < 32 /*sizeof(SA_prom)*/; i+=2) {
230 SA_prom[i] = readb(ioaddr + NE_DATAPORT);
231 SA_prom[i+1] = readb(ioaddr + NE_DATAPORT);
232 if (SA_prom[i] != SA_prom[i+1])
233 wordlength = 1;
236 /* At this point, wordlength *only* tells us if the SA_prom is doubled
237 up or not because some broken PCI cards don't respect the byte-wide
238 request in program_seq above, and hence don't have doubled up values.
239 These broken cards would otherwise be detected as an ne1000. */
241 if (wordlength == 2)
242 for (i = 0; i < 16; i++)
243 SA_prom[i] = SA_prom[i+i];
245 if (wordlength == 2) {
246 /* We must set the 8390 for word mode. */
247 writeb(0x49, ioaddr + NE_EN0_DCFG);
248 start_page = NESM_START_PG;
249 stop_page = NESM_STOP_PG;
250 } else {
251 start_page = NE1SM_START_PG;
252 stop_page = NE1SM_STOP_PG;
255 neX000 = (SA_prom[14] == 0x57 && SA_prom[15] == 0x57);
256 ctron = (SA_prom[0] == 0x00 && SA_prom[1] == 0x00 && SA_prom[2] == 0x1d);
258 /* Set up the rest of the parameters. */
259 if (neX000) {
260 name = (wordlength == 2) ? "NE2000" : "NE1000";
261 } else if (ctron) {
262 name = (wordlength == 2) ? "Ctron-8" : "Ctron-16";
263 start_page = 0x01;
264 stop_page = (wordlength == 2) ? 0x40 : 0x20;
265 } else {
266 printk(" not found.\n");
267 return -ENXIO;
271 #else
272 wordlength = 2;
273 /* We must set the 8390 for word mode. */
274 writeb(0x49, ioaddr + NE_EN0_DCFG);
275 start_page = NESM_START_PG;
276 stop_page = NESM_STOP_PG;
278 SA_prom[0] = MANUAL_HWADDR0;
279 SA_prom[1] = MANUAL_HWADDR1;
280 SA_prom[2] = MANUAL_HWADDR2;
281 SA_prom[3] = MANUAL_HWADDR3;
282 SA_prom[4] = MANUAL_HWADDR4;
283 SA_prom[5] = MANUAL_HWADDR5;
284 name = "NE2000";
285 #endif
287 dev->base_addr = ioaddr;
289 /* Install the Interrupt handler */
290 i = request_irq(IRQ_AMIGA_PORTS, apne_interrupt, SA_SHIRQ, dev->name, dev);
291 if (i) return i;
293 /* Allocate dev->priv and fill in 8390 specific dev fields. */
294 if (ethdev_init(dev)) {
295 printk (" unable to get memory for dev->priv.\n");
296 return -ENOMEM;
299 for(i = 0; i < ETHER_ADDR_LEN; i++) {
300 printk(" %2.2x", SA_prom[i]);
301 dev->dev_addr[i] = SA_prom[i];
304 printk("\n%s: %s found.\n", dev->name, name);
306 ei_status.name = name;
307 ei_status.tx_start_page = start_page;
308 ei_status.stop_page = stop_page;
309 ei_status.word16 = (wordlength == 2);
311 ei_status.rx_start_page = start_page + TX_PAGES;
313 ei_status.reset_8390 = &apne_reset_8390;
314 ei_status.block_input = &apne_block_input;
315 ei_status.block_output = &apne_block_output;
316 ei_status.get_8390_hdr = &apne_get_8390_hdr;
317 ei_status.reg_offset = pcmcia_offsets;
318 dev->open = &apne_open;
319 dev->stop = &apne_close;
320 NS8390_init(dev, 0);
322 pcmcia_ack_int(pcmcia_get_intreq()); /* ack PCMCIA int req */
323 pcmcia_enable_irq();
325 apne_owned = 1;
327 return 0;
330 static int
331 apne_open(struct net_device *dev)
333 ei_open(dev);
334 return 0;
337 static int
338 apne_close(struct net_device *dev)
340 if (ei_debug > 1)
341 printk("%s: Shutting down ethercard.\n", dev->name);
342 ei_close(dev);
343 return 0;
346 /* Hard reset the card. This used to pause for the same period that a
347 8390 reset command required, but that shouldn't be necessary. */
348 static void
349 apne_reset_8390(struct net_device *dev)
351 unsigned long reset_start_time = jiffies;
353 init_pcmcia();
355 if (ei_debug > 1) printk("resetting the 8390 t=%ld...", jiffies);
357 writeb(readb(NE_BASE + NE_RESET), NE_BASE + NE_RESET);
359 ei_status.txing = 0;
360 ei_status.dmaing = 0;
362 /* This check _should_not_ be necessary, omit eventually. */
363 while ((readb(NE_BASE+NE_EN0_ISR) & ENISR_RESET) == 0)
364 if (jiffies - reset_start_time > 2*HZ/100) {
365 printk("%s: ne_reset_8390() did not complete.\n", dev->name);
366 break;
368 writeb(ENISR_RESET, NE_BASE + NE_EN0_ISR); /* Ack intr. */
371 /* Grab the 8390 specific header. Similar to the block_input routine, but
372 we don't need to be concerned with ring wrap as the header will be at
373 the start of a page, so we optimize accordingly. */
375 static void
376 apne_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
379 int nic_base = dev->base_addr;
380 int cnt;
381 char *ptrc;
382 short *ptrs;
384 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
385 if (ei_status.dmaing) {
386 printk("%s: DMAing conflict in ne_get_8390_hdr "
387 "[DMAstat:%d][irqlock:%d][intr:%ld].\n",
388 dev->name, ei_status.dmaing, ei_status.irqlock,
389 dev->interrupt);
390 return;
393 ei_status.dmaing |= 0x01;
394 writeb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
395 writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
396 writeb(sizeof(struct e8390_pkt_hdr), nic_base + NE_EN0_RCNTLO);
397 writeb(0, nic_base + NE_EN0_RCNTHI);
398 writeb(0, nic_base + NE_EN0_RSARLO); /* On page boundary */
399 writeb(ring_page, nic_base + NE_EN0_RSARHI);
400 writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
402 if (ei_status.word16) {
403 ptrs = (short*)hdr;
404 for(cnt = 0; cnt < (sizeof(struct e8390_pkt_hdr)>>1); cnt++)
405 *ptrs++ = readw(NE_BASE + NE_DATAPORT);
406 } else {
407 ptrc = (char*)hdr;
408 for(cnt = 0; cnt < sizeof(struct e8390_pkt_hdr); cnt++)
409 *ptrc++ = readb(NE_BASE + NE_DATAPORT);
412 writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
414 hdr->count = WORDSWAP(hdr->count);
416 ei_status.dmaing &= ~0x01;
419 /* Block input and output, similar to the Crynwr packet driver. If you
420 are porting to a new ethercard, look at the packet driver source for hints.
421 The NEx000 doesn't share the on-board packet memory -- you have to put
422 the packet out through the "remote DMA" dataport using writeb. */
424 static void
425 apne_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
427 int nic_base = dev->base_addr;
428 char *buf = skb->data;
429 char *ptrc;
430 short *ptrs;
431 int cnt;
433 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
434 if (ei_status.dmaing) {
435 printk("%s: DMAing conflict in ne_block_input "
436 "[DMAstat:%d][irqlock:%d][intr:%ld].\n",
437 dev->name, ei_status.dmaing, ei_status.irqlock,
438 dev->interrupt);
439 return;
441 ei_status.dmaing |= 0x01;
442 writeb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
443 writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
444 writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
445 writeb(count >> 8, nic_base + NE_EN0_RCNTHI);
446 writeb(ring_offset & 0xff, nic_base + NE_EN0_RSARLO);
447 writeb(ring_offset >> 8, nic_base + NE_EN0_RSARHI);
448 writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
449 if (ei_status.word16) {
450 ptrs = (short*)buf;
451 for (cnt = 0; cnt < (count>>1); cnt++)
452 *ptrs++ = readw(NE_BASE + NE_DATAPORT);
453 if (count & 0x01) {
454 buf[count-1] = readb(NE_BASE + NE_DATAPORT);
456 } else {
457 ptrc = (char*)buf;
458 for (cnt = 0; cnt < count; cnt++)
459 *ptrc++ = readb(NE_BASE + NE_DATAPORT);
462 writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
463 ei_status.dmaing &= ~0x01;
466 static void
467 apne_block_output(struct net_device *dev, int count,
468 const unsigned char *buf, const int start_page)
470 int nic_base = NE_BASE;
471 unsigned long dma_start;
472 char *ptrc;
473 short *ptrs;
474 int cnt;
476 /* Round the count up for word writes. Do we need to do this?
477 What effect will an odd byte count have on the 8390?
478 I should check someday. */
479 if (ei_status.word16 && (count & 0x01))
480 count++;
482 /* This *shouldn't* happen. If it does, it's the last thing you'll see */
483 if (ei_status.dmaing) {
484 printk("%s: DMAing conflict in ne_block_output."
485 "[DMAstat:%d][irqlock:%d][intr:%ld]\n",
486 dev->name, ei_status.dmaing, ei_status.irqlock,
487 dev->interrupt);
488 return;
490 ei_status.dmaing |= 0x01;
491 /* We should already be in page 0, but to be safe... */
492 writeb(E8390_PAGE0+E8390_START+E8390_NODMA, nic_base + NE_CMD);
494 writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
496 /* Now the normal output. */
497 writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
498 writeb(count >> 8, nic_base + NE_EN0_RCNTHI);
499 writeb(0x00, nic_base + NE_EN0_RSARLO);
500 writeb(start_page, nic_base + NE_EN0_RSARHI);
502 writeb(E8390_RWRITE+E8390_START, nic_base + NE_CMD);
503 if (ei_status.word16) {
504 ptrs = (short*)buf;
505 for (cnt = 0; cnt < count>>1; cnt++)
506 writew(*ptrs++, NE_BASE+NE_DATAPORT);
507 } else {
508 ptrc = (char*)buf;
509 for (cnt = 0; cnt < count; cnt++)
510 writeb(*ptrc++, NE_BASE + NE_DATAPORT);
513 dma_start = jiffies;
515 while ((readb(NE_BASE + NE_EN0_ISR) & ENISR_RDC) == 0)
516 if (jiffies - dma_start > 2*HZ/100) { /* 20ms */
517 printk("%s: timeout waiting for Tx RDC.\n", dev->name);
518 apne_reset_8390(dev);
519 NS8390_init(dev,1);
520 break;
523 writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
524 ei_status.dmaing &= ~0x01;
525 return;
528 static void apne_interrupt(int irq, void *dev_id, struct pt_regs *regs)
530 unsigned char pcmcia_intreq;
532 if (!(gayle.inten & GAYLE_IRQ_IRQ))
533 return;
535 pcmcia_intreq = pcmcia_get_intreq();
537 if (!(pcmcia_intreq & GAYLE_IRQ_IRQ)) {
538 pcmcia_ack_int(pcmcia_intreq);
539 return;
541 if (ei_debug > 3)
542 printk("pcmcia intreq = %x\n", pcmcia_intreq);
543 pcmcia_disable_irq(); /* to get rid of the sti() within ei_interrupt */
544 ei_interrupt(irq, dev_id, regs);
545 pcmcia_ack_int(pcmcia_get_intreq());
546 pcmcia_enable_irq();
549 #ifdef MODULE
550 static struct net_device apne_dev;
552 int init_module(void)
554 int err;
556 apne_dev.init = apne_probe;
557 if ((err = register_netdev(&apne_dev))) {
558 if (err == -EIO)
559 printk("No PCMCIA NEx000 ethernet card found.\n");
560 return (err);
562 return (0);
565 void cleanup_module(void)
567 unregister_netdev(&apne_dev);
569 pcmcia_disable_irq();
571 free_irq(IRQ_AMIGA_PORTS, &apne_dev);
573 pcmcia_reset();
575 apne_owned = 0;
578 #endif
580 static int init_pcmcia(void)
582 u_char config;
583 #ifndef MANUAL_CONFIG
584 u_char tuple[32];
585 int offset_len;
586 #endif
587 u_long offset;
589 pcmcia_reset();
590 pcmcia_program_voltage(PCMCIA_0V);
591 pcmcia_access_speed(PCMCIA_SPEED_250NS);
592 pcmcia_write_enable();
594 #ifdef MANUAL_CONFIG
595 config = MANUAL_CONFIG;
596 #else
597 /* get and write config byte to enable IO port */
599 if (pcmcia_copy_tuple(CISTPL_CFTABLE_ENTRY, tuple, 32) < 3)
600 return 0;
602 config = tuple[2] & 0x3f;
603 #endif
604 #ifdef MANUAL_OFFSET
605 offset = MANUAL_OFFSET;
606 #else
607 if (pcmcia_copy_tuple(CISTPL_CONFIG, tuple, 32) < 6)
608 return 0;
610 offset_len = (tuple[2] & 0x3) + 1;
611 offset = 0;
612 while(offset_len--) {
613 offset = (offset << 8) | tuple[4+offset_len];
615 #endif
617 writeb(config, GAYLE_ATTRIBUTE+offset);
619 return 1;