drivers/net/pcmcia/3c589_cs.c

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