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