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_NUM_ANALOG_CHANNELS 4
34 #define DEFAULT_ANALOG_AMPLITUDE 10
36 static const char *logic_pattern_str[] = {
45 static const uint32_t drvopts[] = {
47 SR_CONF_LOGIC_ANALYZER,
51 static const uint32_t scanopts[] = {
52 SR_CONF_NUM_LOGIC_CHANNELS,
53 SR_CONF_NUM_ANALOG_CHANNELS,
56 static const uint32_t devopts[] = {
58 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
59 SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
60 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
61 SR_CONF_AVERAGING | SR_CONF_GET | SR_CONF_SET,
62 SR_CONF_AVG_SAMPLES | SR_CONF_GET | SR_CONF_SET,
65 static const uint32_t devopts_cg_logic[] = {
66 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
69 static const uint32_t devopts_cg_analog_group[] = {
70 SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
73 static const uint32_t devopts_cg_analog_channel[] = {
74 SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
75 SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
78 static const uint64_t samplerates[] = {
84 static GSList *scan(struct sr_dev_driver *di, GSList *options)
86 struct dev_context *devc;
87 struct sr_dev_inst *sdi;
88 struct sr_channel *ch;
89 struct sr_channel_group *cg, *acg;
90 struct sr_config *src;
91 struct analog_gen *ag;
93 int num_logic_channels, num_analog_channels, pattern, i;
94 char channel_name[16];
96 num_logic_channels = DEFAULT_NUM_LOGIC_CHANNELS;
97 num_analog_channels = DEFAULT_NUM_ANALOG_CHANNELS;
98 for (l = options; l; l = l->next) {
101 case SR_CONF_NUM_LOGIC_CHANNELS:
102 num_logic_channels = g_variant_get_int32(src->data);
104 case SR_CONF_NUM_ANALOG_CHANNELS:
105 num_analog_channels = g_variant_get_int32(src->data);
110 sdi = g_malloc0(sizeof(struct sr_dev_inst));
111 sdi->status = SR_ST_INACTIVE;
112 sdi->model = g_strdup("Demo device");
114 devc = g_malloc0(sizeof(struct dev_context));
115 devc->cur_samplerate = SR_KHZ(200);
116 devc->num_logic_channels = num_logic_channels;
117 devc->logic_unitsize = (devc->num_logic_channels + 7) / 8;
118 devc->logic_pattern = PATTERN_SIGROK;
119 devc->num_analog_channels = num_analog_channels;
121 if (num_logic_channels > 0) {
122 /* Logic channels, all in one channel group. */
123 cg = g_malloc0(sizeof(struct sr_channel_group));
124 cg->name = g_strdup("Logic");
125 for (i = 0; i < num_logic_channels; i++) {
126 sprintf(channel_name, "D%d", i);
127 ch = sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name);
128 cg->channels = g_slist_append(cg->channels, ch);
130 sdi->channel_groups = g_slist_append(NULL, cg);
133 /* Analog channels, channel groups and pattern generators. */
134 if (num_analog_channels > 0) {
136 /* An "Analog" channel group with all analog channels in it. */
137 acg = g_malloc0(sizeof(struct sr_channel_group));
138 acg->name = g_strdup("Analog");
139 sdi->channel_groups = g_slist_append(sdi->channel_groups, acg);
141 devc->ch_ag = g_hash_table_new(g_direct_hash, g_direct_equal);
142 for (i = 0; i < num_analog_channels; i++) {
143 snprintf(channel_name, 16, "A%d", i);
144 ch = sr_channel_new(sdi, i + num_logic_channels, SR_CHANNEL_ANALOG,
146 acg->channels = g_slist_append(acg->channels, ch);
148 /* Every analog channel gets its own channel group as well. */
149 cg = g_malloc0(sizeof(struct sr_channel_group));
150 cg->name = g_strdup(channel_name);
151 cg->channels = g_slist_append(NULL, ch);
152 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
154 /* Every channel gets a generator struct. */
155 ag = g_malloc(sizeof(struct analog_gen));
156 ag->amplitude = DEFAULT_ANALOG_AMPLITUDE;
157 sr_analog_init(&ag->packet, &ag->encoding, &ag->meaning, &ag->spec, 2);
158 ag->packet.meaning->channels = cg->channels;
159 ag->packet.meaning->mq = 0;
160 ag->packet.meaning->mqflags = 0;
161 ag->packet.meaning->unit = SR_UNIT_VOLT;
162 ag->packet.data = ag->pattern_data;
163 ag->pattern = pattern;
166 g_hash_table_insert(devc->ch_ag, ch, ag);
168 if (++pattern == ARRAY_SIZE(analog_pattern_str))
175 return std_scan_complete(di, g_slist_append(NULL, sdi));
178 static int dev_open(struct sr_dev_inst *sdi)
180 sdi->status = SR_ST_ACTIVE;
185 static int dev_close(struct sr_dev_inst *sdi)
187 sdi->status = SR_ST_INACTIVE;
192 static void clear_helper(void *priv)
194 struct dev_context *devc;
200 /* Analog generators. */
201 g_hash_table_iter_init(&iter, devc->ch_ag);
202 while (g_hash_table_iter_next(&iter, NULL, &value))
204 g_hash_table_unref(devc->ch_ag);
208 static int dev_clear(const struct sr_dev_driver *di)
210 return std_dev_clear(di, clear_helper);
213 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
214 const struct sr_channel_group *cg)
216 struct dev_context *devc;
217 struct sr_channel *ch;
218 struct analog_gen *ag;
226 case SR_CONF_SAMPLERATE:
227 *data = g_variant_new_uint64(devc->cur_samplerate);
229 case SR_CONF_LIMIT_SAMPLES:
230 *data = g_variant_new_uint64(devc->limit_samples);
232 case SR_CONF_LIMIT_MSEC:
233 *data = g_variant_new_uint64(devc->limit_msec);
235 case SR_CONF_AVERAGING:
236 *data = g_variant_new_boolean(devc->avg);
238 case SR_CONF_AVG_SAMPLES:
239 *data = g_variant_new_uint64(devc->avg_samples);
241 case SR_CONF_PATTERN_MODE:
243 return SR_ERR_CHANNEL_GROUP;
244 /* Any channel in the group will do. */
245 ch = cg->channels->data;
246 if (ch->type == SR_CHANNEL_LOGIC) {
247 pattern = devc->logic_pattern;
248 *data = g_variant_new_string(logic_pattern_str[pattern]);
249 } else if (ch->type == SR_CHANNEL_ANALOG) {
250 ag = g_hash_table_lookup(devc->ch_ag, ch);
251 pattern = ag->pattern;
252 *data = g_variant_new_string(analog_pattern_str[pattern]);
256 case SR_CONF_AMPLITUDE:
258 return SR_ERR_CHANNEL_GROUP;
259 /* Any channel in the group will do. */
260 ch = cg->channels->data;
261 if (ch->type != SR_CHANNEL_ANALOG)
263 ag = g_hash_table_lookup(devc->ch_ag, ch);
264 *data = g_variant_new_double(ag->amplitude);
273 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
274 const struct sr_channel_group *cg)
276 struct dev_context *devc;
277 struct analog_gen *ag;
278 struct sr_channel *ch;
280 int logic_pattern, analog_pattern, ret;
286 if (sdi->status != SR_ST_ACTIVE)
287 return SR_ERR_DEV_CLOSED;
291 case SR_CONF_SAMPLERATE:
292 devc->cur_samplerate = g_variant_get_uint64(data);
294 case SR_CONF_LIMIT_SAMPLES:
295 devc->limit_msec = 0;
296 devc->limit_samples = g_variant_get_uint64(data);
298 case SR_CONF_LIMIT_MSEC:
299 devc->limit_msec = g_variant_get_uint64(data);
300 devc->limit_samples = 0;
302 case SR_CONF_AVERAGING:
303 devc->avg = g_variant_get_boolean(data);
304 sr_dbg("%s averaging", devc->avg ? "Enabling" : "Disabling");
306 case SR_CONF_AVG_SAMPLES:
307 devc->avg_samples = g_variant_get_uint64(data);
308 sr_dbg("Setting averaging rate to %" PRIu64, devc->avg_samples);
310 case SR_CONF_PATTERN_MODE:
312 return SR_ERR_CHANNEL_GROUP;
313 stropt = g_variant_get_string(data, NULL);
314 logic_pattern = analog_pattern = -1;
315 for (i = 0; i < ARRAY_SIZE(logic_pattern_str); i++) {
316 if (!strcmp(stropt, logic_pattern_str[i])) {
321 for (i = 0; i < ARRAY_SIZE(analog_pattern_str); i++) {
322 if (!strcmp(stropt, analog_pattern_str[i])) {
327 if (logic_pattern == -1 && analog_pattern == -1)
329 for (l = cg->channels; l; l = l->next) {
331 if (ch->type == SR_CHANNEL_LOGIC) {
332 if (logic_pattern == -1)
334 sr_dbg("Setting logic pattern to %s",
335 logic_pattern_str[logic_pattern]);
336 devc->logic_pattern = logic_pattern;
337 /* Might as well do this now, these are static. */
338 if (logic_pattern == PATTERN_ALL_LOW)
339 memset(devc->logic_data, 0x00, LOGIC_BUFSIZE);
340 else if (logic_pattern == PATTERN_ALL_HIGH)
341 memset(devc->logic_data, 0xff, LOGIC_BUFSIZE);
342 } else if (ch->type == SR_CHANNEL_ANALOG) {
343 if (analog_pattern == -1)
345 sr_dbg("Setting analog pattern for channel %s to %s",
346 ch->name, analog_pattern_str[analog_pattern]);
347 ag = g_hash_table_lookup(devc->ch_ag, ch);
348 ag->pattern = analog_pattern;
353 case SR_CONF_AMPLITUDE:
355 return SR_ERR_CHANNEL_GROUP;
356 for (l = cg->channels; l; l = l->next) {
358 if (ch->type != SR_CHANNEL_ANALOG)
360 ag = g_hash_table_lookup(devc->ch_ag, ch);
361 ag->amplitude = g_variant_get_double(data);
371 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
372 const struct sr_channel_group *cg)
374 struct sr_channel *ch;
378 if (key == SR_CONF_SCAN_OPTIONS) {
379 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
380 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
384 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
385 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
386 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
395 case SR_CONF_DEVICE_OPTIONS:
396 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
397 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
399 case SR_CONF_SAMPLERATE:
400 g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
401 gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
402 ARRAY_SIZE(samplerates), sizeof(uint64_t));
403 g_variant_builder_add(&gvb, "{sv}", "samplerate-steps", gvar);
404 *data = g_variant_builder_end(&gvb);
410 ch = cg->channels->data;
412 case SR_CONF_DEVICE_OPTIONS:
413 if (ch->type == SR_CHANNEL_LOGIC)
414 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
415 devopts_cg_logic, ARRAY_SIZE(devopts_cg_logic),
417 else if (ch->type == SR_CHANNEL_ANALOG) {
418 if (strcmp(cg->name, "Analog") == 0)
419 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
420 devopts_cg_analog_group, ARRAY_SIZE(devopts_cg_analog_group),
423 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
424 devopts_cg_analog_channel, ARRAY_SIZE(devopts_cg_analog_channel),
430 case SR_CONF_PATTERN_MODE:
431 /* The analog group (with all 4 channels) shall not have a pattern property. */
432 if (strcmp(cg->name, "Analog") == 0)
435 if (ch->type == SR_CHANNEL_LOGIC)
436 *data = g_variant_new_strv(logic_pattern_str,
437 ARRAY_SIZE(logic_pattern_str));
438 else if (ch->type == SR_CHANNEL_ANALOG)
439 *data = g_variant_new_strv(analog_pattern_str,
440 ARRAY_SIZE(analog_pattern_str));
452 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
454 struct dev_context *devc;
458 if (sdi->status != SR_ST_ACTIVE)
459 return SR_ERR_DEV_CLOSED;
462 devc->sent_samples = 0;
464 g_hash_table_iter_init(&iter, devc->ch_ag);
465 while (g_hash_table_iter_next(&iter, NULL, &value))
466 demo_generate_analog_pattern(value, devc->cur_samplerate);
468 sr_session_source_add(sdi->session, -1, 0, 100,
469 demo_prepare_data, (struct sr_dev_inst *)sdi);
471 std_session_send_df_header(sdi);
473 /* We use this timestamp to decide how many more samples to send. */
474 devc->start_us = g_get_monotonic_time();
481 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
483 sr_dbg("Stopping acquisition.");
484 sr_session_source_remove(sdi->session, -1);
485 std_session_send_df_end(sdi);
490 static struct sr_dev_driver demo_driver_info = {
492 .longname = "Demo driver and pattern generator",
495 .cleanup = std_cleanup,
497 .dev_list = std_dev_list,
498 .dev_clear = dev_clear,
499 .config_get = config_get,
500 .config_set = config_set,
501 .config_list = config_list,
502 .dev_open = dev_open,
503 .dev_close = dev_close,
504 .dev_acquisition_start = dev_acquisition_start,
505 .dev_acquisition_stop = dev_acquisition_stop,
508 SR_REGISTER_DEV_DRIVER(demo_driver_info);