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