drivers/net/pcmcia/3c589_cs.c

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