stv0g/comedilib
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

updated man pages

Browse source
This commit is contained in:
David Schleef 2000-10-10 00:52:59 +00:00
parent 809aaa48b9
commit ccc75d8ae8
2 changed files with 62 additions and 169 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
man/comedi.7
View file

@ -10,50 +10,27 @@ library routines that can be used to communicate with a variety of
data acquisition boards, including A/D converters, D/A converters,
digital I/O and timers.
The hardware drivers that are installed on your system may include
one or more of the following:
\fB8255\fR - Generic 8255 support
.br
\fBdas08\fR - Keithley DAS08 and compatibles
.br
\fBdt2811\fR - Data Translation DT2811
.br
\fBdt2814\fR - Data Translation DT2814
.br
\fBdt2817\fR - Data Translation DT2817
.br
\fBdt282x\fR - Data Translation DT2821 series
.br
\fBni_E\fR - National Instruments AT-MIO E series
.br
\fBni_E\fR - National Instruments AT-MIO (Am9513 based)
.br
\fBparport\fR - Standard PC parallel port digital I/O
.br
\fBpcl711\fR - PC-LabCard PCL-711, 711B
.br
\fBpcl711\fR - PC-LabCard PCL-725
.br
\fBpcl711\fR - PC-LabCard PCL-726
.br
\fBrti800\fR - Analog Devices RTI-800/815
.SH OTHER DOCUMENTATION
The following man pages may be useful:
Hardware and driver configuration, and device-specific information,
can be found in the \fBcomedi\fR souce, in the file
Documentation/comedi/drivers.txt.
\fBcomedi_config\fR(8),
.br
Programming documentation for comedilib can be found in
/usr/doc/comedilib, or also at http://stm.lbl.gov/comedi.
Additional text documentation is located in /usr/doc/comedi-0.5.0.
.SH SEE ALSO
\fBcomedi_config\fR(8),
\fBcomedi_calibrate\fR(8)
.SH VERSION
0.5.0
The current version can be found at ftp://stm.lbl.gov/pub/comedi.
0.7.x
.SH AUTHOR
David Schleef, <ds@stm.lbl.gov>
David Schleef, <ds@schleef.org>

184
man/comedi_config.8
View file

@ -6,145 +6,43 @@
<option1>[,<option2>...]
.br
.SH DESCRIPTION
\fBcomedi_config\fR is a utility designed to configure
control and measurement hardware associated with a particular
\fBcomedi\fR device. You must have the \fBcomedi\fR module installed
in the kernel to use this utility.
\fBcomedi_config\fR is used to configure \fBcomedi\fR drivers.
You must have \fBcomedi\fR support compiled
into your kernel or loaded as a separate module in order
to use this utility.
Each control and measurement device is associated with a
particular \fBcomedi\fR device file \fB/dev/comedi\fRN, where
N is 0,1,2,3, etc.
\fBComedi_config\fR allows you to associate a particular
driver and device with a \fBcomedi\fR device file, and also
configure driver parameters for the particular device.
Each control and measurement card in your computer is associated
with an individual comedi device; to a user, these appear as the
files \fB/dev/comedi\fRN, with N being 0,1,2,3,etc. To configure
\fBcomedi\fR to use a particular hardware driver for your card,
you would use this utility with the device file, driver name, and
other vital parameters (I/O base address, IRQ, etc.) on the
command line.
\fBComedi_config\fR can be used with optional
parameters which are driver dependent. Parameters are
specified by comma-delimited list of integers. The integers
may be expressed as decimal, hexidecimal (starting with 0x)
or octal (stating with 0). In addition, a parameter may be
left blank, indicating 0. PCI-based devices typically
require no parameters. ISA-based devices typically use
the first and second parameters to indicate I/O base
address and interrupt level.
As an example, the command line used to tell the comedi module that
you want to access a National Instruments AT-MIO E series board as
\fB/dev/comedi0\fR would be:
More information about the parameters required by individual
drivers can be found in the \fBcomedi\fR documentation, in
the file \fBdrivers.txt\fR.
/usr/sbin/comedi_config /dev/comedi0 atmio-E 0x220,3
This tells the driver that the board is configured
for I/O base 0x220 and IRQ 3. In general, I/O base is listed first
and IRQ, if necessary, is listed second. Additional parameters
vary, so see the information below for the particular driver.
Parameters can be expressed in either decimal or hexadecimal, with
a 0x prefix.
.SH OPTIONS
\fBcomedi_config\fR recognizes the following options:
\fB-a\fR obtain configuration information from the file
/fB/etc/comedi.conf/fR.
\fB-q, --quiet\fR don't print output while running.
\fB-q\fR don't print output while running.
\fB-v, --verbose\fR print verbose output while running.
\fB-v\fR print verbose output while running.
\fB-V, --version\fR print version number and exit.
\fB-V\fR print version number and exit.
.SH HARDWARE DRIVERS
Additional information pertaining to each hardware driver is
available in \fB/usr/doc/comedi-0.5.0\fR. Unless noted,
the names below are the same as the driver names given on
the command line.
\fB8255\fR Generic 8255 support
.br
<I/O base>
\fBdas08\fR - Keithley DAS08 and compatibles
.br
<I/O base>
\fBdt2811\fR - Data Translation DT2811
.br
<I/O base>
.br
Interrupts are not used with this board.
\fBdt2814\fR - Data Translation DT2814
.br
<I/O base>,<IRQ>
.br
Set IRQ to -1 to probe for IRQ.
\fBdt2817\fR - Data Translation DT2817
.br
<I/O base>
\fBdt282x\fR - Data Translation DT2821 series
.br
<I/O base>,<IRQ>,<DMA 1>,<DMA 2>,
<analog reference>,
<encoding, analog input>,
<encoding, analog output 0>,
<encoding, analog output 1>,
<voltage range, analog input>,
<voltage range, analog output 0>,
<voltage range, analog output 1>.
.br
Valid values for analog reference are 0=single ended,
1=differential.
Valid values for encoding are
[0=straight or offset binary, 1=two's complement].
Valid values for voltage range are
0=(-10,10), 1=(0,10), 2=(-5,+5), 3=(0,5),
4=(-2.5,2.5).
Options must agree with how your board is
configured.
.br
The driver recognizes the following names:
\fBdt2821\fR,
\fBdt2823\fR,
\fBdt2824-pgh\fR,
\fBdt2824-pgl\fR,
\fBdt2825\fR,
\fBdt2827\fR,
\fBdt2828\fR.
Use the name that best represents your board.
\fBatmio-E\fR - National Instruments AT-MIO E series
.br
<I/O base>,<IRQ>
.br
This driver automatically detects which board is installed
in your computer. The E-series boards are plug-and-play, so use
\fBisapnptools\fR to tell the board which I/O port to use before
running \fBcomedi_config\fR. In a random fit of stupidity, the
E-series boards ignore the IRQ which PnP assigns to it.
\fBparport\fR - Standard PC parallel port digital I/O
.br
<I/O base>
.br
This driver does not work with the new parallel port sharing
capabilities of Linux.
\fBpcl711\fR - PC-LabCard PCL-711, 711B, ACL-8112
.br
<I/O base>
.br
Use the driver name \fBpcl711b\fR to configure for a 711B board.
\fBpcl725\fR - PC-LabCard PCL-725
.br
<I/O base>
.br
\fBpcl726\fR - PC-LabCard PCL-726
.br
<I/O base>
.br
\fBrti800\fR - Analog Devices RTI-800/815
.br
<I/O base>
.SH CONFIGURATION FILE
@ -159,19 +57,37 @@ These configurations will be read and performed when the
switch \fB-a\fR is used. This is potentially useful when
run from an initialization script.
.SH OTHER DOCUMENTATION
.SH EXAMPLES
\fBcomedi\fR(7),
A National Instruments PCI-MIO E series board can be
configured to use /dev/comedi0 using the command:
Additional text documentation is located in /usr/doc/comedi-0.5.0.
/usr/sbin/comedi_config /dev/comedi0 ni_pcimio
A National Instruments AT-MIO E series board can be
configured to use /dev/comedi3 using the command:
/usr/sbin/comedi_config /dev/comedi3 ni_atmio 0x220,3
This tells the driver that the board is configured
for I/O base 0x220 and IRQ 3.
.SH ADDITIONAL INFORMATION
Additional text documentation can be found in /usr/doc/comedilib-0.7.11.
The current version of \fBComedi\fR and \fBComedilib\fR can be
obtained from ftp://stm.lbl.gov/pub/comedi. The Comedi web site
is located at http://stm.lbl.gov/comedi.
.SH SEE ALSO
\fBcomedi\fR(7)
.SH VERSION
0.5.0
The current version can be obtained from ftp://stm.lbl.gov/pub/comedi.
0.7.x
.SH AUTHOR
David Schleef, <ds@stm.lbl.gov>
David Schleef, <ds@schleef.org>