]> sigrok.org Git - sigrok-cli.git/blobdiff - sigrok-cli.c
Show only one output type at the same time.
[sigrok-cli.git] / sigrok-cli.c
index 61cd1e4bf37aebb3acc4e16955bef6fbe93cf936..ac84e1d2144fb5e211f687629e336140b83250df 100644 (file)
@@ -48,6 +48,8 @@ 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;
 
@@ -60,11 +62,14 @@ 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;
@@ -94,6 +99,8 @@ static GOptionEntry optargs[] = {
                        "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,
@@ -105,6 +112,10 @@ static GOptionEntry optargs[] = {
                        "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},
@@ -151,6 +162,29 @@ static GSList *hash_to_hwopt(GHashTable *hash)
        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);
@@ -336,7 +370,9 @@ static void show_dev_detail(void)
 {
        struct sr_dev_inst *sdi;
        const struct sr_config_info *srci;
-       GSList *devices;
+       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;
@@ -380,19 +416,41 @@ static void show_dev_detail(void)
                g_variant_unref(gvar_opts);
        }
 
-       if ((sr_config_list(sdi->driver, sdi, NULL, SR_CONF_DEVICE_OPTIONS,
-                       &gvar_opts) != SR_OK))
+       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;
 
-       printf("Supported configuration options:\n");
+       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, NULL, srci->key,
+                       if (sr_config_list(sdi->driver, sdi, probe_group, srci->key,
                                        &gvar) != SR_OK) {
                                printf("\n");
                                continue;
@@ -409,7 +467,7 @@ static void show_dev_detail(void)
                } else if (srci->key == SR_CONF_PATTERN_MODE) {
                        /* Pattern generator modes */
                        printf("    %s", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, NULL, srci->key,
+                       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);
@@ -423,7 +481,7 @@ static void show_dev_detail(void)
                } else if (srci->key == SR_CONF_SAMPLERATE) {
                        /* Supported samplerates */
                        printf("    %s", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE,
+                       if (sr_config_list(sdi->driver, sdi, probe_group, SR_CONF_SAMPLERATE,
                                        &gvar_dict) != SR_OK) {
                                printf("\n");
                                continue;
@@ -466,7 +524,7 @@ static void show_dev_detail(void)
                } else if (srci->key == SR_CONF_BUFFERSIZE) {
                        /* Supported buffer sizes */
                        printf("    %s", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, NULL,
+                       if (sr_config_list(sdi->driver, sdi, probe_group,
                                        SR_CONF_BUFFERSIZE, &gvar_list) != SR_OK) {
                                printf("\n");
                                continue;
@@ -481,7 +539,7 @@ static void show_dev_detail(void)
                } else if (srci->key == SR_CONF_TIMEBASE) {
                        /* Supported time bases */
                        printf("    %s", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, NULL,
+                       if (sr_config_list(sdi->driver, sdi, probe_group,
                                        SR_CONF_TIMEBASE, &gvar_list) != SR_OK) {
                                printf("\n");
                                continue;
@@ -500,7 +558,7 @@ static void show_dev_detail(void)
                } else if (srci->key == SR_CONF_VDIV) {
                        /* Supported volts/div values */
                        printf("    %s", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, NULL,
+                       if (sr_config_list(sdi->driver, sdi, probe_group,
                                        SR_CONF_VDIV, &gvar_list) != SR_OK) {
                                printf("\n");
                                continue;
@@ -518,14 +576,14 @@ static void show_dev_detail(void)
 
                } else if (srci->datatype == SR_T_CHAR) {
                        printf("    %s: ", srci->id);
-                       if (sr_config_get(sdi->driver, sdi, NULL, srci->key,
+                       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, NULL, srci->key,
+                       if (sr_config_list(sdi->driver, sdi, probe_group, srci->key,
                                        &gvar) != SR_OK) {
                                printf("\n");
                                continue;
@@ -546,7 +604,7 @@ static void show_dev_detail(void)
 
                } else if (srci->datatype == SR_T_UINT64_RANGE) {
                        printf("    %s: ", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, NULL, srci->key,
+                       if (sr_config_list(sdi->driver, sdi, probe_group, srci->key,
                                        &gvar_list) != SR_OK) {
                                printf("\n");
                                continue;
@@ -1072,9 +1130,9 @@ static int register_pds(struct sr_dev *dev, const char *pdstring)
 
        (void)dev;
 
-       ret = 0;
        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);
@@ -1122,7 +1180,7 @@ static int register_pds(struct sr_dev *dev, const char *pdstring)
                 */
                if (!opt_pd_annotations)
                        g_hash_table_insert(pd_ann_visible,
-                                           g_strdup(di->inst_id), NULL);
+                                           g_strdup(di->inst_id), GINT_TO_POINTER(-1));
 
                /* Remap the probes if needed. */
                if (srd_inst_probe_set_all(di, probes) != SRD_OK) {
@@ -1207,51 +1265,125 @@ int setup_pd_annotations(void)
 {
        GSList *l;
        struct srd_decoder *dec;
-       int ann;
+       int ann_class;
        char **pds, **pdtok, **keyval, **ann_descr;
 
        /* Set up custom list of PDs and annotations to show. */
-       if (opt_pd_annotations) {
-               pds = g_strsplit(opt_pd_annotations, ",", 0);
-               for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
-                       ann = 0;
-                       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;
+       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 (!dec->annotations) {
-                               g_critical("Protocol decoder '%s' has no annotations.", keyval[0]);
+                       if (!l) {
+                               g_critical("Annotation '%s' not found "
+                                               "for protocol decoder '%s'.", keyval[1], keyval[0]);
                                return 1;
                        }
-                       if (g_strv_length(keyval) == 2) {
-                               for (l = dec->annotations; l; l = l->next, ann++) {
-                                       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;
                        }
-                       g_debug("cli: showing protocol decoder annotation %d from '%s'", ann, keyval[0]);
-                       g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann));
-                       g_strfreev(keyval);
+                       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_strfreev(pds);
+               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)
 {
-       int i;
-       char **annotations;
+       struct srd_proto_data_annotation *pda;
        gpointer ann_format;
+       int format;
 
        /* 'cb_data' is not used in this specific callback. */
        (void)cb_data;
@@ -1264,19 +1396,64 @@ void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
                /* Not in the list of PDs whose annotations we're showing. */
                return;
 
-       if (pdata->ann_format != GPOINTER_TO_INT(ann_format))
+       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;
 
-       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]);
+       /* 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)
@@ -1495,6 +1672,7 @@ static void load_input_file(void)
 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;
@@ -1564,8 +1742,10 @@ static int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
                default:
                        ret = SR_ERR;
                }
-               if (val)
-                       ret = sr_config_set(sdi, NULL, srci->key, val);
+               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;
@@ -1835,13 +2015,30 @@ int main(int argc, char **argv)
                }
                if (register_pds(NULL, opt_pds) != 0)
                        goto done;
-               if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_ANN,
-                               show_pd_annotations, NULL) != SRD_OK)
-                       goto done;
                if (setup_pd_stack() != 0)
                        goto done;
-               if (setup_pd_annotations() != 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