a45f9952a3f7610b393d6107197e60f44bb3e1ca
[linux-2.6.git] / drivers / net / zorro8390.c
1 /*
2  *  Amiga Linux/m68k and Linux/PPC Zorro NS8390 Ethernet Driver
3  *
4  *  (C) Copyright 1998-2000 by some Elitist 680x0 Users(TM)
5  *
6  *  ---------------------------------------------------------------------------
7  *
8  *  This program is based on all the other NE2000 drivers for Linux
9  *
10  *  ---------------------------------------------------------------------------
11  *
12  *  This file is subject to the terms and conditions of the GNU General Public
13  *  License.  See the file COPYING in the main directory of the Linux
14  *  distribution for more details.
15  *
16  *  ---------------------------------------------------------------------------
17  *
18  *  The Ariadne II and X-Surf are Zorro-II boards containing Realtek RTL8019AS
19  *  Ethernet Controllers.
20  */
21
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/errno.h>
25 #include <linux/init.h>
26 #include <linux/delay.h>
27 #include <linux/netdevice.h>
28 #include <linux/etherdevice.h>
29 #include <linux/zorro.h>
30 #include <linux/jiffies.h>
31
32 #include <asm/system.h>
33 #include <asm/irq.h>
34 #include <asm/amigaints.h>
35 #include <asm/amigahw.h>
36
37 #define EI_SHIFT(x)     (ei_local->reg_offset[x])
38 #define ei_inb(port)   in_8(port)
39 #define ei_outb(val,port)  out_8(port,val)
40 #define ei_inb_p(port)   in_8(port)
41 #define ei_outb_p(val,port)  out_8(port,val)
42
43 static const char version[] =
44     "8390.c:v1.10cvs 9/23/94 Donald Becker (becker@cesdis.gsfc.nasa.gov)\n";
45
46 #include "lib8390.c"
47
48 #define DRV_NAME        "zorro8390"
49
50 #define NE_BASE         (dev->base_addr)
51 #define NE_CMD          (0x00*2)
52 #define NE_DATAPORT     (0x10*2)        /* NatSemi-defined port window offset. */
53 #define NE_RESET        (0x1f*2)        /* Issue a read to reset, a write to clear. */
54 #define NE_IO_EXTENT    (0x20*2)
55
56 #define NE_EN0_ISR      (0x07*2)
57 #define NE_EN0_DCFG     (0x0e*2)
58
59 #define NE_EN0_RSARLO   (0x08*2)
60 #define NE_EN0_RSARHI   (0x09*2)
61 #define NE_EN0_RCNTLO   (0x0a*2)
62 #define NE_EN0_RXCR     (0x0c*2)
63 #define NE_EN0_TXCR     (0x0d*2)
64 #define NE_EN0_RCNTHI   (0x0b*2)
65 #define NE_EN0_IMR      (0x0f*2)
66
67 #define NESM_START_PG   0x40    /* First page of TX buffer */
68 #define NESM_STOP_PG    0x80    /* Last page +1 of RX ring */
69
70
71 #define WORDSWAP(a)     ((((a)>>8)&0xff) | ((a)<<8))
72
73
74 static struct card_info {
75     zorro_id id;
76     const char *name;
77     unsigned int offset;
78 } cards[] __devinitdata = {
79     { ZORRO_PROD_VILLAGE_TRONIC_ARIADNE2, "Ariadne II", 0x0600 },
80     { ZORRO_PROD_INDIVIDUAL_COMPUTERS_X_SURF, "X-Surf", 0x8600 },
81 };
82
83 static int __devinit zorro8390_init_one(struct zorro_dev *z,
84                                         const struct zorro_device_id *ent);
85 static int __devinit zorro8390_init(struct net_device *dev,
86                                     unsigned long board, const char *name,
87                                     unsigned long ioaddr);
88 static int zorro8390_open(struct net_device *dev);
89 static int zorro8390_close(struct net_device *dev);
90 static void zorro8390_reset_8390(struct net_device *dev);
91 static void zorro8390_get_8390_hdr(struct net_device *dev,
92                                    struct e8390_pkt_hdr *hdr, int ring_page);
93 static void zorro8390_block_input(struct net_device *dev, int count,
94                                   struct sk_buff *skb, int ring_offset);
95 static void zorro8390_block_output(struct net_device *dev, const int count,
96                                    const unsigned char *buf,
97                                    const int start_page);
98 static void __devexit zorro8390_remove_one(struct zorro_dev *z);
99
100 static struct zorro_device_id zorro8390_zorro_tbl[] __devinitdata = {
101     { ZORRO_PROD_VILLAGE_TRONIC_ARIADNE2, },
102     { ZORRO_PROD_INDIVIDUAL_COMPUTERS_X_SURF, },
103     { 0 }
104 };
105
106 static struct zorro_driver zorro8390_driver = {
107     .name       = "zorro8390",
108     .id_table   = zorro8390_zorro_tbl,
109     .probe      = zorro8390_init_one,
110     .remove     = __devexit_p(zorro8390_remove_one),
111 };
112
113 static int __devinit zorro8390_init_one(struct zorro_dev *z,
114                                         const struct zorro_device_id *ent)
115 {
116     struct net_device *dev;
117     unsigned long board, ioaddr;
118     int err, i;
119
120     for (i = ARRAY_SIZE(cards)-1; i >= 0; i--)
121         if (z->id == cards[i].id)
122             break;
123     board = z->resource.start;
124     ioaddr = board+cards[i].offset;
125     dev = ____alloc_ei_netdev(0);
126     if (!dev)
127         return -ENOMEM;
128     if (!request_mem_region(ioaddr, NE_IO_EXTENT*2, DRV_NAME)) {
129         free_netdev(dev);
130         return -EBUSY;
131     }
132     if ((err = zorro8390_init(dev, board, cards[i].name,
133                               ZTWO_VADDR(ioaddr)))) {
134         release_mem_region(ioaddr, NE_IO_EXTENT*2);
135         free_netdev(dev);
136         return err;
137     }
138     zorro_set_drvdata(z, dev);
139     return 0;
140 }
141
142 static int __devinit zorro8390_init(struct net_device *dev,
143                                     unsigned long board, const char *name,
144                                     unsigned long ioaddr)
145 {
146     int i;
147     int err;
148     unsigned char SA_prom[32];
149     int start_page, stop_page;
150     static u32 zorro8390_offsets[16] = {
151         0x00, 0x02, 0x04, 0x06, 0x08, 0x0a, 0x0c, 0x0e,
152         0x10, 0x12, 0x14, 0x16, 0x18, 0x1a, 0x1c, 0x1e,
153     };
154
155     /* Reset card. Who knows what dain-bramaged state it was left in. */
156     {
157         unsigned long reset_start_time = jiffies;
158
159         z_writeb(z_readb(ioaddr + NE_RESET), ioaddr + NE_RESET);
160
161         while ((z_readb(ioaddr + NE_EN0_ISR) & ENISR_RESET) == 0)
162             if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
163                 printk(KERN_WARNING " not found (no reset ack).\n");
164                 return -ENODEV;
165             }
166
167         z_writeb(0xff, ioaddr + NE_EN0_ISR);            /* Ack all intr. */
168     }
169
170     /* Read the 16 bytes of station address PROM.
171        We must first initialize registers, similar to NS8390_init(eifdev, 0).
172        We can't reliably read the SAPROM address without this.
173        (I learned the hard way!). */
174     {
175         struct {
176             u32 value;
177             u32 offset;
178         } program_seq[] = {
179             {E8390_NODMA+E8390_PAGE0+E8390_STOP, NE_CMD}, /* Select page 0*/
180             {0x48,      NE_EN0_DCFG},   /* Set byte-wide (0x48) access. */
181             {0x00,      NE_EN0_RCNTLO}, /* Clear the count regs. */
182             {0x00,      NE_EN0_RCNTHI},
183             {0x00,      NE_EN0_IMR},    /* Mask completion irq. */
184             {0xFF,      NE_EN0_ISR},
185             {E8390_RXOFF, NE_EN0_RXCR}, /* 0x20  Set to monitor */
186             {E8390_TXOFF, NE_EN0_TXCR}, /* 0x02  and loopback mode. */
187             {32,        NE_EN0_RCNTLO},
188             {0x00,      NE_EN0_RCNTHI},
189             {0x00,      NE_EN0_RSARLO}, /* DMA starting at 0x0000. */
190             {0x00,      NE_EN0_RSARHI},
191             {E8390_RREAD+E8390_START, NE_CMD},
192         };
193         for (i = 0; i < sizeof(program_seq)/sizeof(program_seq[0]); i++) {
194             z_writeb(program_seq[i].value, ioaddr + program_seq[i].offset);
195         }
196     }
197     for (i = 0; i < 16; i++) {
198         SA_prom[i] = z_readb(ioaddr + NE_DATAPORT);
199         (void)z_readb(ioaddr + NE_DATAPORT);
200     }
201
202     /* We must set the 8390 for word mode. */
203     z_writeb(0x49, ioaddr + NE_EN0_DCFG);
204     start_page = NESM_START_PG;
205     stop_page = NESM_STOP_PG;
206
207     dev->base_addr = ioaddr;
208     dev->irq = IRQ_AMIGA_PORTS;
209
210     /* Install the Interrupt handler */
211     i = request_irq(IRQ_AMIGA_PORTS, __ei_interrupt, IRQF_SHARED, DRV_NAME, dev);
212     if (i) return i;
213
214     for(i = 0; i < ETHER_ADDR_LEN; i++) {
215 #ifdef DEBUG
216         printk(" %2.2x", SA_prom[i]);
217 #endif
218         dev->dev_addr[i] = SA_prom[i];
219     }
220
221     ei_status.name = name;
222     ei_status.tx_start_page = start_page;
223     ei_status.stop_page = stop_page;
224     ei_status.word16 = 1;
225
226     ei_status.rx_start_page = start_page + TX_PAGES;
227
228     ei_status.reset_8390 = &zorro8390_reset_8390;
229     ei_status.block_input = &zorro8390_block_input;
230     ei_status.block_output = &zorro8390_block_output;
231     ei_status.get_8390_hdr = &zorro8390_get_8390_hdr;
232     ei_status.reg_offset = zorro8390_offsets;
233     dev->open = &zorro8390_open;
234     dev->stop = &zorro8390_close;
235 #ifdef CONFIG_NET_POLL_CONTROLLER
236     dev->poll_controller = __ei_poll;
237 #endif
238
239     __NS8390_init(dev, 0);
240     err = register_netdev(dev);
241     if (err) {
242         free_irq(IRQ_AMIGA_PORTS, dev);
243         return err;
244     }
245
246     printk(KERN_INFO "%s: %s at 0x%08lx, Ethernet Address "
247            "%02x:%02x:%02x:%02x:%02x:%02x\n", dev->name, name, board,
248            dev->dev_addr[0], dev->dev_addr[1], dev->dev_addr[2],
249            dev->dev_addr[3], dev->dev_addr[4], dev->dev_addr[5]);
250
251     return 0;
252 }
253
254 static int zorro8390_open(struct net_device *dev)
255 {
256     __ei_open(dev);
257     return 0;
258 }
259
260 static int zorro8390_close(struct net_device *dev)
261 {
262     if (ei_debug > 1)
263         printk(KERN_DEBUG "%s: Shutting down ethercard.\n", dev->name);
264     __ei_close(dev);
265     return 0;
266 }
267
268 /* Hard reset the card.  This used to pause for the same period that a
269    8390 reset command required, but that shouldn't be necessary. */
270 static void zorro8390_reset_8390(struct net_device *dev)
271 {
272     unsigned long reset_start_time = jiffies;
273
274     if (ei_debug > 1)
275         printk(KERN_DEBUG "resetting the 8390 t=%ld...\n", jiffies);
276
277     z_writeb(z_readb(NE_BASE + NE_RESET), NE_BASE + NE_RESET);
278
279     ei_status.txing = 0;
280     ei_status.dmaing = 0;
281
282     /* This check _should_not_ be necessary, omit eventually. */
283     while ((z_readb(NE_BASE+NE_EN0_ISR) & ENISR_RESET) == 0)
284         if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
285             printk(KERN_WARNING "%s: ne_reset_8390() did not complete.\n",
286                    dev->name);
287             break;
288         }
289     z_writeb(ENISR_RESET, NE_BASE + NE_EN0_ISR);        /* Ack intr. */
290 }
291
292 /* Grab the 8390 specific header. Similar to the block_input routine, but
293    we don't need to be concerned with ring wrap as the header will be at
294    the start of a page, so we optimize accordingly. */
295
296 static void zorro8390_get_8390_hdr(struct net_device *dev,
297                                    struct e8390_pkt_hdr *hdr, int ring_page)
298 {
299     int nic_base = dev->base_addr;
300     int cnt;
301     short *ptrs;
302
303     /* This *shouldn't* happen. If it does, it's the last thing you'll see */
304     if (ei_status.dmaing) {
305         printk(KERN_ERR "%s: DMAing conflict in ne_get_8390_hdr "
306            "[DMAstat:%d][irqlock:%d].\n", dev->name, ei_status.dmaing,
307            ei_status.irqlock);
308         return;
309     }
310
311     ei_status.dmaing |= 0x01;
312     z_writeb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
313     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
314     z_writeb(sizeof(struct e8390_pkt_hdr), nic_base + NE_EN0_RCNTLO);
315     z_writeb(0, nic_base + NE_EN0_RCNTHI);
316     z_writeb(0, nic_base + NE_EN0_RSARLO);              /* On page boundary */
317     z_writeb(ring_page, nic_base + NE_EN0_RSARHI);
318     z_writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
319
320     ptrs = (short*)hdr;
321     for (cnt = 0; cnt < (sizeof(struct e8390_pkt_hdr)>>1); cnt++)
322         *ptrs++ = z_readw(NE_BASE + NE_DATAPORT);
323
324     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
325
326     hdr->count = WORDSWAP(hdr->count);
327
328     ei_status.dmaing &= ~0x01;
329 }
330
331 /* Block input and output, similar to the Crynwr packet driver.  If you
332    are porting to a new ethercard, look at the packet driver source for hints.
333    The NEx000 doesn't share the on-board packet memory -- you have to put
334    the packet out through the "remote DMA" dataport using z_writeb. */
335
336 static void zorro8390_block_input(struct net_device *dev, int count,
337                                  struct sk_buff *skb, int ring_offset)
338 {
339     int nic_base = dev->base_addr;
340     char *buf = skb->data;
341     short *ptrs;
342     int cnt;
343
344     /* This *shouldn't* happen. If it does, it's the last thing you'll see */
345     if (ei_status.dmaing) {
346         printk(KERN_ERR "%s: DMAing conflict in ne_block_input "
347            "[DMAstat:%d][irqlock:%d].\n",
348            dev->name, ei_status.dmaing, ei_status.irqlock);
349         return;
350     }
351     ei_status.dmaing |= 0x01;
352     z_writeb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
353     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
354     z_writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
355     z_writeb(count >> 8, nic_base + NE_EN0_RCNTHI);
356     z_writeb(ring_offset & 0xff, nic_base + NE_EN0_RSARLO);
357     z_writeb(ring_offset >> 8, nic_base + NE_EN0_RSARHI);
358     z_writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
359     ptrs = (short*)buf;
360     for (cnt = 0; cnt < (count>>1); cnt++)
361         *ptrs++ = z_readw(NE_BASE + NE_DATAPORT);
362     if (count & 0x01)
363         buf[count-1] = z_readb(NE_BASE + NE_DATAPORT);
364
365     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
366     ei_status.dmaing &= ~0x01;
367 }
368
369 static void zorro8390_block_output(struct net_device *dev, int count,
370                                    const unsigned char *buf,
371                                    const int start_page)
372 {
373     int nic_base = NE_BASE;
374     unsigned long dma_start;
375     short *ptrs;
376     int cnt;
377
378     /* Round the count up for word writes.  Do we need to do this?
379        What effect will an odd byte count have on the 8390?
380        I should check someday. */
381     if (count & 0x01)
382         count++;
383
384     /* This *shouldn't* happen. If it does, it's the last thing you'll see */
385     if (ei_status.dmaing) {
386         printk(KERN_ERR "%s: DMAing conflict in ne_block_output."
387            "[DMAstat:%d][irqlock:%d]\n", dev->name, ei_status.dmaing,
388            ei_status.irqlock);
389         return;
390     }
391     ei_status.dmaing |= 0x01;
392     /* We should already be in page 0, but to be safe... */
393     z_writeb(E8390_PAGE0+E8390_START+E8390_NODMA, nic_base + NE_CMD);
394
395     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
396
397    /* Now the normal output. */
398     z_writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
399     z_writeb(count >> 8,   nic_base + NE_EN0_RCNTHI);
400     z_writeb(0x00, nic_base + NE_EN0_RSARLO);
401     z_writeb(start_page, nic_base + NE_EN0_RSARHI);
402
403     z_writeb(E8390_RWRITE+E8390_START, nic_base + NE_CMD);
404     ptrs = (short*)buf;
405     for (cnt = 0; cnt < count>>1; cnt++)
406         z_writew(*ptrs++, NE_BASE+NE_DATAPORT);
407
408     dma_start = jiffies;
409
410     while ((z_readb(NE_BASE + NE_EN0_ISR) & ENISR_RDC) == 0)
411         if (time_after(jiffies, dma_start + 2*HZ/100)) {        /* 20ms */
412                 printk(KERN_ERR "%s: timeout waiting for Tx RDC.\n",
413                        dev->name);
414                 zorro8390_reset_8390(dev);
415                 __NS8390_init(dev,1);
416                 break;
417         }
418
419     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
420     ei_status.dmaing &= ~0x01;
421     return;
422 }
423
424 static void __devexit zorro8390_remove_one(struct zorro_dev *z)
425 {
426     struct net_device *dev = zorro_get_drvdata(z);
427
428     unregister_netdev(dev);
429     free_irq(IRQ_AMIGA_PORTS, dev);
430     release_mem_region(ZTWO_PADDR(dev->base_addr), NE_IO_EXTENT*2);
431     free_netdev(dev);
432 }
433
434 static int __init zorro8390_init_module(void)
435 {
436     return zorro_register_driver(&zorro8390_driver);
437 }
438
439 static void __exit zorro8390_cleanup_module(void)
440 {
441     zorro_unregister_driver(&zorro8390_driver);
442 }
443
444 module_init(zorro8390_init_module);
445 module_exit(zorro8390_cleanup_module);
446
447 MODULE_LICENSE("GPL");