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);
230 static int tc574_event(event_t event, int priority,
231 event_callback_args_t *args);
233 static void mdio_sync(kio_addr_t ioaddr, int bits);
234 static int mdio_read(kio_addr_t ioaddr, int phy_id, int location);
235 static void mdio_write(kio_addr_t ioaddr, int phy_id, int location, int value);
236 static unsigned short read_eeprom(kio_addr_t ioaddr, int index);
237 static void tc574_wait_for_completion(struct net_device *dev, int cmd);
239 static void tc574_reset(struct net_device *dev);
240 static void media_check(unsigned long arg);
241 static int el3_open(struct net_device *dev);
242 static int el3_start_xmit(struct sk_buff *skb, struct net_device *dev);
243 static irqreturn_t el3_interrupt(int irq, void *dev_id, struct pt_regs *regs);
244 static void update_stats(struct net_device *dev);
245 static struct net_device_stats *el3_get_stats(struct net_device *dev);
246 static int el3_rx(struct net_device *dev, int worklimit);
247 static int el3_close(struct net_device *dev);
248 static void el3_tx_timeout(struct net_device *dev);
249 static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
250 static struct ethtool_ops netdev_ethtool_ops;
251 static void set_rx_mode(struct net_device *dev);
253 static dev_info_t dev_info = "3c574_cs";
255 static dev_link_t *tc574_attach(void);
256 static void tc574_detach(dev_link_t *);
258 static dev_link_t *dev_list;
261 tc574_attach() creates an "instance" of the driver, allocating
262 local data structures for one device. The device is registered
266 static dev_link_t *tc574_attach(void)
268 struct el3_private *lp;
269 client_reg_t client_reg;
271 struct net_device *dev;
274 DEBUG(0, "3c574_attach()\n");
276 /* Create the PC card device object. */
277 dev = alloc_etherdev(sizeof(struct el3_private));
280 lp = netdev_priv(dev);
284 spin_lock_init(&lp->window_lock);
285 link->io.NumPorts1 = 32;
286 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
287 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE | IRQ_HANDLE_PRESENT;
288 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
289 link->irq.Handler = &el3_interrupt;
290 link->irq.Instance = dev;
291 link->conf.Attributes = CONF_ENABLE_IRQ;
293 link->conf.IntType = INT_MEMORY_AND_IO;
294 link->conf.ConfigIndex = 1;
295 link->conf.Present = PRESENT_OPTION;
297 /* The EL3-specific entries in the device structure. */
298 dev->hard_start_xmit = &el3_start_xmit;
299 dev->get_stats = &el3_get_stats;
300 dev->do_ioctl = &el3_ioctl;
301 SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
302 dev->set_multicast_list = &set_rx_mode;
303 dev->open = &el3_open;
304 dev->stop = &el3_close;
305 #ifdef HAVE_TX_TIMEOUT
306 dev->tx_timeout = el3_tx_timeout;
307 dev->watchdog_timeo = TX_TIMEOUT;
310 /* Register with Card Services */
311 link->next = dev_list;
313 client_reg.dev_info = &dev_info;
314 client_reg.Version = 0x0210;
315 client_reg.event_callback_args.client_data = link;
316 ret = pcmcia_register_client(&link->handle, &client_reg);
318 cs_error(link->handle, RegisterClient, ret);
328 This deletes a driver "instance". The device is de-registered
329 with Card Services. If it has been released, all local data
330 structures are freed. Otherwise, the structures will be freed
331 when the device is released.
335 static void tc574_detach(dev_link_t *link)
337 struct net_device *dev = link->priv;
340 DEBUG(0, "3c574_detach(0x%p)\n", link);
342 /* Locate device structure */
343 for (linkp = &dev_list; *linkp; linkp = &(*linkp)->next)
344 if (*linkp == link) break;
349 unregister_netdev(dev);
351 if (link->state & DEV_CONFIG)
355 pcmcia_deregister_client(link->handle);
357 /* Unlink device structure, free bits */
363 tc574_config() is scheduled to run after a CARD_INSERTION event
364 is received, to configure the PCMCIA socket, and to make the
365 ethernet device available to the system.
368 #define CS_CHECK(fn, ret) \
369 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
371 static char *ram_split[] = {"5:3", "3:1", "1:1", "3:5"};
373 static void tc574_config(dev_link_t *link)
375 client_handle_t handle = link->handle;
376 struct net_device *dev = link->priv;
377 struct el3_private *lp = netdev_priv(dev);
380 unsigned short buf[32];
381 int last_fn, last_ret, i, j;
385 union wn3_config config;
387 phys_addr = (u16 *)dev->dev_addr;
389 DEBUG(0, "3c574_config(0x%p)\n", link);
391 tuple.Attributes = 0;
392 tuple.DesiredTuple = CISTPL_CONFIG;
393 CS_CHECK(GetFirstTuple, pcmcia_get_first_tuple(handle, &tuple));
394 tuple.TupleData = (cisdata_t *)buf;
395 tuple.TupleDataMax = 64;
396 tuple.TupleOffset = 0;
397 CS_CHECK(GetTupleData, pcmcia_get_tuple_data(handle, &tuple));
398 CS_CHECK(ParseTuple, pcmcia_parse_tuple(handle, &tuple, &parse));
399 link->conf.ConfigBase = parse.config.base;
400 link->conf.Present = parse.config.rmask[0];
403 link->state |= DEV_CONFIG;
405 link->io.IOAddrLines = 16;
406 for (i = j = 0; j < 0x400; j += 0x20) {
407 link->io.BasePort1 = j ^ 0x300;
408 i = pcmcia_request_io(link->handle, &link->io);
409 if (i == CS_SUCCESS) break;
411 if (i != CS_SUCCESS) {
412 cs_error(link->handle, RequestIO, i);
415 CS_CHECK(RequestIRQ, pcmcia_request_irq(link->handle, &link->irq));
416 CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link->handle, &link->conf));
418 dev->irq = link->irq.AssignedIRQ;
419 dev->base_addr = link->io.BasePort1;
421 ioaddr = dev->base_addr;
423 /* The 3c574 normally uses an EEPROM for configuration info, including
424 the hardware address. The future products may include a modem chip
425 and put the address in the CIS. */
426 tuple.DesiredTuple = 0x88;
427 if (pcmcia_get_first_tuple(handle, &tuple) == CS_SUCCESS) {
428 pcmcia_get_tuple_data(handle, &tuple);
429 for (i = 0; i < 3; i++)
430 phys_addr[i] = htons(buf[i]);
433 for (i = 0; i < 3; i++)
434 phys_addr[i] = htons(read_eeprom(ioaddr, i + 10));
435 if (phys_addr[0] == 0x6060) {
436 printk(KERN_NOTICE "3c574_cs: IO port conflict at 0x%03lx"
437 "-0x%03lx\n", dev->base_addr, dev->base_addr+15);
441 tuple.DesiredTuple = CISTPL_VERS_1;
442 if (pcmcia_get_first_tuple(handle, &tuple) == CS_SUCCESS &&
443 pcmcia_get_tuple_data(handle, &tuple) == CS_SUCCESS &&
444 pcmcia_parse_tuple(handle, &tuple, &parse) == CS_SUCCESS) {
445 cardname = parse.version_1.str + parse.version_1.ofs[1];
447 cardname = "3Com 3c574";
451 outw(2<<11, ioaddr + RunnerRdCtrl);
452 mcr = inb(ioaddr + 2);
453 outw(0<<11, ioaddr + RunnerRdCtrl);
454 printk(KERN_INFO " ASIC rev %d,", mcr>>3);
456 config.i = inl(ioaddr + Wn3_Config);
457 lp->default_media = config.u.xcvr;
458 lp->autoselect = config.u.autoselect;
461 init_timer(&lp->media);
466 /* Roadrunner only: Turn on the MII transceiver */
467 outw(0x8040, ioaddr + Wn3_Options);
469 outw(0xc040, ioaddr + Wn3_Options);
470 tc574_wait_for_completion(dev, TxReset);
471 tc574_wait_for_completion(dev, RxReset);
473 outw(0x8040, ioaddr + Wn3_Options);
476 for (phy = 1; phy <= 32; phy++) {
478 mdio_sync(ioaddr, 32);
479 mii_status = mdio_read(ioaddr, phy & 0x1f, 1);
480 if (mii_status != 0xffff) {
481 lp->phys = phy & 0x1f;
482 DEBUG(0, " MII transceiver at index %d, status %x.\n",
484 if ((mii_status & 0x0040) == 0)
485 mii_preamble_required = 1;
490 printk(KERN_NOTICE " No MII transceivers found!\n");
493 i = mdio_read(ioaddr, lp->phys, 16) | 0x40;
494 mdio_write(ioaddr, lp->phys, 16, i);
495 lp->advertising = mdio_read(ioaddr, lp->phys, 4);
497 /* Only advertise the FD media types. */
498 lp->advertising &= ~0x02a0;
499 mdio_write(ioaddr, lp->phys, 4, lp->advertising);
503 link->state &= ~DEV_CONFIG_PENDING;
504 link->dev = &lp->node;
505 SET_NETDEV_DEV(dev, &handle_to_dev(handle));
507 if (register_netdev(dev) != 0) {
508 printk(KERN_NOTICE "3c574_cs: register_netdev() failed\n");
513 strcpy(lp->node.dev_name, dev->name);
515 printk(KERN_INFO "%s: %s at io %#3lx, irq %d, hw_addr ",
516 dev->name, cardname, dev->base_addr, dev->irq);
517 for (i = 0; i < 6; i++)
518 printk("%02X%s", dev->dev_addr[i], ((i<5) ? ":" : ".\n"));
519 printk(" %dK FIFO split %s Rx:Tx, %sMII interface.\n",
520 8 << config.u.ram_size, ram_split[config.u.ram_split],
521 config.u.autoselect ? "autoselect " : "");
526 cs_error(link->handle, last_fn, last_ret);
534 After a card is removed, tc574_release() will unregister the net
535 device, and release the PCMCIA configuration. If the device is
536 still open, this will be postponed until it is closed.
539 static void tc574_release(dev_link_t *link)
541 DEBUG(0, "3c574_release(0x%p)\n", link);
543 pcmcia_release_configuration(link->handle);
544 pcmcia_release_io(link->handle, &link->io);
545 pcmcia_release_irq(link->handle, &link->irq);
547 link->state &= ~DEV_CONFIG;
551 The card status event handler. Mostly, this schedules other
552 stuff to run after an event is received. A CARD_REMOVAL event
553 also sets some flags to discourage the net drivers from trying
554 to talk to the card any more.
557 static int tc574_event(event_t event, int priority,
558 event_callback_args_t *args)
560 dev_link_t *link = args->client_data;
561 struct net_device *dev = link->priv;
563 DEBUG(1, "3c574_event(0x%06x)\n", event);
566 case CS_EVENT_CARD_REMOVAL:
567 link->state &= ~DEV_PRESENT;
568 if (link->state & DEV_CONFIG)
569 netif_device_detach(dev);
571 case CS_EVENT_CARD_INSERTION:
572 link->state |= DEV_PRESENT | DEV_CONFIG_PENDING;
575 case CS_EVENT_PM_SUSPEND:
576 link->state |= DEV_SUSPEND;
577 /* Fall through... */
578 case CS_EVENT_RESET_PHYSICAL:
579 if (link->state & DEV_CONFIG) {
581 netif_device_detach(dev);
582 pcmcia_release_configuration(link->handle);
585 case CS_EVENT_PM_RESUME:
586 link->state &= ~DEV_SUSPEND;
587 /* Fall through... */
588 case CS_EVENT_CARD_RESET:
589 if (link->state & DEV_CONFIG) {
590 pcmcia_request_configuration(link->handle, &link->conf);
593 netif_device_attach(dev);
601 static void dump_status(struct net_device *dev)
603 kio_addr_t ioaddr = dev->base_addr;
605 printk(KERN_INFO " irq status %04x, rx status %04x, tx status "
606 "%02x, tx free %04x\n", inw(ioaddr+EL3_STATUS),
607 inw(ioaddr+RxStatus), inb(ioaddr+TxStatus),
610 printk(KERN_INFO " diagnostics: fifo %04x net %04x ethernet %04x"
611 " media %04x\n", inw(ioaddr+0x04), inw(ioaddr+0x06),
612 inw(ioaddr+0x08), inw(ioaddr+0x0a));
617 Use this for commands that may take time to finish
619 static void tc574_wait_for_completion(struct net_device *dev, int cmd)
622 outw(cmd, dev->base_addr + EL3_CMD);
624 if (!(inw(dev->base_addr + EL3_STATUS) & 0x1000)) break;
626 printk(KERN_NOTICE "%s: command 0x%04x did not complete!\n", dev->name, cmd);
629 /* Read a word from the EEPROM using the regular EEPROM access register.
630 Assume that we are in register window zero.
632 static unsigned short read_eeprom(kio_addr_t ioaddr, int index)
635 outw(EEPROM_Read + index, ioaddr + Wn0EepromCmd);
636 /* Pause for at least 162 usec for the read to take place. */
637 for (timer = 1620; timer >= 0; timer--) {
638 if ((inw(ioaddr + Wn0EepromCmd) & 0x8000) == 0)
641 return inw(ioaddr + Wn0EepromData);
644 /* MII transceiver control section.
645 Read and write the MII registers using software-generated serial
646 MDIO protocol. See the MII specifications or DP83840A data sheet
648 The maxium data clock rate is 2.5 Mhz. The timing is easily met by the
649 slow PC card interface. */
651 #define MDIO_SHIFT_CLK 0x01
652 #define MDIO_DIR_WRITE 0x04
653 #define MDIO_DATA_WRITE0 (0x00 | MDIO_DIR_WRITE)
654 #define MDIO_DATA_WRITE1 (0x02 | MDIO_DIR_WRITE)
655 #define MDIO_DATA_READ 0x02
656 #define MDIO_ENB_IN 0x00
658 /* Generate the preamble required for initial synchronization and
659 a few older transceivers. */
660 static void mdio_sync(kio_addr_t ioaddr, int bits)
662 kio_addr_t mdio_addr = ioaddr + Wn4_PhysicalMgmt;
664 /* Establish sync by sending at least 32 logic ones. */
665 while (-- bits >= 0) {
666 outw(MDIO_DATA_WRITE1, mdio_addr);
667 outw(MDIO_DATA_WRITE1 | MDIO_SHIFT_CLK, mdio_addr);
671 static int mdio_read(kio_addr_t ioaddr, int phy_id, int location)
674 int read_cmd = (0xf6 << 10) | (phy_id << 5) | location;
675 unsigned int retval = 0;
676 kio_addr_t mdio_addr = ioaddr + Wn4_PhysicalMgmt;
678 if (mii_preamble_required)
679 mdio_sync(ioaddr, 32);
681 /* Shift the read command bits out. */
682 for (i = 14; i >= 0; i--) {
683 int dataval = (read_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
684 outw(dataval, mdio_addr);
685 outw(dataval | MDIO_SHIFT_CLK, mdio_addr);
687 /* Read the two transition, 16 data, and wire-idle bits. */
688 for (i = 19; i > 0; i--) {
689 outw(MDIO_ENB_IN, mdio_addr);
690 retval = (retval << 1) | ((inw(mdio_addr) & MDIO_DATA_READ) ? 1 : 0);
691 outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);
693 return (retval>>1) & 0xffff;
696 static void mdio_write(kio_addr_t ioaddr, int phy_id, int location, int value)
698 int write_cmd = 0x50020000 | (phy_id << 23) | (location << 18) | value;
699 kio_addr_t mdio_addr = ioaddr + Wn4_PhysicalMgmt;
702 if (mii_preamble_required)
703 mdio_sync(ioaddr, 32);
705 /* Shift the command bits out. */
706 for (i = 31; i >= 0; i--) {
707 int dataval = (write_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
708 outw(dataval, mdio_addr);
709 outw(dataval | MDIO_SHIFT_CLK, mdio_addr);
711 /* Leave the interface idle. */
712 for (i = 1; i >= 0; i--) {
713 outw(MDIO_ENB_IN, mdio_addr);
714 outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);
720 /* Reset and restore all of the 3c574 registers. */
721 static void tc574_reset(struct net_device *dev)
723 struct el3_private *lp = netdev_priv(dev);
725 kio_addr_t ioaddr = dev->base_addr;
728 tc574_wait_for_completion(dev, TotalReset|0x10);
730 spin_lock_irqsave(&lp->window_lock, flags);
731 /* Clear any transactions in progress. */
732 outw(0, ioaddr + RunnerWrCtrl);
733 outw(0, ioaddr + RunnerRdCtrl);
735 /* Set the station address and mask. */
737 for (i = 0; i < 6; i++)
738 outb(dev->dev_addr[i], ioaddr + i);
742 /* Reset config options */
744 outb((dev->mtu > 1500 ? 0x40 : 0), ioaddr + Wn3_MAC_Ctrl);
745 outl((lp->autoselect ? 0x01000000 : 0) | 0x0062001b,
746 ioaddr + Wn3_Config);
747 /* Roadrunner only: Turn on the MII transceiver. */
748 outw(0x8040, ioaddr + Wn3_Options);
750 outw(0xc040, ioaddr + Wn3_Options);
752 spin_unlock_irqrestore(&lp->window_lock, flags);
754 tc574_wait_for_completion(dev, TxReset);
755 tc574_wait_for_completion(dev, RxReset);
757 spin_lock_irqsave(&lp->window_lock, flags);
759 outw(0x8040, ioaddr + Wn3_Options);
761 /* Switch to the stats window, and clear all stats by reading. */
762 outw(StatsDisable, ioaddr + EL3_CMD);
764 for (i = 0; i < 10; i++)
772 /* .. enable any extra statistics bits.. */
773 outw(0x0040, ioaddr + Wn4_NetDiag);
776 spin_unlock_irqrestore(&lp->window_lock, flags);
778 /* .. re-sync MII and re-fill what NWay is advertising. */
779 mdio_sync(ioaddr, 32);
780 mdio_write(ioaddr, lp->phys, 4, lp->advertising);
781 if (!auto_polarity) {
782 /* works for TDK 78Q2120 series MII's */
783 int i = mdio_read(ioaddr, lp->phys, 16) | 0x20;
784 mdio_write(ioaddr, lp->phys, 16, i);
787 spin_lock_irqsave(&lp->window_lock, flags);
788 /* Switch to register set 1 for normal use, just for TxFree. */
790 spin_unlock_irqrestore(&lp->window_lock, flags);
791 outw(StatsEnable, ioaddr + EL3_CMD); /* Turn on statistics. */
792 outw(RxEnable, ioaddr + EL3_CMD); /* Enable the receiver. */
793 outw(TxEnable, ioaddr + EL3_CMD); /* Enable transmitter. */
794 /* Allow status bits to be seen. */
795 outw(SetStatusEnb | 0xff, ioaddr + EL3_CMD);
796 /* Ack all pending events, and set active indicator mask. */
797 outw(AckIntr | IntLatch | TxAvailable | RxEarly | IntReq,
799 outw(SetIntrEnb | IntLatch | TxAvailable | RxComplete | StatsFull
800 | AdapterFailure | RxEarly, ioaddr + EL3_CMD);
803 static int el3_open(struct net_device *dev)
805 struct el3_private *lp = netdev_priv(dev);
806 dev_link_t *link = &lp->link;
812 netif_start_queue(dev);
815 lp->media.function = &media_check;
816 lp->media.data = (unsigned long) dev;
817 lp->media.expires = jiffies + HZ;
818 add_timer(&lp->media);
820 DEBUG(2, "%s: opened, status %4.4x.\n",
821 dev->name, inw(dev->base_addr + EL3_STATUS));
826 static void el3_tx_timeout(struct net_device *dev)
828 struct el3_private *lp = netdev_priv(dev);
829 kio_addr_t ioaddr = dev->base_addr;
831 printk(KERN_NOTICE "%s: Transmit timed out!\n", dev->name);
833 lp->stats.tx_errors++;
834 dev->trans_start = jiffies;
835 /* Issue TX_RESET and TX_START commands. */
836 tc574_wait_for_completion(dev, TxReset);
837 outw(TxEnable, ioaddr + EL3_CMD);
838 netif_wake_queue(dev);
841 static void pop_tx_status(struct net_device *dev)
843 struct el3_private *lp = netdev_priv(dev);
844 kio_addr_t ioaddr = dev->base_addr;
847 /* Clear the Tx status stack. */
848 for (i = 32; i > 0; i--) {
849 u_char tx_status = inb(ioaddr + TxStatus);
850 if (!(tx_status & 0x84))
852 /* reset transmitter on jabber error or underrun */
853 if (tx_status & 0x30)
854 tc574_wait_for_completion(dev, TxReset);
855 if (tx_status & 0x38) {
856 DEBUG(1, "%s: transmit error: status 0x%02x\n",
857 dev->name, tx_status);
858 outw(TxEnable, ioaddr + EL3_CMD);
859 lp->stats.tx_aborted_errors++;
861 outb(0x00, ioaddr + TxStatus); /* Pop the status stack. */
865 static int el3_start_xmit(struct sk_buff *skb, struct net_device *dev)
867 kio_addr_t ioaddr = dev->base_addr;
868 struct el3_private *lp = netdev_priv(dev);
871 DEBUG(3, "%s: el3_start_xmit(length = %ld) called, "
872 "status %4.4x.\n", dev->name, (long)skb->len,
873 inw(ioaddr + EL3_STATUS));
875 spin_lock_irqsave(&lp->window_lock, flags);
876 outw(skb->len, ioaddr + TX_FIFO);
877 outw(0, ioaddr + TX_FIFO);
878 outsl(ioaddr + TX_FIFO, skb->data, (skb->len+3)>>2);
880 dev->trans_start = jiffies;
882 /* TxFree appears only in Window 1, not offset 0x1c. */
883 if (inw(ioaddr + TxFree) <= 1536) {
884 netif_stop_queue(dev);
885 /* Interrupt us when the FIFO has room for max-sized packet.
886 The threshold is in units of dwords. */
887 outw(SetTxThreshold + (1536>>2), ioaddr + EL3_CMD);
891 spin_unlock_irqrestore(&lp->window_lock, flags);
896 /* The EL3 interrupt handler. */
897 static irqreturn_t el3_interrupt(int irq, void *dev_id, struct pt_regs *regs)
899 struct net_device *dev = (struct net_device *) dev_id;
900 struct el3_private *lp = netdev_priv(dev);
903 int work_budget = max_interrupt_work;
906 if (!netif_device_present(dev))
908 ioaddr = dev->base_addr;
910 DEBUG(3, "%s: interrupt, status %4.4x.\n",
911 dev->name, inw(ioaddr + EL3_STATUS));
913 spin_lock(&lp->window_lock);
915 while ((status = inw(ioaddr + EL3_STATUS)) &
916 (IntLatch | RxComplete | RxEarly | StatsFull)) {
917 if (!netif_device_present(dev) ||
918 ((status & 0xe000) != 0x2000)) {
919 DEBUG(1, "%s: Interrupt from dead card\n", dev->name);
925 if (status & RxComplete)
926 work_budget = el3_rx(dev, work_budget);
928 if (status & TxAvailable) {
929 DEBUG(3, " TX room bit was handled.\n");
930 /* There's room in the FIFO for a full-sized packet. */
931 outw(AckIntr | TxAvailable, ioaddr + EL3_CMD);
932 netif_wake_queue(dev);
935 if (status & TxComplete)
938 if (status & (AdapterFailure | RxEarly | StatsFull)) {
939 /* Handle all uncommon interrupts. */
940 if (status & StatsFull)
942 if (status & RxEarly) {
943 work_budget = el3_rx(dev, work_budget);
944 outw(AckIntr | RxEarly, ioaddr + EL3_CMD);
946 if (status & AdapterFailure) {
949 fifo_diag = inw(ioaddr + Wn4_FIFODiag);
951 printk(KERN_NOTICE "%s: adapter failure, FIFO diagnostic"
952 " register %04x.\n", dev->name, fifo_diag);
953 if (fifo_diag & 0x0400) {
955 tc574_wait_for_completion(dev, TxReset);
956 outw(TxEnable, ioaddr + EL3_CMD);
958 if (fifo_diag & 0x2000) {
960 tc574_wait_for_completion(dev, RxReset);
962 outw(RxEnable, ioaddr + EL3_CMD);
964 outw(AckIntr | AdapterFailure, ioaddr + EL3_CMD);
968 if (--work_budget < 0) {
969 DEBUG(0, "%s: Too much work in interrupt, "
970 "status %4.4x.\n", dev->name, status);
971 /* Clear all interrupts */
972 outw(AckIntr | 0xFF, ioaddr + EL3_CMD);
975 /* Acknowledge the IRQ. */
976 outw(AckIntr | IntReq | IntLatch, ioaddr + EL3_CMD);
979 DEBUG(3, "%s: exiting interrupt, status %4.4x.\n",
980 dev->name, inw(ioaddr + EL3_STATUS));
982 spin_unlock(&lp->window_lock);
983 return IRQ_RETVAL(handled);
987 This timer serves two purposes: to check for missed interrupts
988 (and as a last resort, poll the NIC for events), and to monitor
989 the MII, reporting changes in cable status.
991 static void media_check(unsigned long arg)
993 struct net_device *dev = (struct net_device *) arg;
994 struct el3_private *lp = netdev_priv(dev);
995 kio_addr_t ioaddr = dev->base_addr;
997 unsigned short /* cable, */ media, partner;
999 if (!netif_device_present(dev))
1002 /* Check for pending interrupt with expired latency timer: with
1003 this, we can limp along even if the interrupt is blocked */
1004 if ((inw(ioaddr + EL3_STATUS) & IntLatch) && (inb(ioaddr + Timer) == 0xff)) {
1006 printk(KERN_INFO "%s: interrupt(s) dropped!\n", dev->name);
1007 el3_interrupt(dev->irq, lp, NULL);
1010 if (lp->fast_poll) {
1012 lp->media.expires = jiffies + 2*HZ/100;
1013 add_timer(&lp->media);
1017 spin_lock_irqsave(&lp->window_lock, flags);
1019 media = mdio_read(ioaddr, lp->phys, 1);
1020 partner = mdio_read(ioaddr, lp->phys, 5);
1023 if (media != lp->media_status) {
1024 if ((media ^ lp->media_status) & 0x0004)
1025 printk(KERN_INFO "%s: %s link beat\n", dev->name,
1026 (lp->media_status & 0x0004) ? "lost" : "found");
1027 if ((media ^ lp->media_status) & 0x0020) {
1029 if (lp->media_status & 0x0020) {
1030 printk(KERN_INFO "%s: autonegotiation restarted\n",
1032 } else if (partner) {
1033 partner &= lp->advertising;
1034 lp->partner = partner;
1035 printk(KERN_INFO "%s: autonegotiation complete: "
1036 "%sbaseT-%cD selected\n", dev->name,
1037 ((partner & 0x0180) ? "100" : "10"),
1038 ((partner & 0x0140) ? 'F' : 'H'));
1040 printk(KERN_INFO "%s: link partner did not autonegotiate\n",
1045 outb((partner & 0x0140 ? 0x20 : 0) |
1046 (dev->mtu > 1500 ? 0x40 : 0), ioaddr + Wn3_MAC_Ctrl);
1051 printk(KERN_INFO "%s: remote fault detected\n",
1054 printk(KERN_INFO "%s: jabber detected\n", dev->name);
1055 lp->media_status = media;
1057 spin_unlock_irqrestore(&lp->window_lock, flags);
1060 lp->media.expires = jiffies + HZ;
1061 add_timer(&lp->media);
1064 static struct net_device_stats *el3_get_stats(struct net_device *dev)
1066 struct el3_private *lp = netdev_priv(dev);
1068 if (netif_device_present(dev)) {
1069 unsigned long flags;
1070 spin_lock_irqsave(&lp->window_lock, flags);
1072 spin_unlock_irqrestore(&lp->window_lock, flags);
1077 /* Update statistics.
1078 Suprisingly this need not be run single-threaded, but it effectively is.
1079 The counters clear when read, so the adds must merely be atomic.
1081 static void update_stats(struct net_device *dev)
1083 struct el3_private *lp = netdev_priv(dev);
1084 kio_addr_t ioaddr = dev->base_addr;
1087 DEBUG(2, "%s: updating the statistics.\n", dev->name);
1089 if (inw(ioaddr+EL3_STATUS) == 0xffff) /* No card. */
1092 /* Unlike the 3c509 we need not turn off stats updates while reading. */
1093 /* Switch to the stats window, and read everything. */
1095 lp->stats.tx_carrier_errors += inb(ioaddr + 0);
1096 lp->stats.tx_heartbeat_errors += inb(ioaddr + 1);
1097 /* Multiple collisions. */ inb(ioaddr + 2);
1098 lp->stats.collisions += inb(ioaddr + 3);
1099 lp->stats.tx_window_errors += inb(ioaddr + 4);
1100 lp->stats.rx_fifo_errors += inb(ioaddr + 5);
1101 lp->stats.tx_packets += inb(ioaddr + 6);
1102 up = inb(ioaddr + 9);
1103 lp->stats.tx_packets += (up&0x30) << 4;
1104 /* Rx packets */ inb(ioaddr + 7);
1105 /* Tx deferrals */ inb(ioaddr + 8);
1106 rx = inw(ioaddr + 10);
1107 tx = inw(ioaddr + 12);
1110 /* BadSSD */ inb(ioaddr + 12);
1111 up = inb(ioaddr + 13);
1113 lp->stats.tx_bytes += tx + ((up & 0xf0) << 12);
1118 static int el3_rx(struct net_device *dev, int worklimit)
1120 struct el3_private *lp = netdev_priv(dev);
1121 kio_addr_t ioaddr = dev->base_addr;
1124 DEBUG(3, "%s: in rx_packet(), status %4.4x, rx_status %4.4x.\n",
1125 dev->name, inw(ioaddr+EL3_STATUS), inw(ioaddr+RxStatus));
1126 while (!((rx_status = inw(ioaddr + RxStatus)) & 0x8000) &&
1127 (--worklimit >= 0)) {
1128 if (rx_status & 0x4000) { /* Error, update stats. */
1129 short error = rx_status & 0x3800;
1130 lp->stats.rx_errors++;
1132 case 0x0000: lp->stats.rx_over_errors++; break;
1133 case 0x0800: lp->stats.rx_length_errors++; break;
1134 case 0x1000: lp->stats.rx_frame_errors++; break;
1135 case 0x1800: lp->stats.rx_length_errors++; break;
1136 case 0x2000: lp->stats.rx_frame_errors++; break;
1137 case 0x2800: lp->stats.rx_crc_errors++; break;
1140 short pkt_len = rx_status & 0x7ff;
1141 struct sk_buff *skb;
1143 skb = dev_alloc_skb(pkt_len+5);
1145 DEBUG(3, " Receiving packet size %d status %4.4x.\n",
1146 pkt_len, rx_status);
1149 skb_reserve(skb, 2);
1150 insl(ioaddr+RX_FIFO, skb_put(skb, pkt_len),
1152 skb->protocol = eth_type_trans(skb, dev);
1154 dev->last_rx = jiffies;
1155 lp->stats.rx_packets++;
1156 lp->stats.rx_bytes += pkt_len;
1158 DEBUG(1, "%s: couldn't allocate a sk_buff of"
1159 " size %d.\n", dev->name, pkt_len);
1160 lp->stats.rx_dropped++;
1163 tc574_wait_for_completion(dev, RxDiscard);
1169 static void netdev_get_drvinfo(struct net_device *dev,
1170 struct ethtool_drvinfo *info)
1172 strcpy(info->driver, "3c574_cs");
1175 static struct ethtool_ops netdev_ethtool_ops = {
1176 .get_drvinfo = netdev_get_drvinfo,
1179 /* Provide ioctl() calls to examine the MII xcvr state. */
1180 static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
1182 struct el3_private *lp = netdev_priv(dev);
1183 kio_addr_t ioaddr = dev->base_addr;
1184 u16 *data = (u16 *)&rq->ifr_ifru;
1185 int phy = lp->phys & 0x1f;
1187 DEBUG(2, "%s: In ioct(%-.6s, %#4.4x) %4.4x %4.4x %4.4x %4.4x.\n",
1188 dev->name, rq->ifr_ifrn.ifrn_name, cmd,
1189 data[0], data[1], data[2], data[3]);
1192 case SIOCGMIIPHY: /* Get the address of the PHY in use. */
1194 case SIOCGMIIREG: /* Read the specified MII register. */
1197 unsigned long flags;
1199 spin_lock_irqsave(&lp->window_lock, flags);
1200 saved_window = inw(ioaddr + EL3_CMD) >> 13;
1202 data[3] = mdio_read(ioaddr, data[0] & 0x1f, data[1] & 0x1f);
1203 EL3WINDOW(saved_window);
1204 spin_unlock_irqrestore(&lp->window_lock, flags);
1207 case SIOCSMIIREG: /* Write the specified MII register */
1210 unsigned long flags;
1212 if (!capable(CAP_NET_ADMIN))
1214 spin_lock_irqsave(&lp->window_lock, flags);
1215 saved_window = inw(ioaddr + EL3_CMD) >> 13;
1217 mdio_write(ioaddr, data[0] & 0x1f, data[1] & 0x1f, data[2]);
1218 EL3WINDOW(saved_window);
1219 spin_unlock_irqrestore(&lp->window_lock, flags);
1227 /* The Odie chip has a 64 bin multicast filter, but the bit layout is not
1228 documented. Until it is we revert to receiving all multicast frames when
1229 any multicast reception is desired.
1230 Note: My other drivers emit a log message whenever promiscuous mode is
1231 entered to help detect password sniffers. This is less desirable on
1232 typical PC card machines, so we omit the message.
1235 static void set_rx_mode(struct net_device *dev)
1237 kio_addr_t ioaddr = dev->base_addr;
1239 if (dev->flags & IFF_PROMISC)
1240 outw(SetRxFilter | RxStation | RxMulticast | RxBroadcast | RxProm,
1242 else if (dev->mc_count || (dev->flags & IFF_ALLMULTI))
1243 outw(SetRxFilter|RxStation|RxMulticast|RxBroadcast, ioaddr + EL3_CMD);
1245 outw(SetRxFilter | RxStation | RxBroadcast, ioaddr + EL3_CMD);
1248 static int el3_close(struct net_device *dev)
1250 kio_addr_t ioaddr = dev->base_addr;
1251 struct el3_private *lp = netdev_priv(dev);
1252 dev_link_t *link = &lp->link;
1254 DEBUG(2, "%s: shutting down ethercard.\n", dev->name);
1257 unsigned long flags;
1259 /* Turn off statistics ASAP. We update lp->stats below. */
1260 outw(StatsDisable, ioaddr + EL3_CMD);
1262 /* Disable the receiver and transmitter. */
1263 outw(RxDisable, ioaddr + EL3_CMD);
1264 outw(TxDisable, ioaddr + EL3_CMD);
1266 /* Note: Switching to window 0 may disable the IRQ. */
1268 spin_lock_irqsave(&lp->window_lock, flags);
1270 spin_unlock_irqrestore(&lp->window_lock, flags);
1272 /* force interrupts off */
1273 outw(SetIntrEnb | 0x0000, ioaddr + EL3_CMD);
1277 netif_stop_queue(dev);
1278 del_timer_sync(&lp->media);
1283 static struct pcmcia_device_id tc574_ids[] = {
1284 PCMCIA_DEVICE_MANF_CARD(0x0101, 0x0574),
1285 PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x0556, "3CCFEM556.cis"),
1288 MODULE_DEVICE_TABLE(pcmcia, tc574_ids);
1290 static struct pcmcia_driver tc574_driver = {
1291 .owner = THIS_MODULE,
1295 .attach = tc574_attach,
1296 .event = tc574_event,
1297 .detach = tc574_detach,
1298 .id_table = tc574_ids,
1301 static int __init init_tc574(void)
1303 return pcmcia_register_driver(&tc574_driver);
1306 static void __exit exit_tc574(void)
1308 pcmcia_unregister_driver(&tc574_driver);
1309 BUG_ON(dev_list != NULL);
1312 module_init(init_tc574);
1313 module_exit(exit_tc574);