Release 4.9 drivers/staging/comedi/drivers/ni_tiocmd.c

/*
 * Command support for NI general purpose counters
 *
 * Copyright (C) 2006 Frank Mori Hess <fmhess@users.sourceforge.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

/*
 * Module: ni_tiocmd
 * Description: National Instruments general purpose counters command support
 * Author: J.P. Mellor <jpmellor@rose-hulman.edu>,
 *         Herman.Bruyninckx@mech.kuleuven.ac.be,
 *         Wim.Meeussen@mech.kuleuven.ac.be,
 *         Klaas.Gadeyne@mech.kuleuven.ac.be,
 *         Frank Mori Hess <fmhess@users.sourceforge.net>
 * Updated: Fri, 11 Apr 2008 12:32:35 +0100
 * Status: works
 *
 * This module is not used directly by end-users.  Rather, it
 * is used by other drivers (for example ni_660x and ni_pcimio)
 * to provide command support for NI's general purpose counters.
 * It was originally split out of ni_tio.c to stop the 'ni_tio'
 * module depending on the 'mite' module.
 *
 * References:
 * DAQ 660x Register-Level Programmer Manual  (NI 370505A-01)
 * DAQ 6601/6602 User Manual (NI 322137B-01)
 * 340934b.pdf  DAQ-STC reference manual
 *
 * TODO: Support use of both banks X and Y
 */

#include <linux/module.h>
#include "ni_tio_internal.h"
#include "mite.h"



static void ni_tio_configure_dma(struct ni_gpct *counter,
				 bool enable, bool read)
{
	struct ni_gpct_device *counter_dev = counter->counter_dev;
	unsigned int cidx = counter->counter_index;
	unsigned int mask;
	unsigned int bits;

	mask = GI_READ_ACKS_IRQ | GI_WRITE_ACKS_IRQ;
	bits = 0;

	if (enable) {
		if (read)
			bits |= GI_READ_ACKS_IRQ;
		else
			bits |= GI_WRITE_ACKS_IRQ;
	}
	ni_tio_set_bits(counter, NITIO_INPUT_SEL_REG(cidx), mask, bits);

	switch (counter_dev->variant) {
	case ni_gpct_variant_e_series:
		break;
	case ni_gpct_variant_m_series:
	case ni_gpct_variant_660x:
		mask = GI_DMA_ENABLE | GI_DMA_INT_ENA | GI_DMA_WRITE;
		bits = 0;

		if (enable)
			bits |= GI_DMA_ENABLE | GI_DMA_INT_ENA;
		if (!read)
			bits |= GI_DMA_WRITE;
		ni_tio_set_bits(counter, NITIO_DMA_CFG_REG(cidx), mask, bits);
		break;
	}
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
90
60.40%
1
12.50%
h hartley sweeten
h hartley sweeten
59
39.60%
7
87.50%
Total
149
100.00%
8
100.00%



static int ni_tio_input_inttrig(struct comedi_device *dev,
				struct comedi_subdevice *s,
				unsigned int trig_num)
{
	struct ni_gpct *counter = s->private;
	struct comedi_cmd *cmd = &s->async->cmd;
	unsigned long flags;
	int ret = 0;

	if (trig_num != cmd->start_arg)
		return -EINVAL;

	spin_lock_irqsave(&counter->lock, flags);
	if (counter->mite_chan)
		mite_dma_arm(counter->mite_chan);
	else
		ret = -EIO;
	spin_unlock_irqrestore(&counter->lock, flags);
	if (ret < 0)
		return ret;
	ret = ni_tio_arm(counter, true, NI_GPCT_ARM_IMMEDIATE);
	s->async->inttrig = NULL;

	return ret;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
96
72.73%
1
12.50%
h hartley sweeten
h hartley sweeten
31
23.48%
3
37.50%
greg kroah-hartman
greg kroah-hartman
2
1.52%
1
12.50%
bill pemberton
bill pemberton
2
1.52%
2
25.00%
spencer e. olson
spencer e. olson
1
0.76%
1
12.50%
Total
132
100.00%
8
100.00%



static int ni_tio_input_cmd(struct comedi_subdevice *s)
{
	struct ni_gpct *counter = s->private;
	struct ni_gpct_device *counter_dev = counter->counter_dev;
	unsigned int cidx = counter->counter_index;
	struct comedi_async *async = s->async;
	struct comedi_cmd *cmd = &async->cmd;
	int ret = 0;

	/* write alloc the entire buffer */
	comedi_buf_write_alloc(s, async->prealloc_bufsz);
	counter->mite_chan->dir = COMEDI_INPUT;
	switch (counter_dev->variant) {
	case ni_gpct_variant_m_series:
	case ni_gpct_variant_660x:
		mite_prep_dma(counter->mite_chan, 32, 32);
		break;
	case ni_gpct_variant_e_series:
		mite_prep_dma(counter->mite_chan, 16, 32);
		break;
	}
	ni_tio_set_bits(counter, NITIO_CMD_REG(cidx), GI_SAVE_TRACE, 0);
	ni_tio_configure_dma(counter, true, true);

	if (cmd->start_src == TRIG_INT) {
		async->inttrig = &ni_tio_input_inttrig;
	} else {	/* TRIG_NOW || TRIG_EXT || TRIG_OTHER */
		async->inttrig = NULL;
		mite_dma_arm(counter->mite_chan);

		if (cmd->start_src == TRIG_NOW)
			ret = ni_tio_arm(counter, true, NI_GPCT_ARM_IMMEDIATE);
		else if (cmd->start_src == TRIG_EXT)
			ret = ni_tio_arm(counter, true, cmd->start_arg);
	}
	return ret;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
151
68.33%
1
9.09%
h hartley sweeten
h hartley sweeten
48
21.72%
7
63.64%
ian abbott
ian abbott
21
9.50%
2
18.18%
bill pemberton
bill pemberton
1
0.45%
1
9.09%
Total
221
100.00%
11
100.00%



static int ni_tio_output_cmd(struct comedi_subdevice *s)
{
	struct ni_gpct *counter = s->private;

	dev_err(counter->counter_dev->dev->class_dev,
		"output commands not yet implemented.\n");
	return -ENOTSUPP;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
16
43.24%
1
33.33%
ian abbott
ian abbott
11
29.73%
1
33.33%
toshiaki yamane
toshiaki yamane
10
27.03%
1
33.33%
Total
37
100.00%
3
100.00%



static int ni_tio_cmd_setup(struct comedi_subdevice *s)
{
	struct comedi_cmd *cmd = &s->async->cmd;
	struct ni_gpct *counter = s->private;
	unsigned int cidx = counter->counter_index;
	int set_gate_source = 0;
	unsigned int gate_source;
	int retval = 0;

	if (cmd->scan_begin_src == TRIG_EXT) {
		set_gate_source = 1;
		gate_source = cmd->scan_begin_arg;
	} else if (cmd->convert_src == TRIG_EXT) {
		set_gate_source = 1;
		gate_source = cmd->convert_arg;
	}
	if (set_gate_source)
		retval = ni_tio_set_gate_src(counter, 0, gate_source);
	if (cmd->flags & CMDF_WAKE_EOS) {
		ni_tio_set_bits(counter, NITIO_INT_ENA_REG(cidx),
				GI_GATE_INTERRUPT_ENABLE(cidx),
				GI_GATE_INTERRUPT_ENABLE(cidx));
	}
	return retval;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
113
79.02%
1
12.50%
h hartley sweeten
h hartley sweeten
15
10.49%
4
50.00%
ian abbott
ian abbott
14
9.79%
2
25.00%
bill pemberton
bill pemberton
1
0.70%
1
12.50%
Total
143
100.00%
8
100.00%



int ni_tio_cmd(struct comedi_device *dev, struct comedi_subdevice *s)
{
	struct ni_gpct *counter = s->private;
	struct comedi_async *async = s->async;
	struct comedi_cmd *cmd = &async->cmd;
	int retval = 0;
	unsigned long flags;

	spin_lock_irqsave(&counter->lock, flags);
	if (!counter->mite_chan) {
		dev_err(counter->counter_dev->dev->class_dev,
			"commands only supported with DMA.  ");
		dev_err(counter->counter_dev->dev->class_dev,
			"Interrupt-driven commands not yet implemented.\n");
		retval = -EIO;
	} else {
		retval = ni_tio_cmd_setup(s);
		if (retval == 0) {
			if (cmd->flags & CMDF_WRITE)
				retval = ni_tio_output_cmd(s);
			else
				retval = ni_tio_input_cmd(s);
		}
	}
	spin_unlock_irqrestore(&counter->lock, flags);
	return retval;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
104
66.67%
1
12.50%
toshiaki yamane
toshiaki yamane
23
14.74%
1
12.50%
h hartley sweeten
h hartley sweeten
22
14.10%
2
25.00%
ian abbott
ian abbott
3
1.92%
1
12.50%
bill pemberton
bill pemberton
2
1.28%
2
25.00%
greg kroah-hartman
greg kroah-hartman
2
1.28%
1
12.50%
Total
156
100.00%
8
100.00%


EXPORT_SYMBOL_GPL(ni_tio_cmd);



int ni_tio_cmdtest(struct comedi_device *dev,
		   struct comedi_subdevice *s,
		   struct comedi_cmd *cmd)
{
	struct ni_gpct *counter = s->private;
	int err = 0;
	unsigned int sources;

	/* Step 1 : check if triggers are trivially valid */

	sources = TRIG_NOW | TRIG_INT | TRIG_OTHER;
	if (ni_tio_counting_mode_registers_present(counter->counter_dev))
		sources |= TRIG_EXT;
	err |= comedi_check_trigger_src(&cmd->start_src, sources);

	err |= comedi_check_trigger_src(&cmd->scan_begin_src,
					TRIG_FOLLOW | TRIG_EXT | TRIG_OTHER);
	err |= comedi_check_trigger_src(&cmd->convert_src,
					TRIG_NOW | TRIG_EXT | TRIG_OTHER);
	err |= comedi_check_trigger_src(&cmd->scan_end_src, TRIG_COUNT);
	err |= comedi_check_trigger_src(&cmd->stop_src, TRIG_NONE);

	if (err)
		return 1;

	/* Step 2a : make sure trigger sources are unique */

	err |= comedi_check_trigger_is_unique(cmd->start_src);
	err |= comedi_check_trigger_is_unique(cmd->scan_begin_src);
	err |= comedi_check_trigger_is_unique(cmd->convert_src);

	/* Step 2b : and mutually compatible */

	if (cmd->convert_src != TRIG_NOW && cmd->scan_begin_src != TRIG_FOLLOW)
		err |= -EINVAL;

	if (err)
		return 2;

	/* Step 3: check if arguments are trivially valid */

	switch (cmd->start_src) {
	case TRIG_NOW:
	case TRIG_INT:
	case TRIG_OTHER:
		err |= comedi_check_trigger_arg_is(&cmd->start_arg, 0);
		break;
	case TRIG_EXT:
		/* start_arg is the start_trigger passed to ni_tio_arm() */
		break;
	}

	if (cmd->scan_begin_src != TRIG_EXT)
		err |= comedi_check_trigger_arg_is(&cmd->scan_begin_arg, 0);

	if (cmd->convert_src != TRIG_EXT)
		err |= comedi_check_trigger_arg_is(&cmd->convert_arg, 0);

	err |= comedi_check_trigger_arg_is(&cmd->scan_end_arg,
					   cmd->chanlist_len);
	err |= comedi_check_trigger_arg_is(&cmd->stop_arg, 0);

	if (err)
		return 3;

	/* Step 4: fix up any arguments */

	/* Step 5: check channel list if it exists */

	return 0;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
180
59.21%
1
12.50%
h hartley sweeten
h hartley sweeten
110
36.18%
5
62.50%
ian abbott
ian abbott
13
4.28%
1
12.50%
bill pemberton
bill pemberton
1
0.33%
1
12.50%
Total
304
100.00%
8
100.00%


EXPORT_SYMBOL_GPL(ni_tio_cmdtest);



int ni_tio_cancel(struct ni_gpct *counter)
{
	unsigned int cidx = counter->counter_index;
	unsigned long flags;

	ni_tio_arm(counter, false, 0);
	spin_lock_irqsave(&counter->lock, flags);
	if (counter->mite_chan)
		mite_dma_disarm(counter->mite_chan);
	spin_unlock_irqrestore(&counter->lock, flags);
	ni_tio_configure_dma(counter, false, false);

	ni_tio_set_bits(counter, NITIO_INT_ENA_REG(cidx),
			GI_GATE_INTERRUPT_ENABLE(cidx), 0x0);
	return 0;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
76
81.72%
1
12.50%
h hartley sweeten
h hartley sweeten
15
16.13%
6
75.00%
greg kroah-hartman
greg kroah-hartman
2
2.15%
1
12.50%
Total
93
100.00%
8
100.00%


EXPORT_SYMBOL_GPL(ni_tio_cancel);



static int should_ack_gate(struct ni_gpct *counter)
{
	unsigned long flags;
	int retval = 0;

	switch (counter->counter_dev->variant) {
	case ni_gpct_variant_m_series:
	case ni_gpct_variant_660x:
		/*
                 * not sure if 660x really supports gate interrupts
                 * (the bits are not listed in register-level manual)
                 */
		return 1;
	case ni_gpct_variant_e_series:
		/*
                 * During buffered input counter operation for e-series,
                 * the gate interrupt is acked automatically by the dma
                 * controller, due to the Gi_Read/Write_Acknowledges_IRQ
                 * bits in the input select register.
                 */
		spin_lock_irqsave(&counter->lock, flags);
		{
			if (!counter->mite_chan ||
			    counter->mite_chan->dir != COMEDI_INPUT ||
			    (mite_done(counter->mite_chan))) {
				retval = 1;
			}
		}
		spin_unlock_irqrestore(&counter->lock, flags);
		break;
	}
	return retval;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
95
95.00%
1
25.00%
h hartley sweeten
h hartley sweeten
3
3.00%
2
50.00%
greg kroah-hartman
greg kroah-hartman
2
2.00%
1
25.00%
Total
100
100.00%
4
100.00%



static void ni_tio_acknowledge_and_confirm(struct ni_gpct *counter,
					   int *gate_error,
					   int *tc_error,
					   int *perm_stale_data)
{
	unsigned int cidx = counter->counter_index;
	const unsigned short gxx_status = ni_tio_read(counter,
						NITIO_SHARED_STATUS_REG(cidx));
	const unsigned short gi_status = ni_tio_read(counter,
						NITIO_STATUS_REG(cidx));
	unsigned int ack = 0;

	if (gate_error)
		*gate_error = 0;
	if (tc_error)
		*tc_error = 0;
	if (perm_stale_data)
		*perm_stale_data = 0;

	if (gxx_status & GI_GATE_ERROR(cidx)) {
		ack |= GI_GATE_ERROR_CONFIRM(cidx);
		if (gate_error) {
			/*
                         * 660x don't support automatic acknowledgment
                         * of gate interrupt via dma read/write
                         * and report bogus gate errors
                         */
			if (counter->counter_dev->variant !=
			    ni_gpct_variant_660x)
				*gate_error = 1;
		}
	}
	if (gxx_status & GI_TC_ERROR(cidx)) {
		ack |= GI_TC_ERROR_CONFIRM(cidx);
		if (tc_error)
			*tc_error = 1;
	}
	if (gi_status & GI_TC)
		ack |= GI_TC_INTERRUPT_ACK;
	if (gi_status & GI_GATE_INTERRUPT) {
		if (should_ack_gate(counter))
			ack |= GI_GATE_INTERRUPT_ACK;
	}
	if (ack)
		ni_tio_write(counter, ack, NITIO_INT_ACK_REG(cidx));
	if (ni_tio_get_soft_copy(counter, NITIO_MODE_REG(cidx)) &
	    GI_LOADING_ON_GATE) {
		if (ni_tio_read(counter, NITIO_STATUS2_REG(cidx)) &
		    GI_PERMANENT_STALE(cidx)) {
			dev_info(counter->counter_dev->dev->class_dev,
				 "%s: Gi_Permanent_Stale_Data detected.\n",
				 __func__);
			if (perm_stale_data)
				*perm_stale_data = 1;
		}
	}
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
215
81.13%
1
5.88%
h hartley sweeten
h hartley sweeten
40
15.09%
14
82.35%
toshiaki yamane
toshiaki yamane
9
3.40%
1
5.88%
xenofon foukas
xenofon foukas
1
0.38%
1
5.88%
Total
265
100.00%
17
100.00%



void ni_tio_acknowledge(struct ni_gpct *counter)
{
	ni_tio_acknowledge_and_confirm(counter, NULL, NULL, NULL);
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
h hartley sweeten
h hartley sweeten
21
100.00%
1
100.00%
Total
21
100.00%
1
100.00%


EXPORT_SYMBOL_GPL(ni_tio_acknowledge);



void ni_tio_handle_interrupt(struct ni_gpct *counter,
			     struct comedi_subdevice *s)
{
	unsigned int cidx = counter->counter_index;
	unsigned long flags;
	int gate_error;
	int tc_error;
	int perm_stale_data;

	ni_tio_acknowledge_and_confirm(counter, &gate_error, &tc_error,
				       &perm_stale_data);
	if (gate_error) {
		dev_notice(counter->counter_dev->dev->class_dev,
			   "%s: Gi_Gate_Error detected.\n", __func__);
		s->async->events |= COMEDI_CB_OVERFLOW;
	}
	if (perm_stale_data)
		s->async->events |= COMEDI_CB_ERROR;
	switch (counter->counter_dev->variant) {
	case ni_gpct_variant_m_series:
	case ni_gpct_variant_660x:
		if (ni_tio_read(counter, NITIO_DMA_STATUS_REG(cidx)) &
		    GI_DRQ_ERROR) {
			dev_notice(counter->counter_dev->dev->class_dev,
				   "%s: Gi_DRQ_Error detected.\n", __func__);
			s->async->events |= COMEDI_CB_OVERFLOW;
		}
		break;
	case ni_gpct_variant_e_series:
		break;
	}
	spin_lock_irqsave(&counter->lock, flags);
	if (counter->mite_chan)
		mite_ack_linkc(counter->mite_chan, s, true);
	spin_unlock_irqrestore(&counter->lock, flags);
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
149
79.26%
1
7.69%
toshiaki yamane
toshiaki yamane
18
9.57%
1
7.69%
h hartley sweeten
h hartley sweeten
16
8.51%
8
61.54%
greg kroah-hartman
greg kroah-hartman
2
1.06%
1
7.69%
xenofon foukas
xenofon foukas
2
1.06%
1
7.69%
bill pemberton
bill pemberton
1
0.53%
1
7.69%
Total
188
100.00%
13
100.00%


EXPORT_SYMBOL_GPL(ni_tio_handle_interrupt);



void ni_tio_set_mite_channel(struct ni_gpct *counter,
			     struct mite_channel *mite_chan)
{
	unsigned long flags;

	spin_lock_irqsave(&counter->lock, flags);
	counter->mite_chan = mite_chan;
	spin_unlock_irqrestore(&counter->lock, flags);
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
43
95.56%
1
50.00%
greg kroah-hartman
greg kroah-hartman
2
4.44%
1
50.00%
Total
45
100.00%
2
100.00%


EXPORT_SYMBOL_GPL(ni_tio_set_mite_channel);



static int __init ni_tiocmd_init_module(void)
{
	return 0;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
12
100.00%
1
100.00%
Total
12
100.00%
1
100.00%


module_init(ni_tiocmd_init_module);



static void __exit ni_tiocmd_cleanup_module(void)
{
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
8
100.00%
1
100.00%
Total
8
100.00%
1
100.00%


module_exit(ni_tiocmd_cleanup_module);

MODULE_AUTHOR("Comedi <comedi@comedi.org>");
MODULE_DESCRIPTION("Comedi command support for NI general-purpose counters");
MODULE_LICENSE("GPL");
Overall Contributors
Person
Tokens
Prop
Commits
CommitProp
frank mori hess
frank mori hess
1364
70.31%
1
1.89%
h hartley sweeten
h hartley sweeten
401
20.67%
40
75.47%
ian abbott
ian abbott
62
3.20%
4
7.55%
toshiaki yamane
toshiaki yamane
60
3.09%
1
1.89%
xenofon foukas
xenofon foukas
32
1.65%
1
1.89%
greg kroah-hartman
greg kroah-hartman
12
0.62%
1
1.89%
bill pemberton
bill pemberton
8
0.41%
4
7.55%
spencer e. olson
spencer e. olson
1
0.05%
1
1.89%
Total
1940
100.00%
53
100.00%
  
Directory: drivers/staging/comedi/drivers