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 extern struct sr_hwcap_option sr_hwcap_options[];
41 static uint64_t limit_samples = 0;
42 static uint64_t limit_frames = 0;
43 static struct sr_output_format *output_format = NULL;
44 static int default_output_format = FALSE;
45 static char *output_format_param = NULL;
46 static GHashTable *pd_ann_visible = NULL;
48 static gboolean opt_version = FALSE;
49 static gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
50 static gboolean opt_list_devs = FALSE;
51 static gboolean opt_wait_trigger = FALSE;
52 static gchar *opt_input_file = NULL;
53 static gchar *opt_output_file = 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_time = NULL;
63 static gchar *opt_samples = NULL;
64 static gchar *opt_frames = NULL;
65 static gchar *opt_continuous = NULL;
67 static GOptionEntry optargs[] = {
68 {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version,
69 "Show version and support list", NULL},
70 {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel,
71 "Set libsigrok/libsigrokdecode loglevel", NULL},
72 {"list-devices", 'D', 0, G_OPTION_ARG_NONE, &opt_list_devs,
73 "Scan for devices", NULL},
74 {"device", 'd', 0, G_OPTION_ARG_STRING, &opt_dev,
75 "Use specified device", NULL},
76 {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file,
77 "Load input from file", NULL},
78 {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format,
79 "Input format", NULL},
80 {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file,
81 "Save output to file", NULL},
82 {"output-format", 'O', 0, G_OPTION_ARG_STRING, &opt_output_format,
83 "Output format", NULL},
84 {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes,
85 "Probes to use", NULL},
86 {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers,
87 "Trigger configuration", NULL},
88 {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
89 "Wait for trigger", NULL},
90 {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds,
91 "Protocol decoders to run", NULL},
92 {"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING, &opt_pd_stack,
93 "Protocol decoder stack", NULL},
94 {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_STRING, &opt_pd_annotations,
95 "Protocol decoder annotation(s) to show", NULL},
96 {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time,
97 "How long to sample (ms)", NULL},
98 {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples,
99 "Number of samples to acquire", NULL},
100 {"frames", 0, 0, G_OPTION_ARG_STRING, &opt_frames,
101 "Number of frames to acquire", NULL},
102 {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous,
103 "Sample continuously", NULL},
104 {NULL, 0, 0, 0, NULL, NULL, NULL}
107 static void show_version(void)
110 struct sr_dev_driver **drivers;
111 struct sr_input_format **inputs;
112 struct sr_output_format **outputs;
113 struct srd_decoder *dec;
116 printf("sigrok-cli %s\n\n", VERSION);
118 printf("Using libsigrok %s (lib version %s).\n",
119 sr_package_version_string_get(), sr_lib_version_string_get());
120 printf("Using libsigrokdecode %s (lib version %s).\n\n",
121 srd_package_version_string_get(), srd_lib_version_string_get());
123 printf("Supported hardware drivers:\n");
124 drivers = sr_driver_list();
125 for (i = 0; drivers[i]; i++) {
126 printf(" %-20s %s\n", drivers[i]->name, drivers[i]->longname);
130 printf("Supported input formats:\n");
131 inputs = sr_input_list();
132 for (i = 0; inputs[i]; i++)
133 printf(" %-20s %s\n", inputs[i]->id, inputs[i]->description);
136 printf("Supported output formats:\n");
137 outputs = sr_output_list();
138 for (i = 0; outputs[i]; i++)
139 printf(" %-20s %s\n", outputs[i]->id, outputs[i]->description);
142 if (srd_init(NULL) == SRD_OK) {
143 printf("Supported protocol decoders:\n");
144 srd_decoder_load_all();
145 for (l = srd_decoder_list(); l; l = l->next) {
147 printf(" %-20s %s\n", dec->id, dec->longname);
148 /* Print protocol description upon "-l 3" or higher. */
149 if (opt_loglevel >= SR_LOG_INFO)
150 printf(" %-20s %s\n", "", dec->desc);
157 static void print_dev_line(const struct sr_dev *dev)
159 const struct sr_dev_inst *sdi;
161 sr_dev_info_get(dev, SR_DI_INST, (const void **)&sdi);
163 if (sdi->vendor && sdi->vendor[0])
164 printf("%s ", sdi->vendor);
165 if (sdi->model && sdi->model[0])
166 printf("%s ", sdi->model);
167 if (sdi->version && sdi->version[0])
168 printf("%s ", sdi->version);
170 printf("with %d probes", g_slist_length(dev->probes));
174 static void show_dev_list(void)
176 struct sr_dev *dev, *demo_dev;
181 devs = sr_dev_list();
183 if (g_slist_length(devs) == 0)
186 printf("The following devices were found:\nID Device\n");
188 for (l = devs; l; l = l->next) {
190 if (sr_dev_has_hwcap(dev, SR_HWCAP_DEMO_DEV)) {
194 printf("%-3d ", devcnt++);
199 print_dev_line(demo_dev);
203 static void show_dev_detail(void)
206 const struct sr_hwcap_option *hwo;
207 const struct sr_samplerates *samplerates;
208 struct sr_rational *rationals;
213 const char *charopts, **stropts;
215 dev = parse_devstring(opt_dev);
217 printf("No such device. Use -D to list all devices.\n");
223 if (sr_dev_info_get(dev, SR_DI_TRIGGER_TYPES,
224 (const void **)&charopts) == SR_OK) {
225 printf("Supported triggers: ");
227 printf("%c ", *charopts);
233 title = "Supported options:\n";
234 hwcaps = dev->driver->hwcap_get_all();
235 for (cap = 0; hwcaps[cap]; cap++) {
236 if (!(hwo = sr_hw_hwcap_get(hwcaps[cap])))
244 if (hwo->hwcap == SR_HWCAP_PATTERN_MODE) {
245 /* Pattern generator modes */
246 printf(" %s", hwo->shortname);
247 if (sr_dev_info_get(dev, SR_DI_PATTERNS,
248 (const void **)&stropts) == SR_OK) {
249 printf(" - supported patterns:\n");
250 for (i = 0; stropts[i]; i++)
251 printf(" %s\n", stropts[i]);
256 } else if (hwo->hwcap == SR_HWCAP_SAMPLERATE) {
257 /* Supported samplerates */
258 printf(" %s", hwo->shortname);
259 if (sr_dev_info_get(dev, SR_DI_SAMPLERATES,
260 (const void **)&samplerates) != SR_OK) {
264 if (samplerates->step) {
266 if (!(s = sr_samplerate_string(samplerates->low)))
271 if (!(s = sr_samplerate_string(samplerates->high)))
276 if (!(s = sr_samplerate_string(samplerates->step)))
278 printf(" in steps of %s)\n", s);
281 printf(" - supported samplerates:\n");
282 for (i = 0; samplerates->list[i]; i++)
283 printf(" %s\n", sr_samplerate_string(samplerates->list[i]));
286 } else if (hwo->hwcap == SR_HWCAP_BUFFERSIZE) {
287 /* Supported buffer sizes */
288 printf(" %s", hwo->shortname);
289 if (sr_dev_info_get(dev, SR_DI_BUFFERSIZES,
290 (const void **)&integers) != SR_OK) {
294 printf(" - supported buffer sizes:\n");
295 for (i = 0; integers[i]; i++)
296 printf(" %"PRIu64"\n", integers[i]);
298 } else if (hwo->hwcap == SR_HWCAP_TIMEBASE) {
299 /* Supported time bases */
300 printf(" %s", hwo->shortname);
301 if (sr_dev_info_get(dev, SR_DI_TIMEBASES,
302 (const void **)&rationals) != SR_OK) {
306 printf(" - supported time bases:\n");
307 for (i = 0; rationals[i].p && rationals[i].q; i++)
308 printf(" %s\n", sr_period_string(
309 rationals[i].p * rationals[i].q));
311 } else if (hwo->hwcap == SR_HWCAP_TRIGGER_SOURCE) {
312 /* Supported trigger sources */
313 printf(" %s", hwo->shortname);
314 if (sr_dev_info_get(dev, SR_DI_TRIGGER_SOURCES,
315 (const void **)&stropts) != SR_OK) {
319 printf(" - supported trigger sources:\n");
320 for (i = 0; stropts[i]; i++)
321 printf(" %s\n", stropts[i]);
323 } else if (hwo->hwcap == SR_HWCAP_FILTER) {
324 /* Supported trigger sources */
325 printf(" %s", hwo->shortname);
326 if (sr_dev_info_get(dev, SR_DI_FILTERS,
327 (const void **)&stropts) != SR_OK) {
331 printf(" - supported filter targets:\n");
332 for (i = 0; stropts[i]; i++)
333 printf(" %s\n", stropts[i]);
335 } else if (hwo->hwcap == SR_HWCAP_VDIV) {
336 /* Supported volts/div values */
337 printf(" %s", hwo->shortname);
338 if (sr_dev_info_get(dev, SR_DI_VDIVS,
339 (const void **)&rationals) != SR_OK) {
343 printf(" - supported volts/div:\n");
344 for (i = 0; rationals[i].p && rationals[i].q; i++)
345 printf(" %s\n", sr_voltage_string( &rationals[i]));
347 } else if (hwo->hwcap == SR_HWCAP_COUPLING) {
348 /* Supported coupling settings */
349 printf(" %s", hwo->shortname);
350 if (sr_dev_info_get(dev, SR_DI_COUPLING,
351 (const void **)&stropts) != SR_OK) {
355 printf(" - supported coupling options:\n");
356 for (i = 0; stropts[i]; i++)
357 printf(" %s\n", stropts[i]);
360 /* Everything else */
361 printf(" %s\n", hwo->shortname);
366 static void show_pd_detail(void)
369 struct srd_decoder *dec;
370 char **pdtokens, **pdtok, **ann, *doc;
373 pdtokens = g_strsplit(opt_pds, ",", -1);
374 for (pdtok = pdtokens; *pdtok; pdtok++) {
375 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
376 printf("Protocol decoder %s not found.\n", *pdtok);
379 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
380 dec->id, dec->name, dec->longname, dec->desc);
381 printf("License: %s\n", dec->license);
382 printf("Annotations:\n");
383 if (dec->annotations) {
384 for (l = dec->annotations; l; l = l->next) {
386 printf("- %s\n %s\n", ann[0], ann[1]);
391 /* TODO: Print supported decoder options. */
392 printf("Required probes:\n");
394 for (l = dec->probes; l; l = l->next) {
396 printf("- %s (%s): %s\n",
397 p->name, p->id, p->desc);
402 printf("Optional probes:\n");
403 if (dec->opt_probes) {
404 for (l = dec->opt_probes; l; l = l->next) {
406 printf("- %s (%s): %s\n",
407 p->name, p->id, p->desc);
412 if ((doc = srd_decoder_doc_get(dec))) {
413 printf("Documentation:\n%s\n",
414 doc[0] == '\n' ? doc + 1 : doc);
419 g_strfreev(pdtokens);
422 static void datafeed_in(struct sr_dev *dev, struct sr_datafeed_packet *packet)
424 static struct sr_output *o = NULL;
425 static int logic_probelist[SR_MAX_NUM_PROBES] = { 0 };
426 static struct sr_probe *analog_probelist[SR_MAX_NUM_PROBES];
427 static uint64_t received_samples = 0;
428 static int unitsize = 0;
429 static int triggered = 0;
430 static FILE *outfile = NULL;
431 static int num_analog_probes = 0;
432 struct sr_probe *probe;
433 struct sr_datafeed_logic *logic;
434 struct sr_datafeed_meta_logic *meta_logic;
435 struct sr_datafeed_analog *analog;
436 struct sr_datafeed_meta_analog *meta_analog;
437 static int num_enabled_analog_probes = 0;
438 int num_enabled_probes, sample_size, ret, i;
439 uint64_t output_len, filter_out_len;
440 uint8_t *output_buf, *filter_out;
442 /* If the first packet to come in isn't a header, don't even try. */
443 if (packet->type != SR_DF_HEADER && o == NULL)
447 switch (packet->type) {
449 g_debug("cli: Received SR_DF_HEADER");
450 /* Initialize the output module. */
451 if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
452 g_critical("Output module malloc failed.");
455 o->format = output_format;
457 o->param = output_format_param;
458 if (o->format->init) {
459 if (o->format->init(o) != SR_OK) {
460 g_critical("Output format initialization failed.");
467 g_debug("cli: Received SR_DF_END");
469 g_debug("cli: double end!");
472 if (o->format->event) {
473 o->format->event(o, SR_DF_END, &output_buf, &output_len);
476 fwrite(output_buf, 1, output_len, outfile);
481 if (limit_samples && received_samples < limit_samples)
482 g_warning("Device only sent %" PRIu64 " samples.",
485 g_warning("Device stopped after %" PRIu64 " samples.",
488 if (outfile && outfile != stdout)
495 g_debug("cli: received SR_DF_TRIGGER");
496 if (o->format->event)
497 o->format->event(o, SR_DF_TRIGGER, &output_buf,
502 case SR_DF_META_LOGIC:
503 g_message("cli: Received SR_DF_META_LOGIC");
504 meta_logic = packet->payload;
505 num_enabled_probes = 0;
506 for (i = 0; i < meta_logic->num_probes; i++) {
507 probe = g_slist_nth_data(dev->probes, i);
509 logic_probelist[num_enabled_probes++] = probe->index;
511 /* How many bytes we need to store num_enabled_probes bits */
512 unitsize = (num_enabled_probes + 7) / 8;
515 if (opt_output_file) {
516 if (default_output_format) {
517 /* output file is in session format, which means we'll
518 * dump everything in the datastore as it comes in,
519 * and save from there after the session. */
521 ret = sr_datastore_new(unitsize, &(dev->datastore));
523 printf("Failed to create datastore.\n");
527 /* saving to a file in whatever format was set
528 * with --format, so all we need is a filehandle */
529 outfile = g_fopen(opt_output_file, "wb");
533 srd_session_start(num_enabled_probes, unitsize,
534 meta_logic->samplerate);
538 logic = packet->payload;
539 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
540 sample_size = logic->unitsize;
541 if (logic->length == 0)
544 /* Don't store any samples until triggered. */
545 if (opt_wait_trigger && !triggered)
548 if (limit_samples && received_samples >= limit_samples)
551 ret = sr_filter_probes(sample_size, unitsize, logic_probelist,
552 logic->data, logic->length,
553 &filter_out, &filter_out_len);
557 /* what comes out of the filter is guaranteed to be packed into the
558 * minimum size needed to support the number of samples at this sample
559 * size. however, the driver may have submitted too much -- cut off
560 * the buffer of the last packet according to the sample limit.
562 if (limit_samples && (received_samples + logic->length / sample_size >
563 limit_samples * sample_size))
564 filter_out_len = limit_samples * sample_size - received_samples;
567 sr_datastore_put(dev->datastore, filter_out,
568 filter_out_len, sample_size, logic_probelist);
570 if (opt_output_file && default_output_format)
571 /* saving to a session file, don't need to do anything else
572 * to this data for now. */
576 if (srd_session_send(received_samples, (uint8_t*)filter_out,
577 filter_out_len) != SRD_OK)
581 if (o->format->data && packet->type == o->format->df_type)
582 o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len);
584 fwrite(output_buf, 1, output_len, outfile);
592 received_samples += logic->length / sample_size;
595 case SR_DF_META_ANALOG:
596 g_message("cli: Received SR_DF_META_ANALOG");
597 meta_analog = packet->payload;
598 num_analog_probes = meta_analog->num_probes;
599 num_enabled_analog_probes = 0;
600 for (i = 0; i < num_analog_probes; i++) {
601 probe = g_slist_nth_data(dev->probes, i);
603 analog_probelist[num_enabled_analog_probes++] = probe;
607 if (opt_output_file) {
608 if (default_output_format) {
609 /* output file is in session format, which means we'll
610 * dump everything in the datastore as it comes in,
611 * and save from there after the session. */
613 ret = sr_datastore_new(unitsize, &(dev->datastore));
615 printf("Failed to create datastore.\n");
619 /* saving to a file in whatever format was set
620 * with --format, so all we need is a filehandle */
621 outfile = g_fopen(opt_output_file, "wb");
627 analog = packet->payload;
628 g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples);
629 if (analog->num_samples == 0)
632 if (limit_samples && received_samples >= limit_samples)
635 if (o->format->data && packet->type == o->format->df_type) {
636 o->format->data(o, (const uint8_t *)analog->data,
637 analog->num_samples * sizeof(float),
638 &output_buf, &output_len);
640 fwrite(output_buf, 1, output_len, outfile);
646 received_samples += analog->num_samples;
649 case SR_DF_FRAME_BEGIN:
650 g_debug("cli: received SR_DF_FRAME_BEGIN");
651 if (o->format->event) {
652 o->format->event(o, SR_DF_FRAME_BEGIN, &output_buf,
655 fwrite(output_buf, 1, output_len, outfile);
662 case SR_DF_FRAME_END:
663 g_debug("cli: received SR_DF_FRAME_END");
664 if (o->format->event) {
665 o->format->event(o, SR_DF_FRAME_END, &output_buf,
668 fwrite(output_buf, 1, output_len, outfile);
676 g_message("received unknown packet type %d", packet->type);
681 /* Register the given PDs for this session.
682 * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
683 * That will instantiate two SPI decoders on the clock but different data
686 static int register_pds(struct sr_dev *dev, const char *pdstring)
688 GHashTable *pd_opthash;
689 struct srd_decoder_inst *di;
691 char **pdtokens, **pdtok, *pd_name;
693 /* Avoid compiler warnings. */
697 pd_ann_visible = g_hash_table_new_full(g_str_hash, g_int_equal,
701 pdtokens = g_strsplit(pdstring, ",", 0);
702 for (pdtok = pdtokens; *pdtok; pdtok++) {
703 if (!(pd_opthash = parse_generic_arg(*pdtok))) {
704 g_critical("Invalid protocol decoder option '%s'.", *pdtok);
708 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
709 g_hash_table_remove(pd_opthash, "sigrok_key");
710 if (srd_decoder_load(pd_name) != SRD_OK) {
711 g_critical("Failed to load protocol decoder %s.", pd_name);
715 if (!(di = srd_inst_new(pd_name, pd_opthash))) {
716 g_critical("Failed to instantiate protocol decoder %s.", pd_name);
721 /* If no annotation list was specified, add them all in now.
722 * This will be pared down later to leave only the last PD
725 if (!opt_pd_annotations)
726 g_hash_table_insert(pd_ann_visible,
727 g_strdup(di->inst_id), NULL);
729 /* Any keys left in the options hash are probes, where the key
730 * is the probe name as specified in the decoder class, and the
731 * value is the probe number i.e. the order in which the PD's
732 * incoming samples are arranged. */
733 if (srd_inst_probe_set_all(di, pd_opthash) != SRD_OK) {
737 g_hash_table_destroy(pd_opthash);
742 g_strfreev(pdtokens);
744 g_hash_table_destroy(pd_opthash);
751 int setup_pd_stack(void)
753 struct srd_decoder_inst *di_from, *di_to;
757 /* Set up the protocol decoder stack. */
758 pds = g_strsplit(opt_pds, ",", 0);
759 if (g_strv_length(pds) > 1) {
761 /* A stack setup was specified, use that. */
763 pds = g_strsplit(opt_pd_stack, ",", 0);
764 if (g_strv_length(pds) < 2) {
766 g_critical("Specify at least two protocol decoders to stack.");
771 /* First PD goes at the bottom of the stack. */
772 ids = g_strsplit(pds[0], ":", 0);
773 if (!(di_from = srd_inst_find_by_id(ids[0]))) {
775 g_critical("Cannot stack protocol decoder '%s': "
776 "instance not found.", pds[0]);
781 /* Every subsequent PD goes on top. */
782 for (i = 1; pds[i]; i++) {
783 ids = g_strsplit(pds[i], ":", 0);
784 if (!(di_to = srd_inst_find_by_id(ids[0]))) {
786 g_critical("Cannot stack protocol decoder '%s': "
787 "instance not found.", pds[i]);
791 if ((ret = srd_inst_stack(di_from, di_to)) != SRD_OK)
794 /* Don't show annotation from this PD. Only the last PD in
795 * the stack will be left on the annotation list (unless
796 * the annotation list was specifically provided).
798 if (!opt_pd_annotations)
799 g_hash_table_remove(pd_ann_visible,
810 int setup_pd_annotations(void)
813 struct srd_decoder *dec;
815 char **pds, **pdtok, **keyval, **ann_descr;
817 /* Set up custom list of PDs and annotations to show. */
818 if (opt_pd_annotations) {
819 pds = g_strsplit(opt_pd_annotations, ",", 0);
820 for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
822 keyval = g_strsplit(*pdtok, "=", 0);
823 if (!(dec = srd_decoder_get_by_id(keyval[0]))) {
824 g_critical("Protocol decoder '%s' not found.", keyval[0]);
827 if (!dec->annotations) {
828 g_critical("Protocol decoder '%s' has no annotations.", keyval[0]);
831 if (g_strv_length(keyval) == 2) {
832 for (l = dec->annotations; l; l = l->next, ann++) {
834 if (!canon_cmp(ann_descr[0], keyval[1]))
839 g_critical("Annotation '%s' not found "
840 "for protocol decoder '%s'.", keyval[1], keyval[0]);
844 g_debug("cli: showing protocol decoder annotation %d from '%s'", ann, keyval[0]);
845 g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann));
854 int setup_output_format(void)
859 struct sr_output_format **outputs;
863 if (!opt_output_format) {
864 opt_output_format = DEFAULT_OUTPUT_FORMAT;
865 /* we'll need to remember this so when saving to a file
866 * later, sigrok session format will be used.
868 default_output_format = TRUE;
871 fmtargs = parse_generic_arg(opt_output_format);
872 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
874 g_critical("Invalid output format.");
877 outputs = sr_output_list();
878 for (i = 0; outputs[i]; i++) {
879 if (strcmp(outputs[i]->id, fmtspec))
881 g_hash_table_remove(fmtargs, "sigrok_key");
882 output_format = outputs[i];
883 g_hash_table_iter_init(&iter, fmtargs);
884 while (g_hash_table_iter_next(&iter, &key, &value)) {
885 /* only supporting one parameter per output module
886 * for now, and only its value */
887 output_format_param = g_strdup(value);
892 if (!output_format) {
893 g_critical("Invalid output format %s.", opt_output_format);
896 g_hash_table_destroy(fmtargs);
901 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
907 /* 'cb_data' is not used in this specific callback. */
913 if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id,
915 /* Not in the list of PDs whose annotations we're showing. */
918 if (pdata->ann_format != GPOINTER_TO_INT(ann_format))
919 /* We don't want this particular format from the PD. */
922 annotations = pdata->data;
923 if (opt_loglevel > SR_LOG_WARN)
924 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
925 printf("%s: ", pdata->pdo->proto_id);
926 for (i = 0; annotations[i]; i++)
927 printf("\"%s\" ", annotations[i]);
932 static int select_probes(struct sr_dev *dev)
934 struct sr_probe *probe;
942 * This only works because a device by default initializes
943 * and enables all its probes.
945 max_probes = g_slist_length(dev->probes);
946 probelist = parse_probestring(max_probes, opt_probes);
951 for (i = 0; i < max_probes; i++) {
953 sr_dev_probe_name_set(dev, i + 1, probelist[i]);
954 g_free(probelist[i]);
956 probe = sr_dev_probe_find(dev, i + 1);
957 probe->enabled = FALSE;
966 * Return the input file format which the CLI tool should use.
968 * If the user specified -I / --input-format, use that one. Otherwise, try to
969 * autodetect the format as good as possible. Failing that, return NULL.
971 * @param filename The filename of the input file. Must not be NULL.
972 * @param opt The -I / --input-file option the user specified (or NULL).
974 * @return A pointer to the 'struct sr_input_format' that should be used,
975 * or NULL if no input format was selected or auto-detected.
977 static struct sr_input_format *determine_input_file_format(
978 const char *filename, const char *opt)
981 struct sr_input_format **inputs;
983 /* If there are no input formats, return NULL right away. */
984 inputs = sr_input_list();
986 g_critical("No supported input formats available.");
990 /* If the user specified -I / --input-format, use that one. */
992 for (i = 0; inputs[i]; i++) {
993 if (strcasecmp(inputs[i]->id, opt))
995 g_debug("Using user-specified input file format '%s'.",
1000 /* The user specified an unknown input format, return NULL. */
1001 g_critical("Error: specified input file format '%s' is "
1006 /* Otherwise, try to find an input module that can handle this file. */
1007 for (i = 0; inputs[i]; i++) {
1008 if (inputs[i]->format_match(filename))
1012 /* Return NULL if no input module wanted to touch this. */
1014 g_critical("Error: no matching input module found.");
1018 g_debug("cli: Autodetected '%s' input format for file '%s'.",
1019 inputs[i]->id, filename);
1024 static void load_input_file_format(void)
1026 GHashTable *fmtargs = NULL;
1028 struct sr_input *in;
1029 struct sr_input_format *input_format;
1030 char *fmtspec = NULL;
1032 if (opt_input_format) {
1033 fmtargs = parse_generic_arg(opt_input_format);
1034 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1037 if (!(input_format = determine_input_file_format(opt_input_file,
1039 /* The exact cause was already logged. */
1044 g_hash_table_remove(fmtargs, "sigrok_key");
1046 if (stat(opt_input_file, &st) == -1) {
1047 g_critical("Failed to load %s: %s", opt_input_file,
1052 /* Initialize the input module. */
1053 if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
1054 g_critical("Failed to allocate input module.");
1057 in->format = input_format;
1058 in->param = fmtargs;
1059 if (in->format->init) {
1060 if (in->format->init(in) != SR_OK) {
1061 g_critical("Input format init failed.");
1066 if (select_probes(in->vdev) > 0)
1070 sr_session_datafeed_callback_add(datafeed_in);
1071 if (sr_session_dev_add(in->vdev) != SR_OK) {
1072 g_critical("Failed to use device.");
1073 sr_session_destroy();
1077 input_format->loadfile(in, opt_input_file);
1078 if (opt_output_file && default_output_format) {
1079 if (sr_session_save(opt_output_file) != SR_OK)
1080 g_critical("Failed to save session.");
1082 sr_session_destroy();
1085 g_hash_table_destroy(fmtargs);
1088 static void load_input_file(void)
1091 if (sr_session_load(opt_input_file) == SR_OK) {
1092 /* sigrok session file */
1093 sr_session_datafeed_callback_add(datafeed_in);
1099 /* fall back on input modules */
1100 load_input_file_format();
1104 int num_real_devs(void)
1111 devs = sr_dev_list();
1112 for (l = devs; l; l = l->next) {
1114 if (!sr_dev_has_hwcap(dev, SR_HWCAP_DEMO_DEV))
1121 static int set_dev_options(struct sr_dev *dev, GHashTable *args)
1123 GHashTableIter iter;
1124 gpointer key, value;
1128 struct sr_rational tmp_rat;
1132 g_hash_table_iter_init(&iter, args);
1133 while (g_hash_table_iter_next(&iter, &key, &value)) {
1135 for (i = 0; sr_hwcap_options[i].hwcap; i++) {
1136 if (strcmp(sr_hwcap_options[i].shortname, key))
1138 if ((value == NULL) &&
1139 (sr_hwcap_options[i].type != SR_T_BOOL)) {
1140 g_critical("Option '%s' needs a value.", (char *)key);
1144 switch (sr_hwcap_options[i].type) {
1146 ret = sr_parse_sizestring(value, &tmp_u64);
1149 ret = dev->driver->dev_config_set(dev->driver_index,
1150 sr_hwcap_options[i].hwcap, &tmp_u64);
1153 ret = dev->driver->dev_config_set(dev->driver_index,
1154 sr_hwcap_options[i].hwcap, value);
1160 tmp_bool = sr_parse_boolstring(value);
1161 ret = dev->driver->dev_config_set(dev->driver_index,
1162 sr_hwcap_options[i].hwcap,
1163 GINT_TO_POINTER(tmp_bool));
1166 tmp_float = strtof(value, NULL);
1167 ret = dev->driver->dev_config_set(dev->driver_index,
1168 sr_hwcap_options[i].hwcap, &tmp_float);
1170 case SR_T_RATIONAL_PERIOD:
1171 if ((ret = sr_parse_period(value, &tmp_rat)) != SR_OK)
1173 ret = dev->driver->dev_config_set(dev->driver_index,
1174 sr_hwcap_options[i].hwcap, &tmp_rat);
1176 case SR_T_RATIONAL_VOLT:
1177 if ((ret = sr_parse_voltage(value, &tmp_rat)) != SR_OK)
1179 ret = dev->driver->dev_config_set(dev->driver_index,
1180 sr_hwcap_options[i].hwcap, &tmp_rat);
1187 g_critical("Failed to set device option '%s'.", (char *)key);
1194 g_critical("Unknown device option '%s'.", (char *) key);
1202 static void run_session(void)
1205 GHashTable *devargs;
1206 int num_devs, max_probes, i;
1208 char **probelist, *devspec;
1212 devargs = parse_generic_arg(opt_dev);
1213 devspec = g_hash_table_lookup(devargs, "sigrok_key");
1214 dev = parse_devstring(devspec);
1216 g_critical("Device not found.");
1219 g_hash_table_remove(devargs, "sigrok_key");
1221 num_devs = num_real_devs();
1222 if (num_devs == 1) {
1223 /* No device specified, but there is only one. */
1225 dev = parse_devstring("0");
1226 } else if (num_devs == 0) {
1227 g_critical("No devices found.");
1230 g_critical("%d devices found, please select one.", num_devs);
1236 sr_session_datafeed_callback_add(datafeed_in);
1238 if (sr_session_dev_add(dev) != SR_OK) {
1239 g_critical("Failed to use device.");
1240 sr_session_destroy();
1245 if (set_dev_options(dev, devargs) != SR_OK) {
1246 sr_session_destroy();
1249 g_hash_table_destroy(devargs);
1252 if (select_probes(dev) != SR_OK)
1255 if (opt_continuous) {
1256 if (!sr_driver_hwcap_exists(dev->driver, SR_HWCAP_CONTINUOUS)) {
1257 g_critical("This device does not support continuous sampling.");
1258 sr_session_destroy();
1264 probelist = sr_parse_triggerstring(dev, opt_triggers);
1266 sr_session_destroy();
1270 max_probes = g_slist_length(dev->probes);
1271 for (i = 0; i < max_probes; i++) {
1273 sr_dev_trigger_set(dev, i + 1, probelist[i]);
1274 g_free(probelist[i]);
1281 time_msec = sr_parse_timestring(opt_time);
1282 if (time_msec == 0) {
1283 g_critical("Invalid time '%s'", opt_time);
1284 sr_session_destroy();
1288 if (sr_driver_hwcap_exists(dev->driver, SR_HWCAP_LIMIT_MSEC)) {
1289 if (dev->driver->dev_config_set(dev->driver_index,
1290 SR_HWCAP_LIMIT_MSEC, &time_msec) != SR_OK) {
1291 g_critical("Failed to configure time limit.");
1292 sr_session_destroy();
1297 /* time limit set, but device doesn't support this...
1298 * convert to samples based on the samplerate.
1301 if (sr_dev_has_hwcap(dev, SR_HWCAP_SAMPLERATE)) {
1302 const uint64_t *samplerate;
1304 sr_dev_info_get(dev, SR_DI_CUR_SAMPLERATE,
1305 (const void **)&samplerate);
1306 limit_samples = (*samplerate) * time_msec / (uint64_t)1000;
1308 if (limit_samples == 0) {
1309 g_critical("Not enough time at this samplerate.");
1310 sr_session_destroy();
1314 if (dev->driver->dev_config_set(dev->driver_index,
1315 SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK) {
1316 g_critical("Failed to configure time-based sample limit.");
1317 sr_session_destroy();
1324 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)
1325 || (dev->driver->dev_config_set(dev->driver_index,
1326 SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK)) {
1327 g_critical("Failed to configure sample limit.");
1328 sr_session_destroy();
1334 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)
1335 || (dev->driver->dev_config_set(dev->driver_index,
1336 SR_HWCAP_LIMIT_FRAMES, &limit_frames) != SR_OK)) {
1337 printf("Failed to configure frame limit.\n");
1338 sr_session_destroy();
1343 if (dev->driver->dev_config_set(dev->driver_index,
1344 SR_HWCAP_PROBECONFIG, (char *)dev->probes) != SR_OK) {
1345 g_critical("Failed to configure probes.");
1346 sr_session_destroy();
1350 if (sr_session_start() != SR_OK) {
1351 g_critical("Failed to start session.");
1352 sr_session_destroy();
1364 if (opt_output_file && default_output_format) {
1365 if (sr_session_save(opt_output_file) != SR_OK)
1366 g_critical("Failed to save session.");
1368 sr_session_destroy();
1371 static void logger(const gchar *log_domain, GLogLevelFlags log_level,
1372 const gchar *message, gpointer cb_data)
1374 /* Avoid compiler warnings. */
1379 * All messages, warnings, errors etc. go to stderr (not stdout) in
1380 * order to not mess up the CLI tool data output, e.g. VCD output.
1382 if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
1383 || opt_loglevel > SR_LOG_WARN) {
1384 fprintf(stderr, "%s\n", message);
1389 int main(int argc, char **argv)
1391 GOptionContext *context;
1394 g_log_set_default_handler(logger, NULL);
1397 context = g_option_context_new(NULL);
1398 g_option_context_add_main_entries(context, optargs, NULL);
1400 if (!g_option_context_parse(context, &argc, &argv, &error)) {
1401 g_critical("%s", error->message);
1405 /* Set the loglevel (amount of messages to output) for libsigrok. */
1406 if (sr_log_loglevel_set(opt_loglevel) != SR_OK)
1409 /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
1410 if (srd_log_loglevel_set(opt_loglevel) != SRD_OK)
1413 if (sr_init() != SR_OK)
1417 if (srd_init(NULL) != SRD_OK)
1419 if (register_pds(NULL, opt_pds) != 0)
1421 if (srd_pd_output_callback_add(SRD_OUTPUT_ANN,
1422 show_pd_annotations, NULL) != SRD_OK)
1424 if (setup_pd_stack() != 0)
1426 if (setup_pd_annotations() != 0)
1430 if (setup_output_format() != 0)
1435 else if (opt_list_devs)
1437 else if (opt_input_file)
1439 else if (opt_samples || opt_time || opt_frames || opt_continuous)
1446 printf("%s", g_option_context_get_help(context, TRUE, NULL));
1451 g_option_context_free(context);