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