Merge remote-tracking branch 'asoc/topic/max98095' into asoc-next
[cascardo/linux.git] / drivers / staging / comedi / drivers / pcl726.c
1 /*
2     comedi/drivers/pcl726.c
3
4     hardware driver for Advantech cards:
5      card:   PCL-726, PCL-727, PCL-728
6      driver: pcl726,  pcl727,  pcl728
7     and for ADLink cards:
8      card:   ACL-6126, ACL-6128
9      driver: acl6126,  acl6128
10
11     COMEDI - Linux Control and Measurement Device Interface
12     Copyright (C) 1998 David A. Schleef <ds@schleef.org>
13
14     This program is free software; you can redistribute it and/or modify
15     it under the terms of the GNU General Public License as published by
16     the Free Software Foundation; either version 2 of the License, or
17     (at your option) any later version.
18
19     This program is distributed in the hope that it will be useful,
20     but WITHOUT ANY WARRANTY; without even the implied warranty of
21     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22     GNU General Public License for more details.
23 */
24 /*
25 Driver: pcl726
26 Description: Advantech PCL-726 & compatibles
27 Author: ds
28 Status: untested
29 Devices: [Advantech] PCL-726 (pcl726), PCL-727 (pcl727), PCL-728 (pcl728),
30   [ADLink] ACL-6126 (acl6126), ACL-6128 (acl6128)
31
32 Interrupts are not supported.
33
34     Options for PCL-726:
35      [0] - IO Base
36      [2]...[7] - D/A output range for channel 1-6:
37                 0: 0-5V, 1: 0-10V, 2: +/-5V, 3: +/-10V,
38                 4: 4-20mA, 5: unknown (external reference)
39
40     Options for PCL-727:
41      [0] - IO Base
42      [2]...[13] - D/A output range for channel 1-12:
43                 0: 0-5V, 1: 0-10V, 2: +/-5V,
44                 3: 4-20mA
45
46     Options for PCL-728 and ACL-6128:
47      [0] - IO Base
48      [2], [3] - D/A output range for channel 1 and 2:
49                 0: 0-5V, 1: 0-10V, 2: +/-5V, 3: +/-10V,
50                 4: 4-20mA, 5: 0-20mA
51
52     Options for ACL-6126:
53      [0] - IO Base
54      [1] - IRQ (0=disable, 3, 5, 6, 7, 9, 10, 11, 12, 15) (currently ignored)
55      [2]...[7] - D/A output range for channel 1-6:
56                 0: 0-5V, 1: 0-10V, 2: +/-5V, 3: +/-10V,
57                 4: 4-20mA
58 */
59
60 /*
61     Thanks to Circuit Specialists for having programming info (!) on
62     their web page.  (http://www.cir.com/)
63 */
64
65 #include <linux/module.h>
66 #include "../comedidev.h"
67
68 #undef ACL6126_IRQ              /* no interrupt support (yet) */
69
70 #define PCL726_SIZE 16
71 #define PCL727_SIZE 32
72 #define PCL728_SIZE 8
73
74 #define PCL726_DAC0_HI 0
75 #define PCL726_DAC0_LO 1
76
77 #define PCL726_DO_HI 12
78 #define PCL726_DO_LO 13
79 #define PCL726_DI_HI 14
80 #define PCL726_DI_LO 15
81
82 #define PCL727_DO_HI 24
83 #define PCL727_DO_LO 25
84 #define PCL727_DI_HI  0
85 #define PCL727_DI_LO  1
86
87 static const struct comedi_lrange *const rangelist_726[] = {
88         &range_unipolar5, &range_unipolar10,
89         &range_bipolar5, &range_bipolar10,
90         &range_4_20mA, &range_unknown
91 };
92
93 static const struct comedi_lrange *const rangelist_727[] = {
94         &range_unipolar5, &range_unipolar10,
95         &range_bipolar5,
96         &range_4_20mA
97 };
98
99 static const struct comedi_lrange *const rangelist_728[] = {
100         &range_unipolar5, &range_unipolar10,
101         &range_bipolar5, &range_bipolar10,
102         &range_4_20mA, &range_0_20mA
103 };
104
105 struct pcl726_board {
106
107         const char *name;       /*  driver name */
108         int n_aochan;           /*  num of D/A chans */
109         int num_of_ranges;      /*  num of ranges */
110         unsigned int IRQbits;   /*  allowed interrupts */
111         unsigned int io_range;  /*  len of IO space */
112         char have_dio;          /*  1=card have DI/DO ports */
113         int di_hi;              /*  ports for DI/DO operations */
114         int di_lo;
115         int do_hi;
116         int do_lo;
117         const struct comedi_lrange *const *range_type_list;
118         /*  list of supported ranges */
119 };
120
121 static const struct pcl726_board boardtypes[] = {
122         {"pcl726", 6, 6, 0x0000, PCL726_SIZE, 1,
123          PCL726_DI_HI, PCL726_DI_LO, PCL726_DO_HI, PCL726_DO_LO,
124          &rangelist_726[0],},
125         {"pcl727", 12, 4, 0x0000, PCL727_SIZE, 1,
126          PCL727_DI_HI, PCL727_DI_LO, PCL727_DO_HI, PCL727_DO_LO,
127          &rangelist_727[0],},
128         {"pcl728", 2, 6, 0x0000, PCL728_SIZE, 0,
129          0, 0, 0, 0,
130          &rangelist_728[0],},
131         {"acl6126", 6, 5, 0x96e8, PCL726_SIZE, 1,
132          PCL726_DI_HI, PCL726_DI_LO, PCL726_DO_HI, PCL726_DO_LO,
133          &rangelist_726[0],},
134         {"acl6128", 2, 6, 0x0000, PCL728_SIZE, 0,
135          0, 0, 0, 0,
136          &rangelist_728[0],},
137 };
138
139 struct pcl726_private {
140
141         int bipolar[12];
142         const struct comedi_lrange *rangelist[12];
143         unsigned int ao_readback[12];
144 };
145
146 static int pcl726_ao_insn(struct comedi_device *dev, struct comedi_subdevice *s,
147                           struct comedi_insn *insn, unsigned int *data)
148 {
149         struct pcl726_private *devpriv = dev->private;
150         int hi, lo;
151         int n;
152         int chan = CR_CHAN(insn->chanspec);
153
154         for (n = 0; n < insn->n; n++) {
155                 lo = data[n] & 0xff;
156                 hi = (data[n] >> 8) & 0xf;
157                 if (devpriv->bipolar[chan])
158                         hi ^= 0x8;
159                 /*
160                  * the programming info did not say which order
161                  * to write bytes.  switch the order of the next
162                  * two lines if you get glitches.
163                  */
164                 outb(hi, dev->iobase + PCL726_DAC0_HI + 2 * chan);
165                 outb(lo, dev->iobase + PCL726_DAC0_LO + 2 * chan);
166                 devpriv->ao_readback[chan] = data[n];
167         }
168
169         return n;
170 }
171
172 static int pcl726_ao_insn_read(struct comedi_device *dev,
173                                struct comedi_subdevice *s,
174                                struct comedi_insn *insn, unsigned int *data)
175 {
176         struct pcl726_private *devpriv = dev->private;
177         int chan = CR_CHAN(insn->chanspec);
178         int n;
179
180         for (n = 0; n < insn->n; n++)
181                 data[n] = devpriv->ao_readback[chan];
182         return n;
183 }
184
185 static int pcl726_di_insn_bits(struct comedi_device *dev,
186                                struct comedi_subdevice *s,
187                                struct comedi_insn *insn, unsigned int *data)
188 {
189         const struct pcl726_board *board = comedi_board(dev);
190
191         data[1] = inb(dev->iobase + board->di_lo) |
192             (inb(dev->iobase + board->di_hi) << 8);
193
194         return insn->n;
195 }
196
197 static int pcl726_do_insn_bits(struct comedi_device *dev,
198                                struct comedi_subdevice *s,
199                                struct comedi_insn *insn, unsigned int *data)
200 {
201         const struct pcl726_board *board = comedi_board(dev);
202
203         if (data[0]) {
204                 s->state &= ~data[0];
205                 s->state |= data[0] & data[1];
206         }
207         if (data[1] & 0x00ff)
208                 outb(s->state & 0xff, dev->iobase + board->do_lo);
209         if (data[1] & 0xff00)
210                 outb((s->state >> 8), dev->iobase + board->do_hi);
211
212         data[1] = s->state;
213
214         return insn->n;
215 }
216
217 static int pcl726_attach(struct comedi_device *dev, struct comedi_devconfig *it)
218 {
219         const struct pcl726_board *board = comedi_board(dev);
220         struct pcl726_private *devpriv;
221         struct comedi_subdevice *s;
222         int ret, i;
223 #ifdef ACL6126_IRQ
224         unsigned int irq;
225 #endif
226
227         ret = comedi_request_region(dev, it->options[0], board->io_range);
228         if (ret)
229                 return ret;
230
231         devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
232         if (!devpriv)
233                 return -ENOMEM;
234
235         for (i = 0; i < 12; i++) {
236                 devpriv->bipolar[i] = 0;
237                 devpriv->rangelist[i] = &range_unknown;
238         }
239
240 #ifdef ACL6126_IRQ
241         irq = 0;
242         if (boardtypes[board].IRQbits != 0) {   /* board support IRQ */
243                 irq = it->options[1];
244                 devpriv->first_chan = 2;
245                 if (irq) {      /* we want to use IRQ */
246                         if (((1 << irq) & boardtypes[board].IRQbits) == 0) {
247                                 printk(KERN_WARNING
248                                         ", IRQ %d is out of allowed range,"
249                                         " DISABLING IT", irq);
250                                 irq = 0;        /* Bad IRQ */
251                         } else {
252                                 if (request_irq(irq, interrupt_pcl818, 0,
253                                                 dev->board_name, dev)) {
254                                         printk(KERN_WARNING
255                                                 ", unable to allocate IRQ %d,"
256                                                 " DISABLING IT", irq);
257                                         irq = 0;        /* Can't use IRQ */
258                                 } else {
259                                         printk(", irq=%d", irq);
260                                 }
261                         }
262                 }
263         }
264
265         dev->irq = irq;
266 #endif
267
268         printk("\n");
269
270         ret = comedi_alloc_subdevices(dev, 3);
271         if (ret)
272                 return ret;
273
274         s = &dev->subdevices[0];
275         /* ao */
276         s->type = COMEDI_SUBD_AO;
277         s->subdev_flags = SDF_WRITABLE | SDF_GROUND;
278         s->n_chan = board->n_aochan;
279         s->maxdata = 0xfff;
280         s->len_chanlist = 1;
281         s->insn_write = pcl726_ao_insn;
282         s->insn_read = pcl726_ao_insn_read;
283         s->range_table_list = devpriv->rangelist;
284         for (i = 0; i < board->n_aochan; i++) {
285                 int j;
286
287                 j = it->options[2 + 1];
288                 if ((j < 0) || (j >= board->num_of_ranges)) {
289                         printk
290                             ("Invalid range for channel %d! Must be 0<=%d<%d\n",
291                              i, j, board->num_of_ranges - 1);
292                         j = 0;
293                 }
294                 devpriv->rangelist[i] = board->range_type_list[j];
295                 if (devpriv->rangelist[i]->range[0].min ==
296                     -devpriv->rangelist[i]->range[0].max)
297                         devpriv->bipolar[i] = 1;        /* bipolar range */
298         }
299
300         s = &dev->subdevices[1];
301         /* di */
302         if (!board->have_dio) {
303                 s->type = COMEDI_SUBD_UNUSED;
304         } else {
305                 s->type = COMEDI_SUBD_DI;
306                 s->subdev_flags = SDF_READABLE | SDF_GROUND;
307                 s->n_chan = 16;
308                 s->maxdata = 1;
309                 s->len_chanlist = 1;
310                 s->insn_bits = pcl726_di_insn_bits;
311                 s->range_table = &range_digital;
312         }
313
314         s = &dev->subdevices[2];
315         /* do */
316         if (!board->have_dio) {
317                 s->type = COMEDI_SUBD_UNUSED;
318         } else {
319                 s->type = COMEDI_SUBD_DO;
320                 s->subdev_flags = SDF_WRITABLE | SDF_GROUND;
321                 s->n_chan = 16;
322                 s->maxdata = 1;
323                 s->len_chanlist = 1;
324                 s->insn_bits = pcl726_do_insn_bits;
325                 s->range_table = &range_digital;
326         }
327
328         return 0;
329 }
330
331 static struct comedi_driver pcl726_driver = {
332         .driver_name    = "pcl726",
333         .module         = THIS_MODULE,
334         .attach         = pcl726_attach,
335         .detach         = comedi_legacy_detach,
336         .board_name     = &boardtypes[0].name,
337         .num_names      = ARRAY_SIZE(boardtypes),
338         .offset         = sizeof(struct pcl726_board),
339 };
340 module_comedi_driver(pcl726_driver);
341
342 MODULE_AUTHOR("Comedi http://www.comedi.org");
343 MODULE_DESCRIPTION("Comedi low-level driver");
344 MODULE_LICENSE("GPL");