* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "sigrok-cli.h"
-#include "config.h"
+#include <config.h>
+#include <stdlib.h>
+#include <string.h>
#include <glib.h>
+#include "sigrok-cli.h"
#ifdef HAVE_SRD
static GHashTable *pd_ann_visible = NULL;
static GHashTable *pd_channel_maps = NULL;
extern struct srd_session *srd_sess;
-extern gint opt_loglevel;
-
static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash,
GHashTable **options)
GSList *optl;
GVariant *gvar;
gint64 val_int;
+ double val_dbl;
int ret;
char *val_str, *conv;
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)) {
+ conv = NULL;
val_int = strtoll(val_str, &conv, 0);
- if (!conv || conv == val_str) {
+ if (!conv || conv == val_str || *conv) {
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 if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_DOUBLE)) {
+ conv = NULL;
+ val_dbl = strtod(val_str, &conv);
+ if (!conv || conv == val_str || *conv) {
+ g_critical("Protocol decoder '%s' option '%s' requires a float number.",
+ dec->name, o->id);
+ ret = FALSE;
+ break;
+ }
+ gvar = g_variant_new_double(val_dbl);
} else {
g_critical("Unsupported type for option '%s' (%s)",
o->id, g_variant_get_type_string(o->def));
return channel_map;
}
-/* 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 *opt_pds, char *opt_pd_annotations)
+static int register_pd(char *opt_pds, char *opt_pd_annotations)
{
+ int ret;
struct srd_decoder *dec;
+ struct srd_decoder_inst *di, *di_prior;
+ char **pdtokens, **pdtok, *pd_name;
GHashTable *pd_opthash, *options, *channels;
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_str_equal,
- g_free, NULL);
ret = 0;
pd_name = NULL;
- pd_opthash = options = channels = pd_channel_maps = NULL;
+ di_prior = NULL;
+ pd_opthash = options = channels = NULL;
+
pdtokens = g_strsplit(opt_pds, ",", 0);
for (pdtok = pdtokens; *pdtok; pdtok++) {
if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) {
ret = 1;
break;
}
- dec = srd_decoder_get_by_id(pd_name);
+ if (!(dec = srd_decoder_get_by_id(pd_name))) {
+ g_critical("Failed to get decoder %s by id.", pd_name);
+ ret = 1;
+ break;
+ }
/* Convert decoder option and channel values to GVariant. */
if (!opts_to_gvar(dec, pd_opthash, &options)) {
* Save the channel setup for later, but only on the
* first decoder (stacked decoders don't get channels).
*/
- pd_channel_maps = g_hash_table_new_full(g_str_hash,
- g_str_equal, g_free, (GDestroyNotify)g_hash_table_destroy);
g_hash_table_insert(pd_channel_maps, g_strdup(di->inst_id), channels);
channels = NULL;
}
- /* If no annotation list was specified, add them all in now.
+ /*
+ * 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),
+ if (!opt_pd_annotations) {
+ g_hash_table_insert(pd_ann_visible, g_strdup(di->decoder->id),
g_slist_append(NULL, GINT_TO_POINTER(-1)));
+ }
+ if (di_prior) {
+ if (srd_inst_stack(srd_sess, di_prior, di) != SRD_OK) {
+ g_critical("Failed to stack %s -> %s.",
+ di_prior->inst_id, di->inst_id);
+ ret = 1;
+ break;
+ }
+ /* Remove annotations from prior levels. */
+ if (!opt_pd_annotations)
+ g_hash_table_remove(pd_ann_visible, di_prior->inst_id);
+ }
+ di_prior = di;
+ g_free(pd_name);
+ g_hash_table_destroy(pd_opthash);
+ g_hash_table_destroy(options);
+ pd_opthash = options = NULL;
}
- g_strfreev(pdtokens);
if (pd_opthash)
g_hash_table_destroy(pd_opthash);
if (options)
g_hash_table_destroy(options);
if (channels)
g_hash_table_destroy(channels);
- if (pd_name)
- g_free(pd_name);
+
+ g_strfreev(pdtokens);
+
+ return ret;
+}
+
+/*
+ * Register all the PDs from all stacks.
+ *
+ * Each PD string is a single stack such as "uart:baudrate=19200,modbus".
+ */
+int register_pds(gchar **all_pds, char *opt_pd_annotations)
+{
+ int ret;
+
+ ret = 0;
+ pd_ann_visible = g_hash_table_new_full(g_str_hash, g_str_equal,
+ g_free, NULL);
+ pd_channel_maps = g_hash_table_new_full(g_str_hash,
+ g_str_equal, g_free, (GDestroyNotify)g_hash_table_destroy);
+
+ for (int i = 0; all_pds[i]; i++)
+ ret += register_pd(all_pds[i], opt_pd_annotations);
return ret;
}
void *channel_target;
struct sr_channel *ch;
GHashTableIter iter;
- int num_channels;
channel_map = value;
channel_list = user_data;
g_hash_table_insert(channel_indices, g_strdup(channel_id), var);
}
- num_channels = g_slist_length(channel_list);
- srd_inst_channel_set_all(di, channel_indices, (num_channels + 7) / 8);
+ srd_inst_channel_set_all(di, channel_indices);
+ g_hash_table_destroy(channel_indices);
}
void map_pd_channels(struct sr_dev_inst *sdi)
{
+ GSList *channels;
+
+ channels = sr_dev_inst_channels_get(sdi);
+
if (pd_channel_maps) {
g_hash_table_foreach(pd_channel_maps, &map_pd_inst_channels,
- sdi->channels);
+ channels);
g_hash_table_destroy(pd_channel_maps);
pd_channel_maps = NULL;
}
}
-int setup_pd_stack(char *opt_pds, char *opt_pd_stack, char *opt_pd_annotations)
-{
- 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(char *opt_pd_annotations)
{
GSList *l, *l_ann;
struct srd_decoder *dec;
int ann_class;
char **pds, **pdtok, **keyval, **annlist, **ann, **ann_descr;
+ const char *dec_id;
+ const char *ann_txt;
+ const char *ann_id;
+ const struct srd_decoder_annotation_row *row_desc;
+ char **ann_diag;
/* 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]);
+ dec_id = keyval[0];
+ if (!(dec = srd_decoder_get_by_id(dec_id))) {
+ g_critical("Protocol decoder '%s' not found.", dec_id);
+ g_strfreev(keyval);
+ g_strfreev(pds);
return 1;
}
if (!dec->annotations) {
- g_critical("Protocol decoder '%s' has no annotations.", keyval[0]);
+ g_critical("Protocol decoder '%s' has no annotations.", dec_id);
+ g_strfreev(keyval);
+ g_strfreev(pds);
return 1;
}
- if (g_strv_length(keyval) == 2 && keyval[1][0] != '\0') {
- annlist = g_strsplit(keyval[1], ":", 0);
+ ann_txt = (g_strv_length(keyval) == 2) ? keyval[1] : NULL;
+ if (ann_txt && *ann_txt) {
+ annlist = g_strsplit(ann_txt, ":", 0);
for (ann = annlist; *ann && **ann; ann++) {
+ ann_id = *ann;
+ g_debug("cli: Lookup decoder %s annotation %s.", dec_id, ann_id);
+ /* Lookup annotation class. */
ann_class = 0;
for (l = dec->annotations; l; l = l->next, ann_class++) {
ann_descr = l->data;
- if (!canon_cmp(ann_descr[0], *ann))
+ if (!canon_cmp(ann_descr[0], ann_id))
/* Found it. */
break;
}
- if (!l) {
- g_critical("Annotation '%s' not found "
- "for protocol decoder '%s'.", *ann, keyval[0]);
- return 1;
+ if (l) {
+ l_ann = g_hash_table_lookup(pd_ann_visible, dec_id);
+ l_ann = g_slist_append(l_ann, GINT_TO_POINTER(ann_class));
+ g_hash_table_replace(pd_ann_visible, g_strdup(dec_id), l_ann);
+ g_debug("cli: Showing protocol decoder %s annotation "
+ "class %d (%s).", dec_id, ann_class, ann_descr[0]);
+ continue;
+ }
+ /* Lookup annotation row. */
+ for (l = dec->annotation_rows; l; l = l->next) {
+ row_desc = l->data;
+ if (!canon_cmp(row_desc->id, ann_id))
+ break;
}
- l_ann = g_hash_table_lookup(pd_ann_visible, keyval[0]);
- l_ann = g_slist_append(l_ann, GINT_TO_POINTER(ann_class));
- g_hash_table_replace(pd_ann_visible, g_strdup(keyval[0]), l_ann);
- g_debug("cli: Showing protocol decoder %s annotation "
- "class %d (%s).", keyval[0], ann_class, ann_descr[0]);
+ if (l) {
+ g_debug("cli: Showing decoder %s annotation row %s (%s).",
+ dec_id, row_desc->id, row_desc->desc);
+ l_ann = g_hash_table_lookup(pd_ann_visible, dec_id);
+ for (l = row_desc->ann_classes; l; l = l->next) {
+ /*
+ * This could just be:
+ * l_ann = g_slist_append(l_ann, l->data);
+ * But we are explicit for readability
+ * and to access details for diagnostics.
+ */
+ ann_class = GPOINTER_TO_INT(l->data);
+ l_ann = g_slist_append(l_ann, GINT_TO_POINTER(ann_class));
+ ann_diag = g_slist_nth_data(dec->annotations, ann_class);
+ g_debug("cli: Adding class %d/%s from row %s.",
+ ann_class, ann_diag[0], row_desc->id);
+ }
+ g_hash_table_replace(pd_ann_visible, g_strdup(dec_id), l_ann);
+ continue;
+ }
+ /* No match found. */
+ g_critical("Annotation '%s' not found "
+ "for protocol decoder '%s'.", ann_id, dec_id);
+ g_strfreev(keyval);
+ g_strfreev(pds);
+ return 1;
}
} else {
/* No class specified: show all of them. */
- g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]),
- g_slist_append(NULL, GINT_TO_POINTER(-1)));
+ ann_class = -1;
+ l_ann = g_slist_append(NULL, GINT_TO_POINTER(ann_class));
+ g_hash_table_insert(pd_ann_visible, g_strdup(dec_id), l_ann);
g_debug("cli: Showing all annotation classes for protocol "
- "decoder %s.", keyval[0]);
+ "decoder %s.", dec_id);
}
g_strfreev(keyval);
}
GSList *ann_list, *l;
int i;
char **ann_descr;
- gboolean show;
+ gboolean show_ann, show_snum, show_class, show_quotes, show_abbrev;
+ const char *quote;
- /* '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, (void **)&ann_list))
+ if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->decoder->id,
+ NULL, (void **)&ann_list)) {
/* Not in the list of PDs whose annotations we're showing. */
return;
+ }
dec = pdata->pdo->di->decoder;
pda = pdata->data;
- show = FALSE;
+ show_ann = FALSE;
for (l = ann_list; l; l = l->next) {
if (GPOINTER_TO_INT(l->data) == -1
- || GPOINTER_TO_INT(l->data) == pda->ann_format) {
- show = TRUE;
+ || GPOINTER_TO_INT(l->data) == pda->ann_class) {
+ show_ann = TRUE;
break;
}
}
- if (!show)
+ if (!show_ann)
return;
- if (opt_loglevel <= SR_LOG_WARN) {
- /* Show only the longest annotation. */
- printf("%s", pda->ann_text[0]);
- } else if (opt_loglevel >= SR_LOG_INFO) {
- /* Sample numbers and quotes around the longest annotation. */
- printf("%"PRIu64"-%"PRIu64"", pdata->start_sample, pdata->end_sample);
- if (opt_loglevel == SR_LOG_INFO) {
- printf(" \"%s\"", pda->ann_text[0]);
- } else {
- /* Protocol decoder id, annotation class,
- * all annotation strings. */
- ann_descr = g_slist_nth_data(dec->annotations, pda->ann_format);
- printf(" %s: %s:", pdata->pdo->proto_id, ann_descr[0]);
- for (i = 0; pda->ann_text[i]; i++)
- printf(" \"%s\"", pda->ann_text[i]);
- }
+ /*
+ * Determine which fields of the annotation to display. Inspect
+ * user specified options as well as the verbosity of the log level:
+ * - Optionally show the sample numbers for the annotation's span.
+ * - Always show the protocol decoder ID.
+ * - Optionally show the annotation's class description.
+ * - Always show the longest annotation text.
+ * - Optionally show alternative annotation text (abbreviations
+ * for different zoom levels).
+ * - Optionally put quote marks around annotation text, when
+ * recipients might have to deal with a set of text variants.
+ */
+ show_snum = show_class = show_quotes = show_abbrev = FALSE;
+ if (opt_pd_samplenum || opt_loglevel > SR_LOG_WARN) {
+ show_snum = TRUE;
+ }
+ if (opt_loglevel > SR_LOG_WARN) {
+ show_quotes = TRUE;
+ }
+ if (opt_loglevel > SR_LOG_INFO) {
+ show_class = TRUE;
+ show_abbrev = TRUE;
+ }
+
+ /*
+ * Display the annotation's fields after the layout was
+ * determined above.
+ */
+ if (show_snum) {
+ printf("%" PRIu64 "-%" PRIu64 " ",
+ pdata->start_sample, pdata->end_sample);
+ }
+ printf("%s: ", pdata->pdo->proto_id);
+ if (show_class) {
+ ann_descr = g_slist_nth_data(dec->annotations, pda->ann_class);
+ printf("%s: ", ann_descr[0]);
+ }
+ quote = show_quotes ? "\"" : "";
+ printf("%s%s%s", quote, pda->ann_text[0], quote);
+ if (show_abbrev) {
+ for (i = 1; pda->ann_text[i]; i++)
+ printf(" %s%s%s", quote, pda->ann_text[i], quote);
}
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,
/* Not in the list of PDs whose meta output we're showing. */
return;
- if (opt_loglevel > SR_LOG_WARN)
+ if (opt_pd_samplenum || 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));
{
struct srd_proto_data_binary *pdb;
gpointer classp;
- int class;
+ int classi;
- /* 'cb_data' is not used in this specific callback. */
(void)cb_data;
if (!g_hash_table_lookup_extended(pd_binary_visible,
/* Not in the list of PDs whose meta output we're showing. */
return;
- class = GPOINTER_TO_INT(classp);
+ classi = GPOINTER_TO_INT(classp);
pdb = pdata->data;
- if (class != -1 && class != pdb->bin_class)
+ if (classi != -1 && classi != pdb->bin_class)
/* Not showing this binary class. */
return;
fflush(stdout);
}
#endif
-
projects / sigrok-cli.git / blobdiff