]> sigrok.org Git - sigrok-cli.git/blobdiff - decode.c
HACKING: Update URL to Linux kernel coding style.
[sigrok-cli.git] / decode.c
index 0b7d9ee49e200cf6b8fa4010f9f869cdbe209772..2bcc0ae13f53306a2743abc7e692695523a5eff9 100644 (file)
--- a/decode.c
+++ b/decode.c
  * 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_meta_visible = NULL;
 static GHashTable *pd_binary_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)
@@ -74,63 +75,54 @@ static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash,
        return ret;
 }
 
-static int probes_to_gvar(struct srd_decoder *dec, GHashTable *hash,
-               GHashTable **probes)
+static int move_hash_element(GHashTable *src, GHashTable *dest, void *key)
 {
-       struct srd_probe *p;
-       GSList *all_probes, *l;
-       GVariant *gvar;
-       gint32 val_int;
-       int ret;
-       char *val_str, *conv;
+       void *orig_key, *value;
 
-       ret = TRUE;
-       *probes = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
-                       (GDestroyNotify)g_variant_unref);
+       if (!g_hash_table_lookup_extended(src, key, &orig_key, &value))
+               /* Not specified. */
+               return FALSE;
+       g_hash_table_steal(src, orig_key);
+       g_hash_table_insert(dest, orig_key, value);
 
-       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);
+       return TRUE;
+}
+
+static GHashTable *extract_channel_map(struct srd_decoder *dec, GHashTable *hash)
+{
+       GHashTable *channel_map;
+       struct srd_channel *pdch;
+       GSList *l;
+
+       channel_map = g_hash_table_new_full(g_str_hash, g_str_equal,
+                                         g_free, g_free);
+
+       for (l = dec->channels; l; l = l->next) {
+               pdch = l->data;
+               move_hash_element(hash, channel_map, pdch->id);
+       }
+       for (l = dec->opt_channels; l; l = l->next) {
+               pdch = l->data;
+               move_hash_element(hash, channel_map, pdch->id);
        }
-       g_slist_free(all_probes);
 
-       return ret;
+       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)
 {
-       struct srd_decoder *dec;
-       GHashTable *pd_opthash, *options, *probes;
-       GList *leftover, *l;
-       struct srd_decoder_inst *di;
        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;
 
-       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;
+       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))) {
@@ -145,21 +137,23 @@ int register_pds(const char *opt_pds, char *opt_pd_annotations)
                        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)) {
+               if (!(dec = srd_decoder_get_by_id(pd_name))) {
+                       g_critical("Failed to get decoder %s by id.", pd_name);
                        ret = 1;
                        break;
                }
-               if (!probes_to_gvar(dec, pd_opthash, &probes)) {
+
+               /* Convert decoder option and channel values to GVariant. */
+               if (!opts_to_gvar(dec, pd_opthash, &options)) {
                        ret = 1;
                        break;
                }
+               channels = extract_channel_map(dec, pd_opthash);
+
                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_critical("Unknown option or channel '%s'", (char *)l->data);
                        g_list_free(leftover);
                        break;
                }
@@ -170,99 +164,140 @@ int register_pds(const char *opt_pds, char *opt_pd_annotations)
                        break;
                }
 
-               /* If no annotation list was specified, add them all in now.
+               if (pdtok == pdtokens) {
+                       /*
+                        * Save the channel setup for later, but only on the
+                        * first decoder (stacked decoders don't get channels).
+                        */
+                       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.
                 * 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, (g_hash_table_size(probes) + 7) / 8) != SRD_OK) {
-                       ret = 1;
-                       break;
+               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 (probes)
-               g_hash_table_destroy(probes);
-       if (pd_name)
-               g_free(pd_name);
+       if (channels)
+               g_hash_table_destroy(channels);
+
+       g_strfreev(pdtokens);
 
        return ret;
 }
 
-int setup_pd_stack(char *opt_pds, char *opt_pd_stack, char *opt_pd_annotations)
+/*
+ * 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)
 {
-       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;
-                       }
-               }
+       int ret;
 
-               /* 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;
+       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);
 
-                       /* 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);
+       for (int i = 0; all_pds[i]; i++)
+               ret += register_pd(all_pds[i], opt_pd_annotations);
+
+       return ret;
+}
 
-                       di_from = di_to;
+static void map_pd_inst_channels(void *key, void *value, void *user_data)
+{
+       GHashTable *channel_map;
+       GHashTable *channel_indices;
+       GSList *channel_list;
+       struct srd_decoder_inst *di;
+       GVariant *var;
+       void *channel_id;
+       void *channel_target;
+       struct sr_channel *ch;
+       GHashTableIter iter;
+
+       channel_map = value;
+       channel_list = user_data;
+
+       di = srd_inst_find_by_id(srd_sess, key);
+       if (!di) {
+               g_critical("Protocol decoder instance \"%s\" not found.",
+                          (char *)key);
+               return;
+       }
+       channel_indices = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
+                                             (GDestroyNotify)g_variant_unref);
+
+       g_hash_table_iter_init(&iter, channel_map);
+       while (g_hash_table_iter_next(&iter, &channel_id, &channel_target)) {
+               ch = find_channel(channel_list, channel_target);
+               if (!ch) {
+                       g_printerr("cli: No channel with name \"%s\" found.\n",
+                                  (char *)channel_target);
+                       continue;
                }
+               if (!ch->enabled)
+                       g_printerr("cli: Target channel \"%s\" not enabled.\n",
+                                  (char *)channel_target);
+
+               var = g_variant_new_int32(ch->index);
+               g_variant_ref_sink(var);
+               g_hash_table_insert(channel_indices, g_strdup(channel_id), var);
        }
-       g_strfreev(pds);
 
-       return 0;
+       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,
+                                    channels);
+               g_hash_table_destroy(pd_channel_maps);
+               pd_channel_maps = NULL;
+       }
 }
 
 int setup_pd_annotations(char *opt_pd_annotations)
 {
-       GSList *l;
+       GSList *l, *l_ann;
        struct srd_decoder *dec;
        int ann_class;
-       char **pds, **pdtok, **keyval, **ann_descr;
+       char **pds, **pdtok, **keyval, **annlist, **ann, **ann_descr;
 
        /* Set up custom list of PDs and annotations to show. */
        pds = g_strsplit(opt_pd_annotations, ",", 0);
@@ -276,28 +311,34 @@ int setup_pd_annotations(char *opt_pd_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;
+               if (g_strv_length(keyval) == 2 && keyval[1][0] != '\0') {
+                       annlist = g_strsplit(keyval[1], ":", 0);
+                       for (ann = annlist; *ann && **ann; ann++) {
+                               ann_class = 0;
+                               for (l = dec->annotations; l; l = l->next, ann_class++) {
+                                       ann_descr = l->data;
+                                       if (!canon_cmp(ann_descr[0], *ann))
+                                               /* Found it. */
+                                               break;
+                               }
+                               if (!l) {
+                                       g_critical("Annotation '%s' not found "
+                                                       "for protocol decoder '%s'.", *ann, keyval[0]);
+                                       return 1;
+                               }
+                               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]);
                        }
-                       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_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]),
+                                               g_slist_append(NULL, GINT_TO_POINTER(-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);
@@ -379,40 +420,47 @@ void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
 {
        struct srd_decoder *dec;
        struct srd_proto_data_annotation *pda;
-       gpointer ann_format;
-       int format, i;
+       GSList *ann_list, *l;
+       int i;
        char **ann_descr;
+       gboolean show;
 
-       /* '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))
+       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;
+       }
 
-       format = GPOINTER_TO_INT(ann_format);
        dec = pdata->pdo->di->decoder;
        pda = pdata->data;
-       if (format != -1 && pda->ann_format != format)
-               /* We don't want this particular format from the PD. */
+       show = FALSE;
+       for (l = ann_list; l; l = l->next) {
+               if (GPOINTER_TO_INT(l->data) == -1
+                               || GPOINTER_TO_INT(l->data) == pda->ann_class) {
+                       show = TRUE;
+                       break;
+               }
+       }
+       if (!show)
                return;
 
        if (opt_loglevel <= SR_LOG_WARN) {
                /* Show only the longest annotation. */
-               printf("%s", pda->ann_text[0]);
+               printf("%s: %s", pdata->pdo->proto_id, 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]);
+                       printf(" %s \"%s\"", pdata->pdo->proto_id, pda->ann_text[0]);
                } else {
                        /* Protocol decoder id, annotation class,
                         * all annotation strings. */
-                       ann_descr = g_slist_nth_data(dec->annotations, pda->ann_format);
+                       ann_descr = g_slist_nth_data(dec->annotations, pda->ann_class);
                        printf(" %s: %s:", pdata->pdo->proto_id, ann_descr[0]);
                        for (i = 0; pda->ann_text[i]; i++)
                                printf(" \"%s\"", pda->ann_text[i]);
@@ -424,8 +472,6 @@ void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
 
 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,
@@ -447,7 +493,6 @@ void show_pd_binary(struct srd_proto_data *pdata, void *cb_data)
        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,
@@ -466,4 +511,3 @@ void show_pd_binary(struct srd_proto_data *pdata, void *cb_data)
        fflush(stdout);
 }
 #endif
-