Merge branch 'simplify_PRT' into release
[linux-2.6] / drivers / net / tokenring / skisa.c
1 /*
2  *  skisa.c: A network driver for SK-NET TMS380-based ISA token ring cards.
3  *
4  *  Based on tmspci written 1999 by Adam Fritzler
5  *  
6  *  Written 2000 by Jochen Friedrich
7  *  Dedicated to my girlfriend Steffi Bopp
8  *
9  *  This software may be used and distributed according to the terms
10  *  of the GNU General Public License, incorporated herein by reference.
11  *
12  *  This driver module supports the following cards:
13  *      - SysKonnect TR4/16(+) ISA      (SK-4190)
14  *
15  *  Maintainer(s):
16  *    AF        Adam Fritzler
17  *    JF        Jochen Friedrich        jochen@scram.de
18  *
19  *  Modification History:
20  *      14-Jan-01       JF      Created
21  *      28-Oct-02       JF      Fixed probe of card for static compilation.
22  *                              Fixed module init to not make hotplug go wild.
23  *      09-Nov-02       JF      Fixed early bail out on out of memory
24  *                              situations if multiple cards are found.
25  *                              Cleaned up some unnecessary console SPAM.
26  *      09-Dec-02       JF      Fixed module reference counting.
27  *      02-Jan-03       JF      Renamed to skisa.c
28  *
29  */
30 static const char version[] = "skisa.c: v1.03 09/12/2002 by Jochen Friedrich\n";
31
32 #include <linux/module.h>
33 #include <linux/kernel.h>
34 #include <linux/errno.h>
35 #include <linux/pci.h>
36 #include <linux/init.h>
37 #include <linux/netdevice.h>
38 #include <linux/trdevice.h>
39 #include <linux/platform_device.h>
40
41 #include <asm/system.h>
42 #include <asm/io.h>
43 #include <asm/irq.h>
44 #include <asm/pci.h>
45 #include <asm/dma.h>
46
47 #include "tms380tr.h"
48
49 #define SK_ISA_IO_EXTENT 32
50
51 /* A zero-terminated list of I/O addresses to be probed. */
52 static unsigned int portlist[] __initdata = {
53         0x0A20, 0x1A20, 0x0B20, 0x1B20, 0x0980, 0x1980, 0x0900, 0x1900,// SK
54         0
55 };
56
57 /* A zero-terminated list of IRQs to be probed. 
58  * Used again after initial probe for sktr_chipset_init, called from sktr_open.
59  */
60 static const unsigned short irqlist[] = {
61         3, 5, 9, 10, 11, 12, 15,
62         0
63 };
64
65 /* A zero-terminated list of DMAs to be probed. */
66 static int dmalist[] __initdata = {
67         5, 6, 7,
68         0
69 };
70
71 static char isa_cardname[] = "SK NET TR 4/16 ISA\0";
72 static u64 dma_mask = ISA_MAX_ADDRESS;
73 static int sk_isa_open(struct net_device *dev);
74 static void sk_isa_read_eeprom(struct net_device *dev);
75 static unsigned short sk_isa_setnselout_pins(struct net_device *dev);
76
77 static unsigned short sk_isa_sifreadb(struct net_device *dev, unsigned short reg)
78 {
79         return inb(dev->base_addr + reg);
80 }
81
82 static unsigned short sk_isa_sifreadw(struct net_device *dev, unsigned short reg)
83 {
84         return inw(dev->base_addr + reg);
85 }
86
87 static void sk_isa_sifwriteb(struct net_device *dev, unsigned short val, unsigned short reg)
88 {
89         outb(val, dev->base_addr + reg);
90 }
91
92 static void sk_isa_sifwritew(struct net_device *dev, unsigned short val, unsigned short reg)
93 {
94         outw(val, dev->base_addr + reg);
95 }
96
97
98 static int __init sk_isa_probe1(struct net_device *dev, int ioaddr)
99 {
100         unsigned char old, chk1, chk2;
101
102         if (!request_region(ioaddr, SK_ISA_IO_EXTENT, isa_cardname))
103                 return -ENODEV;
104
105         old = inb(ioaddr + SIFADR);     /* Get the old SIFADR value */
106
107         chk1 = 0;       /* Begin with check value 0 */
108         do {
109                 /* Write new SIFADR value */
110                 outb(chk1, ioaddr + SIFADR);
111
112                 /* Read, invert and write */
113                 chk2 = inb(ioaddr + SIFADD);
114                 chk2 ^= 0x0FE;
115                 outb(chk2, ioaddr + SIFADR);
116
117                 /* Read, invert and compare */
118                 chk2 = inb(ioaddr + SIFADD);
119                 chk2 ^= 0x0FE;
120
121                 if(chk1 != chk2) {
122                         release_region(ioaddr, SK_ISA_IO_EXTENT);
123                         return -ENODEV;
124                 }
125
126                 chk1 -= 2;
127         } while(chk1 != 0);     /* Repeat 128 times (all byte values) */
128
129         /* Restore the SIFADR value */
130         outb(old, ioaddr + SIFADR);
131
132         dev->base_addr = ioaddr;
133         return 0;
134 }
135
136 static int __init setup_card(struct net_device *dev, struct device *pdev)
137 {
138         struct net_local *tp;
139         static int versionprinted;
140         const unsigned *port;
141         int j, err = 0;
142
143         if (!dev)
144                 return -ENOMEM;
145
146         if (dev->base_addr)     /* probe specific location */
147                 err = sk_isa_probe1(dev, dev->base_addr);
148         else {
149                 for (port = portlist; *port; port++) {
150                         err = sk_isa_probe1(dev, *port);
151                         if (!err)
152                                 break;
153                 }
154         }
155         if (err)
156                 goto out5;
157
158         /* At this point we have found a valid card. */
159
160         if (versionprinted++ == 0)
161                 printk(KERN_DEBUG "%s", version);
162
163         err = -EIO;
164         pdev->dma_mask = &dma_mask;
165         if (tmsdev_init(dev, pdev))
166                 goto out4;
167
168         dev->base_addr &= ~3; 
169                 
170         sk_isa_read_eeprom(dev);
171
172         printk(KERN_DEBUG "skisa.c:    Ring Station Address: %pM\n",
173                dev->dev_addr);
174                 
175         tp = netdev_priv(dev);
176         tp->setnselout = sk_isa_setnselout_pins;
177                 
178         tp->sifreadb = sk_isa_sifreadb;
179         tp->sifreadw = sk_isa_sifreadw;
180         tp->sifwriteb = sk_isa_sifwriteb;
181         tp->sifwritew = sk_isa_sifwritew;
182         
183         memcpy(tp->ProductID, isa_cardname, PROD_ID_SIZE + 1);
184
185         tp->tmspriv = NULL;
186
187         dev->open = sk_isa_open;
188         dev->stop = tms380tr_close;
189
190         if (dev->irq == 0)
191         {
192                 for(j = 0; irqlist[j] != 0; j++)
193                 {
194                         dev->irq = irqlist[j];
195                         if (!request_irq(dev->irq, tms380tr_interrupt, 0, 
196                                 isa_cardname, dev))
197                                 break;
198                 }
199                 
200                 if(irqlist[j] == 0)
201                 {
202                         printk(KERN_INFO "skisa.c: AutoSelect no IRQ available\n");
203                         goto out3;
204                 }
205         }
206         else
207         {
208                 for(j = 0; irqlist[j] != 0; j++)
209                         if (irqlist[j] == dev->irq)
210                                 break;
211                 if (irqlist[j] == 0)
212                 {
213                         printk(KERN_INFO "skisa.c: Illegal IRQ %d specified\n",
214                                 dev->irq);
215                         goto out3;
216                 }
217                 if (request_irq(dev->irq, tms380tr_interrupt, 0, 
218                         isa_cardname, dev))
219                 {
220                         printk(KERN_INFO "skisa.c: Selected IRQ %d not available\n",
221                                 dev->irq);
222                         goto out3;
223                 }
224         }
225
226         if (dev->dma == 0)
227         {
228                 for(j = 0; dmalist[j] != 0; j++)
229                 {
230                         dev->dma = dmalist[j];
231                         if (!request_dma(dev->dma, isa_cardname))
232                                 break;
233                 }
234
235                 if(dmalist[j] == 0)
236                 {
237                         printk(KERN_INFO "skisa.c: AutoSelect no DMA available\n");
238                         goto out2;
239                 }
240         }
241         else
242         {
243                 for(j = 0; dmalist[j] != 0; j++)
244                         if (dmalist[j] == dev->dma)
245                                 break;
246                 if (dmalist[j] == 0)
247                 {
248                         printk(KERN_INFO "skisa.c: Illegal DMA %d specified\n",
249                                 dev->dma);
250                         goto out2;
251                 }
252                 if (request_dma(dev->dma, isa_cardname))
253                 {
254                         printk(KERN_INFO "skisa.c: Selected DMA %d not available\n",
255                                 dev->dma);
256                         goto out2;
257                 }
258         }
259
260         err = register_netdev(dev);
261         if (err)
262                 goto out;
263
264         printk(KERN_DEBUG "%s:    IO: %#4lx  IRQ: %d  DMA: %d\n",
265                dev->name, dev->base_addr, dev->irq, dev->dma);
266
267         return 0;
268 out:
269         free_dma(dev->dma);
270 out2:
271         free_irq(dev->irq, dev);
272 out3:
273         tmsdev_term(dev);
274 out4:
275         release_region(dev->base_addr, SK_ISA_IO_EXTENT);
276 out5:
277         return err;
278 }
279
280 /*
281  * Reads MAC address from adapter RAM, which should've read it from
282  * the onboard ROM.  
283  *
284  * Calling this on a board that does not support it can be a very
285  * dangerous thing.  The Madge board, for instance, will lock your
286  * machine hard when this is called.  Luckily, its supported in a
287  * separate driver.  --ASF
288  */
289 static void sk_isa_read_eeprom(struct net_device *dev)
290 {
291         int i;
292         
293         /* Address: 0000:0000 */
294         sk_isa_sifwritew(dev, 0, SIFADX);
295         sk_isa_sifwritew(dev, 0, SIFADR);       
296         
297         /* Read six byte MAC address data */
298         dev->addr_len = 6;
299         for(i = 0; i < 6; i++)
300                 dev->dev_addr[i] = sk_isa_sifreadw(dev, SIFINC) >> 8;
301 }
302
303 static unsigned short sk_isa_setnselout_pins(struct net_device *dev)
304 {
305         return 0;
306 }
307
308 static int sk_isa_open(struct net_device *dev)
309 {  
310         struct net_local *tp = netdev_priv(dev);
311         unsigned short val = 0;
312         unsigned short oldval;
313         int i;
314
315         val = 0;
316         for(i = 0; irqlist[i] != 0; i++)
317         {
318                 if(irqlist[i] == dev->irq)
319                         break;
320         }
321
322         val |= CYCLE_TIME << 2;
323         val |= i << 4;
324         i = dev->dma - 5;
325         val |= i;
326         if(tp->DataRate == SPEED_4)
327                 val |= LINE_SPEED_BIT;
328         else
329                 val &= ~LINE_SPEED_BIT;
330         oldval = sk_isa_sifreadb(dev, POSREG);
331         /* Leave cycle bits alone */
332         oldval |= 0xf3;
333         val &= oldval;
334         sk_isa_sifwriteb(dev, val, POSREG);
335
336         return tms380tr_open(dev);
337 }
338
339 #define ISATR_MAX_ADAPTERS 3
340
341 static int io[ISATR_MAX_ADAPTERS];
342 static int irq[ISATR_MAX_ADAPTERS];
343 static int dma[ISATR_MAX_ADAPTERS];
344
345 MODULE_LICENSE("GPL");
346
347 module_param_array(io, int, NULL, 0);
348 module_param_array(irq, int, NULL, 0);
349 module_param_array(dma, int, NULL, 0);
350
351 static struct platform_device *sk_isa_dev[ISATR_MAX_ADAPTERS];
352
353 static struct platform_driver sk_isa_driver = {
354         .driver         = {
355                 .name   = "skisa",
356         },
357 };
358
359 static int __init sk_isa_init(void)
360 {
361         struct net_device *dev;
362         struct platform_device *pdev;
363         int i, num = 0, err = 0;
364
365         err = platform_driver_register(&sk_isa_driver);
366         if (err)
367                 return err;
368
369         for (i = 0; i < ISATR_MAX_ADAPTERS ; i++) {
370                 dev = alloc_trdev(sizeof(struct net_local));
371                 if (!dev)
372                         continue;
373
374                 dev->base_addr = io[i];
375                 dev->irq = irq[i];
376                 dev->dma = dma[i];
377                 pdev = platform_device_register_simple("skisa",
378                         i, NULL, 0);
379                 if (IS_ERR(pdev)) {
380                         free_netdev(dev);
381                         continue;
382                 }
383                 err = setup_card(dev, &pdev->dev);
384                 if (!err) {
385                         sk_isa_dev[i] = pdev;
386                         platform_set_drvdata(sk_isa_dev[i], dev);
387                         ++num;
388                 } else {
389                         platform_device_unregister(pdev);
390                         free_netdev(dev);
391                 }
392         }
393
394         printk(KERN_NOTICE "skisa.c: %d cards found.\n", num);
395         /* Probe for cards. */
396         if (num == 0) {
397                 printk(KERN_NOTICE "skisa.c: No cards found.\n");
398                 platform_driver_unregister(&sk_isa_driver);
399                 return -ENODEV;
400         }
401         return 0;
402 }
403
404 static void __exit sk_isa_cleanup(void)
405 {
406         struct net_device *dev;
407         int i;
408
409         for (i = 0; i < ISATR_MAX_ADAPTERS ; i++) {
410                 struct platform_device *pdev = sk_isa_dev[i];
411
412                 if (!pdev)
413                         continue;
414                 dev = platform_get_drvdata(pdev);
415                 unregister_netdev(dev);
416                 release_region(dev->base_addr, SK_ISA_IO_EXTENT);
417                 free_irq(dev->irq, dev);
418                 free_dma(dev->dma);
419                 tmsdev_term(dev);
420                 free_netdev(dev);
421                 platform_set_drvdata(pdev, NULL);
422                 platform_device_unregister(pdev);
423         }
424         platform_driver_unregister(&sk_isa_driver);
425 }
426
427 module_init(sk_isa_init);
428 module_exit(sk_isa_cleanup);