1 /***************************************************************************
3 * comedi/drivers/unioxx5.c *
4 * Driver for Fastwel UNIOxx-5 (analog and digital i/o) boards. *
6 * Copyright (C) 2006 Kruchinin Daniil (asgard) [asgard@etersoft.ru] *
8 * COMEDI - Linux Control and Measurement Device Interface *
9 * Copyright (C) 1998,2000 David A. Schleef <ds@schleef.org> *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the Free Software *
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
25 ***************************************************************************/
29 Description: Driver for Fastwel UNIOxx-5 (analog and digital i/o) boards.
30 Author: Kruchinin Daniil (asgard) <asgard@etersoft.ru>
33 Devices: [Fastwel] UNIOxx-5 (unioxx5),
35 This card supports digital and analog I/O. It written for g01
37 channels range: 0 .. 23 dio channels
38 and 0 .. 11 analog modules range
39 During attaching unioxx5 module displays modules identifiers
40 (see dmesg after comedi_config) in format:
41 | [module_number] module_id |
45 #include "../comedidev.h"
46 #include <linux/ioport.h>
47 #include <linux/slab.h>
49 #define DRIVER_NAME "unioxx5"
50 #define UNIOXX5_SIZE 0x10
51 #define UNIOXX5_SUBDEV_BASE 0xA000 /* base addr of first subdev */
52 #define UNIOXX5_SUBDEV_ODDS 0x400
55 #define MODULE_DIGITAL 0
56 #define MODULE_OUTPUT_MASK 0x80 /* analog input/output */
58 /* constants for digital i/o */
59 #define UNIOXX5_NUM_OF_CHANS 24
61 /* constants for analog i/o */
62 #define TxBE 0x10 /* transmit buffer enable */
63 #define RxCA 0x20 /* 1 receive character available */
64 #define Rx2CA 0x40 /* 2 receive character available */
65 #define Rx4CA 0x80 /* 4 receive character available */
67 /* bytes mask errors */
68 #define Rx2CA_ERR_MASK 0x04 /* 2 bytes receiving error */
69 #define Rx4CA_ERR_MASK 0x08 /* 4 bytes receiving error */
72 #define ALL_2_INPUT 0 /* config all digital channels to input */
73 #define ALL_2_OUTPUT 1 /* config all digital channels to output */
75 /* 'private' structure for each subdevice */
76 struct unioxx5_subd_priv {
78 unsigned char usp_module_type[12]; /* 12 modules. each can be 70L or 73L */
79 unsigned char usp_extra_data[12][4]; /* for saving previous written value for analog modules */
80 unsigned char usp_prev_wr_val[3]; /* previous written value */
81 unsigned char usp_prev_cn_val[3]; /* previous channel value */
84 static int unioxx5_attach(struct comedi_device *dev,
85 struct comedi_devconfig *it);
86 static int unioxx5_subdev_write(struct comedi_device *dev,
87 struct comedi_subdevice *subdev,
88 struct comedi_insn *insn, unsigned int *data);
89 static int unioxx5_subdev_read(struct comedi_device *dev,
90 struct comedi_subdevice *subdev,
91 struct comedi_insn *insn, unsigned int *data);
92 static int unioxx5_insn_config(struct comedi_device *dev,
93 struct comedi_subdevice *subdev,
94 struct comedi_insn *insn, unsigned int *data);
95 static int unioxx5_detach(struct comedi_device *dev);
96 static int __unioxx5_subdev_init(struct comedi_subdevice *subdev,
97 int subdev_iobase, int minor);
98 static int __unioxx5_digital_write(struct unioxx5_subd_priv *usp,
99 unsigned int *data, int channel, int minor);
100 static int __unioxx5_digital_read(struct unioxx5_subd_priv *usp,
101 unsigned int *data, int channel, int minor);
102 /* static void __unioxx5_digital_config(struct unioxx5_subd_priv* usp, int mode); */
103 static int __unioxx5_analog_write(struct unioxx5_subd_priv *usp,
104 unsigned int *data, int channel, int minor);
105 static int __unioxx5_analog_read(struct unioxx5_subd_priv *usp,
106 unsigned int *data, int channel, int minor);
107 static int __unioxx5_define_chan_offset(int chan_num);
108 static void __unioxx5_analog_config(struct unioxx5_subd_priv *usp, int channel);
110 static struct comedi_driver unioxx5_driver = {
111 .driver_name = DRIVER_NAME,
112 .module = THIS_MODULE,
113 .attach = unioxx5_attach,
114 .detach = unioxx5_detach
117 COMEDI_INITCLEANUP(unioxx5_driver);
119 static int unioxx5_attach(struct comedi_device *dev,
120 struct comedi_devconfig *it)
122 int iobase, i, n_subd;
125 iobase = it->options[0];
127 dev->board_name = DRIVER_NAME;
128 dev->iobase = iobase;
129 iobase += UNIOXX5_SUBDEV_BASE;
131 /* defining number of subdevices and getting they types (it must be 'g01') */
132 for (i = n_subd = 0, ba = iobase; i < 4; i++, ba += UNIOXX5_SUBDEV_ODDS) {
136 if (id != 'g' || num != 1)
142 /* unioxx5 can has from two to four subdevices */
145 "your card must has at least 2 'g01' subdevices\n");
149 if (alloc_subdevices(dev, n_subd) < 0) {
150 printk(KERN_ERR "out of memory\n");
154 /* initializing each of for same subdevices */
155 for (i = 0; i < n_subd; i++, iobase += UNIOXX5_SUBDEV_ODDS) {
156 if (__unioxx5_subdev_init(&dev->subdevices[i], iobase,
161 printk("attached\n");
165 static int unioxx5_subdev_read(struct comedi_device *dev,
166 struct comedi_subdevice *subdev,
167 struct comedi_insn *insn, unsigned int *data)
169 struct unioxx5_subd_priv *usp = subdev->private;
172 channel = CR_CHAN(insn->chanspec);
173 type = usp->usp_module_type[channel / 2]; /* defining module type(analog or digital) */
175 if (type == MODULE_DIGITAL) {
176 if (!__unioxx5_digital_read(usp, data, channel, dev->minor))
179 if (!__unioxx5_analog_read(usp, data, channel, dev->minor))
186 static int unioxx5_subdev_write(struct comedi_device *dev,
187 struct comedi_subdevice *subdev,
188 struct comedi_insn *insn, unsigned int *data)
190 struct unioxx5_subd_priv *usp = subdev->private;
193 channel = CR_CHAN(insn->chanspec);
194 type = usp->usp_module_type[channel / 2]; /* defining module type(analog or digital) */
196 if (type == MODULE_DIGITAL) {
197 if (!__unioxx5_digital_write(usp, data, channel, dev->minor))
200 if (!__unioxx5_analog_write(usp, data, channel, dev->minor))
207 /* for digital modules only */
208 static int unioxx5_insn_config(struct comedi_device *dev,
209 struct comedi_subdevice *subdev,
210 struct comedi_insn *insn, unsigned int *data)
212 int channel_offset, flags, channel = CR_CHAN(insn->chanspec), type;
213 struct unioxx5_subd_priv *usp = subdev->private;
214 int mask = 1 << (channel & 0x07);
216 type = usp->usp_module_type[channel / 2];
218 if (type != MODULE_DIGITAL) {
220 "comedi%d: channel configuration accessible only for digital modules\n",
225 channel_offset = __unioxx5_define_chan_offset(channel);
226 if (channel_offset < 0) {
228 "comedi%d: undefined channel %d. channel range is 0 .. 23\n",
229 dev->minor, channel);
233 /* gets previously written value */
234 flags = usp->usp_prev_cn_val[channel_offset - 1];
244 printk(KERN_ERR "comedi%d: unknown flag\n", dev->minor);
249 * sets channels buffer to 1(after this we are allowed to *
250 * change channel type on input or output) *
252 outb(1, usp->usp_iobase + 0);
253 outb(flags, usp->usp_iobase + channel_offset); /* changes type of _one_ channel */
254 outb(0, usp->usp_iobase + 0); /* sets channels bank to 0(allows directly input/output) */
255 usp->usp_prev_cn_val[channel_offset - 1] = flags; /* saves written value */
260 static int unioxx5_detach(struct comedi_device *dev)
263 struct comedi_subdevice *subdev;
264 struct unioxx5_subd_priv *usp;
266 for (i = 0; i < dev->n_subdevices; i++) {
267 subdev = &dev->subdevices[i];
268 usp = subdev->private;
269 release_region(usp->usp_iobase, UNIOXX5_SIZE);
270 kfree(subdev->private);
276 /* initializing subdevice with given address */
277 static int __unioxx5_subdev_init(struct comedi_subdevice *subdev,
278 int subdev_iobase, int minor)
280 struct unioxx5_subd_priv *usp;
281 int i, to, ndef_flag = 0;
283 if (!request_region(subdev_iobase, UNIOXX5_SIZE, DRIVER_NAME)) {
284 printk(KERN_ERR "comedi%d: I/O port conflict\n", minor);
288 usp = (struct unioxx5_subd_priv *)kzalloc(sizeof(*usp), GFP_KERNEL);
291 printk(KERN_ERR "comedi%d: erorr! --> out of memory!\n", minor);
295 usp->usp_iobase = subdev_iobase;
296 printk("comedi%d: |", minor);
298 /* defining modules types */
299 for (i = 0; i < 12; i++) {
302 __unioxx5_analog_config(usp, i * 2);
303 outb(i + 1, subdev_iobase + 5); /* sends channel number to card */
304 outb('H', subdev_iobase + 6); /* requests EEPROM world */
305 while (!(inb(subdev_iobase + 0) & TxBE)) ; /* waits while writting will be allowed */
306 outb(0, subdev_iobase + 6);
308 /* waits while reading of two bytes will be allowed */
309 while (!(inb(subdev_iobase + 0) & Rx2CA)) {
317 usp->usp_module_type[i] = 0;
320 usp->usp_module_type[i] = inb(subdev_iobase + 6);
322 printk(" [%d] 0x%02x |", i, usp->usp_module_type[i]);
328 /* initial subdevice for digital or analog i/o */
329 subdev->type = COMEDI_SUBD_DIO;
330 subdev->private = usp;
331 subdev->subdev_flags = SDF_READABLE | SDF_WRITABLE;
332 subdev->n_chan = UNIOXX5_NUM_OF_CHANS;
333 subdev->maxdata = 0xFFF;
334 subdev->range_table = &range_digital;
335 subdev->insn_read = unioxx5_subdev_read;
336 subdev->insn_write = unioxx5_subdev_write;
337 subdev->insn_config = unioxx5_insn_config; /* for digital modules only!!! */
339 printk("subdevice configured\n");
344 static int __unioxx5_digital_write(struct unioxx5_subd_priv *usp,
345 unsigned int *data, int channel, int minor)
347 int channel_offset, val;
348 int mask = 1 << (channel & 0x07);
350 channel_offset = __unioxx5_define_chan_offset(channel);
351 if (channel_offset < 0) {
353 "comedi%d: undefined channel %d. channel range is 0 .. 23\n",
358 val = usp->usp_prev_wr_val[channel_offset - 1]; /* getting previous written value */
365 outb(val, usp->usp_iobase + channel_offset);
366 usp->usp_prev_wr_val[channel_offset - 1] = val; /* saving new written value */
371 /* function for digital reading */
372 static int __unioxx5_digital_read(struct unioxx5_subd_priv *usp,
373 unsigned int *data, int channel, int minor)
375 int channel_offset, mask = 1 << (channel & 0x07);
377 channel_offset = __unioxx5_define_chan_offset(channel);
378 if (channel_offset < 0) {
380 "comedi%d: undefined channel %d. channel range is 0 .. 23\n",
385 *data = inb(usp->usp_iobase + channel_offset);
388 if (channel_offset > 1)
389 channel -= 2 << channel_offset; /* this operation is created for correct readed value to 0 or 1 */
395 #if 0 /* not used? */
396 static void __unioxx5_digital_config(struct unioxx5_subd_priv *usp, int mode)
400 mask = (mode == ALL_2_OUTPUT) ? 0xFF : 0x00;
401 printk("COMEDI: mode = %d\n", mask);
403 outb(1, usp->usp_iobase + 0);
405 for (i = 0; i < 3; i++)
406 outb(mask, usp->usp_iobase + i);
408 outb(0, usp->usp_iobase + 0);
412 static int __unioxx5_analog_write(struct unioxx5_subd_priv *usp,
413 unsigned int *data, int channel, int minor)
417 module = channel / 2; /* definig module number(0 .. 11) */
418 i = (channel % 2) << 1; /* depends on type of channel (A or B) */
420 /* defining if given module can work on output */
421 if (!(usp->usp_module_type[module] & MODULE_OUTPUT_MASK)) {
423 "comedi%d: module in position %d with id 0x%0x is for input only!\n",
424 minor, module, usp->usp_module_type[module]);
428 __unioxx5_analog_config(usp, channel);
429 /* saving minor byte */
430 usp->usp_extra_data[module][i++] = (unsigned char)(*data & 0x00FF);
431 /* saving major byte */
432 usp->usp_extra_data[module][i] = (unsigned char)((*data & 0xFF00) >> 8);
434 /* while(!((inb(usp->usp_iobase + 0)) & TxBE)); */
435 outb(module + 1, usp->usp_iobase + 5); /* sending module number to card(1 .. 12) */
436 outb('W', usp->usp_iobase + 6); /* sends (W)rite command to module */
438 /* sending for bytes to module(one byte per cycle iteration) */
439 for (i = 0; i < 4; i++) {
440 while (!((inb(usp->usp_iobase + 0)) & TxBE)) ; /* waits while writting will be allowed */
441 outb(usp->usp_extra_data[module][i], usp->usp_iobase + 6);
447 static int __unioxx5_analog_read(struct unioxx5_subd_priv *usp,
448 unsigned int *data, int channel, int minor)
450 int module_no, read_ch;
453 module_no = channel / 2;
454 read_ch = channel % 2; /* depend on type of channel (A or B) */
456 /* defining if given module can work on input */
457 if (usp->usp_module_type[module_no] & MODULE_OUTPUT_MASK) {
459 "comedi%d: module in position %d with id 0x%02x is for output only",
460 minor, module_no, usp->usp_module_type[module_no]);
464 __unioxx5_analog_config(usp, channel);
465 outb(module_no + 1, usp->usp_iobase + 5); /* sends module number to card(1 .. 12) */
466 outb('V', usp->usp_iobase + 6); /* sends to module (V)erify command */
467 control = inb(usp->usp_iobase); /* get control register byte */
469 /* waits while reading four bytes will be allowed */
470 while (!((control = inb(usp->usp_iobase + 0)) & Rx4CA)) ;
472 /* if four bytes readding error occurs - return 0(false) */
473 if ((control & Rx4CA_ERR_MASK)) {
474 printk("COMEDI: 4 bytes error\n");
479 *data = inw(usp->usp_iobase + 6); /* channel B */
481 *data = inw(usp->usp_iobase + 4); /* channel A */
486 /* configure channels for analog i/o (even to output, odd to input) */
487 static void __unioxx5_analog_config(struct unioxx5_subd_priv *usp, int channel)
489 int chan_a, chan_b, conf, channel_offset;
491 channel_offset = __unioxx5_define_chan_offset(channel);
492 conf = usp->usp_prev_cn_val[channel_offset - 1];
495 /* setting channel A and channel B mask */
496 if (channel % 2 == 0) {
497 chan_a <<= channel & 0x07;
498 chan_b <<= (channel + 1) & 0x07;
500 chan_a <<= (channel - 1) & 0x07;
501 chan_b <<= channel & 0x07;
504 conf |= chan_a; /* even channel ot output */
505 conf &= ~chan_b; /* odd channel to input */
507 outb(1, usp->usp_iobase + 0);
508 outb(conf, usp->usp_iobase + channel_offset);
509 outb(0, usp->usp_iobase + 0);
511 usp->usp_prev_cn_val[channel_offset - 1] = conf;
515 * this function defines if the given channel number *
516 * enters in default numeric interspace(from 0 to 23) *
517 * and it returns address offset for usage needed *
521 static int __unioxx5_define_chan_offset(int chan_num)
524 if (chan_num < 0 || chan_num > 23)
527 return (chan_num >> 3) + 1;