New driver from Nickolay Petrov <nick@office.etersoft.ru>:
authorFrank Mori Hess <fmhess@speakeasy.net>
Tue, 10 Oct 2006 00:37:55 +0000 (00:37 +0000)
committerFrank Mori Hess <fmhess@speakeasy.net>
Tue, 10 Oct 2006 00:37:55 +0000 (00:37 +0000)
Driver for Fastwel UNIOxx-5 (analog and digital i/o) boards.
Copyright (C) 2006 Kruchinin Daniil (asgard) [asgard@etersoft.ru]

comedi/drivers/Kbuild
comedi/drivers/Makefile.am
comedi/drivers/unioxx5.c [new file with mode: 0644]

index dd60c581a265f7477706a40989802b368768b64b..921d816fdcb0c86139b8d88e3ecd54f9354e6c4b 100644 (file)
@@ -100,4 +100,4 @@ obj-m += ssv_dnp.o
 obj-m += s526.o
 obj-m += s626.o
 obj-m += comedi_test.o
-
+obj-m += unioxx5.o
index c33f2da9b931be2576a14aa4d572795a24838e74..4e3150b323f13a1c573ce7c68896385b47545a49 100644 (file)
@@ -165,6 +165,7 @@ module_PROGRAMS = \
  s526.ko \
  s626.ko \
  comedi_test.ko \
+ unioxx5.ko \
  $(pcmcia_modules) \
  $(usb_modules) \
  $(rt_modules)
@@ -261,6 +262,7 @@ ssv_dnp_ko_SOURCES = ssv_dnp.c
 s526_ko_SOURCES = s526.c
 s626_ko_SOURCES = s626.c
 comedi_test_ko_SOURCES = comedi_test.c
+unioxx5_ko_SOURCES = unioxx5.c
 usbdux_ko_SOURCES = usbdux.c
 usbduxfast_ko_SOURCES = usbduxfast.c
 
diff --git a/comedi/drivers/unioxx5.c b/comedi/drivers/unioxx5.c
new file mode 100644 (file)
index 0000000..de18d2f
--- /dev/null
@@ -0,0 +1,506 @@
+/***************************************************************************\
+ *                                                                         *
+ *  comedi/drivers/unioxx5.c                                               *
+ *  Driver for Fastwel UNIOxx-5 (analog and digital i/o) boards.           *
+ *                                                                         *
+ *  Copyright (C) 2006 Kruchinin Daniil (asgard) [asgard@etersoft.ru]      *
+ *                                                                         *
+ *  COMEDI - Linux Control and Measurement Device Interface                *
+ *  Copyright (C) 1998,2000 David A. Schleef <ds@schleef.org>              *
+ *                                                                         *
+ *  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.              *
+ *                                                                         *
+ *                                                                         *
+ *  --------------------------------                                       *
+ *   Fastwal UNIOxx-5 specification                                        *
+ *  --------------------------------                                       *
+ *                                                                         *
+ *  driver name: unioxx5.o                                                 *
+ *  kernel module: unioxx5.ko                                              *
+ *                                                                         *
+ *  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 <linux/comedidev.h>
+#include <linux/ioport.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 */
+typedef struct unioxx5_subd_priv {
+  int usp_iobase;
+  unsigned char usp_module_type[12]; /* 12 modules. each can be 70L or 73L */
+  unsigned char usp_extra_data[12][4]; /* for saving previous written value for analog modules */
+  unsigned char usp_prev_wr_val[3]; /* previous written value */
+  unsigned char usp_prev_cn_val[3]; /* previous channel value */
+} unioxx5_subd_priv;
+
+static int unioxx5_attach(comedi_device* dev, comedi_devconfig* it);
+static int unioxx5_subdev_write(comedi_device* dev, comedi_subdevice* subdev,
+                                                               comedi_insn* insn, lsampl_t* data);
+static int unioxx5_subdev_read(comedi_device* dev, comedi_subdevice* subdev,
+                                                          comedi_insn* insn, lsampl_t* data);
+static int unioxx5_insn_config(comedi_device* dev, comedi_subdevice* subdev,
+                                                                  comedi_insn* insn, lsampl_t* data);
+static int unioxx5_detach(comedi_device* dev);
+static int __unioxx5_subdev_init(comedi_subdevice* subdev, int subdev_iobase, int minor);
+static int __unioxx5_digital_write(unioxx5_subd_priv* usp, lsampl_t* data, 
+                                                                  int channel, int minor);
+static int __unioxx5_digital_read(unioxx5_subd_priv* usp, lsampl_t* data,
+                                                                 int channel, int minor);
+static void __unioxx5_digital_config(unioxx5_subd_priv* usp, int mode);
+static int __unioxx5_analog_write(unioxx5_subd_priv* usp, lsampl_t* data, 
+                                                                 int channel, int minor);
+static int __unioxx5_analog_read(unioxx5_subd_priv* usp, lsampl_t* data,
+                                          int channel, int minor);
+static int __unioxx5_define_chan_offset(int chan_num);
+static void __unioxx5_analog_config(unioxx5_subd_priv* usp, int channel);
+
+
+static comedi_driver unioxx5_driver = {
+ driver_name:   DRIVER_NAME,
+ module:        THIS_MODULE,
+ attach:        unioxx5_attach,
+ detach:        unioxx5_detach
+};
+
+COMEDI_INITCLEANUP(unioxx5_driver);
+
+static int unioxx5_attach(comedi_device* dev, comedi_devconfig* it)
+{
+  int iobase, i, n_subd;
+  int id, num, ba;
+
+  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;
+  }
+
+  if(alloc_subdevices(dev, n_subd) < 0) {
+       printk(KERN_ERR "out of memory\n");
+       return -ENOMEM;
+  }
+
+  /* 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("attached\n");
+  return 0;
+}
+
+static int unioxx5_subdev_read(comedi_device* dev, comedi_subdevice* subdev,
+                                                          comedi_insn* insn, lsampl_t* data)
+{
+  unioxx5_subd_priv* usp = subdev->private;
+  int channel, type;
+
+  channel = CR_CHAN(insn->chanspec);
+  type = usp->usp_module_type[channel / 2]; /* defining module type(analog or digital) */
+
+  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(comedi_device* dev, comedi_subdevice* subdev,
+                                                               comedi_insn* insn, lsampl_t* data)
+{
+  unioxx5_subd_priv* usp = subdev->private;
+  int channel, type;
+
+  channel = CR_CHAN(insn->chanspec);
+  type = usp->usp_module_type[channel / 2]; /* defining module type(analog or digital) */
+
+  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(comedi_device* dev, comedi_subdevice* subdev,
+                                                          comedi_insn* insn, lsampl_t* data)
+{
+  int channel_offset, flags, channel = CR_CHAN(insn->chanspec), type;
+  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;
+  }
+  
+  if((channel_offset = __unioxx5_define_chan_offset(channel)) < 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);
+  outb(flags, usp->usp_iobase + channel_offset); /* changes type of _one_ channel */
+  outb(0, usp->usp_iobase + 0); /* sets channels bank to 0(allows directly input/output) */
+  usp->usp_prev_cn_val[channel_offset - 1] = flags; /* saves written value */
+
+  return 0;
+}
+
+static int unioxx5_detach(comedi_device* dev)
+{
+  int i;
+  comedi_subdevice* subdev;
+  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);
+  }
+
+  return 0;
+}
+
+/* initializing subdevice with given address */
+static int __unioxx5_subdev_init(comedi_subdevice* subdev, int subdev_iobase, int minor)
+{
+  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;
+  }
+  
+  if((usp = (unioxx5_subd_priv*)kmalloc(sizeof(*usp), GFP_KERNEL)) == NULL) {
+       printk(KERN_ERR "comedi%d: erorr! --> out of memory!\n", minor);
+       return -1;
+  }
+  
+  memset(usp, 0, sizeof(*usp));
+  usp->usp_iobase = subdev_iobase;
+  printk("comedi%d: |", minor);
+  
+  /* defining modules types */
+  for(i = 0; i < 12; i++) {
+       to  = 10000;
+
+       __unioxx5_analog_config(usp, i * 2);
+       outb(i + 1, subdev_iobase + 5); /* sends channel number to card */
+       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]);
+       comedi_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;
+  subdev->insn_config = unioxx5_insn_config; /* for digital modules only!!! */
+
+  printk("subdevice configured\n");
+
+  return 0;
+}
+
+static int __unioxx5_digital_write(unioxx5_subd_priv* usp, lsampl_t* data, 
+                                                                  int channel, int minor)
+{
+  int channel_offset, val;
+  int mask = 1 << (channel & 0x07);
+
+  if((channel_offset = __unioxx5_define_chan_offset(channel)) < 0) {
+       printk(KERN_ERR "comedi%d: undefined channel %d. channel range is 0 .. 23\n", minor, channel);
+       return 0;
+  }
+
+  val = usp->usp_prev_wr_val[channel_offset - 1]; /* getting previous written value */
+  
+  if(*data)
+       val |= mask;
+  else
+       val &= ~mask;
+  
+  outb(val, usp->usp_iobase + channel_offset);
+  usp->usp_prev_wr_val[channel_offset - 1] = val; /* saving new written value */
+  
+  return 1;
+}
+
+/* function for digital reading */
+static int __unioxx5_digital_read(unioxx5_subd_priv* usp, lsampl_t* data,
+                                                          int channel, int minor)
+{
+  int channel_offset, mask = 1 << (channel & 0x07);
+
+  if((channel_offset = __unioxx5_define_chan_offset(channel)) < 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;
+
+  if(channel_offset > 1)
+       channel -= 2 << channel_offset; /* this operation is created for correct readed value to 0 or 1 */
+  
+  *data >>= channel;
+  return 1;
+}
+
+static void __unioxx5_digital_config(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);
+}
+
+static int __unioxx5_analog_write(unioxx5_subd_priv* usp, lsampl_t* 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));
+  outb(module + 1, usp->usp_iobase + 5); /* sending module number to card(1 .. 12) */
+  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_analog_read(unioxx5_subd_priv* usp, lsampl_t* 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);
+  outb(module_no + 1, usp->usp_iobase + 5); /* sends module number to card(1 .. 12) */
+  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;
+}
+
+/* configure channels for analog i/o (even to output, odd to input) */
+static void __unioxx5_analog_config(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;
+}
+
+/*                                                    *\
+ * this function defines if the given channel number  *
+ * enters in default numeric interspace(from 0 to 23) *
+ * and it returns address offset for usage needed     *
+ * channel.                                           *
+\*                                                    */
+
+static int __unioxx5_define_chan_offset(int chan_num)
+{
+  
+  
+  if(chan_num < 0 || chan_num > 23)
+       return -1;
+
+  return (chan_num >> 3) + 1;
+}