blob: c2729312d57e7ed1dd8c107c0bcb2ce7c2c59861 [file] [log] [blame]
David Schleefed9eccb2008-11-04 20:29:31 -08001/*
2 linux/include/comedilib.h
3 header file for kcomedilib
4
5 COMEDI - Linux Control and Measurement Device Interface
6 Copyright (C) 1998-2001 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 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#ifndef _LINUX_COMEDILIB_H
25#define _LINUX_COMEDILIB_H
26
Greg Kroah-Hartman02ebd472008-11-14 14:58:46 -080027#include "comedi.h"
David Schleefed9eccb2008-11-04 20:29:31 -080028
29/* Kernel internal stuff. Needed by real-time modules and such. */
30
31#ifndef __KERNEL__
32#error linux/comedilib.h should not be included by non-kernel-space code
33#endif
34
35/* exported functions */
36
37#ifndef KCOMEDILIB_DEPRECATED
38
David Schleefed9eccb2008-11-04 20:29:31 -080039/* these functions may not be called at real-time priority */
40
Bill Pemberton0b3fb272009-03-16 22:04:56 -040041void *comedi_open(const char *path);
42int comedi_close(void *dev);
David Schleefed9eccb2008-11-04 20:29:31 -080043
44/* these functions may be called at any priority, but may fail at
45 real-time priority */
46
Bill Pemberton0b3fb272009-03-16 22:04:56 -040047int comedi_lock(void *dev, unsigned int subdev);
48int comedi_unlock(void *dev, unsigned int subdev);
David Schleefed9eccb2008-11-04 20:29:31 -080049
50/* these functions may be called at any priority, but you must hold
51 the lock for the subdevice */
52
53int comedi_loglevel(int loglevel);
54void comedi_perror(const char *s);
55char *comedi_strerror(int errnum);
56int comedi_errno(void);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040057int comedi_fileno(void *dev);
David Schleefed9eccb2008-11-04 20:29:31 -080058
Bill Pemberton0b3fb272009-03-16 22:04:56 -040059int comedi_cancel(void *dev, unsigned int subdev);
60int comedi_register_callback(void *dev, unsigned int subdev,
David Schleefed9eccb2008-11-04 20:29:31 -080061 unsigned int mask, int (*cb) (unsigned int, void *), void *arg);
62
Bill Pembertonea6d0d42009-03-16 22:05:47 -040063int comedi_command(void *dev, struct comedi_cmd *cmd);
64int comedi_command_test(void *dev, struct comedi_cmd *cmd);
Bill Pembertonb50d88d2009-03-16 22:05:42 -040065int comedi_trigger(void *dev, unsigned int subdev, struct comedi_trig *it);
66int __comedi_trigger(void *dev, unsigned int subdev, struct comedi_trig *it);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040067int comedi_data_write(void *dev, unsigned int subdev, unsigned int chan,
Bill Pemberton790c5542009-03-16 22:05:02 -040068 unsigned int range, unsigned int aref, unsigned int data);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040069int comedi_data_read(void *dev, unsigned int subdev, unsigned int chan,
Bill Pemberton790c5542009-03-16 22:05:02 -040070 unsigned int range, unsigned int aref, unsigned int *data);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040071int comedi_data_read_hint(void *dev, unsigned int subdev,
David Schleefed9eccb2008-11-04 20:29:31 -080072 unsigned int chan, unsigned int range, unsigned int aref);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040073int comedi_data_read_delayed(void *dev, unsigned int subdev,
David Schleefed9eccb2008-11-04 20:29:31 -080074 unsigned int chan, unsigned int range, unsigned int aref,
Bill Pemberton790c5542009-03-16 22:05:02 -040075 unsigned int *data, unsigned int nano_sec);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040076int comedi_dio_config(void *dev, unsigned int subdev, unsigned int chan,
David Schleefed9eccb2008-11-04 20:29:31 -080077 unsigned int io);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040078int comedi_dio_read(void *dev, unsigned int subdev, unsigned int chan,
David Schleefed9eccb2008-11-04 20:29:31 -080079 unsigned int *val);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040080int comedi_dio_write(void *dev, unsigned int subdev, unsigned int chan,
David Schleefed9eccb2008-11-04 20:29:31 -080081 unsigned int val);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040082int comedi_dio_bitfield(void *dev, unsigned int subdev, unsigned int mask,
David Schleefed9eccb2008-11-04 20:29:31 -080083 unsigned int *bits);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040084int comedi_get_n_subdevices(void *dev);
85int comedi_get_version_code(void *dev);
86const char *comedi_get_driver_name(void *dev);
87const char *comedi_get_board_name(void *dev);
88int comedi_get_subdevice_type(void *dev, unsigned int subdevice);
89int comedi_find_subdevice_by_type(void *dev, int type, unsigned int subd);
90int comedi_get_n_channels(void *dev, unsigned int subdevice);
Bill Pemberton790c5542009-03-16 22:05:02 -040091unsigned int comedi_get_maxdata(void *dev, unsigned int subdevice, unsigned
David Schleefed9eccb2008-11-04 20:29:31 -080092 int chan);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040093int comedi_get_n_ranges(void *dev, unsigned int subdevice, unsigned int
David Schleefed9eccb2008-11-04 20:29:31 -080094 chan);
Bill Pemberton90035c02009-03-16 22:05:53 -040095int comedi_do_insn(void *dev, struct comedi_insn *insn);
Bill Pemberton0b3fb272009-03-16 22:04:56 -040096int comedi_poll(void *dev, unsigned int subdev);
David Schleefed9eccb2008-11-04 20:29:31 -080097
98/* DEPRECATED functions */
Bill Pemberton0b3fb272009-03-16 22:04:56 -040099int comedi_get_rangetype(void *dev, unsigned int subdevice,
David Schleefed9eccb2008-11-04 20:29:31 -0800100 unsigned int chan);
101
102/* ALPHA functions */
Bill Pemberton0b3fb272009-03-16 22:04:56 -0400103unsigned int comedi_get_subdevice_flags(void *dev, unsigned int subdevice);
104int comedi_get_len_chanlist(void *dev, unsigned int subdevice);
105int comedi_get_krange(void *dev, unsigned int subdevice, unsigned int
Bill Pemberton1f6325d2009-03-16 22:06:31 -0400106 chan, unsigned int range, struct comedi_krange *krange);
Bill Pemberton0b3fb272009-03-16 22:04:56 -0400107unsigned int comedi_get_buf_head_pos(void *dev, unsigned int subdevice);
108int comedi_set_user_int_count(void *dev, unsigned int subdevice,
David Schleefed9eccb2008-11-04 20:29:31 -0800109 unsigned int buf_user_count);
Bill Pemberton0b3fb272009-03-16 22:04:56 -0400110int comedi_map(void *dev, unsigned int subdev, void *ptr);
111int comedi_unmap(void *dev, unsigned int subdev);
112int comedi_get_buffer_size(void *dev, unsigned int subdev);
113int comedi_mark_buffer_read(void *dev, unsigned int subdevice,
David Schleefed9eccb2008-11-04 20:29:31 -0800114 unsigned int num_bytes);
Bill Pemberton0b3fb272009-03-16 22:04:56 -0400115int comedi_mark_buffer_written(void *d, unsigned int subdevice,
David Schleefed9eccb2008-11-04 20:29:31 -0800116 unsigned int num_bytes);
Bill Pemberton0b3fb272009-03-16 22:04:56 -0400117int comedi_get_buffer_contents(void *dev, unsigned int subdevice);
118int comedi_get_buffer_offset(void *dev, unsigned int subdevice);
David Schleefed9eccb2008-11-04 20:29:31 -0800119
120#else
121
122/* these functions may not be called at real-time priority */
123
124int comedi_open(unsigned int minor);
125void comedi_close(unsigned int minor);
126
127/* these functions may be called at any priority, but may fail at
128 real-time priority */
129
130int comedi_lock(unsigned int minor, unsigned int subdev);
131int comedi_unlock(unsigned int minor, unsigned int subdev);
132
133/* these functions may be called at any priority, but you must hold
134 the lock for the subdevice */
135
136int comedi_cancel(unsigned int minor, unsigned int subdev);
137int comedi_register_callback(unsigned int minor, unsigned int subdev,
138 unsigned int mask, int (*cb) (unsigned int, void *), void *arg);
139
Bill Pembertonea6d0d42009-03-16 22:05:47 -0400140int comedi_command(unsigned int minor, struct comedi_cmd *cmd);
141int comedi_command_test(unsigned int minor, struct comedi_cmd *cmd);
Bill Pembertonb50d88d2009-03-16 22:05:42 -0400142int comedi_trigger(unsigned int minor, unsigned int subdev, struct comedi_trig *it);
143int __comedi_trigger(unsigned int minor, unsigned int subdev, struct comedi_trig *it);
David Schleefed9eccb2008-11-04 20:29:31 -0800144int comedi_data_write(unsigned int dev, unsigned int subdev, unsigned int chan,
Bill Pemberton790c5542009-03-16 22:05:02 -0400145 unsigned int range, unsigned int aref, unsigned int data);
David Schleefed9eccb2008-11-04 20:29:31 -0800146int comedi_data_read(unsigned int dev, unsigned int subdev, unsigned int chan,
Bill Pemberton790c5542009-03-16 22:05:02 -0400147 unsigned int range, unsigned int aref, unsigned int *data);
David Schleefed9eccb2008-11-04 20:29:31 -0800148int comedi_dio_config(unsigned int dev, unsigned int subdev, unsigned int chan,
149 unsigned int io);
150int comedi_dio_read(unsigned int dev, unsigned int subdev, unsigned int chan,
151 unsigned int *val);
152int comedi_dio_write(unsigned int dev, unsigned int subdev, unsigned int chan,
153 unsigned int val);
154int comedi_dio_bitfield(unsigned int dev, unsigned int subdev,
155 unsigned int mask, unsigned int *bits);
156int comedi_get_n_subdevices(unsigned int dev);
157int comedi_get_version_code(unsigned int dev);
158char *comedi_get_driver_name(unsigned int dev);
159char *comedi_get_board_name(unsigned int minor);
160int comedi_get_subdevice_type(unsigned int minor, unsigned int subdevice);
161int comedi_find_subdevice_by_type(unsigned int minor, int type,
162 unsigned int subd);
163int comedi_get_n_channels(unsigned int minor, unsigned int subdevice);
Bill Pemberton790c5542009-03-16 22:05:02 -0400164unsigned int comedi_get_maxdata(unsigned int minor, unsigned int subdevice, unsigned
David Schleefed9eccb2008-11-04 20:29:31 -0800165 int chan);
166int comedi_get_n_ranges(unsigned int minor, unsigned int subdevice, unsigned int
167 chan);
Bill Pemberton90035c02009-03-16 22:05:53 -0400168int comedi_do_insn(unsigned int minor, struct comedi_insn *insn);
David Schleefed9eccb2008-11-04 20:29:31 -0800169int comedi_poll(unsigned int minor, unsigned int subdev);
170
171/* DEPRECATED functions */
172int comedi_get_rangetype(unsigned int minor, unsigned int subdevice,
173 unsigned int chan);
174
175/* ALPHA functions */
176unsigned int comedi_get_subdevice_flags(unsigned int minor, unsigned int
177 subdevice);
178int comedi_get_len_chanlist(unsigned int minor, unsigned int subdevice);
179int comedi_get_krange(unsigned int minor, unsigned int subdevice, unsigned int
Bill Pemberton1f6325d2009-03-16 22:06:31 -0400180 chan, unsigned int range, struct comedi_krange *krange);
David Schleefed9eccb2008-11-04 20:29:31 -0800181unsigned int comedi_get_buf_head_pos(unsigned int minor, unsigned int
182 subdevice);
183int comedi_set_user_int_count(unsigned int minor, unsigned int subdevice,
184 unsigned int buf_user_count);
185int comedi_map(unsigned int minor, unsigned int subdev, void **ptr);
186int comedi_unmap(unsigned int minor, unsigned int subdev);
187
188#endif
189
190#endif