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@redhat.com>
  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     struct net_device_stats stats;
 111     /* For transceiver monitoring */
 112     struct timer_list   media;
 113     u16                 media_status;
 114     u16                 fast_poll;
 115     unsigned long       last_irq;
 116     spinlock_t          lock;
 117 };
 118
 119 static const char *if_names[] = { "auto", "10baseT", "10base2", "AUI" };
 120
 121 /*====================================================================*/
 122
 123 /* Module parameters */
 124
 125 MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");
 126 MODULE_DESCRIPTION("3Com 3c589 series PCMCIA ethernet driver");
 127 MODULE_LICENSE("GPL");
 128
 129 #define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)
 130
 131 /* Special hook for setting if_port when module is loaded */
 132 INT_MODULE_PARM(if_port, 0);
 133
 134 #ifdef PCMCIA_DEBUG
 135 INT_MODULE_PARM(pc_debug, PCMCIA_DEBUG);
 136 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
 137 static char *version =
 138 DRV_NAME ".c " DRV_VERSION " 2001/10/13 00:08:50 (David Hinds)";
 139 #else
 140 #define DEBUG(n, args...)
 141 #endif
 142
 143 /*====================================================================*/
 144
 145 static int tc589_config(struct pcmcia_device *link);
 146 static void tc589_release(struct pcmcia_device *link);
 147
 148 static u16 read_eeprom(kio_addr_t ioaddr, int index);
 149 static void tc589_reset(struct net_device *dev);
 150 static void media_check(unsigned long arg);
 151 static int el3_config(struct net_device *dev, struct ifmap *map);
 152 static int el3_open(struct net_device *dev);
 153 static int el3_start_xmit(struct sk_buff *skb, struct net_device *dev);
 154 static irqreturn_t el3_interrupt(int irq, void *dev_id);
 155 static void update_stats(struct net_device *dev);
 156 static struct net_device_stats *el3_get_stats(struct net_device *dev);
 157 static int el3_rx(struct net_device *dev);
 158 static int el3_close(struct net_device *dev);
 159 static void el3_tx_timeout(struct net_device *dev);
 160 static void set_multicast_list(struct net_device *dev);
 161 static const struct ethtool_ops netdev_ethtool_ops;
 162
 163 static void tc589_detach(struct pcmcia_device *p_dev);
 164
 165 /*======================================================================
 166
 167     tc589_attach() creates an "instance" of the driver, allocating
 168     local data structures for one device.  The device is registered
 169     with Card Services.
 170
 171 ======================================================================*/
 172
 173 static int tc589_probe(struct pcmcia_device *link)
 174 {
 175     struct el3_private *lp;
 176     struct net_device *dev;
 177
 178     DEBUG(0, "3c589_attach()\n");
 179
 180     /* Create new ethernet device */
 181     dev = alloc_etherdev(sizeof(struct el3_private));
 182     if (!dev)
 183          return -ENOMEM;
 184     lp = netdev_priv(dev);
 185     link->priv = dev;
 186     lp->p_dev = link;
 187
 188     spin_lock_init(&lp->lock);
 189     link->io.NumPorts1 = 16;
 190     link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 191     link->irq.Attributes = IRQ_TYPE_EXCLUSIVE | IRQ_HANDLE_PRESENT;
 192     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
 193     link->irq.Handler = &el3_interrupt;
 194     link->irq.Instance = dev;
 195     link->conf.Attributes = CONF_ENABLE_IRQ;
 196     link->conf.IntType = INT_MEMORY_AND_IO;
 197     link->conf.ConfigIndex = 1;
 198     link->conf.Present = PRESENT_OPTION;
 199
 200     /* The EL3-specific entries in the device structure. */
 201     SET_MODULE_OWNER(dev);
 202     dev->hard_start_xmit = &el3_start_xmit;
 203     dev->set_config = &el3_config;
 204     dev->get_stats = &el3_get_stats;
 205     dev->set_multicast_list = &set_multicast_list;
 206     dev->open = &el3_open;
 207     dev->stop = &el3_close;
 208 #ifdef HAVE_TX_TIMEOUT
 209     dev->tx_timeout = el3_tx_timeout;
 210     dev->watchdog_timeo = TX_TIMEOUT;
 211 #endif
 212     SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
 213
 214     return tc589_config(link);
 215 } /* tc589_attach */
 216
 217 /*======================================================================
 218
 219     This deletes a driver "instance".  The device is de-registered
 220     with Card Services.  If it has been released, all local data
 221     structures are freed.  Otherwise, the structures will be freed
 222     when the device is released.
 223
 224 ======================================================================*/
 225
 226 static void tc589_detach(struct pcmcia_device *link)
 227 {
 228     struct net_device *dev = link->priv;
 229
 230     DEBUG(0, "3c589_detach(0x%p)\n", link);
 231
 232     if (link->dev_node)
 233         unregister_netdev(dev);
 234
 235     tc589_release(link);
 236
 237     free_netdev(dev);
 238 } /* tc589_detach */
 239
 240 /*======================================================================
 241
 242     tc589_config() is scheduled to run after a CARD_INSERTION event
 243     is received, to configure the PCMCIA socket, and to make the
 244     ethernet device available to the system.
 245
 246 ======================================================================*/
 247
 248 #define CS_CHECK(fn, ret) \
 249 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
 250
 251 static int tc589_config(struct pcmcia_device *link)
 252 {
 253     struct net_device *dev = link->priv;
 254     struct el3_private *lp = netdev_priv(dev);
 255     tuple_t tuple;
 256     u16 buf[32], *phys_addr;
 257     int last_fn, last_ret, i, j, multi = 0, fifo;
 258     kio_addr_t ioaddr;
 259     char *ram_split[] = {"5:3", "3:1", "1:1", "3:5"};
 260
 261     DEBUG(0, "3c589_config(0x%p)\n", link);
 262
 263     phys_addr = (u16 *)dev->dev_addr;
 264     tuple.Attributes = 0;
 265     tuple.TupleData = (cisdata_t *)buf;
 266     tuple.TupleDataMax = sizeof(buf);
 267     tuple.TupleOffset = 0;
 268     tuple.Attributes = TUPLE_RETURN_COMMON;
 269
 270     /* Is this a 3c562? */
 271     if (link->manf_id != MANFID_3COM)
 272             printk(KERN_INFO "3c589_cs: hmmm, is this really a "
 273                    "3Com card??\n");
 274     multi = (link->card_id == PRODID_3COM_3C562);
 275
 276     /* For the 3c562, the base address must be xx00-xx7f */
 277     link->io.IOAddrLines = 16;
 278     for (i = j = 0; j < 0x400; j += 0x10) {
 279         if (multi && (j & 0x80)) continue;
 280         link->io.BasePort1 = j ^ 0x300;
 281         i = pcmcia_request_io(link, &link->io);
 282         if (i == CS_SUCCESS) break;
 283     }
 284     if (i != CS_SUCCESS) {
 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) == CS_SUCCESS) {
 300         pcmcia_get_tuple_data(link, &tuple);
 301         for (i = 0; i < 3; i++)
 302             phys_addr[i] = htons(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] == 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, hw_addr ",
 336            dev->name, (multi ? "562" : "589"), dev->base_addr,
 337            dev->irq);
 338     for (i = 0; i < 6; i++)
 339         printk("%02X%s", dev->dev_addr[i], ((i<5) ? ":" : "\n"));
 340     printk(KERN_INFO "  %dK FIFO split %s Rx:Tx, %s xcvr\n",
 341            (fifo & 7) ? 32 : 8, ram_split[(fifo >> 16) & 3],
 342            if_names[dev->if_port]);
 343     return 0;
 344
 345 cs_failed:
 346     cs_error(link, last_fn, last_ret);
 347 failed:
 348     tc589_release(link);
 349     return -ENODEV;
 350 } /* tc589_config */
 351
 352 /*======================================================================
 353
 354     After a card is removed, tc589_release() will unregister the net
 355     device, and release the PCMCIA configuration.  If the device is
 356     still open, this will be postponed until it is closed.
 357
 358 ======================================================================*/
 359
 360 static void tc589_release(struct pcmcia_device *link)
 361 {
 362         pcmcia_disable_device(link);
 363 }
 364
 365 static int tc589_suspend(struct pcmcia_device *link)
 366 {
 367         struct net_device *dev = link->priv;
 368
 369         if (link->open)
 370                 netif_device_detach(dev);
 371
 372         return 0;
 373 }
 374
 375 static int tc589_resume(struct pcmcia_device *link)
 376 {
 377         struct net_device *dev = link->priv;
 378
 379         if (link->open) {
 380                 tc589_reset(dev);
 381                 netif_device_attach(dev);
 382         }
 383
 384         return 0;
 385 }
 386
 387 /*====================================================================*/
 388
 389 /*
 390   Use this for commands that may take time to finish
 391 */
 392 static void tc589_wait_for_completion(struct net_device *dev, int cmd)
 393 {
 394     int i = 100;
 395     outw(cmd, dev->base_addr + EL3_CMD);
 396     while (--i > 0)
 397         if (!(inw(dev->base_addr + EL3_STATUS) & 0x1000)) break;
 398     if (i == 0)
 399         printk(KERN_WARNING "%s: command 0x%04x did not complete!\n",
 400                dev->name, cmd);
 401 }
 402
 403 /*
 404   Read a word from the EEPROM using the regular EEPROM access register.
 405   Assume that we are in register window zero.
 406 */
 407 static u16 read_eeprom(kio_addr_t ioaddr, int index)
 408 {
 409     int i;
 410     outw(EEPROM_READ + index, ioaddr + 10);
 411     /* Reading the eeprom takes 162 us */
 412     for (i = 1620; i >= 0; i--)
 413         if ((inw(ioaddr + 10) & EEPROM_BUSY) == 0)
 414             break;
 415     return inw(ioaddr + 12);
 416 }
 417
 418 /*
 419   Set transceiver type, perhaps to something other than what the user
 420   specified in dev->if_port.
 421 */
 422 static void tc589_set_xcvr(struct net_device *dev, int if_port)
 423 {
 424     struct el3_private *lp = netdev_priv(dev);
 425     kio_addr_t ioaddr = dev->base_addr;
 426
 427     EL3WINDOW(0);
 428     switch (if_port) {
 429     case 0: case 1: outw(0, ioaddr + 6); break;
 430     case 2: outw(3<<14, ioaddr + 6); break;
 431     case 3: outw(1<<14, ioaddr + 6); break;
 432     }
 433     /* On PCMCIA, this just turns on the LED */
 434     outw((if_port == 2) ? StartCoax : StopCoax, ioaddr + EL3_CMD);
 435     /* 10baseT interface, enable link beat and jabber check. */
 436     EL3WINDOW(4);
 437     outw(MEDIA_LED | ((if_port < 2) ? MEDIA_TP : 0), ioaddr + WN4_MEDIA);
 438     EL3WINDOW(1);
 439     if (if_port == 2)
 440         lp->media_status = ((dev->if_port == 0) ? 0x8000 : 0x4000);
 441     else
 442         lp->media_status = ((dev->if_port == 0) ? 0x4010 : 0x8800);
 443 }
 444
 445 static void dump_status(struct net_device *dev)
 446 {
 447     kio_addr_t ioaddr = dev->base_addr;
 448     EL3WINDOW(1);
 449     printk(KERN_INFO "  irq status %04x, rx status %04x, tx status "
 450            "%02x  tx free %04x\n", inw(ioaddr+EL3_STATUS),
 451            inw(ioaddr+RX_STATUS), inb(ioaddr+TX_STATUS),
 452            inw(ioaddr+TX_FREE));
 453     EL3WINDOW(4);
 454     printk(KERN_INFO "  diagnostics: fifo %04x net %04x ethernet %04x"
 455            " media %04x\n", inw(ioaddr+0x04), inw(ioaddr+0x06),
 456            inw(ioaddr+0x08), inw(ioaddr+0x0a));
 457     EL3WINDOW(1);
 458 }
 459
 460 /* Reset and restore all of the 3c589 registers. */
 461 static void tc589_reset(struct net_device *dev)
 462 {
 463     kio_addr_t ioaddr = dev->base_addr;
 464     int i;
 465
 466     EL3WINDOW(0);
 467     outw(0x0001, ioaddr + 4);                   /* Activate board. */
 468     outw(0x3f00, ioaddr + 8);                   /* Set the IRQ line. */
 469
 470     /* Set the station address in window 2. */
 471     EL3WINDOW(2);
 472     for (i = 0; i < 6; i++)
 473         outb(dev->dev_addr[i], ioaddr + i);
 474
 475     tc589_set_xcvr(dev, dev->if_port);
 476
 477     /* Switch to the stats window, and clear all stats by reading. */
 478     outw(StatsDisable, ioaddr + EL3_CMD);
 479     EL3WINDOW(6);
 480     for (i = 0; i < 9; i++)
 481         inb(ioaddr+i);
 482     inw(ioaddr + 10);
 483     inw(ioaddr + 12);
 484
 485     /* Switch to register set 1 for normal use. */
 486     EL3WINDOW(1);
 487
 488     /* Accept b-cast and phys addr only. */
 489     outw(SetRxFilter | RxStation | RxBroadcast, ioaddr + EL3_CMD);
 490     outw(StatsEnable, ioaddr + EL3_CMD); /* Turn on statistics. */
 491     outw(RxEnable, ioaddr + EL3_CMD); /* Enable the receiver. */
 492     outw(TxEnable, ioaddr + EL3_CMD); /* Enable transmitter. */
 493     /* Allow status bits to be seen. */
 494     outw(SetStatusEnb | 0xff, ioaddr + EL3_CMD);
 495     /* Ack all pending events, and set active indicator mask. */
 496     outw(AckIntr | IntLatch | TxAvailable | RxEarly | IntReq,
 497          ioaddr + EL3_CMD);
 498     outw(SetIntrEnb | IntLatch | TxAvailable | RxComplete | StatsFull
 499          | AdapterFailure, ioaddr + EL3_CMD);
 500 }
 501
 502 static void netdev_get_drvinfo(struct net_device *dev,
 503                                struct ethtool_drvinfo *info)
 504 {
 505         strcpy(info->driver, DRV_NAME);
 506         strcpy(info->version, DRV_VERSION);
 507         sprintf(info->bus_info, "PCMCIA 0x%lx", dev->base_addr);
 508 }
 509
 510 #ifdef PCMCIA_DEBUG
 511 static u32 netdev_get_msglevel(struct net_device *dev)
 512 {
 513         return pc_debug;
 514 }
 515
 516 static void netdev_set_msglevel(struct net_device *dev, u32 level)
 517 {
 518         pc_debug = level;
 519 }
 520 #endif /* PCMCIA_DEBUG */
 521
 522 static const struct ethtool_ops netdev_ethtool_ops = {
 523         .get_drvinfo            = netdev_get_drvinfo,
 524 #ifdef PCMCIA_DEBUG
 525         .get_msglevel           = netdev_get_msglevel,
 526         .set_msglevel           = netdev_set_msglevel,
 527 #endif /* PCMCIA_DEBUG */
 528 };
 529
 530 static int el3_config(struct net_device *dev, struct ifmap *map)
 531 {
 532     if ((map->port != (u_char)(-1)) && (map->port != dev->if_port)) {
 533         if (map->port <= 3) {
 534             dev->if_port = map->port;
 535             printk(KERN_INFO "%s: switched to %s port\n",
 536                    dev->name, if_names[dev->if_port]);
 537             tc589_set_xcvr(dev, dev->if_port);
 538         } else
 539             return -EINVAL;
 540     }
 541     return 0;
 542 }
 543
 544 static int el3_open(struct net_device *dev)
 545 {
 546     struct el3_private *lp = netdev_priv(dev);
 547     struct pcmcia_device *link = lp->p_dev;
 548
 549     if (!pcmcia_dev_present(link))
 550         return -ENODEV;
 551
 552     link->open++;
 553     netif_start_queue(dev);
 554
 555     tc589_reset(dev);
 556     init_timer(&lp->media);
 557     lp->media.function = &media_check;
 558     lp->media.data = (unsigned long) dev;
 559     lp->media.expires = jiffies + HZ;
 560     add_timer(&lp->media);
 561
 562     DEBUG(1, "%s: opened, status %4.4x.\n",
 563           dev->name, inw(dev->base_addr + EL3_STATUS));
 564
 565     return 0;
 566 }
 567
 568 static void el3_tx_timeout(struct net_device *dev)
 569 {
 570     struct el3_private *lp = netdev_priv(dev);
 571     kio_addr_t ioaddr = dev->base_addr;
 572
 573     printk(KERN_WARNING "%s: Transmit timed out!\n", dev->name);
 574     dump_status(dev);
 575     lp->stats.tx_errors++;
 576     dev->trans_start = jiffies;
 577     /* Issue TX_RESET and TX_START commands. */
 578     tc589_wait_for_completion(dev, TxReset);
 579     outw(TxEnable, ioaddr + EL3_CMD);
 580     netif_wake_queue(dev);
 581 }
 582
 583 static void pop_tx_status(struct net_device *dev)
 584 {
 585     struct el3_private *lp = netdev_priv(dev);
 586     kio_addr_t ioaddr = dev->base_addr;
 587     int i;
 588
 589     /* Clear the Tx status stack. */
 590     for (i = 32; i > 0; i--) {
 591         u_char tx_status = inb(ioaddr + TX_STATUS);
 592         if (!(tx_status & 0x84)) break;
 593         /* reset transmitter on jabber error or underrun */
 594         if (tx_status & 0x30)
 595             tc589_wait_for_completion(dev, TxReset);
 596         if (tx_status & 0x38) {
 597             DEBUG(1, "%s: transmit error: status 0x%02x\n",
 598                   dev->name, tx_status);
 599             outw(TxEnable, ioaddr + EL3_CMD);
 600             lp->stats.tx_aborted_errors++;
 601         }
 602         outb(0x00, ioaddr + TX_STATUS); /* Pop the status stack. */
 603     }
 604 }
 605
 606 static int el3_start_xmit(struct sk_buff *skb, struct net_device *dev)
 607 {
 608     kio_addr_t ioaddr = dev->base_addr;
 609     struct el3_private *priv = netdev_priv(dev);
 610
 611     DEBUG(3, "%s: el3_start_xmit(length = %ld) called, "
 612           "status %4.4x.\n", dev->name, (long)skb->len,
 613           inw(ioaddr + EL3_STATUS));
 614
 615     priv->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     dev_kfree_skb(skb);
 631     pop_tx_status(dev);
 632
 633     return 0;
 634 }
 635
 636 /* The EL3 interrupt handler. */
 637 static irqreturn_t el3_interrupt(int irq, void *dev_id)
 638 {
 639     struct net_device *dev = (struct net_device *) dev_id;
 640     struct el3_private *lp = netdev_priv(dev);
 641     kio_addr_t ioaddr;
 642     __u16 status;
 643     int i = 0, handled = 1;
 644
 645     if (!netif_device_present(dev))
 646         return IRQ_NONE;
 647
 648     ioaddr = dev->base_addr;
 649
 650     DEBUG(3, "%s: interrupt, status %4.4x.\n",
 651           dev->name, inw(ioaddr + EL3_STATUS));
 652
 653     spin_lock(&lp->lock);
 654     while ((status = inw(ioaddr + EL3_STATUS)) &
 655         (IntLatch | RxComplete | StatsFull)) {
 656         if ((status & 0xe000) != 0x2000) {
 657             DEBUG(1, "%s: interrupt from dead card\n", dev->name);
 658             handled = 0;
 659             break;
 660         }
 661
 662         if (status & RxComplete)
 663             el3_rx(dev);
 664
 665         if (status & TxAvailable) {
 666             DEBUG(3, "    TX room bit was handled.\n");
 667             /* There's room in the FIFO for a full-sized packet. */
 668             outw(AckIntr | TxAvailable, ioaddr + EL3_CMD);
 669             netif_wake_queue(dev);
 670         }
 671
 672         if (status & TxComplete)
 673             pop_tx_status(dev);
 674
 675         if (status & (AdapterFailure | RxEarly | StatsFull)) {
 676             /* Handle all uncommon interrupts. */
 677             if (status & StatsFull)             /* Empty statistics. */
 678                 update_stats(dev);
 679             if (status & RxEarly) {             /* Rx early is unused. */
 680                 el3_rx(dev);
 681                 outw(AckIntr | RxEarly, ioaddr + EL3_CMD);
 682             }
 683             if (status & AdapterFailure) {
 684                 u16 fifo_diag;
 685                 EL3WINDOW(4);
 686                 fifo_diag = inw(ioaddr + 4);
 687                 EL3WINDOW(1);
 688                 printk(KERN_WARNING "%s: adapter failure, FIFO diagnostic"
 689                        " register %04x.\n", dev->name, fifo_diag);
 690                 if (fifo_diag & 0x0400) {
 691                     /* Tx overrun */
 692                     tc589_wait_for_completion(dev, TxReset);
 693                     outw(TxEnable, ioaddr + EL3_CMD);
 694                 }
 695                 if (fifo_diag & 0x2000) {
 696                     /* Rx underrun */
 697                     tc589_wait_for_completion(dev, RxReset);
 698                     set_multicast_list(dev);
 699                     outw(RxEnable, ioaddr + EL3_CMD);
 700                 }
 701                 outw(AckIntr | AdapterFailure, ioaddr + EL3_CMD);
 702             }
 703         }
 704
 705         if (++i > 10) {
 706             printk(KERN_ERR "%s: infinite loop in interrupt, "
 707                    "status %4.4x.\n", dev->name, status);
 708             /* Clear all interrupts */
 709             outw(AckIntr | 0xFF, ioaddr + EL3_CMD);
 710             break;
 711         }
 712         /* Acknowledge the IRQ. */
 713         outw(AckIntr | IntReq | IntLatch, ioaddr + EL3_CMD);
 714     }
 715
 716     lp->last_irq = jiffies;
 717     spin_unlock(&lp->lock);
 718     DEBUG(3, "%s: exiting interrupt, status %4.4x.\n",
 719           dev->name, inw(ioaddr + EL3_STATUS));
 720     return IRQ_RETVAL(handled);
 721 }
 722
 723 static void media_check(unsigned long arg)
 724 {
 725     struct net_device *dev = (struct net_device *)(arg);
 726     struct el3_private *lp = netdev_priv(dev);
 727     kio_addr_t ioaddr = dev->base_addr;
 728     u16 media, errs;
 729     unsigned long flags;
 730
 731     if (!netif_device_present(dev)) goto reschedule;
 732
 733     EL3WINDOW(1);
 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, lp);
 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         lp->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 &lp->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     struct el3_private *lp = netdev_priv(dev);
 829     kio_addr_t ioaddr = dev->base_addr;
 830
 831     DEBUG(2, "%s: updating the statistics.\n", dev->name);
 832     /* Turn off statistics updates while reading. */
 833     outw(StatsDisable, ioaddr + EL3_CMD);
 834     /* Switch to the stats window, and read everything. */
 835     EL3WINDOW(6);
 836     lp->stats.tx_carrier_errors         += inb(ioaddr + 0);
 837     lp->stats.tx_heartbeat_errors       += inb(ioaddr + 1);
 838     /* Multiple collisions. */          inb(ioaddr + 2);
 839     lp->stats.collisions                += inb(ioaddr + 3);
 840     lp->stats.tx_window_errors          += inb(ioaddr + 4);
 841     lp->stats.rx_fifo_errors            += inb(ioaddr + 5);
 842     lp->stats.tx_packets                += inb(ioaddr + 6);
 843     /* Rx packets   */                  inb(ioaddr + 7);
 844     /* Tx deferrals */                  inb(ioaddr + 8);
 845     /* Rx octets */                     inw(ioaddr + 10);
 846     /* Tx octets */                     inw(ioaddr + 12);
 847
 848     /* Back to window 1, and turn statistics back on. */
 849     EL3WINDOW(1);
 850     outw(StatsEnable, ioaddr + EL3_CMD);
 851 }
 852
 853 static int el3_rx(struct net_device *dev)
 854 {
 855     struct el3_private *lp = netdev_priv(dev);
 856     kio_addr_t ioaddr = dev->base_addr;
 857     int worklimit = 32;
 858     short rx_status;
 859
 860     DEBUG(3, "%s: in rx_packet(), status %4.4x, rx_status %4.4x.\n",
 861           dev->name, inw(ioaddr+EL3_STATUS), inw(ioaddr+RX_STATUS));
 862     while (!((rx_status = inw(ioaddr + RX_STATUS)) & 0x8000) &&
 863            (--worklimit >= 0)) {
 864         if (rx_status & 0x4000) { /* Error, update stats. */
 865             short error = rx_status & 0x3800;
 866             lp->stats.rx_errors++;
 867             switch (error) {
 868             case 0x0000:        lp->stats.rx_over_errors++; break;
 869             case 0x0800:        lp->stats.rx_length_errors++; break;
 870             case 0x1000:        lp->stats.rx_frame_errors++; break;
 871             case 0x1800:        lp->stats.rx_length_errors++; break;
 872             case 0x2000:        lp->stats.rx_frame_errors++; break;
 873             case 0x2800:        lp->stats.rx_crc_errors++; break;
 874             }
 875         } else {
 876             short pkt_len = rx_status & 0x7ff;
 877             struct sk_buff *skb;
 878
 879             skb = dev_alloc_skb(pkt_len+5);
 880
 881             DEBUG(3, "    Receiving packet size %d status %4.4x.\n",
 882                   pkt_len, rx_status);
 883             if (skb != NULL) {
 884                 skb->dev = dev;
 885                 skb_reserve(skb, 2);
 886                 insl(ioaddr+RX_FIFO, skb_put(skb, pkt_len),
 887                         (pkt_len+3)>>2);
 888                 skb->protocol = eth_type_trans(skb, dev);
 889                 netif_rx(skb);
 890                 dev->last_rx = jiffies;
 891                 lp->stats.rx_packets++;
 892                 lp->stats.rx_bytes += pkt_len;
 893             } else {
 894                 DEBUG(1, "%s: couldn't allocate a sk_buff of"
 895                       " size %d.\n", dev->name, pkt_len);
 896                 lp->stats.rx_dropped++;
 897             }
 898         }
 899         /* Pop the top of the Rx FIFO */
 900         tc589_wait_for_completion(dev, RxDiscard);
 901     }
 902     if (worklimit == 0)
 903         printk(KERN_WARNING "%s: too much work in el3_rx!\n", dev->name);
 904     return 0;
 905 }
 906
 907 static void set_multicast_list(struct net_device *dev)
 908 {
 909     struct el3_private *lp = netdev_priv(dev);
 910     struct pcmcia_device *link = lp->p_dev;
 911     kio_addr_t ioaddr = dev->base_addr;
 912     u16 opts = SetRxFilter | RxStation | RxBroadcast;
 913
 914     if (!pcmcia_dev_present(link)) return;
 915     if (dev->flags & IFF_PROMISC)
 916         opts |= RxMulticast | RxProm;
 917     else if (dev->mc_count || (dev->flags & IFF_ALLMULTI))
 918         opts |= RxMulticast;
 919     outw(opts, ioaddr + EL3_CMD);
 920 }
 921
 922 static int el3_close(struct net_device *dev)
 923 {
 924     struct el3_private *lp = netdev_priv(dev);
 925     struct pcmcia_device *link = lp->p_dev;
 926     kio_addr_t ioaddr = dev->base_addr;
 927
 928     DEBUG(1, "%s: shutting down ethercard.\n", dev->name);
 929
 930     if (pcmcia_dev_present(link)) {
 931         /* Turn off statistics ASAP.  We update lp->stats below. */
 932         outw(StatsDisable, ioaddr + EL3_CMD);
 933
 934         /* Disable the receiver and transmitter. */
 935         outw(RxDisable, ioaddr + EL3_CMD);
 936         outw(TxDisable, ioaddr + EL3_CMD);
 937
 938         if (dev->if_port == 2)
 939             /* Turn off thinnet power.  Green! */
 940             outw(StopCoax, ioaddr + EL3_CMD);
 941         else if (dev->if_port == 1) {
 942             /* Disable link beat and jabber */
 943             EL3WINDOW(4);
 944             outw(0, ioaddr + WN4_MEDIA);
 945         }
 946
 947         /* Switching back to window 0 disables the IRQ. */
 948         EL3WINDOW(0);
 949         /* But we explicitly zero the IRQ line select anyway. */
 950         outw(0x0f00, ioaddr + WN0_IRQ);
 951
 952         /* Check if the card still exists */
 953         if ((inw(ioaddr+EL3_STATUS) & 0xe000) == 0x2000)
 954             update_stats(dev);
 955     }
 956
 957     link->open--;
 958     netif_stop_queue(dev);
 959     del_timer_sync(&lp->media);
 960
 961     return 0;
 962 }
 963
 964 static struct pcmcia_device_id tc589_ids[] = {
 965         PCMCIA_MFC_DEVICE_MANF_CARD(0, 0x0101, 0x0562),
 966         PCMCIA_MFC_DEVICE_PROD_ID1(0, "Motorola MARQUIS", 0xf03e4e77),
 967         PCMCIA_DEVICE_MANF_CARD(0x0101, 0x0589),
 968         PCMCIA_DEVICE_PROD_ID12("Farallon", "ENet", 0x58d93fc4, 0x992c2202),
 969         PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x0035, "3CXEM556.cis"),
 970         PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x003d, "3CXEM556.cis"),
 971         PCMCIA_DEVICE_NULL,
 972 };
 973 MODULE_DEVICE_TABLE(pcmcia, tc589_ids);
 974
 975 static struct pcmcia_driver tc589_driver = {
 976         .owner          = THIS_MODULE,
 977         .drv            = {
 978                 .name   = "3c589_cs",
 979         },
 980         .probe          = tc589_probe,
 981         .remove         = tc589_detach,
 982         .id_table       = tc589_ids,
 983         .suspend        = tc589_suspend,
 984         .resume         = tc589_resume,
 985 };
 986
 987 static int __init init_tc589(void)
 988 {
 989         return pcmcia_register_driver(&tc589_driver);
 990 }
 991
 992 static void __exit exit_tc589(void)
 993 {
 994         pcmcia_unregister_driver(&tc589_driver);
 995 }
 996
 997 module_init(init_tc589);
 998 module_exit(exit_tc589);