drivers/net/pcmcia/3c589_cs.c

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