include/comedilib.h

   1 /*
   2     include/comedilib.h
   3     header file for the comedi library routines
   4
   5     COMEDI - Linux Control and Measurement Device Interface
   6     Copyright (C) 1998-2002 David A. Schleef <ds@schleef.org>
   7
   8     This program is free software; you can redistribute it and/or modify
   9     it under the terms of the GNU Lesser General Public License as published by
  10     the Free Software Foundation; either version 2 of the License, or
  11     (at your option) any later version.
  12
  13     This program is distributed in the hope that it will be useful,
  14     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16     GNU General Public License for more details.
  17
  18     You should have received a copy of the GNU General Public License
  19     along with this program; if not, write to the Free Software
  20     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21
  22 */
  23
  24
  25 #ifndef _COMEDILIB_H
  26 #define _COMEDILIB_H
  27
  28 #include <comedi.h>
  29 #include <sys/ioctl.h>
  30 #include <fcntl.h>
  31 #include <stdio.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 typedef struct comedi_t_struct comedi_t;
  38
  39 typedef struct{
  40         double min;
  41         double max;
  42         unsigned int unit;
  43 }comedi_range;
  44
  45 typedef struct comedi_sv_struct{
  46         comedi_t *dev;
  47         unsigned int subdevice;
  48         unsigned int chan;
  49
  50         /* range policy */
  51         int range;
  52         int aref;
  53
  54         /* number of measurements to average (for ai) */
  55         int n;
  56
  57         lsampl_t maxdata;
  58 }comedi_sv_t;
  59
  60 enum comedi_oor_behavior {
  61         COMEDI_OOR_NUMBER = 0,
  62         COMEDI_OOR_NAN
  63 };
  64
  65
  66
  67
  68 comedi_t *comedi_open(const char *fn);
  69 int comedi_close(comedi_t *it);
  70
  71 /* logging */
  72 int comedi_loglevel(int loglevel);
  73 void comedi_perror(const char *s);
  74 char *comedi_strerror(int errnum);
  75 int comedi_errno(void);
  76 int comedi_fileno(comedi_t *it);
  77
  78 /* global behavior */
  79 enum comedi_oor_behavior comedi_set_global_oor_behavior(enum comedi_oor_behavior behavior);
  80
  81 /* device queries */
  82 int comedi_get_n_subdevices(comedi_t *it);
  83 #define COMEDI_VERSION_CODE(a,b,c) (((a)<<16) | ((b)<<8) | (c))
  84 int comedi_get_version_code(comedi_t *it);
  85 char *comedi_get_driver_name(comedi_t *it);
  86 char *comedi_get_board_name(comedi_t *it);
  87 int comedi_get_read_subdevice(comedi_t *dev);
  88 int comedi_get_write_subdevice(comedi_t *dev);
  89
  90 /* subdevice queries */
  91 int comedi_get_subdevice_type(comedi_t *it,unsigned int subdevice);
  92 int comedi_find_subdevice_by_type(comedi_t *it,int type,unsigned int subd);
  93 int comedi_get_subdevice_flags(comedi_t *it,unsigned int subdevice);
  94 int comedi_get_n_channels(comedi_t *it,unsigned int subdevice);
  95 int comedi_range_is_chan_specific(comedi_t *it,unsigned int subdevice);
  96 int comedi_maxdata_is_chan_specific(comedi_t *it,unsigned int subdevice);
  97
  98 /* channel queries */
  99 lsampl_t comedi_get_maxdata(comedi_t *it,unsigned int subdevice,
 100         unsigned int chan);
 101 int comedi_get_n_ranges(comedi_t *it,unsigned int subdevice,
 102         unsigned int chan);
 103 comedi_range * comedi_get_range(comedi_t *it,unsigned int subdevice,
 104         unsigned int chan,unsigned int range);
 105 int comedi_find_range(comedi_t *it,unsigned int subd,unsigned int chan,
 106         unsigned int unit,double min,double max);
 107
 108 /* buffer queries */
 109 int comedi_get_buffer_size(comedi_t *it,unsigned int subdevice);
 110 int comedi_get_max_buffer_size(comedi_t *it,unsigned int subdevice);
 111 int comedi_set_buffer_size(comedi_t *it,unsigned int subdevice,
 112         unsigned int len);
 113
 114 /* low-level stuff */
 115 #ifdef _COMEDILIB_DEPRECATED
 116 int comedi_trigger(comedi_t *it,comedi_trig *trig); /* deprecated */
 117 #endif
 118 int comedi_do_insnlist(comedi_t *it,comedi_insnlist *il);
 119 int comedi_do_insn(comedi_t *it,comedi_insn *insn);
 120 int comedi_lock(comedi_t *it,unsigned int subdevice);
 121 int comedi_unlock(comedi_t *it,unsigned int subdevice);
 122
 123 /* physical units */
 124 double comedi_to_phys(lsampl_t data,comedi_range *rng,lsampl_t maxdata);
 125 lsampl_t comedi_from_phys(double data,comedi_range *rng,lsampl_t maxdata);
 126 int comedi_sampl_to_phys(double *dest, int dst_stride, sampl_t *src,
 127         int src_stride, comedi_range *rng, lsampl_t maxdata, int n);
 128 int comedi_sampl_from_phys(sampl_t *dest,int dst_stride,double *src,
 129         int src_stride, comedi_range *rng, lsampl_t maxdata, int n);
 130
 131 /* syncronous stuff */
 132 int comedi_data_read(comedi_t *it,unsigned int subd,unsigned int chan,
 133         unsigned int range,unsigned int aref,lsampl_t *data);
 134 int comedi_data_read_n(comedi_t *it,unsigned int subd,unsigned int chan,
 135         unsigned int range,unsigned int aref,lsampl_t *data, unsigned int n);
 136 int comedi_data_read_hint(comedi_t *it,unsigned int subd,unsigned int chan,
 137         unsigned int range,unsigned int aref);
 138 int comedi_data_read_delayed(comedi_t *it,unsigned int subd,unsigned int chan,
 139         unsigned int range,unsigned int aref,lsampl_t *data, unsigned int nano_sec);
 140 int comedi_data_write(comedi_t *it,unsigned int subd,unsigned int chan,
 141         unsigned int range,unsigned int aref,lsampl_t data);
 142 int comedi_dio_config(comedi_t *it,unsigned int subd,unsigned int chan,
 143         unsigned int dir);
 144 int comedi_dio_get_config(comedi_t *it,unsigned int subd,unsigned int chan,
 145         unsigned int *dir);
 146 int comedi_dio_read(comedi_t *it,unsigned int subd,unsigned int chan,
 147         unsigned int *bit);
 148 int comedi_dio_write(comedi_t *it,unsigned int subd,unsigned int chan,
 149         unsigned int bit);
 150 int comedi_dio_bitfield(comedi_t *it,unsigned int subd,
 151         unsigned int write_mask, unsigned int *bits);
 152
 153 /* slowly varying stuff */
 154 int comedi_sv_init(comedi_sv_t *it,comedi_t *dev,unsigned int subd,unsigned int chan);
 155 int comedi_sv_update(comedi_sv_t *it);
 156 int comedi_sv_measure(comedi_sv_t *it,double *data);
 157
 158 /* streaming I/O (commands) */
 159
 160 int comedi_get_cmd_src_mask(comedi_t *dev,unsigned int subdevice,
 161         comedi_cmd *cmd);
 162 int comedi_get_cmd_generic_timed(comedi_t *dev,unsigned int subdevice,
 163         comedi_cmd *cmd,unsigned int ns);
 164 int comedi_cancel(comedi_t *it,unsigned int subdevice);
 165 int comedi_command(comedi_t *it,comedi_cmd *cmd);
 166 int comedi_command_test(comedi_t *it,comedi_cmd *cmd);
 167 int comedi_poll(comedi_t *dev,unsigned int subdevice);
 168
 169 /* buffer control */
 170
 171 int comedi_set_max_buffer_size(comedi_t *it, unsigned int subdev,
 172         unsigned int max_size);
 173 int comedi_get_buffer_contents(comedi_t *it, unsigned int subdev);
 174 int comedi_mark_buffer_read(comedi_t *it, unsigned int subdev,
 175         unsigned int bytes);
 176 int comedi_mark_buffer_written(comedi_t *it, unsigned int subdev,
 177         unsigned int bytes);
 178 int comedi_get_buffer_offset(comedi_t *it, unsigned int subdev);
 179
 180 #ifdef _COMEDILIB_DEPRECATED
 181 /*
 182  * The following functions are deprecated and should not be used.
 183  */
 184 int comedi_get_timer(comedi_t *it,unsigned int subdev,double freq,
 185         unsigned int *trigvar,double *actual_freq);
 186 int comedi_timed_1chan(comedi_t *it,unsigned int subdev,unsigned int chan,
 187         unsigned int range, unsigned int aref,double freq,
 188         unsigned int n_samples,double *data);
 189 int comedi_get_rangetype(comedi_t *it,unsigned int subdevice,
 190         unsigned int chan);
 191 #endif
 192
 193
 194 #ifndef _COMEDILIB_STRICT_ABI
 195 /*
 196    The following prototypes are _NOT_ part of the Comedilib ABI, and
 197    may change in future versions without regard to source or binary
 198    compatibility.  In practice, this is a holding place for the next
 199    library ABI version change.
 200  */
 201 /* structs and functions used for parsing calibration files */
 202 typedef struct
 203 {
 204         unsigned int subdevice;
 205         unsigned int channel;
 206         unsigned int value;
 207 } comedi_caldac_t;
 208 #define CS_MAX_AREFS_LENGTH 4
 209 typedef struct
 210 {
 211         unsigned int subdevice;
 212         unsigned int *channels;
 213         unsigned int num_channels;
 214         unsigned int *ranges;
 215         unsigned int num_ranges;
 216         unsigned int arefs[ CS_MAX_AREFS_LENGTH ];
 217         unsigned int num_arefs;
 218         comedi_caldac_t *caldacs;
 219         unsigned int num_caldacs;
 220 } comedi_calibration_setting_t;
 221
 222 typedef struct
 223 {
 224         char *driver_name;
 225         char *board_name;
 226         comedi_calibration_setting_t *settings;
 227         unsigned int num_settings;
 228 } comedi_calibration_t;
 229
 230 comedi_calibration_t* comedi_parse_calibration_file( const char *cal_file_path );
 231 int comedi_apply_parsed_calibration( comedi_t *dev, unsigned int subdev, unsigned int channel,
 232         unsigned int range, unsigned int aref, const comedi_calibration_t *calibration );
 233 char* comedi_get_default_calibration_path( comedi_t *dev );
 234 void comedi_cleanup_calibration( comedi_calibration_t *calibration );
 235 int comedi_apply_calibration( comedi_t *dev, unsigned int subdev, unsigned int channel,
 236         unsigned int range, unsigned int aref, const char *cal_file_path);
 237
 238
 239
 240 #endif
 241
 242 #ifdef __cplusplus
 243 }
 244 #endif
 245
 246 #endif
 247