comedilib/include/comedilib.h File Reference

#include <comedi.h>
#include <sys/ioctl.h>
#include <fcntl.h>
#include <stdio.h>

Go to the source code of this file.

Classes
struct	comedi_range
struct	comedi_sv_struct
struct	comedi_caldac_t
struct	comedi_polynomial_t
struct	comedi_softcal_t
struct	comedi_calibration_setting_t
struct	comedi_calibration_t
Defines
#define	SWIG_OUTPUT(x)   x
#define	SWIG_INPUT(x)   x
#define	SWIG_INOUT(x)   x
#define	COMEDI_VERSION_CODE(a, b, c)   (((a)<<16) | ((b)<<8) | (c))
#define	COMEDI_MAX_NUM_POLYNOMIAL_COEFFICIENTS   4
#define	CS_MAX_AREFS_LENGTH   4
Typedefs
typedef struct comedi_t_struct	comedi_t
typedef struct comedi_sv_struct	comedi_sv_t
Enumerations
enum	comedi_oor_behavior { COMEDI_OOR_NUMBER = 0, COMEDI_OOR_NAN }
enum	comedi_conversion_direction { COMEDI_TO_PHYSICAL, COMEDI_FROM_PHYSICAL }
Functions
comedi_t *	comedi_open (const char *fn)
int	comedi_close (comedi_t *it)
int	comedi_loglevel (int loglevel)
void	comedi_perror (const char *s)
const char *	comedi_strerror (int errnum)
int	comedi_errno (void)
int	comedi_fileno (comedi_t *it)
enum comedi_oor_behavior	comedi_set_global_oor_behavior (enum comedi_oor_behavior behavior)
int	comedi_get_n_subdevices (comedi_t *it)
int	comedi_get_version_code (comedi_t *it)
const char *	comedi_get_driver_name (comedi_t *it)
const char *	comedi_get_board_name (comedi_t *it)
int	comedi_get_read_subdevice (comedi_t *dev)
int	comedi_get_write_subdevice (comedi_t *dev)
int	comedi_get_subdevice_type (comedi_t *it, unsigned int subdevice)
int	comedi_find_subdevice_by_type (comedi_t *it, int type, unsigned int subd)
int	comedi_get_subdevice_flags (comedi_t *it, unsigned int subdevice)
int	comedi_get_n_channels (comedi_t *it, unsigned int subdevice)
int	comedi_range_is_chan_specific (comedi_t *it, unsigned int subdevice)
int	comedi_maxdata_is_chan_specific (comedi_t *it, unsigned int subdevice)
lsampl_t	comedi_get_maxdata (comedi_t *it, unsigned int subdevice, unsigned int chan)
int	comedi_get_n_ranges (comedi_t *it, unsigned int subdevice, unsigned int chan)
comedi_range *	comedi_get_range (comedi_t *it, unsigned int subdevice, unsigned int chan, unsigned int range)
int	comedi_find_range (comedi_t *it, unsigned int subd, unsigned int chan, unsigned int unit, double min, double max)
int	comedi_get_buffer_size (comedi_t *it, unsigned int subdevice)
int	comedi_get_max_buffer_size (comedi_t *it, unsigned int subdevice)
int	comedi_set_buffer_size (comedi_t *it, unsigned int subdevice, unsigned int len)
int	comedi_do_insnlist (comedi_t *it, comedi_insnlist *il)
int	comedi_do_insn (comedi_t *it, comedi_insn *insn)
int	comedi_lock (comedi_t *it, unsigned int subdevice)
int	comedi_unlock (comedi_t *it, unsigned int subdevice)
double	comedi_to_phys (lsampl_t data, comedi_range *rng, lsampl_t maxdata)
lsampl_t	comedi_from_phys (double data, comedi_range *rng, lsampl_t maxdata)
int	comedi_sampl_to_phys (double *dest, int dst_stride, sampl_t *src, int src_stride, comedi_range *rng, lsampl_t maxdata, int n)
int	comedi_sampl_from_phys (sampl_t *dest, int dst_stride, double *src, int src_stride, comedi_range *rng, lsampl_t maxdata, int n)
int	comedi_data_read (comedi_t *it, unsigned int subd, unsigned int chan, unsigned int range, unsigned int aref, lsampl_t *SWIG_OUTPUT(data))
int	comedi_data_read_n (comedi_t *it, unsigned int subd, unsigned int chan, unsigned int range, unsigned int aref, lsampl_t *SWIG_OUTPUT(data), unsigned int n)
int	comedi_data_read_hint (comedi_t *it, unsigned int subd, unsigned int chan, unsigned int range, unsigned int aref)
int	comedi_data_read_delayed (comedi_t *it, unsigned int subd, unsigned int chan, unsigned int range, unsigned int aref, lsampl_t *SWIG_OUTPUT(data), unsigned int nano_sec)
int	comedi_data_write (comedi_t *it, unsigned int subd, unsigned int chan, unsigned int range, unsigned int aref, lsampl_t data)
int	comedi_dio_config (comedi_t *it, unsigned int subd, unsigned int chan, unsigned int dir)
int	comedi_dio_get_config (comedi_t *it, unsigned int subd, unsigned int chan, unsigned int *SWIG_OUTPUT(dir))
int	comedi_dio_read (comedi_t *it, unsigned int subd, unsigned int chan, unsigned int *SWIG_OUTPUT(bit))
int	comedi_dio_write (comedi_t *it, unsigned int subd, unsigned int chan, unsigned int bit)
int	comedi_dio_bitfield2 (comedi_t *it, unsigned int subd, unsigned int write_mask, unsigned int *SWIG_INOUT(bits), unsigned int base_channel)
int	comedi_dio_bitfield (comedi_t *it, unsigned int subd, unsigned int write_mask, unsigned int *SWIG_INOUT(bits))
int	comedi_sv_init (comedi_sv_t *it, comedi_t *dev, unsigned int subd, unsigned int chan)
int	comedi_sv_update (comedi_sv_t *it)
int	comedi_sv_measure (comedi_sv_t *it, double *data)
int	comedi_get_cmd_src_mask (comedi_t *dev, unsigned int subdevice, comedi_cmd *SWIG_INOUT(cmd))
int	comedi_get_cmd_generic_timed (comedi_t *dev, unsigned int subdevice, comedi_cmd *SWIG_INOUT(cmd), unsigned chanlist_len, unsigned scan_period_ns)
int	comedi_cancel (comedi_t *it, unsigned int subdevice)
int	comedi_command (comedi_t *it, comedi_cmd *cmd)
int	comedi_command_test (comedi_t *it, comedi_cmd *SWIG_INOUT(cmd))
int	comedi_poll (comedi_t *dev, unsigned int subdevice)
int	comedi_set_max_buffer_size (comedi_t *it, unsigned int subdev, unsigned int max_size)
int	comedi_get_buffer_contents (comedi_t *it, unsigned int subdev)
int	comedi_mark_buffer_read (comedi_t *it, unsigned int subdev, unsigned int bytes)
int	comedi_mark_buffer_written (comedi_t *it, unsigned int subdev, unsigned int bytes)
int	comedi_get_buffer_offset (comedi_t *it, unsigned int subdev)
comedi_calibration_t *	comedi_parse_calibration_file (const char *cal_file_path)
int	comedi_apply_parsed_calibration (comedi_t *dev, unsigned int subdev, unsigned int channel, unsigned int range, unsigned int aref, const comedi_calibration_t *calibration)
char *	comedi_get_default_calibration_path (comedi_t *dev)
void	comedi_cleanup_calibration (comedi_calibration_t *calibration)
int	comedi_apply_calibration (comedi_t *dev, unsigned int subdev, unsigned int channel, unsigned int range, unsigned int aref, const char *cal_file_path)
int	comedi_get_softcal_converter (unsigned subdevice, unsigned channel, unsigned range, enum comedi_conversion_direction direction, const comedi_calibration_t *calibration, comedi_polynomial_t *SWIG_OUTPUT(polynomial))
int	comedi_get_hardcal_converter (comedi_t *dev, unsigned subdevice, unsigned channel, unsigned range, enum comedi_conversion_direction direction, comedi_polynomial_t *SWIG_OUTPUT(polynomial))
double	comedi_to_physical (lsampl_t data, const comedi_polynomial_t *conversion_polynomial)
lsampl_t	comedi_from_physical (double data, const comedi_polynomial_t *conversion_polynomial)
int	comedi_internal_trigger (comedi_t *dev, unsigned subd, unsigned trignum)
int	comedi_arm (comedi_t *device, unsigned subdevice, unsigned source)
int	comedi_reset (comedi_t *device, unsigned subdevice)
int	comedi_get_clock_source (comedi_t *device, unsigned subdevice, unsigned *SWIG_OUTPUT(clock), unsigned *SWIG_OUTPUT(period_ns))
int	comedi_get_gate_source (comedi_t *device, unsigned subdevice, unsigned channel, unsigned gate, unsigned *SWIG_OUTPUT(source))
int	comedi_get_routing (comedi_t *device, unsigned subdevice, unsigned channel, unsigned *SWIG_OUTPUT(routing))
int	comedi_set_counter_mode (comedi_t *device, unsigned subdevice, unsigned channel, unsigned mode_bits)
int	comedi_set_clock_source (comedi_t *device, unsigned subdevice, unsigned clock, unsigned period_ns)
int	comedi_set_filter (comedi_t *device, unsigned subdevice, unsigned channel, unsigned filter)
int	comedi_set_gate_source (comedi_t *device, unsigned subdevice, unsigned channel, unsigned gate_index, unsigned gate_source)
int	comedi_set_other_source (comedi_t *device, unsigned subdevice, unsigned channel, unsigned other, unsigned source)
int	comedi_set_routing (comedi_t *device, unsigned subdevice, unsigned channel, unsigned routing)
int	comedi_get_hardware_buffer_size (comedi_t *device, unsigned subdevice, enum comedi_io_direction direction)

---

Define Documentation

#define COMEDI_MAX_NUM_POLYNOMIAL_COEFFICIENTS   4

Definition at line 223 of file comedilib.h.

#define COMEDI_VERSION_CODE	(		a,
			b,
			c
	)		(((a)<<16) | ((b)<<8) | (c))

Definition at line 94 of file comedilib.h.

#define CS_MAX_AREFS_LENGTH   4

Definition at line 235 of file comedilib.h.

#define SWIG_INOUT

(

x

)

x

Definition at line 45 of file comedilib.h.

#define SWIG_INPUT

(

x

)

x

Definition at line 44 of file comedilib.h.

#define SWIG_OUTPUT

(

x

)

x

Definition at line 43 of file comedilib.h.

---

Typedef Documentation

typedef struct comedi_sv_struct comedi_sv_t

typedef struct comedi_t_struct comedi_t

Definition at line 48 of file comedilib.h.

---

Enumeration Type Documentation

enum comedi_conversion_direction

Enumerator:

COMEDI_TO_PHYSICAL
COMEDI_FROM_PHYSICAL

Definition at line 268 of file comedilib.h.

enum comedi_oor_behavior

Enumerator:

COMEDI_OOR_NUMBER
COMEDI_OOR_NAN

Definition at line 71 of file comedilib.h.

---

Function Documentation

int comedi_apply_calibration	(	comedi_t *	dev,
		unsigned int	subdev,
		unsigned int	channel,
		unsigned int	range,
		unsigned int	aref,
		const char *	cal_file_path
	)

int comedi_apply_parsed_calibration	(	comedi_t *	dev,
		unsigned int	subdev,
		unsigned int	channel,
		unsigned int	range,
		unsigned int	aref,
		const comedi_calibration_t *	calibration
	)

int comedi_arm	(	comedi_t *	device,
		unsigned	subdevice,
		unsigned	source
	)

int comedi_cancel	(	comedi_t *	it,
		unsigned int	subdevice
	)

Definition at line 421 of file kcomedilib_main.c.

void comedi_cleanup_calibration

(

comedi_calibration_t *

calibration

)

int comedi_close

(

comedi_t *

it

)

Definition at line 92 of file kcomedilib_main.c.

int comedi_command	(	comedi_t *	it,
		comedi_cmd *	cmd
	)

Definition at line 124 of file kcomedilib_main.c.

int comedi_command_test	(	comedi_t *	it,
		comedi_cmd *	SWIG_INOUTcmd
	)

int comedi_data_read	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	chan,
		unsigned int	range,
		unsigned int	aref,
		lsampl_t *	SWIG_OUTPUTdata
	)

int comedi_data_read_delayed	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	chan,
		unsigned int	range,
		unsigned int	aref,
		lsampl_t *	SWIG_OUTPUTdata,
		unsigned int	nano_sec
	)

int comedi_data_read_hint	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	chan,
		unsigned int	range,
		unsigned int	aref
	)

Definition at line 60 of file data.c.

int comedi_data_read_n	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	chan,
		unsigned int	range,
		unsigned int	aref,
		lsampl_t *	SWIG_OUTPUTdata,
		unsigned int	n
	)

int comedi_data_write	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	chan,
		unsigned int	range,
		unsigned int	aref,
		lsampl_t	data
	)

Definition at line 30 of file data.c.

int comedi_dio_bitfield	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	write_mask,
		unsigned int *	SWIG_INOUTbits
	)

int comedi_dio_bitfield2	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	write_mask,
		unsigned int *	SWIG_INOUTbits,
		unsigned int	base_channel
	)

int comedi_dio_config	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	chan,
		unsigned int	dir
	)

Definition at line 29 of file dio.c.

int comedi_dio_get_config	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	chan,
		unsigned int *	SWIG_OUTPUTdir
	)

int comedi_dio_read	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	chan,
		unsigned int *	SWIG_OUTPUTbit
	)

int comedi_dio_write	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	chan,
		unsigned int	bit
	)

Definition at line 59 of file dio.c.

int comedi_do_insn	(	comedi_t *	it,
		comedi_insn *	insn
	)

Definition at line 186 of file kcomedilib_main.c.

int comedi_do_insnlist	(	comedi_t *	it,
		comedi_insnlist *	il
	)

int comedi_errno

(

void

)

int comedi_fileno

(

comedi_t *

it

)

Definition at line 116 of file kcomedilib_main.c.

int comedi_find_range	(	comedi_t *	it,
		unsigned int	subd,
		unsigned int	chan,
		unsigned int	unit,
		double	min,
		double	max
	)

int comedi_find_subdevice_by_type	(	comedi_t *	it,
		int	type,
		unsigned int	subd
	)

Definition at line 71 of file get.c.

lsampl_t comedi_from_phys	(	double	data,
		comedi_range *	rng,
		lsampl_t	maxdata
	)

lsampl_t comedi_from_physical	(	double	data,
		const comedi_polynomial_t *	conversion_polynomial
	)

const char* comedi_get_board_name

(

comedi_t *

it

)

Definition at line 48 of file get.c.

int comedi_get_buffer_contents	(	comedi_t *	it,
		unsigned int	subdev
	)

Definition at line 187 of file get.c.

int comedi_get_buffer_offset	(	comedi_t *	it,
		unsigned int	subdev
	)

Definition at line 281 of file get.c.

int comedi_get_buffer_size	(	comedi_t *	it,
		unsigned int	subdevice
	)

Definition at line 266 of file get.c.

int comedi_get_clock_source	(	comedi_t *	device,
		unsigned	subdevice,
		unsigned *	SWIG_OUTPUTclock,
		unsigned *	SWIG_OUTPUTperiod_ns
	)

int comedi_get_cmd_generic_timed	(	comedi_t *	dev,
		unsigned int	subdevice,
		comedi_cmd *	SWIG_INOUTcmd,
		unsigned	chanlist_len,
		unsigned	scan_period_ns
	)

int comedi_get_cmd_src_mask	(	comedi_t *	dev,
		unsigned int	subdevice,
		comedi_cmd *	SWIG_INOUTcmd
	)

char* comedi_get_default_calibration_path

(

comedi_t *

dev

)

const char* comedi_get_driver_name

(

comedi_t *

it

)

Definition at line 41 of file get.c.

int comedi_get_gate_source	(	comedi_t *	device,
		unsigned	subdevice,
		unsigned	channel,
		unsigned	gate,
		unsigned *	SWIG_OUTPUTsource
	)

int comedi_get_hardcal_converter	(	comedi_t *	dev,
		unsigned	subdevice,
		unsigned	channel,
		unsigned	range,
		enum comedi_conversion_direction	direction,
		comedi_polynomial_t *	SWIG_OUTPUTpolynomial
	)

int comedi_get_hardware_buffer_size	(	comedi_t *	device,
		unsigned	subdevice,
		enum comedi_io_direction	direction
	)

int comedi_get_max_buffer_size	(	comedi_t *	it,
		unsigned int	subdevice
	)

lsampl_t comedi_get_maxdata	(	comedi_t *	it,
		unsigned int	subdevice,
		unsigned int	chan
	)

Definition at line 101 of file get.c.

int comedi_get_n_channels	(	comedi_t *	it,
		unsigned int	subdevice
	)

Definition at line 85 of file get.c.

int comedi_get_n_ranges	(	comedi_t *	it,
		unsigned int	subdevice,
		unsigned int	chan
	)

Definition at line 133 of file get.c.

int comedi_get_n_subdevices

(

comedi_t *

it

)

Definition at line 29 of file get.c.

comedi_range* comedi_get_range	(	comedi_t *	it,
		unsigned int	subdevice,
		unsigned int	chan,
		unsigned int	range
	)

int comedi_get_read_subdevice

(

comedi_t *

dev

)

int comedi_get_routing	(	comedi_t *	device,
		unsigned	subdevice,
		unsigned	channel,
		unsigned *	SWIG_OUTPUTrouting
	)

int comedi_get_softcal_converter	(	unsigned	subdevice,
		unsigned	channel,
		unsigned	range,
		enum comedi_conversion_direction	direction,
		const comedi_calibration_t *	calibration,
		comedi_polynomial_t *	SWIG_OUTPUTpolynomial
	)

int comedi_get_subdevice_flags	(	comedi_t *	it,
		unsigned int	subdevice
	)

Definition at line 63 of file get.c.

int comedi_get_subdevice_type	(	comedi_t *	it,
		unsigned int	subdevice
	)

Definition at line 55 of file get.c.

int comedi_get_version_code

(

comedi_t *

it

)

Definition at line 36 of file get.c.

int comedi_get_write_subdevice

(

comedi_t *

dev

)

int comedi_internal_trigger	(	comedi_t *	dev,
		unsigned	subd,
		unsigned	trignum
	)

Definition at line 215 of file insn_config_wrappers.c.

int comedi_lock	(	comedi_t *	it,
		unsigned int	subdevice
	)

Definition at line 326 of file kcomedilib_main.c.

int comedi_loglevel

(

int

loglevel

)

Definition at line 101 of file kcomedilib_main.c.

int comedi_mark_buffer_read	(	comedi_t *	it,
		unsigned int	subdev,
		unsigned int	bytes
	)

Definition at line 227 of file get.c.

int comedi_mark_buffer_written	(	comedi_t *	it,
		unsigned int	subdev,
		unsigned int	bytes
	)

Definition at line 246 of file get.c.

int comedi_maxdata_is_chan_specific	(	comedi_t *	it,
		unsigned int	subdevice
	)

comedi_t* comedi_open

(

const char *

fn

)

Definition at line 45 of file kcomedilib_main.c.

comedi_calibration_t* comedi_parse_calibration_file

(

const char *

cal_file_path

)

void comedi_perror

(

const char *

s

)

Definition at line 106 of file kcomedilib_main.c.

int comedi_poll	(	comedi_t *	dev,
		unsigned int	subdevice
	)

Definition at line 501 of file kcomedilib_main.c.

int comedi_range_is_chan_specific	(	comedi_t *	it,
		unsigned int	subdevice
	)

int comedi_reset	(	comedi_t *	device,
		unsigned	subdevice
	)

int comedi_sampl_from_phys	(	sampl_t *	dest,
		int	dst_stride,
		double *	src,
		int	src_stride,
		comedi_range *	rng,
		lsampl_t	maxdata,
		int	n
	)

int comedi_sampl_to_phys	(	double *	dest,
		int	dst_stride,
		sampl_t *	src,
		int	src_stride,
		comedi_range *	rng,
		lsampl_t	maxdata,
		int	n
	)

int comedi_set_buffer_size	(	comedi_t *	it,
		unsigned int	subdevice,
		unsigned int	len
	)

int comedi_set_clock_source	(	comedi_t *	device,
		unsigned	subdevice,
		unsigned	clock,
		unsigned	period_ns
	)

int comedi_set_counter_mode	(	comedi_t *	device,
		unsigned	subdevice,
		unsigned	channel,
		unsigned	mode_bits
	)

int comedi_set_filter	(	comedi_t *	device,
		unsigned	subdevice,
		unsigned	channel,
		unsigned	filter
	)

int comedi_set_gate_source	(	comedi_t *	device,
		unsigned	subdevice,
		unsigned	channel,
		unsigned	gate_index,
		unsigned	gate_source
	)

enum comedi_oor_behavior comedi_set_global_oor_behavior

(

enum comedi_oor_behavior

behavior

)

int comedi_set_max_buffer_size	(	comedi_t *	it,
		unsigned int	subdev,
		unsigned int	max_size
	)

int comedi_set_other_source	(	comedi_t *	device,
		unsigned	subdevice,
		unsigned	channel,
		unsigned	other,
		unsigned	source
	)

int comedi_set_routing	(	comedi_t *	device,
		unsigned	subdevice,
		unsigned	channel,
		unsigned	routing
	)

const char* comedi_strerror

(

int

errnum

)

Definition at line 111 of file kcomedilib_main.c.

int comedi_sv_init	(	comedi_sv_t *	it,
		comedi_t *	dev,
		unsigned int	subd,
		unsigned int	chan
	)

int comedi_sv_measure	(	comedi_sv_t *	it,
		double *	data
	)

int comedi_sv_update

(

comedi_sv_t *

it

)

double comedi_to_phys	(	lsampl_t	data,
		comedi_range *	rng,
		lsampl_t	maxdata
	)

double comedi_to_physical	(	lsampl_t	data,
		const comedi_polynomial_t *	conversion_polynomial
	)

int comedi_unlock	(	comedi_t *	it,
		unsigned int	subdevice
	)

Definition at line 369 of file kcomedilib_main.c.