[PATCH 15/15] staging: comedi: ni_daq_700: update the comedi driver comment

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Update the comment block that comedilib uses to automatically
generate documentation so that it matches the drivers new
functionality.

Remove the Version information. The git history provides better
information.

Signed-off-by: H Hartley Sweeten <hsweeten@xxxxxxxxxxxxxxxxxxx>
Cc: Ian Abbott <abbotti@xxxxxxxxx>
Cc: Greg Kroah-Hartman <gregk@xxxxxxxxxxxxxxxxxxx>
---
 drivers/staging/comedi/drivers/ni_daq_700.c | 46 +++++++++++++++++++++--------
 1 file changed, 34 insertions(+), 12 deletions(-)

diff --git a/drivers/staging/comedi/drivers/ni_daq_700.c b/drivers/staging/comedi/drivers/ni_daq_700.c
index 4ff3556..a321774 100644
--- a/drivers/staging/comedi/drivers/ni_daq_700.c
+++ b/drivers/staging/comedi/drivers/ni_daq_700.c
@@ -26,22 +26,44 @@
  * Status: works
  * Updated: Wed, 21 May 2014 12:07:20 +0000
  *
- * The daqcard-700 appears in Comedi as a  digital I/O subdevice (0) with
- * 16 channels and a analog input subdevice (1) with 16 single-ended channels
- * or 8 differential channels, and three input ranges.
+ * Configuration Options: not applicable, uses PCMCIA auto config
  *
- * Digital:  The channel 0 corresponds to the daqcard-700's output
- * port, bit 0; channel 8 corresponds to the input port, bit 0.
+ * The daqcard-700 appears in Comedi as a three subdevices:
  *
- * Digital direction configuration: channels 0-7 output, 8-15 input.
+ * Subdevice 0: Digital I/O - 16 channels (fixed direction)
+ * --------------------------------------------------------
+ * Channels 0-7 are the output port 0-7 signals
+ * Channels 8-15 are the input port 0-7 signals
  *
- * Analog: The input  range is 0 to 4095 with a default of -10 to +10 volts.
- * Valid ranges:
- *       0 for -10 to 10V bipolar
- *       1 for -5 to 5V bipolar
- *       2 for -2.5 to 2.5V bipolar
+ * Subdevice 1: Analog Input - 16 single-ended / 8 differential channels
+ * ---------------------------------------------------------------------
+ * Input range is 0 - 4095 with programmable gain
+ *	0 for -10 to 10V bipolar (default)
+ *	1 for -5 to 5V bipolar
+ *	2 for -2.5 to 2.5V bipolar
  *
- * IRQ is assigned but not used.
+ * In differential mode, the channels are paired as:
+ *	channels 0-7	positive inputs
+ *	channels 8-15	negative inputs
+ *
+ * Subdevice 2: Counter - 3 channels (8254 timer/counter)
+ * ------------------------------------------------------
+ * Channel 0 is can be used for timed AI acquisitions, all three timers
+ * can also be used for general-purpose timing functions.
+ *
+ * The clock source for channel 0 is fixed to the internal 1MHz clock.
+ * Channel 1 can be configured to use the intenal 1MHz clock or an
+ * external clock. Channel 2 always uses an external clock source.
+ *
+ * Async command support (requires an IRQ assigned by the PCMCIA subsystem)
+ * ------------------------------------------------------------------------
+ * The Analog Input subdevice can do timed acquisitions using counter 0.
+ * Sample interval must be between 10 and 65535 ns. Acquisitions can also
+ * be triggered externally using the EXTCONV signal.
+ *
+ * All channels in the scan list must have the same range and aref. The
+ * channels must also be sequential and count down to 0 or the scan list
+ * must only have a single channel.
  *
  * Manuals:	Register level:	http://www.ni.com/pdf/manuals/340698.pdf
  *		User Manual:	http://www.ni.com/pdf/manuals/320676d.pdf
-- 
1.9.3

_______________________________________________
devel mailing list
devel@xxxxxxxxxxxxxxxxxxxxxx
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel




[Index of Archives]     [Linux Driver Backports]     [DMA Engine]     [Linux GPIO]     [Linux SPI]     [Video for Linux]     [Linux USB Devel]     [Linux Coverity]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Yosemite Backpacking]
  Powered by Linux