2 * This file is part of the sigrok 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;
275 if (sdi->vendor && sdi->vendor[0])
276 printf("%s ", sdi->vendor);
277 if (sdi->model && sdi->model[0])
278 printf("%s ", sdi->model);
279 if (sdi->version && sdi->version[0])
280 printf("%s ", sdi->version);
282 if (g_slist_length(sdi->probes) == 1) {
283 probe = sdi->probes->data;
284 printf("with 1 probe: %s", probe->name);
286 printf("with %d probes:", g_slist_length(sdi->probes));
287 for (l = sdi->probes; l; l = l->next) {
289 printf(" %s", probe->name);
296 static void show_dev_list(void)
298 struct sr_dev_inst *sdi;
301 if (!(devices = device_scan()))
304 printf("The following devices were found:\n");
305 for (l = devices; l; l = l->next) {
309 g_slist_free(devices);
313 static void show_dev_detail(void)
315 struct sr_dev_inst *sdi;
316 const struct sr_config_info *srci;
317 struct sr_rational *rationals;
319 GVariant *gvar_opts, *gvar_dict, *gvar_list, *gvar;
320 gsize num_opts, num_elements;
321 const uint64_t *integers;
323 unsigned int num_devices, tmp_bool, o, i;
325 const char *charopts, **stropts;
327 if (!(devices = device_scan())) {
328 g_critical("No devices found.");
332 num_devices = g_slist_length(devices);
333 if (num_devices > 1) {
334 g_critical("%d devices found. Use --list-devices to show them, "
335 "and --device to select one.", num_devices);
342 /* This properly opens and initializes the device, so we can get
343 * current settings. */
345 if (sr_session_dev_add(sdi) != SR_OK) {
346 g_critical("Failed to use device.");
350 if ((sr_config_list(sdi->driver, SR_CONF_SCAN_OPTIONS, &gvar_opts,
352 opts = g_variant_get_fixed_array(gvar_opts, &num_elements,
354 printf("Supported driver options:\n");
355 for (i = 0; i < num_elements; i++) {
356 if (!(srci = sr_config_info_get(opts[i])))
358 printf(" %s\n", srci->id);
360 g_variant_unref(gvar_opts);
363 if ((sr_config_list(sdi->driver, SR_CONF_DEVICE_OPTIONS, &gvar_opts,
365 /* Driver supports no device instance options. */
368 printf("Supported device options:\n");
369 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(int32_t));
370 for (o = 0; o < num_opts; o++) {
371 if (!(srci = sr_config_info_get(opts[o])))
374 if (srci->key == SR_CONF_TRIGGER_TYPE) {
375 if (sr_config_list(sdi->driver, srci->key, &gvar,
380 charopts = g_variant_get_string(gvar, NULL);
381 printf(" Supported triggers: ");
383 printf("%c ", *charopts);
387 g_variant_unref(gvar);
389 } else if (srci->key == SR_CONF_PATTERN_MODE) {
391 /* Pattern generator modes */
392 printf(" %s", srci->id);
393 if (sr_config_list(sdi->driver, srci->key, &gvar,
395 // stropts = g_variant_get_fixed_array(gvar, &num_elements,
397 printf(" - supported patterns:\n");
398 for (i = 0; stropts[i]; i++)
399 printf(" %s\n", stropts[i]);
400 g_variant_unref(gvar);
405 } else if (srci->key == SR_CONF_SAMPLERATE) {
406 /* Supported samplerates */
407 printf(" %s", srci->id);
408 if (sr_config_list(sdi->driver, SR_CONF_SAMPLERATE,
409 &gvar_dict, sdi) != SR_OK) {
413 if ((gvar_list = g_variant_lookup_value(gvar_dict,
414 "samplerates", G_VARIANT_TYPE("at")))) {
415 integers = g_variant_get_fixed_array(gvar_list,
416 &num_elements, sizeof(uint64_t));
417 printf(" - supported samplerates:\n");
418 for (i = 0; i < num_elements; i++)
419 printf(" %s\n", sr_samplerate_string(integers[i]));
420 } if ((gvar_list = g_variant_lookup_value(gvar_dict,
421 "samplerate-steps", G_VARIANT_TYPE("at")))) {
422 integers = g_variant_get_fixed_array(gvar_list,
423 &num_elements, sizeof(uint64_t));
425 if (!(s = sr_samplerate_string(integers[0])))
430 if (!(s = sr_samplerate_string(integers[1])))
435 if (!(s = sr_samplerate_string(integers[2])))
437 printf(" in steps of %s)\n", s);
440 g_variant_unref(gvar_dict);
442 } else if (srci->key == SR_CONF_BUFFERSIZE) {
443 /* Supported buffer sizes */
444 printf(" %s", srci->id);
445 if (sr_config_list(sdi->driver, SR_CONF_BUFFERSIZE,
446 (const void **)&integers, sdi) != SR_OK) {
450 printf(" - supported buffer sizes:\n");
451 for (i = 0; integers[i]; i++)
452 printf(" %"PRIu64"\n", integers[i]);
454 } else if (srci->key == SR_CONF_TIMEBASE) {
455 /* Supported time bases */
456 printf(" %s", srci->id);
457 if (sr_config_list(sdi->driver, SR_CONF_TIMEBASE,
458 (const void **)&rationals, sdi) != SR_OK) {
462 printf(" - supported time bases:\n");
463 for (i = 0; rationals[i].p && rationals[i].q; i++)
464 printf(" %s\n", sr_period_string(
465 rationals[i].p * rationals[i].q));
467 } else if (srci->key == SR_CONF_TRIGGER_SOURCE) {
468 /* Supported trigger sources */
469 printf(" %s", srci->id);
470 if (sr_config_list(sdi->driver, SR_CONF_TRIGGER_SOURCE,
471 (const void **)&stropts, sdi) != SR_OK) {
475 printf(" - supported trigger sources:\n");
476 for (i = 0; stropts[i]; i++)
477 printf(" %s\n", stropts[i]);
479 } else if (srci->key == SR_CONF_FILTER) {
480 /* Supported filters */
481 printf(" %s", srci->id);
482 if (sr_config_list(sdi->driver, SR_CONF_FILTER,
483 (const void **)&stropts, sdi) != SR_OK) {
487 printf(" - supported filter targets:\n");
488 for (i = 0; stropts[i]; i++)
489 printf(" %s\n", stropts[i]);
491 } else if (srci->key == SR_CONF_VDIV) {
492 /* Supported volts/div values */
493 printf(" %s", srci->id);
494 if (sr_config_list(sdi->driver, SR_CONF_VDIV,
495 (const void **)&rationals, sdi) != SR_OK) {
499 printf(" - supported volts/div:\n");
500 for (i = 0; rationals[i].p && rationals[i].q; i++)
501 printf(" %s\n", sr_voltage_string( &rationals[i]));
503 } else if (srci->key == SR_CONF_COUPLING) {
504 /* Supported coupling settings */
505 printf(" %s", srci->id);
506 if (sr_config_list(sdi->driver, SR_CONF_COUPLING,
507 (const void **)&stropts, sdi) != SR_OK) {
511 printf(" - supported coupling options:\n");
512 for (i = 0; stropts[i]; i++)
513 printf(" %s\n", stropts[i]);
515 } else if (srci->key == SR_CONF_DATALOG) {
516 /* Turning on/off internal data logging. */
517 printf(" %s\t(on/off", srci->id);
518 if (sr_config_get(sdi->driver, SR_CONF_DATALOG,
519 &gvar, sdi) == SR_OK) {
520 tmp_bool = g_variant_get_boolean(gvar);
521 printf(", currently %s", tmp_bool ? "on" : "off");
525 /* Everything else */
526 printf(" %s\n", srci->id);
529 g_variant_unref(gvar_opts);
531 sr_session_destroy();
536 static void show_pd_detail(void)
539 struct srd_decoder *dec;
540 struct srd_decoder_option *o;
541 char **pdtokens, **pdtok, *optsep, **ann, *val, *doc;
544 pdtokens = g_strsplit(opt_pds, ",", -1);
545 for (pdtok = pdtokens; *pdtok; pdtok++) {
547 if ((optsep = strchr(*pdtok, ':')))
549 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
550 g_critical("Protocol decoder %s not found.", *pdtok);
553 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
554 dec->id, dec->name, dec->longname, dec->desc);
555 printf("License: %s\n", dec->license);
556 printf("Annotations:\n");
557 if (dec->annotations) {
558 for (l = dec->annotations; l; l = l->next) {
560 printf("- %s\n %s\n", ann[0], ann[1]);
565 printf("Required probes:\n");
567 for (l = dec->probes; l; l = l->next) {
569 printf("- %s (%s): %s\n",
570 p->name, p->id, p->desc);
575 printf("Optional probes:\n");
576 if (dec->opt_probes) {
577 for (l = dec->opt_probes; l; l = l->next) {
579 printf("- %s (%s): %s\n",
580 p->name, p->id, p->desc);
586 printf("Options:\n");
587 for (l = dec->options; l; l = l->next) {
589 val = g_variant_print(o->def, FALSE);
590 printf("- %s: %s (default %s)\n", o->id, o->desc, val);
594 if ((doc = srd_decoder_doc_get(dec))) {
595 printf("Documentation:\n%s\n",
596 doc[0] == '\n' ? doc + 1 : doc);
601 g_strfreev(pdtokens);
605 static GArray *get_enabled_logic_probes(const struct sr_dev_inst *sdi)
607 struct sr_probe *probe;
611 probes = g_array_new(FALSE, FALSE, sizeof(int));
612 for (l = sdi->probes; l; l = l->next) {
614 if (probe->type != SR_PROBE_LOGIC)
616 if (probe->enabled != TRUE)
618 g_array_append_val(probes, probe->index);
624 static void datafeed_in(const struct sr_dev_inst *sdi,
625 const struct sr_datafeed_packet *packet)
627 const struct sr_datafeed_meta *meta;
628 const struct sr_datafeed_logic *logic;
629 const struct sr_datafeed_analog *analog;
630 struct sr_config *src;
631 static struct sr_output *o = NULL;
632 static GArray *logic_probelist = NULL;
633 static uint64_t received_samples = 0;
634 static int unitsize = 0;
635 static int triggered = 0;
636 static FILE *outfile = NULL;
640 int sample_size, ret;
641 uint64_t samplerate, output_len, filter_out_len;
642 uint8_t *output_buf, *filter_out;
644 /* If the first packet to come in isn't a header, don't even try. */
645 if (packet->type != SR_DF_HEADER && o == NULL)
649 switch (packet->type) {
651 g_debug("cli: Received SR_DF_HEADER");
652 /* Initialize the output module. */
653 if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
654 g_critical("Output module malloc failed.");
657 o->format = output_format;
658 o->sdi = (struct sr_dev_inst *)sdi;
659 o->param = output_format_param;
660 if (o->format->init) {
661 if (o->format->init(o) != SR_OK) {
662 g_critical("Output format initialization failed.");
667 /* Prepare non-stdout output. */
669 if (opt_output_file) {
670 if (default_output_format) {
671 /* output file is in session format, so we'll
672 * keep a copy of everything as it comes in
673 * and save from there after the session. */
675 savebuf = g_byte_array_new();
677 /* saving to a file in whatever format was set
678 * with --format, so all we need is a filehandle */
679 outfile = g_fopen(opt_output_file, "wb");
683 /* Prepare for logic data. */
684 logic_probelist = get_enabled_logic_probes(sdi);
685 /* How many bytes we need to store the packed samples. */
686 unitsize = (logic_probelist->len + 7) / 8;
689 if (opt_pds && logic_probelist->len) {
690 if (sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
691 &gvar, sdi) != SR_OK) {
692 g_critical("Unable to initialize protocol "
693 "decoders: no samplerate found.");
696 samplerate = g_variant_get_uint64(gvar);
697 g_variant_unref(gvar);
698 srd_session_start(logic_probelist->len, unitsize, samplerate);
704 g_debug("cli: received SR_DF_META");
705 meta = packet->payload;
706 for (l = meta->config; l; l = l->next) {
709 case SR_CONF_SAMPLERATE:
710 samplerate = g_variant_get_uint64(src->data);
711 g_debug("cli: got samplerate %"PRIu64" Hz", samplerate);
713 case SR_CONF_SAMPLE_INTERVAL:
714 samplerate = g_variant_get_uint64(src->data);
715 g_debug("cli: got sample interval %"PRIu64" ms", samplerate);
718 /* Unknown metadata is not an error. */
725 g_debug("cli: received SR_DF_TRIGGER");
726 if (o->format->event)
727 o->format->event(o, SR_DF_TRIGGER, &output_buf,
733 logic = packet->payload;
734 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
735 sample_size = logic->unitsize;
736 if (logic->length == 0)
739 /* Don't store any samples until triggered. */
740 if (opt_wait_trigger && !triggered)
743 if (limit_samples && received_samples >= limit_samples)
746 ret = sr_filter_probes(sample_size, unitsize, logic_probelist,
747 logic->data, logic->length,
748 &filter_out, &filter_out_len);
752 /* What comes out of the filter is guaranteed to be packed into the
753 * minimum size needed to support the number of samples at this sample
754 * size. however, the driver may have submitted too much -- cut off
755 * the buffer of the last packet according to the sample limit.
757 if (limit_samples && (received_samples + logic->length / sample_size >
758 limit_samples * sample_size))
759 filter_out_len = limit_samples * sample_size - received_samples;
761 if (opt_output_file && default_output_format) {
762 /* Saving to a session file. */
763 g_byte_array_append(savebuf, filter_out, filter_out_len);
767 if (srd_session_send(received_samples, (uint8_t*)filter_out,
768 filter_out_len) != SRD_OK)
773 if (o->format->data && packet->type == o->format->df_type)
774 o->format->data(o, filter_out, filter_out_len,
775 &output_buf, &output_len);
777 fwrite(output_buf, 1, output_len, outfile);
785 received_samples += logic->length / sample_size;
789 analog = packet->payload;
790 g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples);
791 if (analog->num_samples == 0)
794 if (limit_samples && received_samples >= limit_samples)
797 if (o->format->data && packet->type == o->format->df_type) {
798 o->format->data(o, (const uint8_t *)analog->data,
799 analog->num_samples * sizeof(float),
800 &output_buf, &output_len);
802 fwrite(output_buf, 1, output_len, outfile);
808 received_samples += analog->num_samples;
811 case SR_DF_FRAME_BEGIN:
812 g_debug("cli: received SR_DF_FRAME_BEGIN");
813 if (o->format->event) {
814 o->format->event(o, SR_DF_FRAME_BEGIN, &output_buf,
817 fwrite(output_buf, 1, output_len, outfile);
824 case SR_DF_FRAME_END:
825 g_debug("cli: received SR_DF_FRAME_END");
826 if (o->format->event) {
827 o->format->event(o, SR_DF_FRAME_END, &output_buf,
830 fwrite(output_buf, 1, output_len, outfile);
841 if (o && o->format->recv) {
842 out = o->format->recv(o, sdi, packet);
843 if (out && out->len) {
844 fwrite(out->str, 1, out->len, outfile);
849 /* SR_DF_END needs to be handled after the output module's recv()
850 * is called, so it can properly clean up that module etc. */
851 if (packet->type == SR_DF_END) {
852 g_debug("cli: Received SR_DF_END");
854 if (o->format->event) {
855 o->format->event(o, SR_DF_END, &output_buf, &output_len);
858 fwrite(output_buf, 1, output_len, outfile);
864 if (limit_samples && received_samples < limit_samples)
865 g_warning("Device only sent %" PRIu64 " samples.",
869 g_warning("Device stopped after %" PRIu64 " samples.",
872 g_array_free(logic_probelist, TRUE);
874 if (o->format->cleanup)
875 o->format->cleanup(o);
879 if (outfile && outfile != stdout)
882 if (opt_output_file && default_output_format) {
883 if (sr_session_save(opt_output_file, sdi, savebuf->data,
884 unitsize, savebuf->len / unitsize) != SR_OK)
885 g_critical("Failed to save session.");
886 g_byte_array_free(savebuf, FALSE);
893 static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash,
894 GHashTable **options)
896 struct srd_decoder_option *o;
901 char *val_str, *conv;
904 *options = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
905 (GDestroyNotify)g_variant_unref);
907 for (optl = dec->options; optl; optl = optl->next) {
909 if (!(val_str = g_hash_table_lookup(hash, o->id)))
912 if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_STRING)) {
913 gvar = g_variant_new_string(val_str);
914 } else if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_INT64)) {
915 val_int = strtoll(val_str, &conv, 10);
916 if (!conv || conv == val_str) {
917 g_critical("Protocol decoder '%s' option '%s' "
918 "requires a number.", dec->name, o->id);
922 gvar = g_variant_new_int64(val_int);
924 g_critical("Unsupported type for option '%s' (%s)",
925 o->id, g_variant_get_type_string(o->def));
929 g_variant_ref_sink(gvar);
930 g_hash_table_insert(*options, g_strdup(o->id), gvar);
931 g_hash_table_remove(hash, o->id);
937 static int probes_to_gvar(struct srd_decoder *dec, GHashTable *hash,
941 GSList *all_probes, *l;
945 char *val_str, *conv;
948 *probes = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
949 (GDestroyNotify)g_variant_unref);
951 all_probes = g_slist_copy(dec->probes);
952 all_probes = g_slist_concat(all_probes, dec->opt_probes);
953 for (l = all_probes; l; l = l->next) {
955 if (!(val_str = g_hash_table_lookup(hash, p->id)))
958 val_int = strtoll(val_str, &conv, 10);
959 if (!conv || conv == val_str) {
960 g_critical("Protocol decoder '%s' probes '%s' "
961 "is not a number.", dec->name, p->id);
965 gvar = g_variant_new_int32(val_int);
966 g_variant_ref_sink(gvar);
967 g_hash_table_insert(*probes, g_strdup(p->id), gvar);
968 g_hash_table_remove(hash, p->id);
970 g_slist_free(all_probes);
975 /* Register the given PDs for this session.
976 * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
977 * That will instantiate two SPI decoders on the clock but different data
980 static int register_pds(struct sr_dev *dev, const char *pdstring)
982 struct srd_decoder *dec;
983 GHashTable *pd_opthash, *options, *probes;
985 struct srd_decoder_inst *di;
987 char **pdtokens, **pdtok, *pd_name;
992 pd_ann_visible = g_hash_table_new_full(g_str_hash, g_int_equal,
995 pd_opthash = options = probes = NULL;
996 pdtokens = g_strsplit(pdstring, ",", 0);
997 for (pdtok = pdtokens; *pdtok; pdtok++) {
998 if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) {
999 g_critical("Invalid protocol decoder option '%s'.", *pdtok);
1003 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
1004 g_hash_table_remove(pd_opthash, "sigrok_key");
1005 if (srd_decoder_load(pd_name) != SRD_OK) {
1006 g_critical("Failed to load protocol decoder %s.", pd_name);
1010 dec = srd_decoder_get_by_id(pd_name);
1012 /* Convert decoder option and probe values to GVariant. */
1013 if (!opts_to_gvar(dec, pd_opthash, &options)) {
1017 if (!probes_to_gvar(dec, pd_opthash, &probes)) {
1021 if (g_hash_table_size(pd_opthash) > 0) {
1022 leftover = g_hash_table_get_keys(pd_opthash);
1023 for (l = leftover; l; l = l->next)
1024 g_critical("Unknown option or probe '%s'", (char *)l->data);
1025 g_list_free(leftover);
1029 if (!(di = srd_inst_new(pd_name, options))) {
1030 g_critical("Failed to instantiate protocol decoder %s.", pd_name);
1035 /* If no annotation list was specified, add them all in now.
1036 * This will be pared down later to leave only the last PD
1039 if (!opt_pd_annotations)
1040 g_hash_table_insert(pd_ann_visible,
1041 g_strdup(di->inst_id), NULL);
1043 /* Remap the probes if needed. */
1044 if (srd_inst_probe_set_all(di, probes) != SRD_OK) {
1050 g_strfreev(pdtokens);
1052 g_hash_table_destroy(pd_opthash);
1054 g_hash_table_destroy(options);
1056 g_hash_table_destroy(probes);
1063 int setup_pd_stack(void)
1065 struct srd_decoder_inst *di_from, *di_to;
1069 /* Set up the protocol decoder stack. */
1070 pds = g_strsplit(opt_pds, ",", 0);
1071 if (g_strv_length(pds) > 1) {
1073 /* A stack setup was specified, use that. */
1075 pds = g_strsplit(opt_pd_stack, ",", 0);
1076 if (g_strv_length(pds) < 2) {
1078 g_critical("Specify at least two protocol decoders to stack.");
1083 /* First PD goes at the bottom of the stack. */
1084 ids = g_strsplit(pds[0], ":", 0);
1085 if (!(di_from = srd_inst_find_by_id(ids[0]))) {
1087 g_critical("Cannot stack protocol decoder '%s': "
1088 "instance not found.", pds[0]);
1093 /* Every subsequent PD goes on top. */
1094 for (i = 1; pds[i]; i++) {
1095 ids = g_strsplit(pds[i], ":", 0);
1096 if (!(di_to = srd_inst_find_by_id(ids[0]))) {
1098 g_critical("Cannot stack protocol decoder '%s': "
1099 "instance not found.", pds[i]);
1103 if ((ret = srd_inst_stack(di_from, di_to)) != SRD_OK)
1106 /* Don't show annotation from this PD. Only the last PD in
1107 * the stack will be left on the annotation list (unless
1108 * the annotation list was specifically provided).
1110 if (!opt_pd_annotations)
1111 g_hash_table_remove(pd_ann_visible,
1122 int setup_pd_annotations(void)
1125 struct srd_decoder *dec;
1127 char **pds, **pdtok, **keyval, **ann_descr;
1129 /* Set up custom list of PDs and annotations to show. */
1130 if (opt_pd_annotations) {
1131 pds = g_strsplit(opt_pd_annotations, ",", 0);
1132 for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
1134 keyval = g_strsplit(*pdtok, "=", 0);
1135 if (!(dec = srd_decoder_get_by_id(keyval[0]))) {
1136 g_critical("Protocol decoder '%s' not found.", keyval[0]);
1139 if (!dec->annotations) {
1140 g_critical("Protocol decoder '%s' has no annotations.", keyval[0]);
1143 if (g_strv_length(keyval) == 2) {
1144 for (l = dec->annotations; l; l = l->next, ann++) {
1145 ann_descr = l->data;
1146 if (!canon_cmp(ann_descr[0], keyval[1]))
1151 g_critical("Annotation '%s' not found "
1152 "for protocol decoder '%s'.", keyval[1], keyval[0]);
1156 g_debug("cli: showing protocol decoder annotation %d from '%s'", ann, keyval[0]);
1157 g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann));
1166 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
1170 gpointer ann_format;
1172 /* 'cb_data' is not used in this specific callback. */
1175 if (!pd_ann_visible)
1178 if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id,
1180 /* Not in the list of PDs whose annotations we're showing. */
1183 if (pdata->ann_format != GPOINTER_TO_INT(ann_format))
1184 /* We don't want this particular format from the PD. */
1187 annotations = pdata->data;
1188 if (opt_loglevel > SR_LOG_WARN)
1189 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
1190 printf("%s: ", pdata->pdo->proto_id);
1191 for (i = 0; annotations[i]; i++)
1192 printf("\"%s\" ", annotations[i]);
1198 int setup_output_format(void)
1200 GHashTable *fmtargs;
1201 GHashTableIter iter;
1202 gpointer key, value;
1203 struct sr_output_format **outputs;
1207 if (!opt_output_format) {
1208 opt_output_format = DEFAULT_OUTPUT_FORMAT;
1209 /* we'll need to remember this so when saving to a file
1210 * later, sigrok session format will be used.
1212 default_output_format = TRUE;
1215 fmtargs = parse_generic_arg(opt_output_format, TRUE);
1216 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1218 g_critical("Invalid output format.");
1221 outputs = sr_output_list();
1222 for (i = 0; outputs[i]; i++) {
1223 if (strcmp(outputs[i]->id, fmtspec))
1225 g_hash_table_remove(fmtargs, "sigrok_key");
1226 output_format = outputs[i];
1227 g_hash_table_iter_init(&iter, fmtargs);
1228 while (g_hash_table_iter_next(&iter, &key, &value)) {
1229 /* only supporting one parameter per output module
1230 * for now, and only its value */
1231 output_format_param = g_strdup(value);
1236 if (!output_format) {
1237 g_critical("Invalid output format %s.", opt_output_format);
1240 g_hash_table_destroy(fmtargs);
1245 static int select_probes(struct sr_dev_inst *sdi)
1247 struct sr_probe *probe;
1248 GSList *selected_probes, *l;
1253 if (!(selected_probes = parse_probestring(sdi, opt_probes)))
1256 for (l = sdi->probes; l; l = l->next) {
1258 if (g_slist_find(selected_probes, probe))
1259 probe->enabled = TRUE;
1261 probe->enabled = FALSE;
1263 g_slist_free(selected_probes);
1269 * Return the input file format which the CLI tool should use.
1271 * If the user specified -I / --input-format, use that one. Otherwise, try to
1272 * autodetect the format as good as possible. Failing that, return NULL.
1274 * @param filename The filename of the input file. Must not be NULL.
1275 * @param opt The -I / --input-file option the user specified (or NULL).
1277 * @return A pointer to the 'struct sr_input_format' that should be used,
1278 * or NULL if no input format was selected or auto-detected.
1280 static struct sr_input_format *determine_input_file_format(
1281 const char *filename, const char *opt)
1284 struct sr_input_format **inputs;
1286 /* If there are no input formats, return NULL right away. */
1287 inputs = sr_input_list();
1289 g_critical("No supported input formats available.");
1293 /* If the user specified -I / --input-format, use that one. */
1295 for (i = 0; inputs[i]; i++) {
1296 if (strcasecmp(inputs[i]->id, opt))
1298 g_debug("Using user-specified input file format '%s'.",
1303 /* The user specified an unknown input format, return NULL. */
1304 g_critical("Error: specified input file format '%s' is "
1309 /* Otherwise, try to find an input module that can handle this file. */
1310 for (i = 0; inputs[i]; i++) {
1311 if (inputs[i]->format_match(filename))
1315 /* Return NULL if no input module wanted to touch this. */
1317 g_critical("Error: no matching input module found.");
1321 g_debug("cli: Autodetected '%s' input format for file '%s'.",
1322 inputs[i]->id, filename);
1327 static void load_input_file_format(void)
1329 GHashTable *fmtargs = NULL;
1331 struct sr_input *in;
1332 struct sr_input_format *input_format;
1333 char *fmtspec = NULL;
1335 if (opt_input_format) {
1336 fmtargs = parse_generic_arg(opt_input_format, TRUE);
1337 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1340 if (!(input_format = determine_input_file_format(opt_input_file,
1342 /* The exact cause was already logged. */
1347 g_hash_table_remove(fmtargs, "sigrok_key");
1349 if (stat(opt_input_file, &st) == -1) {
1350 g_critical("Failed to load %s: %s", opt_input_file,
1355 /* Initialize the input module. */
1356 if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
1357 g_critical("Failed to allocate input module.");
1360 in->format = input_format;
1361 in->param = fmtargs;
1362 if (in->format->init) {
1363 if (in->format->init(in, opt_input_file) != SR_OK) {
1364 g_critical("Input format init failed.");
1369 if (select_probes(in->sdi) > 0)
1373 sr_session_datafeed_callback_add(datafeed_in);
1374 if (sr_session_dev_add(in->sdi) != SR_OK) {
1375 g_critical("Failed to use device.");
1376 sr_session_destroy();
1380 input_format->loadfile(in, opt_input_file);
1382 sr_session_destroy();
1385 g_hash_table_destroy(fmtargs);
1388 static void load_input_file(void)
1391 if (sr_session_load(opt_input_file) == SR_OK) {
1392 /* sigrok session file */
1393 sr_session_datafeed_callback_add(datafeed_in);
1399 /* fall back on input modules */
1400 load_input_file_format();
1404 static int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
1406 const struct sr_config_info *srci;
1407 GHashTableIter iter;
1408 gpointer key, value;
1412 struct sr_rational tmp_rat;
1416 g_hash_table_iter_init(&iter, args);
1417 while (g_hash_table_iter_next(&iter, &key, &value)) {
1418 if (!(srci = sr_config_info_name_get(key))) {
1419 g_critical("Unknown device option '%s'.", (char *) key);
1423 if ((value == NULL) &&
1424 (srci->datatype != SR_T_BOOL)) {
1425 g_critical("Option '%s' needs a value.", (char *)key);
1429 switch (srci->datatype) {
1431 ret = sr_parse_sizestring(value, &tmp_u64);
1443 tmp_bool = sr_parse_boolstring(value);
1447 tmp_float = strtof(value, NULL);
1450 case SR_T_RATIONAL_PERIOD:
1451 if ((ret = sr_parse_period(value, &tmp_rat)) != SR_OK)
1455 case SR_T_RATIONAL_VOLT:
1456 if ((ret = sr_parse_voltage(value, &tmp_rat)) != SR_OK)
1464 ret = sr_config_set(sdi, srci->key, val);
1466 g_critical("Failed to set device option '%s'.", (char *)key);
1474 static void set_options(void)
1476 struct sr_dev_inst *sdi;
1478 GHashTable *devargs;
1481 g_critical("No setting specified.");
1485 if (!(devargs = parse_generic_arg(opt_dev, FALSE)))
1488 if (!(devices = device_scan())) {
1489 g_critical("No devices found.");
1492 sdi = devices->data;
1495 if (sr_session_dev_add(sdi) != SR_OK) {
1496 g_critical("Failed to use device.");
1500 set_dev_options(sdi, devargs);
1502 sr_session_destroy();
1503 g_slist_free(devices);
1504 g_hash_table_destroy(devargs);
1508 static int set_limit_time(const struct sr_dev_inst *sdi)
1512 uint64_t samplerate;
1514 if (!(time_msec = sr_parse_timestring(opt_time))) {
1515 g_critical("Invalid time '%s'", opt_time);
1519 if (sr_dev_has_option(sdi, SR_CONF_LIMIT_MSEC)) {
1520 gvar = g_variant_new_uint64(time_msec);
1521 if (sr_config_set(sdi, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) {
1522 g_critical("Failed to configure time limit.");
1525 } else if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
1526 /* Convert to samples based on the samplerate. */
1527 sr_config_get(sdi->driver, SR_CONF_SAMPLERATE, &gvar, sdi);
1528 samplerate = g_variant_get_uint64(gvar);
1529 g_variant_unref(gvar);
1530 limit_samples = (samplerate) * time_msec / (uint64_t)1000;
1531 if (limit_samples == 0) {
1532 g_critical("Not enough time at this samplerate.");
1535 gvar = g_variant_new_uint64(limit_samples);
1536 if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
1537 g_critical("Failed to configure time-based sample limit.");
1541 g_critical("This device does not support time limits.");
1548 static void run_session(void)
1551 GHashTable *devargs;
1553 struct sr_dev_inst *sdi;
1557 devices = device_scan();
1559 g_critical("No devices found.");
1562 if (g_slist_length(devices) > 1) {
1563 g_critical("sigrok-cli only supports one device for capturing.");
1566 sdi = devices->data;
1569 sr_session_datafeed_callback_add(datafeed_in);
1571 if (sr_session_dev_add(sdi) != SR_OK) {
1572 g_critical("Failed to use device.");
1573 sr_session_destroy();
1578 if ((devargs = parse_generic_arg(opt_dev, FALSE))) {
1579 if (set_dev_options(sdi, devargs) != SR_OK)
1581 g_hash_table_destroy(devargs);
1585 if (select_probes(sdi) != SR_OK) {
1586 g_critical("Failed to set probes.");
1587 sr_session_destroy();
1592 if (!(triggerlist = sr_parse_triggerstring(sdi, opt_triggers))) {
1593 sr_session_destroy();
1596 max_probes = g_slist_length(sdi->probes);
1597 for (i = 0; i < max_probes; i++) {
1598 if (triggerlist[i]) {
1599 sr_dev_trigger_set(sdi, i, triggerlist[i]);
1600 g_free(triggerlist[i]);
1603 g_free(triggerlist);
1606 if (opt_continuous) {
1607 if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) {
1608 g_critical("This device does not support continuous sampling.");
1609 sr_session_destroy();
1615 if (set_limit_time(sdi) != SR_OK) {
1616 sr_session_destroy();
1622 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) {
1623 g_critical("Invalid sample limit '%s'.", opt_samples);
1624 sr_session_destroy();
1627 gvar = g_variant_new_uint64(limit_samples);
1628 if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
1629 g_critical("Failed to configure sample limit.");
1630 sr_session_destroy();
1636 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) {
1637 g_critical("Invalid sample limit '%s'.", opt_samples);
1638 sr_session_destroy();
1641 if (sr_config_set(sdi, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
1642 g_critical("Failed to configure frame limit.");
1643 sr_session_destroy();
1648 if (sr_session_start() != SR_OK) {
1649 g_critical("Failed to start session.");
1650 sr_session_destroy();
1662 sr_session_destroy();
1663 g_slist_free(devices);
1667 static void logger(const gchar *log_domain, GLogLevelFlags log_level,
1668 const gchar *message, gpointer cb_data)
1674 * All messages, warnings, errors etc. go to stderr (not stdout) in
1675 * order to not mess up the CLI tool data output, e.g. VCD output.
1677 if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
1678 || opt_loglevel > SR_LOG_WARN) {
1679 fprintf(stderr, "%s\n", message);
1684 int main(int argc, char **argv)
1687 GOptionContext *context;
1690 g_log_set_default_handler(logger, NULL);
1693 context = g_option_context_new(NULL);
1694 g_option_context_add_main_entries(context, optargs, NULL);
1696 if (!g_option_context_parse(context, &argc, &argv, &error)) {
1697 g_critical("%s", error->message);
1701 /* Set the loglevel (amount of messages to output) for libsigrok. */
1702 if (sr_log_loglevel_set(opt_loglevel) != SR_OK)
1705 if (sr_init(&sr_ctx) != SR_OK)
1709 /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
1710 if (srd_log_loglevel_set(opt_loglevel) != SRD_OK)
1714 if (srd_init(NULL) != SRD_OK)
1716 if (register_pds(NULL, opt_pds) != 0)
1718 if (srd_pd_output_callback_add(SRD_OUTPUT_ANN,
1719 show_pd_annotations, NULL) != SRD_OK)
1721 if (setup_pd_stack() != 0)
1723 if (setup_pd_annotations() != 0)
1728 if (setup_output_format() != 0)
1733 else if (opt_list_devs)
1736 else if (opt_pds && opt_show)
1741 else if (opt_input_file)
1745 else if (opt_samples || opt_time || opt_frames || opt_continuous)
1748 printf("%s", g_option_context_get_help(context, TRUE, NULL));
1761 g_option_context_free(context);