doc/deprecated_funcref.txt

   1 Deprecated functions
   2 Function: comedi_dio_bitfield -- read/write multiple digital channels
   3 Retval: int
   4 Param: comedi_t * device
   5 Param: unsigned int subdevice
   6 Param: unsigned int write_mask
   7 Param: unsigned int * bits
   8 Status: deprecated
   9 Description:
  10  This function is deprecated.  Use <function><link
  11  linkend="func-ref-comedi-dio-bitfield2">comedi_dio_bitfield2</link></function>
  12  instead.  It is equivalent to using <function>comedi_dio_bitfield2</function>
  13  with <parameter class="function">base_channel</parameter> set to
  14  <literal>0</literal>.
  15
  16 Function: comedi_get_timer -- timer information (deprecated)
  17 Retval: int
  18 Param: comedi_t * device
  19 Param: unsigned int subdevice
  20 Param: double frequency
  21 Param: unsigned int * trigvar
  22 Param: double * actual_frequency
  23 Status: deprecated
  24 Description:
  25  The function <function>comedi_get_timer</function> converts the frequency
  26  <parameter class="function">frequency</parameter>
  27  to a number suitable to send to the driver in a <type>comedi_trig</type>
  28  structure.  This function remains for compatibility with very
  29  old versions of Comedi, that converted sampling rates to timer
  30  values in the library.  This conversion is now done in the kernel,
  31  and every device has the timer type <constant>nanosec_timer</constant>, indicating
  32  that timer values are simply a time specified in nanoseconds.
  33
  34 Function: comedi_sv_init -- slowly-varying inputs
  35 Retval: int
  36 Param: comedi_sv_t * sv
  37 Param: comedi_t * device
  38 Param: unsigned int subdevice
  39 Param: unsigned int channel
  40 Status: deprecated
  41 Description:
  42  The function <function>comedi_sv_init</function> initializes the slow varying Comedi
  43  structure pointed to by <parameter class="function">sv</parameter> to use the
  44  device <parameter class="function">device</parameter>, the analog input subdevice
  45  <parameter class="function">subdevice</parameter>, and the channel
  46  <parameter class="function">channel</parameter>.  The slow varying Comedi
  47  structure is used by
  48  <function><link linkend="func-ref-comedi-sv-measure">comedi_sv_measure</link></function>
  49  to accurately measure
  50  an analog input by averaging over many samples.  The default
  51  number of samples is 100.
  52 Returns:
  53  This function returns <literal>0</literal> on success,
  54  <literal>-1</literal> on error.
  55
  56 Function: comedi_sv_measure -- slowly-varying inputs
  57 Retval: int
  58 Param: comedi_sv_t * sv
  59 Param: double * data
  60 Status: deprecated
  61 Description:
  62  The function <function>comedi_sv_measure</function> uses the slowly varying Comedi
  63  structure pointed to by <parameter class="function">sv</parameter>
  64  to measure a slowly varying signal.  If successful,
  65  the result (in physical units) is stored in the location pointed
  66  to by <parameter class="function">data</parameter>, and the number of samples
  67  is returned.  On error, <literal>-1</literal>
  68  is returned.
  69
  70 Function: comedi_sv_update -- slowly-varying inputs
  71 Retval: int
  72 Param: comedi_sv_t * sv
  73 Status: deprecated
  74 Description:
  75  The function <function>comedi_sv_update</function> updates internal parameters of
  76  the slowly varying Comedi structure pointed to by
  77  <parameter class="function">sv</parameter>.
  78
  79 Function: comedi_timed_1chan -- streaming input (deprecated)
  80 Retval: int
  81 Param: comedi_t * device
  82 Param: unsigned int subdevice
  83 Param: unsigned int channel
  84 Param: unsigned int range
  85 Param: unsigned int aref
  86 Param: double frequency
  87 Param: unsigned int num_samples
  88 Param: double * data
  89 Status: deprecated
  90 Description:
  91  Not documented.
  92
  93 Function: comedi_trigger -- perform streaming input/output (deprecated)
  94 Retval: int
  95 Param: comedi_t * device
  96 Param: comedi_trig * trig
  97 Status: deprecated
  98 Description:
  99  The function <function>comedi_trigger</function> instructs Comedi to
 100  perform the command specified by the trigger structure pointed to by
 101  <parameter class="function">trig</parameter>.
 102  The return value depends on
 103  the particular trigger being issued.  If there is an
 104  error, <literal>-1</literal> is returned.