unioxx5.c revision 6fd071cccf4127f1e81767a819720d8915b2a800 
1/***************************************************************************
2 *                                                                         *
3 *  comedi/drivers/unioxx5.c                                               *
4 *  Driver for Fastwel UNIOxx-5 (analog and digital i/o) boards.           *
5 *                                                                         *
6 *  Copyright (C) 2006 Kruchinin Daniil (asgard) [asgard@etersoft.ru]      *
7 *                                                                         *
8 *  COMEDI - Linux Control and Measurement Device Interface                *
9 *  Copyright (C) 1998,2000 David A. Schleef <ds@schleef.org>              *
10 *                                                                         *
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.                                    *
15 *                                                                         *
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.                           *
20 *                                                                         *
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.              *
24 *                                                                         *
25 ***************************************************************************/
26/*
27
28Driver: unioxx5
29Description: Driver for Fastwel UNIOxx-5 (analog and digital i/o) boards.
30Author: Kruchinin Daniil (asgard) <asgard@etersoft.ru>
31Status: unknown
32Updated: 2006-10-09
33Devices: [Fastwel] UNIOxx-5 (unioxx5),
34
35 This card supports digital and analog I/O. It written for g01
36 subdevices only.
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 |
42
43*/
44
45#include "../comedidev.h"
46#include <linux/ioport.h>
47#include <linux/slab.h>
48
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
53
54/* modules types */
55#define MODULE_DIGITAL 0
56#define MODULE_OUTPUT_MASK 0x80	/* analog input/output */
57
58/* constants for digital i/o */
59#define UNIOXX5_NUM_OF_CHANS 24
60
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 */
66
67/* bytes mask errors */
68#define Rx2CA_ERR_MASK 0x04	/* 2 bytes receiving error */
69#define Rx4CA_ERR_MASK 0x08	/* 4 bytes receiving error */
70
71/* channel modes */
72#define ALL_2_INPUT  0		/* config all digital channels to input */
73#define ALL_2_OUTPUT 1		/* config all digital channels to output */
74
75/* 'private' structure for each subdevice */
76struct unioxx5_subd_priv {
77	int usp_iobase;
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 */
82};
83
84static int unioxx5_attach(struct comedi_device *dev,
85			  struct comedi_devconfig *it);
86static int unioxx5_subdev_write(struct comedi_device *dev,
87				struct comedi_subdevice *subdev,
88				struct comedi_insn *insn, unsigned int *data);
89static int unioxx5_subdev_read(struct comedi_device *dev,
90			       struct comedi_subdevice *subdev,
91			       struct comedi_insn *insn, unsigned int *data);
92static int unioxx5_insn_config(struct comedi_device *dev,
93			       struct comedi_subdevice *subdev,
94			       struct comedi_insn *insn, unsigned int *data);
95static int unioxx5_detach(struct comedi_device *dev);
96static int __unioxx5_subdev_init(struct comedi_subdevice *subdev,
97				 int subdev_iobase, int minor);
98static int __unioxx5_digital_write(struct unioxx5_subd_priv *usp,
99				   unsigned int *data, int channel, int minor);
100static 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); */
103static int __unioxx5_analog_write(struct unioxx5_subd_priv *usp,
104				  unsigned int *data, int channel, int minor);
105static int __unioxx5_analog_read(struct unioxx5_subd_priv *usp,
106				 unsigned int *data, int channel, int minor);
107static int __unioxx5_define_chan_offset(int chan_num);
108static void __unioxx5_analog_config(struct unioxx5_subd_priv *usp, int channel);
109
110static struct comedi_driver unioxx5_driver = {
111	.driver_name = DRIVER_NAME,
112	.module = THIS_MODULE,
113	.attach = unioxx5_attach,
114	.detach = unioxx5_detach
115};
116
117COMEDI_INITCLEANUP(unioxx5_driver);
118
119static int unioxx5_attach(struct comedi_device *dev,
120			  struct comedi_devconfig *it)
121{
122	int iobase, i, n_subd;
123	int id, num, ba;
124
125	iobase = it->options[0];
126
127	dev->board_name = DRIVER_NAME;
128	dev->iobase = iobase;
129	iobase += UNIOXX5_SUBDEV_BASE;
130
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) {
133		id = inb(ba + 0xE);
134		num = inb(ba + 0xF);
135
136		if (id != 'g' || num != 1)
137			continue;
138
139		n_subd++;
140	}
141
142	/* unioxx5 can has from two to four subdevices */
143	if (n_subd < 2) {
144		printk(KERN_ERR
145		       "your card must has at least 2 'g01' subdevices\n");
146		return -1;
147	}
148
149	if (alloc_subdevices(dev, n_subd) < 0) {
150		printk(KERN_ERR "out of memory\n");
151		return -ENOMEM;
152	}
153
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,
157					  dev->minor) < 0)
158			return -1;
159	}
160
161	printk("attached\n");
162	return 0;
163}
164
165static int unioxx5_subdev_read(struct comedi_device *dev,
166			       struct comedi_subdevice *subdev,
167			       struct comedi_insn *insn, unsigned int *data)
168{
169	struct unioxx5_subd_priv *usp = subdev->private;
170	int channel, type;
171
172	channel = CR_CHAN(insn->chanspec);
173	type = usp->usp_module_type[channel / 2];	/* defining module type(analog or digital) */
174
175	if (type == MODULE_DIGITAL) {
176		if (!__unioxx5_digital_read(usp, data, channel, dev->minor))
177			return -1;
178	} else {
179		if (!__unioxx5_analog_read(usp, data, channel, dev->minor))
180			return -1;
181	}
182
183	return 1;
184}
185
186static int unioxx5_subdev_write(struct comedi_device *dev,
187				struct comedi_subdevice *subdev,
188				struct comedi_insn *insn, unsigned int *data)
189{
190	struct unioxx5_subd_priv *usp = subdev->private;
191	int channel, type;
192
193	channel = CR_CHAN(insn->chanspec);
194	type = usp->usp_module_type[channel / 2];	/* defining module type(analog or digital) */
195
196	if (type == MODULE_DIGITAL) {
197		if (!__unioxx5_digital_write(usp, data, channel, dev->minor))
198			return -1;
199	} else {
200		if (!__unioxx5_analog_write(usp, data, channel, dev->minor))
201			return -1;
202	}
203
204	return 1;
205}
206
207/* for digital modules only */
208static int unioxx5_insn_config(struct comedi_device *dev,
209			       struct comedi_subdevice *subdev,
210			       struct comedi_insn *insn, unsigned int *data)
211{
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);
215
216	type = usp->usp_module_type[channel / 2];
217
218	if (type != MODULE_DIGITAL) {
219		printk(KERN_ERR
220		       "comedi%d: channel configuration accessible only for digital modules\n",
221		       dev->minor);
222		return -1;
223	}
224
225	channel_offset = __unioxx5_define_chan_offset(channel);
226	if (channel_offset < 0) {
227		printk(KERN_ERR
228		       "comedi%d: undefined channel %d. channel range is 0 .. 23\n",
229		       dev->minor, channel);
230		return -1;
231	}
232
233	/* gets previously written value */
234	flags = usp->usp_prev_cn_val[channel_offset - 1];
235
236	switch (*data) {
237	case COMEDI_INPUT:
238		flags &= ~mask;
239		break;
240	case COMEDI_OUTPUT:
241		flags |= mask;
242		break;
243	default:
244		printk(KERN_ERR "comedi%d: unknown flag\n", dev->minor);
245		return -1;
246	}
247
248	/*                                                        *\
249	 * sets channels buffer to 1(after this we are allowed to *
250	 * change channel type on input or output)                *
251	 \*                                                        */
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 */
256
257	return 0;
258}
259
260static int unioxx5_detach(struct comedi_device *dev)
261{
262	int i;
263	struct comedi_subdevice *subdev;
264	struct unioxx5_subd_priv *usp;
265
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);
271	}
272
273	return 0;
274}
275
276/* initializing subdevice with given address */
277static int __unioxx5_subdev_init(struct comedi_subdevice *subdev,
278				 int subdev_iobase, int minor)
279{
280	struct unioxx5_subd_priv *usp;
281	int i, to, ndef_flag = 0;
282
283	if (!request_region(subdev_iobase, UNIOXX5_SIZE, DRIVER_NAME)) {
284		printk(KERN_ERR "comedi%d: I/O port conflict\n", minor);
285		return -EIO;
286	}
287
288	usp = kzalloc(sizeof(*usp), GFP_KERNEL);
289
290	if (usp == NULL) {
291		printk(KERN_ERR "comedi%d: erorr! --> out of memory!\n", minor);
292		return -1;
293	}
294
295	usp->usp_iobase = subdev_iobase;
296	printk("comedi%d: |", minor);
297
298	/* defining modules types */
299	for (i = 0; i < 12; i++) {
300		to = 10000;
301
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))
306			;	/* waits while writting will be allowed */
307		outb(0, subdev_iobase + 6);
308
309		/* waits while reading of two bytes will be allowed */
310		while (!(inb(subdev_iobase + 0) & Rx2CA)) {
311			if (--to <= 0) {
312				ndef_flag = 1;
313				break;
314			}
315		}
316
317		if (ndef_flag) {
318			usp->usp_module_type[i] = 0;
319			ndef_flag = 0;
320		} else
321			usp->usp_module_type[i] = inb(subdev_iobase + 6);
322
323		printk(" [%d] 0x%02x |", i, usp->usp_module_type[i]);
324		udelay(1);
325	}
326
327	printk("\n");
328
329	/* initial subdevice for digital or analog i/o */
330	subdev->type = COMEDI_SUBD_DIO;
331	subdev->private = usp;
332	subdev->subdev_flags = SDF_READABLE | SDF_WRITABLE;
333	subdev->n_chan = UNIOXX5_NUM_OF_CHANS;
334	subdev->maxdata = 0xFFF;
335	subdev->range_table = &range_digital;
336	subdev->insn_read = unioxx5_subdev_read;
337	subdev->insn_write = unioxx5_subdev_write;
338	subdev->insn_config = unioxx5_insn_config;	/* for digital modules only!!! */
339
340	printk("subdevice configured\n");
341
342	return 0;
343}
344
345static int __unioxx5_digital_write(struct unioxx5_subd_priv *usp,
346				   unsigned int *data, int channel, int minor)
347{
348	int channel_offset, val;
349	int mask = 1 << (channel & 0x07);
350
351	channel_offset = __unioxx5_define_chan_offset(channel);
352	if (channel_offset < 0) {
353		printk(KERN_ERR
354		       "comedi%d: undefined channel %d. channel range is 0 .. 23\n",
355		       minor, channel);
356		return 0;
357	}
358
359	val = usp->usp_prev_wr_val[channel_offset - 1];	/* getting previous written value */
360
361	if (*data)
362		val |= mask;
363	else
364		val &= ~mask;
365
366	outb(val, usp->usp_iobase + channel_offset);
367	usp->usp_prev_wr_val[channel_offset - 1] = val;	/* saving new written value */
368
369	return 1;
370}
371
372/* function for digital reading */
373static int __unioxx5_digital_read(struct unioxx5_subd_priv *usp,
374				  unsigned int *data, int channel, int minor)
375{
376	int channel_offset, mask = 1 << (channel & 0x07);
377
378	channel_offset = __unioxx5_define_chan_offset(channel);
379	if (channel_offset < 0) {
380		printk(KERN_ERR
381		       "comedi%d: undefined channel %d. channel range is 0 .. 23\n",
382		       minor, channel);
383		return 0;
384	}
385
386	*data = inb(usp->usp_iobase + channel_offset);
387	*data &= mask;
388
389	if (channel_offset > 1)
390		channel -= 2 << channel_offset;	/* this operation is created for correct readed value to 0 or 1 */
391
392	*data >>= channel;
393	return 1;
394}
395
396#if 0				/* not used? */
397static void __unioxx5_digital_config(struct unioxx5_subd_priv *usp, int mode)
398{
399	int i, mask;
400
401	mask = (mode == ALL_2_OUTPUT) ? 0xFF : 0x00;
402	printk("COMEDI: mode = %d\n", mask);
403
404	outb(1, usp->usp_iobase + 0);
405
406	for (i = 0; i < 3; i++)
407		outb(mask, usp->usp_iobase + i);
408
409	outb(0, usp->usp_iobase + 0);
410}
411#endif
412
413static int __unioxx5_analog_write(struct unioxx5_subd_priv *usp,
414				  unsigned int *data, int channel, int minor)
415{
416	int module, i;
417
418	module = channel / 2;	/* definig module number(0 .. 11) */
419	i = (channel % 2) << 1;	/* depends on type of channel (A or B) */
420
421	/* defining if given module can work on output */
422	if (!(usp->usp_module_type[module] & MODULE_OUTPUT_MASK)) {
423		printk(KERN_ERR
424		       "comedi%d: module in position %d with id 0x%0x is for input only!\n",
425		       minor, module, usp->usp_module_type[module]);
426		return 0;
427	}
428
429	__unioxx5_analog_config(usp, channel);
430	/* saving minor byte */
431	usp->usp_extra_data[module][i++] = (unsigned char)(*data & 0x00FF);
432	/* saving major byte */
433	usp->usp_extra_data[module][i] = (unsigned char)((*data & 0xFF00) >> 8);
434
435	/* while(!((inb(usp->usp_iobase + 0)) & TxBE)); */
436	outb(module + 1, usp->usp_iobase + 5);	/* sending module number to card(1 .. 12) */
437	outb('W', usp->usp_iobase + 6);	/* sends (W)rite command to module */
438
439	/* sending for bytes to module(one byte per cycle iteration) */
440	for (i = 0; i < 4; i++) {
441		while (!((inb(usp->usp_iobase + 0)) & TxBE))
442			;	/* waits while writting will be allowed */
443		outb(usp->usp_extra_data[module][i], usp->usp_iobase + 6);
444	}
445
446	return 1;
447}
448
449static int __unioxx5_analog_read(struct unioxx5_subd_priv *usp,
450				 unsigned int *data, int channel, int minor)
451{
452	int module_no, read_ch;
453	char control;
454
455	module_no = channel / 2;
456	read_ch = channel % 2;	/* depend on type of channel (A or B) */
457
458	/* defining if given module can work on input */
459	if (usp->usp_module_type[module_no] & MODULE_OUTPUT_MASK) {
460		printk(KERN_ERR
461		       "comedi%d: module in position %d with id 0x%02x is for output only",
462		       minor, module_no, usp->usp_module_type[module_no]);
463		return 0;
464	}
465
466	__unioxx5_analog_config(usp, channel);
467	outb(module_no + 1, usp->usp_iobase + 5);	/* sends module number to card(1 .. 12) */
468	outb('V', usp->usp_iobase + 6);	/* sends to module (V)erify command */
469	control = inb(usp->usp_iobase);	/* get control register byte */
470
471	/* waits while reading four bytes will be allowed */
472	while (!((control = inb(usp->usp_iobase + 0)) & Rx4CA))
473		;
474
475	/* if four bytes readding error occurs - return 0(false) */
476	if ((control & Rx4CA_ERR_MASK)) {
477		printk("COMEDI: 4 bytes error\n");
478		return 0;
479	}
480
481	if (read_ch)
482		*data = inw(usp->usp_iobase + 6);	/* channel B */
483	else
484		*data = inw(usp->usp_iobase + 4);	/* channel A */
485
486	return 1;
487}
488
489/* configure channels for analog i/o (even to output, odd to input) */
490static void __unioxx5_analog_config(struct unioxx5_subd_priv *usp, int channel)
491{
492	int chan_a, chan_b, conf, channel_offset;
493
494	channel_offset = __unioxx5_define_chan_offset(channel);
495	conf = usp->usp_prev_cn_val[channel_offset - 1];
496	chan_a = chan_b = 1;
497
498	/* setting channel A and channel B mask */
499	if (channel % 2 == 0) {
500		chan_a <<= channel & 0x07;
501		chan_b <<= (channel + 1) & 0x07;
502	} else {
503		chan_a <<= (channel - 1) & 0x07;
504		chan_b <<= channel & 0x07;
505	}
506
507	conf |= chan_a;		/* even channel ot output */
508	conf &= ~chan_b;	/* odd channel to input */
509
510	outb(1, usp->usp_iobase + 0);
511	outb(conf, usp->usp_iobase + channel_offset);
512	outb(0, usp->usp_iobase + 0);
513
514	usp->usp_prev_cn_val[channel_offset - 1] = conf;
515}
516
517/*                                                    *\
518 * this function defines if the given channel number  *
519 * enters in default numeric interspace(from 0 to 23) *
520 * and it returns address offset for usage needed     *
521 * channel.                                           *
522\*                                                    */
523
524static int __unioxx5_define_chan_offset(int chan_num)
525{
526
527	if (chan_num < 0 || chan_num > 23)
528		return -1;
529
530	return (chan_num >> 3) + 1;
531}
532