pcmcia: convert net pcmcia drivers to use new CIS helpers
[firefly-linux-kernel-4.4.55.git] / drivers / net / pcmcia / 3c589_cs.c
1 /*======================================================================
2
3     A PCMCIA ethernet driver for the 3com 3c589 card.
4     
5     Copyright (C) 1999 David A. Hinds -- dahinds@users.sourceforge.net
6
7     3c589_cs.c 1.162 2001/10/13 00:08:50
8
9     The network driver code is based on Donald Becker's 3c589 code:
10     
11     Written 1994 by Donald Becker.
12     Copyright 1993 United States Government as represented by the
13     Director, National Security Agency.  This software may be used and
14     distributed according to the terms of the GNU General Public License,
15     incorporated herein by reference.
16     Donald Becker may be reached at becker@scyld.com
17     
18     Updated for 2.5.x by Alan Cox <alan@lxorguk.ukuu.org.uk>
19
20 ======================================================================*/
21
22 #define DRV_NAME        "3c589_cs"
23 #define DRV_VERSION     "1.162-ac"
24
25 #include <linux/module.h>
26 #include <linux/init.h>
27 #include <linux/kernel.h>
28 #include <linux/ptrace.h>
29 #include <linux/slab.h>
30 #include <linux/string.h>
31 #include <linux/timer.h>
32 #include <linux/interrupt.h>
33 #include <linux/in.h>
34 #include <linux/delay.h>
35 #include <linux/ethtool.h>
36 #include <linux/netdevice.h>
37 #include <linux/etherdevice.h>
38 #include <linux/skbuff.h>
39 #include <linux/if_arp.h>
40 #include <linux/ioport.h>
41 #include <linux/bitops.h>
42 #include <linux/jiffies.h>
43
44 #include <pcmcia/cs_types.h>
45 #include <pcmcia/cs.h>
46 #include <pcmcia/cistpl.h>
47 #include <pcmcia/cisreg.h>
48 #include <pcmcia/ciscode.h>
49 #include <pcmcia/ds.h>
50
51 #include <asm/uaccess.h>
52 #include <asm/io.h>
53 #include <asm/system.h>
54
55 /* To minimize the size of the driver source I only define operating
56    constants if they are used several times.  You'll need the manual
57    if you want to understand driver details. */
58 /* Offsets from base I/O address. */
59 #define EL3_DATA        0x00
60 #define EL3_TIMER       0x0a
61 #define EL3_CMD         0x0e
62 #define EL3_STATUS      0x0e
63
64 #define EEPROM_READ     0x0080
65 #define EEPROM_BUSY     0x8000
66
67 #define EL3WINDOW(win_num) outw(SelectWindow + (win_num), ioaddr + EL3_CMD)
68
69 /* The top five bits written to EL3_CMD are a command, the lower
70    11 bits are the parameter, if applicable. */
71 enum c509cmd {
72     TotalReset = 0<<11, SelectWindow = 1<<11, StartCoax = 2<<11,
73     RxDisable = 3<<11, RxEnable = 4<<11, RxReset = 5<<11, RxDiscard = 8<<11,
74     TxEnable = 9<<11, TxDisable = 10<<11, TxReset = 11<<11,
75     FakeIntr = 12<<11, AckIntr = 13<<11, SetIntrEnb = 14<<11,
76     SetStatusEnb = 15<<11, SetRxFilter = 16<<11, SetRxThreshold = 17<<11,
77     SetTxThreshold = 18<<11, SetTxStart = 19<<11, StatsEnable = 21<<11,
78     StatsDisable = 22<<11, StopCoax = 23<<11,
79 };
80
81 enum c509status {
82     IntLatch = 0x0001, AdapterFailure = 0x0002, TxComplete = 0x0004,
83     TxAvailable = 0x0008, RxComplete = 0x0010, RxEarly = 0x0020,
84     IntReq = 0x0040, StatsFull = 0x0080, CmdBusy = 0x1000
85 };
86
87 /* The SetRxFilter command accepts the following classes: */
88 enum RxFilter {
89     RxStation = 1, RxMulticast = 2, RxBroadcast = 4, RxProm = 8
90 };
91
92 /* Register window 1 offsets, the window used in normal operation. */
93 #define TX_FIFO         0x00
94 #define RX_FIFO         0x00
95 #define RX_STATUS       0x08
96 #define TX_STATUS       0x0B
97 #define TX_FREE         0x0C    /* Remaining free bytes in Tx buffer. */
98
99 #define WN0_IRQ         0x08    /* Window 0: Set IRQ line in bits 12-15. */
100 #define WN4_MEDIA       0x0A    /* Window 4: Various transcvr/media bits. */
101 #define MEDIA_TP        0x00C0  /* Enable link beat and jabber for 10baseT. */
102 #define MEDIA_LED       0x0001  /* Enable link light on 3C589E cards. */
103
104 /* Time in jiffies before concluding Tx hung */
105 #define TX_TIMEOUT      ((400*HZ)/1000)
106
107 struct el3_private {
108         struct pcmcia_device    *p_dev;
109     dev_node_t          node;
110     /* For transceiver monitoring */
111     struct timer_list   media;
112     u16                 media_status;
113     u16                 fast_poll;
114     unsigned long       last_irq;
115     spinlock_t          lock;
116 };
117
118 static const char *if_names[] = { "auto", "10baseT", "10base2", "AUI" };
119
120 /*====================================================================*/
121
122 /* Module parameters */
123
124 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
125 MODULE_DESCRIPTION("3Com 3c589 series PCMCIA ethernet driver");
126 MODULE_LICENSE("GPL");
127
128 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)
129
130 /* Special hook for setting if_port when module is loaded */
131 INT_MODULE_PARM(if_port, 0);
132
133 #ifdef PCMCIA_DEBUG
134 INT_MODULE_PARM(pc_debug, PCMCIA_DEBUG);
135 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
136 static char *version =
137 DRV_NAME ".c " DRV_VERSION " 2001/10/13 00:08:50 (David Hinds)";
138 #else
139 #define DEBUG(n, args...)
140 #endif
141
142 /*====================================================================*/
143
144 static int tc589_config(struct pcmcia_device *link);
145 static void tc589_release(struct pcmcia_device *link);
146
147 static u16 read_eeprom(unsigned int ioaddr, int index);
148 static void tc589_reset(struct net_device *dev);
149 static void media_check(unsigned long arg);
150 static int el3_config(struct net_device *dev, struct ifmap *map);
151 static int el3_open(struct net_device *dev);
152 static netdev_tx_t el3_start_xmit(struct sk_buff *skb,
153                                         struct net_device *dev);
154 static irqreturn_t el3_interrupt(int irq, void *dev_id);
155 static void update_stats(struct net_device *dev);
156 static struct net_device_stats *el3_get_stats(struct net_device *dev);
157 static int el3_rx(struct net_device *dev);
158 static int el3_close(struct net_device *dev);
159 static void el3_tx_timeout(struct net_device *dev);
160 static void set_rx_mode(struct net_device *dev);
161 static void set_multicast_list(struct net_device *dev);
162 static const struct ethtool_ops netdev_ethtool_ops;
163
164 static void tc589_detach(struct pcmcia_device *p_dev);
165
166 /*======================================================================
167
168     tc589_attach() creates an "instance" of the driver, allocating
169     local data structures for one device.  The device is registered
170     with Card Services.
171
172 ======================================================================*/
173
174 static const struct net_device_ops el3_netdev_ops = {
175         .ndo_open               = el3_open,
176         .ndo_stop               = el3_close,
177         .ndo_start_xmit         = el3_start_xmit,
178         .ndo_tx_timeout         = el3_tx_timeout,
179         .ndo_set_config         = el3_config,
180         .ndo_get_stats          = el3_get_stats,
181         .ndo_set_multicast_list = set_multicast_list,
182         .ndo_change_mtu         = eth_change_mtu,
183         .ndo_set_mac_address    = eth_mac_addr,
184         .ndo_validate_addr      = eth_validate_addr,
185 };
186
187 static int tc589_probe(struct pcmcia_device *link)
188 {
189     struct el3_private *lp;
190     struct net_device *dev;
191
192     DEBUG(0, "3c589_attach()\n");
193
194     /* Create new ethernet device */
195     dev = alloc_etherdev(sizeof(struct el3_private));
196     if (!dev)
197          return -ENOMEM;
198     lp = netdev_priv(dev);
199     link->priv = dev;
200     lp->p_dev = link;
201
202     spin_lock_init(&lp->lock);
203     link->io.NumPorts1 = 16;
204     link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
205     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_HANDLE_PRESENT;
206     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
207     link->irq.Handler = &el3_interrupt;
208     link->irq.Instance = dev;
209     link->conf.Attributes = CONF_ENABLE_IRQ;
210     link->conf.IntType = INT_MEMORY_AND_IO;
211     link->conf.ConfigIndex = 1;
212
213     dev->netdev_ops = &el3_netdev_ops;
214     dev->watchdog_timeo = TX_TIMEOUT;
215
216     SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
217
218     return tc589_config(link);
219 } /* tc589_attach */
220
221 /*======================================================================
222
223     This deletes a driver "instance".  The device is de-registered
224     with Card Services.  If it has been released, all local data
225     structures are freed.  Otherwise, the structures will be freed
226     when the device is released.
227
228 ======================================================================*/
229
230 static void tc589_detach(struct pcmcia_device *link)
231 {
232     struct net_device *dev = link->priv;
233
234     DEBUG(0, "3c589_detach(0x%p)\n", link);
235
236     if (link->dev_node)
237         unregister_netdev(dev);
238
239     tc589_release(link);
240
241     free_netdev(dev);
242 } /* tc589_detach */
243
244 /*======================================================================
245
246     tc589_config() is scheduled to run after a CARD_INSERTION event
247     is received, to configure the PCMCIA socket, and to make the
248     ethernet device available to the system.
249     
250 ======================================================================*/
251
252 #define CS_CHECK(fn, ret) \
253 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
254
255 static int tc589_config(struct pcmcia_device *link)
256 {
257     struct net_device *dev = link->priv;
258     struct el3_private *lp = netdev_priv(dev);
259     __be16 *phys_addr;
260     int last_fn, last_ret, i, j, multi = 0, fifo;
261     unsigned int ioaddr;
262     char *ram_split[] = {"5:3", "3:1", "1:1", "3:5"};
263     u8 *buf;
264     size_t len;
265     
266     DEBUG(0, "3c589_config(0x%p)\n", link);
267
268     phys_addr = (__be16 *)dev->dev_addr;
269     /* Is this a 3c562? */
270     if (link->manf_id != MANFID_3COM)
271             printk(KERN_INFO "3c589_cs: hmmm, is this really a "
272                    "3Com card??\n");
273     multi = (link->card_id == PRODID_3COM_3C562);
274
275     /* For the 3c562, the base address must be xx00-xx7f */
276     link->io.IOAddrLines = 16;
277     for (i = j = 0; j < 0x400; j += 0x10) {
278         if (multi && (j & 0x80)) continue;
279         link->io.BasePort1 = j ^ 0x300;
280         i = pcmcia_request_io(link, &link->io);
281         if (i == 0)
282                 break;
283     }
284     if (i != 0) {
285         cs_error(link, RequestIO, i);
286         goto failed;
287     }
288     CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
289     CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
290         
291     dev->irq = link->irq.AssignedIRQ;
292     dev->base_addr = link->io.BasePort1;
293     ioaddr = dev->base_addr;
294     EL3WINDOW(0);
295
296     /* The 3c589 has an extra EEPROM for configuration info, including
297        the hardware address.  The 3c562 puts the address in the CIS. */
298     len = pcmcia_get_tuple(link, 0x88, &buf);
299     if (buf && len >= 6) {
300             for (i = 0; i < 3; i++)
301                     phys_addr[i] = htons(le16_to_cpu(buf[i*2]));
302             kfree(buf);
303     } else {
304         kfree(buf); /* 0 < len < 6 */
305         for (i = 0; i < 3; i++)
306             phys_addr[i] = htons(read_eeprom(ioaddr, i));
307         if (phys_addr[0] == htons(0x6060)) {
308             printk(KERN_ERR "3c589_cs: IO port conflict at 0x%03lx"
309                    "-0x%03lx\n", dev->base_addr, dev->base_addr+15);
310             goto failed;
311         }
312     }
313
314     /* The address and resource configuration register aren't loaded from
315        the EEPROM and *must* be set to 0 and IRQ3 for the PCMCIA version. */
316     outw(0x3f00, ioaddr + 8);
317     fifo = inl(ioaddr);
318
319     /* The if_port symbol can be set when the module is loaded */
320     if ((if_port >= 0) && (if_port <= 3))
321         dev->if_port = if_port;
322     else
323         printk(KERN_ERR "3c589_cs: invalid if_port requested\n");
324     
325     link->dev_node = &lp->node;
326     SET_NETDEV_DEV(dev, &handle_to_dev(link));
327
328     if (register_netdev(dev) != 0) {
329         printk(KERN_ERR "3c589_cs: register_netdev() failed\n");
330         link->dev_node = NULL;
331         goto failed;
332     }
333
334     strcpy(lp->node.dev_name, dev->name);
335
336     printk(KERN_INFO "%s: 3Com 3c%s, io %#3lx, irq %d, "
337            "hw_addr %pM\n",
338            dev->name, (multi ? "562" : "589"), dev->base_addr, dev->irq,
339            dev->dev_addr);
340     printk(KERN_INFO "  %dK FIFO split %s Rx:Tx, %s xcvr\n",
341            (fifo & 7) ? 32 : 8, ram_split[(fifo >> 16) & 3],
342            if_names[dev->if_port]);
343     return 0;
344
345 cs_failed:
346     cs_error(link, last_fn, last_ret);
347 failed:
348     tc589_release(link);
349     return -ENODEV;
350 } /* tc589_config */
351
352 /*======================================================================
353
354     After a card is removed, tc589_release() will unregister the net
355     device, and release the PCMCIA configuration.  If the device is
356     still open, this will be postponed until it is closed.
357     
358 ======================================================================*/
359
360 static void tc589_release(struct pcmcia_device *link)
361 {
362         pcmcia_disable_device(link);
363 }
364
365 static int tc589_suspend(struct pcmcia_device *link)
366 {
367         struct net_device *dev = link->priv;
368
369         if (link->open)
370                 netif_device_detach(dev);
371
372         return 0;
373 }
374
375 static int tc589_resume(struct pcmcia_device *link)
376 {
377         struct net_device *dev = link->priv;
378
379         if (link->open) {
380                 tc589_reset(dev);
381                 netif_device_attach(dev);
382         }
383
384         return 0;
385 }
386
387 /*====================================================================*/
388
389 /*
390   Use this for commands that may take time to finish
391 */
392 static void tc589_wait_for_completion(struct net_device *dev, int cmd)
393 {
394     int i = 100;
395     outw(cmd, dev->base_addr + EL3_CMD);
396     while (--i > 0)
397         if (!(inw(dev->base_addr + EL3_STATUS) & 0x1000)) break;
398     if (i == 0)
399         printk(KERN_WARNING "%s: command 0x%04x did not complete!\n",
400                dev->name, cmd);
401 }
402
403 /*
404   Read a word from the EEPROM using the regular EEPROM access register.
405   Assume that we are in register window zero.
406 */
407 static u16 read_eeprom(unsigned int ioaddr, int index)
408 {
409     int i;
410     outw(EEPROM_READ + index, ioaddr + 10);
411     /* Reading the eeprom takes 162 us */
412     for (i = 1620; i >= 0; i--)
413         if ((inw(ioaddr + 10) & EEPROM_BUSY) == 0)
414             break;
415     return inw(ioaddr + 12);
416 }
417
418 /*
419   Set transceiver type, perhaps to something other than what the user
420   specified in dev->if_port.
421 */
422 static void tc589_set_xcvr(struct net_device *dev, int if_port)
423 {
424     struct el3_private *lp = netdev_priv(dev);
425     unsigned int ioaddr = dev->base_addr;
426     
427     EL3WINDOW(0);
428     switch (if_port) {
429     case 0: case 1: outw(0, ioaddr + 6); break;
430     case 2: outw(3<<14, ioaddr + 6); break;
431     case 3: outw(1<<14, ioaddr + 6); break;
432     }
433     /* On PCMCIA, this just turns on the LED */
434     outw((if_port == 2) ? StartCoax : StopCoax, ioaddr + EL3_CMD);
435     /* 10baseT interface, enable link beat and jabber check. */
436     EL3WINDOW(4);
437     outw(MEDIA_LED | ((if_port < 2) ? MEDIA_TP : 0), ioaddr + WN4_MEDIA);
438     EL3WINDOW(1);
439     if (if_port == 2)
440         lp->media_status = ((dev->if_port == 0) ? 0x8000 : 0x4000);
441     else
442         lp->media_status = ((dev->if_port == 0) ? 0x4010 : 0x8800);
443 }
444
445 static void dump_status(struct net_device *dev)
446 {
447     unsigned int ioaddr = dev->base_addr;
448     EL3WINDOW(1);
449     printk(KERN_INFO "  irq status %04x, rx status %04x, tx status "
450            "%02x  tx free %04x\n", inw(ioaddr+EL3_STATUS),
451            inw(ioaddr+RX_STATUS), inb(ioaddr+TX_STATUS),
452            inw(ioaddr+TX_FREE));
453     EL3WINDOW(4);
454     printk(KERN_INFO "  diagnostics: fifo %04x net %04x ethernet %04x"
455            " media %04x\n", inw(ioaddr+0x04), inw(ioaddr+0x06),
456            inw(ioaddr+0x08), inw(ioaddr+0x0a));
457     EL3WINDOW(1);
458 }
459
460 /* Reset and restore all of the 3c589 registers. */
461 static void tc589_reset(struct net_device *dev)
462 {
463     unsigned int ioaddr = dev->base_addr;
464     int i;
465     
466     EL3WINDOW(0);
467     outw(0x0001, ioaddr + 4);                   /* Activate board. */ 
468     outw(0x3f00, ioaddr + 8);                   /* Set the IRQ line. */
469     
470     /* Set the station address in window 2. */
471     EL3WINDOW(2);
472     for (i = 0; i < 6; i++)
473         outb(dev->dev_addr[i], ioaddr + i);
474
475     tc589_set_xcvr(dev, dev->if_port);
476     
477     /* Switch to the stats window, and clear all stats by reading. */
478     outw(StatsDisable, ioaddr + EL3_CMD);
479     EL3WINDOW(6);
480     for (i = 0; i < 9; i++)
481         inb(ioaddr+i);
482     inw(ioaddr + 10);
483     inw(ioaddr + 12);
484     
485     /* Switch to register set 1 for normal use. */
486     EL3WINDOW(1);
487
488     set_rx_mode(dev);
489     outw(StatsEnable, ioaddr + EL3_CMD); /* Turn on statistics. */
490     outw(RxEnable, ioaddr + EL3_CMD); /* Enable the receiver. */
491     outw(TxEnable, ioaddr + EL3_CMD); /* Enable transmitter. */
492     /* Allow status bits to be seen. */
493     outw(SetStatusEnb | 0xff, ioaddr + EL3_CMD);
494     /* Ack all pending events, and set active indicator mask. */
495     outw(AckIntr | IntLatch | TxAvailable | RxEarly | IntReq,
496          ioaddr + EL3_CMD);
497     outw(SetIntrEnb | IntLatch | TxAvailable | RxComplete | StatsFull
498          | AdapterFailure, ioaddr + EL3_CMD);
499 }
500
501 static void netdev_get_drvinfo(struct net_device *dev,
502                                struct ethtool_drvinfo *info)
503 {
504         strcpy(info->driver, DRV_NAME);
505         strcpy(info->version, DRV_VERSION);
506         sprintf(info->bus_info, "PCMCIA 0x%lx", dev->base_addr);
507 }
508
509 #ifdef PCMCIA_DEBUG
510 static u32 netdev_get_msglevel(struct net_device *dev)
511 {
512         return pc_debug;
513 }
514
515 static void netdev_set_msglevel(struct net_device *dev, u32 level)
516 {
517         pc_debug = level;
518 }
519 #endif /* PCMCIA_DEBUG */
520
521 static const struct ethtool_ops netdev_ethtool_ops = {
522         .get_drvinfo            = netdev_get_drvinfo,
523 #ifdef PCMCIA_DEBUG
524         .get_msglevel           = netdev_get_msglevel,
525         .set_msglevel           = netdev_set_msglevel,
526 #endif /* PCMCIA_DEBUG */
527 };
528
529 static int el3_config(struct net_device *dev, struct ifmap *map)
530 {
531     if ((map->port != (u_char)(-1)) && (map->port != dev->if_port)) {
532         if (map->port <= 3) {
533             dev->if_port = map->port;
534             printk(KERN_INFO "%s: switched to %s port\n",
535                    dev->name, if_names[dev->if_port]);
536             tc589_set_xcvr(dev, dev->if_port);
537         } else
538             return -EINVAL;
539     }
540     return 0;
541 }
542
543 static int el3_open(struct net_device *dev)
544 {
545     struct el3_private *lp = netdev_priv(dev);
546     struct pcmcia_device *link = lp->p_dev;
547     
548     if (!pcmcia_dev_present(link))
549         return -ENODEV;
550
551     link->open++;
552     netif_start_queue(dev);
553     
554     tc589_reset(dev);
555     init_timer(&lp->media);
556     lp->media.function = &media_check;
557     lp->media.data = (unsigned long) dev;
558     lp->media.expires = jiffies + HZ;
559     add_timer(&lp->media);
560
561     DEBUG(1, "%s: opened, status %4.4x.\n",
562           dev->name, inw(dev->base_addr + EL3_STATUS));
563     
564     return 0;
565 }
566
567 static void el3_tx_timeout(struct net_device *dev)
568 {
569     unsigned int ioaddr = dev->base_addr;
570     
571     printk(KERN_WARNING "%s: Transmit timed out!\n", dev->name);
572     dump_status(dev);
573     dev->stats.tx_errors++;
574     dev->trans_start = jiffies;
575     /* Issue TX_RESET and TX_START commands. */
576     tc589_wait_for_completion(dev, TxReset);
577     outw(TxEnable, ioaddr + EL3_CMD);
578     netif_wake_queue(dev);
579 }
580
581 static void pop_tx_status(struct net_device *dev)
582 {
583     unsigned int ioaddr = dev->base_addr;
584     int i;
585     
586     /* Clear the Tx status stack. */
587     for (i = 32; i > 0; i--) {
588         u_char tx_status = inb(ioaddr + TX_STATUS);
589         if (!(tx_status & 0x84)) break;
590         /* reset transmitter on jabber error or underrun */
591         if (tx_status & 0x30)
592             tc589_wait_for_completion(dev, TxReset);
593         if (tx_status & 0x38) {
594             DEBUG(1, "%s: transmit error: status 0x%02x\n",
595                   dev->name, tx_status);
596             outw(TxEnable, ioaddr + EL3_CMD);
597             dev->stats.tx_aborted_errors++;
598         }
599         outb(0x00, ioaddr + TX_STATUS); /* Pop the status stack. */
600     }
601 }
602
603 static netdev_tx_t el3_start_xmit(struct sk_buff *skb,
604                                         struct net_device *dev)
605 {
606     unsigned int ioaddr = dev->base_addr;
607     struct el3_private *priv = netdev_priv(dev);
608     unsigned long flags;
609
610     DEBUG(3, "%s: el3_start_xmit(length = %ld) called, "
611           "status %4.4x.\n", dev->name, (long)skb->len,
612           inw(ioaddr + EL3_STATUS));
613
614     spin_lock_irqsave(&priv->lock, flags);    
615
616     dev->stats.tx_bytes += skb->len;
617
618     /* Put out the doubleword header... */
619     outw(skb->len, ioaddr + TX_FIFO);
620     outw(0x00, ioaddr + TX_FIFO);
621     /* ... and the packet rounded to a doubleword. */
622     outsl(ioaddr + TX_FIFO, skb->data, (skb->len + 3) >> 2);
623
624     dev->trans_start = jiffies;
625     if (inw(ioaddr + TX_FREE) <= 1536) {
626         netif_stop_queue(dev);
627         /* Interrupt us when the FIFO has room for max-sized packet. */
628         outw(SetTxThreshold + 1536, ioaddr + EL3_CMD);
629     }
630
631     pop_tx_status(dev);
632     spin_unlock_irqrestore(&priv->lock, flags);    
633     dev_kfree_skb(skb);
634     
635     return NETDEV_TX_OK;
636 }
637
638 /* The EL3 interrupt handler. */
639 static irqreturn_t el3_interrupt(int irq, void *dev_id)
640 {
641     struct net_device *dev = (struct net_device *) dev_id;
642     struct el3_private *lp = netdev_priv(dev);
643     unsigned int ioaddr;
644     __u16 status;
645     int i = 0, handled = 1;
646     
647     if (!netif_device_present(dev))
648         return IRQ_NONE;
649
650     ioaddr = dev->base_addr;
651
652     DEBUG(3, "%s: interrupt, status %4.4x.\n",
653           dev->name, inw(ioaddr + EL3_STATUS));
654
655     spin_lock(&lp->lock);    
656     while ((status = inw(ioaddr + EL3_STATUS)) &
657         (IntLatch | RxComplete | StatsFull)) {
658         if ((status & 0xe000) != 0x2000) {
659             DEBUG(1, "%s: interrupt from dead card\n", dev->name);
660             handled = 0;
661             break;
662         }
663         
664         if (status & RxComplete)
665             el3_rx(dev);
666         
667         if (status & TxAvailable) {
668             DEBUG(3, "    TX room bit was handled.\n");
669             /* There's room in the FIFO for a full-sized packet. */
670             outw(AckIntr | TxAvailable, ioaddr + EL3_CMD);
671             netif_wake_queue(dev);
672         }
673         
674         if (status & TxComplete)
675             pop_tx_status(dev);
676
677         if (status & (AdapterFailure | RxEarly | StatsFull)) {
678             /* Handle all uncommon interrupts. */
679             if (status & StatsFull)             /* Empty statistics. */
680                 update_stats(dev);
681             if (status & RxEarly) {             /* Rx early is unused. */
682                 el3_rx(dev);
683                 outw(AckIntr | RxEarly, ioaddr + EL3_CMD);
684             }
685             if (status & AdapterFailure) {
686                 u16 fifo_diag;
687                 EL3WINDOW(4);
688                 fifo_diag = inw(ioaddr + 4);
689                 EL3WINDOW(1);
690                 printk(KERN_WARNING "%s: adapter failure, FIFO diagnostic"
691                        " register %04x.\n", dev->name, fifo_diag);
692                 if (fifo_diag & 0x0400) {
693                     /* Tx overrun */
694                     tc589_wait_for_completion(dev, TxReset);
695                     outw(TxEnable, ioaddr + EL3_CMD);
696                 }
697                 if (fifo_diag & 0x2000) {
698                     /* Rx underrun */
699                     tc589_wait_for_completion(dev, RxReset);
700                     set_rx_mode(dev);
701                     outw(RxEnable, ioaddr + EL3_CMD);
702                 }
703                 outw(AckIntr | AdapterFailure, ioaddr + EL3_CMD);
704             }
705         }
706         
707         if (++i > 10) {
708             printk(KERN_ERR "%s: infinite loop in interrupt, "
709                    "status %4.4x.\n", dev->name, status);
710             /* Clear all interrupts */
711             outw(AckIntr | 0xFF, ioaddr + EL3_CMD);
712             break;
713         }
714         /* Acknowledge the IRQ. */
715         outw(AckIntr | IntReq | IntLatch, ioaddr + EL3_CMD);
716     }
717
718     lp->last_irq = jiffies;
719     spin_unlock(&lp->lock);    
720     DEBUG(3, "%s: exiting interrupt, status %4.4x.\n",
721           dev->name, inw(ioaddr + EL3_STATUS));
722     return IRQ_RETVAL(handled);
723 }
724
725 static void media_check(unsigned long arg)
726 {
727     struct net_device *dev = (struct net_device *)(arg);
728     struct el3_private *lp = netdev_priv(dev);
729     unsigned int ioaddr = dev->base_addr;
730     u16 media, errs;
731     unsigned long flags;
732
733     if (!netif_device_present(dev)) goto reschedule;
734
735     /* Check for pending interrupt with expired latency timer: with
736        this, we can limp along even if the interrupt is blocked */
737     if ((inw(ioaddr + EL3_STATUS) & IntLatch) &&
738         (inb(ioaddr + EL3_TIMER) == 0xff)) {
739         if (!lp->fast_poll)
740             printk(KERN_WARNING "%s: interrupt(s) dropped!\n", dev->name);
741         el3_interrupt(dev->irq, dev);
742         lp->fast_poll = HZ;
743     }
744     if (lp->fast_poll) {
745         lp->fast_poll--;
746         lp->media.expires = jiffies + HZ/100;
747         add_timer(&lp->media);
748         return;
749     }
750
751     /* lp->lock guards the EL3 window. Window should always be 1 except
752        when the lock is held */
753     spin_lock_irqsave(&lp->lock, flags);    
754     EL3WINDOW(4);
755     media = inw(ioaddr+WN4_MEDIA) & 0xc810;
756
757     /* Ignore collisions unless we've had no irq's recently */
758     if (time_before(jiffies, lp->last_irq + HZ)) {
759         media &= ~0x0010;
760     } else {
761         /* Try harder to detect carrier errors */
762         EL3WINDOW(6);
763         outw(StatsDisable, ioaddr + EL3_CMD);
764         errs = inb(ioaddr + 0);
765         outw(StatsEnable, ioaddr + EL3_CMD);
766         dev->stats.tx_carrier_errors += errs;
767         if (errs || (lp->media_status & 0x0010)) media |= 0x0010;
768     }
769
770     if (media != lp->media_status) {
771         if ((media & lp->media_status & 0x8000) &&
772             ((lp->media_status ^ media) & 0x0800))
773             printk(KERN_INFO "%s: %s link beat\n", dev->name,
774                    (lp->media_status & 0x0800 ? "lost" : "found"));
775         else if ((media & lp->media_status & 0x4000) &&
776                  ((lp->media_status ^ media) & 0x0010))
777             printk(KERN_INFO "%s: coax cable %s\n", dev->name,
778                    (lp->media_status & 0x0010 ? "ok" : "problem"));
779         if (dev->if_port == 0) {
780             if (media & 0x8000) {
781                 if (media & 0x0800)
782                     printk(KERN_INFO "%s: flipped to 10baseT\n",
783                            dev->name);
784                 else
785                     tc589_set_xcvr(dev, 2);
786             } else if (media & 0x4000) {
787                 if (media & 0x0010)
788                     tc589_set_xcvr(dev, 1);
789                 else
790                     printk(KERN_INFO "%s: flipped to 10base2\n",
791                            dev->name);
792             }
793         }
794         lp->media_status = media;
795     }
796     
797     EL3WINDOW(1);
798     spin_unlock_irqrestore(&lp->lock, flags);    
799
800 reschedule:
801     lp->media.expires = jiffies + HZ;
802     add_timer(&lp->media);
803 }
804
805 static struct net_device_stats *el3_get_stats(struct net_device *dev)
806 {
807     struct el3_private *lp = netdev_priv(dev);
808     unsigned long flags;
809     struct pcmcia_device *link = lp->p_dev;
810
811     if (pcmcia_dev_present(link)) {
812         spin_lock_irqsave(&lp->lock, flags);
813         update_stats(dev);
814         spin_unlock_irqrestore(&lp->lock, flags);
815     }
816     return &dev->stats;
817 }
818
819 /*
820   Update statistics.  We change to register window 6, so this should be run
821   single-threaded if the device is active. This is expected to be a rare
822   operation, and it's simpler for the rest of the driver to assume that
823   window 1 is always valid rather than use a special window-state variable.
824   
825   Caller must hold the lock for this
826 */
827 static void update_stats(struct net_device *dev)
828 {
829     unsigned int ioaddr = dev->base_addr;
830
831     DEBUG(2, "%s: updating the statistics.\n", dev->name);
832     /* Turn off statistics updates while reading. */
833     outw(StatsDisable, ioaddr + EL3_CMD);
834     /* Switch to the stats window, and read everything. */
835     EL3WINDOW(6);
836     dev->stats.tx_carrier_errors        += inb(ioaddr + 0);
837     dev->stats.tx_heartbeat_errors      += inb(ioaddr + 1);
838     /* Multiple collisions. */          inb(ioaddr + 2);
839     dev->stats.collisions               += inb(ioaddr + 3);
840     dev->stats.tx_window_errors         += inb(ioaddr + 4);
841     dev->stats.rx_fifo_errors           += inb(ioaddr + 5);
842     dev->stats.tx_packets               += inb(ioaddr + 6);
843     /* Rx packets   */                  inb(ioaddr + 7);
844     /* Tx deferrals */                  inb(ioaddr + 8);
845     /* Rx octets */                     inw(ioaddr + 10);
846     /* Tx octets */                     inw(ioaddr + 12);
847     
848     /* Back to window 1, and turn statistics back on. */
849     EL3WINDOW(1);
850     outw(StatsEnable, ioaddr + EL3_CMD);
851 }
852
853 static int el3_rx(struct net_device *dev)
854 {
855     unsigned int ioaddr = dev->base_addr;
856     int worklimit = 32;
857     short rx_status;
858     
859     DEBUG(3, "%s: in rx_packet(), status %4.4x, rx_status %4.4x.\n",
860           dev->name, inw(ioaddr+EL3_STATUS), inw(ioaddr+RX_STATUS));
861     while (!((rx_status = inw(ioaddr + RX_STATUS)) & 0x8000) &&
862                     worklimit > 0) {
863         worklimit--;
864         if (rx_status & 0x4000) { /* Error, update stats. */
865             short error = rx_status & 0x3800;
866             dev->stats.rx_errors++;
867             switch (error) {
868             case 0x0000:        dev->stats.rx_over_errors++; break;
869             case 0x0800:        dev->stats.rx_length_errors++; break;
870             case 0x1000:        dev->stats.rx_frame_errors++; break;
871             case 0x1800:        dev->stats.rx_length_errors++; break;
872             case 0x2000:        dev->stats.rx_frame_errors++; break;
873             case 0x2800:        dev->stats.rx_crc_errors++; break;
874             }
875         } else {
876             short pkt_len = rx_status & 0x7ff;
877             struct sk_buff *skb;
878             
879             skb = dev_alloc_skb(pkt_len+5);
880             
881             DEBUG(3, "    Receiving packet size %d status %4.4x.\n",
882                   pkt_len, rx_status);
883             if (skb != NULL) {
884                 skb_reserve(skb, 2);
885                 insl(ioaddr+RX_FIFO, skb_put(skb, pkt_len),
886                         (pkt_len+3)>>2);
887                 skb->protocol = eth_type_trans(skb, dev);
888                 netif_rx(skb);
889                 dev->stats.rx_packets++;
890                 dev->stats.rx_bytes += pkt_len;
891             } else {
892                 DEBUG(1, "%s: couldn't allocate a sk_buff of"
893                       " size %d.\n", dev->name, pkt_len);
894                 dev->stats.rx_dropped++;
895             }
896         }
897         /* Pop the top of the Rx FIFO */
898         tc589_wait_for_completion(dev, RxDiscard);
899     }
900     if (worklimit == 0)
901         printk(KERN_WARNING "%s: too much work in el3_rx!\n", dev->name);
902     return 0;
903 }
904
905 static void set_rx_mode(struct net_device *dev)
906 {
907     unsigned int ioaddr = dev->base_addr;
908     u16 opts = SetRxFilter | RxStation | RxBroadcast;
909
910     if (dev->flags & IFF_PROMISC)
911         opts |= RxMulticast | RxProm;
912     else if (dev->mc_count || (dev->flags & IFF_ALLMULTI))
913         opts |= RxMulticast;
914     outw(opts, ioaddr + EL3_CMD);
915 }
916
917 static void set_multicast_list(struct net_device *dev)
918 {
919         struct el3_private *priv = netdev_priv(dev);
920         unsigned long flags;
921
922         spin_lock_irqsave(&priv->lock, flags);
923         set_rx_mode(dev);
924         spin_unlock_irqrestore(&priv->lock, flags);
925 }
926
927 static int el3_close(struct net_device *dev)
928 {
929     struct el3_private *lp = netdev_priv(dev);
930     struct pcmcia_device *link = lp->p_dev;
931     unsigned int ioaddr = dev->base_addr;
932     
933     DEBUG(1, "%s: shutting down ethercard.\n", dev->name);
934
935     if (pcmcia_dev_present(link)) {
936         /* Turn off statistics ASAP.  We update dev->stats below. */
937         outw(StatsDisable, ioaddr + EL3_CMD);
938         
939         /* Disable the receiver and transmitter. */
940         outw(RxDisable, ioaddr + EL3_CMD);
941         outw(TxDisable, ioaddr + EL3_CMD);
942         
943         if (dev->if_port == 2)
944             /* Turn off thinnet power.  Green! */
945             outw(StopCoax, ioaddr + EL3_CMD);
946         else if (dev->if_port == 1) {
947             /* Disable link beat and jabber */
948             EL3WINDOW(4);
949             outw(0, ioaddr + WN4_MEDIA);
950         }
951         
952         /* Switching back to window 0 disables the IRQ. */
953         EL3WINDOW(0);
954         /* But we explicitly zero the IRQ line select anyway. */
955         outw(0x0f00, ioaddr + WN0_IRQ);
956         
957         /* Check if the card still exists */
958         if ((inw(ioaddr+EL3_STATUS) & 0xe000) == 0x2000)
959             update_stats(dev);
960     }
961
962     link->open--;
963     netif_stop_queue(dev);
964     del_timer_sync(&lp->media);
965     
966     return 0;
967 }
968
969 static struct pcmcia_device_id tc589_ids[] = {
970         PCMCIA_MFC_DEVICE_MANF_CARD(0, 0x0101, 0x0562),
971         PCMCIA_MFC_DEVICE_PROD_ID1(0, "Motorola MARQUIS", 0xf03e4e77),
972         PCMCIA_DEVICE_MANF_CARD(0x0101, 0x0589),
973         PCMCIA_DEVICE_PROD_ID12("Farallon", "ENet", 0x58d93fc4, 0x992c2202),
974         PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x0035, "cis/3CXEM556.cis"),
975         PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x003d, "cis/3CXEM556.cis"),
976         PCMCIA_DEVICE_NULL,
977 };
978 MODULE_DEVICE_TABLE(pcmcia, tc589_ids);
979
980 static struct pcmcia_driver tc589_driver = {
981         .owner          = THIS_MODULE,
982         .drv            = {
983                 .name   = "3c589_cs",
984         },
985         .probe          = tc589_probe,
986         .remove         = tc589_detach,
987         .id_table       = tc589_ids,
988         .suspend        = tc589_suspend,
989         .resume         = tc589_resume,
990 };
991
992 static int __init init_tc589(void)
993 {
994         return pcmcia_register_driver(&tc589_driver);
995 }
996
997 static void __exit exit_tc589(void)
998 {
999         pcmcia_unregister_driver(&tc589_driver);
1000 }
1001
1002 module_init(init_tc589);
1003 module_exit(exit_tc589);