unioxx5.c

Go to the documentation of this file.

/***************************************************************************
 *                                                                         *
 *  comedi/drivers/unioxx5.c                                               *
 *  Driver for Fastwel UNIOxx-5 (analog and digital i/o) boards.           *
 *                                                                         *
 *  Copyright (C) 2006 Kruchinin Daniil (asgard) [[email protected]]      *
 *                                                                         *
 *  COMEDI - Linux Control and Measurement Device Interface                *
 *  Copyright (C) 1998,2000 David A. Schleef <[email protected]>              *
 *                                                                         *
 *  This program is free software; you can redistribute it and/or modify   *
 *  it under the terms of the GNU General Public License as published by   *
 *  the Free Software Foundation; either version 2 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  This program 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., 675 Mass Ave, Cambridge, MA 02139, USA.              *
 *                                                                         *
 ***************************************************************************/
/*

Driver: unioxx5
Description: Driver for Fastwel UNIOxx-5 (analog and digital i/o) boards.
Author: Kruchinin Daniil (asgard) <[email protected]>
Status: unknown
Updated: 2006-10-09
Devices: [Fastwel] UNIOxx-5 (unioxx5),

 This card supports digital and analog I/O. It written for g01
 subdevices only.
 channels range: 0 .. 23 dio channels
 and 0 .. 11 analog modules range
 During attaching unioxx5 module displays modules identifiers
 (see dmesg after comedi_config) in format:
 | [module_number] module_id |

*/

#include "../comedidev.h"
#include <linux/ioport.h>
#include <linux/slab.h>

#define DRIVER_NAME "unioxx5"
#define UNIOXX5_SIZE 0x10
#define UNIOXX5_SUBDEV_BASE 0xA000  /* base addr of first subdev */
#define UNIOXX5_SUBDEV_ODDS 0x400

/* modules types */
#define MODULE_DIGITAL 0
#define MODULE_OUTPUT_MASK 0x80 /* analog input/output */

/* constants for digital i/o */
#define UNIOXX5_NUM_OF_CHANS 24

/* constants for analog i/o */
#define TxBE  0x10      /* transmit buffer enable */
#define RxCA  0x20      /* 1 receive character available */
#define Rx2CA 0x40      /* 2 receive character available */
#define Rx4CA 0x80      /* 4 receive character available */

/* bytes mask errors */
#define Rx2CA_ERR_MASK 0x04 /* 2 bytes receiving error */
#define Rx4CA_ERR_MASK 0x08 /* 4 bytes receiving error */

/* channel modes */
#define ALL_2_INPUT  0      /* config all digital channels to input */
#define ALL_2_OUTPUT 1      /* config all digital channels to output */

/* 'private' structure for each subdevice */
struct unioxx5_subd_priv {
    int usp_iobase;
    /* 12 modules. each can be 70L or 73L */
    unsigned char usp_module_type[12];
    /* for saving previous written value for analog modules */
    unsigned char usp_extra_data[12][4];
    unsigned char usp_prev_wr_val[3];   /* previous written value */
    unsigned char usp_prev_cn_val[3];   /* previous channel value */
};

static int __unioxx5_define_chan_offset(int chan_num)
{

    if (chan_num < 0 || chan_num > 23)
        return -1;

    return (chan_num >> 3) + 1;
}

#if 0               /* not used? */
static void __unioxx5_digital_config(struct unioxx5_subd_priv *usp, int mode)
{
    int i, mask;

    mask = (mode == ALL_2_OUTPUT) ? 0xFF : 0x00;
    printk("COMEDI: mode = %d\n", mask);

    outb(1, usp->usp_iobase + 0);

    for (i = 0; i < 3; i++)
        outb(mask, usp->usp_iobase + i);

    outb(0, usp->usp_iobase + 0);
}
#endif

/* configure channels for analog i/o (even to output, odd to input) */
static void __unioxx5_analog_config(struct unioxx5_subd_priv *usp, int channel)
{
    int chan_a, chan_b, conf, channel_offset;

    channel_offset = __unioxx5_define_chan_offset(channel);
    conf = usp->usp_prev_cn_val[channel_offset - 1];
    chan_a = chan_b = 1;

    /* setting channel A and channel B mask */
    if (channel % 2 == 0) {
        chan_a <<= channel & 0x07;
        chan_b <<= (channel + 1) & 0x07;
    } else {
        chan_a <<= (channel - 1) & 0x07;
        chan_b <<= channel & 0x07;
    }

    conf |= chan_a;     /* even channel ot output */
    conf &= ~chan_b;    /* odd channel to input */

    outb(1, usp->usp_iobase + 0);
    outb(conf, usp->usp_iobase + channel_offset);
    outb(0, usp->usp_iobase + 0);

    usp->usp_prev_cn_val[channel_offset - 1] = conf;
}

static int __unioxx5_digital_read(struct unioxx5_subd_priv *usp,
                  unsigned int *data, int channel, int minor)
{
    int channel_offset, mask = 1 << (channel & 0x07);

    channel_offset = __unioxx5_define_chan_offset(channel);
    if (channel_offset < 0) {
        printk(KERN_ERR
               "comedi%d: undefined channel %d. channel range is 0 .. 23\n",
               minor, channel);
        return 0;
    }

    *data = inb(usp->usp_iobase + channel_offset);
    *data &= mask;

    /* correct the read value to 0 or 1 */
    if (channel_offset > 1)
        channel -= 2 << channel_offset;
    *data >>= channel;
    return 1;
}

static int __unioxx5_analog_read(struct unioxx5_subd_priv *usp,
                 unsigned int *data, int channel, int minor)
{
    int module_no, read_ch;
    char control;

    module_no = channel / 2;
    read_ch = channel % 2;  /* depend on type of channel (A or B) */

    /* defining if given module can work on input */
    if (usp->usp_module_type[module_no] & MODULE_OUTPUT_MASK) {
        printk(KERN_ERR
               "comedi%d: module in position %d with id 0x%02x is for output only",
               minor, module_no, usp->usp_module_type[module_no]);
        return 0;
    }

    __unioxx5_analog_config(usp, channel);
    /* sends module number to card(1 .. 12) */
    outb(module_no + 1, usp->usp_iobase + 5);
    outb('V', usp->usp_iobase + 6); /* sends to module (V)erify command */
    control = inb(usp->usp_iobase); /* get control register byte */

    /* waits while reading four bytes will be allowed */
    while (!((control = inb(usp->usp_iobase + 0)) & Rx4CA))
        ;

    /* if four bytes readding error occurs - return 0(false) */
    if ((control & Rx4CA_ERR_MASK)) {
        printk("COMEDI: 4 bytes error\n");
        return 0;
    }

    if (read_ch)
        *data = inw(usp->usp_iobase + 6);   /* channel B */
    else
        *data = inw(usp->usp_iobase + 4);   /* channel A */

    return 1;
}

static int __unioxx5_digital_write(struct unioxx5_subd_priv *usp,
                   unsigned int *data, int channel, int minor)
{
    int channel_offset, val;
    int mask = 1 << (channel & 0x07);

    channel_offset = __unioxx5_define_chan_offset(channel);
    if (channel_offset < 0) {
        printk(KERN_ERR
               "comedi%d: undefined channel %d. channel range is 0 .. 23\n",
               minor, channel);
        return 0;
    }

    /* getting previous written value */
    val = usp->usp_prev_wr_val[channel_offset - 1];

    if (*data)
        val |= mask;
    else
        val &= ~mask;

    outb(val, usp->usp_iobase + channel_offset);
    /* saving new written value */
    usp->usp_prev_wr_val[channel_offset - 1] = val;

    return 1;
}

static int __unioxx5_analog_write(struct unioxx5_subd_priv *usp,
                  unsigned int *data, int channel, int minor)
{
    int module, i;

    module = channel / 2;   /* definig module number(0 .. 11) */
    i = (channel % 2) << 1; /* depends on type of channel (A or B) */

    /* defining if given module can work on output */
    if (!(usp->usp_module_type[module] & MODULE_OUTPUT_MASK)) {
        printk(KERN_ERR
               "comedi%d: module in position %d with id 0x%0x is for input only!\n",
               minor, module, usp->usp_module_type[module]);
        return 0;
    }

    __unioxx5_analog_config(usp, channel);
    /* saving minor byte */
    usp->usp_extra_data[module][i++] = (unsigned char)(*data & 0x00FF);
    /* saving major byte */
    usp->usp_extra_data[module][i] = (unsigned char)((*data & 0xFF00) >> 8);

    /* while(!((inb(usp->usp_iobase + 0)) & TxBE)); */
    /* sending module number to card(1 .. 12) */
    outb(module + 1, usp->usp_iobase + 5);
    outb('W', usp->usp_iobase + 6); /* sends (W)rite command to module */

    /* sending for bytes to module(one byte per cycle iteration) */
    for (i = 0; i < 4; i++) {
        while (!((inb(usp->usp_iobase + 0)) & TxBE))
            ;   /* waits while writting will be allowed */
        outb(usp->usp_extra_data[module][i], usp->usp_iobase + 6);
    }

    return 1;
}

static int unioxx5_subdev_read(struct comedi_device *dev,
                   struct comedi_subdevice *subdev,
                   struct comedi_insn *insn, unsigned int *data)
{
    struct unioxx5_subd_priv *usp = subdev->private;
    int channel, type;

    channel = CR_CHAN(insn->chanspec);
    /* defining module type(analog or digital) */
    type = usp->usp_module_type[channel / 2];

    if (type == MODULE_DIGITAL) {
        if (!__unioxx5_digital_read(usp, data, channel, dev->minor))
            return -1;
    } else {
        if (!__unioxx5_analog_read(usp, data, channel, dev->minor))
            return -1;
    }

    return 1;
}

static int unioxx5_subdev_write(struct comedi_device *dev,
                struct comedi_subdevice *subdev,
                struct comedi_insn *insn, unsigned int *data)
{
    struct unioxx5_subd_priv *usp = subdev->private;
    int channel, type;

    channel = CR_CHAN(insn->chanspec);
    /* defining module type(analog or digital) */
    type = usp->usp_module_type[channel / 2];

    if (type == MODULE_DIGITAL) {
        if (!__unioxx5_digital_write(usp, data, channel, dev->minor))
            return -1;
    } else {
        if (!__unioxx5_analog_write(usp, data, channel, dev->minor))
            return -1;
    }

    return 1;
}

/* for digital modules only */
static int unioxx5_insn_config(struct comedi_device *dev,
                   struct comedi_subdevice *subdev,
                   struct comedi_insn *insn, unsigned int *data)
{
    int channel_offset, flags, channel = CR_CHAN(insn->chanspec), type;
    struct unioxx5_subd_priv *usp = subdev->private;
    int mask = 1 << (channel & 0x07);

    type = usp->usp_module_type[channel / 2];

    if (type != MODULE_DIGITAL) {
        printk(KERN_ERR
               "comedi%d: channel configuration accessible only for digital modules\n",
               dev->minor);
        return -1;
    }

    channel_offset = __unioxx5_define_chan_offset(channel);
    if (channel_offset < 0) {
        printk(KERN_ERR
               "comedi%d: undefined channel %d. channel range is 0 .. 23\n",
               dev->minor, channel);
        return -1;
    }

    /* gets previously written value */
    flags = usp->usp_prev_cn_val[channel_offset - 1];

    switch (*data) {
    case COMEDI_INPUT:
        flags &= ~mask;
        break;
    case COMEDI_OUTPUT:
        flags |= mask;
        break;
    default:
        printk(KERN_ERR "comedi%d: unknown flag\n", dev->minor);
        return -1;
    }

    /*                                                        *\
     * sets channels buffer to 1(after this we are allowed to *
     * change channel type on input or output)                *
     \*                                                        */
    outb(1, usp->usp_iobase + 0);
    /* changes type of _one_ channel */
    outb(flags, usp->usp_iobase + channel_offset);
    /* sets channels bank to 0(allows directly input/output) */
    outb(0, usp->usp_iobase + 0);
    /* saves written value */
    usp->usp_prev_cn_val[channel_offset - 1] = flags;

    return 0;
}

/* initializing subdevice with given address */
static int __unioxx5_subdev_init(struct comedi_subdevice *subdev,
                 int subdev_iobase, int minor)
{
    struct unioxx5_subd_priv *usp;
    int i, to, ndef_flag = 0;

    if (!request_region(subdev_iobase, UNIOXX5_SIZE, DRIVER_NAME)) {
        printk(KERN_ERR "comedi%d: I/O port conflict\n", minor);
        return -EIO;
    }

    usp = kzalloc(sizeof(*usp), GFP_KERNEL);

    if (usp == NULL) {
        printk(KERN_ERR "comedi%d: error! --> out of memory!\n", minor);
        return -1;
    }

    usp->usp_iobase = subdev_iobase;
    printk(KERN_INFO "comedi%d: |", minor);

    /* defining modules types */
    for (i = 0; i < 12; i++) {
        to = 10000;

        __unioxx5_analog_config(usp, i * 2);
        /* sends channel number to card */
        outb(i + 1, subdev_iobase + 5);
        outb('H', subdev_iobase + 6);   /* requests EEPROM world */
        while (!(inb(subdev_iobase + 0) & TxBE))
            ;   /* waits while writting will be allowed */
        outb(0, subdev_iobase + 6);

        /* waits while reading of two bytes will be allowed */
        while (!(inb(subdev_iobase + 0) & Rx2CA)) {
            if (--to <= 0) {
                ndef_flag = 1;
                break;
            }
        }

        if (ndef_flag) {
            usp->usp_module_type[i] = 0;
            ndef_flag = 0;
        } else
            usp->usp_module_type[i] = inb(subdev_iobase + 6);

        printk(" [%d] 0x%02x |", i, usp->usp_module_type[i]);
        udelay(1);
    }

    printk("\n");

    /* initial subdevice for digital or analog i/o */
    subdev->type = COMEDI_SUBD_DIO;
    subdev->private = usp;
    subdev->subdev_flags = SDF_READABLE | SDF_WRITABLE;
    subdev->n_chan = UNIOXX5_NUM_OF_CHANS;
    subdev->maxdata = 0xFFF;
    subdev->range_table = &range_digital;
    subdev->insn_read = unioxx5_subdev_read;
    subdev->insn_write = unioxx5_subdev_write;
    /* for digital modules only!!! */
    subdev->insn_config = unioxx5_insn_config;

    printk(KERN_INFO "subdevice configured\n");

    return 0;
}

static int unioxx5_attach(struct comedi_device *dev,
              struct comedi_devconfig *it)
{
    int iobase, i, n_subd;
    int id, num, ba;
    int ret;

    iobase = it->options[0];

    dev->board_name = DRIVER_NAME;
    dev->iobase = iobase;
    iobase += UNIOXX5_SUBDEV_BASE;

    /* defining number of subdevices and getting they types (it must be 'g01')  */
    for (i = n_subd = 0, ba = iobase; i < 4; i++, ba += UNIOXX5_SUBDEV_ODDS) {
        id = inb(ba + 0xE);
        num = inb(ba + 0xF);

        if (id != 'g' || num != 1)
            continue;

        n_subd++;
    }

    /* unioxx5 can has from two to four subdevices */
    if (n_subd < 2) {
        printk(KERN_ERR
               "your card must has at least 2 'g01' subdevices\n");
        return -1;
    }

    ret = comedi_alloc_subdevices(dev, n_subd);
    if (ret)
        return ret;

    /* initializing each of for same subdevices */
    for (i = 0; i < n_subd; i++, iobase += UNIOXX5_SUBDEV_ODDS) {
        if (__unioxx5_subdev_init(&dev->subdevices[i], iobase,
                      dev->minor) < 0)
            return -1;
    }

    printk(KERN_INFO "attached\n");
    return 0;
}

static void unioxx5_detach(struct comedi_device *dev)
{
    int i;
    struct comedi_subdevice *subdev;
    struct unioxx5_subd_priv *usp;

    for (i = 0; i < dev->n_subdevices; i++) {
        subdev = &dev->subdevices[i];
        usp = subdev->private;
        release_region(usp->usp_iobase, UNIOXX5_SIZE);
        kfree(subdev->private);
    }
}

static struct comedi_driver unioxx5_driver = {
    .driver_name    = DRIVER_NAME,
    .module     = THIS_MODULE,
    .attach     = unioxx5_attach,
    .detach     = unioxx5_detach,
};
module_comedi_driver(unioxx5_driver);

MODULE_AUTHOR("Comedi http://www.comedi.org");
MODULE_DESCRIPTION("Comedi low-level driver");
MODULE_LICENSE("GPL");