* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#include "config.h"
+#ifdef HAVE_SRD
#include <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
+#endif
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <glib/gstdio.h>
#include <libsigrok/libsigrok.h>
#include "sigrok-cli.h"
-#include "config.h"
#define DEFAULT_OUTPUT_FORMAT "bits:width=64"
static struct sr_output_format *output_format = NULL;
static int default_output_format = FALSE;
static char *output_format_param = NULL;
+#ifdef HAVE_SRD
static GHashTable *pd_ann_visible = NULL;
+#endif
static GByteArray *savebuf;
static gboolean opt_version = FALSE;
static gchar *opt_probes = 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;
+#endif
static gchar *opt_input_format = NULL;
static gchar *opt_output_format = NULL;
static gchar *opt_show = 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,
"Trigger configuration", NULL},
{"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
"Wait for trigger", NULL},
+#ifdef HAVE_SRD
{"protocol-decoders", 'a', 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},
+#endif
{"show", 0, 0, G_OPTION_ARG_NONE, &opt_show,
"Show device detail", NULL},
{"time", 0, 0, G_OPTION_ARG_STRING, &opt_time,
"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 show_version(void)
{
- const GSList *l;
struct sr_dev_driver **drivers;
struct sr_input_format **inputs;
struct sr_output_format **outputs;
- struct srd_decoder *dec;
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();
printf(" %-20s %s\n", outputs[i]->id, outputs[i]->description);
printf("\n");
+#ifdef HAVE_SRD
if (srd_init(NULL) == SRD_OK) {
printf("Supported protocol decoders:\n");
srd_decoder_load_all();
srd_exit();
}
printf("\n");
+#endif
}
static void print_dev_line(const struct sr_dev_inst *sdi)
GSList *devices;
uint64_t *integers;
const int *hwopts, *hwcaps;
- int cap, num_devices, n, i;
+ int cap, num_devices, *tmp_bool, i;
char *s, *title;
const char *charopts, **stropts;
num_devices = g_slist_length(devices);
if (num_devices > 1) {
- if (!opt_dev) {
- g_critical("%d devices found. Use --list-devices to show them, "
- "and --device to select one.", num_devices);
- return;
- }
- /* opt_dev is NULL if not specified, which is fine. */
- n = strtol(opt_dev, NULL, 10);
- if (n >= num_devices) {
- g_critical("%d devices found, numbered starting from 0.",
- num_devices);
- return;
- }
- sdi = g_slist_nth_data(devices, n);
- } else
- sdi = g_slist_nth_data(devices, 0);
+ g_critical("%d devices found. Use --list-devices to show them, "
+ "and --device to select one.", num_devices);
+ return;
+ }
+ sdi = devices->data;
print_dev_line(sdi);
+ /* This properly opens and initializes the device, so we can get
+ * current settings. */
+ sr_session_new();
+ if (sr_session_dev_add(sdi) != SR_OK) {
+ g_critical("Failed to use device.");
+ return;
+ }
+
if (sr_config_list(sdi->driver, SR_CONF_TRIGGER_TYPE, (const void **)&charopts,
sdi) == SR_OK && charopts) {
printf("Supported triggers: ");
for (i = 0; stropts[i]; i++)
printf(" %s\n", stropts[i]);
+ } else if (srci->key == SR_CONF_DATALOG) {
+ /* Turning on/off internal data logging. */
+ printf(" %s\t(on/off", srci->id);
+ if (sr_config_get(sdi->driver, SR_CONF_DATALOG,
+ (const void **)&tmp_bool, sdi) == SR_OK) {
+ printf(", currently %s", *tmp_bool ? "on" : "off");
+ }
+ printf(")\n");
} else {
/* Everything else */
printf(" %s\n", srci->id);
}
}
+ sr_session_destroy();
+
}
+#ifdef HAVE_SRD
static void show_pd_detail(void)
{
GSList *l;
struct srd_decoder *dec;
- char **pdtokens, **pdtok, **ann, *doc;
+ 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;
} else {
printf("None.\n");
}
- /* TODO: Print supported decoder options. */
printf("Required probes:\n");
if (dec->probes) {
for (l = dec->probes; l; l = l->next) {
} 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_strfreev(pdtokens);
}
+#endif
static GArray *get_enabled_logic_probes(const struct sr_dev_inst *sdi)
{
/* How many bytes we need to store the packed samples. */
unitsize = (logic_probelist->len + 7) / 8;
+#ifdef HAVE_SRD
if (opt_pds && logic_probelist->len) {
if (sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
(const void **)&samplerate, sdi) != SR_OK) {
srd_session_start(logic_probelist->len, unitsize,
*samplerate);
}
- break;
-
- case SR_DF_END:
- g_debug("cli: Received SR_DF_END");
- if (!o) {
- g_debug("cli: double end!");
- break;
- }
- 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);
-
- if (outfile && outfile != stdout)
- fclose(outfile);
-
- if (opt_output_file && default_output_format) {
- 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);
- }
-
- g_array_free(logic_probelist, TRUE);
- if (o->format->cleanup)
- o->format->cleanup(o);
- g_free(o);
- o = NULL;
+#endif
break;
case SR_DF_META:
switch (src->key) {
case SR_CONF_SAMPLERATE:
samplerate = (uint64_t *)src->value;
- g_debug("cli: got samplerate %"PRIu64, *samplerate);
+ g_debug("cli: got samplerate %"PRIu64" Hz", *samplerate);
+ break;
+ case SR_CONF_SAMPLE_INTERVAL:
+ samplerate = (uint64_t *)src->value;
+ g_debug("cli: got sample interval %"PRIu64" ms", *samplerate);
break;
default:
/* Unknown metadata is not an error. */
g_byte_array_append(savebuf, filter_out, filter_out_len);
} else {
if (opt_pds) {
+#ifdef HAVE_SRD
if (srd_session_send(received_samples, (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)
}
}
+ /* SR_DF_END needs to be handled after the output module's recv()
+ * 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) {
+ 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, 10);
+ 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, 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.
*/
static int register_pds(struct sr_dev *dev, const char *pdstring)
{
- GHashTable *pd_opthash;
+ 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);
pd_name = NULL;
- pd_opthash = 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);
- goto err_out;
+ break;
}
pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
if (srd_decoder_load(pd_name) != SRD_OK) {
g_critical("Failed to load protocol decoder %s.", pd_name);
ret = 1;
- goto err_out;
+ 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(pd_name, pd_opthash))) {
+
+ if (!(di = srd_inst_new(pd_name, options))) {
g_critical("Failed to instantiate protocol decoder %s.", pd_name);
ret = 1;
- goto err_out;
+ break;
}
/* If no annotation list was specified, add them all in now.
g_hash_table_insert(pd_ann_visible,
g_strdup(di->inst_id), NULL);
- /* Any keys left in the options hash are probes, where the key
- * is the probe name as specified in the decoder class, and the
- * value is the probe number i.e. the order in which the PD's
- * incoming samples are arranged. */
- if (srd_inst_probe_set_all(di, pd_opthash) != SRD_OK) {
+ /* Remap the probes if needed. */
+ if (srd_inst_probe_set_all(di, probes) != SRD_OK) {
ret = 1;
- goto err_out;
+ break;
}
- g_hash_table_destroy(pd_opthash);
- pd_opthash = NULL;
}
-err_out:
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 0;
}
+void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
+{
+ int i;
+ char **annotations;
+ gpointer ann_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;
+
+ if (pdata->ann_format != GPOINTER_TO_INT(ann_format))
+ /* We don't want this particular format from the PD. */
+ return;
+
+ annotations = pdata->data;
+ if (opt_loglevel > SR_LOG_WARN)
+ printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
+ printf("%s: ", pdata->pdo->proto_id);
+ for (i = 0; annotations[i]; i++)
+ printf("\"%s\" ", annotations[i]);
+ printf("\n");
+ fflush(stdout);
+}
+#endif
+
int setup_output_format(void)
{
GHashTable *fmtargs;
return 0;
}
-void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
-{
- int i;
- char **annotations;
- gpointer ann_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;
-
- if (pdata->ann_format != GPOINTER_TO_INT(ann_format))
- /* We don't want this particular format from the PD. */
- return;
-
- annotations = pdata->data;
- if (opt_loglevel > SR_LOG_WARN)
- printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
- printf("%s: ", pdata->pdo->proto_id);
- for (i = 0; annotations[i]; i++)
- printf("\"%s\" ", annotations[i]);
- printf("\n");
- fflush(stdout);
-}
-
static int select_probes(struct sr_dev_inst *sdi)
{
struct sr_probe *probe;
return SR_OK;
}
+static void set_options(void)
+{
+ struct sr_dev_inst *sdi;
+ GSList *devices;
+ GHashTable *devargs;
+
+ if (!opt_dev) {
+ g_critical("No setting specified.");
+ return;
+ }
+
+ if (!(devargs = parse_generic_arg(opt_dev, FALSE)))
+ return;
+
+ if (!(devices = device_scan())) {
+ g_critical("No devices found.");
+ return;
+ }
+ sdi = devices->data;
+
+ sr_session_new();
+ if (sr_session_dev_add(sdi) != SR_OK) {
+ g_critical("Failed to use device.");
+ return;
+ }
+
+ set_dev_options(sdi, devargs);
+
+ sr_session_destroy();
+ g_slist_free(devices);
+ g_hash_table_destroy(devargs);
+
+}
+
static int set_limit_time(const struct sr_dev_inst *sdi)
{
uint64_t time_msec;
uint64_t *samplerate;
- time_msec = sr_parse_timestring(opt_time);
- if (time_msec == 0) {
+ if (!(time_msec = sr_parse_timestring(opt_time))) {
g_critical("Invalid time '%s'", opt_time);
- sr_session_destroy();
return SR_ERR;
}
if (sr_dev_has_option(sdi, SR_CONF_LIMIT_MSEC)) {
if (sr_config_set(sdi, SR_CONF_LIMIT_MSEC, &time_msec) != SR_OK) {
g_critical("Failed to configure time limit.");
- sr_session_destroy();
return SR_ERR;
}
- }
- else {
- /* time limit set, but device doesn't support this...
- * convert to samples based on the samplerate.
- */
- limit_samples = 0;
- if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
- sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
- (const void **)&samplerate, sdi);
- limit_samples = (*samplerate) * time_msec / (uint64_t)1000;
- }
+ } else if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
+ /* Convert to samples based on the samplerate. */
+ sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
+ (const void **)&samplerate, sdi);
+ limit_samples = (*samplerate) * time_msec / (uint64_t)1000;
if (limit_samples == 0) {
g_critical("Not enough time at this samplerate.");
- sr_session_destroy();
return SR_ERR;
}
-
if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES,
&limit_samples) != SR_OK) {
g_critical("Failed to configure time-based sample limit.");
- sr_session_destroy();
return SR_ERR;
}
+ } else {
+ g_critical("This device does not support time limits.");
+ return SR_ERR;
}
return SR_OK;
if (sr_log_loglevel_set(opt_loglevel) != SR_OK)
goto done;
- /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
- if (srd_log_loglevel_set(opt_loglevel) != SRD_OK)
+ if (sr_init(&sr_ctx) != SR_OK)
goto done;
- if (sr_init(&sr_ctx) != SR_OK)
+#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 (setup_pd_annotations() != 0)
goto done;
}
+#endif
if (setup_output_format() != 0)
goto done;
show_version();
else if (opt_list_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
printf("%s", g_option_context_get_help(context, TRUE, NULL));
+#ifdef HAVE_SRD
if (opt_pds)
srd_exit();
+#endif
ret = 0;
projects / sigrok-cli.git / blobdiff