]> sigrok.org Git - sigrok-cli.git/blobdiff - show.c
doc: update sigrok-cli(1) for channel assignment to decoder inputs
[sigrok-cli.git] / show.c
diff --git a/show.c b/show.c
index 54b367c909a98046d11d25b8dc34cb53e6bf73ed..85b440989212f04d2480f68bb242c155117c5b0f 100644 (file)
--- a/show.c
+++ b/show.c
 #include <string.h>
 #include "sigrok-cli.h"
 
+#define DECODERS_HAVE_TAGS \
+       ((SRD_PACKAGE_VERSION_MAJOR > 0) || \
+        (SRD_PACKAGE_VERSION_MAJOR == 0) && (SRD_PACKAGE_VERSION_MINOR > 5))
+
 static gint sort_inputs(gconstpointer a, gconstpointer b)
 {
        return strcmp(sr_input_id_get((struct sr_input_module *)a),
@@ -57,6 +61,70 @@ static gint sort_pds(gconstpointer a, gconstpointer b)
 #endif
 
 void show_version(void)
+{
+       GString *s;
+       GSList *l, *l_orig, *m;
+       char *str;
+       const char *lib, *version;
+
+       printf("sigrok-cli %s\n\n", SC_PACKAGE_VERSION_STRING);
+
+       printf("Libraries and features:\n");
+
+       printf("- libsigrok %s/%s (rt: %s/%s).\n",
+               SR_PACKAGE_VERSION_STRING, SR_LIB_VERSION_STRING,
+               sr_package_version_string_get(), sr_lib_version_string_get());
+
+       s = g_string_sized_new(200);
+       g_string_append(s, " - Libs:\n");
+       l_orig = sr_buildinfo_libs_get();
+       for (l = l_orig; l; l = l->next) {
+               m = l->data;
+               lib = m->data;
+               version = m->next->data;
+               g_string_append_printf(s, "  - %s %s\n", lib, version);
+               g_slist_free_full(m, g_free);
+       }
+       g_slist_free(l_orig);
+       s->str[s->len - 1] = '\0';
+       printf("%s\n", s->str);
+       g_string_free(s, TRUE);
+
+       str = sr_buildinfo_host_get();
+       printf("  - Host: %s.\n", str);
+       g_free(str);
+
+       str = sr_buildinfo_scpi_backends_get();
+       printf("  - SCPI backends: %s.\n", str);
+       g_free(str);
+
+#ifdef HAVE_SRD
+       printf("- libsigrokdecode %s/%s (rt: %s/%s).\n",
+               SRD_PACKAGE_VERSION_STRING, SRD_LIB_VERSION_STRING,
+               srd_package_version_string_get(), srd_lib_version_string_get());
+
+       s = g_string_sized_new(200);
+       g_string_append(s, " - Libs:\n");
+       l_orig = srd_buildinfo_libs_get();
+       for (l = l_orig; l; l = l->next) {
+               m = l->data;
+               lib = m->data;
+               version = m->next->data;
+               g_string_append_printf(s, "  - %s %s\n", lib, version);
+               g_slist_free_full(m, g_free);
+       }
+       g_slist_free(l_orig);
+       s->str[s->len - 1] = '\0';
+       printf("%s\n", s->str);
+       g_string_free(s, TRUE);
+
+       str = srd_buildinfo_host_get();
+       printf("  - Host: %s.\n", str);
+       g_free(str);
+#endif
+}
+
+void show_supported(void)
 {
        struct sr_dev_driver **drivers, *driver;
        const struct sr_input_module **inputs, *input;
@@ -69,15 +137,6 @@ void show_version(void)
        struct srd_decoder *dec;
 #endif
 
-       printf("sigrok-cli %s\n\n", SC_PACKAGE_VERSION_STRING);
-
-       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(sr_ctx);
        for (sl = NULL, i = 0; drivers[i]; i++)
@@ -149,6 +208,84 @@ void show_version(void)
 #endif
 }
 
+void show_supported_wiki(void)
+{
+#ifndef HAVE_SRD
+       printf("Error, libsigrokdecode support not compiled in.");
+#else
+       const GSList *l;
+       GSList *sl;
+       struct srd_decoder *dec;
+
+       if (srd_init(NULL) != SRD_OK)
+               return;
+
+       srd_decoder_load_all();
+       sl = g_slist_copy((GSList *)srd_decoder_list());
+       sl = g_slist_sort(sl, sort_pds);
+
+       printf("== Supported protocol decoders ==\n\n");
+
+       printf("<!-- Generated via sigrok-cli --list-supported-wiki. -->\n\n");
+
+       printf("Number of currently supported protocol decoders: "
+               "'''%d'''.\n\n", g_slist_length(sl));
+
+       printf("{| border=\"0\" style=\"font-size: smaller\" "
+               "class=\"alternategrey sortable sigroktable\"\n"
+               "|-\n!Protocol\n!Tags\n!Input IDs\n!Output IDs\n!Status\n"
+               "!Full name\n!Description\n\n");
+
+       for (l = sl; l; l = l->next) {
+               dec = l->data;
+
+#if DECODERS_HAVE_TAGS
+               GString *tags = g_string_new(NULL);
+               for (GSList *t = dec->tags; t; t = t->next)
+                       g_string_append_printf(tags, "%s, ", (char *)t->data);
+               if (tags->len != 0)
+                       g_string_truncate(tags, tags->len - 2);
+#endif
+
+               GString *in = g_string_new(NULL);
+               for (GSList *t = dec->inputs; t; t = t->next)
+                       g_string_append_printf(in, "%s, ", (char *)t->data);
+               if (in->len == 0)
+                       g_string_append_printf(in, "&mdash;");
+               else
+                       g_string_truncate(in, in->len - 2);
+
+               GString *out = g_string_new(NULL);
+               for (GSList *t = dec->outputs; t; t = t->next)
+                       g_string_append_printf(out, "%s, ", (char *)t->data);
+               if (out->len == 0)
+                       g_string_append_printf(out, "&mdash;");
+               else
+                       g_string_truncate(out, out->len - 2);
+
+#if DECODERS_HAVE_TAGS
+               printf("{{pd|%s|%s|%s|%s|%s|%s|%s|supported}}\n",
+                       dec->id, dec->name, dec->longname, dec->desc,
+                       tags->str, in->str, out->str);
+#else
+               printf("{{pd|%s|%s|%s|%s|%s|%s|supported}}\n",
+                       dec->id, dec->name, dec->longname, dec->desc,
+                       in->str, out->str);
+#endif
+
+#if DECODERS_HAVE_TAGS
+               g_string_free(tags, TRUE);
+#endif
+               g_string_free(in, TRUE);
+               g_string_free(out, TRUE);
+       }
+       g_slist_free(sl);
+       srd_exit();
+
+       printf("\n|}\n");
+#endif
+}
+
 static gint sort_channels(gconstpointer a, gconstpointer b)
 {
        const struct sr_channel *pa = a, *pb = b;
@@ -163,12 +300,13 @@ static void print_dev_line(const struct sr_dev_inst *sdi)
        GString *s;
        GVariant *gvar;
        struct sr_dev_driver *driver;
-       const char *vendor, *model, *version;
+       const char *vendor, *model, *version, *sernum;
 
        driver = sr_dev_inst_driver_get(sdi);
        vendor = sr_dev_inst_vendor_get(sdi);
        model = sr_dev_inst_model_get(sdi);
        version = sr_dev_inst_version_get(sdi);
+       sernum = sr_dev_inst_sernum_get(sdi);
        channels = sr_dev_inst_channels_get(sdi);
 
        s = g_string_sized_new(128);
@@ -185,6 +323,8 @@ static void print_dev_line(const struct sr_dev_inst *sdi)
                g_string_append_printf(s, "%s ", model);
        if (version && version[0])
                g_string_append_printf(s, "%s ", version);
+       if (sernum && sernum[0])
+               g_string_append_printf(s, "[S/N: %s] ", sernum);
        if (channels) {
                if (g_slist_length(channels) == 1) {
                        ch = channels->data;
@@ -266,7 +406,9 @@ void show_dev_detail(void)
        GVariant *gvar_dict, *gvar_list, *gvar;
        gsize num_elements;
        double dlow, dhigh, dcur_low, dcur_high;
-       const uint64_t *uint64, p, q, low, high;
+       const uint64_t *uint64;
+       uint64_t cur_rate, rate;
+       uint64_t p = 0, q = 0, low = 0, high = 0;
        uint64_t tmp_uint64, mask, cur_low, cur_high, cur_p, cur_q;
        GArray *opts;
        const int32_t *int32;
@@ -275,6 +417,9 @@ void show_dev_detail(void)
        unsigned int num_devices, i, j;
        char *tmp_str, *s, c;
        const char **stropts;
+       double tmp_flt;
+       gboolean have_tmp_flt, have_curr;
+       const double *fltopts;
 
        if (parse_driver(opt_drv, &driver_from_opt, NULL)) {
                /* A driver was specified, report driver-wide options now. */
@@ -310,7 +455,7 @@ void show_dev_detail(void)
         * returned, or which values for them.
         */
        select_channels(sdi);
-       channel_group = select_channel_group(sdi);
+       channel_group = lookup_channel_group(sdi, NULL);
 
        if (!(opts = sr_dev_options(driver, sdi, channel_group)))
                /* Driver supports no device instance options. */
@@ -320,8 +465,11 @@ void show_dev_detail(void)
                printf("Channel groups:\n");
                for (cgl = channel_groups; cgl; cgl = cgl->next) {
                        cg = cgl->data;
-                       printf("    %s: channel%s", cg->name,
-                                       g_slist_length(cg->channels) > 1 ? "s" : "");
+                       printf("    %s: ", cg->name);
+                       if (g_slist_length(cg->channels) == 0)
+                               printf("No channels");
+                       else
+                               printf("channel%s", g_slist_length(cg->channels) > 1 ? "s" : "");
                        for (chl = cg->channels; chl; chl = chl->next) {
                                ch = chl->data;
                                printf(" %s", ch->name);
@@ -406,6 +554,13 @@ void show_dev_detail(void)
                } else if (key == SR_CONF_SAMPLERATE) {
                        /* Supported samplerates */
                        printf("    %s", srci->id);
+                       cur_rate = ~0ull;
+                       if (maybe_config_get(driver, sdi, channel_group,
+                               SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
+                               if (g_variant_is_of_type(gvar, G_VARIANT_TYPE_UINT64))
+                                       cur_rate = g_variant_get_uint64(gvar);
+                               g_variant_unref(gvar);
+                       }
                        if (maybe_config_list(driver, sdi, channel_group, SR_CONF_SAMPLERATE,
                                        &gvar_dict) != SR_OK) {
                                printf("\n");
@@ -417,9 +572,14 @@ void show_dev_detail(void)
                                                &num_elements, sizeof(uint64_t));
                                printf(" - supported samplerates:\n");
                                for (i = 0; i < num_elements; i++) {
-                                       if (!(s = sr_samplerate_string(uint64[i])))
+                                       rate = uint64[i];
+                                       s = sr_samplerate_string(rate);
+                                       if (!s)
                                                continue;
-                                       printf("      %s\n", s);
+                                       printf("      %s", s);
+                                       if (rate == cur_rate)
+                                               printf(" (current)");
+                                       printf("\n");
                                        g_free(s);
                                }
                                g_variant_unref(gvar_list);
@@ -558,12 +718,11 @@ void show_dev_detail(void)
                                continue;
                        }
 
+                       have_curr = FALSE;
                        if (maybe_config_get(driver, sdi, channel_group, key, &gvar) == SR_OK) {
                                g_variant_get(gvar, "(dd)", &dcur_low, &dcur_high);
                                g_variant_unref(gvar);
-                       } else {
-                               dcur_low = 0;
-                               dcur_high = 0;
+                               have_curr = TRUE;
                        }
 
                        num_elements = g_variant_n_children(gvar_list);
@@ -574,6 +733,8 @@ void show_dev_detail(void)
                                if (i)
                                        printf(", ");
                                printf("%.1f-%.1f", dlow, dhigh);
+                               if (!have_curr)
+                                       continue;
                                if (dlow == dcur_low && dhigh == dcur_high)
                                        printf(" (current)");
                        }
@@ -582,12 +743,34 @@ void show_dev_detail(void)
 
                } else if (srci->datatype == SR_T_FLOAT) {
                        printf("    %s: ", srci->id);
+                       tmp_flt = 0.0;
+                       have_tmp_flt = FALSE;
                        if (maybe_config_get(driver, sdi, channel_group, key,
                                        &gvar) == SR_OK) {
-                               printf("%f\n", g_variant_get_double(gvar));
+                               tmp_flt = g_variant_get_double(gvar);
+                               have_tmp_flt = TRUE;
                                g_variant_unref(gvar);
-                       } else
+                       }
+                       if (maybe_config_list(driver, sdi, channel_group, key,
+                                       &gvar) != SR_OK) {
+                               if (have_tmp_flt) {
+                                       /* Can't list, but got a value to show. */
+                                       printf("%f (current)", tmp_flt);
+                               }
                                printf("\n");
+                               continue;
+                       }
+                       fltopts = g_variant_get_fixed_array(gvar,
+                               &num_elements, sizeof(tmp_flt));
+                       for (i = 0; i < num_elements; i++) {
+                               if (i)
+                                       printf(", ");
+                               printf("%f", fltopts[i]);
+                               if (have_tmp_flt && fltopts[i] == tmp_flt)
+                                       printf(" (current)");
+                       }
+                       printf("\n");
+                       g_variant_unref(gvar);
 
                } else if (srci->datatype == SR_T_RATIONAL_PERIOD
                                || srci->datatype == SR_T_RATIONAL_VOLT) {
@@ -610,7 +793,7 @@ void show_dev_detail(void)
                                gvar = g_variant_get_child_value(gvar_list, i);
                                g_variant_get(gvar, "(tt)", &p, &q);
                                if (srci->datatype == SR_T_RATIONAL_PERIOD)
-                                       s = sr_period_string(p * q);
+                                       s = sr_period_string(p, q);
                                else
                                        s = sr_voltage_string(p, q);
                                printf("      %s", s);
@@ -674,7 +857,7 @@ void show_dev_detail(void)
 }
 
 #ifdef HAVE_SRD
-void show_pd_detail(void)
+static void show_pd_detail_single(const char *pd)
 {
        struct srd_decoder *dec;
        struct srd_decoder_option *o;
@@ -682,9 +865,9 @@ void show_pd_detail(void)
        struct srd_decoder_annotation_row *r;
        GSList *l, *ll, *ol;
        int idx;
-       char **pdtokens, **pdtok, *optsep, **ann, *val, *doc;
+       char **pdtokens, **pdtok, *optsep, **ann, **bin, *val, *doc, *str;
 
-       pdtokens = g_strsplit(opt_pds, ",", -1);
+       pdtokens = g_strsplit(pd, ",", -1);
        for (pdtok = pdtokens; *pdtok; pdtok++) {
                /* Strip options. */
                if ((optsep = strchr(*pdtok, ':')))
@@ -696,6 +879,35 @@ void show_pd_detail(void)
                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("Possible decoder input IDs:\n");
+               if (dec->inputs) {
+                       for (l = dec->inputs; l; l = l->next) {
+                               str = l->data;
+                               printf("- %s\n", str);
+                       }
+               } else {
+                       printf("None.\n");
+               }
+               printf("Possible decoder output IDs:\n");
+               if (dec->outputs) {
+                       for (l = dec->outputs; l; l = l->next) {
+                               str = l->data;
+                               printf("- %s\n", str);
+                       }
+               } else {
+                       printf("None.\n");
+               }
+               printf("Decoder tags:\n");
+#if DECODERS_HAVE_TAGS
+               if (dec->tags) {
+                       for (l = dec->tags; l; l = l->next) {
+                               str = l->data;
+                               printf("- %s\n", str);
+                       }
+               } else {
+                       printf("None.\n");
+               }
+#endif
                printf("Annotation classes:\n");
                if (dec->annotations) {
                        for (l = dec->annotations; l; l = l->next) {
@@ -722,6 +934,15 @@ void show_pd_detail(void)
                } else {
                        printf("None.\n");
                }
+               printf("Binary classes:\n");
+               if (dec->binary) {
+                       for (l = dec->binary; l; l = l->next) {
+                               bin = l->data;
+                               printf("- %s: %s\n", bin[0], bin[1]);
+                       }
+               } else {
+                       printf("None.\n");
+               }
                printf("Required channels:\n");
                if (dec->channels) {
                        for (l = dec->channels; l; l = l->next) {
@@ -768,6 +989,12 @@ void show_pd_detail(void)
 
        g_strfreev(pdtokens);
 }
+
+void show_pd_detail(void)
+{
+       for (int i = 0; opt_pds[i]; i++)
+               show_pd_detail_single(opt_pds[i]);
+}
 #endif
 
 void show_input(void)
@@ -889,3 +1116,25 @@ void show_transform(void)
        }
        g_strfreev(tok);
 }
+
+static void print_serial_port(gpointer data, gpointer user_data)
+{
+       struct sr_serial_port *port;
+
+       port = (void *)data;
+       (void)user_data;
+       printf("  %s\t%s\n", port->name, port->description);
+}
+
+void show_serial_ports(void)
+{
+       GSList *serial_ports;
+
+       serial_ports = sr_serial_list(NULL);
+       if (!serial_ports)
+               return;
+
+       printf("Available serial/HID/BT/BLE ports:\n");
+       g_slist_foreach(serial_ports, print_serial_port, NULL);
+       g_slist_free_full(serial_ports, (GDestroyNotify)sr_serial_free);
+}