/* smc-mca.c: A SMC Ultra ethernet driver for linux. */
/*
    Most of this driver, except for ultramca_probe is nearly
    verbatim from smc-ultra.c by Donald Becker. The rest is
    written and copyright 1996 by David Weis, weisd3458@uni.edu

    This is a driver for the SMC Ultra and SMC EtherEZ ethercards.

    This driver uses the cards in the 8390-compatible, shared memory mode.
    Most of the run-time complexity is handled by the generic code in
    8390.c.

    This driver enables the shared memory only when doing the actual data
    transfers to avoid a bug in early version of the card that corrupted
    data transferred by a AHA1542.

    This driver does not support the programmed-I/O data transfer mode of
    the EtherEZ.  That support (if available) is smc-ez.c.  Nor does it
    use the non-8390-compatible "Altego" mode. (No support currently planned.)

    Changelog:

    Paul Gortmaker       : multiple card support for module users.
    David Weis           : Micro Channel-ized it.
    Tom Sightler         : Added support for IBM PS/2 Ethernet Adapter/A
    Christopher Turcksin : Changed MCA-probe so that multiple adapters are
                           found correctly (Jul 16, 1997)
    Chris Beauregard     : Tried to merge the two changes above (Dec 15, 1997)
    Tom Sightler         : Fixed minor detection bug caused by above merge
    Tom Sightler         : Added support for three more Western Digital
                           MCA-adapters
    Tom Sightler         : Added support for 2.2.x mca_find_unused_adapter
    Hartmut Schmidt      : - Modified parameter detection to handle each
                             card differently depending on a switch-list
                           - 'card_ver' removed from the adapter list
                           - Some minor bug fixes
*/

#include <linux/mca.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/string.h>
#include <linux/init.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>

#include <asm/io.h>
#include <asm/system.h>

#include "8390.h"

#define DRV_NAME "smc-mca"

static int ultramca_open(struct net_device *dev);
static void ultramca_reset_8390(struct net_device *dev);
static void ultramca_get_8390_hdr(struct net_device *dev,
                                  struct e8390_pkt_hdr *hdr,
                                  int ring_page);
static void ultramca_block_input(struct net_device *dev, int count,
                                 struct sk_buff *skb,
                                 int ring_offset);
static void ultramca_block_output(struct net_device *dev, int count,
                                  const unsigned char *buf,
                                  const int start_page);
static int ultramca_close_card(struct net_device *dev);

#define START_PG        0x00    /* First page of TX buffer */

#define ULTRA_CMDREG 0      /* Offset to ASIC command register. */
#define ULTRA_RESET  0x80   /* Board reset, in ULTRA_CMDREG. */
#define ULTRA_MEMENB 0x40   /* Enable the shared memory. */
#define ULTRA_NIC_OFFSET 16 /* NIC register offset from the base_addr. */
#define ULTRA_IO_EXTENT 32
#define EN0_ERWCNT      0x08  /* Early receive warning count. */

#define _61c8_SMC_Ethercard_PLUS_Elite_A_BNC_AUI_WD8013EP_A            0
#define _61c9_SMC_Ethercard_PLUS_Elite_A_UTP_AUI_WD8013EP_A            1
#define _6fc0_WD_Ethercard_PLUS_A_WD8003E_A_OR_WD8003ET_A              2
#define _6fc1_WD_Starcard_PLUS_A_WD8003ST_A                            3
#define _6fc2_WD_Ethercard_PLUS_10T_A_WD8003W_A                        4
#define _efd4_IBM_PS2_Adapter_A_for_Ethernet_UTP_AUI_WD8013WP_A        5
#define _efd5_IBM_PS2_Adapter_A_for_Ethernet_BNC_AUI_WD8013WP_A        6
#define _efe5_IBM_PS2_Adapter_A_for_Ethernet                           7

struct smc_mca_adapters_t {
        unsigned int id;
        char *name;
};

#define MAX_ULTRAMCA_CARDS 4    /* Max number of Ultra cards per module */

static int ultra_io[MAX_ULTRAMCA_CARDS];
static int ultra_irq[MAX_ULTRAMCA_CARDS];
MODULE_LICENSE("GPL");

module_param_array(ultra_io, int, NULL, 0);
module_param_array(ultra_irq, int, NULL, 0);
MODULE_PARM_DESC(ultra_io, "SMC Ultra/EtherEZ MCA I/O base address(es)");
MODULE_PARM_DESC(ultra_irq, "SMC Ultra/EtherEZ MCA IRQ number(s)");

static const struct {
  unsigned int base_addr;
} addr_table[] = {
    { 0x0800 },
    { 0x1800 },
    { 0x2800 },
    { 0x3800 },
    { 0x4800 },
    { 0x5800 },
    { 0x6800 },
    { 0x7800 },
    { 0x8800 },
    { 0x9800 },
    { 0xa800 },
    { 0xb800 },
    { 0xc800 },
    { 0xd800 },
    { 0xe800 },
    { 0xf800 }
};

#define MEM_MASK 64

static const struct {
  unsigned char mem_index;
  unsigned long mem_start;
  unsigned char num_pages;
} mem_table[] = {
    { 16, 0x0c0000, 40 },
    { 18, 0x0c4000, 40 },
    { 20, 0x0c8000, 40 },
    { 22, 0x0cc000, 40 },
    { 24, 0x0d0000, 40 },
    { 26, 0x0d4000, 40 },
    { 28, 0x0d8000, 40 },
    { 30, 0x0dc000, 40 },
    {144, 0xfc0000, 40 },
    {148, 0xfc8000, 40 },
    {154, 0xfd0000, 40 },
    {156, 0xfd8000, 40 },
    {  0, 0x0c0000, 20 },
    {  1, 0x0c2000, 20 },
    {  2, 0x0c4000, 20 },
    {  3, 0x0c6000, 20 }
};

#define IRQ_MASK 243
static const struct {
   unsigned char new_irq;
   unsigned char old_irq;
} irq_table[] = {
   {  3,  3 },
   {  4,  4 },
   { 10, 10 },
   { 14, 15 }
};

static short smc_mca_adapter_ids[] __initdata = {
        0x61c8,
        0x61c9,
        0x6fc0,
        0x6fc1,
        0x6fc2,
        0xefd4,
        0xefd5,
        0xefe5,
        0x0000
};

static char *smc_mca_adapter_names[] __initdata = {
        "SMC Ethercard PLUS Elite/A BNC/AUI (WD8013EP/A)",
        "SMC Ethercard PLUS Elite/A UTP/AUI (WD8013WP/A)",
        "WD Ethercard PLUS/A (WD8003E/A or WD8003ET/A)",
        "WD Starcard PLUS/A (WD8003ST/A)",
        "WD Ethercard PLUS 10T/A (WD8003W/A)",
        "IBM PS/2 Adapter/A for Ethernet UTP/AUI (WD8013WP/A)",
        "IBM PS/2 Adapter/A for Ethernet BNC/AUI (WD8013EP/A)",
        "IBM PS/2 Adapter/A for Ethernet",
        NULL
};

static int ultra_found = 0;


static const struct net_device_ops ultramca_netdev_ops = {
        .ndo_open               = ultramca_open,
        .ndo_stop               = ultramca_close_card,

        .ndo_start_xmit         = ei_start_xmit,
        .ndo_tx_timeout         = ei_tx_timeout,
        .ndo_get_stats          = ei_get_stats,
        .ndo_set_multicast_list = ei_set_multicast_list,
        .ndo_validate_addr      = eth_validate_addr,
        .ndo_set_mac_address    = eth_mac_addr,
        .ndo_change_mtu         = eth_change_mtu,
#ifdef CONFIG_NET_POLL_CONTROLLER
        .ndo_poll_controller    = ei_poll,
#endif
};

static int __init ultramca_probe(struct device *gen_dev)
{
        unsigned short ioaddr;
        struct net_device *dev;
        unsigned char reg4, num_pages;
        struct mca_device *mca_dev = to_mca_device(gen_dev);
        char slot = mca_dev->slot;
        unsigned char pos2 = 0xff, pos3 = 0xff, pos4 = 0xff, pos5 = 0xff;
        int i, rc;
        int adapter = mca_dev->index;
        int tbase = 0;
        int tirq = 0;
        int base_addr = ultra_io[ultra_found];
        int irq = ultra_irq[ultra_found];

        if (base_addr || irq) {
                printk(KERN_INFO "Probing for SMC MCA adapter");
                if (base_addr) {
                        printk(KERN_INFO " at I/O address 0x%04x%c",
                               base_addr, irq ? ' ' : '\n');
                }
                if (irq) {
                        printk(KERN_INFO "using irq %d\n", irq);
                }
        }

        tirq = 0;
        tbase = 0;

        /* If we're trying to match a specificied irq or io address,
         * we'll reject the adapter found unless it's the one we're
         * looking for */

        pos2 = mca_device_read_stored_pos(mca_dev, 2); /* io_addr */
        pos3 = mca_device_read_stored_pos(mca_dev, 3); /* shared mem */
        pos4 = mca_device_read_stored_pos(mca_dev, 4); /* ROM bios addr range */
        pos5 = mca_device_read_stored_pos(mca_dev, 5); /* irq, media and RIPL */

        /* Test the following conditions:
         * - If an irq parameter is supplied, compare it
         *   with the irq of the adapter we found
         * - If a base_addr paramater is given, compare it
         *   with the base_addr of the adapter we found
         * - Check that the irq and the base_addr of the
         *   adapter we found is not already in use by
         *   this driver
         */

        switch (mca_dev->index) {
        case _61c8_SMC_Ethercard_PLUS_Elite_A_BNC_AUI_WD8013EP_A:
        case _61c9_SMC_Ethercard_PLUS_Elite_A_UTP_AUI_WD8013EP_A:
        case _efd4_IBM_PS2_Adapter_A_for_Ethernet_UTP_AUI_WD8013WP_A:
        case _efd5_IBM_PS2_Adapter_A_for_Ethernet_BNC_AUI_WD8013WP_A:
                {
                        tbase = addr_table[(pos2 & 0xf0) >> 4].base_addr;
                        tirq  = irq_table[(pos5 & 0xc) >> 2].new_irq;
                        break;
                }
        case _6fc0_WD_Ethercard_PLUS_A_WD8003E_A_OR_WD8003ET_A:
        case _6fc1_WD_Starcard_PLUS_A_WD8003ST_A:
        case _6fc2_WD_Ethercard_PLUS_10T_A_WD8003W_A:
        case _efe5_IBM_PS2_Adapter_A_for_Ethernet:
                {
                        tbase = ((pos2 & 0x0fe) * 0x10);
                        tirq  = irq_table[(pos5 & 3)].old_irq;
                        break;
                }
        }

        if(!tirq || !tbase
           || (irq && irq != tirq)
           || (base_addr && tbase != base_addr))
                /* FIXME: we're trying to force the ordering of the
                 * devices here, there should be a way of getting this
                 * to happen */
                return -ENXIO;

        /* Adapter found. */
        dev  = alloc_ei_netdev();
        if(!dev)
                return -ENODEV;

        SET_NETDEV_DEV(dev, gen_dev);
        mca_device_set_name(mca_dev, smc_mca_adapter_names[adapter]);
        mca_device_set_claim(mca_dev, 1);

        printk(KERN_INFO "smc_mca: %s found in slot %d\n",
                       smc_mca_adapter_names[adapter], slot + 1);

        ultra_found++;

        dev->base_addr = ioaddr = mca_device_transform_ioport(mca_dev, tbase);
        dev->irq       = mca_device_transform_irq(mca_dev, tirq);
        dev->mem_start = 0;
        num_pages      = 40;

        switch (adapter) {      /* card-# in const array above [hs] */
                case _61c8_SMC_Ethercard_PLUS_Elite_A_BNC_AUI_WD8013EP_A:
                case _61c9_SMC_Ethercard_PLUS_Elite_A_UTP_AUI_WD8013EP_A:
                {
                        for (i = 0; i < 16; i++) { /* taking 16 counts
                                                    * up to 15 [hs] */
                                if (mem_table[i].mem_index == (pos3 & ~MEM_MASK)) {
                                        dev->mem_start = (unsigned long)
                                          mca_device_transform_memory(mca_dev, (void *)mem_table[i].mem_start);
                                        num_pages = mem_table[i].num_pages;
                                }
                        }
                        break;
                }
                case _6fc0_WD_Ethercard_PLUS_A_WD8003E_A_OR_WD8003ET_A:
                case _6fc1_WD_Starcard_PLUS_A_WD8003ST_A:
                case _6fc2_WD_Ethercard_PLUS_10T_A_WD8003W_A:
                case _efe5_IBM_PS2_Adapter_A_for_Ethernet:
                {
                        dev->mem_start = (unsigned long)
                          mca_device_transform_memory(mca_dev, (void *)((pos3 & 0xfc) * 0x1000));
                        num_pages = 0x40;
                        break;
                }
                case _efd4_IBM_PS2_Adapter_A_for_Ethernet_UTP_AUI_WD8013WP_A:
                case _efd5_IBM_PS2_Adapter_A_for_Ethernet_BNC_AUI_WD8013WP_A:
                {
                        /* courtesy of gamera@quartz.ocn.ne.jp, pos3 indicates
                         * the index of the 0x2000 step.
                         * beware different number of pages [hs]
                         */
                        dev->mem_start = (unsigned long)
                          mca_device_transform_memory(mca_dev, (void *)(0xc0000 + (0x2000 * (pos3 & 0xf))));
                        num_pages = 0x20 + (2 * (pos3 & 0x10));
                        break;
                }
        }

        /* sanity check, shouldn't happen */
        if (dev->mem_start == 0) {
                rc = -ENODEV;
                goto err_unclaim;
        }

        if (!request_region(ioaddr, ULTRA_IO_EXTENT, DRV_NAME)) {
                rc = -ENODEV;
                goto err_unclaim;
        }

        reg4 = inb(ioaddr + 4) & 0x7f;
        outb(reg4, ioaddr + 4);

        for (i = 0; i < 6; i++)
                dev->dev_addr[i] = inb(ioaddr + 8 + i);

        printk(KERN_INFO "smc_mca[%d]: Parameters: %#3x, %pM",
               slot + 1, ioaddr, dev->dev_addr);

        /* Switch from the station address to the alternate register set
         * and read the useful registers there.
         */

        outb(0x80 | reg4, ioaddr + 4);

        /* Enable FINE16 mode to avoid BIOS ROM width mismatches @ reboot.
         */

        outb(0x80 | inb(ioaddr + 0x0c), ioaddr + 0x0c);

        /* Switch back to the station address register set so that
         * the MS-DOS driver can find the card after a warm boot.
         */

        outb(reg4, ioaddr + 4);

        dev_set_drvdata(gen_dev, dev);

        /* The 8390 isn't at the base address, so fake the offset
         */

        dev->base_addr = ioaddr + ULTRA_NIC_OFFSET;

        ei_status.name = "SMC Ultra MCA";
        ei_status.word16 = 1;
        ei_status.tx_start_page = START_PG;
        ei_status.rx_start_page = START_PG + TX_PAGES;
        ei_status.stop_page = num_pages;

        ei_status.mem = ioremap(dev->mem_start, (ei_status.stop_page - START_PG) * 256);
        if (!ei_status.mem) {
                rc = -ENOMEM;
                goto err_release_region;
        }

        dev->mem_end = dev->mem_start + (ei_status.stop_page - START_PG) * 256;

        printk(", IRQ %d memory %#lx-%#lx.\n",
        dev->irq, dev->mem_start, dev->mem_end - 1);

        ei_status.reset_8390 = &ultramca_reset_8390;
        ei_status.block_input = &ultramca_block_input;
        ei_status.block_output = &ultramca_block_output;
        ei_status.get_8390_hdr = &ultramca_get_8390_hdr;

        ei_status.priv = slot;

        dev->netdev_ops = &ultramca_netdev_ops;

        NS8390_init(dev, 0);

        rc = register_netdev(dev);
        if (rc)
                goto err_unmap;

        return 0;

err_unmap:
        iounmap(ei_status.mem);
err_release_region:
        release_region(ioaddr, ULTRA_IO_EXTENT);
err_unclaim:
        mca_device_set_claim(mca_dev, 0);
        free_netdev(dev);
        return rc;
}

static int ultramca_open(struct net_device *dev)
{
        int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */
        int retval;

        if ((retval = request_irq(dev->irq, ei_interrupt, 0, dev->name, dev)))
                return retval;

        outb(ULTRA_MEMENB, ioaddr); /* Enable memory */
        outb(0x80, ioaddr + 5);     /* ??? */
        outb(0x01, ioaddr + 6);     /* Enable interrupts and memory. */
        outb(0x04, ioaddr + 5);     /* ??? */

        /* Set the early receive warning level in window 0 high enough not
         * to receive ERW interrupts.
         */

        /* outb_p(E8390_NODMA + E8390_PAGE0, dev->base_addr);
         * outb(0xff, dev->base_addr + EN0_ERWCNT);
         */

        ei_open(dev);
        return 0;
}

static void ultramca_reset_8390(struct net_device *dev)
{
        int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */

        outb(ULTRA_RESET, ioaddr);
        if (ei_debug > 1)
                printk("resetting Ultra, t=%ld...", jiffies);
        ei_status.txing = 0;

        outb(0x80, ioaddr + 5);     /* ??? */
        outb(0x01, ioaddr + 6);     /* Enable interrupts and memory. */

        if (ei_debug > 1)
                printk("reset done\n");
        return;
}

/* Grab the 8390 specific header. Similar to the block_input routine, but
 * we don't need to be concerned with ring wrap as the header will be at
 * the start of a page, so we optimize accordingly.
 */

static void ultramca_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page)
{
        void __iomem *hdr_start = ei_status.mem + ((ring_page - START_PG) << 8);

#ifdef notdef
        /* Officially this is what we are doing, but the readl() is faster */
        memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr));
#else
        ((unsigned int*)hdr)[0] = readl(hdr_start);
#endif
}

/* Block input and output are easy on shared memory ethercards, the only
 * complication is when the ring buffer wraps.
 */

static void ultramca_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset)
{
        void __iomem *xfer_start = ei_status.mem + ring_offset - START_PG * 256;

        if (ring_offset + count > ei_status.stop_page * 256) {
                /* We must wrap the input move. */
                int semi_count = ei_status.stop_page * 256 - ring_offset;
                memcpy_fromio(skb->data, xfer_start, semi_count);
                count -= semi_count;
                memcpy_fromio(skb->data + semi_count, ei_status.mem + TX_PAGES * 256, count);
        } else {
                memcpy_fromio(skb->data, xfer_start, count);
        }

}

static void ultramca_block_output(struct net_device *dev, int count, const unsigned char *buf,
                int start_page)
{
        void __iomem *shmem = ei_status.mem + ((start_page - START_PG) << 8);

        memcpy_toio(shmem, buf, count);
}

static int ultramca_close_card(struct net_device *dev)
{
        int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET; /* ASIC addr */

        netif_stop_queue(dev);

        if (ei_debug > 1)
                printk("%s: Shutting down ethercard.\n", dev->name);

        outb(0x00, ioaddr + 6);     /* Disable interrupts. */
        free_irq(dev->irq, dev);

        NS8390_init(dev, 0);
        /* We should someday disable shared memory and change to 8-bit mode
         * "just in case"...
         */

        return 0;
}

static int ultramca_remove(struct device *gen_dev)
{
        struct mca_device *mca_dev = to_mca_device(gen_dev);
        struct net_device *dev = dev_get_drvdata(gen_dev);

        if (dev) {
                /* NB: ultra_close_card() does free_irq */
                int ioaddr = dev->base_addr - ULTRA_NIC_OFFSET;

                unregister_netdev(dev);
                mca_device_set_claim(mca_dev, 0);
                release_region(ioaddr, ULTRA_IO_EXTENT);
                iounmap(ei_status.mem);
                free_netdev(dev);
        }
        return 0;
}


static struct mca_driver ultra_driver = {
        .id_table = smc_mca_adapter_ids,
        .driver = {
                .name = "smc-mca",
                .bus = &mca_bus_type,
                .probe = ultramca_probe,
                .remove = ultramca_remove,
        }
};

static int __init ultramca_init_module(void)
{
        if(!MCA_bus)
                return -ENXIO;

        mca_register_driver(&ultra_driver);

        return ultra_found ? 0 : -ENXIO;
}

static void __exit ultramca_cleanup_module(void)
{
        mca_unregister_driver(&ultra_driver);
}
module_init(ultramca_init_module);
module_exit(ultramca_cleanup_module);