2 comedi/drivers/adq12b.c
3 driver for MicroAxial ADQ12-B data acquisition and control card
5 COMEDI - Linux Control and Measurement Device Interface
6 Copyright (C) 2000 David A. Schleef <ds@schleef.org>
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 Description: driver for MicroAxial ADQ12-B data acquisition and control card
26 Devices: [MicroAxial] ADQ12-B (adq12b)
27 Author: jeremy theler <thelerg@ib.cnea.gov.ar>
28 Updated: Thu, 21 Feb 2008 02:56:27 -0300
31 Driver for the acquisition card ADQ12-B (without any add-on).
33 - Analog input is subdevice 0 (16 channels single-ended or 8 differential)
34 - Digital input is subdevice 1 (5 channels)
35 - Digital output is subdevice 1 (8 channels)
36 - The PACER is not supported in this version
38 If you do not specify any options, they will default to
40 # comedi_config /dev/comedi0 adq12b 0x300,0,0
42 option 1: I/O base address. The following table is provided as a help
43 of the hardware jumpers.
46 0x300 1 (factory default)
53 option 2: unipolar/bipolar ADC selection: 0 -> bipolar, 1 -> unipolar
55 selection comedi_config option JUB
56 bipolar 0 2-3 (factory default)
59 option 3: single-ended/differential AI selection: 0 -> SE, 1 -> differential
61 selection comedi_config option JCHA JCHB
62 single-ended 0 1-2 1-2 (factory default)
63 differential 1 2-3 2-3
65 written by jeremy theler <thelerg@ib.cnea.gov.ar>
68 comision nacional de energia atomica
69 universidad nacional de cuyo
73 + changed supported devices string (missused the [] and ())
81 #include "../comedidev.h"
83 /* address scheme (page 2.17 of the manual) */
84 #define ADQ12B_SIZE 16
86 #define ADQ12B_CTREG 0x00
87 #define ADQ12B_STINR 0x00
88 #define ADQ12B_OUTBR 0x04
89 #define ADQ12B_ADLOW 0x08
90 #define ADQ12B_ADHIG 0x09
91 #define ADQ12B_CONT0 0x0c
92 #define ADQ12B_CONT1 0x0d
93 #define ADQ12B_CONT2 0x0e
94 #define ADQ12B_COWORD 0x0f
96 /* mask of the bit at STINR to check end of conversion */
97 #define ADQ12B_EOC 0x20
101 /* available ranges through the PGA gains */
102 static const struct comedi_lrange range_adq12b_ai_bipolar = { 4, {
110 static const struct comedi_lrange range_adq12b_ai_unipolar = { 4, {
119 struct adq12b_board {
128 static const struct adq12b_board adq12b_boards[] = {
136 /* potentially, more adq-based deviced will be added */
139 .ai_chans = 16, // this is just for reference, hardcoded again later
146 #define thisboard ((const struct adq12b_board *)dev->board_ptr)
148 struct adq12b_private {
149 int unipolar; /* option 2 of comedi_config (1 is iobase) */
150 int differential; /* option 3 of comedi_config */
153 unsigned int digital_state;
156 #define devpriv ((struct adq12b_private *)dev->private)
159 * The struct comedi_driver structure tells the Comedi core module
160 * which functions to call to configure/deconfigure (attach/detach)
161 * the board, and also about the kernel module that contains
164 static int adq12b_attach(struct comedi_device *dev,
165 struct comedi_devconfig *it);
166 static int adq12b_detach(struct comedi_device *dev);
168 static struct comedi_driver driver_adq12b = {
169 .driver_name = "adq12b",
170 .module = THIS_MODULE,
171 .attach = adq12b_attach,
172 .detach = adq12b_detach,
173 .board_name = &adq12b_boards[0].name,
174 .offset = sizeof(struct adq12b_board),
175 .num_names = ARRAY_SIZE(adq12b_boards),
178 static int adq12b_ai_rinsn(struct comedi_device *dev,
179 struct comedi_subdevice *s, struct comedi_insn *insn,
181 static int adq12b_di_insn_bits(struct comedi_device *dev,
182 struct comedi_subdevice *s,
183 struct comedi_insn *insn, unsigned int *data);
184 static int adq12b_do_insn_bits(struct comedi_device *dev,
185 struct comedi_subdevice *s,
186 struct comedi_insn *insn, unsigned int *data);
189 * Attach is called by the Comedi core to configure the driver
190 * for a particular board. If you specified a board_name array
191 * in the driver structure, dev->board_ptr contains that
194 static int adq12b_attach(struct comedi_device *dev, struct comedi_devconfig *it)
196 struct comedi_subdevice *s;
197 unsigned long iobase;
198 int unipolar, differential;
200 iobase = it->options[0];
201 unipolar = it->options[1];
202 differential = it->options[2];
204 printk(KERN_INFO "comedi%d: adq12b called with options base=0x%03lx, "
205 "%s and %s\n", dev->minor, iobase,
206 (unipolar == 1) ? "unipolar" : "bipolar",
207 (differential == 1) ? "differential" : "single-ended");
209 /* if no address was specified, try the default 0x300 */
211 printk(KERN_WARNING "comedi%d: adq12b warning: I/O base "
212 "address not specified. Trying the default 0x300.\n",
217 printk("comedi%d: adq12b: 0x%04lx ", dev->minor, iobase);
218 if (!request_region(iobase, ADQ12B_SIZE, "adq12b")) {
219 printk("I/O port conflict\n");
222 dev->iobase = iobase;
225 * Initialize dev->board_name. Note that we can use the "thisboard"
226 * macro now, since we just initialized it in the last line.
228 dev->board_name = thisboard->name;
231 * Allocate the private structure area. alloc_private() is a
232 * convenient macro defined in comedidev.h.
234 if (alloc_private(dev, sizeof(struct adq12b_private)) < 0)
237 /* fill in devpriv structure */
238 devpriv->unipolar = unipolar;
239 devpriv->differential = differential;
240 devpriv->digital_state = 0;
241 /* initialize channel and range to -1 so we make sure we always write
242 at least once to the CTREG in the instruction */
243 devpriv->last_channel = -1;
244 devpriv->last_range = -1;
247 * Allocate the subdevice structures. alloc_subdevice() is a
248 * convenient macro defined in comedidev.h.
250 if (alloc_subdevices(dev, 3) < 0)
253 s = dev->subdevices + 0;
254 /* analog input subdevice */
255 s->type = COMEDI_SUBD_AI;
257 s->subdev_flags = SDF_READABLE | SDF_GROUND | SDF_DIFF;
258 s->n_chan = thisboard->ai_diff_chans;
260 s->subdev_flags = SDF_READABLE | SDF_GROUND;
261 s->n_chan = thisboard->ai_se_chans;
265 s->range_table = &range_adq12b_ai_unipolar;
267 s->range_table = &range_adq12b_ai_bipolar;
269 s->maxdata = (1 << thisboard->ai_bits) - 1;
271 s->len_chanlist = 4; /* This is the maximum chanlist length that
272 the board can handle */
273 s->insn_read = adq12b_ai_rinsn;
275 s = dev->subdevices + 1;
276 /* digital input subdevice */
277 s->type = COMEDI_SUBD_DI;
278 s->subdev_flags = SDF_READABLE;
279 s->n_chan = thisboard->di_chans;
281 s->range_table = &range_digital;
282 s->insn_bits = adq12b_di_insn_bits;
284 s = dev->subdevices + 2;
285 /* digital output subdevice */
286 s->type = COMEDI_SUBD_DO;
287 s->subdev_flags = SDF_WRITABLE;
288 s->n_chan = thisboard->do_chans;
290 s->range_table = &range_digital;
291 s->insn_bits = adq12b_do_insn_bits;
293 printk(KERN_INFO "attached\n");
299 * _detach is called to deconfigure a device. It should deallocate
301 * This function is also called when _attach() fails, so it should be
302 * careful not to release resources that were not necessarily
303 * allocated by _attach(). dev->private and dev->subdevices are
304 * deallocated automatically by the core.
306 static int adq12b_detach(struct comedi_device *dev)
309 release_region(dev->iobase, ADQ12B_SIZE);
313 printk(KERN_INFO "comedi%d: adq12b: removed\n", dev->minor);
319 * "instructions" read/write data in "one-shot" or "software-triggered"
323 static int adq12b_ai_rinsn(struct comedi_device *dev,
324 struct comedi_subdevice *s, struct comedi_insn *insn,
329 unsigned char hi, lo, status;
331 /* change channel and range only if it is different from the previous */
332 range = CR_RANGE(insn->chanspec);
333 channel = CR_CHAN(insn->chanspec);
334 if (channel != devpriv->last_channel || range != devpriv->last_range) {
335 outb((range << 4) | channel, dev->iobase + ADQ12B_CTREG);
336 udelay(50); /* wait for the mux to settle */
339 /* trigger conversion */
340 status = inb(dev->iobase + ADQ12B_ADLOW);
342 /* convert n samples */
343 for (n = 0; n < insn->n; n++) {
345 /* wait for end of convertion */
349 status = inb(dev->iobase + ADQ12B_STINR);
350 status = status & ADQ12B_EOC;
351 } while (status == 0 && ++i < TIMEOUT);
352 /* } while (++i < 10); */
355 hi = inb(dev->iobase + ADQ12B_ADHIG);
356 lo = inb(dev->iobase + ADQ12B_ADLOW);
358 /* printk("debug: chan=%d range=%d status=%d hi=%d lo=%d\n",
359 channel, range, status, hi, lo); */
360 data[n] = (hi << 8) | lo;
364 /* return the number of samples read/written */
368 static int adq12b_di_insn_bits(struct comedi_device *dev,
369 struct comedi_subdevice *s,
370 struct comedi_insn *insn, unsigned int *data)
373 /* only bits 0-4 have information about digital inputs */
374 data[1] = (inb(dev->iobase + ADQ12B_STINR) & (0x1f));
379 static int adq12b_do_insn_bits(struct comedi_device *dev,
380 struct comedi_subdevice *s,
381 struct comedi_insn *insn, unsigned int *data)
385 for (channel = 0; channel < 8; channel++)
386 if (((data[0] >> channel) & 0x01) != 0)
387 outb((((data[1] >> channel) & 0x01) << 3) | channel,
388 dev->iobase + ADQ12B_OUTBR);
390 /* store information to retrieve when asked for reading */
392 devpriv->digital_state &= ~data[0];
393 devpriv->digital_state |= (data[0] & data[1]);
396 data[1] = devpriv->digital_state;
402 * A convenient macro that defines init_module() and cleanup_module(),
405 static int __init driver_adq12b_init_module(void)
407 return comedi_driver_register(&driver_adq12b);
410 static void __exit driver_adq12b_cleanup_module(void)
412 comedi_driver_unregister(&driver_adq12b);
415 module_init(driver_adq12b_init_module);
416 module_exit(driver_adq12b_cleanup_module);
418 MODULE_AUTHOR("Comedi http://www.comedi.org");
419 MODULE_DESCRIPTION("Comedi low-level driver");
420 MODULE_LICENSE("GPL");