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/>.
20 #include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
28 #include <sys/types.h>
32 #include <glib/gstdio.h>
33 #include <libsigrok/libsigrok.h>
34 #include "sigrok-cli.h"
37 #define DEFAULT_OUTPUT_FORMAT "bits:width=64"
39 static uint64_t limit_samples = 0;
40 static uint64_t limit_frames = 0;
41 static struct sr_output_format *output_format = NULL;
42 static int default_output_format = FALSE;
43 static char *output_format_param = NULL;
44 static GHashTable *pd_ann_visible = NULL;
45 static struct sr_datastore *singleds = NULL;
47 static gboolean opt_version = FALSE;
48 static gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
49 static gboolean opt_list_devs = FALSE;
50 static gboolean opt_wait_trigger = FALSE;
51 static gchar *opt_input_file = NULL;
52 static gchar *opt_output_file = NULL;
53 static gchar *opt_drv = NULL;
54 static gchar *opt_dev = NULL;
55 static gchar *opt_probes = NULL;
56 static gchar *opt_triggers = NULL;
57 static gchar *opt_pds = NULL;
58 static gchar *opt_pd_stack = NULL;
59 static gchar *opt_pd_annotations = NULL;
60 static gchar *opt_input_format = NULL;
61 static gchar *opt_output_format = NULL;
62 static gchar *opt_show = NULL;
63 static gchar *opt_time = NULL;
64 static gchar *opt_samples = NULL;
65 static gchar *opt_frames = NULL;
66 static gchar *opt_continuous = NULL;
68 static GOptionEntry optargs[] = {
69 {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version,
70 "Show version and support list", NULL},
71 {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel,
72 "Set libsigrok/libsigrokdecode loglevel", NULL},
73 {"list-devices", 'D', 0, G_OPTION_ARG_NONE, &opt_list_devs,
74 "Scan for devices", NULL},
75 {"driver", 0, 0, G_OPTION_ARG_STRING, &opt_drv,
76 "Use only this driver", NULL},
77 {"device", 'd', 0, G_OPTION_ARG_STRING, &opt_dev,
78 "Use specified device", NULL},
79 {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file,
80 "Load input from file", NULL},
81 {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format,
82 "Input format", NULL},
83 {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file,
84 "Save output to file", NULL},
85 {"output-format", 'O', 0, G_OPTION_ARG_STRING, &opt_output_format,
86 "Output format", NULL},
87 {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes,
88 "Probes to use", NULL},
89 {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers,
90 "Trigger configuration", NULL},
91 {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
92 "Wait for trigger", NULL},
93 {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds,
94 "Protocol decoders to run", NULL},
95 {"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING, &opt_pd_stack,
96 "Protocol decoder stack", NULL},
97 {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_STRING, &opt_pd_annotations,
98 "Protocol decoder annotation(s) to show", NULL},
99 {"show", 0, 0, G_OPTION_ARG_NONE, &opt_show,
100 "Show device detail", NULL},
101 {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time,
102 "How long to sample (ms)", NULL},
103 {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples,
104 "Number of samples to acquire", NULL},
105 {"frames", 0, 0, G_OPTION_ARG_STRING, &opt_frames,
106 "Number of frames to acquire", NULL},
107 {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous,
108 "Sample continuously", NULL},
109 {NULL, 0, 0, 0, NULL, NULL, NULL}
113 /* Convert driver options hash to GSList of struct sr_hwopt. */
114 static GSList *hash_to_hwopt(GHashTable *hash)
116 const struct sr_hwcap_option *hwo;
117 struct sr_hwopt *hwopt;
122 keys = g_hash_table_get_keys(hash);
124 for (gl = keys; gl; gl = gl->next) {
126 if (!(hwo = sr_drvopt_name_get(key))) {
127 g_critical("Unknown option %s", key);
130 hwopt = g_try_malloc(sizeof(struct sr_hwopt));
131 hwopt->hwopt = hwo->hwcap;
132 value = g_hash_table_lookup(hash, key);
133 hwopt->value = g_strdup(value);
134 opts = g_slist_append(opts, hwopt);
141 static GSList *device_scan(void)
143 struct sr_dev_driver **drivers, *driver;
145 GSList *drvopts, *devices, *tmpdevs, *l;
150 drvargs = parse_generic_arg(opt_drv, TRUE);
151 drvname = g_strdup(g_hash_table_lookup(drvargs, "sigrok_key"));
152 g_hash_table_remove(drvargs, "sigrok_key");
154 drivers = sr_driver_list();
155 for (i = 0; drivers[i]; i++) {
156 if (strcmp(drivers[i]->name, drvname))
161 g_critical("Driver %s not found.", drvname);
165 if (sr_driver_init(driver) != SR_OK) {
166 g_critical("Failed to initialize driver.");
170 if (g_hash_table_size(drvargs) > 0)
171 if (!(drvopts = hash_to_hwopt(drvargs)))
172 /* Unknown options, already logged. */
174 devices = sr_driver_scan(driver, drvopts);
176 /* No driver specified, let them all scan on their own. */
178 drivers = sr_driver_list();
179 for (i = 0; drivers[i]; i++) {
181 if (sr_driver_init(driver) != SR_OK) {
182 g_critical("Failed to initialize driver.");
185 tmpdevs = sr_driver_scan(driver, NULL);
186 for (l = tmpdevs; l; l = l->next)
187 devices = g_slist_append(devices, l->data);
188 g_slist_free(tmpdevs);
195 static void show_version(void)
198 struct sr_dev_driver **drivers;
199 struct sr_input_format **inputs;
200 struct sr_output_format **outputs;
201 struct srd_decoder *dec;
204 printf("sigrok-cli %s\n\n", VERSION);
206 printf("Using libsigrok %s (lib version %s).\n",
207 sr_package_version_string_get(), sr_lib_version_string_get());
208 printf("Using libsigrokdecode %s (lib version %s).\n\n",
209 srd_package_version_string_get(), srd_lib_version_string_get());
211 printf("Supported hardware drivers:\n");
212 drivers = sr_driver_list();
213 for (i = 0; drivers[i]; i++) {
214 printf(" %-20s %s\n", drivers[i]->name, drivers[i]->longname);
218 printf("Supported input formats:\n");
219 inputs = sr_input_list();
220 for (i = 0; inputs[i]; i++)
221 printf(" %-20s %s\n", inputs[i]->id, inputs[i]->description);
224 printf("Supported output formats:\n");
225 outputs = sr_output_list();
226 for (i = 0; outputs[i]; i++)
227 printf(" %-20s %s\n", outputs[i]->id, outputs[i]->description);
230 if (srd_init(NULL) == SRD_OK) {
231 printf("Supported protocol decoders:\n");
232 srd_decoder_load_all();
233 for (l = srd_decoder_list(); l; l = l->next) {
235 printf(" %-20s %s\n", dec->id, dec->longname);
236 /* Print protocol description upon "-l 3" or higher. */
237 if (opt_loglevel >= SR_LOG_INFO)
238 printf(" %-20s %s\n", "", dec->desc);
245 static void print_dev_line(const struct sr_dev_inst *sdi)
247 struct sr_probe *probe;
250 if (sdi->vendor && sdi->vendor[0])
251 printf("%s ", sdi->vendor);
252 if (sdi->model && sdi->model[0])
253 printf("%s ", sdi->model);
254 if (sdi->version && sdi->version[0])
255 printf("%s ", sdi->version);
257 if (g_slist_length(sdi->probes) == 1) {
258 probe = sdi->probes->data;
259 printf("with 1 probe: %s\n", probe->name);
261 printf("with %d probes:\n", g_slist_length(sdi->probes));
262 for (l = sdi->probes; l; l = l->next) {
264 printf(" %s\n", probe->name);
271 static void show_dev_list(void)
273 struct sr_dev_inst *sdi;
276 if (!(devices = device_scan()))
279 printf("The following devices were found:\n");
280 for (l = devices; l; l = l->next) {
284 g_slist_free(devices);
288 static void show_dev_detail(void)
290 struct sr_dev_inst *sdi;
291 const struct sr_hwcap_option *hwo;
292 const struct sr_samplerates *samplerates;
293 struct sr_rational *rationals;
296 const int *hwopts, *hwcaps;
297 int cap, num_devices, n, i;
299 const char *charopts, **stropts;
301 if (!(devices = device_scan())) {
302 g_critical("No devices found.");
306 num_devices = g_slist_length(devices);
307 if (num_devices > 1) {
309 g_critical("%d devices found. Use --list-devices to show them, "
310 "and --device to select one.", num_devices);
313 /* opt_dev is NULL if not specified, which is fine. */
314 n = strtol(opt_dev, NULL, 10);
315 if (n >= num_devices) {
316 g_critical("%d devices found, numbered starting from 0.",
320 sdi = g_slist_nth_data(devices, n);
322 sdi = g_slist_nth_data(devices, 0);
326 if (sr_info_get(sdi->driver, SR_DI_TRIGGER_TYPES, (const void **)&charopts,
327 sdi) == SR_OK && charopts) {
328 printf("Supported triggers: ");
330 printf("%c ", *charopts);
336 if ((sr_info_get(sdi->driver, SR_DI_HWOPTS, (const void **)&hwopts,
337 NULL) == SR_OK) && hwopts) {
338 printf("Supported driver options:\n");
339 for (i = 0; hwopts[i]; i++) {
340 if (!(hwo = sr_drvopt_get(hwopts[i])))
342 printf(" %s\n", hwo->shortname);
346 title = "Supported device options:\n";
347 if ((sr_info_get(sdi->driver, SR_DI_HWCAPS, (const void **)&hwcaps,
348 NULL) != SR_OK) || !hwcaps)
349 /* Driver supports no device instance options. */
352 for (cap = 0; hwcaps[cap]; cap++) {
353 if (!(hwo = sr_devopt_get(hwcaps[cap])))
361 if (hwo->hwcap == SR_HWCAP_PATTERN_MODE) {
362 /* Pattern generator modes */
363 printf(" %s", hwo->shortname);
364 if (sr_info_get(sdi->driver, SR_DI_PATTERNS,
365 (const void **)&stropts, sdi) == SR_OK) {
366 printf(" - supported patterns:\n");
367 for (i = 0; stropts[i]; i++)
368 printf(" %s\n", stropts[i]);
373 } else if (hwo->hwcap == SR_HWCAP_SAMPLERATE) {
374 /* Supported samplerates */
375 printf(" %s", hwo->shortname);
376 if (sr_info_get(sdi->driver, SR_DI_SAMPLERATES,
377 (const void **)&samplerates, sdi) != SR_OK) {
381 if (samplerates->step) {
383 if (!(s = sr_samplerate_string(samplerates->low)))
388 if (!(s = sr_samplerate_string(samplerates->high)))
393 if (!(s = sr_samplerate_string(samplerates->step)))
395 printf(" in steps of %s)\n", s);
398 printf(" - supported samplerates:\n");
399 for (i = 0; samplerates->list[i]; i++)
400 printf(" %s\n", sr_samplerate_string(samplerates->list[i]));
403 } else if (hwo->hwcap == SR_HWCAP_BUFFERSIZE) {
404 /* Supported buffer sizes */
405 printf(" %s", hwo->shortname);
406 if (sr_info_get(sdi->driver, SR_DI_BUFFERSIZES,
407 (const void **)&integers, sdi) != SR_OK) {
411 printf(" - supported buffer sizes:\n");
412 for (i = 0; integers[i]; i++)
413 printf(" %"PRIu64"\n", integers[i]);
415 } else if (hwo->hwcap == SR_HWCAP_TIMEBASE) {
416 /* Supported time bases */
417 printf(" %s", hwo->shortname);
418 if (sr_info_get(sdi->driver, SR_DI_TIMEBASES,
419 (const void **)&rationals, sdi) != SR_OK) {
423 printf(" - supported time bases:\n");
424 for (i = 0; rationals[i].p && rationals[i].q; i++)
425 printf(" %s\n", sr_period_string(
426 rationals[i].p * rationals[i].q));
428 } else if (hwo->hwcap == SR_HWCAP_TRIGGER_SOURCE) {
429 /* Supported trigger sources */
430 printf(" %s", hwo->shortname);
431 if (sr_info_get(sdi->driver, SR_DI_TRIGGER_SOURCES,
432 (const void **)&stropts, sdi) != SR_OK) {
436 printf(" - supported trigger sources:\n");
437 for (i = 0; stropts[i]; i++)
438 printf(" %s\n", stropts[i]);
440 } else if (hwo->hwcap == SR_HWCAP_FILTER) {
441 /* Supported trigger sources */
442 printf(" %s", hwo->shortname);
443 if (sr_info_get(sdi->driver, SR_DI_FILTERS,
444 (const void **)&stropts, sdi) != SR_OK) {
448 printf(" - supported filter targets:\n");
449 for (i = 0; stropts[i]; i++)
450 printf(" %s\n", stropts[i]);
452 } else if (hwo->hwcap == SR_HWCAP_VDIV) {
453 /* Supported volts/div values */
454 printf(" %s", hwo->shortname);
455 if (sr_info_get(sdi->driver, SR_DI_VDIVS,
456 (const void **)&rationals, sdi) != SR_OK) {
460 printf(" - supported volts/div:\n");
461 for (i = 0; rationals[i].p && rationals[i].q; i++)
462 printf(" %s\n", sr_voltage_string( &rationals[i]));
464 } else if (hwo->hwcap == SR_HWCAP_COUPLING) {
465 /* Supported coupling settings */
466 printf(" %s", hwo->shortname);
467 if (sr_info_get(sdi->driver, SR_DI_COUPLING,
468 (const void **)&stropts, sdi) != SR_OK) {
472 printf(" - supported coupling options:\n");
473 for (i = 0; stropts[i]; i++)
474 printf(" %s\n", stropts[i]);
477 /* Everything else */
478 printf(" %s\n", hwo->shortname);
484 static void show_pd_detail(void)
487 struct srd_decoder *dec;
488 char **pdtokens, **pdtok, **ann, *doc;
491 pdtokens = g_strsplit(opt_pds, ",", -1);
492 for (pdtok = pdtokens; *pdtok; pdtok++) {
493 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
494 g_critical("Protocol decoder %s not found.", *pdtok);
497 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
498 dec->id, dec->name, dec->longname, dec->desc);
499 printf("License: %s\n", dec->license);
500 printf("Annotations:\n");
501 if (dec->annotations) {
502 for (l = dec->annotations; l; l = l->next) {
504 printf("- %s\n %s\n", ann[0], ann[1]);
509 /* TODO: Print supported decoder options. */
510 printf("Required probes:\n");
512 for (l = dec->probes; l; l = l->next) {
514 printf("- %s (%s): %s\n",
515 p->name, p->id, p->desc);
520 printf("Optional probes:\n");
521 if (dec->opt_probes) {
522 for (l = dec->opt_probes; l; l = l->next) {
524 printf("- %s (%s): %s\n",
525 p->name, p->id, p->desc);
530 if ((doc = srd_decoder_doc_get(dec))) {
531 printf("Documentation:\n%s\n",
532 doc[0] == '\n' ? doc + 1 : doc);
537 g_strfreev(pdtokens);
540 static void datafeed_in(const struct sr_dev_inst *sdi,
541 struct sr_datafeed_packet *packet)
543 static struct sr_output *o = NULL;
544 static int logic_probelist[SR_MAX_NUM_PROBES] = { -1 };
545 static struct sr_probe *analog_probelist[SR_MAX_NUM_PROBES];
546 static uint64_t received_samples = 0;
547 static int unitsize = 0;
548 static int triggered = 0;
549 static FILE *outfile = NULL;
550 static int num_analog_probes = 0;
551 struct sr_probe *probe;
552 struct sr_datafeed_logic *logic;
553 struct sr_datafeed_meta_logic *meta_logic;
554 struct sr_datafeed_analog *analog;
555 struct sr_datafeed_meta_analog *meta_analog;
556 static int num_enabled_analog_probes = 0;
557 int num_enabled_probes, sample_size, ret, i;
558 uint64_t output_len, filter_out_len;
559 uint8_t *output_buf, *filter_out;
562 /* If the first packet to come in isn't a header, don't even try. */
563 if (packet->type != SR_DF_HEADER && o == NULL)
567 switch (packet->type) {
569 g_debug("cli: Received SR_DF_HEADER");
570 /* Initialize the output module. */
571 if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
572 g_critical("Output module malloc failed.");
575 o->format = output_format;
576 o->sdi = (struct sr_dev_inst *)sdi;
577 o->param = output_format_param;
578 if (o->format->init) {
579 if (o->format->init(o) != SR_OK) {
580 g_critical("Output format initialization failed.");
587 g_debug("cli: Received SR_DF_END");
589 g_debug("cli: double end!");
592 if (o->format->event) {
593 o->format->event(o, SR_DF_END, &output_buf, &output_len);
596 fwrite(output_buf, 1, output_len, outfile);
601 if (limit_samples && received_samples < limit_samples)
602 g_warning("Device only sent %" PRIu64 " samples.",
605 g_warning("Device stopped after %" PRIu64 " samples.",
607 if (outfile && outfile != stdout)
610 if (o->format->cleanup)
611 o->format->cleanup(o);
617 g_debug("cli: received SR_DF_TRIGGER");
618 if (o->format->event)
619 o->format->event(o, SR_DF_TRIGGER, &output_buf,
624 case SR_DF_META_LOGIC:
625 g_message("cli: Received SR_DF_META_LOGIC");
626 meta_logic = packet->payload;
627 num_enabled_probes = 0;
628 for (i = 0; i < meta_logic->num_probes; i++) {
629 probe = g_slist_nth_data(sdi->probes, i);
631 logic_probelist[num_enabled_probes++] = probe->index;
633 logic_probelist[num_enabled_probes] = -1;
634 /* How many bytes we need to store num_enabled_probes bits */
635 unitsize = (num_enabled_probes + 7) / 8;
638 if (opt_output_file) {
639 if (default_output_format) {
640 /* output file is in session format, which means we'll
641 * dump everything in the datastore as it comes in,
642 * and save from there after the session. */
644 ret = sr_datastore_new(unitsize, &singleds);
646 g_critical("Failed to create datastore.");
650 /* saving to a file in whatever format was set
651 * with --format, so all we need is a filehandle */
652 outfile = g_fopen(opt_output_file, "wb");
656 srd_session_start(num_enabled_probes, unitsize,
657 meta_logic->samplerate);
661 logic = packet->payload;
662 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
663 sample_size = logic->unitsize;
664 if (logic->length == 0)
667 /* Don't store any samples until triggered. */
668 if (opt_wait_trigger && !triggered)
671 if (limit_samples && received_samples >= limit_samples)
674 ret = sr_filter_probes(sample_size, unitsize, logic_probelist,
675 logic->data, logic->length,
676 &filter_out, &filter_out_len);
680 /* what comes out of the filter is guaranteed to be packed into the
681 * minimum size needed to support the number of samples at this sample
682 * size. however, the driver may have submitted too much -- cut off
683 * the buffer of the last packet according to the sample limit.
685 if (limit_samples && (received_samples + logic->length / sample_size >
686 limit_samples * sample_size))
687 filter_out_len = limit_samples * sample_size - received_samples;
690 sr_datastore_put(singleds, filter_out,
691 filter_out_len, sample_size, logic_probelist);
693 if (opt_output_file && default_output_format)
694 /* saving to a session file, don't need to do anything else
695 * to this data for now. */
699 if (srd_session_send(received_samples, (uint8_t*)filter_out,
700 filter_out_len) != SRD_OK)
704 if (o->format->data && packet->type == o->format->df_type)
705 o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len);
707 fwrite(output_buf, 1, output_len, outfile);
715 received_samples += logic->length / sample_size;
718 case SR_DF_META_ANALOG:
719 g_message("cli: Received SR_DF_META_ANALOG");
720 meta_analog = packet->payload;
721 num_analog_probes = meta_analog->num_probes;
722 num_enabled_analog_probes = 0;
723 for (i = 0; i < num_analog_probes; i++) {
724 probe = g_slist_nth_data(sdi->probes, i);
726 analog_probelist[num_enabled_analog_probes++] = probe;
730 if (opt_output_file) {
731 if (default_output_format) {
732 /* output file is in session format, which means we'll
733 * dump everything in the datastore as it comes in,
734 * and save from there after the session. */
736 ret = sr_datastore_new(unitsize, &singleds);
738 g_critical("Failed to create datastore.");
742 /* saving to a file in whatever format was set
743 * with --format, so all we need is a filehandle */
744 outfile = g_fopen(opt_output_file, "wb");
750 analog = packet->payload;
751 g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples);
752 if (analog->num_samples == 0)
755 if (limit_samples && received_samples >= limit_samples)
758 if (o->format->data && packet->type == o->format->df_type) {
759 o->format->data(o, (const uint8_t *)analog->data,
760 analog->num_samples * sizeof(float),
761 &output_buf, &output_len);
763 fwrite(output_buf, 1, output_len, outfile);
769 received_samples += analog->num_samples;
772 case SR_DF_FRAME_BEGIN:
773 g_debug("cli: received SR_DF_FRAME_BEGIN");
774 if (o->format->event) {
775 o->format->event(o, SR_DF_FRAME_BEGIN, &output_buf,
778 fwrite(output_buf, 1, output_len, outfile);
785 case SR_DF_FRAME_END:
786 g_debug("cli: received SR_DF_FRAME_END");
787 if (o->format->event) {
788 o->format->event(o, SR_DF_FRAME_END, &output_buf,
791 fwrite(output_buf, 1, output_len, outfile);
799 g_message("received unknown packet type %d", packet->type);
802 if (o && o->format->recv) {
803 out = o->format->recv(o, sdi, packet);
804 if (out && out->len) {
805 fwrite(out->str, 1, out->len, outfile);
812 /* Register the given PDs for this session.
813 * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
814 * That will instantiate two SPI decoders on the clock but different data
817 static int register_pds(struct sr_dev *dev, const char *pdstring)
819 GHashTable *pd_opthash;
820 struct srd_decoder_inst *di;
822 char **pdtokens, **pdtok, *pd_name;
824 /* Avoid compiler warnings. */
828 pd_ann_visible = g_hash_table_new_full(g_str_hash, g_int_equal,
832 pdtokens = g_strsplit(pdstring, ",", 0);
833 for (pdtok = pdtokens; *pdtok; pdtok++) {
834 if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) {
835 g_critical("Invalid protocol decoder option '%s'.", *pdtok);
839 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
840 g_hash_table_remove(pd_opthash, "sigrok_key");
841 if (srd_decoder_load(pd_name) != SRD_OK) {
842 g_critical("Failed to load protocol decoder %s.", pd_name);
846 if (!(di = srd_inst_new(pd_name, pd_opthash))) {
847 g_critical("Failed to instantiate protocol decoder %s.", pd_name);
852 /* If no annotation list was specified, add them all in now.
853 * This will be pared down later to leave only the last PD
856 if (!opt_pd_annotations)
857 g_hash_table_insert(pd_ann_visible,
858 g_strdup(di->inst_id), NULL);
860 /* Any keys left in the options hash are probes, where the key
861 * is the probe name as specified in the decoder class, and the
862 * value is the probe number i.e. the order in which the PD's
863 * incoming samples are arranged. */
864 if (srd_inst_probe_set_all(di, pd_opthash) != SRD_OK) {
868 g_hash_table_destroy(pd_opthash);
873 g_strfreev(pdtokens);
875 g_hash_table_destroy(pd_opthash);
882 int setup_pd_stack(void)
884 struct srd_decoder_inst *di_from, *di_to;
888 /* Set up the protocol decoder stack. */
889 pds = g_strsplit(opt_pds, ",", 0);
890 if (g_strv_length(pds) > 1) {
892 /* A stack setup was specified, use that. */
894 pds = g_strsplit(opt_pd_stack, ",", 0);
895 if (g_strv_length(pds) < 2) {
897 g_critical("Specify at least two protocol decoders to stack.");
902 /* First PD goes at the bottom of the stack. */
903 ids = g_strsplit(pds[0], ":", 0);
904 if (!(di_from = srd_inst_find_by_id(ids[0]))) {
906 g_critical("Cannot stack protocol decoder '%s': "
907 "instance not found.", pds[0]);
912 /* Every subsequent PD goes on top. */
913 for (i = 1; pds[i]; i++) {
914 ids = g_strsplit(pds[i], ":", 0);
915 if (!(di_to = srd_inst_find_by_id(ids[0]))) {
917 g_critical("Cannot stack protocol decoder '%s': "
918 "instance not found.", pds[i]);
922 if ((ret = srd_inst_stack(di_from, di_to)) != SRD_OK)
925 /* Don't show annotation from this PD. Only the last PD in
926 * the stack will be left on the annotation list (unless
927 * the annotation list was specifically provided).
929 if (!opt_pd_annotations)
930 g_hash_table_remove(pd_ann_visible,
941 int setup_pd_annotations(void)
944 struct srd_decoder *dec;
946 char **pds, **pdtok, **keyval, **ann_descr;
948 /* Set up custom list of PDs and annotations to show. */
949 if (opt_pd_annotations) {
950 pds = g_strsplit(opt_pd_annotations, ",", 0);
951 for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
953 keyval = g_strsplit(*pdtok, "=", 0);
954 if (!(dec = srd_decoder_get_by_id(keyval[0]))) {
955 g_critical("Protocol decoder '%s' not found.", keyval[0]);
958 if (!dec->annotations) {
959 g_critical("Protocol decoder '%s' has no annotations.", keyval[0]);
962 if (g_strv_length(keyval) == 2) {
963 for (l = dec->annotations; l; l = l->next, ann++) {
965 if (!canon_cmp(ann_descr[0], keyval[1]))
970 g_critical("Annotation '%s' not found "
971 "for protocol decoder '%s'.", keyval[1], keyval[0]);
975 g_debug("cli: showing protocol decoder annotation %d from '%s'", ann, keyval[0]);
976 g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann));
985 int setup_output_format(void)
990 struct sr_output_format **outputs;
994 if (!opt_output_format) {
995 opt_output_format = DEFAULT_OUTPUT_FORMAT;
996 /* we'll need to remember this so when saving to a file
997 * later, sigrok session format will be used.
999 default_output_format = TRUE;
1002 fmtargs = parse_generic_arg(opt_output_format, TRUE);
1003 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1005 g_critical("Invalid output format.");
1008 outputs = sr_output_list();
1009 for (i = 0; outputs[i]; i++) {
1010 if (strcmp(outputs[i]->id, fmtspec))
1012 g_hash_table_remove(fmtargs, "sigrok_key");
1013 output_format = outputs[i];
1014 g_hash_table_iter_init(&iter, fmtargs);
1015 while (g_hash_table_iter_next(&iter, &key, &value)) {
1016 /* only supporting one parameter per output module
1017 * for now, and only its value */
1018 output_format_param = g_strdup(value);
1023 if (!output_format) {
1024 g_critical("Invalid output format %s.", opt_output_format);
1027 g_hash_table_destroy(fmtargs);
1032 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
1036 gpointer ann_format;
1038 /* 'cb_data' is not used in this specific callback. */
1041 if (!pd_ann_visible)
1044 if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id,
1046 /* Not in the list of PDs whose annotations we're showing. */
1049 if (pdata->ann_format != GPOINTER_TO_INT(ann_format))
1050 /* We don't want this particular format from the PD. */
1053 annotations = pdata->data;
1054 if (opt_loglevel > SR_LOG_WARN)
1055 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
1056 printf("%s: ", pdata->pdo->proto_id);
1057 for (i = 0; annotations[i]; i++)
1058 printf("\"%s\" ", annotations[i]);
1063 static int select_probes(struct sr_dev_inst *sdi)
1072 * This only works because a device by default initializes
1073 * and enables all its probes.
1075 max_probes = g_slist_length(sdi->probes);
1076 probelist = parse_probestring(max_probes, opt_probes);
1081 for (i = 0; i < max_probes; i++) {
1083 sr_dev_probe_name_set(sdi, i, probelist[i]);
1084 g_free(probelist[i]);
1086 sr_dev_probe_enable(sdi, i, FALSE);
1095 * Return the input file format which the CLI tool should use.
1097 * If the user specified -I / --input-format, use that one. Otherwise, try to
1098 * autodetect the format as good as possible. Failing that, return NULL.
1100 * @param filename The filename of the input file. Must not be NULL.
1101 * @param opt The -I / --input-file option the user specified (or NULL).
1103 * @return A pointer to the 'struct sr_input_format' that should be used,
1104 * or NULL if no input format was selected or auto-detected.
1106 static struct sr_input_format *determine_input_file_format(
1107 const char *filename, const char *opt)
1110 struct sr_input_format **inputs;
1112 /* If there are no input formats, return NULL right away. */
1113 inputs = sr_input_list();
1115 g_critical("No supported input formats available.");
1119 /* If the user specified -I / --input-format, use that one. */
1121 for (i = 0; inputs[i]; i++) {
1122 if (strcasecmp(inputs[i]->id, opt))
1124 g_debug("Using user-specified input file format '%s'.",
1129 /* The user specified an unknown input format, return NULL. */
1130 g_critical("Error: specified input file format '%s' is "
1135 /* Otherwise, try to find an input module that can handle this file. */
1136 for (i = 0; inputs[i]; i++) {
1137 if (inputs[i]->format_match(filename))
1141 /* Return NULL if no input module wanted to touch this. */
1143 g_critical("Error: no matching input module found.");
1147 g_debug("cli: Autodetected '%s' input format for file '%s'.",
1148 inputs[i]->id, filename);
1153 static void load_input_file_format(void)
1155 GHashTable *fmtargs = NULL;
1157 struct sr_input *in;
1158 struct sr_input_format *input_format;
1159 char *fmtspec = NULL;
1161 if (opt_input_format) {
1162 fmtargs = parse_generic_arg(opt_input_format, TRUE);
1163 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1166 if (!(input_format = determine_input_file_format(opt_input_file,
1168 /* The exact cause was already logged. */
1173 g_hash_table_remove(fmtargs, "sigrok_key");
1175 if (stat(opt_input_file, &st) == -1) {
1176 g_critical("Failed to load %s: %s", opt_input_file,
1181 /* Initialize the input module. */
1182 if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
1183 g_critical("Failed to allocate input module.");
1186 in->format = input_format;
1187 in->param = fmtargs;
1188 if (in->format->init) {
1189 if (in->format->init(in) != SR_OK) {
1190 g_critical("Input format init failed.");
1195 if (select_probes(in->sdi) > 0)
1199 sr_session_datafeed_callback_add(datafeed_in);
1200 if (sr_session_dev_add(in->sdi) != SR_OK) {
1201 g_critical("Failed to use device.");
1202 sr_session_destroy();
1206 input_format->loadfile(in, opt_input_file);
1207 if (opt_output_file && default_output_format) {
1208 if (sr_session_save(opt_output_file, in->sdi, singleds) != SR_OK)
1209 g_critical("Failed to save session.");
1211 sr_session_destroy();
1214 g_hash_table_destroy(fmtargs);
1217 static void load_input_file(void)
1220 if (sr_session_load(opt_input_file) == SR_OK) {
1221 /* sigrok session file */
1222 sr_session_datafeed_callback_add(datafeed_in);
1228 /* fall back on input modules */
1229 load_input_file_format();
1233 static int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
1235 const struct sr_hwcap_option *hwo;
1236 GHashTableIter iter;
1237 gpointer key, value;
1241 struct sr_rational tmp_rat;
1245 g_hash_table_iter_init(&iter, args);
1246 while (g_hash_table_iter_next(&iter, &key, &value)) {
1247 if (!(hwo = sr_devopt_name_get(key))) {
1248 g_critical("Unknown device option '%s'.", (char *) key);
1252 if ((value == NULL) &&
1253 (hwo->type != SR_T_BOOL)) {
1254 g_critical("Option '%s' needs a value.", (char *)key);
1258 switch (hwo->type) {
1260 ret = sr_parse_sizestring(value, &tmp_u64);
1272 tmp_bool = sr_parse_boolstring(value);
1276 tmp_float = strtof(value, NULL);
1279 case SR_T_RATIONAL_PERIOD:
1280 if ((ret = sr_parse_period(value, &tmp_rat)) != SR_OK)
1284 case SR_T_RATIONAL_VOLT:
1285 if ((ret = sr_parse_voltage(value, &tmp_rat)) != SR_OK)
1293 ret = sr_dev_config_set(sdi, hwo->hwcap, val);
1295 g_critical("Failed to set device option '%s'.", (char *)key);
1305 static int set_limit_time(const struct sr_dev_inst *sdi)
1308 uint64_t *samplerate;
1310 time_msec = sr_parse_timestring(opt_time);
1311 if (time_msec == 0) {
1312 g_critical("Invalid time '%s'", opt_time);
1313 sr_session_destroy();
1317 if (sr_driver_hwcap_exists(sdi->driver, SR_HWCAP_LIMIT_MSEC)) {
1318 if (sr_dev_config_set(sdi, SR_HWCAP_LIMIT_MSEC, &time_msec) != SR_OK) {
1319 g_critical("Failed to configure time limit.");
1320 sr_session_destroy();
1325 /* time limit set, but device doesn't support this...
1326 * convert to samples based on the samplerate.
1329 if (sr_dev_has_hwcap(sdi, SR_HWCAP_SAMPLERATE)) {
1330 sr_info_get(sdi->driver, SR_DI_CUR_SAMPLERATE,
1331 (const void **)&samplerate, sdi);
1332 limit_samples = (*samplerate) * time_msec / (uint64_t)1000;
1334 if (limit_samples == 0) {
1335 g_critical("Not enough time at this samplerate.");
1336 sr_session_destroy();
1340 if (sr_dev_config_set(sdi, SR_HWCAP_LIMIT_SAMPLES,
1341 &limit_samples) != SR_OK) {
1342 g_critical("Failed to configure time-based sample limit.");
1343 sr_session_destroy();
1351 static void run_session(void)
1354 GHashTable *devargs;
1355 struct sr_dev_inst *sdi;
1359 devices = device_scan();
1361 g_critical("No devices found.");
1364 if (g_slist_length(devices) > 1) {
1365 g_critical("sigrok-cli only supports one device for capturing.");
1368 sdi = devices->data;
1371 sr_session_datafeed_callback_add(datafeed_in);
1373 if (sr_session_dev_add(sdi) != SR_OK) {
1374 g_critical("Failed to use device.");
1375 sr_session_destroy();
1380 if ((devargs = parse_generic_arg(opt_dev, FALSE))) {
1381 if (set_dev_options(sdi, devargs) != SR_OK)
1383 g_hash_table_destroy(devargs);
1387 if (select_probes(sdi) != SR_OK) {
1388 g_critical("Failed to set probes.");
1389 sr_session_destroy();
1394 if (!(triggerlist = sr_parse_triggerstring(sdi, opt_triggers))) {
1395 sr_session_destroy();
1398 max_probes = g_slist_length(sdi->probes);
1399 for (i = 0; i < max_probes; i++) {
1400 if (triggerlist[i]) {
1401 sr_dev_trigger_set(sdi, i, triggerlist[i]);
1402 g_free(triggerlist[i]);
1405 g_free(triggerlist);
1408 if (opt_continuous) {
1409 if (!sr_driver_hwcap_exists(sdi->driver, SR_HWCAP_CONTINUOUS)) {
1410 g_critical("This device does not support continuous sampling.");
1411 sr_session_destroy();
1417 if (set_limit_time(sdi) != SR_OK) {
1418 sr_session_destroy();
1424 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)
1425 || (sr_dev_config_set(sdi, SR_HWCAP_LIMIT_SAMPLES,
1426 &limit_samples) != SR_OK)) {
1427 g_critical("Failed to configure sample limit.");
1428 sr_session_destroy();
1434 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)
1435 || (sr_dev_config_set(sdi, SR_HWCAP_LIMIT_FRAMES,
1436 &limit_frames) != SR_OK)) {
1437 g_critical("Failed to configure frame limit.");
1438 sr_session_destroy();
1443 if (sr_session_start() != SR_OK) {
1444 g_critical("Failed to start session.");
1445 sr_session_destroy();
1457 if (opt_output_file && default_output_format) {
1458 if (sr_session_save(opt_output_file, sdi, singleds) != SR_OK)
1459 g_critical("Failed to save session.");
1461 sr_session_destroy();
1462 g_slist_free(devices);
1466 static void logger(const gchar *log_domain, GLogLevelFlags log_level,
1467 const gchar *message, gpointer cb_data)
1469 /* Avoid compiler warnings. */
1474 * All messages, warnings, errors etc. go to stderr (not stdout) in
1475 * order to not mess up the CLI tool data output, e.g. VCD output.
1477 if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
1478 || opt_loglevel > SR_LOG_WARN) {
1479 fprintf(stderr, "%s\n", message);
1484 int main(int argc, char **argv)
1486 GOptionContext *context;
1489 g_log_set_default_handler(logger, NULL);
1492 context = g_option_context_new(NULL);
1493 g_option_context_add_main_entries(context, optargs, NULL);
1495 if (!g_option_context_parse(context, &argc, &argv, &error)) {
1496 g_critical("%s", error->message);
1500 /* Set the loglevel (amount of messages to output) for libsigrok. */
1501 if (sr_log_loglevel_set(opt_loglevel) != SR_OK)
1504 /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
1505 if (srd_log_loglevel_set(opt_loglevel) != SRD_OK)
1508 if (sr_init() != SR_OK)
1512 if (srd_init(NULL) != SRD_OK)
1514 if (register_pds(NULL, opt_pds) != 0)
1516 if (srd_pd_output_callback_add(SRD_OUTPUT_ANN,
1517 show_pd_annotations, NULL) != SRD_OK)
1519 if (setup_pd_stack() != 0)
1521 if (setup_pd_annotations() != 0)
1525 if (setup_output_format() != 0)
1530 else if (opt_list_devs)
1532 else if (opt_pds && opt_show)
1536 else if (opt_input_file)
1538 else if (opt_samples || opt_time || opt_frames || opt_continuous)
1541 printf("%s", g_option_context_get_help(context, TRUE, NULL));
1546 g_option_context_free(context);