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 David A. Schleef <ds@stm.lbl.gov>
   7
   8     This program is free software; you can redistribute it and/or modify
   9     it under the terms of the GNU 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
  61
  62
  63 comedi_t *comedi_open(const char *fn);
  64 void comedi_close(comedi_t *it);
  65
  66 int comedi_loglevel(int loglevel);
  67 void comedi_perror(const char *s);
  68 char *comedi_strerror(int errnum);
  69 int comedi_errno(void);
  70 int comedi_fileno(comedi_t *it);
  71
  72 /* queries */
  73
  74 int comedi_get_n_subdevices(comedi_t *it);
  75 int comedi_get_version_code(comedi_t *it);
  76 char *comedi_get_driver_name(comedi_t *it);
  77 char *comedi_get_board_name(comedi_t *it);
  78
  79 int comedi_get_subdevice_type(comedi_t *it,unsigned int subdevice);
  80 int comedi_find_subdevice_by_type(comedi_t *it,int type,unsigned int subd);
  81 int comedi_get_subdevice_flags(comedi_t *it,unsigned int subdevice);
  82 int comedi_get_n_channels(comedi_t *it,unsigned int subdevice);
  83 lsampl_t comedi_get_maxdata(comedi_t *it,unsigned int subdevice,unsigned int chan);
  84 int comedi_get_rangetype(comedi_t *it,unsigned int subdevice,unsigned int chan);
  85 comedi_range * comedi_get_range(comedi_t *it,unsigned int subdevice,unsigned int chan,unsigned int range);
  86 int comedi_find_range(comedi_t *it,unsigned int subd,unsigned int chan,unsigned int unit,double min,double max);
  87 int comedi_get_n_ranges(comedi_t *it,unsigned int subdevice,unsigned int chan);
  88
  89 int comedi_range_is_chan_specific(comedi_t *it,unsigned int subdevice);
  90 int comedi_maxdata_is_chan_specific(comedi_t *it,unsigned int subdevice);
  91
  92 int comedi_get_buffer_size(comedi_t *it,unsigned int subdevice);
  93 int comedi_get_max_buffer_size(comedi_t *it,unsigned int subdevice);
  94 int comedi_set_buffer_size(comedi_t *it,unsigned int subdevice,unsigned int len);
  95
  96 /* triggers and commands */
  97
  98 int comedi_cancel(comedi_t *it,unsigned int subdevice);
  99 int comedi_trigger(comedi_t *it,comedi_trig *trig);
 100 int comedi_command(comedi_t *it,comedi_cmd *cmd);
 101 int comedi_command_test(comedi_t *it,comedi_cmd *cmd);
 102 int comedi_do_insnlist(comedi_t *it,comedi_insnlist *il);
 103 int comedi_do_insn(comedi_t *it,comedi_insn *insn);
 104 int comedi_lock(comedi_t *it,unsigned int subdevice);
 105 int comedi_unlock(comedi_t *it,unsigned int subdevice);
 106
 107 /* physical units */
 108
 109 double comedi_to_phys(lsampl_t data,comedi_range *rng,lsampl_t maxdata);
 110 lsampl_t comedi_from_phys(double data,comedi_range *rng,lsampl_t maxdata);
 111
 112 /* synchronous stuff */
 113
 114 int comedi_data_read(comedi_t *it,unsigned int subd,unsigned int chan,unsigned int range,
 115         unsigned int aref,lsampl_t *data);
 116 int comedi_data_write(comedi_t *it,unsigned int subd,unsigned int chan,unsigned int range,
 117         unsigned int aref,lsampl_t data);
 118
 119 /* slowly varying stuff */
 120
 121 int comedi_sv_init(comedi_sv_t *it,comedi_t *dev,unsigned int subd,unsigned int chan);
 122 int comedi_sv_update(comedi_sv_t *it);
 123 int comedi_sv_measure(comedi_sv_t *it,double *data);
 124
 125 /* dio config */
 126
 127 int comedi_dio_config(comedi_t *it,unsigned int subd,unsigned int chan,unsigned int dir);
 128 int comedi_dio_read(comedi_t *it,unsigned int subd,unsigned int chan,unsigned int *bit);
 129 int comedi_dio_write(comedi_t *it,unsigned int subd,unsigned int chan,unsigned int bit);
 130 int comedi_dio_bitfield(comedi_t *it,unsigned int subd,unsigned int write_mask,
 131         unsigned int *bits);
 132
 133 /* functions related to streaming I/O (commands) */
 134
 135 int comedi_get_cmd_src_mask(comedi_t *dev,unsigned int subdevice, comedi_cmd *cmd);
 136 int comedi_get_cmd_generic_timed(comedi_t *dev,unsigned int subdevice, comedi_cmd *cmd);
 137
 138 int comedi_poll(comedi_t *dev,unsigned int subdevice);
 139
 140 /* timer stuff (deprecated) */
 141
 142 int comedi_get_timer(comedi_t *it,unsigned int subdev,double freq,unsigned int *trigvar,
 143         double *actual_freq);
 144
 145 int comedi_timed_1chan(comedi_t *it,unsigned int subdev,unsigned int chan,unsigned int range,
 146         unsigned int aref,double freq,unsigned int n_samples,double *data);
 147
 148
 149 /*
 150    The following prototypes are ALPHA, indicating that they might change
 151    in future releases of comedilib, without regard to backward compatibility.
 152  */
 153
 154 enum comedi_oor_behavior {
 155         COMEDI_OOR_NUMBER = 0,
 156         COMEDI_OOR_NAN
 157 };
 158
 159 enum comedi_oor_behavior comedi_set_global_oor_behavior(enum comedi_oor_behavior behavior);
 160
 161
 162
 163 // changes maximum size (in bytes) of preallocated buffer, requires root priviledge, returns new max size
 164 int comedi_set_max_buffer_size(comedi_t *it, unsigned int subdev, unsigned int max_size);
 165 // returns number of bytes in buffer waiting to be read by user
 166 int comedi_get_buffer_contents(comedi_t *it, unsigned int subdev);
 167 // marks 'bytes' number of bytes in buffer as read by user, returns number of bytes left to be read
 168 int comedi_mark_buffer_read(comedi_t *it, unsigned int subdev, unsigned int bytes);
 169 // returns offset in bytes from beginning of buffer for first unread data point in buffer
 170 int comedi_get_buffer_offset(comedi_t *it, unsigned int subdev);
 171
 172 #ifdef __cplusplus
 173 }
 174 #endif
 175
 176 #endif
 177