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);
134 static void print_dev_line(const struct sr_dev *dev)
136 const struct sr_dev_inst *sdi;
138 sr_dev_info_get(dev, SR_DI_INST, (const void **)&sdi);
140 if (sdi->vendor && sdi->vendor[0])
141 printf("%s ", sdi->vendor);
142 if (sdi->model && sdi->model[0])
143 printf("%s ", sdi->model);
144 if (sdi->version && sdi->version[0])
145 printf("%s ", sdi->version);
147 printf("with %d probes", g_slist_length(dev->probes));
151 static void show_dev_list(void)
153 struct sr_dev *dev, *demo_dev;
158 devs = sr_dev_list();
160 if (g_slist_length(devs) == 0)
163 printf("The following devices were found:\nID Device\n");
165 for (l = devs; l; l = l->next) {
167 if (sr_dev_has_hwcap(dev, SR_HWCAP_DEMO_DEV)) {
171 printf("%-3d ", devcnt++);
176 print_dev_line(demo_dev);
180 static void show_dev_detail(void)
183 struct sr_hwcap_option *hwo;
184 const struct sr_samplerates *samplerates;
187 const char *charopts, **stropts;
189 dev = parse_devstring(opt_dev);
191 printf("No such device. Use -D to list all devices.\n");
197 if (sr_dev_info_get(dev, SR_DI_TRIGGER_TYPES,
198 (const void **)&charopts) == SR_OK) {
199 printf("Supported triggers: ");
201 printf("%c ", *charopts);
207 title = "Supported options:\n";
208 hwcaps = dev->driver->hwcap_get_all();
209 for (cap = 0; hwcaps[cap]; cap++) {
210 if (!(hwo = sr_hw_hwcap_get(hwcaps[cap])))
218 if (hwo->hwcap == SR_HWCAP_PATTERN_MODE) {
219 printf(" %s", hwo->shortname);
220 if (sr_dev_info_get(dev, SR_DI_PATTERNS,
221 (const void **)&stropts) == SR_OK) {
222 printf(" - supported patterns:\n");
223 for (i = 0; stropts[i]; i++)
224 printf(" %s\n", stropts[i]);
228 } else if (hwo->hwcap == SR_HWCAP_SAMPLERATE) {
229 printf(" %s", hwo->shortname);
230 /* Supported samplerates */
231 if (sr_dev_info_get(dev, SR_DI_SAMPLERATES,
232 (const void **)&samplerates) != SR_OK) {
237 if (samplerates->step) {
239 if (!(s = sr_samplerate_string(samplerates->low)))
244 if (!(s = sr_samplerate_string(samplerates->high)))
249 if (!(s = sr_samplerate_string(samplerates->step)))
251 printf(" in steps of %s)\n", s);
254 printf(" - supported samplerates:\n");
255 for (i = 0; samplerates->list[i]; i++) {
256 printf(" %s\n", sr_samplerate_string(samplerates->list[i]));
260 printf(" %s\n", hwo->shortname);
265 static void show_pd_detail(void)
268 struct srd_decoder *dec;
269 char **pdtokens, **pdtok, **ann, *doc;
271 pdtokens = g_strsplit(opt_pds, ",", -1);
272 for (pdtok = pdtokens; *pdtok; pdtok++) {
273 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
274 printf("Protocol decoder %s not found.", *pdtok);
277 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
278 dec->id, dec->name, dec->longname, dec->desc);
279 printf("License: %s\n", dec->license);
280 if (dec->annotations) {
281 printf("Annotations:\n");
282 for (l = dec->annotations; l; l = l->next) {
284 printf("- %s\n %s\n", ann[0], ann[1]);
287 if ((doc = srd_decoder_doc_get(dec))) {
288 printf("Documentation:\n%s\n", doc[0] == '\n' ? doc+1 : doc);
293 g_strfreev(pdtokens);
297 static void datafeed_in(struct sr_dev *dev, struct sr_datafeed_packet *packet)
299 static struct sr_output *o = NULL;
300 static int probelist[SR_MAX_NUM_PROBES + 1] = { 0 };
301 static uint64_t received_samples = 0;
302 static int unitsize = 0;
303 static int triggered = 0;
304 static FILE *outfile = NULL;
305 struct sr_probe *probe;
306 struct sr_datafeed_header *header;
307 struct sr_datafeed_logic *logic;
308 int num_enabled_probes, sample_size, ret, i;
309 uint64_t output_len, filter_out_len;
310 uint8_t *output_buf, *filter_out;
312 /* If the first packet to come in isn't a header, don't even try. */
313 if (packet->type != SR_DF_HEADER && o == NULL)
317 switch (packet->type) {
319 g_message("cli: Received SR_DF_HEADER");
320 /* Initialize the output module. */
321 if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
322 printf("Output module malloc failed.\n");
325 o->format = output_format;
327 o->param = output_format_param;
328 if (o->format->init) {
329 if (o->format->init(o) != SR_OK) {
330 printf("Output format initialization failed.\n");
335 header = packet->payload;
336 num_enabled_probes = 0;
337 for (i = 0; i < header->num_logic_probes; i++) {
338 probe = g_slist_nth_data(dev->probes, i);
340 probelist[num_enabled_probes++] = probe->index;
342 /* How many bytes we need to store num_enabled_probes bits */
343 unitsize = (num_enabled_probes + 7) / 8;
346 if (opt_output_file) {
347 if (default_output_format) {
348 /* output file is in session format, which means we'll
349 * dump everything in the datastore as it comes in,
350 * and save from there after the session. */
352 ret = sr_datastore_new(unitsize, &(dev->datastore));
354 printf("Failed to create datastore.\n");
358 /* saving to a file in whatever format was set
359 * with -O, so all we need is a filehandle */
360 outfile = g_fopen(opt_output_file, "wb");
364 srd_session_start(num_enabled_probes, unitsize,
368 g_message("cli: Received SR_DF_END");
370 g_message("cli: double end!");
373 if (o->format->event) {
374 o->format->event(o, SR_DF_END, &output_buf, &output_len);
377 fwrite(output_buf, 1, output_len, outfile);
382 if (limit_samples && received_samples < limit_samples)
383 printf("Device only sent %" PRIu64 " samples.\n",
386 printf("Device stopped after %" PRIu64 " samples.\n",
389 if (outfile && outfile != stdout)
395 g_message("cli: received SR_DF_TRIGGER");
396 if (o->format->event)
397 o->format->event(o, SR_DF_TRIGGER, &output_buf,
402 logic = packet->payload;
403 sample_size = logic->unitsize;
404 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
408 /* not supporting anything but SR_DF_LOGIC for now */
410 if (sample_size == -1 || logic->length == 0)
413 /* Don't store any samples until triggered. */
414 if (opt_wait_trigger && !triggered)
417 if (limit_samples && received_samples >= limit_samples)
420 /* TODO: filters only support SR_DF_LOGIC */
421 ret = sr_filter_probes(sample_size, unitsize, probelist,
422 logic->data, logic->length,
423 &filter_out, &filter_out_len);
427 /* what comes out of the filter is guaranteed to be packed into the
428 * minimum size needed to support the number of samples at this sample
429 * size. however, the driver may have submitted too much -- cut off
430 * the buffer of the last packet according to the sample limit.
432 if (limit_samples && (received_samples + logic->length / sample_size >
433 limit_samples * sample_size))
434 filter_out_len = limit_samples * sample_size - received_samples;
437 sr_datastore_put(dev->datastore, filter_out,
438 filter_out_len, sample_size, probelist);
440 if (opt_output_file && default_output_format)
441 /* saving to a session file, don't need to do anything else
442 * to this data for now. */
446 if (srd_session_send(received_samples, (uint8_t*)filter_out,
447 filter_out_len) != SRD_OK)
451 if (o->format->data && packet->type == o->format->df_type)
452 o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len);
454 fwrite(output_buf, 1, output_len, outfile);
461 received_samples += logic->length / sample_size;
465 /* Register the given PDs for this session.
466 * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
467 * That will instantiate two SPI decoders on the clock but different data
470 static int register_pds(struct sr_dev *dev, const char *pdstring)
472 GHashTable *pd_opthash;
473 struct srd_decoder_inst *di;
474 char **pdtokens, **pdtok, *pd_name;
476 /* Avoid compiler warnings. */
479 g_datalist_init(&pd_ann_visible);
480 pdtokens = g_strsplit(pdstring, ",", -1);
484 for (pdtok = pdtokens; *pdtok; pdtok++) {
485 if (!(pd_opthash = parse_generic_arg(*pdtok))) {
486 fprintf(stderr, "Invalid protocol decoder option '%s'.\n", *pdtok);
490 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
491 g_hash_table_remove(pd_opthash, "sigrok_key");
492 if (srd_decoder_load(pd_name) != SRD_OK) {
493 fprintf(stderr, "Failed to load protocol decoder %s\n", pd_name);
496 if (!(di = srd_inst_new(pd_name, pd_opthash))) {
497 fprintf(stderr, "Failed to instantiate protocol decoder %s\n", pd_name);
500 g_datalist_set_data(&pd_ann_visible, di->inst_id, pd_name);
502 /* Any keys left in the options hash are probes, where the key
503 * is the probe name as specified in the decoder class, and the
504 * value is the probe number i.e. the order in which the PD's
505 * incoming samples are arranged. */
506 if (srd_inst_probe_set_all(di, pd_opthash) != SRD_OK)
508 g_hash_table_destroy(pd_opthash);
513 g_strfreev(pdtokens);
515 g_hash_table_destroy(pd_opthash);
522 void show_pd_annotation(struct srd_proto_data *pdata, void *cb_data)
527 /* 'cb_data' is not used in this specific callback. */
530 if (pdata->ann_format != 0) {
531 /* CLI only shows the default annotation format. */
535 if (!g_datalist_get_data(&pd_ann_visible, pdata->pdo->di->inst_id)) {
536 /* Not in the list of PDs whose annotations we're showing. */
540 annotations = pdata->data;
541 if (opt_loglevel > SR_LOG_WARN)
542 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
543 printf("%s: ", pdata->pdo->proto_id);
544 for (i = 0; annotations[i]; i++)
545 printf("\"%s\" ", annotations[i]);
550 static int select_probes(struct sr_dev *dev)
552 struct sr_probe *probe;
560 * This only works because a device by default initializes
561 * and enables all its probes.
563 max_probes = g_slist_length(dev->probes);
564 probelist = parse_probestring(max_probes, opt_probes);
569 for (i = 0; i < max_probes; i++) {
571 sr_dev_probe_name_set(dev, i + 1, probelist[i]);
572 g_free(probelist[i]);
574 probe = sr_dev_probe_find(dev, i + 1);
575 probe->enabled = FALSE;
584 * Return the input file format which the CLI tool should use.
586 * If the user specified -I / --input-format, use that one. Otherwise, try to
587 * autodetect the format as good as possible. Failing that, return NULL.
589 * @param filename The filename of the input file. Must not be NULL.
590 * @param opt The -I / --input-file option the user specified (or NULL).
592 * @return A pointer to the 'struct sr_input_format' that should be used,
593 * or NULL if no input format was selected or auto-detected.
595 static struct sr_input_format *determine_input_file_format(
596 const char *filename, const char *opt)
599 struct sr_input_format **inputs;
601 /* If there are no input formats, return NULL right away. */
602 inputs = sr_input_list();
604 fprintf(stderr, "cli: %s: no supported input formats "
605 "available", __func__);
609 /* If the user specified -I / --input-format, use that one. */
611 for (i = 0; inputs[i]; i++) {
612 if (strcasecmp(inputs[i]->id, opt_input_format))
614 printf("Using user-specified input file format"
615 " '%s'.\n", inputs[i]->id);
619 /* The user specified an unknown input format, return NULL. */
620 fprintf(stderr, "Error: Specified input file format '%s' is "
621 "unknown.\n", opt_input_format);
625 /* Otherwise, try to find an input module that can handle this file. */
626 for (i = 0; inputs[i]; i++) {
627 if (inputs[i]->format_match(filename))
631 /* Return NULL if no input module wanted to touch this. */
633 fprintf(stderr, "Error: No matching input module found.\n");
637 printf("Using input file format '%s'.\n", inputs[i]->id);
641 static void load_input_file_format(void)
645 struct sr_input_format *input_format;
647 input_format = determine_input_file_format(opt_input_file,
650 fprintf(stderr, "Error: Couldn't detect input file format.\n");
654 if (stat(opt_input_file, &st) == -1) {
655 printf("Failed to load %s: %s\n", opt_input_file,
660 /* Initialize the input module. */
661 if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
662 printf("Failed to allocate input module.\n");
665 in->format = input_format;
666 in->param = input_format_param;
667 if (in->format->init) {
668 if (in->format->init(in) != SR_OK) {
669 printf("Input format init failed.\n");
674 if (select_probes(in->vdev) > 0)
678 sr_session_datafeed_callback_add(datafeed_in);
679 if (sr_session_dev_add(in->vdev) != SR_OK) {
680 printf("Failed to use device.\n");
681 sr_session_destroy();
685 input_format->loadfile(in, opt_input_file);
686 if (opt_output_file && default_output_format) {
687 if (sr_session_save(opt_output_file) != SR_OK)
688 printf("Failed to save session.\n");
690 sr_session_destroy();
694 static void load_input_file(void)
697 if (sr_session_load(opt_input_file) == SR_OK) {
698 /* sigrok session file */
699 sr_session_datafeed_callback_add(datafeed_in);
705 /* fall back on input modules */
706 load_input_file_format();
711 int num_real_devs(void)
718 devs = sr_dev_list();
719 for (l = devs; l; l = l->next) {
721 if (!sr_dev_has_hwcap(dev, SR_HWCAP_DEMO_DEV))
728 static int set_dev_options(struct sr_dev *dev, GHashTable *args)
737 g_hash_table_iter_init(&iter, args);
738 while (g_hash_table_iter_next(&iter, &key, &value)) {
740 for (i = 0; sr_hwcap_options[i].hwcap; i++) {
741 if (strcmp(sr_hwcap_options[i].shortname, key))
743 if ((value == NULL) &&
744 (sr_hwcap_options[i].type != SR_T_BOOL)) {
745 printf("Option '%s' needs a value.\n", (char *)key);
749 switch (sr_hwcap_options[i].type) {
751 ret = sr_parse_sizestring(value, &tmp_u64);
754 ret = dev->driver->dev_config_set(dev->driver_index,
755 sr_hwcap_options[i].hwcap, &tmp_u64);
758 ret = dev->driver->dev_config_set(dev->driver_index,
759 sr_hwcap_options[i].hwcap, value);
765 tmp_bool = sr_parse_boolstring(value);
766 ret = dev->driver->dev_config_set(dev->driver_index,
767 sr_hwcap_options[i].hwcap,
768 GINT_TO_POINTER(tmp_bool));
775 printf("Failed to set device option '%s'.\n", (char *)key);
782 printf("Unknown device option '%s'.\n", (char *) key);
790 static void run_session(void)
794 int num_devs, max_probes, i;
796 char **probelist, *devspec;
800 devargs = parse_generic_arg(opt_dev);
801 devspec = g_hash_table_lookup(devargs, "sigrok_key");
802 dev = parse_devstring(devspec);
804 g_warning("Device not found.");
807 g_hash_table_remove(devargs, "sigrok_key");
809 num_devs = num_real_devs();
811 /* No device specified, but there is only one. */
813 dev = parse_devstring("0");
814 } else if (num_devs == 0) {
815 printf("No devices found.\n");
818 printf("%d devices found, please select one.\n", num_devs);
824 sr_session_datafeed_callback_add(datafeed_in);
826 if (sr_session_dev_add(dev) != SR_OK) {
827 printf("Failed to use device.\n");
828 sr_session_destroy();
833 if (set_dev_options(dev, devargs) != SR_OK) {
834 sr_session_destroy();
837 g_hash_table_destroy(devargs);
840 if (select_probes(dev) != SR_OK)
843 if (opt_continuous) {
844 if (!sr_driver_hwcap_exists(dev->driver, SR_HWCAP_CONTINUOUS)) {
845 printf("This device does not support continuous sampling.");
846 sr_session_destroy();
852 probelist = sr_parse_triggerstring(dev, opt_triggers);
854 sr_session_destroy();
858 max_probes = g_slist_length(dev->probes);
859 for (i = 0; i < max_probes; i++) {
861 sr_dev_trigger_set(dev, i + 1, probelist[i]);
862 g_free(probelist[i]);
869 time_msec = sr_parse_timestring(opt_time);
870 if (time_msec == 0) {
871 printf("Invalid time '%s'\n", opt_time);
872 sr_session_destroy();
876 if (sr_driver_hwcap_exists(dev->driver, SR_HWCAP_LIMIT_MSEC)) {
877 if (dev->driver->dev_config_set(dev->driver_index,
878 SR_HWCAP_LIMIT_MSEC, &time_msec) != SR_OK) {
879 printf("Failed to configure time limit.\n");
880 sr_session_destroy();
885 /* time limit set, but device doesn't support this...
886 * convert to samples based on the samplerate.
889 if (sr_dev_has_hwcap(dev, SR_HWCAP_SAMPLERATE)) {
890 const uint64_t *samplerate;
892 sr_dev_info_get(dev, SR_DI_CUR_SAMPLERATE,
893 (const void **)&samplerate);
894 limit_samples = (*samplerate) * time_msec / (uint64_t)1000;
896 if (limit_samples == 0) {
897 printf("Not enough time at this samplerate.\n");
898 sr_session_destroy();
902 if (dev->driver->dev_config_set(dev->driver_index,
903 SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK) {
904 printf("Failed to configure time-based sample limit.\n");
905 sr_session_destroy();
912 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)
913 || (dev->driver->dev_config_set(dev->driver_index,
914 SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK)) {
915 printf("Failed to configure sample limit.\n");
916 sr_session_destroy();
921 if (dev->driver->dev_config_set(dev->driver_index,
922 SR_HWCAP_PROBECONFIG, (char *)dev->probes) != SR_OK) {
923 printf("Failed to configure probes.\n");
924 sr_session_destroy();
928 if (sr_session_start() != SR_OK) {
929 printf("Failed to start session.\n");
930 sr_session_destroy();
942 if (opt_output_file && default_output_format) {
943 if (sr_session_save(opt_output_file) != SR_OK)
944 printf("Failed to save session.\n");
946 sr_session_destroy();
950 static void logger(const gchar *log_domain, GLogLevelFlags log_level,
951 const gchar *message, gpointer cb_data)
953 /* Avoid compiler warnings. */
958 * All messages, warnings, errors etc. go to stderr (not stdout) in
959 * order to not mess up the CLI tool data output, e.g. VCD output.
961 if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_WARNING)) {
962 fprintf(stderr, "%s\n", message);
965 if ((log_level & G_LOG_LEVEL_MESSAGE && debug == 1)
967 printf("%s\n", message);
973 int main(int argc, char **argv)
975 GOptionContext *context;
980 struct sr_output_format **outputs;
981 struct srd_decoder_inst *di_from, *di_to;
983 char *fmtspec, **pds;
985 g_log_set_default_handler(logger, NULL);
986 if (getenv("SIGROK_DEBUG"))
987 debug = strtol(getenv("SIGROK_DEBUG"), NULL, 10);
990 context = g_option_context_new(NULL);
991 g_option_context_add_main_entries(context, optargs, NULL);
993 if (!g_option_context_parse(context, &argc, &argv, &error)) {
994 g_warning("%s", error->message);
998 /* Set the loglevel (amount of messages to output) for libsigrok. */
999 if (sr_log_loglevel_set(opt_loglevel) != SR_OK) {
1000 fprintf(stderr, "cli: %s: sr_log_loglevel_set(%d) failed\n",
1001 __func__, opt_loglevel);
1005 /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
1006 if (srd_log_loglevel_set(opt_loglevel) != SRD_OK) {
1007 fprintf(stderr, "cli: %s: srd_log_loglevel_set(%d) failed\n",
1008 __func__, opt_loglevel);
1012 if (sr_init() != SR_OK)
1016 if (srd_init(NULL) != SRD_OK) {
1017 printf("Failed to initialize sigrokdecode\n");
1020 if (register_pds(NULL, opt_pds) != 0) {
1021 printf("Failed to register protocol decoders\n");
1024 if (srd_pd_output_callback_add(SRD_OUTPUT_ANN,
1025 show_pd_annotation, NULL) != SRD_OK) {
1026 printf("Failed to register protocol decoder callback\n");
1032 pds = g_strsplit(opt_pd_stack, ",", 0);
1033 if (g_strv_length(pds) < 2) {
1034 printf("Specify at least two protocol decoders to stack.\n");
1038 if (!(di_from = srd_inst_find_by_id(pds[0]))) {
1039 printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[0]);
1042 for (i = 1; pds[i]; i++) {
1043 if (!(di_to = srd_inst_find_by_id(pds[i]))) {
1044 printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[i]);
1047 if ((ret = srd_inst_stack(di_from, di_to)) != SRD_OK)
1050 /* Don't show annotation from this PD. Only the last PD in
1051 * the stack will be left on the annotation list.
1053 g_datalist_remove_data(&pd_ann_visible, di_from->inst_id);
1060 if (!opt_output_format) {
1061 opt_output_format = DEFAULT_OUTPUT_FORMAT;
1062 /* we'll need to remember this so when saving to a file
1063 * later, sigrok session format will be used.
1065 default_output_format = TRUE;
1067 fmtargs = parse_generic_arg(opt_output_format);
1068 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1070 printf("Invalid output format.\n");
1073 outputs = sr_output_list();
1074 for (i = 0; outputs[i]; i++) {
1075 if (strcmp(outputs[i]->id, fmtspec))
1077 g_hash_table_remove(fmtargs, "sigrok_key");
1078 output_format = outputs[i];
1079 g_hash_table_iter_init(&iter, fmtargs);
1080 while (g_hash_table_iter_next(&iter, &key, &value)) {
1081 /* only supporting one parameter per output module
1082 * for now, and only its value */
1083 output_format_param = g_strdup(value);
1088 if (!output_format) {
1089 printf("invalid output format %s\n", opt_output_format);
1095 else if (opt_list_devs)
1097 else if (opt_input_file)
1099 else if (opt_samples || opt_time || opt_continuous)
1106 printf("%s", g_option_context_get_help(context, TRUE, NULL));
1111 g_option_context_free(context);
1112 g_hash_table_destroy(fmtargs);