/*
 * Driver for 802.11b cards using RAM-loadable Symbol firmware, such as
 * Symbol Wireless Networker LA4137, CompactFlash cards by Socket
 * Communications and Intel PRO/Wireless 2011B.
 *
 * The driver implements Symbol firmware download.  The rest is handled
 * in hermes.c and main.c.
 *
 * Utilities for downloading the Symbol firmware are available at
 * http://sourceforge.net/projects/orinoco/
 *
 * Copyright (C) 2002-2005 Pavel Roskin <proski@gnu.org>
 * Portions based on orinoco_cs.c:
 *      Copyright (C) David Gibson, Linuxcare Australia
 * Portions based on Spectrum24tDnld.c from original spectrum24 driver:
 *      Copyright (C) Symbol Technologies.
 *
 * See copyright notice in file main.c.
 */

#define DRIVER_NAME "spectrum_cs"
#define PFX DRIVER_NAME ": "

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <pcmcia/cistpl.h>
#include <pcmcia/cisreg.h>
#include <pcmcia/ds.h>

#include "orinoco.h"

/********************************************************************/
/* Module stuff                                                     */
/********************************************************************/

MODULE_AUTHOR("Pavel Roskin <proski@gnu.org>");
MODULE_DESCRIPTION("Driver for Symbol Spectrum24 Trilogy cards with firmware downloader");
MODULE_LICENSE("Dual MPL/GPL");

/* Module parameters */

/* Some D-Link cards have buggy CIS. They do work at 5v properly, but
 * don't have any CIS entry for it. This workaround it... */
static int ignore_cis_vcc; /* = 0 */
module_param(ignore_cis_vcc, int, 0);
MODULE_PARM_DESC(ignore_cis_vcc, "Allow voltage mismatch between card and socket");

/********************************************************************/
/* Data structures                                                  */
/********************************************************************/

/* PCMCIA specific device information (goes in the card field of
 * struct orinoco_private */
struct orinoco_pccard {
        struct pcmcia_device    *p_dev;
};

/********************************************************************/
/* Function prototypes                                              */
/********************************************************************/

static int spectrum_cs_config(struct pcmcia_device *link);
static void spectrum_cs_release(struct pcmcia_device *link);

/* Constants for the CISREG_CCSR register */
#define HCR_RUN         0x07    /* run firmware after reset */
#define HCR_IDLE        0x0E    /* don't run firmware after reset */
#define HCR_MEM16       0x10    /* memory width bit, should be preserved */


/*
 * Reset the card using configuration registers COR and CCSR.
 * If IDLE is 1, stop the firmware, so that it can be safely rewritten.
 */
static int
spectrum_reset(struct pcmcia_device *link, int idle)
{
        int ret;
        u8 save_cor;
        u8 ccsr;

        /* Doing it if hardware is gone is guaranteed crash */
        if (!pcmcia_dev_present(link))
                return -ENODEV;

        /* Save original COR value */
        ret = pcmcia_read_config_byte(link, CISREG_COR, &save_cor);
        if (ret)
                goto failed;

        /* Soft-Reset card */
        ret = pcmcia_write_config_byte(link, CISREG_COR,
                                (save_cor | COR_SOFT_RESET));
        if (ret)
                goto failed;
        udelay(1000);

        /* Read CCSR */
        ret = pcmcia_read_config_byte(link, CISREG_CCSR, &ccsr);
        if (ret)
                goto failed;

        /*
         * Start or stop the firmware.  Memory width bit should be
         * preserved from the value we've just read.
         */
        ccsr = (idle ? HCR_IDLE : HCR_RUN) | (ccsr & HCR_MEM16);
        ret = pcmcia_write_config_byte(link, CISREG_CCSR, ccsr);
        if (ret)
                goto failed;
        udelay(1000);

        /* Restore original COR configuration index */
        ret = pcmcia_write_config_byte(link, CISREG_COR,
                                (save_cor & ~COR_SOFT_RESET));
        if (ret)
                goto failed;
        udelay(1000);
        return 0;

failed:
        return -ENODEV;
}

/********************************************************************/
/* Device methods                                                   */
/********************************************************************/

static int
spectrum_cs_hard_reset(struct orinoco_private *priv)
{
        struct orinoco_pccard *card = priv->card;
        struct pcmcia_device *link = card->p_dev;

        /* Soft reset using COR and HCR */
        spectrum_reset(link, 0);

        return 0;
}

static int
spectrum_cs_stop_firmware(struct orinoco_private *priv, int idle)
{
        struct orinoco_pccard *card = priv->card;
        struct pcmcia_device *link = card->p_dev;

        return spectrum_reset(link, idle);
}

/********************************************************************/
/* PCMCIA stuff                                                     */
/********************************************************************/

static int
spectrum_cs_probe(struct pcmcia_device *link)
{
        struct orinoco_private *priv;
        struct orinoco_pccard *card;

        priv = alloc_orinocodev(sizeof(*card), &link->dev,
                                spectrum_cs_hard_reset,
                                spectrum_cs_stop_firmware);
        if (!priv)
                return -ENOMEM;
        card = priv->card;

        /* Link both structures together */
        card->p_dev = link;
        link->priv = priv;

        return spectrum_cs_config(link);
}                               /* spectrum_cs_attach */

static void spectrum_cs_detach(struct pcmcia_device *link)
{
        struct orinoco_private *priv = link->priv;

        orinoco_if_del(priv);

        spectrum_cs_release(link);

        free_orinocodev(priv);
}                               /* spectrum_cs_detach */

static int spectrum_cs_config_check(struct pcmcia_device *p_dev,
                                    void *priv_data)
{
        if (p_dev->config_index == 0)
                return -EINVAL;

        return pcmcia_request_io(p_dev);
};

static int
spectrum_cs_config(struct pcmcia_device *link)
{
        struct orinoco_private *priv = link->priv;
        struct hermes *hw = &priv->hw;
        int ret;
        void __iomem *mem;

        link->config_flags |= CONF_AUTO_SET_VPP | CONF_AUTO_CHECK_VCC |
                CONF_AUTO_SET_IO | CONF_ENABLE_IRQ;
        if (ignore_cis_vcc)
                link->config_flags &= ~CONF_AUTO_CHECK_VCC;
        ret = pcmcia_loop_config(link, spectrum_cs_config_check, NULL);
        if (ret) {
                if (!ignore_cis_vcc)
                        printk(KERN_ERR PFX "GetNextTuple(): No matching "
                               "CIS configuration.  Maybe you need the "
                               "ignore_cis_vcc=1 parameter.\n");
                goto failed;
        }

        mem = ioport_map(link->resource[0]->start,
                        resource_size(link->resource[0]));
        if (!mem)
                goto failed;

        /* We initialize the hermes structure before completing PCMCIA
         * configuration just in case the interrupt handler gets
         * called. */
        hermes_struct_init(hw, mem, HERMES_16BIT_REGSPACING);
        hw->eeprom_pda = true;

        ret = pcmcia_request_irq(link, orinoco_interrupt);
        if (ret)
                goto failed;

        ret = pcmcia_enable_device(link);
        if (ret)
                goto failed;

        /* Reset card */
        if (spectrum_cs_hard_reset(priv) != 0)
                goto failed;

        /* Initialise the main driver */
        if (orinoco_init(priv) != 0) {
                printk(KERN_ERR PFX "orinoco_init() failed\n");
                goto failed;
        }

        /* Register an interface with the stack */
        if (orinoco_if_add(priv, link->resource[0]->start,
                           link->irq, NULL) != 0) {
                printk(KERN_ERR PFX "orinoco_if_add() failed\n");
                goto failed;
        }

        return 0;

 failed:
        spectrum_cs_release(link);
        return -ENODEV;
}                               /* spectrum_cs_config */

static void
spectrum_cs_release(struct pcmcia_device *link)
{
        struct orinoco_private *priv = link->priv;
        unsigned long flags;

        /* We're committed to taking the device away now, so mark the
         * hardware as unavailable */
        priv->hw.ops->lock_irqsave(&priv->lock, &flags);
        priv->hw_unavailable++;
        priv->hw.ops->unlock_irqrestore(&priv->lock, &flags);

        pcmcia_disable_device(link);
        if (priv->hw.iobase)
                ioport_unmap(priv->hw.iobase);
}                               /* spectrum_cs_release */


static int
spectrum_cs_suspend(struct pcmcia_device *link)
{
        struct orinoco_private *priv = link->priv;
        int err = 0;

        /* Mark the device as stopped, to block IO until later */
        orinoco_down(priv);

        return err;
}

static int
spectrum_cs_resume(struct pcmcia_device *link)
{
        struct orinoco_private *priv = link->priv;
        int err = orinoco_up(priv);

        return err;
}


/********************************************************************/
/* Module initialization                                            */
/********************************************************************/

static const struct pcmcia_device_id spectrum_cs_ids[] = {
        PCMCIA_DEVICE_MANF_CARD(0x026c, 0x0001), /* Symbol Spectrum24 LA4137 */
        PCMCIA_DEVICE_MANF_CARD(0x0104, 0x0001), /* Socket Communications CF */
        PCMCIA_DEVICE_PROD_ID12("Intel", "PRO/Wireless LAN PC Card", 0x816cc815, 0x6fbf459a), /* 2011B, not 2011 */
        PCMCIA_DEVICE_NULL,
};
MODULE_DEVICE_TABLE(pcmcia, spectrum_cs_ids);

static struct pcmcia_driver orinoco_driver = {
        .owner          = THIS_MODULE,
        .name           = DRIVER_NAME,
        .probe          = spectrum_cs_probe,
        .remove         = spectrum_cs_detach,
        .suspend        = spectrum_cs_suspend,
        .resume         = spectrum_cs_resume,
        .id_table       = spectrum_cs_ids,
};
module_pcmcia_driver(orinoco_driver);