1 /* 3c509.c: A 3c509 EtherLink3 ethernet driver for linux. */
3 Written 1993-2000 by Donald Becker.
5 Copyright 1994-2000 by Donald Becker.
6 Copyright 1993 United States Government as represented by the
7 Director, National Security Agency. This software may be used and
8 distributed according to the terms of the GNU General Public License,
9 incorporated herein by reference.
11 This driver is for the 3Com EtherLinkIII series.
13 The author may be reached as becker@scyld.com, or C/O
14 Scyld Computing Corporation
15 410 Severn Ave., Suite 210
19 Because of the way 3c509 ISA detection works it's difficult to predict
20 a priori which of several ISA-mode cards will be detected first.
22 This driver does not use predictive interrupt mode, resulting in higher
23 packet latency but lower overhead. If interrupts are disabled for an
24 unusually long time it could also result in missed packets, but in
25 practice this rarely happens.
29 Alan Cox: Removed the 'Unexpected interrupt' bug.
30 Michael Meskes: Upgraded to Donald Becker's version 1.07.
31 Alan Cox: Increased the eeprom delay. Regardless of
32 what the docs say some people definitely
33 get problems with lower (but in card spec)
35 v1.10 4/21/97 Fixed module code so that multiple cards may be detected,
37 Andrea Arcangeli: Upgraded to Donald Becker's version 1.12.
38 Rick Payne: Fixed SMP race condition
39 v1.13 9/8/97 Made 'max_interrupt_work' an insmod-settable variable -djb
40 v1.14 10/15/97 Avoided waiting..discard message for fast machines -djb
41 v1.15 1/31/98 Faster recovery for Tx errors. -djb
42 v1.16 2/3/98 Different ID port handling to avoid sound cards. -djb
43 v1.18 12Mar2001 Andrew Morton
44 - Avoid bogus detect of 3c590's (Andrzej Krzysztofowicz)
45 - Reviewed against 1.18 from scyld.com
46 v1.18a 17Nov2001 Jeff Garzik <jgarzik@pobox.com>
48 v1.18b 1Mar2002 Zwane Mwaikambo <zwane@commfireservices.com>
49 - Power Management support
50 v1.18c 1Mar2002 David Ruggiero <jdr@farfalle.com>
52 v1.19 16Oct2002 Zwane Mwaikambo <zwane@linuxpower.ca>
53 - Additional ethtool features
54 v1.19a 28Oct2002 Davud Ruggiero <jdr@farfalle.com>
55 - Increase *read_eeprom udelay to workaround oops with 2 cards.
56 v1.19b 08Nov2002 Marc Zyngier <maz@wild-wind.fr.eu.org>
57 - Introduce driver model for EISA cards.
58 v1.20 04Feb2008 Ondrej Zary <linux@rainbow-software.org>
59 - convert to isa_driver and pnp_driver and some cleanups
62 #define DRV_NAME "3c509"
63 #define DRV_VERSION "1.20"
64 #define DRV_RELDATE "04Feb2008"
66 /* A few values that may be tweaked. */
68 /* Time in jiffies before concluding the transmitter is hung. */
69 #define TX_TIMEOUT (400*HZ/1000)
71 #include <linux/module.h>
72 #include <linux/isa.h>
73 #include <linux/pnp.h>
74 #include <linux/string.h>
75 #include <linux/interrupt.h>
76 #include <linux/errno.h>
78 #include <linux/ioport.h>
79 #include <linux/init.h>
80 #include <linux/netdevice.h>
81 #include <linux/etherdevice.h>
83 #include <linux/skbuff.h>
84 #include <linux/delay.h> /* for udelay() */
85 #include <linux/spinlock.h>
86 #include <linux/ethtool.h>
87 #include <linux/device.h>
88 #include <linux/eisa.h>
89 #include <linux/bitops.h>
91 #include <asm/uaccess.h>
95 static char version[] = DRV_NAME ".c:" DRV_VERSION " " DRV_RELDATE " becker@scyld.com\n";
98 static int el3_debug = EL3_DEBUG;
100 static int el3_debug = 2;
103 /* Used to do a global count of all the cards in the system. Must be
104 * a global variable so that the eisa probe routines can increment
106 static int el3_cards = 0;
107 #define EL3_MAX_CARDS 8
109 /* To minimize the size of the driver source I only define operating
110 constants if they are used several times. You'll need the manual
111 anyway if you want to understand driver details. */
112 /* Offsets from base I/O address. */
113 #define EL3_DATA 0x00
115 #define EL3_STATUS 0x0e
116 #define EEPROM_READ 0x80
118 #define EL3_IO_EXTENT 16
120 #define EL3WINDOW(win_num) outw(SelectWindow + (win_num), ioaddr + EL3_CMD)
123 /* The top five bits written to EL3_CMD are a command, the lower
124 11 bits are the parameter, if applicable. */
126 TotalReset = 0<<11, SelectWindow = 1<<11, StartCoax = 2<<11,
127 RxDisable = 3<<11, RxEnable = 4<<11, RxReset = 5<<11, RxDiscard = 8<<11,
128 TxEnable = 9<<11, TxDisable = 10<<11, TxReset = 11<<11,
129 FakeIntr = 12<<11, AckIntr = 13<<11, SetIntrEnb = 14<<11,
130 SetStatusEnb = 15<<11, SetRxFilter = 16<<11, SetRxThreshold = 17<<11,
131 SetTxThreshold = 18<<11, SetTxStart = 19<<11, StatsEnable = 21<<11,
132 StatsDisable = 22<<11, StopCoax = 23<<11, PowerUp = 27<<11,
133 PowerDown = 28<<11, PowerAuto = 29<<11};
136 IntLatch = 0x0001, AdapterFailure = 0x0002, TxComplete = 0x0004,
137 TxAvailable = 0x0008, RxComplete = 0x0010, RxEarly = 0x0020,
138 IntReq = 0x0040, StatsFull = 0x0080, CmdBusy = 0x1000, };
140 /* The SetRxFilter command accepts the following classes: */
142 RxStation = 1, RxMulticast = 2, RxBroadcast = 4, RxProm = 8 };
144 /* Register window 1 offsets, the window used in normal operation. */
147 #define RX_STATUS 0x08
148 #define TX_STATUS 0x0B
149 #define TX_FREE 0x0C /* Remaining free bytes in Tx buffer. */
151 #define WN0_CONF_CTRL 0x04 /* Window 0: Configuration control register */
152 #define WN0_ADDR_CONF 0x06 /* Window 0: Address configuration register */
153 #define WN0_IRQ 0x08 /* Window 0: Set IRQ line in bits 12-15. */
154 #define WN4_MEDIA 0x0A /* Window 4: Various transcvr/media bits. */
155 #define MEDIA_TP 0x00C0 /* Enable link beat and jabber for 10baseT. */
156 #define WN4_NETDIAG 0x06 /* Window 4: Net diagnostic */
157 #define FD_ENABLE 0x8000 /* Enable full-duplex ("external loopback") */
160 * Must be a power of two (we use a binary and in the
163 #define SKB_QUEUE_SIZE 64
165 enum el3_cardtype { EL3_ISA, EL3_PNP, EL3_EISA };
171 struct sk_buff *queue[SKB_QUEUE_SIZE];
172 enum el3_cardtype type;
175 static int current_tag;
176 static struct net_device *el3_devs[EL3_MAX_CARDS];
178 /* Parameters that may be passed into the module. */
179 static int debug = -1;
180 static int irq[] = {-1, -1, -1, -1, -1, -1, -1, -1};
181 /* Maximum events (Rx packets, etc.) to handle at each interrupt. */
182 static int max_interrupt_work = 10;
187 static int el3_common_init(struct net_device *dev);
188 static void el3_common_remove(struct net_device *dev);
189 static ushort id_read_eeprom(int index);
190 static ushort read_eeprom(int ioaddr, int index);
191 static int el3_open(struct net_device *dev);
192 static netdev_tx_t el3_start_xmit(struct sk_buff *skb, struct net_device *dev);
193 static irqreturn_t el3_interrupt(int irq, void *dev_id);
194 static void update_stats(struct net_device *dev);
195 static struct net_device_stats *el3_get_stats(struct net_device *dev);
196 static int el3_rx(struct net_device *dev);
197 static int el3_close(struct net_device *dev);
198 static void set_multicast_list(struct net_device *dev);
199 static void el3_tx_timeout (struct net_device *dev);
200 static void el3_down(struct net_device *dev);
201 static void el3_up(struct net_device *dev);
202 static const struct ethtool_ops ethtool_ops;
204 static int el3_suspend(struct device *, pm_message_t);
205 static int el3_resume(struct device *);
207 #define el3_suspend NULL
208 #define el3_resume NULL
212 /* generic device remove for all device types */
213 static int el3_device_remove (struct device *device);
214 #ifdef CONFIG_NET_POLL_CONTROLLER
215 static void el3_poll_controller(struct net_device *dev);
218 /* Return 0 on success, 1 on error, 2 when found already detected PnP card */
219 static int el3_isa_id_sequence(__be16 *phys_addr)
221 short lrs_state = 0xff;
224 /* ISA boards are detected by sending the ID sequence to the
225 ID_PORT. We find cards past the first by setting the 'current_tag'
226 on cards as they are found. Cards with their tag set will not
227 respond to subsequent ID sequences. */
231 for (i = 0; i < 255; i++) {
232 outb(lrs_state, id_port);
234 lrs_state = lrs_state & 0x100 ? lrs_state ^ 0xcf : lrs_state;
236 /* For the first probe, clear all board's tag registers. */
237 if (current_tag == 0)
239 else /* Otherwise kill off already-found boards. */
241 if (id_read_eeprom(7) != 0x6d50)
243 /* Read in EEPROM data, which does contention-select.
244 Only the lowest address board will stay "on-line".
245 3Com got the byte order backwards. */
246 for (i = 0; i < 3; i++)
247 phys_addr[i] = htons(id_read_eeprom(i));
250 /* The ISA PnP 3c509 cards respond to the ID sequence too.
251 This check is needed in order not to register them twice. */
252 for (i = 0; i < el3_cards; i++) {
253 struct el3_private *lp = netdev_priv(el3_devs[i]);
254 if (lp->type == EL3_PNP &&
255 !memcmp(phys_addr, el3_devs[i]->dev_addr,
258 pr_debug("3c509 with address %02x %02x %02x %02x %02x %02x was found by ISAPnP\n",
259 phys_addr[0] & 0xff, phys_addr[0] >> 8,
260 phys_addr[1] & 0xff, phys_addr[1] >> 8,
261 phys_addr[2] & 0xff, phys_addr[2] >> 8);
262 /* Set the adaptor tag so that the next card can be found. */
263 outb(0xd0 + ++current_tag, id_port);
268 #endif /* CONFIG_PNP */
273 static void el3_dev_fill(struct net_device *dev, __be16 *phys_addr, int ioaddr,
274 int irq, int if_port, enum el3_cardtype type)
276 struct el3_private *lp = netdev_priv(dev);
278 memcpy(dev->dev_addr, phys_addr, ETH_ALEN);
279 dev->base_addr = ioaddr;
281 dev->if_port = if_port;
285 static int el3_isa_match(struct device *pdev, unsigned int ndev)
287 struct net_device *dev;
288 int ioaddr, isa_irq, if_port, err;
292 while ((err = el3_isa_id_sequence(phys_addr)) == 2)
293 ; /* Skip to next card when PnP card found */
297 iobase = id_read_eeprom(8);
298 if_port = iobase >> 14;
299 ioaddr = 0x200 + ((iobase & 0x1f) << 4);
300 if (irq[el3_cards] > 1 && irq[el3_cards] < 16)
301 isa_irq = irq[el3_cards];
303 isa_irq = id_read_eeprom(9) >> 12;
305 dev = alloc_etherdev(sizeof(struct el3_private));
309 netdev_boot_setup_check(dev);
311 if (!request_region(ioaddr, EL3_IO_EXTENT, "3c509-isa")) {
316 /* Set the adaptor tag so that the next card can be found. */
317 outb(0xd0 + ++current_tag, id_port);
319 /* Activate the adaptor at the EEPROM location. */
320 outb((ioaddr >> 4) | 0xe0, id_port);
323 if (inw(ioaddr) != 0x6d50) {
328 /* Free the interrupt so that some other card can use it. */
329 outw(0x0f00, ioaddr + WN0_IRQ);
331 el3_dev_fill(dev, phys_addr, ioaddr, isa_irq, if_port, EL3_ISA);
332 dev_set_drvdata(pdev, dev);
333 if (el3_common_init(dev)) {
338 el3_devs[el3_cards++] = dev;
342 static int el3_isa_remove(struct device *pdev,
345 el3_device_remove(pdev);
346 dev_set_drvdata(pdev, NULL);
351 static int el3_isa_suspend(struct device *dev, unsigned int n,
355 return el3_suspend(dev, state);
358 static int el3_isa_resume(struct device *dev, unsigned int n)
360 struct net_device *ndev = dev_get_drvdata(dev);
361 int ioaddr = ndev->base_addr, err;
364 while ((err = el3_isa_id_sequence(phys_addr)) == 2)
365 ; /* Skip to next card when PnP card found */
368 /* Set the adaptor tag so that the next card can be found. */
369 outb(0xd0 + ++current_tag, id_port);
370 /* Enable the card */
371 outb((ioaddr >> 4) | 0xe0, id_port);
373 if (inw(ioaddr) != 0x6d50)
375 /* Free the interrupt so that some other card can use it. */
376 outw(0x0f00, ioaddr + WN0_IRQ);
377 return el3_resume(dev);
381 static struct isa_driver el3_isa_driver = {
382 .match = el3_isa_match,
383 .remove = el3_isa_remove,
385 .suspend = el3_isa_suspend,
386 .resume = el3_isa_resume,
392 static int isa_registered;
395 static struct pnp_device_id el3_pnp_ids[] = {
396 { .id = "TCM5090" }, /* 3Com Etherlink III (TP) */
397 { .id = "TCM5091" }, /* 3Com Etherlink III */
398 { .id = "TCM5094" }, /* 3Com Etherlink III (combo) */
399 { .id = "TCM5095" }, /* 3Com Etherlink III (TPO) */
400 { .id = "TCM5098" }, /* 3Com Etherlink III (TPC) */
401 { .id = "PNP80f7" }, /* 3Com Etherlink III compatible */
402 { .id = "PNP80f8" }, /* 3Com Etherlink III compatible */
405 MODULE_DEVICE_TABLE(pnp, el3_pnp_ids);
407 static int el3_pnp_probe(struct pnp_dev *pdev, const struct pnp_device_id *id)
410 int ioaddr, irq, if_port;
412 struct net_device *dev = NULL;
415 ioaddr = pnp_port_start(pdev, 0);
416 if (!request_region(ioaddr, EL3_IO_EXTENT, "3c509-pnp"))
418 irq = pnp_irq(pdev, 0);
420 for (i = 0; i < 3; i++)
421 phys_addr[i] = htons(read_eeprom(ioaddr, i));
422 if_port = read_eeprom(ioaddr, 8) >> 14;
423 dev = alloc_etherdev(sizeof(struct el3_private));
425 release_region(ioaddr, EL3_IO_EXTENT);
428 SET_NETDEV_DEV(dev, &pdev->dev);
429 netdev_boot_setup_check(dev);
431 el3_dev_fill(dev, phys_addr, ioaddr, irq, if_port, EL3_PNP);
432 pnp_set_drvdata(pdev, dev);
433 err = el3_common_init(dev);
436 pnp_set_drvdata(pdev, NULL);
441 el3_devs[el3_cards++] = dev;
445 static void el3_pnp_remove(struct pnp_dev *pdev)
447 el3_common_remove(pnp_get_drvdata(pdev));
448 pnp_set_drvdata(pdev, NULL);
452 static int el3_pnp_suspend(struct pnp_dev *pdev, pm_message_t state)
454 return el3_suspend(&pdev->dev, state);
457 static int el3_pnp_resume(struct pnp_dev *pdev)
459 return el3_resume(&pdev->dev);
463 static struct pnp_driver el3_pnp_driver = {
465 .id_table = el3_pnp_ids,
466 .probe = el3_pnp_probe,
467 .remove = el3_pnp_remove,
469 .suspend = el3_pnp_suspend,
470 .resume = el3_pnp_resume,
473 static int pnp_registered;
474 #endif /* CONFIG_PNP */
477 static struct eisa_device_id el3_eisa_ids[] = {
487 MODULE_DEVICE_TABLE(eisa, el3_eisa_ids);
489 static int el3_eisa_probe (struct device *device);
491 static struct eisa_driver el3_eisa_driver = {
492 .id_table = el3_eisa_ids,
495 .probe = el3_eisa_probe,
496 .remove = el3_device_remove,
497 .suspend = el3_suspend,
498 .resume = el3_resume,
501 static int eisa_registered;
504 static const struct net_device_ops netdev_ops = {
505 .ndo_open = el3_open,
506 .ndo_stop = el3_close,
507 .ndo_start_xmit = el3_start_xmit,
508 .ndo_get_stats = el3_get_stats,
509 .ndo_set_rx_mode = set_multicast_list,
510 .ndo_tx_timeout = el3_tx_timeout,
511 .ndo_change_mtu = eth_change_mtu,
512 .ndo_set_mac_address = eth_mac_addr,
513 .ndo_validate_addr = eth_validate_addr,
514 #ifdef CONFIG_NET_POLL_CONTROLLER
515 .ndo_poll_controller = el3_poll_controller,
519 static int el3_common_init(struct net_device *dev)
521 struct el3_private *lp = netdev_priv(dev);
523 const char *if_names[] = {"10baseT", "AUI", "undefined", "BNC"};
525 spin_lock_init(&lp->lock);
527 if (dev->mem_start & 0x05) { /* xcvr codes 1/3/4/12 */
528 dev->if_port = (dev->mem_start & 0x0f);
529 } else { /* xcvr codes 0/8 */
530 /* use eeprom value, but save user's full-duplex selection */
531 dev->if_port |= (dev->mem_start & 0x08);
534 /* The EL3-specific entries in the device structure. */
535 dev->netdev_ops = &netdev_ops;
536 dev->watchdog_timeo = TX_TIMEOUT;
537 SET_ETHTOOL_OPS(dev, ðtool_ops);
539 err = register_netdev(dev);
541 pr_err("Failed to register 3c5x9 at %#3.3lx, IRQ %d.\n",
542 dev->base_addr, dev->irq);
543 release_region(dev->base_addr, EL3_IO_EXTENT);
547 pr_info("%s: 3c5x9 found at %#3.3lx, %s port, address %pM, IRQ %d.\n",
548 dev->name, dev->base_addr, if_names[(dev->if_port & 0x03)],
549 dev->dev_addr, dev->irq);
552 pr_info("%s", version);
557 static void el3_common_remove (struct net_device *dev)
559 unregister_netdev (dev);
560 release_region(dev->base_addr, EL3_IO_EXTENT);
565 static int __init el3_eisa_probe (struct device *device)
568 int ioaddr, irq, if_port;
570 struct net_device *dev = NULL;
571 struct eisa_device *edev;
574 /* Yeepee, The driver framework is calling us ! */
575 edev = to_eisa_device (device);
576 ioaddr = edev->base_addr;
578 if (!request_region(ioaddr, EL3_IO_EXTENT, "3c579-eisa"))
581 /* Change the register set to the configuration window 0. */
582 outw(SelectWindow | 0, ioaddr + 0xC80 + EL3_CMD);
584 irq = inw(ioaddr + WN0_IRQ) >> 12;
585 if_port = inw(ioaddr + 6)>>14;
586 for (i = 0; i < 3; i++)
587 phys_addr[i] = htons(read_eeprom(ioaddr, i));
589 /* Restore the "Product ID" to the EEPROM read register. */
590 read_eeprom(ioaddr, 3);
592 dev = alloc_etherdev(sizeof (struct el3_private));
594 release_region(ioaddr, EL3_IO_EXTENT);
598 netdev_boot_setup_check(dev);
600 el3_dev_fill(dev, phys_addr, ioaddr, irq, if_port, EL3_EISA);
601 eisa_set_drvdata (edev, dev);
602 err = el3_common_init(dev);
605 eisa_set_drvdata (edev, NULL);
610 el3_devs[el3_cards++] = dev;
615 /* This remove works for all device types.
617 * The net dev must be stored in the driver data field */
618 static int el3_device_remove(struct device *device)
620 struct net_device *dev;
622 dev = dev_get_drvdata(device);
624 el3_common_remove (dev);
628 /* Read a word from the EEPROM using the regular EEPROM access register.
629 Assume that we are in register window zero.
631 static ushort read_eeprom(int ioaddr, int index)
633 outw(EEPROM_READ + index, ioaddr + 10);
634 /* Pause for at least 162 us. for the read to take place.
635 Some chips seem to require much longer */
637 return inw(ioaddr + 12);
640 /* Read a word from the EEPROM when in the ISA ID probe state. */
641 static ushort id_read_eeprom(int index)
645 /* Issue read command, and pause for at least 162 us. for it to complete.
646 Assume extra-fast 16Mhz bus. */
647 outb(EEPROM_READ + index, id_port);
649 /* Pause for at least 162 us. for the read to take place. */
650 /* Some chips seem to require much longer */
653 for (bit = 15; bit >= 0; bit--)
654 word = (word << 1) + (inb(id_port) & 0x01);
657 pr_debug(" 3c509 EEPROM word %d %#4.4x.\n", index, word);
664 el3_open(struct net_device *dev)
666 int ioaddr = dev->base_addr;
669 outw(TxReset, ioaddr + EL3_CMD);
670 outw(RxReset, ioaddr + EL3_CMD);
671 outw(SetStatusEnb | 0x00, ioaddr + EL3_CMD);
673 i = request_irq(dev->irq, el3_interrupt, 0, dev->name, dev);
679 pr_debug("%s: Opening, IRQ %d status@%x %4.4x.\n", dev->name,
680 dev->irq, ioaddr + EL3_STATUS, inw(ioaddr + EL3_STATUS));
685 pr_debug("%s: Opened 3c509 IRQ %d status %4.4x.\n",
686 dev->name, dev->irq, inw(ioaddr + EL3_STATUS));
692 el3_tx_timeout (struct net_device *dev)
694 int ioaddr = dev->base_addr;
696 /* Transmitter timeout, serious problems. */
697 pr_warning("%s: transmit timed out, Tx_status %2.2x status %4.4x Tx FIFO room %d.\n",
698 dev->name, inb(ioaddr + TX_STATUS), inw(ioaddr + EL3_STATUS),
699 inw(ioaddr + TX_FREE));
700 dev->stats.tx_errors++;
701 dev->trans_start = jiffies; /* prevent tx timeout */
702 /* Issue TX_RESET and TX_START commands. */
703 outw(TxReset, ioaddr + EL3_CMD);
704 outw(TxEnable, ioaddr + EL3_CMD);
705 netif_wake_queue(dev);
710 el3_start_xmit(struct sk_buff *skb, struct net_device *dev)
712 struct el3_private *lp = netdev_priv(dev);
713 int ioaddr = dev->base_addr;
716 netif_stop_queue (dev);
718 dev->stats.tx_bytes += skb->len;
721 pr_debug("%s: el3_start_xmit(length = %u) called, status %4.4x.\n",
722 dev->name, skb->len, inw(ioaddr + EL3_STATUS));
725 #ifndef final_version
726 { /* Error-checking code, delete someday. */
727 ushort status = inw(ioaddr + EL3_STATUS);
728 if (status & 0x0001 && /* IRQ line active, missed one. */
729 inw(ioaddr + EL3_STATUS) & 1) { /* Make sure. */
730 pr_debug("%s: Missed interrupt, status then %04x now %04x"
731 " Tx %2.2x Rx %4.4x.\n", dev->name, status,
732 inw(ioaddr + EL3_STATUS), inb(ioaddr + TX_STATUS),
733 inw(ioaddr + RX_STATUS));
734 /* Fake interrupt trigger by masking, acknowledge interrupts. */
735 outw(SetStatusEnb | 0x00, ioaddr + EL3_CMD);
736 outw(AckIntr | IntLatch | TxAvailable | RxEarly | IntReq,
738 outw(SetStatusEnb | 0xff, ioaddr + EL3_CMD);
744 * We lock the driver against other processors. Note
745 * we don't need to lock versus the IRQ as we suspended
746 * that. This means that we lose the ability to take
747 * an RX during a TX upload. That sucks a bit with SMP
748 * on an original 3c509 (2K buffer)
750 * Using disable_irq stops us crapping on other
751 * time sensitive devices.
754 spin_lock_irqsave(&lp->lock, flags);
756 /* Put out the doubleword header... */
757 outw(skb->len, ioaddr + TX_FIFO);
758 outw(0x00, ioaddr + TX_FIFO);
759 /* ... and the packet rounded to a doubleword. */
760 outsl(ioaddr + TX_FIFO, skb->data, (skb->len + 3) >> 2);
762 if (inw(ioaddr + TX_FREE) > 1536)
763 netif_start_queue(dev);
765 /* Interrupt us when the FIFO has room for max-sized packet. */
766 outw(SetTxThreshold + 1536, ioaddr + EL3_CMD);
768 spin_unlock_irqrestore(&lp->lock, flags);
772 /* Clear the Tx status stack. */
777 while (--i > 0 && (tx_status = inb(ioaddr + TX_STATUS)) > 0) {
778 if (tx_status & 0x38) dev->stats.tx_aborted_errors++;
779 if (tx_status & 0x30) outw(TxReset, ioaddr + EL3_CMD);
780 if (tx_status & 0x3C) outw(TxEnable, ioaddr + EL3_CMD);
781 outb(0x00, ioaddr + TX_STATUS); /* Pop the status stack. */
787 /* The EL3 interrupt handler. */
789 el3_interrupt(int irq, void *dev_id)
791 struct net_device *dev = dev_id;
792 struct el3_private *lp;
794 int i = max_interrupt_work;
796 lp = netdev_priv(dev);
797 spin_lock(&lp->lock);
799 ioaddr = dev->base_addr;
802 status = inw(ioaddr + EL3_STATUS);
803 pr_debug("%s: interrupt, status %4.4x.\n", dev->name, status);
806 while ((status = inw(ioaddr + EL3_STATUS)) &
807 (IntLatch | RxComplete | StatsFull)) {
809 if (status & RxComplete)
812 if (status & TxAvailable) {
814 pr_debug(" TX room bit was handled.\n");
815 /* There's room in the FIFO for a full-sized packet. */
816 outw(AckIntr | TxAvailable, ioaddr + EL3_CMD);
817 netif_wake_queue (dev);
819 if (status & (AdapterFailure | RxEarly | StatsFull | TxComplete)) {
820 /* Handle all uncommon interrupts. */
821 if (status & StatsFull) /* Empty statistics. */
823 if (status & RxEarly) { /* Rx early is unused. */
825 outw(AckIntr | RxEarly, ioaddr + EL3_CMD);
827 if (status & TxComplete) { /* Really Tx error. */
831 while (--i>0 && (tx_status = inb(ioaddr + TX_STATUS)) > 0) {
832 if (tx_status & 0x38) dev->stats.tx_aborted_errors++;
833 if (tx_status & 0x30) outw(TxReset, ioaddr + EL3_CMD);
834 if (tx_status & 0x3C) outw(TxEnable, ioaddr + EL3_CMD);
835 outb(0x00, ioaddr + TX_STATUS); /* Pop the status stack. */
838 if (status & AdapterFailure) {
839 /* Adapter failure requires Rx reset and reinit. */
840 outw(RxReset, ioaddr + EL3_CMD);
841 /* Set the Rx filter to the current state. */
842 outw(SetRxFilter | RxStation | RxBroadcast
843 | (dev->flags & IFF_ALLMULTI ? RxMulticast : 0)
844 | (dev->flags & IFF_PROMISC ? RxProm : 0),
846 outw(RxEnable, ioaddr + EL3_CMD); /* Re-enable the receiver. */
847 outw(AckIntr | AdapterFailure, ioaddr + EL3_CMD);
852 pr_err("%s: Infinite loop in interrupt, status %4.4x.\n",
854 /* Clear all interrupts. */
855 outw(AckIntr | 0xFF, ioaddr + EL3_CMD);
858 /* Acknowledge the IRQ. */
859 outw(AckIntr | IntReq | IntLatch, ioaddr + EL3_CMD); /* Ack IRQ */
863 pr_debug("%s: exiting interrupt, status %4.4x.\n", dev->name,
864 inw(ioaddr + EL3_STATUS));
866 spin_unlock(&lp->lock);
871 #ifdef CONFIG_NET_POLL_CONTROLLER
873 * Polling receive - used by netconsole and other diagnostic tools
874 * to allow network i/o with interrupts disabled.
876 static void el3_poll_controller(struct net_device *dev)
878 disable_irq(dev->irq);
879 el3_interrupt(dev->irq, dev);
880 enable_irq(dev->irq);
884 static struct net_device_stats *
885 el3_get_stats(struct net_device *dev)
887 struct el3_private *lp = netdev_priv(dev);
891 * This is fast enough not to bother with disable IRQ
895 spin_lock_irqsave(&lp->lock, flags);
897 spin_unlock_irqrestore(&lp->lock, flags);
901 /* Update statistics. We change to register window 6, so this should be run
902 single-threaded if the device is active. This is expected to be a rare
903 operation, and it's simpler for the rest of the driver to assume that
904 window 1 is always valid rather than use a special window-state variable.
906 static void update_stats(struct net_device *dev)
908 int ioaddr = dev->base_addr;
911 pr_debug(" Updating the statistics.\n");
912 /* Turn off statistics updates while reading. */
913 outw(StatsDisable, ioaddr + EL3_CMD);
914 /* Switch to the stats window, and read everything. */
916 dev->stats.tx_carrier_errors += inb(ioaddr + 0);
917 dev->stats.tx_heartbeat_errors += inb(ioaddr + 1);
918 /* Multiple collisions. */ inb(ioaddr + 2);
919 dev->stats.collisions += inb(ioaddr + 3);
920 dev->stats.tx_window_errors += inb(ioaddr + 4);
921 dev->stats.rx_fifo_errors += inb(ioaddr + 5);
922 dev->stats.tx_packets += inb(ioaddr + 6);
923 /* Rx packets */ inb(ioaddr + 7);
924 /* Tx deferrals */ inb(ioaddr + 8);
925 inw(ioaddr + 10); /* Total Rx and Tx octets. */
928 /* Back to window 1, and turn statistics back on. */
930 outw(StatsEnable, ioaddr + EL3_CMD);
934 el3_rx(struct net_device *dev)
936 int ioaddr = dev->base_addr;
940 pr_debug(" In rx_packet(), status %4.4x, rx_status %4.4x.\n",
941 inw(ioaddr+EL3_STATUS), inw(ioaddr+RX_STATUS));
942 while ((rx_status = inw(ioaddr + RX_STATUS)) > 0) {
943 if (rx_status & 0x4000) { /* Error, update stats. */
944 short error = rx_status & 0x3800;
946 outw(RxDiscard, ioaddr + EL3_CMD);
947 dev->stats.rx_errors++;
949 case 0x0000: dev->stats.rx_over_errors++; break;
950 case 0x0800: dev->stats.rx_length_errors++; break;
951 case 0x1000: dev->stats.rx_frame_errors++; break;
952 case 0x1800: dev->stats.rx_length_errors++; break;
953 case 0x2000: dev->stats.rx_frame_errors++; break;
954 case 0x2800: dev->stats.rx_crc_errors++; break;
957 short pkt_len = rx_status & 0x7ff;
960 skb = netdev_alloc_skb(dev, pkt_len + 5);
962 pr_debug("Receiving packet size %d status %4.4x.\n",
965 skb_reserve(skb, 2); /* Align IP on 16 byte */
967 /* 'skb->data' points to the start of sk_buff data area. */
968 insl(ioaddr + RX_FIFO, skb_put(skb,pkt_len),
971 outw(RxDiscard, ioaddr + EL3_CMD); /* Pop top Rx packet. */
972 skb->protocol = eth_type_trans(skb,dev);
974 dev->stats.rx_bytes += pkt_len;
975 dev->stats.rx_packets++;
978 outw(RxDiscard, ioaddr + EL3_CMD);
979 dev->stats.rx_dropped++;
981 pr_debug("%s: Couldn't allocate a sk_buff of size %d.\n",
984 inw(ioaddr + EL3_STATUS); /* Delay. */
985 while (inw(ioaddr + EL3_STATUS) & 0x1000)
986 pr_debug(" Waiting for 3c509 to discard packet, status %x.\n",
987 inw(ioaddr + EL3_STATUS) );
994 * Set or clear the multicast filter for this adaptor.
997 set_multicast_list(struct net_device *dev)
1000 struct el3_private *lp = netdev_priv(dev);
1001 int ioaddr = dev->base_addr;
1002 int mc_count = netdev_mc_count(dev);
1004 if (el3_debug > 1) {
1006 if (old != mc_count) {
1008 pr_debug("%s: Setting Rx mode to %d addresses.\n",
1009 dev->name, mc_count);
1012 spin_lock_irqsave(&lp->lock, flags);
1013 if (dev->flags&IFF_PROMISC) {
1014 outw(SetRxFilter | RxStation | RxMulticast | RxBroadcast | RxProm,
1017 else if (mc_count || (dev->flags&IFF_ALLMULTI)) {
1018 outw(SetRxFilter | RxStation | RxMulticast | RxBroadcast, ioaddr + EL3_CMD);
1021 outw(SetRxFilter | RxStation | RxBroadcast, ioaddr + EL3_CMD);
1022 spin_unlock_irqrestore(&lp->lock, flags);
1026 el3_close(struct net_device *dev)
1028 int ioaddr = dev->base_addr;
1029 struct el3_private *lp = netdev_priv(dev);
1032 pr_debug("%s: Shutting down ethercard.\n", dev->name);
1036 free_irq(dev->irq, dev);
1037 /* Switching back to window 0 disables the IRQ. */
1039 if (lp->type != EL3_EISA) {
1040 /* But we explicitly zero the IRQ line select anyway. Don't do
1041 * it on EISA cards, it prevents the module from getting an
1042 * IRQ after unload+reload... */
1043 outw(0x0f00, ioaddr + WN0_IRQ);
1050 el3_link_ok(struct net_device *dev)
1052 int ioaddr = dev->base_addr;
1056 tmp = inw(ioaddr + WN4_MEDIA);
1058 return tmp & (1<<11);
1062 el3_netdev_get_ecmd(struct net_device *dev, struct ethtool_cmd *ecmd)
1065 int ioaddr = dev->base_addr;
1068 /* obtain current transceiver via WN4_MEDIA? */
1069 tmp = inw(ioaddr + WN0_ADDR_CONF);
1070 ecmd->transceiver = XCVR_INTERNAL;
1071 switch (tmp >> 14) {
1073 ecmd->port = PORT_TP;
1076 ecmd->port = PORT_AUI;
1077 ecmd->transceiver = XCVR_EXTERNAL;
1080 ecmd->port = PORT_BNC;
1085 ecmd->duplex = DUPLEX_HALF;
1086 ecmd->supported = 0;
1087 tmp = inw(ioaddr + WN0_CONF_CTRL);
1089 ecmd->supported |= SUPPORTED_AUI;
1091 ecmd->supported |= SUPPORTED_BNC;
1093 ecmd->supported |= SUPPORTED_TP | SUPPORTED_10baseT_Half |
1094 SUPPORTED_10baseT_Full; /* hmm... */
1096 tmp = inw(ioaddr + WN4_NETDIAG);
1097 if (tmp & FD_ENABLE)
1098 ecmd->duplex = DUPLEX_FULL;
1101 ethtool_cmd_speed_set(ecmd, SPEED_10);
1107 el3_netdev_set_ecmd(struct net_device *dev, struct ethtool_cmd *ecmd)
1110 int ioaddr = dev->base_addr;
1112 if (ecmd->speed != SPEED_10)
1114 if ((ecmd->duplex != DUPLEX_HALF) && (ecmd->duplex != DUPLEX_FULL))
1116 if ((ecmd->transceiver != XCVR_INTERNAL) && (ecmd->transceiver != XCVR_EXTERNAL))
1119 /* change XCVR type */
1121 tmp = inw(ioaddr + WN0_ADDR_CONF);
1122 switch (ecmd->port) {
1139 outw(tmp, ioaddr + WN0_ADDR_CONF);
1140 if (dev->if_port == 3) {
1141 /* fire up the DC-DC convertor if BNC gets enabled */
1142 tmp = inw(ioaddr + WN0_ADDR_CONF);
1143 if (tmp & (3 << 14)) {
1144 outw(StartCoax, ioaddr + EL3_CMD);
1151 tmp = inw(ioaddr + WN4_NETDIAG);
1152 if (ecmd->duplex == DUPLEX_FULL)
1156 outw(tmp, ioaddr + WN4_NETDIAG);
1162 static void el3_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
1164 strcpy(info->driver, DRV_NAME);
1165 strcpy(info->version, DRV_VERSION);
1168 static int el3_get_settings(struct net_device *dev, struct ethtool_cmd *ecmd)
1170 struct el3_private *lp = netdev_priv(dev);
1173 spin_lock_irq(&lp->lock);
1174 ret = el3_netdev_get_ecmd(dev, ecmd);
1175 spin_unlock_irq(&lp->lock);
1179 static int el3_set_settings(struct net_device *dev, struct ethtool_cmd *ecmd)
1181 struct el3_private *lp = netdev_priv(dev);
1184 spin_lock_irq(&lp->lock);
1185 ret = el3_netdev_set_ecmd(dev, ecmd);
1186 spin_unlock_irq(&lp->lock);
1190 static u32 el3_get_link(struct net_device *dev)
1192 struct el3_private *lp = netdev_priv(dev);
1195 spin_lock_irq(&lp->lock);
1196 ret = el3_link_ok(dev);
1197 spin_unlock_irq(&lp->lock);
1201 static u32 el3_get_msglevel(struct net_device *dev)
1206 static void el3_set_msglevel(struct net_device *dev, u32 v)
1211 static const struct ethtool_ops ethtool_ops = {
1212 .get_drvinfo = el3_get_drvinfo,
1213 .get_settings = el3_get_settings,
1214 .set_settings = el3_set_settings,
1215 .get_link = el3_get_link,
1216 .get_msglevel = el3_get_msglevel,
1217 .set_msglevel = el3_set_msglevel,
1221 el3_down(struct net_device *dev)
1223 int ioaddr = dev->base_addr;
1225 netif_stop_queue(dev);
1227 /* Turn off statistics ASAP. We update lp->stats below. */
1228 outw(StatsDisable, ioaddr + EL3_CMD);
1230 /* Disable the receiver and transmitter. */
1231 outw(RxDisable, ioaddr + EL3_CMD);
1232 outw(TxDisable, ioaddr + EL3_CMD);
1234 if (dev->if_port == 3)
1235 /* Turn off thinnet power. Green! */
1236 outw(StopCoax, ioaddr + EL3_CMD);
1237 else if (dev->if_port == 0) {
1238 /* Disable link beat and jabber, if_port may change here next open(). */
1240 outw(inw(ioaddr + WN4_MEDIA) & ~MEDIA_TP, ioaddr + WN4_MEDIA);
1243 outw(SetIntrEnb | 0x0000, ioaddr + EL3_CMD);
1249 el3_up(struct net_device *dev)
1251 int i, sw_info, net_diag;
1252 int ioaddr = dev->base_addr;
1254 /* Activating the board required and does no harm otherwise */
1255 outw(0x0001, ioaddr + 4);
1257 /* Set the IRQ line. */
1258 outw((dev->irq << 12) | 0x0f00, ioaddr + WN0_IRQ);
1260 /* Set the station address in window 2 each time opened. */
1263 for (i = 0; i < 6; i++)
1264 outb(dev->dev_addr[i], ioaddr + i);
1266 if ((dev->if_port & 0x03) == 3) /* BNC interface */
1267 /* Start the thinnet transceiver. We should really wait 50ms...*/
1268 outw(StartCoax, ioaddr + EL3_CMD);
1269 else if ((dev->if_port & 0x03) == 0) { /* 10baseT interface */
1270 /* Combine secondary sw_info word (the adapter level) and primary
1271 sw_info word (duplex setting plus other useless bits) */
1273 sw_info = (read_eeprom(ioaddr, 0x14) & 0x400f) |
1274 (read_eeprom(ioaddr, 0x0d) & 0xBff0);
1277 net_diag = inw(ioaddr + WN4_NETDIAG);
1278 net_diag = (net_diag | FD_ENABLE); /* temporarily assume full-duplex will be set */
1279 pr_info("%s: ", dev->name);
1280 switch (dev->if_port & 0x0c) {
1282 /* force full-duplex mode if 3c5x9b */
1283 if (sw_info & 0x000f) {
1284 pr_cont("Forcing 3c5x9b full-duplex mode");
1288 /* set full-duplex mode based on eeprom config setting */
1289 if ((sw_info & 0x000f) && (sw_info & 0x8000)) {
1290 pr_cont("Setting 3c5x9b full-duplex mode (from EEPROM configuration bit)");
1294 /* xcvr=(0 || 4) OR user has an old 3c5x9 non "B" model */
1295 pr_cont("Setting 3c5x9/3c5x9B half-duplex mode");
1296 net_diag = (net_diag & ~FD_ENABLE); /* disable full duplex */
1299 outw(net_diag, ioaddr + WN4_NETDIAG);
1300 pr_cont(" if_port: %d, sw_info: %4.4x\n", dev->if_port, sw_info);
1302 pr_debug("%s: 3c5x9 net diag word is now: %4.4x.\n", dev->name, net_diag);
1303 /* Enable link beat and jabber check. */
1304 outw(inw(ioaddr + WN4_MEDIA) | MEDIA_TP, ioaddr + WN4_MEDIA);
1307 /* Switch to the stats window, and clear all stats by reading. */
1308 outw(StatsDisable, ioaddr + EL3_CMD);
1310 for (i = 0; i < 9; i++)
1315 /* Switch to register set 1 for normal use. */
1318 /* Accept b-case and phys addr only. */
1319 outw(SetRxFilter | RxStation | RxBroadcast, ioaddr + EL3_CMD);
1320 outw(StatsEnable, ioaddr + EL3_CMD); /* Turn on statistics. */
1322 outw(RxEnable, ioaddr + EL3_CMD); /* Enable the receiver. */
1323 outw(TxEnable, ioaddr + EL3_CMD); /* Enable transmitter. */
1324 /* Allow status bits to be seen. */
1325 outw(SetStatusEnb | 0xff, ioaddr + EL3_CMD);
1326 /* Ack all pending events, and set active indicator mask. */
1327 outw(AckIntr | IntLatch | TxAvailable | RxEarly | IntReq,
1329 outw(SetIntrEnb | IntLatch|TxAvailable|TxComplete|RxComplete|StatsFull,
1332 netif_start_queue(dev);
1335 /* Power Management support functions */
1339 el3_suspend(struct device *pdev, pm_message_t state)
1341 unsigned long flags;
1342 struct net_device *dev;
1343 struct el3_private *lp;
1346 dev = dev_get_drvdata(pdev);
1347 lp = netdev_priv(dev);
1348 ioaddr = dev->base_addr;
1350 spin_lock_irqsave(&lp->lock, flags);
1352 if (netif_running(dev))
1353 netif_device_detach(dev);
1356 outw(PowerDown, ioaddr + EL3_CMD);
1358 spin_unlock_irqrestore(&lp->lock, flags);
1363 el3_resume(struct device *pdev)
1365 unsigned long flags;
1366 struct net_device *dev;
1367 struct el3_private *lp;
1370 dev = dev_get_drvdata(pdev);
1371 lp = netdev_priv(dev);
1372 ioaddr = dev->base_addr;
1374 spin_lock_irqsave(&lp->lock, flags);
1376 outw(PowerUp, ioaddr + EL3_CMD);
1380 if (netif_running(dev))
1381 netif_device_attach(dev);
1383 spin_unlock_irqrestore(&lp->lock, flags);
1387 #endif /* CONFIG_PM */
1389 module_param(debug,int, 0);
1390 module_param_array(irq, int, NULL, 0);
1391 module_param(max_interrupt_work, int, 0);
1392 MODULE_PARM_DESC(debug, "debug level (0-6)");
1393 MODULE_PARM_DESC(irq, "IRQ number(s) (assigned)");
1394 MODULE_PARM_DESC(max_interrupt_work, "maximum events handled per interrupt");
1396 module_param(nopnp, int, 0);
1397 MODULE_PARM_DESC(nopnp, "disable ISA PnP support (0-1)");
1398 #endif /* CONFIG_PNP */
1399 MODULE_DESCRIPTION("3Com Etherlink III (3c509, 3c509B, 3c529, 3c579) ethernet driver");
1400 MODULE_LICENSE("GPL");
1402 static int __init el3_init_module(void)
1411 ret = pnp_register_driver(&el3_pnp_driver);
1416 /* Select an open I/O location at 0x1*0 to do ISA contention select. */
1417 /* Start with 0x110 to avoid some sound cards.*/
1418 for (id_port = 0x110 ; id_port < 0x200; id_port += 0x10) {
1419 if (!request_region(id_port, 1, "3c509-control"))
1421 outb(0x00, id_port);
1422 outb(0xff, id_port);
1423 if (inb(id_port) & 0x01)
1426 release_region(id_port, 1);
1428 if (id_port >= 0x200) {
1430 pr_err("No I/O port available for 3c509 activation.\n");
1432 ret = isa_register_driver(&el3_isa_driver, EL3_MAX_CARDS);
1437 ret = eisa_driver_register(&el3_eisa_driver);
1439 eisa_registered = 1;
1449 if (eisa_registered)
1455 static void __exit el3_cleanup_module(void)
1459 pnp_unregister_driver(&el3_pnp_driver);
1462 isa_unregister_driver(&el3_isa_driver);
1464 release_region(id_port, 1);
1466 if (eisa_registered)
1467 eisa_driver_unregister(&el3_eisa_driver);
1471 module_init (el3_init_module);
1472 module_exit (el3_cleanup_module);