Subversion Repositories test_project

/* 3c574.c: A PCMCIA ethernet driver for the 3com 3c574 "RoadRunner".

        Written 1993-1998 by

        Donald Becker, becker@scyld.com, (driver core) and

        David Hinds, dahinds@users.sourceforge.net (from his PC card code).

        Locking fixes (C) Copyright 2003 Red Hat Inc

        This software may be used and distributed according to the terms of

        the GNU General Public License, incorporated herein by reference.

        This driver derives from Donald Becker's 3c509 core, which has the

        following copyright:

        Copyright 1993 United States Government as represented by the

        Director, National Security Agency.

*/

/*

                                Theory of Operation

I. Board Compatibility

This device driver is designed for the 3Com 3c574 PC card Fast Ethernet

Adapter.

II. Board-specific settings

None -- PC cards are autoconfigured.

III. Driver operation

The 3c574 uses a Boomerang-style interface, without the bus-master capability.

See the Boomerang driver and documentation for most details.

IV. Notes and chip documentation.

Two added registers are used to enhance PIO performance, RunnerRdCtrl and

RunnerWrCtrl.  These are 11 bit down-counters that are preloaded with the

count of word (16 bits) reads or writes the driver is about to do to the Rx

or Tx FIFO.  The chip is then able to hide the internal-PCI-bus to PC-card

translation latency by buffering the I/O operations with an 8 word FIFO.

Note: No other chip accesses are permitted when this buffer is used.

A second enhancement is that both attribute and common memory space

0x0800-0x0fff can translated to the PIO FIFO.  Thus memory operations (faster

with *some* PCcard bridges) may be used instead of I/O operations.

This is enabled by setting the 0x10 bit in the PCMCIA LAN COR.

Some slow PC card bridges work better if they never see a WAIT signal.

This is configured by setting the 0x20 bit in the PCMCIA LAN COR.

Only do this after testing that it is reliable and improves performance.

The upper five bits of RunnerRdCtrl are used to window into PCcard

configuration space registers.  Window 0 is the regular Boomerang/Odie

register set, 1-5 are various PC card control registers, and 16-31 are

the (reversed!) CIS table.

A final note: writing the InternalConfig register in window 3 with an

invalid ramWidth is Very Bad.

V. References

http://www.scyld.com/expert/NWay.html

http://www.national.com/pf/DP/DP83840.html

Thanks to Terry Murphy of 3Com for providing development information for

earlier 3Com products.

*/

#include <linux/module.h>

#include <linux/kernel.h>

#include <linux/init.h>

#include <linux/slab.h>

#include <linux/string.h>

#include <linux/timer.h>

#include <linux/interrupt.h>

#include <linux/in.h>

#include <linux/delay.h>

#include <linux/netdevice.h>

#include <linux/etherdevice.h>

#include <linux/skbuff.h>

#include <linux/if_arp.h>

#include <linux/ioport.h>

#include <linux/ethtool.h>

#include <linux/bitops.h>

#include <pcmcia/cs_types.h>

#include <pcmcia/cs.h>

#include <pcmcia/cistpl.h>

#include <pcmcia/cisreg.h>

#include <pcmcia/ciscode.h>

#include <pcmcia/ds.h>

#include <pcmcia/mem_op.h>

#include <asm/uaccess.h>

#include <asm/io.h>

#include <asm/system.h>

/*====================================================================*/

/* Module parameters */

MODULE_AUTHOR("David Hinds <dahinds@users.sourceforge.net>");

MODULE_DESCRIPTION("3Com 3c574 series PCMCIA ethernet driver");

MODULE_LICENSE("GPL");

#define INT_MODULE_PARM(n, v) static int n = v; module_param(n, int, 0)

/* Maximum events (Rx packets, etc.) to handle at each interrupt. */

INT_MODULE_PARM(max_interrupt_work, 32);

/* Force full duplex modes? */

INT_MODULE_PARM(full_duplex, 0);

/* Autodetect link polarity reversal? */

INT_MODULE_PARM(auto_polarity, 1);

#ifdef PCMCIA_DEBUG

INT_MODULE_PARM(pc_debug, PCMCIA_DEBUG);

#define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)

static char *version =

"3c574_cs.c 1.65ac1 2003/04/07 Donald Becker/David Hinds, becker@scyld.com.\n";

#else

#define DEBUG(n, args...)

#endif

/*====================================================================*/

/* Time in jiffies before concluding the transmitter is hung. */

#define TX_TIMEOUT  ((800*HZ)/1000)

/* To minimize the size of the driver source and make the driver more

   readable not all constants are symbolically defined.

   You'll need the manual if you want to understand driver details anyway. */

/* Offsets from base I/O address. */

#define EL3_DATA        0x00

#define EL3_CMD         0x0e

#define EL3_STATUS      0x0e

#define EL3WINDOW(win_num) outw(SelectWindow + (win_num), ioaddr + EL3_CMD)

/* The top five bits written to EL3_CMD are a command, the lower

   11 bits are the parameter, if applicable. */

enum el3_cmds {

        TotalReset = 0<<11, SelectWindow = 1<<11, StartCoax = 2<<11,

        RxDisable = 3<<11, RxEnable = 4<<11, RxReset = 5<<11, RxDiscard = 8<<11,

        TxEnable = 9<<11, TxDisable = 10<<11, TxReset = 11<<11,

        FakeIntr = 12<<11, AckIntr = 13<<11, SetIntrEnb = 14<<11,

        SetStatusEnb = 15<<11, SetRxFilter = 16<<11, SetRxThreshold = 17<<11,

        SetTxThreshold = 18<<11, SetTxStart = 19<<11, StatsEnable = 21<<11,

        StatsDisable = 22<<11, StopCoax = 23<<11,

};

enum elxl_status {

        IntLatch = 0x0001, AdapterFailure = 0x0002, TxComplete = 0x0004,

        TxAvailable = 0x0008, RxComplete = 0x0010, RxEarly = 0x0020,

        IntReq = 0x0040, StatsFull = 0x0080, CmdBusy = 0x1000 };

/* The SetRxFilter command accepts the following classes: */

enum RxFilter {

        RxStation = 1, RxMulticast = 2, RxBroadcast = 4, RxProm = 8

};

enum Window0 {

        Wn0EepromCmd = 10, Wn0EepromData = 12, /* EEPROM command/address, data. */

        IntrStatus=0x0E,                /* Valid in all windows. */

};

/* These assumes the larger EEPROM. */

enum Win0_EEPROM_cmds {

        EEPROM_Read = 0x200, EEPROM_WRITE = 0x100, EEPROM_ERASE = 0x300,

        EEPROM_EWENB = 0x30,            /* Enable erasing/writing for 10 msec. */

        EEPROM_EWDIS = 0x00,            /* Disable EWENB before 10 msec timeout. */

};

/* Register window 1 offsets, the window used in normal operation.

   On the "Odie" this window is always mapped at offsets 0x10-0x1f.

   Except for TxFree, which is overlapped by RunnerWrCtrl. */

enum Window1 {

        TX_FIFO = 0x10,  RX_FIFO = 0x10,  RxErrors = 0x14,

        RxStatus = 0x18,  Timer=0x1A, TxStatus = 0x1B,

        TxFree = 0x0C, /* Remaining free bytes in Tx buffer. */

        RunnerRdCtrl = 0x16, RunnerWrCtrl = 0x1c,

};

enum Window3 {                  /* Window 3: MAC/config bits. */

        Wn3_Config=0, Wn3_MAC_Ctrl=6, Wn3_Options=8,

};

enum wn3_config {

        Ram_size = 7,

        Ram_width = 8,

        Ram_speed = 0x30,

        Rom_size = 0xc0,

        Ram_split_shift = 16,

        Ram_split = 3 << Ram_split_shift,

        Xcvr_shift = 20,

        Xcvr = 7 << Xcvr_shift,

        Autoselect = 0x1000000,

};

enum Window4 {          /* Window 4: Xcvr/media bits. */

        Wn4_FIFODiag = 4, Wn4_NetDiag = 6, Wn4_PhysicalMgmt=8, Wn4_Media = 10,

};

#define MEDIA_TP        0x00C0  /* Enable link beat and jabber for 10baseT. */

struct el3_private {

        struct pcmcia_device    *p_dev;

        dev_node_t node;

        struct net_device_stats stats;

        u16 advertising, partner;               /* NWay media advertisement */

        unsigned char phys;                     /* MII device address */

        unsigned int autoselect:1, default_media:3;     /* Read from the EEPROM/Wn3_Config. */

        /* for transceiver monitoring */

        struct timer_list media;

        unsigned short media_status;

        unsigned short fast_poll;

        unsigned long last_irq;

        spinlock_t window_lock;                 /* Guards the Window selection */

};

/* Set iff a MII transceiver on any interface requires mdio preamble.

   This only set with the original DP83840 on older 3c905 boards, so the extra

   code size of a per-interface flag is not worthwhile. */

static char mii_preamble_required = 0;

/* Index of functions. */

static int tc574_config(struct pcmcia_device *link);

static void tc574_release(struct pcmcia_device *link);

static void mdio_sync(kio_addr_t ioaddr, int bits);

static int mdio_read(kio_addr_t ioaddr, int phy_id, int location);

static void mdio_write(kio_addr_t ioaddr, int phy_id, int location, int value);

static unsigned short read_eeprom(kio_addr_t ioaddr, int index);

static void tc574_wait_for_completion(struct net_device *dev, int cmd);

static void tc574_reset(struct net_device *dev);

static void media_check(unsigned long arg);

static int el3_open(struct net_device *dev);

static int el3_start_xmit(struct sk_buff *skb, struct net_device *dev);

static irqreturn_t el3_interrupt(int irq, void *dev_id);

static void update_stats(struct net_device *dev);

static struct net_device_stats *el3_get_stats(struct net_device *dev);

static int el3_rx(struct net_device *dev, int worklimit);

static int el3_close(struct net_device *dev);

static void el3_tx_timeout(struct net_device *dev);

static int el3_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);

static const struct ethtool_ops netdev_ethtool_ops;

static void set_rx_mode(struct net_device *dev);

static void tc574_detach(struct pcmcia_device *p_dev);

/*

        tc574_attach() creates an "instance" of the driver, allocating

        local data structures for one device.  The device is registered

        with Card Services.

*/

static int tc574_probe(struct pcmcia_device *link)

{

        struct el3_private *lp;

        struct net_device *dev;

        DEBUG(0, "3c574_attach()\n");

        /* Create the PC card device object. */

        dev = alloc_etherdev(sizeof(struct el3_private));

        if (!dev)

                return -ENOMEM;

        lp = netdev_priv(dev);

        link->priv = dev;

        lp->p_dev = link;

        spin_lock_init(&lp->window_lock);

        link->io.NumPorts1 = 32;

        link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;

        link->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING|IRQ_HANDLE_PRESENT;

        link->irq.IRQInfo1 = IRQ_LEVEL_ID;

        link->irq.Handler = &el3_interrupt;

        link->irq.Instance = dev;

        link->conf.Attributes = CONF_ENABLE_IRQ;

        link->conf.IntType = INT_MEMORY_AND_IO;

        link->conf.ConfigIndex = 1;

        /* The EL3-specific entries in the device structure. */

        dev->hard_start_xmit = &el3_start_xmit;

        dev->get_stats = &el3_get_stats;

        dev->do_ioctl = &el3_ioctl;

        SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);

        dev->set_multicast_list = &set_rx_mode;

        dev->open = &el3_open;

        dev->stop = &el3_close;

#ifdef HAVE_TX_TIMEOUT

        dev->tx_timeout = el3_tx_timeout;

        dev->watchdog_timeo = TX_TIMEOUT;

#endif

        return tc574_config(link);

} /* tc574_attach */

/*

        This deletes a driver "instance".  The device is de-registered

        with Card Services.  If it has been released, all local data

        structures are freed.  Otherwise, the structures will be freed

        when the device is released.

*/

static void tc574_detach(struct pcmcia_device *link)

{

        struct net_device *dev = link->priv;

        DEBUG(0, "3c574_detach(0x%p)\n", link);

        if (link->dev_node)

                unregister_netdev(dev);

        tc574_release(link);

        free_netdev(dev);

} /* tc574_detach */

/*

        tc574_config() is scheduled to run after a CARD_INSERTION event

        is received, to configure the PCMCIA socket, and to make the

        ethernet device available to the system.

*/

#define CS_CHECK(fn, ret) \

  do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)

static const char *ram_split[] = {"5:3", "3:1", "1:1", "3:5"};

static int tc574_config(struct pcmcia_device *link)

{

        struct net_device *dev = link->priv;

        struct el3_private *lp = netdev_priv(dev);

        tuple_t tuple;

        __le16 buf[32];

        int last_fn, last_ret, i, j;

        kio_addr_t ioaddr;

        __be16 *phys_addr;

        char *cardname;

        __u32 config;

        DECLARE_MAC_BUF(mac);

        phys_addr = (__be16 *)dev->dev_addr;

        DEBUG(0, "3c574_config(0x%p)\n", link);

        link->io.IOAddrLines = 16;

        for (i = j = 0; j < 0x400; j += 0x20) {

                link->io.BasePort1 = j ^ 0x300;

                i = pcmcia_request_io(link, &link->io);

                if (i == CS_SUCCESS) break;

        }

        if (i != CS_SUCCESS) {

                cs_error(link, RequestIO, i);

                goto failed;

        }

        CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));

        CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));

        dev->irq = link->irq.AssignedIRQ;

        dev->base_addr = link->io.BasePort1;

        ioaddr = dev->base_addr;

        /* The 3c574 normally uses an EEPROM for configuration info, including

           the hardware address.  The future products may include a modem chip

           and put the address in the CIS. */

        tuple.Attributes = 0;

        tuple.TupleData = (cisdata_t *)buf;

        tuple.TupleDataMax = 64;

        tuple.TupleOffset = 0;

        tuple.DesiredTuple = 0x88;

        if (pcmcia_get_first_tuple(link, &tuple) == CS_SUCCESS) {

                pcmcia_get_tuple_data(link, &tuple);

                for (i = 0; i < 3; i++)

                        phys_addr[i] = htons(le16_to_cpu(buf[i]));

        } else {

                EL3WINDOW(0);

                for (i = 0; i < 3; i++)

                        phys_addr[i] = htons(read_eeprom(ioaddr, i + 10));

                if (phys_addr[0] == htons(0x6060)) {

                        printk(KERN_NOTICE "3c574_cs: IO port conflict at 0x%03lx"

                                   "-0x%03lx\n", dev->base_addr, dev->base_addr+15);

                        goto failed;

                }

        }

        if (link->prod_id[1])

                cardname = link->prod_id[1];

        else

                cardname = "3Com 3c574";

        {

                u_char mcr;

                outw(2<<11, ioaddr + RunnerRdCtrl);

                mcr = inb(ioaddr + 2);

                outw(0<<11, ioaddr + RunnerRdCtrl);

                printk(KERN_INFO "  ASIC rev %d,", mcr>>3);

                EL3WINDOW(3);

                config = inl(ioaddr + Wn3_Config);

                lp->default_media = (config & Xcvr) >> Xcvr_shift;

                lp->autoselect = config & Autoselect ? 1 : 0;

        }

        init_timer(&lp->media);

        {

                int phy;

                /* Roadrunner only: Turn on the MII transceiver */

                outw(0x8040, ioaddr + Wn3_Options);

                mdelay(1);

                outw(0xc040, ioaddr + Wn3_Options);

                tc574_wait_for_completion(dev, TxReset);

                tc574_wait_for_completion(dev, RxReset);

                mdelay(1);

                outw(0x8040, ioaddr + Wn3_Options);

                EL3WINDOW(4);

                for (phy = 1; phy <= 32; phy++) {

                        int mii_status;

                        mdio_sync(ioaddr, 32);

                        mii_status = mdio_read(ioaddr, phy & 0x1f, 1);

                        if (mii_status != 0xffff) {

                                lp->phys = phy & 0x1f;

                                DEBUG(0, "  MII transceiver at index %d, status %x.\n",

                                          phy, mii_status);

                                if ((mii_status & 0x0040) == 0)

                                        mii_preamble_required = 1;

                                break;

                        }

                }

                if (phy > 32) {

                        printk(KERN_NOTICE "  No MII transceivers found!\n");

                        goto failed;

                }

                i = mdio_read(ioaddr, lp->phys, 16) | 0x40;

                mdio_write(ioaddr, lp->phys, 16, i);

                lp->advertising = mdio_read(ioaddr, lp->phys, 4);

                if (full_duplex) {

                        /* Only advertise the FD media types. */

                        lp->advertising &= ~0x02a0;

                        mdio_write(ioaddr, lp->phys, 4, lp->advertising);

                }

        }

        link->dev_node = &lp->node;

        SET_NETDEV_DEV(dev, &handle_to_dev(link));

        if (register_netdev(dev) != 0) {

                printk(KERN_NOTICE "3c574_cs: register_netdev() failed\n");

                link->dev_node = NULL;

                goto failed;

        }

        strcpy(lp->node.dev_name, dev->name);

        printk(KERN_INFO "%s: %s at io %#3lx, irq %d, "

               "hw_addr %s.\n",

               dev->name, cardname, dev->base_addr, dev->irq,

               print_mac(mac, dev->dev_addr));

        printk(" %dK FIFO split %s Rx:Tx, %sMII interface.\n",

                   8 << config & Ram_size,

                   ram_split[(config & Ram_split) >> Ram_split_shift],

                   config & Autoselect ? "autoselect " : "");

        return 0;

cs_failed:

        cs_error(link, last_fn, last_ret);

failed:

        tc574_release(link);

        return -ENODEV;

} /* tc574_config */

/*

        After a card is removed, tc574_release() will unregister the net

        device, and release the PCMCIA configuration.  If the device is

        still open, this will be postponed until it is closed.

*/

static void tc574_release(struct pcmcia_device *link)

{

        pcmcia_disable_device(link);

}

static int tc574_suspend(struct pcmcia_device *link)

{

        struct net_device *dev = link->priv;

        if (link->open)

                netif_device_detach(dev);

        return 0;

}

static int tc574_resume(struct pcmcia_device *link)

{

        struct net_device *dev = link->priv;

        if (link->open) {

                tc574_reset(dev);

                netif_device_attach(dev);

        }

        return 0;

}

static void dump_status(struct net_device *dev)

{

        kio_addr_t ioaddr = dev->base_addr;

        EL3WINDOW(1);

        printk(KERN_INFO "  irq status %04x, rx status %04x, tx status "

                   "%02x, tx free %04x\n", inw(ioaddr+EL3_STATUS),

                   inw(ioaddr+RxStatus), inb(ioaddr+TxStatus),

                   inw(ioaddr+TxFree));

        EL3WINDOW(4);

        printk(KERN_INFO "  diagnostics: fifo %04x net %04x ethernet %04x"

                   " media %04x\n", inw(ioaddr+0x04), inw(ioaddr+0x06),

                   inw(ioaddr+0x08), inw(ioaddr+0x0a));

        EL3WINDOW(1);

}

/*

  Use this for commands that may take time to finish

*/

static void tc574_wait_for_completion(struct net_device *dev, int cmd)

{

        int i = 1500;

        outw(cmd, dev->base_addr + EL3_CMD);

        while (--i > 0)

                if (!(inw(dev->base_addr + EL3_STATUS) & 0x1000)) break;

        if (i == 0)

                printk(KERN_NOTICE "%s: command 0x%04x did not complete!\n", dev->name, cmd);

}

/* Read a word from the EEPROM using the regular EEPROM access register.

   Assume that we are in register window zero.

 */

static unsigned short read_eeprom(kio_addr_t ioaddr, int index)

{

        int timer;

        outw(EEPROM_Read + index, ioaddr + Wn0EepromCmd);

        /* Pause for at least 162 usec for the read to take place. */

        for (timer = 1620; timer >= 0; timer--) {

                if ((inw(ioaddr + Wn0EepromCmd) & 0x8000) == 0)

                        break;

        }

        return inw(ioaddr + Wn0EepromData);

}

/* MII transceiver control section.

   Read and write the MII registers using software-generated serial

   MDIO protocol.  See the MII specifications or DP83840A data sheet

   for details.

   The maxium data clock rate is 2.5 Mhz.  The timing is easily met by the

   slow PC card interface. */

#define MDIO_SHIFT_CLK  0x01

#define MDIO_DIR_WRITE  0x04

#define MDIO_DATA_WRITE0 (0x00 | MDIO_DIR_WRITE)

#define MDIO_DATA_WRITE1 (0x02 | MDIO_DIR_WRITE)

#define MDIO_DATA_READ  0x02

#define MDIO_ENB_IN             0x00

/* Generate the preamble required for initial synchronization and

   a few older transceivers. */

static void mdio_sync(kio_addr_t ioaddr, int bits)

{

        kio_addr_t mdio_addr = ioaddr + Wn4_PhysicalMgmt;

        /* Establish sync by sending at least 32 logic ones. */

        while (-- bits >= 0) {

                outw(MDIO_DATA_WRITE1, mdio_addr);

                outw(MDIO_DATA_WRITE1 | MDIO_SHIFT_CLK, mdio_addr);

        }

}

static int mdio_read(kio_addr_t ioaddr, int phy_id, int location)

{

        int i;

        int read_cmd = (0xf6 << 10) | (phy_id << 5) | location;

        unsigned int retval = 0;

        kio_addr_t mdio_addr = ioaddr + Wn4_PhysicalMgmt;

        if (mii_preamble_required)

                mdio_sync(ioaddr, 32);

        /* Shift the read command bits out. */

        for (i = 14; i >= 0; i--) {

                int dataval = (read_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;

                outw(dataval, mdio_addr);

                outw(dataval | MDIO_SHIFT_CLK, mdio_addr);

        }

        /* Read the two transition, 16 data, and wire-idle bits. */

        for (i = 19; i > 0; i--) {

                outw(MDIO_ENB_IN, mdio_addr);

                retval = (retval << 1) | ((inw(mdio_addr) & MDIO_DATA_READ) ? 1 : 0);

                outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);

        }

        return (retval>>1) & 0xffff;

}

static void mdio_write(kio_addr_t ioaddr, int phy_id, int location, int value)

{

        int write_cmd = 0x50020000 | (phy_id << 23) | (location << 18) | value;

        kio_addr_t mdio_addr = ioaddr + Wn4_PhysicalMgmt;

        int i;

        if (mii_preamble_required)

                mdio_sync(ioaddr, 32);

        /* Shift the command bits out. */

        for (i = 31; i >= 0; i--) {

                int dataval = (write_cmd&(1<<i)) ? MDIO_DATA_WRITE1 : MDIO_DATA_WRITE0;

                outw(dataval, mdio_addr);

                outw(dataval | MDIO_SHIFT_CLK, mdio_addr);

        }

        /* Leave the interface idle. */

        for (i = 1; i >= 0; i--) {

                outw(MDIO_ENB_IN, mdio_addr);

                outw(MDIO_ENB_IN | MDIO_SHIFT_CLK, mdio_addr);

        }

        return;

}

/* Reset and restore all of the 3c574 registers. */

static void tc574_reset(struct net_device *dev)

{

        struct el3_private *lp = netdev_priv(dev);

        int i;

        kio_addr_t ioaddr = dev->base_addr;

        unsigned long flags;

        tc574_wait_for_completion(dev, TotalReset|0x10);

        spin_lock_irqsave(&lp->window_lock, flags);

        /* Clear any transactions in progress. */

        outw(0, ioaddr + RunnerWrCtrl);

        outw(0, ioaddr + RunnerRdCtrl);

        /* Set the station address and mask. */

        EL3WINDOW(2);

        for (i = 0; i < 6; i++)

                outb(dev->dev_addr[i], ioaddr + i);

        for (; i < 12; i+=2)

                outw(0, ioaddr + i);