1 // SPDX-License-Identifier: GPL-2.0+
3 * comedi/drivers/das800.c
4 * Driver for Keitley das800 series boards and compatibles
5 * Copyright (C) 2000 Frank Mori Hess <fmhess@users.sourceforge.net>
7 * COMEDI - Linux Control and Measurement Device Interface
8 * Copyright (C) 2000 David A. Schleef <ds@schleef.org>
12 * Description: Keithley Metrabyte DAS800 (& compatibles)
13 * Author: Frank Mori Hess <fmhess@users.sourceforge.net>
14 * Devices: [Keithley Metrabyte] DAS-800 (das-800), DAS-801 (das-801),
16 * [Measurement Computing] CIO-DAS800 (cio-das800),
17 * CIO-DAS801 (cio-das801), CIO-DAS802 (cio-das802),
18 * CIO-DAS802/16 (cio-das802/16)
19 * Status: works, cio-das802/16 untested - email me if you have tested it
21 * Configuration options:
22 * [0] - I/O port base address
23 * [1] - IRQ (optional, required for timed or externally triggered conversions)
26 * IRQ can be omitted, although the cmd interface will not work without it.
28 * All entries in the channel/gain list must use the same gain and be
29 * consecutive channels counting upwards in channel number (these are
30 * hardware limitations.)
32 * I've never tested the gain setting stuff since I only have a
33 * DAS-800 board with fixed gain.
35 * The cio-das802/16 does not have a fifo-empty status bit! Therefore
36 * only fifo-half-full transfers are possible with this card.
38 * cmd triggers supported:
39 * start_src: TRIG_NOW | TRIG_EXT
40 * scan_begin_src: TRIG_FOLLOW
41 * scan_end_src: TRIG_COUNT
42 * convert_src: TRIG_TIMER | TRIG_EXT
43 * stop_src: TRIG_NONE | TRIG_COUNT
46 #include <linux/module.h>
47 #include <linux/interrupt.h>
48 #include <linux/delay.h>
49 #include <linux/comedi/comedidev.h>
50 #include <linux/comedi/comedi_8254.h>
52 #define N_CHAN_AI 8 /* number of analog input channels */
54 /* Registers for the das800 */
57 #define FIFO_EMPTY 0x1
60 #define DAS800_CONTROL1 2
61 #define CONTROL1_INTE 0x8
62 #define DAS800_CONV_CONTROL 2
68 #define CONV_HCEN 0x80
69 #define DAS800_SCAN_LIMITS 2
70 #define DAS800_STATUS 2
74 #define CIO_FFOV 0x8 /* cio-das802/16 fifo overflow */
75 #define CIO_ENHF 0x90 /* cio-das802/16 fifo half full int ena */
77 #define CONV_CONTROL 0xa0
78 #define SCAN_LIMITS 0xc0
81 #define DAS800_STATUS2 7
82 #define STATUS2_HCEN 0x80
83 #define STATUS2_INTE 0X20
86 #define DAS802_16_HALF_FIFO_SZ 128
91 const struct comedi_lrange *ai_range;
95 static const struct comedi_lrange range_das801_ai = {
109 static const struct comedi_lrange range_cio_das801_ai = {
123 static const struct comedi_lrange range_das802_ai = {
137 static const struct comedi_lrange range_das80216_ai = {
150 enum das800_boardinfo {
160 static const struct das800_board das800_boards[] = {
164 .ai_range = &range_bipolar5,
167 [BOARD_CIODAS800] = {
168 .name = "cio-das800",
170 .ai_range = &range_bipolar5,
176 .ai_range = &range_das801_ai,
179 [BOARD_CIODAS801] = {
180 .name = "cio-das801",
182 .ai_range = &range_cio_das801_ai,
188 .ai_range = &range_das802_ai,
191 [BOARD_CIODAS802] = {
192 .name = "cio-das802",
194 .ai_range = &range_das802_ai,
197 [BOARD_CIODAS80216] = {
198 .name = "cio-das802/16",
200 .ai_range = &range_das80216_ai,
205 struct das800_private {
206 unsigned int do_bits; /* digital output bits */
209 static void das800_ind_write(struct comedi_device *dev,
210 unsigned int val, unsigned int reg)
213 * Select dev->iobase + 2 to be desired register
214 * then write to that register.
216 outb(reg, dev->iobase + DAS800_GAIN);
217 outb(val, dev->iobase + 2);
220 static unsigned int das800_ind_read(struct comedi_device *dev, unsigned int reg)
223 * Select dev->iobase + 7 to be desired register
224 * then read from that register.
226 outb(reg, dev->iobase + DAS800_GAIN);
227 return inb(dev->iobase + 7);
230 static void das800_enable(struct comedi_device *dev)
232 const struct das800_board *board = dev->board_ptr;
233 struct das800_private *devpriv = dev->private;
234 unsigned long irq_flags;
236 spin_lock_irqsave(&dev->spinlock, irq_flags);
237 /* enable fifo-half full interrupts for cio-das802/16 */
238 if (board->resolution == 16)
239 outb(CIO_ENHF, dev->iobase + DAS800_GAIN);
240 /* enable hardware triggering */
241 das800_ind_write(dev, CONV_HCEN, CONV_CONTROL);
242 /* enable card's interrupt */
243 das800_ind_write(dev, CONTROL1_INTE | devpriv->do_bits, CONTROL1);
244 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
247 static void das800_disable(struct comedi_device *dev)
249 unsigned long irq_flags;
251 spin_lock_irqsave(&dev->spinlock, irq_flags);
252 /* disable hardware triggering of conversions */
253 das800_ind_write(dev, 0x0, CONV_CONTROL);
254 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
257 static int das800_cancel(struct comedi_device *dev, struct comedi_subdevice *s)
263 static int das800_ai_check_chanlist(struct comedi_device *dev,
264 struct comedi_subdevice *s,
265 struct comedi_cmd *cmd)
267 unsigned int chan0 = CR_CHAN(cmd->chanlist[0]);
268 unsigned int range0 = CR_RANGE(cmd->chanlist[0]);
271 for (i = 1; i < cmd->chanlist_len; i++) {
272 unsigned int chan = CR_CHAN(cmd->chanlist[i]);
273 unsigned int range = CR_RANGE(cmd->chanlist[i]);
275 if (chan != (chan0 + i) % s->n_chan) {
276 dev_dbg(dev->class_dev,
277 "chanlist must be consecutive, counting upwards\n");
281 if (range != range0) {
282 dev_dbg(dev->class_dev,
283 "chanlist must all have the same gain\n");
291 static int das800_ai_do_cmdtest(struct comedi_device *dev,
292 struct comedi_subdevice *s,
293 struct comedi_cmd *cmd)
295 const struct das800_board *board = dev->board_ptr;
298 /* Step 1 : check if triggers are trivially valid */
300 err |= comedi_check_trigger_src(&cmd->start_src, TRIG_NOW | TRIG_EXT);
301 err |= comedi_check_trigger_src(&cmd->scan_begin_src, TRIG_FOLLOW);
302 err |= comedi_check_trigger_src(&cmd->convert_src,
303 TRIG_TIMER | TRIG_EXT);
304 err |= comedi_check_trigger_src(&cmd->scan_end_src, TRIG_COUNT);
305 err |= comedi_check_trigger_src(&cmd->stop_src, TRIG_COUNT | TRIG_NONE);
310 /* Step 2a : make sure trigger sources are unique */
312 err |= comedi_check_trigger_is_unique(cmd->start_src);
313 err |= comedi_check_trigger_is_unique(cmd->convert_src);
314 err |= comedi_check_trigger_is_unique(cmd->stop_src);
316 /* Step 2b : and mutually compatible */
321 /* Step 3: check if arguments are trivially valid */
323 err |= comedi_check_trigger_arg_is(&cmd->start_arg, 0);
325 if (cmd->convert_src == TRIG_TIMER) {
326 err |= comedi_check_trigger_arg_min(&cmd->convert_arg,
330 err |= comedi_check_trigger_arg_min(&cmd->chanlist_len, 1);
331 err |= comedi_check_trigger_arg_is(&cmd->scan_end_arg,
334 if (cmd->stop_src == TRIG_COUNT)
335 err |= comedi_check_trigger_arg_min(&cmd->stop_arg, 1);
337 err |= comedi_check_trigger_arg_is(&cmd->stop_arg, 0);
342 /* step 4: fix up any arguments */
344 if (cmd->convert_src == TRIG_TIMER) {
345 unsigned int arg = cmd->convert_arg;
347 comedi_8254_cascade_ns_to_timer(dev->pacer, &arg, cmd->flags);
348 err |= comedi_check_trigger_arg_is(&cmd->convert_arg, arg);
354 /* Step 5: check channel list if it exists */
355 if (cmd->chanlist && cmd->chanlist_len > 0)
356 err |= das800_ai_check_chanlist(dev, s, cmd);
364 static int das800_ai_do_cmd(struct comedi_device *dev,
365 struct comedi_subdevice *s)
367 const struct das800_board *board = dev->board_ptr;
368 struct comedi_async *async = s->async;
369 struct comedi_cmd *cmd = &async->cmd;
370 unsigned int gain = CR_RANGE(cmd->chanlist[0]);
371 unsigned int start_chan = CR_CHAN(cmd->chanlist[0]);
372 unsigned int end_chan = (start_chan + cmd->chanlist_len - 1) % 8;
373 unsigned int scan_chans = (end_chan << 3) | start_chan;
375 unsigned long irq_flags;
379 spin_lock_irqsave(&dev->spinlock, irq_flags);
380 /* set scan limits */
381 das800_ind_write(dev, scan_chans, SCAN_LIMITS);
382 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
385 if (board->resolution == 12 && gain > 0)
388 outb(gain, dev->iobase + DAS800_GAIN);
390 /* enable auto channel scan, send interrupts on end of conversion
391 * and set clock source to internal or external
394 conv_bits |= EACS | IEOC;
395 if (cmd->start_src == TRIG_EXT)
397 if (cmd->convert_src == TRIG_TIMER) {
398 conv_bits |= CASC | ITE;
399 comedi_8254_update_divisors(dev->pacer);
400 comedi_8254_pacer_enable(dev->pacer, 1, 2, true);
403 spin_lock_irqsave(&dev->spinlock, irq_flags);
404 das800_ind_write(dev, conv_bits, CONV_CONTROL);
405 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
411 static unsigned int das800_ai_get_sample(struct comedi_device *dev)
413 unsigned int lsb = inb(dev->iobase + DAS800_LSB);
414 unsigned int msb = inb(dev->iobase + DAS800_MSB);
416 return (msb << 8) | lsb;
419 static irqreturn_t das800_interrupt(int irq, void *d)
421 struct comedi_device *dev = d;
422 struct das800_private *devpriv = dev->private;
423 struct comedi_subdevice *s = dev->read_subdev;
424 struct comedi_async *async;
425 struct comedi_cmd *cmd;
426 unsigned long irq_flags;
433 status = inb(dev->iobase + DAS800_STATUS);
442 spin_lock_irqsave(&dev->spinlock, irq_flags);
443 status = das800_ind_read(dev, CONTROL1) & STATUS2_HCEN;
445 * Don't release spinlock yet since we want to make sure
446 * no one else disables hardware conversions.
449 /* if hardware conversions are not enabled, then quit */
451 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
455 for (i = 0; i < DAS802_16_HALF_FIFO_SZ; i++) {
456 val = das800_ai_get_sample(dev);
457 if (s->maxdata == 0x0fff) {
458 fifo_empty = !!(val & FIFO_EMPTY);
459 fifo_overflow = !!(val & FIFO_OVF);
461 /* cio-das802/16 has no fifo empty status bit */
463 fifo_overflow = !!(inb(dev->iobase + DAS800_GAIN) &
466 if (fifo_empty || fifo_overflow)
469 if (s->maxdata == 0x0fff)
470 val >>= 4; /* 12-bit sample */
473 comedi_buf_write_samples(s, &val, 1);
475 if (cmd->stop_src == TRIG_COUNT &&
476 async->scans_done >= cmd->stop_arg) {
477 async->events |= COMEDI_CB_EOA;
483 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
484 async->events |= COMEDI_CB_ERROR;
485 comedi_handle_events(dev, s);
489 if (!(async->events & COMEDI_CB_CANCEL_MASK)) {
491 * Re-enable card's interrupt.
492 * We already have spinlock, so indirect addressing is safe
494 das800_ind_write(dev, CONTROL1_INTE | devpriv->do_bits,
496 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
498 /* otherwise, stop taking data */
499 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
502 comedi_handle_events(dev, s);
506 static int das800_ai_eoc(struct comedi_device *dev,
507 struct comedi_subdevice *s,
508 struct comedi_insn *insn,
509 unsigned long context)
513 status = inb(dev->iobase + DAS800_STATUS);
514 if ((status & BUSY) == 0)
519 static int das800_ai_insn_read(struct comedi_device *dev,
520 struct comedi_subdevice *s,
521 struct comedi_insn *insn,
524 struct das800_private *devpriv = dev->private;
525 unsigned int chan = CR_CHAN(insn->chanspec);
526 unsigned int range = CR_RANGE(insn->chanspec);
527 unsigned long irq_flags;
534 /* set multiplexer */
535 spin_lock_irqsave(&dev->spinlock, irq_flags);
536 das800_ind_write(dev, chan | devpriv->do_bits, CONTROL1);
537 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
539 /* set gain / range */
540 if (s->maxdata == 0x0fff && range)
543 outb(range, dev->iobase + DAS800_GAIN);
547 for (i = 0; i < insn->n; i++) {
548 /* trigger conversion */
549 outb_p(0, dev->iobase + DAS800_MSB);
551 ret = comedi_timeout(dev, s, insn, das800_ai_eoc, 0);
555 val = das800_ai_get_sample(dev);
556 if (s->maxdata == 0x0fff)
557 val >>= 4; /* 12-bit sample */
558 data[i] = val & s->maxdata;
564 static int das800_di_insn_bits(struct comedi_device *dev,
565 struct comedi_subdevice *s,
566 struct comedi_insn *insn,
569 data[1] = (inb(dev->iobase + DAS800_STATUS) >> 4) & 0x7;
574 static int das800_do_insn_bits(struct comedi_device *dev,
575 struct comedi_subdevice *s,
576 struct comedi_insn *insn,
579 struct das800_private *devpriv = dev->private;
580 unsigned long irq_flags;
582 if (comedi_dio_update_state(s, data)) {
583 devpriv->do_bits = s->state << 4;
585 spin_lock_irqsave(&dev->spinlock, irq_flags);
586 das800_ind_write(dev, CONTROL1_INTE | devpriv->do_bits,
588 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
596 static const struct das800_board *das800_probe(struct comedi_device *dev)
598 const struct das800_board *board = dev->board_ptr;
599 int index = board ? board - das800_boards : -EINVAL;
601 unsigned long irq_flags;
604 * The dev->board_ptr will be set by comedi_device_attach() if the
605 * board name provided by the user matches a board->name in this
606 * driver. If so, this function sanity checks the id_bits to verify
607 * that the board is correct.
609 * If the dev->board_ptr is not set, the user is trying to attach
610 * an unspecified board to this driver. In this case the id_bits
611 * are used to 'probe' for the correct dev->board_ptr.
613 spin_lock_irqsave(&dev->spinlock, irq_flags);
614 id_bits = das800_ind_read(dev, ID) & 0x3;
615 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
619 if (index == BOARD_DAS800 || index == BOARD_CIODAS800)
621 index = BOARD_DAS800;
624 if (index == BOARD_DAS801 || index == BOARD_CIODAS801)
626 index = BOARD_DAS801;
629 if (index == BOARD_DAS802 || index == BOARD_CIODAS802 ||
630 index == BOARD_CIODAS80216)
632 index = BOARD_DAS802;
635 dev_dbg(dev->class_dev, "Board model: 0x%x (unknown)\n",
639 dev_dbg(dev->class_dev, "Board model (probed): %s series\n",
640 das800_boards[index].name);
642 return &das800_boards[index];
645 static int das800_attach(struct comedi_device *dev, struct comedi_devconfig *it)
647 const struct das800_board *board;
648 struct das800_private *devpriv;
649 struct comedi_subdevice *s;
650 unsigned int irq = it->options[1];
651 unsigned long irq_flags;
654 devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
658 ret = comedi_request_region(dev, it->options[0], 0x8);
662 board = das800_probe(dev);
665 dev->board_ptr = board;
666 dev->board_name = board->name;
668 if (irq > 1 && irq <= 7) {
669 ret = request_irq(irq, das800_interrupt, 0, "das800",
675 dev->pacer = comedi_8254_io_alloc(dev->iobase + DAS800_8254,
676 I8254_OSC_BASE_1MHZ, I8254_IO8, 0);
677 if (IS_ERR(dev->pacer))
678 return PTR_ERR(dev->pacer);
680 ret = comedi_alloc_subdevices(dev, 3);
684 /* Analog Input subdevice */
685 s = &dev->subdevices[0];
686 dev->read_subdev = s;
687 s->type = COMEDI_SUBD_AI;
688 s->subdev_flags = SDF_READABLE | SDF_GROUND;
690 s->maxdata = (1 << board->resolution) - 1;
691 s->range_table = board->ai_range;
692 s->insn_read = das800_ai_insn_read;
694 s->subdev_flags |= SDF_CMD_READ;
696 s->do_cmdtest = das800_ai_do_cmdtest;
697 s->do_cmd = das800_ai_do_cmd;
698 s->cancel = das800_cancel;
701 /* Digital Input subdevice */
702 s = &dev->subdevices[1];
703 s->type = COMEDI_SUBD_DI;
704 s->subdev_flags = SDF_READABLE;
707 s->range_table = &range_digital;
708 s->insn_bits = das800_di_insn_bits;
710 /* Digital Output subdevice */
711 s = &dev->subdevices[2];
712 s->type = COMEDI_SUBD_DO;
713 s->subdev_flags = SDF_WRITABLE;
716 s->range_table = &range_digital;
717 s->insn_bits = das800_do_insn_bits;
721 /* initialize digital out channels */
722 spin_lock_irqsave(&dev->spinlock, irq_flags);
723 das800_ind_write(dev, CONTROL1_INTE | devpriv->do_bits, CONTROL1);
724 spin_unlock_irqrestore(&dev->spinlock, irq_flags);
729 static struct comedi_driver driver_das800 = {
730 .driver_name = "das800",
731 .module = THIS_MODULE,
732 .attach = das800_attach,
733 .detach = comedi_legacy_detach,
734 .num_names = ARRAY_SIZE(das800_boards),
735 .board_name = &das800_boards[0].name,
736 .offset = sizeof(struct das800_board),
738 module_comedi_driver(driver_das800);
740 MODULE_AUTHOR("Comedi https://www.comedi.org");
741 MODULE_DESCRIPTION("Comedi low-level driver");
742 MODULE_LICENSE("GPL");