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