aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/staging/meilhaus/medriver.h
blob: 02e2408ce5f3f34ffe5280daa314c0c45cd8f747 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/*
 * Copyright (C) 2005 Meilhaus Electronic GmbH (support@meilhaus.de)
 *
 * Source File : medriver.h
 * Author      : GG (Guenter Gebhardt)  <g.gebhardt@meilhaus.de>
 *  Author:	Krzysztof Gantzke	<k.gantzke@meilhaus.de>
 */

#ifndef _MEDRIVER_H_
#define _MEDRIVER_H_

#include "metypes.h"
#include "meerror.h"
#include "medefines.h"

#ifdef __cplusplus
extern "C" {
#endif

	/*===========================================================================
	  Functions to access the driver system
	  =========================================================================*/

	int meOpen(int iFlags);
	int meClose(int iFlags);

	int meLockDriver(int iLock, int iFlags);
	int meLockDevice(int iDevice, int iLock, int iFlags);
	int meLockSubdevice(int iDevice, int iSubdevice, int iLock, int iFlags);

	/*===========================================================================
	  Error handling functions
	  =========================================================================*/

	int meErrorGetLastMessage(char *pcErrorMsg, int iCount);
	int meErrorGetMessage(int iErrorCode, char *pcErrorMsg, int iCount);
	int meErrorSetDefaultProc(int iSwitch);
	int meErrorSetUserProc(meErrorCB_t pErrorProc);


	/*===========================================================================
	  Functions to perform I/O on a device
	  =========================================================================*/

	int meIOIrqSetCallback(
			int iDevice,
			int iSubdevice,
			meIOIrqCB_t pCallback,
			void *pCallbackContext,
			int iFlags);
	int meIOIrqStart(
			int iDevice,
			int iSubdevice,
			int iChannel,
			int iIrqSource,
			int iIrqEdge,
			int iIrqArg,
			int iFlags);
	int meIOIrqStop(
			int iDevice,
			int iSubdevice,
			int iChannel,
			int iFlags);
	int meIOIrqWait(
			int iDevice,
			int iSubdevice,
			int iChannel,
			int *piIrqCount,
			int *piValue,
			int iTimeOut,
			int iFlags);

	int meIOResetDevice(int iDevice, int iFlags);
	int meIOResetSubdevice(int iDevice, int iSubdevice, int iFlags);

	int meIOStreamFrequencyToTicks(
			int iDevice,
			int iSubdevice,
			int iTimer,
			double *pdFrequency,
			int *piTicksLow,
			int *piTicksHigh,
			int iFlags);

	int meIOSingleConfig(
			int iDevice,
			int iSubdevice,
			int iChannel,
			int iSingleConfig,
			int iRef,
			int iTrigChan,
			int iTrigType,
			int iTrigEdge,
			int iFlags);
	int meIOSingle(meIOSingle_t *pSingleList, int iCount, int iFlags);

	int meIOStreamConfig(
			int iDevice,
			int iSubdevice,
			meIOStreamConfig_t *pConfigList,
			int iCount,
			meIOStreamTrigger_t *pTrigger,
			int iFifoIrqThreshold,
			int iFlags);
	int meIOStreamNewValues(
			int iDevice,
			int iSubdevice,
			int iTimeOut,
			int *piCount,
			int iFlags);
	int meIOStreamRead(
			int iDevice,
			int iSubdevice,
			int iReadMode,
			int *piValues,
			int *piCount,
			int iFlags);
	int meIOStreamWrite(
			int iDevice,
			int iSubdevice,
			int iWriteMode,
			int *piValues,
			int *piCount,
			int iFlags);
	int meIOStreamStart(meIOStreamStart_t *pStartList, int iCount, int iFlags);
	int meIOStreamStop(meIOStreamStop_t *pStopList, int iCount, int iFlags);
	int meIOStreamStatus(
			int iDevice,
			int iSubdevice,
			int iWait,
			int *piStatus,
			int *piCount,
			int iFlags);
	int meIOStreamSetCallbacks(
			int iDevice,
			int iSubdevice,
			meIOStreamCB_t pStartCB,
			void *pStartCBContext,
			meIOStreamCB_t pNewValuesCB,
			void *pNewValuesCBContext,
			meIOStreamCB_t pEndCB,
			void *pEndCBContext,
			int iFlags);
	int meIOStreamTimeToTicks(
			int iDevice,
			int iSubdevice,
			int iTimer,
			double *pdTime,
			int *piTicksLow,
			int *piTicksHigh,
			int iFlags);


	/*===========================================================================
	  Functions to query the driver system
	  =========================================================================*/

	int meQueryDescriptionDevice(int iDevice, char *pcDescription, int iCount);

	int meQueryInfoDevice(
			int iDevice,
			int *piVendorId,
			int *piDeviceId,
			int *piSerialNo,
			int *piBusType,
			int *piBusNo,
			int *piDevNo,
			int *piFuncNo,
			int *piPlugged);

	int meQueryNameDevice(int iDevice, char *pcName, int iCount);
	int meQueryNameDeviceDriver(int iDevice, char *pcName, int iCount);

	int meQueryNumberDevices(int *piNumber);
	int meQueryNumberSubdevices(int iDevice, int *piNumber);
	int meQueryNumberChannels(int iDevice, int iSubdevice, int *piNumber);
	int meQueryNumberRanges(
			int iDevice,
			int iSubdevice,
			int iUnit,
			int *piNumber);

	int meQueryRangeByMinMax(
			int iDevice,
			int iSubdevice,
			int iUnit,
			double *pdMin,
			double *pdMax,
			int *piMaxData,
			int *piRange);
	int meQueryRangeInfo(
			int iDevice,
			int iSubdevice,
			int iRange,
			int *piUnit,
			double *pdMin,
			double *pdMax,
			int *piMaxData);

	int meQuerySubdeviceByType(
			int iDevice,
			int iStartSubdevice,
			int iType,
			int iSubtype,
			int *piSubdevice);
	int meQuerySubdeviceType(
			int iDevice,
			int iSubdevice,
			int *piType,
			int *piSubtype);
	int meQuerySubdeviceCaps(
			int iDevice,
			int iSubdevice,
			int *piCaps);
	int meQuerySubdeviceCapsArgs(
			int iDevice,
			int iSubdevice,
			int iCap,
			int *piArgs,
			int iCount);

	int meQueryVersionLibrary(int *piVersion);
	int meQueryVersionMainDriver(int *piVersion);
	int meQueryVersionDeviceDriver(int iDevice, int *piVersion);


	/*===========================================================================
	  Common utility functions
	  =========================================================================*/

	int meUtilityExtractValues(
			int iChannel,
			int *piAIBuffer,
			int iAIBufferCount,
			meIOStreamConfig_t *pConfigList,
			int iConfigListCount,
			int *piChanBuffer,
			int *piChanBufferCount);
	int meUtilityDigitalToPhysical(
			double dMin,
			double dMax,
			int iMaxData,
			int iData,
			int iModuleType,
			double dRefValue,
			double *pdPhysical);
	int meUtilityDigitalToPhysicalV(
			double dMin,
			double dMax,
			int iMaxData,
			int *piDataBuffer,
			int iCount,
			int iModuleType,
			double dRefValue,
			double *pdPhysicalBuffer);
	int meUtilityPhysicalToDigital(
			double dMin,
			double dMax,
			int iMaxData,
			double dPhysical,
			int *piData);
	int meUtilityPWMStart(
			int iDevice,
			int iSubdevice1,
			int iSubdevice2,
			int iSubdevice3,
			int iRef,
			int iPrescaler,
			int iDutyCycle,
			int iFlag);
	int meUtilityPWMStop(int iDevice,
			int iSubdevice1);
	int meUtilityPWMRestart(
			int iDevice,
			int iSubdevice1,
			int iRef,
			int iPrescaler);


	/*===========================================================================
	  Load configuration from file into driver system
	  =========================================================================*/

	int meConfigLoad(char *pcConfigFile);


	/*===========================================================================
	  Functions to query a remote driver system
	  =========================================================================*/

	int meRQueryDescriptionDevice(
			char *location,
			int iDevice,
			char *pcDescription,
			int iCount);

	int meRQueryInfoDevice(
			char *location,
			int iDevice,
			int *piVendorId,
			int *piDeviceId,
			int *piSerialNo,
			int *piBusType,
			int *piBusNo,
			int *piDevNo,
			int *piFuncNo,
			int *piPlugged);

	int meRQueryNameDevice(
			char *location,
			int iDevice,
			char *pcName,
			int iCount);

	int meRQueryNumberDevices(char *location, int *piNumber);
	int meRQueryNumberSubdevices(char *location, int iDevice, int *piNumber);
	int meRQueryNumberChannels(
			char *location,
			int iDevice,
			int iSubdevice,
			int *piNumber);
	int meRQueryNumberRanges(
			char *location,
			int iDevice,
			int iSubdevice,
			int iUnit,
			int *piNumber);

	int meRQueryRangeInfo(
			char *location,
			int iDevice,
			int iSubdevice,
			int iRange,
			int *piUnit,
			double *pdMin,
			double *pdMax,
			int *piMaxData);

	int meRQuerySubdeviceType(
			char *location,
			int iDevice,
			int iSubdevice,
			int *piType,
			int *piSubtype);

#ifdef __cplusplus
}
#endif

#endif