sr/cli/gtk/qt: s/configuration/config/.

[sigrok-cli.git] / sigrok-cli.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <time.h>
#include <sys/time.h>
#include <inttypes.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <errno.h>
#include <glib.h>
#include <glib/gstdio.h>
#include <sigrok.h>
#include "sigrok-cli.h"
#include "config.h"

#define DEFAULT_OUTPUT_FORMAT "bits:width=64"

extern struct sr_hwcap_option sr_hwcap_options[];

static gboolean debug = 0;
static uint64_t limit_samples = 0;
static struct sr_output_format *output_format = NULL;
static int default_output_format = FALSE;
static char *output_format_param = NULL;
static char *input_format_param = NULL;
static GData *pd_ann_visible = NULL;

static gboolean opt_version = FALSE;
static gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
static gboolean opt_list_devs = FALSE;
static gboolean opt_wait_trigger = FALSE;
static gchar *opt_input_file = NULL;
static gchar *opt_output_file = NULL;
static gchar *opt_dev = NULL;
static gchar *opt_probes = NULL;
static gchar *opt_triggers = NULL;
static gchar *opt_pds = NULL;
static gchar *opt_pd_stack = NULL;
static gchar *opt_input_format = NULL;
static gchar *opt_format = NULL;
static gchar *opt_time = NULL;
static gchar *opt_samples = NULL;
static gchar *opt_continuous = NULL;

static GOptionEntry optargs[] = {
        {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version, "Show version and support list", NULL},
        {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel, "Select libsigrok loglevel", NULL},
        {"list-devices", 'D', 0, G_OPTION_ARG_NONE, &opt_list_devs, "List devices", NULL},
        {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file, "Load input from file", NULL},
        {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file, "Save output to file", NULL},
        {"device", 'd', 0, G_OPTION_ARG_STRING, &opt_dev, "Use device ID", NULL},
        {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes, "Probes to use", NULL},
        {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers, "Trigger configuration", NULL},
        {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger, "Wait for trigger", NULL},
        {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds, "Protocol decoder sequence", NULL},
        {"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING, &opt_pd_stack, "Protocol decoder stack", NULL},
        {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format, "Input format", NULL},
        {"format", 'f', 0, G_OPTION_ARG_STRING, &opt_format, "Output format", NULL},
        {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time, "How long to sample (ms)", NULL},
        {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples, "Number of samples to acquire", NULL},
        {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous, "Sample continuously", NULL},
        {NULL, 0, 0, 0, NULL, NULL, NULL}
};

static void show_version(void)
{
        GSList *plugins, *p, *l;
        struct sr_dev_plugin *plugin;
        struct sr_input_format **inputs;
        struct sr_output_format **outputs;
        struct srd_decoder *dec;
        int i;

        printf("sigrok-cli %s\n\n", VERSION);

        printf("Supported hardware drivers:\n");
        plugins = sr_hw_list();
        for (p = plugins; p; p = p->next) {
                plugin = p->data;
                printf("  %-20s %s\n", plugin->name, plugin->longname);
        }
        printf("\n");

        printf("Supported input formats:\n");
        inputs = sr_input_list();
        for (i = 0; inputs[i]; i++)
                printf("  %-20s %s\n", inputs[i]->id, inputs[i]->description);
        printf("\n");

        printf("Supported output formats:\n");
        outputs = sr_output_list();
        for (i = 0; outputs[i]; i++)
                printf("  %-20s %s\n", outputs[i]->id, outputs[i]->description);
        printf("\n");

        if (srd_init(NULL) == SRD_OK) {
                printf("Supported protocol decoders:\n");
                srd_decoders_load_all();
                for (l = srd_decoders_list(); l; l = l->next) {
                        dec = l->data;
                        printf("  %-20s %s\n", dec->id, dec->longname);
                }
                srd_exit();
        }
        printf("\n");

}

static void print_dev_line(const struct sr_dev *dev)
{
        const struct sr_dev_inst *sdi;

        sr_dev_info_get(dev, SR_DI_INST, (const void **)&sdi);

        if (sdi->vendor && sdi->vendor[0])
                printf("%s ", sdi->vendor);
        if (sdi->model && sdi->model[0])
                printf("%s ", sdi->model);
        if (sdi->version && sdi->version[0])
                printf("%s ", sdi->version);
        if (dev->probes)
                printf("with %d probes", g_slist_length(dev->probes));
        printf("\n");
}

static void show_dev_list(void)
{
        struct sr_dev *dev, *demo_dev;
        GSList *devs, *l;
        int devcnt;

        devcnt = 0;
        devs = sr_dev_list();

        if (g_slist_length(devs) == 0)
                return;

        printf("The following devices were found:\nID    Device\n");
        demo_dev = NULL;
        for (l = devs; l; l = l->next) {
                dev = l->data;
                if (sr_dev_has_hwcap(dev, SR_HWCAP_DEMO_DEV)) {
                        demo_dev = dev;
                        continue;
                }
                printf("%-3d   ", devcnt++);
                print_dev_line(dev);
        }
        if (demo_dev) {
                printf("demo  ");
                print_dev_line(demo_dev);
        }
}

static void show_dev_detail(void)
{
        struct sr_dev *dev;
        struct sr_hwcap_option *hwo;
        const struct sr_samplerates *samplerates;
        int cap, *hwcaps, i;
        char *s, *title;
        const char *charopts, **stropts;

        dev = parse_devstring(opt_dev);
        if (!dev) {
                printf("No such device. Use -D to list all devices.\n");
                return;
        }

        print_dev_line(dev);

        if (sr_dev_info_get(dev, SR_DI_TRIGGER_TYPES,
                                        (const void **)&charopts) == SR_OK) {
                printf("Supported triggers: ");
                while (*charopts) {
                        printf("%c ", *charopts);
                        charopts++;
                }
                printf("\n");
        }

        title = "Supported options:\n";
        hwcaps = dev->plugin->hwcap_get_all();
        for (cap = 0; hwcaps[cap]; cap++) {
                if (!(hwo = sr_hw_hwcap_get(hwcaps[cap])))
                        continue;

                if (title) {
                        printf("%s", title);
                        title = NULL;
                }

                if (hwo->hwcap == SR_HWCAP_PATTERN_MODE) {
                        printf("    %s", hwo->shortname);
                        if (sr_dev_info_get(dev, SR_DI_PATTERNMODES,
                                        (const void **)&stropts) == SR_OK) {
                                printf(" - supported modes:\n");
                                for (i = 0; stropts[i]; i++)
                                        printf("      %s\n", stropts[i]);
                        } else {
                                printf("\n");
                        }
                } else if (hwo->hwcap == SR_HWCAP_SAMPLERATE) {
                        printf("    %s", hwo->shortname);
                        /* Supported samplerates */
                        if (sr_dev_info_get(dev, SR_DI_SAMPLERATES,
                                        (const void **)&samplerates) != SR_OK) {
                                printf("\n");
                                continue;
                        }

                        if (samplerates->step) {
                                /* low */
                                if (!(s = sr_samplerate_string(samplerates->low)))
                                        continue;
                                printf(" (%s", s);
                                g_free(s);
                                /* high */
                                if (!(s = sr_samplerate_string(samplerates->high)))
                                        continue;
                                printf(" - %s", s);
                                g_free(s);
                                /* step */
                                if (!(s = sr_samplerate_string(samplerates->step)))
                                        continue;
                                printf(" in steps of %s)\n", s);
                                g_free(s);
                        } else {
                                printf(" - supported samplerates:\n");
                                for (i = 0; samplerates->list[i]; i++) {
                                        printf("      %7s\n", sr_samplerate_string(samplerates->list[i]));
                                }
                        }
                } else {
                        printf("    %s\n", hwo->shortname);
                }
        }
}

static void show_pd_detail(void)
{
        GSList *l;
        struct srd_decoder *dec;
        char **pdtokens, **pdtok, **ann, *doc;

        pdtokens = g_strsplit(opt_pds, ",", -1);
        for (pdtok = pdtokens; *pdtok; pdtok++) {
                if (!(dec = srd_decoder_get_by_id(*pdtok))) {
                        printf("Protocol decoder %s not found.", *pdtok);
                        return;
                }
                printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
                                dec->id, dec->name, dec->longname, dec->desc);
                printf("License: %s\n", dec->license);
                if (dec->annotations) {
                        printf("Annotations:\n");
                        for (l = dec->annotations; l; l = l->next) {
                                ann = l->data;
                                printf("- %s\n  %s\n", ann[0], ann[1]);
                        }
                }
                if ((doc = srd_decoder_doc(dec))) {
                        printf("Documentation:\n%s\n", doc[0] == '\n' ? doc+1 : doc);
                        g_free(doc);
                }
        }

        g_strfreev(pdtokens);

}

static void datafeed_in(struct sr_dev *dev, struct sr_datafeed_packet *packet)
{
        static struct sr_output *o = NULL;
        static int probelist[SR_MAX_NUM_PROBES] = { 0 };
        static uint64_t received_samples = 0;
        static int unitsize = 0;
        static int triggered = 0;
        static FILE *outfile = NULL;
        struct sr_probe *probe;
        struct sr_datafeed_header *header;
        struct sr_datafeed_logic *logic;
        int num_enabled_probes, sample_size, ret, i;
        uint64_t output_len, filter_out_len;
        char *output_buf, *filter_out;

        /* If the first packet to come in isn't a header, don't even try. */
        if (packet->type != SR_DF_HEADER && o == NULL)
                return;

        sample_size = -1;
        switch (packet->type) {
        case SR_DF_HEADER:
                g_message("cli: Received SR_DF_HEADER");
                /* Initialize the output module. */
                if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
                        printf("Output module malloc failed.\n");
                        exit(1);
                }
                o->format = output_format;
                o->dev = dev;
                o->param = output_format_param;
                if (o->format->init) {
                        if (o->format->init(o) != SR_OK) {
                                printf("Output format initialization failed.\n");
                                exit(1);
                        }
                }

                header = packet->payload;
                num_enabled_probes = 0;
                for (i = 0; i < header->num_logic_probes; i++) {
                        probe = g_slist_nth_data(dev->probes, i);
                        if (probe->enabled)
                                probelist[num_enabled_probes++] = probe->index;
                }
                /* How many bytes we need to store num_enabled_probes bits */
                unitsize = (num_enabled_probes + 7) / 8;

                outfile = stdout;
                if (opt_output_file) {
                        if (default_output_format) {
                                /* output file is in session format, which means we'll
                                 * dump everything in the datastore as it comes in,
                                 * and save from there after the session. */
                                outfile = NULL;
                                ret = sr_datastore_new(unitsize, &(dev->datastore));
                                if (ret != SR_OK) {
                                        printf("Failed to create datastore.\n");
                                        exit(1);
                                }
                        } else {
                                /* saving to a file in whatever format was set
                                 * with --format, so all we need is a filehandle */
                                outfile = g_fopen(opt_output_file, "wb");
                        }
                }
                if (opt_pds)
                        srd_session_start(num_enabled_probes, unitsize,
                                        header->samplerate);
                break;
        case SR_DF_END:
                g_message("cli: Received SR_DF_END");
                if (!o) {
                        g_message("cli: double end!");
                        break;
                }
                if (o->format->event) {
                        o->format->event(o, SR_DF_END, &output_buf, &output_len);
                        if (output_len) {
                                if (outfile)
                                        fwrite(output_buf, 1, output_len, outfile);
                                g_free(output_buf);
                                output_len = 0;
                        }
                }
                if (limit_samples && received_samples < limit_samples)
                        printf("Device only sent %" PRIu64 " samples.\n",
                               received_samples);
                if (opt_continuous)
                        printf("Device stopped after %" PRIu64 " samples.\n",
                               received_samples);
                sr_session_halt();
                if (outfile && outfile != stdout)
                        fclose(outfile);
                g_free(o);
                o = NULL;
                break;
        case SR_DF_TRIGGER:
                g_message("cli: received SR_DF_TRIGGER");
                if (o->format->event)
                        o->format->event(o, SR_DF_TRIGGER, &output_buf,
                                         &output_len);
                triggered = 1;
                break;
        case SR_DF_LOGIC:
                logic = packet->payload;
                sample_size = logic->unitsize;
                g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
                break;
        }

        /* not supporting anything but SR_DF_LOGIC for now */

        if (sample_size == -1 || logic->length == 0)
                return;

        /* Don't store any samples until triggered. */
        if (opt_wait_trigger && !triggered)
                return;

        if (limit_samples && received_samples >= limit_samples)
                return;

        /* TODO: filters only support SR_DF_LOGIC */
        ret = sr_filter_probes(sample_size, unitsize, probelist,
                                   logic->data, logic->length,
                                   &filter_out, &filter_out_len);
        if (ret != SR_OK)
                return;

        /* what comes out of the filter is guaranteed to be packed into the
         * minimum size needed to support the number of samples at this sample
         * size. however, the driver may have submitted too much -- cut off
         * the buffer of the last packet according to the sample limit.
         */
        if (limit_samples && (received_samples + logic->length / sample_size >
                        limit_samples * sample_size))
                filter_out_len = limit_samples * sample_size - received_samples;

        if (dev->datastore)
                sr_datastore_put(dev->datastore, filter_out,
                                 filter_out_len, sample_size, probelist);

        if (opt_output_file && default_output_format)
                /* saving to a session file, don't need to do anything else
                 * to this data for now. */
                goto cleanup;

        if (opt_pds) {
                if (srd_session_feed(received_samples, (uint8_t*)filter_out,
                                filter_out_len) != SRD_OK)
                        sr_session_halt();
        } else {
                output_len = 0;
                if (o->format->data && packet->type == o->format->df_type)
                        o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len);
                if (output_len) {
                        fwrite(output_buf, 1, output_len, outfile);
                        g_free(output_buf);
                }
        }

cleanup:
        g_free(filter_out);
        received_samples += logic->length / sample_size;

}

/* Register the given PDs for this session.
 * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
 * That will instantiate two SPI decoders on the clock but different data
 * lines.
 */
static int register_pds(struct sr_dev *dev, const char *pdstring)
{
        GHashTable *pd_opthash;
        struct srd_decoder_inst *di;
        char **pdtokens, **pdtok, *pd_name;

        /* Avoid compiler warnings. */
        (void)dev;

        g_datalist_init(&pd_ann_visible);
        pdtokens = g_strsplit(pdstring, ",", -1);
        pd_opthash = NULL;
        pd_name = NULL;

        for (pdtok = pdtokens; *pdtok; pdtok++) {
                if (!(pd_opthash = parse_generic_arg(*pdtok))) {
                        fprintf(stderr, "Invalid protocol decoder option '%s'.\n", *pdtok);
                        goto err_out;
                }

                pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
                g_hash_table_remove(pd_opthash, "sigrok_key");
                if (srd_decoder_load(pd_name) != SRD_OK) {
                        fprintf(stderr, "Failed to load protocol decoder %s\n", pd_name);
                        goto err_out;
                }
                if (!(di = srd_inst_new(pd_name, pd_opthash))) {
                        fprintf(stderr, "Failed to instantiate protocol decoder %s\n", pd_name);
                        goto err_out;
                }
                g_datalist_set_data(&pd_ann_visible, di->inst_id, pd_name);

                /* Any keys left in the options hash are probes, where the key
                 * is the probe name as specified in the decoder class, and the
                 * value is the probe number i.e. the order in which the PD's
                 * incoming samples are arranged. */
                if (srd_inst_probes_set(di, pd_opthash) != SRD_OK)
                        goto err_out;
                g_hash_table_destroy(pd_opthash);
                pd_opthash = NULL;
        }

err_out:
        g_strfreev(pdtokens);
        if (pd_opthash)
                g_hash_table_destroy(pd_opthash);
        if (pd_name)
                g_free(pd_name);

        return 0;
}

void show_pd_annotation(struct srd_proto_data *pdata, void *user_data)
{
        int i;
        char **annotations;

        /* 'user_data' is not used in this specific callback. */
        (void)user_data;

        if (pdata->ann_format != 0) {
                /* CLI only shows the default annotation format. */
                return;
        }

        if (!g_datalist_get_data(&pd_ann_visible, pdata->pdo->di->inst_id)) {
                /* Not in the list of PDs whose annotations we're showing. */
                return;
        }

        annotations = pdata->data;
        if (opt_loglevel > SR_LOG_WARN)
                printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
        printf("%s: ", pdata->pdo->proto_id);
        for (i = 0; annotations[i]; i++)
                printf("\"%s\" ", annotations[i]);
        printf("\n");

}

static int select_probes(struct sr_dev *dev)
{
        struct sr_probe *probe;
        char **probelist;
        int max_probes, i;

        if (!opt_probes)
                return SR_OK;

        /*
         * This only works because a device by default initializes
         * and enables all its probes.
         */
        max_probes = g_slist_length(dev->probes);
        probelist = parse_probestring(max_probes, opt_probes);
        if (!probelist) {
                return SR_ERR;
        }

        for (i = 0; i < max_probes; i++) {
                if (probelist[i]) {
                        sr_dev_probe_name(dev, i + 1, probelist[i]);
                        g_free(probelist[i]);
                } else {
                        probe = sr_dev_probe_find(dev, i + 1);
                        probe->enabled = FALSE;
                }
        }
        g_free(probelist);

        return SR_OK;
}

/**
 * Return the input file format which the CLI tool should use.
 *
 * If the user specified -I / --input-format, use that one. Otherwise, try to
 * autodetect the format as good as possible. Failing that, return NULL.
 *
 * @param filename The filename of the input file. Must not be NULL.
 * @param opt The -I / --input-file option the user specified (or NULL).
 *
 * @return A pointer to the 'struct sr_input_format' that should be used,
 *         or NULL if no input format was selected or auto-detected.
 */
static struct sr_input_format *determine_input_file_format(
                        const char *filename, const char *opt)
{
        int i;
        struct sr_input_format **inputs;

        /* If there are no input formats, return NULL right away. */
        inputs = sr_input_list();
        if (!inputs) {
                fprintf(stderr, "cli: %s: no supported input formats "
                        "available", __func__);
                return NULL;
        }

        /* If the user specified -I / --input-format, use that one. */
        if (opt) {
                for (i = 0; inputs[i]; i++) {
                        if (strcasecmp(inputs[i]->id, opt_input_format))
                                continue;
                        printf("Using user-specified input file format"
                               " '%s'.\n", inputs[i]->id);
                        return inputs[i];
                }

                /* The user specified an unknown input format, return NULL. */
                fprintf(stderr, "Error: Specified input file format '%s' is "
                        "unknown.\n", opt_input_format);
                return NULL;
        }

        /* Otherwise, try to find an input module that can handle this file. */
        for (i = 0; inputs[i]; i++) {
                if (inputs[i]->format_match(filename))
                        break;
        }

        /* Return NULL if no input module wanted to touch this. */
        if (!inputs[i]) {
                fprintf(stderr, "Error: No matching input module found.\n");
                return NULL;
        }
                
        printf("Using input file format '%s'.\n", inputs[i]->id);
        return inputs[i];
}

static void load_input_file_format(void)
{
        struct stat st;
        struct sr_input *in;
        struct sr_input_format *input_format;

        input_format = determine_input_file_format(opt_input_file,
                                                   opt_input_format);
        if (!input_format) {
                fprintf(stderr, "Error: Couldn't detect input file format.\n");
                return;
        }

        if (stat(opt_input_file, &st) == -1) {
                printf("Failed to load %s: %s\n", opt_input_file,
                        strerror(errno));
                exit(1);
        }

        /* Initialize the input module. */
        if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
                printf("Failed to allocate input module.\n");
                exit(1);
        }
        in->format = input_format;
        in->param = input_format_param;
        if (in->format->init) {
                if (in->format->init(in) != SR_OK) {
                        printf("Input format init failed.\n");
                        exit(1);
                }
        }

        if (select_probes(in->vdev) > 0)
            return;

        sr_session_new();
        sr_session_datafeed_callback_add(datafeed_in);
        if (sr_session_dev_add(in->vdev) != SR_OK) {
                printf("Failed to use device.\n");
                sr_session_destroy();
                return;
        }

        input_format->loadfile(in, opt_input_file);
        if (opt_output_file && default_output_format) {
                if (sr_session_save(opt_output_file) != SR_OK)
                        printf("Failed to save session.\n");
        }
        sr_session_destroy();

}

static void load_input_file(void)
{

        if (sr_session_load(opt_input_file) == SR_OK) {
                /* sigrok session file */
                sr_session_datafeed_callback_add(datafeed_in);
                sr_session_start();
                sr_session_run();
                sr_session_stop();
        }
        else {
                /* fall back on input modules */
                load_input_file_format();
        }

}

int num_real_devs(void)
{
        struct sr_dev *dev;
        GSList *devs, *l;
        int num_devs;

        num_devs = 0;
        devs = sr_dev_list();
        for (l = devs; l; l = l->next) {
                dev = l->data;
                if (!sr_dev_has_hwcap(dev, SR_HWCAP_DEMO_DEV))
                        num_devs++;
        }

        return num_devs;
}

static int set_dev_options(struct sr_dev *dev, GHashTable *args)
{
        GHashTableIter iter;
        gpointer key, value;
        int ret, i;
        uint64_t tmp_u64;
        gboolean found;
        gboolean tmp_bool;

        g_hash_table_iter_init(&iter, args);
        while (g_hash_table_iter_next(&iter, &key, &value)) {
                found = FALSE;
                for (i = 0; sr_hwcap_options[i].hwcap; i++) {
                        if (strcmp(sr_hwcap_options[i].shortname, key))
                                continue;
                        if ((value == NULL) && 
                            (sr_hwcap_options[i].type != SR_T_BOOL)) {
                                printf("Option '%s' needs a value.\n", (char *)key);
                                return SR_ERR;
                        }
                        found = TRUE;
                        switch (sr_hwcap_options[i].type) {
                        case SR_T_UINT64:
                                ret = sr_parse_sizestring(value, &tmp_u64);
                                if (ret != SR_OK)
                                        break;
                                ret = dev->plugin->config_set(dev->plugin_index,
                                        sr_hwcap_options[i].hwcap, &tmp_u64);
                                break;
                        case SR_T_CHAR:
                                ret = dev->plugin->config_set(dev->plugin_index,
                                        sr_hwcap_options[i].hwcap, value);
                                break;
                        case SR_T_BOOL:
                                if (!value)
                                        tmp_bool = TRUE;
                                else 
                                        tmp_bool = sr_parse_boolstring(value);
                                ret = dev->plugin->config_set(dev->plugin_index,
                                                sr_hwcap_options[i].hwcap, 
                                                GINT_TO_POINTER(tmp_bool));
                                break;
                        default:
                                ret = SR_ERR;
                        }

                        if (ret != SR_OK) {
                                printf("Failed to set device option '%s'.\n", (char *)key);
                                return ret;
                        }
                        else
                                break;
                }
                if (!found) {
                        printf("Unknown device option '%s'.\n", (char *) key);
                        return SR_ERR;
                }
        }

        return SR_OK;
}

static void run_session(void)
{
        struct sr_dev *dev;
        GHashTable *devargs;
        int num_devs, max_probes, i;
        uint64_t time_msec;
        char **probelist, *devspec;

        devargs = NULL;
        if (opt_dev) {
                devargs = parse_generic_arg(opt_dev);
                devspec = g_hash_table_lookup(devargs, "sigrok_key");
                dev = parse_devstring(devspec);
                if (!dev) {
                        g_warning("Device not found.");
                        return;
                }
                g_hash_table_remove(devargs, "sigrok_key");
        } else {
                num_devs = num_real_devs();
                if (num_devs == 1) {
                        /* No device specified, but there is only one. */
                        devargs = NULL;
                        dev = parse_devstring("0");
                } else if (num_devs == 0) {
                        printf("No devices found.\n");
                        return;
                } else {
                        printf("%d devices found, please select one.\n", num_devs);
                        return;
                }
        }

        sr_session_new();
        sr_session_datafeed_callback_add(datafeed_in);

        if (sr_session_dev_add(dev) != SR_OK) {
                printf("Failed to use device.\n");
                sr_session_destroy();
                return;
        }

        if (devargs) {
                if (set_dev_options(dev, devargs) != SR_OK) {
                        sr_session_destroy();
                        return;
                }
                g_hash_table_destroy(devargs);
        }

        if (select_probes(dev) != SR_OK)
            return;

        if (opt_continuous) {
                if (!sr_hw_has_hwcap(dev->plugin, SR_HWCAP_CONTINUOUS)) {
                        printf("This device does not support continuous sampling.");
                        sr_session_destroy();
                        return;
                }
        }

        if (opt_triggers) {
                probelist = sr_parse_triggerstring(dev, opt_triggers);
                if (!probelist) {
                        sr_session_destroy();
                        return;
                }

                max_probes = g_slist_length(dev->probes);
                for (i = 0; i < max_probes; i++) {
                        if (probelist[i]) {
                                sr_dev_trigger_set(dev, i + 1, probelist[i]);
                                g_free(probelist[i]);
                        }
                }
                g_free(probelist);
        }

        if (opt_time) {
                time_msec = sr_parse_timestring(opt_time);
                if (time_msec == 0) {
                        printf("Invalid time '%s'\n", opt_time);
                        sr_session_destroy();
                        return;
                }

                if (sr_hw_has_hwcap(dev->plugin, SR_HWCAP_LIMIT_MSEC)) {
                        if (dev->plugin->config_set(dev->plugin_index,
                            SR_HWCAP_LIMIT_MSEC, &time_msec) != SR_OK) {
                                printf("Failed to configure time limit.\n");
                                sr_session_destroy();
                                return;
                        }
                }
                else {
                        /* time limit set, but device doesn't support this...
                         * convert to samples based on the samplerate.
                         */
                        limit_samples = 0;
                        if (sr_dev_has_hwcap(dev, SR_HWCAP_SAMPLERATE)) {
                                const uint64_t *samplerate;

                                sr_dev_info_get(dev, SR_DI_CUR_SAMPLERATE,
                                                (const void **)&samplerate);
                                limit_samples = (*samplerate) * time_msec / (uint64_t)1000;
                        }
                        if (limit_samples == 0) {
                                printf("Not enough time at this samplerate.\n");
                                sr_session_destroy();
                                return;
                        }

                        if (dev->plugin->config_set(dev->plugin_index,
                            SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK) {
                                printf("Failed to configure time-based sample limit.\n");
                                sr_session_destroy();
                                return;
                        }
                }
        }

        if (opt_samples) {
                if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)
                        || (dev->plugin->config_set(dev->plugin_index,
                            SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK)) {
                        printf("Failed to configure sample limit.\n");
                        sr_session_destroy();
                        return;
                }
        }

        if (dev->plugin->config_set(dev->plugin_index,
                  SR_HWCAP_PROBECONFIG, (char *)dev->probes) != SR_OK) {
                printf("Failed to configure probes.\n");
                sr_session_destroy();
                return;
        }

        if (sr_session_start() != SR_OK) {
                printf("Failed to start session.\n");
                sr_session_destroy();
                return;
        }

        if (opt_continuous)
                add_anykey();

        sr_session_run();

        if (opt_continuous)
                clear_anykey();

        if (opt_output_file && default_output_format) {
                if (sr_session_save(opt_output_file) != SR_OK)
                        printf("Failed to save session.\n");
        }
        sr_session_destroy();

}

static void logger(const gchar *log_domain, GLogLevelFlags log_level,
                   const gchar *message, gpointer user_data)
{
        /* Avoid compiler warnings. */
        (void)log_domain;
        (void)user_data;

        /*
         * All messages, warnings, errors etc. go to stderr (not stdout) in
         * order to not mess up the CLI tool data output, e.g. VCD output.
         */
        if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_WARNING)) {
                fprintf(stderr, "%s\n", message);
                fflush(stderr);
        } else {
                if ((log_level & G_LOG_LEVEL_MESSAGE && debug == 1)
                    || debug == 2) {
                        printf("%s\n", message);
                        fflush(stderr);
                }
        }
}

int main(int argc, char **argv)
{
        GOptionContext *context;
        GError *error;
        GHashTable *fmtargs;
        GHashTableIter iter;
        gpointer key, value;
        struct sr_output_format **outputs;
        struct srd_decoder_inst *di_from, *di_to;
        int i, ret;
        char *fmtspec, **pds;

        g_log_set_default_handler(logger, NULL);
        if (getenv("SIGROK_DEBUG"))
                debug = strtol(getenv("SIGROK_DEBUG"), NULL, 10);

        error = NULL;
        context = g_option_context_new(NULL);
        g_option_context_add_main_entries(context, optargs, NULL);

        if (!g_option_context_parse(context, &argc, &argv, &error)) {
                g_warning("%s", error->message);
                return 1;
        }

        /* Set the loglevel (amount of messages to output) for libsigrok. */
        if (sr_log_loglevel_set(opt_loglevel) != SR_OK) {
                fprintf(stderr, "cli: %s: sr_log_loglevel_set(%d) failed\n",
                        __func__, opt_loglevel);
                return 1;
        }

        /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
        if (srd_log_loglevel_set(opt_loglevel) != SRD_OK) {
                fprintf(stderr, "cli: %s: srd_log_loglevel_set(%d) failed\n",
                        __func__, opt_loglevel);
                return 1;
        }

        if (sr_init() != SR_OK)
                return 1;

        if (opt_pds) {
                if (srd_init(NULL) != SRD_OK) {
                        printf("Failed to initialize sigrokdecode\n");
                        return 1;
                }
                if (register_pds(NULL, opt_pds) != 0) {
                        printf("Failed to register protocol decoders\n");
                        return 1;
                }
                if (srd_register_callback(SRD_OUTPUT_ANN,
                                show_pd_annotation, NULL) != SRD_OK) {
                        printf("Failed to register protocol decoder callback\n");
                        return 1;
                }
        }

        if (opt_pd_stack) {
                pds = g_strsplit(opt_pd_stack, ",", 0);
                if (g_strv_length(pds) < 2) {
                        printf("Specify at least two protocol decoders to stack.\n");
                        return 1;
                }

                if (!(di_from = srd_inst_find_by_id(pds[0]))) {
                        printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[0]);
                        return 1;
                }
                for (i = 1; pds[i]; i++) {
                        if (!(di_to = srd_inst_find_by_id(pds[i]))) {
                                printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[i]);
                                return 1;
                        }
                        if ((ret = srd_inst_stack(di_from, di_to) != SRD_OK))
                                return ret;

                        /* Don't show annotation from this PD. Only the last PD in
                         * the stack will be left on the annotation list.
                         */
                        g_datalist_remove_data(&pd_ann_visible, di_from->inst_id);

                        di_from = di_to;
                }
                g_strfreev(pds);
        }

        if (!opt_format) {
                opt_format = DEFAULT_OUTPUT_FORMAT;
                /* we'll need to remember this so when saving to a file
                 * later, sigrok session format will be used.
                 */
                default_output_format = TRUE;
        }
        fmtargs = parse_generic_arg(opt_format);
        fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
        if (!fmtspec) {
                printf("Invalid output format.\n");
                return 1;
        }
        outputs = sr_output_list();
        for (i = 0; outputs[i]; i++) {
                if (strcmp(outputs[i]->id, fmtspec))
                        continue;
                g_hash_table_remove(fmtargs, "sigrok_key");
                output_format = outputs[i];
                g_hash_table_iter_init(&iter, fmtargs);
                while (g_hash_table_iter_next(&iter, &key, &value)) {
                        /* only supporting one parameter per output module
                         * for now, and only its value */
                        output_format_param = g_strdup(value);
                        break;
                }
                break;
        }
        if (!output_format) {
                printf("invalid output format %s\n", opt_format);
                return 1;
        }

        if (opt_version)
                show_version();
        else if (opt_list_devs)
                show_dev_list();
        else if (opt_input_file)
                load_input_file();
        else if (opt_samples || opt_time || opt_continuous)
                run_session();
        else if (opt_dev)
                show_dev_detail();
        else if (opt_pds)
                show_pd_detail();
        else
                printf("%s", g_option_context_get_help(context, TRUE, NULL));

        if (opt_pds)
                srd_exit();

        g_option_context_free(context);
        g_hash_table_destroy(fmtargs);
        sr_exit();

        return 0;
}