2 * This file is part of the sigrok-cli project.
4 * Copyright (C) 2012 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 <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
31 #include <sys/types.h>
35 #include <glib/gstdio.h>
36 #include <libsigrok/libsigrok.h>
37 #include "sigrok-cli.h"
39 #define DEFAULT_OUTPUT_FORMAT "bits:width=64"
41 static struct sr_context *sr_ctx = NULL;
43 static uint64_t limit_samples = 0;
44 static uint64_t limit_frames = 0;
45 static struct sr_output_format *output_format = NULL;
46 static int default_output_format = FALSE;
47 static char *output_format_param = NULL;
49 static GHashTable *pd_ann_visible = NULL;
51 static GByteArray *savebuf;
53 static gboolean opt_version = FALSE;
54 static gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
55 static gboolean opt_list_devs = FALSE;
56 static gboolean opt_wait_trigger = FALSE;
57 static gchar *opt_input_file = NULL;
58 static gchar *opt_output_file = NULL;
59 static gchar *opt_drv = NULL;
60 static gchar *opt_dev = NULL;
61 static gchar *opt_probes = NULL;
62 static gchar *opt_triggers = NULL;
63 static gchar *opt_pds = NULL;
65 static gchar *opt_pd_stack = NULL;
66 static gchar *opt_pd_annotations = NULL;
68 static gchar *opt_input_format = NULL;
69 static gchar *opt_output_format = NULL;
70 static gchar *opt_show = NULL;
71 static gchar *opt_time = NULL;
72 static gchar *opt_samples = NULL;
73 static gchar *opt_frames = NULL;
74 static gchar *opt_continuous = NULL;
75 static gchar *opt_set = NULL;
77 static GOptionEntry optargs[] = {
78 {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version,
79 "Show version and support list", NULL},
80 {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel,
81 "Set libsigrok/libsigrokdecode loglevel", NULL},
82 {"list-devices", 'D', 0, G_OPTION_ARG_NONE, &opt_list_devs,
83 "Scan for devices", NULL},
84 {"driver", 0, 0, G_OPTION_ARG_STRING, &opt_drv,
85 "Use only this driver", NULL},
86 {"device", 'd', 0, G_OPTION_ARG_STRING, &opt_dev,
87 "Use specified device", NULL},
88 {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file,
89 "Load input from file", NULL},
90 {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format,
91 "Input format", NULL},
92 {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file,
93 "Save output to file", NULL},
94 {"output-format", 'O', 0, G_OPTION_ARG_STRING, &opt_output_format,
95 "Output format", NULL},
96 {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes,
97 "Probes to use", NULL},
98 {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers,
99 "Trigger configuration", NULL},
100 {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
101 "Wait for trigger", NULL},
103 {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds,
104 "Protocol decoders to run", NULL},
105 {"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING, &opt_pd_stack,
106 "Protocol decoder stack", NULL},
107 {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_STRING, &opt_pd_annotations,
108 "Protocol decoder annotation(s) to show", NULL},
110 {"show", 0, 0, G_OPTION_ARG_NONE, &opt_show,
111 "Show device detail", NULL},
112 {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time,
113 "How long to sample (ms)", NULL},
114 {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples,
115 "Number of samples to acquire", NULL},
116 {"frames", 0, 0, G_OPTION_ARG_STRING, &opt_frames,
117 "Number of frames to acquire", NULL},
118 {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous,
119 "Sample continuously", NULL},
120 {"set", 0, 0, G_OPTION_ARG_NONE, &opt_set, "Set device options only", NULL},
121 {NULL, 0, 0, 0, NULL, NULL, NULL}
125 /* Convert driver options hash to GSList of struct sr_config. */
126 static GSList *hash_to_hwopt(GHashTable *hash)
128 const struct sr_config_info *srci;
129 struct sr_config *src;
134 keys = g_hash_table_get_keys(hash);
136 for (gl = keys; gl; gl = gl->next) {
138 if (!(srci = sr_config_info_name_get(key))) {
139 g_critical("Unknown option %s", key);
142 src = g_try_malloc(sizeof(struct sr_config));
143 src->key = srci->key;
144 value = g_hash_table_lookup(hash, key);
145 src->data = g_variant_new_string(value);
146 opts = g_slist_append(opts, src);
153 static void free_drvopts(struct sr_config *src)
155 g_variant_unref(src->data);
159 static GSList *device_scan(void)
161 struct sr_dev_driver **drivers, *driver;
163 GSList *drvopts, *devices, *tmpdevs, *l;
168 drvargs = parse_generic_arg(opt_drv, TRUE);
169 drvname = g_strdup(g_hash_table_lookup(drvargs, "sigrok_key"));
170 g_hash_table_remove(drvargs, "sigrok_key");
172 drivers = sr_driver_list();
173 for (i = 0; drivers[i]; i++) {
174 if (strcmp(drivers[i]->name, drvname))
179 g_critical("Driver %s not found.", drvname);
183 if (sr_driver_init(sr_ctx, driver) != SR_OK) {
184 g_critical("Failed to initialize driver.");
188 if (g_hash_table_size(drvargs) > 0)
189 if (!(drvopts = hash_to_hwopt(drvargs)))
190 /* Unknown options, already logged. */
192 devices = sr_driver_scan(driver, drvopts);
193 g_slist_free_full(drvopts, (GDestroyNotify)free_drvopts);
195 /* No driver specified, let them all scan on their own. */
197 drivers = sr_driver_list();
198 for (i = 0; drivers[i]; i++) {
200 if (sr_driver_init(sr_ctx, driver) != SR_OK) {
201 g_critical("Failed to initialize driver.");
204 tmpdevs = sr_driver_scan(driver, NULL);
205 for (l = tmpdevs; l; l = l->next)
206 devices = g_slist_append(devices, l->data);
207 g_slist_free(tmpdevs);
214 static void show_version(void)
216 struct sr_dev_driver **drivers;
217 struct sr_input_format **inputs;
218 struct sr_output_format **outputs;
221 struct srd_decoder *dec;
225 printf("sigrok-cli %s\n\n", VERSION);
227 printf("Using libsigrok %s (lib version %s).\n",
228 sr_package_version_string_get(), sr_lib_version_string_get());
230 printf("Using libsigrokdecode %s (lib version %s).\n\n",
231 srd_package_version_string_get(), srd_lib_version_string_get());
234 printf("Supported hardware drivers:\n");
235 drivers = sr_driver_list();
236 for (i = 0; drivers[i]; i++) {
237 printf(" %-20s %s\n", drivers[i]->name, drivers[i]->longname);
241 printf("Supported input formats:\n");
242 inputs = sr_input_list();
243 for (i = 0; inputs[i]; i++)
244 printf(" %-20s %s\n", inputs[i]->id, inputs[i]->description);
247 printf("Supported output formats:\n");
248 outputs = sr_output_list();
249 for (i = 0; outputs[i]; i++)
250 printf(" %-20s %s\n", outputs[i]->id, outputs[i]->description);
254 if (srd_init(NULL) == SRD_OK) {
255 printf("Supported protocol decoders:\n");
256 srd_decoder_load_all();
257 for (l = srd_decoder_list(); l; l = l->next) {
259 printf(" %-20s %s\n", dec->id, dec->longname);
260 /* Print protocol description upon "-l 3" or higher. */
261 if (opt_loglevel >= SR_LOG_INFO)
262 printf(" %-20s %s\n", "", dec->desc);
270 static void print_dev_line(const struct sr_dev_inst *sdi)
272 struct sr_probe *probe;
277 s = g_string_sized_new(128);
278 g_string_assign(s, sdi->driver->name);
279 if (sr_config_get(sdi->driver, SR_CONF_CONN, &gvar, sdi) == SR_OK) {
280 g_string_append(s, ":conn=");
281 g_string_append(s, g_variant_get_string(gvar, NULL));
282 g_variant_unref(gvar);
284 g_string_append(s, " - ");
285 if (sdi->vendor && sdi->vendor[0])
286 g_string_append_printf(s, "%s ", sdi->vendor);
287 if (sdi->model && sdi->model[0])
288 g_string_append_printf(s, "%s ", sdi->model);
289 if (sdi->version && sdi->version[0])
290 g_string_append_printf(s, "%s ", sdi->version);
292 if (g_slist_length(sdi->probes) == 1) {
293 probe = sdi->probes->data;
294 g_string_append_printf(s, "with 1 probe: %s", probe->name);
296 g_string_append_printf(s, "with %d probes:", g_slist_length(sdi->probes));
297 for (l = sdi->probes; l; l = l->next) {
299 g_string_append_printf(s, " %s", probe->name);
303 g_string_append_printf(s, "\n");
304 printf("%s", s->str);
305 g_string_free(s, TRUE);
309 static void show_dev_list(void)
311 struct sr_dev_inst *sdi;
314 if (!(devices = device_scan()))
317 printf("The following devices were found:\n");
318 for (l = devices; l; l = l->next) {
322 g_slist_free(devices);
326 static void show_dev_detail(void)
328 struct sr_dev_inst *sdi;
329 const struct sr_config_info *srci;
331 GVariant *gvar_opts, *gvar_dict, *gvar_list, *gvar;
332 gsize num_opts, num_elements;
333 const uint64_t *uint64, p, q;
335 unsigned int num_devices, tmp_bool, o, i;
337 const char *charopts, **stropts;
339 if (!(devices = device_scan())) {
340 g_critical("No devices found.");
344 num_devices = g_slist_length(devices);
345 if (num_devices > 1) {
346 g_critical("%d devices found. Use --list-devices to show them, "
347 "and --device to select one.", num_devices);
354 if (sr_dev_open(sdi) != SR_OK) {
355 g_critical("Failed to open device.");
359 if ((sr_config_list(sdi->driver, SR_CONF_SCAN_OPTIONS, &gvar_opts,
361 opts = g_variant_get_fixed_array(gvar_opts, &num_elements,
363 printf("Supported driver options:\n");
364 for (i = 0; i < num_elements; i++) {
365 if (!(srci = sr_config_info_get(opts[i])))
367 printf(" %s\n", srci->id);
369 g_variant_unref(gvar_opts);
372 if ((sr_config_list(sdi->driver, SR_CONF_DEVICE_OPTIONS, &gvar_opts,
374 /* Driver supports no device instance options. */
377 printf("Supported device options:\n");
378 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(int32_t));
379 for (o = 0; o < num_opts; o++) {
380 if (!(srci = sr_config_info_get(opts[o])))
383 if (srci->key == SR_CONF_TRIGGER_TYPE) {
384 if (sr_config_list(sdi->driver, srci->key, &gvar,
389 charopts = g_variant_get_string(gvar, NULL);
390 printf(" Supported triggers: ");
392 printf("%c ", *charopts);
396 g_variant_unref(gvar);
398 } else if (srci->key == SR_CONF_PATTERN_MODE) {
399 /* Pattern generator modes */
400 printf(" %s", srci->id);
401 if (sr_config_list(sdi->driver, srci->key, &gvar,
403 printf(" - supported patterns:\n");
404 stropts = g_variant_get_strv(gvar, &num_elements);
405 for (i = 0; i < num_elements; i++)
406 printf(" %s\n", stropts[i]);
407 g_variant_unref(gvar);
412 } else if (srci->key == SR_CONF_SAMPLERATE) {
413 /* Supported samplerates */
414 printf(" %s", srci->id);
415 if (sr_config_list(sdi->driver, SR_CONF_SAMPLERATE,
416 &gvar_dict, sdi) != SR_OK) {
420 if ((gvar_list = g_variant_lookup_value(gvar_dict,
421 "samplerates", G_VARIANT_TYPE("at")))) {
422 uint64 = g_variant_get_fixed_array(gvar_list,
423 &num_elements, sizeof(uint64_t));
424 printf(" - supported samplerates:\n");
425 for (i = 0; i < num_elements; i++)
426 printf(" %s\n", sr_samplerate_string(uint64[i]));
427 } if ((gvar_list = g_variant_lookup_value(gvar_dict,
428 "samplerate-steps", G_VARIANT_TYPE("at")))) {
429 uint64 = g_variant_get_fixed_array(gvar_list,
430 &num_elements, sizeof(uint64_t));
432 if (!(s = sr_samplerate_string(uint64[0])))
437 if (!(s = sr_samplerate_string(uint64[1])))
442 if (!(s = sr_samplerate_string(uint64[2])))
444 printf(" in steps of %s)\n", s);
446 g_variant_unref(gvar_list);
448 g_variant_unref(gvar_dict);
450 } else if (srci->key == SR_CONF_BUFFERSIZE) {
451 /* Supported buffer sizes */
452 printf(" %s", srci->id);
453 if (sr_config_list(sdi->driver, SR_CONF_BUFFERSIZE,
454 &gvar_list, sdi) != SR_OK) {
458 uint64 = g_variant_get_fixed_array(gvar_list,
459 &num_elements, sizeof(uint64_t));
460 printf(" - supported buffer sizes:\n");
461 for (i = 0; i < num_elements; i++)
462 printf(" %"PRIu64"\n", uint64[i]);
463 g_variant_unref(gvar_list);
465 } else if (srci->key == SR_CONF_TIMEBASE) {
466 /* Supported time bases */
467 printf(" %s", srci->id);
468 if (sr_config_list(sdi->driver, SR_CONF_TIMEBASE,
469 &gvar_list, sdi) != SR_OK) {
473 printf(" - supported time bases:\n");
474 num_elements = g_variant_n_children(gvar_list);
475 for (i = 0; i < num_elements; i++) {
476 gvar = g_variant_get_child_value(gvar_list, i);
477 g_variant_get(gvar, "(tt)", &p, &q);
478 s = sr_period_string(p * q);
482 g_variant_unref(gvar_list);
484 } else if (srci->key == SR_CONF_TRIGGER_SOURCE) {
485 /* Supported trigger sources */
486 printf(" %s", srci->id);
487 if (sr_config_list(sdi->driver, SR_CONF_TRIGGER_SOURCE,
488 &gvar, sdi) != SR_OK) {
492 printf(" - supported trigger sources:\n");
493 stropts = g_variant_get_strv(gvar, &num_elements);
494 for (i = 0; i < num_elements; i++)
495 printf(" %s\n", stropts[i]);
496 g_variant_unref(gvar);
498 } else if (srci->key == SR_CONF_FILTER) {
499 /* Supported filters */
500 printf(" %s", srci->id);
501 if (sr_config_list(sdi->driver, SR_CONF_FILTER,
502 &gvar, sdi) != SR_OK) {
506 printf(" - supported filter targets:\n");
507 stropts = g_variant_get_strv(gvar, &num_elements);
508 for (i = 0; i < num_elements; i++)
509 printf(" %s\n", stropts[i]);
510 g_variant_unref(gvar);
512 } else if (srci->key == SR_CONF_VDIV) {
513 /* Supported volts/div values */
514 printf(" %s", srci->id);
515 if (sr_config_list(sdi->driver, SR_CONF_VDIV,
516 &gvar_list, sdi) != SR_OK) {
520 printf(" - supported volts/div:\n");
521 num_elements = g_variant_n_children(gvar_list);
522 for (i = 0; i < num_elements; i++) {
523 gvar = g_variant_get_child_value(gvar_list, i);
524 g_variant_get(gvar, "(tt)", &p, &q);
525 s = sr_voltage_string(p, q);
529 g_variant_unref(gvar_list);
531 } else if (srci->key == SR_CONF_COUPLING) {
532 /* Supported coupling settings */
533 printf(" %s", srci->id);
534 if (sr_config_list(sdi->driver, SR_CONF_COUPLING,
535 &gvar, sdi) != SR_OK) {
539 printf(" - supported coupling options:\n");
540 stropts = g_variant_get_strv(gvar, &num_elements);
541 for (i = 0; i < num_elements; i++)
542 printf(" %s\n", stropts[i]);
543 g_variant_unref(gvar);
545 } else if (srci->key == SR_CONF_DATALOG) {
547 /* Turning on/off internal data logging. */
548 printf(" %s\t(on/off", srci->id);
549 if (sr_config_get(sdi->driver, SR_CONF_DATALOG,
550 &gvar, sdi) == SR_OK) {
551 tmp_bool = g_variant_get_boolean(gvar);
552 printf(", currently %s", tmp_bool ? "on" : "off");
553 g_variant_unref(gvar);
557 /* Everything else */
558 printf(" %s\n", srci->id);
561 g_variant_unref(gvar_opts);
568 static void show_pd_detail(void)
571 struct srd_decoder *dec;
572 struct srd_decoder_option *o;
573 char **pdtokens, **pdtok, *optsep, **ann, *val, *doc;
576 pdtokens = g_strsplit(opt_pds, ",", -1);
577 for (pdtok = pdtokens; *pdtok; pdtok++) {
579 if ((optsep = strchr(*pdtok, ':')))
581 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
582 g_critical("Protocol decoder %s not found.", *pdtok);
585 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
586 dec->id, dec->name, dec->longname, dec->desc);
587 printf("License: %s\n", dec->license);
588 printf("Annotations:\n");
589 if (dec->annotations) {
590 for (l = dec->annotations; l; l = l->next) {
592 printf("- %s\n %s\n", ann[0], ann[1]);
597 printf("Required probes:\n");
599 for (l = dec->probes; l; l = l->next) {
601 printf("- %s (%s): %s\n",
602 p->name, p->id, p->desc);
607 printf("Optional probes:\n");
608 if (dec->opt_probes) {
609 for (l = dec->opt_probes; l; l = l->next) {
611 printf("- %s (%s): %s\n",
612 p->name, p->id, p->desc);
618 printf("Options:\n");
619 for (l = dec->options; l; l = l->next) {
621 val = g_variant_print(o->def, FALSE);
622 printf("- %s: %s (default %s)\n", o->id, o->desc, val);
626 if ((doc = srd_decoder_doc_get(dec))) {
627 printf("Documentation:\n%s\n",
628 doc[0] == '\n' ? doc + 1 : doc);
633 g_strfreev(pdtokens);
637 static GArray *get_enabled_logic_probes(const struct sr_dev_inst *sdi)
639 struct sr_probe *probe;
643 probes = g_array_new(FALSE, FALSE, sizeof(int));
644 for (l = sdi->probes; l; l = l->next) {
646 if (probe->type != SR_PROBE_LOGIC)
648 if (probe->enabled != TRUE)
650 g_array_append_val(probes, probe->index);
656 static void datafeed_in(const struct sr_dev_inst *sdi,
657 const struct sr_datafeed_packet *packet, void *cb_data)
659 const struct sr_datafeed_meta *meta;
660 const struct sr_datafeed_logic *logic;
661 const struct sr_datafeed_analog *analog;
662 struct sr_config *src;
663 static struct sr_output *o = NULL;
664 static GArray *logic_probelist = NULL;
665 static uint64_t received_samples = 0;
666 static int unitsize = 0;
667 static int triggered = 0;
668 static FILE *outfile = NULL;
672 int sample_size, ret;
673 uint64_t samplerate, output_len, filter_out_len;
674 uint8_t *output_buf, *filter_out;
678 /* If the first packet to come in isn't a header, don't even try. */
679 if (packet->type != SR_DF_HEADER && o == NULL)
683 switch (packet->type) {
685 g_debug("cli: Received SR_DF_HEADER");
686 /* Initialize the output module. */
687 if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
688 g_critical("Output module malloc failed.");
691 o->format = output_format;
692 o->sdi = (struct sr_dev_inst *)sdi;
693 o->param = output_format_param;
694 if (o->format->init) {
695 if (o->format->init(o) != SR_OK) {
696 g_critical("Output format initialization failed.");
701 /* Prepare non-stdout output. */
703 if (opt_output_file) {
704 if (default_output_format) {
705 /* output file is in session format, so we'll
706 * keep a copy of everything as it comes in
707 * and save from there after the session. */
709 savebuf = g_byte_array_new();
711 /* saving to a file in whatever format was set
712 * with --format, so all we need is a filehandle */
713 outfile = g_fopen(opt_output_file, "wb");
717 /* Prepare for logic data. */
718 logic_probelist = get_enabled_logic_probes(sdi);
719 /* How many bytes we need to store the packed samples. */
720 unitsize = (logic_probelist->len + 7) / 8;
723 if (opt_pds && logic_probelist->len) {
724 if (sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
725 &gvar, sdi) != SR_OK) {
726 g_critical("Unable to initialize protocol "
727 "decoders: no samplerate found.");
730 samplerate = g_variant_get_uint64(gvar);
731 g_variant_unref(gvar);
732 srd_session_start(logic_probelist->len, unitsize, samplerate);
738 g_debug("cli: received SR_DF_META");
739 meta = packet->payload;
740 for (l = meta->config; l; l = l->next) {
743 case SR_CONF_SAMPLERATE:
744 samplerate = g_variant_get_uint64(src->data);
745 g_debug("cli: got samplerate %"PRIu64" Hz", samplerate);
747 case SR_CONF_SAMPLE_INTERVAL:
748 samplerate = g_variant_get_uint64(src->data);
749 g_debug("cli: got sample interval %"PRIu64" ms", samplerate);
752 /* Unknown metadata is not an error. */
759 g_debug("cli: received SR_DF_TRIGGER");
760 if (o->format->event)
761 o->format->event(o, SR_DF_TRIGGER, &output_buf,
767 logic = packet->payload;
768 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
769 sample_size = logic->unitsize;
770 if (logic->length == 0)
773 /* Don't store any samples until triggered. */
774 if (opt_wait_trigger && !triggered)
777 if (limit_samples && received_samples >= limit_samples)
780 ret = sr_filter_probes(sample_size, unitsize, logic_probelist,
781 logic->data, logic->length,
782 &filter_out, &filter_out_len);
786 /* What comes out of the filter is guaranteed to be packed into the
787 * minimum size needed to support the number of samples at this sample
788 * size. however, the driver may have submitted too much -- cut off
789 * the buffer of the last packet according to the sample limit.
791 if (limit_samples && (received_samples + logic->length / sample_size >
792 limit_samples * sample_size))
793 filter_out_len = limit_samples * sample_size - received_samples;
795 if (opt_output_file && default_output_format) {
796 /* Saving to a session file. */
797 g_byte_array_append(savebuf, filter_out, filter_out_len);
801 if (srd_session_send(received_samples, (uint8_t*)filter_out,
802 filter_out_len) != SRD_OK)
807 if (o->format->data && packet->type == o->format->df_type)
808 o->format->data(o, filter_out, filter_out_len,
809 &output_buf, &output_len);
811 fwrite(output_buf, 1, output_len, outfile);
819 received_samples += logic->length / sample_size;
823 analog = packet->payload;
824 g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples);
825 if (analog->num_samples == 0)
828 if (limit_samples && received_samples >= limit_samples)
831 if (o->format->data && packet->type == o->format->df_type) {
832 o->format->data(o, (const uint8_t *)analog->data,
833 analog->num_samples * sizeof(float),
834 &output_buf, &output_len);
836 fwrite(output_buf, 1, output_len, outfile);
842 received_samples += analog->num_samples;
845 case SR_DF_FRAME_BEGIN:
846 g_debug("cli: received SR_DF_FRAME_BEGIN");
847 if (o->format->event) {
848 o->format->event(o, SR_DF_FRAME_BEGIN, &output_buf,
851 fwrite(output_buf, 1, output_len, outfile);
858 case SR_DF_FRAME_END:
859 g_debug("cli: received SR_DF_FRAME_END");
860 if (o->format->event) {
861 o->format->event(o, SR_DF_FRAME_END, &output_buf,
864 fwrite(output_buf, 1, output_len, outfile);
875 if (o && o->format->recv) {
876 out = o->format->recv(o, sdi, packet);
877 if (out && out->len) {
878 fwrite(out->str, 1, out->len, outfile);
883 /* SR_DF_END needs to be handled after the output module's recv()
884 * is called, so it can properly clean up that module etc. */
885 if (packet->type == SR_DF_END) {
886 g_debug("cli: Received SR_DF_END");
888 if (o->format->event) {
889 o->format->event(o, SR_DF_END, &output_buf, &output_len);
892 fwrite(output_buf, 1, output_len, outfile);
898 if (limit_samples && received_samples < limit_samples)
899 g_warning("Device only sent %" PRIu64 " samples.",
903 g_warning("Device stopped after %" PRIu64 " samples.",
906 g_array_free(logic_probelist, TRUE);
908 if (o->format->cleanup)
909 o->format->cleanup(o);
913 if (outfile && outfile != stdout)
916 if (opt_output_file && default_output_format) {
917 if (sr_session_save(opt_output_file, sdi, savebuf->data,
918 unitsize, savebuf->len / unitsize) != SR_OK)
919 g_critical("Failed to save session.");
920 g_byte_array_free(savebuf, FALSE);
927 static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash,
928 GHashTable **options)
930 struct srd_decoder_option *o;
935 char *val_str, *conv;
938 *options = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
939 (GDestroyNotify)g_variant_unref);
941 for (optl = dec->options; optl; optl = optl->next) {
943 if (!(val_str = g_hash_table_lookup(hash, o->id)))
946 if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_STRING)) {
947 gvar = g_variant_new_string(val_str);
948 } else if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_INT64)) {
949 val_int = strtoll(val_str, &conv, 10);
950 if (!conv || conv == val_str) {
951 g_critical("Protocol decoder '%s' option '%s' "
952 "requires a number.", dec->name, o->id);
956 gvar = g_variant_new_int64(val_int);
958 g_critical("Unsupported type for option '%s' (%s)",
959 o->id, g_variant_get_type_string(o->def));
963 g_variant_ref_sink(gvar);
964 g_hash_table_insert(*options, g_strdup(o->id), gvar);
965 g_hash_table_remove(hash, o->id);
971 static int probes_to_gvar(struct srd_decoder *dec, GHashTable *hash,
975 GSList *all_probes, *l;
979 char *val_str, *conv;
982 *probes = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
983 (GDestroyNotify)g_variant_unref);
985 all_probes = g_slist_copy(dec->probes);
986 all_probes = g_slist_concat(all_probes, dec->opt_probes);
987 for (l = all_probes; l; l = l->next) {
989 if (!(val_str = g_hash_table_lookup(hash, p->id)))
992 val_int = strtoll(val_str, &conv, 10);
993 if (!conv || conv == val_str) {
994 g_critical("Protocol decoder '%s' probes '%s' "
995 "is not a number.", dec->name, p->id);
999 gvar = g_variant_new_int32(val_int);
1000 g_variant_ref_sink(gvar);
1001 g_hash_table_insert(*probes, g_strdup(p->id), gvar);
1002 g_hash_table_remove(hash, p->id);
1004 g_slist_free(all_probes);
1009 /* Register the given PDs for this session.
1010 * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
1011 * That will instantiate two SPI decoders on the clock but different data
1014 static int register_pds(struct sr_dev *dev, const char *pdstring)
1016 struct srd_decoder *dec;
1017 GHashTable *pd_opthash, *options, *probes;
1018 GList *leftover, *l;
1019 struct srd_decoder_inst *di;
1021 char **pdtokens, **pdtok, *pd_name;
1026 pd_ann_visible = g_hash_table_new_full(g_str_hash, g_int_equal,
1029 pd_opthash = options = probes = NULL;
1030 pdtokens = g_strsplit(pdstring, ",", 0);
1031 for (pdtok = pdtokens; *pdtok; pdtok++) {
1032 if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) {
1033 g_critical("Invalid protocol decoder option '%s'.", *pdtok);
1037 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
1038 g_hash_table_remove(pd_opthash, "sigrok_key");
1039 if (srd_decoder_load(pd_name) != SRD_OK) {
1040 g_critical("Failed to load protocol decoder %s.", pd_name);
1044 dec = srd_decoder_get_by_id(pd_name);
1046 /* Convert decoder option and probe values to GVariant. */
1047 if (!opts_to_gvar(dec, pd_opthash, &options)) {
1051 if (!probes_to_gvar(dec, pd_opthash, &probes)) {
1055 if (g_hash_table_size(pd_opthash) > 0) {
1056 leftover = g_hash_table_get_keys(pd_opthash);
1057 for (l = leftover; l; l = l->next)
1058 g_critical("Unknown option or probe '%s'", (char *)l->data);
1059 g_list_free(leftover);
1063 if (!(di = srd_inst_new(pd_name, options))) {
1064 g_critical("Failed to instantiate protocol decoder %s.", pd_name);
1069 /* If no annotation list was specified, add them all in now.
1070 * This will be pared down later to leave only the last PD
1073 if (!opt_pd_annotations)
1074 g_hash_table_insert(pd_ann_visible,
1075 g_strdup(di->inst_id), NULL);
1077 /* Remap the probes if needed. */
1078 if (srd_inst_probe_set_all(di, probes) != SRD_OK) {
1084 g_strfreev(pdtokens);
1086 g_hash_table_destroy(pd_opthash);
1088 g_hash_table_destroy(options);
1090 g_hash_table_destroy(probes);
1097 int setup_pd_stack(void)
1099 struct srd_decoder_inst *di_from, *di_to;
1103 /* Set up the protocol decoder stack. */
1104 pds = g_strsplit(opt_pds, ",", 0);
1105 if (g_strv_length(pds) > 1) {
1107 /* A stack setup was specified, use that. */
1109 pds = g_strsplit(opt_pd_stack, ",", 0);
1110 if (g_strv_length(pds) < 2) {
1112 g_critical("Specify at least two protocol decoders to stack.");
1117 /* First PD goes at the bottom of the stack. */
1118 ids = g_strsplit(pds[0], ":", 0);
1119 if (!(di_from = srd_inst_find_by_id(ids[0]))) {
1121 g_critical("Cannot stack protocol decoder '%s': "
1122 "instance not found.", pds[0]);
1127 /* Every subsequent PD goes on top. */
1128 for (i = 1; pds[i]; i++) {
1129 ids = g_strsplit(pds[i], ":", 0);
1130 if (!(di_to = srd_inst_find_by_id(ids[0]))) {
1132 g_critical("Cannot stack protocol decoder '%s': "
1133 "instance not found.", pds[i]);
1137 if ((ret = srd_inst_stack(di_from, di_to)) != SRD_OK)
1140 /* Don't show annotation from this PD. Only the last PD in
1141 * the stack will be left on the annotation list (unless
1142 * the annotation list was specifically provided).
1144 if (!opt_pd_annotations)
1145 g_hash_table_remove(pd_ann_visible,
1156 int setup_pd_annotations(void)
1159 struct srd_decoder *dec;
1161 char **pds, **pdtok, **keyval, **ann_descr;
1163 /* Set up custom list of PDs and annotations to show. */
1164 if (opt_pd_annotations) {
1165 pds = g_strsplit(opt_pd_annotations, ",", 0);
1166 for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
1168 keyval = g_strsplit(*pdtok, "=", 0);
1169 if (!(dec = srd_decoder_get_by_id(keyval[0]))) {
1170 g_critical("Protocol decoder '%s' not found.", keyval[0]);
1173 if (!dec->annotations) {
1174 g_critical("Protocol decoder '%s' has no annotations.", keyval[0]);
1177 if (g_strv_length(keyval) == 2) {
1178 for (l = dec->annotations; l; l = l->next, ann++) {
1179 ann_descr = l->data;
1180 if (!canon_cmp(ann_descr[0], keyval[1]))
1185 g_critical("Annotation '%s' not found "
1186 "for protocol decoder '%s'.", keyval[1], keyval[0]);
1190 g_debug("cli: showing protocol decoder annotation %d from '%s'", ann, keyval[0]);
1191 g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann));
1200 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
1204 gpointer ann_format;
1206 /* 'cb_data' is not used in this specific callback. */
1209 if (!pd_ann_visible)
1212 if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id,
1214 /* Not in the list of PDs whose annotations we're showing. */
1217 if (pdata->ann_format != GPOINTER_TO_INT(ann_format))
1218 /* We don't want this particular format from the PD. */
1221 annotations = pdata->data;
1222 if (opt_loglevel > SR_LOG_WARN)
1223 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
1224 printf("%s: ", pdata->pdo->proto_id);
1225 for (i = 0; annotations[i]; i++)
1226 printf("\"%s\" ", annotations[i]);
1232 int setup_output_format(void)
1234 GHashTable *fmtargs;
1235 GHashTableIter iter;
1236 gpointer key, value;
1237 struct sr_output_format **outputs;
1241 if (!opt_output_format) {
1242 opt_output_format = DEFAULT_OUTPUT_FORMAT;
1243 /* we'll need to remember this so when saving to a file
1244 * later, sigrok session format will be used.
1246 default_output_format = TRUE;
1249 fmtargs = parse_generic_arg(opt_output_format, TRUE);
1250 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1252 g_critical("Invalid output format.");
1255 outputs = sr_output_list();
1256 for (i = 0; outputs[i]; i++) {
1257 if (strcmp(outputs[i]->id, fmtspec))
1259 g_hash_table_remove(fmtargs, "sigrok_key");
1260 output_format = outputs[i];
1261 g_hash_table_iter_init(&iter, fmtargs);
1262 while (g_hash_table_iter_next(&iter, &key, &value)) {
1263 /* only supporting one parameter per output module
1264 * for now, and only its value */
1265 output_format_param = g_strdup(value);
1270 if (!output_format) {
1271 g_critical("Invalid output format %s.", opt_output_format);
1274 g_hash_table_destroy(fmtargs);
1279 static int select_probes(struct sr_dev_inst *sdi)
1281 struct sr_probe *probe;
1282 GSList *selected_probes, *l;
1287 if (!(selected_probes = parse_probestring(sdi, opt_probes)))
1290 for (l = sdi->probes; l; l = l->next) {
1292 if (g_slist_find(selected_probes, probe))
1293 probe->enabled = TRUE;
1295 probe->enabled = FALSE;
1297 g_slist_free(selected_probes);
1303 * Return the input file format which the CLI tool should use.
1305 * If the user specified -I / --input-format, use that one. Otherwise, try to
1306 * autodetect the format as good as possible. Failing that, return NULL.
1308 * @param filename The filename of the input file. Must not be NULL.
1309 * @param opt The -I / --input-file option the user specified (or NULL).
1311 * @return A pointer to the 'struct sr_input_format' that should be used,
1312 * or NULL if no input format was selected or auto-detected.
1314 static struct sr_input_format *determine_input_file_format(
1315 const char *filename, const char *opt)
1318 struct sr_input_format **inputs;
1320 /* If there are no input formats, return NULL right away. */
1321 inputs = sr_input_list();
1323 g_critical("No supported input formats available.");
1327 /* If the user specified -I / --input-format, use that one. */
1329 for (i = 0; inputs[i]; i++) {
1330 if (strcasecmp(inputs[i]->id, opt))
1332 g_debug("Using user-specified input file format '%s'.",
1337 /* The user specified an unknown input format, return NULL. */
1338 g_critical("Error: specified input file format '%s' is "
1343 /* Otherwise, try to find an input module that can handle this file. */
1344 for (i = 0; inputs[i]; i++) {
1345 if (inputs[i]->format_match(filename))
1349 /* Return NULL if no input module wanted to touch this. */
1351 g_critical("Error: no matching input module found.");
1355 g_debug("cli: Autodetected '%s' input format for file '%s'.",
1356 inputs[i]->id, filename);
1361 static void load_input_file_format(void)
1363 GHashTable *fmtargs = NULL;
1365 struct sr_input *in;
1366 struct sr_input_format *input_format;
1367 char *fmtspec = NULL;
1369 if (opt_input_format) {
1370 fmtargs = parse_generic_arg(opt_input_format, TRUE);
1371 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1374 if (!(input_format = determine_input_file_format(opt_input_file,
1376 /* The exact cause was already logged. */
1381 g_hash_table_remove(fmtargs, "sigrok_key");
1383 if (stat(opt_input_file, &st) == -1) {
1384 g_critical("Failed to load %s: %s", opt_input_file,
1389 /* Initialize the input module. */
1390 if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
1391 g_critical("Failed to allocate input module.");
1394 in->format = input_format;
1395 in->param = fmtargs;
1396 if (in->format->init) {
1397 if (in->format->init(in, opt_input_file) != SR_OK) {
1398 g_critical("Input format init failed.");
1403 if (select_probes(in->sdi) > 0)
1407 sr_session_datafeed_callback_add(datafeed_in, NULL);
1408 if (sr_session_dev_add(in->sdi) != SR_OK) {
1409 g_critical("Failed to use device.");
1410 sr_session_destroy();
1414 input_format->loadfile(in, opt_input_file);
1416 sr_session_destroy();
1419 g_hash_table_destroy(fmtargs);
1422 static void load_input_file(void)
1425 if (sr_session_load(opt_input_file) == SR_OK) {
1426 /* sigrok session file */
1427 sr_session_datafeed_callback_add(datafeed_in, NULL);
1433 /* fall back on input modules */
1434 load_input_file_format();
1438 static int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
1440 const struct sr_config_info *srci;
1441 GHashTableIter iter;
1442 gpointer key, value;
1445 uint64_t tmp_u64, p, q;
1447 GVariant *val, *rational[2];
1449 g_hash_table_iter_init(&iter, args);
1450 while (g_hash_table_iter_next(&iter, &key, &value)) {
1451 if (!(srci = sr_config_info_name_get(key))) {
1452 g_critical("Unknown device option '%s'.", (char *) key);
1456 if ((value == NULL) &&
1457 (srci->datatype != SR_T_BOOL)) {
1458 g_critical("Option '%s' needs a value.", (char *)key);
1462 switch (srci->datatype) {
1464 ret = sr_parse_sizestring(value, &tmp_u64);
1467 val = g_variant_new_uint64(tmp_u64);
1470 val = g_variant_new_string(value);
1476 tmp_bool = sr_parse_boolstring(value);
1477 val = g_variant_new_boolean(tmp_bool);
1480 tmp_double = strtof(value, NULL);
1481 val = g_variant_new_double(tmp_double);
1483 case SR_T_RATIONAL_PERIOD:
1484 if ((ret = sr_parse_period(value, &p, &q)) != SR_OK)
1486 rational[0] = g_variant_new_uint64(p);
1487 rational[1] = g_variant_new_uint64(q);
1488 val = g_variant_new_tuple(rational, 2);
1490 case SR_T_RATIONAL_VOLT:
1491 if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK)
1493 rational[0] = g_variant_new_uint64(p);
1494 rational[1] = g_variant_new_uint64(q);
1495 val = g_variant_new_tuple(rational, 2);
1501 ret = sr_config_set(sdi, srci->key, val);
1503 g_critical("Failed to set device option '%s'.", (char *)key);
1511 static void set_options(void)
1513 struct sr_dev_inst *sdi;
1515 GHashTable *devargs;
1518 g_critical("No setting specified.");
1522 if (!(devargs = parse_generic_arg(opt_dev, FALSE)))
1525 if (!(devices = device_scan())) {
1526 g_critical("No devices found.");
1529 sdi = devices->data;
1531 if (sr_dev_open(sdi) != SR_OK) {
1532 g_critical("Failed to open device.");
1536 set_dev_options(sdi, devargs);
1539 g_slist_free(devices);
1540 g_hash_table_destroy(devargs);
1544 static int set_limit_time(const struct sr_dev_inst *sdi)
1548 uint64_t samplerate;
1550 if (!(time_msec = sr_parse_timestring(opt_time))) {
1551 g_critical("Invalid time '%s'", opt_time);
1555 if (sr_dev_has_option(sdi, SR_CONF_LIMIT_MSEC)) {
1556 gvar = g_variant_new_uint64(time_msec);
1557 if (sr_config_set(sdi, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) {
1558 g_critical("Failed to configure time limit.");
1561 } else if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
1562 /* Convert to samples based on the samplerate. */
1563 sr_config_get(sdi->driver, SR_CONF_SAMPLERATE, &gvar, sdi);
1564 samplerate = g_variant_get_uint64(gvar);
1565 g_variant_unref(gvar);
1566 limit_samples = (samplerate) * time_msec / (uint64_t)1000;
1567 if (limit_samples == 0) {
1568 g_critical("Not enough time at this samplerate.");
1571 gvar = g_variant_new_uint64(limit_samples);
1572 if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
1573 g_critical("Failed to configure time-based sample limit.");
1577 g_critical("This device does not support time limits.");
1584 static void run_session(void)
1587 GHashTable *devargs;
1589 struct sr_dev_inst *sdi;
1593 devices = device_scan();
1595 g_critical("No devices found.");
1598 if (g_slist_length(devices) > 1) {
1599 g_critical("sigrok-cli only supports one device for capturing.");
1602 sdi = devices->data;
1605 sr_session_datafeed_callback_add(datafeed_in, NULL);
1607 if (sr_dev_open(sdi) != SR_OK) {
1608 g_critical("Failed to open device.");
1612 if (sr_session_dev_add(sdi) != SR_OK) {
1613 g_critical("Failed to add device to session.");
1614 sr_session_destroy();
1619 if ((devargs = parse_generic_arg(opt_dev, FALSE))) {
1620 if (set_dev_options(sdi, devargs) != SR_OK)
1622 g_hash_table_destroy(devargs);
1626 if (select_probes(sdi) != SR_OK) {
1627 g_critical("Failed to set probes.");
1628 sr_session_destroy();
1633 if (!(triggerlist = sr_parse_triggerstring(sdi, opt_triggers))) {
1634 sr_session_destroy();
1637 max_probes = g_slist_length(sdi->probes);
1638 for (i = 0; i < max_probes; i++) {
1639 if (triggerlist[i]) {
1640 sr_dev_trigger_set(sdi, i, triggerlist[i]);
1641 g_free(triggerlist[i]);
1644 g_free(triggerlist);
1647 if (opt_continuous) {
1648 if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) {
1649 g_critical("This device does not support continuous sampling.");
1650 sr_session_destroy();
1656 if (set_limit_time(sdi) != SR_OK) {
1657 sr_session_destroy();
1663 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) {
1664 g_critical("Invalid sample limit '%s'.", opt_samples);
1665 sr_session_destroy();
1668 gvar = g_variant_new_uint64(limit_samples);
1669 if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
1670 g_critical("Failed to configure sample limit.");
1671 sr_session_destroy();
1677 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) {
1678 g_critical("Invalid sample limit '%s'.", opt_samples);
1679 sr_session_destroy();
1682 gvar = g_variant_new_uint64(limit_frames);
1683 if (sr_config_set(sdi, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
1684 g_critical("Failed to configure frame limit.");
1685 sr_session_destroy();
1690 if (sr_session_start() != SR_OK) {
1691 g_critical("Failed to start session.");
1692 sr_session_destroy();
1704 sr_session_destroy();
1705 g_slist_free(devices);
1709 static void logger(const gchar *log_domain, GLogLevelFlags log_level,
1710 const gchar *message, gpointer cb_data)
1716 * All messages, warnings, errors etc. go to stderr (not stdout) in
1717 * order to not mess up the CLI tool data output, e.g. VCD output.
1719 if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
1720 || opt_loglevel > SR_LOG_WARN) {
1721 fprintf(stderr, "%s\n", message);
1726 int main(int argc, char **argv)
1729 GOptionContext *context;
1732 g_log_set_default_handler(logger, NULL);
1735 context = g_option_context_new(NULL);
1736 g_option_context_add_main_entries(context, optargs, NULL);
1738 if (!g_option_context_parse(context, &argc, &argv, &error)) {
1739 g_critical("%s", error->message);
1743 /* Set the loglevel (amount of messages to output) for libsigrok. */
1744 if (sr_log_loglevel_set(opt_loglevel) != SR_OK)
1747 if (sr_init(&sr_ctx) != SR_OK)
1751 /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
1752 if (srd_log_loglevel_set(opt_loglevel) != SRD_OK)
1756 if (srd_init(NULL) != SRD_OK)
1758 if (register_pds(NULL, opt_pds) != 0)
1760 if (srd_pd_output_callback_add(SRD_OUTPUT_ANN,
1761 show_pd_annotations, NULL) != SRD_OK)
1763 if (setup_pd_stack() != 0)
1765 if (setup_pd_annotations() != 0)
1770 if (setup_output_format() != 0)
1775 else if (opt_list_devs)
1778 else if (opt_pds && opt_show)
1783 else if (opt_input_file)
1787 else if (opt_samples || opt_time || opt_frames || opt_continuous)
1790 printf("%s", g_option_context_get_help(context, TRUE, NULL));
1803 g_option_context_free(context);