2 comedi/drivers/ni_6514.c
3 driver for National Instruments PCI-6514
5 Copyright (C) 2006 Jon Grierson <jd@renko.co.uk>
6 Copyright (C) 2006 Frank Mori Hess <fmhess@users.sourceforge.net>
8 COMEDI - Linux Control and Measurement Device Interface
9 Copyright (C) 1999,2002,2003 David A. Schleef <ds@schleef.org>
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.
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.
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.
28 Description: National Instruments 65xx static dio boards
29 Author: Jon Grierson <jd@renko.co.uk>,
30 Frank Mori Hess <fmhess@users.sourceforge.net>
32 Devices: [National Instruments] PCI-6509 (ni_65xx), PXI-6509, PCI-6510,
33 PCI-6511, PXI-6511, PCI-6512, PXI-6512, PCI-6513, PXI-6513, PCI-6514,
34 PXI-6514, PCI-6515, PXI-6515, PCI-6516, PCI-6517, PCI-6518, PCI-6519,
35 PCI-6520, PCI-6521, PXI-6521, PCI-6528, PXI-6528
36 Updated: Wed Oct 18 08:59:11 EDT 2006
38 Based on the PCI-6527 driver by ds.
39 The interrupt subdevice (subdevice 3) is probably broken for all boards
40 except maybe the 6514.
45 Manuals (available from ftp://ftp.natinst.com/support/manuals)
47 370106b.pdf 6514 Register Level Programmer Manual
54 #include <linux/pci.h>
55 #include <linux/interrupt.h>
56 #include <linux/slab.h>
58 #include "../comedidev.h"
60 #include "comedi_fc.h"
63 #define NI6514_DIO_SIZE 4096
64 #define NI6514_MITE_SIZE 4096
66 #define NI_65XX_MAX_NUM_PORTS 12
67 static const unsigned ni_65xx_channels_per_port = 8;
68 static const unsigned ni_65xx_port_offset = 0x10;
70 static inline unsigned Port_Data(unsigned port)
72 return 0x40 + port * ni_65xx_port_offset;
75 static inline unsigned Port_Select(unsigned port)
77 return 0x41 + port * ni_65xx_port_offset;
80 static inline unsigned Rising_Edge_Detection_Enable(unsigned port)
82 return 0x42 + port * ni_65xx_port_offset;
85 static inline unsigned Falling_Edge_Detection_Enable(unsigned port)
87 return 0x43 + port * ni_65xx_port_offset;
90 static inline unsigned Filter_Enable(unsigned port)
92 return 0x44 + port * ni_65xx_port_offset;
95 #define ID_Register 0x00
97 #define Clear_Register 0x01
99 #define ClrOverflow 0x04
101 #define Filter_Interval 0x08
103 #define Change_Status 0x02
104 #define MasterInterruptStatus 0x04
105 #define Overflow 0x02
106 #define EdgeStatus 0x01
108 #define Master_Interrupt_Control 0x03
109 #define FallingEdgeIntEnable 0x10
110 #define RisingEdgeIntEnable 0x08
111 #define MasterInterruptEnable 0x04
112 #define OverflowIntEnable 0x02
113 #define EdgeIntEnable 0x01
115 struct ni_65xx_board {
118 unsigned num_dio_ports;
119 unsigned num_di_ports;
120 unsigned num_do_ports;
121 unsigned invert_outputs:1;
124 static const struct ni_65xx_board ni_65xx_boards[] = {
129 .invert_outputs = 0},
134 .invert_outputs = 0},
159 .invert_outputs = 1},
164 .invert_outputs = 1},
170 .invert_outputs = 1},
176 .invert_outputs = 1},
182 .invert_outputs = 1},
188 .invert_outputs = 1},
193 .invert_outputs = 1},
198 .invert_outputs = 1},
204 .invert_outputs = 1},
210 .invert_outputs = 1},
243 #define n_ni_65xx_boards ARRAY_SIZE(ni_65xx_boards)
244 static inline const struct ni_65xx_board *board(struct comedi_device *dev)
246 return dev->board_ptr;
249 static inline unsigned ni_65xx_port_by_channel(unsigned channel)
251 return channel / ni_65xx_channels_per_port;
254 static inline unsigned ni_65xx_total_num_ports(const struct ni_65xx_board
257 return board->num_dio_ports + board->num_di_ports + board->num_do_ports;
260 static DEFINE_PCI_DEVICE_TABLE(ni_65xx_pci_table) = {
261 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x1710)},
262 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x7085)},
263 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x7086)},
264 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x7087)},
265 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x7088)},
266 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x70a9)},
267 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x70c3)},
268 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x70c8)},
269 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x70c9)},
270 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x70cc)},
271 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x70CD)},
272 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x70d1)},
273 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x70d2)},
274 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x70d3)},
275 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x7124)},
276 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x7125)},
277 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x7126)},
278 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x7127)},
279 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x7128)},
280 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x718b)},
281 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x718c)},
282 {PCI_DEVICE(PCI_VENDOR_ID_NI, 0x71c5)},
286 MODULE_DEVICE_TABLE(pci, ni_65xx_pci_table);
288 struct ni_65xx_private {
289 struct mite_struct *mite;
290 unsigned int filter_interval;
291 unsigned short filter_enable[NI_65XX_MAX_NUM_PORTS];
292 unsigned short output_bits[NI_65XX_MAX_NUM_PORTS];
293 unsigned short dio_direction[NI_65XX_MAX_NUM_PORTS];
296 struct ni_65xx_subdevice_private {
300 static inline struct ni_65xx_subdevice_private *sprivate(struct comedi_subdevice
303 return subdev->private;
306 static struct ni_65xx_subdevice_private *ni_65xx_alloc_subdevice_private(void)
308 struct ni_65xx_subdevice_private *subdev_private =
309 kzalloc(sizeof(struct ni_65xx_subdevice_private), GFP_KERNEL);
310 if (subdev_private == NULL)
312 return subdev_private;
315 static int ni_65xx_config_filter(struct comedi_device *dev,
316 struct comedi_subdevice *s,
317 struct comedi_insn *insn, unsigned int *data)
319 struct ni_65xx_private *devpriv = dev->private;
320 const unsigned chan = CR_CHAN(insn->chanspec);
321 const unsigned port =
322 sprivate(s)->base_port + ni_65xx_port_by_channel(chan);
324 if (data[0] != INSN_CONFIG_FILTER)
327 static const unsigned filter_resolution_ns = 200;
328 static const unsigned max_filter_interval = 0xfffff;
331 (filter_resolution_ns / 2)) / filter_resolution_ns;
332 if (interval > max_filter_interval)
333 interval = max_filter_interval;
334 data[1] = interval * filter_resolution_ns;
336 if (interval != devpriv->filter_interval) {
338 devpriv->mite->daq_io_addr +
340 devpriv->filter_interval = interval;
343 devpriv->filter_enable[port] |=
344 1 << (chan % ni_65xx_channels_per_port);
346 devpriv->filter_enable[port] &=
347 ~(1 << (chan % ni_65xx_channels_per_port));
350 writeb(devpriv->filter_enable[port],
351 devpriv->mite->daq_io_addr + Filter_Enable(port));
356 static int ni_65xx_dio_insn_config(struct comedi_device *dev,
357 struct comedi_subdevice *s,
358 struct comedi_insn *insn, unsigned int *data)
360 struct ni_65xx_private *devpriv = dev->private;
365 port = sprivate(s)->base_port +
366 ni_65xx_port_by_channel(CR_CHAN(insn->chanspec));
368 case INSN_CONFIG_FILTER:
369 return ni_65xx_config_filter(dev, s, insn, data);
371 case INSN_CONFIG_DIO_OUTPUT:
372 if (s->type != COMEDI_SUBD_DIO)
374 devpriv->dio_direction[port] = COMEDI_OUTPUT;
375 writeb(0, devpriv->mite->daq_io_addr + Port_Select(port));
378 case INSN_CONFIG_DIO_INPUT:
379 if (s->type != COMEDI_SUBD_DIO)
381 devpriv->dio_direction[port] = COMEDI_INPUT;
382 writeb(1, devpriv->mite->daq_io_addr + Port_Select(port));
385 case INSN_CONFIG_DIO_QUERY:
386 if (s->type != COMEDI_SUBD_DIO)
388 data[1] = devpriv->dio_direction[port];
397 static int ni_65xx_dio_insn_bits(struct comedi_device *dev,
398 struct comedi_subdevice *s,
399 struct comedi_insn *insn, unsigned int *data)
401 struct ni_65xx_private *devpriv = dev->private;
402 unsigned base_bitfield_channel;
403 const unsigned max_ports_per_bitfield = 5;
404 unsigned read_bits = 0;
407 base_bitfield_channel = CR_CHAN(insn->chanspec);
408 for (j = 0; j < max_ports_per_bitfield; ++j) {
409 const unsigned port_offset =
410 ni_65xx_port_by_channel(base_bitfield_channel) + j;
411 const unsigned port =
412 sprivate(s)->base_port + port_offset;
413 unsigned base_port_channel;
414 unsigned port_mask, port_data, port_read_bits;
416 if (port >= ni_65xx_total_num_ports(board(dev)))
418 base_port_channel = port_offset * ni_65xx_channels_per_port;
421 bitshift = base_port_channel - base_bitfield_channel;
422 if (bitshift >= 32 || bitshift <= -32)
425 port_mask >>= bitshift;
426 port_data >>= bitshift;
428 port_mask <<= -bitshift;
429 port_data <<= -bitshift;
435 devpriv->output_bits[port] &= ~port_mask;
436 devpriv->output_bits[port] |=
437 port_data & port_mask;
438 bits = devpriv->output_bits[port];
439 if (board(dev)->invert_outputs)
442 devpriv->mite->daq_io_addr +
446 readb(devpriv->mite->daq_io_addr + Port_Data(port));
447 if (s->type == COMEDI_SUBD_DO && board(dev)->invert_outputs) {
448 /* Outputs inverted, so invert value read back from
449 * DO subdevice. (Does not apply to boards with DIO
451 port_read_bits ^= 0xFF;
454 port_read_bits <<= bitshift;
456 port_read_bits >>= -bitshift;
458 read_bits |= port_read_bits;
464 static irqreturn_t ni_65xx_interrupt(int irq, void *d)
466 struct comedi_device *dev = d;
467 struct ni_65xx_private *devpriv = dev->private;
468 struct comedi_subdevice *s = &dev->subdevices[2];
471 status = readb(devpriv->mite->daq_io_addr + Change_Status);
472 if ((status & MasterInterruptStatus) == 0)
474 if ((status & EdgeStatus) == 0)
477 writeb(ClrEdge | ClrOverflow,
478 devpriv->mite->daq_io_addr + Clear_Register);
480 comedi_buf_put(s->async, 0);
481 s->async->events |= COMEDI_CB_EOS;
482 comedi_event(dev, s);
486 static int ni_65xx_intr_cmdtest(struct comedi_device *dev,
487 struct comedi_subdevice *s,
488 struct comedi_cmd *cmd)
492 /* Step 1 : check if triggers are trivially valid */
494 err |= cfc_check_trigger_src(&cmd->start_src, TRIG_NOW);
495 err |= cfc_check_trigger_src(&cmd->scan_begin_src, TRIG_OTHER);
496 err |= cfc_check_trigger_src(&cmd->convert_src, TRIG_FOLLOW);
497 err |= cfc_check_trigger_src(&cmd->scan_end_src, TRIG_COUNT);
498 err |= cfc_check_trigger_src(&cmd->stop_src, TRIG_COUNT);
503 /* Step 2a : make sure trigger sources are unique */
504 /* Step 2b : and mutually compatible */
509 /* Step 3: check if arguments are trivially valid */
511 err |= cfc_check_trigger_arg_is(&cmd->start_arg, 0);
512 err |= cfc_check_trigger_arg_is(&cmd->scan_begin_arg, 0);
513 err |= cfc_check_trigger_arg_is(&cmd->convert_arg, 0);
514 err |= cfc_check_trigger_arg_is(&cmd->scan_end_arg, 1);
515 err |= cfc_check_trigger_arg_is(&cmd->stop_arg, 0);
520 /* step 4: fix up any arguments */
528 static int ni_65xx_intr_cmd(struct comedi_device *dev,
529 struct comedi_subdevice *s)
531 struct ni_65xx_private *devpriv = dev->private;
532 /* struct comedi_cmd *cmd = &s->async->cmd; */
534 writeb(ClrEdge | ClrOverflow,
535 devpriv->mite->daq_io_addr + Clear_Register);
536 writeb(FallingEdgeIntEnable | RisingEdgeIntEnable |
537 MasterInterruptEnable | EdgeIntEnable,
538 devpriv->mite->daq_io_addr + Master_Interrupt_Control);
543 static int ni_65xx_intr_cancel(struct comedi_device *dev,
544 struct comedi_subdevice *s)
546 struct ni_65xx_private *devpriv = dev->private;
548 writeb(0x00, devpriv->mite->daq_io_addr + Master_Interrupt_Control);
553 static int ni_65xx_intr_insn_bits(struct comedi_device *dev,
554 struct comedi_subdevice *s,
555 struct comedi_insn *insn, unsigned int *data)
561 static int ni_65xx_intr_insn_config(struct comedi_device *dev,
562 struct comedi_subdevice *s,
563 struct comedi_insn *insn,
566 struct ni_65xx_private *devpriv = dev->private;
570 if (data[0] != INSN_CONFIG_CHANGE_NOTIFY)
574 devpriv->mite->daq_io_addr +
575 Rising_Edge_Detection_Enable(0));
577 devpriv->mite->daq_io_addr +
578 Rising_Edge_Detection_Enable(0x10));
579 writeb(data[1] >> 16,
580 devpriv->mite->daq_io_addr +
581 Rising_Edge_Detection_Enable(0x20));
582 writeb(data[1] >> 24,
583 devpriv->mite->daq_io_addr +
584 Rising_Edge_Detection_Enable(0x30));
587 devpriv->mite->daq_io_addr +
588 Falling_Edge_Detection_Enable(0));
590 devpriv->mite->daq_io_addr +
591 Falling_Edge_Detection_Enable(0x10));
592 writeb(data[2] >> 16,
593 devpriv->mite->daq_io_addr +
594 Falling_Edge_Detection_Enable(0x20));
595 writeb(data[2] >> 24,
596 devpriv->mite->daq_io_addr +
597 Falling_Edge_Detection_Enable(0x30));
602 static const struct ni_65xx_board *
603 ni_65xx_find_boardinfo(struct pci_dev *pcidev)
605 unsigned int dev_id = pcidev->device;
608 for (n = 0; n < ARRAY_SIZE(ni_65xx_boards); n++) {
609 const struct ni_65xx_board *board = &ni_65xx_boards[n];
610 if (board->dev_id == dev_id)
616 static int ni_65xx_auto_attach(struct comedi_device *dev,
617 unsigned long context_unused)
619 struct pci_dev *pcidev = comedi_to_pci_dev(dev);
620 struct ni_65xx_private *devpriv;
621 struct comedi_subdevice *s;
625 devpriv = kzalloc(sizeof(*devpriv), GFP_KERNEL);
628 dev->private = devpriv;
630 dev->board_ptr = ni_65xx_find_boardinfo(pcidev);
634 devpriv->mite = mite_alloc(pcidev);
638 ret = mite_setup(devpriv->mite);
640 dev_warn(dev->class_dev, "error setting up mite\n");
644 dev->board_name = board(dev)->name;
645 dev->irq = mite_irq(devpriv->mite);
646 dev_info(dev->class_dev, "board: %s, ID=0x%02x", dev->board_name,
647 readb(devpriv->mite->daq_io_addr + ID_Register));
649 ret = comedi_alloc_subdevices(dev, 4);
653 s = &dev->subdevices[0];
654 if (board(dev)->num_di_ports) {
655 s->type = COMEDI_SUBD_DI;
656 s->subdev_flags = SDF_READABLE;
658 board(dev)->num_di_ports * ni_65xx_channels_per_port;
659 s->range_table = &range_digital;
661 s->insn_config = ni_65xx_dio_insn_config;
662 s->insn_bits = ni_65xx_dio_insn_bits;
663 s->private = ni_65xx_alloc_subdevice_private();
664 if (s->private == NULL)
666 sprivate(s)->base_port = 0;
668 s->type = COMEDI_SUBD_UNUSED;
671 s = &dev->subdevices[1];
672 if (board(dev)->num_do_ports) {
673 s->type = COMEDI_SUBD_DO;
674 s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
676 board(dev)->num_do_ports * ni_65xx_channels_per_port;
677 s->range_table = &range_digital;
679 s->insn_bits = ni_65xx_dio_insn_bits;
680 s->private = ni_65xx_alloc_subdevice_private();
681 if (s->private == NULL)
683 sprivate(s)->base_port = board(dev)->num_di_ports;
685 s->type = COMEDI_SUBD_UNUSED;
688 s = &dev->subdevices[2];
689 if (board(dev)->num_dio_ports) {
690 s->type = COMEDI_SUBD_DIO;
691 s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
693 board(dev)->num_dio_ports * ni_65xx_channels_per_port;
694 s->range_table = &range_digital;
696 s->insn_config = ni_65xx_dio_insn_config;
697 s->insn_bits = ni_65xx_dio_insn_bits;
698 s->private = ni_65xx_alloc_subdevice_private();
699 if (s->private == NULL)
701 sprivate(s)->base_port = 0;
702 for (i = 0; i < board(dev)->num_dio_ports; ++i) {
703 /* configure all ports for input */
705 devpriv->mite->daq_io_addr +
709 s->type = COMEDI_SUBD_UNUSED;
712 s = &dev->subdevices[3];
713 dev->read_subdev = s;
714 s->type = COMEDI_SUBD_DI;
715 s->subdev_flags = SDF_READABLE | SDF_CMD_READ;
717 s->range_table = &range_unknown;
719 s->do_cmdtest = ni_65xx_intr_cmdtest;
720 s->do_cmd = ni_65xx_intr_cmd;
721 s->cancel = ni_65xx_intr_cancel;
722 s->insn_bits = ni_65xx_intr_insn_bits;
723 s->insn_config = ni_65xx_intr_insn_config;
725 for (i = 0; i < ni_65xx_total_num_ports(board(dev)); ++i) {
727 devpriv->mite->daq_io_addr + Filter_Enable(i));
728 if (board(dev)->invert_outputs)
730 devpriv->mite->daq_io_addr + Port_Data(i));
733 devpriv->mite->daq_io_addr + Port_Data(i));
735 writeb(ClrEdge | ClrOverflow,
736 devpriv->mite->daq_io_addr + Clear_Register);
738 devpriv->mite->daq_io_addr + Master_Interrupt_Control);
740 /* Set filter interval to 0 (32bit reg) */
741 writeb(0x00000000, devpriv->mite->daq_io_addr + Filter_Interval);
743 ret = request_irq(dev->irq, ni_65xx_interrupt, IRQF_SHARED,
747 dev_warn(dev->class_dev, "irq not available\n");
753 static void ni_65xx_detach(struct comedi_device *dev)
755 struct ni_65xx_private *devpriv = dev->private;
757 if (devpriv && devpriv->mite && devpriv->mite->daq_io_addr) {
759 devpriv->mite->daq_io_addr +
760 Master_Interrupt_Control);
763 free_irq(dev->irq, dev);
765 struct comedi_subdevice *s;
768 for (i = 0; i < dev->n_subdevices; ++i) {
769 s = &dev->subdevices[i];
774 mite_unsetup(devpriv->mite);
775 mite_free(devpriv->mite);
780 static struct comedi_driver ni_65xx_driver = {
781 .driver_name = "ni_65xx",
782 .module = THIS_MODULE,
783 .auto_attach = ni_65xx_auto_attach,
784 .detach = ni_65xx_detach,
787 static int ni_65xx_pci_probe(struct pci_dev *dev,
788 const struct pci_device_id *ent)
790 return comedi_pci_auto_config(dev, &ni_65xx_driver);
793 static struct pci_driver ni_65xx_pci_driver = {
795 .id_table = ni_65xx_pci_table,
796 .probe = ni_65xx_pci_probe,
797 .remove = comedi_pci_auto_unconfig,
799 module_comedi_pci_driver(ni_65xx_driver, ni_65xx_pci_driver);
801 MODULE_AUTHOR("Comedi http://www.comedi.org");
802 MODULE_DESCRIPTION("Comedi low-level driver");
803 MODULE_LICENSE("GPL");