From: Bert Vermeulen Date: Sun, 17 Nov 2013 12:15:38 +0000 (+0100) Subject: Refactor main source into separate files X-Git-Tag: sigrok-cli-0.5.0~63 X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=2be182e6437fb082aedca653fdc106d702518db0;p=sigrok-cli.git Refactor main source into separate files --- diff --git a/Makefile.am b/Makefile.am index 2534750..f273aef 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,7 +1,7 @@ ## ## This file is part of the sigrok-cli project. ## -## Copyright (C) 2010 Bert Vermeulen +## Copyright (C) 2013 Bert Vermeulen ## ## 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 @@ -23,7 +23,16 @@ SUBDIRS = contrib doc bin_PROGRAMS = sigrok-cli -sigrok_cli_SOURCES = sigrok-cli.c sigrok-cli.h parsers.c anykey.c +sigrok_cli_SOURCES = \ + main.c \ + show.c \ + device.c \ + session.c \ + input.c \ + decode.c \ + sigrok-cli.h \ + parsers.c \ + anykey.c MAINTAINERCLEANFILES = ChangeLog diff --git a/decode.c b/decode.c new file mode 100644 index 0000000..19112a9 --- /dev/null +++ b/decode.c @@ -0,0 +1,463 @@ +/* + * This file is part of the sigrok-cli project. + * + * Copyright (C) 2013 Bert Vermeulen + * + * 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 . + */ + +#include "config.h" +#include +#include +#ifdef HAVE_SRD +#include /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#endif +#include "sigrok-cli.h" + +#ifdef HAVE_SRD +static GHashTable *pd_ann_visible = NULL; +static GHashTable *pd_meta_visible = NULL; +static GHashTable *pd_binary_visible = NULL; + +extern struct srd_session *srd_sess; +extern gint opt_loglevel; +extern gchar *opt_pds; +extern gchar *opt_pd_stack; +extern gchar *opt_pd_annotations; +extern gchar *opt_pd_meta; +extern gchar *opt_pd_binary; + + +static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash, + GHashTable **options) +{ + struct srd_decoder_option *o; + GSList *optl; + GVariant *gvar; + gint64 val_int; + int ret; + char *val_str, *conv; + + ret = TRUE; + *options = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, + (GDestroyNotify)g_variant_unref); + + for (optl = dec->options; optl; optl = optl->next) { + o = optl->data; + if (!(val_str = g_hash_table_lookup(hash, o->id))) + /* Not specified. */ + continue; + if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_STRING)) { + gvar = g_variant_new_string(val_str); + } else if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_INT64)) { + val_int = strtoll(val_str, &conv, 0); + if (!conv || conv == val_str) { + g_critical("Protocol decoder '%s' option '%s' " + "requires a number.", dec->name, o->id); + ret = FALSE; + break; + } + gvar = g_variant_new_int64(val_int); + } else { + g_critical("Unsupported type for option '%s' (%s)", + o->id, g_variant_get_type_string(o->def)); + ret = FALSE; + break; + } + g_variant_ref_sink(gvar); + g_hash_table_insert(*options, g_strdup(o->id), gvar); + g_hash_table_remove(hash, o->id); + } + + return ret; +} + +static int probes_to_gvar(struct srd_decoder *dec, GHashTable *hash, + GHashTable **probes) +{ + struct srd_probe *p; + GSList *all_probes, *l; + GVariant *gvar; + gint32 val_int; + int ret; + char *val_str, *conv; + + ret = TRUE; + *probes = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, + (GDestroyNotify)g_variant_unref); + + all_probes = g_slist_copy(dec->probes); + all_probes = g_slist_concat(all_probes, g_slist_copy(dec->opt_probes)); + for (l = all_probes; l; l = l->next) { + p = l->data; + if (!(val_str = g_hash_table_lookup(hash, p->id))) + /* Not specified. */ + continue; + val_int = strtoll(val_str, &conv, 10); + if (!conv || conv == val_str) { + g_critical("Protocol decoder '%s' probes '%s' " + "is not a number.", dec->name, p->id); + ret = FALSE; + break; + } + gvar = g_variant_new_int32(val_int); + g_variant_ref_sink(gvar); + g_hash_table_insert(*probes, g_strdup(p->id), gvar); + g_hash_table_remove(hash, p->id); + } + g_slist_free(all_probes); + + return ret; +} + +/* 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. + */ +int register_pds(const char *pdstring) +{ + struct srd_decoder *dec; + GHashTable *pd_opthash, *options, *probes; + GList *leftover, *l; + struct srd_decoder_inst *di; + int ret; + char **pdtokens, **pdtok, *pd_name; + + pd_ann_visible = g_hash_table_new_full(g_str_hash, g_int_equal, + g_free, NULL); + ret = 0; + pd_name = NULL; + pd_opthash = options = probes = NULL; + pdtokens = g_strsplit(pdstring, ",", 0); + for (pdtok = pdtokens; *pdtok; pdtok++) { + if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) { + g_critical("Invalid protocol decoder option '%s'.", *pdtok); + break; + } + + 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) { + g_critical("Failed to load protocol decoder %s.", pd_name); + ret = 1; + break; + } + dec = srd_decoder_get_by_id(pd_name); + + /* Convert decoder option and probe values to GVariant. */ + if (!opts_to_gvar(dec, pd_opthash, &options)) { + ret = 1; + break; + } + if (!probes_to_gvar(dec, pd_opthash, &probes)) { + ret = 1; + break; + } + if (g_hash_table_size(pd_opthash) > 0) { + leftover = g_hash_table_get_keys(pd_opthash); + for (l = leftover; l; l = l->next) + g_critical("Unknown option or probe '%s'", (char *)l->data); + g_list_free(leftover); + break; + } + + if (!(di = srd_inst_new(srd_sess, pd_name, options))) { + g_critical("Failed to instantiate protocol decoder %s.", pd_name); + ret = 1; + break; + } + + /* If no annotation list was specified, add them all in now. + * This will be pared down later to leave only the last PD + * in the stack. + */ + if (!opt_pd_annotations) + g_hash_table_insert(pd_ann_visible, + g_strdup(di->inst_id), GINT_TO_POINTER(-1)); + + /* Remap the probes if needed. */ + if (srd_inst_probe_set_all(di, probes) != SRD_OK) { + ret = 1; + break; + } + } + + g_strfreev(pdtokens); + if (pd_opthash) + g_hash_table_destroy(pd_opthash); + if (options) + g_hash_table_destroy(options); + if (probes) + g_hash_table_destroy(probes); + if (pd_name) + g_free(pd_name); + + return ret; +} + +int setup_pd_stack(void) +{ + struct srd_decoder_inst *di_from, *di_to; + int ret, i; + char **pds, **ids; + + /* Set up the protocol decoder stack. */ + pds = g_strsplit(opt_pds, ",", 0); + if (g_strv_length(pds) > 1) { + if (opt_pd_stack) { + /* A stack setup was specified, use that. */ + g_strfreev(pds); + pds = g_strsplit(opt_pd_stack, ",", 0); + if (g_strv_length(pds) < 2) { + g_strfreev(pds); + g_critical("Specify at least two protocol decoders to stack."); + return 1; + } + } + + /* First PD goes at the bottom of the stack. */ + ids = g_strsplit(pds[0], ":", 0); + if (!(di_from = srd_inst_find_by_id(srd_sess, ids[0]))) { + g_strfreev(ids); + g_critical("Cannot stack protocol decoder '%s': " + "instance not found.", pds[0]); + return 1; + } + g_strfreev(ids); + + /* Every subsequent PD goes on top. */ + for (i = 1; pds[i]; i++) { + ids = g_strsplit(pds[i], ":", 0); + if (!(di_to = srd_inst_find_by_id(srd_sess, ids[0]))) { + g_strfreev(ids); + g_critical("Cannot stack protocol decoder '%s': " + "instance not found.", pds[i]); + return 1; + } + g_strfreev(ids); + if ((ret = srd_inst_stack(srd_sess, di_from, di_to)) != SRD_OK) + return 1; + + /* Don't show annotation from this PD. Only the last PD in + * the stack will be left on the annotation list (unless + * the annotation list was specifically provided). + */ + if (!opt_pd_annotations) + g_hash_table_remove(pd_ann_visible, + di_from->inst_id); + + di_from = di_to; + } + } + g_strfreev(pds); + + return 0; +} + +int setup_pd_annotations(void) +{ + GSList *l; + struct srd_decoder *dec; + int ann_class; + char **pds, **pdtok, **keyval, **ann_descr; + + /* Set up custom list of PDs and annotations to show. */ + pds = g_strsplit(opt_pd_annotations, ",", 0); + for (pdtok = pds; *pdtok && **pdtok; pdtok++) { + keyval = g_strsplit(*pdtok, "=", 0); + if (!(dec = srd_decoder_get_by_id(keyval[0]))) { + g_critical("Protocol decoder '%s' not found.", keyval[0]); + return 1; + } + if (!dec->annotations) { + g_critical("Protocol decoder '%s' has no annotations.", keyval[0]); + return 1; + } + ann_class = 0; + if (g_strv_length(keyval) == 2) { + for (l = dec->annotations; l; l = l->next, ann_class++) { + ann_descr = l->data; + if (!canon_cmp(ann_descr[0], keyval[1])) + /* Found it. */ + break; + } + if (!l) { + g_critical("Annotation '%s' not found " + "for protocol decoder '%s'.", keyval[1], keyval[0]); + return 1; + } + g_debug("cli: Showing protocol decoder %s annotation " + "class %d (%s).", keyval[0], ann_class, ann_descr[0]); + } else { + /* No class specified: show all of them. */ + ann_class = -1; + g_debug("cli: Showing all annotation classes for protocol " + "decoder %s.", keyval[0]); + } + g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann_class)); + g_strfreev(keyval); + } + g_strfreev(pds); + + return 0; +} + +int setup_pd_meta(void) +{ + struct srd_decoder *dec; + char **pds, **pdtok; + + pd_meta_visible = g_hash_table_new_full(g_str_hash, g_int_equal, + g_free, NULL); + pds = g_strsplit(opt_pd_meta, ",", 0); + for (pdtok = pds; *pdtok && **pdtok; pdtok++) { + if (!(dec = srd_decoder_get_by_id(*pdtok))) { + g_critical("Protocol decoder '%s' not found.", *pdtok); + return 1; + } + g_debug("cli: Showing protocol decoder meta output from '%s'.", *pdtok); + g_hash_table_insert(pd_meta_visible, g_strdup(*pdtok), NULL); + } + g_strfreev(pds); + + return 0; +} + +int setup_pd_binary(void) +{ + GSList *l; + struct srd_decoder *dec; + int bin_class; + char **pds, **pdtok, **keyval, *bin_name; + + pd_binary_visible = g_hash_table_new_full(g_str_hash, g_int_equal, + g_free, NULL); + pds = g_strsplit(opt_pd_binary, ",", 0); + for (pdtok = pds; *pdtok && **pdtok; pdtok++) { + keyval = g_strsplit(*pdtok, "=", 0); + if (!(dec = srd_decoder_get_by_id(keyval[0]))) { + g_critical("Protocol decoder '%s' not found.", keyval[0]); + return 1; + } + if (!dec->binary) { + g_critical("Protocol decoder '%s' has no binary output.", keyval[0]); + return 1; + } + bin_class = 0; + if (g_strv_length(keyval) == 2) { + for (l = dec->binary; l; l = l->next, bin_class++) { + bin_name = l->data; + if (!canon_cmp(bin_name, keyval[1])) + /* Found it. */ + break; + } + if (!l) { + g_critical("binary output '%s' not found " + "for protocol decoder '%s'.", keyval[1], keyval[0]); + return 1; + } + g_debug("cli: Showing protocol decoder %s binary class " + "%d (%s).", keyval[0], bin_class, bin_name); + } else { + /* No class specified: output all of them. */ + bin_class = -1; + g_debug("cli: Showing all binary classes for protocol " + "decoder %s.", keyval[0]); + } + g_hash_table_insert(pd_binary_visible, g_strdup(keyval[0]), GINT_TO_POINTER(bin_class)); + g_strfreev(keyval); + } + g_strfreev(pds); + + return 0; +} + +void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data) +{ + struct srd_proto_data_annotation *pda; + gpointer ann_format; + int format; + + /* 'cb_data' is not used in this specific callback. */ + (void)cb_data; + + if (!pd_ann_visible) + return; + + if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id, + NULL, &ann_format)) + /* Not in the list of PDs whose annotations we're showing. */ + return; + + format = GPOINTER_TO_INT(ann_format); + pda = pdata->data; + if (format != -1 && pda->ann_format != format) + /* We don't want this particular format from the PD. */ + return; + + if (opt_loglevel > SR_LOG_WARN) + printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample); + printf("%s: ", pdata->pdo->proto_id); + /* Show only the longest annotation. */ + printf("\"%s\" ", pda->ann_text[0]); + printf("\n"); + fflush(stdout); +} + +void show_pd_meta(struct srd_proto_data *pdata, void *cb_data) +{ + + /* 'cb_data' is not used in this specific callback. */ + (void)cb_data; + + if (!g_hash_table_lookup_extended(pd_meta_visible, + pdata->pdo->di->decoder->id, NULL, NULL)) + /* Not in the list of PDs whose meta output we're showing. */ + return; + + if (opt_loglevel > SR_LOG_WARN) + printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample); + printf("%s: ", pdata->pdo->proto_id); + printf("%s: %s", pdata->pdo->meta_name, g_variant_print(pdata->data, FALSE)); + printf("\n"); + fflush(stdout); +} + +void show_pd_binary(struct srd_proto_data *pdata, void *cb_data) +{ + struct srd_proto_data_binary *pdb; + gpointer classp; + int class; + + /* 'cb_data' is not used in this specific callback. */ + (void)cb_data; + + if (!g_hash_table_lookup_extended(pd_binary_visible, + pdata->pdo->di->decoder->id, NULL, (void **)&classp)) + /* Not in the list of PDs whose meta output we're showing. */ + return; + + class = GPOINTER_TO_INT(classp); + pdb = pdata->data; + if (class != -1 && class != pdb->bin_class) + /* Not showing this binary class. */ + return; + + /* Just send the binary output to stdout, no embellishments. */ + fwrite(pdb->data, pdb->size, 1, stdout); + fflush(stdout); +} +#endif + diff --git a/device.c b/device.c new file mode 100644 index 0000000..2dc8308 --- /dev/null +++ b/device.c @@ -0,0 +1,147 @@ +/* + * This file is part of the sigrok-cli project. + * + * Copyright (C) 2013 Bert Vermeulen + * + * 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 . + */ + +#include "config.h" +#include +#include +#include "sigrok-cli.h" + +extern struct sr_context *sr_ctx; +extern gchar *opt_drv; +extern gchar *opt_probe_group; + +/* Convert driver options hash to GSList of struct sr_config. */ +static GSList *hash_to_hwopt(GHashTable *hash) +{ + const struct sr_config_info *srci; + struct sr_config *src; + GList *gl, *keys; + GSList *opts; + char *key, *value; + + keys = g_hash_table_get_keys(hash); + opts = NULL; + for (gl = keys; gl; gl = gl->next) { + key = gl->data; + if (!(srci = sr_config_info_name_get(key))) { + g_critical("Unknown option %s", key); + return NULL; + } + src = g_try_malloc(sizeof(struct sr_config)); + src->key = srci->key; + value = g_hash_table_lookup(hash, key); + src->data = g_variant_new_string(value); + opts = g_slist_append(opts, src); + } + g_list_free(keys); + + return opts; +} + +static void free_drvopts(struct sr_config *src) +{ + g_variant_unref(src->data); + g_free(src); +} + +GSList *device_scan(void) +{ + struct sr_dev_driver **drivers, *driver; + GHashTable *drvargs; + GSList *drvopts, *devices, *tmpdevs, *l; + int i; + char *drvname; + + if (opt_drv) { + drvargs = parse_generic_arg(opt_drv, TRUE); + drvname = g_strdup(g_hash_table_lookup(drvargs, "sigrok_key")); + g_hash_table_remove(drvargs, "sigrok_key"); + driver = NULL; + drivers = sr_driver_list(); + for (i = 0; drivers[i]; i++) { + if (strcmp(drivers[i]->name, drvname)) + continue; + driver = drivers[i]; + } + if (!driver) { + g_critical("Driver %s not found.", drvname); + g_hash_table_destroy(drvargs); + g_free(drvname); + return NULL; + } + g_free(drvname); + if (sr_driver_init(sr_ctx, driver) != SR_OK) { + g_critical("Failed to initialize driver."); + g_hash_table_destroy(drvargs); + return NULL; + } + drvopts = NULL; + if (g_hash_table_size(drvargs) > 0) { + if (!(drvopts = hash_to_hwopt(drvargs))) { + /* Unknown options, already logged. */ + g_hash_table_destroy(drvargs); + return NULL; + } + } + g_hash_table_destroy(drvargs); + devices = sr_driver_scan(driver, drvopts); + g_slist_free_full(drvopts, (GDestroyNotify)free_drvopts); + } else { + /* No driver specified, let them all scan on their own. */ + devices = NULL; + drivers = sr_driver_list(); + for (i = 0; drivers[i]; i++) { + driver = drivers[i]; + if (sr_driver_init(sr_ctx, driver) != SR_OK) { + g_critical("Failed to initialize driver."); + return NULL; + } + tmpdevs = sr_driver_scan(driver, NULL); + for (l = tmpdevs; l; l = l->next) + devices = g_slist_append(devices, l->data); + g_slist_free(tmpdevs); + } + } + + return devices; +} + +struct sr_probe_group *select_probe_group(struct sr_dev_inst *sdi) +{ + struct sr_probe_group *pg; + GSList *l; + + if (!opt_probe_group) + return NULL; + + if (!sdi->probe_groups) { + g_critical("This device does not have any probe groups."); + return NULL; + } + + for (l = sdi->probe_groups; l; l = l->next) { + pg = l->data; + if (!strcasecmp(opt_probe_group, pg->name)) { + return pg; + } + } + + return NULL; +} + diff --git a/input.c b/input.c new file mode 100644 index 0000000..7ef694d --- /dev/null +++ b/input.c @@ -0,0 +1,165 @@ +/* + * This file is part of the sigrok-cli project. + * + * Copyright (C) 2013 Bert Vermeulen + * + * 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 . + */ + +#include "config.h" +#include +#include +#include "sigrok-cli.h" + +extern gchar *opt_input_file; +extern gchar *opt_input_format; +extern gchar *opt_probes; + + +/** + * 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) { + g_critical("No supported input formats available."); + 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)) + continue; + g_debug("Using user-specified input file format '%s'.", + inputs[i]->id); + return inputs[i]; + } + + /* The user specified an unknown input format, return NULL. */ + g_critical("Error: specified input file format '%s' is " + "unknown.", opt); + 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]) { + g_critical("Error: no matching input module found."); + return NULL; + } + + g_debug("cli: Autodetected '%s' input format for file '%s'.", + inputs[i]->id, filename); + + return inputs[i]; +} + +static void load_input_file_format(void) +{ + GHashTable *fmtargs = NULL; + struct stat st; + struct sr_input *in; + struct sr_input_format *input_format; + char *fmtspec = NULL; + + if (opt_input_format) { + fmtargs = parse_generic_arg(opt_input_format, TRUE); + fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key"); + } + + if (!(input_format = determine_input_file_format(opt_input_file, + fmtspec))) { + /* The exact cause was already logged. */ + return; + } + + if (fmtargs) + g_hash_table_remove(fmtargs, "sigrok_key"); + + if (stat(opt_input_file, &st) == -1) { + g_critical("Failed to load %s: %s", opt_input_file, + strerror(errno)); + exit(1); + } + + /* Initialize the input module. */ + if (!(in = g_try_malloc(sizeof(struct sr_input)))) { + g_critical("Failed to allocate input module."); + exit(1); + } + in->format = input_format; + in->param = fmtargs; + if (in->format->init) { + if (in->format->init(in, opt_input_file) != SR_OK) { + g_critical("Input format init failed."); + exit(1); + } + } + + if (select_probes(in->sdi) > 0) + return; + + sr_session_new(); + sr_session_datafeed_callback_add(datafeed_in, NULL); + if (sr_session_dev_add(in->sdi) != SR_OK) { + g_critical("Failed to use device."); + sr_session_destroy(); + return; + } + + input_format->loadfile(in, opt_input_file); + + sr_session_destroy(); + + if (fmtargs) + g_hash_table_destroy(fmtargs); +} + +void load_input_file(void) +{ + + if (sr_session_load(opt_input_file) == SR_OK) { + /* sigrok session file */ + sr_session_datafeed_callback_add(datafeed_in, NULL); + sr_session_start(); + sr_session_run(); + sr_session_stop(); + } + else { + /* fall back on input modules */ + load_input_file_format(); + } +} + diff --git a/main.c b/main.c new file mode 100644 index 0000000..50826a5 --- /dev/null +++ b/main.c @@ -0,0 +1,297 @@ +/* + * This file is part of the sigrok-cli project. + * + * Copyright (C) 2013 Bert Vermeulen + * + * 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 . + */ + +#include "config.h" +#include +#include +#ifdef HAVE_SRD +#include /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#endif +#include "sigrok-cli.h" + +struct sr_context *sr_ctx = NULL; +#ifdef HAVE_SRD +struct srd_session *srd_sess = NULL; +#endif + +static gboolean opt_version = FALSE; +gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings by default. */ +static gboolean opt_scan_devs = FALSE; +gboolean opt_wait_trigger = FALSE; +gchar *opt_input_file = NULL; +gchar *opt_output_file = NULL; +gchar *opt_drv = NULL; +gchar *opt_config = NULL; +static gchar *opt_probes = NULL; +gchar *opt_probe_group = NULL; +gchar *opt_triggers = NULL; +gchar *opt_pds = NULL; +#ifdef HAVE_SRD +gchar *opt_pd_stack = NULL; +gchar *opt_pd_annotations = NULL; +gchar *opt_pd_meta = NULL; +gchar *opt_pd_binary = NULL; +#endif +gchar *opt_input_format = NULL; +gchar *opt_output_format = NULL; +static gchar *opt_show = NULL; +gchar *opt_time = NULL; +gchar *opt_samples = NULL; +gchar *opt_frames = NULL; +gchar *opt_continuous = NULL; +static gchar *opt_set = 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, + "Set loglevel (5 is most verbose)", NULL}, + {"driver", 'd', 0, G_OPTION_ARG_STRING, &opt_drv, + "The driver to use", NULL}, + {"config", 'c', 0, G_OPTION_ARG_STRING, &opt_config, + "Specify device configuration options", NULL}, + {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file, + "Load input from file", NULL}, + {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format, + "Input format", NULL}, + {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file, + "Save output to file", NULL}, + {"output-format", 'O', 0, G_OPTION_ARG_STRING, &opt_output_format, + "Output format", NULL}, + {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes, + "Probes to use", NULL}, + {"probe-group", 'g', 0, G_OPTION_ARG_STRING, &opt_probe_group, + "Probe groups", 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}, +#ifdef HAVE_SRD + {"protocol-decoders", 'P', 0, G_OPTION_ARG_STRING, &opt_pds, + "Protocol decoders to run", NULL}, + {"protocol-decoder-stack", 'S', 0, G_OPTION_ARG_STRING, &opt_pd_stack, + "Protocol decoder stack", NULL}, + {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_STRING, &opt_pd_annotations, + "Protocol decoder annotation(s) to show", NULL}, + {"protocol-decoder-meta", 'M', 0, G_OPTION_ARG_STRING, &opt_pd_meta, + "Protocol decoder meta output to show", NULL}, + {"protocol-decoder-binary", 'B', 0, G_OPTION_ARG_STRING, &opt_pd_binary, + "Protocol decoder binary output to show", NULL}, +#endif + {"scan", 0, 0, G_OPTION_ARG_NONE, &opt_scan_devs, + "Scan for devices", NULL}, + {"show", 0, 0, G_OPTION_ARG_NONE, &opt_show, + "Show device detail", 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}, + {"frames", 0, 0, G_OPTION_ARG_STRING, &opt_frames, + "Number of frames to acquire", NULL}, + {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous, + "Sample continuously", NULL}, + {"set", 0, 0, G_OPTION_ARG_NONE, &opt_set, "Set device options only", NULL}, + {NULL, 0, 0, 0, NULL, NULL, NULL} +}; + + +static void logger(const gchar *log_domain, GLogLevelFlags log_level, + const gchar *message, gpointer cb_data) +{ + (void)log_domain; + (void)cb_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_CRITICAL | G_LOG_LEVEL_WARNING) + || opt_loglevel > SR_LOG_WARN) { + fprintf(stderr, "%s\n", message); + fflush(stderr); + } + + if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL)) + exit(1); + +} + +int select_probes(struct sr_dev_inst *sdi) +{ + struct sr_probe *probe; + GSList *selected_probes, *l; + + if (!opt_probes) + return SR_OK; + + if (!(selected_probes = parse_probestring(sdi, opt_probes))) + return SR_ERR; + + for (l = sdi->probes; l; l = l->next) { + probe = l->data; + if (g_slist_find(selected_probes, probe)) + probe->enabled = TRUE; + else + probe->enabled = FALSE; + } + g_slist_free(selected_probes); + + return SR_OK; +} + +static void set_options(void) +{ + struct sr_dev_inst *sdi; + GSList *devices; + GHashTable *devargs; + + if (!opt_config) { + g_critical("No setting specified."); + return; + } + + if (!(devargs = parse_generic_arg(opt_config, FALSE))) + return; + + if (!(devices = device_scan())) { + g_critical("No devices found."); + return; + } + sdi = devices->data; + + if (sr_dev_open(sdi) != SR_OK) { + g_critical("Failed to open device."); + return; + } + + set_dev_options(sdi, devargs); + + sr_dev_close(sdi); + g_slist_free(devices); + g_hash_table_destroy(devargs); + +} + +int main(int argc, char **argv) +{ + GOptionContext *context; + GError *error; + int ret; + char *help; + + g_log_set_default_handler(logger, NULL); + + context = g_option_context_new(NULL); + g_option_context_add_main_entries(context, optargs, NULL); + + ret = 1; + error = NULL; + if (!g_option_context_parse(context, &argc, &argv, &error)) { + g_critical("%s", error->message); + goto done; + } + + /* Set the loglevel (amount of messages to output) for libsigrok. */ + if (sr_log_loglevel_set(opt_loglevel) != SR_OK) + goto done; + + if (sr_init(&sr_ctx) != SR_OK) + goto done; + +#ifdef HAVE_SRD + /* Set the loglevel (amount of messages to output) for libsigrokdecode. */ + if (srd_log_loglevel_set(opt_loglevel) != SRD_OK) + goto done; + + if (opt_pds) { + if (srd_init(NULL) != SRD_OK) + goto done; + if (srd_session_new(&srd_sess) != SRD_OK) { + g_critical("Failed to create new decode session."); + goto done; + } + if (register_pds(opt_pds) != 0) + goto done; + if (setup_pd_stack() != 0) + goto done; + + /* Only one output type is ever shown. */ + if (opt_pd_binary) { + if (setup_pd_binary() != 0) + goto done; + if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_BINARY, + show_pd_binary, NULL) != SRD_OK) + goto done; + } else if (opt_pd_meta) { + if (setup_pd_meta() != 0) + goto done; + if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_META, + show_pd_meta, NULL) != SRD_OK) + goto done; + } else { + if (opt_pd_annotations) + if (setup_pd_annotations() != 0) + goto done; + if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_ANN, + show_pd_annotations, NULL) != SRD_OK) + goto done; + } + } +#endif + + if (setup_output_format() != 0) + goto done; + + if (opt_version) + show_version(); + else if (opt_scan_devs) + show_dev_list(); +#ifdef HAVE_SRD + else if (opt_pds && opt_show) + show_pd_detail(); +#endif + else if (opt_show) + show_dev_detail(); + else if (opt_input_file) + load_input_file(); + else if (opt_set) + set_options(); + else if (opt_samples || opt_time || opt_frames || opt_continuous) + run_session(); + else { + help = g_option_context_get_help(context, TRUE, NULL); + printf("%s", help); + g_free(help); + } + +#ifdef HAVE_SRD + if (opt_pds) + srd_exit(); +#endif + + ret = 0; + +done: + if (sr_ctx) + sr_exit(sr_ctx); + + g_option_context_free(context); + + return ret; +} diff --git a/parsers.c b/parsers.c index e940417..059d339 100644 --- a/parsers.c +++ b/parsers.c @@ -25,7 +25,7 @@ #include #include "sigrok-cli.h" -struct sr_probe *find_probe(GSList *probelist, const char *probename) +static struct sr_probe *find_probe(GSList *probelist, const char *probename) { struct sr_probe *probe; GSList *l; @@ -183,7 +183,7 @@ GHashTable *parse_generic_arg(const char *arg, gboolean sep_first) return hash; } -char *strcanon(const char *str) +static char *strcanon(const char *str) { int p0, p1; char *s; diff --git a/session.c b/session.c new file mode 100644 index 0000000..82fea55 --- /dev/null +++ b/session.c @@ -0,0 +1,660 @@ +/* + * This file is part of the sigrok-cli project. + * + * Copyright (C) 2013 Bert Vermeulen + * + * 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 . + */ + +#include "config.h" +#include +#include +#include +#ifdef HAVE_SRD +#include /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#endif +#include "sigrok-cli.h" + +static struct sr_output_format *output_format = NULL; +static int default_output_format = FALSE; +static char *output_format_param = NULL; +static GByteArray *savebuf; +static uint64_t limit_samples = 0; +static uint64_t limit_frames = 0; + +extern gchar *opt_output_file; +extern gchar *opt_output_format; +extern gchar *opt_pds; +extern gboolean opt_wait_trigger; +extern gchar *opt_time; +extern gchar *opt_samples; +extern gchar *opt_frames; +extern gchar *opt_continuous; +extern gchar *opt_config; +extern gchar *opt_triggers; +#ifdef HAVE_SRD +extern struct srd_session *srd_sess; +#endif + + +static GArray *get_enabled_logic_probes(const struct sr_dev_inst *sdi) +{ + struct sr_probe *probe; + GArray *probes; + GSList *l; + + probes = g_array_new(FALSE, FALSE, sizeof(int)); + for (l = sdi->probes; l; l = l->next) { + probe = l->data; + if (probe->type != SR_PROBE_LOGIC) + continue; + if (probe->enabled != TRUE) + continue; + g_array_append_val(probes, probe->index); + } + + return probes; +} + +static int set_limit_time(const struct sr_dev_inst *sdi) +{ + GVariant *gvar; + uint64_t time_msec; + uint64_t samplerate; + + if (!(time_msec = sr_parse_timestring(opt_time))) { + g_critical("Invalid time '%s'", opt_time); + return SR_ERR; + } + + if (sr_dev_has_option(sdi, SR_CONF_LIMIT_MSEC)) { + gvar = g_variant_new_uint64(time_msec); + if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) { + g_critical("Failed to configure time limit."); + return SR_ERR; + } + } else if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) { + /* Convert to samples based on the samplerate. */ + sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar); + samplerate = g_variant_get_uint64(gvar); + g_variant_unref(gvar); + limit_samples = (samplerate) * time_msec / (uint64_t)1000; + if (limit_samples == 0) { + g_critical("Not enough time at this samplerate."); + return SR_ERR; + } + gvar = g_variant_new_uint64(limit_samples); + if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) { + g_critical("Failed to configure time-based sample limit."); + return SR_ERR; + } + } else { + g_critical("This device does not support time limits."); + return SR_ERR; + } + + return SR_OK; +} + +int setup_output_format(void) +{ + GHashTable *fmtargs; + GHashTableIter iter; + gpointer key, value; + struct sr_output_format **outputs; + int i; + char *fmtspec; + + if (opt_output_format && !strcmp(opt_output_format, "sigrok")) { + /* Doesn't really exist as an output module - this is + * the session save mode. */ + g_free(opt_output_format); + opt_output_format = NULL; + } + + if (!opt_output_format) { + opt_output_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_output_format, TRUE); + fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key"); + if (!fmtspec) { + g_critical("Invalid output format."); + 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) { + g_critical("Invalid output format %s.", opt_output_format); + return 1; + } + g_hash_table_destroy(fmtargs); + + return 0; +} + +void datafeed_in(const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *packet, void *cb_data) +{ + const struct sr_datafeed_meta *meta; + const struct sr_datafeed_logic *logic; + const struct sr_datafeed_analog *analog; + struct sr_config *src; + static struct sr_output *o = NULL; + static GArray *logic_probelist = NULL; + static uint64_t received_samples = 0; + static int unitsize = 0; + static int triggered = 0; + static FILE *outfile = NULL; + GSList *l; + GString *out; + int sample_size, ret; + uint64_t samplerate, output_len, filter_out_len, end_sample; + uint8_t *output_buf, *filter_out; + + (void) cb_data; + + /* 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_debug("cli: Received SR_DF_HEADER"); + /* Initialize the output module. */ + if (!(o = g_try_malloc(sizeof(struct sr_output)))) { + g_critical("Output module malloc failed."); + exit(1); + } + o->format = output_format; + o->sdi = (struct sr_dev_inst *)sdi; + o->param = output_format_param; + if (o->format->init) { + if (o->format->init(o) != SR_OK) { + g_critical("Output format initialization failed."); + exit(1); + } + } + + /* Prepare non-stdout output. */ + outfile = stdout; + if (opt_output_file) { + if (default_output_format) { + /* output file is in session format, so we'll + * keep a copy of everything as it comes in + * and save from there after the session. */ + outfile = NULL; + savebuf = g_byte_array_new(); + } 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"); + } + } + + /* Prepare for logic data. */ + logic_probelist = get_enabled_logic_probes(sdi); + /* How many bytes we need to store the packed samples. */ + unitsize = (logic_probelist->len + 7) / 8; + +#ifdef HAVE_SRD + GVariant *gvar; + if (opt_pds && logic_probelist->len) { + if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE, + &gvar) == SR_OK) { + samplerate = g_variant_get_uint64(gvar); + g_variant_unref(gvar); + if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE, + g_variant_new_uint64(samplerate)) != SRD_OK) { + g_critical("Failed to configure decode session."); + break; + } + } + if (srd_session_start(srd_sess) != SRD_OK) { + g_critical("Failed to start decode session."); + break; + } + } +#endif + break; + + case SR_DF_META: + g_debug("cli: received SR_DF_META"); + meta = packet->payload; + for (l = meta->config; l; l = l->next) { + src = l->data; + switch (src->key) { + case SR_CONF_SAMPLERATE: + samplerate = g_variant_get_uint64(src->data); + g_debug("cli: got samplerate %"PRIu64" Hz", samplerate); +#ifdef HAVE_SRD + if (opt_pds) { + if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE, + g_variant_new_uint64(samplerate)) != SRD_OK) { + g_critical("Failed to pass samplerate to decoder."); + } + } +#endif + break; + case SR_CONF_SAMPLE_INTERVAL: + samplerate = g_variant_get_uint64(src->data); + g_debug("cli: got sample interval %"PRIu64" ms", samplerate); + break; + default: + /* Unknown metadata is not an error. */ + break; + } + } + break; + + case SR_DF_TRIGGER: + g_debug("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; + g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length); + sample_size = logic->unitsize; + if (logic->length == 0) + break; + + /* Don't store any samples until triggered. */ + if (opt_wait_trigger && !triggered) + break; + + if (limit_samples && received_samples >= limit_samples) + break; + + ret = sr_filter_probes(sample_size, unitsize, logic_probelist, + logic->data, logic->length, + &filter_out, &filter_out_len); + if (ret != SR_OK) + break; + + /* + * 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 (opt_output_file && default_output_format) { + /* Saving to a session file. */ + g_byte_array_append(savebuf, filter_out, filter_out_len); + } else { + if (opt_pds) { +#ifdef HAVE_SRD + end_sample = received_samples + filter_out_len / unitsize; + if (srd_session_send(srd_sess, received_samples, end_sample, + (uint8_t*)filter_out, filter_out_len) != SRD_OK) + sr_session_stop(); +#endif + } 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); + fflush(outfile); + g_free(output_buf); + } + } + } + g_free(filter_out); + + received_samples += logic->length / sample_size; + break; + + case SR_DF_ANALOG: + analog = packet->payload; + g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples); + if (analog->num_samples == 0) + break; + + if (limit_samples && received_samples >= limit_samples) + break; + + if (o->format->data && packet->type == o->format->df_type) { + o->format->data(o, (const uint8_t *)analog->data, + analog->num_samples * sizeof(float), + &output_buf, &output_len); + if (output_buf) { + fwrite(output_buf, 1, output_len, outfile); + fflush(outfile); + g_free(output_buf); + } + } + + received_samples += analog->num_samples; + break; + + case SR_DF_FRAME_BEGIN: + g_debug("cli: received SR_DF_FRAME_BEGIN"); + if (o->format->event) { + o->format->event(o, SR_DF_FRAME_BEGIN, &output_buf, + &output_len); + if (output_buf) { + fwrite(output_buf, 1, output_len, outfile); + fflush(outfile); + g_free(output_buf); + } + } + break; + + case SR_DF_FRAME_END: + g_debug("cli: received SR_DF_FRAME_END"); + if (o->format->event) { + o->format->event(o, SR_DF_FRAME_END, &output_buf, + &output_len); + if (output_buf) { + fwrite(output_buf, 1, output_len, outfile); + fflush(outfile); + g_free(output_buf); + } + } + break; + + default: + break; + } + + if (o && o->format->receive) { + if (o->format->receive(o, sdi, packet, &out) == SR_OK && out) { + fwrite(out->str, 1, out->len, outfile); + fflush(outfile); + g_string_free(out, TRUE); + } + } + + /* SR_DF_END needs to be handled after the output module's receive() + * is called, so it can properly clean up that module etc. */ + if (packet->type == SR_DF_END) { + g_debug("cli: Received SR_DF_END"); + + if (o->format->event) { + o->format->event(o, SR_DF_END, &output_buf, &output_len); + if (output_buf) { + if (outfile) + fwrite(output_buf, 1, output_len, outfile); + g_free(output_buf); + output_len = 0; + } + } + + if (limit_samples && received_samples < limit_samples) + g_warning("Device only sent %" PRIu64 " samples.", + received_samples); + + if (opt_continuous) + g_warning("Device stopped after %" PRIu64 " samples.", + received_samples); + + g_array_free(logic_probelist, TRUE); + + if (o->format->cleanup) + o->format->cleanup(o); + g_free(o); + o = NULL; + + if (outfile && outfile != stdout) + fclose(outfile); + + if (opt_output_file && default_output_format && savebuf->len) { + if (sr_session_save(opt_output_file, sdi, savebuf->data, + unitsize, savebuf->len / unitsize) != SR_OK) + g_critical("Failed to save session."); + g_byte_array_free(savebuf, FALSE); + } + } + +} + +int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args) +{ + const struct sr_config_info *srci; + struct sr_probe_group *pg; + GHashTableIter iter; + gpointer key, value; + int ret; + double tmp_double; + uint64_t tmp_u64, p, q, low, high; + gboolean tmp_bool; + GVariant *val, *rational[2], *range[2]; + + g_hash_table_iter_init(&iter, args); + while (g_hash_table_iter_next(&iter, &key, &value)) { + if (!(srci = sr_config_info_name_get(key))) { + g_critical("Unknown device option '%s'.", (char *) key); + return SR_ERR; + } + + if ((value == NULL) && + (srci->datatype != SR_T_BOOL)) { + g_critical("Option '%s' needs a value.", (char *)key); + return SR_ERR; + } + val = NULL; + switch (srci->datatype) { + case SR_T_UINT64: + ret = sr_parse_sizestring(value, &tmp_u64); + if (ret != SR_OK) + break; + val = g_variant_new_uint64(tmp_u64); + break; + case SR_T_CHAR: + val = g_variant_new_string(value); + break; + case SR_T_BOOL: + if (!value) + tmp_bool = TRUE; + else + tmp_bool = sr_parse_boolstring(value); + val = g_variant_new_boolean(tmp_bool); + break; + case SR_T_FLOAT: + tmp_double = strtof(value, NULL); + val = g_variant_new_double(tmp_double); + break; + case SR_T_RATIONAL_PERIOD: + if ((ret = sr_parse_period(value, &p, &q)) != SR_OK) + break; + rational[0] = g_variant_new_uint64(p); + rational[1] = g_variant_new_uint64(q); + val = g_variant_new_tuple(rational, 2); + break; + case SR_T_RATIONAL_VOLT: + if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK) + break; + rational[0] = g_variant_new_uint64(p); + rational[1] = g_variant_new_uint64(q); + val = g_variant_new_tuple(rational, 2); + break; + case SR_T_UINT64_RANGE: + if (sscanf(value, "%"PRIu64"-%"PRIu64, &low, &high) != 2) { + ret = SR_ERR; + break; + } else { + range[0] = g_variant_new_uint64(low); + range[1] = g_variant_new_uint64(high); + val = g_variant_new_tuple(range, 2); + } + break; + default: + ret = SR_ERR; + } + if (val) { + pg = select_probe_group(sdi); + ret = sr_config_set(sdi, pg, srci->key, val); + } + if (ret != SR_OK) { + g_critical("Failed to set device option '%s'.", (char *)key); + return ret; + } + } + + return SR_OK; +} + +void run_session(void) +{ + GSList *devices; + GHashTable *devargs; + GVariant *gvar; + struct sr_dev_inst *sdi; + int max_probes, i; + char **triggerlist; + + devices = device_scan(); + if (!devices) { + g_critical("No devices found."); + return; + } + if (g_slist_length(devices) > 1) { + g_critical("sigrok-cli only supports one device for capturing."); + return; + } + sdi = devices->data; + + sr_session_new(); + sr_session_datafeed_callback_add(datafeed_in, NULL); + + if (sr_dev_open(sdi) != SR_OK) { + g_critical("Failed to open device."); + return; + } + + if (sr_session_dev_add(sdi) != SR_OK) { + g_critical("Failed to add device to session."); + sr_session_destroy(); + return; + } + + if (opt_config) { + if ((devargs = parse_generic_arg(opt_config, FALSE))) { + if (set_dev_options(sdi, devargs) != SR_OK) + return; + g_hash_table_destroy(devargs); + } + } + + if (select_probes(sdi) != SR_OK) { + g_critical("Failed to set probes."); + sr_session_destroy(); + return; + } + + if (opt_triggers) { + if (!(triggerlist = sr_parse_triggerstring(sdi, opt_triggers))) { + sr_session_destroy(); + return; + } + max_probes = g_slist_length(sdi->probes); + for (i = 0; i < max_probes; i++) { + if (triggerlist[i]) { + sr_dev_trigger_set(sdi, i, triggerlist[i]); + g_free(triggerlist[i]); + } + } + g_free(triggerlist); + } + + if (opt_continuous) { + if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) { + g_critical("This device does not support continuous sampling."); + sr_session_destroy(); + return; + } + } + + if (opt_time) { + if (set_limit_time(sdi) != SR_OK) { + sr_session_destroy(); + return; + } + } + + if (opt_samples) { + if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) { + g_critical("Invalid sample limit '%s'.", opt_samples); + sr_session_destroy(); + return; + } + gvar = g_variant_new_uint64(limit_samples); + if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) { + g_critical("Failed to configure sample limit."); + sr_session_destroy(); + return; + } + } + + if (opt_frames) { + if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) { + g_critical("Invalid sample limit '%s'.", opt_samples); + sr_session_destroy(); + return; + } + gvar = g_variant_new_uint64(limit_frames); + if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) { + g_critical("Failed to configure frame limit."); + sr_session_destroy(); + return; + } + } + + if (sr_session_start() != SR_OK) { + g_critical("Failed to start session."); + sr_session_destroy(); + return; + } + + if (opt_continuous) + add_anykey(); + + sr_session_run(); + + if (opt_continuous) + clear_anykey(); + + sr_session_datafeed_callback_remove_all(); + sr_session_destroy(); + g_slist_free(devices); + +} + diff --git a/show.c b/show.c new file mode 100644 index 0000000..07341c9 --- /dev/null +++ b/show.c @@ -0,0 +1,504 @@ +/* + * This file is part of the sigrok-cli project. + * + * Copyright (C) 2013 Bert Vermeulen + * + * 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 . + */ + +#include "config.h" +#include +#include +#ifdef HAVE_SRD +#include +#endif +#include "sigrok-cli.h" + +extern gint opt_loglevel; +extern gchar *opt_pds; + +void show_version(void) +{ + struct sr_dev_driver **drivers; + struct sr_input_format **inputs; + struct sr_output_format **outputs; + int i; +#ifdef HAVE_SRD + struct srd_decoder *dec; + const GSList *l; +#endif + + printf("sigrok-cli %s\n\n", VERSION); + + printf("Using libsigrok %s (lib version %s).\n", + sr_package_version_string_get(), sr_lib_version_string_get()); +#ifdef HAVE_SRD + printf("Using libsigrokdecode %s (lib version %s).\n\n", + srd_package_version_string_get(), srd_lib_version_string_get()); +#endif + + printf("Supported hardware drivers:\n"); + drivers = sr_driver_list(); + for (i = 0; drivers[i]; i++) { + printf(" %-20s %s\n", drivers[i]->name, drivers[i]->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(" %-20s %s\n", "sigrok", "Default file output format"); + printf("\n"); + +#ifdef HAVE_SRD + if (srd_init(NULL) == SRD_OK) { + printf("Supported protocol decoders:\n"); + srd_decoder_load_all(); + for (l = srd_decoder_list(); l; l = l->next) { + dec = l->data; + printf(" %-20s %s\n", dec->id, dec->longname); + /* Print protocol description upon "-l 3" or higher. */ + if (opt_loglevel >= SR_LOG_INFO) + printf(" %-20s %s\n", "", dec->desc); + } + srd_exit(); + } + printf("\n"); +#endif +} + +static void print_dev_line(const struct sr_dev_inst *sdi) +{ + struct sr_probe *probe; + GSList *l; + GString *s; + GVariant *gvar; + + s = g_string_sized_new(128); + g_string_assign(s, sdi->driver->name); + if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_CONN, &gvar) == SR_OK) { + g_string_append(s, ":conn="); + g_string_append(s, g_variant_get_string(gvar, NULL)); + g_variant_unref(gvar); + } + g_string_append(s, " - "); + if (sdi->vendor && sdi->vendor[0]) + g_string_append_printf(s, "%s ", sdi->vendor); + if (sdi->model && sdi->model[0]) + g_string_append_printf(s, "%s ", sdi->model); + if (sdi->version && sdi->version[0]) + g_string_append_printf(s, "%s ", sdi->version); + if (sdi->probes) { + if (g_slist_length(sdi->probes) == 1) { + probe = sdi->probes->data; + g_string_append_printf(s, "with 1 probe: %s", probe->name); + } else { + g_string_append_printf(s, "with %d probes:", g_slist_length(sdi->probes)); + for (l = sdi->probes; l; l = l->next) { + probe = l->data; + g_string_append_printf(s, " %s", probe->name); + } + } + } + g_string_append_printf(s, "\n"); + printf("%s", s->str); + g_string_free(s, TRUE); + +} + +void show_dev_list(void) +{ + struct sr_dev_inst *sdi; + GSList *devices, *l; + + if (!(devices = device_scan())) + return; + + printf("The following devices were found:\n"); + for (l = devices; l; l = l->next) { + sdi = l->data; + print_dev_line(sdi); + } + g_slist_free(devices); + +} + +void show_dev_detail(void) +{ + struct sr_dev_inst *sdi; + const struct sr_config_info *srci; + struct sr_probe *probe; + struct sr_probe_group *probe_group, *pg; + GSList *devices, *pgl, *prl; + GVariant *gvar_opts, *gvar_dict, *gvar_list, *gvar; + gsize num_opts, num_elements; + const uint64_t *uint64, p, q, low, high; + uint64_t cur_low, cur_high; + const int32_t *opts; + unsigned int num_devices, o, i; + char *tmp_str; + char *s; + const char *charopts, **stropts; + + if (!(devices = device_scan())) { + g_critical("No devices found."); + return; + } + + num_devices = g_slist_length(devices); + if (num_devices > 1) { + g_critical("%d devices found. Use --scan to show them, " + "and select one to show.", num_devices); + return; + } + + sdi = devices->data; + print_dev_line(sdi); + + if (sr_dev_open(sdi) != SR_OK) { + g_critical("Failed to open device."); + return; + } + + if ((sr_config_list(sdi->driver, NULL, NULL, SR_CONF_SCAN_OPTIONS, + &gvar_opts) == SR_OK)) { + opts = g_variant_get_fixed_array(gvar_opts, &num_elements, + sizeof(int32_t)); + printf("Supported driver options:\n"); + for (i = 0; i < num_elements; i++) { + if (!(srci = sr_config_info_get(opts[i]))) + continue; + printf(" %s\n", srci->id); + } + g_variant_unref(gvar_opts); + } + + probe_group = select_probe_group(sdi); + if ((sr_config_list(sdi->driver, sdi, probe_group, SR_CONF_DEVICE_OPTIONS, + &gvar_opts)) != SR_OK) + /* Driver supports no device instance options. */ + return; + + if (sdi->probe_groups) { + printf("Probe groups:\n"); + for (pgl = sdi->probe_groups; pgl; pgl = pgl->next) { + pg = pgl->data; + printf(" %s: channel%s", pg->name, + g_slist_length(pg->probes) > 1 ? "s" : ""); + for (prl = pg->probes; prl; prl = prl->next) { + probe = prl->data; + printf(" %s", probe->name); + } + printf("\n"); + } + } + + printf("Supported configuration options"); + if (sdi->probe_groups) { + if (!probe_group) + printf(" across all probe groups"); + else + printf(" on probe group %s", probe_group->name); + } + printf(":\n"); + opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(int32_t)); + for (o = 0; o < num_opts; o++) { + if (!(srci = sr_config_info_get(opts[o]))) + continue; + + if (srci->key == SR_CONF_TRIGGER_TYPE) { + if (sr_config_list(sdi->driver, sdi, probe_group, srci->key, + &gvar) != SR_OK) { + printf("\n"); + continue; + } + charopts = g_variant_get_string(gvar, NULL); + printf(" Supported triggers: "); + while (*charopts) { + printf("%c ", *charopts); + charopts++; + } + printf("\n"); + g_variant_unref(gvar); + + } else if (srci->key == SR_CONF_PATTERN_MODE) { + /* Pattern generator modes */ + printf(" %s", srci->id); + if (sr_config_list(sdi->driver, sdi, probe_group, srci->key, + &gvar) == SR_OK) { + printf(" - supported patterns:\n"); + stropts = g_variant_get_strv(gvar, &num_elements); + for (i = 0; i < num_elements; i++) + printf(" %s\n", stropts[i]); + g_variant_unref(gvar); + } else { + printf("\n"); + } + + } else if (srci->key == SR_CONF_SAMPLERATE) { + /* Supported samplerates */ + printf(" %s", srci->id); + if (sr_config_list(sdi->driver, sdi, probe_group, SR_CONF_SAMPLERATE, + &gvar_dict) != SR_OK) { + printf("\n"); + continue; + } + if ((gvar_list = g_variant_lookup_value(gvar_dict, + "samplerates", G_VARIANT_TYPE("at")))) { + uint64 = g_variant_get_fixed_array(gvar_list, + &num_elements, sizeof(uint64_t)); + printf(" - supported samplerates:\n"); + for (i = 0; i < num_elements; i++) { + if (!(s = sr_samplerate_string(uint64[i]))) + continue; + printf(" %s\n", s); + g_free(s); + } + g_variant_unref(gvar_list); + } else if ((gvar_list = g_variant_lookup_value(gvar_dict, + "samplerate-steps", G_VARIANT_TYPE("at")))) { + uint64 = g_variant_get_fixed_array(gvar_list, + &num_elements, sizeof(uint64_t)); + /* low */ + if (!(s = sr_samplerate_string(uint64[0]))) + continue; + printf(" (%s", s); + g_free(s); + /* high */ + if (!(s = sr_samplerate_string(uint64[1]))) + continue; + printf(" - %s", s); + g_free(s); + /* step */ + if (!(s = sr_samplerate_string(uint64[2]))) + continue; + printf(" in steps of %s)\n", s); + g_free(s); + g_variant_unref(gvar_list); + } + g_variant_unref(gvar_dict); + + } else if (srci->key == SR_CONF_BUFFERSIZE) { + /* Supported buffer sizes */ + printf(" %s", srci->id); + if (sr_config_list(sdi->driver, sdi, probe_group, + SR_CONF_BUFFERSIZE, &gvar_list) != SR_OK) { + printf("\n"); + continue; + } + uint64 = g_variant_get_fixed_array(gvar_list, + &num_elements, sizeof(uint64_t)); + printf(" - supported buffer sizes:\n"); + for (i = 0; i < num_elements; i++) + printf(" %"PRIu64"\n", uint64[i]); + g_variant_unref(gvar_list); + + } else if (srci->key == SR_CONF_TIMEBASE) { + /* Supported time bases */ + printf(" %s", srci->id); + if (sr_config_list(sdi->driver, sdi, probe_group, + SR_CONF_TIMEBASE, &gvar_list) != SR_OK) { + printf("\n"); + continue; + } + printf(" - supported time bases:\n"); + num_elements = g_variant_n_children(gvar_list); + for (i = 0; i < num_elements; i++) { + gvar = g_variant_get_child_value(gvar_list, i); + g_variant_get(gvar, "(tt)", &p, &q); + s = sr_period_string(p * q); + printf(" %s\n", s); + g_free(s); + } + g_variant_unref(gvar_list); + + } else if (srci->key == SR_CONF_VDIV) { + /* Supported volts/div values */ + printf(" %s", srci->id); + if (sr_config_list(sdi->driver, sdi, probe_group, + SR_CONF_VDIV, &gvar_list) != SR_OK) { + printf("\n"); + continue; + } + printf(" - supported volts/div:\n"); + num_elements = g_variant_n_children(gvar_list); + for (i = 0; i < num_elements; i++) { + gvar = g_variant_get_child_value(gvar_list, i); + g_variant_get(gvar, "(tt)", &p, &q); + s = sr_voltage_string(p, q); + printf(" %s\n", s); + g_free(s); + } + g_variant_unref(gvar_list); + + } else if (srci->datatype == SR_T_CHAR) { + printf(" %s: ", srci->id); + if (sr_config_get(sdi->driver, sdi, probe_group, srci->key, + &gvar) == SR_OK) { + tmp_str = g_strdup(g_variant_get_string(gvar, NULL)); + g_variant_unref(gvar); + } else + tmp_str = NULL; + + if (sr_config_list(sdi->driver, sdi, probe_group, srci->key, + &gvar) != SR_OK) { + printf("\n"); + continue; + } + + stropts = g_variant_get_strv(gvar, &num_elements); + for (i = 0; i < num_elements; i++) { + if (i) + printf(", "); + printf("%s", stropts[i]); + if (tmp_str && !strcmp(tmp_str, stropts[i])) + printf(" (current)"); + } + printf("\n"); + g_free(stropts); + g_free(tmp_str); + g_variant_unref(gvar); + + } else if (srci->datatype == SR_T_UINT64_RANGE) { + printf(" %s: ", srci->id); + if (sr_config_list(sdi->driver, sdi, probe_group, srci->key, + &gvar_list) != SR_OK) { + printf("\n"); + continue; + } + + if (sr_config_get(sdi->driver, sdi, NULL, srci->key, &gvar) == SR_OK) { + g_variant_get(gvar, "(tt)", &cur_low, &cur_high); + g_variant_unref(gvar); + } else { + cur_low = 0; + cur_high = 0; + } + + num_elements = g_variant_n_children(gvar_list); + for (i = 0; i < num_elements; i++) { + gvar = g_variant_get_child_value(gvar_list, i); + g_variant_get(gvar, "(tt)", &low, &high); + g_variant_unref(gvar); + if (i) + printf(", "); + printf("%"PRIu64"-%"PRIu64, low, high); + if (low == cur_low && high == cur_high) + printf(" (current)"); + } + printf("\n"); + g_variant_unref(gvar_list); + + } else if (srci->datatype == SR_T_BOOL) { + printf(" %s: ", srci->id); + if (sr_config_get(sdi->driver, sdi, NULL, srci->key, + &gvar) == SR_OK) { + if (g_variant_get_boolean(gvar)) + printf("on (current), off\n"); + else + printf("on, off (current)\n"); + g_variant_unref(gvar); + } else + printf("on, off\n"); + + } else { + + /* Everything else */ + printf(" %s\n", srci->id); + } + } + g_variant_unref(gvar_opts); + + sr_dev_close(sdi); + g_slist_free(devices); + +} + +#ifdef HAVE_SRD +void show_pd_detail(void) +{ + GSList *l; + struct srd_decoder *dec; + struct srd_decoder_option *o; + char **pdtokens, **pdtok, *optsep, **ann, *val, *doc; + struct srd_probe *p; + + pdtokens = g_strsplit(opt_pds, ",", -1); + for (pdtok = pdtokens; *pdtok; pdtok++) { + /* Strip options. */ + if ((optsep = strchr(*pdtok, ':'))) + *optsep = '\0'; + if (!(dec = srd_decoder_get_by_id(*pdtok))) { + g_critical("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); + printf("Annotations:\n"); + if (dec->annotations) { + for (l = dec->annotations; l; l = l->next) { + ann = l->data; + printf("- %s\n %s\n", ann[0], ann[1]); + } + } else { + printf("None.\n"); + } + printf("Required probes:\n"); + if (dec->probes) { + for (l = dec->probes; l; l = l->next) { + p = l->data; + printf("- %s (%s): %s\n", + p->name, p->id, p->desc); + } + } else { + printf("None.\n"); + } + printf("Optional probes:\n"); + if (dec->opt_probes) { + for (l = dec->opt_probes; l; l = l->next) { + p = l->data; + printf("- %s (%s): %s\n", + p->name, p->id, p->desc); + } + } else { + printf("None.\n"); + } + if (dec->options) { + printf("Options:\n"); + for (l = dec->options; l; l = l->next) { + o = l->data; + val = g_variant_print(o->def, FALSE); + printf("- %s: %s (default %s)\n", o->id, o->desc, val); + g_free(val); + } + } + if ((doc = srd_decoder_doc_get(dec))) { + printf("Documentation:\n%s\n", + doc[0] == '\n' ? doc + 1 : doc); + g_free(doc); + } + } + + g_strfreev(pdtokens); +} +#endif + diff --git a/sigrok-cli.c b/sigrok-cli.c deleted file mode 100644 index ac84e1d..0000000 --- a/sigrok-cli.c +++ /dev/null @@ -1,2084 +0,0 @@ -/* - * This file is part of the sigrok-cli project. - * - * Copyright (C) 2012 Bert Vermeulen - * - * 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 . - */ - -#include "config.h" -#ifdef HAVE_SRD -#include /* First, so we avoid a _POSIX_C_SOURCE warning. */ -#endif -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "sigrok-cli.h" - -#define DEFAULT_OUTPUT_FORMAT "bits:width=64" - -static struct sr_context *sr_ctx = NULL; - -static uint64_t limit_samples = 0; -static uint64_t limit_frames = 0; -static struct sr_output_format *output_format = NULL; -static int default_output_format = FALSE; -static char *output_format_param = NULL; -#ifdef HAVE_SRD -static struct srd_session *srd_sess = NULL; -static GHashTable *pd_ann_visible = NULL; -static GHashTable *pd_meta_visible = NULL; -static GHashTable *pd_binary_visible = NULL; -#endif -static GByteArray *savebuf; - -static gboolean opt_version = FALSE; -static gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */ -static gboolean opt_scan_devs = FALSE; -static gboolean opt_wait_trigger = FALSE; -static gchar *opt_input_file = NULL; -static gchar *opt_output_file = NULL; -static gchar *opt_drv = NULL; -static gchar *opt_config = NULL; -static gchar *opt_probes = NULL; -static gchar *opt_probe_group = NULL; -static gchar *opt_triggers = NULL; -static gchar *opt_pds = NULL; -#ifdef HAVE_SRD -static gchar *opt_pd_stack = NULL; -static gchar *opt_pd_annotations = NULL; -static gchar *opt_pd_meta = NULL; -static gchar *opt_pd_binary = NULL; -#endif -static gchar *opt_input_format = NULL; -static gchar *opt_output_format = NULL; -static gchar *opt_show = NULL; -static gchar *opt_time = NULL; -static gchar *opt_samples = NULL; -static gchar *opt_frames = NULL; -static gchar *opt_continuous = NULL; -static gchar *opt_set = 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, - "Set loglevel (5 is most verbose)", NULL}, - {"driver", 'd', 0, G_OPTION_ARG_STRING, &opt_drv, - "The driver to use", NULL}, - {"config", 'c', 0, G_OPTION_ARG_STRING, &opt_config, - "Specify device configuration options", NULL}, - {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file, - "Load input from file", NULL}, - {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format, - "Input format", NULL}, - {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file, - "Save output to file", NULL}, - {"output-format", 'O', 0, G_OPTION_ARG_STRING, &opt_output_format, - "Output format", NULL}, - {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes, - "Probes to use", NULL}, - {"probe-group", 'g', 0, G_OPTION_ARG_STRING, &opt_probe_group, - "Probe groups", 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}, -#ifdef HAVE_SRD - {"protocol-decoders", 'P', 0, G_OPTION_ARG_STRING, &opt_pds, - "Protocol decoders to run", NULL}, - {"protocol-decoder-stack", 'S', 0, G_OPTION_ARG_STRING, &opt_pd_stack, - "Protocol decoder stack", NULL}, - {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_STRING, &opt_pd_annotations, - "Protocol decoder annotation(s) to show", NULL}, - {"protocol-decoder-meta", 'M', 0, G_OPTION_ARG_STRING, &opt_pd_meta, - "Protocol decoder meta output to show", NULL}, - {"protocol-decoder-binary", 'B', 0, G_OPTION_ARG_STRING, &opt_pd_binary, - "Protocol decoder binary output to show", NULL}, -#endif - {"scan", 0, 0, G_OPTION_ARG_NONE, &opt_scan_devs, - "Scan for devices", NULL}, - {"show", 0, 0, G_OPTION_ARG_NONE, &opt_show, - "Show device detail", 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}, - {"frames", 0, 0, G_OPTION_ARG_STRING, &opt_frames, - "Number of frames to acquire", NULL}, - {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous, - "Sample continuously", NULL}, - {"set", 0, 0, G_OPTION_ARG_NONE, &opt_set, "Set device options only", NULL}, - {NULL, 0, 0, 0, NULL, NULL, NULL} -}; - - -/* Convert driver options hash to GSList of struct sr_config. */ -static GSList *hash_to_hwopt(GHashTable *hash) -{ - const struct sr_config_info *srci; - struct sr_config *src; - GList *gl, *keys; - GSList *opts; - char *key, *value; - - keys = g_hash_table_get_keys(hash); - opts = NULL; - for (gl = keys; gl; gl = gl->next) { - key = gl->data; - if (!(srci = sr_config_info_name_get(key))) { - g_critical("Unknown option %s", key); - return NULL; - } - src = g_try_malloc(sizeof(struct sr_config)); - src->key = srci->key; - value = g_hash_table_lookup(hash, key); - src->data = g_variant_new_string(value); - opts = g_slist_append(opts, src); - } - g_list_free(keys); - - return opts; -} - -static struct sr_probe_group *select_probe_group(struct sr_dev_inst *sdi) -{ - struct sr_probe_group *pg; - GSList *l; - - if (!opt_probe_group) - return NULL; - - if (!sdi->probe_groups) { - g_critical("This device does not have any probe groups."); - return NULL; - } - - for (l = sdi->probe_groups; l; l = l->next) { - pg = l->data; - if (!strcasecmp(opt_probe_group, pg->name)) { - return pg; - } - } - - return NULL; -} - -static void free_drvopts(struct sr_config *src) -{ - g_variant_unref(src->data); - g_free(src); -} - -static GSList *device_scan(void) -{ - struct sr_dev_driver **drivers, *driver; - GHashTable *drvargs; - GSList *drvopts, *devices, *tmpdevs, *l; - int i; - char *drvname; - - if (opt_drv) { - drvargs = parse_generic_arg(opt_drv, TRUE); - drvname = g_strdup(g_hash_table_lookup(drvargs, "sigrok_key")); - g_hash_table_remove(drvargs, "sigrok_key"); - driver = NULL; - drivers = sr_driver_list(); - for (i = 0; drivers[i]; i++) { - if (strcmp(drivers[i]->name, drvname)) - continue; - driver = drivers[i]; - } - if (!driver) { - g_critical("Driver %s not found.", drvname); - g_hash_table_destroy(drvargs); - g_free(drvname); - return NULL; - } - g_free(drvname); - if (sr_driver_init(sr_ctx, driver) != SR_OK) { - g_critical("Failed to initialize driver."); - g_hash_table_destroy(drvargs); - return NULL; - } - drvopts = NULL; - if (g_hash_table_size(drvargs) > 0) { - if (!(drvopts = hash_to_hwopt(drvargs))) { - /* Unknown options, already logged. */ - g_hash_table_destroy(drvargs); - return NULL; - } - } - g_hash_table_destroy(drvargs); - devices = sr_driver_scan(driver, drvopts); - g_slist_free_full(drvopts, (GDestroyNotify)free_drvopts); - } else { - /* No driver specified, let them all scan on their own. */ - devices = NULL; - drivers = sr_driver_list(); - for (i = 0; drivers[i]; i++) { - driver = drivers[i]; - if (sr_driver_init(sr_ctx, driver) != SR_OK) { - g_critical("Failed to initialize driver."); - return NULL; - } - tmpdevs = sr_driver_scan(driver, NULL); - for (l = tmpdevs; l; l = l->next) - devices = g_slist_append(devices, l->data); - g_slist_free(tmpdevs); - } - } - - return devices; -} - -static void show_version(void) -{ - struct sr_dev_driver **drivers; - struct sr_input_format **inputs; - struct sr_output_format **outputs; - int i; -#ifdef HAVE_SRD - struct srd_decoder *dec; - const GSList *l; -#endif - - printf("sigrok-cli %s\n\n", VERSION); - - printf("Using libsigrok %s (lib version %s).\n", - sr_package_version_string_get(), sr_lib_version_string_get()); -#ifdef HAVE_SRD - printf("Using libsigrokdecode %s (lib version %s).\n\n", - srd_package_version_string_get(), srd_lib_version_string_get()); -#endif - - printf("Supported hardware drivers:\n"); - drivers = sr_driver_list(); - for (i = 0; drivers[i]; i++) { - printf(" %-20s %s\n", drivers[i]->name, drivers[i]->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(" %-20s %s\n", "sigrok", "Default file output format"); - printf("\n"); - -#ifdef HAVE_SRD - if (srd_init(NULL) == SRD_OK) { - printf("Supported protocol decoders:\n"); - srd_decoder_load_all(); - for (l = srd_decoder_list(); l; l = l->next) { - dec = l->data; - printf(" %-20s %s\n", dec->id, dec->longname); - /* Print protocol description upon "-l 3" or higher. */ - if (opt_loglevel >= SR_LOG_INFO) - printf(" %-20s %s\n", "", dec->desc); - } - srd_exit(); - } - printf("\n"); -#endif -} - -static void print_dev_line(const struct sr_dev_inst *sdi) -{ - struct sr_probe *probe; - GSList *l; - GString *s; - GVariant *gvar; - - s = g_string_sized_new(128); - g_string_assign(s, sdi->driver->name); - if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_CONN, &gvar) == SR_OK) { - g_string_append(s, ":conn="); - g_string_append(s, g_variant_get_string(gvar, NULL)); - g_variant_unref(gvar); - } - g_string_append(s, " - "); - if (sdi->vendor && sdi->vendor[0]) - g_string_append_printf(s, "%s ", sdi->vendor); - if (sdi->model && sdi->model[0]) - g_string_append_printf(s, "%s ", sdi->model); - if (sdi->version && sdi->version[0]) - g_string_append_printf(s, "%s ", sdi->version); - if (sdi->probes) { - if (g_slist_length(sdi->probes) == 1) { - probe = sdi->probes->data; - g_string_append_printf(s, "with 1 probe: %s", probe->name); - } else { - g_string_append_printf(s, "with %d probes:", g_slist_length(sdi->probes)); - for (l = sdi->probes; l; l = l->next) { - probe = l->data; - g_string_append_printf(s, " %s", probe->name); - } - } - } - g_string_append_printf(s, "\n"); - printf("%s", s->str); - g_string_free(s, TRUE); - -} - -static void show_dev_list(void) -{ - struct sr_dev_inst *sdi; - GSList *devices, *l; - - if (!(devices = device_scan())) - return; - - printf("The following devices were found:\n"); - for (l = devices; l; l = l->next) { - sdi = l->data; - print_dev_line(sdi); - } - g_slist_free(devices); - -} - -static void show_dev_detail(void) -{ - struct sr_dev_inst *sdi; - const struct sr_config_info *srci; - struct sr_probe *probe; - struct sr_probe_group *probe_group, *pg; - GSList *devices, *pgl, *prl; - GVariant *gvar_opts, *gvar_dict, *gvar_list, *gvar; - gsize num_opts, num_elements; - const uint64_t *uint64, p, q, low, high; - uint64_t cur_low, cur_high; - const int32_t *opts; - unsigned int num_devices, o, i; - char *tmp_str; - char *s; - const char *charopts, **stropts; - - if (!(devices = device_scan())) { - g_critical("No devices found."); - return; - } - - num_devices = g_slist_length(devices); - if (num_devices > 1) { - g_critical("%d devices found. Use --scan to show them, " - "and select one to show.", num_devices); - return; - } - - sdi = devices->data; - print_dev_line(sdi); - - if (sr_dev_open(sdi) != SR_OK) { - g_critical("Failed to open device."); - return; - } - - if ((sr_config_list(sdi->driver, NULL, NULL, SR_CONF_SCAN_OPTIONS, - &gvar_opts) == SR_OK)) { - opts = g_variant_get_fixed_array(gvar_opts, &num_elements, - sizeof(int32_t)); - printf("Supported driver options:\n"); - for (i = 0; i < num_elements; i++) { - if (!(srci = sr_config_info_get(opts[i]))) - continue; - printf(" %s\n", srci->id); - } - g_variant_unref(gvar_opts); - } - - probe_group = select_probe_group(sdi); - if ((sr_config_list(sdi->driver, sdi, probe_group, SR_CONF_DEVICE_OPTIONS, - &gvar_opts)) != SR_OK) - /* Driver supports no device instance options. */ - return; - - if (sdi->probe_groups) { - printf("Probe groups:\n"); - for (pgl = sdi->probe_groups; pgl; pgl = pgl->next) { - pg = pgl->data; - printf(" %s: channel%s", pg->name, - g_slist_length(pg->probes) > 1 ? "s" : ""); - for (prl = pg->probes; prl; prl = prl->next) { - probe = prl->data; - printf(" %s", probe->name); - } - printf("\n"); - } - } - - printf("Supported configuration options"); - if (sdi->probe_groups) { - if (!probe_group) - printf(" across all probe groups"); - else - printf(" on probe group %s", probe_group->name); - } - printf(":\n"); - opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(int32_t)); - for (o = 0; o < num_opts; o++) { - if (!(srci = sr_config_info_get(opts[o]))) - continue; - - if (srci->key == SR_CONF_TRIGGER_TYPE) { - if (sr_config_list(sdi->driver, sdi, probe_group, srci->key, - &gvar) != SR_OK) { - printf("\n"); - continue; - } - charopts = g_variant_get_string(gvar, NULL); - printf(" Supported triggers: "); - while (*charopts) { - printf("%c ", *charopts); - charopts++; - } - printf("\n"); - g_variant_unref(gvar); - - } else if (srci->key == SR_CONF_PATTERN_MODE) { - /* Pattern generator modes */ - printf(" %s", srci->id); - if (sr_config_list(sdi->driver, sdi, probe_group, srci->key, - &gvar) == SR_OK) { - printf(" - supported patterns:\n"); - stropts = g_variant_get_strv(gvar, &num_elements); - for (i = 0; i < num_elements; i++) - printf(" %s\n", stropts[i]); - g_variant_unref(gvar); - } else { - printf("\n"); - } - - } else if (srci->key == SR_CONF_SAMPLERATE) { - /* Supported samplerates */ - printf(" %s", srci->id); - if (sr_config_list(sdi->driver, sdi, probe_group, SR_CONF_SAMPLERATE, - &gvar_dict) != SR_OK) { - printf("\n"); - continue; - } - if ((gvar_list = g_variant_lookup_value(gvar_dict, - "samplerates", G_VARIANT_TYPE("at")))) { - uint64 = g_variant_get_fixed_array(gvar_list, - &num_elements, sizeof(uint64_t)); - printf(" - supported samplerates:\n"); - for (i = 0; i < num_elements; i++) { - if (!(s = sr_samplerate_string(uint64[i]))) - continue; - printf(" %s\n", s); - g_free(s); - } - g_variant_unref(gvar_list); - } else if ((gvar_list = g_variant_lookup_value(gvar_dict, - "samplerate-steps", G_VARIANT_TYPE("at")))) { - uint64 = g_variant_get_fixed_array(gvar_list, - &num_elements, sizeof(uint64_t)); - /* low */ - if (!(s = sr_samplerate_string(uint64[0]))) - continue; - printf(" (%s", s); - g_free(s); - /* high */ - if (!(s = sr_samplerate_string(uint64[1]))) - continue; - printf(" - %s", s); - g_free(s); - /* step */ - if (!(s = sr_samplerate_string(uint64[2]))) - continue; - printf(" in steps of %s)\n", s); - g_free(s); - g_variant_unref(gvar_list); - } - g_variant_unref(gvar_dict); - - } else if (srci->key == SR_CONF_BUFFERSIZE) { - /* Supported buffer sizes */ - printf(" %s", srci->id); - if (sr_config_list(sdi->driver, sdi, probe_group, - SR_CONF_BUFFERSIZE, &gvar_list) != SR_OK) { - printf("\n"); - continue; - } - uint64 = g_variant_get_fixed_array(gvar_list, - &num_elements, sizeof(uint64_t)); - printf(" - supported buffer sizes:\n"); - for (i = 0; i < num_elements; i++) - printf(" %"PRIu64"\n", uint64[i]); - g_variant_unref(gvar_list); - - } else if (srci->key == SR_CONF_TIMEBASE) { - /* Supported time bases */ - printf(" %s", srci->id); - if (sr_config_list(sdi->driver, sdi, probe_group, - SR_CONF_TIMEBASE, &gvar_list) != SR_OK) { - printf("\n"); - continue; - } - printf(" - supported time bases:\n"); - num_elements = g_variant_n_children(gvar_list); - for (i = 0; i < num_elements; i++) { - gvar = g_variant_get_child_value(gvar_list, i); - g_variant_get(gvar, "(tt)", &p, &q); - s = sr_period_string(p * q); - printf(" %s\n", s); - g_free(s); - } - g_variant_unref(gvar_list); - - } else if (srci->key == SR_CONF_VDIV) { - /* Supported volts/div values */ - printf(" %s", srci->id); - if (sr_config_list(sdi->driver, sdi, probe_group, - SR_CONF_VDIV, &gvar_list) != SR_OK) { - printf("\n"); - continue; - } - printf(" - supported volts/div:\n"); - num_elements = g_variant_n_children(gvar_list); - for (i = 0; i < num_elements; i++) { - gvar = g_variant_get_child_value(gvar_list, i); - g_variant_get(gvar, "(tt)", &p, &q); - s = sr_voltage_string(p, q); - printf(" %s\n", s); - g_free(s); - } - g_variant_unref(gvar_list); - - } else if (srci->datatype == SR_T_CHAR) { - printf(" %s: ", srci->id); - if (sr_config_get(sdi->driver, sdi, probe_group, srci->key, - &gvar) == SR_OK) { - tmp_str = g_strdup(g_variant_get_string(gvar, NULL)); - g_variant_unref(gvar); - } else - tmp_str = NULL; - - if (sr_config_list(sdi->driver, sdi, probe_group, srci->key, - &gvar) != SR_OK) { - printf("\n"); - continue; - } - - stropts = g_variant_get_strv(gvar, &num_elements); - for (i = 0; i < num_elements; i++) { - if (i) - printf(", "); - printf("%s", stropts[i]); - if (tmp_str && !strcmp(tmp_str, stropts[i])) - printf(" (current)"); - } - printf("\n"); - g_free(stropts); - g_free(tmp_str); - g_variant_unref(gvar); - - } else if (srci->datatype == SR_T_UINT64_RANGE) { - printf(" %s: ", srci->id); - if (sr_config_list(sdi->driver, sdi, probe_group, srci->key, - &gvar_list) != SR_OK) { - printf("\n"); - continue; - } - - if (sr_config_get(sdi->driver, sdi, NULL, srci->key, &gvar) == SR_OK) { - g_variant_get(gvar, "(tt)", &cur_low, &cur_high); - g_variant_unref(gvar); - } else { - cur_low = 0; - cur_high = 0; - } - - num_elements = g_variant_n_children(gvar_list); - for (i = 0; i < num_elements; i++) { - gvar = g_variant_get_child_value(gvar_list, i); - g_variant_get(gvar, "(tt)", &low, &high); - g_variant_unref(gvar); - if (i) - printf(", "); - printf("%"PRIu64"-%"PRIu64, low, high); - if (low == cur_low && high == cur_high) - printf(" (current)"); - } - printf("\n"); - g_variant_unref(gvar_list); - - } else if (srci->datatype == SR_T_BOOL) { - printf(" %s: ", srci->id); - if (sr_config_get(sdi->driver, sdi, NULL, srci->key, - &gvar) == SR_OK) { - if (g_variant_get_boolean(gvar)) - printf("on (current), off\n"); - else - printf("on, off (current)\n"); - g_variant_unref(gvar); - } else - printf("on, off\n"); - - } else { - - /* Everything else */ - printf(" %s\n", srci->id); - } - } - g_variant_unref(gvar_opts); - - sr_dev_close(sdi); - g_slist_free(devices); - -} - -#ifdef HAVE_SRD -static void show_pd_detail(void) -{ - GSList *l; - struct srd_decoder *dec; - struct srd_decoder_option *o; - char **pdtokens, **pdtok, *optsep, **ann, *val, *doc; - struct srd_probe *p; - - pdtokens = g_strsplit(opt_pds, ",", -1); - for (pdtok = pdtokens; *pdtok; pdtok++) { - /* Strip options. */ - if ((optsep = strchr(*pdtok, ':'))) - *optsep = '\0'; - if (!(dec = srd_decoder_get_by_id(*pdtok))) { - g_critical("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); - printf("Annotations:\n"); - if (dec->annotations) { - for (l = dec->annotations; l; l = l->next) { - ann = l->data; - printf("- %s\n %s\n", ann[0], ann[1]); - } - } else { - printf("None.\n"); - } - printf("Required probes:\n"); - if (dec->probes) { - for (l = dec->probes; l; l = l->next) { - p = l->data; - printf("- %s (%s): %s\n", - p->name, p->id, p->desc); - } - } else { - printf("None.\n"); - } - printf("Optional probes:\n"); - if (dec->opt_probes) { - for (l = dec->opt_probes; l; l = l->next) { - p = l->data; - printf("- %s (%s): %s\n", - p->name, p->id, p->desc); - } - } else { - printf("None.\n"); - } - if (dec->options) { - printf("Options:\n"); - for (l = dec->options; l; l = l->next) { - o = l->data; - val = g_variant_print(o->def, FALSE); - printf("- %s: %s (default %s)\n", o->id, o->desc, val); - g_free(val); - } - } - if ((doc = srd_decoder_doc_get(dec))) { - printf("Documentation:\n%s\n", - doc[0] == '\n' ? doc + 1 : doc); - g_free(doc); - } - } - - g_strfreev(pdtokens); -} -#endif - -static GArray *get_enabled_logic_probes(const struct sr_dev_inst *sdi) -{ - struct sr_probe *probe; - GArray *probes; - GSList *l; - - probes = g_array_new(FALSE, FALSE, sizeof(int)); - for (l = sdi->probes; l; l = l->next) { - probe = l->data; - if (probe->type != SR_PROBE_LOGIC) - continue; - if (probe->enabled != TRUE) - continue; - g_array_append_val(probes, probe->index); - } - - return probes; -} - -static void datafeed_in(const struct sr_dev_inst *sdi, - const struct sr_datafeed_packet *packet, void *cb_data) -{ - const struct sr_datafeed_meta *meta; - const struct sr_datafeed_logic *logic; - const struct sr_datafeed_analog *analog; - struct sr_config *src; - static struct sr_output *o = NULL; - static GArray *logic_probelist = NULL; - static uint64_t received_samples = 0; - static int unitsize = 0; - static int triggered = 0; - static FILE *outfile = NULL; - GSList *l; - GString *out; - int sample_size, ret; - uint64_t samplerate, output_len, filter_out_len, end_sample; - uint8_t *output_buf, *filter_out; - - (void) cb_data; - - /* 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_debug("cli: Received SR_DF_HEADER"); - /* Initialize the output module. */ - if (!(o = g_try_malloc(sizeof(struct sr_output)))) { - g_critical("Output module malloc failed."); - exit(1); - } - o->format = output_format; - o->sdi = (struct sr_dev_inst *)sdi; - o->param = output_format_param; - if (o->format->init) { - if (o->format->init(o) != SR_OK) { - g_critical("Output format initialization failed."); - exit(1); - } - } - - /* Prepare non-stdout output. */ - outfile = stdout; - if (opt_output_file) { - if (default_output_format) { - /* output file is in session format, so we'll - * keep a copy of everything as it comes in - * and save from there after the session. */ - outfile = NULL; - savebuf = g_byte_array_new(); - } 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"); - } - } - - /* Prepare for logic data. */ - logic_probelist = get_enabled_logic_probes(sdi); - /* How many bytes we need to store the packed samples. */ - unitsize = (logic_probelist->len + 7) / 8; - -#ifdef HAVE_SRD - GVariant *gvar; - if (opt_pds && logic_probelist->len) { - if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE, - &gvar) == SR_OK) { - samplerate = g_variant_get_uint64(gvar); - g_variant_unref(gvar); - if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE, - g_variant_new_uint64(samplerate)) != SRD_OK) { - g_critical("Failed to configure decode session."); - break; - } - } - if (srd_session_start(srd_sess) != SRD_OK) { - g_critical("Failed to start decode session."); - break; - } - } -#endif - break; - - case SR_DF_META: - g_debug("cli: received SR_DF_META"); - meta = packet->payload; - for (l = meta->config; l; l = l->next) { - src = l->data; - switch (src->key) { - case SR_CONF_SAMPLERATE: - samplerate = g_variant_get_uint64(src->data); - g_debug("cli: got samplerate %"PRIu64" Hz", samplerate); -#ifdef HAVE_SRD - if (opt_pds) { - if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE, - g_variant_new_uint64(samplerate)) != SRD_OK) { - g_critical("Failed to pass samplerate to decoder."); - } - } -#endif - break; - case SR_CONF_SAMPLE_INTERVAL: - samplerate = g_variant_get_uint64(src->data); - g_debug("cli: got sample interval %"PRIu64" ms", samplerate); - break; - default: - /* Unknown metadata is not an error. */ - break; - } - } - break; - - case SR_DF_TRIGGER: - g_debug("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; - g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length); - sample_size = logic->unitsize; - if (logic->length == 0) - break; - - /* Don't store any samples until triggered. */ - if (opt_wait_trigger && !triggered) - break; - - if (limit_samples && received_samples >= limit_samples) - break; - - ret = sr_filter_probes(sample_size, unitsize, logic_probelist, - logic->data, logic->length, - &filter_out, &filter_out_len); - if (ret != SR_OK) - break; - - /* - * 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 (opt_output_file && default_output_format) { - /* Saving to a session file. */ - g_byte_array_append(savebuf, filter_out, filter_out_len); - } else { - if (opt_pds) { -#ifdef HAVE_SRD - end_sample = received_samples + filter_out_len / unitsize; - if (srd_session_send(srd_sess, received_samples, end_sample, - (uint8_t*)filter_out, filter_out_len) != SRD_OK) - sr_session_stop(); -#endif - } 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); - fflush(outfile); - g_free(output_buf); - } - } - } - g_free(filter_out); - - received_samples += logic->length / sample_size; - break; - - case SR_DF_ANALOG: - analog = packet->payload; - g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples); - if (analog->num_samples == 0) - break; - - if (limit_samples && received_samples >= limit_samples) - break; - - if (o->format->data && packet->type == o->format->df_type) { - o->format->data(o, (const uint8_t *)analog->data, - analog->num_samples * sizeof(float), - &output_buf, &output_len); - if (output_buf) { - fwrite(output_buf, 1, output_len, outfile); - fflush(outfile); - g_free(output_buf); - } - } - - received_samples += analog->num_samples; - break; - - case SR_DF_FRAME_BEGIN: - g_debug("cli: received SR_DF_FRAME_BEGIN"); - if (o->format->event) { - o->format->event(o, SR_DF_FRAME_BEGIN, &output_buf, - &output_len); - if (output_buf) { - fwrite(output_buf, 1, output_len, outfile); - fflush(outfile); - g_free(output_buf); - } - } - break; - - case SR_DF_FRAME_END: - g_debug("cli: received SR_DF_FRAME_END"); - if (o->format->event) { - o->format->event(o, SR_DF_FRAME_END, &output_buf, - &output_len); - if (output_buf) { - fwrite(output_buf, 1, output_len, outfile); - fflush(outfile); - g_free(output_buf); - } - } - break; - - default: - break; - } - - if (o && o->format->receive) { - if (o->format->receive(o, sdi, packet, &out) == SR_OK && out) { - fwrite(out->str, 1, out->len, outfile); - fflush(outfile); - g_string_free(out, TRUE); - } - } - - /* SR_DF_END needs to be handled after the output module's receive() - * is called, so it can properly clean up that module etc. */ - if (packet->type == SR_DF_END) { - g_debug("cli: Received SR_DF_END"); - - if (o->format->event) { - o->format->event(o, SR_DF_END, &output_buf, &output_len); - if (output_buf) { - if (outfile) - fwrite(output_buf, 1, output_len, outfile); - g_free(output_buf); - output_len = 0; - } - } - - if (limit_samples && received_samples < limit_samples) - g_warning("Device only sent %" PRIu64 " samples.", - received_samples); - - if (opt_continuous) - g_warning("Device stopped after %" PRIu64 " samples.", - received_samples); - - g_array_free(logic_probelist, TRUE); - - if (o->format->cleanup) - o->format->cleanup(o); - g_free(o); - o = NULL; - - if (outfile && outfile != stdout) - fclose(outfile); - - if (opt_output_file && default_output_format && savebuf->len) { - if (sr_session_save(opt_output_file, sdi, savebuf->data, - unitsize, savebuf->len / unitsize) != SR_OK) - g_critical("Failed to save session."); - g_byte_array_free(savebuf, FALSE); - } - } - -} - -#ifdef HAVE_SRD -static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash, - GHashTable **options) -{ - struct srd_decoder_option *o; - GSList *optl; - GVariant *gvar; - gint64 val_int; - int ret; - char *val_str, *conv; - - ret = TRUE; - *options = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, - (GDestroyNotify)g_variant_unref); - - for (optl = dec->options; optl; optl = optl->next) { - o = optl->data; - if (!(val_str = g_hash_table_lookup(hash, o->id))) - /* Not specified. */ - continue; - if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_STRING)) { - gvar = g_variant_new_string(val_str); - } else if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_INT64)) { - val_int = strtoll(val_str, &conv, 0); - if (!conv || conv == val_str) { - g_critical("Protocol decoder '%s' option '%s' " - "requires a number.", dec->name, o->id); - ret = FALSE; - break; - } - gvar = g_variant_new_int64(val_int); - } else { - g_critical("Unsupported type for option '%s' (%s)", - o->id, g_variant_get_type_string(o->def)); - ret = FALSE; - break; - } - g_variant_ref_sink(gvar); - g_hash_table_insert(*options, g_strdup(o->id), gvar); - g_hash_table_remove(hash, o->id); - } - - return ret; -} - -static int probes_to_gvar(struct srd_decoder *dec, GHashTable *hash, - GHashTable **probes) -{ - struct srd_probe *p; - GSList *all_probes, *l; - GVariant *gvar; - gint32 val_int; - int ret; - char *val_str, *conv; - - ret = TRUE; - *probes = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, - (GDestroyNotify)g_variant_unref); - - all_probes = g_slist_copy(dec->probes); - all_probes = g_slist_concat(all_probes, g_slist_copy(dec->opt_probes)); - for (l = all_probes; l; l = l->next) { - p = l->data; - if (!(val_str = g_hash_table_lookup(hash, p->id))) - /* Not specified. */ - continue; - val_int = strtoll(val_str, &conv, 10); - if (!conv || conv == val_str) { - g_critical("Protocol decoder '%s' probes '%s' " - "is not a number.", dec->name, p->id); - ret = FALSE; - break; - } - gvar = g_variant_new_int32(val_int); - g_variant_ref_sink(gvar); - g_hash_table_insert(*probes, g_strdup(p->id), gvar); - g_hash_table_remove(hash, p->id); - } - g_slist_free(all_probes); - - return ret; -} - -/* 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) -{ - struct srd_decoder *dec; - GHashTable *pd_opthash, *options, *probes; - GList *leftover, *l; - struct srd_decoder_inst *di; - int ret; - char **pdtokens, **pdtok, *pd_name; - - (void)dev; - - pd_ann_visible = g_hash_table_new_full(g_str_hash, g_int_equal, - g_free, NULL); - ret = 0; - pd_name = NULL; - pd_opthash = options = probes = NULL; - pdtokens = g_strsplit(pdstring, ",", 0); - for (pdtok = pdtokens; *pdtok; pdtok++) { - if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) { - g_critical("Invalid protocol decoder option '%s'.", *pdtok); - break; - } - - 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) { - g_critical("Failed to load protocol decoder %s.", pd_name); - ret = 1; - break; - } - dec = srd_decoder_get_by_id(pd_name); - - /* Convert decoder option and probe values to GVariant. */ - if (!opts_to_gvar(dec, pd_opthash, &options)) { - ret = 1; - break; - } - if (!probes_to_gvar(dec, pd_opthash, &probes)) { - ret = 1; - break; - } - if (g_hash_table_size(pd_opthash) > 0) { - leftover = g_hash_table_get_keys(pd_opthash); - for (l = leftover; l; l = l->next) - g_critical("Unknown option or probe '%s'", (char *)l->data); - g_list_free(leftover); - break; - } - - if (!(di = srd_inst_new(srd_sess, pd_name, options))) { - g_critical("Failed to instantiate protocol decoder %s.", pd_name); - ret = 1; - break; - } - - /* If no annotation list was specified, add them all in now. - * This will be pared down later to leave only the last PD - * in the stack. - */ - if (!opt_pd_annotations) - g_hash_table_insert(pd_ann_visible, - g_strdup(di->inst_id), GINT_TO_POINTER(-1)); - - /* Remap the probes if needed. */ - if (srd_inst_probe_set_all(di, probes) != SRD_OK) { - ret = 1; - break; - } - } - - g_strfreev(pdtokens); - if (pd_opthash) - g_hash_table_destroy(pd_opthash); - if (options) - g_hash_table_destroy(options); - if (probes) - g_hash_table_destroy(probes); - if (pd_name) - g_free(pd_name); - - return ret; -} - -int setup_pd_stack(void) -{ - struct srd_decoder_inst *di_from, *di_to; - int ret, i; - char **pds, **ids; - - /* Set up the protocol decoder stack. */ - pds = g_strsplit(opt_pds, ",", 0); - if (g_strv_length(pds) > 1) { - if (opt_pd_stack) { - /* A stack setup was specified, use that. */ - g_strfreev(pds); - pds = g_strsplit(opt_pd_stack, ",", 0); - if (g_strv_length(pds) < 2) { - g_strfreev(pds); - g_critical("Specify at least two protocol decoders to stack."); - return 1; - } - } - - /* First PD goes at the bottom of the stack. */ - ids = g_strsplit(pds[0], ":", 0); - if (!(di_from = srd_inst_find_by_id(srd_sess, ids[0]))) { - g_strfreev(ids); - g_critical("Cannot stack protocol decoder '%s': " - "instance not found.", pds[0]); - return 1; - } - g_strfreev(ids); - - /* Every subsequent PD goes on top. */ - for (i = 1; pds[i]; i++) { - ids = g_strsplit(pds[i], ":", 0); - if (!(di_to = srd_inst_find_by_id(srd_sess, ids[0]))) { - g_strfreev(ids); - g_critical("Cannot stack protocol decoder '%s': " - "instance not found.", pds[i]); - return 1; - } - g_strfreev(ids); - if ((ret = srd_inst_stack(srd_sess, di_from, di_to)) != SRD_OK) - return 1; - - /* Don't show annotation from this PD. Only the last PD in - * the stack will be left on the annotation list (unless - * the annotation list was specifically provided). - */ - if (!opt_pd_annotations) - g_hash_table_remove(pd_ann_visible, - di_from->inst_id); - - di_from = di_to; - } - } - g_strfreev(pds); - - return 0; -} - -int setup_pd_annotations(void) -{ - GSList *l; - struct srd_decoder *dec; - int ann_class; - char **pds, **pdtok, **keyval, **ann_descr; - - /* Set up custom list of PDs and annotations to show. */ - pds = g_strsplit(opt_pd_annotations, ",", 0); - for (pdtok = pds; *pdtok && **pdtok; pdtok++) { - keyval = g_strsplit(*pdtok, "=", 0); - if (!(dec = srd_decoder_get_by_id(keyval[0]))) { - g_critical("Protocol decoder '%s' not found.", keyval[0]); - return 1; - } - if (!dec->annotations) { - g_critical("Protocol decoder '%s' has no annotations.", keyval[0]); - return 1; - } - ann_class = 0; - if (g_strv_length(keyval) == 2) { - for (l = dec->annotations; l; l = l->next, ann_class++) { - ann_descr = l->data; - if (!canon_cmp(ann_descr[0], keyval[1])) - /* Found it. */ - break; - } - if (!l) { - g_critical("Annotation '%s' not found " - "for protocol decoder '%s'.", keyval[1], keyval[0]); - return 1; - } - g_debug("cli: Showing protocol decoder %s annotation " - "class %d (%s).", keyval[0], ann_class, ann_descr[0]); - } else { - /* No class specified: show all of them. */ - ann_class = -1; - g_debug("cli: Showing all annotation classes for protocol " - "decoder %s.", keyval[0]); - } - g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann_class)); - g_strfreev(keyval); - } - g_strfreev(pds); - - return 0; -} - -int setup_pd_meta(void) -{ - struct srd_decoder *dec; - char **pds, **pdtok; - - pd_meta_visible = g_hash_table_new_full(g_str_hash, g_int_equal, - g_free, NULL); - pds = g_strsplit(opt_pd_meta, ",", 0); - for (pdtok = pds; *pdtok && **pdtok; pdtok++) { - if (!(dec = srd_decoder_get_by_id(*pdtok))) { - g_critical("Protocol decoder '%s' not found.", *pdtok); - return 1; - } - g_debug("cli: Showing protocol decoder meta output from '%s'.", *pdtok); - g_hash_table_insert(pd_meta_visible, g_strdup(*pdtok), NULL); - } - g_strfreev(pds); - - return 0; -} - -int setup_pd_binary(void) -{ - GSList *l; - struct srd_decoder *dec; - int bin_class; - char **pds, **pdtok, **keyval, *bin_name; - - pd_binary_visible = g_hash_table_new_full(g_str_hash, g_int_equal, - g_free, NULL); - pds = g_strsplit(opt_pd_binary, ",", 0); - for (pdtok = pds; *pdtok && **pdtok; pdtok++) { - keyval = g_strsplit(*pdtok, "=", 0); - if (!(dec = srd_decoder_get_by_id(keyval[0]))) { - g_critical("Protocol decoder '%s' not found.", keyval[0]); - return 1; - } - if (!dec->binary) { - g_critical("Protocol decoder '%s' has no binary output.", keyval[0]); - return 1; - } - bin_class = 0; - if (g_strv_length(keyval) == 2) { - for (l = dec->binary; l; l = l->next, bin_class++) { - bin_name = l->data; - if (!canon_cmp(bin_name, keyval[1])) - /* Found it. */ - break; - } - if (!l) { - g_critical("binary output '%s' not found " - "for protocol decoder '%s'.", keyval[1], keyval[0]); - return 1; - } - g_debug("cli: Showing protocol decoder %s binary class " - "%d (%s).", keyval[0], bin_class, bin_name); - } else { - /* No class specified: output all of them. */ - bin_class = -1; - g_debug("cli: Showing all binary classes for protocol " - "decoder %s.", keyval[0]); - } - g_hash_table_insert(pd_binary_visible, g_strdup(keyval[0]), GINT_TO_POINTER(bin_class)); - g_strfreev(keyval); - } - g_strfreev(pds); - - return 0; -} - -void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data) -{ - struct srd_proto_data_annotation *pda; - gpointer ann_format; - int format; - - /* 'cb_data' is not used in this specific callback. */ - (void)cb_data; - - if (!pd_ann_visible) - return; - - if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id, - NULL, &ann_format)) - /* Not in the list of PDs whose annotations we're showing. */ - return; - - format = GPOINTER_TO_INT(ann_format); - pda = pdata->data; - if (format != -1 && pda->ann_format != format) - /* We don't want this particular format from the PD. */ - return; - - if (opt_loglevel > SR_LOG_WARN) - printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample); - printf("%s: ", pdata->pdo->proto_id); - /* Show only the longest annotation. */ - printf("\"%s\" ", pda->ann_text[0]); - printf("\n"); - fflush(stdout); -} - -void show_pd_meta(struct srd_proto_data *pdata, void *cb_data) -{ - - /* 'cb_data' is not used in this specific callback. */ - (void)cb_data; - - if (!g_hash_table_lookup_extended(pd_meta_visible, - pdata->pdo->di->decoder->id, NULL, NULL)) - /* Not in the list of PDs whose meta output we're showing. */ - return; - - if (opt_loglevel > SR_LOG_WARN) - printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample); - printf("%s: ", pdata->pdo->proto_id); - printf("%s: %s", pdata->pdo->meta_name, g_variant_print(pdata->data, FALSE)); - printf("\n"); - fflush(stdout); -} - -void show_pd_binary(struct srd_proto_data *pdata, void *cb_data) -{ - struct srd_proto_data_binary *pdb; - gpointer classp; - int class; - - /* 'cb_data' is not used in this specific callback. */ - (void)cb_data; - - if (!g_hash_table_lookup_extended(pd_binary_visible, - pdata->pdo->di->decoder->id, NULL, (void **)&classp)) - /* Not in the list of PDs whose meta output we're showing. */ - return; - - class = GPOINTER_TO_INT(classp); - pdb = pdata->data; - if (class != -1 && class != pdb->bin_class) - /* Not showing this binary class. */ - return; - - /* Just send the binary output to stdout, no embellishments. */ - fwrite(pdb->data, pdb->size, 1, stdout); - fflush(stdout); -} -#endif - -int setup_output_format(void) -{ - GHashTable *fmtargs; - GHashTableIter iter; - gpointer key, value; - struct sr_output_format **outputs; - int i; - char *fmtspec; - - if (opt_output_format && !strcmp(opt_output_format, "sigrok")) { - /* Doesn't really exist as an output module - this is - * the session save mode. */ - g_free(opt_output_format); - opt_output_format = NULL; - } - - if (!opt_output_format) { - opt_output_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_output_format, TRUE); - fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key"); - if (!fmtspec) { - g_critical("Invalid output format."); - 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) { - g_critical("Invalid output format %s.", opt_output_format); - return 1; - } - g_hash_table_destroy(fmtargs); - - return 0; -} - -static int select_probes(struct sr_dev_inst *sdi) -{ - struct sr_probe *probe; - GSList *selected_probes, *l; - - if (!opt_probes) - return SR_OK; - - if (!(selected_probes = parse_probestring(sdi, opt_probes))) - return SR_ERR; - - for (l = sdi->probes; l; l = l->next) { - probe = l->data; - if (g_slist_find(selected_probes, probe)) - probe->enabled = TRUE; - else - probe->enabled = FALSE; - } - g_slist_free(selected_probes); - - 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) { - g_critical("No supported input formats available."); - 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)) - continue; - g_debug("Using user-specified input file format '%s'.", - inputs[i]->id); - return inputs[i]; - } - - /* The user specified an unknown input format, return NULL. */ - g_critical("Error: specified input file format '%s' is " - "unknown.", opt); - 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]) { - g_critical("Error: no matching input module found."); - return NULL; - } - - g_debug("cli: Autodetected '%s' input format for file '%s'.", - inputs[i]->id, filename); - - return inputs[i]; -} - -static void load_input_file_format(void) -{ - GHashTable *fmtargs = NULL; - struct stat st; - struct sr_input *in; - struct sr_input_format *input_format; - char *fmtspec = NULL; - - if (opt_input_format) { - fmtargs = parse_generic_arg(opt_input_format, TRUE); - fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key"); - } - - if (!(input_format = determine_input_file_format(opt_input_file, - fmtspec))) { - /* The exact cause was already logged. */ - return; - } - - if (fmtargs) - g_hash_table_remove(fmtargs, "sigrok_key"); - - if (stat(opt_input_file, &st) == -1) { - g_critical("Failed to load %s: %s", opt_input_file, - strerror(errno)); - exit(1); - } - - /* Initialize the input module. */ - if (!(in = g_try_malloc(sizeof(struct sr_input)))) { - g_critical("Failed to allocate input module."); - exit(1); - } - in->format = input_format; - in->param = fmtargs; - if (in->format->init) { - if (in->format->init(in, opt_input_file) != SR_OK) { - g_critical("Input format init failed."); - exit(1); - } - } - - if (select_probes(in->sdi) > 0) - return; - - sr_session_new(); - sr_session_datafeed_callback_add(datafeed_in, NULL); - if (sr_session_dev_add(in->sdi) != SR_OK) { - g_critical("Failed to use device."); - sr_session_destroy(); - return; - } - - input_format->loadfile(in, opt_input_file); - - sr_session_destroy(); - - if (fmtargs) - g_hash_table_destroy(fmtargs); -} - -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, NULL); - sr_session_start(); - sr_session_run(); - sr_session_stop(); - } - else { - /* fall back on input modules */ - load_input_file_format(); - } -} - -static int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args) -{ - const struct sr_config_info *srci; - struct sr_probe_group *pg; - GHashTableIter iter; - gpointer key, value; - int ret; - double tmp_double; - uint64_t tmp_u64, p, q, low, high; - gboolean tmp_bool; - GVariant *val, *rational[2], *range[2]; - - g_hash_table_iter_init(&iter, args); - while (g_hash_table_iter_next(&iter, &key, &value)) { - if (!(srci = sr_config_info_name_get(key))) { - g_critical("Unknown device option '%s'.", (char *) key); - return SR_ERR; - } - - if ((value == NULL) && - (srci->datatype != SR_T_BOOL)) { - g_critical("Option '%s' needs a value.", (char *)key); - return SR_ERR; - } - val = NULL; - switch (srci->datatype) { - case SR_T_UINT64: - ret = sr_parse_sizestring(value, &tmp_u64); - if (ret != SR_OK) - break; - val = g_variant_new_uint64(tmp_u64); - break; - case SR_T_CHAR: - val = g_variant_new_string(value); - break; - case SR_T_BOOL: - if (!value) - tmp_bool = TRUE; - else - tmp_bool = sr_parse_boolstring(value); - val = g_variant_new_boolean(tmp_bool); - break; - case SR_T_FLOAT: - tmp_double = strtof(value, NULL); - val = g_variant_new_double(tmp_double); - break; - case SR_T_RATIONAL_PERIOD: - if ((ret = sr_parse_period(value, &p, &q)) != SR_OK) - break; - rational[0] = g_variant_new_uint64(p); - rational[1] = g_variant_new_uint64(q); - val = g_variant_new_tuple(rational, 2); - break; - case SR_T_RATIONAL_VOLT: - if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK) - break; - rational[0] = g_variant_new_uint64(p); - rational[1] = g_variant_new_uint64(q); - val = g_variant_new_tuple(rational, 2); - break; - case SR_T_UINT64_RANGE: - if (sscanf(value, "%"PRIu64"-%"PRIu64, &low, &high) != 2) { - ret = SR_ERR; - break; - } else { - range[0] = g_variant_new_uint64(low); - range[1] = g_variant_new_uint64(high); - val = g_variant_new_tuple(range, 2); - } - break; - default: - ret = SR_ERR; - } - if (val) { - pg = select_probe_group(sdi); - ret = sr_config_set(sdi, pg, srci->key, val); - } - if (ret != SR_OK) { - g_critical("Failed to set device option '%s'.", (char *)key); - return ret; - } - } - - return SR_OK; -} - -static void set_options(void) -{ - struct sr_dev_inst *sdi; - GSList *devices; - GHashTable *devargs; - - if (!opt_config) { - g_critical("No setting specified."); - return; - } - - if (!(devargs = parse_generic_arg(opt_config, FALSE))) - return; - - if (!(devices = device_scan())) { - g_critical("No devices found."); - return; - } - sdi = devices->data; - - if (sr_dev_open(sdi) != SR_OK) { - g_critical("Failed to open device."); - return; - } - - set_dev_options(sdi, devargs); - - sr_dev_close(sdi); - g_slist_free(devices); - g_hash_table_destroy(devargs); - -} - -static int set_limit_time(const struct sr_dev_inst *sdi) -{ - GVariant *gvar; - uint64_t time_msec; - uint64_t samplerate; - - if (!(time_msec = sr_parse_timestring(opt_time))) { - g_critical("Invalid time '%s'", opt_time); - return SR_ERR; - } - - if (sr_dev_has_option(sdi, SR_CONF_LIMIT_MSEC)) { - gvar = g_variant_new_uint64(time_msec); - if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) { - g_critical("Failed to configure time limit."); - return SR_ERR; - } - } else if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) { - /* Convert to samples based on the samplerate. */ - sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar); - samplerate = g_variant_get_uint64(gvar); - g_variant_unref(gvar); - limit_samples = (samplerate) * time_msec / (uint64_t)1000; - if (limit_samples == 0) { - g_critical("Not enough time at this samplerate."); - return SR_ERR; - } - gvar = g_variant_new_uint64(limit_samples); - if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) { - g_critical("Failed to configure time-based sample limit."); - return SR_ERR; - } - } else { - g_critical("This device does not support time limits."); - return SR_ERR; - } - - return SR_OK; -} - -static void run_session(void) -{ - GSList *devices; - GHashTable *devargs; - GVariant *gvar; - struct sr_dev_inst *sdi; - int max_probes, i; - char **triggerlist; - - devices = device_scan(); - if (!devices) { - g_critical("No devices found."); - return; - } - if (g_slist_length(devices) > 1) { - g_critical("sigrok-cli only supports one device for capturing."); - return; - } - sdi = devices->data; - - sr_session_new(); - sr_session_datafeed_callback_add(datafeed_in, NULL); - - if (sr_dev_open(sdi) != SR_OK) { - g_critical("Failed to open device."); - return; - } - - if (sr_session_dev_add(sdi) != SR_OK) { - g_critical("Failed to add device to session."); - sr_session_destroy(); - return; - } - - if (opt_config) { - if ((devargs = parse_generic_arg(opt_config, FALSE))) { - if (set_dev_options(sdi, devargs) != SR_OK) - return; - g_hash_table_destroy(devargs); - } - } - - if (select_probes(sdi) != SR_OK) { - g_critical("Failed to set probes."); - sr_session_destroy(); - return; - } - - if (opt_triggers) { - if (!(triggerlist = sr_parse_triggerstring(sdi, opt_triggers))) { - sr_session_destroy(); - return; - } - max_probes = g_slist_length(sdi->probes); - for (i = 0; i < max_probes; i++) { - if (triggerlist[i]) { - sr_dev_trigger_set(sdi, i, triggerlist[i]); - g_free(triggerlist[i]); - } - } - g_free(triggerlist); - } - - if (opt_continuous) { - if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) { - g_critical("This device does not support continuous sampling."); - sr_session_destroy(); - return; - } - } - - if (opt_time) { - if (set_limit_time(sdi) != SR_OK) { - sr_session_destroy(); - return; - } - } - - if (opt_samples) { - if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) { - g_critical("Invalid sample limit '%s'.", opt_samples); - sr_session_destroy(); - return; - } - gvar = g_variant_new_uint64(limit_samples); - if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) { - g_critical("Failed to configure sample limit."); - sr_session_destroy(); - return; - } - } - - if (opt_frames) { - if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) { - g_critical("Invalid sample limit '%s'.", opt_samples); - sr_session_destroy(); - return; - } - gvar = g_variant_new_uint64(limit_frames); - if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) { - g_critical("Failed to configure frame limit."); - sr_session_destroy(); - return; - } - } - - if (sr_session_start() != SR_OK) { - g_critical("Failed to start session."); - sr_session_destroy(); - return; - } - - if (opt_continuous) - add_anykey(); - - sr_session_run(); - - if (opt_continuous) - clear_anykey(); - - sr_session_datafeed_callback_remove_all(); - sr_session_destroy(); - g_slist_free(devices); - -} - -static void logger(const gchar *log_domain, GLogLevelFlags log_level, - const gchar *message, gpointer cb_data) -{ - (void)log_domain; - (void)cb_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_CRITICAL | G_LOG_LEVEL_WARNING) - || opt_loglevel > SR_LOG_WARN) { - fprintf(stderr, "%s\n", message); - fflush(stderr); - } - - if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL)) - exit(1); - -} - -int main(int argc, char **argv) -{ - GOptionContext *context; - GError *error; - int ret; - char *help; - - g_log_set_default_handler(logger, NULL); - - context = g_option_context_new(NULL); - g_option_context_add_main_entries(context, optargs, NULL); - - ret = 1; - error = NULL; - if (!g_option_context_parse(context, &argc, &argv, &error)) { - g_critical("%s", error->message); - goto done; - } - - /* Set the loglevel (amount of messages to output) for libsigrok. */ - if (sr_log_loglevel_set(opt_loglevel) != SR_OK) - goto done; - - if (sr_init(&sr_ctx) != SR_OK) - goto done; - -#ifdef HAVE_SRD - /* Set the loglevel (amount of messages to output) for libsigrokdecode. */ - if (srd_log_loglevel_set(opt_loglevel) != SRD_OK) - goto done; - - if (opt_pds) { - if (srd_init(NULL) != SRD_OK) - goto done; - if (srd_session_new(&srd_sess) != SRD_OK) { - g_critical("Failed to create new decode session."); - goto done; - } - if (register_pds(NULL, opt_pds) != 0) - goto done; - if (setup_pd_stack() != 0) - goto done; - - /* Only one output type is ever shown. */ - if (opt_pd_binary) { - if (setup_pd_binary() != 0) - goto done; - if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_BINARY, - show_pd_binary, NULL) != SRD_OK) - goto done; - } else if (opt_pd_meta) { - if (setup_pd_meta() != 0) - goto done; - if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_META, - show_pd_meta, NULL) != SRD_OK) - goto done; - } else { - if (opt_pd_annotations) - if (setup_pd_annotations() != 0) - goto done; - if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_ANN, - show_pd_annotations, NULL) != SRD_OK) - goto done; - } - } -#endif - - if (setup_output_format() != 0) - goto done; - - if (opt_version) - show_version(); - else if (opt_scan_devs) - show_dev_list(); -#ifdef HAVE_SRD - else if (opt_pds && opt_show) - show_pd_detail(); -#endif - else if (opt_show) - show_dev_detail(); - else if (opt_input_file) - load_input_file(); - else if (opt_set) - set_options(); - else if (opt_samples || opt_time || opt_frames || opt_continuous) - run_session(); - else { - help = g_option_context_get_help(context, TRUE, NULL); - printf("%s", help); - g_free(help); - } - -#ifdef HAVE_SRD - if (opt_pds) - srd_exit(); -#endif - - ret = 0; - -done: - if (sr_ctx) - sr_exit(sr_ctx); - - g_option_context_free(context); - - return ret; -} diff --git a/sigrok-cli.h b/sigrok-cli.h index 3b72791..32981e3 100644 --- a/sigrok-cli.h +++ b/sigrok-cli.h @@ -20,15 +20,50 @@ #ifndef SIGROK_CLI_SIGROK_CLI_H #define SIGROK_CLI_SIGROK_CLI_H -/* sigrok-cli.c */ -int num_real_devs(void); +#include "config.h" +#include +#ifdef HAVE_SRD +#include +#endif + +#define DEFAULT_OUTPUT_FORMAT "bits:width=64" + +/* main.c */ +int select_probes(struct sr_dev_inst *sdi); + +/* show.c */ +void show_version(void); +void show_dev_list(void); +void show_dev_detail(void); +void show_pd_detail(void); + +/* device.c */ +GSList *device_scan(void); +struct sr_probe_group *select_probe_group(struct sr_dev_inst *sdi); + +/* session.c */ +int setup_output_format(void); +void datafeed_in(const struct sr_dev_inst *sdi, + const struct sr_datafeed_packet *packet, void *cb_data); +int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args); +void run_session(void); + +/* input.c */ +void load_input_file(void); + +/* decode.c */ +int register_pds(const char *pdstring); +int setup_pd_stack(void); +int setup_pd_annotations(void); +int setup_pd_meta(void); +int setup_pd_binary(void); +void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data); +void show_pd_meta(struct srd_proto_data *pdata, void *cb_data); +void show_pd_binary(struct srd_proto_data *pdata, void *cb_data); /* parsers.c */ GSList *parse_probestring(struct sr_dev_inst *sdi, const char *probestring); GHashTable *parse_generic_arg(const char *arg, gboolean sep_first); -struct sr_dev *parse_devstring(const char *devstring); -uint64_t sr_parse_timestring(const char *timestring); -char *strcanon(const char *str); int canon_cmp(const char *str1, const char *str2); /* anykey.c */