SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/net/pcmcia/3c589_cs.c

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