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