2 * This file is part of the libsigrok project.
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>
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.
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.
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/>.
27 #include <libsigrok/libsigrok.h>
28 #include "libsigrok-internal.h"
31 #define DEFAULT_NUM_LOGIC_CHANNELS 8
32 #define DEFAULT_ENABLED_LOGIC_CHANNELS 8
33 #define DEFAULT_LOGIC_PATTERN PATTERN_SIGROK
35 #define DEFAULT_NUM_ANALOG_CHANNELS 4
36 #define DEFAULT_ENABLED_ANALOG_CHANNELS 4
37 #define DEFAULT_ANALOG_AMPLITUDE 10
39 /* Note: No spaces allowed because of sigrok-cli. */
40 static const char *logic_pattern_str[] = {
51 static const uint32_t drvopts[] = {
53 SR_CONF_LOGIC_ANALYZER,
57 static const uint32_t scanopts[] = {
58 SR_CONF_NUM_LOGIC_CHANNELS,
59 SR_CONF_NUM_ANALOG_CHANNELS,
62 static const uint32_t devopts[] = {
64 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
65 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
66 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
67 SR_CONF_AVERAGING | SR_CONF_GET | SR_CONF_SET,
68 SR_CONF_AVG_SAMPLES | SR_CONF_GET | SR_CONF_SET,
71 static const uint32_t devopts_cg_logic[] = {
72 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
75 static const uint32_t devopts_cg_analog_group[] = {
76 SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
79 static const uint32_t devopts_cg_analog_channel[] = {
80 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
81 SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
84 static const uint64_t samplerates[] = {
90 static GSList *scan(struct sr_dev_driver *di, GSList *options)
92 struct dev_context *devc;
93 struct sr_dev_inst *sdi;
94 struct sr_channel *ch;
95 struct sr_channel_group *cg, *acg;
96 struct sr_config *src;
97 struct analog_gen *ag;
99 int num_logic_channels, num_analog_channels, pattern, i;
100 char channel_name[16];
103 num_logic_channels = DEFAULT_NUM_LOGIC_CHANNELS;
104 num_analog_channels = DEFAULT_NUM_ANALOG_CHANNELS;
105 for (l = options; l; l = l->next) {
108 case SR_CONF_NUM_LOGIC_CHANNELS:
109 num_logic_channels = g_variant_get_int32(src->data);
111 case SR_CONF_NUM_ANALOG_CHANNELS:
112 num_analog_channels = g_variant_get_int32(src->data);
117 sdi = g_malloc0(sizeof(struct sr_dev_inst));
118 sdi->status = SR_ST_INACTIVE;
119 sdi->model = g_strdup("Demo device");
121 devc = g_malloc0(sizeof(struct dev_context));
122 devc->cur_samplerate = SR_KHZ(200);
123 devc->num_logic_channels = num_logic_channels;
124 devc->logic_unitsize = (devc->num_logic_channels + 7) / 8;
125 devc->logic_pattern = DEFAULT_LOGIC_PATTERN;
126 devc->num_analog_channels = num_analog_channels;
128 if (num_logic_channels > 0) {
129 /* Logic channels, all in one channel group. */
130 cg = g_malloc0(sizeof(struct sr_channel_group));
131 cg->name = g_strdup("Logic");
132 for (i = 0; i < num_logic_channels; i++) {
133 sprintf(channel_name, "D%d", i);
134 enabled = (i < DEFAULT_ENABLED_LOGIC_CHANNELS) ? TRUE : FALSE;
135 ch = sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, enabled, channel_name);
136 cg->channels = g_slist_append(cg->channels, ch);
138 sdi->channel_groups = g_slist_append(NULL, cg);
141 /* Analog channels, channel groups and pattern generators. */
142 if (num_analog_channels > 0) {
144 /* An "Analog" channel group with all analog channels in it. */
145 acg = g_malloc0(sizeof(struct sr_channel_group));
146 acg->name = g_strdup("Analog");
147 sdi->channel_groups = g_slist_append(sdi->channel_groups, acg);
149 devc->ch_ag = g_hash_table_new(g_direct_hash, g_direct_equal);
150 for (i = 0; i < num_analog_channels; i++) {
151 snprintf(channel_name, 16, "A%d", i);
152 enabled = (i < DEFAULT_ENABLED_ANALOG_CHANNELS) ? TRUE : FALSE;
153 ch = sr_channel_new(sdi, i + num_logic_channels, SR_CHANNEL_ANALOG,
154 enabled, channel_name);
155 acg->channels = g_slist_append(acg->channels, ch);
157 /* Every analog channel gets its own channel group as well. */
158 cg = g_malloc0(sizeof(struct sr_channel_group));
159 cg->name = g_strdup(channel_name);
160 cg->channels = g_slist_append(NULL, ch);
161 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
163 /* Every channel gets a generator struct. */
164 ag = g_malloc(sizeof(struct analog_gen));
165 ag->amplitude = DEFAULT_ANALOG_AMPLITUDE;
166 sr_analog_init(&ag->packet, &ag->encoding, &ag->meaning, &ag->spec, 2);
167 ag->packet.meaning->channels = cg->channels;
168 ag->packet.meaning->mq = 0;
169 ag->packet.meaning->mqflags = 0;
170 ag->packet.meaning->unit = SR_UNIT_VOLT;
171 ag->packet.data = ag->pattern_data;
172 ag->pattern = pattern;
175 g_hash_table_insert(devc->ch_ag, ch, ag);
177 if (++pattern == ARRAY_SIZE(analog_pattern_str))
184 return std_scan_complete(di, g_slist_append(NULL, sdi));
187 static int dev_open(struct sr_dev_inst *sdi)
189 sdi->status = SR_ST_ACTIVE;
194 static int dev_close(struct sr_dev_inst *sdi)
196 sdi->status = SR_ST_INACTIVE;
201 static void clear_helper(void *priv)
203 struct dev_context *devc;
209 /* Analog generators. */
210 g_hash_table_iter_init(&iter, devc->ch_ag);
211 while (g_hash_table_iter_next(&iter, NULL, &value))
213 g_hash_table_unref(devc->ch_ag);
217 static int dev_clear(const struct sr_dev_driver *di)
219 return std_dev_clear(di, clear_helper);
222 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
223 const struct sr_channel_group *cg)
225 struct dev_context *devc;
226 struct sr_channel *ch;
227 struct analog_gen *ag;
235 case SR_CONF_SAMPLERATE:
236 *data = g_variant_new_uint64(devc->cur_samplerate);
238 case SR_CONF_LIMIT_SAMPLES:
239 *data = g_variant_new_uint64(devc->limit_samples);
241 case SR_CONF_LIMIT_MSEC:
242 *data = g_variant_new_uint64(devc->limit_msec);
244 case SR_CONF_AVERAGING:
245 *data = g_variant_new_boolean(devc->avg);
247 case SR_CONF_AVG_SAMPLES:
248 *data = g_variant_new_uint64(devc->avg_samples);
250 case SR_CONF_PATTERN_MODE:
252 return SR_ERR_CHANNEL_GROUP;
253 /* Any channel in the group will do. */
254 ch = cg->channels->data;
255 if (ch->type == SR_CHANNEL_LOGIC) {
256 pattern = devc->logic_pattern;
257 *data = g_variant_new_string(logic_pattern_str[pattern]);
258 } else if (ch->type == SR_CHANNEL_ANALOG) {
259 ag = g_hash_table_lookup(devc->ch_ag, ch);
260 pattern = ag->pattern;
261 *data = g_variant_new_string(analog_pattern_str[pattern]);
265 case SR_CONF_AMPLITUDE:
267 return SR_ERR_CHANNEL_GROUP;
268 /* Any channel in the group will do. */
269 ch = cg->channels->data;
270 if (ch->type != SR_CHANNEL_ANALOG)
272 ag = g_hash_table_lookup(devc->ch_ag, ch);
273 *data = g_variant_new_double(ag->amplitude);
282 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
283 const struct sr_channel_group *cg)
285 struct dev_context *devc;
286 struct analog_gen *ag;
287 struct sr_channel *ch;
289 int logic_pattern, analog_pattern, ret;
295 if (sdi->status != SR_ST_ACTIVE)
296 return SR_ERR_DEV_CLOSED;
300 case SR_CONF_SAMPLERATE:
301 devc->cur_samplerate = g_variant_get_uint64(data);
303 case SR_CONF_LIMIT_SAMPLES:
304 devc->limit_msec = 0;
305 devc->limit_samples = g_variant_get_uint64(data);
307 case SR_CONF_LIMIT_MSEC:
308 devc->limit_msec = g_variant_get_uint64(data);
309 devc->limit_samples = 0;
311 case SR_CONF_AVERAGING:
312 devc->avg = g_variant_get_boolean(data);
313 sr_dbg("%s averaging", devc->avg ? "Enabling" : "Disabling");
315 case SR_CONF_AVG_SAMPLES:
316 devc->avg_samples = g_variant_get_uint64(data);
317 sr_dbg("Setting averaging rate to %" PRIu64, devc->avg_samples);
319 case SR_CONF_PATTERN_MODE:
321 return SR_ERR_CHANNEL_GROUP;
322 stropt = g_variant_get_string(data, NULL);
323 logic_pattern = analog_pattern = -1;
324 for (i = 0; i < ARRAY_SIZE(logic_pattern_str); i++) {
325 if (!strcmp(stropt, logic_pattern_str[i])) {
330 for (i = 0; i < ARRAY_SIZE(analog_pattern_str); i++) {
331 if (!strcmp(stropt, analog_pattern_str[i])) {
336 if (logic_pattern == -1 && analog_pattern == -1)
338 for (l = cg->channels; l; l = l->next) {
340 if (ch->type == SR_CHANNEL_LOGIC) {
341 if (logic_pattern == -1)
343 sr_dbg("Setting logic pattern to %s",
344 logic_pattern_str[logic_pattern]);
345 devc->logic_pattern = logic_pattern;
346 /* Might as well do this now, these are static. */
347 if (logic_pattern == PATTERN_ALL_LOW)
348 memset(devc->logic_data, 0x00, LOGIC_BUFSIZE);
349 else if (logic_pattern == PATTERN_ALL_HIGH)
350 memset(devc->logic_data, 0xff, LOGIC_BUFSIZE);
351 } else if (ch->type == SR_CHANNEL_ANALOG) {
352 if (analog_pattern == -1)
354 sr_dbg("Setting analog pattern for channel %s to %s",
355 ch->name, analog_pattern_str[analog_pattern]);
356 ag = g_hash_table_lookup(devc->ch_ag, ch);
357 ag->pattern = analog_pattern;
362 case SR_CONF_AMPLITUDE:
364 return SR_ERR_CHANNEL_GROUP;
365 for (l = cg->channels; l; l = l->next) {
367 if (ch->type != SR_CHANNEL_ANALOG)
369 ag = g_hash_table_lookup(devc->ch_ag, ch);
370 ag->amplitude = g_variant_get_double(data);
380 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
381 const struct sr_channel_group *cg)
383 struct sr_channel *ch;
387 if (key == SR_CONF_SCAN_OPTIONS) {
388 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
389 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
393 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
394 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
395 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
404 case SR_CONF_DEVICE_OPTIONS:
405 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
406 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
408 case SR_CONF_SAMPLERATE:
409 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
410 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
411 ARRAY_SIZE(samplerates), sizeof(uint64_t));
412 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
413 *data = g_variant_builder_end(&gvb);
419 ch = cg->channels->data;
421 case SR_CONF_DEVICE_OPTIONS:
422 if (ch->type == SR_CHANNEL_LOGIC)
423 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
424 devopts_cg_logic, ARRAY_SIZE(devopts_cg_logic),
426 else if (ch->type == SR_CHANNEL_ANALOG) {
427 if (strcmp(cg->name, "Analog") == 0)
428 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
429 devopts_cg_analog_group, ARRAY_SIZE(devopts_cg_analog_group),
432 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
433 devopts_cg_analog_channel, ARRAY_SIZE(devopts_cg_analog_channel),
439 case SR_CONF_PATTERN_MODE:
440 /* The analog group (with all 4 channels) shall not have a pattern property. */
441 if (strcmp(cg->name, "Analog") == 0)
444 if (ch->type == SR_CHANNEL_LOGIC)
445 *data = g_variant_new_strv(logic_pattern_str,
446 ARRAY_SIZE(logic_pattern_str));
447 else if (ch->type == SR_CHANNEL_ANALOG)
448 *data = g_variant_new_strv(analog_pattern_str,
449 ARRAY_SIZE(analog_pattern_str));
461 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
463 struct dev_context *devc;
467 if (sdi->status != SR_ST_ACTIVE)
468 return SR_ERR_DEV_CLOSED;
471 devc->sent_samples = 0;
473 g_hash_table_iter_init(&iter, devc->ch_ag);
474 while (g_hash_table_iter_next(&iter, NULL, &value))
475 demo_generate_analog_pattern(value, devc->cur_samplerate);
477 sr_session_source_add(sdi->session, -1, 0, 100,
478 demo_prepare_data, (struct sr_dev_inst *)sdi);
480 std_session_send_df_header(sdi);
482 /* We use this timestamp to decide how many more samples to send. */
483 devc->start_us = g_get_monotonic_time();
490 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
492 sr_dbg("Stopping acquisition.");
493 sr_session_source_remove(sdi->session, -1);
494 std_session_send_df_end(sdi);
499 static struct sr_dev_driver demo_driver_info = {
501 .longname = "Demo driver and pattern generator",
504 .cleanup = std_cleanup,
506 .dev_list = std_dev_list,
507 .dev_clear = dev_clear,
508 .config_get = config_get,
509 .config_set = config_set,
510 .config_list = config_list,
511 .dev_open = dev_open,
512 .dev_close = dev_close,
513 .dev_acquisition_start = dev_acquisition_start,
514 .dev_acquisition_stop = dev_acquisition_stop,
517 SR_REGISTER_DEV_DRIVER(demo_driver_info);