Merge git://git.kernel.org/pub/scm/linux/kernel/git/sam/kbuild-next
[linux-2.6] / 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();
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 const struct net_device_ops zorro8390_netdev_ops = {
143         .ndo_open               = zorro8390_open,
144         .ndo_stop               = zorro8390_close,
145         .ndo_start_xmit         = ei_start_xmit,
146         .ndo_tx_timeout         = ei_tx_timeout,
147         .ndo_get_stats          = ei_get_stats,
148         .ndo_set_multicast_list = ei_set_multicast_list,
149         .ndo_validate_addr      = eth_validate_addr,
150         .ndo_change_mtu         = eth_change_mtu,
151 #ifdef CONFIG_NET_POLL_CONTROLLER
152         .ndo_poll_controller    = ei_poll,
153 #endif
154 };
155
156 static int __devinit zorro8390_init(struct net_device *dev,
157                                     unsigned long board, const char *name,
158                                     unsigned long ioaddr)
159 {
160     int i;
161     int err;
162     unsigned char SA_prom[32];
163     int start_page, stop_page;
164     static u32 zorro8390_offsets[16] = {
165         0x00, 0x02, 0x04, 0x06, 0x08, 0x0a, 0x0c, 0x0e,
166         0x10, 0x12, 0x14, 0x16, 0x18, 0x1a, 0x1c, 0x1e,
167     };
168
169     /* Reset card. Who knows what dain-bramaged state it was left in. */
170     {
171         unsigned long reset_start_time = jiffies;
172
173         z_writeb(z_readb(ioaddr + NE_RESET), ioaddr + NE_RESET);
174
175         while ((z_readb(ioaddr + NE_EN0_ISR) & ENISR_RESET) == 0)
176             if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
177                 printk(KERN_WARNING " not found (no reset ack).\n");
178                 return -ENODEV;
179             }
180
181         z_writeb(0xff, ioaddr + NE_EN0_ISR);            /* Ack all intr. */
182     }
183
184     /* Read the 16 bytes of station address PROM.
185        We must first initialize registers, similar to NS8390_init(eifdev, 0).
186        We can't reliably read the SAPROM address without this.
187        (I learned the hard way!). */
188     {
189         struct {
190             u32 value;
191             u32 offset;
192         } program_seq[] = {
193             {E8390_NODMA+E8390_PAGE0+E8390_STOP, NE_CMD}, /* Select page 0*/
194             {0x48,      NE_EN0_DCFG},   /* Set byte-wide (0x48) access. */
195             {0x00,      NE_EN0_RCNTLO}, /* Clear the count regs. */
196             {0x00,      NE_EN0_RCNTHI},
197             {0x00,      NE_EN0_IMR},    /* Mask completion irq. */
198             {0xFF,      NE_EN0_ISR},
199             {E8390_RXOFF, NE_EN0_RXCR}, /* 0x20  Set to monitor */
200             {E8390_TXOFF, NE_EN0_TXCR}, /* 0x02  and loopback mode. */
201             {32,        NE_EN0_RCNTLO},
202             {0x00,      NE_EN0_RCNTHI},
203             {0x00,      NE_EN0_RSARLO}, /* DMA starting at 0x0000. */
204             {0x00,      NE_EN0_RSARHI},
205             {E8390_RREAD+E8390_START, NE_CMD},
206         };
207         for (i = 0; i < ARRAY_SIZE(program_seq); i++) {
208             z_writeb(program_seq[i].value, ioaddr + program_seq[i].offset);
209         }
210     }
211     for (i = 0; i < 16; i++) {
212         SA_prom[i] = z_readb(ioaddr + NE_DATAPORT);
213         (void)z_readb(ioaddr + NE_DATAPORT);
214     }
215
216     /* We must set the 8390 for word mode. */
217     z_writeb(0x49, ioaddr + NE_EN0_DCFG);
218     start_page = NESM_START_PG;
219     stop_page = NESM_STOP_PG;
220
221     dev->base_addr = ioaddr;
222     dev->irq = IRQ_AMIGA_PORTS;
223
224     /* Install the Interrupt handler */
225     i = request_irq(IRQ_AMIGA_PORTS, __ei_interrupt, IRQF_SHARED, DRV_NAME, dev);
226     if (i) return i;
227
228     for(i = 0; i < ETHER_ADDR_LEN; i++)
229         dev->dev_addr[i] = SA_prom[i];
230
231 #ifdef DEBUG
232     printk("%pM", dev->dev_addr);
233 #endif
234
235     ei_status.name = name;
236     ei_status.tx_start_page = start_page;
237     ei_status.stop_page = stop_page;
238     ei_status.word16 = 1;
239
240     ei_status.rx_start_page = start_page + TX_PAGES;
241
242     ei_status.reset_8390 = &zorro8390_reset_8390;
243     ei_status.block_input = &zorro8390_block_input;
244     ei_status.block_output = &zorro8390_block_output;
245     ei_status.get_8390_hdr = &zorro8390_get_8390_hdr;
246     ei_status.reg_offset = zorro8390_offsets;
247
248     dev->netdev_ops = &zorro8390_netdev_ops;
249     __NS8390_init(dev, 0);
250     err = register_netdev(dev);
251     if (err) {
252         free_irq(IRQ_AMIGA_PORTS, dev);
253         return err;
254     }
255
256     printk(KERN_INFO "%s: %s at 0x%08lx, Ethernet Address %pM\n",
257            dev->name, name, board, dev->dev_addr);
258
259     return 0;
260 }
261
262 static int zorro8390_open(struct net_device *dev)
263 {
264     __ei_open(dev);
265     return 0;
266 }
267
268 static int zorro8390_close(struct net_device *dev)
269 {
270     if (ei_debug > 1)
271         printk(KERN_DEBUG "%s: Shutting down ethercard.\n", dev->name);
272     __ei_close(dev);
273     return 0;
274 }
275
276 /* Hard reset the card.  This used to pause for the same period that a
277    8390 reset command required, but that shouldn't be necessary. */
278 static void zorro8390_reset_8390(struct net_device *dev)
279 {
280     unsigned long reset_start_time = jiffies;
281
282     if (ei_debug > 1)
283         printk(KERN_DEBUG "resetting the 8390 t=%ld...\n", jiffies);
284
285     z_writeb(z_readb(NE_BASE + NE_RESET), NE_BASE + NE_RESET);
286
287     ei_status.txing = 0;
288     ei_status.dmaing = 0;
289
290     /* This check _should_not_ be necessary, omit eventually. */
291     while ((z_readb(NE_BASE+NE_EN0_ISR) & ENISR_RESET) == 0)
292         if (time_after(jiffies, reset_start_time + 2*HZ/100)) {
293             printk(KERN_WARNING "%s: ne_reset_8390() did not complete.\n",
294                    dev->name);
295             break;
296         }
297     z_writeb(ENISR_RESET, NE_BASE + NE_EN0_ISR);        /* Ack intr. */
298 }
299
300 /* Grab the 8390 specific header. Similar to the block_input routine, but
301    we don't need to be concerned with ring wrap as the header will be at
302    the start of a page, so we optimize accordingly. */
303
304 static void zorro8390_get_8390_hdr(struct net_device *dev,
305                                    struct e8390_pkt_hdr *hdr, int ring_page)
306 {
307     int nic_base = dev->base_addr;
308     int cnt;
309     short *ptrs;
310
311     /* This *shouldn't* happen. If it does, it's the last thing you'll see */
312     if (ei_status.dmaing) {
313         printk(KERN_ERR "%s: DMAing conflict in ne_get_8390_hdr "
314            "[DMAstat:%d][irqlock:%d].\n", dev->name, ei_status.dmaing,
315            ei_status.irqlock);
316         return;
317     }
318
319     ei_status.dmaing |= 0x01;
320     z_writeb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
321     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
322     z_writeb(sizeof(struct e8390_pkt_hdr), nic_base + NE_EN0_RCNTLO);
323     z_writeb(0, nic_base + NE_EN0_RCNTHI);
324     z_writeb(0, nic_base + NE_EN0_RSARLO);              /* On page boundary */
325     z_writeb(ring_page, nic_base + NE_EN0_RSARHI);
326     z_writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
327
328     ptrs = (short*)hdr;
329     for (cnt = 0; cnt < (sizeof(struct e8390_pkt_hdr)>>1); cnt++)
330         *ptrs++ = z_readw(NE_BASE + NE_DATAPORT);
331
332     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
333
334     hdr->count = WORDSWAP(hdr->count);
335
336     ei_status.dmaing &= ~0x01;
337 }
338
339 /* Block input and output, similar to the Crynwr packet driver.  If you
340    are porting to a new ethercard, look at the packet driver source for hints.
341    The NEx000 doesn't share the on-board packet memory -- you have to put
342    the packet out through the "remote DMA" dataport using z_writeb. */
343
344 static void zorro8390_block_input(struct net_device *dev, int count,
345                                  struct sk_buff *skb, int ring_offset)
346 {
347     int nic_base = dev->base_addr;
348     char *buf = skb->data;
349     short *ptrs;
350     int cnt;
351
352     /* This *shouldn't* happen. If it does, it's the last thing you'll see */
353     if (ei_status.dmaing) {
354         printk(KERN_ERR "%s: DMAing conflict in ne_block_input "
355            "[DMAstat:%d][irqlock:%d].\n",
356            dev->name, ei_status.dmaing, ei_status.irqlock);
357         return;
358     }
359     ei_status.dmaing |= 0x01;
360     z_writeb(E8390_NODMA+E8390_PAGE0+E8390_START, nic_base+ NE_CMD);
361     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
362     z_writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
363     z_writeb(count >> 8, nic_base + NE_EN0_RCNTHI);
364     z_writeb(ring_offset & 0xff, nic_base + NE_EN0_RSARLO);
365     z_writeb(ring_offset >> 8, nic_base + NE_EN0_RSARHI);
366     z_writeb(E8390_RREAD+E8390_START, nic_base + NE_CMD);
367     ptrs = (short*)buf;
368     for (cnt = 0; cnt < (count>>1); cnt++)
369         *ptrs++ = z_readw(NE_BASE + NE_DATAPORT);
370     if (count & 0x01)
371         buf[count-1] = z_readb(NE_BASE + NE_DATAPORT);
372
373     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
374     ei_status.dmaing &= ~0x01;
375 }
376
377 static void zorro8390_block_output(struct net_device *dev, int count,
378                                    const unsigned char *buf,
379                                    const int start_page)
380 {
381     int nic_base = NE_BASE;
382     unsigned long dma_start;
383     short *ptrs;
384     int cnt;
385
386     /* Round the count up for word writes.  Do we need to do this?
387        What effect will an odd byte count have on the 8390?
388        I should check someday. */
389     if (count & 0x01)
390         count++;
391
392     /* This *shouldn't* happen. If it does, it's the last thing you'll see */
393     if (ei_status.dmaing) {
394         printk(KERN_ERR "%s: DMAing conflict in ne_block_output."
395            "[DMAstat:%d][irqlock:%d]\n", dev->name, ei_status.dmaing,
396            ei_status.irqlock);
397         return;
398     }
399     ei_status.dmaing |= 0x01;
400     /* We should already be in page 0, but to be safe... */
401     z_writeb(E8390_PAGE0+E8390_START+E8390_NODMA, nic_base + NE_CMD);
402
403     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR);
404
405    /* Now the normal output. */
406     z_writeb(count & 0xff, nic_base + NE_EN0_RCNTLO);
407     z_writeb(count >> 8,   nic_base + NE_EN0_RCNTHI);
408     z_writeb(0x00, nic_base + NE_EN0_RSARLO);
409     z_writeb(start_page, nic_base + NE_EN0_RSARHI);
410
411     z_writeb(E8390_RWRITE+E8390_START, nic_base + NE_CMD);
412     ptrs = (short*)buf;
413     for (cnt = 0; cnt < count>>1; cnt++)
414         z_writew(*ptrs++, NE_BASE+NE_DATAPORT);
415
416     dma_start = jiffies;
417
418     while ((z_readb(NE_BASE + NE_EN0_ISR) & ENISR_RDC) == 0)
419         if (time_after(jiffies, dma_start + 2*HZ/100)) {        /* 20ms */
420                 printk(KERN_ERR "%s: timeout waiting for Tx RDC.\n",
421                        dev->name);
422                 zorro8390_reset_8390(dev);
423                 __NS8390_init(dev,1);
424                 break;
425         }
426
427     z_writeb(ENISR_RDC, nic_base + NE_EN0_ISR); /* Ack intr. */
428     ei_status.dmaing &= ~0x01;
429     return;
430 }
431
432 static void __devexit zorro8390_remove_one(struct zorro_dev *z)
433 {
434     struct net_device *dev = zorro_get_drvdata(z);
435
436     unregister_netdev(dev);
437     free_irq(IRQ_AMIGA_PORTS, dev);
438     release_mem_region(ZTWO_PADDR(dev->base_addr), NE_IO_EXTENT*2);
439     free_netdev(dev);
440 }
441
442 static int __init zorro8390_init_module(void)
443 {
444     return zorro_register_driver(&zorro8390_driver);
445 }
446
447 static void __exit zorro8390_cleanup_module(void)
448 {
449     zorro_unregister_driver(&zorro8390_driver);
450 }
451
452 module_init(zorro8390_init_module);
453 module_exit(zorro8390_cleanup_module);
454
455 MODULE_LICENSE("GPL");