Added reference entry for comedi_get_hardware_buffer_size().

This commit is contained in:
Frank Mori Hess 2008-03-28 18:16:45 +00:00
parent d0956ca8b5
commit 8952c74075
2 changed files with 43 additions and 0 deletions

View file

@ -66,6 +66,25 @@ Description:
Returns:
0 on success, -1 on error.
Function: comedi_get_hardware_buffer_size -- get size of subdevice's hardware buffer
Retval: int
Param: comedi_t *device
Param: unsigned int subdevice
Param: <link linkend="ref-enum-comedi-io-direction">enum comedi_io_direction</link> direction
Description:
This functions returns the number of bytes the subdevice can hold in it's hardware buffer.
The term "hardware buffer" refers to any fifos, etc. on the acquisition board itself which
are used during streaming commands. This does not include the buffer maintained by
the comedi kernel module in host memory, whose size may be queried by
<link linkend="func-ref-comedi-get-buffer-size"><function>comedi_get_buffer_size</function></link>.
The <parameter>direction</parameter> parameter of type
<link linkend="ref-enum-comedi-io-direction">enum comedi_io_direction</link>
should be set to COMEDI_INPUT to query the input buffer size (e.g., the buffer of an analog
input subdevice), or COMEDI_OUTPUT to query the output buffer size (e.g., the buffer of
an analog output).
Returns:
Number of bytes, or -1 on error.
Function: comedi_get_routing -- get routing for an output
Retval: int
Param: comedi_t * device

View file

@ -153,6 +153,30 @@ and converting from a physical value to Comedi's integer sample values (COMEDI_F
</section>
<section id="ref-enum-comedi-io-direction">
<title>
enum comedi_io_direction
</title>
<para>
<programlisting>
enum comedi_io_direction
{
COMEDI_INPUT,
COMEDI_OUTPUT
};
</programlisting>
</para>
<para>
A comedi_io_direction is used to select between input or output. For example,
<link linkend="func-ref-comedi-dio-config"><function>comedi_dio_config</function></link>
uses the COMEDI_INPUT and COMEDI_OUTPUT values to specify
whether a configurable digital i/o channel should be configured as an input
or output.
</para>
</section>
<section id="ref-enum-comedi-subdevice-type">
<title>
enum comedi_subdevice_type