Loading...
1/* 3c574.c: A PCMCIA ethernet driver for the 3com 3c574 "RoadRunner".
2
3 Written 1993-1998 by
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
7
8 This software may be used and distributed according to the terms of
9 the GNU General Public License, incorporated herein by reference.
10
11 This driver derives from Donald Becker's 3c509 core, which has the
12 following copyright:
13 Copyright 1993 United States Government as represented by the
14 Director, National Security Agency.
15
16
17*/
18
19/*
20 Theory of Operation
21
22I. Board Compatibility
23
24This device driver is designed for the 3Com 3c574 PC card Fast Ethernet
25Adapter.
26
27II. Board-specific settings
28
29None -- PC cards are autoconfigured.
30
31III. Driver operation
32
33The 3c574 uses a Boomerang-style interface, without the bus-master capability.
34See the Boomerang driver and documentation for most details.
35
36IV. Notes and chip documentation.
37
38Two added registers are used to enhance PIO performance, RunnerRdCtrl and
39RunnerWrCtrl. These are 11 bit down-counters that are preloaded with the
40count of word (16 bits) reads or writes the driver is about to do to the Rx
41or Tx FIFO. The chip is then able to hide the internal-PCI-bus to PC-card
42translation latency by buffering the I/O operations with an 8 word FIFO.
43Note: No other chip accesses are permitted when this buffer is used.
44
45A second enhancement is that both attribute and common memory space
460x0800-0x0fff can translated to the PIO FIFO. Thus memory operations (faster
47with *some* PCcard bridges) may be used instead of I/O operations.
48This is enabled by setting the 0x10 bit in the PCMCIA LAN COR.
49
50Some slow PC card bridges work better if they never see a WAIT signal.
51This is configured by setting the 0x20 bit in the PCMCIA LAN COR.
52Only do this after testing that it is reliable and improves performance.
53
54The upper five bits of RunnerRdCtrl are used to window into PCcard
55configuration space registers. Window 0 is the regular Boomerang/Odie
56register set, 1-5 are various PC card control registers, and 16-31 are
57the (reversed!) CIS table.
58
59A final note: writing the InternalConfig register in window 3 with an
60invalid ramWidth is Very Bad.
61
62V. References
63
64http://www.scyld.com/expert/NWay.html
65http://www.national.com/opf/DP/DP83840A.html
66
67Thanks to Terry Murphy of 3Com for providing development information for
68earlier 3Com products.
69
70*/
71
72#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
73
74#include <linux/module.h>
75#include <linux/kernel.h>
76#include <linux/slab.h>
77#include <linux/string.h>
78#include <linux/timer.h>
79#include <linux/interrupt.h>
80#include <linux/in.h>
81#include <linux/delay.h>
82#include <linux/netdevice.h>
83#include <linux/etherdevice.h>
84#include <linux/skbuff.h>
85#include <linux/if_arp.h>
86#include <linux/ioport.h>
87#include <linux/bitops.h>
88#include <linux/mii.h>
89
90#include <pcmcia/cistpl.h>
91#include <pcmcia/cisreg.h>
92#include <pcmcia/ciscode.h>
93#include <pcmcia/ds.h>
94
95#include <linux/uaccess.h>
96#include <asm/io.h>
97
98/*====================================================================*/
99
100/* Module parameters */
101
102MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
103MODULE_DESCRIPTION("3Com 3c574 series PCMCIA ethernet driver");
104MODULE_LICENSE("GPL");
105
106#define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)
107
108/* Maximum events (Rx packets, etc.) to handle at each interrupt. */
109INT_MODULE_PARM(max_interrupt_work, 32);
110
111/* Force full duplex modes? */
112INT_MODULE_PARM(full_duplex, 0);
113
114/* Autodetect link polarity reversal? */
115INT_MODULE_PARM(auto_polarity, 1);
116
117
118/*====================================================================*/
119
120/* Time in jiffies before concluding the transmitter is hung. */
121#define TX_TIMEOUT ((800*HZ)/1000)
122
123/* To minimize the size of the driver source and make the driver more
124 readable not all constants are symbolically defined.
125 You'll need the manual if you want to understand driver details anyway. */
126/* Offsets from base I/O address. */
127#define EL3_DATA 0x00
128#define EL3_CMD 0x0e
129#define EL3_STATUS 0x0e
130
131#define EL3WINDOW(win_num) outw(SelectWindow + (win_num), ioaddr + EL3_CMD)
132
133/* The top five bits written to EL3_CMD are a command, the lower
134 11 bits are the parameter, if applicable. */
135enum el3_cmds {
136 TotalReset = 0<<11, SelectWindow = 1<<11, StartCoax = 2<<11,
137 RxDisable = 3<<11, RxEnable = 4<<11, RxReset = 5<<11, RxDiscard = 8<<11,
138 TxEnable = 9<<11, TxDisable = 10<<11, TxReset = 11<<11,
139 FakeIntr = 12<<11, AckIntr = 13<<11, SetIntrEnb = 14<<11,
140 SetStatusEnb = 15<<11, SetRxFilter = 16<<11, SetRxThreshold = 17<<11,
141 SetTxThreshold = 18<<11, SetTxStart = 19<<11, StatsEnable = 21<<11,
142 StatsDisable = 22<<11, StopCoax = 23<<11,
143};
144
145enum elxl_status {
146 IntLatch = 0x0001, AdapterFailure = 0x0002, TxComplete = 0x0004,
147 TxAvailable = 0x0008, RxComplete = 0x0010, RxEarly = 0x0020,
148 IntReq = 0x0040, StatsFull = 0x0080, CmdBusy = 0x1000 };
149
150/* The SetRxFilter command accepts the following classes: */
151enum RxFilter {
152 RxStation = 1, RxMulticast = 2, RxBroadcast = 4, RxProm = 8
153};
154
155enum Window0 {
156 Wn0EepromCmd = 10, Wn0EepromData = 12, /* EEPROM command/address, data. */
157 IntrStatus=0x0E, /* Valid in all windows. */
158};
159/* These assumes the larger EEPROM. */
160enum Win0_EEPROM_cmds {
161 EEPROM_Read = 0x200, EEPROM_WRITE = 0x100, EEPROM_ERASE = 0x300,
162 EEPROM_EWENB = 0x30, /* Enable erasing/writing for 10 msec. */
163 EEPROM_EWDIS = 0x00, /* Disable EWENB before 10 msec timeout. */
164};
165
166/* Register window 1 offsets, the window used in normal operation.
167 On the "Odie" this window is always mapped at offsets 0x10-0x1f.
168 Except for TxFree, which is overlapped by RunnerWrCtrl. */
169enum Window1 {
170 TX_FIFO = 0x10, RX_FIFO = 0x10, RxErrors = 0x14,
171 RxStatus = 0x18, Timer=0x1A, TxStatus = 0x1B,
172 TxFree = 0x0C, /* Remaining free bytes in Tx buffer. */
173 RunnerRdCtrl = 0x16, RunnerWrCtrl = 0x1c,
174};
175
176enum Window3 { /* Window 3: MAC/config bits. */
177 Wn3_Config=0, Wn3_MAC_Ctrl=6, Wn3_Options=8,
178};
179enum wn3_config {
180 Ram_size = 7,
181 Ram_width = 8,
182 Ram_speed = 0x30,
183 Rom_size = 0xc0,
184 Ram_split_shift = 16,
185 Ram_split = 3 << Ram_split_shift,
186 Xcvr_shift = 20,
187 Xcvr = 7 << Xcvr_shift,
188 Autoselect = 0x1000000,
189};
190
191enum Window4 { /* Window 4: Xcvr/media bits. */
192 Wn4_FIFODiag = 4, Wn4_NetDiag = 6, Wn4_PhysicalMgmt=8, Wn4_Media = 10,
193};
194
195#define MEDIA_TP 0x00C0 /* Enable link beat and jabber for 10baseT. */
196
197struct el3_private {
198 struct pcmcia_device *p_dev;
199 u16 advertising, partner; /* NWay media advertisement */
200 unsigned char phys; /* MII device address */
201 unsigned int autoselect:1, default_media:3; /* Read from the EEPROM/Wn3_Config. */
202 /* for transceiver monitoring */
203 struct timer_list media;
204 unsigned short media_status;
205 unsigned short fast_poll;
206 unsigned long last_irq;
207 spinlock_t window_lock; /* Guards the Window selection */
208};
209
210/* Set iff a MII transceiver on any interface requires mdio preamble.
211 This only set with the original DP83840 on older 3c905 boards, so the extra
212 code size of a per-interface flag is not worthwhile. */
213static char mii_preamble_required = 0;
214
215/* Index of functions. */
216
217static int tc574_config(struct pcmcia_device *link);
218static void tc574_release(struct pcmcia_device *link);
219
220static void mdio_sync(unsigned int ioaddr, int bits);
221static int mdio_read(unsigned int ioaddr, int phy_id, int location);
222static void mdio_write(unsigned int ioaddr, int phy_id, int location,
223 int value);
224static unsigned short read_eeprom(unsigned int ioaddr, int index);
225static void tc574_wait_for_completion(struct net_device *dev, int cmd);
226
227static void tc574_reset(struct net_device *dev);
228static void media_check(struct timer_list *t);
229static int el3_open(struct net_device *dev);
230static netdev_tx_t el3_start_xmit(struct sk_buff *skb,
231 struct net_device *dev);
232static irqreturn_t el3_interrupt(int irq, void *dev_id);
233static void update_stats(struct net_device *dev);
234static struct net_device_stats *el3_get_stats(struct net_device *dev);
235static int el3_rx(struct net_device *dev, int worklimit);
236static int el3_close(struct net_device *dev);
237static void el3_tx_timeout(struct net_device *dev, unsigned int txqueue);
238static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
239static void set_rx_mode(struct net_device *dev);
240static void set_multicast_list(struct net_device *dev);
241
242static void tc574_detach(struct pcmcia_device *p_dev);
243
244/*
245 tc574_attach() creates an "instance" of the driver, allocating
246 local data structures for one device. The device is registered
247 with Card Services.
248*/
249static const struct net_device_ops el3_netdev_ops = {
250 .ndo_open = el3_open,
251 .ndo_stop = el3_close,
252 .ndo_start_xmit = el3_start_xmit,
253 .ndo_tx_timeout = el3_tx_timeout,
254 .ndo_get_stats = el3_get_stats,
255 .ndo_eth_ioctl = el3_ioctl,
256 .ndo_set_rx_mode = set_multicast_list,
257 .ndo_set_mac_address = eth_mac_addr,
258 .ndo_validate_addr = eth_validate_addr,
259};
260
261static int tc574_probe(struct pcmcia_device *link)
262{
263 struct el3_private *lp;
264 struct net_device *dev;
265
266 dev_dbg(&link->dev, "3c574_attach()\n");
267
268 /* Create the PC card device object. */
269 dev = alloc_etherdev(sizeof(struct el3_private));
270 if (!dev)
271 return -ENOMEM;
272 lp = netdev_priv(dev);
273 link->priv = dev;
274 lp->p_dev = link;
275
276 spin_lock_init(&lp->window_lock);
277 link->resource[0]->end = 32;
278 link->resource[0]->flags |= IO_DATA_PATH_WIDTH_16;
279 link->config_flags |= CONF_ENABLE_IRQ;
280 link->config_index = 1;
281
282 dev->netdev_ops = &el3_netdev_ops;
283 dev->watchdog_timeo = TX_TIMEOUT;
284
285 return tc574_config(link);
286}
287
288static void tc574_detach(struct pcmcia_device *link)
289{
290 struct net_device *dev = link->priv;
291
292 dev_dbg(&link->dev, "3c574_detach()\n");
293
294 unregister_netdev(dev);
295
296 tc574_release(link);
297
298 free_netdev(dev);
299} /* tc574_detach */
300
301static const char *ram_split[] = {"5:3", "3:1", "1:1", "3:5"};
302
303static int tc574_config(struct pcmcia_device *link)
304{
305 struct net_device *dev = link->priv;
306 struct el3_private *lp = netdev_priv(dev);
307 int ret, i, j;
308 __be16 addr[ETH_ALEN / 2];
309 unsigned int ioaddr;
310 char *cardname;
311 __u32 config;
312 u8 *buf;
313 size_t len;
314
315 dev_dbg(&link->dev, "3c574_config()\n");
316
317 link->io_lines = 16;
318
319 for (i = j = 0; j < 0x400; j += 0x20) {
320 link->resource[0]->start = j ^ 0x300;
321 i = pcmcia_request_io(link);
322 if (i == 0)
323 break;
324 }
325 if (i != 0)
326 goto failed;
327
328 ret = pcmcia_request_irq(link, el3_interrupt);
329 if (ret)
330 goto failed;
331
332 ret = pcmcia_enable_device(link);
333 if (ret)
334 goto failed;
335
336 dev->irq = link->irq;
337 dev->base_addr = link->resource[0]->start;
338
339 ioaddr = dev->base_addr;
340
341 /* The 3c574 normally uses an EEPROM for configuration info, including
342 the hardware address. The future products may include a modem chip
343 and put the address in the CIS. */
344
345 len = pcmcia_get_tuple(link, 0x88, &buf);
346 if (buf && len >= 6) {
347 for (i = 0; i < 3; i++)
348 addr[i] = htons(le16_to_cpu(buf[i * 2]));
349 kfree(buf);
350 } else {
351 kfree(buf); /* 0 < len < 6 */
352 EL3WINDOW(0);
353 for (i = 0; i < 3; i++)
354 addr[i] = htons(read_eeprom(ioaddr, i + 10));
355 if (addr[0] == htons(0x6060)) {
356 pr_notice("IO port conflict at 0x%03lx-0x%03lx\n",
357 dev->base_addr, dev->base_addr+15);
358 goto failed;
359 }
360 }
361 eth_hw_addr_set(dev, (u8 *)addr);
362 if (link->prod_id[1])
363 cardname = link->prod_id[1];
364 else
365 cardname = "3Com 3c574";
366
367 {
368 u_char mcr;
369 outw(2<<11, ioaddr + RunnerRdCtrl);
370 mcr = inb(ioaddr + 2);
371 outw(0<<11, ioaddr + RunnerRdCtrl);
372 pr_info(" ASIC rev %d,", mcr>>3);
373 EL3WINDOW(3);
374 config = inl(ioaddr + Wn3_Config);
375 lp->default_media = (config & Xcvr) >> Xcvr_shift;
376 lp->autoselect = config & Autoselect ? 1 : 0;
377 }
378
379 timer_setup(&lp->media, media_check, 0);
380
381 {
382 int phy;
383
384 /* Roadrunner only: Turn on the MII transceiver */
385 outw(0x8040, ioaddr + Wn3_Options);
386 mdelay(1);
387 outw(0xc040, ioaddr + Wn3_Options);
388 tc574_wait_for_completion(dev, TxReset);
389 tc574_wait_for_completion(dev, RxReset);
390 mdelay(1);
391 outw(0x8040, ioaddr + Wn3_Options);
392
393 EL3WINDOW(4);
394 for (phy = 1; phy <= 32; phy++) {
395 int mii_status;
396 mdio_sync(ioaddr, 32);
397 mii_status = mdio_read(ioaddr, phy & 0x1f, 1);
398 if (mii_status != 0xffff) {
399 lp->phys = phy & 0x1f;
400 dev_dbg(&link->dev, " MII transceiver at "
401 "index %d, status %x.\n",
402 phy, mii_status);
403 if ((mii_status & 0x0040) == 0)
404 mii_preamble_required = 1;
405 break;
406 }
407 }
408 if (phy > 32) {
409 pr_notice(" No MII transceivers found!\n");
410 goto failed;
411 }
412 i = mdio_read(ioaddr, lp->phys, 16) | 0x40;
413 mdio_write(ioaddr, lp->phys, 16, i);
414 lp->advertising = mdio_read(ioaddr, lp->phys, 4);
415 if (full_duplex) {
416 /* Only advertise the FD media types. */
417 lp->advertising &= ~0x02a0;
418 mdio_write(ioaddr, lp->phys, 4, lp->advertising);
419 }
420 }
421
422 SET_NETDEV_DEV(dev, &link->dev);
423
424 if (register_netdev(dev) != 0) {
425 pr_notice("register_netdev() failed\n");
426 goto failed;
427 }
428
429 netdev_info(dev, "%s at io %#3lx, irq %d, hw_addr %pM\n",
430 cardname, dev->base_addr, dev->irq, dev->dev_addr);
431 netdev_info(dev, " %dK FIFO split %s Rx:Tx, %sMII interface.\n",
432 8 << (config & Ram_size),
433 ram_split[(config & Ram_split) >> Ram_split_shift],
434 config & Autoselect ? "autoselect " : "");
435
436 return 0;
437
438failed:
439 tc574_release(link);
440 return -ENODEV;
441
442} /* tc574_config */
443
444static void tc574_release(struct pcmcia_device *link)
445{
446 pcmcia_disable_device(link);
447}
448
449static int tc574_suspend(struct pcmcia_device *link)
450{
451 struct net_device *dev = link->priv;
452
453 if (link->open)
454 netif_device_detach(dev);
455
456 return 0;
457}
458
459static int tc574_resume(struct pcmcia_device *link)
460{
461 struct net_device *dev = link->priv;
462
463 if (link->open) {
464 tc574_reset(dev);
465 netif_device_attach(dev);
466 }
467
468 return 0;
469}
470
471static void dump_status(struct net_device *dev)
472{
473 unsigned int ioaddr = dev->base_addr;
474 EL3WINDOW(1);
475 netdev_info(dev, " irq status %04x, rx status %04x, tx status %02x, tx free %04x\n",
476 inw(ioaddr+EL3_STATUS),
477 inw(ioaddr+RxStatus), inb(ioaddr+TxStatus),
478 inw(ioaddr+TxFree));
479 EL3WINDOW(4);
480 netdev_info(dev, " diagnostics: fifo %04x net %04x ethernet %04x media %04x\n",
481 inw(ioaddr+0x04), inw(ioaddr+0x06),
482 inw(ioaddr+0x08), inw(ioaddr+0x0a));
483 EL3WINDOW(1);
484}
485
486/*
487 Use this for commands that may take time to finish
488*/
489static void tc574_wait_for_completion(struct net_device *dev, int cmd)
490{
491 int i = 1500;
492 outw(cmd, dev->base_addr + EL3_CMD);
493 while (--i > 0)
494 if (!(inw(dev->base_addr + EL3_STATUS) & 0x1000)) break;
495 if (i == 0)
496 netdev_notice(dev, "command 0x%04x did not complete!\n", cmd);
497}
498
499/* Read a word from the EEPROM using the regular EEPROM access register.
500 Assume that we are in register window zero.
501 */
502static unsigned short read_eeprom(unsigned int ioaddr, int index)
503{
504 int timer;
505 outw(EEPROM_Read + index, ioaddr + Wn0EepromCmd);
506 /* Pause for at least 162 usec for the read to take place. */
507 for (timer = 1620; timer >= 0; timer--) {
508 if ((inw(ioaddr + Wn0EepromCmd) & 0x8000) == 0)
509 break;
510 }
511 return inw(ioaddr + Wn0EepromData);
512}
513
514/* MII transceiver control section.
515 Read and write the MII registers using software-generated serial
516 MDIO protocol. See the MII specifications or DP83840A data sheet
517 for details.
518 The maxium data clock rate is 2.5 Mhz. The timing is easily met by the
519 slow PC card interface. */
520
521#define MDIO_SHIFT_CLK 0x01
522#define MDIO_DIR_WRITE 0x04
523#define MDIO_DATA_WRITE0 (0x00 | MDIO_DIR_WRITE)
524#define MDIO_DATA_WRITE1 (0x02 | MDIO_DIR_WRITE)
525#define MDIO_DATA_READ 0x02
526#define MDIO_ENB_IN 0x00
527
528/* Generate the preamble required for initial synchronization and
529 a few older transceivers. */
530static void mdio_sync(unsigned int ioaddr, int bits)
531{
532 unsigned int mdio_addr = ioaddr + Wn4_PhysicalMgmt;
533
534 /* Establish sync by sending at least 32 logic ones. */
535 while (-- bits >= 0) {
536 outw(MDIO_DATA_WRITE1, mdio_addr);
537 outw(MDIO_DATA_WRITE1 | MDIO_SHIFT_CLK, mdio_addr);
538 }
539}
540
541static int mdio_read(unsigned int ioaddr, int phy_id, int location)
542{
543 int i;
544 int read_cmd = (0xf6 << 10) | (phy_id << 5) | location;
545 unsigned int retval = 0;
546 unsigned int mdio_addr = ioaddr + Wn4_PhysicalMgmt;
547
548 if (mii_preamble_required)
549 mdio_sync(ioaddr, 32);
550
551 /* Shift the read command bits out. */
552 for (i = 14; i >= 0; i--) {
553 int dataval = (read_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
554 outw(dataval, mdio_addr);
555 outw(dataval | MDIO_SHIFT_CLK, mdio_addr);
556 }
557 /* Read the two transition, 16 data, and wire-idle bits. */
558 for (i = 19; i > 0; i--) {
559 outw(MDIO_ENB_IN, mdio_addr);
560 retval = (retval << 1) | ((inw(mdio_addr) & MDIO_DATA_READ) ? 1 : 0);
561 outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);
562 }
563 return (retval>>1) & 0xffff;
564}
565
566static void mdio_write(unsigned int ioaddr, int phy_id, int location, int value)
567{
568 int write_cmd = 0x50020000 | (phy_id << 23) | (location << 18) | value;
569 unsigned int mdio_addr = ioaddr + Wn4_PhysicalMgmt;
570 int i;
571
572 if (mii_preamble_required)
573 mdio_sync(ioaddr, 32);
574
575 /* Shift the command bits out. */
576 for (i = 31; i >= 0; i--) {
577 int dataval = (write_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
578 outw(dataval, mdio_addr);
579 outw(dataval | MDIO_SHIFT_CLK, mdio_addr);
580 }
581 /* Leave the interface idle. */
582 for (i = 1; i >= 0; i--) {
583 outw(MDIO_ENB_IN, mdio_addr);
584 outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);
585 }
586}
587
588/* Reset and restore all of the 3c574 registers. */
589static void tc574_reset(struct net_device *dev)
590{
591 struct el3_private *lp = netdev_priv(dev);
592 int i;
593 unsigned int ioaddr = dev->base_addr;
594 unsigned long flags;
595
596 tc574_wait_for_completion(dev, TotalReset|0x10);
597
598 spin_lock_irqsave(&lp->window_lock, flags);
599 /* Clear any transactions in progress. */
600 outw(0, ioaddr + RunnerWrCtrl);
601 outw(0, ioaddr + RunnerRdCtrl);
602
603 /* Set the station address and mask. */
604 EL3WINDOW(2);
605 for (i = 0; i < 6; i++)
606 outb(dev->dev_addr[i], ioaddr + i);
607 for (; i < 12; i+=2)
608 outw(0, ioaddr + i);
609
610 /* Reset config options */
611 EL3WINDOW(3);
612 outb((dev->mtu > 1500 ? 0x40 : 0), ioaddr + Wn3_MAC_Ctrl);
613 outl((lp->autoselect ? 0x01000000 : 0) | 0x0062001b,
614 ioaddr + Wn3_Config);
615 /* Roadrunner only: Turn on the MII transceiver. */
616 outw(0x8040, ioaddr + Wn3_Options);
617 mdelay(1);
618 outw(0xc040, ioaddr + Wn3_Options);
619 EL3WINDOW(1);
620 spin_unlock_irqrestore(&lp->window_lock, flags);
621
622 tc574_wait_for_completion(dev, TxReset);
623 tc574_wait_for_completion(dev, RxReset);
624 mdelay(1);
625 spin_lock_irqsave(&lp->window_lock, flags);
626 EL3WINDOW(3);
627 outw(0x8040, ioaddr + Wn3_Options);
628
629 /* Switch to the stats window, and clear all stats by reading. */
630 outw(StatsDisable, ioaddr + EL3_CMD);
631 EL3WINDOW(6);
632 for (i = 0; i < 10; i++)
633 inb(ioaddr + i);
634 inw(ioaddr + 10);
635 inw(ioaddr + 12);
636 EL3WINDOW(4);
637 inb(ioaddr + 12);
638 inb(ioaddr + 13);
639
640 /* .. enable any extra statistics bits.. */
641 outw(0x0040, ioaddr + Wn4_NetDiag);
642
643 EL3WINDOW(1);
644 spin_unlock_irqrestore(&lp->window_lock, flags);
645
646 /* .. re-sync MII and re-fill what NWay is advertising. */
647 mdio_sync(ioaddr, 32);
648 mdio_write(ioaddr, lp->phys, 4, lp->advertising);
649 if (!auto_polarity) {
650 /* works for TDK 78Q2120 series MII's */
651 i = mdio_read(ioaddr, lp->phys, 16) | 0x20;
652 mdio_write(ioaddr, lp->phys, 16, i);
653 }
654
655 spin_lock_irqsave(&lp->window_lock, flags);
656 /* Switch to register set 1 for normal use, just for TxFree. */
657 set_rx_mode(dev);
658 spin_unlock_irqrestore(&lp->window_lock, flags);
659 outw(StatsEnable, ioaddr + EL3_CMD); /* Turn on statistics. */
660 outw(RxEnable, ioaddr + EL3_CMD); /* Enable the receiver. */
661 outw(TxEnable, ioaddr + EL3_CMD); /* Enable transmitter. */
662 /* Allow status bits to be seen. */
663 outw(SetStatusEnb | 0xff, ioaddr + EL3_CMD);
664 /* Ack all pending events, and set active indicator mask. */
665 outw(AckIntr | IntLatch | TxAvailable | RxEarly | IntReq,
666 ioaddr + EL3_CMD);
667 outw(SetIntrEnb | IntLatch | TxAvailable | RxComplete | StatsFull
668 | AdapterFailure | RxEarly, ioaddr + EL3_CMD);
669}
670
671static int el3_open(struct net_device *dev)
672{
673 struct el3_private *lp = netdev_priv(dev);
674 struct pcmcia_device *link = lp->p_dev;
675
676 if (!pcmcia_dev_present(link))
677 return -ENODEV;
678
679 link->open++;
680 netif_start_queue(dev);
681
682 tc574_reset(dev);
683 lp->media.expires = jiffies + HZ;
684 add_timer(&lp->media);
685
686 dev_dbg(&link->dev, "%s: opened, status %4.4x.\n",
687 dev->name, inw(dev->base_addr + EL3_STATUS));
688
689 return 0;
690}
691
692static void el3_tx_timeout(struct net_device *dev, unsigned int txqueue)
693{
694 unsigned int ioaddr = dev->base_addr;
695
696 netdev_notice(dev, "Transmit timed out!\n");
697 dump_status(dev);
698 dev->stats.tx_errors++;
699 netif_trans_update(dev); /* prevent tx timeout */
700 /* Issue TX_RESET and TX_START commands. */
701 tc574_wait_for_completion(dev, TxReset);
702 outw(TxEnable, ioaddr + EL3_CMD);
703 netif_wake_queue(dev);
704}
705
706static void pop_tx_status(struct net_device *dev)
707{
708 unsigned int ioaddr = dev->base_addr;
709 int i;
710
711 /* Clear the Tx status stack. */
712 for (i = 32; i > 0; i--) {
713 u_char tx_status = inb(ioaddr + TxStatus);
714 if (!(tx_status & 0x84))
715 break;
716 /* reset transmitter on jabber error or underrun */
717 if (tx_status & 0x30)
718 tc574_wait_for_completion(dev, TxReset);
719 if (tx_status & 0x38) {
720 pr_debug("%s: transmit error: status 0x%02x\n",
721 dev->name, tx_status);
722 outw(TxEnable, ioaddr + EL3_CMD);
723 dev->stats.tx_aborted_errors++;
724 }
725 outb(0x00, ioaddr + TxStatus); /* Pop the status stack. */
726 }
727}
728
729static netdev_tx_t el3_start_xmit(struct sk_buff *skb,
730 struct net_device *dev)
731{
732 unsigned int ioaddr = dev->base_addr;
733 struct el3_private *lp = netdev_priv(dev);
734 unsigned long flags;
735
736 pr_debug("%s: el3_start_xmit(length = %ld) called, "
737 "status %4.4x.\n", dev->name, (long)skb->len,
738 inw(ioaddr + EL3_STATUS));
739
740 spin_lock_irqsave(&lp->window_lock, flags);
741
742 dev->stats.tx_bytes += skb->len;
743
744 /* Put out the doubleword header... */
745 outw(skb->len, ioaddr + TX_FIFO);
746 outw(0, ioaddr + TX_FIFO);
747 /* ... and the packet rounded to a doubleword. */
748 outsl(ioaddr + TX_FIFO, skb->data, (skb->len+3)>>2);
749
750 /* TxFree appears only in Window 1, not offset 0x1c. */
751 if (inw(ioaddr + TxFree) <= 1536) {
752 netif_stop_queue(dev);
753 /* Interrupt us when the FIFO has room for max-sized packet.
754 The threshold is in units of dwords. */
755 outw(SetTxThreshold + (1536>>2), ioaddr + EL3_CMD);
756 }
757
758 pop_tx_status(dev);
759 spin_unlock_irqrestore(&lp->window_lock, flags);
760 dev_kfree_skb(skb);
761 return NETDEV_TX_OK;
762}
763
764/* The EL3 interrupt handler. */
765static irqreturn_t el3_interrupt(int irq, void *dev_id)
766{
767 struct net_device *dev = (struct net_device *) dev_id;
768 struct el3_private *lp = netdev_priv(dev);
769 unsigned int ioaddr;
770 unsigned status;
771 int work_budget = max_interrupt_work;
772 int handled = 0;
773
774 if (!netif_device_present(dev))
775 return IRQ_NONE;
776 ioaddr = dev->base_addr;
777
778 pr_debug("%s: interrupt, status %4.4x.\n",
779 dev->name, inw(ioaddr + EL3_STATUS));
780
781 spin_lock(&lp->window_lock);
782
783 while ((status = inw(ioaddr + EL3_STATUS)) &
784 (IntLatch | RxComplete | RxEarly | StatsFull)) {
785 if (!netif_device_present(dev) ||
786 ((status & 0xe000) != 0x2000)) {
787 pr_debug("%s: Interrupt from dead card\n", dev->name);
788 break;
789 }
790
791 handled = 1;
792
793 if (status & RxComplete)
794 work_budget = el3_rx(dev, work_budget);
795
796 if (status & TxAvailable) {
797 pr_debug(" TX room bit was handled.\n");
798 /* There's room in the FIFO for a full-sized packet. */
799 outw(AckIntr | TxAvailable, ioaddr + EL3_CMD);
800 netif_wake_queue(dev);
801 }
802
803 if (status & TxComplete)
804 pop_tx_status(dev);
805
806 if (status & (AdapterFailure | RxEarly | StatsFull)) {
807 /* Handle all uncommon interrupts. */
808 if (status & StatsFull)
809 update_stats(dev);
810 if (status & RxEarly) {
811 work_budget = el3_rx(dev, work_budget);
812 outw(AckIntr | RxEarly, ioaddr + EL3_CMD);
813 }
814 if (status & AdapterFailure) {
815 u16 fifo_diag;
816 EL3WINDOW(4);
817 fifo_diag = inw(ioaddr + Wn4_FIFODiag);
818 EL3WINDOW(1);
819 netdev_notice(dev, "adapter failure, FIFO diagnostic register %04x\n",
820 fifo_diag);
821 if (fifo_diag & 0x0400) {
822 /* Tx overrun */
823 tc574_wait_for_completion(dev, TxReset);
824 outw(TxEnable, ioaddr + EL3_CMD);
825 }
826 if (fifo_diag & 0x2000) {
827 /* Rx underrun */
828 tc574_wait_for_completion(dev, RxReset);
829 set_rx_mode(dev);
830 outw(RxEnable, ioaddr + EL3_CMD);
831 }
832 outw(AckIntr | AdapterFailure, ioaddr + EL3_CMD);
833 }
834 }
835
836 if (--work_budget < 0) {
837 pr_debug("%s: Too much work in interrupt, "
838 "status %4.4x.\n", dev->name, status);
839 /* Clear all interrupts */
840 outw(AckIntr | 0xFF, ioaddr + EL3_CMD);
841 break;
842 }
843 /* Acknowledge the IRQ. */
844 outw(AckIntr | IntReq | IntLatch, ioaddr + EL3_CMD);
845 }
846
847 pr_debug("%s: exiting interrupt, status %4.4x.\n",
848 dev->name, inw(ioaddr + EL3_STATUS));
849
850 spin_unlock(&lp->window_lock);
851 return IRQ_RETVAL(handled);
852}
853
854/*
855 This timer serves two purposes: to check for missed interrupts
856 (and as a last resort, poll the NIC for events), and to monitor
857 the MII, reporting changes in cable status.
858*/
859static void media_check(struct timer_list *t)
860{
861 struct el3_private *lp = from_timer(lp, t, media);
862 struct net_device *dev = lp->p_dev->priv;
863 unsigned int ioaddr = dev->base_addr;
864 unsigned long flags;
865 unsigned short /* cable, */ media, partner;
866
867 if (!netif_device_present(dev))
868 goto reschedule;
869
870 /* Check for pending interrupt with expired latency timer: with
871 this, we can limp along even if the interrupt is blocked */
872 if ((inw(ioaddr + EL3_STATUS) & IntLatch) && (inb(ioaddr + Timer) == 0xff)) {
873 if (!lp->fast_poll)
874 netdev_info(dev, "interrupt(s) dropped!\n");
875
876 local_irq_save(flags);
877 el3_interrupt(dev->irq, dev);
878 local_irq_restore(flags);
879
880 lp->fast_poll = HZ;
881 }
882 if (lp->fast_poll) {
883 lp->fast_poll--;
884 lp->media.expires = jiffies + 2*HZ/100;
885 add_timer(&lp->media);
886 return;
887 }
888
889 spin_lock_irqsave(&lp->window_lock, flags);
890 EL3WINDOW(4);
891 media = mdio_read(ioaddr, lp->phys, 1);
892 partner = mdio_read(ioaddr, lp->phys, 5);
893 EL3WINDOW(1);
894
895 if (media != lp->media_status) {
896 if ((media ^ lp->media_status) & 0x0004)
897 netdev_info(dev, "%s link beat\n",
898 (lp->media_status & 0x0004) ? "lost" : "found");
899 if ((media ^ lp->media_status) & 0x0020) {
900 lp->partner = 0;
901 if (lp->media_status & 0x0020) {
902 netdev_info(dev, "autonegotiation restarted\n");
903 } else if (partner) {
904 partner &= lp->advertising;
905 lp->partner = partner;
906 netdev_info(dev, "autonegotiation complete: "
907 "%dbaseT-%cD selected\n",
908 (partner & 0x0180) ? 100 : 10,
909 (partner & 0x0140) ? 'F' : 'H');
910 } else {
911 netdev_info(dev, "link partner did not autonegotiate\n");
912 }
913
914 EL3WINDOW(3);
915 outb((partner & 0x0140 ? 0x20 : 0) |
916 (dev->mtu > 1500 ? 0x40 : 0), ioaddr + Wn3_MAC_Ctrl);
917 EL3WINDOW(1);
918
919 }
920 if (media & 0x0010)
921 netdev_info(dev, "remote fault detected\n");
922 if (media & 0x0002)
923 netdev_info(dev, "jabber detected\n");
924 lp->media_status = media;
925 }
926 spin_unlock_irqrestore(&lp->window_lock, flags);
927
928reschedule:
929 lp->media.expires = jiffies + HZ;
930 add_timer(&lp->media);
931}
932
933static struct net_device_stats *el3_get_stats(struct net_device *dev)
934{
935 struct el3_private *lp = netdev_priv(dev);
936
937 if (netif_device_present(dev)) {
938 unsigned long flags;
939 spin_lock_irqsave(&lp->window_lock, flags);
940 update_stats(dev);
941 spin_unlock_irqrestore(&lp->window_lock, flags);
942 }
943 return &dev->stats;
944}
945
946/* Update statistics.
947 Surprisingly this need not be run single-threaded, but it effectively is.
948 The counters clear when read, so the adds must merely be atomic.
949 */
950static void update_stats(struct net_device *dev)
951{
952 unsigned int ioaddr = dev->base_addr;
953 u8 up;
954
955 pr_debug("%s: updating the statistics.\n", dev->name);
956
957 if (inw(ioaddr+EL3_STATUS) == 0xffff) /* No card. */
958 return;
959
960 /* Unlike the 3c509 we need not turn off stats updates while reading. */
961 /* Switch to the stats window, and read everything. */
962 EL3WINDOW(6);
963 dev->stats.tx_carrier_errors += inb(ioaddr + 0);
964 dev->stats.tx_heartbeat_errors += inb(ioaddr + 1);
965 /* Multiple collisions. */ inb(ioaddr + 2);
966 dev->stats.collisions += inb(ioaddr + 3);
967 dev->stats.tx_window_errors += inb(ioaddr + 4);
968 dev->stats.rx_fifo_errors += inb(ioaddr + 5);
969 dev->stats.tx_packets += inb(ioaddr + 6);
970 up = inb(ioaddr + 9);
971 dev->stats.tx_packets += (up&0x30) << 4;
972 /* Rx packets */ inb(ioaddr + 7);
973 /* Tx deferrals */ inb(ioaddr + 8);
974 /* rx */ inw(ioaddr + 10);
975 /* tx */ inw(ioaddr + 12);
976
977 EL3WINDOW(4);
978 /* BadSSD */ inb(ioaddr + 12);
979 up = inb(ioaddr + 13);
980
981 EL3WINDOW(1);
982}
983
984static int el3_rx(struct net_device *dev, int worklimit)
985{
986 unsigned int ioaddr = dev->base_addr;
987 short rx_status;
988
989 pr_debug("%s: in rx_packet(), status %4.4x, rx_status %4.4x.\n",
990 dev->name, inw(ioaddr+EL3_STATUS), inw(ioaddr+RxStatus));
991 while (!((rx_status = inw(ioaddr + RxStatus)) & 0x8000) &&
992 worklimit > 0) {
993 worklimit--;
994 if (rx_status & 0x4000) { /* Error, update stats. */
995 short error = rx_status & 0x3800;
996 dev->stats.rx_errors++;
997 switch (error) {
998 case 0x0000: dev->stats.rx_over_errors++; break;
999 case 0x0800: dev->stats.rx_length_errors++; break;
1000 case 0x1000: dev->stats.rx_frame_errors++; break;
1001 case 0x1800: dev->stats.rx_length_errors++; break;
1002 case 0x2000: dev->stats.rx_frame_errors++; break;
1003 case 0x2800: dev->stats.rx_crc_errors++; break;
1004 }
1005 } else {
1006 short pkt_len = rx_status & 0x7ff;
1007 struct sk_buff *skb;
1008
1009 skb = netdev_alloc_skb(dev, pkt_len + 5);
1010
1011 pr_debug(" Receiving packet size %d status %4.4x.\n",
1012 pkt_len, rx_status);
1013 if (skb != NULL) {
1014 skb_reserve(skb, 2);
1015 insl(ioaddr+RX_FIFO, skb_put(skb, pkt_len),
1016 ((pkt_len+3)>>2));
1017 skb->protocol = eth_type_trans(skb, dev);
1018 netif_rx(skb);
1019 dev->stats.rx_packets++;
1020 dev->stats.rx_bytes += pkt_len;
1021 } else {
1022 pr_debug("%s: couldn't allocate a sk_buff of"
1023 " size %d.\n", dev->name, pkt_len);
1024 dev->stats.rx_dropped++;
1025 }
1026 }
1027 tc574_wait_for_completion(dev, RxDiscard);
1028 }
1029
1030 return worklimit;
1031}
1032
1033/* Provide ioctl() calls to examine the MII xcvr state. */
1034static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
1035{
1036 struct el3_private *lp = netdev_priv(dev);
1037 unsigned int ioaddr = dev->base_addr;
1038 struct mii_ioctl_data *data = if_mii(rq);
1039 int phy = lp->phys & 0x1f;
1040
1041 pr_debug("%s: In ioct(%-.6s, %#4.4x) %4.4x %4.4x %4.4x %4.4x.\n",
1042 dev->name, rq->ifr_ifrn.ifrn_name, cmd,
1043 data->phy_id, data->reg_num, data->val_in, data->val_out);
1044
1045 switch(cmd) {
1046 case SIOCGMIIPHY: /* Get the address of the PHY in use. */
1047 data->phy_id = phy;
1048 fallthrough;
1049 case SIOCGMIIREG: /* Read the specified MII register. */
1050 {
1051 int saved_window;
1052 unsigned long flags;
1053
1054 spin_lock_irqsave(&lp->window_lock, flags);
1055 saved_window = inw(ioaddr + EL3_CMD) >> 13;
1056 EL3WINDOW(4);
1057 data->val_out = mdio_read(ioaddr, data->phy_id & 0x1f,
1058 data->reg_num & 0x1f);
1059 EL3WINDOW(saved_window);
1060 spin_unlock_irqrestore(&lp->window_lock, flags);
1061 return 0;
1062 }
1063 case SIOCSMIIREG: /* Write the specified MII register */
1064 {
1065 int saved_window;
1066 unsigned long flags;
1067
1068 spin_lock_irqsave(&lp->window_lock, flags);
1069 saved_window = inw(ioaddr + EL3_CMD) >> 13;
1070 EL3WINDOW(4);
1071 mdio_write(ioaddr, data->phy_id & 0x1f,
1072 data->reg_num & 0x1f, data->val_in);
1073 EL3WINDOW(saved_window);
1074 spin_unlock_irqrestore(&lp->window_lock, flags);
1075 return 0;
1076 }
1077 default:
1078 return -EOPNOTSUPP;
1079 }
1080}
1081
1082/* The Odie chip has a 64 bin multicast filter, but the bit layout is not
1083 documented. Until it is we revert to receiving all multicast frames when
1084 any multicast reception is desired.
1085 Note: My other drivers emit a log message whenever promiscuous mode is
1086 entered to help detect password sniffers. This is less desirable on
1087 typical PC card machines, so we omit the message.
1088 */
1089
1090static void set_rx_mode(struct net_device *dev)
1091{
1092 unsigned int ioaddr = dev->base_addr;
1093
1094 if (dev->flags & IFF_PROMISC)
1095 outw(SetRxFilter | RxStation | RxMulticast | RxBroadcast | RxProm,
1096 ioaddr + EL3_CMD);
1097 else if (!netdev_mc_empty(dev) || (dev->flags & IFF_ALLMULTI))
1098 outw(SetRxFilter|RxStation|RxMulticast|RxBroadcast, ioaddr + EL3_CMD);
1099 else
1100 outw(SetRxFilter | RxStation | RxBroadcast, ioaddr + EL3_CMD);
1101}
1102
1103static void set_multicast_list(struct net_device *dev)
1104{
1105 struct el3_private *lp = netdev_priv(dev);
1106 unsigned long flags;
1107
1108 spin_lock_irqsave(&lp->window_lock, flags);
1109 set_rx_mode(dev);
1110 spin_unlock_irqrestore(&lp->window_lock, flags);
1111}
1112
1113static int el3_close(struct net_device *dev)
1114{
1115 unsigned int ioaddr = dev->base_addr;
1116 struct el3_private *lp = netdev_priv(dev);
1117 struct pcmcia_device *link = lp->p_dev;
1118
1119 dev_dbg(&link->dev, "%s: shutting down ethercard.\n", dev->name);
1120
1121 if (pcmcia_dev_present(link)) {
1122 unsigned long flags;
1123
1124 /* Turn off statistics ASAP. We update lp->stats below. */
1125 outw(StatsDisable, ioaddr + EL3_CMD);
1126
1127 /* Disable the receiver and transmitter. */
1128 outw(RxDisable, ioaddr + EL3_CMD);
1129 outw(TxDisable, ioaddr + EL3_CMD);
1130
1131 /* Note: Switching to window 0 may disable the IRQ. */
1132 EL3WINDOW(0);
1133 spin_lock_irqsave(&lp->window_lock, flags);
1134 update_stats(dev);
1135 spin_unlock_irqrestore(&lp->window_lock, flags);
1136
1137 /* force interrupts off */
1138 outw(SetIntrEnb | 0x0000, ioaddr + EL3_CMD);
1139 }
1140
1141 link->open--;
1142 netif_stop_queue(dev);
1143 del_timer_sync(&lp->media);
1144
1145 return 0;
1146}
1147
1148static const struct pcmcia_device_id tc574_ids[] = {
1149 PCMCIA_DEVICE_MANF_CARD(0x0101, 0x0574),
1150 PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x0556, "cis/3CCFEM556.cis"),
1151 PCMCIA_DEVICE_NULL,
1152};
1153MODULE_DEVICE_TABLE(pcmcia, tc574_ids);
1154
1155static struct pcmcia_driver tc574_driver = {
1156 .owner = THIS_MODULE,
1157 .name = "3c574_cs",
1158 .probe = tc574_probe,
1159 .remove = tc574_detach,
1160 .id_table = tc574_ids,
1161 .suspend = tc574_suspend,
1162 .resume = tc574_resume,
1163};
1164module_pcmcia_driver(tc574_driver);
1/* 3c574.c: A PCMCIA ethernet driver for the 3com 3c574 "RoadRunner".
2
3 Written 1993-1998 by
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
7
8 This software may be used and distributed according to the terms of
9 the GNU General Public License, incorporated herein by reference.
10
11 This driver derives from Donald Becker's 3c509 core, which has the
12 following copyright:
13 Copyright 1993 United States Government as represented by the
14 Director, National Security Agency.
15
16
17*/
18
19/*
20 Theory of Operation
21
22I. Board Compatibility
23
24This device driver is designed for the 3Com 3c574 PC card Fast Ethernet
25Adapter.
26
27II. Board-specific settings
28
29None -- PC cards are autoconfigured.
30
31III. Driver operation
32
33The 3c574 uses a Boomerang-style interface, without the bus-master capability.
34See the Boomerang driver and documentation for most details.
35
36IV. Notes and chip documentation.
37
38Two added registers are used to enhance PIO performance, RunnerRdCtrl and
39RunnerWrCtrl. These are 11 bit down-counters that are preloaded with the
40count of word (16 bits) reads or writes the driver is about to do to the Rx
41or Tx FIFO. The chip is then able to hide the internal-PCI-bus to PC-card
42translation latency by buffering the I/O operations with an 8 word FIFO.
43Note: No other chip accesses are permitted when this buffer is used.
44
45A second enhancement is that both attribute and common memory space
460x0800-0x0fff can translated to the PIO FIFO. Thus memory operations (faster
47with *some* PCcard bridges) may be used instead of I/O operations.
48This is enabled by setting the 0x10 bit in the PCMCIA LAN COR.
49
50Some slow PC card bridges work better if they never see a WAIT signal.
51This is configured by setting the 0x20 bit in the PCMCIA LAN COR.
52Only do this after testing that it is reliable and improves performance.
53
54The upper five bits of RunnerRdCtrl are used to window into PCcard
55configuration space registers. Window 0 is the regular Boomerang/Odie
56register set, 1-5 are various PC card control registers, and 16-31 are
57the (reversed!) CIS table.
58
59A final note: writing the InternalConfig register in window 3 with an
60invalid ramWidth is Very Bad.
61
62V. References
63
64http://www.scyld.com/expert/NWay.html
65http://www.national.com/opf/DP/DP83840A.html
66
67Thanks to Terry Murphy of 3Com for providing development information for
68earlier 3Com products.
69
70*/
71
72#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
73
74#include <linux/module.h>
75#include <linux/kernel.h>
76#include <linux/init.h>
77#include <linux/slab.h>
78#include <linux/string.h>
79#include <linux/timer.h>
80#include <linux/interrupt.h>
81#include <linux/in.h>
82#include <linux/delay.h>
83#include <linux/netdevice.h>
84#include <linux/etherdevice.h>
85#include <linux/skbuff.h>
86#include <linux/if_arp.h>
87#include <linux/ioport.h>
88#include <linux/bitops.h>
89#include <linux/mii.h>
90
91#include <pcmcia/cistpl.h>
92#include <pcmcia/cisreg.h>
93#include <pcmcia/ciscode.h>
94#include <pcmcia/ds.h>
95
96#include <asm/uaccess.h>
97#include <asm/io.h>
98
99/*====================================================================*/
100
101/* Module parameters */
102
103MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
104MODULE_DESCRIPTION("3Com 3c574 series PCMCIA ethernet driver");
105MODULE_LICENSE("GPL");
106
107#define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)
108
109/* Maximum events (Rx packets, etc.) to handle at each interrupt. */
110INT_MODULE_PARM(max_interrupt_work, 32);
111
112/* Force full duplex modes? */
113INT_MODULE_PARM(full_duplex, 0);
114
115/* Autodetect link polarity reversal? */
116INT_MODULE_PARM(auto_polarity, 1);
117
118
119/*====================================================================*/
120
121/* Time in jiffies before concluding the transmitter is hung. */
122#define TX_TIMEOUT ((800*HZ)/1000)
123
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
129#define EL3_CMD 0x0e
130#define EL3_STATUS 0x0e
131
132#define EL3WINDOW(win_num) outw(SelectWindow + (win_num), ioaddr + EL3_CMD)
133
134/* The top five bits written to EL3_CMD are a command, the lower
135 11 bits are the parameter, if applicable. */
136enum el3_cmds {
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,
144};
145
146enum elxl_status {
147 IntLatch = 0x0001, AdapterFailure = 0x0002, TxComplete = 0x0004,
148 TxAvailable = 0x0008, RxComplete = 0x0010, RxEarly = 0x0020,
149 IntReq = 0x0040, StatsFull = 0x0080, CmdBusy = 0x1000 };
150
151/* The SetRxFilter command accepts the following classes: */
152enum RxFilter {
153 RxStation = 1, RxMulticast = 2, RxBroadcast = 4, RxProm = 8
154};
155
156enum Window0 {
157 Wn0EepromCmd = 10, Wn0EepromData = 12, /* EEPROM command/address, data. */
158 IntrStatus=0x0E, /* Valid in all windows. */
159};
160/* These assumes the larger EEPROM. */
161enum 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. */
165};
166
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. */
170enum Window1 {
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,
175};
176
177enum Window3 { /* Window 3: MAC/config bits. */
178 Wn3_Config=0, Wn3_MAC_Ctrl=6, Wn3_Options=8,
179};
180enum wn3_config {
181 Ram_size = 7,
182 Ram_width = 8,
183 Ram_speed = 0x30,
184 Rom_size = 0xc0,
185 Ram_split_shift = 16,
186 Ram_split = 3 << Ram_split_shift,
187 Xcvr_shift = 20,
188 Xcvr = 7 << Xcvr_shift,
189 Autoselect = 0x1000000,
190};
191
192enum Window4 { /* Window 4: Xcvr/media bits. */
193 Wn4_FIFODiag = 4, Wn4_NetDiag = 6, Wn4_PhysicalMgmt=8, Wn4_Media = 10,
194};
195
196#define MEDIA_TP 0x00C0 /* Enable link beat and jabber for 10baseT. */
197
198struct el3_private {
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 */
209};
210
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. */
214static char mii_preamble_required = 0;
215
216/* Index of functions. */
217
218static int tc574_config(struct pcmcia_device *link);
219static void tc574_release(struct pcmcia_device *link);
220
221static void mdio_sync(unsigned int ioaddr, int bits);
222static int mdio_read(unsigned int ioaddr, int phy_id, int location);
223static void mdio_write(unsigned int ioaddr, int phy_id, int location,
224 int value);
225static unsigned short read_eeprom(unsigned int ioaddr, int index);
226static void tc574_wait_for_completion(struct net_device *dev, int cmd);
227
228static void tc574_reset(struct net_device *dev);
229static void media_check(unsigned long arg);
230static int el3_open(struct net_device *dev);
231static netdev_tx_t el3_start_xmit(struct sk_buff *skb,
232 struct net_device *dev);
233static irqreturn_t el3_interrupt(int irq, void *dev_id);
234static void update_stats(struct net_device *dev);
235static struct net_device_stats *el3_get_stats(struct net_device *dev);
236static int el3_rx(struct net_device *dev, int worklimit);
237static int el3_close(struct net_device *dev);
238static void el3_tx_timeout(struct net_device *dev);
239static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
240static void set_rx_mode(struct net_device *dev);
241static void set_multicast_list(struct net_device *dev);
242
243static void tc574_detach(struct pcmcia_device *p_dev);
244
245/*
246 tc574_attach() creates an "instance" of the driver, allocating
247 local data structures for one device. The device is registered
248 with Card Services.
249*/
250static const struct net_device_ops el3_netdev_ops = {
251 .ndo_open = el3_open,
252 .ndo_stop = el3_close,
253 .ndo_start_xmit = el3_start_xmit,
254 .ndo_tx_timeout = el3_tx_timeout,
255 .ndo_get_stats = el3_get_stats,
256 .ndo_do_ioctl = el3_ioctl,
257 .ndo_set_rx_mode = set_multicast_list,
258 .ndo_change_mtu = eth_change_mtu,
259 .ndo_set_mac_address = eth_mac_addr,
260 .ndo_validate_addr = eth_validate_addr,
261};
262
263static int tc574_probe(struct pcmcia_device *link)
264{
265 struct el3_private *lp;
266 struct net_device *dev;
267
268 dev_dbg(&link->dev, "3c574_attach()\n");
269
270 /* Create the PC card device object. */
271 dev = alloc_etherdev(sizeof(struct el3_private));
272 if (!dev)
273 return -ENOMEM;
274 lp = netdev_priv(dev);
275 link->priv = dev;
276 lp->p_dev = link;
277
278 spin_lock_init(&lp->window_lock);
279 link->resource[0]->end = 32;
280 link->resource[0]->flags |= IO_DATA_PATH_WIDTH_16;
281 link->config_flags |= CONF_ENABLE_IRQ;
282 link->config_index = 1;
283
284 dev->netdev_ops = &el3_netdev_ops;
285 dev->watchdog_timeo = TX_TIMEOUT;
286
287 return tc574_config(link);
288}
289
290static void tc574_detach(struct pcmcia_device *link)
291{
292 struct net_device *dev = link->priv;
293
294 dev_dbg(&link->dev, "3c574_detach()\n");
295
296 unregister_netdev(dev);
297
298 tc574_release(link);
299
300 free_netdev(dev);
301} /* tc574_detach */
302
303static const char *ram_split[] = {"5:3", "3:1", "1:1", "3:5"};
304
305static int tc574_config(struct pcmcia_device *link)
306{
307 struct net_device *dev = link->priv;
308 struct el3_private *lp = netdev_priv(dev);
309 int ret, i, j;
310 unsigned int ioaddr;
311 __be16 *phys_addr;
312 char *cardname;
313 __u32 config;
314 u8 *buf;
315 size_t len;
316
317 phys_addr = (__be16 *)dev->dev_addr;
318
319 dev_dbg(&link->dev, "3c574_config()\n");
320
321 link->io_lines = 16;
322
323 for (i = j = 0; j < 0x400; j += 0x20) {
324 link->resource[0]->start = j ^ 0x300;
325 i = pcmcia_request_io(link);
326 if (i == 0)
327 break;
328 }
329 if (i != 0)
330 goto failed;
331
332 ret = pcmcia_request_irq(link, el3_interrupt);
333 if (ret)
334 goto failed;
335
336 ret = pcmcia_enable_device(link);
337 if (ret)
338 goto failed;
339
340 dev->irq = link->irq;
341 dev->base_addr = link->resource[0]->start;
342
343 ioaddr = dev->base_addr;
344
345 /* The 3c574 normally uses an EEPROM for configuration info, including
346 the hardware address. The future products may include a modem chip
347 and put the address in the CIS. */
348
349 len = pcmcia_get_tuple(link, 0x88, &buf);
350 if (buf && len >= 6) {
351 for (i = 0; i < 3; i++)
352 phys_addr[i] = htons(le16_to_cpu(buf[i * 2]));
353 kfree(buf);
354 } else {
355 kfree(buf); /* 0 < len < 6 */
356 EL3WINDOW(0);
357 for (i = 0; i < 3; i++)
358 phys_addr[i] = htons(read_eeprom(ioaddr, i + 10));
359 if (phys_addr[0] == htons(0x6060)) {
360 pr_notice("IO port conflict at 0x%03lx-0x%03lx\n",
361 dev->base_addr, dev->base_addr+15);
362 goto failed;
363 }
364 }
365 if (link->prod_id[1])
366 cardname = link->prod_id[1];
367 else
368 cardname = "3Com 3c574";
369
370 {
371 u_char mcr;
372 outw(2<<11, ioaddr + RunnerRdCtrl);
373 mcr = inb(ioaddr + 2);
374 outw(0<<11, ioaddr + RunnerRdCtrl);
375 pr_info(" ASIC rev %d,", mcr>>3);
376 EL3WINDOW(3);
377 config = inl(ioaddr + Wn3_Config);
378 lp->default_media = (config & Xcvr) >> Xcvr_shift;
379 lp->autoselect = config & Autoselect ? 1 : 0;
380 }
381
382 init_timer(&lp->media);
383
384 {
385 int phy;
386
387 /* Roadrunner only: Turn on the MII transceiver */
388 outw(0x8040, ioaddr + Wn3_Options);
389 mdelay(1);
390 outw(0xc040, ioaddr + Wn3_Options);
391 tc574_wait_for_completion(dev, TxReset);
392 tc574_wait_for_completion(dev, RxReset);
393 mdelay(1);
394 outw(0x8040, ioaddr + Wn3_Options);
395
396 EL3WINDOW(4);
397 for (phy = 1; phy <= 32; phy++) {
398 int mii_status;
399 mdio_sync(ioaddr, 32);
400 mii_status = mdio_read(ioaddr, phy & 0x1f, 1);
401 if (mii_status != 0xffff) {
402 lp->phys = phy & 0x1f;
403 dev_dbg(&link->dev, " MII transceiver at "
404 "index %d, status %x.\n",
405 phy, mii_status);
406 if ((mii_status & 0x0040) == 0)
407 mii_preamble_required = 1;
408 break;
409 }
410 }
411 if (phy > 32) {
412 pr_notice(" No MII transceivers found!\n");
413 goto failed;
414 }
415 i = mdio_read(ioaddr, lp->phys, 16) | 0x40;
416 mdio_write(ioaddr, lp->phys, 16, i);
417 lp->advertising = mdio_read(ioaddr, lp->phys, 4);
418 if (full_duplex) {
419 /* Only advertise the FD media types. */
420 lp->advertising &= ~0x02a0;
421 mdio_write(ioaddr, lp->phys, 4, lp->advertising);
422 }
423 }
424
425 SET_NETDEV_DEV(dev, &link->dev);
426
427 if (register_netdev(dev) != 0) {
428 pr_notice("register_netdev() failed\n");
429 goto failed;
430 }
431
432 netdev_info(dev, "%s at io %#3lx, irq %d, hw_addr %pM\n",
433 cardname, dev->base_addr, dev->irq, dev->dev_addr);
434 netdev_info(dev, " %dK FIFO split %s Rx:Tx, %sMII interface.\n",
435 8 << config & Ram_size,
436 ram_split[(config & Ram_split) >> Ram_split_shift],
437 config & Autoselect ? "autoselect " : "");
438
439 return 0;
440
441failed:
442 tc574_release(link);
443 return -ENODEV;
444
445} /* tc574_config */
446
447static void tc574_release(struct pcmcia_device *link)
448{
449 pcmcia_disable_device(link);
450}
451
452static int tc574_suspend(struct pcmcia_device *link)
453{
454 struct net_device *dev = link->priv;
455
456 if (link->open)
457 netif_device_detach(dev);
458
459 return 0;
460}
461
462static int tc574_resume(struct pcmcia_device *link)
463{
464 struct net_device *dev = link->priv;
465
466 if (link->open) {
467 tc574_reset(dev);
468 netif_device_attach(dev);
469 }
470
471 return 0;
472}
473
474static void dump_status(struct net_device *dev)
475{
476 unsigned int ioaddr = dev->base_addr;
477 EL3WINDOW(1);
478 netdev_info(dev, " irq status %04x, rx status %04x, tx status %02x, tx free %04x\n",
479 inw(ioaddr+EL3_STATUS),
480 inw(ioaddr+RxStatus), inb(ioaddr+TxStatus),
481 inw(ioaddr+TxFree));
482 EL3WINDOW(4);
483 netdev_info(dev, " diagnostics: fifo %04x net %04x ethernet %04x media %04x\n",
484 inw(ioaddr+0x04), inw(ioaddr+0x06),
485 inw(ioaddr+0x08), inw(ioaddr+0x0a));
486 EL3WINDOW(1);
487}
488
489/*
490 Use this for commands that may take time to finish
491*/
492static void tc574_wait_for_completion(struct net_device *dev, int cmd)
493{
494 int i = 1500;
495 outw(cmd, dev->base_addr + EL3_CMD);
496 while (--i > 0)
497 if (!(inw(dev->base_addr + EL3_STATUS) & 0x1000)) break;
498 if (i == 0)
499 netdev_notice(dev, "command 0x%04x did not complete!\n", cmd);
500}
501
502/* Read a word from the EEPROM using the regular EEPROM access register.
503 Assume that we are in register window zero.
504 */
505static unsigned short read_eeprom(unsigned int ioaddr, int index)
506{
507 int timer;
508 outw(EEPROM_Read + index, ioaddr + Wn0EepromCmd);
509 /* Pause for at least 162 usec for the read to take place. */
510 for (timer = 1620; timer >= 0; timer--) {
511 if ((inw(ioaddr + Wn0EepromCmd) & 0x8000) == 0)
512 break;
513 }
514 return inw(ioaddr + Wn0EepromData);
515}
516
517/* MII transceiver control section.
518 Read and write the MII registers using software-generated serial
519 MDIO protocol. See the MII specifications or DP83840A data sheet
520 for details.
521 The maxium data clock rate is 2.5 Mhz. The timing is easily met by the
522 slow PC card interface. */
523
524#define MDIO_SHIFT_CLK 0x01
525#define MDIO_DIR_WRITE 0x04
526#define MDIO_DATA_WRITE0 (0x00 | MDIO_DIR_WRITE)
527#define MDIO_DATA_WRITE1 (0x02 | MDIO_DIR_WRITE)
528#define MDIO_DATA_READ 0x02
529#define MDIO_ENB_IN 0x00
530
531/* Generate the preamble required for initial synchronization and
532 a few older transceivers. */
533static void mdio_sync(unsigned int ioaddr, int bits)
534{
535 unsigned int mdio_addr = ioaddr + Wn4_PhysicalMgmt;
536
537 /* Establish sync by sending at least 32 logic ones. */
538 while (-- bits >= 0) {
539 outw(MDIO_DATA_WRITE1, mdio_addr);
540 outw(MDIO_DATA_WRITE1 | MDIO_SHIFT_CLK, mdio_addr);
541 }
542}
543
544static int mdio_read(unsigned int ioaddr, int phy_id, int location)
545{
546 int i;
547 int read_cmd = (0xf6 << 10) | (phy_id << 5) | location;
548 unsigned int retval = 0;
549 unsigned int mdio_addr = ioaddr + Wn4_PhysicalMgmt;
550
551 if (mii_preamble_required)
552 mdio_sync(ioaddr, 32);
553
554 /* Shift the read command bits out. */
555 for (i = 14; i >= 0; i--) {
556 int dataval = (read_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
557 outw(dataval, mdio_addr);
558 outw(dataval | MDIO_SHIFT_CLK, mdio_addr);
559 }
560 /* Read the two transition, 16 data, and wire-idle bits. */
561 for (i = 19; i > 0; i--) {
562 outw(MDIO_ENB_IN, mdio_addr);
563 retval = (retval << 1) | ((inw(mdio_addr) & MDIO_DATA_READ) ? 1 : 0);
564 outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);
565 }
566 return (retval>>1) & 0xffff;
567}
568
569static void mdio_write(unsigned int ioaddr, int phy_id, int location, int value)
570{
571 int write_cmd = 0x50020000 | (phy_id << 23) | (location << 18) | value;
572 unsigned int mdio_addr = ioaddr + Wn4_PhysicalMgmt;
573 int i;
574
575 if (mii_preamble_required)
576 mdio_sync(ioaddr, 32);
577
578 /* Shift the command bits out. */
579 for (i = 31; i >= 0; i--) {
580 int dataval = (write_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;
581 outw(dataval, mdio_addr);
582 outw(dataval | MDIO_SHIFT_CLK, mdio_addr);
583 }
584 /* Leave the interface idle. */
585 for (i = 1; i >= 0; i--) {
586 outw(MDIO_ENB_IN, mdio_addr);
587 outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);
588 }
589}
590
591/* Reset and restore all of the 3c574 registers. */
592static void tc574_reset(struct net_device *dev)
593{
594 struct el3_private *lp = netdev_priv(dev);
595 int i;
596 unsigned int ioaddr = dev->base_addr;
597 unsigned long flags;
598
599 tc574_wait_for_completion(dev, TotalReset|0x10);
600
601 spin_lock_irqsave(&lp->window_lock, flags);
602 /* Clear any transactions in progress. */
603 outw(0, ioaddr + RunnerWrCtrl);
604 outw(0, ioaddr + RunnerRdCtrl);
605
606 /* Set the station address and mask. */
607 EL3WINDOW(2);
608 for (i = 0; i < 6; i++)
609 outb(dev->dev_addr[i], ioaddr + i);
610 for (; i < 12; i+=2)
611 outw(0, ioaddr + i);
612
613 /* Reset config options */
614 EL3WINDOW(3);
615 outb((dev->mtu > 1500 ? 0x40 : 0), ioaddr + Wn3_MAC_Ctrl);
616 outl((lp->autoselect ? 0x01000000 : 0) | 0x0062001b,
617 ioaddr + Wn3_Config);
618 /* Roadrunner only: Turn on the MII transceiver. */
619 outw(0x8040, ioaddr + Wn3_Options);
620 mdelay(1);
621 outw(0xc040, ioaddr + Wn3_Options);
622 EL3WINDOW(1);
623 spin_unlock_irqrestore(&lp->window_lock, flags);
624
625 tc574_wait_for_completion(dev, TxReset);
626 tc574_wait_for_completion(dev, RxReset);
627 mdelay(1);
628 spin_lock_irqsave(&lp->window_lock, flags);
629 EL3WINDOW(3);
630 outw(0x8040, ioaddr + Wn3_Options);
631
632 /* Switch to the stats window, and clear all stats by reading. */
633 outw(StatsDisable, ioaddr + EL3_CMD);
634 EL3WINDOW(6);
635 for (i = 0; i < 10; i++)
636 inb(ioaddr + i);
637 inw(ioaddr + 10);
638 inw(ioaddr + 12);
639 EL3WINDOW(4);
640 inb(ioaddr + 12);
641 inb(ioaddr + 13);
642
643 /* .. enable any extra statistics bits.. */
644 outw(0x0040, ioaddr + Wn4_NetDiag);
645
646 EL3WINDOW(1);
647 spin_unlock_irqrestore(&lp->window_lock, flags);
648
649 /* .. re-sync MII and re-fill what NWay is advertising. */
650 mdio_sync(ioaddr, 32);
651 mdio_write(ioaddr, lp->phys, 4, lp->advertising);
652 if (!auto_polarity) {
653 /* works for TDK 78Q2120 series MII's */
654 i = mdio_read(ioaddr, lp->phys, 16) | 0x20;
655 mdio_write(ioaddr, lp->phys, 16, i);
656 }
657
658 spin_lock_irqsave(&lp->window_lock, flags);
659 /* Switch to register set 1 for normal use, just for TxFree. */
660 set_rx_mode(dev);
661 spin_unlock_irqrestore(&lp->window_lock, flags);
662 outw(StatsEnable, ioaddr + EL3_CMD); /* Turn on statistics. */
663 outw(RxEnable, ioaddr + EL3_CMD); /* Enable the receiver. */
664 outw(TxEnable, ioaddr + EL3_CMD); /* Enable transmitter. */
665 /* Allow status bits to be seen. */
666 outw(SetStatusEnb | 0xff, ioaddr + EL3_CMD);
667 /* Ack all pending events, and set active indicator mask. */
668 outw(AckIntr | IntLatch | TxAvailable | RxEarly | IntReq,
669 ioaddr + EL3_CMD);
670 outw(SetIntrEnb | IntLatch | TxAvailable | RxComplete | StatsFull
671 | AdapterFailure | RxEarly, ioaddr + EL3_CMD);
672}
673
674static int el3_open(struct net_device *dev)
675{
676 struct el3_private *lp = netdev_priv(dev);
677 struct pcmcia_device *link = lp->p_dev;
678
679 if (!pcmcia_dev_present(link))
680 return -ENODEV;
681
682 link->open++;
683 netif_start_queue(dev);
684
685 tc574_reset(dev);
686 lp->media.function = media_check;
687 lp->media.data = (unsigned long) dev;
688 lp->media.expires = jiffies + HZ;
689 add_timer(&lp->media);
690
691 dev_dbg(&link->dev, "%s: opened, status %4.4x.\n",
692 dev->name, inw(dev->base_addr + EL3_STATUS));
693
694 return 0;
695}
696
697static void el3_tx_timeout(struct net_device *dev)
698{
699 unsigned int ioaddr = dev->base_addr;
700
701 netdev_notice(dev, "Transmit timed out!\n");
702 dump_status(dev);
703 dev->stats.tx_errors++;
704 dev->trans_start = jiffies; /* prevent tx timeout */
705 /* Issue TX_RESET and TX_START commands. */
706 tc574_wait_for_completion(dev, TxReset);
707 outw(TxEnable, ioaddr + EL3_CMD);
708 netif_wake_queue(dev);
709}
710
711static void pop_tx_status(struct net_device *dev)
712{
713 unsigned int ioaddr = dev->base_addr;
714 int i;
715
716 /* Clear the Tx status stack. */
717 for (i = 32; i > 0; i--) {
718 u_char tx_status = inb(ioaddr + TxStatus);
719 if (!(tx_status & 0x84))
720 break;
721 /* reset transmitter on jabber error or underrun */
722 if (tx_status & 0x30)
723 tc574_wait_for_completion(dev, TxReset);
724 if (tx_status & 0x38) {
725 pr_debug("%s: transmit error: status 0x%02x\n",
726 dev->name, tx_status);
727 outw(TxEnable, ioaddr + EL3_CMD);
728 dev->stats.tx_aborted_errors++;
729 }
730 outb(0x00, ioaddr + TxStatus); /* Pop the status stack. */
731 }
732}
733
734static netdev_tx_t el3_start_xmit(struct sk_buff *skb,
735 struct net_device *dev)
736{
737 unsigned int ioaddr = dev->base_addr;
738 struct el3_private *lp = netdev_priv(dev);
739 unsigned long flags;
740
741 pr_debug("%s: el3_start_xmit(length = %ld) called, "
742 "status %4.4x.\n", dev->name, (long)skb->len,
743 inw(ioaddr + EL3_STATUS));
744
745 spin_lock_irqsave(&lp->window_lock, flags);
746
747 dev->stats.tx_bytes += skb->len;
748
749 /* Put out the doubleword header... */
750 outw(skb->len, ioaddr + TX_FIFO);
751 outw(0, ioaddr + TX_FIFO);
752 /* ... and the packet rounded to a doubleword. */
753 outsl(ioaddr + TX_FIFO, skb->data, (skb->len+3)>>2);
754
755 /* TxFree appears only in Window 1, not offset 0x1c. */
756 if (inw(ioaddr + TxFree) <= 1536) {
757 netif_stop_queue(dev);
758 /* Interrupt us when the FIFO has room for max-sized packet.
759 The threshold is in units of dwords. */
760 outw(SetTxThreshold + (1536>>2), ioaddr + EL3_CMD);
761 }
762
763 pop_tx_status(dev);
764 spin_unlock_irqrestore(&lp->window_lock, flags);
765 dev_kfree_skb(skb);
766 return NETDEV_TX_OK;
767}
768
769/* The EL3 interrupt handler. */
770static irqreturn_t el3_interrupt(int irq, void *dev_id)
771{
772 struct net_device *dev = (struct net_device *) dev_id;
773 struct el3_private *lp = netdev_priv(dev);
774 unsigned int ioaddr;
775 unsigned status;
776 int work_budget = max_interrupt_work;
777 int handled = 0;
778
779 if (!netif_device_present(dev))
780 return IRQ_NONE;
781 ioaddr = dev->base_addr;
782
783 pr_debug("%s: interrupt, status %4.4x.\n",
784 dev->name, inw(ioaddr + EL3_STATUS));
785
786 spin_lock(&lp->window_lock);
787
788 while ((status = inw(ioaddr + EL3_STATUS)) &
789 (IntLatch | RxComplete | RxEarly | StatsFull)) {
790 if (!netif_device_present(dev) ||
791 ((status & 0xe000) != 0x2000)) {
792 pr_debug("%s: Interrupt from dead card\n", dev->name);
793 break;
794 }
795
796 handled = 1;
797
798 if (status & RxComplete)
799 work_budget = el3_rx(dev, work_budget);
800
801 if (status & TxAvailable) {
802 pr_debug(" TX room bit was handled.\n");
803 /* There's room in the FIFO for a full-sized packet. */
804 outw(AckIntr | TxAvailable, ioaddr + EL3_CMD);
805 netif_wake_queue(dev);
806 }
807
808 if (status & TxComplete)
809 pop_tx_status(dev);
810
811 if (status & (AdapterFailure | RxEarly | StatsFull)) {
812 /* Handle all uncommon interrupts. */
813 if (status & StatsFull)
814 update_stats(dev);
815 if (status & RxEarly) {
816 work_budget = el3_rx(dev, work_budget);
817 outw(AckIntr | RxEarly, ioaddr + EL3_CMD);
818 }
819 if (status & AdapterFailure) {
820 u16 fifo_diag;
821 EL3WINDOW(4);
822 fifo_diag = inw(ioaddr + Wn4_FIFODiag);
823 EL3WINDOW(1);
824 netdev_notice(dev, "adapter failure, FIFO diagnostic register %04x\n",
825 fifo_diag);
826 if (fifo_diag & 0x0400) {
827 /* Tx overrun */
828 tc574_wait_for_completion(dev, TxReset);
829 outw(TxEnable, ioaddr + EL3_CMD);
830 }
831 if (fifo_diag & 0x2000) {
832 /* Rx underrun */
833 tc574_wait_for_completion(dev, RxReset);
834 set_rx_mode(dev);
835 outw(RxEnable, ioaddr + EL3_CMD);
836 }
837 outw(AckIntr | AdapterFailure, ioaddr + EL3_CMD);
838 }
839 }
840
841 if (--work_budget < 0) {
842 pr_debug("%s: Too much work in interrupt, "
843 "status %4.4x.\n", dev->name, status);
844 /* Clear all interrupts */
845 outw(AckIntr | 0xFF, ioaddr + EL3_CMD);
846 break;
847 }
848 /* Acknowledge the IRQ. */
849 outw(AckIntr | IntReq | IntLatch, ioaddr + EL3_CMD);
850 }
851
852 pr_debug("%s: exiting interrupt, status %4.4x.\n",
853 dev->name, inw(ioaddr + EL3_STATUS));
854
855 spin_unlock(&lp->window_lock);
856 return IRQ_RETVAL(handled);
857}
858
859/*
860 This timer serves two purposes: to check for missed interrupts
861 (and as a last resort, poll the NIC for events), and to monitor
862 the MII, reporting changes in cable status.
863*/
864static void media_check(unsigned long arg)
865{
866 struct net_device *dev = (struct net_device *) arg;
867 struct el3_private *lp = netdev_priv(dev);
868 unsigned int ioaddr = dev->base_addr;
869 unsigned long flags;
870 unsigned short /* cable, */ media, partner;
871
872 if (!netif_device_present(dev))
873 goto reschedule;
874
875 /* Check for pending interrupt with expired latency timer: with
876 this, we can limp along even if the interrupt is blocked */
877 if ((inw(ioaddr + EL3_STATUS) & IntLatch) && (inb(ioaddr + Timer) == 0xff)) {
878 if (!lp->fast_poll)
879 netdev_info(dev, "interrupt(s) dropped!\n");
880
881 local_irq_save(flags);
882 el3_interrupt(dev->irq, dev);
883 local_irq_restore(flags);
884
885 lp->fast_poll = HZ;
886 }
887 if (lp->fast_poll) {
888 lp->fast_poll--;
889 lp->media.expires = jiffies + 2*HZ/100;
890 add_timer(&lp->media);
891 return;
892 }
893
894 spin_lock_irqsave(&lp->window_lock, flags);
895 EL3WINDOW(4);
896 media = mdio_read(ioaddr, lp->phys, 1);
897 partner = mdio_read(ioaddr, lp->phys, 5);
898 EL3WINDOW(1);
899
900 if (media != lp->media_status) {
901 if ((media ^ lp->media_status) & 0x0004)
902 netdev_info(dev, "%s link beat\n",
903 (lp->media_status & 0x0004) ? "lost" : "found");
904 if ((media ^ lp->media_status) & 0x0020) {
905 lp->partner = 0;
906 if (lp->media_status & 0x0020) {
907 netdev_info(dev, "autonegotiation restarted\n");
908 } else if (partner) {
909 partner &= lp->advertising;
910 lp->partner = partner;
911 netdev_info(dev, "autonegotiation complete: "
912 "%dbaseT-%cD selected\n",
913 (partner & 0x0180) ? 100 : 10,
914 (partner & 0x0140) ? 'F' : 'H');
915 } else {
916 netdev_info(dev, "link partner did not autonegotiate\n");
917 }
918
919 EL3WINDOW(3);
920 outb((partner & 0x0140 ? 0x20 : 0) |
921 (dev->mtu > 1500 ? 0x40 : 0), ioaddr + Wn3_MAC_Ctrl);
922 EL3WINDOW(1);
923
924 }
925 if (media & 0x0010)
926 netdev_info(dev, "remote fault detected\n");
927 if (media & 0x0002)
928 netdev_info(dev, "jabber detected\n");
929 lp->media_status = media;
930 }
931 spin_unlock_irqrestore(&lp->window_lock, flags);
932
933reschedule:
934 lp->media.expires = jiffies + HZ;
935 add_timer(&lp->media);
936}
937
938static struct net_device_stats *el3_get_stats(struct net_device *dev)
939{
940 struct el3_private *lp = netdev_priv(dev);
941
942 if (netif_device_present(dev)) {
943 unsigned long flags;
944 spin_lock_irqsave(&lp->window_lock, flags);
945 update_stats(dev);
946 spin_unlock_irqrestore(&lp->window_lock, flags);
947 }
948 return &dev->stats;
949}
950
951/* Update statistics.
952 Surprisingly this need not be run single-threaded, but it effectively is.
953 The counters clear when read, so the adds must merely be atomic.
954 */
955static void update_stats(struct net_device *dev)
956{
957 unsigned int ioaddr = dev->base_addr;
958 u8 rx, tx, up;
959
960 pr_debug("%s: updating the statistics.\n", dev->name);
961
962 if (inw(ioaddr+EL3_STATUS) == 0xffff) /* No card. */
963 return;
964
965 /* Unlike the 3c509 we need not turn off stats updates while reading. */
966 /* Switch to the stats window, and read everything. */
967 EL3WINDOW(6);
968 dev->stats.tx_carrier_errors += inb(ioaddr + 0);
969 dev->stats.tx_heartbeat_errors += inb(ioaddr + 1);
970 /* Multiple collisions. */ inb(ioaddr + 2);
971 dev->stats.collisions += inb(ioaddr + 3);
972 dev->stats.tx_window_errors += inb(ioaddr + 4);
973 dev->stats.rx_fifo_errors += inb(ioaddr + 5);
974 dev->stats.tx_packets += inb(ioaddr + 6);
975 up = inb(ioaddr + 9);
976 dev->stats.tx_packets += (up&0x30) << 4;
977 /* Rx packets */ inb(ioaddr + 7);
978 /* Tx deferrals */ inb(ioaddr + 8);
979 rx = inw(ioaddr + 10);
980 tx = inw(ioaddr + 12);
981
982 EL3WINDOW(4);
983 /* BadSSD */ inb(ioaddr + 12);
984 up = inb(ioaddr + 13);
985
986 EL3WINDOW(1);
987}
988
989static int el3_rx(struct net_device *dev, int worklimit)
990{
991 unsigned int ioaddr = dev->base_addr;
992 short rx_status;
993
994 pr_debug("%s: in rx_packet(), status %4.4x, rx_status %4.4x.\n",
995 dev->name, inw(ioaddr+EL3_STATUS), inw(ioaddr+RxStatus));
996 while (!((rx_status = inw(ioaddr + RxStatus)) & 0x8000) &&
997 worklimit > 0) {
998 worklimit--;
999 if (rx_status & 0x4000) { /* Error, update stats. */
1000 short error = rx_status & 0x3800;
1001 dev->stats.rx_errors++;
1002 switch (error) {
1003 case 0x0000: dev->stats.rx_over_errors++; break;
1004 case 0x0800: dev->stats.rx_length_errors++; break;
1005 case 0x1000: dev->stats.rx_frame_errors++; break;
1006 case 0x1800: dev->stats.rx_length_errors++; break;
1007 case 0x2000: dev->stats.rx_frame_errors++; break;
1008 case 0x2800: dev->stats.rx_crc_errors++; break;
1009 }
1010 } else {
1011 short pkt_len = rx_status & 0x7ff;
1012 struct sk_buff *skb;
1013
1014 skb = netdev_alloc_skb(dev, pkt_len + 5);
1015
1016 pr_debug(" Receiving packet size %d status %4.4x.\n",
1017 pkt_len, rx_status);
1018 if (skb != NULL) {
1019 skb_reserve(skb, 2);
1020 insl(ioaddr+RX_FIFO, skb_put(skb, pkt_len),
1021 ((pkt_len+3)>>2));
1022 skb->protocol = eth_type_trans(skb, dev);
1023 netif_rx(skb);
1024 dev->stats.rx_packets++;
1025 dev->stats.rx_bytes += pkt_len;
1026 } else {
1027 pr_debug("%s: couldn't allocate a sk_buff of"
1028 " size %d.\n", dev->name, pkt_len);
1029 dev->stats.rx_dropped++;
1030 }
1031 }
1032 tc574_wait_for_completion(dev, RxDiscard);
1033 }
1034
1035 return worklimit;
1036}
1037
1038/* Provide ioctl() calls to examine the MII xcvr state. */
1039static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd)
1040{
1041 struct el3_private *lp = netdev_priv(dev);
1042 unsigned int ioaddr = dev->base_addr;
1043 struct mii_ioctl_data *data = if_mii(rq);
1044 int phy = lp->phys & 0x1f;
1045
1046 pr_debug("%s: In ioct(%-.6s, %#4.4x) %4.4x %4.4x %4.4x %4.4x.\n",
1047 dev->name, rq->ifr_ifrn.ifrn_name, cmd,
1048 data->phy_id, data->reg_num, data->val_in, data->val_out);
1049
1050 switch(cmd) {
1051 case SIOCGMIIPHY: /* Get the address of the PHY in use. */
1052 data->phy_id = phy;
1053 case SIOCGMIIREG: /* Read the specified MII register. */
1054 {
1055 int saved_window;
1056 unsigned long flags;
1057
1058 spin_lock_irqsave(&lp->window_lock, flags);
1059 saved_window = inw(ioaddr + EL3_CMD) >> 13;
1060 EL3WINDOW(4);
1061 data->val_out = mdio_read(ioaddr, data->phy_id & 0x1f,
1062 data->reg_num & 0x1f);
1063 EL3WINDOW(saved_window);
1064 spin_unlock_irqrestore(&lp->window_lock, flags);
1065 return 0;
1066 }
1067 case SIOCSMIIREG: /* Write the specified MII register */
1068 {
1069 int saved_window;
1070 unsigned long flags;
1071
1072 spin_lock_irqsave(&lp->window_lock, flags);
1073 saved_window = inw(ioaddr + EL3_CMD) >> 13;
1074 EL3WINDOW(4);
1075 mdio_write(ioaddr, data->phy_id & 0x1f,
1076 data->reg_num & 0x1f, data->val_in);
1077 EL3WINDOW(saved_window);
1078 spin_unlock_irqrestore(&lp->window_lock, flags);
1079 return 0;
1080 }
1081 default:
1082 return -EOPNOTSUPP;
1083 }
1084}
1085
1086/* The Odie chip has a 64 bin multicast filter, but the bit layout is not
1087 documented. Until it is we revert to receiving all multicast frames when
1088 any multicast reception is desired.
1089 Note: My other drivers emit a log message whenever promiscuous mode is
1090 entered to help detect password sniffers. This is less desirable on
1091 typical PC card machines, so we omit the message.
1092 */
1093
1094static void set_rx_mode(struct net_device *dev)
1095{
1096 unsigned int ioaddr = dev->base_addr;
1097
1098 if (dev->flags & IFF_PROMISC)
1099 outw(SetRxFilter | RxStation | RxMulticast | RxBroadcast | RxProm,
1100 ioaddr + EL3_CMD);
1101 else if (!netdev_mc_empty(dev) || (dev->flags & IFF_ALLMULTI))
1102 outw(SetRxFilter|RxStation|RxMulticast|RxBroadcast, ioaddr + EL3_CMD);
1103 else
1104 outw(SetRxFilter | RxStation | RxBroadcast, ioaddr + EL3_CMD);
1105}
1106
1107static void set_multicast_list(struct net_device *dev)
1108{
1109 struct el3_private *lp = netdev_priv(dev);
1110 unsigned long flags;
1111
1112 spin_lock_irqsave(&lp->window_lock, flags);
1113 set_rx_mode(dev);
1114 spin_unlock_irqrestore(&lp->window_lock, flags);
1115}
1116
1117static int el3_close(struct net_device *dev)
1118{
1119 unsigned int ioaddr = dev->base_addr;
1120 struct el3_private *lp = netdev_priv(dev);
1121 struct pcmcia_device *link = lp->p_dev;
1122
1123 dev_dbg(&link->dev, "%s: shutting down ethercard.\n", dev->name);
1124
1125 if (pcmcia_dev_present(link)) {
1126 unsigned long flags;
1127
1128 /* Turn off statistics ASAP. We update lp->stats below. */
1129 outw(StatsDisable, ioaddr + EL3_CMD);
1130
1131 /* Disable the receiver and transmitter. */
1132 outw(RxDisable, ioaddr + EL3_CMD);
1133 outw(TxDisable, ioaddr + EL3_CMD);
1134
1135 /* Note: Switching to window 0 may disable the IRQ. */
1136 EL3WINDOW(0);
1137 spin_lock_irqsave(&lp->window_lock, flags);
1138 update_stats(dev);
1139 spin_unlock_irqrestore(&lp->window_lock, flags);
1140
1141 /* force interrupts off */
1142 outw(SetIntrEnb | 0x0000, ioaddr + EL3_CMD);
1143 }
1144
1145 link->open--;
1146 netif_stop_queue(dev);
1147 del_timer_sync(&lp->media);
1148
1149 return 0;
1150}
1151
1152static const struct pcmcia_device_id tc574_ids[] = {
1153 PCMCIA_DEVICE_MANF_CARD(0x0101, 0x0574),
1154 PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x0556, "cis/3CCFEM556.cis"),
1155 PCMCIA_DEVICE_NULL,
1156};
1157MODULE_DEVICE_TABLE(pcmcia, tc574_ids);
1158
1159static struct pcmcia_driver tc574_driver = {
1160 .owner = THIS_MODULE,
1161 .name = "3c574_cs",
1162 .probe = tc574_probe,
1163 .remove = tc574_detach,
1164 .id_table = tc574_ids,
1165 .suspend = tc574_suspend,
1166 .resume = tc574_resume,
1167};
1168
1169static int __init init_tc574(void)
1170{
1171 return pcmcia_register_driver(&tc574_driver);
1172}
1173
1174static void __exit exit_tc574(void)
1175{
1176 pcmcia_unregister_driver(&tc574_driver);
1177}
1178
1179module_init(init_tc574);
1180module_exit(exit_tc574);