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_rx_mode(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 const struct net_device_ops el3_netdev_ops = {
 174         .ndo_open               = el3_open,
 175         .ndo_stop               = el3_close,
 176         .ndo_start_xmit         = el3_start_xmit,
 177         .ndo_tx_timeout         = el3_tx_timeout,
 178         .ndo_set_config         = el3_config,
 179         .ndo_get_stats          = el3_get_stats,
 180         .ndo_set_multicast_list = set_multicast_list,
 181         .ndo_change_mtu         = eth_change_mtu,
 182         .ndo_set_mac_address    = eth_mac_addr,
 183         .ndo_validate_addr      = eth_validate_addr,
 184 };
 185
 186 static int tc589_probe(struct pcmcia_device *link)
 187 {
 188     struct el3_private *lp;
 189     struct net_device *dev;
 190
 191     DEBUG(0, "3c589_attach()\n");
 192
 193     /* Create new ethernet device */
 194     dev = alloc_etherdev(sizeof(struct el3_private));
 195     if (!dev)
 196          return -ENOMEM;
 197     lp = netdev_priv(dev);
 198     link->priv = dev;
 199     lp->p_dev = link;
 200
 201     spin_lock_init(&lp->lock);
 202     link->io.NumPorts1 = 16;
 203     link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 204     link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_HANDLE_PRESENT;
 205     link->irq.IRQInfo1 = IRQ_LEVEL_ID;
 206     link->irq.Handler = &el3_interrupt;
 207     link->irq.Instance = dev;
 208     link->conf.Attributes = CONF_ENABLE_IRQ;
 209     link->conf.IntType = INT_MEMORY_AND_IO;
 210     link->conf.ConfigIndex = 1;
 211
 212     dev->netdev_ops = &el3_netdev_ops;
 213     dev->watchdog_timeo = TX_TIMEOUT;
 214
 215     SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
 216
 217     return tc589_config(link);
 218 } /* tc589_attach */
 219
 220 /*======================================================================
 221
 222     This deletes a driver "instance".  The device is de-registered
 223     with Card Services.  If it has been released, all local data
 224     structures are freed.  Otherwise, the structures will be freed
 225     when the device is released.
 226
 227 ======================================================================*/
 228
 229 static void tc589_detach(struct pcmcia_device *link)
 230 {
 231     struct net_device *dev = link->priv;
 232
 233     DEBUG(0, "3c589_detach(0x%p)\n", link);
 234
 235     if (link->dev_node)
 236         unregister_netdev(dev);
 237
 238     tc589_release(link);
 239
 240     free_netdev(dev);
 241 } /* tc589_detach */
 242
 243 /*======================================================================
 244
 245     tc589_config() is scheduled to run after a CARD_INSERTION event
 246     is received, to configure the PCMCIA socket, and to make the
 247     ethernet device available to the system.
 248
 249 ======================================================================*/
 250
 251 #define CS_CHECK(fn, ret) \
 252 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
 253
 254 static int tc589_config(struct pcmcia_device *link)
 255 {
 256     struct net_device *dev = link->priv;
 257     struct el3_private *lp = netdev_priv(dev);
 258     tuple_t tuple;
 259     __le16 buf[32];
 260     __be16 *phys_addr;
 261     int last_fn, last_ret, i, j, multi = 0, fifo;
 262     unsigned int ioaddr;
 263     char *ram_split[] = {"5:3", "3:1", "1:1", "3:5"};
 264
 265     DEBUG(0, "3c589_config(0x%p)\n", link);
 266
 267     phys_addr = (__be16 *)dev->dev_addr;
 268     tuple.Attributes = 0;
 269     tuple.TupleData = (cisdata_t *)buf;
 270     tuple.TupleDataMax = sizeof(buf);
 271     tuple.TupleOffset = 0;
 272     tuple.Attributes = TUPLE_RETURN_COMMON;
 273
 274     /* Is this a 3c562? */
 275     if (link->manf_id != MANFID_3COM)
 276             printk(KERN_INFO "3c589_cs: hmmm, is this really a "
 277                    "3Com card??\n");
 278     multi = (link->card_id == PRODID_3COM_3C562);
 279
 280     /* For the 3c562, the base address must be xx00-xx7f */
 281     link->io.IOAddrLines = 16;
 282     for (i = j = 0; j < 0x400; j += 0x10) {
 283         if (multi && (j & 0x80)) continue;
 284         link->io.BasePort1 = j ^ 0x300;
 285         i = pcmcia_request_io(link, &link->io);
 286         if (i == 0)
 287                 break;
 288     }
 289     if (i != 0) {
 290         cs_error(link, RequestIO, i);
 291         goto failed;
 292     }
 293     CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
 294     CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
 295
 296     dev->irq = link->irq.AssignedIRQ;
 297     dev->base_addr = link->io.BasePort1;
 298     ioaddr = dev->base_addr;
 299     EL3WINDOW(0);
 300
 301     /* The 3c589 has an extra EEPROM for configuration info, including
 302        the hardware address.  The 3c562 puts the address in the CIS. */
 303     tuple.DesiredTuple = 0x88;
 304     if (pcmcia_get_first_tuple(link, &tuple) == 0) {
 305         pcmcia_get_tuple_data(link, &tuple);
 306         for (i = 0; i < 3; i++)
 307             phys_addr[i] = htons(le16_to_cpu(buf[i]));
 308     } else {
 309         for (i = 0; i < 3; i++)
 310             phys_addr[i] = htons(read_eeprom(ioaddr, i));
 311         if (phys_addr[0] == htons(0x6060)) {
 312             printk(KERN_ERR "3c589_cs: IO port conflict at 0x%03lx"
 313                    "-0x%03lx\n", dev->base_addr, dev->base_addr+15);
 314             goto failed;
 315         }
 316     }
 317
 318     /* The address and resource configuration register aren't loaded from
 319        the EEPROM and *must* be set to 0 and IRQ3 for the PCMCIA version. */
 320     outw(0x3f00, ioaddr + 8);
 321     fifo = inl(ioaddr);
 322
 323     /* The if_port symbol can be set when the module is loaded */
 324     if ((if_port >= 0) && (if_port <= 3))
 325         dev->if_port = if_port;
 326     else
 327         printk(KERN_ERR "3c589_cs: invalid if_port requested\n");
 328
 329     link->dev_node = &lp->node;
 330     SET_NETDEV_DEV(dev, &handle_to_dev(link));
 331
 332     if (register_netdev(dev) != 0) {
 333         printk(KERN_ERR "3c589_cs: register_netdev() failed\n");
 334         link->dev_node = NULL;
 335         goto failed;
 336     }
 337
 338     strcpy(lp->node.dev_name, dev->name);
 339
 340     printk(KERN_INFO "%s: 3Com 3c%s, io %#3lx, irq %d, "
 341            "hw_addr %pM\n",
 342            dev->name, (multi ? "562" : "589"), dev->base_addr, dev->irq,
 343            dev->dev_addr);
 344     printk(KERN_INFO "  %dK FIFO split %s Rx:Tx, %s xcvr\n",
 345            (fifo & 7) ? 32 : 8, ram_split[(fifo >> 16) & 3],
 346            if_names[dev->if_port]);
 347     return 0;
 348
 349 cs_failed:
 350     cs_error(link, last_fn, last_ret);
 351 failed:
 352     tc589_release(link);
 353     return -ENODEV;
 354 } /* tc589_config */
 355
 356 /*======================================================================
 357
 358     After a card is removed, tc589_release() will unregister the net
 359     device, and release the PCMCIA configuration.  If the device is
 360     still open, this will be postponed until it is closed.
 361
 362 ======================================================================*/
 363
 364 static void tc589_release(struct pcmcia_device *link)
 365 {
 366         pcmcia_disable_device(link);
 367 }
 368
 369 static int tc589_suspend(struct pcmcia_device *link)
 370 {
 371         struct net_device *dev = link->priv;
 372
 373         if (link->open)
 374                 netif_device_detach(dev);
 375
 376         return 0;
 377 }
 378
 379 static int tc589_resume(struct pcmcia_device *link)
 380 {
 381         struct net_device *dev = link->priv;
 382
 383         if (link->open) {
 384                 tc589_reset(dev);
 385                 netif_device_attach(dev);
 386         }
 387
 388         return 0;
 389 }
 390
 391 /*====================================================================*/
 392
 393 /*
 394   Use this for commands that may take time to finish
 395 */
 396 static void tc589_wait_for_completion(struct net_device *dev, int cmd)
 397 {
 398     int i = 100;
 399     outw(cmd, dev->base_addr + EL3_CMD);
 400     while (--i > 0)
 401         if (!(inw(dev->base_addr + EL3_STATUS) & 0x1000)) break;
 402     if (i == 0)
 403         printk(KERN_WARNING "%s: command 0x%04x did not complete!\n",
 404                dev->name, cmd);
 405 }
 406
 407 /*
 408   Read a word from the EEPROM using the regular EEPROM access register.
 409   Assume that we are in register window zero.
 410 */
 411 static u16 read_eeprom(unsigned int ioaddr, int index)
 412 {
 413     int i;
 414     outw(EEPROM_READ + index, ioaddr + 10);
 415     /* Reading the eeprom takes 162 us */
 416     for (i = 1620; i >= 0; i--)
 417         if ((inw(ioaddr + 10) & EEPROM_BUSY) == 0)
 418             break;
 419     return inw(ioaddr + 12);
 420 }
 421
 422 /*
 423   Set transceiver type, perhaps to something other than what the user
 424   specified in dev->if_port.
 425 */
 426 static void tc589_set_xcvr(struct net_device *dev, int if_port)
 427 {
 428     struct el3_private *lp = netdev_priv(dev);
 429     unsigned int ioaddr = dev->base_addr;
 430
 431     EL3WINDOW(0);
 432     switch (if_port) {
 433     case 0: case 1: outw(0, ioaddr + 6); break;
 434     case 2: outw(3<<14, ioaddr + 6); break;
 435     case 3: outw(1<<14, ioaddr + 6); break;
 436     }
 437     /* On PCMCIA, this just turns on the LED */
 438     outw((if_port == 2) ? StartCoax : StopCoax, ioaddr + EL3_CMD);
 439     /* 10baseT interface, enable link beat and jabber check. */
 440     EL3WINDOW(4);
 441     outw(MEDIA_LED | ((if_port < 2) ? MEDIA_TP : 0), ioaddr + WN4_MEDIA);
 442     EL3WINDOW(1);
 443     if (if_port == 2)
 444         lp->media_status = ((dev->if_port == 0) ? 0x8000 : 0x4000);
 445     else
 446         lp->media_status = ((dev->if_port == 0) ? 0x4010 : 0x8800);
 447 }
 448
 449 static void dump_status(struct net_device *dev)
 450 {
 451     unsigned int ioaddr = dev->base_addr;
 452     EL3WINDOW(1);
 453     printk(KERN_INFO "  irq status %04x, rx status %04x, tx status "
 454            "%02x  tx free %04x\n", inw(ioaddr+EL3_STATUS),
 455            inw(ioaddr+RX_STATUS), inb(ioaddr+TX_STATUS),
 456            inw(ioaddr+TX_FREE));
 457     EL3WINDOW(4);
 458     printk(KERN_INFO "  diagnostics: fifo %04x net %04x ethernet %04x"
 459            " media %04x\n", inw(ioaddr+0x04), inw(ioaddr+0x06),
 460            inw(ioaddr+0x08), inw(ioaddr+0x0a));
 461     EL3WINDOW(1);
 462 }
 463
 464 /* Reset and restore all of the 3c589 registers. */
 465 static void tc589_reset(struct net_device *dev)
 466 {
 467     unsigned int ioaddr = dev->base_addr;
 468     int i;
 469
 470     EL3WINDOW(0);
 471     outw(0x0001, ioaddr + 4);                   /* Activate board. */
 472     outw(0x3f00, ioaddr + 8);                   /* Set the IRQ line. */
 473
 474     /* Set the station address in window 2. */
 475     EL3WINDOW(2);
 476     for (i = 0; i < 6; i++)
 477         outb(dev->dev_addr[i], ioaddr + i);
 478
 479     tc589_set_xcvr(dev, dev->if_port);
 480
 481     /* Switch to the stats window, and clear all stats by reading. */
 482     outw(StatsDisable, ioaddr + EL3_CMD);
 483     EL3WINDOW(6);
 484     for (i = 0; i < 9; i++)
 485         inb(ioaddr+i);
 486     inw(ioaddr + 10);
 487     inw(ioaddr + 12);
 488
 489     /* Switch to register set 1 for normal use. */
 490     EL3WINDOW(1);
 491
 492     set_rx_mode(dev);
 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_rx_mode(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_rx_mode(struct net_device *dev)
 909 {
 910     unsigned int ioaddr = dev->base_addr;
 911     u16 opts = SetRxFilter | RxStation | RxBroadcast;
 912
 913     if (dev->flags & IFF_PROMISC)
 914         opts |= RxMulticast | RxProm;
 915     else if (dev->mc_count || (dev->flags & IFF_ALLMULTI))
 916         opts |= RxMulticast;
 917     outw(opts, ioaddr + EL3_CMD);
 918 }
 919
 920 static void set_multicast_list(struct net_device *dev)
 921 {
 922         struct el3_private *priv = netdev_priv(dev);
 923         unsigned long flags;
 924
 925         spin_lock_irqsave(&priv->lock, flags);
 926         set_rx_mode(dev);
 927         spin_unlock_irqrestore(&priv->lock, flags);
 928 }
 929
 930 static int el3_close(struct net_device *dev)
 931 {
 932     struct el3_private *lp = netdev_priv(dev);
 933     struct pcmcia_device *link = lp->p_dev;
 934     unsigned int ioaddr = dev->base_addr;
 935
 936     DEBUG(1, "%s: shutting down ethercard.\n", dev->name);
 937
 938     if (pcmcia_dev_present(link)) {
 939         /* Turn off statistics ASAP.  We update dev->stats below. */
 940         outw(StatsDisable, ioaddr + EL3_CMD);
 941
 942         /* Disable the receiver and transmitter. */
 943         outw(RxDisable, ioaddr + EL3_CMD);
 944         outw(TxDisable, ioaddr + EL3_CMD);
 945
 946         if (dev->if_port == 2)
 947             /* Turn off thinnet power.  Green! */
 948             outw(StopCoax, ioaddr + EL3_CMD);
 949         else if (dev->if_port == 1) {
 950             /* Disable link beat and jabber */
 951             EL3WINDOW(4);
 952             outw(0, ioaddr + WN4_MEDIA);
 953         }
 954
 955         /* Switching back to window 0 disables the IRQ. */
 956         EL3WINDOW(0);
 957         /* But we explicitly zero the IRQ line select anyway. */
 958         outw(0x0f00, ioaddr + WN0_IRQ);
 959
 960         /* Check if the card still exists */
 961         if ((inw(ioaddr+EL3_STATUS) & 0xe000) == 0x2000)
 962             update_stats(dev);
 963     }
 964
 965     link->open--;
 966     netif_stop_queue(dev);
 967     del_timer_sync(&lp->media);
 968
 969     return 0;
 970 }
 971
 972 static struct pcmcia_device_id tc589_ids[] = {
 973         PCMCIA_MFC_DEVICE_MANF_CARD(0, 0x0101, 0x0562),
 974         PCMCIA_MFC_DEVICE_PROD_ID1(0, "Motorola MARQUIS", 0xf03e4e77),
 975         PCMCIA_DEVICE_MANF_CARD(0x0101, 0x0589),
 976         PCMCIA_DEVICE_PROD_ID12("Farallon", "ENet", 0x58d93fc4, 0x992c2202),
 977         PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x0035, "cis/3CXEM556.cis"),
 978         PCMCIA_MFC_DEVICE_CIS_MANF_CARD(0, 0x0101, 0x003d, "cis/3CXEM556.cis"),
 979         PCMCIA_DEVICE_NULL,
 980 };
 981 MODULE_DEVICE_TABLE(pcmcia, tc589_ids);
 982
 983 static struct pcmcia_driver tc589_driver = {
 984         .owner          = THIS_MODULE,
 985         .drv            = {
 986                 .name   = "3c589_cs",
 987         },
 988         .probe          = tc589_probe,
 989         .remove         = tc589_detach,
 990         .id_table       = tc589_ids,
 991         .suspend        = tc589_suspend,
 992         .resume         = tc589_resume,
 993 };
 994
 995 static int __init init_tc589(void)
 996 {
 997         return pcmcia_register_driver(&tc589_driver);
 998 }
 999
1000 static void __exit exit_tc589(void)
1001 {
1002         pcmcia_unregister_driver(&tc589_driver);
1003 }
1004
1005 module_init(init_tc589);
1006 module_exit(exit_tc589);