/usr/share/doc/libcomedi-dev/html/r5153.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>comedi_get_subdevice_flags</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="    Comedi
  "
HREF="index.html"><LINK
REL="UP"
TITLE="    Comedi Function Reference
  "
HREF="x4629.html#FUNCTIONREFERENCE"><LINK
REL="PREVIOUS"
TITLE="comedi_get_write_subdevice"
HREF="r5134.html"><LINK
REL="NEXT"
TITLE="comedi_get_n_channels"
HREF="r5268.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Comedi: The <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Control and Measurement Device Interface</I
></SPAN
>
handbook
  </TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="r5134.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="r5268.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="FUNC-REF-COMEDI-GET-SUBDEVICE-FLAGS"
></A
>comedi_get_subdevice_flags</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5157"
></A
><H2
>Name</H2
>comedi_get_subdevice_flags&nbsp;--&nbsp;properties of subdevice</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5160"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5161"
></A
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &lt;comedilib.h&gt;</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int comedi_get_subdevice_flags</CODE
>(comedi_t * device, unsigned int subdevice);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5170"
></A
><H2
>      Description
    </H2
><P
>This function returns a bitfield describing the capabilities of
the specified subdevice.  If there is an error, -1 is returned,
and the Comedilib error value is set.</P
><P
><DIV
CLASS="TABLE"
><A
NAME="AEN5174"
></A
><P
><B
>Table 1. subdevice flags</B
></P
><TABLE
BORDER="1"
RULES="all"
WIDTH="100%"
CLASS="CALSTABLE"
><COL><COL><COL><THEAD
><TR
><TH
>Subdevice Flag</TH
><TH
>Value (hexadecimal)</TH
><TH
>Description</TH
></TR
></THEAD
><TBODY
><TR
><TD
>SDF_BUSY</TD
><TD
>0x00000001</TD
><TD
>The subdevice is busy performing an asynchronous command.  A subdevice being "busy"
is slightly different from the "running" state flagged by SDF_RUNNING.  A "running" subdevice
is always "busy", but a "busy" subdevice is not necessarily "running".  For example, suppose an
analog input command has been completed by the hardware, but there are still samples in
Comedi's buffer waiting to be read out.  In this case, the subdevice is not "running", but
is still "busy" until all the samples are read out or comedi_cancel() is called.</TD
></TR
><TR
><TD
>SDF_BUSY_OWNER</TD
><TD
>0x00000002</TD
><TD
>The subdevice is "busy", and the command it is running was started by the current process.</TD
></TR
><TR
><TD
>SDF_LOCKED</TD
><TD
>0x00000004</TD
><TD
>The subdevice has been locked by comedi_lock().</TD
></TR
><TR
><TD
>SDF_LOCK_OWNER</TD
><TD
>0x00000008</TD
><TD
>The subdevice is locked, and was locked by the current process.</TD
></TR
><TR
><TD
>SDF_MAXDATA</TD
><TD
>0x00000010</TD
><TD
>The maximum data value for the subdevice depends on the channel.</TD
></TR
><TR
><TD
>SDF_FLAGS</TD
><TD
>0x00000020</TD
><TD
>The subdevice flags depend on the channel (unfinished/broken support in library).</TD
></TR
><TR
><TD
>SDF_RANGETYPE</TD
><TD
>0x00000040</TD
><TD
>The range type depends on the channel.</TD
></TR
><TR
><TD
>SDF_CMD</TD
><TD
>0x00001000</TD
><TD
>The subdevice supports asynchronous commands.</TD
></TR
><TR
><TD
>SDF_SOFT_CALIBRATED</TD
><TD
>0x00002000</TD
><TD
>The subdevice relies on the host to do calibration in software.
Software calibration coefficients are determined by the comedi_soft_calibrate
utility.  See the description of the comedi_get_softcal_converter() function
for more information.</TD
></TR
><TR
><TD
>SDF_READABLE</TD
><TD
>0x00010000</TD
><TD
>The subdevice can be read (e.g. analog input).</TD
></TR
><TR
><TD
>SDF_WRITABLE</TD
><TD
>0x00020000</TD
><TD
>The subdevice can be written to (e.g. analog output).</TD
></TR
><TR
><TD
>SDF_INTERNAL</TD
><TD
>0x00040000</TD
><TD
>The subdevice does not have externally visible lines.</TD
></TR
><TR
><TD
>SDF_GROUND</TD
><TD
>0x00100000</TD
><TD
>The subdevice supports AREF_GROUND.</TD
></TR
><TR
><TD
>SDF_COMMON</TD
><TD
>0x00200000</TD
><TD
>The subdevice supports AREF_COMMON.</TD
></TR
><TR
><TD
>SDF_DIFF</TD
><TD
>0x00400000</TD
><TD
>The subdevice supports AREF_DIFF.</TD
></TR
><TR
><TD
>SDF_OTHER</TD
><TD
>0x00800000</TD
><TD
>The subdevice supports AREF_OTHER</TD
></TR
><TR
><TD
>SDF_DITHER</TD
><TD
>0x01000000</TD
><TD
>The subdevice supports dithering (via the CR_ALT_FILTER chanspec flag).</TD
></TR
><TR
><TD
>SDF_DEGLITCH</TD
><TD
>0x02000000</TD
><TD
>The subdevice supports deglitching (via the CR_ALT_FILTER chanspec flag).</TD
></TR
><TR
><TD
>SDF_RUNNING</TD
><TD
>0x08000000</TD
><TD
>An asynchronous command is running.  You can use this flag to poll for the completion of an
output command.</TD
></TR
><TR
><TD
>SDF_LSAMPL</TD
><TD
>0x10000000</TD
><TD
>The subdevice uses the 32 bit lsampl_t type instead of the 16 bit sampl_t for
asynchronous command data.</TD
></TR
><TR
><TD
>SDF_PACKED</TD
><TD
>0x20000000</TD
><TD
>The subdevice uses bitfield samples for asynchronous command data,
one bit per channel (otherwise it uses
one sampl_t or lsampl_t per channel).  Commonly used for digital subdevices.</TD
></TR
></TBODY
></TABLE
></DIV
></P
><P
>    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="r5134.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="r5268.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>comedi_get_write_subdevice</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="x4629.html#FUNCTIONREFERENCE"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>comedi_get_n_channels</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
libcomedi-dev 0.8.1-5ubuntu6 / usr / share / doc / libcomedi-dev / html / r5153.html
