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");
113 g_critical("Cannot write to output file '%s'.",
120 setup_binary_stdout();
125 g_hash_table_destroy(fmtopts);
126 g_hash_table_destroy(fmtargs);
131 const struct sr_transform *setup_transform_module(const struct sr_dev_inst *sdi)
133 const struct sr_transform_module *tmod;
134 const struct sr_option **options;
135 const struct sr_transform *t;
136 GHashTable *fmtargs, *fmtopts;
139 fmtargs = parse_generic_arg(opt_transform_module, TRUE);
140 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
142 g_critical("Invalid transform module.");
143 if (!(tmod = sr_transform_find(fmtspec)))
144 g_critical("Unknown transform module '%s'.", fmtspec);
145 g_hash_table_remove(fmtargs, "sigrok_key");
146 if ((options = sr_transform_options_get(tmod))) {
147 fmtopts = generic_arg_to_opt(options, fmtargs);
148 sr_transform_options_free(options);
151 t = sr_transform_new(tmod, fmtopts, sdi);
153 g_hash_table_destroy(fmtopts);
154 g_hash_table_destroy(fmtargs);
159 /* Get the input stream's list of channels and their types, once. */
160 static void props_get_channels(struct df_arg_desc *args,
161 const struct sr_dev_inst *sdi)
163 struct input_stream_props *props;
165 const struct sr_channel *ch;
169 props = &args->props;
173 props->channels = g_slist_copy(sr_dev_inst_channels_get(sdi));
174 if (!props->channels)
176 for (l = props->channels; l; l = l->next) {
180 if (ch->type != SR_CHANNEL_ANALOG)
182 props->first_analog_channel = ch;
187 static gboolean props_chk_1st_channel(struct df_arg_desc *args,
188 const struct sr_datafeed_analog *analog)
190 struct sr_channel *ch;
192 if (!args || !analog || !analog->meaning)
194 ch = g_slist_nth_data(analog->meaning->channels, 0);
197 return ch == args->props.first_analog_channel;
200 static void props_dump_details(struct df_arg_desc *args)
202 struct input_stream_props *props;
205 const struct sr_channel *ch;
210 props = &args->props;
211 if (props->samplerate)
212 printf("Samplerate: %" PRIu64 "\n", props->samplerate);
213 if (props->channels) {
214 ch_count = g_slist_length(props->channels);
215 printf("Channels: %zu\n", ch_count);
216 for (l = props->channels; l; l = l->next) {
218 if (ch->type == SR_CHANNEL_ANALOG)
222 printf("- %s: %s\n", ch->name, type);
226 printf("Logic unitsize: %zu\n", props->unitsize);
227 if (props->sample_count_logic)
228 printf("Logic sample count: %" PRIu64 "\n", props->sample_count_logic);
229 if (props->sample_count_analog)
230 printf("Analog sample count: %" PRIu64 "\n", props->sample_count_analog);
231 if (props->frame_count)
232 printf("Frame count: %" PRIu64 "\n", props->frame_count);
233 if (props->triggered)
234 printf("Trigger count: %" PRIu64 "\n", props->triggered);
237 static void props_cleanup(struct df_arg_desc *args)
239 struct input_stream_props *props;
243 props = &args->props;
244 g_slist_free(props->channels);
245 props->channels = NULL;
246 props->first_analog_channel = NULL;
249 void datafeed_in(const struct sr_dev_inst *sdi,
250 const struct sr_datafeed_packet *packet, void *cb_data)
252 static const struct sr_output *o = NULL;
253 static const struct sr_output *oa = NULL;
254 static uint64_t rcvd_samples_logic = 0;
255 static uint64_t rcvd_samples_analog = 0;
256 static uint64_t samplerate = 0;
257 static int triggered = 0;
258 static FILE *outfile = NULL;
260 const struct sr_datafeed_meta *meta;
261 const struct sr_datafeed_logic *logic;
262 const struct sr_datafeed_analog *analog;
263 struct df_arg_desc *df_arg;
265 struct input_stream_props *props;
266 struct sr_session *session;
267 struct sr_config *src;
273 struct sr_dev_driver *driver;
275 /* Avoid warnings when building without decoder support. */
279 driver = sr_dev_inst_driver_get(sdi);
281 /* Skip all packets before the first header. */
282 if (packet->type != SR_DF_HEADER && !o)
285 /* Prepare to either process data, or "just" gather properties. */
287 session = df_arg->session;
288 do_props = df_arg->do_props;
289 props = &df_arg->props;
291 switch (packet->type) {
293 g_debug("cli: Received SR_DF_HEADER.");
294 if (maybe_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE,
296 samplerate = g_variant_get_uint64(gvar);
297 g_variant_unref(gvar);
300 /* Setup variables for maximum code path re-use. */
303 /* Start collecting input stream properties. */
304 memset(props, 0, sizeof(*props));
305 props->samplerate = samplerate;
306 props_get_channels(df_arg, sdi);
309 if (!(o = setup_output_format(sdi, &outfile)))
310 g_critical("Failed to initialize output module.");
312 /* Set up backup analog output module. */
314 oa = sr_output_new(sr_output_find("analog"), NULL,
317 rcvd_samples_logic = rcvd_samples_analog = 0;
322 if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
323 g_variant_new_uint64(samplerate)) != SRD_OK) {
324 g_critical("Failed to configure decode session.");
328 if (srd_session_start(srd_sess) != SRD_OK) {
329 g_critical("Failed to start decode session.");
337 g_debug("cli: Received SR_DF_META.");
338 meta = packet->payload;
339 for (l = meta->config; l; l = l->next) {
342 case SR_CONF_SAMPLERATE:
343 samplerate = g_variant_get_uint64(src->data);
344 g_debug("cli: Got samplerate %"PRIu64" Hz.", samplerate);
346 props->samplerate = samplerate;
351 if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
352 g_variant_new_uint64(samplerate)) != SRD_OK) {
353 g_critical("Failed to pass samplerate to decoder.");
358 case SR_CONF_SAMPLE_INTERVAL:
359 samplerate = g_variant_get_uint64(src->data);
360 g_debug("cli: Got sample interval %"PRIu64" ms.", samplerate);
362 props->samplerate = samplerate;
367 /* Unknown metadata is not an error. */
374 g_debug("cli: Received SR_DF_TRIGGER.");
383 logic = packet->payload;
384 g_message("cli: Received SR_DF_LOGIC (%"PRIu64" bytes, unitsize = %d).",
385 logic->length, logic->unitsize);
386 if (logic->length == 0)
390 props_get_channels(df_arg, sdi);
391 props->unitsize = logic->unitsize;
392 props->sample_count_logic += logic->length / logic->unitsize;
396 /* Don't store any samples until triggered. */
397 if (opt_wait_trigger && !triggered)
400 if (limit_samples && rcvd_samples_logic >= limit_samples)
403 end_sample = rcvd_samples_logic + logic->length / logic->unitsize;
404 /* Cut off last packet according to the sample limit. */
405 if (limit_samples && end_sample > limit_samples)
406 end_sample = limit_samples;
407 input_len = (end_sample - rcvd_samples_logic) * logic->unitsize;
411 if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample,
412 logic->data, input_len, logic->unitsize) != SRD_OK)
413 sr_session_stop(session);
417 rcvd_samples_logic = end_sample;
421 analog = packet->payload;
422 g_message("cli: Received SR_DF_ANALOG (%d samples).", analog->num_samples);
423 if (analog->num_samples == 0)
427 /* Only count the first analog channel. */
428 props_get_channels(df_arg, sdi);
429 if (!props_chk_1st_channel(df_arg, analog))
431 props->sample_count_analog += analog->num_samples;
435 if (limit_samples && rcvd_samples_analog >= limit_samples)
438 rcvd_samples_analog += analog->num_samples;
441 case SR_DF_FRAME_BEGIN:
442 g_debug("cli: Received SR_DF_FRAME_BEGIN.");
445 case SR_DF_FRAME_END:
446 g_debug("cli: Received SR_DF_FRAME_END.");
448 props->frame_count++;
457 if (!do_props && o && !opt_pds) {
458 if (sr_output_send(o, packet, &out) == SR_OK) {
461 * The user didn't specify an output module,
462 * but needs to see this analog data.
464 sr_output_send(oa, packet, &out);
466 if (outfile && out && out->len > 0) {
467 fwrite(out->str, 1, out->len, outfile);
471 g_string_free(out, TRUE);
476 * SR_DF_END needs to be handled after the output module's receive()
477 * is called, so it can properly clean up that module.
479 if (packet->type == SR_DF_END) {
480 g_debug("cli: Received SR_DF_END.");
483 props_dump_details(df_arg);
484 props_cleanup(df_arg);
496 if (outfile && outfile != stdout)
500 if (rcvd_samples_logic > 0 && rcvd_samples_logic < limit_samples)
501 g_warning("Device only sent %" PRIu64 " samples.",
503 else if (rcvd_samples_analog > 0 && rcvd_samples_analog < limit_samples)
504 g_warning("Device only sent %" PRIu64 " samples.",
505 rcvd_samples_analog);
511 int opt_to_gvar(char *key, char *value, struct sr_config *src)
513 const struct sr_key_info *srci, *srmqi;
514 double tmp_double, dlow, dhigh;
515 uint64_t tmp_u64, p, q, low, high, mqflags;
517 GVariant *rational[2], *range[2], *gtup[2];
518 GVariantBuilder *vbl;
523 if (!(srci = sr_key_info_name_get(SR_KEY_CONFIG, key))) {
524 g_critical("Unknown device option '%s'.", (char *) key);
527 src->key = srci->key;
529 if ((!value || strlen(value) == 0) &&
530 (srci->datatype != SR_T_BOOL)) {
531 g_critical("Option '%s' needs a value.", (char *)key);
536 switch (srci->datatype) {
538 ret = sr_parse_sizestring(value, &tmp_u64);
541 src->data = g_variant_new_uint64(tmp_u64);
544 ret = sr_parse_sizestring(value, &tmp_u64);
547 src->data = g_variant_new_int32(tmp_u64);
550 src->data = g_variant_new_string(value);
556 tmp_bool = sr_parse_boolstring(value);
557 src->data = g_variant_new_boolean(tmp_bool);
560 tmp_double = strtof(value, NULL);
561 src->data = g_variant_new_double(tmp_double);
563 case SR_T_RATIONAL_PERIOD:
564 if ((ret = sr_parse_period(value, &p, &q)) != SR_OK)
566 rational[0] = g_variant_new_uint64(p);
567 rational[1] = g_variant_new_uint64(q);
568 src->data = g_variant_new_tuple(rational, 2);
570 case SR_T_RATIONAL_VOLT:
571 if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK)
573 rational[0] = g_variant_new_uint64(p);
574 rational[1] = g_variant_new_uint64(q);
575 src->data = g_variant_new_tuple(rational, 2);
577 case SR_T_UINT64_RANGE:
578 if (sscanf(value, "%"PRIu64"-%"PRIu64, &low, &high) != 2) {
582 range[0] = g_variant_new_uint64(low);
583 range[1] = g_variant_new_uint64(high);
584 src->data = g_variant_new_tuple(range, 2);
587 case SR_T_DOUBLE_RANGE:
588 if (sscanf(value, "%lf-%lf", &dlow, &dhigh) != 2) {
592 range[0] = g_variant_new_double(dlow);
593 range[1] = g_variant_new_double(dhigh);
594 src->data = g_variant_new_tuple(range, 2);
598 /* Expects the argument to be in the form of key=value. */
599 keyval = g_strsplit(value, "=", 2);
600 if (!keyval[0] || !keyval[1]) {
605 vbl = g_variant_builder_new(G_VARIANT_TYPE_DICTIONARY);
606 g_variant_builder_add(vbl, "{ss}",
607 keyval[0], keyval[1]);
608 src->data = g_variant_builder_end(vbl);
614 Argument is MQ id e.g. ("voltage") optionally followed by one
615 or more /<mqflag> e.g. "/ac".
617 keyval = g_strsplit(value, "/", 0);
618 if (!keyval[0] || !(srmqi = sr_key_info_name_get(SR_KEY_MQ, keyval[0]))) {
625 for (i = 1; keyval[i]; i++) {
626 if (!(srmqi = sr_key_info_name_get(SR_KEY_MQFLAGS, keyval[i]))) {
630 mqflags |= srmqi->key;
634 gtup[0] = g_variant_new_uint32(mq);
635 gtup[1] = g_variant_new_uint64(mqflags);
636 src->data = g_variant_new_tuple(gtup, 2);
640 g_critical("Unknown data type specified for option '%s' "
641 "(driver implementation bug?).", key);
646 g_critical("Invalid value: '%s' for option '%s'", value, key);
651 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
653 struct sr_config src;
654 struct sr_channel_group *cg;
659 g_hash_table_iter_init(&iter, args);
660 while (g_hash_table_iter_next(&iter, &key, &value)) {
661 if ((ret = opt_to_gvar(key, value, &src)) != 0)
663 cg = select_channel_group(sdi);
664 if ((ret = maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, cg,
665 src.key, src.data)) != SR_OK) {
666 g_critical("Failed to set device option '%s': %s.",
667 (char *)key, sr_strerror(ret));
675 void run_session(void)
677 struct df_arg_desc df_arg;
678 GSList *devices, *real_devices, *sd;
681 struct sr_session *session;
682 struct sr_trigger *trigger;
683 struct sr_dev_inst *sdi;
684 uint64_t min_samples, max_samples;
688 struct sr_dev_driver *driver;
689 const struct sr_transform *t;
690 GMainLoop *main_loop;
692 memset(&df_arg, 0, sizeof(df_arg));
693 df_arg.do_props = FALSE;
695 devices = device_scan();
697 g_critical("No devices found.");
702 for (sd = devices; sd; sd = sd->next) {
705 driver = sr_dev_inst_driver_get(sdi);
707 if (!(drv_opts = sr_dev_options(driver, NULL, NULL))) {
708 g_critical("Failed to query list of driver options.");
713 for (i = 0; i < drv_opts->len; i++) {
714 if (g_array_index(drv_opts, uint32_t, i) == SR_CONF_DEMO_DEV)
718 g_array_free(drv_opts, TRUE);
721 real_devices = g_slist_append(real_devices, sdi);
724 if (g_slist_length(devices) > 1) {
725 if (g_slist_length(real_devices) != 1) {
726 g_critical("sigrok-cli only supports one device for capturing.");
729 /* We only have one non-demo device. */
730 g_slist_free(devices);
731 devices = real_devices;
736 /* This is unlikely to happen but it makes static analyzers stop complaining. */
738 g_critical("No real devices found.");
743 g_slist_free(devices);
744 g_slist_free(real_devices);
746 sr_session_new(sr_ctx, &session);
747 df_arg.session = session;
748 sr_session_datafeed_callback_add(session, datafeed_in, &df_arg);
749 df_arg.session = NULL;
751 if (sr_dev_open(sdi) != SR_OK) {
752 g_critical("Failed to open device.");
756 if (sr_session_dev_add(session, sdi) != SR_OK) {
757 g_critical("Failed to add device to session.");
758 sr_session_destroy(session);
763 if ((devargs = parse_generic_arg(opt_config, FALSE))) {
764 if (set_dev_options(sdi, devargs) != SR_OK)
766 g_hash_table_destroy(devargs);
770 if (select_channels(sdi) != SR_OK) {
771 g_critical("Failed to set channels.");
772 sr_session_destroy(session);
778 if (!parse_triggerstring(sdi, opt_triggers, &trigger)) {
779 sr_session_destroy(session);
782 if (sr_session_trigger_set(session, trigger) != SR_OK) {
783 sr_session_destroy(session);
788 if (opt_continuous) {
789 if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) {
790 g_critical("This device does not support continuous sampling.");
791 sr_session_destroy(session);
797 if (set_limit_time(sdi) != SR_OK) {
798 sr_session_destroy(session);
804 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) {
805 g_critical("Invalid sample limit '%s'.", opt_samples);
806 sr_session_destroy(session);
809 if (maybe_config_list(driver, sdi, NULL, SR_CONF_LIMIT_SAMPLES,
812 * The device has no compression, or compression is turned
813 * off, and publishes its sample memory size.
815 g_variant_get(gvar, "(tt)", &min_samples, &max_samples);
816 g_variant_unref(gvar);
817 if (limit_samples < min_samples) {
818 g_critical("The device stores at least %"PRIu64
819 " samples with the current settings.", min_samples);
821 if (limit_samples > max_samples) {
822 g_critical("The device can store only %"PRIu64
823 " samples with the current settings.", max_samples);
826 gvar = g_variant_new_uint64(limit_samples);
827 if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
828 g_critical("Failed to configure sample limit.");
829 sr_session_destroy(session);
835 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) {
836 g_critical("Invalid frame limit '%s'.", opt_frames);
837 sr_session_destroy(session);
840 gvar = g_variant_new_uint64(limit_frames);
841 if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
842 g_critical("Failed to configure frame limit.");
843 sr_session_destroy(session);
848 if (opt_transform_module) {
849 if (!(t = setup_transform_module(sdi)))
850 g_critical("Failed to initialize transform module.");
853 main_loop = g_main_loop_new(NULL, FALSE);
855 sr_session_stopped_callback_set(session,
856 (sr_session_stopped_callback)g_main_loop_quit, main_loop);
858 if (sr_session_start(session) != SR_OK) {
859 g_critical("Failed to start session.");
860 g_main_loop_unref(main_loop);
861 sr_session_destroy(session);
868 g_main_loop_run(main_loop);
874 sr_trigger_free(trigger);
876 sr_session_datafeed_callback_remove_all(session);
877 g_main_loop_unref(main_loop);
878 sr_session_destroy(session);