2 * This file is part of the sigrok-cli project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include <glib/gstdio.h>
25 #include "sigrok-cli.h"
27 static uint64_t limit_samples = 0;
28 static uint64_t limit_frames = 0;
31 extern struct srd_session *srd_sess;
34 static int set_limit_time(const struct sr_dev_inst *sdi)
39 struct sr_dev_driver *driver;
41 driver = sr_dev_inst_driver_get(sdi);
43 if (!(time_msec = sr_parse_timestring(opt_time))) {
44 g_critical("Invalid time '%s'", opt_time);
48 if (sr_dev_config_capabilities_list(sdi, NULL, SR_CONF_LIMIT_MSEC)
50 gvar = g_variant_new_uint64(time_msec);
51 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) {
52 g_critical("Failed to configure time limit.");
55 } else if (sr_dev_config_capabilities_list(sdi, NULL, SR_CONF_SAMPLERATE)
56 & (SR_CONF_GET | SR_CONF_SET)) {
57 /* Convert to samples based on the samplerate. */
58 sr_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar);
59 samplerate = g_variant_get_uint64(gvar);
60 g_variant_unref(gvar);
61 limit_samples = (samplerate) * time_msec / (uint64_t)1000;
62 if (limit_samples == 0) {
63 g_critical("Not enough time at this samplerate.");
66 gvar = g_variant_new_uint64(limit_samples);
67 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
68 g_critical("Failed to configure time-based sample limit.");
72 g_critical("This device does not support time limits.");
79 const struct sr_output *setup_output_format(const struct sr_dev_inst *sdi, FILE **outfile)
81 const struct sr_output_module *omod;
82 const struct sr_option **options;
83 const struct sr_output *o;
84 GHashTable *fmtargs, *fmtopts;
87 if (!opt_output_format) {
88 if (opt_output_file) {
89 opt_output_format = DEFAULT_OUTPUT_FORMAT_FILE;
91 opt_output_format = DEFAULT_OUTPUT_FORMAT_NOFILE;
95 fmtargs = parse_generic_arg(opt_output_format, TRUE);
96 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
98 g_critical("Invalid output format.");
99 if (!(omod = sr_output_find(fmtspec)))
100 g_critical("Unknown output module '%s'.", fmtspec);
101 g_hash_table_remove(fmtargs, "sigrok_key");
102 if ((options = sr_output_options_get(omod))) {
103 fmtopts = generic_arg_to_opt(options, fmtargs);
104 sr_output_options_free(options);
107 o = sr_output_new(omod, fmtopts, sdi, opt_output_file);
109 if (opt_output_file) {
110 if (!sr_output_test_flag(omod, SR_OUTPUT_INTERNAL_IO_HANDLING))
111 *outfile = g_fopen(opt_output_file, "wb");
119 g_hash_table_destroy(fmtopts);
120 g_hash_table_destroy(fmtargs);
125 const struct sr_transform *setup_transform_module(const struct sr_dev_inst *sdi)
127 const struct sr_transform_module *tmod;
128 const struct sr_option **options;
129 const struct sr_transform *t;
130 GHashTable *fmtargs, *fmtopts;
133 fmtargs = parse_generic_arg(opt_transform_module, TRUE);
134 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
136 g_critical("Invalid transform module.");
137 if (!(tmod = sr_transform_find(fmtspec)))
138 g_critical("Unknown transform module '%s'.", fmtspec);
139 g_hash_table_remove(fmtargs, "sigrok_key");
140 if ((options = sr_transform_options_get(tmod))) {
141 fmtopts = generic_arg_to_opt(options, fmtargs);
142 sr_transform_options_free(options);
145 t = sr_transform_new(tmod, fmtopts, sdi);
147 g_hash_table_destroy(fmtopts);
148 g_hash_table_destroy(fmtargs);
153 /* Get the input stream's list of channels and their types, once. */
154 static void props_get_channels(struct df_arg_desc *args,
155 const struct sr_dev_inst *sdi)
157 struct input_stream_props *props;
159 const struct sr_channel *ch;
163 props = &args->props;
167 props->channels = g_slist_copy(sr_dev_inst_channels_get(sdi));
168 if (!props->channels)
170 for (l = props->channels; l; l = l->next) {
174 if (ch->type != SR_CHANNEL_ANALOG)
176 props->first_analog_channel = ch;
181 static gboolean props_chk_1st_channel(struct df_arg_desc *args,
182 const struct sr_datafeed_analog *analog)
184 struct sr_channel *ch;
186 if (!args || !analog || !analog->meaning)
188 ch = g_slist_nth_data(analog->meaning->channels, 0);
191 return ch == args->props.first_analog_channel;
194 static void props_dump_details(struct df_arg_desc *args)
196 struct input_stream_props *props;
199 const struct sr_channel *ch;
204 props = &args->props;
205 if (props->samplerate)
206 printf("Samplerate: %" PRIu64 "\n", props->samplerate);
207 if (props->channels) {
208 ch_count = g_slist_length(props->channels);
209 printf("Channels: %zu\n", ch_count);
210 for (l = props->channels; l; l = l->next) {
212 if (ch->type == SR_CHANNEL_ANALOG)
216 printf("- %s: %s\n", ch->name, type);
220 printf("Logic unitsize: %zu\n", props->unitsize);
221 if (props->sample_count_logic)
222 printf("Logic sample count: %" PRIu64 "\n", props->sample_count_logic);
223 if (props->sample_count_analog)
224 printf("Analog sample count: %" PRIu64 "\n", props->sample_count_analog);
225 if (props->frame_count)
226 printf("Frame count: %" PRIu64 "\n", props->frame_count);
227 if (props->triggered)
228 printf("Trigger count: %" PRIu64 "\n", props->triggered);
231 static void props_cleanup(struct df_arg_desc *args)
233 struct input_stream_props *props;
237 props = &args->props;
238 g_slist_free(props->channels);
239 props->channels = NULL;
240 props->first_analog_channel = NULL;
243 void datafeed_in(const struct sr_dev_inst *sdi,
244 const struct sr_datafeed_packet *packet, void *cb_data)
246 static const struct sr_output *o = NULL;
247 static const struct sr_output *oa = NULL;
248 static uint64_t rcvd_samples_logic = 0;
249 static uint64_t rcvd_samples_analog = 0;
250 static uint64_t samplerate = 0;
251 static int triggered = 0;
252 static FILE *outfile = NULL;
254 const struct sr_datafeed_meta *meta;
255 const struct sr_datafeed_logic *logic;
256 const struct sr_datafeed_analog *analog;
257 struct df_arg_desc *df_arg;
259 struct input_stream_props *props;
260 struct sr_session *session;
261 struct sr_config *src;
267 struct sr_dev_driver *driver;
269 /* Avoid warnings when building without decoder support. */
273 driver = sr_dev_inst_driver_get(sdi);
275 /* Skip all packets before the first header. */
276 if (packet->type != SR_DF_HEADER && !o)
279 /* Prepare to either process data, or "just" gather properties. */
281 session = df_arg->session;
282 do_props = df_arg->do_props;
283 props = &df_arg->props;
285 switch (packet->type) {
287 g_debug("cli: Received SR_DF_HEADER.");
288 if (maybe_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE,
290 samplerate = g_variant_get_uint64(gvar);
291 g_variant_unref(gvar);
294 /* Setup variables for maximum code path re-use. */
297 /* Start collecting input stream properties. */
298 memset(props, 0, sizeof(*props));
299 props->samplerate = samplerate;
300 props_get_channels(df_arg, sdi);
303 if (!(o = setup_output_format(sdi, &outfile)))
304 g_critical("Failed to initialize output module.");
306 /* Set up backup analog output module. */
308 oa = sr_output_new(sr_output_find("analog"), NULL,
311 rcvd_samples_logic = rcvd_samples_analog = 0;
316 if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
317 g_variant_new_uint64(samplerate)) != SRD_OK) {
318 g_critical("Failed to configure decode session.");
322 if (srd_session_start(srd_sess) != SRD_OK) {
323 g_critical("Failed to start decode session.");
331 g_debug("cli: Received SR_DF_META.");
332 meta = packet->payload;
333 for (l = meta->config; l; l = l->next) {
336 case SR_CONF_SAMPLERATE:
337 samplerate = g_variant_get_uint64(src->data);
338 g_debug("cli: Got samplerate %"PRIu64" Hz.", samplerate);
340 props->samplerate = samplerate;
345 if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
346 g_variant_new_uint64(samplerate)) != SRD_OK) {
347 g_critical("Failed to pass samplerate to decoder.");
352 case SR_CONF_SAMPLE_INTERVAL:
353 samplerate = g_variant_get_uint64(src->data);
354 g_debug("cli: Got sample interval %"PRIu64" ms.", samplerate);
356 props->samplerate = samplerate;
361 /* Unknown metadata is not an error. */
368 g_debug("cli: Received SR_DF_TRIGGER.");
377 logic = packet->payload;
378 g_message("cli: Received SR_DF_LOGIC (%"PRIu64" bytes, unitsize = %d).",
379 logic->length, logic->unitsize);
380 if (logic->length == 0)
384 props_get_channels(df_arg, sdi);
385 props->unitsize = logic->unitsize;
386 props->sample_count_logic += logic->length / logic->unitsize;
390 /* Don't store any samples until triggered. */
391 if (opt_wait_trigger && !triggered)
394 if (limit_samples && rcvd_samples_logic >= limit_samples)
397 end_sample = rcvd_samples_logic + logic->length / logic->unitsize;
398 /* Cut off last packet according to the sample limit. */
399 if (limit_samples && end_sample > limit_samples)
400 end_sample = limit_samples;
401 input_len = (end_sample - rcvd_samples_logic) * logic->unitsize;
405 if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample,
406 logic->data, input_len, logic->unitsize) != SRD_OK)
407 sr_session_stop(session);
411 rcvd_samples_logic = end_sample;
415 analog = packet->payload;
416 g_message("cli: Received SR_DF_ANALOG (%d samples).", analog->num_samples);
417 if (analog->num_samples == 0)
421 /* Only count the first analog channel. */
422 props_get_channels(df_arg, sdi);
423 if (!props_chk_1st_channel(df_arg, analog))
425 props->sample_count_analog += analog->num_samples;
429 if (limit_samples && rcvd_samples_analog >= limit_samples)
432 rcvd_samples_analog += analog->num_samples;
435 case SR_DF_FRAME_BEGIN:
436 g_debug("cli: Received SR_DF_FRAME_BEGIN.");
439 case SR_DF_FRAME_END:
440 g_debug("cli: Received SR_DF_FRAME_END.");
442 props->frame_count++;
451 if (!do_props && o && !opt_pds) {
452 if (sr_output_send(o, packet, &out) == SR_OK) {
455 * The user didn't specify an output module,
456 * but needs to see this analog data.
458 sr_output_send(oa, packet, &out);
460 if (outfile && out && out->len > 0) {
461 fwrite(out->str, 1, out->len, outfile);
465 g_string_free(out, TRUE);
470 * SR_DF_END needs to be handled after the output module's receive()
471 * is called, so it can properly clean up that module.
473 if (packet->type == SR_DF_END) {
474 g_debug("cli: Received SR_DF_END.");
477 props_dump_details(df_arg);
478 props_cleanup(df_arg);
490 if (outfile && outfile != stdout)
494 if (rcvd_samples_logic > 0 && rcvd_samples_logic < limit_samples)
495 g_warning("Device only sent %" PRIu64 " samples.",
497 else if (rcvd_samples_analog > 0 && rcvd_samples_analog < limit_samples)
498 g_warning("Device only sent %" PRIu64 " samples.",
499 rcvd_samples_analog);
505 int opt_to_gvar(char *key, char *value, struct sr_config *src)
507 const struct sr_key_info *srci, *srmqi;
508 double tmp_double, dlow, dhigh;
509 uint64_t tmp_u64, p, q, low, high, mqflags;
511 GVariant *rational[2], *range[2], *gtup[2];
512 GVariantBuilder *vbl;
517 if (!(srci = sr_key_info_name_get(SR_KEY_CONFIG, key))) {
518 g_critical("Unknown device option '%s'.", (char *) key);
521 src->key = srci->key;
523 if ((!value || strlen(value) == 0) &&
524 (srci->datatype != SR_T_BOOL)) {
525 g_critical("Option '%s' needs a value.", (char *)key);
530 switch (srci->datatype) {
532 ret = sr_parse_sizestring(value, &tmp_u64);
535 src->data = g_variant_new_uint64(tmp_u64);
538 ret = sr_parse_sizestring(value, &tmp_u64);
541 src->data = g_variant_new_int32(tmp_u64);
544 src->data = g_variant_new_string(value);
550 tmp_bool = sr_parse_boolstring(value);
551 src->data = g_variant_new_boolean(tmp_bool);
554 tmp_double = strtof(value, NULL);
555 src->data = g_variant_new_double(tmp_double);
557 case SR_T_RATIONAL_PERIOD:
558 if ((ret = sr_parse_period(value, &p, &q)) != SR_OK)
560 rational[0] = g_variant_new_uint64(p);
561 rational[1] = g_variant_new_uint64(q);
562 src->data = g_variant_new_tuple(rational, 2);
564 case SR_T_RATIONAL_VOLT:
565 if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK)
567 rational[0] = g_variant_new_uint64(p);
568 rational[1] = g_variant_new_uint64(q);
569 src->data = g_variant_new_tuple(rational, 2);
571 case SR_T_UINT64_RANGE:
572 if (sscanf(value, "%"PRIu64"-%"PRIu64, &low, &high) != 2) {
576 range[0] = g_variant_new_uint64(low);
577 range[1] = g_variant_new_uint64(high);
578 src->data = g_variant_new_tuple(range, 2);
581 case SR_T_DOUBLE_RANGE:
582 if (sscanf(value, "%lf-%lf", &dlow, &dhigh) != 2) {
586 range[0] = g_variant_new_double(dlow);
587 range[1] = g_variant_new_double(dhigh);
588 src->data = g_variant_new_tuple(range, 2);
592 /* Expects the argument to be in the form of key=value. */
593 keyval = g_strsplit(value, "=", 2);
594 if (!keyval[0] || !keyval[1]) {
599 vbl = g_variant_builder_new(G_VARIANT_TYPE_DICTIONARY);
600 g_variant_builder_add(vbl, "{ss}",
601 keyval[0], keyval[1]);
602 src->data = g_variant_builder_end(vbl);
608 Argument is MQ id e.g. ("voltage") optionally followed by one
609 or more /<mqflag> e.g. "/ac".
611 keyval = g_strsplit(value, "/", 0);
612 if (!keyval[0] || !(srmqi = sr_key_info_name_get(SR_KEY_MQ, keyval[0]))) {
619 for (i = 1; keyval[i]; i++) {
620 if (!(srmqi = sr_key_info_name_get(SR_KEY_MQFLAGS, keyval[i]))) {
624 mqflags |= srmqi->key;
628 gtup[0] = g_variant_new_uint32(mq);
629 gtup[1] = g_variant_new_uint64(mqflags);
630 src->data = g_variant_new_tuple(gtup, 2);
634 g_critical("Unknown data type specified for option '%s' "
635 "(driver implementation bug?).", key);
640 g_critical("Invalid value: '%s' for option '%s'", value, key);
645 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
647 struct sr_config src;
648 struct sr_channel_group *cg;
653 g_hash_table_iter_init(&iter, args);
654 while (g_hash_table_iter_next(&iter, &key, &value)) {
655 if ((ret = opt_to_gvar(key, value, &src)) != 0)
657 cg = select_channel_group(sdi);
658 if ((ret = maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, cg,
659 src.key, src.data)) != SR_OK) {
660 g_critical("Failed to set device option '%s': %s.",
661 (char *)key, sr_strerror(ret));
669 void run_session(void)
671 struct df_arg_desc df_arg;
672 GSList *devices, *real_devices, *sd;
675 struct sr_session *session;
676 struct sr_trigger *trigger;
677 struct sr_dev_inst *sdi;
678 uint64_t min_samples, max_samples;
682 struct sr_dev_driver *driver;
683 const struct sr_transform *t;
684 GMainLoop *main_loop;
686 memset(&df_arg, 0, sizeof(df_arg));
687 df_arg.do_props = FALSE;
689 devices = device_scan();
691 g_critical("No devices found.");
696 for (sd = devices; sd; sd = sd->next) {
699 driver = sr_dev_inst_driver_get(sdi);
701 if (!(drv_opts = sr_dev_options(driver, NULL, NULL))) {
702 g_critical("Failed to query list of driver options.");
707 for (i = 0; i < drv_opts->len; i++) {
708 if (g_array_index(drv_opts, uint32_t, i) == SR_CONF_DEMO_DEV)
712 g_array_free(drv_opts, TRUE);
715 real_devices = g_slist_append(real_devices, sdi);
718 if (g_slist_length(devices) > 1) {
719 if (g_slist_length(real_devices) != 1) {
720 g_critical("sigrok-cli only supports one device for capturing.");
723 /* We only have one non-demo device. */
724 g_slist_free(devices);
725 devices = real_devices;
730 /* This is unlikely to happen but it makes static analyzers stop complaining. */
732 g_critical("No real devices found.");
737 g_slist_free(devices);
738 g_slist_free(real_devices);
740 sr_session_new(sr_ctx, &session);
741 df_arg.session = session;
742 sr_session_datafeed_callback_add(session, datafeed_in, &df_arg);
743 df_arg.session = NULL;
745 if (sr_dev_open(sdi) != SR_OK) {
746 g_critical("Failed to open device.");
750 if (sr_session_dev_add(session, sdi) != SR_OK) {
751 g_critical("Failed to add device to session.");
752 sr_session_destroy(session);
757 if ((devargs = parse_generic_arg(opt_config, FALSE))) {
758 if (set_dev_options(sdi, devargs) != SR_OK)
760 g_hash_table_destroy(devargs);
764 if (select_channels(sdi) != SR_OK) {
765 g_critical("Failed to set channels.");
766 sr_session_destroy(session);
772 if (!parse_triggerstring(sdi, opt_triggers, &trigger)) {
773 sr_session_destroy(session);
776 if (sr_session_trigger_set(session, trigger) != SR_OK) {
777 sr_session_destroy(session);
782 if (opt_continuous) {
783 if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) {
784 g_critical("This device does not support continuous sampling.");
785 sr_session_destroy(session);
791 if (set_limit_time(sdi) != SR_OK) {
792 sr_session_destroy(session);
798 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) {
799 g_critical("Invalid sample limit '%s'.", opt_samples);
800 sr_session_destroy(session);
803 if (maybe_config_list(driver, sdi, NULL, SR_CONF_LIMIT_SAMPLES,
806 * The device has no compression, or compression is turned
807 * off, and publishes its sample memory size.
809 g_variant_get(gvar, "(tt)", &min_samples, &max_samples);
810 g_variant_unref(gvar);
811 if (limit_samples < min_samples) {
812 g_critical("The device stores at least %"PRIu64
813 " samples with the current settings.", min_samples);
815 if (limit_samples > max_samples) {
816 g_critical("The device can store only %"PRIu64
817 " samples with the current settings.", max_samples);
820 gvar = g_variant_new_uint64(limit_samples);
821 if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
822 g_critical("Failed to configure sample limit.");
823 sr_session_destroy(session);
829 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) {
830 g_critical("Invalid frame limit '%s'.", opt_frames);
831 sr_session_destroy(session);
834 gvar = g_variant_new_uint64(limit_frames);
835 if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
836 g_critical("Failed to configure frame limit.");
837 sr_session_destroy(session);
842 if (opt_transform_module) {
843 if (!(t = setup_transform_module(sdi)))
844 g_critical("Failed to initialize transform module.");
847 main_loop = g_main_loop_new(NULL, FALSE);
849 sr_session_stopped_callback_set(session,
850 (sr_session_stopped_callback)g_main_loop_quit, main_loop);
852 if (sr_session_start(session) != SR_OK) {
853 g_critical("Failed to start session.");
854 g_main_loop_unref(main_loop);
855 sr_session_destroy(session);
862 g_main_loop_run(main_loop);
868 sr_trigger_free(trigger);
870 sr_session_datafeed_callback_remove_all(session);
871 g_main_loop_unref(main_loop);
872 sr_session_destroy(session);