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