Commit graph

267 commits

Author SHA1 Message Date
Ian Abbott
44c031d0f2 doc/drivers.txt: Rebuilt from Comedi sources
Rebuilt from the "out-of-tree" Comedi kernel module sources.  The
adv_pci1710 driver gains support for Advantech PCI-1716.
2017-05-11 12:12:37 +01:00
Ian Abbott
05bdfb7cfa doc/drivers.txt: Rebuilt from Comedi sources
Note: This is built from the "out-of-tree" Comedi kernel module sources,
not the Linux "staging" Comedi kernel sources.
2017-04-27 16:35:31 +01:00
Ian Abbott
a2573fff8f doc/drivers.txt: Rebuilt from Comedi - capitalize ADLINK consistently
Use updated drivers.txt from the comedi.org Comedi package.  The
documentation for the ADLINK drivers has been updated to capitalize
ADLINK in a consistent manner.
2016-07-07 11:23:37 +01:00
Ian Abbott
f6c1318c6c doc/drivers.txt: Rebuilt from comedi
Rebuilt "doc/drivers.txt" using "make Documentation/comedi/drivers.txt"
in the Comedi package, which scans the driver sources for documentation.

Note: this is built from the comedi.org Comedi sources, not the Linux
"staging" Comedi sources.
2016-07-07 10:58:55 +01:00
Ian Abbott
a4dd004076 demo/insn: report start and end time as unsigned values
Report the seconds and microseconds values from the INSN_GTOD
instructions as unsigned values to postpone the Y2038 problem to a Y2106
problem.  Be a bit more careful with the conversion to a signed
difference.  We wouldn't normally expect time to go backwards, but it is
possible if the system time is set to to an older time between the
instructions.

Also, in the description of INSN_GTOD in the Comedilib manual,
explicitly mention that the seconds and microseconds values are
unsigned.
2016-06-20 11:09:55 +01:00
Ian Abbott
7958fec6c5 doc: Makefile.am: rebuild manual when tutorial program source changes 2016-05-13 18:14:57 +01:00
Ian Abbott
6373588120 doc: include the full tut3.c program listing
Include the full tut3.c program listing in the document as it's not much
bigger than tut3_part.c and it's a pain maintaining both of them.
2016-05-13 17:55:39 +01:00
Ian Abbott
8c31fb88c1 lib: don't change read or write subdevice unnecessarily
Change comedi_set_read_subdevice() and comedi_set_write_subdevice() to
do nothing if the requested subdevice is already set as the current read
or write subdevice, respectively.

The functions now return success even if the Comedi drivers do not
support changes to the read or write subdevice as long as the specified
subdevice is the default one.
2016-05-13 16:18:02 +01:00
Ian Abbott
aff4937e03 Added some more buffer position functions for use with mmap
Added comedi_get_buffer_read_offset(), comedi_get_buffer_write_offset(),
comedi_get_buffer_read_count(), and comedi_get_buffer_write_count().

comedi_get_buffer_read_offset() is the same as
comedi_get_buffer_offset(), which has now been documented as deprecated,
but is currently still declared in "comedilib.h" by default.  It gets
the read position within the buffer as an offset from the start of the
buffer (modulo the buffer size).

comedi_get_buffer_write_offset() gets the write position within the
buffer as an offset from the start of the buffer (modulo the buffer
size).

comedi_get_buffer_read_count() gets the number of bytes read from the
buffer, modulo UINT_MAX+1.

comedi_get_buffer_write_count() gets the number of bytes written to the
buffer, modulo UINT_MAX+1.
2016-05-13 15:14:47 +01:00
Ian Abbott
fad46b9b16 doc: tweak some of the documentation for streaming acquisition functions 2016-05-13 14:30:19 +01:00
Ian Abbott
22caa42aee doc: command_funcref.txt: fix DocBook tag
Change '<em>' to '<emphasis>'.
2016-05-13 14:19:58 +01:00
Ian Abbott
5762a1dd60 doc: corrected link content comedi_cleanup_calibration_file
'comedi_cleanup_calibrate_calibration_file' should be
'comedi_cleanup_calibration'.
2016-05-12 19:08:31 +01:00
Ian Abbott
aec40a79aa doc: refer to device file descriptors rather than device files 2016-05-12 18:18:08 +01:00
Ian Abbott
66070c6af6 Add comedi_set_read_subdevice() and comedi_set_write_subdevice()
These functions allow the current read or write subdevice to be changed
to another subdevice that supports streaming input (for read), or
streaming output (for write) asynchronous commands.

They return 0 on success, in which case the comedi_get_read_subdevice()
or comedi_get_write_subdevice() functions will get the updated read or
write subdevice.

Changes are local to the "open file description" that was created by
comedi_open() (actually, by open()), and have no effect on other open
file descriptions created by other calls to comedi_open() (or open())
for the same underlying Comedi device node.

Changes to the read or write subdevice is not currently supported by the
comedi.org version of the Comedi drivers, but is supported by the Linux
"in-tree" Comedi drivers since kernel version 3.19.
2016-05-12 18:10:59 +01:00
Ian Abbott
27509ba9c9 Add digital trigger configuration functions
Add wrapper functions for the INSN_CONFIG_DIGITAL_TRIG configuration
instruction.  These are comedi_digital_trigger_disable(),
comedi_digital_trigger_enable_edges(), and
comedi_digital_trigger_enable_levels().
2016-03-21 11:28:29 +00:00
Ian Abbott
ac2ce44520 Add channel-specific arm, disarm, and reset wrappers.
The comedi_arm(), comedi_disarm(), and comedi_reset() functions always
set the channel number in the corresponding configuration instructions
to 0, as they assume the channel number will be ignored by the driver.
Some drivers do in fact use the channel number in these configuration
instructions.  Add additional wrapper functions comedi_arm_channel(),
comedi_disarm_channel(), and comedi_reset_channel() to allow the channel
number to be specified.
2016-03-21 11:28:29 +00:00
Ian Abbott
2062d615ff Add comedi_disarm() and bump to 0.11.0
Add the comedi_disarm() function to send the INSN_CONFIG_DISARM
configuration instruction to a subdevice.

In configure.ac, bump the comedilib libtool version code to 11:0:11, so
the comedilib version becomes 0.11.0.  Also bump the comedilib manual
version to 0.11.0 in doc/comedilib.ent.
2016-03-21 11:28:29 +00:00
Spencer E. Olson
3f19af6b53 Documents stop_arg!=0 when stop_src=TRIG_NONE
This patch documents the new interpretation of stop_arg when stop_src ==
TRIG_NONE.  In the new interpretation, if stop_src==TRIG_NONE, a user may
specify that a buffer of finite length (and less than or equal to the
maximum buffer size) be repeated indefinitely.

For now, only the NI MIO driver implements this new interpretation.  All
other drivers should continue to force stop_arg==0 when
stop_src==TRIG_NONE.  In this case, the old behavior is maintained.
2016-03-08 22:47:52 -07:00
Spencer E. Olson
ea09b60196 update supported hardware list to include NI PXI-6251 2016-03-08 22:42:34 -07:00
Ian Abbott
abb45335e3 doc: Bump to version 0.10.3. 2015-06-08 11:53:50 +01:00
Ian Abbott
cda898efc6 doc: update copyright years 2015-05-28 13:45:18 +01:00
Ian Abbott
29607869cd doc: fix capitalization of National Instruments 2015-05-28 13:35:58 +01:00
Éric Piel
16142b8d9c doc: add information about using the National Instrument GPCT
The counter interface might eventually be changed to a more generic one.
However, for now it's good to have something documented on how things work.
2015-05-28 13:33:57 +01:00
Éric Piel
027ca2c5ad doc: fix names of *SOURCE constants to *_SRC
Synchronises the content of the documentation with the actually content of the include files.
2015-05-28 13:30:26 +01:00
Ian Abbott
155529234a doc/funcref: fixed a couple of minor mark-up issues. 2013-07-23 17:43:19 +01:00
Ian Abbott
0404ed50dd doc/driverwriting.xml: editing Kbuild
Add a step to the instructions for integrating a new driver into comedi.
The Kbuild file needs to be edited.
2013-05-14 12:50:14 +01:00
Ian Abbott
df2466c0f6 doc: add missing -lm option to command line for compiling tut1 2013-04-15 12:26:05 +01:00
Ian Abbott
ada711164c doc: Bump to version 0.10.2. 2013-03-21 16:36:42 +00:00
Ian Abbott
977d9057a1 doc: Add Éric Piel to comedilib manual authors and copyright 2012-10-29 17:23:43 +00:00
Éric Piel
7d4ad9ad15 doc: add a section about Python bindings
This section goes into a "Language bindings" section where description
for Perl and Ruby could also go.
2012-10-29 17:08:09 +00:00
Ian Abbott
ba3117525a doc/Makefile.am: fix maintainer-clean-local rule.
The maintainer-clean-local rule was removing the wrong file for
comedilib.pdf.
2012-08-28 14:19:09 +01:00
Ian Abbott
bafead2b6d doc: Bump to version 0.10.1. 2012-08-28 12:08:47 +01:00
Ian Abbott
2c810c12e3 doc/install.xml: Describe comedi_num_legacy_minors.
Add some info to the Install section about reserving devices for manual
configuration using the comedi_num_legacy_minors module parameter.
2012-08-28 11:54:39 +01:00
Ian Abbott
96078fcada doc: Add Comedilib version number
In "comedilib.ent", Add an XML entity 'comedilib_version' expanding to
the Comedilib version '0.10.0'.  This is hard-edited in rather than set
dynamically.  Setting it dynamically would be nice but producing it from
an AC_OUTPUT() file isn't all that nice as it would end up in the
'build' tree and we'd some ugly 'make' rule to copy it to the 'source'
tree.  For now, just edit it manually as required.  At least having it
as an entity means it only needs to be set in a single documentation
file!

In "comedilib.xml", change the subtitle to mention Comedilib and the
version number, using the comediliv_version entity.
2012-05-14 17:00:35 +01:00
Ian Abbott
8a63ce2ecc doc/drivers.txt: Minor correction for USB-DUX-FAST.
The Devices line still showed USB-DUX-FAST as USB-DUX.
2012-05-14 14:10:13 +01:00
Bernd Porr
bf8bd73b6b Updated the drivers.txt 2012-05-13 15:00:34 +01:00
Bernd Porr
02b796adde Changed my e-mail address to the linux-usb-daq one to be
consistent with the driver e-mails which I also changed
to the company e-mails adress.
2012-05-13 11:09:45 +01:00
Ian Abbott
b39b8cb8a4 doc/funcref: Fix "Returns:" for comedi_to_physical.
There was a stray space before the "Returns:" heading so it wasn't
processed as intended.  Also, there was an empty line above it leading
to an empty paragraph in the DocBook funcref.xml.
2012-05-11 12:56:55 +01:00
Ian Abbott
d7e611cc6f doc/funcref: Add links between comedi_to_phys and comedi_set_global_oor_behavior. 2012-05-11 12:45:29 +01:00
Ian Abbott
168fcd6ed6 doc/funcref: Moved in comedi_set_global_oor_behavior
Moved function comedi_set_global_oor_behavior out of the deprecated
section as it is associated with the comedi_to_phys function.
2012-05-11 12:34:31 +01:00
Bernd Porr
cda5011a87 Moved comedi_to_phys and comedi_from_phys back to the main
section. Both comedi_to_phys and comedi_to_physical complement
each other. Comedi_to_phys is linear and very fast whereas
comedi_to_physical is more precise but requires polynomials
and calibration data.
2012-05-11 11:15:45 +01:00
Ian Abbott
034f98154f doc/comedilib_html_config.xsl: Use numbered sections.
Change DocBook XSL parameters for HTML output to use numbered sections
(like it was before we switched from SGML to XML) and to use just the
numbers in cross references, rather than number and/or title.
2012-05-10 14:33:33 +01:00
Ian Abbott
f415b87538 doc/intro.xml: Replace a link to figure 1 with an xref. 2012-05-10 14:14:56 +01:00
Ian Abbott
dbe3c77a3d doc/other.xml: Add extra details about range and aref.
Add extra detail to the section on acquisition functions about the
range and aref parameters, and describe the comedi_range type.

The whole section is still a bit higgledy-piggledy and could do with
some rearrangement one day!
2012-05-09 18:41:51 +01:00
Ian Abbott
98869fa36d doc/other.xml: Small DocBook mark-up fix.
Use proper mark-up for sqrt function in slowly varying inputs section.
2012-05-09 17:40:34 +01:00
Ian Abbott
2c729dbb34 doc/comedilib_dblatex_config.xsl: Set function.parens to "1".
Persuades dblatex to output parentheses for all the <function> tags,
even those without <parameter> tags inside.
2012-05-09 17:28:58 +01:00
Ian Abbott
24d02fde41 doc/comedilib_html_config.xsl: Set function.parens to "1".
This makes sure the HTML output for
<function>foo<parameter>bar</parameter><parameter>baz</parameter></function>
includes parentheses, although it doesn't seem to add empty parentheses
after a plain <function>foo</function> which perhaps it should.
2012-05-09 17:22:31 +01:00
Ian Abbott
b41732fa62 doc/reference.xml: Added CR_PACK_FLAGS()
Added description of CR_PACK_FLAGS() macro and the various flag bits.
2012-05-09 17:12:23 +01:00
Ian Abbott
c3ba569f87 doc/glossary.xml: A few DocBook mark-up changes. 2012-05-09 16:05:02 +01:00
Ian Abbott
4a6276c257 doc/driverwriting.xml: Various changes.
Some DocBook mark-up changes.  Also avoided absolute path-names for
sources as people tend to put them in different places!  Also changed
instructions for submitting drivers for review.
2012-05-09 15:50:17 +01:00