comedilib.h revision 981bdf41ea7bbeece1f08045e0456c725a4d8f2f 
1/*
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
27#include "comedi.h"
28
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
39/* these functions may not be called at real-time priority */
40
41void *comedi_open(const char *path);
42int comedi_close(void *dev);
43
44/* these functions may be called at any priority, but may fail at
45   real-time priority */
46
47int comedi_lock(void *dev, unsigned int subdev);
48int comedi_unlock(void *dev, unsigned int subdev);
49
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);
57int comedi_fileno(void *dev);
58
59int comedi_cancel(void *dev, unsigned int subdev);
60int comedi_register_callback(void *dev, unsigned int subdev,
61			     unsigned int mask, int (*cb) (unsigned int,
62							   void *), void *arg);
63
64int comedi_command(void *dev, struct comedi_cmd *cmd);
65int comedi_command_test(void *dev, struct comedi_cmd *cmd);
66int comedi_trigger(void *dev, unsigned int subdev, struct comedi_trig *it);
67int __comedi_trigger(void *dev, unsigned int subdev, struct comedi_trig *it);
68int comedi_data_write(void *dev, unsigned int subdev, unsigned int chan,
69		      unsigned int range, unsigned int aref, unsigned int data);
70int comedi_data_read(void *dev, unsigned int subdev, unsigned int chan,
71		     unsigned int range, unsigned int aref, unsigned int *data);
72int comedi_data_read_hint(void *dev, unsigned int subdev,
73			  unsigned int chan, unsigned int range,
74			  unsigned int aref);
75int comedi_data_read_delayed(void *dev, unsigned int subdev, unsigned int chan,
76			     unsigned int range, unsigned int aref,
77			     unsigned int *data, unsigned int nano_sec);
78int comedi_dio_config(void *dev, unsigned int subdev, unsigned int chan,
79		      unsigned int io);
80int comedi_dio_read(void *dev, unsigned int subdev, unsigned int chan,
81		    unsigned int *val);
82int comedi_dio_write(void *dev, unsigned int subdev, unsigned int chan,
83		     unsigned int val);
84int comedi_dio_bitfield(void *dev, unsigned int subdev, unsigned int mask,
85			unsigned int *bits);
86int comedi_get_n_subdevices(void *dev);
87int comedi_get_version_code(void *dev);
88const char *comedi_get_driver_name(void *dev);
89const char *comedi_get_board_name(void *dev);
90int comedi_get_subdevice_type(void *dev, unsigned int subdevice);
91int comedi_find_subdevice_by_type(void *dev, int type, unsigned int subd);
92int comedi_get_n_channels(void *dev, unsigned int subdevice);
93unsigned int comedi_get_maxdata(void *dev, unsigned int subdevice, unsigned
94				int chan);
95int comedi_get_n_ranges(void *dev, unsigned int subdevice, unsigned int chan);
96int comedi_do_insn(void *dev, struct comedi_insn *insn);
97int comedi_poll(void *dev, unsigned int subdev);
98
99/* DEPRECATED functions */
100int comedi_get_rangetype(void *dev, unsigned int subdevice, unsigned int chan);
101
102/* ALPHA functions */
103unsigned 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
106		      chan, unsigned int range, struct comedi_krange *krange);
107unsigned int comedi_get_buf_head_pos(void *dev, unsigned int subdevice);
108int comedi_set_user_int_count(void *dev, unsigned int subdevice,
109			      unsigned int buf_user_count);
110int 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,
114			    unsigned int num_bytes);
115int comedi_mark_buffer_written(void *d, unsigned int subdevice,
116			       unsigned int num_bytes);
117int comedi_get_buffer_contents(void *dev, unsigned int subdevice);
118int comedi_get_buffer_offset(void *dev, unsigned int subdevice);
119
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,
139							   void *), void *arg);
140
141int comedi_command(unsigned int minor, struct comedi_cmd *cmd);
142int comedi_command_test(unsigned int minor, struct comedi_cmd *cmd);
143int comedi_trigger(unsigned int minor, unsigned int subdev,
144		   struct comedi_trig *it);
145int __comedi_trigger(unsigned int minor, unsigned int subdev,
146		     struct comedi_trig *it);
147int comedi_data_write(unsigned int dev, unsigned int subdev, unsigned int chan,
148		      unsigned int range, unsigned int aref, unsigned int data);
149int comedi_data_read(unsigned int dev, unsigned int subdev, unsigned int chan,
150		     unsigned int range, unsigned int aref, unsigned int *data);
151int comedi_dio_config(unsigned int dev, unsigned int subdev, unsigned int chan,
152		      unsigned int io);
153int comedi_dio_read(unsigned int dev, unsigned int subdev, unsigned int chan,
154		    unsigned int *val);
155int comedi_dio_write(unsigned int dev, unsigned int subdev, unsigned int chan,
156		     unsigned int val);
157int comedi_dio_bitfield(unsigned int dev, unsigned int subdev,
158			unsigned int mask, unsigned int *bits);
159int comedi_get_n_subdevices(unsigned int dev);
160int comedi_get_version_code(unsigned int dev);
161char *comedi_get_driver_name(unsigned int dev);
162char *comedi_get_board_name(unsigned int minor);
163int comedi_get_subdevice_type(unsigned int minor, unsigned int subdevice);
164int comedi_find_subdevice_by_type(unsigned int minor, int type,
165				  unsigned int subd);
166int comedi_get_n_channels(unsigned int minor, unsigned int subdevice);
167unsigned int comedi_get_maxdata(unsigned int minor, unsigned int subdevice,
168				unsigned int chan);
169int comedi_get_n_ranges(unsigned int minor, unsigned int subdevice,
170			unsigned int chan);
171int comedi_do_insn(unsigned int minor, struct comedi_insn *insn);
172int comedi_poll(unsigned int minor, unsigned int subdev);
173
174/* DEPRECATED functions */
175int comedi_get_rangetype(unsigned int minor, unsigned int subdevice,
176			 unsigned int chan);
177
178/* ALPHA functions */
179unsigned int comedi_get_subdevice_flags(unsigned int minor, unsigned int
180					subdevice);
181int comedi_get_len_chanlist(unsigned int minor, unsigned int subdevice);
182int comedi_get_krange(unsigned int minor, unsigned int subdevice, unsigned int
183		      chan, unsigned int range, struct comedi_krange *krange);
184unsigned int comedi_get_buf_head_pos(unsigned int minor, unsigned int
185				     subdevice);
186int comedi_set_user_int_count(unsigned int minor, unsigned int subdevice,
187			      unsigned int buf_user_count);
188int comedi_map(unsigned int minor, unsigned int subdev, void **ptr);
189int comedi_unmap(unsigned int minor, unsigned int subdev);
190
191#endif
192
193#endif
194