Commit | Line | Data |
---|---|---|
498460eb JW |
1 | /* |
2 | comedi/drivers/comedi_test.c | |
3 | ||
4 | Generates fake waveform signals that can be read through | |
5 | the command interface. It does _not_ read from any board; | |
6 | it just generates deterministic waveforms. | |
7 | Useful for various testing purposes. | |
8 | ||
9 | Copyright (C) 2002 Joachim Wuttke <Joachim.Wuttke@icn.siemens.de> | |
10 | Copyright (C) 2002 Frank Mori Hess <fmhess@users.sourceforge.net> | |
11 | ||
12 | COMEDI - Linux Control and Measurement Device Interface | |
13 | Copyright (C) 2000 David A. Schleef <ds@schleef.org> | |
14 | ||
15 | This program is free software; you can redistribute it and/or modify | |
16 | it under the terms of the GNU General Public License as published by | |
17 | the Free Software Foundation; either version 2 of the License, or | |
18 | (at your option) any later version. | |
19 | ||
20 | This program is distributed in the hope that it will be useful, | |
21 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
22 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
23 | GNU General Public License for more details. | |
24 | ||
25 | You should have received a copy of the GNU General Public License | |
26 | along with this program; if not, write to the Free Software | |
27 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
28 | ||
29 | ************************************************************************/ | |
30 | /* | |
31 | Driver: comedi_test | |
32 | Description: generates fake waveforms | |
33 | Author: Joachim Wuttke <Joachim.Wuttke@icn.siemens.de>, Frank Mori Hess | |
34 | <fmhess@users.sourceforge.net>, ds | |
35 | Devices: | |
36 | Status: works | |
37 | Updated: Sat, 16 Mar 2002 17:34:48 -0800 | |
38 | ||
39 | This driver is mainly for testing purposes, but can also be used to | |
40 | generate sample waveforms on systems that don't have data acquisition | |
41 | hardware. | |
42 | ||
43 | Configuration options: | |
44 | [0] - Amplitude in microvolts for fake waveforms (default 1 volt) | |
45 | [1] - Period in microseconds for fake waveforms (default 0.1 sec) | |
46 | ||
47 | Generates a sawtooth wave on channel 0, square wave on channel 1, additional | |
48 | waveforms could be added to other channels (currently they return flatline | |
49 | zero volts). | |
50 | ||
51 | */ | |
52 | ||
53 | #include "../comedidev.h" | |
54 | ||
55 | #include <asm/div64.h> | |
56 | ||
57 | #include "comedi_fc.h" | |
de4545cd | 58 | #include <linux/timer.h> |
498460eb | 59 | |
498460eb JW |
60 | #define N_CHANS 8 |
61 | ||
498460eb | 62 | /* Data unique to this driver */ |
8c49292f | 63 | struct waveform_private { |
498460eb | 64 | struct timer_list timer; |
25985edc | 65 | struct timeval last; /* time at which last timer interrupt occurred */ |
1be0e3ed GKH |
66 | unsigned int uvolt_amplitude; /* waveform amplitude in microvolts */ |
67 | unsigned long usec_period; /* waveform period in microseconds */ | |
0a85b6f0 | 68 | unsigned long usec_current; /* current time (modulo waveform period) */ |
1be0e3ed GKH |
69 | unsigned long usec_remainder; /* usec since last scan; */ |
70 | unsigned long ai_count; /* number of conversions remaining */ | |
71 | unsigned int scan_period; /* scan period in usec */ | |
72 | unsigned int convert_period; /* conversion period in usec */ | |
73 | unsigned timer_running:1; | |
790c5541 | 74 | unsigned int ao_loopbacks[N_CHANS]; |
8c49292f | 75 | }; |
498460eb | 76 | |
1be0e3ed GKH |
77 | /* 1000 nanosec in a microsec */ |
78 | static const int nano_per_micro = 1000; | |
79 | ||
80 | /* fake analog input ranges */ | |
9ced1de6 | 81 | static const struct comedi_lrange waveform_ai_ranges = { |
498460eb JW |
82 | 2, |
83 | { | |
0a85b6f0 MT |
84 | BIP_RANGE(10), |
85 | BIP_RANGE(5), | |
86 | } | |
498460eb JW |
87 | }; |
88 | ||
0eb0f278 HS |
89 | static short fake_sawtooth(struct comedi_device *dev, unsigned int range_index, |
90 | unsigned long current_time) | |
91 | { | |
f1e5aa75 | 92 | struct waveform_private *devpriv = dev->private; |
0eb0f278 HS |
93 | struct comedi_subdevice *s = dev->read_subdev; |
94 | unsigned int offset = s->maxdata / 2; | |
95 | u64 value; | |
96 | const struct comedi_krange *krange = | |
97 | &s->range_table->range[range_index]; | |
98 | u64 binary_amplitude; | |
99 | ||
100 | binary_amplitude = s->maxdata; | |
101 | binary_amplitude *= devpriv->uvolt_amplitude; | |
102 | do_div(binary_amplitude, krange->max - krange->min); | |
103 | ||
104 | current_time %= devpriv->usec_period; | |
105 | value = current_time; | |
106 | value *= binary_amplitude * 2; | |
107 | do_div(value, devpriv->usec_period); | |
108 | value -= binary_amplitude; /* get rid of sawtooth's dc offset */ | |
109 | ||
110 | return offset + value; | |
111 | } | |
112 | ||
113 | static short fake_squarewave(struct comedi_device *dev, | |
114 | unsigned int range_index, | |
115 | unsigned long current_time) | |
116 | { | |
f1e5aa75 | 117 | struct waveform_private *devpriv = dev->private; |
0eb0f278 HS |
118 | struct comedi_subdevice *s = dev->read_subdev; |
119 | unsigned int offset = s->maxdata / 2; | |
120 | u64 value; | |
121 | const struct comedi_krange *krange = | |
122 | &s->range_table->range[range_index]; | |
123 | current_time %= devpriv->usec_period; | |
124 | ||
125 | value = s->maxdata; | |
126 | value *= devpriv->uvolt_amplitude; | |
127 | do_div(value, krange->max - krange->min); | |
128 | ||
129 | if (current_time < devpriv->usec_period / 2) | |
130 | value *= -1; | |
131 | ||
132 | return offset + value; | |
133 | } | |
134 | ||
135 | static short fake_flatline(struct comedi_device *dev, unsigned int range_index, | |
136 | unsigned long current_time) | |
137 | { | |
138 | return dev->read_subdev->maxdata / 2; | |
139 | } | |
140 | ||
141 | /* generates a different waveform depending on what channel is read */ | |
142 | static short fake_waveform(struct comedi_device *dev, unsigned int channel, | |
143 | unsigned int range, unsigned long current_time) | |
144 | { | |
145 | enum { | |
146 | SAWTOOTH_CHAN, | |
147 | SQUARE_CHAN, | |
148 | }; | |
149 | switch (channel) { | |
150 | case SAWTOOTH_CHAN: | |
151 | return fake_sawtooth(dev, range, current_time); | |
152 | break; | |
153 | case SQUARE_CHAN: | |
154 | return fake_squarewave(dev, range, current_time); | |
155 | break; | |
156 | default: | |
157 | break; | |
158 | } | |
159 | ||
160 | return fake_flatline(dev, range, current_time); | |
161 | } | |
162 | ||
498460eb JW |
163 | /* |
164 | This is the background routine used to generate arbitrary data. | |
165 | It should run in the background; therefore it is scheduled by | |
166 | a timer mechanism. | |
167 | */ | |
168 | static void waveform_ai_interrupt(unsigned long arg) | |
169 | { | |
0a85b6f0 | 170 | struct comedi_device *dev = (struct comedi_device *)arg; |
f1e5aa75 | 171 | struct waveform_private *devpriv = dev->private; |
d163679c | 172 | struct comedi_async *async = dev->read_subdev->async; |
ea6d0d4c | 173 | struct comedi_cmd *cmd = &async->cmd; |
498460eb | 174 | unsigned int i, j; |
1be0e3ed | 175 | /* all times in microsec */ |
498460eb JW |
176 | unsigned long elapsed_time; |
177 | unsigned int num_scans; | |
178 | struct timeval now; | |
179 | ||
180 | do_gettimeofday(&now); | |
181 | ||
182 | elapsed_time = | |
0a85b6f0 MT |
183 | 1000000 * (now.tv_sec - devpriv->last.tv_sec) + now.tv_usec - |
184 | devpriv->last.tv_usec; | |
498460eb JW |
185 | devpriv->last = now; |
186 | num_scans = | |
0a85b6f0 | 187 | (devpriv->usec_remainder + elapsed_time) / devpriv->scan_period; |
498460eb | 188 | devpriv->usec_remainder = |
0a85b6f0 | 189 | (devpriv->usec_remainder + elapsed_time) % devpriv->scan_period; |
498460eb JW |
190 | async->events = 0; |
191 | ||
192 | for (i = 0; i < num_scans; i++) { | |
193 | for (j = 0; j < cmd->chanlist_len; j++) { | |
194 | cfc_write_to_buffer(dev->read_subdev, | |
0a85b6f0 MT |
195 | fake_waveform(dev, |
196 | CR_CHAN(cmd-> | |
197 | chanlist[j]), | |
198 | CR_RANGE(cmd-> | |
199 | chanlist[j]), | |
200 | devpriv-> | |
201 | usec_current + | |
202 | i * | |
203 | devpriv->scan_period + | |
204 | j * | |
205 | devpriv-> | |
206 | convert_period)); | |
498460eb JW |
207 | } |
208 | devpriv->ai_count++; | |
209 | if (cmd->stop_src == TRIG_COUNT | |
0a85b6f0 | 210 | && devpriv->ai_count >= cmd->stop_arg) { |
498460eb JW |
211 | async->events |= COMEDI_CB_EOA; |
212 | break; | |
213 | } | |
214 | } | |
215 | ||
216 | devpriv->usec_current += elapsed_time; | |
217 | devpriv->usec_current %= devpriv->usec_period; | |
218 | ||
219 | if ((async->events & COMEDI_CB_EOA) == 0 && devpriv->timer_running) | |
220 | mod_timer(&devpriv->timer, jiffies + 1); | |
221 | else | |
222 | del_timer(&devpriv->timer); | |
223 | ||
224 | comedi_event(dev, dev->read_subdev); | |
225 | } | |
226 | ||
0a85b6f0 MT |
227 | static int waveform_ai_cmdtest(struct comedi_device *dev, |
228 | struct comedi_subdevice *s, | |
ea6d0d4c | 229 | struct comedi_cmd *cmd) |
498460eb JW |
230 | { |
231 | int err = 0; | |
232 | int tmp; | |
233 | ||
234 | /* step 1: make sure trigger sources are trivially valid */ | |
235 | ||
236 | tmp = cmd->start_src; | |
237 | cmd->start_src &= TRIG_NOW; | |
238 | if (!cmd->start_src || tmp != cmd->start_src) | |
239 | err++; | |
240 | ||
241 | tmp = cmd->scan_begin_src; | |
242 | cmd->scan_begin_src &= TRIG_TIMER; | |
243 | if (!cmd->scan_begin_src || tmp != cmd->scan_begin_src) | |
244 | err++; | |
245 | ||
246 | tmp = cmd->convert_src; | |
247 | cmd->convert_src &= TRIG_NOW | TRIG_TIMER; | |
248 | if (!cmd->convert_src || tmp != cmd->convert_src) | |
249 | err++; | |
250 | ||
251 | tmp = cmd->scan_end_src; | |
252 | cmd->scan_end_src &= TRIG_COUNT; | |
253 | if (!cmd->scan_end_src || tmp != cmd->scan_end_src) | |
254 | err++; | |
255 | ||
256 | tmp = cmd->stop_src; | |
257 | cmd->stop_src &= TRIG_COUNT | TRIG_NONE; | |
258 | if (!cmd->stop_src || tmp != cmd->stop_src) | |
259 | err++; | |
260 | ||
261 | if (err) | |
262 | return 1; | |
263 | ||
1be0e3ed GKH |
264 | /* |
265 | * step 2: make sure trigger sources are unique and mutually compatible | |
266 | */ | |
498460eb JW |
267 | |
268 | if (cmd->convert_src != TRIG_NOW && cmd->convert_src != TRIG_TIMER) | |
269 | err++; | |
270 | if (cmd->stop_src != TRIG_COUNT && cmd->stop_src != TRIG_NONE) | |
271 | err++; | |
272 | ||
273 | if (err) | |
274 | return 2; | |
275 | ||
276 | /* step 3: make sure arguments are trivially compatible */ | |
277 | ||
278 | if (cmd->start_arg != 0) { | |
279 | cmd->start_arg = 0; | |
280 | err++; | |
281 | } | |
282 | if (cmd->convert_src == TRIG_NOW) { | |
283 | if (cmd->convert_arg != 0) { | |
284 | cmd->convert_arg = 0; | |
285 | err++; | |
286 | } | |
287 | } | |
288 | if (cmd->scan_begin_src == TRIG_TIMER) { | |
289 | if (cmd->scan_begin_arg < nano_per_micro) { | |
290 | cmd->scan_begin_arg = nano_per_micro; | |
291 | err++; | |
292 | } | |
293 | if (cmd->convert_src == TRIG_TIMER && | |
0a85b6f0 MT |
294 | cmd->scan_begin_arg < |
295 | cmd->convert_arg * cmd->chanlist_len) { | |
498460eb | 296 | cmd->scan_begin_arg = |
0a85b6f0 | 297 | cmd->convert_arg * cmd->chanlist_len; |
498460eb JW |
298 | err++; |
299 | } | |
300 | } | |
1be0e3ed GKH |
301 | /* |
302 | * XXX these checks are generic and should go in core if not there | |
303 | * already | |
304 | */ | |
498460eb JW |
305 | if (!cmd->chanlist_len) { |
306 | cmd->chanlist_len = 1; | |
307 | err++; | |
308 | } | |
309 | if (cmd->scan_end_arg != cmd->chanlist_len) { | |
310 | cmd->scan_end_arg = cmd->chanlist_len; | |
311 | err++; | |
312 | } | |
313 | ||
314 | if (cmd->stop_src == TRIG_COUNT) { | |
315 | if (!cmd->stop_arg) { | |
316 | cmd->stop_arg = 1; | |
317 | err++; | |
318 | } | |
319 | } else { /* TRIG_NONE */ | |
320 | if (cmd->stop_arg != 0) { | |
321 | cmd->stop_arg = 0; | |
322 | err++; | |
323 | } | |
324 | } | |
325 | ||
326 | if (err) | |
327 | return 3; | |
328 | ||
329 | /* step 4: fix up any arguments */ | |
330 | ||
331 | if (cmd->scan_begin_src == TRIG_TIMER) { | |
332 | tmp = cmd->scan_begin_arg; | |
1be0e3ed | 333 | /* round to nearest microsec */ |
498460eb | 334 | cmd->scan_begin_arg = |
0a85b6f0 MT |
335 | nano_per_micro * ((tmp + |
336 | (nano_per_micro / 2)) / nano_per_micro); | |
498460eb JW |
337 | if (tmp != cmd->scan_begin_arg) |
338 | err++; | |
339 | } | |
340 | if (cmd->convert_src == TRIG_TIMER) { | |
341 | tmp = cmd->convert_arg; | |
1be0e3ed | 342 | /* round to nearest microsec */ |
498460eb | 343 | cmd->convert_arg = |
0a85b6f0 MT |
344 | nano_per_micro * ((tmp + |
345 | (nano_per_micro / 2)) / nano_per_micro); | |
498460eb JW |
346 | if (tmp != cmd->convert_arg) |
347 | err++; | |
348 | } | |
349 | ||
350 | if (err) | |
351 | return 4; | |
352 | ||
353 | return 0; | |
354 | } | |
355 | ||
0a85b6f0 MT |
356 | static int waveform_ai_cmd(struct comedi_device *dev, |
357 | struct comedi_subdevice *s) | |
498460eb | 358 | { |
f1e5aa75 | 359 | struct waveform_private *devpriv = dev->private; |
ea6d0d4c | 360 | struct comedi_cmd *cmd = &s->async->cmd; |
498460eb JW |
361 | |
362 | if (cmd->flags & TRIG_RT) { | |
363 | comedi_error(dev, | |
0a85b6f0 | 364 | "commands at RT priority not supported in this driver"); |
498460eb JW |
365 | return -1; |
366 | } | |
367 | ||
368 | devpriv->timer_running = 1; | |
369 | devpriv->ai_count = 0; | |
370 | devpriv->scan_period = cmd->scan_begin_arg / nano_per_micro; | |
371 | ||
372 | if (cmd->convert_src == TRIG_NOW) | |
373 | devpriv->convert_period = 0; | |
374 | else if (cmd->convert_src == TRIG_TIMER) | |
375 | devpriv->convert_period = cmd->convert_arg / nano_per_micro; | |
376 | else { | |
377 | comedi_error(dev, "bug setting conversion period"); | |
378 | return -1; | |
379 | } | |
380 | ||
381 | do_gettimeofday(&devpriv->last); | |
382 | devpriv->usec_current = devpriv->last.tv_usec % devpriv->usec_period; | |
383 | devpriv->usec_remainder = 0; | |
384 | ||
385 | devpriv->timer.expires = jiffies + 1; | |
386 | add_timer(&devpriv->timer); | |
387 | return 0; | |
388 | } | |
389 | ||
0a85b6f0 MT |
390 | static int waveform_ai_cancel(struct comedi_device *dev, |
391 | struct comedi_subdevice *s) | |
498460eb | 392 | { |
f1e5aa75 HS |
393 | struct waveform_private *devpriv = dev->private; |
394 | ||
498460eb JW |
395 | devpriv->timer_running = 0; |
396 | del_timer(&devpriv->timer); | |
397 | return 0; | |
398 | } | |
399 | ||
0a85b6f0 MT |
400 | static int waveform_ai_insn_read(struct comedi_device *dev, |
401 | struct comedi_subdevice *s, | |
90035c08 | 402 | struct comedi_insn *insn, unsigned int *data) |
498460eb | 403 | { |
f1e5aa75 | 404 | struct waveform_private *devpriv = dev->private; |
498460eb JW |
405 | int i, chan = CR_CHAN(insn->chanspec); |
406 | ||
407 | for (i = 0; i < insn->n; i++) | |
408 | data[i] = devpriv->ao_loopbacks[chan]; | |
409 | ||
410 | return insn->n; | |
411 | } | |
412 | ||
0a85b6f0 MT |
413 | static int waveform_ao_insn_write(struct comedi_device *dev, |
414 | struct comedi_subdevice *s, | |
90035c08 | 415 | struct comedi_insn *insn, unsigned int *data) |
498460eb | 416 | { |
f1e5aa75 | 417 | struct waveform_private *devpriv = dev->private; |
498460eb JW |
418 | int i, chan = CR_CHAN(insn->chanspec); |
419 | ||
420 | for (i = 0; i < insn->n; i++) | |
421 | devpriv->ao_loopbacks[chan] = data[i]; | |
422 | ||
423 | return insn->n; | |
424 | } | |
90f703d3 | 425 | |
0eb0f278 HS |
426 | static int waveform_attach(struct comedi_device *dev, |
427 | struct comedi_devconfig *it) | |
428 | { | |
f1e5aa75 | 429 | struct waveform_private *devpriv; |
0eb0f278 HS |
430 | struct comedi_subdevice *s; |
431 | int amplitude = it->options[0]; | |
432 | int period = it->options[1]; | |
433 | int i; | |
8b6c5694 | 434 | int ret; |
0eb0f278 | 435 | |
b1da4943 | 436 | dev->board_name = dev->driver->driver_name; |
0eb0f278 | 437 | |
f1e5aa75 HS |
438 | ret = alloc_private(dev, sizeof(*devpriv)); |
439 | if (ret < 0) | |
440 | return ret; | |
441 | devpriv = dev->private; | |
0eb0f278 HS |
442 | |
443 | /* set default amplitude and period */ | |
444 | if (amplitude <= 0) | |
445 | amplitude = 1000000; /* 1 volt */ | |
446 | if (period <= 0) | |
447 | period = 100000; /* 0.1 sec */ | |
448 | ||
449 | devpriv->uvolt_amplitude = amplitude; | |
450 | devpriv->usec_period = period; | |
451 | ||
8b6c5694 HS |
452 | ret = comedi_alloc_subdevices(dev, 2); |
453 | if (ret) | |
454 | return ret; | |
0eb0f278 HS |
455 | |
456 | s = dev->subdevices + 0; | |
457 | dev->read_subdev = s; | |
458 | /* analog input subdevice */ | |
459 | s->type = COMEDI_SUBD_AI; | |
460 | s->subdev_flags = SDF_READABLE | SDF_GROUND | SDF_CMD_READ; | |
b1da4943 HS |
461 | s->n_chan = N_CHANS; |
462 | s->maxdata = 0xffff; | |
0eb0f278 HS |
463 | s->range_table = &waveform_ai_ranges; |
464 | s->len_chanlist = s->n_chan * 2; | |
465 | s->insn_read = waveform_ai_insn_read; | |
466 | s->do_cmd = waveform_ai_cmd; | |
467 | s->do_cmdtest = waveform_ai_cmdtest; | |
468 | s->cancel = waveform_ai_cancel; | |
469 | ||
470 | s = dev->subdevices + 1; | |
471 | dev->write_subdev = s; | |
472 | /* analog output subdevice (loopback) */ | |
473 | s->type = COMEDI_SUBD_AO; | |
474 | s->subdev_flags = SDF_WRITEABLE | SDF_GROUND; | |
b1da4943 HS |
475 | s->n_chan = N_CHANS; |
476 | s->maxdata = 0xffff; | |
0eb0f278 HS |
477 | s->range_table = &waveform_ai_ranges; |
478 | s->len_chanlist = s->n_chan * 2; | |
479 | s->insn_write = waveform_ao_insn_write; | |
480 | s->do_cmd = NULL; | |
481 | s->do_cmdtest = NULL; | |
482 | s->cancel = NULL; | |
483 | ||
484 | /* Our default loopback value is just a 0V flatline */ | |
485 | for (i = 0; i < s->n_chan; i++) | |
486 | devpriv->ao_loopbacks[i] = s->maxdata / 2; | |
487 | ||
488 | init_timer(&(devpriv->timer)); | |
489 | devpriv->timer.function = waveform_ai_interrupt; | |
490 | devpriv->timer.data = (unsigned long)dev; | |
491 | ||
9ac6eb40 HS |
492 | dev_info(dev->class_dev, |
493 | "%s: %i microvolt, %li microsecond waveform attached\n", | |
494 | dev->board_name, | |
495 | devpriv->uvolt_amplitude, devpriv->usec_period); | |
496 | ||
497 | return 0; | |
0eb0f278 HS |
498 | } |
499 | ||
484ecc95 | 500 | static void waveform_detach(struct comedi_device *dev) |
0eb0f278 | 501 | { |
f1e5aa75 HS |
502 | struct waveform_private *devpriv = dev->private; |
503 | ||
504 | if (devpriv) | |
0eb0f278 | 505 | waveform_ai_cancel(dev, dev->read_subdev); |
0eb0f278 HS |
506 | } |
507 | ||
0eb0f278 HS |
508 | static struct comedi_driver waveform_driver = { |
509 | .driver_name = "comedi_test", | |
510 | .module = THIS_MODULE, | |
511 | .attach = waveform_attach, | |
512 | .detach = waveform_detach, | |
0eb0f278 HS |
513 | }; |
514 | module_comedi_driver(waveform_driver); | |
515 | ||
90f703d3 AT |
516 | MODULE_AUTHOR("Comedi http://www.comedi.org"); |
517 | MODULE_DESCRIPTION("Comedi low-level driver"); | |
518 | MODULE_LICENSE("GPL"); |