drivers/net/pcmcia/3c589_cs.c

   1 /*======================================================================
   2
   3     A PCMCIA ethernet driver for the 3com 3c589 card.
   4
   5     Copyright (C) 1999 David A. Hinds -- dahinds@users.sourceforge.net
   6
   7     3c589_cs.c 1.162 2001/10/13 00:08:50
   8
   9     The network driver code is based on Donald Becker's 3c589 code:
  10
  11     Written 1994 by Donald Becker.
  12     Copyright 1993 United States Government as represented by the
  13     Director, National Security Agency.  This software may be used and
  14     distributed according to the terms of the GNU General Public License,
  15     incorporated herein by reference.
  16     Donald Becker may be reached at becker@scyld.com
  17
  18     Updated for 2.5.x by Alan Cox <alan@lxorguk.ukuu.org.uk>
  19
  20 ======================================================================*/
  21
  22 #define DRV_NAME        "3c589_cs"
  23 #define DRV_VERSION     "1.162-ac"
  24
  25 #include <linux/module.h>
  26 #include <linux/init.h>
  27 #include <linux/kernel.h>
  28 #include <linux/ptrace.h>
  29 #include <linux/slab.h>
  30 #include <linux/string.h>
  31 #include <linux/timer.h>
  32 #include <linux/interrupt.h>
  33 #include <linux/in.h>
  34 #include <linux/delay.h>
  35 #include <linux/ethtool.h>
  36 #include <linux/netdevice.h>
  37 #include <linux/etherdevice.h>
  38 #include <linux/skbuff.h>
  39 #include <linux/if_arp.h>
  40 #include <linux/ioport.h>
  41 #include <linux/bitops.h>
  42 #include <linux/jiffies.h>
  43
  44 #include <pcmcia/cs_types.h>
  45 #include <pcmcia/cs.h>
  46 #include <pcmcia/cistpl.h>
  47 #include <pcmcia/cisreg.h>
  48 #include <pcmcia/ciscode.h>
  49 #include <pcmcia/ds.h>
  50
  51 #include <asm/uaccess.h>
  52 #include <asm/io.h>
  53 #include <asm/system.h>
  54
  55 /* To minimize the size of the driver source I only define operating
  56    constants if they are used several times.  You'll need the manual
  57    if you want to understand driver details. */
  58 /* Offsets from base I/O address. */
  59 #define EL3_DATA        0x00
  60 #define EL3_TIMER       0x0a
  61 #define EL3_CMD         0x0e
  62 #define EL3_STATUS      0x0e
  63
  64 #define EEPROM_READ     0x0080
  65 #define EEPROM_BUSY     0x8000
  66
  67 #define EL3WINDOW(win_num) outw(SelectWindow + (win_num), ioaddr + EL3_CMD)
  68
  69 /* The top five bits written to EL3_CMD are a command, the lower
  70    11 bits are the parameter, if applicable. */
  71 enum c509cmd {
  72     TotalReset = 0<<11, SelectWindow = 1<<11, StartCoax = 2<<11,
  73     RxDisable = 3<<11, RxEnable = 4<<11, RxReset = 5<<11, RxDiscard = 8<<11,
  74     TxEnable = 9<<11, TxDisable = 10<<11, TxReset = 11<<11,
  75     FakeIntr = 12<<11, AckIntr = 13<<11, SetIntrEnb = 14<<11,
  76     SetStatusEnb = 15<<11, SetRxFilter = 16<<11, SetRxThreshold = 17<<11,
  77     SetTxThreshold = 18<<11, SetTxStart = 19<<11, StatsEnable = 21<<11,
  78     StatsDisable = 22<<11, StopCoax = 23<<11,
  79 };
  80
  81 enum c509status {
  82     IntLatch = 0x0001, AdapterFailure = 0x0002, TxComplete = 0x0004,
  83     TxAvailable = 0x0008, RxComplete = 0x0010, RxEarly = 0x0020,
  84     IntReq = 0x0040, StatsFull = 0x0080, CmdBusy = 0x1000
  85 };
  86
  87 /* The SetRxFilter command accepts the following classes: */
  88 enum RxFilter {
  89     RxStation = 1, RxMulticast = 2, RxBroadcast = 4, RxProm = 8
  90 };
  91
  92 /* Register window 1 offsets, the window used in normal operation. */
  93 #define TX_FIFO         0x00
  94 #define RX_FIFO         0x00
  95 #define RX_STATUS       0x08
  96 #define TX_STATUS       0x0B
  97 #define TX_FREE         0x0C    /* Remaining free bytes in Tx buffer. */
  98
  99 #define WN0_IRQ         0x08    /* Window 0: Set IRQ line in bits 12-15. */
 100 #define WN4_MEDIA       0x0A    /* Window 4: Various transcvr/media bits. */
 101 #define MEDIA_TP        0x00C0  /* Enable link beat and jabber for 10baseT. */
 102 #define MEDIA_LED       0x0001  /* Enable link light on 3C589E cards. */
 103
 104 /* Time in jiffies before concluding Tx hung */
 105 #define TX_TIMEOUT      ((400*HZ)/1000)
 106
 107 struct el3_private {
 108         struct pcmcia_device    *p_dev;
 109     dev_node_t          node;
 110     /* For transceiver monitoring */
 111     struct timer_list   media;
 112     u16                 media_status;
 113     u16                 fast_poll;
 114     unsigned long       last_irq;
 115     spinlock_t          lock;
 116 };
 117
 118 static const char *if_names[] = { "auto", "10baseT", "10base2", "AUI" };
 119
 120 /*====================================================================*/
 121
 122 /* Module parameters */
 123
 124 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
 125 MODULE_DESCRIPTION("3Com 3c589 series PCMCIA ethernet driver");
 126 MODULE_LICENSE("GPL");
 127
 128 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)
 129
 130 /* Special hook for setting if_port when module is loaded */
 131 INT_MODULE_PARM(if_port, 0);
 132
 133 #ifdef PCMCIA_DEBUG
 134 INT_MODULE_PARM(pc_debug, PCMCIA_DEBUG);
 135 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
 136 static char *version =
 137 DRV_NAME ".c " DRV_VERSION " 2001/10/13 00:08:50 (David Hinds)";
 138 #else
 139 #define DEBUG(n, args...)
 140 #endif
 141
 142 /*====================================================================*/
 143
 144 static int tc589_config(struct pcmcia_device *link);
 145 static void tc589_release(struct pcmcia_device *link);
 146
 147 static u16 read_eeprom(unsigned int ioaddr, int index);
 148 static void tc589_reset(struct net_device *dev);
 149 static void media_check(unsigned long arg);
 150 static int el3_config(struct net_device *dev, struct ifmap *map);
 151 static int el3_open(struct net_device *dev);
 152 static int el3_start_xmit(struct sk_buff *skb, struct net_device *dev);
 153 static irqreturn_t el3_interrupt(int irq, void *dev_id);
 154 static void update_stats(struct net_device *dev);
 155 static struct net_device_stats *el3_get_stats(struct net_device *dev);
 156 static int el3_rx(struct net_device *dev);
 157 static int el3_close(struct net_device *dev);
 158 static void el3_tx_timeout(struct net_device *dev);
 159 static void set_multicast_list(struct net_device *dev);
 160 static const struct ethtool_ops netdev_ethtool_ops;
 161
 162 static void tc589_detach(struct pcmcia_device *p_dev);
 163
 164 /*======================================================================
 165
 166     tc589_attach() creates an "instance" of the driver, allocating
 167     local data structures for one device.  The device is registered
 168     with Card Services.
 169
 170 ======================================================================*/
 171
 172 static int tc589_probe(struct pcmcia_device *link)
 173 {
 174     struct el3_private *lp;
 175     struct net_device *dev;
 176
 177     DEBUG(0, "3c589_attach()\n");
 178
 179     /* Create new ethernet device */
 180     dev = alloc_etherdev(sizeof(struct el3_private));
 181     if (!dev)
 182          return -ENOMEM;
 183     lp = netdev_priv(dev);
 184     link->priv = dev;
 185     lp->p_dev = link;
 186
 187     spin_lock_init(&lp->lock);
 188     link->io.NumPorts1 = 16;
 189     link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 190     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_HANDLE_PRESENT;
 191     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
 192     link->irq.Handler = &el3_interrupt;
 193     link->irq.Instance = dev;
 194     link->conf.Attributes = CONF_ENABLE_IRQ;
 195     link->conf.IntType = INT_MEMORY_AND_IO;
 196     link->conf.ConfigIndex = 1;
 197
 198     /* The EL3-specific entries in the device structure. */
 199     dev->hard_start_xmit = &el3_start_xmit;
 200     dev->set_config = &el3_config;
 201     dev->get_stats = &el3_get_stats;
 202     dev->set_multicast_list = &set_multicast_list;
 203     dev->open = &el3_open;
 204     dev->stop = &el3_close;
 205 #ifdef HAVE_TX_TIMEOUT
 206     dev->tx_timeout = el3_tx_timeout;
 207     dev->watchdog_timeo = TX_TIMEOUT;
 208 #endif
 209     SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
 210
 211     return tc589_config(link);
 212 } /* tc589_attach */
 213
 214 /*======================================================================
 215
 216     This deletes a driver "instance".  The device is de-registered
 217     with Card Services.  If it has been released, all local data
 218     structures are freed.  Otherwise, the structures will be freed
 219     when the device is released.
 220
 221 ======================================================================*/
 222
 223 static void tc589_detach(struct pcmcia_device *link)
 224 {
 225     struct net_device *dev = link->priv;
 226
 227     DEBUG(0, "3c589_detach(0x%p)\n", link);
 228
 229     if (link->dev_node)
 230         unregister_netdev(dev);
 231
 232     tc589_release(link);
 233
 234     free_netdev(dev);
 235 } /* tc589_detach */
 236
 237 /*======================================================================
 238
 239     tc589_config() is scheduled to run after a CARD_INSERTION event
 240     is received, to configure the PCMCIA socket, and to make the
 241     ethernet device available to the system.
 242
 243 ======================================================================*/
 244
 245 #define CS_CHECK(fn, ret) \
 246 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
 247
 248 static int tc589_config(struct pcmcia_device *link)
 249 {
 250     struct net_device *dev = link->priv;
 251     struct el3_private *lp = netdev_priv(dev);
 252     tuple_t tuple;
 253     __le16 buf[32];
 254     __be16 *phys_addr;
 255     int last_fn, last_ret, i, j, multi = 0, fifo;
 256     unsigned int ioaddr;
 257     char *ram_split[] = {"5:3", "3:1", "1:1", "3:5"};
 258     DECLARE_MAC_BUF(mac);
 259
 260     DEBUG(0, "3c589_config(0x%p)\n", link);
 261
 262     phys_addr = (__be16 *)dev->dev_addr;
 263     tuple.Attributes = 0;
 264     tuple.TupleData = (cisdata_t *)buf;
 265     tuple.TupleDataMax = sizeof(buf);
 266     tuple.TupleOffset = 0;
 267     tuple.Attributes = TUPLE_RETURN_COMMON;
 268
 269     /* Is this a 3c562? */
 270     if (link->manf_id != MANFID_3COM)
 271             printk(KERN_INFO "3c589_cs: hmmm, is this really a "
 272                    "3Com card??\n");
 273     multi = (link->card_id == PRODID_3COM_3C562);
 274
 275     /* For the 3c562, the base address must be xx00-xx7f */
 276     link->io.IOAddrLines = 16;
 277     for (i = j = 0; j < 0x400; j += 0x10) {
 278         if (multi && (j & 0x80)) continue;
 279         link->io.BasePort1 = j ^ 0x300;
 280         i = pcmcia_request_io(link, &link->io);
 281         if (i == 0)
 282                 break;
 283     }
 284     if (i != 0) {
 285         cs_error(link, RequestIO, i);
 286         goto failed;
 287     }
 288     CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
 289     CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
 290
 291     dev->irq = link->irq.AssignedIRQ;
 292     dev->base_addr = link->io.BasePort1;
 293     ioaddr = dev->base_addr;
 294     EL3WINDOW(0);
 295
 296     /* The 3c589 has an extra EEPROM for configuration info, including
 297        the hardware address.  The 3c562 puts the address in the CIS. */
 298     tuple.DesiredTuple = 0x88;
 299     if (pcmcia_get_first_tuple(link, &tuple) == 0) {
 300         pcmcia_get_tuple_data(link, &tuple);
 301         for (i = 0; i < 3; i++)
 302             phys_addr[i] = htons(le16_to_cpu(buf[i]));
 303     } else {
 304         for (i = 0; i < 3; i++)
 305             phys_addr[i] = htons(read_eeprom(ioaddr, i));
 306         if (phys_addr[0] == htons(0x6060)) {
 307             printk(KERN_ERR "3c589_cs: IO port conflict at 0x%03lx"
 308                    "-0x%03lx\n", dev->base_addr, dev->base_addr+15);
 309             goto failed;
 310         }
 311     }
 312
 313     /* The address and resource configuration register aren't loaded from
 314        the EEPROM and *must* be set to 0 and IRQ3 for the PCMCIA version. */
 315     outw(0x3f00, ioaddr + 8);
 316     fifo = inl(ioaddr);
 317
 318     /* The if_port symbol can be set when the module is loaded */
 319     if ((if_port >= 0) && (if_port <= 3))
 320         dev->if_port = if_port;
 321     else
 322         printk(KERN_ERR "3c589_cs: invalid if_port requested\n");
 323
 324     link->dev_node = &lp->node;
 325     SET_NETDEV_DEV(dev, &handle_to_dev(link));
 326
 327     if (register_netdev(dev) != 0) {
 328         printk(KERN_ERR "3c589_cs: register_netdev() failed\n");
 329         link->dev_node = NULL;
 330         goto failed;
 331     }
 332
 333     strcpy(lp->node.dev_name, dev->name);
 334
 335     printk(KERN_INFO "%s: 3Com 3c%s, io %#3lx, irq %d, "
 336            "hw_addr %s\n",
 337            dev->name, (multi ? "562" : "589"), dev->base_addr, dev->irq,
 338            print_mac(mac, dev->dev_addr));
 339     printk(KERN_INFO "  %dK FIFO split %s Rx:Tx, %s xcvr\n",
 340            (fifo & 7) ? 32 : 8, ram_split[(fifo >> 16) & 3],
 341            if_names[dev->if_port]);
 342     return 0;
 343
 344 cs_failed:
 345     cs_error(link, last_fn, last_ret);
 346 failed:
 347     tc589_release(link);
 348     return -ENODEV;
 349 } /* tc589_config */
 350
 351 /*======================================================================
 352
 353     After a card is removed, tc589_release() will unregister the net
 354     device, and release the PCMCIA configuration.  If the device is
 355     still open, this will be postponed until it is closed.
 356
 357 ======================================================================*/
 358
 359 static void tc589_release(struct pcmcia_device *link)
 360 {
 361         pcmcia_disable_device(link);
 362 }
 363
 364 static int tc589_suspend(struct pcmcia_device *link)
 365 {
 366         struct net_device *dev = link->priv;
 367
 368         if (link->open)
 369                 netif_device_detach(dev);
 370
 371         return 0;
 372 }
 373
 374 static int tc589_resume(struct pcmcia_device *link)
 375 {
 376         struct net_device *dev = link->priv;
 377
 378         if (link->open) {
 379                 tc589_reset(dev);
 380                 netif_device_attach(dev);
 381         }
 382
 383         return 0;
 384 }
 385
 386 /*====================================================================*/
 387
 388 /*
 389   Use this for commands that may take time to finish
 390 */
 391 static void tc589_wait_for_completion(struct net_device *dev, int cmd)
 392 {
 393     int i = 100;
 394     outw(cmd, dev->base_addr + EL3_CMD);
 395     while (--i > 0)
 396         if (!(inw(dev->base_addr + EL3_STATUS) & 0x1000)) break;
 397     if (i == 0)
 398         printk(KERN_WARNING "%s: command 0x%04x did not complete!\n",
 399                dev->name, cmd);
 400 }
 401
 402 /*
 403   Read a word from the EEPROM using the regular EEPROM access register.
 404   Assume that we are in register window zero.
 405 */
 406 static u16 read_eeprom(unsigned int ioaddr, int index)
 407 {
 408     int i;
 409     outw(EEPROM_READ + index, ioaddr + 10);
 410     /* Reading the eeprom takes 162 us */
 411     for (i = 1620; i >= 0; i--)
 412         if ((inw(ioaddr + 10) & EEPROM_BUSY) == 0)
 413             break;
 414     return inw(ioaddr + 12);
 415 }
 416
 417 /*
 418   Set transceiver type, perhaps to something other than what the user
 419   specified in dev->if_port.
 420 */
 421 static void tc589_set_xcvr(struct net_device *dev, int if_port)
 422 {
 423     struct el3_private *lp = netdev_priv(dev);
 424     unsigned int ioaddr = dev->base_addr;
 425
 426     EL3WINDOW(0);
 427     switch (if_port) {
 428     case 0: case 1: outw(0, ioaddr + 6); break;
 429     case 2: outw(3<<14, ioaddr + 6); break;
 430     case 3: outw(1<<14, ioaddr + 6); break;
 431     }
 432     /* On PCMCIA, this just turns on the LED */
 433     outw((if_port == 2) ? StartCoax : StopCoax, ioaddr + EL3_CMD);
 434     /* 10baseT interface, enable link beat and jabber check. */
 435     EL3WINDOW(4);
 436     outw(MEDIA_LED | ((if_port < 2) ? MEDIA_TP : 0), ioaddr + WN4_MEDIA);
 437     EL3WINDOW(1);
 438     if (if_port == 2)
 439         lp->media_status = ((dev->if_port == 0) ? 0x8000 : 0x4000);
 440     else
 441         lp->media_status = ((dev->if_port == 0) ? 0x4010 : 0x8800);
 442 }
 443
 444 static void dump_status(struct net_device *dev)
 445 {
 446     unsigned int ioaddr = dev->base_addr;
 447     EL3WINDOW(1);
 448     printk(KERN_INFO "  irq status %04x, rx status %04x, tx status "
 449            "%02x  tx free %04x\n", inw(ioaddr+EL3_STATUS),
 450            inw(ioaddr+RX_STATUS), inb(ioaddr+TX_STATUS),
 451            inw(ioaddr+TX_FREE));
 452     EL3WINDOW(4);
 453     printk(KERN_INFO "  diagnostics: fifo %04x net %04x ethernet %04x"
 454            " media %04x\n", inw(ioaddr+0x04), inw(ioaddr+0x06),
 455            inw(ioaddr+0x08), inw(ioaddr+0x0a));
 456     EL3WINDOW(1);
 457 }
 458
 459 /* Reset and restore all of the 3c589 registers. */
 460 static void tc589_reset(struct net_device *dev)
 461 {
 462     unsigned int ioaddr = dev->base_addr;
 463     int i;
 464
 465     EL3WINDOW(0);
 466     outw(0x0001, ioaddr + 4);                   /* Activate board. */
 467     outw(0x3f00, ioaddr + 8);                   /* Set the IRQ line. */
 468
 469     /* Set the station address in window 2. */
 470     EL3WINDOW(2);
 471     for (i = 0; i < 6; i++)
 472         outb(dev->dev_addr[i], ioaddr + i);
 473
 474     tc589_set_xcvr(dev, dev->if_port);
 475
 476     /* Switch to the stats window, and clear all stats by reading. */
 477     outw(StatsDisable, ioaddr + EL3_CMD);
 478     EL3WINDOW(6);
 479     for (i = 0; i < 9; i++)
 480         inb(ioaddr+i);
 481     inw(ioaddr + 10);
 482     inw(ioaddr + 12);
 483
 484     /* Switch to register set 1 for normal use. */
 485     EL3WINDOW(1);
 486
 487     /* Accept b-cast and phys addr only. */
 488     outw(SetRxFilter | RxStation | RxBroadcast, ioaddr + EL3_CMD);
 489     outw(StatsEnable, ioaddr + EL3_CMD); /* Turn on statistics. */
 490     outw(RxEnable, ioaddr + EL3_CMD); /* Enable the receiver. */
 491     outw(TxEnable, ioaddr + EL3_CMD); /* Enable transmitter. */
 492     /* Allow status bits to be seen. */
 493     outw(SetStatusEnb | 0xff, ioaddr + EL3_CMD);
 494     /* Ack all pending events, and set active indicator mask. */
 495     outw(AckIntr | IntLatch | TxAvailable | RxEarly | IntReq,
 496          ioaddr + EL3_CMD);
 497     outw(SetIntrEnb | IntLatch | TxAvailable | RxComplete | StatsFull
 498          | AdapterFailure, ioaddr + EL3_CMD);
 499 }
 500
 501 static void netdev_get_drvinfo(struct net_device *dev,
 502                                struct ethtool_drvinfo *info)
 503 {
 504         strcpy(info->driver, DRV_NAME);
 505         strcpy(info->version, DRV_VERSION);
 506         sprintf(info->bus_info, "PCMCIA 0x%lx", dev->base_addr);
 507 }
 508
 509 #ifdef PCMCIA_DEBUG
 510 static u32 netdev_get_msglevel(struct net_device *dev)
 511 {
 512         return pc_debug;
 513 }
 514
 515 static void netdev_set_msglevel(struct net_device *dev, u32 level)
 516 {
 517         pc_debug = level;
 518 }
 519 #endif /* PCMCIA_DEBUG */
 520
 521 static const struct ethtool_ops netdev_ethtool_ops = {
 522         .get_drvinfo            = netdev_get_drvinfo,
 523 #ifdef PCMCIA_DEBUG
 524         .get_msglevel           = netdev_get_msglevel,
 525         .set_msglevel           = netdev_set_msglevel,
 526 #endif /* PCMCIA_DEBUG */
 527 };
 528
 529 static int el3_config(struct net_device *dev, struct ifmap *map)
 530 {
 531     if ((map->port != (u_char)(-1)) && (map->port != dev->if_port)) {
 532         if (map->port <= 3) {
 533             dev->if_port = map->port;
 534             printk(KERN_INFO "%s: switched to %s port\n",
 535                    dev->name, if_names[dev->if_port]);
 536             tc589_set_xcvr(dev, dev->if_port);
 537         } else
 538             return -EINVAL;
 539     }
 540     return 0;
 541 }
 542
 543 static int el3_open(struct net_device *dev)
 544 {
 545     struct el3_private *lp = netdev_priv(dev);
 546     struct pcmcia_device *link = lp->p_dev;
 547
 548     if (!pcmcia_dev_present(link))
 549         return -ENODEV;
 550
 551     link->open++;
 552     netif_start_queue(dev);
 553
 554     tc589_reset(dev);
 555     init_timer(&lp->media);
 556     lp->media.function = &media_check;
 557     lp->media.data = (unsigned long) dev;
 558     lp->media.expires = jiffies + HZ;
 559     add_timer(&lp->media);
 560
 561     DEBUG(1, "%s: opened, status %4.4x.\n",
 562           dev->name, inw(dev->base_addr + EL3_STATUS));
 563
 564     return 0;
 565 }
 566
 567 static void el3_tx_timeout(struct net_device *dev)
 568 {
 569     unsigned int ioaddr = dev->base_addr;
 570
 571     printk(KERN_WARNING "%s: Transmit timed out!\n", dev->name);
 572     dump_status(dev);
 573     dev->stats.tx_errors++;
 574     dev->trans_start = jiffies;
 575     /* Issue TX_RESET and TX_START commands. */
 576     tc589_wait_for_completion(dev, TxReset);
 577     outw(TxEnable, ioaddr + EL3_CMD);
 578     netif_wake_queue(dev);
 579 }
 580
 581 static void pop_tx_status(struct net_device *dev)
 582 {
 583     unsigned int ioaddr = dev->base_addr;
 584     int i;
 585
 586     /* Clear the Tx status stack. */
 587     for (i = 32; i > 0; i--) {
 588         u_char tx_status = inb(ioaddr + TX_STATUS);
 589         if (!(tx_status & 0x84)) break;
 590         /* reset transmitter on jabber error or underrun */
 591         if (tx_status & 0x30)
 592             tc589_wait_for_completion(dev, TxReset);
 593         if (tx_status & 0x38) {
 594             DEBUG(1, "%s: transmit error: status 0x%02x\n",
 595                   dev->name, tx_status);
 596             outw(TxEnable, ioaddr + EL3_CMD);
 597             dev->stats.tx_aborted_errors++;
 598         }
 599         outb(0x00, ioaddr + TX_STATUS); /* Pop the status stack. */
 600     }
 601 }
 602
 603 static int el3_start_xmit(struct sk_buff *skb, struct net_device *dev)
 604 {
 605     unsigned int ioaddr = dev->base_addr;
 606     struct el3_private *priv = netdev_priv(dev);
 607     unsigned long flags;
 608
 609     DEBUG(3, "%s: el3_start_xmit(length = %ld) called, "
 610           "status %4.4x.\n", dev->name, (long)skb->len,
 611           inw(ioaddr + EL3_STATUS));
 612
 613     spin_lock_irqsave(&priv->lock, flags);
 614
 615     dev->stats.tx_bytes += skb->len;
 616
 617     /* Put out the doubleword header... */
 618     outw(skb->len, ioaddr + TX_FIFO);
 619     outw(0x00, ioaddr + TX_FIFO);
 620     /* ... and the packet rounded to a doubleword. */
 621     outsl(ioaddr + TX_FIFO, skb->data, (skb->len + 3) >> 2);
 622
 623     dev->trans_start = jiffies;
 624     if (inw(ioaddr + TX_FREE) <= 1536) {
 625         netif_stop_queue(dev);
 626         /* Interrupt us when the FIFO has room for max-sized packet. */
 627         outw(SetTxThreshold + 1536, ioaddr + EL3_CMD);
 628     }
 629
 630     pop_tx_status(dev);
 631     spin_unlock_irqrestore(&priv->lock, flags);
 632     dev_kfree_skb(skb);
 633
 634     return 0;
 635 }
 636
 637 /* The EL3 interrupt handler. */
 638 static irqreturn_t el3_interrupt(int irq, void *dev_id)
 639 {
 640     struct net_device *dev = (struct net_device *) dev_id;
 641     struct el3_private *lp = netdev_priv(dev);
 642     unsigned int ioaddr;
 643     __u16 status;
 644     int i = 0, handled = 1;
 645
 646     if (!netif_device_present(dev))
 647         return IRQ_NONE;
 648
 649     ioaddr = dev->base_addr;
 650
 651     DEBUG(3, "%s: interrupt, status %4.4x.\n",
 652           dev->name, inw(ioaddr + EL3_STATUS));
 653
 654     spin_lock(&lp->lock);
 655     while ((status = inw(ioaddr + EL3_STATUS)) &
 656         (IntLatch | RxComplete | StatsFull)) {
 657         if ((status & 0xe000) != 0x2000) {
 658             DEBUG(1, "%s: interrupt from dead card\n", dev->name);
 659             handled = 0;
 660             break;
 661         }
 662
 663         if (status & RxComplete)
 664             el3_rx(dev);
 665
 666         if (status & TxAvailable) {
 667             DEBUG(3, "    TX room bit was handled.\n");
 668             /* There's room in the FIFO for a full-sized packet. */
 669             outw(AckIntr | TxAvailable, ioaddr + EL3_CMD);
 670             netif_wake_queue(dev);
 671         }
 672
 673         if (status & TxComplete)
 674             pop_tx_status(dev);
 675
 676         if (status & (AdapterFailure | RxEarly | StatsFull)) {
 677             /* Handle all uncommon interrupts. */
 678             if (status & StatsFull)             /* Empty statistics. */
 679                 update_stats(dev);
 680             if (status & RxEarly) {             /* Rx early is unused. */
 681                 el3_rx(dev);
 682                 outw(AckIntr | RxEarly, ioaddr + EL3_CMD);
 683             }
 684             if (status & AdapterFailure) {
 685                 u16 fifo_diag;
 686                 EL3WINDOW(4);
 687                 fifo_diag = inw(ioaddr + 4);
 688                 EL3WINDOW(1);
 689                 printk(KERN_WARNING "%s: adapter failure, FIFO diagnostic"
 690                        " register %04x.\n", dev->name, fifo_diag);
 691                 if (fifo_diag & 0x0400) {
 692                     /* Tx overrun */
 693                     tc589_wait_for_completion(dev, TxReset);
 694                     outw(TxEnable, ioaddr + EL3_CMD);
 695                 }
 696                 if (fifo_diag & 0x2000) {
 697                     /* Rx underrun */
 698                     tc589_wait_for_completion(dev, RxReset);
 699                     set_multicast_list(dev);
 700                     outw(RxEnable, ioaddr + EL3_CMD);
 701                 }
 702                 outw(AckIntr | AdapterFailure, ioaddr + EL3_CMD);
 703             }
 704         }
 705
 706         if (++i > 10) {
 707             printk(KERN_ERR "%s: infinite loop in interrupt, "
 708                    "status %4.4x.\n", dev->name, status);
 709             /* Clear all interrupts */
 710             outw(AckIntr | 0xFF, ioaddr + EL3_CMD);
 711             break;
 712         }
 713         /* Acknowledge the IRQ. */
 714         outw(AckIntr | IntReq | IntLatch, ioaddr + EL3_CMD);
 715     }
 716
 717     lp->last_irq = jiffies;
 718     spin_unlock(&lp->lock);
 719     DEBUG(3, "%s: exiting interrupt, status %4.4x.\n",
 720           dev->name, inw(ioaddr + EL3_STATUS));
 721     return IRQ_RETVAL(handled);
 722 }
 723
 724 static void media_check(unsigned long arg)
 725 {
 726     struct net_device *dev = (struct net_device *)(arg);
 727     struct el3_private *lp = netdev_priv(dev);
 728     unsigned int ioaddr = dev->base_addr;
 729     u16 media, errs;
 730     unsigned long flags;
 731
 732     if (!netif_device_present(dev)) goto reschedule;
 733
 734     /* Check for pending interrupt with expired latency timer: with
 735        this, we can limp along even if the interrupt is blocked */
 736     if ((inw(ioaddr + EL3_STATUS) & IntLatch) &&
 737         (inb(ioaddr + EL3_TIMER) == 0xff)) {
 738         if (!lp->fast_poll)
 739             printk(KERN_WARNING "%s: interrupt(s) dropped!\n", dev->name);
 740         el3_interrupt(dev->irq, dev);
 741         lp->fast_poll = HZ;
 742     }
 743     if (lp->fast_poll) {
 744         lp->fast_poll--;
 745         lp->media.expires = jiffies + HZ/100;
 746         add_timer(&lp->media);
 747         return;
 748     }
 749
 750     /* lp->lock guards the EL3 window. Window should always be 1 except
 751        when the lock is held */
 752     spin_lock_irqsave(&lp->lock, flags);
 753     EL3WINDOW(4);
 754     media = inw(ioaddr+WN4_MEDIA) & 0xc810;
 755
 756     /* Ignore collisions unless we've had no irq's recently */
 757     if (time_before(jiffies, lp->last_irq + HZ)) {
 758         media &= ~0x0010;
 759     } else {
 760         /* Try harder to detect carrier errors */
 761         EL3WINDOW(6);
 762         outw(StatsDisable, ioaddr + EL3_CMD);
 763         errs = inb(ioaddr + 0);
 764         outw(StatsEnable, ioaddr + EL3_CMD);
 765         dev->stats.tx_carrier_errors += errs;
 766         if (errs || (lp->media_status & 0x0010)) media |= 0x0010;
 767     }
 768
 769     if (media != lp->media_status) {
 770         if ((media & lp->media_status & 0x8000) &&
 771             ((lp->media_status ^ media) & 0x0800))
 772             printk(KERN_INFO "%s: %s link beat\n", dev->name,
 773                    (lp->media_status & 0x0800 ? "lost" : "found"));
 774         else if ((media & lp->media_status & 0x4000) &&
 775                  ((lp->media_status ^ media) & 0x0010))
 776             printk(KERN_INFO "%s: coax cable %s\n", dev->name,
 777                    (lp->media_status & 0x0010 ? "ok" : "problem"));
 778         if (dev->if_port == 0) {
 779             if (media & 0x8000) {
 780                 if (media & 0x0800)
 781                     printk(KERN_INFO "%s: flipped to 10baseT\n",
 782                            dev->name);
 783                 else
 784                     tc589_set_xcvr(dev, 2);
 785             } else if (media & 0x4000) {
 786                 if (media & 0x0010)
 787                     tc589_set_xcvr(dev, 1);
 788                 else
 789                     printk(KERN_INFO "%s: flipped to 10base2\n",
 790                            dev->name);
 791             }
 792         }
 793         lp->media_status = media;
 794     }
 795
 796     EL3WINDOW(1);
 797     spin_unlock_irqrestore(&lp->lock, flags);
 798
 799 reschedule:
 800     lp->media.expires = jiffies + HZ;
 801     add_timer(&lp->media);
 802 }
 803
 804 static struct net_device_stats *el3_get_stats(struct net_device *dev)
 805 {
 806     struct el3_private *lp = netdev_priv(dev);
 807     unsigned long flags;
 808     struct pcmcia_device *link = lp->p_dev;
 809
 810     if (pcmcia_dev_present(link)) {
 811         spin_lock_irqsave(&lp->lock, flags);
 812         update_stats(dev);
 813         spin_unlock_irqrestore(&lp->lock, flags);
 814     }
 815     return &dev->stats;
 816 }
 817
 818 /*
 819   Update statistics.  We change to register window 6, so this should be run
 820   single-threaded if the device is active. This is expected to be a rare
 821   operation, and it's simpler for the rest of the driver to assume that
 822   window 1 is always valid rather than use a special window-state variable.
 823
 824   Caller must hold the lock for this
 825 */
 826 static void update_stats(struct net_device *dev)
 827 {
 828     unsigned int ioaddr = dev->base_addr;
 829
 830     DEBUG(2, "%s: updating the statistics.\n", dev->name);
 831     /* Turn off statistics updates while reading. */
 832     outw(StatsDisable, ioaddr + EL3_CMD);
 833     /* Switch to the stats window, and read everything. */
 834     EL3WINDOW(6);
 835     dev->stats.tx_carrier_errors        += inb(ioaddr + 0);
 836     dev->stats.tx_heartbeat_errors      += inb(ioaddr + 1);
 837     /* Multiple collisions. */          inb(ioaddr + 2);
 838     dev->stats.collisions               += inb(ioaddr + 3);
 839     dev->stats.tx_window_errors         += inb(ioaddr + 4);
 840     dev->stats.rx_fifo_errors           += inb(ioaddr + 5);
 841     dev->stats.tx_packets               += inb(ioaddr + 6);
 842     /* Rx packets   */                  inb(ioaddr + 7);
 843     /* Tx deferrals */                  inb(ioaddr + 8);
 844     /* Rx octets */                     inw(ioaddr + 10);
 845     /* Tx octets */                     inw(ioaddr + 12);
 846
 847     /* Back to window 1, and turn statistics back on. */
 848     EL3WINDOW(1);
 849     outw(StatsEnable, ioaddr + EL3_CMD);
 850 }
 851
 852 static int el3_rx(struct net_device *dev)
 853 {
 854     unsigned int ioaddr = dev->base_addr;
 855     int worklimit = 32;
 856     short rx_status;
 857
 858     DEBUG(3, "%s: in rx_packet(), status %4.4x, rx_status %4.4x.\n",
 859           dev->name, inw(ioaddr+EL3_STATUS), inw(ioaddr+RX_STATUS));
 860     while (!((rx_status = inw(ioaddr + RX_STATUS)) & 0x8000) &&
 861            (--worklimit >= 0)) {
 862         if (rx_status & 0x4000) { /* Error, update stats. */
 863             short error = rx_status & 0x3800;
 864             dev->stats.rx_errors++;
 865             switch (error) {
 866             case 0x0000:        dev->stats.rx_over_errors++; break;
 867             case 0x0800:        dev->stats.rx_length_errors++; break;
 868             case 0x1000:        dev->stats.rx_frame_errors++; break;
 869             case 0x1800:        dev->stats.rx_length_errors++; break;
 870             case 0x2000:        dev->stats.rx_frame_errors++; break;
 871             case 0x2800:        dev->stats.rx_crc_errors++; break;
 872             }
 873         } else {
 874             short pkt_len = rx_status & 0x7ff;
 875             struct sk_buff *skb;
 876
 877             skb = dev_alloc_skb(pkt_len+5);
 878
 879             DEBUG(3, "    Receiving packet size %d status %4.4x.\n",
 880                   pkt_len, rx_status);
 881             if (skb != NULL) {
 882                 skb_reserve(skb, 2);
 883                 insl(ioaddr+RX_FIFO, skb_put(skb, pkt_len),
 884                         (pkt_len+3)>>2);
 885                 skb->protocol = eth_type_trans(skb, dev);
 886                 netif_rx(skb);
 887                 dev->last_rx = jiffies;
 888                 dev->stats.rx_packets++;
 889                 dev->stats.rx_bytes += pkt_len;
 890             } else {
 891                 DEBUG(1, "%s: couldn't allocate a sk_buff of"
 892                       " size %d.\n", dev->name, pkt_len);
 893                 dev->stats.rx_dropped++;
 894             }
 895         }
 896         /* Pop the top of the Rx FIFO */
 897         tc589_wait_for_completion(dev, RxDiscard);
 898     }
 899     if (worklimit == 0)
 900         printk(KERN_WARNING "%s: too much work in el3_rx!\n", dev->name);
 901     return 0;
 902 }
 903
 904 static void set_multicast_list(struct net_device *dev)
 905 {
 906     struct el3_private *lp = netdev_priv(dev);
 907     struct pcmcia_device *link = lp->p_dev;
 908     unsigned int ioaddr = dev->base_addr;
 909     u16 opts = SetRxFilter | RxStation | RxBroadcast;
 910
 911     if (!pcmcia_dev_present(link)) return;
 912     if (dev->flags & IFF_PROMISC)
 913         opts |= RxMulticast | RxProm;
 914     else if (dev->mc_count || (dev->flags & IFF_ALLMULTI))
 915         opts |= RxMulticast;
 916     outw(opts, ioaddr + EL3_CMD);
 917 }
 918
 919 static int el3_close(struct net_device *dev)
 920 {
 921     struct el3_private *lp = netdev_priv(dev);
 922     struct pcmcia_device *link = lp->p_dev;
 923     unsigned int ioaddr = dev->base_addr;
 924
 925     DEBUG(1, "%s: shutting down ethercard.\n", dev->name);
 926
 927     if (pcmcia_dev_present(link)) {
 928         /* Turn off statistics ASAP.  We update dev->stats below. */
 929         outw(StatsDisable, ioaddr + EL3_CMD);
 930
 931         /* Disable the receiver and transmitter. */
 932         outw(RxDisable, ioaddr + EL3_CMD);
 933         outw(TxDisable, ioaddr + EL3_CMD);
 934
 935         if (dev->if_port == 2)
 936             /* Turn off thinnet power.  Green! */
 937             outw(StopCoax, ioaddr + EL3_CMD);
 938         else if (dev->if_port == 1) {
 939             /* Disable link beat and jabber */
 940             EL3WINDOW(4);
 941             outw(0, ioaddr + WN4_MEDIA);
 942         }
 943
 944         /* Switching back to window 0 disables the IRQ. */
 945         EL3WINDOW(0);
 946         /* But we explicitly zero the IRQ line select anyway. */
 947         outw(0x0f00, ioaddr + WN0_IRQ);
 948
 949         /* Check if the card still exists */
 950         if ((inw(ioaddr+EL3_STATUS) & 0xe000) == 0x2000)
 951             update_stats(dev);
 952     }
 953
 954     link->open--;
 955     netif_stop_queue(dev);
 956     del_timer_sync(&lp->media);
 957
 958     return 0;
 959 }
 960
 961 static struct pcmcia_device_id tc589_ids[] = {
 962         PCMCIA_MFC_DEVICE_MANF_CARD(0, 0x0101, 0x0562),
 963         PCMCIA_MFC_DEVICE_PROD_ID1(0, "Motorola MARQUIS", 0xf03e4e77),
 964         PCMCIA_DEVICE_MANF_CARD(0x0101, 0x0589),
 965         PCMCIA_DEVICE_PROD_ID12("Farallon", "ENet", 0x58d93fc4, 0x992c2202),
 966         PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x0035, "3CXEM556.cis"),
 967         PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x003d, "3CXEM556.cis"),
 968         PCMCIA_DEVICE_NULL,
 969 };
 970 MODULE_DEVICE_TABLE(pcmcia, tc589_ids);
 971
 972 static struct pcmcia_driver tc589_driver = {
 973         .owner          = THIS_MODULE,
 974         .drv            = {
 975                 .name   = "3c589_cs",
 976         },
 977         .probe          = tc589_probe,
 978         .remove         = tc589_detach,
 979         .id_table       = tc589_ids,
 980         .suspend        = tc589_suspend,
 981         .resume         = tc589_resume,
 982 };
 983
 984 static int __init init_tc589(void)
 985 {
 986         return pcmcia_register_driver(&tc589_driver);
 987 }
 988
 989 static void __exit exit_tc589(void)
 990 {
 991         pcmcia_unregister_driver(&tc589_driver);
 992 }
 993
 994 module_init(init_tc589);
 995 module_exit(exit_tc589);