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 gboolean debug = 0;
42 static uint64_t limit_samples = 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 GData *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_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_continuous = NULL;
66 static GOptionEntry optargs[] = {
67 {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version, "Show version and support list", NULL},
68 {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel, "Select libsigrok/libsigrokdecode loglevel", NULL},
69 {"list-devices", 'D', 0, G_OPTION_ARG_NONE, &opt_list_devs, "Scan for devices", NULL},
70 {"device", 'd', 0, G_OPTION_ARG_STRING, &opt_dev, "Use specified device", NULL},
71 {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file, "Load input from file", NULL},
72 {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format, "Input format", NULL},
73 {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file, "Save output to file", NULL},
74 {"output-format", 'O', 0, G_OPTION_ARG_STRING, &opt_output_format, "Output format", NULL},
75 {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes, "Probes to use", NULL},
76 {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers, "Trigger configuration", NULL},
77 {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger, "Wait for trigger", NULL},
78 {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds, "Protocol decoders to run", NULL},
79 {"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING, &opt_pd_stack, "Protocol decoder stack", NULL},
80 {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time, "How long to sample (ms)", NULL},
81 {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples, "Number of samples to acquire", NULL},
82 {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous, "Sample continuously", NULL},
83 {NULL, 0, 0, 0, NULL, NULL, NULL}
86 static void show_version(void)
89 struct sr_dev_driver **drivers;
90 struct sr_input_format **inputs;
91 struct sr_output_format **outputs;
92 struct srd_decoder *dec;
95 printf("sigrok-cli %s\n\n", VERSION);
97 printf("Using libsigrok %s (lib version %s).\n",
98 sr_package_version_string_get(), sr_lib_version_string_get());
99 printf("Using libsigrokdecode %s (lib version %s).\n\n",
100 srd_package_version_string_get(), srd_lib_version_string_get());
102 printf("Supported hardware drivers:\n");
103 drivers = sr_driver_list();
104 for (i = 0; drivers[i]; i++) {
105 printf(" %-20s %s\n", drivers[i]->name, drivers[i]->longname);
109 printf("Supported input formats:\n");
110 inputs = sr_input_list();
111 for (i = 0; inputs[i]; i++)
112 printf(" %-20s %s\n", inputs[i]->id, inputs[i]->description);
115 printf("Supported output formats:\n");
116 outputs = sr_output_list();
117 for (i = 0; outputs[i]; i++)
118 printf(" %-20s %s\n", outputs[i]->id, outputs[i]->description);
121 if (srd_init(NULL) == SRD_OK) {
122 printf("Supported protocol decoders:\n");
123 srd_decoder_load_all();
124 for (l = srd_decoder_list(); l; l = l->next) {
126 printf(" %-20s %s\n", dec->id, dec->longname);
127 /* Print protocol description upon "-l 3" or higher. */
128 if (opt_loglevel >= SR_LOG_INFO)
129 printf(" %-20s %s\n", "", dec->desc);
136 static void print_dev_line(const struct sr_dev *dev)
138 const struct sr_dev_inst *sdi;
140 sr_dev_info_get(dev, SR_DI_INST, (const void **)&sdi);
142 if (sdi->vendor && sdi->vendor[0])
143 printf("%s ", sdi->vendor);
144 if (sdi->model && sdi->model[0])
145 printf("%s ", sdi->model);
146 if (sdi->version && sdi->version[0])
147 printf("%s ", sdi->version);
149 printf("with %d probes", g_slist_length(dev->probes));
153 static void show_dev_list(void)
155 struct sr_dev *dev, *demo_dev;
160 devs = sr_dev_list();
162 if (g_slist_length(devs) == 0)
165 printf("The following devices were found:\nID Device\n");
167 for (l = devs; l; l = l->next) {
169 if (sr_dev_has_hwcap(dev, SR_HWCAP_DEMO_DEV)) {
173 printf("%-3d ", devcnt++);
178 print_dev_line(demo_dev);
182 static void show_dev_detail(void)
185 struct sr_hwcap_option *hwo;
186 const struct sr_samplerates *samplerates;
189 const char *charopts, **stropts;
191 dev = parse_devstring(opt_dev);
193 printf("No such device. Use -D to list all devices.\n");
199 if (sr_dev_info_get(dev, SR_DI_TRIGGER_TYPES,
200 (const void **)&charopts) == SR_OK) {
201 printf("Supported triggers: ");
203 printf("%c ", *charopts);
209 title = "Supported options:\n";
210 hwcaps = dev->driver->hwcap_get_all();
211 for (cap = 0; hwcaps[cap]; cap++) {
212 if (!(hwo = sr_hw_hwcap_get(hwcaps[cap])))
220 if (hwo->hwcap == SR_HWCAP_PATTERN_MODE) {
221 printf(" %s", hwo->shortname);
222 if (sr_dev_info_get(dev, SR_DI_PATTERNS,
223 (const void **)&stropts) == SR_OK) {
224 printf(" - supported patterns:\n");
225 for (i = 0; stropts[i]; i++)
226 printf(" %s\n", stropts[i]);
230 } else if (hwo->hwcap == SR_HWCAP_SAMPLERATE) {
231 printf(" %s", hwo->shortname);
232 /* Supported samplerates */
233 if (sr_dev_info_get(dev, SR_DI_SAMPLERATES,
234 (const void **)&samplerates) != SR_OK) {
239 if (samplerates->step) {
241 if (!(s = sr_samplerate_string(samplerates->low)))
246 if (!(s = sr_samplerate_string(samplerates->high)))
251 if (!(s = sr_samplerate_string(samplerates->step)))
253 printf(" in steps of %s)\n", s);
256 printf(" - supported samplerates:\n");
257 for (i = 0; samplerates->list[i]; i++) {
258 printf(" %s\n", sr_samplerate_string(samplerates->list[i]));
262 printf(" %s\n", hwo->shortname);
267 static void show_pd_detail(void)
270 struct srd_decoder *dec;
271 char **pdtokens, **pdtok, **ann, *doc;
274 pdtokens = g_strsplit(opt_pds, ",", -1);
275 for (pdtok = pdtokens; *pdtok; pdtok++) {
276 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
277 printf("Protocol decoder %s not found.", *pdtok);
280 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
281 dec->id, dec->name, dec->longname, dec->desc);
282 printf("License: %s\n", dec->license);
283 printf("Annotations:\n");
284 if (dec->annotations) {
285 for (l = dec->annotations; l; l = l->next) {
287 printf("- %s\n %s\n", ann[0], ann[1]);
292 /* TODO: Print supported decoder options. */
293 printf("Required probes:\n");
295 for (l = dec->probes; l; l = l->next) {
297 printf("- %s (%s): %s\n",
298 p->name, p->id, p->desc);
303 printf("Optional probes:\n");
304 if (dec->opt_probes) {
305 for (l = dec->opt_probes; l; l = l->next) {
307 printf("- %s (%s): %s\n",
308 p->name, p->id, p->desc);
313 if ((doc = srd_decoder_doc_get(dec))) {
314 printf("Documentation:\n%s\n",
315 doc[0] == '\n' ? doc + 1 : doc);
320 g_strfreev(pdtokens);
323 static void datafeed_in(struct sr_dev *dev, struct sr_datafeed_packet *packet)
325 static struct sr_output *o = NULL;
326 static int probelist[SR_MAX_NUM_PROBES + 1] = { 0 };
327 static uint64_t received_samples = 0;
328 static int unitsize = 0;
329 static int triggered = 0;
330 static FILE *outfile = NULL;
331 struct sr_probe *probe;
332 struct sr_datafeed_header *header;
333 struct sr_datafeed_logic *logic;
334 int num_enabled_probes, sample_size, ret, i;
335 uint64_t output_len, filter_out_len;
336 uint8_t *output_buf, *filter_out;
338 /* If the first packet to come in isn't a header, don't even try. */
339 if (packet->type != SR_DF_HEADER && o == NULL)
343 switch (packet->type) {
345 g_message("cli: Received SR_DF_HEADER");
346 /* Initialize the output module. */
347 if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
348 printf("Output module malloc failed.\n");
351 o->format = output_format;
353 o->param = output_format_param;
354 if (o->format->init) {
355 if (o->format->init(o) != SR_OK) {
356 printf("Output format initialization failed.\n");
361 header = packet->payload;
362 num_enabled_probes = 0;
363 for (i = 0; i < header->num_logic_probes; i++) {
364 probe = g_slist_nth_data(dev->probes, i);
366 probelist[num_enabled_probes++] = probe->index;
368 /* How many bytes we need to store num_enabled_probes bits */
369 unitsize = (num_enabled_probes + 7) / 8;
372 if (opt_output_file) {
373 if (default_output_format) {
374 /* output file is in session format, which means we'll
375 * dump everything in the datastore as it comes in,
376 * and save from there after the session. */
378 ret = sr_datastore_new(unitsize, &(dev->datastore));
380 printf("Failed to create datastore.\n");
384 /* saving to a file in whatever format was set
385 * with -O, so all we need is a filehandle */
386 outfile = g_fopen(opt_output_file, "wb");
390 srd_session_start(num_enabled_probes, unitsize,
394 g_message("cli: Received SR_DF_END");
396 g_message("cli: double end!");
399 if (o->format->event) {
400 o->format->event(o, SR_DF_END, &output_buf, &output_len);
403 fwrite(output_buf, 1, output_len, outfile);
408 if (limit_samples && received_samples < limit_samples)
409 printf("Device only sent %" PRIu64 " samples.\n",
412 printf("Device stopped after %" PRIu64 " samples.\n",
415 if (outfile && outfile != stdout)
421 g_message("cli: received SR_DF_TRIGGER");
422 if (o->format->event)
423 o->format->event(o, SR_DF_TRIGGER, &output_buf,
428 logic = packet->payload;
429 sample_size = logic->unitsize;
430 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
434 /* not supporting anything but SR_DF_LOGIC for now */
436 if (sample_size == -1 || logic->length == 0)
439 /* Don't store any samples until triggered. */
440 if (opt_wait_trigger && !triggered)
443 if (limit_samples && received_samples >= limit_samples)
446 /* TODO: filters only support SR_DF_LOGIC */
447 ret = sr_filter_probes(sample_size, unitsize, probelist,
448 logic->data, logic->length,
449 &filter_out, &filter_out_len);
453 /* what comes out of the filter is guaranteed to be packed into the
454 * minimum size needed to support the number of samples at this sample
455 * size. however, the driver may have submitted too much -- cut off
456 * the buffer of the last packet according to the sample limit.
458 if (limit_samples && (received_samples + logic->length / sample_size >
459 limit_samples * sample_size))
460 filter_out_len = limit_samples * sample_size - received_samples;
463 sr_datastore_put(dev->datastore, filter_out,
464 filter_out_len, sample_size, probelist);
466 if (opt_output_file && default_output_format)
467 /* saving to a session file, don't need to do anything else
468 * to this data for now. */
472 if (srd_session_send(received_samples, (uint8_t*)filter_out,
473 filter_out_len) != SRD_OK)
477 if (o->format->data && packet->type == o->format->df_type)
478 o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len);
480 fwrite(output_buf, 1, output_len, outfile);
487 received_samples += logic->length / sample_size;
490 /* Register the given PDs for this session.
491 * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
492 * That will instantiate two SPI decoders on the clock but different data
495 static int register_pds(struct sr_dev *dev, const char *pdstring)
497 GHashTable *pd_opthash;
498 struct srd_decoder_inst *di;
499 char **pdtokens, **pdtok, *pd_name;
501 /* Avoid compiler warnings. */
504 g_datalist_init(&pd_ann_visible);
505 pdtokens = g_strsplit(pdstring, ",", -1);
509 for (pdtok = pdtokens; *pdtok; pdtok++) {
510 if (!(pd_opthash = parse_generic_arg(*pdtok))) {
511 fprintf(stderr, "Invalid protocol decoder option '%s'.\n", *pdtok);
515 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
516 g_hash_table_remove(pd_opthash, "sigrok_key");
517 if (srd_decoder_load(pd_name) != SRD_OK) {
518 fprintf(stderr, "Failed to load protocol decoder %s\n", pd_name);
521 if (!(di = srd_inst_new(pd_name, pd_opthash))) {
522 fprintf(stderr, "Failed to instantiate protocol decoder %s\n", pd_name);
525 g_datalist_set_data(&pd_ann_visible, di->inst_id, pd_name);
527 /* Any keys left in the options hash are probes, where the key
528 * is the probe name as specified in the decoder class, and the
529 * value is the probe number i.e. the order in which the PD's
530 * incoming samples are arranged. */
531 if (srd_inst_probe_set_all(di, pd_opthash) != SRD_OK)
533 g_hash_table_destroy(pd_opthash);
538 g_strfreev(pdtokens);
540 g_hash_table_destroy(pd_opthash);
547 void show_pd_annotation(struct srd_proto_data *pdata, void *cb_data)
552 /* 'cb_data' is not used in this specific callback. */
555 if (pdata->ann_format != 0) {
556 /* CLI only shows the default annotation format. */
560 if (!g_datalist_get_data(&pd_ann_visible, pdata->pdo->di->inst_id)) {
561 /* Not in the list of PDs whose annotations we're showing. */
565 annotations = pdata->data;
566 if (opt_loglevel > SR_LOG_WARN)
567 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
568 printf("%s: ", pdata->pdo->proto_id);
569 for (i = 0; annotations[i]; i++)
570 printf("\"%s\" ", annotations[i]);
574 static int select_probes(struct sr_dev *dev)
576 struct sr_probe *probe;
584 * This only works because a device by default initializes
585 * and enables all its probes.
587 max_probes = g_slist_length(dev->probes);
588 probelist = parse_probestring(max_probes, opt_probes);
593 for (i = 0; i < max_probes; i++) {
595 sr_dev_probe_name_set(dev, i + 1, probelist[i]);
596 g_free(probelist[i]);
598 probe = sr_dev_probe_find(dev, i + 1);
599 probe->enabled = FALSE;
608 * Return the input file format which the CLI tool should use.
610 * If the user specified -I / --input-format, use that one. Otherwise, try to
611 * autodetect the format as good as possible. Failing that, return NULL.
613 * @param filename The filename of the input file. Must not be NULL.
614 * @param opt The -I / --input-file option the user specified (or NULL).
616 * @return A pointer to the 'struct sr_input_format' that should be used,
617 * or NULL if no input format was selected or auto-detected.
619 static struct sr_input_format *determine_input_file_format(
620 const char *filename, const char *opt)
623 struct sr_input_format **inputs;
625 /* If there are no input formats, return NULL right away. */
626 inputs = sr_input_list();
628 fprintf(stderr, "cli: %s: no supported input formats "
629 "available", __func__);
633 /* If the user specified -I / --input-format, use that one. */
635 for (i = 0; inputs[i]; i++) {
636 if (strcasecmp(inputs[i]->id, opt_input_format))
638 printf("Using user-specified input file format"
639 " '%s'.\n", inputs[i]->id);
643 /* The user specified an unknown input format, return NULL. */
644 fprintf(stderr, "Error: Specified input file format '%s' is "
645 "unknown.\n", opt_input_format);
649 /* Otherwise, try to find an input module that can handle this file. */
650 for (i = 0; inputs[i]; i++) {
651 if (inputs[i]->format_match(filename))
655 /* Return NULL if no input module wanted to touch this. */
657 fprintf(stderr, "Error: No matching input module found.\n");
661 printf("Using input file format '%s'.\n", inputs[i]->id);
665 static void load_input_file_format(void)
669 struct sr_input_format *input_format;
671 input_format = determine_input_file_format(opt_input_file,
674 fprintf(stderr, "Error: Couldn't detect input file format.\n");
678 if (stat(opt_input_file, &st) == -1) {
679 printf("Failed to load %s: %s\n", opt_input_file,
684 /* Initialize the input module. */
685 if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
686 printf("Failed to allocate input module.\n");
689 in->format = input_format;
690 in->param = input_format_param;
691 if (in->format->init) {
692 if (in->format->init(in) != SR_OK) {
693 printf("Input format init failed.\n");
698 if (select_probes(in->vdev) > 0)
702 sr_session_datafeed_callback_add(datafeed_in);
703 if (sr_session_dev_add(in->vdev) != SR_OK) {
704 printf("Failed to use device.\n");
705 sr_session_destroy();
709 input_format->loadfile(in, opt_input_file);
710 if (opt_output_file && default_output_format) {
711 if (sr_session_save(opt_output_file) != SR_OK)
712 printf("Failed to save session.\n");
714 sr_session_destroy();
717 static void load_input_file(void)
720 if (sr_session_load(opt_input_file) == SR_OK) {
721 /* sigrok session file */
722 sr_session_datafeed_callback_add(datafeed_in);
728 /* fall back on input modules */
729 load_input_file_format();
733 int num_real_devs(void)
740 devs = sr_dev_list();
741 for (l = devs; l; l = l->next) {
743 if (!sr_dev_has_hwcap(dev, SR_HWCAP_DEMO_DEV))
750 static int set_dev_options(struct sr_dev *dev, GHashTable *args)
759 g_hash_table_iter_init(&iter, args);
760 while (g_hash_table_iter_next(&iter, &key, &value)) {
762 for (i = 0; sr_hwcap_options[i].hwcap; i++) {
763 if (strcmp(sr_hwcap_options[i].shortname, key))
765 if ((value == NULL) &&
766 (sr_hwcap_options[i].type != SR_T_BOOL)) {
767 printf("Option '%s' needs a value.\n", (char *)key);
771 switch (sr_hwcap_options[i].type) {
773 ret = sr_parse_sizestring(value, &tmp_u64);
776 ret = dev->driver->dev_config_set(dev->driver_index,
777 sr_hwcap_options[i].hwcap, &tmp_u64);
780 ret = dev->driver->dev_config_set(dev->driver_index,
781 sr_hwcap_options[i].hwcap, value);
787 tmp_bool = sr_parse_boolstring(value);
788 ret = dev->driver->dev_config_set(dev->driver_index,
789 sr_hwcap_options[i].hwcap,
790 GINT_TO_POINTER(tmp_bool));
797 printf("Failed to set device option '%s'.\n", (char *)key);
804 printf("Unknown device option '%s'.\n", (char *) key);
812 static void run_session(void)
816 int num_devs, max_probes, i;
818 char **probelist, *devspec;
822 devargs = parse_generic_arg(opt_dev);
823 devspec = g_hash_table_lookup(devargs, "sigrok_key");
824 dev = parse_devstring(devspec);
826 g_warning("Device not found.");
829 g_hash_table_remove(devargs, "sigrok_key");
831 num_devs = num_real_devs();
833 /* No device specified, but there is only one. */
835 dev = parse_devstring("0");
836 } else if (num_devs == 0) {
837 printf("No devices found.\n");
840 printf("%d devices found, please select one.\n", num_devs);
846 sr_session_datafeed_callback_add(datafeed_in);
848 if (sr_session_dev_add(dev) != SR_OK) {
849 printf("Failed to use device.\n");
850 sr_session_destroy();
855 if (set_dev_options(dev, devargs) != SR_OK) {
856 sr_session_destroy();
859 g_hash_table_destroy(devargs);
862 if (select_probes(dev) != SR_OK)
865 if (opt_continuous) {
866 if (!sr_driver_hwcap_exists(dev->driver, SR_HWCAP_CONTINUOUS)) {
867 printf("This device does not support continuous sampling.");
868 sr_session_destroy();
874 probelist = sr_parse_triggerstring(dev, opt_triggers);
876 sr_session_destroy();
880 max_probes = g_slist_length(dev->probes);
881 for (i = 0; i < max_probes; i++) {
883 sr_dev_trigger_set(dev, i + 1, probelist[i]);
884 g_free(probelist[i]);
891 time_msec = sr_parse_timestring(opt_time);
892 if (time_msec == 0) {
893 printf("Invalid time '%s'\n", opt_time);
894 sr_session_destroy();
898 if (sr_driver_hwcap_exists(dev->driver, SR_HWCAP_LIMIT_MSEC)) {
899 if (dev->driver->dev_config_set(dev->driver_index,
900 SR_HWCAP_LIMIT_MSEC, &time_msec) != SR_OK) {
901 printf("Failed to configure time limit.\n");
902 sr_session_destroy();
907 /* time limit set, but device doesn't support this...
908 * convert to samples based on the samplerate.
911 if (sr_dev_has_hwcap(dev, SR_HWCAP_SAMPLERATE)) {
912 const uint64_t *samplerate;
914 sr_dev_info_get(dev, SR_DI_CUR_SAMPLERATE,
915 (const void **)&samplerate);
916 limit_samples = (*samplerate) * time_msec / (uint64_t)1000;
918 if (limit_samples == 0) {
919 printf("Not enough time at this samplerate.\n");
920 sr_session_destroy();
924 if (dev->driver->dev_config_set(dev->driver_index,
925 SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK) {
926 printf("Failed to configure time-based sample limit.\n");
927 sr_session_destroy();
934 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)
935 || (dev->driver->dev_config_set(dev->driver_index,
936 SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK)) {
937 printf("Failed to configure sample limit.\n");
938 sr_session_destroy();
943 if (dev->driver->dev_config_set(dev->driver_index,
944 SR_HWCAP_PROBECONFIG, (char *)dev->probes) != SR_OK) {
945 printf("Failed to configure probes.\n");
946 sr_session_destroy();
950 if (sr_session_start() != SR_OK) {
951 printf("Failed to start session.\n");
952 sr_session_destroy();
964 if (opt_output_file && default_output_format) {
965 if (sr_session_save(opt_output_file) != SR_OK)
966 printf("Failed to save session.\n");
968 sr_session_destroy();
971 static void logger(const gchar *log_domain, GLogLevelFlags log_level,
972 const gchar *message, gpointer cb_data)
974 /* Avoid compiler warnings. */
979 * All messages, warnings, errors etc. go to stderr (not stdout) in
980 * order to not mess up the CLI tool data output, e.g. VCD output.
982 if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_WARNING)) {
983 fprintf(stderr, "%s\n", message);
986 if ((log_level & G_LOG_LEVEL_MESSAGE && debug == 1)
988 printf("%s\n", message);
994 int main(int argc, char **argv)
996 GOptionContext *context;
1000 gpointer key, value;
1001 struct sr_output_format **outputs;
1002 struct srd_decoder_inst *di_from, *di_to;
1004 char *fmtspec, **pds;
1006 g_log_set_default_handler(logger, NULL);
1007 if (getenv("SIGROK_DEBUG"))
1008 debug = strtol(getenv("SIGROK_DEBUG"), NULL, 10);
1011 context = g_option_context_new(NULL);
1012 g_option_context_add_main_entries(context, optargs, NULL);
1014 if (!g_option_context_parse(context, &argc, &argv, &error)) {
1015 g_warning("%s", error->message);
1019 /* Set the loglevel (amount of messages to output) for libsigrok. */
1020 if (sr_log_loglevel_set(opt_loglevel) != SR_OK) {
1021 fprintf(stderr, "cli: %s: sr_log_loglevel_set(%d) failed\n",
1022 __func__, opt_loglevel);
1026 /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
1027 if (srd_log_loglevel_set(opt_loglevel) != SRD_OK) {
1028 fprintf(stderr, "cli: %s: srd_log_loglevel_set(%d) failed\n",
1029 __func__, opt_loglevel);
1033 if (sr_init() != SR_OK)
1037 if (srd_init(NULL) != SRD_OK) {
1038 printf("Failed to initialize sigrokdecode\n");
1041 if (register_pds(NULL, opt_pds) != 0) {
1042 printf("Failed to register protocol decoders\n");
1045 if (srd_pd_output_callback_add(SRD_OUTPUT_ANN,
1046 show_pd_annotation, NULL) != SRD_OK) {
1047 printf("Failed to register protocol decoder callback\n");
1053 pds = g_strsplit(opt_pd_stack, ",", 0);
1054 if (g_strv_length(pds) < 2) {
1055 printf("Specify at least two protocol decoders to stack.\n");
1059 if (!(di_from = srd_inst_find_by_id(pds[0]))) {
1060 printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[0]);
1063 for (i = 1; pds[i]; i++) {
1064 if (!(di_to = srd_inst_find_by_id(pds[i]))) {
1065 printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[i]);
1068 if ((ret = srd_inst_stack(di_from, di_to)) != SRD_OK)
1071 /* Don't show annotation from this PD. Only the last PD in
1072 * the stack will be left on the annotation list.
1074 g_datalist_remove_data(&pd_ann_visible, di_from->inst_id);
1081 if (!opt_output_format) {
1082 opt_output_format = DEFAULT_OUTPUT_FORMAT;
1083 /* we'll need to remember this so when saving to a file
1084 * later, sigrok session format will be used.
1086 default_output_format = TRUE;
1088 fmtargs = parse_generic_arg(opt_output_format);
1089 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1091 printf("Invalid output format.\n");
1094 outputs = sr_output_list();
1095 for (i = 0; outputs[i]; i++) {
1096 if (strcmp(outputs[i]->id, fmtspec))
1098 g_hash_table_remove(fmtargs, "sigrok_key");
1099 output_format = outputs[i];
1100 g_hash_table_iter_init(&iter, fmtargs);
1101 while (g_hash_table_iter_next(&iter, &key, &value)) {
1102 /* only supporting one parameter per output module
1103 * for now, and only its value */
1104 output_format_param = g_strdup(value);
1109 if (!output_format) {
1110 printf("invalid output format %s\n", opt_output_format);
1116 else if (opt_list_devs)
1118 else if (opt_input_file)
1120 else if (opt_samples || opt_time || opt_continuous)
1127 printf("%s", g_option_context_get_help(context, TRUE, NULL));
1132 g_option_context_free(context);
1133 g_hash_table_destroy(fmtargs);