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>
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 char *input_format_param = NULL;
47 static GHashTable *pd_ann_visible = NULL;
49 static gboolean opt_version = FALSE;
50 static gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
51 static gboolean opt_list_devs = FALSE;
52 static gboolean opt_wait_trigger = FALSE;
53 static gchar *opt_input_file = NULL;
54 static gchar *opt_output_file = NULL;
55 static gchar *opt_dev = NULL;
56 static gchar *opt_probes = NULL;
57 static gchar *opt_triggers = NULL;
58 static gchar *opt_pds = NULL;
59 static gchar *opt_pd_stack = NULL;
60 static gchar *opt_pd_annotations = NULL;
61 static gchar *opt_input_format = NULL;
62 static gchar *opt_output_format = 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 {"device", 'd', 0, G_OPTION_ARG_STRING, &opt_dev,
76 "Use specified device", NULL},
77 {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file,
78 "Load input from file", NULL},
79 {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format,
80 "Input format", NULL},
81 {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file,
82 "Save output to file", NULL},
83 {"output-format", 'O', 0, G_OPTION_ARG_STRING, &opt_output_format,
84 "Output format", NULL},
85 {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes,
86 "Probes to use", NULL},
87 {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers,
88 "Trigger configuration", NULL},
89 {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
90 "Wait for trigger", NULL},
91 {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds,
92 "Protocol decoders to run", NULL},
93 {"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING, &opt_pd_stack,
94 "Protocol decoder stack", NULL},
95 {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_STRING, &opt_pd_annotations,
96 "Protocol decoder annotation(s) to show", NULL},
97 {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time,
98 "How long to sample (ms)", NULL},
99 {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples,
100 "Number of samples to acquire", NULL},
101 {"frames", 0, 0, G_OPTION_ARG_STRING, &opt_frames,
102 "Number of frames to acquire", NULL},
103 {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous,
104 "Sample continuously", NULL},
105 {NULL, 0, 0, 0, NULL, NULL, NULL}
108 static void show_version(void)
111 struct sr_dev_driver **drivers;
112 struct sr_input_format **inputs;
113 struct sr_output_format **outputs;
114 struct srd_decoder *dec;
117 printf("sigrok-cli %s\n\n", VERSION);
119 printf("Using libsigrok %s (lib version %s).\n",
120 sr_package_version_string_get(), sr_lib_version_string_get());
121 printf("Using libsigrokdecode %s (lib version %s).\n\n",
122 srd_package_version_string_get(), srd_lib_version_string_get());
124 printf("Supported hardware drivers:\n");
125 drivers = sr_driver_list();
126 for (i = 0; drivers[i]; i++) {
127 printf(" %-20s %s\n", drivers[i]->name, drivers[i]->longname);
131 printf("Supported input formats:\n");
132 inputs = sr_input_list();
133 for (i = 0; inputs[i]; i++)
134 printf(" %-20s %s\n", inputs[i]->id, inputs[i]->description);
137 printf("Supported output formats:\n");
138 outputs = sr_output_list();
139 for (i = 0; outputs[i]; i++)
140 printf(" %-20s %s\n", outputs[i]->id, outputs[i]->description);
143 if (srd_init(NULL) == SRD_OK) {
144 printf("Supported protocol decoders:\n");
145 srd_decoder_load_all();
146 for (l = srd_decoder_list(); l; l = l->next) {
148 printf(" %-20s %s\n", dec->id, dec->longname);
149 /* Print protocol description upon "-l 3" or higher. */
150 if (opt_loglevel >= SR_LOG_INFO)
151 printf(" %-20s %s\n", "", dec->desc);
158 static void print_dev_line(const struct sr_dev *dev)
160 const struct sr_dev_inst *sdi;
162 sr_dev_info_get(dev, SR_DI_INST, (const void **)&sdi);
164 if (sdi->vendor && sdi->vendor[0])
165 printf("%s ", sdi->vendor);
166 if (sdi->model && sdi->model[0])
167 printf("%s ", sdi->model);
168 if (sdi->version && sdi->version[0])
169 printf("%s ", sdi->version);
171 printf("with %d probes", g_slist_length(dev->probes));
175 static void show_dev_list(void)
177 struct sr_dev *dev, *demo_dev;
182 devs = sr_dev_list();
184 if (g_slist_length(devs) == 0)
187 printf("The following devices were found:\nID Device\n");
189 for (l = devs; l; l = l->next) {
191 if (sr_dev_has_hwcap(dev, SR_HWCAP_DEMO_DEV)) {
195 printf("%-3d ", devcnt++);
200 print_dev_line(demo_dev);
204 static void show_dev_detail(void)
207 struct sr_hwcap_option *hwo;
208 const struct sr_samplerates *samplerates;
211 const char *charopts, **stropts;
213 dev = parse_devstring(opt_dev);
215 printf("No such device. Use -D to list all devices.\n");
221 if (sr_dev_info_get(dev, SR_DI_TRIGGER_TYPES,
222 (const void **)&charopts) == SR_OK) {
223 printf("Supported triggers: ");
225 printf("%c ", *charopts);
231 title = "Supported options:\n";
232 hwcaps = dev->driver->hwcap_get_all();
233 for (cap = 0; hwcaps[cap]; cap++) {
234 if (!(hwo = sr_hw_hwcap_get(hwcaps[cap])))
242 if (hwo->hwcap == SR_HWCAP_PATTERN_MODE) {
243 printf(" %s", hwo->shortname);
244 if (sr_dev_info_get(dev, SR_DI_PATTERNS,
245 (const void **)&stropts) == SR_OK) {
246 printf(" - supported patterns:\n");
247 for (i = 0; stropts[i]; i++)
248 printf(" %s\n", stropts[i]);
252 } else if (hwo->hwcap == SR_HWCAP_SAMPLERATE) {
253 printf(" %s", hwo->shortname);
254 /* Supported samplerates */
255 if (sr_dev_info_get(dev, SR_DI_SAMPLERATES,
256 (const void **)&samplerates) != SR_OK) {
261 if (samplerates->step) {
263 if (!(s = sr_samplerate_string(samplerates->low)))
268 if (!(s = sr_samplerate_string(samplerates->high)))
273 if (!(s = sr_samplerate_string(samplerates->step)))
275 printf(" in steps of %s)\n", s);
278 printf(" - supported samplerates:\n");
279 for (i = 0; samplerates->list[i]; i++) {
280 printf(" %s\n", sr_samplerate_string(samplerates->list[i]));
284 printf(" %s\n", hwo->shortname);
289 static void show_pd_detail(void)
292 struct srd_decoder *dec;
293 char **pdtokens, **pdtok, **ann, *doc;
296 pdtokens = g_strsplit(opt_pds, ",", -1);
297 for (pdtok = pdtokens; *pdtok; pdtok++) {
298 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
299 printf("Protocol decoder %s not found.\n", *pdtok);
302 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
303 dec->id, dec->name, dec->longname, dec->desc);
304 printf("License: %s\n", dec->license);
305 printf("Annotations:\n");
306 if (dec->annotations) {
307 for (l = dec->annotations; l; l = l->next) {
309 printf("- %s\n %s\n", ann[0], ann[1]);
314 /* TODO: Print supported decoder options. */
315 printf("Required probes:\n");
317 for (l = dec->probes; l; l = l->next) {
319 printf("- %s (%s): %s\n",
320 p->name, p->id, p->desc);
325 printf("Optional probes:\n");
326 if (dec->opt_probes) {
327 for (l = dec->opt_probes; l; l = l->next) {
329 printf("- %s (%s): %s\n",
330 p->name, p->id, p->desc);
335 if ((doc = srd_decoder_doc_get(dec))) {
336 printf("Documentation:\n%s\n",
337 doc[0] == '\n' ? doc + 1 : doc);
342 g_strfreev(pdtokens);
345 static void datafeed_in(struct sr_dev *dev, struct sr_datafeed_packet *packet)
347 static struct sr_output *o = NULL;
348 static int logic_probelist[SR_MAX_NUM_PROBES] = { 0 };
349 static int analog_probelist[SR_MAX_NUM_PROBES] = { 0 };
350 static uint64_t received_samples = 0;
351 static int unitsize = 0;
352 static int triggered = 0;
353 static FILE *outfile = NULL;
354 static int num_analog_probes = 0;
355 struct sr_probe *probe;
356 struct sr_datafeed_header *header;
357 struct sr_datafeed_logic *logic;
358 struct sr_datafeed_meta_logic *meta_logic;
359 struct sr_datafeed_analog *analog;
360 struct sr_datafeed_meta_analog *meta_analog;
361 int num_enabled_probes, sample_size, ret, i;
362 uint64_t output_len, filter_out_len;
363 uint8_t *output_buf, *filter_out;
364 float asample1, asample2;
366 /* If the first packet to come in isn't a header, don't even try. */
367 if (packet->type != SR_DF_HEADER && o == NULL)
371 switch (packet->type) {
373 g_debug("cli: Received SR_DF_HEADER");
374 /* Initialize the output module. */
375 if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
376 g_critical("Output module malloc failed.");
379 o->format = output_format;
381 o->param = output_format_param;
382 if (o->format->init) {
383 if (o->format->init(o) != SR_OK) {
384 g_critical("Output format initialization failed.");
391 g_debug("cli: Received SR_DF_END");
393 g_debug("cli: double end!");
396 if (o->format->event) {
397 o->format->event(o, SR_DF_END, &output_buf, &output_len);
400 fwrite(output_buf, 1, output_len, outfile);
405 if (limit_samples && received_samples < limit_samples)
406 g_warning("Device only sent %" PRIu64 " samples.",
409 g_warning("Device stopped after %" PRIu64 " samples.",
412 if (outfile && outfile != stdout)
419 g_debug("cli: received SR_DF_TRIGGER");
420 if (o->format->event)
421 o->format->event(o, SR_DF_TRIGGER, &output_buf,
426 case SR_DF_META_LOGIC:
427 g_message("cli: Received SR_DF_META_LOGIC");
428 meta_logic = packet->payload;
429 num_enabled_probes = 0;
430 for (i = 0; i < meta_logic->num_probes; i++) {
431 probe = g_slist_nth_data(dev->probes, i);
433 logic_probelist[num_enabled_probes++] = probe->index;
435 /* How many bytes we need to store num_enabled_probes bits */
436 unitsize = (num_enabled_probes + 7) / 8;
439 if (opt_output_file) {
440 if (default_output_format) {
441 /* output file is in session format, which means we'll
442 * dump everything in the datastore as it comes in,
443 * and save from there after the session. */
445 ret = sr_datastore_new(unitsize, &(dev->datastore));
447 printf("Failed to create datastore.\n");
451 /* saving to a file in whatever format was set
452 * with --format, so all we need is a filehandle */
453 outfile = g_fopen(opt_output_file, "wb");
457 srd_session_start(num_enabled_probes, unitsize,
458 meta_logic->samplerate);
462 logic = packet->payload;
463 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
464 sample_size = logic->unitsize;
465 if (logic->length == 0)
468 /* Don't store any samples until triggered. */
469 if (opt_wait_trigger && !triggered)
472 if (limit_samples && received_samples >= limit_samples)
475 ret = sr_filter_probes(sample_size, unitsize, logic_probelist,
476 logic->data, logic->length,
477 &filter_out, &filter_out_len);
481 /* what comes out of the filter is guaranteed to be packed into the
482 * minimum size needed to support the number of samples at this sample
483 * size. however, the driver may have submitted too much -- cut off
484 * the buffer of the last packet according to the sample limit.
486 if (limit_samples && (received_samples + logic->length / sample_size >
487 limit_samples * sample_size))
488 filter_out_len = limit_samples * sample_size - received_samples;
491 sr_datastore_put(dev->datastore, filter_out,
492 filter_out_len, sample_size, logic_probelist);
494 if (opt_output_file && default_output_format)
495 /* saving to a session file, don't need to do anything else
496 * to this data for now. */
500 if (srd_session_send(received_samples, (uint8_t*)filter_out,
501 filter_out_len) != SRD_OK)
505 if (o->format->data && packet->type == o->format->df_type)
506 o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len);
508 fwrite(output_buf, 1, output_len, outfile);
515 received_samples += logic->length / sample_size;
518 case SR_DF_META_ANALOG:
519 g_message("cli: Received SR_DF_META_ANALOG");
520 meta_analog = packet->payload;
521 num_analog_probes = meta_analog->num_probes;
522 num_enabled_probes = 0;
523 for (i = 0; i < num_analog_probes; i++) {
524 probe = g_slist_nth_data(dev->probes, i);
526 analog_probelist[num_enabled_probes++] = probe->index;
530 if (opt_output_file) {
531 if (default_output_format) {
532 /* output file is in session format, which means we'll
533 * dump everything in the datastore as it comes in,
534 * and save from there after the session. */
536 ret = sr_datastore_new(unitsize, &(dev->datastore));
538 printf("Failed to create datastore.\n");
542 /* saving to a file in whatever format was set
543 * with --format, so all we need is a filehandle */
544 outfile = g_fopen(opt_output_file, "wb");
548 // srd_session_start(num_enabled_probes, unitsize,
549 // meta_logic->samplerate);
553 analog = packet->payload;
554 g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples);
555 if (analog->num_samples == 0)
558 if (limit_samples && received_samples >= limit_samples)
561 for (i = 0; i < analog->num_samples; i++) {
562 asample1 = analog->data[i * num_analog_probes];
563 asample2 = analog->data[i * num_analog_probes + 1];
564 printf("CH1 %f CH2 %f\n", asample1, asample2);
565 // write(STDOUT_FILENO, &asample1, sizeof(float));
569 // if (o->format->data && packet->type == o->format->df_type)
570 // o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len);
572 received_samples += analog->num_samples;
575 case SR_DF_FRAME_BEGIN:
580 case SR_DF_FRAME_END:
586 g_message("received unknown packet type %d", packet->type);
591 /* Register the given PDs for this session.
592 * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
593 * That will instantiate two SPI decoders on the clock but different data
596 static int register_pds(struct sr_dev *dev, const char *pdstring)
598 GHashTable *pd_opthash;
599 struct srd_decoder_inst *di;
601 char **pdtokens, **pdtok, *pd_name;
603 /* Avoid compiler warnings. */
607 pd_ann_visible = g_hash_table_new_full(g_str_hash, g_int_equal,
611 pdtokens = g_strsplit(pdstring, ",", 0);
612 for (pdtok = pdtokens; *pdtok; pdtok++) {
613 if (!(pd_opthash = parse_generic_arg(*pdtok))) {
614 g_critical("Invalid protocol decoder option '%s'.", *pdtok);
618 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
619 g_hash_table_remove(pd_opthash, "sigrok_key");
620 if (srd_decoder_load(pd_name) != SRD_OK) {
621 g_critical("Failed to load protocol decoder %s.", pd_name);
625 if (!(di = srd_inst_new(pd_name, pd_opthash))) {
626 g_critical("Failed to instantiate protocol decoder %s.", pd_name);
631 /* If no annotation list was specified, add them all in now.
632 * This will be pared down later to leave only the last PD
635 if (!opt_pd_annotations)
636 g_hash_table_insert(pd_ann_visible,
637 g_strdup(di->inst_id), NULL);
639 /* Any keys left in the options hash are probes, where the key
640 * is the probe name as specified in the decoder class, and the
641 * value is the probe number i.e. the order in which the PD's
642 * incoming samples are arranged. */
643 if (srd_inst_probe_set_all(di, pd_opthash) != SRD_OK) {
647 g_hash_table_destroy(pd_opthash);
652 g_strfreev(pdtokens);
654 g_hash_table_destroy(pd_opthash);
661 int setup_pd_stack(void)
663 struct srd_decoder_inst *di_from, *di_to;
667 /* Set up the protocol decoder stack. */
668 pds = g_strsplit(opt_pds, ",", 0);
669 if (g_strv_length(pds) > 1) {
671 /* A stack setup was specified, use that. */
673 pds = g_strsplit(opt_pd_stack, ",", 0);
674 if (g_strv_length(pds) < 2) {
676 g_critical("Specify at least two protocol decoders to stack.");
681 if (!(di_from = srd_inst_find_by_id(pds[0]))) {
682 g_critical("Cannot stack protocol decoder '%s': "
683 "instance not found.", pds[0]);
686 for (i = 1; pds[i]; i++) {
687 if (!(di_to = srd_inst_find_by_id(pds[i]))) {
688 g_critical("Cannot stack protocol decoder '%s': "
689 "instance not found.", pds[i]);
692 if ((ret = srd_inst_stack(di_from, di_to)) != SRD_OK)
695 /* Don't show annotation from this PD. Only the last PD in
696 * the stack will be left on the annotation list (unless
697 * the annotation list was specifically provided).
699 if (!opt_pd_annotations)
700 g_hash_table_remove(pd_ann_visible,
711 int setup_pd_annotations(void)
714 struct srd_decoder *dec;
716 char **pds, **pdtok, **keyval, **ann_descr;
718 /* Set up custom list of PDs and annotations to show. */
719 if (opt_pd_annotations) {
720 pds = g_strsplit(opt_pd_annotations, ",", 0);
721 for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
723 keyval = g_strsplit(*pdtok, "=", 0);
724 if (!(dec = srd_decoder_get_by_id(keyval[0]))) {
725 g_critical("Protocol decoder '%s' not found.", keyval[0]);
728 if (!dec->annotations) {
729 g_critical("Protocol decoder '%s' has no annotations.", keyval[0]);
732 if (g_strv_length(keyval) == 2) {
733 for (l = dec->annotations; l; l = l->next, ann++) {
735 if (!canon_cmp(ann_descr[0], keyval[1]))
740 g_critical("Annotation '%s' not found "
741 "for protocol decoder '%s'.", keyval[1], keyval[0]);
745 g_debug("cli: showing protocol decoder annotation %d from '%s'", ann, keyval[0]);
746 g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann));
755 int setup_output_format(void)
760 struct sr_output_format **outputs;
764 if (!opt_output_format) {
765 opt_output_format = DEFAULT_OUTPUT_FORMAT;
766 /* we'll need to remember this so when saving to a file
767 * later, sigrok session format will be used.
769 default_output_format = TRUE;
771 fmtargs = parse_generic_arg(opt_output_format);
772 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
774 g_critical("Invalid output format.");
777 outputs = sr_output_list();
778 for (i = 0; outputs[i]; i++) {
779 if (strcmp(outputs[i]->id, fmtspec))
781 g_hash_table_remove(fmtargs, "sigrok_key");
782 output_format = outputs[i];
783 g_hash_table_iter_init(&iter, fmtargs);
784 while (g_hash_table_iter_next(&iter, &key, &value)) {
785 /* only supporting one parameter per output module
786 * for now, and only its value */
787 output_format_param = g_strdup(value);
792 if (!output_format) {
793 g_critical("Invalid output format %s.", opt_output_format);
796 g_hash_table_destroy(fmtargs);
801 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
807 /* 'cb_data' is not used in this specific callback. */
813 if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id,
815 /* Not in the list of PDs whose annotations we're showing. */
818 if (pdata->ann_format != GPOINTER_TO_INT(ann_format))
819 /* We don't want this particular format from the PD. */
822 annotations = pdata->data;
823 if (opt_loglevel > SR_LOG_WARN)
824 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
825 printf("%s: ", pdata->pdo->proto_id);
826 for (i = 0; annotations[i]; i++)
827 printf("\"%s\" ", annotations[i]);
831 static int select_probes(struct sr_dev *dev)
833 struct sr_probe *probe;
841 * This only works because a device by default initializes
842 * and enables all its probes.
844 max_probes = g_slist_length(dev->probes);
845 probelist = parse_probestring(max_probes, opt_probes);
850 for (i = 0; i < max_probes; i++) {
852 sr_dev_probe_name_set(dev, i + 1, probelist[i]);
853 g_free(probelist[i]);
855 probe = sr_dev_probe_find(dev, i + 1);
856 probe->enabled = FALSE;
865 * Return the input file format which the CLI tool should use.
867 * If the user specified -I / --input-format, use that one. Otherwise, try to
868 * autodetect the format as good as possible. Failing that, return NULL.
870 * @param filename The filename of the input file. Must not be NULL.
871 * @param opt The -I / --input-file option the user specified (or NULL).
873 * @return A pointer to the 'struct sr_input_format' that should be used,
874 * or NULL if no input format was selected or auto-detected.
876 static struct sr_input_format *determine_input_file_format(
877 const char *filename, const char *opt)
880 struct sr_input_format **inputs;
882 /* If there are no input formats, return NULL right away. */
883 inputs = sr_input_list();
885 g_critical("No supported input formats available.");
889 /* If the user specified -I / --input-format, use that one. */
891 for (i = 0; inputs[i]; i++) {
892 if (strcasecmp(inputs[i]->id, opt_input_format))
894 g_debug("Using user-specified input file format '%s'.",
899 /* The user specified an unknown input format, return NULL. */
900 g_critical("Error: specified input file format '%s' is "
901 "unknown.", opt_input_format);
905 /* Otherwise, try to find an input module that can handle this file. */
906 for (i = 0; inputs[i]; i++) {
907 if (inputs[i]->format_match(filename))
911 /* Return NULL if no input module wanted to touch this. */
913 g_critical("Error: no matching input module found.");
917 g_debug("cli: Autodetected '%s' input format for file '%s'.",
918 inputs[i]->id, filename);
923 static void load_input_file_format(void)
927 struct sr_input_format *input_format;
929 if (!(input_format = determine_input_file_format(opt_input_file,
931 /* The exact cause was already logged. */
934 if (stat(opt_input_file, &st) == -1) {
935 g_critical("Failed to load %s: %s", opt_input_file,
940 /* Initialize the input module. */
941 if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
942 g_critical("Failed to allocate input module.");
945 in->format = input_format;
946 in->param = input_format_param;
947 if (in->format->init) {
948 if (in->format->init(in) != SR_OK) {
949 g_critical("Input format init failed.");
954 if (select_probes(in->vdev) > 0)
958 sr_session_datafeed_callback_add(datafeed_in);
959 if (sr_session_dev_add(in->vdev) != SR_OK) {
960 g_critical("Failed to use device.");
961 sr_session_destroy();
965 input_format->loadfile(in, opt_input_file);
966 if (opt_output_file && default_output_format) {
967 if (sr_session_save(opt_output_file) != SR_OK)
968 g_critical("Failed to save session.");
970 sr_session_destroy();
973 static void load_input_file(void)
976 if (sr_session_load(opt_input_file) == SR_OK) {
977 /* sigrok session file */
978 sr_session_datafeed_callback_add(datafeed_in);
984 /* fall back on input modules */
985 load_input_file_format();
989 int num_real_devs(void)
996 devs = sr_dev_list();
997 for (l = devs; l; l = l->next) {
999 if (!sr_dev_has_hwcap(dev, SR_HWCAP_DEMO_DEV))
1006 static int set_dev_options(struct sr_dev *dev, GHashTable *args)
1008 GHashTableIter iter;
1009 gpointer key, value;
1015 g_hash_table_iter_init(&iter, args);
1016 while (g_hash_table_iter_next(&iter, &key, &value)) {
1018 for (i = 0; sr_hwcap_options[i].hwcap; i++) {
1019 if (strcmp(sr_hwcap_options[i].shortname, key))
1021 if ((value == NULL) &&
1022 (sr_hwcap_options[i].type != SR_T_BOOL)) {
1023 g_critical("Option '%s' needs a value.", (char *)key);
1027 switch (sr_hwcap_options[i].type) {
1029 ret = sr_parse_sizestring(value, &tmp_u64);
1032 ret = dev->driver->dev_config_set(dev->driver_index,
1033 sr_hwcap_options[i].hwcap, &tmp_u64);
1036 ret = dev->driver->dev_config_set(dev->driver_index,
1037 sr_hwcap_options[i].hwcap, value);
1043 tmp_bool = sr_parse_boolstring(value);
1044 ret = dev->driver->dev_config_set(dev->driver_index,
1045 sr_hwcap_options[i].hwcap,
1046 GINT_TO_POINTER(tmp_bool));
1053 g_critical("Failed to set device option '%s'.", (char *)key);
1060 g_critical("Unknown device option '%s'.", (char *) key);
1068 static void run_session(void)
1071 GHashTable *devargs;
1072 int num_devs, max_probes, i;
1074 char **probelist, *devspec;
1078 devargs = parse_generic_arg(opt_dev);
1079 devspec = g_hash_table_lookup(devargs, "sigrok_key");
1080 dev = parse_devstring(devspec);
1082 g_critical("Device not found.");
1085 g_hash_table_remove(devargs, "sigrok_key");
1087 num_devs = num_real_devs();
1088 if (num_devs == 1) {
1089 /* No device specified, but there is only one. */
1091 dev = parse_devstring("0");
1092 } else if (num_devs == 0) {
1093 g_critical("No devices found.");
1096 g_critical("%d devices found, please select one.", num_devs);
1102 sr_session_datafeed_callback_add(datafeed_in);
1104 if (sr_session_dev_add(dev) != SR_OK) {
1105 g_critical("Failed to use device.");
1106 sr_session_destroy();
1111 if (set_dev_options(dev, devargs) != SR_OK) {
1112 sr_session_destroy();
1115 g_hash_table_destroy(devargs);
1118 if (select_probes(dev) != SR_OK)
1121 if (opt_continuous) {
1122 if (!sr_driver_hwcap_exists(dev->driver, SR_HWCAP_CONTINUOUS)) {
1123 g_critical("This device does not support continuous sampling.");
1124 sr_session_destroy();
1130 probelist = sr_parse_triggerstring(dev, opt_triggers);
1132 sr_session_destroy();
1136 max_probes = g_slist_length(dev->probes);
1137 for (i = 0; i < max_probes; i++) {
1139 sr_dev_trigger_set(dev, i + 1, probelist[i]);
1140 g_free(probelist[i]);
1147 time_msec = sr_parse_timestring(opt_time);
1148 if (time_msec == 0) {
1149 g_critical("Invalid time '%s'", opt_time);
1150 sr_session_destroy();
1154 if (sr_driver_hwcap_exists(dev->driver, SR_HWCAP_LIMIT_MSEC)) {
1155 if (dev->driver->dev_config_set(dev->driver_index,
1156 SR_HWCAP_LIMIT_MSEC, &time_msec) != SR_OK) {
1157 g_critical("Failed to configure time limit.");
1158 sr_session_destroy();
1163 /* time limit set, but device doesn't support this...
1164 * convert to samples based on the samplerate.
1167 if (sr_dev_has_hwcap(dev, SR_HWCAP_SAMPLERATE)) {
1168 const uint64_t *samplerate;
1170 sr_dev_info_get(dev, SR_DI_CUR_SAMPLERATE,
1171 (const void **)&samplerate);
1172 limit_samples = (*samplerate) * time_msec / (uint64_t)1000;
1174 if (limit_samples == 0) {
1175 g_critical("Not enough time at this samplerate.");
1176 sr_session_destroy();
1180 if (dev->driver->dev_config_set(dev->driver_index,
1181 SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK) {
1182 g_critical("Failed to configure time-based sample limit.");
1183 sr_session_destroy();
1190 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)
1191 || (dev->driver->dev_config_set(dev->driver_index,
1192 SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK)) {
1193 g_critical("Failed to configure sample limit.");
1194 sr_session_destroy();
1200 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)
1201 || (dev->driver->dev_config_set(dev->driver_index,
1202 SR_HWCAP_LIMIT_FRAMES, &limit_frames) != SR_OK)) {
1203 printf("Failed to configure frame limit.\n");
1204 sr_session_destroy();
1209 if (dev->driver->dev_config_set(dev->driver_index,
1210 SR_HWCAP_PROBECONFIG, (char *)dev->probes) != SR_OK) {
1211 g_critical("Failed to configure probes.");
1212 sr_session_destroy();
1216 if (sr_session_start() != SR_OK) {
1217 g_critical("Failed to start session.");
1218 sr_session_destroy();
1230 if (opt_output_file && default_output_format) {
1231 if (sr_session_save(opt_output_file) != SR_OK)
1232 g_critical("Failed to save session.");
1234 sr_session_destroy();
1237 static void logger(const gchar *log_domain, GLogLevelFlags log_level,
1238 const gchar *message, gpointer cb_data)
1240 /* Avoid compiler warnings. */
1245 * All messages, warnings, errors etc. go to stderr (not stdout) in
1246 * order to not mess up the CLI tool data output, e.g. VCD output.
1248 if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
1249 || opt_loglevel > SR_LOG_WARN) {
1250 fprintf(stderr, "%s\n", message);
1255 int main(int argc, char **argv)
1257 GOptionContext *context;
1260 g_log_set_default_handler(logger, NULL);
1263 context = g_option_context_new(NULL);
1264 g_option_context_add_main_entries(context, optargs, NULL);
1266 if (!g_option_context_parse(context, &argc, &argv, &error)) {
1267 g_critical("%s", error->message);
1271 /* Set the loglevel (amount of messages to output) for libsigrok. */
1272 if (sr_log_loglevel_set(opt_loglevel) != SR_OK)
1275 /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
1276 if (srd_log_loglevel_set(opt_loglevel) != SRD_OK)
1279 if (sr_init() != SR_OK)
1283 if (srd_init(NULL) != SRD_OK)
1285 if (register_pds(NULL, opt_pds) != 0)
1287 if (srd_pd_output_callback_add(SRD_OUTPUT_ANN,
1288 show_pd_annotations, NULL) != SRD_OK)
1290 if (setup_pd_stack() != 0)
1292 if (setup_pd_annotations() != 0)
1296 if (setup_output_format() != 0)
1301 else if (opt_list_devs)
1303 else if (opt_input_file)
1305 else if (opt_samples || opt_time || opt_frames || opt_continuous)
1312 printf("%s", g_option_context_get_help(context, TRUE, NULL));
1317 g_option_context_free(context);