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>
89 #include <pcmcia/cs_types.h>
90 #include <pcmcia/cs.h>
91 #include <pcmcia/cistpl.h>
92 #include <pcmcia/cisreg.h>
93 #include <pcmcia/ciscode.h>
94 #include <pcmcia/ds.h>
95 #include <pcmcia/mem_op.h>
97 #include <asm/uaccess.h>
99 #include <asm/system.h>
101 /*====================================================================*/
103 /* Module parameters */
105 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
106 MODULE_DESCRIPTION("3Com 3c574 series PCMCIA ethernet driver");
107 MODULE_LICENSE("GPL");
109 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)
111 /* Maximum events (Rx packets, etc.) to handle at each interrupt. */
112 INT_MODULE_PARM(max_interrupt_work, 32);
114 /* Force full duplex modes? */
115 INT_MODULE_PARM(full_duplex, 0);
117 /* Autodetect link polarity reversal? */
118 INT_MODULE_PARM(auto_polarity, 1);
121 INT_MODULE_PARM(pc_debug, PCMCIA_DEBUG);
122 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
123 static char *version =
124 "3c574_cs.c 1.65ac1 2003/04/07 Donald Becker/David Hinds, becker@scyld.com.\n";
126 #define DEBUG(n, args...)
129 /*====================================================================*/
131 /* Time in jiffies before concluding the transmitter is hung. */
132 #define TX_TIMEOUT ((800*HZ)/1000)
134 /* To minimize the size of the driver source and make the driver more
135 readable not all constants are symbolically defined.
136 You'll need the manual if you want to understand driver details anyway. */
137 /* Offsets from base I/O address. */
138 #define EL3_DATA 0x00
140 #define EL3_STATUS 0x0e
142 #define EL3WINDOW(win_num) outw(SelectWindow + (win_num), ioaddr + EL3_CMD)
144 /* The top five bits written to EL3_CMD are a command, the lower
145 11 bits are the parameter, if applicable. */
147 TotalReset = 0<<11, SelectWindow = 1<<11, StartCoax = 2<<11,
148 RxDisable = 3<<11, RxEnable = 4<<11, RxReset = 5<<11, RxDiscard = 8<<11,
149 TxEnable = 9<<11, TxDisable = 10<<11, TxReset = 11<<11,
150 FakeIntr = 12<<11, AckIntr = 13<<11, SetIntrEnb = 14<<11,
151 SetStatusEnb = 15<<11, SetRxFilter = 16<<11, SetRxThreshold = 17<<11,
152 SetTxThreshold = 18<<11, SetTxStart = 19<<11, StatsEnable = 21<<11,
153 StatsDisable = 22<<11, StopCoax = 23<<11,
157 IntLatch = 0x0001, AdapterFailure = 0x0002, TxComplete = 0x0004,
158 TxAvailable = 0x0008, RxComplete = 0x0010, RxEarly = 0x0020,
159 IntReq = 0x0040, StatsFull = 0x0080, CmdBusy = 0x1000 };
161 /* The SetRxFilter command accepts the following classes: */
163 RxStation = 1, RxMulticast = 2, RxBroadcast = 4, RxProm = 8
167 Wn0EepromCmd = 10, Wn0EepromData = 12, /* EEPROM command/address, data. */
168 IntrStatus=0x0E, /* Valid in all windows. */
170 /* These assumes the larger EEPROM. */
171 enum Win0_EEPROM_cmds {
172 EEPROM_Read = 0x200, EEPROM_WRITE = 0x100, EEPROM_ERASE = 0x300,
173 EEPROM_EWENB = 0x30, /* Enable erasing/writing for 10 msec. */
174 EEPROM_EWDIS = 0x00, /* Disable EWENB before 10 msec timeout. */
177 /* Register window 1 offsets, the window used in normal operation.
178 On the "Odie" this window is always mapped at offsets 0x10-0x1f.
179 Except for TxFree, which is overlapped by RunnerWrCtrl. */
181 TX_FIFO = 0x10, RX_FIFO = 0x10, RxErrors = 0x14,
182 RxStatus = 0x18, Timer=0x1A, TxStatus = 0x1B,
183 TxFree = 0x0C, /* Remaining free bytes in Tx buffer. */
184 RunnerRdCtrl = 0x16, RunnerWrCtrl = 0x1c,
187 enum Window3 { /* Window 3: MAC/config bits. */
188 Wn3_Config=0, Wn3_MAC_Ctrl=6, Wn3_Options=8,
192 struct w3_config_fields {
193 unsigned int ram_size:3, ram_width:1, ram_speed:2, rom_size:2;
195 unsigned int ram_split:2, pad18:2, xcvr:3, pad21:1, autoselect:1;
200 enum Window4 { /* Window 4: Xcvr/media bits. */
201 Wn4_FIFODiag = 4, Wn4_NetDiag = 6, Wn4_PhysicalMgmt=8, Wn4_Media = 10,
204 #define MEDIA_TP 0x00C0 /* Enable link beat and jabber for 10baseT. */
209 struct net_device_stats stats;
210 u16 advertising, partner; /* NWay media advertisement */
211 unsigned char phys; /* MII device address */
212 unsigned int autoselect:1, default_media:3; /* Read from the EEPROM/Wn3_Config. */
213 /* for transceiver monitoring */
214 struct timer_list media;
215 unsigned short media_status;
216 unsigned short fast_poll;
217 unsigned long last_irq;
218 spinlock_t window_lock; /* Guards the Window selection */
221 /* Set iff a MII transceiver on any interface requires mdio preamble.
222 This only set with the original DP83840 on older 3c905 boards, so the extra
223 code size of a per-interface flag is not worthwhile. */
224 static char mii_preamble_required = 0;
226 /* Index of functions. */
228 static void tc574_config(dev_link_t *link);
229 static void tc574_release(dev_link_t *link);
231 static void mdio_sync(kio_addr_t ioaddr, int bits);
232 static int mdio_read(kio_addr_t ioaddr, int phy_id, int location);
233 static void mdio_write(kio_addr_t ioaddr, int phy_id, int location, int value);
234 static unsigned short read_eeprom(kio_addr_t ioaddr, int index);
235 static void tc574_wait_for_completion(struct net_device *dev, int cmd);
237 static void tc574_reset(struct net_device *dev);
238 static void media_check(unsigned long arg);
239 static int el3_open(struct net_device *dev);
240 static int el3_start_xmit(struct sk_buff *skb, struct net_device *dev);
241 static irqreturn_t el3_interrupt(int irq, void *dev_id, struct pt_regs *regs);
242 static void update_stats(struct net_device *dev);
243 static struct net_device_stats *el3_get_stats(struct net_device *dev);
244 static int el3_rx(struct net_device *dev, int worklimit);
245 static int el3_close(struct net_device *dev);
246 static void el3_tx_timeout(struct net_device *dev);
247 static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
248 static struct ethtool_ops netdev_ethtool_ops;
249 static void set_rx_mode(struct net_device *dev);
251 static void tc574_detach(struct pcmcia_device *p_dev);
254 tc574_attach() creates an "instance" of the driver, allocating
255 local data structures for one device. The device is registered
259 static int tc574_attach(struct pcmcia_device *p_dev)
261 struct el3_private *lp;
263 struct net_device *dev;
265 DEBUG(0, "3c574_attach()\n");
267 /* Create the PC card device object. */
268 dev = alloc_etherdev(sizeof(struct el3_private));
271 lp = netdev_priv(dev);
275 spin_lock_init(&lp->window_lock);
276 link->io.NumPorts1 = 32;
277 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
278 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE | IRQ_HANDLE_PRESENT;
279 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
280 link->irq.Handler = &el3_interrupt;
281 link->irq.Instance = dev;
282 link->conf.Attributes = CONF_ENABLE_IRQ;
283 link->conf.IntType = INT_MEMORY_AND_IO;
284 link->conf.ConfigIndex = 1;
285 link->conf.Present = PRESENT_OPTION;
287 /* The EL3-specific entries in the device structure. */
288 dev->hard_start_xmit = &el3_start_xmit;
289 dev->get_stats = &el3_get_stats;
290 dev->do_ioctl = &el3_ioctl;
291 SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
292 dev->set_multicast_list = &set_rx_mode;
293 dev->open = &el3_open;
294 dev->stop = &el3_close;
295 #ifdef HAVE_TX_TIMEOUT
296 dev->tx_timeout = el3_tx_timeout;
297 dev->watchdog_timeo = TX_TIMEOUT;
300 link->handle = p_dev;
301 p_dev->instance = link;
303 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
311 This deletes a driver "instance". The device is de-registered
312 with Card Services. If it has been released, all local data
313 structures are freed. Otherwise, the structures will be freed
314 when the device is released.
318 static void tc574_detach(struct pcmcia_device *p_dev)
320 dev_link_t *link = dev_to_instance(p_dev);
321 struct net_device *dev = link->priv;
323 DEBUG(0, "3c574_detach(0x%p)\n", link);
326 unregister_netdev(dev);
328 if (link->state & DEV_CONFIG)
335 tc574_config() is scheduled to run after a CARD_INSERTION event
336 is received, to configure the PCMCIA socket, and to make the
337 ethernet device available to the system.
340 #define CS_CHECK(fn, ret) \
341 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
343 static const char *ram_split[] = {"5:3", "3:1", "1:1", "3:5"};
345 static void tc574_config(dev_link_t *link)
347 client_handle_t handle = link->handle;
348 struct net_device *dev = link->priv;
349 struct el3_private *lp = netdev_priv(dev);
352 unsigned short buf[32];
353 int last_fn, last_ret, i, j;
357 union wn3_config config;
359 phys_addr = (u16 *)dev->dev_addr;
361 DEBUG(0, "3c574_config(0x%p)\n", link);
363 tuple.Attributes = 0;
364 tuple.DesiredTuple = CISTPL_CONFIG;
365 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
366 tuple.TupleData = (cisdata_t *)buf;
367 tuple.TupleDataMax = 64;
368 tuple.TupleOffset = 0;
369 CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
370 CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
371 link->conf.ConfigBase = parse.config.base;
372 link->conf.Present = parse.config.rmask[0];
375 link->state |= DEV_CONFIG;
377 link->io.IOAddrLines = 16;
378 for (i = j = 0; j < 0x400; j += 0x20) {
379 link->io.BasePort1 = j ^ 0x300;
380 i = pcmcia_request_io(link->handle, &link->io);
381 if (i == CS_SUCCESS) break;
383 if (i != CS_SUCCESS) {
384 cs_error(link->handle, RequestIO, i);
387 CS_CHECK(RequestIRQ, pcmcia_request_irq(link->handle, &link->irq));
388 CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link->handle, &link->conf));
390 dev->irq = link->irq.AssignedIRQ;
391 dev->base_addr = link->io.BasePort1;
393 ioaddr = dev->base_addr;
395 /* The 3c574 normally uses an EEPROM for configuration info, including
396 the hardware address. The future products may include a modem chip
397 and put the address in the CIS. */
398 tuple.DesiredTuple = 0x88;
399 if (pcmcia_get_first_tuple(handle, &tuple) == CS_SUCCESS) {
400 pcmcia_get_tuple_data(handle, &tuple);
401 for (i = 0; i < 3; i++)
402 phys_addr[i] = htons(buf[i]);
405 for (i = 0; i < 3; i++)
406 phys_addr[i] = htons(read_eeprom(ioaddr, i + 10));
407 if (phys_addr[0] == 0x6060) {
408 printk(KERN_NOTICE "3c574_cs: IO port conflict at 0x%03lx"
409 "-0x%03lx\n", dev->base_addr, dev->base_addr+15);
413 tuple.DesiredTuple = CISTPL_VERS_1;
414 if (pcmcia_get_first_tuple(handle, &tuple) == CS_SUCCESS &&
415 pcmcia_get_tuple_data(handle, &tuple) == CS_SUCCESS &&
416 pcmcia_parse_tuple(handle, &tuple, &parse) == CS_SUCCESS) {
417 cardname = parse.version_1.str + parse.version_1.ofs[1];
419 cardname = "3Com 3c574";
423 outw(2<<11, ioaddr + RunnerRdCtrl);
424 mcr = inb(ioaddr + 2);
425 outw(0<<11, ioaddr + RunnerRdCtrl);
426 printk(KERN_INFO " ASIC rev %d,", mcr>>3);
428 config.i = inl(ioaddr + Wn3_Config);
429 lp->default_media = config.u.xcvr;
430 lp->autoselect = config.u.autoselect;
433 init_timer(&lp->media);
438 /* Roadrunner only: Turn on the MII transceiver */
439 outw(0x8040, ioaddr + Wn3_Options);
441 outw(0xc040, ioaddr + Wn3_Options);
442 tc574_wait_for_completion(dev, TxReset);
443 tc574_wait_for_completion(dev, RxReset);
445 outw(0x8040, ioaddr + Wn3_Options);
448 for (phy = 1; phy <= 32; phy++) {
450 mdio_sync(ioaddr, 32);
451 mii_status = mdio_read(ioaddr, phy & 0x1f, 1);
452 if (mii_status != 0xffff) {
453 lp->phys = phy & 0x1f;
454 DEBUG(0, " MII transceiver at index %d, status %x.\n",
456 if ((mii_status & 0x0040) == 0)
457 mii_preamble_required = 1;
462 printk(KERN_NOTICE " No MII transceivers found!\n");
465 i = mdio_read(ioaddr, lp->phys, 16) | 0x40;
466 mdio_write(ioaddr, lp->phys, 16, i);
467 lp->advertising = mdio_read(ioaddr, lp->phys, 4);
469 /* Only advertise the FD media types. */
470 lp->advertising &= ~0x02a0;
471 mdio_write(ioaddr, lp->phys, 4, lp->advertising);
475 link->state &= ~DEV_CONFIG_PENDING;
476 link->dev = &lp->node;
477 SET_NETDEV_DEV(dev, &handle_to_dev(handle));
479 if (register_netdev(dev) != 0) {
480 printk(KERN_NOTICE "3c574_cs: register_netdev() failed\n");
485 strcpy(lp->node.dev_name, dev->name);
487 printk(KERN_INFO "%s: %s at io %#3lx, irq %d, hw_addr ",
488 dev->name, cardname, dev->base_addr, dev->irq);
489 for (i = 0; i < 6; i++)
490 printk("%02X%s", dev->dev_addr[i], ((i<5) ? ":" : ".\n"));
491 printk(" %dK FIFO split %s Rx:Tx, %sMII interface.\n",
492 8 << config.u.ram_size, ram_split[config.u.ram_split],
493 config.u.autoselect ? "autoselect " : "");
498 cs_error(link->handle, last_fn, last_ret);
506 After a card is removed, tc574_release() will unregister the net
507 device, and release the PCMCIA configuration. If the device is
508 still open, this will be postponed until it is closed.
511 static void tc574_release(dev_link_t *link)
513 pcmcia_disable_device(link->handle);
516 static int tc574_suspend(struct pcmcia_device *p_dev)
518 dev_link_t *link = dev_to_instance(p_dev);
519 struct net_device *dev = link->priv;
521 if ((link->state & DEV_CONFIG) && (link->open))
522 netif_device_detach(dev);
527 static int tc574_resume(struct pcmcia_device *p_dev)
529 dev_link_t *link = dev_to_instance(p_dev);
530 struct net_device *dev = link->priv;
532 if ((link->state & DEV_CONFIG) && (link->open)) {
534 netif_device_attach(dev);
540 static void dump_status(struct net_device *dev)
542 kio_addr_t ioaddr = dev->base_addr;
544 printk(KERN_INFO " irq status %04x, rx status %04x, tx status "
545 "%02x, tx free %04x\n", inw(ioaddr+EL3_STATUS),
546 inw(ioaddr+RxStatus), inb(ioaddr+TxStatus),
549 printk(KERN_INFO " diagnostics: fifo %04x net %04x ethernet %04x"
550 " media %04x\n", inw(ioaddr+0x04), inw(ioaddr+0x06),
551 inw(ioaddr+0x08), inw(ioaddr+0x0a));
556 Use this for commands that may take time to finish
558 static void tc574_wait_for_completion(struct net_device *dev, int cmd)
561 outw(cmd, dev->base_addr + EL3_CMD);
563 if (!(inw(dev->base_addr + EL3_STATUS) & 0x1000)) break;
565 printk(KERN_NOTICE "%s: command 0x%04x did not complete!\n", dev->name, cmd);
568 /* Read a word from the EEPROM using the regular EEPROM access register.
569 Assume that we are in register window zero.
571 static unsigned short read_eeprom(kio_addr_t ioaddr, int index)
574 outw(EEPROM_Read + index, ioaddr + Wn0EepromCmd);
575 /* Pause for at least 162 usec for the read to take place. */
576 for (timer = 1620; timer >= 0; timer--) {
577 if ((inw(ioaddr + Wn0EepromCmd) & 0x8000) == 0)
580 return inw(ioaddr + Wn0EepromData);
583 /* MII transceiver control section.
584 Read and write the MII registers using software-generated serial
585 MDIO protocol. See the MII specifications or DP83840A data sheet
587 The maxium data clock rate is 2.5 Mhz. The timing is easily met by the
588 slow PC card interface. */
590 #define MDIO_SHIFT_CLK 0x01
591 #define MDIO_DIR_WRITE 0x04
592 #define MDIO_DATA_WRITE0 (0x00 | MDIO_DIR_WRITE)
593 #define MDIO_DATA_WRITE1 (0x02 | MDIO_DIR_WRITE)
594 #define MDIO_DATA_READ 0x02
595 #define MDIO_ENB_IN 0x00
597 /* Generate the preamble required for initial synchronization and
598 a few older transceivers. */
599 static void mdio_sync(kio_addr_t ioaddr, int bits)
601 kio_addr_t mdio_addr = ioaddr + Wn4_PhysicalMgmt;
603 /* Establish sync by sending at least 32 logic ones. */
604 while (-- bits >= 0) {
605 outw(MDIO_DATA_WRITE1, mdio_addr);
606 outw(MDIO_DATA_WRITE1 | MDIO_SHIFT_CLK, mdio_addr);
610 static int mdio_read(kio_addr_t ioaddr, int phy_id, int location)
613 int read_cmd = (0xf6 << 10) | (phy_id << 5) | location;
614 unsigned int retval = 0;
615 kio_addr_t mdio_addr = ioaddr + Wn4_PhysicalMgmt;
617 if (mii_preamble_required)
618 mdio_sync(ioaddr, 32);
620 /* Shift the read command bits out. */
621 for (i = 14; i >= 0; i--) {
622 int dataval = (read_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
623 outw(dataval, mdio_addr);
624 outw(dataval | MDIO_SHIFT_CLK, mdio_addr);
626 /* Read the two transition, 16 data, and wire-idle bits. */
627 for (i = 19; i > 0; i--) {
628 outw(MDIO_ENB_IN, mdio_addr);
629 retval = (retval << 1) | ((inw(mdio_addr) & MDIO_DATA_READ) ? 1 : 0);
630 outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);
632 return (retval>>1) & 0xffff;
635 static void mdio_write(kio_addr_t ioaddr, int phy_id, int location, int value)
637 int write_cmd = 0x50020000 | (phy_id << 23) | (location << 18) | value;
638 kio_addr_t mdio_addr = ioaddr + Wn4_PhysicalMgmt;
641 if (mii_preamble_required)
642 mdio_sync(ioaddr, 32);
644 /* Shift the command bits out. */
645 for (i = 31; i >= 0; i--) {
646 int dataval = (write_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
647 outw(dataval, mdio_addr);
648 outw(dataval | MDIO_SHIFT_CLK, mdio_addr);
650 /* Leave the interface idle. */
651 for (i = 1; i >= 0; i--) {
652 outw(MDIO_ENB_IN, mdio_addr);
653 outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);
659 /* Reset and restore all of the 3c574 registers. */
660 static void tc574_reset(struct net_device *dev)
662 struct el3_private *lp = netdev_priv(dev);
664 kio_addr_t ioaddr = dev->base_addr;
667 tc574_wait_for_completion(dev, TotalReset|0x10);
669 spin_lock_irqsave(&lp->window_lock, flags);
670 /* Clear any transactions in progress. */
671 outw(0, ioaddr + RunnerWrCtrl);
672 outw(0, ioaddr + RunnerRdCtrl);
674 /* Set the station address and mask. */
676 for (i = 0; i < 6; i++)
677 outb(dev->dev_addr[i], ioaddr + i);
681 /* Reset config options */
683 outb((dev->mtu > 1500 ? 0x40 : 0), ioaddr + Wn3_MAC_Ctrl);
684 outl((lp->autoselect ? 0x01000000 : 0) | 0x0062001b,
685 ioaddr + Wn3_Config);
686 /* Roadrunner only: Turn on the MII transceiver. */
687 outw(0x8040, ioaddr + Wn3_Options);
689 outw(0xc040, ioaddr + Wn3_Options);
691 spin_unlock_irqrestore(&lp->window_lock, flags);
693 tc574_wait_for_completion(dev, TxReset);
694 tc574_wait_for_completion(dev, RxReset);
696 spin_lock_irqsave(&lp->window_lock, flags);
698 outw(0x8040, ioaddr + Wn3_Options);
700 /* Switch to the stats window, and clear all stats by reading. */
701 outw(StatsDisable, ioaddr + EL3_CMD);
703 for (i = 0; i < 10; i++)
711 /* .. enable any extra statistics bits.. */
712 outw(0x0040, ioaddr + Wn4_NetDiag);
715 spin_unlock_irqrestore(&lp->window_lock, flags);
717 /* .. re-sync MII and re-fill what NWay is advertising. */
718 mdio_sync(ioaddr, 32);
719 mdio_write(ioaddr, lp->phys, 4, lp->advertising);
720 if (!auto_polarity) {
721 /* works for TDK 78Q2120 series MII's */
722 int i = mdio_read(ioaddr, lp->phys, 16) | 0x20;
723 mdio_write(ioaddr, lp->phys, 16, i);
726 spin_lock_irqsave(&lp->window_lock, flags);
727 /* Switch to register set 1 for normal use, just for TxFree. */
729 spin_unlock_irqrestore(&lp->window_lock, flags);
730 outw(StatsEnable, ioaddr + EL3_CMD); /* Turn on statistics. */
731 outw(RxEnable, ioaddr + EL3_CMD); /* Enable the receiver. */
732 outw(TxEnable, ioaddr + EL3_CMD); /* Enable transmitter. */
733 /* Allow status bits to be seen. */
734 outw(SetStatusEnb | 0xff, ioaddr + EL3_CMD);
735 /* Ack all pending events, and set active indicator mask. */
736 outw(AckIntr | IntLatch | TxAvailable | RxEarly | IntReq,
738 outw(SetIntrEnb | IntLatch | TxAvailable | RxComplete | StatsFull
739 | AdapterFailure | RxEarly, ioaddr + EL3_CMD);
742 static int el3_open(struct net_device *dev)
744 struct el3_private *lp = netdev_priv(dev);
745 dev_link_t *link = &lp->link;
751 netif_start_queue(dev);
754 lp->media.function = &media_check;
755 lp->media.data = (unsigned long) dev;
756 lp->media.expires = jiffies + HZ;
757 add_timer(&lp->media);
759 DEBUG(2, "%s: opened, status %4.4x.\n",
760 dev->name, inw(dev->base_addr + EL3_STATUS));
765 static void el3_tx_timeout(struct net_device *dev)
767 struct el3_private *lp = netdev_priv(dev);
768 kio_addr_t ioaddr = dev->base_addr;
770 printk(KERN_NOTICE "%s: Transmit timed out!\n", dev->name);
772 lp->stats.tx_errors++;
773 dev->trans_start = jiffies;
774 /* Issue TX_RESET and TX_START commands. */
775 tc574_wait_for_completion(dev, TxReset);
776 outw(TxEnable, ioaddr + EL3_CMD);
777 netif_wake_queue(dev);
780 static void pop_tx_status(struct net_device *dev)
782 struct el3_private *lp = netdev_priv(dev);
783 kio_addr_t ioaddr = dev->base_addr;
786 /* Clear the Tx status stack. */
787 for (i = 32; i > 0; i--) {
788 u_char tx_status = inb(ioaddr + TxStatus);
789 if (!(tx_status & 0x84))
791 /* reset transmitter on jabber error or underrun */
792 if (tx_status & 0x30)
793 tc574_wait_for_completion(dev, TxReset);
794 if (tx_status & 0x38) {
795 DEBUG(1, "%s: transmit error: status 0x%02x\n",
796 dev->name, tx_status);
797 outw(TxEnable, ioaddr + EL3_CMD);
798 lp->stats.tx_aborted_errors++;
800 outb(0x00, ioaddr + TxStatus); /* Pop the status stack. */
804 static int el3_start_xmit(struct sk_buff *skb, struct net_device *dev)
806 kio_addr_t ioaddr = dev->base_addr;
807 struct el3_private *lp = netdev_priv(dev);
810 DEBUG(3, "%s: el3_start_xmit(length = %ld) called, "
811 "status %4.4x.\n", dev->name, (long)skb->len,
812 inw(ioaddr + EL3_STATUS));
814 spin_lock_irqsave(&lp->window_lock, flags);
815 outw(skb->len, ioaddr + TX_FIFO);
816 outw(0, ioaddr + TX_FIFO);
817 outsl(ioaddr + TX_FIFO, skb->data, (skb->len+3)>>2);
819 dev->trans_start = jiffies;
821 /* TxFree appears only in Window 1, not offset 0x1c. */
822 if (inw(ioaddr + TxFree) <= 1536) {
823 netif_stop_queue(dev);
824 /* Interrupt us when the FIFO has room for max-sized packet.
825 The threshold is in units of dwords. */
826 outw(SetTxThreshold + (1536>>2), ioaddr + EL3_CMD);
830 spin_unlock_irqrestore(&lp->window_lock, flags);
835 /* The EL3 interrupt handler. */
836 static irqreturn_t el3_interrupt(int irq, void *dev_id, struct pt_regs *regs)
838 struct net_device *dev = (struct net_device *) dev_id;
839 struct el3_private *lp = netdev_priv(dev);
842 int work_budget = max_interrupt_work;
845 if (!netif_device_present(dev))
847 ioaddr = dev->base_addr;
849 DEBUG(3, "%s: interrupt, status %4.4x.\n",
850 dev->name, inw(ioaddr + EL3_STATUS));
852 spin_lock(&lp->window_lock);
854 while ((status = inw(ioaddr + EL3_STATUS)) &
855 (IntLatch | RxComplete | RxEarly | StatsFull)) {
856 if (!netif_device_present(dev) ||
857 ((status & 0xe000) != 0x2000)) {
858 DEBUG(1, "%s: Interrupt from dead card\n", dev->name);
864 if (status & RxComplete)
865 work_budget = el3_rx(dev, work_budget);
867 if (status & TxAvailable) {
868 DEBUG(3, " TX room bit was handled.\n");
869 /* There's room in the FIFO for a full-sized packet. */
870 outw(AckIntr | TxAvailable, ioaddr + EL3_CMD);
871 netif_wake_queue(dev);
874 if (status & TxComplete)
877 if (status & (AdapterFailure | RxEarly | StatsFull)) {
878 /* Handle all uncommon interrupts. */
879 if (status & StatsFull)
881 if (status & RxEarly) {
882 work_budget = el3_rx(dev, work_budget);
883 outw(AckIntr | RxEarly, ioaddr + EL3_CMD);
885 if (status & AdapterFailure) {
888 fifo_diag = inw(ioaddr + Wn4_FIFODiag);
890 printk(KERN_NOTICE "%s: adapter failure, FIFO diagnostic"
891 " register %04x.\n", dev->name, fifo_diag);
892 if (fifo_diag & 0x0400) {
894 tc574_wait_for_completion(dev, TxReset);
895 outw(TxEnable, ioaddr + EL3_CMD);
897 if (fifo_diag & 0x2000) {
899 tc574_wait_for_completion(dev, RxReset);
901 outw(RxEnable, ioaddr + EL3_CMD);
903 outw(AckIntr | AdapterFailure, ioaddr + EL3_CMD);
907 if (--work_budget < 0) {
908 DEBUG(0, "%s: Too much work in interrupt, "
909 "status %4.4x.\n", dev->name, status);
910 /* Clear all interrupts */
911 outw(AckIntr | 0xFF, ioaddr + EL3_CMD);
914 /* Acknowledge the IRQ. */
915 outw(AckIntr | IntReq | IntLatch, ioaddr + EL3_CMD);
918 DEBUG(3, "%s: exiting interrupt, status %4.4x.\n",
919 dev->name, inw(ioaddr + EL3_STATUS));
921 spin_unlock(&lp->window_lock);
922 return IRQ_RETVAL(handled);
926 This timer serves two purposes: to check for missed interrupts
927 (and as a last resort, poll the NIC for events), and to monitor
928 the MII, reporting changes in cable status.
930 static void media_check(unsigned long arg)
932 struct net_device *dev = (struct net_device *) arg;
933 struct el3_private *lp = netdev_priv(dev);
934 kio_addr_t ioaddr = dev->base_addr;
936 unsigned short /* cable, */ media, partner;
938 if (!netif_device_present(dev))
941 /* Check for pending interrupt with expired latency timer: with
942 this, we can limp along even if the interrupt is blocked */
943 if ((inw(ioaddr + EL3_STATUS) & IntLatch) && (inb(ioaddr + Timer) == 0xff)) {
945 printk(KERN_INFO "%s: interrupt(s) dropped!\n", dev->name);
946 el3_interrupt(dev->irq, lp, NULL);
951 lp->media.expires = jiffies + 2*HZ/100;
952 add_timer(&lp->media);
956 spin_lock_irqsave(&lp->window_lock, flags);
958 media = mdio_read(ioaddr, lp->phys, 1);
959 partner = mdio_read(ioaddr, lp->phys, 5);
962 if (media != lp->media_status) {
963 if ((media ^ lp->media_status) & 0x0004)
964 printk(KERN_INFO "%s: %s link beat\n", dev->name,
965 (lp->media_status & 0x0004) ? "lost" : "found");
966 if ((media ^ lp->media_status) & 0x0020) {
968 if (lp->media_status & 0x0020) {
969 printk(KERN_INFO "%s: autonegotiation restarted\n",
971 } else if (partner) {
972 partner &= lp->advertising;
973 lp->partner = partner;
974 printk(KERN_INFO "%s: autonegotiation complete: "
975 "%sbaseT-%cD selected\n", dev->name,
976 ((partner & 0x0180) ? "100" : "10"),
977 ((partner & 0x0140) ? 'F' : 'H'));
979 printk(KERN_INFO "%s: link partner did not autonegotiate\n",
984 outb((partner & 0x0140 ? 0x20 : 0) |
985 (dev->mtu > 1500 ? 0x40 : 0), ioaddr + Wn3_MAC_Ctrl);
990 printk(KERN_INFO "%s: remote fault detected\n",
993 printk(KERN_INFO "%s: jabber detected\n", dev->name);
994 lp->media_status = media;
996 spin_unlock_irqrestore(&lp->window_lock, flags);
999 lp->media.expires = jiffies + HZ;
1000 add_timer(&lp->media);
1003 static struct net_device_stats *el3_get_stats(struct net_device *dev)
1005 struct el3_private *lp = netdev_priv(dev);
1007 if (netif_device_present(dev)) {
1008 unsigned long flags;
1009 spin_lock_irqsave(&lp->window_lock, flags);
1011 spin_unlock_irqrestore(&lp->window_lock, flags);
1016 /* Update statistics.
1017 Suprisingly this need not be run single-threaded, but it effectively is.
1018 The counters clear when read, so the adds must merely be atomic.
1020 static void update_stats(struct net_device *dev)
1022 struct el3_private *lp = netdev_priv(dev);
1023 kio_addr_t ioaddr = dev->base_addr;
1026 DEBUG(2, "%s: updating the statistics.\n", dev->name);
1028 if (inw(ioaddr+EL3_STATUS) == 0xffff) /* No card. */
1031 /* Unlike the 3c509 we need not turn off stats updates while reading. */
1032 /* Switch to the stats window, and read everything. */
1034 lp->stats.tx_carrier_errors += inb(ioaddr + 0);
1035 lp->stats.tx_heartbeat_errors += inb(ioaddr + 1);
1036 /* Multiple collisions. */ inb(ioaddr + 2);
1037 lp->stats.collisions += inb(ioaddr + 3);
1038 lp->stats.tx_window_errors += inb(ioaddr + 4);
1039 lp->stats.rx_fifo_errors += inb(ioaddr + 5);
1040 lp->stats.tx_packets += inb(ioaddr + 6);
1041 up = inb(ioaddr + 9);
1042 lp->stats.tx_packets += (up&0x30) << 4;
1043 /* Rx packets */ inb(ioaddr + 7);
1044 /* Tx deferrals */ inb(ioaddr + 8);
1045 rx = inw(ioaddr + 10);
1046 tx = inw(ioaddr + 12);
1049 /* BadSSD */ inb(ioaddr + 12);
1050 up = inb(ioaddr + 13);
1052 lp->stats.tx_bytes += tx + ((up & 0xf0) << 12);
1057 static int el3_rx(struct net_device *dev, int worklimit)
1059 struct el3_private *lp = netdev_priv(dev);
1060 kio_addr_t ioaddr = dev->base_addr;
1063 DEBUG(3, "%s: in rx_packet(), status %4.4x, rx_status %4.4x.\n",
1064 dev->name, inw(ioaddr+EL3_STATUS), inw(ioaddr+RxStatus));
1065 while (!((rx_status = inw(ioaddr + RxStatus)) & 0x8000) &&
1066 (--worklimit >= 0)) {
1067 if (rx_status & 0x4000) { /* Error, update stats. */
1068 short error = rx_status & 0x3800;
1069 lp->stats.rx_errors++;
1071 case 0x0000: lp->stats.rx_over_errors++; break;
1072 case 0x0800: lp->stats.rx_length_errors++; break;
1073 case 0x1000: lp->stats.rx_frame_errors++; break;
1074 case 0x1800: lp->stats.rx_length_errors++; break;
1075 case 0x2000: lp->stats.rx_frame_errors++; break;
1076 case 0x2800: lp->stats.rx_crc_errors++; break;
1079 short pkt_len = rx_status & 0x7ff;
1080 struct sk_buff *skb;
1082 skb = dev_alloc_skb(pkt_len+5);
1084 DEBUG(3, " Receiving packet size %d status %4.4x.\n",
1085 pkt_len, rx_status);
1088 skb_reserve(skb, 2);
1089 insl(ioaddr+RX_FIFO, skb_put(skb, pkt_len),
1091 skb->protocol = eth_type_trans(skb, dev);
1093 dev->last_rx = jiffies;
1094 lp->stats.rx_packets++;
1095 lp->stats.rx_bytes += pkt_len;
1097 DEBUG(1, "%s: couldn't allocate a sk_buff of"
1098 " size %d.\n", dev->name, pkt_len);
1099 lp->stats.rx_dropped++;
1102 tc574_wait_for_completion(dev, RxDiscard);
1108 static void netdev_get_drvinfo(struct net_device *dev,
1109 struct ethtool_drvinfo *info)
1111 strcpy(info->driver, "3c574_cs");
1114 static struct ethtool_ops netdev_ethtool_ops = {
1115 .get_drvinfo = netdev_get_drvinfo,
1118 /* Provide ioctl() calls to examine the MII xcvr state. */
1119 static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
1121 struct el3_private *lp = netdev_priv(dev);
1122 kio_addr_t ioaddr = dev->base_addr;
1123 u16 *data = (u16 *)&rq->ifr_ifru;
1124 int phy = lp->phys & 0x1f;
1126 DEBUG(2, "%s: In ioct(%-.6s, %#4.4x) %4.4x %4.4x %4.4x %4.4x.\n",
1127 dev->name, rq->ifr_ifrn.ifrn_name, cmd,
1128 data[0], data[1], data[2], data[3]);
1131 case SIOCGMIIPHY: /* Get the address of the PHY in use. */
1133 case SIOCGMIIREG: /* Read the specified MII register. */
1136 unsigned long flags;
1138 spin_lock_irqsave(&lp->window_lock, flags);
1139 saved_window = inw(ioaddr + EL3_CMD) >> 13;
1141 data[3] = mdio_read(ioaddr, data[0] & 0x1f, data[1] & 0x1f);
1142 EL3WINDOW(saved_window);
1143 spin_unlock_irqrestore(&lp->window_lock, flags);
1146 case SIOCSMIIREG: /* Write the specified MII register */
1149 unsigned long flags;
1151 if (!capable(CAP_NET_ADMIN))
1153 spin_lock_irqsave(&lp->window_lock, flags);
1154 saved_window = inw(ioaddr + EL3_CMD) >> 13;
1156 mdio_write(ioaddr, data[0] & 0x1f, data[1] & 0x1f, data[2]);
1157 EL3WINDOW(saved_window);
1158 spin_unlock_irqrestore(&lp->window_lock, flags);
1166 /* The Odie chip has a 64 bin multicast filter, but the bit layout is not
1167 documented. Until it is we revert to receiving all multicast frames when
1168 any multicast reception is desired.
1169 Note: My other drivers emit a log message whenever promiscuous mode is
1170 entered to help detect password sniffers. This is less desirable on
1171 typical PC card machines, so we omit the message.
1174 static void set_rx_mode(struct net_device *dev)
1176 kio_addr_t ioaddr = dev->base_addr;
1178 if (dev->flags & IFF_PROMISC)
1179 outw(SetRxFilter | RxStation | RxMulticast | RxBroadcast | RxProm,
1181 else if (dev->mc_count || (dev->flags & IFF_ALLMULTI))
1182 outw(SetRxFilter|RxStation|RxMulticast|RxBroadcast, ioaddr + EL3_CMD);
1184 outw(SetRxFilter | RxStation | RxBroadcast, ioaddr + EL3_CMD);
1187 static int el3_close(struct net_device *dev)
1189 kio_addr_t ioaddr = dev->base_addr;
1190 struct el3_private *lp = netdev_priv(dev);
1191 dev_link_t *link = &lp->link;
1193 DEBUG(2, "%s: shutting down ethercard.\n", dev->name);
1196 unsigned long flags;
1198 /* Turn off statistics ASAP. We update lp->stats below. */
1199 outw(StatsDisable, ioaddr + EL3_CMD);
1201 /* Disable the receiver and transmitter. */
1202 outw(RxDisable, ioaddr + EL3_CMD);
1203 outw(TxDisable, ioaddr + EL3_CMD);
1205 /* Note: Switching to window 0 may disable the IRQ. */
1207 spin_lock_irqsave(&lp->window_lock, flags);
1209 spin_unlock_irqrestore(&lp->window_lock, flags);
1211 /* force interrupts off */
1212 outw(SetIntrEnb | 0x0000, ioaddr + EL3_CMD);
1216 netif_stop_queue(dev);
1217 del_timer_sync(&lp->media);
1222 static struct pcmcia_device_id tc574_ids[] = {
1223 PCMCIA_DEVICE_MANF_CARD(0x0101, 0x0574),
1224 PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x0556, "3CCFEM556.cis"),
1227 MODULE_DEVICE_TABLE(pcmcia, tc574_ids);
1229 static struct pcmcia_driver tc574_driver = {
1230 .owner = THIS_MODULE,
1234 .probe = tc574_attach,
1235 .remove = tc574_detach,
1236 .id_table = tc574_ids,
1237 .suspend = tc574_suspend,
1238 .resume = tc574_resume,
1241 static int __init init_tc574(void)
1243 return pcmcia_register_driver(&tc574_driver);
1246 static void __exit exit_tc574(void)
1248 pcmcia_unregister_driver(&tc574_driver);
1251 module_init(init_tc574);
1252 module_exit(exit_tc574);