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