/*=============================================================================
 *
 * A  PCMCIA client driver for the Raylink wireless LAN card.
 * The starting point for this module was the skeleton.c in the
 * PCMCIA 2.9.12 package written by David Hinds, dahinds@users.sourceforge.net
 *
 *
 * Copyright (c) 1998  Corey Thomas (corey@world.std.com)
 *
 * This driver is free software; you can redistribute it and/or modify
 * it under the terms of version 2 only of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * It is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
 *
 * Changes:
 * Arnaldo Carvalho de Melo <acme@conectiva.com.br> - 08/08/2000
 * - reorganize kmallocs in ray_attach, checking all for failure
 *   and releasing the previous allocations if one fails
 *
 * Daniele Bellucci <bellucda@tiscali.it> - 07/10/2003
 * - Audit copy_to_user in ioctl(SIOCGIWESSID)
 *
=============================================================================*/

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/proc_fs.h>
#include <linux/ptrace.h>
#include <linux/seq_file.h>
#include <linux/slab.h>
#include <linux/string.h>
#include <linux/timer.h>
#include <linux/init.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/if_arp.h>
#include <linux/ioport.h>
#include <linux/skbuff.h>
#include <linux/ethtool.h>
#include <linux/ieee80211.h>

#include <pcmcia/cs_types.h>
#include <pcmcia/cs.h>
#include <pcmcia/cistpl.h>
#include <pcmcia/cisreg.h>
#include <pcmcia/ds.h>
#include <pcmcia/mem_op.h>

#include <linux/wireless.h>
#include <net/iw_handler.h>

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

/* Warning : these stuff will slow down the driver... */
#define WIRELESS_SPY            /* Enable spying addresses */
/* Definitions we need for spy */
typedef struct iw_statistics iw_stats;
typedef u_char mac_addr[ETH_ALEN];      /* Hardware address */

#include "rayctl.h"
#include "ray_cs.h"

/* All the PCMCIA modules use PCMCIA_DEBUG to control debugging.  If
   you do not define PCMCIA_DEBUG at all, all the debug code will be
   left out.  If you compile with PCMCIA_DEBUG=0, the debug code will
   be present but disabled -- but it can then be enabled for specific
   modules at load time with a 'pc_debug=#' option to insmod.
*/

#ifdef RAYLINK_DEBUG
#define PCMCIA_DEBUG RAYLINK_DEBUG
#endif
#ifdef PCMCIA_DEBUG
static int ray_debug;
static int pc_debug = PCMCIA_DEBUG;
module_param(pc_debug, int, 0);
/* #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args); */
#define DEBUG(n, args...) if (pc_debug > (n)) printk(args);
#else
#define DEBUG(n, args...)
#endif
/** Prototypes based on PCMCIA skeleton driver *******************************/
static int ray_config(struct pcmcia_device *link);
static void ray_release(struct pcmcia_device *link);
static void ray_detach(struct pcmcia_device *p_dev);

/***** Prototypes indicated by device structure ******************************/
static int ray_dev_close(struct net_device *dev);
static int ray_dev_config(struct net_device *dev, struct ifmap *map);
static struct net_device_stats *ray_get_stats(struct net_device *dev);
static int ray_dev_init(struct net_device *dev);

static const struct ethtool_ops netdev_ethtool_ops;

static int ray_open(struct net_device *dev);
static int ray_dev_start_xmit(struct sk_buff *skb, struct net_device *dev);
static void set_multicast_list(struct net_device *dev);
static void ray_update_multi_list(struct net_device *dev, int all);
static int translate_frame(ray_dev_t *local, struct tx_msg __iomem *ptx,
                           unsigned char *data, int len);
static void ray_build_header(ray_dev_t *local, struct tx_msg __iomem *ptx,
                             UCHAR msg_type, unsigned char *data);
static void untranslate(ray_dev_t *local, struct sk_buff *skb, int len);
static iw_stats *ray_get_wireless_stats(struct net_device *dev);
static const struct iw_handler_def ray_handler_def;

/***** Prototypes for raylink functions **************************************/
static int asc_to_int(char a);
static void authenticate(ray_dev_t *local);
static int build_auth_frame(ray_dev_t *local, UCHAR *dest, int auth_type);
static void authenticate_timeout(u_long);
static int get_free_ccs(ray_dev_t *local);
static int get_free_tx_ccs(ray_dev_t *local);
static void init_startup_params(ray_dev_t *local);
static int parse_addr(char *in_str, UCHAR *out);
static int ray_hw_xmit(unsigned char *data, int len, struct net_device *dev, UCHAR type);
static int ray_init(struct net_device *dev);
static int interrupt_ecf(ray_dev_t *local, int ccs);
static void ray_reset(struct net_device *dev);
static void ray_update_parm(struct net_device *dev, UCHAR objid, UCHAR *value, int len);
static void verify_dl_startup(u_long);

/* Prototypes for interrpt time functions **********************************/
static irqreturn_t ray_interrupt(int reg, void *dev_id);
static void clear_interrupt(ray_dev_t *local);
static void rx_deauthenticate(ray_dev_t *local, struct rcs __iomem *prcs,
                              unsigned int pkt_addr, int rx_len);
static int copy_from_rx_buff(ray_dev_t *local, UCHAR *dest, int pkt_addr, int len);
static void ray_rx(struct net_device *dev, ray_dev_t *local, struct rcs __iomem *prcs);
static void release_frag_chain(ray_dev_t *local, struct rcs __iomem *prcs);
static void rx_authenticate(ray_dev_t *local, struct rcs __iomem *prcs,
                            unsigned int pkt_addr, int rx_len);
static void rx_data(struct net_device *dev, struct rcs __iomem *prcs,
                    unsigned int pkt_addr, int rx_len);
static void associate(ray_dev_t *local);

/* Card command functions */
static int dl_startup_params(struct net_device *dev);
static void join_net(u_long local);
static void start_net(u_long local);
/* void start_net(ray_dev_t *local); */

/*===========================================================================*/
/* Parameters that can be set with 'insmod' */

/* ADHOC=0, Infrastructure=1 */
static int net_type = ADHOC;

/* Hop dwell time in Kus (1024 us units defined by 802.11) */
static int hop_dwell = 128;

/* Beacon period in Kus */
static int beacon_period = 256;

/* power save mode (0 = off, 1 = save power) */
static int psm;

/* String for network's Extended Service Set ID. 32 Characters max */
static char *essid;

/* Default to encapsulation unless translation requested */
static int translate = 1;

static int country = USA;

static int sniffer;

static int bc;

/* 48 bit physical card address if overriding card's real physical
 * address is required.  Since IEEE 802.11 addresses are 48 bits
 * like ethernet, an int can't be used, so a string is used. To
 * allow use of addresses starting with a decimal digit, the first
 * character must be a letter and will be ignored. This letter is
 * followed by up to 12 hex digits which are the address.  If less
 * than 12 digits are used, the address will be left filled with 0's.
 * Note that bit 0 of the first byte is the broadcast bit, and evil
 * things will happen if it is not 0 in a card address.
 */
static char *phy_addr = NULL;


/* A struct pcmcia_device structure has fields for most things that are needed
   to keep track of a socket, but there will usually be some device
   specific information that also needs to be kept track of.  The
   'priv' pointer in a struct pcmcia_device structure can be used to point to
   a device-specific private data structure, like this.
*/
static unsigned int ray_mem_speed = 500;

/* WARNING: THIS DRIVER IS NOT CAPABLE OF HANDLING MULTIPLE DEVICES! */
static struct pcmcia_device *this_device = NULL;

MODULE_AUTHOR("Corey Thomas <corey@world.std.com>");
MODULE_DESCRIPTION("Raylink/WebGear wireless LAN driver");
MODULE_LICENSE("GPL");

module_param(net_type, int, 0);
module_param(hop_dwell, int, 0);
module_param(beacon_period, int, 0);
module_param(psm, int, 0);
module_param(essid, charp, 0);
module_param(translate, int, 0);
module_param(country, int, 0);
module_param(sniffer, int, 0);
module_param(bc, int, 0);
module_param(phy_addr, charp, 0);
module_param(ray_mem_speed, int, 0);

static UCHAR b5_default_startup_parms[] = {
        0, 0,                   /* Adhoc station */
        'L', 'I', 'N', 'U', 'X', 0, 0, 0,       /* 32 char ESSID */
        0, 0, 0, 0, 0, 0, 0, 0,
        0, 0, 0, 0, 0, 0, 0, 0,
        0, 0, 0, 0, 0, 0, 0, 0,
        1, 0,                   /* Active scan, CA Mode */
        0, 0, 0, 0, 0, 0,       /* No default MAC addr  */
        0x7f, 0xff,             /* Frag threshold */
        0x00, 0x80,             /* Hop time 128 Kus */
        0x01, 0x00,             /* Beacon period 256 Kus */
        0x01, 0x07, 0xa3,       /* DTIM, retries, ack timeout */
        0x1d, 0x82, 0x4e,       /* SIFS, DIFS, PIFS */
        0x7f, 0xff,             /* RTS threshold */
        0x04, 0xe2, 0x38, 0xA4, /* scan_dwell, max_scan_dwell */
        0x05,                   /* assoc resp timeout thresh */
        0x08, 0x02, 0x08,       /* adhoc, infra, super cycle max */
        0,                      /* Promiscuous mode */
        0x0c, 0x0bd,            /* Unique word */
        0x32,                   /* Slot time */
        0xff, 0xff,             /* roam-low snr, low snr count */
        0x05, 0xff,             /* Infra, adhoc missed bcn thresh */
        0x01, 0x0b, 0x4f,       /* USA, hop pattern, hop pat length */
/* b4 - b5 differences start here */
        0x00, 0x3f,             /* CW max */
        0x00, 0x0f,             /* CW min */
        0x04, 0x08,             /* Noise gain, limit offset */
        0x28, 0x28,             /* det rssi, med busy offsets */
        7,                      /* det sync thresh */
        0, 2, 2,                /* test mode, min, max */
        0,                      /* allow broadcast SSID probe resp */
        0, 0,                   /* privacy must start, can join */
        2, 0, 0, 0, 0, 0, 0, 0  /* basic rate set */
};

static UCHAR b4_default_startup_parms[] = {
        0, 0,                   /* Adhoc station */
        'L', 'I', 'N', 'U', 'X', 0, 0, 0,       /* 32 char ESSID */
        0, 0, 0, 0, 0, 0, 0, 0,
        0, 0, 0, 0, 0, 0, 0, 0,
        0, 0, 0, 0, 0, 0, 0, 0,
        1, 0,                   /* Active scan, CA Mode */
        0, 0, 0, 0, 0, 0,       /* No default MAC addr  */
        0x7f, 0xff,             /* Frag threshold */
        0x02, 0x00,             /* Hop time */
        0x00, 0x01,             /* Beacon period */
        0x01, 0x07, 0xa3,       /* DTIM, retries, ack timeout */
        0x1d, 0x82, 0xce,       /* SIFS, DIFS, PIFS */
        0x7f, 0xff,             /* RTS threshold */
        0xfb, 0x1e, 0xc7, 0x5c, /* scan_dwell, max_scan_dwell */
        0x05,                   /* assoc resp timeout thresh */
        0x04, 0x02, 0x4,        /* adhoc, infra, super cycle max */
        0,                      /* Promiscuous mode */
        0x0c, 0x0bd,            /* Unique word */
        0x4e,                   /* Slot time (TBD seems wrong) */
        0xff, 0xff,             /* roam-low snr, low snr count */
        0x05, 0xff,             /* Infra, adhoc missed bcn thresh */
        0x01, 0x0b, 0x4e,       /* USA, hop pattern, hop pat length */
/* b4 - b5 differences start here */
        0x3f, 0x0f,             /* CW max, min */
        0x04, 0x08,             /* Noise gain, limit offset */
        0x28, 0x28,             /* det rssi, med busy offsets */
        7,                      /* det sync thresh */
        0, 2, 2                 /* test mode, min, max */
};

/*===========================================================================*/
static unsigned char eth2_llc[] = { 0xaa, 0xaa, 3, 0, 0, 0 };

static char hop_pattern_length[] = { 1,
        USA_HOP_MOD, EUROPE_HOP_MOD,
        JAPAN_HOP_MOD, KOREA_HOP_MOD,
        SPAIN_HOP_MOD, FRANCE_HOP_MOD,
        ISRAEL_HOP_MOD, AUSTRALIA_HOP_MOD,
        JAPAN_TEST_HOP_MOD
};

static char rcsid[] =
    "Raylink/WebGear wireless LAN - Corey <Thomas corey@world.std.com>";

static const struct net_device_ops ray_netdev_ops = {
        .ndo_init               = ray_dev_init,
        .ndo_open               = ray_open,
        .ndo_stop               = ray_dev_close,
        .ndo_start_xmit         = ray_dev_start_xmit,
        .ndo_set_config         = ray_dev_config,
        .ndo_get_stats          = ray_get_stats,
        .ndo_set_multicast_list = set_multicast_list,
        .ndo_change_mtu         = eth_change_mtu,
        .ndo_set_mac_address    = eth_mac_addr,
        .ndo_validate_addr      = eth_validate_addr,
};

/*=============================================================================
    ray_attach() creates an "instance" of the driver, allocating
    local data structures for one device.  The device is registered
    with Card Services.
    The dev_link structure is initialized, but we don't actually
    configure the card at this point -- we wait until we receive a
    card insertion event.
=============================================================================*/
static int ray_probe(struct pcmcia_device *p_dev)
{
        ray_dev_t *local;
        struct net_device *dev;

        DEBUG(1, "ray_attach()\n");

        /* Allocate space for private device-specific data */
        dev = alloc_etherdev(sizeof(ray_dev_t));
        if (!dev)
                goto fail_alloc_dev;

        local = netdev_priv(dev);
        local->finder = p_dev;

        /* The io structure describes IO port mapping. None used here */
        p_dev->io.NumPorts1 = 0;
        p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
        p_dev->io.IOAddrLines = 5;

        /* Interrupt setup. For PCMCIA, driver takes what's given */
        p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING | IRQ_HANDLE_PRESENT;
        p_dev->irq.IRQInfo1 = IRQ_LEVEL_ID;
        p_dev->irq.Handler = &ray_interrupt;

        /* General socket configuration */
        p_dev->conf.Attributes = CONF_ENABLE_IRQ;
        p_dev->conf.IntType = INT_MEMORY_AND_IO;
        p_dev->conf.ConfigIndex = 1;

        p_dev->priv = dev;
        p_dev->irq.Instance = dev;

        local->finder = p_dev;
        local->card_status = CARD_INSERTED;
        local->authentication_state = UNAUTHENTICATED;
        local->num_multi = 0;
        DEBUG(2, "ray_attach p_dev = %p,  dev = %p,  local = %p, intr = %p\n",
              p_dev, dev, local, &ray_interrupt);

        /* Raylink entries in the device structure */
        dev->netdev_ops = &ray_netdev_ops;
        SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
        dev->wireless_handlers = &ray_handler_def;
#ifdef WIRELESS_SPY
        local->wireless_data.spy_data = &local->spy_data;
        dev->wireless_data = &local->wireless_data;
#endif /* WIRELESS_SPY */


        DEBUG(2, "ray_cs ray_attach calling ether_setup.)\n");
        netif_stop_queue(dev);

        init_timer(&local->timer);

        this_device = p_dev;
        return ray_config(p_dev);

fail_alloc_dev:
        return -ENOMEM;
} /* ray_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 ray_detach(struct pcmcia_device *link)
{
        struct net_device *dev;
        ray_dev_t *local;

        DEBUG(1, "ray_detach(0x%p)\n", link);

        this_device = NULL;
        dev = link->priv;

        ray_release(link);

        local = netdev_priv(dev);
        del_timer(&local->timer);

        if (link->priv) {
                if (link->dev_node)
                        unregister_netdev(dev);
                free_netdev(dev);
        }
        DEBUG(2, "ray_cs ray_detach ending\n");
} /* ray_detach */

/*=============================================================================
    ray_config() is 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)
#define MAX_TUPLE_SIZE 128
static int ray_config(struct pcmcia_device *link)
{
        int last_fn = 0, last_ret = 0;
        int i;
        win_req_t req;
        memreq_t mem;
        struct net_device *dev = (struct net_device *)link->priv;
        ray_dev_t *local = netdev_priv(dev);

        DEBUG(1, "ray_config(0x%p)\n", link);

        /* Determine card type and firmware version */
        printk(KERN_INFO "ray_cs Detected: %s%s%s%s\n",
               link->prod_id[0] ? link->prod_id[0] : " ",
               link->prod_id[1] ? link->prod_id[1] : " ",
               link->prod_id[2] ? link->prod_id[2] : " ",
               link->prod_id[3] ? link->prod_id[3] : " ");

        /* Now allocate an interrupt line.  Note that this does not
           actually assign a handler to the interrupt.
         */
        CS_CHECK(RequestIRQ, pcmcia_request_irq(link, &link->irq));
        dev->irq = link->irq.AssignedIRQ;

        /* This actually configures the PCMCIA socket -- setting up
           the I/O windows and the interrupt mapping.
         */
        CS_CHECK(RequestConfiguration,
                 pcmcia_request_configuration(link, &link->conf));

/*** Set up 32k window for shared memory (transmit and control) ************/
        req.Attributes =
            WIN_DATA_WIDTH_8 | WIN_MEMORY_TYPE_CM | WIN_ENABLE | WIN_USE_WAIT;
        req.Base = 0;
        req.Size = 0x8000;
        req.AccessSpeed = ray_mem_speed;
        CS_CHECK(RequestWindow, pcmcia_request_window(&link, &req, &link->win));
        mem.CardOffset = 0x0000;
        mem.Page = 0;
        CS_CHECK(MapMemPage, pcmcia_map_mem_page(link->win, &mem));
        local->sram = ioremap(req.Base, req.Size);

/*** Set up 16k window for shared memory (receive buffer) ***************/
        req.Attributes =
            WIN_DATA_WIDTH_8 | WIN_MEMORY_TYPE_CM | WIN_ENABLE | WIN_USE_WAIT;
        req.Base = 0;
        req.Size = 0x4000;
        req.AccessSpeed = ray_mem_speed;
        CS_CHECK(RequestWindow,
                 pcmcia_request_window(&link, &req, &local->rmem_handle));
        mem.CardOffset = 0x8000;
        mem.Page = 0;
        CS_CHECK(MapMemPage, pcmcia_map_mem_page(local->rmem_handle, &mem));
        local->rmem = ioremap(req.Base, req.Size);

/*** Set up window for attribute memory ***********************************/
        req.Attributes =
            WIN_DATA_WIDTH_8 | WIN_MEMORY_TYPE_AM | WIN_ENABLE | WIN_USE_WAIT;
        req.Base = 0;
        req.Size = 0x1000;
        req.AccessSpeed = ray_mem_speed;
        CS_CHECK(RequestWindow,
                 pcmcia_request_window(&link, &req, &local->amem_handle));
        mem.CardOffset = 0x0000;
        mem.Page = 0;
        CS_CHECK(MapMemPage, pcmcia_map_mem_page(local->amem_handle, &mem));
        local->amem = ioremap(req.Base, req.Size);

        DEBUG(3, "ray_config sram=%p\n", local->sram);
        DEBUG(3, "ray_config rmem=%p\n", local->rmem);
        DEBUG(3, "ray_config amem=%p\n", local->amem);
        if (ray_init(dev) < 0) {
                ray_release(link);
                return -ENODEV;
        }

        SET_NETDEV_DEV(dev, &handle_to_dev(link));
        i = register_netdev(dev);
        if (i != 0) {
                printk("ray_config register_netdev() failed\n");
                ray_release(link);
                return i;
        }

        strcpy(local->node.dev_name, dev->name);
        link->dev_node = &local->node;

        printk(KERN_INFO "%s: RayLink, irq %d, hw_addr %pM\n",
               dev->name, dev->irq, dev->dev_addr);

        return 0;

cs_failed:
        cs_error(link, last_fn, last_ret);

        ray_release(link);
        return -ENODEV;
} /* ray_config */

static inline struct ccs __iomem *ccs_base(ray_dev_t *dev)
{
        return dev->sram + CCS_BASE;
}

static inline struct rcs __iomem *rcs_base(ray_dev_t *dev)
{
        /*
         * This looks nonsensical, since there is a separate
         * RCS_BASE. But the difference between a "struct rcs"
         * and a "struct ccs" ends up being in the _index_ off
         * the base, so the base pointer is the same for both
         * ccs/rcs.
         */
        return dev->sram + CCS_BASE;
}

/*===========================================================================*/
static int ray_init(struct net_device *dev)
{
        int i;
        UCHAR *p;
        struct ccs __iomem *pccs;
        ray_dev_t *local = netdev_priv(dev);
        struct pcmcia_device *link = local->finder;
        DEBUG(1, "ray_init(0x%p)\n", dev);
        if (!(pcmcia_dev_present(link))) {
                DEBUG(0, "ray_init - device not present\n");
                return -1;
        }

        local->net_type = net_type;
        local->sta_type = TYPE_STA;

        /* Copy the startup results to local memory */
        memcpy_fromio(&local->startup_res, local->sram + ECF_TO_HOST_BASE,
                      sizeof(struct startup_res_6));

        /* Check Power up test status and get mac address from card */
        if (local->startup_res.startup_word != 0x80) {
                printk(KERN_INFO "ray_init ERROR card status = %2x\n",
                       local->startup_res.startup_word);
                local->card_status = CARD_INIT_ERROR;
                return -1;
        }

        local->fw_ver = local->startup_res.firmware_version[0];
        local->fw_bld = local->startup_res.firmware_version[1];
        local->fw_var = local->startup_res.firmware_version[2];
        DEBUG(1, "ray_init firmware version %d.%d \n", local->fw_ver,
              local->fw_bld);

        local->tib_length = 0x20;
        if ((local->fw_ver == 5) && (local->fw_bld >= 30))
                local->tib_length = local->startup_res.tib_length;
        DEBUG(2, "ray_init tib_length = 0x%02x\n", local->tib_length);
        /* Initialize CCS's to buffer free state */
        pccs = ccs_base(local);
        for (i = 0; i < NUMBER_OF_CCS; i++) {
                writeb(CCS_BUFFER_FREE, &(pccs++)->buffer_status);
        }
        init_startup_params(local);

        /* copy mac address to startup parameters */
        if (parse_addr(phy_addr, local->sparm.b4.a_mac_addr)) {
                p = local->sparm.b4.a_mac_addr;
        } else {
                memcpy(&local->sparm.b4.a_mac_addr,
                       &local->startup_res.station_addr, ADDRLEN);
                p = local->sparm.b4.a_mac_addr;
        }

        clear_interrupt(local); /* Clear any interrupt from the card */
        local->card_status = CARD_AWAITING_PARAM;
        DEBUG(2, "ray_init ending\n");
        return 0;
} /* ray_init */

/*===========================================================================*/
/* Download startup parameters to the card and command it to read them       */
static int dl_startup_params(struct net_device *dev)
{
        int ccsindex;
        ray_dev_t *local = netdev_priv(dev);
        struct ccs __iomem *pccs;
        struct pcmcia_device *link = local->finder;

        DEBUG(1, "dl_startup_params entered\n");
        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_cs dl_startup_params - device not present\n");
                return -1;
        }

        /* Copy parameters to host to ECF area */
        if (local->fw_ver == 0x55)
                memcpy_toio(local->sram + HOST_TO_ECF_BASE, &local->sparm.b4,
                            sizeof(struct b4_startup_params));
        else
                memcpy_toio(local->sram + HOST_TO_ECF_BASE, &local->sparm.b5,
                            sizeof(struct b5_startup_params));

        /* Fill in the CCS fields for the ECF */
        if ((ccsindex = get_free_ccs(local)) < 0)
                return -1;
        local->dl_param_ccs = ccsindex;
        pccs = ccs_base(local) + ccsindex;
        writeb(CCS_DOWNLOAD_STARTUP_PARAMS, &pccs->cmd);
        DEBUG(2, "dl_startup_params start ccsindex = %d\n",
              local->dl_param_ccs);
        /* Interrupt the firmware to process the command */
        if (interrupt_ecf(local, ccsindex)) {
                printk(KERN_INFO "ray dl_startup_params failed - "
                       "ECF not ready for intr\n");
                local->card_status = CARD_DL_PARAM_ERROR;
                writeb(CCS_BUFFER_FREE, &(pccs++)->buffer_status);
                return -2;
        }
        local->card_status = CARD_DL_PARAM;
        /* Start kernel timer to wait for dl startup to complete. */
        local->timer.expires = jiffies + HZ / 2;
        local->timer.data = (long)local;
        local->timer.function = &verify_dl_startup;
        add_timer(&local->timer);
        DEBUG(2,
              "ray_cs dl_startup_params started timer for verify_dl_startup\n");
        return 0;
} /* dl_startup_params */

/*===========================================================================*/
static void init_startup_params(ray_dev_t *local)
{
        int i;

        if (country > JAPAN_TEST)
                country = USA;
        else if (country < USA)
                country = USA;
        /* structure for hop time and beacon period is defined here using
         * New 802.11D6.1 format.  Card firmware is still using old format
         * until version 6.
         *    Before                    After
         *    a_hop_time ms byte        a_hop_time ms byte
         *    a_hop_time 2s byte        a_hop_time ls byte
         *    a_hop_time ls byte        a_beacon_period ms byte
         *    a_beacon_period           a_beacon_period ls byte
         *
         *    a_hop_time = uS           a_hop_time = KuS
         *    a_beacon_period = hops    a_beacon_period = KuS
         *//* 64ms = 010000 */
        if (local->fw_ver == 0x55) {
                memcpy((UCHAR *) &local->sparm.b4, b4_default_startup_parms,
                       sizeof(struct b4_startup_params));
                /* Translate sane kus input values to old build 4/5 format */
                /* i = hop time in uS truncated to 3 bytes */
                i = (hop_dwell * 1024) & 0xffffff;
                local->sparm.b4.a_hop_time[0] = (i >> 16) & 0xff;
                local->sparm.b4.a_hop_time[1] = (i >> 8) & 0xff;
                local->sparm.b4.a_beacon_period[0] = 0;
                local->sparm.b4.a_beacon_period[1] =
                    ((beacon_period / hop_dwell) - 1) & 0xff;
                local->sparm.b4.a_curr_country_code = country;
                local->sparm.b4.a_hop_pattern_length =
                    hop_pattern_length[(int)country] - 1;
                if (bc) {
                        local->sparm.b4.a_ack_timeout = 0x50;
                        local->sparm.b4.a_sifs = 0x3f;
                }
        } else { /* Version 5 uses real kus values */
                memcpy((UCHAR *) &local->sparm.b5, b5_default_startup_parms,
                       sizeof(struct b5_startup_params));

                local->sparm.b5.a_hop_time[0] = (hop_dwell >> 8) & 0xff;
                local->sparm.b5.a_hop_time[1] = hop_dwell & 0xff;
                local->sparm.b5.a_beacon_period[0] =
                    (beacon_period >> 8) & 0xff;
                local->sparm.b5.a_beacon_period[1] = beacon_period & 0xff;
                if (psm)
                        local->sparm.b5.a_power_mgt_state = 1;
                local->sparm.b5.a_curr_country_code = country;
                local->sparm.b5.a_hop_pattern_length =
                    hop_pattern_length[(int)country];
        }

        local->sparm.b4.a_network_type = net_type & 0x01;
        local->sparm.b4.a_acting_as_ap_status = TYPE_STA;

        if (essid != NULL)
                strncpy(local->sparm.b4.a_current_ess_id, essid, ESSID_SIZE);
} /* init_startup_params */

/*===========================================================================*/
static void verify_dl_startup(u_long data)
{
        ray_dev_t *local = (ray_dev_t *) data;
        struct ccs __iomem *pccs = ccs_base(local) + local->dl_param_ccs;
        UCHAR status;
        struct pcmcia_device *link = local->finder;

        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_cs verify_dl_startup - device not present\n");
                return;
        }
#ifdef PCMCIA_DEBUG
        if (pc_debug > 2) {
                int i;
                printk(KERN_DEBUG
                       "verify_dl_startup parameters sent via ccs %d:\n",
                       local->dl_param_ccs);
                for (i = 0; i < sizeof(struct b5_startup_params); i++) {
                        printk(" %2x",
                               (unsigned int)readb(local->sram +
                                                   HOST_TO_ECF_BASE + i));
                }
                printk("\n");
        }
#endif

        status = readb(&pccs->buffer_status);
        if (status != CCS_BUFFER_FREE) {
                printk(KERN_INFO
                       "Download startup params failed.  Status = %d\n",
                       status);
                local->card_status = CARD_DL_PARAM_ERROR;
                return;
        }
        if (local->sparm.b4.a_network_type == ADHOC)
                start_net((u_long) local);
        else
                join_net((u_long) local);

        return;
} /* end verify_dl_startup */

/*===========================================================================*/
/* Command card to start a network */
static void start_net(u_long data)
{
        ray_dev_t *local = (ray_dev_t *) data;
        struct ccs __iomem *pccs;
        int ccsindex;
        struct pcmcia_device *link = local->finder;
        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_cs start_net - device not present\n");
                return;
        }
        /* Fill in the CCS fields for the ECF */
        if ((ccsindex = get_free_ccs(local)) < 0)
                return;
        pccs = ccs_base(local) + ccsindex;
        writeb(CCS_START_NETWORK, &pccs->cmd);
        writeb(0, &pccs->var.start_network.update_param);
        /* Interrupt the firmware to process the command */
        if (interrupt_ecf(local, ccsindex)) {
                DEBUG(1, "ray start net failed - card not ready for intr\n");
                writeb(CCS_BUFFER_FREE, &(pccs++)->buffer_status);
                return;
        }
        local->card_status = CARD_DOING_ACQ;
        return;
} /* end start_net */

/*===========================================================================*/
/* Command card to join a network */
static void join_net(u_long data)
{
        ray_dev_t *local = (ray_dev_t *) data;

        struct ccs __iomem *pccs;
        int ccsindex;
        struct pcmcia_device *link = local->finder;

        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_cs join_net - device not present\n");
                return;
        }
        /* Fill in the CCS fields for the ECF */
        if ((ccsindex = get_free_ccs(local)) < 0)
                return;
        pccs = ccs_base(local) + ccsindex;
        writeb(CCS_JOIN_NETWORK, &pccs->cmd);
        writeb(0, &pccs->var.join_network.update_param);
        writeb(0, &pccs->var.join_network.net_initiated);
        /* Interrupt the firmware to process the command */
        if (interrupt_ecf(local, ccsindex)) {
                DEBUG(1, "ray join net failed - card not ready for intr\n");
                writeb(CCS_BUFFER_FREE, &(pccs++)->buffer_status);
                return;
        }
        local->card_status = CARD_DOING_ACQ;
        return;
}

/*============================================================================
    After a card is removed, ray_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 ray_release(struct pcmcia_device *link)
{
        struct net_device *dev = link->priv;
        ray_dev_t *local = netdev_priv(dev);
        int i;

        DEBUG(1, "ray_release(0x%p)\n", link);

        del_timer(&local->timer);

        iounmap(local->sram);
        iounmap(local->rmem);
        iounmap(local->amem);
        /* Do bother checking to see if these succeed or not */
        i = pcmcia_release_window(local->amem_handle);
        if (i != 0)
                DEBUG(0, "ReleaseWindow(local->amem) ret = %x\n", i);
        i = pcmcia_release_window(local->rmem_handle);
        if (i != 0)
                DEBUG(0, "ReleaseWindow(local->rmem) ret = %x\n", i);
        pcmcia_disable_device(link);

        DEBUG(2, "ray_release ending\n");
}

static int ray_suspend(struct pcmcia_device *link)
{
        struct net_device *dev = link->priv;

        if (link->open)
                netif_device_detach(dev);

        return 0;
}

static int ray_resume(struct pcmcia_device *link)
{
        struct net_device *dev = link->priv;

        if (link->open) {
                ray_reset(dev);
                netif_device_attach(dev);
        }

        return 0;
}

/*===========================================================================*/
static int ray_dev_init(struct net_device *dev)
{
#ifdef RAY_IMMEDIATE_INIT
        int i;
#endif /* RAY_IMMEDIATE_INIT */
        ray_dev_t *local = netdev_priv(dev);
        struct pcmcia_device *link = local->finder;

        DEBUG(1, "ray_dev_init(dev=%p)\n", dev);
        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_dev_init - device not present\n");
                return -1;
        }
#ifdef RAY_IMMEDIATE_INIT
        /* Download startup parameters */
        if ((i = dl_startup_params(dev)) < 0) {
                printk(KERN_INFO "ray_dev_init dl_startup_params failed - "
                       "returns 0x%x\n", i);
                return -1;
        }
#else /* RAY_IMMEDIATE_INIT */
        /* Postpone the card init so that we can still configure the card,
         * for example using the Wireless Extensions. The init will happen
         * in ray_open() - Jean II */
        DEBUG(1,
              "ray_dev_init: postponing card init to ray_open() ; Status = %d\n",
              local->card_status);
#endif /* RAY_IMMEDIATE_INIT */

        /* copy mac and broadcast addresses to linux device */
        memcpy(&dev->dev_addr, &local->sparm.b4.a_mac_addr, ADDRLEN);
        memset(dev->broadcast, 0xff, ETH_ALEN);

        DEBUG(2, "ray_dev_init ending\n");
        return 0;
}

/*===========================================================================*/
static int ray_dev_config(struct net_device *dev, struct ifmap *map)
{
        ray_dev_t *local = netdev_priv(dev);
        struct pcmcia_device *link = local->finder;
        /* Dummy routine to satisfy device structure */
        DEBUG(1, "ray_dev_config(dev=%p,ifmap=%p)\n", dev, map);
        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_dev_config - device not present\n");
                return -1;
        }

        return 0;
}

/*===========================================================================*/
static int ray_dev_start_xmit(struct sk_buff *skb, struct net_device *dev)
{
        ray_dev_t *local = netdev_priv(dev);
        struct pcmcia_device *link = local->finder;
        short length = skb->len;

        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_dev_start_xmit - device not present\n");
                return -1;
        }
        DEBUG(3, "ray_dev_start_xmit(skb=%p, dev=%p)\n", skb, dev);
        if (local->authentication_state == NEED_TO_AUTH) {
                DEBUG(0, "ray_cs Sending authentication request.\n");
                if (!build_auth_frame(local, local->auth_id, OPEN_AUTH_REQUEST)) {
                        local->authentication_state = AUTHENTICATED;
                        netif_stop_queue(dev);
                        return 1;
                }
        }

        if (length < ETH_ZLEN) {
                if (skb_padto(skb, ETH_ZLEN))
                        return 0;
                length = ETH_ZLEN;
        }
        switch (ray_hw_xmit(skb->data, length, dev, DATA_TYPE)) {
        case XMIT_NO_CCS:
        case XMIT_NEED_AUTH:
                netif_stop_queue(dev);
                return 1;
        case XMIT_NO_INTR:
        case XMIT_MSG_BAD:
        case XMIT_OK:
        default:
                dev->trans_start = jiffies;
                dev_kfree_skb(skb);
                return 0;
        }
        return 0;
} /* ray_dev_start_xmit */

/*===========================================================================*/
static int ray_hw_xmit(unsigned char *data, int len, struct net_device *dev,
                       UCHAR msg_type)
{
        ray_dev_t *local = netdev_priv(dev);
        struct ccs __iomem *pccs;
        int ccsindex;
        int offset;
        struct tx_msg __iomem *ptx;     /* Address of xmit buffer in PC space */
        short int addr;         /* Address of xmit buffer in card space */

        DEBUG(3, "ray_hw_xmit(data=%p, len=%d, dev=%p)\n", data, len, dev);
        if (len + TX_HEADER_LENGTH > TX_BUF_SIZE) {
                printk(KERN_INFO "ray_hw_xmit packet too large: %d bytes\n",
                       len);
                return XMIT_MSG_BAD;
        }
        switch (ccsindex = get_free_tx_ccs(local)) {
        case ECCSBUSY:
                DEBUG(2, "ray_hw_xmit tx_ccs table busy\n");
        case ECCSFULL:
                DEBUG(2, "ray_hw_xmit No free tx ccs\n");
        case ECARDGONE:
                netif_stop_queue(dev);
                return XMIT_NO_CCS;
        default:
                break;
        }
        addr = TX_BUF_BASE + (ccsindex << 11);

        if (msg_type == DATA_TYPE) {
                local->stats.tx_bytes += len;
                local->stats.tx_packets++;
        }

        ptx = local->sram + addr;

        ray_build_header(local, ptx, msg_type, data);
        if (translate) {
                offset = translate_frame(local, ptx, data, len);
        } else { /* Encapsulate frame */
                /* TBD TIB length will move address of ptx->var */

                memcpy_toio(&ptx->var, data, len);
                offset = 0;
        }

        /* fill in the CCS */
        pccs = ccs_base(local) + ccsindex;
        len += TX_HEADER_LENGTH + offset;
        writeb(CCS_TX_REQUEST, &pccs->cmd);
        writeb(addr >> 8, &pccs->var.tx_request.tx_data_ptr[0]);
        writeb(local->tib_length, &pccs->var.tx_request.tx_data_ptr[1]);
        writeb(len >> 8, &pccs->var.tx_request.tx_data_length[0]);
        writeb(len & 0xff, &pccs->var.tx_request.tx_data_length[1]);
/* TBD still need psm_cam? */
        writeb(PSM_CAM, &pccs->var.tx_request.pow_sav_mode);
        writeb(local->net_default_tx_rate, &pccs->var.tx_request.tx_rate);
        writeb(0, &pccs->var.tx_request.antenna);
        DEBUG(3, "ray_hw_xmit default_tx_rate = 0x%x\n",
              local->net_default_tx_rate);

        /* Interrupt the firmware to process the command */
        if (interrupt_ecf(local, ccsindex)) {
                DEBUG(2, "ray_hw_xmit failed - ECF not ready for intr\n");
/* TBD very inefficient to copy packet to buffer, and then not
   send it, but the alternative is to queue the messages and that
   won't be done for a while.  Maybe set tbusy until a CCS is free?
*/
                writeb(CCS_BUFFER_FREE, &pccs->buffer_status);
                return XMIT_NO_INTR;
        }
        return XMIT_OK;
} /* end ray_hw_xmit */

/*===========================================================================*/
static int translate_frame(ray_dev_t *local, struct tx_msg __iomem *ptx,
                           unsigned char *data, int len)
{
        __be16 proto = ((struct ethhdr *)data)->h_proto;
        if (ntohs(proto) >= 1536) { /* DIX II ethernet frame */
                DEBUG(3, "ray_cs translate_frame DIX II\n");
                /* Copy LLC header to card buffer */
                memcpy_toio(&ptx->var, eth2_llc, sizeof(eth2_llc));
                memcpy_toio(((void __iomem *)&ptx->var) + sizeof(eth2_llc),
                            (UCHAR *) &proto, 2);
                if (proto == htons(ETH_P_AARP) || proto == htons(ETH_P_IPX)) {
                        /* This is the selective translation table, only 2 entries */
                        writeb(0xf8,
                               &((struct snaphdr_t __iomem *)ptx->var)->org[3]);
                }
                /* Copy body of ethernet packet without ethernet header */
                memcpy_toio((void __iomem *)&ptx->var +
                            sizeof(struct snaphdr_t), data + ETH_HLEN,
                            len - ETH_HLEN);
                return (int)sizeof(struct snaphdr_t) - ETH_HLEN;
        } else { /* already  802 type, and proto is length */
                DEBUG(3, "ray_cs translate_frame 802\n");
                if (proto == htons(0xffff)) { /* evil netware IPX 802.3 without LLC */
                        DEBUG(3, "ray_cs translate_frame evil IPX\n");
                        memcpy_toio(&ptx->var, data + ETH_HLEN, len - ETH_HLEN);
                        return 0 - ETH_HLEN;
                }
                memcpy_toio(&ptx->var, data + ETH_HLEN, len - ETH_HLEN);
                return 0 - ETH_HLEN;
        }
        /* TBD do other frame types */
} /* end translate_frame */

/*===========================================================================*/
static void ray_build_header(ray_dev_t *local, struct tx_msg __iomem *ptx,
                             UCHAR msg_type, unsigned char *data)
{
        writeb(PROTOCOL_VER | msg_type, &ptx->mac.frame_ctl_1);
/*** IEEE 802.11 Address field assignments *************
                TODS    FROMDS  addr_1          addr_2          addr_3  addr_4
Adhoc           0       0       dest            src (terminal)  BSSID   N/A
AP to Terminal  0       1       dest            AP(BSSID)       source  N/A
Terminal to AP  1       0       AP(BSSID)       src (terminal)  dest    N/A
AP to AP        1       1       dest AP         src AP          dest    source
*******************************************************/
        if (local->net_type == ADHOC) {
                writeb(0, &ptx->mac.frame_ctl_2);
                memcpy_toio(ptx->mac.addr_1, ((struct ethhdr *)data)->h_dest,
                            2 * ADDRLEN);
                memcpy_toio(ptx->mac.addr_3, local->bss_id, ADDRLEN);
        } else { /* infrastructure */

                if (local->sparm.b4.a_acting_as_ap_status) {
                        writeb(FC2_FROM_DS, &ptx->mac.frame_ctl_2);
                        memcpy_toio(ptx->mac.addr_1,
                                    ((struct ethhdr *)data)->h_dest, ADDRLEN);
                        memcpy_toio(ptx->mac.addr_2, local->bss_id, 6);
                        memcpy_toio(ptx->mac.addr_3,
                                    ((struct ethhdr *)data)->h_source, ADDRLEN);
                } else { /* Terminal */

                        writeb(FC2_TO_DS, &ptx->mac.frame_ctl_2);
                        memcpy_toio(ptx->mac.addr_1, local->bss_id, ADDRLEN);
                        memcpy_toio(ptx->mac.addr_2,
                                    ((struct ethhdr *)data)->h_source, ADDRLEN);
                        memcpy_toio(ptx->mac.addr_3,
                                    ((struct ethhdr *)data)->h_dest, ADDRLEN);
                }
        }
} /* end encapsulate_frame */

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

static void netdev_get_drvinfo(struct net_device *dev,
                               struct ethtool_drvinfo *info)
{
        strcpy(info->driver, "ray_cs");
}

static const struct ethtool_ops netdev_ethtool_ops = {
        .get_drvinfo = netdev_get_drvinfo,
};

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

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : get protocol name
 */
static int ray_get_name(struct net_device *dev,
                        struct iw_request_info *info, char *cwrq, char *extra)
{
        strcpy(cwrq, "IEEE 802.11-FH");
        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : set frequency
 */
static int ray_set_freq(struct net_device *dev,
                        struct iw_request_info *info,
                        struct iw_freq *fwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);
        int err = -EINPROGRESS; /* Call commit handler */

        /* Reject if card is already initialised */
        if (local->card_status != CARD_AWAITING_PARAM)
                return -EBUSY;

        /* Setting by channel number */
        if ((fwrq->m > USA_HOP_MOD) || (fwrq->e > 0))
                err = -EOPNOTSUPP;
        else
                local->sparm.b5.a_hop_pattern = fwrq->m;

        return err;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : get frequency
 */
static int ray_get_freq(struct net_device *dev,
                        struct iw_request_info *info,
                        struct iw_freq *fwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);

        fwrq->m = local->sparm.b5.a_hop_pattern;
        fwrq->e = 0;
        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : set ESSID
 */
static int ray_set_essid(struct net_device *dev,
                         struct iw_request_info *info,
                         struct iw_point *dwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);

        /* Reject if card is already initialised */
        if (local->card_status != CARD_AWAITING_PARAM)
                return -EBUSY;

        /* Check if we asked for `any' */
        if (dwrq->flags == 0) {
                /* Corey : can you do that ? */
                return -EOPNOTSUPP;
        } else {
                /* Check the size of the string */
                if (dwrq->length > IW_ESSID_MAX_SIZE) {
                        return -E2BIG;
                }

                /* Set the ESSID in the card */
                memset(local->sparm.b5.a_current_ess_id, 0, IW_ESSID_MAX_SIZE);
                memcpy(local->sparm.b5.a_current_ess_id, extra, dwrq->length);
        }

        return -EINPROGRESS;    /* Call commit handler */
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : get ESSID
 */
static int ray_get_essid(struct net_device *dev,
                         struct iw_request_info *info,
                         struct iw_point *dwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);

        /* Get the essid that was set */
        memcpy(extra, local->sparm.b5.a_current_ess_id, IW_ESSID_MAX_SIZE);

        /* Push it out ! */
        dwrq->length = strlen(extra);
        dwrq->flags = 1;        /* active */

        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : get AP address
 */
static int ray_get_wap(struct net_device *dev,
                       struct iw_request_info *info,
                       struct sockaddr *awrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);

        memcpy(awrq->sa_data, local->bss_id, ETH_ALEN);
        awrq->sa_family = ARPHRD_ETHER;

        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : set Bit-Rate
 */
static int ray_set_rate(struct net_device *dev,
                        struct iw_request_info *info,
                        struct iw_param *vwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);

        /* Reject if card is already initialised */
        if (local->card_status != CARD_AWAITING_PARAM)
                return -EBUSY;

        /* Check if rate is in range */
        if ((vwrq->value != 1000000) && (vwrq->value != 2000000))
                return -EINVAL;

        /* Hack for 1.5 Mb/s instead of 2 Mb/s */
        if ((local->fw_ver == 0x55) &&  /* Please check */
            (vwrq->value == 2000000))
                local->net_default_tx_rate = 3;
        else
                local->net_default_tx_rate = vwrq->value / 500000;

        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : get Bit-Rate
 */
static int ray_get_rate(struct net_device *dev,
                        struct iw_request_info *info,
                        struct iw_param *vwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);

        if (local->net_default_tx_rate == 3)
                vwrq->value = 2000000;  /* Hum... */
        else
                vwrq->value = local->net_default_tx_rate * 500000;
        vwrq->fixed = 0;        /* We are in auto mode */

        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : set RTS threshold
 */
static int ray_set_rts(struct net_device *dev,
                       struct iw_request_info *info,
                       struct iw_param *vwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);
        int rthr = vwrq->value;

        /* Reject if card is already initialised */
        if (local->card_status != CARD_AWAITING_PARAM)
                return -EBUSY;

        /* if(wrq->u.rts.fixed == 0) we should complain */
        if (vwrq->disabled)
                rthr = 32767;
        else {
                if ((rthr < 0) || (rthr > 2347))   /* What's the max packet size ??? */
                        return -EINVAL;
        }
        local->sparm.b5.a_rts_threshold[0] = (rthr >> 8) & 0xFF;
        local->sparm.b5.a_rts_threshold[1] = rthr & 0xFF;

        return -EINPROGRESS;    /* Call commit handler */
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : get RTS threshold
 */
static int ray_get_rts(struct net_device *dev,
                       struct iw_request_info *info,
                       struct iw_param *vwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);

        vwrq->value = (local->sparm.b5.a_rts_threshold[0] << 8)
            + local->sparm.b5.a_rts_threshold[1];
        vwrq->disabled = (vwrq->value == 32767);
        vwrq->fixed = 1;

        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : set Fragmentation threshold
 */
static int ray_set_frag(struct net_device *dev,
                        struct iw_request_info *info,
                        struct iw_param *vwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);
        int fthr = vwrq->value;

        /* Reject if card is already initialised */
        if (local->card_status != CARD_AWAITING_PARAM)
                return -EBUSY;

        /* if(wrq->u.frag.fixed == 0) should complain */
        if (vwrq->disabled)
                fthr = 32767;
        else {
                if ((fthr < 256) || (fthr > 2347))      /* To check out ! */
                        return -EINVAL;
        }
        local->sparm.b5.a_frag_threshold[0] = (fthr >> 8) & 0xFF;
        local->sparm.b5.a_frag_threshold[1] = fthr & 0xFF;

        return -EINPROGRESS;    /* Call commit handler */
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : get Fragmentation threshold
 */
static int ray_get_frag(struct net_device *dev,
                        struct iw_request_info *info,
                        struct iw_param *vwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);

        vwrq->value = (local->sparm.b5.a_frag_threshold[0] << 8)
            + local->sparm.b5.a_frag_threshold[1];
        vwrq->disabled = (vwrq->value == 32767);
        vwrq->fixed = 1;

        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : set Mode of Operation
 */
static int ray_set_mode(struct net_device *dev,
                        struct iw_request_info *info, __u32 *uwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);
        int err = -EINPROGRESS; /* Call commit handler */
        char card_mode = 1;

        /* Reject if card is already initialised */
        if (local->card_status != CARD_AWAITING_PARAM)
                return -EBUSY;

        switch (*uwrq) {
        case IW_MODE_ADHOC:
                card_mode = 0;
                /* Fall through */
        case IW_MODE_INFRA:
                local->sparm.b5.a_network_type = card_mode;
                break;
        default:
                err = -EINVAL;
        }

        return err;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : get Mode of Operation
 */
static int ray_get_mode(struct net_device *dev,
                        struct iw_request_info *info, __u32 *uwrq, char *extra)
{
        ray_dev_t *local = netdev_priv(dev);

        if (local->sparm.b5.a_network_type)
                *uwrq = IW_MODE_INFRA;
        else
                *uwrq = IW_MODE_ADHOC;

        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Handler : get range info
 */
static int ray_get_range(struct net_device *dev,
                         struct iw_request_info *info,
                         struct iw_point *dwrq, char *extra)
{
        struct iw_range *range = (struct iw_range *)extra;

        memset((char *)range, 0, sizeof(struct iw_range));

        /* Set the length (very important for backward compatibility) */
        dwrq->length = sizeof(struct iw_range);

        /* Set the Wireless Extension versions */
        range->we_version_compiled = WIRELESS_EXT;
        range->we_version_source = 9;

        /* Set information in the range struct */
        range->throughput = 1.1 * 1000 * 1000;  /* Put the right number here */
        range->num_channels = hop_pattern_length[(int)country];
        range->num_frequency = 0;
        range->max_qual.qual = 0;
        range->max_qual.level = 255;    /* What's the correct value ? */
        range->max_qual.noise = 255;    /* Idem */
        range->num_bitrates = 2;
        range->bitrate[0] = 1000000;    /* 1 Mb/s */
        range->bitrate[1] = 2000000;    /* 2 Mb/s */
        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Private Handler : set framing mode
 */
static int ray_set_framing(struct net_device *dev,
                           struct iw_request_info *info,
                           union iwreq_data *wrqu, char *extra)
{
        translate = *(extra);   /* Set framing mode */

        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Private Handler : get framing mode
 */
static int ray_get_framing(struct net_device *dev,
                           struct iw_request_info *info,
                           union iwreq_data *wrqu, char *extra)
{
        *(extra) = translate;

        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Wireless Private Handler : get country
 */
static int ray_get_country(struct net_device *dev,
                           struct iw_request_info *info,
                           union iwreq_data *wrqu, char *extra)
{
        *(extra) = country;

        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Commit handler : called after a bunch of SET operations
 */
static int ray_commit(struct net_device *dev, struct iw_request_info *info,     /* NULL */
                      void *zwrq,       /* NULL */
                      char *extra)
{ /* NULL */
        return 0;
}

/*------------------------------------------------------------------*/
/*
 * Stats handler : return Wireless Stats
 */
static iw_stats *ray_get_wireless_stats(struct net_device *dev)
{
        ray_dev_t *local = netdev_priv(dev);
        struct pcmcia_device *link = local->finder;
        struct status __iomem *p = local->sram + STATUS_BASE;

        if (local == (ray_dev_t *) NULL)
                return (iw_stats *) NULL;

        local->wstats.status = local->card_status;
#ifdef WIRELESS_SPY
        if ((local->spy_data.spy_number > 0)
            && (local->sparm.b5.a_network_type == 0)) {
                /* Get it from the first node in spy list */
                local->wstats.qual.qual = local->spy_data.spy_stat[0].qual;
                local->wstats.qual.level = local->spy_data.spy_stat[0].level;
                local->wstats.qual.noise = local->spy_data.spy_stat[0].noise;
                local->wstats.qual.updated =
                    local->spy_data.spy_stat[0].updated;
        }
#endif /* WIRELESS_SPY */

        if (pcmcia_dev_present(link)) {
                local->wstats.qual.noise = readb(&p->rxnoise);
                local->wstats.qual.updated |= 4;
        }

        return &local->wstats;
} /* end ray_get_wireless_stats */

/*------------------------------------------------------------------*/
/*
 * Structures to export the Wireless Handlers
 */

static const iw_handler ray_handler[] = {
        [SIOCSIWCOMMIT - SIOCIWFIRST] = (iw_handler) ray_commit,
        [SIOCGIWNAME - SIOCIWFIRST] = (iw_handler) ray_get_name,
        [SIOCSIWFREQ - SIOCIWFIRST] = (iw_handler) ray_set_freq,
        [SIOCGIWFREQ - SIOCIWFIRST] = (iw_handler) ray_get_freq,
        [SIOCSIWMODE - SIOCIWFIRST] = (iw_handler) ray_set_mode,
        [SIOCGIWMODE - SIOCIWFIRST] = (iw_handler) ray_get_mode,
        [SIOCGIWRANGE - SIOCIWFIRST] = (iw_handler) ray_get_range,
#ifdef WIRELESS_SPY
        [SIOCSIWSPY - SIOCIWFIRST] = (iw_handler) iw_handler_set_spy,
        [SIOCGIWSPY - SIOCIWFIRST] = (iw_handler) iw_handler_get_spy,
        [SIOCSIWTHRSPY - SIOCIWFIRST] = (iw_handler) iw_handler_set_thrspy,
        [SIOCGIWTHRSPY - SIOCIWFIRST] = (iw_handler) iw_handler_get_thrspy,
#endif /* WIRELESS_SPY */
        [SIOCGIWAP - SIOCIWFIRST] = (iw_handler) ray_get_wap,
        [SIOCSIWESSID - SIOCIWFIRST] = (iw_handler) ray_set_essid,
        [SIOCGIWESSID - SIOCIWFIRST] = (iw_handler) ray_get_essid,
        [SIOCSIWRATE - SIOCIWFIRST] = (iw_handler) ray_set_rate,
        [SIOCGIWRATE - SIOCIWFIRST] = (iw_handler) ray_get_rate,
        [SIOCSIWRTS - SIOCIWFIRST] = (iw_handler) ray_set_rts,
        [SIOCGIWRTS - SIOCIWFIRST] = (iw_handler) ray_get_rts,
        [SIOCSIWFRAG - SIOCIWFIRST] = (iw_handler) ray_set_frag,
        [SIOCGIWFRAG - SIOCIWFIRST] = (iw_handler) ray_get_frag,
};

#define SIOCSIPFRAMING  SIOCIWFIRSTPRIV /* Set framing mode */
#define SIOCGIPFRAMING  SIOCIWFIRSTPRIV + 1     /* Get framing mode */
#define SIOCGIPCOUNTRY  SIOCIWFIRSTPRIV + 3     /* Get country code */

static const iw_handler ray_private_handler[] = {
        [0] = (iw_handler) ray_set_framing,
        [1] = (iw_handler) ray_get_framing,
        [3] = (iw_handler) ray_get_country,
};

static const struct iw_priv_args ray_private_args[] = {
/* cmd,         set_args,       get_args,       name */
        {SIOCSIPFRAMING, IW_PRIV_TYPE_BYTE | IW_PRIV_SIZE_FIXED | 1, 0,
         "set_framing"},
        {SIOCGIPFRAMING, 0, IW_PRIV_TYPE_BYTE | IW_PRIV_SIZE_FIXED | 1,
         "get_framing"},
        {SIOCGIPCOUNTRY, 0, IW_PRIV_TYPE_BYTE | IW_PRIV_SIZE_FIXED | 1,
         "get_country"},
};

static const struct iw_handler_def ray_handler_def = {
        .num_standard = ARRAY_SIZE(ray_handler),
        .num_private = ARRAY_SIZE(ray_private_handler),
        .num_private_args = ARRAY_SIZE(ray_private_args),
        .standard = ray_handler,
        .private = ray_private_handler,
        .private_args = ray_private_args,
        .get_wireless_stats = ray_get_wireless_stats,
};

/*===========================================================================*/
static int ray_open(struct net_device *dev)
{
        ray_dev_t *local = netdev_priv(dev);
        struct pcmcia_device *link;
        link = local->finder;

        DEBUG(1, "ray_open('%s')\n", dev->name);

        if (link->open == 0)
                local->num_multi = 0;
        link->open++;

        /* If the card is not started, time to start it ! - Jean II */
        if (local->card_status == CARD_AWAITING_PARAM) {
                int i;

                DEBUG(1, "ray_open: doing init now !\n");

                /* Download startup parameters */
                if ((i = dl_startup_params(dev)) < 0) {
                        printk(KERN_INFO
                               "ray_dev_init dl_startup_params failed - "
                               "returns 0x%x\n", i);
                        return -1;
                }
        }

        if (sniffer)
                netif_stop_queue(dev);
        else
                netif_start_queue(dev);

        DEBUG(2, "ray_open ending\n");
        return 0;
} /* end ray_open */

/*===========================================================================*/
static int ray_dev_close(struct net_device *dev)
{
        ray_dev_t *local = netdev_priv(dev);
        struct pcmcia_device *link;
        link = local->finder;

        DEBUG(1, "ray_dev_close('%s')\n", dev->name);

        link->open--;
        netif_stop_queue(dev);

        /* In here, we should stop the hardware (stop card from beeing active)
         * and set local->card_status to CARD_AWAITING_PARAM, so that while the
         * card is closed we can chage its configuration.
         * Probably also need a COR reset to get sane state - Jean II */

        return 0;
} /* end ray_dev_close */

/*===========================================================================*/
static void ray_reset(struct net_device *dev)
{
        DEBUG(1, "ray_reset entered\n");
        return;
}

/*===========================================================================*/
/* Cause a firmware interrupt if it is ready for one                         */
/* Return nonzero if not ready                                               */
static int interrupt_ecf(ray_dev_t *local, int ccs)
{
        int i = 50;
        struct pcmcia_device *link = local->finder;

        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_cs interrupt_ecf - device not present\n");
                return -1;
        }
        DEBUG(2, "interrupt_ecf(local=%p, ccs = 0x%x\n", local, ccs);

        while (i &&
               (readb(local->amem + CIS_OFFSET + ECF_INTR_OFFSET) &
                ECF_INTR_SET))
                i--;
        if (i == 0) {
                DEBUG(2, "ray_cs interrupt_ecf card not ready for interrupt\n");
                return -1;
        }
        /* Fill the mailbox, then kick the card */
        writeb(ccs, local->sram + SCB_BASE);
        writeb(ECF_INTR_SET, local->amem + CIS_OFFSET + ECF_INTR_OFFSET);
        return 0;
} /* interrupt_ecf */

/*===========================================================================*/
/* Get next free transmit CCS                                                */
/* Return - index of current tx ccs                                          */
static int get_free_tx_ccs(ray_dev_t *local)
{
        int i;
        struct ccs __iomem *pccs = ccs_base(local);
        struct pcmcia_device *link = local->finder;

        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_cs get_free_tx_ccs - device not present\n");
                return ECARDGONE;
        }

        if (test_and_set_bit(0, &local->tx_ccs_lock)) {
                DEBUG(1, "ray_cs tx_ccs_lock busy\n");
                return ECCSBUSY;
        }

        for (i = 0; i < NUMBER_OF_TX_CCS; i++) {
                if (readb(&(pccs + i)->buffer_status) == CCS_BUFFER_FREE) {
                        writeb(CCS_BUFFER_BUSY, &(pccs + i)->buffer_status);
                        writeb(CCS_END_LIST, &(pccs + i)->link);
                        local->tx_ccs_lock = 0;
                        return i;
                }
        }
        local->tx_ccs_lock = 0;
        DEBUG(2, "ray_cs ERROR no free tx CCS for raylink card\n");
        return ECCSFULL;
} /* get_free_tx_ccs */

/*===========================================================================*/
/* Get next free CCS                                                         */
/* Return - index of current ccs                                             */
static int get_free_ccs(ray_dev_t *local)
{
        int i;
        struct ccs __iomem *pccs = ccs_base(local);
        struct pcmcia_device *link = local->finder;

        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_cs get_free_ccs - device not present\n");
                return ECARDGONE;
        }
        if (test_and_set_bit(0, &local->ccs_lock)) {
                DEBUG(1, "ray_cs ccs_lock busy\n");
                return ECCSBUSY;
        }

        for (i = NUMBER_OF_TX_CCS; i < NUMBER_OF_CCS; i++) {
                if (readb(&(pccs + i)->buffer_status) == CCS_BUFFER_FREE) {
                        writeb(CCS_BUFFER_BUSY, &(pccs + i)->buffer_status);
                        writeb(CCS_END_LIST, &(pccs + i)->link);
                        local->ccs_lock = 0;
                        return i;
                }
        }
        local->ccs_lock = 0;
        DEBUG(1, "ray_cs ERROR no free CCS for raylink card\n");
        return ECCSFULL;
} /* get_free_ccs */

/*===========================================================================*/
static void authenticate_timeout(u_long data)
{
        ray_dev_t *local = (ray_dev_t *) data;
        del_timer(&local->timer);
        printk(KERN_INFO "ray_cs Authentication with access point failed"
               " - timeout\n");
        join_net((u_long) local);
}

/*===========================================================================*/
static int asc_to_int(char a)
{
        if (a < '0')
                return -1;
        if (a <= '9')
                return (a - '0');
        if (a < 'A')
                return -1;
        if (a <= 'F')
                return (10 + a - 'A');
        if (a < 'a')
                return -1;
        if (a <= 'f')
                return (10 + a - 'a');
        return -1;
}

/*===========================================================================*/
static int parse_addr(char *in_str, UCHAR *out)
{
        int len;
        int i, j, k;
        int status;

        if (in_str == NULL)
                return 0;
        if ((len = strlen(in_str)) < 2)
                return 0;
        memset(out, 0, ADDRLEN);

        status = 1;
        j = len - 1;
        if (j > 12)
                j = 12;
        i = 5;

        while (j > 0) {
                if ((k = asc_to_int(in_str[j--])) != -1)
                        out[i] = k;
                else
                        return 0;

                if (j == 0)
                        break;
                if ((k = asc_to_int(in_str[j--])) != -1)
                        out[i] += k << 4;
                else
                        return 0;
                if (!i--)
                        break;
        }
        return status;
}

/*===========================================================================*/
static struct net_device_stats *ray_get_stats(struct net_device *dev)
{
        ray_dev_t *local = netdev_priv(dev);
        struct pcmcia_device *link = local->finder;
        struct status __iomem *p = local->sram + STATUS_BASE;
        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_cs net_device_stats - device not present\n");
                return &local->stats;
        }
        if (readb(&p->mrx_overflow_for_host)) {
                local->stats.rx_over_errors += swab16(readw(&p->mrx_overflow));
                writeb(0, &p->mrx_overflow);
                writeb(0, &p->mrx_overflow_for_host);
        }
        if (readb(&p->mrx_checksum_error_for_host)) {
                local->stats.rx_crc_errors +=
                    swab16(readw(&p->mrx_checksum_error));
                writeb(0, &p->mrx_checksum_error);
                writeb(0, &p->mrx_checksum_error_for_host);
        }
        if (readb(&p->rx_hec_error_for_host)) {
                local->stats.rx_frame_errors += swab16(readw(&p->rx_hec_error));
                writeb(0, &p->rx_hec_error);
                writeb(0, &p->rx_hec_error_for_host);
        }
        return &local->stats;
}

/*===========================================================================*/
static void ray_update_parm(struct net_device *dev, UCHAR objid, UCHAR *value,
                            int len)
{
        ray_dev_t *local = netdev_priv(dev);
        struct pcmcia_device *link = local->finder;
        int ccsindex;
        int i;
        struct ccs __iomem *pccs;

        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_update_parm - device not present\n");
                return;
        }

        if ((ccsindex = get_free_ccs(local)) < 0) {
                DEBUG(0, "ray_update_parm - No free ccs\n");
                return;
        }
        pccs = ccs_base(local) + ccsindex;
        writeb(CCS_UPDATE_PARAMS, &pccs->cmd);
        writeb(objid, &pccs->var.update_param.object_id);
        writeb(1, &pccs->var.update_param.number_objects);
        writeb(0, &pccs->var.update_param.failure_cause);
        for (i = 0; i < len; i++) {
                writeb(value[i], local->sram + HOST_TO_ECF_BASE);
        }
        /* Interrupt the firmware to process the command */
        if (interrupt_ecf(local, ccsindex)) {
                DEBUG(0, "ray_cs associate failed - ECF not ready for intr\n");
                writeb(CCS_BUFFER_FREE, &(pccs++)->buffer_status);
        }
}

/*===========================================================================*/
static void ray_update_multi_list(struct net_device *dev, int all)
{
        struct dev_mc_list *dmi, **dmip;
        int ccsindex;
        struct ccs __iomem *pccs;
        int i = 0;
        ray_dev_t *local = netdev_priv(dev);
        struct pcmcia_device *link = local->finder;
        void __iomem *p = local->sram + HOST_TO_ECF_BASE;

        if (!(pcmcia_dev_present(link))) {
                DEBUG(2, "ray_update_multi_list - device not present\n");
                return;
        } else
                DEBUG(2, "ray_update_multi_list(%p)\n", dev);
        if ((ccsindex = get_free_ccs(local)) < 0) {
                DEBUG(1, "ray_update_multi - No free ccs\n");
                return;
        }
        pccs = ccs_base(local) + ccsindex;
        writeb(CCS_UPDATE_MULTICAST_LIST, &pccs->cmd);

        if (all) {
                writeb(0xff, &pccs->var);
                local->num_multi = 0xff;
        } else {
                /* Copy the kernel's list of MC addresses to card */
                for (dmip = &dev->mc_list; (dmi = *dmip) != NULL;
                     dmip = &dmi->next) {
                        memcpy_toio(p, dmi->dmi_addr, ETH_ALEN);
                        DEBUG(1,
                              "ray_update_multi add addr %02x%02x%02x%02x%02x%02x\n",
                              dmi->dmi_addr[0], dmi->dmi_addr[1],
                              dmi->dmi_addr[2], dmi->dmi_addr[3],
                              dmi->dmi_addr[4], dmi->dmi_addr[5]);
                        p += ETH_ALEN;
                        i++;
                }
                if (i > 256 / ADDRLEN)
                        i = 256 / ADDRLEN;
                writeb((UCHAR) i, &pccs->var);
                DEBUG(1, "ray_cs update_multi %d addresses in list\n", i);
                /* Interrupt the firmware to process the command */
                local->num_multi = i;
        }
        if (interrupt_ecf(local, ccsindex)) {
                DEBUG(1,
                      "ray_cs update_multi failed - ECF not ready for intr\n");
                writeb(CCS_BUFFER_FREE, &(pccs++)->buffer_status);
        }
} /* end ray_update_multi_list */

/*===========================================================================*/
static void set_multicast_list(struct net_device *dev)
{
        ray_dev_t *local = netdev_priv(dev);
        UCHAR promisc;

        DEBUG(2, "ray_cs set_multicast_list(%p)\n", dev);

        if (dev->flags & IFF_PROMISC) {
                if (local->sparm.b5.a_promiscuous_mode == 0) {
                        DEBUG(1, "ray_cs set_multicast_list promisc on\n");
                        local->sparm.b5.a_promiscuous_mode = 1;
                        promisc = 1;
                        ray_update_parm(dev, OBJID_promiscuous_mode,
                                        &promisc, sizeof(promisc));
                }
        } else {
                if (local->sparm.b5.a_promiscuous_mode == 1) {
                        DEBUG(1, "ray_cs set_multicast_list promisc off\n");
                        local->sparm.b5.a_promiscuous_mode = 0;
                        promisc = 0;
                        ray_update_parm(dev, OBJID_promiscuous_mode,
                                        &promisc, sizeof(promisc));
                }
        }

        if (dev->flags & IFF_ALLMULTI)
                ray_update_multi_list(dev, 1);
        else {
                if (local->num_multi != dev->mc_count)
                        ray_update_multi_list(dev, 0);
        }
} /* end set_multicast_list */

/*=============================================================================
 * All routines below here are run at interrupt time.
=============================================================================*/
static irqreturn_t ray_interrupt(int irq, void *dev_id)
{
        struct net_device *dev = (struct net_device *)dev_id;
        struct pcmcia_device *link;
        ray_dev_t *local;
        struct ccs __iomem *pccs;
        struct rcs __iomem *prcs;
        UCHAR rcsindex;
        UCHAR tmp;
        UCHAR cmd;
        UCHAR status;

        if (dev == NULL)        /* Note that we want interrupts with dev->start == 0 */
                return IRQ_NONE;

        DEBUG(4, "ray_cs: interrupt for *dev=%p\n", dev);

        local = netdev_priv(dev);
        link = (struct pcmcia_device *)local->finder;
        if (!pcmcia_dev_present(link)) {
                DEBUG(2,
                      "ray_cs interrupt from device not present or suspended.\n");
                return IRQ_NONE;
        }
        rcsindex = readb(&((struct scb __iomem *)(local->sram))->rcs_index);

        if (rcsindex >= (NUMBER_OF_CCS + NUMBER_OF_RCS)) {
                DEBUG(1, "ray_cs interrupt bad rcsindex = 0x%x\n", rcsindex);
                clear_interrupt(local);
                return IRQ_HANDLED;