1 /* 3c574.c: A PCMCIA ethernet driver for the 3com 3c574 "RoadRunner".
4 Donald Becker, becker@scyld.com, (driver core) and
5 David Hinds, dahinds@users.sourceforge.net (from his PC card code).
6 Locking fixes (C) Copyright 2003 Red Hat Inc
8 This software may be used and distributed according to the terms of
9 the GNU General Public License, incorporated herein by reference.
11 This driver derives from Donald Becker's 3c509 core, which has the
13 Copyright 1993 United States Government as represented by the
14 Director, National Security Agency.
22 I. Board Compatibility
24 This device driver is designed for the 3Com 3c574 PC card Fast Ethernet
27 II. Board-specific settings
29 None -- PC cards are autoconfigured.
33 The 3c574 uses a Boomerang-style interface, without the bus-master capability.
34 See the Boomerang driver and documentation for most details.
36 IV. Notes and chip documentation.
38 Two added registers are used to enhance PIO performance, RunnerRdCtrl and
39 RunnerWrCtrl. These are 11 bit down-counters that are preloaded with the
40 count of word (16 bits) reads or writes the driver is about to do to the Rx
41 or Tx FIFO. The chip is then able to hide the internal-PCI-bus to PC-card
42 translation latency by buffering the I/O operations with an 8 word FIFO.
43 Note: No other chip accesses are permitted when this buffer is used.
45 A second enhancement is that both attribute and common memory space
46 0x0800-0x0fff can translated to the PIO FIFO. Thus memory operations (faster
47 with *some* PCcard bridges) may be used instead of I/O operations.
48 This is enabled by setting the 0x10 bit in the PCMCIA LAN COR.
50 Some slow PC card bridges work better if they never see a WAIT signal.
51 This is configured by setting the 0x20 bit in the PCMCIA LAN COR.
52 Only do this after testing that it is reliable and improves performance.
54 The upper five bits of RunnerRdCtrl are used to window into PCcard
55 configuration space registers. Window 0 is the regular Boomerang/Odie
56 register set, 1-5 are various PC card control registers, and 16-31 are
57 the (reversed!) CIS table.
59 A final note: writing the InternalConfig register in window 3 with an
60 invalid ramWidth is Very Bad.
64 http://www.scyld.com/expert/NWay.html
65 http://www.national.com/pf/DP/DP83840.html
67 Thanks to Terry Murphy of 3Com for providing development information for
68 earlier 3Com products.
72 #include <linux/module.h>
73 #include <linux/kernel.h>
74 #include <linux/init.h>
75 #include <linux/slab.h>
76 #include <linux/string.h>
77 #include <linux/timer.h>
78 #include <linux/interrupt.h>
80 #include <linux/delay.h>
81 #include <linux/netdevice.h>
82 #include <linux/etherdevice.h>
83 #include <linux/skbuff.h>
84 #include <linux/if_arp.h>
85 #include <linux/ioport.h>
86 #include <linux/ethtool.h>
87 #include <linux/bitops.h>
88 #include <linux/mii.h>
90 #include <pcmcia/cistpl.h>
91 #include <pcmcia/cisreg.h>
92 #include <pcmcia/ciscode.h>
93 #include <pcmcia/ds.h>
95 #include <asm/uaccess.h>
97 #include <asm/system.h>
99 /*====================================================================*/
101 /* Module parameters */
103 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
104 MODULE_DESCRIPTION("3Com 3c574 series PCMCIA ethernet driver");
105 MODULE_LICENSE("GPL");
107 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)
109 /* Maximum events (Rx packets, etc.) to handle at each interrupt. */
110 INT_MODULE_PARM(max_interrupt_work, 32);
112 /* Force full duplex modes? */
113 INT_MODULE_PARM(full_duplex, 0);
115 /* Autodetect link polarity reversal? */
116 INT_MODULE_PARM(auto_polarity, 1);
119 /*====================================================================*/
121 /* Time in jiffies before concluding the transmitter is hung. */
122 #define TX_TIMEOUT ((800*HZ)/1000)
124 /* To minimize the size of the driver source and make the driver more
125 readable not all constants are symbolically defined.
126 You'll need the manual if you want to understand driver details anyway. */
127 /* Offsets from base I/O address. */
128 #define EL3_DATA 0x00
130 #define EL3_STATUS 0x0e
132 #define EL3WINDOW(win_num) outw(SelectWindow + (win_num), ioaddr + EL3_CMD)
134 /* The top five bits written to EL3_CMD are a command, the lower
135 11 bits are the parameter, if applicable. */
137 TotalReset = 0<<11, SelectWindow = 1<<11, StartCoax = 2<<11,
138 RxDisable = 3<<11, RxEnable = 4<<11, RxReset = 5<<11, RxDiscard = 8<<11,
139 TxEnable = 9<<11, TxDisable = 10<<11, TxReset = 11<<11,
140 FakeIntr = 12<<11, AckIntr = 13<<11, SetIntrEnb = 14<<11,
141 SetStatusEnb = 15<<11, SetRxFilter = 16<<11, SetRxThreshold = 17<<11,
142 SetTxThreshold = 18<<11, SetTxStart = 19<<11, StatsEnable = 21<<11,
143 StatsDisable = 22<<11, StopCoax = 23<<11,
147 IntLatch = 0x0001, AdapterFailure = 0x0002, TxComplete = 0x0004,
148 TxAvailable = 0x0008, RxComplete = 0x0010, RxEarly = 0x0020,
149 IntReq = 0x0040, StatsFull = 0x0080, CmdBusy = 0x1000 };
151 /* The SetRxFilter command accepts the following classes: */
153 RxStation = 1, RxMulticast = 2, RxBroadcast = 4, RxProm = 8
157 Wn0EepromCmd = 10, Wn0EepromData = 12, /* EEPROM command/address, data. */
158 IntrStatus=0x0E, /* Valid in all windows. */
160 /* These assumes the larger EEPROM. */
161 enum Win0_EEPROM_cmds {
162 EEPROM_Read = 0x200, EEPROM_WRITE = 0x100, EEPROM_ERASE = 0x300,
163 EEPROM_EWENB = 0x30, /* Enable erasing/writing for 10 msec. */
164 EEPROM_EWDIS = 0x00, /* Disable EWENB before 10 msec timeout. */
167 /* Register window 1 offsets, the window used in normal operation.
168 On the "Odie" this window is always mapped at offsets 0x10-0x1f.
169 Except for TxFree, which is overlapped by RunnerWrCtrl. */
171 TX_FIFO = 0x10, RX_FIFO = 0x10, RxErrors = 0x14,
172 RxStatus = 0x18, Timer=0x1A, TxStatus = 0x1B,
173 TxFree = 0x0C, /* Remaining free bytes in Tx buffer. */
174 RunnerRdCtrl = 0x16, RunnerWrCtrl = 0x1c,
177 enum Window3 { /* Window 3: MAC/config bits. */
178 Wn3_Config=0, Wn3_MAC_Ctrl=6, Wn3_Options=8,
185 Ram_split_shift = 16,
186 Ram_split = 3 << Ram_split_shift,
188 Xcvr = 7 << Xcvr_shift,
189 Autoselect = 0x1000000,
192 enum Window4 { /* Window 4: Xcvr/media bits. */
193 Wn4_FIFODiag = 4, Wn4_NetDiag = 6, Wn4_PhysicalMgmt=8, Wn4_Media = 10,
196 #define MEDIA_TP 0x00C0 /* Enable link beat and jabber for 10baseT. */
199 struct pcmcia_device *p_dev;
200 u16 advertising, partner; /* NWay media advertisement */
201 unsigned char phys; /* MII device address */
202 unsigned int autoselect:1, default_media:3; /* Read from the EEPROM/Wn3_Config. */
203 /* for transceiver monitoring */
204 struct timer_list media;
205 unsigned short media_status;
206 unsigned short fast_poll;
207 unsigned long last_irq;
208 spinlock_t window_lock; /* Guards the Window selection */
211 /* Set iff a MII transceiver on any interface requires mdio preamble.
212 This only set with the original DP83840 on older 3c905 boards, so the extra
213 code size of a per-interface flag is not worthwhile. */
214 static char mii_preamble_required = 0;
216 /* Index of functions. */
218 static int tc574_config(struct pcmcia_device *link);
219 static void tc574_release(struct pcmcia_device *link);
221 static void mdio_sync(unsigned int ioaddr, int bits);
222 static int mdio_read(unsigned int ioaddr, int phy_id, int location);
223 static void mdio_write(unsigned int ioaddr, int phy_id, int location,
225 static unsigned short read_eeprom(unsigned int ioaddr, int index);
226 static void tc574_wait_for_completion(struct net_device *dev, int cmd);
228 static void tc574_reset(struct net_device *dev);
229 static void media_check(unsigned long arg);
230 static int el3_open(struct net_device *dev);
231 static netdev_tx_t el3_start_xmit(struct sk_buff *skb,
232 struct net_device *dev);
233 static irqreturn_t el3_interrupt(int irq, void *dev_id);
234 static void update_stats(struct net_device *dev);
235 static struct net_device_stats *el3_get_stats(struct net_device *dev);
236 static int el3_rx(struct net_device *dev, int worklimit);
237 static int el3_close(struct net_device *dev);
238 static void el3_tx_timeout(struct net_device *dev);
239 static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
240 static const struct ethtool_ops netdev_ethtool_ops;
241 static void set_rx_mode(struct net_device *dev);
242 static void set_multicast_list(struct net_device *dev);
244 static void tc574_detach(struct pcmcia_device *p_dev);
247 tc574_attach() creates an "instance" of the driver, allocating
248 local data structures for one device. The device is registered
251 static const struct net_device_ops el3_netdev_ops = {
252 .ndo_open = el3_open,
253 .ndo_stop = el3_close,
254 .ndo_start_xmit = el3_start_xmit,
255 .ndo_tx_timeout = el3_tx_timeout,
256 .ndo_get_stats = el3_get_stats,
257 .ndo_do_ioctl = el3_ioctl,
258 .ndo_set_multicast_list = set_multicast_list,
259 .ndo_change_mtu = eth_change_mtu,
260 .ndo_set_mac_address = eth_mac_addr,
261 .ndo_validate_addr = eth_validate_addr,
264 static int tc574_probe(struct pcmcia_device *link)
266 struct el3_private *lp;
267 struct net_device *dev;
269 dev_dbg(&link->dev, "3c574_attach()\n");
271 /* Create the PC card device object. */
272 dev = alloc_etherdev(sizeof(struct el3_private));
275 lp = netdev_priv(dev);
279 spin_lock_init(&lp->window_lock);
280 link->resource[0]->end = 32;
281 link->resource[0]->flags |= IO_DATA_PATH_WIDTH_16;
282 link->config_flags |= CONF_ENABLE_IRQ;
283 link->config_index = 1;
285 dev->netdev_ops = &el3_netdev_ops;
286 SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
287 dev->watchdog_timeo = TX_TIMEOUT;
289 return tc574_config(link);
294 This deletes a driver "instance". The device is de-registered
295 with Card Services. If it has been released, all local data
296 structures are freed. Otherwise, the structures will be freed
297 when the device is released.
301 static void tc574_detach(struct pcmcia_device *link)
303 struct net_device *dev = link->priv;
305 dev_dbg(&link->dev, "3c574_detach()\n");
307 unregister_netdev(dev);
315 tc574_config() is scheduled to run after a CARD_INSERTION event
316 is received, to configure the PCMCIA socket, and to make the
317 ethernet device available to the system.
320 static const char *ram_split[] = {"5:3", "3:1", "1:1", "3:5"};
322 static int tc574_config(struct pcmcia_device *link)
324 struct net_device *dev = link->priv;
325 struct el3_private *lp = netdev_priv(dev);
334 phys_addr = (__be16 *)dev->dev_addr;
336 dev_dbg(&link->dev, "3c574_config()\n");
340 for (i = j = 0; j < 0x400; j += 0x20) {
341 link->resource[0]->start = j ^ 0x300;
342 i = pcmcia_request_io(link);
349 ret = pcmcia_request_irq(link, el3_interrupt);
353 ret = pcmcia_enable_device(link);
357 dev->irq = link->irq;
358 dev->base_addr = link->resource[0]->start;
360 ioaddr = dev->base_addr;
362 /* The 3c574 normally uses an EEPROM for configuration info, including
363 the hardware address. The future products may include a modem chip
364 and put the address in the CIS. */
366 len = pcmcia_get_tuple(link, 0x88, &buf);
367 if (buf && len >= 6) {
368 for (i = 0; i < 3; i++)
369 phys_addr[i] = htons(le16_to_cpu(buf[i * 2]));
372 kfree(buf); /* 0 < len < 6 */
374 for (i = 0; i < 3; i++)
375 phys_addr[i] = htons(read_eeprom(ioaddr, i + 10));
376 if (phys_addr[0] == htons(0x6060)) {
377 printk(KERN_NOTICE "3c574_cs: IO port conflict at 0x%03lx"
378 "-0x%03lx\n", dev->base_addr, dev->base_addr+15);
382 if (link->prod_id[1])
383 cardname = link->prod_id[1];
385 cardname = "3Com 3c574";
389 outw(2<<11, ioaddr + RunnerRdCtrl);
390 mcr = inb(ioaddr + 2);
391 outw(0<<11, ioaddr + RunnerRdCtrl);
392 printk(KERN_INFO " ASIC rev %d,", mcr>>3);
394 config = inl(ioaddr + Wn3_Config);
395 lp->default_media = (config & Xcvr) >> Xcvr_shift;
396 lp->autoselect = config & Autoselect ? 1 : 0;
399 init_timer(&lp->media);
404 /* Roadrunner only: Turn on the MII transceiver */
405 outw(0x8040, ioaddr + Wn3_Options);
407 outw(0xc040, ioaddr + Wn3_Options);
408 tc574_wait_for_completion(dev, TxReset);
409 tc574_wait_for_completion(dev, RxReset);
411 outw(0x8040, ioaddr + Wn3_Options);
414 for (phy = 1; phy <= 32; phy++) {
416 mdio_sync(ioaddr, 32);
417 mii_status = mdio_read(ioaddr, phy & 0x1f, 1);
418 if (mii_status != 0xffff) {
419 lp->phys = phy & 0x1f;
420 dev_dbg(&link->dev, " MII transceiver at "
421 "index %d, status %x.\n",
423 if ((mii_status & 0x0040) == 0)
424 mii_preamble_required = 1;
429 printk(KERN_NOTICE " No MII transceivers found!\n");
432 i = mdio_read(ioaddr, lp->phys, 16) | 0x40;
433 mdio_write(ioaddr, lp->phys, 16, i);
434 lp->advertising = mdio_read(ioaddr, lp->phys, 4);
436 /* Only advertise the FD media types. */
437 lp->advertising &= ~0x02a0;
438 mdio_write(ioaddr, lp->phys, 4, lp->advertising);
442 SET_NETDEV_DEV(dev, &link->dev);
444 if (register_netdev(dev) != 0) {
445 printk(KERN_NOTICE "3c574_cs: register_netdev() failed\n");
449 printk(KERN_INFO "%s: %s at io %#3lx, irq %d, "
451 dev->name, cardname, dev->base_addr, dev->irq,
453 printk(" %dK FIFO split %s Rx:Tx, %sMII interface.\n",
454 8 << config & Ram_size,
455 ram_split[(config & Ram_split) >> Ram_split_shift],
456 config & Autoselect ? "autoselect " : "");
467 After a card is removed, tc574_release() will unregister the net
468 device, and release the PCMCIA configuration. If the device is
469 still open, this will be postponed until it is closed.
472 static void tc574_release(struct pcmcia_device *link)
474 pcmcia_disable_device(link);
477 static int tc574_suspend(struct pcmcia_device *link)
479 struct net_device *dev = link->priv;
482 netif_device_detach(dev);
487 static int tc574_resume(struct pcmcia_device *link)
489 struct net_device *dev = link->priv;
493 netif_device_attach(dev);
499 static void dump_status(struct net_device *dev)
501 unsigned int ioaddr = dev->base_addr;
503 printk(KERN_INFO " irq status %04x, rx status %04x, tx status "
504 "%02x, tx free %04x\n", inw(ioaddr+EL3_STATUS),
505 inw(ioaddr+RxStatus), inb(ioaddr+TxStatus),
508 printk(KERN_INFO " diagnostics: fifo %04x net %04x ethernet %04x"
509 " media %04x\n", inw(ioaddr+0x04), inw(ioaddr+0x06),
510 inw(ioaddr+0x08), inw(ioaddr+0x0a));
515 Use this for commands that may take time to finish
517 static void tc574_wait_for_completion(struct net_device *dev, int cmd)
520 outw(cmd, dev->base_addr + EL3_CMD);
522 if (!(inw(dev->base_addr + EL3_STATUS) & 0x1000)) break;
524 printk(KERN_NOTICE "%s: command 0x%04x did not complete!\n", dev->name, cmd);
527 /* Read a word from the EEPROM using the regular EEPROM access register.
528 Assume that we are in register window zero.
530 static unsigned short read_eeprom(unsigned int ioaddr, int index)
533 outw(EEPROM_Read + index, ioaddr + Wn0EepromCmd);
534 /* Pause for at least 162 usec for the read to take place. */
535 for (timer = 1620; timer >= 0; timer--) {
536 if ((inw(ioaddr + Wn0EepromCmd) & 0x8000) == 0)
539 return inw(ioaddr + Wn0EepromData);
542 /* MII transceiver control section.
543 Read and write the MII registers using software-generated serial
544 MDIO protocol. See the MII specifications or DP83840A data sheet
546 The maxium data clock rate is 2.5 Mhz. The timing is easily met by the
547 slow PC card interface. */
549 #define MDIO_SHIFT_CLK 0x01
550 #define MDIO_DIR_WRITE 0x04
551 #define MDIO_DATA_WRITE0 (0x00 | MDIO_DIR_WRITE)
552 #define MDIO_DATA_WRITE1 (0x02 | MDIO_DIR_WRITE)
553 #define MDIO_DATA_READ 0x02
554 #define MDIO_ENB_IN 0x00
556 /* Generate the preamble required for initial synchronization and
557 a few older transceivers. */
558 static void mdio_sync(unsigned int ioaddr, int bits)
560 unsigned int mdio_addr = ioaddr + Wn4_PhysicalMgmt;
562 /* Establish sync by sending at least 32 logic ones. */
563 while (-- bits >= 0) {
564 outw(MDIO_DATA_WRITE1, mdio_addr);
565 outw(MDIO_DATA_WRITE1 | MDIO_SHIFT_CLK, mdio_addr);
569 static int mdio_read(unsigned int ioaddr, int phy_id, int location)
572 int read_cmd = (0xf6 << 10) | (phy_id << 5) | location;
573 unsigned int retval = 0;
574 unsigned int mdio_addr = ioaddr + Wn4_PhysicalMgmt;
576 if (mii_preamble_required)
577 mdio_sync(ioaddr, 32);
579 /* Shift the read command bits out. */
580 for (i = 14; i >= 0; i--) {
581 int dataval = (read_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
582 outw(dataval, mdio_addr);
583 outw(dataval | MDIO_SHIFT_CLK, mdio_addr);
585 /* Read the two transition, 16 data, and wire-idle bits. */
586 for (i = 19; i > 0; i--) {
587 outw(MDIO_ENB_IN, mdio_addr);
588 retval = (retval << 1) | ((inw(mdio_addr) & MDIO_DATA_READ) ? 1 : 0);
589 outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);
591 return (retval>>1) & 0xffff;
594 static void mdio_write(unsigned int ioaddr, int phy_id, int location, int value)
596 int write_cmd = 0x50020000 | (phy_id << 23) | (location << 18) | value;
597 unsigned int mdio_addr = ioaddr + Wn4_PhysicalMgmt;
600 if (mii_preamble_required)
601 mdio_sync(ioaddr, 32);
603 /* Shift the command bits out. */
604 for (i = 31; i >= 0; i--) {
605 int dataval = (write_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
606 outw(dataval, mdio_addr);
607 outw(dataval | MDIO_SHIFT_CLK, mdio_addr);
609 /* Leave the interface idle. */
610 for (i = 1; i >= 0; i--) {
611 outw(MDIO_ENB_IN, mdio_addr);
612 outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);
616 /* Reset and restore all of the 3c574 registers. */
617 static void tc574_reset(struct net_device *dev)
619 struct el3_private *lp = netdev_priv(dev);
621 unsigned int ioaddr = dev->base_addr;
624 tc574_wait_for_completion(dev, TotalReset|0x10);
626 spin_lock_irqsave(&lp->window_lock, flags);
627 /* Clear any transactions in progress. */
628 outw(0, ioaddr + RunnerWrCtrl);
629 outw(0, ioaddr + RunnerRdCtrl);
631 /* Set the station address and mask. */
633 for (i = 0; i < 6; i++)
634 outb(dev->dev_addr[i], ioaddr + i);
638 /* Reset config options */
640 outb((dev->mtu > 1500 ? 0x40 : 0), ioaddr + Wn3_MAC_Ctrl);
641 outl((lp->autoselect ? 0x01000000 : 0) | 0x0062001b,
642 ioaddr + Wn3_Config);
643 /* Roadrunner only: Turn on the MII transceiver. */
644 outw(0x8040, ioaddr + Wn3_Options);
646 outw(0xc040, ioaddr + Wn3_Options);
648 spin_unlock_irqrestore(&lp->window_lock, flags);
650 tc574_wait_for_completion(dev, TxReset);
651 tc574_wait_for_completion(dev, RxReset);
653 spin_lock_irqsave(&lp->window_lock, flags);
655 outw(0x8040, ioaddr + Wn3_Options);
657 /* Switch to the stats window, and clear all stats by reading. */
658 outw(StatsDisable, ioaddr + EL3_CMD);
660 for (i = 0; i < 10; i++)
668 /* .. enable any extra statistics bits.. */
669 outw(0x0040, ioaddr + Wn4_NetDiag);
672 spin_unlock_irqrestore(&lp->window_lock, flags);
674 /* .. re-sync MII and re-fill what NWay is advertising. */
675 mdio_sync(ioaddr, 32);
676 mdio_write(ioaddr, lp->phys, 4, lp->advertising);
677 if (!auto_polarity) {
678 /* works for TDK 78Q2120 series MII's */
679 i = mdio_read(ioaddr, lp->phys, 16) | 0x20;
680 mdio_write(ioaddr, lp->phys, 16, i);
683 spin_lock_irqsave(&lp->window_lock, flags);
684 /* Switch to register set 1 for normal use, just for TxFree. */
686 spin_unlock_irqrestore(&lp->window_lock, flags);
687 outw(StatsEnable, ioaddr + EL3_CMD); /* Turn on statistics. */
688 outw(RxEnable, ioaddr + EL3_CMD); /* Enable the receiver. */
689 outw(TxEnable, ioaddr + EL3_CMD); /* Enable transmitter. */
690 /* Allow status bits to be seen. */
691 outw(SetStatusEnb | 0xff, ioaddr + EL3_CMD);
692 /* Ack all pending events, and set active indicator mask. */
693 outw(AckIntr | IntLatch | TxAvailable | RxEarly | IntReq,
695 outw(SetIntrEnb | IntLatch | TxAvailable | RxComplete | StatsFull
696 | AdapterFailure | RxEarly, ioaddr + EL3_CMD);
699 static int el3_open(struct net_device *dev)
701 struct el3_private *lp = netdev_priv(dev);
702 struct pcmcia_device *link = lp->p_dev;
704 if (!pcmcia_dev_present(link))
708 netif_start_queue(dev);
711 lp->media.function = &media_check;
712 lp->media.data = (unsigned long) dev;
713 lp->media.expires = jiffies + HZ;
714 add_timer(&lp->media);
716 dev_dbg(&link->dev, "%s: opened, status %4.4x.\n",
717 dev->name, inw(dev->base_addr + EL3_STATUS));
722 static void el3_tx_timeout(struct net_device *dev)
724 unsigned int ioaddr = dev->base_addr;
726 printk(KERN_NOTICE "%s: Transmit timed out!\n", dev->name);
728 dev->stats.tx_errors++;
729 dev->trans_start = jiffies; /* prevent tx timeout */
730 /* Issue TX_RESET and TX_START commands. */
731 tc574_wait_for_completion(dev, TxReset);
732 outw(TxEnable, ioaddr + EL3_CMD);
733 netif_wake_queue(dev);
736 static void pop_tx_status(struct net_device *dev)
738 unsigned int ioaddr = dev->base_addr;
741 /* Clear the Tx status stack. */
742 for (i = 32; i > 0; i--) {
743 u_char tx_status = inb(ioaddr + TxStatus);
744 if (!(tx_status & 0x84))
746 /* reset transmitter on jabber error or underrun */
747 if (tx_status & 0x30)
748 tc574_wait_for_completion(dev, TxReset);
749 if (tx_status & 0x38) {
750 pr_debug("%s: transmit error: status 0x%02x\n",
751 dev->name, tx_status);
752 outw(TxEnable, ioaddr + EL3_CMD);
753 dev->stats.tx_aborted_errors++;
755 outb(0x00, ioaddr + TxStatus); /* Pop the status stack. */
759 static netdev_tx_t el3_start_xmit(struct sk_buff *skb,
760 struct net_device *dev)
762 unsigned int ioaddr = dev->base_addr;
763 struct el3_private *lp = netdev_priv(dev);
766 pr_debug("%s: el3_start_xmit(length = %ld) called, "
767 "status %4.4x.\n", dev->name, (long)skb->len,
768 inw(ioaddr + EL3_STATUS));
770 spin_lock_irqsave(&lp->window_lock, flags);
772 dev->stats.tx_bytes += skb->len;
774 /* Put out the doubleword header... */
775 outw(skb->len, ioaddr + TX_FIFO);
776 outw(0, ioaddr + TX_FIFO);
777 /* ... and the packet rounded to a doubleword. */
778 outsl(ioaddr + TX_FIFO, skb->data, (skb->len+3)>>2);
780 /* TxFree appears only in Window 1, not offset 0x1c. */
781 if (inw(ioaddr + TxFree) <= 1536) {
782 netif_stop_queue(dev);
783 /* Interrupt us when the FIFO has room for max-sized packet.
784 The threshold is in units of dwords. */
785 outw(SetTxThreshold + (1536>>2), ioaddr + EL3_CMD);
789 spin_unlock_irqrestore(&lp->window_lock, flags);
794 /* The EL3 interrupt handler. */
795 static irqreturn_t el3_interrupt(int irq, void *dev_id)
797 struct net_device *dev = (struct net_device *) dev_id;
798 struct el3_private *lp = netdev_priv(dev);
801 int work_budget = max_interrupt_work;
804 if (!netif_device_present(dev))
806 ioaddr = dev->base_addr;
808 pr_debug("%s: interrupt, status %4.4x.\n",
809 dev->name, inw(ioaddr + EL3_STATUS));
811 spin_lock(&lp->window_lock);
813 while ((status = inw(ioaddr + EL3_STATUS)) &
814 (IntLatch | RxComplete | RxEarly | StatsFull)) {
815 if (!netif_device_present(dev) ||
816 ((status & 0xe000) != 0x2000)) {
817 pr_debug("%s: Interrupt from dead card\n", dev->name);
823 if (status & RxComplete)
824 work_budget = el3_rx(dev, work_budget);
826 if (status & TxAvailable) {
827 pr_debug(" TX room bit was handled.\n");
828 /* There's room in the FIFO for a full-sized packet. */
829 outw(AckIntr | TxAvailable, ioaddr + EL3_CMD);
830 netif_wake_queue(dev);
833 if (status & TxComplete)
836 if (status & (AdapterFailure | RxEarly | StatsFull)) {
837 /* Handle all uncommon interrupts. */
838 if (status & StatsFull)
840 if (status & RxEarly) {
841 work_budget = el3_rx(dev, work_budget);
842 outw(AckIntr | RxEarly, ioaddr + EL3_CMD);
844 if (status & AdapterFailure) {
847 fifo_diag = inw(ioaddr + Wn4_FIFODiag);
849 printk(KERN_NOTICE "%s: adapter failure, FIFO diagnostic"
850 " register %04x.\n", dev->name, fifo_diag);
851 if (fifo_diag & 0x0400) {
853 tc574_wait_for_completion(dev, TxReset);
854 outw(TxEnable, ioaddr + EL3_CMD);
856 if (fifo_diag & 0x2000) {
858 tc574_wait_for_completion(dev, RxReset);
860 outw(RxEnable, ioaddr + EL3_CMD);
862 outw(AckIntr | AdapterFailure, ioaddr + EL3_CMD);
866 if (--work_budget < 0) {
867 pr_debug("%s: Too much work in interrupt, "
868 "status %4.4x.\n", dev->name, status);
869 /* Clear all interrupts */
870 outw(AckIntr | 0xFF, ioaddr + EL3_CMD);
873 /* Acknowledge the IRQ. */
874 outw(AckIntr | IntReq | IntLatch, ioaddr + EL3_CMD);
877 pr_debug("%s: exiting interrupt, status %4.4x.\n",
878 dev->name, inw(ioaddr + EL3_STATUS));
880 spin_unlock(&lp->window_lock);
881 return IRQ_RETVAL(handled);
885 This timer serves two purposes: to check for missed interrupts
886 (and as a last resort, poll the NIC for events), and to monitor
887 the MII, reporting changes in cable status.
889 static void media_check(unsigned long arg)
891 struct net_device *dev = (struct net_device *) arg;
892 struct el3_private *lp = netdev_priv(dev);
893 unsigned int ioaddr = dev->base_addr;
895 unsigned short /* cable, */ media, partner;
897 if (!netif_device_present(dev))
900 /* Check for pending interrupt with expired latency timer: with
901 this, we can limp along even if the interrupt is blocked */
902 if ((inw(ioaddr + EL3_STATUS) & IntLatch) && (inb(ioaddr + Timer) == 0xff)) {
904 printk(KERN_INFO "%s: interrupt(s) dropped!\n", dev->name);
906 local_irq_save(flags);
907 el3_interrupt(dev->irq, dev);
908 local_irq_restore(flags);
914 lp->media.expires = jiffies + 2*HZ/100;
915 add_timer(&lp->media);
919 spin_lock_irqsave(&lp->window_lock, flags);
921 media = mdio_read(ioaddr, lp->phys, 1);
922 partner = mdio_read(ioaddr, lp->phys, 5);
925 if (media != lp->media_status) {
926 if ((media ^ lp->media_status) & 0x0004)
927 printk(KERN_INFO "%s: %s link beat\n", dev->name,
928 (lp->media_status & 0x0004) ? "lost" : "found");
929 if ((media ^ lp->media_status) & 0x0020) {
931 if (lp->media_status & 0x0020) {
932 printk(KERN_INFO "%s: autonegotiation restarted\n",
934 } else if (partner) {
935 partner &= lp->advertising;
936 lp->partner = partner;
937 printk(KERN_INFO "%s: autonegotiation complete: "
938 "%sbaseT-%cD selected\n", dev->name,
939 ((partner & 0x0180) ? "100" : "10"),
940 ((partner & 0x0140) ? 'F' : 'H'));
942 printk(KERN_INFO "%s: link partner did not autonegotiate\n",
947 outb((partner & 0x0140 ? 0x20 : 0) |
948 (dev->mtu > 1500 ? 0x40 : 0), ioaddr + Wn3_MAC_Ctrl);
953 printk(KERN_INFO "%s: remote fault detected\n",
956 printk(KERN_INFO "%s: jabber detected\n", dev->name);
957 lp->media_status = media;
959 spin_unlock_irqrestore(&lp->window_lock, flags);
962 lp->media.expires = jiffies + HZ;
963 add_timer(&lp->media);
966 static struct net_device_stats *el3_get_stats(struct net_device *dev)
968 struct el3_private *lp = netdev_priv(dev);
970 if (netif_device_present(dev)) {
972 spin_lock_irqsave(&lp->window_lock, flags);
974 spin_unlock_irqrestore(&lp->window_lock, flags);
979 /* Update statistics.
980 Suprisingly this need not be run single-threaded, but it effectively is.
981 The counters clear when read, so the adds must merely be atomic.
983 static void update_stats(struct net_device *dev)
985 unsigned int ioaddr = dev->base_addr;
988 pr_debug("%s: updating the statistics.\n", dev->name);
990 if (inw(ioaddr+EL3_STATUS) == 0xffff) /* No card. */
993 /* Unlike the 3c509 we need not turn off stats updates while reading. */
994 /* Switch to the stats window, and read everything. */
996 dev->stats.tx_carrier_errors += inb(ioaddr + 0);
997 dev->stats.tx_heartbeat_errors += inb(ioaddr + 1);
998 /* Multiple collisions. */ inb(ioaddr + 2);
999 dev->stats.collisions += inb(ioaddr + 3);
1000 dev->stats.tx_window_errors += inb(ioaddr + 4);
1001 dev->stats.rx_fifo_errors += inb(ioaddr + 5);
1002 dev->stats.tx_packets += inb(ioaddr + 6);
1003 up = inb(ioaddr + 9);
1004 dev->stats.tx_packets += (up&0x30) << 4;
1005 /* Rx packets */ inb(ioaddr + 7);
1006 /* Tx deferrals */ inb(ioaddr + 8);
1007 rx = inw(ioaddr + 10);
1008 tx = inw(ioaddr + 12);
1011 /* BadSSD */ inb(ioaddr + 12);
1012 up = inb(ioaddr + 13);
1017 static int el3_rx(struct net_device *dev, int worklimit)
1019 unsigned int ioaddr = dev->base_addr;
1022 pr_debug("%s: in rx_packet(), status %4.4x, rx_status %4.4x.\n",
1023 dev->name, inw(ioaddr+EL3_STATUS), inw(ioaddr+RxStatus));
1024 while (!((rx_status = inw(ioaddr + RxStatus)) & 0x8000) &&
1027 if (rx_status & 0x4000) { /* Error, update stats. */
1028 short error = rx_status & 0x3800;
1029 dev->stats.rx_errors++;
1031 case 0x0000: dev->stats.rx_over_errors++; break;
1032 case 0x0800: dev->stats.rx_length_errors++; break;
1033 case 0x1000: dev->stats.rx_frame_errors++; break;
1034 case 0x1800: dev->stats.rx_length_errors++; break;
1035 case 0x2000: dev->stats.rx_frame_errors++; break;
1036 case 0x2800: dev->stats.rx_crc_errors++; break;
1039 short pkt_len = rx_status & 0x7ff;
1040 struct sk_buff *skb;
1042 skb = dev_alloc_skb(pkt_len+5);
1044 pr_debug(" Receiving packet size %d status %4.4x.\n",
1045 pkt_len, rx_status);
1047 skb_reserve(skb, 2);
1048 insl(ioaddr+RX_FIFO, skb_put(skb, pkt_len),
1050 skb->protocol = eth_type_trans(skb, dev);
1052 dev->stats.rx_packets++;
1053 dev->stats.rx_bytes += pkt_len;
1055 pr_debug("%s: couldn't allocate a sk_buff of"
1056 " size %d.\n", dev->name, pkt_len);
1057 dev->stats.rx_dropped++;
1060 tc574_wait_for_completion(dev, RxDiscard);
1066 static void netdev_get_drvinfo(struct net_device *dev,
1067 struct ethtool_drvinfo *info)
1069 strcpy(info->driver, "3c574_cs");
1072 static const struct ethtool_ops netdev_ethtool_ops = {
1073 .get_drvinfo = netdev_get_drvinfo,
1076 /* Provide ioctl() calls to examine the MII xcvr state. */
1077 static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
1079 struct el3_private *lp = netdev_priv(dev);
1080 unsigned int ioaddr = dev->base_addr;
1081 struct mii_ioctl_data *data = if_mii(rq);
1082 int phy = lp->phys & 0x1f;
1084 pr_debug("%s: In ioct(%-.6s, %#4.4x) %4.4x %4.4x %4.4x %4.4x.\n",
1085 dev->name, rq->ifr_ifrn.ifrn_name, cmd,
1086 data->phy_id, data->reg_num, data->val_in, data->val_out);
1089 case SIOCGMIIPHY: /* Get the address of the PHY in use. */
1091 case SIOCGMIIREG: /* Read the specified MII register. */
1094 unsigned long flags;
1096 spin_lock_irqsave(&lp->window_lock, flags);
1097 saved_window = inw(ioaddr + EL3_CMD) >> 13;
1099 data->val_out = mdio_read(ioaddr, data->phy_id & 0x1f,
1100 data->reg_num & 0x1f);
1101 EL3WINDOW(saved_window);
1102 spin_unlock_irqrestore(&lp->window_lock, flags);
1105 case SIOCSMIIREG: /* Write the specified MII register */
1108 unsigned long flags;
1110 spin_lock_irqsave(&lp->window_lock, flags);
1111 saved_window = inw(ioaddr + EL3_CMD) >> 13;
1113 mdio_write(ioaddr, data->phy_id & 0x1f,
1114 data->reg_num & 0x1f, data->val_in);
1115 EL3WINDOW(saved_window);
1116 spin_unlock_irqrestore(&lp->window_lock, flags);
1124 /* The Odie chip has a 64 bin multicast filter, but the bit layout is not
1125 documented. Until it is we revert to receiving all multicast frames when
1126 any multicast reception is desired.
1127 Note: My other drivers emit a log message whenever promiscuous mode is
1128 entered to help detect password sniffers. This is less desirable on
1129 typical PC card machines, so we omit the message.
1132 static void set_rx_mode(struct net_device *dev)
1134 unsigned int ioaddr = dev->base_addr;
1136 if (dev->flags & IFF_PROMISC)
1137 outw(SetRxFilter | RxStation | RxMulticast | RxBroadcast | RxProm,
1139 else if (!netdev_mc_empty(dev) || (dev->flags & IFF_ALLMULTI))
1140 outw(SetRxFilter|RxStation|RxMulticast|RxBroadcast, ioaddr + EL3_CMD);
1142 outw(SetRxFilter | RxStation | RxBroadcast, ioaddr + EL3_CMD);
1145 static void set_multicast_list(struct net_device *dev)
1147 struct el3_private *lp = netdev_priv(dev);
1148 unsigned long flags;
1150 spin_lock_irqsave(&lp->window_lock, flags);
1152 spin_unlock_irqrestore(&lp->window_lock, flags);
1155 static int el3_close(struct net_device *dev)
1157 unsigned int ioaddr = dev->base_addr;
1158 struct el3_private *lp = netdev_priv(dev);
1159 struct pcmcia_device *link = lp->p_dev;
1161 dev_dbg(&link->dev, "%s: shutting down ethercard.\n", dev->name);
1163 if (pcmcia_dev_present(link)) {
1164 unsigned long flags;
1166 /* Turn off statistics ASAP. We update lp->stats below. */
1167 outw(StatsDisable, ioaddr + EL3_CMD);
1169 /* Disable the receiver and transmitter. */
1170 outw(RxDisable, ioaddr + EL3_CMD);
1171 outw(TxDisable, ioaddr + EL3_CMD);
1173 /* Note: Switching to window 0 may disable the IRQ. */
1175 spin_lock_irqsave(&lp->window_lock, flags);
1177 spin_unlock_irqrestore(&lp->window_lock, flags);
1179 /* force interrupts off */
1180 outw(SetIntrEnb | 0x0000, ioaddr + EL3_CMD);
1184 netif_stop_queue(dev);
1185 del_timer_sync(&lp->media);
1190 static struct pcmcia_device_id tc574_ids[] = {
1191 PCMCIA_DEVICE_MANF_CARD(0x0101, 0x0574),
1192 PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x0556, "cis/3CCFEM556.cis"),
1195 MODULE_DEVICE_TABLE(pcmcia, tc574_ids);
1197 static struct pcmcia_driver tc574_driver = {
1198 .owner = THIS_MODULE,
1202 .probe = tc574_probe,
1203 .remove = tc574_detach,
1204 .id_table = tc574_ids,
1205 .suspend = tc574_suspend,
1206 .resume = tc574_resume,
1209 static int __init init_tc574(void)
1211 return pcmcia_register_driver(&tc574_driver);
1214 static void __exit exit_tc574(void)
1216 pcmcia_unregister_driver(&tc574_driver);
1219 module_init(init_tc574);
1220 module_exit(exit_tc574);