]> sigrok.org Git - libsigrok.git/blame_incremental - src/hardware/demo/api.c
Fix initial sample value for demo driver
[libsigrok.git] / src / hardware / demo / api.c
... / ...
CommitLineData
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
6 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
7 * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, see <http://www.gnu.org/licenses/>.
21 */
22
23#include <config.h>
24#include <stdlib.h>
25#include <string.h>
26#include <math.h>
27#include <libsigrok/libsigrok.h>
28#include "libsigrok-internal.h"
29#include "protocol.h"
30
31#define DEFAULT_NUM_LOGIC_CHANNELS 8
32#define DEFAULT_NUM_ANALOG_CHANNELS 4
33
34#define DEFAULT_ANALOG_AMPLITUDE 10
35
36static const char *logic_pattern_str[] = {
37 "sigrok",
38 "random",
39 "incremental",
40 "all-low",
41 "all-high",
42};
43
44static const uint32_t drvopts[] = {
45 SR_CONF_DEMO_DEV,
46 SR_CONF_LOGIC_ANALYZER,
47 SR_CONF_OSCILLOSCOPE,
48};
49
50static const uint32_t scanopts[] = {
51 SR_CONF_NUM_LOGIC_CHANNELS,
52 SR_CONF_NUM_ANALOG_CHANNELS,
53};
54
55static const uint32_t devopts[] = {
56 SR_CONF_CONTINUOUS,
57 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
58 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
59 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
60 SR_CONF_AVERAGING | SR_CONF_GET | SR_CONF_SET,
61 SR_CONF_AVG_SAMPLES | SR_CONF_GET | SR_CONF_SET,
62};
63
64static const uint32_t devopts_cg_logic[] = {
65 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
66};
67
68static const uint32_t devopts_cg_analog_group[] = {
69 SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
70};
71
72static const uint32_t devopts_cg_analog_channel[] = {
73 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
74 SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
75};
76
77static const uint64_t samplerates[] = {
78 SR_HZ(1),
79 SR_GHZ(1),
80 SR_HZ(1),
81};
82
83static GSList *scan(struct sr_dev_driver *di, GSList *options)
84{
85 struct dev_context *devc;
86 struct sr_dev_inst *sdi;
87 struct sr_channel *ch;
88 struct sr_channel_group *cg, *acg;
89 struct sr_config *src;
90 struct analog_gen *ag;
91 GSList *l;
92 int num_logic_channels, num_analog_channels, pattern, i;
93 char channel_name[16];
94
95 num_logic_channels = DEFAULT_NUM_LOGIC_CHANNELS;
96 num_analog_channels = DEFAULT_NUM_ANALOG_CHANNELS;
97 for (l = options; l; l = l->next) {
98 src = l->data;
99 switch (src->key) {
100 case SR_CONF_NUM_LOGIC_CHANNELS:
101 num_logic_channels = g_variant_get_int32(src->data);
102 break;
103 case SR_CONF_NUM_ANALOG_CHANNELS:
104 num_analog_channels = g_variant_get_int32(src->data);
105 break;
106 }
107 }
108
109 sdi = g_malloc0(sizeof(struct sr_dev_inst));
110 sdi->status = SR_ST_INACTIVE;
111 sdi->model = g_strdup("Demo device");
112
113 devc = g_malloc0(sizeof(struct dev_context));
114 devc->cur_samplerate = SR_KHZ(200);
115 devc->num_logic_channels = num_logic_channels;
116 devc->logic_unitsize = (devc->num_logic_channels + 7) / 8;
117 devc->logic_pattern = PATTERN_SIGROK;
118 devc->num_analog_channels = num_analog_channels;
119
120 if (num_logic_channels > 0) {
121 /* Logic channels, all in one channel group. */
122 cg = g_malloc0(sizeof(struct sr_channel_group));
123 cg->name = g_strdup("Logic");
124 for (i = 0; i < num_logic_channels; i++) {
125 sprintf(channel_name, "D%d", i);
126 ch = sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name);
127 cg->channels = g_slist_append(cg->channels, ch);
128 }
129 sdi->channel_groups = g_slist_append(NULL, cg);
130 }
131
132 /* Analog channels, channel groups and pattern generators. */
133 if (num_analog_channels > 0) {
134 pattern = 0;
135 /* An "Analog" channel group with all analog channels in it. */
136 acg = g_malloc0(sizeof(struct sr_channel_group));
137 acg->name = g_strdup("Analog");
138 sdi->channel_groups = g_slist_append(sdi->channel_groups, acg);
139
140 devc->ch_ag = g_hash_table_new(g_direct_hash, g_direct_equal);
141 for (i = 0; i < num_analog_channels; i++) {
142 snprintf(channel_name, 16, "A%d", i);
143 ch = sr_channel_new(sdi, i + num_logic_channels, SR_CHANNEL_ANALOG,
144 TRUE, channel_name);
145 acg->channels = g_slist_append(acg->channels, ch);
146
147 /* Every analog channel gets its own channel group as well. */
148 cg = g_malloc0(sizeof(struct sr_channel_group));
149 cg->name = g_strdup(channel_name);
150 cg->channels = g_slist_append(NULL, ch);
151 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
152
153 /* Every channel gets a generator struct. */
154 ag = g_malloc(sizeof(struct analog_gen));
155 ag->amplitude = DEFAULT_ANALOG_AMPLITUDE;
156 sr_analog_init(&ag->packet, &ag->encoding, &ag->meaning, &ag->spec, 2);
157 ag->packet.meaning->channels = cg->channels;
158 ag->packet.meaning->mq = 0;
159 ag->packet.meaning->mqflags = 0;
160 ag->packet.meaning->unit = SR_UNIT_VOLT;
161 ag->packet.data = ag->pattern_data;
162 ag->pattern = pattern;
163 ag->avg_val = 0.0f;
164 ag->num_avgs = 0;
165 g_hash_table_insert(devc->ch_ag, ch, ag);
166
167 if (++pattern == ARRAY_SIZE(analog_pattern_str))
168 pattern = 0;
169 }
170 }
171
172 sdi->priv = devc;
173
174 return std_scan_complete(di, g_slist_append(NULL, sdi));
175}
176
177static int dev_open(struct sr_dev_inst *sdi)
178{
179 sdi->status = SR_ST_ACTIVE;
180
181 return SR_OK;
182}
183
184static int dev_close(struct sr_dev_inst *sdi)
185{
186 sdi->status = SR_ST_INACTIVE;
187
188 return SR_OK;
189}
190
191static void clear_helper(void *priv)
192{
193 struct dev_context *devc;
194 GHashTableIter iter;
195 void *value;
196
197 devc = priv;
198
199 /* Analog generators. */
200 g_hash_table_iter_init(&iter, devc->ch_ag);
201 while (g_hash_table_iter_next(&iter, NULL, &value))
202 g_free(value);
203 g_hash_table_unref(devc->ch_ag);
204 g_free(devc);
205}
206
207static int dev_clear(const struct sr_dev_driver *di)
208{
209 return std_dev_clear(di, clear_helper);
210}
211
212static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
213 const struct sr_channel_group *cg)
214{
215 struct dev_context *devc;
216 struct sr_channel *ch;
217 struct analog_gen *ag;
218 int pattern;
219
220 if (!sdi)
221 return SR_ERR_ARG;
222
223 devc = sdi->priv;
224 switch (key) {
225 case SR_CONF_SAMPLERATE:
226 *data = g_variant_new_uint64(devc->cur_samplerate);
227 break;
228 case SR_CONF_LIMIT_SAMPLES:
229 *data = g_variant_new_uint64(devc->limit_samples);
230 break;
231 case SR_CONF_LIMIT_MSEC:
232 *data = g_variant_new_uint64(devc->limit_msec);
233 break;
234 case SR_CONF_AVERAGING:
235 *data = g_variant_new_boolean(devc->avg);
236 break;
237 case SR_CONF_AVG_SAMPLES:
238 *data = g_variant_new_uint64(devc->avg_samples);
239 break;
240 case SR_CONF_PATTERN_MODE:
241 if (!cg)
242 return SR_ERR_CHANNEL_GROUP;
243 /* Any channel in the group will do. */
244 ch = cg->channels->data;
245 if (ch->type == SR_CHANNEL_LOGIC) {
246 pattern = devc->logic_pattern;
247 *data = g_variant_new_string(logic_pattern_str[pattern]);
248 } else if (ch->type == SR_CHANNEL_ANALOG) {
249 ag = g_hash_table_lookup(devc->ch_ag, ch);
250 pattern = ag->pattern;
251 *data = g_variant_new_string(analog_pattern_str[pattern]);
252 } else
253 return SR_ERR_BUG;
254 break;
255 case SR_CONF_AMPLITUDE:
256 if (!cg)
257 return SR_ERR_CHANNEL_GROUP;
258 /* Any channel in the group will do. */
259 ch = cg->channels->data;
260 if (ch->type != SR_CHANNEL_ANALOG)
261 return SR_ERR_ARG;
262 ag = g_hash_table_lookup(devc->ch_ag, ch);
263 *data = g_variant_new_double(ag->amplitude);
264 break;
265 default:
266 return SR_ERR_NA;
267 }
268
269 return SR_OK;
270}
271
272static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
273 const struct sr_channel_group *cg)
274{
275 struct dev_context *devc;
276 struct analog_gen *ag;
277 struct sr_channel *ch;
278 GSList *l;
279 int logic_pattern, analog_pattern, ret;
280 unsigned int i;
281 const char *stropt;
282
283 devc = sdi->priv;
284
285 if (sdi->status != SR_ST_ACTIVE)
286 return SR_ERR_DEV_CLOSED;
287
288 ret = SR_OK;
289 switch (key) {
290 case SR_CONF_SAMPLERATE:
291 devc->cur_samplerate = g_variant_get_uint64(data);
292 break;
293 case SR_CONF_LIMIT_SAMPLES:
294 devc->limit_msec = 0;
295 devc->limit_samples = g_variant_get_uint64(data);
296 break;
297 case SR_CONF_LIMIT_MSEC:
298 devc->limit_msec = g_variant_get_uint64(data);
299 devc->limit_samples = 0;
300 break;
301 case SR_CONF_AVERAGING:
302 devc->avg = g_variant_get_boolean(data);
303 sr_dbg("%s averaging", devc->avg ? "Enabling" : "Disabling");
304 break;
305 case SR_CONF_AVG_SAMPLES:
306 devc->avg_samples = g_variant_get_uint64(data);
307 sr_dbg("Setting averaging rate to %" PRIu64, devc->avg_samples);
308 break;
309 case SR_CONF_PATTERN_MODE:
310 if (!cg)
311 return SR_ERR_CHANNEL_GROUP;
312 stropt = g_variant_get_string(data, NULL);
313 logic_pattern = analog_pattern = -1;
314 for (i = 0; i < ARRAY_SIZE(logic_pattern_str); i++) {
315 if (!strcmp(stropt, logic_pattern_str[i])) {
316 logic_pattern = i;
317 break;
318 }
319 }
320 for (i = 0; i < ARRAY_SIZE(analog_pattern_str); i++) {
321 if (!strcmp(stropt, analog_pattern_str[i])) {
322 analog_pattern = i;
323 break;
324 }
325 }
326 if (logic_pattern == -1 && analog_pattern == -1)
327 return SR_ERR_ARG;
328 for (l = cg->channels; l; l = l->next) {
329 ch = l->data;
330 if (ch->type == SR_CHANNEL_LOGIC) {
331 if (logic_pattern == -1)
332 return SR_ERR_ARG;
333 sr_dbg("Setting logic pattern to %s",
334 logic_pattern_str[logic_pattern]);
335 devc->logic_pattern = logic_pattern;
336 /* Might as well do this now, these are static. */
337 if (logic_pattern == PATTERN_ALL_LOW)
338 memset(devc->logic_data, 0x00, LOGIC_BUFSIZE);
339 else if (logic_pattern == PATTERN_ALL_HIGH)
340 memset(devc->logic_data, 0xff, LOGIC_BUFSIZE);
341 } else if (ch->type == SR_CHANNEL_ANALOG) {
342 if (analog_pattern == -1)
343 return SR_ERR_ARG;
344 sr_dbg("Setting analog pattern for channel %s to %s",
345 ch->name, analog_pattern_str[analog_pattern]);
346 ag = g_hash_table_lookup(devc->ch_ag, ch);
347 ag->pattern = analog_pattern;
348 } else
349 return SR_ERR_BUG;
350 }
351 break;
352 case SR_CONF_AMPLITUDE:
353 if (!cg)
354 return SR_ERR_CHANNEL_GROUP;
355 for (l = cg->channels; l; l = l->next) {
356 ch = l->data;
357 if (ch->type != SR_CHANNEL_ANALOG)
358 return SR_ERR_ARG;
359 ag = g_hash_table_lookup(devc->ch_ag, ch);
360 ag->amplitude = g_variant_get_double(data);
361 }
362 break;
363 default:
364 ret = SR_ERR_NA;
365 }
366
367 return ret;
368}
369
370static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
371 const struct sr_channel_group *cg)
372{
373 struct sr_channel *ch;
374 GVariant *gvar;
375 GVariantBuilder gvb;
376
377 if (key == SR_CONF_SCAN_OPTIONS) {
378 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
379 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
380 return SR_OK;
381 }
382
383 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
384 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
385 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
386 return SR_OK;
387 }
388
389 if (!sdi)
390 return SR_ERR_ARG;
391
392 if (!cg) {
393 switch (key) {
394 case SR_CONF_DEVICE_OPTIONS:
395 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
396 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
397 break;
398 case SR_CONF_SAMPLERATE:
399 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
400 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
401 ARRAY_SIZE(samplerates), sizeof(uint64_t));
402 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
403 *data = g_variant_builder_end(&gvb);
404 break;
405 default:
406 return SR_ERR_NA;
407 }
408 } else {
409 ch = cg->channels->data;
410 switch (key) {
411 case SR_CONF_DEVICE_OPTIONS:
412 if (ch->type == SR_CHANNEL_LOGIC)
413 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
414 devopts_cg_logic, ARRAY_SIZE(devopts_cg_logic),
415 sizeof(uint32_t));
416 else if (ch->type == SR_CHANNEL_ANALOG) {
417 if (strcmp(cg->name, "Analog") == 0)
418 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
419 devopts_cg_analog_group, ARRAY_SIZE(devopts_cg_analog_group),
420 sizeof(uint32_t));
421 else
422 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
423 devopts_cg_analog_channel, ARRAY_SIZE(devopts_cg_analog_channel),
424 sizeof(uint32_t));
425 }
426 else
427 return SR_ERR_BUG;
428 break;
429 case SR_CONF_PATTERN_MODE:
430 /* The analog group (with all 4 channels) shall not have a pattern property. */
431 if (strcmp(cg->name, "Analog") == 0)
432 return SR_ERR_NA;
433
434 if (ch->type == SR_CHANNEL_LOGIC)
435 *data = g_variant_new_strv(logic_pattern_str,
436 ARRAY_SIZE(logic_pattern_str));
437 else if (ch->type == SR_CHANNEL_ANALOG)
438 *data = g_variant_new_strv(analog_pattern_str,
439 ARRAY_SIZE(analog_pattern_str));
440 else
441 return SR_ERR_BUG;
442 break;
443 default:
444 return SR_ERR_NA;
445 }
446 }
447
448 return SR_OK;
449}
450
451static int dev_acquisition_start(const struct sr_dev_inst *sdi)
452{
453 struct dev_context *devc;
454 GHashTableIter iter;
455 void *value;
456
457 if (sdi->status != SR_ST_ACTIVE)
458 return SR_ERR_DEV_CLOSED;
459
460 devc = sdi->priv;
461 devc->sent_samples = 0;
462
463 g_hash_table_iter_init(&iter, devc->ch_ag);
464 while (g_hash_table_iter_next(&iter, NULL, &value))
465 demo_generate_analog_pattern(value, devc->cur_samplerate);
466
467 sr_session_source_add(sdi->session, -1, 0, 100,
468 demo_prepare_data, (struct sr_dev_inst *)sdi);
469
470 std_session_send_df_header(sdi);
471
472 /* We use this timestamp to decide how many more samples to send. */
473 devc->start_us = g_get_monotonic_time();
474 devc->spent_us = 0;
475 devc->step = 0;
476
477 return SR_OK;
478}
479
480static int dev_acquisition_stop(struct sr_dev_inst *sdi)
481{
482 sr_dbg("Stopping acquisition.");
483 sr_session_source_remove(sdi->session, -1);
484 std_session_send_df_end(sdi);
485
486 return SR_OK;
487}
488
489static struct sr_dev_driver demo_driver_info = {
490 .name = "demo",
491 .longname = "Demo driver and pattern generator",
492 .api_version = 1,
493 .init = std_init,
494 .cleanup = std_cleanup,
495 .scan = scan,
496 .dev_list = std_dev_list,
497 .dev_clear = dev_clear,
498 .config_get = config_get,
499 .config_set = config_set,
500 .config_list = config_list,
501 .dev_open = dev_open,
502 .dev_close = dev_close,
503 .dev_acquisition_start = dev_acquisition_start,
504 .dev_acquisition_stop = dev_acquisition_stop,
505 .context = NULL,
506};
507SR_REGISTER_DEV_DRIVER(demo_driver_info);