]> sigrok.org Git - sigrok-cli.git/blobdiff - show.c
Add -T|--transform-module and show transform modules in -V output.
[sigrok-cli.git] / show.c
diff --git a/show.c b/show.c
index c040078c6082d2621608de03d1f1daa9ad1ea6ce..a5999a2b434d37a93c2f57de57a1f1f996aac5ea 100644 (file)
--- a/show.c
+++ b/show.c
@@ -33,6 +33,12 @@ static gint sort_outputs(gconstpointer a, gconstpointer b)
                        sr_output_id_get((struct sr_output_module *)b));
 }
 
+static gint sort_transforms(gconstpointer a, gconstpointer b)
+{
+       return strcmp(sr_transform_id_get((struct sr_transform_module *)a),
+                       sr_transform_id_get((struct sr_transform_module *)b));
+}
+
 static gint sort_drivers(gconstpointer a, gconstpointer b)
 {
        const struct sr_dev_driver *sdda = a, *sddb = b;
@@ -54,6 +60,7 @@ void show_version(void)
        struct sr_dev_driver **drivers, *driver;
        const struct sr_input_module **inputs, *input;
        const struct sr_output_module **outputs, *output;
+       const struct sr_transform_module **transforms, *transform;
        const GSList *l;
        GSList *sl;
        int i;
@@ -108,6 +115,19 @@ void show_version(void)
        printf("\n");
        g_slist_free(sl);
 
+       printf("Supported transform modules:\n");
+       transforms = sr_transform_list();
+       for (sl = NULL, i = 0; transforms[i]; i++)
+               sl = g_slist_append(sl, (gpointer)transforms[i]);
+       sl = g_slist_sort(sl, sort_transforms);
+       for (l = sl; l; l = l->next) {
+               transform = l->data;
+               printf("  %-20s %s\n", sr_transform_id_get(transform),
+                               sr_transform_description_get(transform));
+       }
+       printf("\n");
+       g_slist_free(sl);
+
 #ifdef HAVE_SRD
        if (srd_init(NULL) == SRD_OK) {
                printf("Supported protocol decoders:\n");
@@ -138,30 +158,38 @@ static gint sort_channels(gconstpointer a, gconstpointer b)
 static void print_dev_line(const struct sr_dev_inst *sdi)
 {
        struct sr_channel *ch;
-       GSList *sl, *l;
+       GSList *sl, *l, *channels;
        GString *s;
        GVariant *gvar;
+       struct sr_dev_driver *driver;
+       const char *vendor, *model, *version;
+
+       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);
+       channels = sr_dev_inst_channels_get(sdi);
 
        s = g_string_sized_new(128);
-       g_string_assign(s, sdi->driver->name);
-       if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_CONN, &gvar) == SR_OK) {
+       g_string_assign(s, driver->name);
+       if (maybe_config_get(driver, sdi, NULL, SR_CONF_CONN, &gvar) == SR_OK) {
                g_string_append(s, ":conn=");
                g_string_append(s, g_variant_get_string(gvar, NULL));
                g_variant_unref(gvar);
        }
        g_string_append(s, " - ");
-       if (sdi->vendor && sdi->vendor[0])
-               g_string_append_printf(s, "%s ", sdi->vendor);
-       if (sdi->model && sdi->model[0])
-               g_string_append_printf(s, "%s ", sdi->model);
-       if (sdi->version && sdi->version[0])
-               g_string_append_printf(s, "%s ", sdi->version);
-       if (sdi->channels) {
-               if (g_slist_length(sdi->channels) == 1) {
-                       ch = sdi->channels->data;
+       if (vendor && vendor[0])
+               g_string_append_printf(s, "%s ", vendor);
+       if (model && model[0])
+               g_string_append_printf(s, "%s ", model);
+       if (version && version[0])
+               g_string_append_printf(s, "%s ", version);
+       if (channels) {
+               if (g_slist_length(channels) == 1) {
+                       ch = channels->data;
                        g_string_append_printf(s, "with 1 channel: %s", ch->name);
                } else {
-                       sl = g_slist_sort(g_slist_copy(sdi->channels), sort_channels);
+                       sl = g_slist_sort(g_slist_copy(channels), sort_channels);
                        g_string_append_printf(s, "with %d channels:", g_slist_length(sl));
                        for (l = sl; l; l = l->next) {
                                ch = l->data;
@@ -193,18 +221,57 @@ void show_dev_list(void)
 
 }
 
+void show_drv_detail(struct sr_dev_driver *driver)
+{
+       const struct sr_config_info *srci;
+       GVariant *gvar_opts;
+       const uint32_t *opts;
+       gsize num_elements, i;
+
+       if (sr_config_list(driver, NULL, NULL, SR_CONF_DEVICE_OPTIONS,
+                       &gvar_opts) == SR_OK) {
+               opts = g_variant_get_fixed_array(gvar_opts, &num_elements,
+                               sizeof(uint32_t));
+               if (num_elements) {
+                       printf("Driver functions:\n");
+                       for (i = 0; i < num_elements; i++) {
+                               if (!(srci = sr_config_info_get(opts[i] & SR_CONF_MASK)))
+                                       continue;
+                               printf("    %s\n", srci->name);
+                       }
+               }
+               g_variant_unref(gvar_opts);
+       }
+
+       if (sr_config_list(driver, NULL, NULL, SR_CONF_SCAN_OPTIONS,
+                       &gvar_opts) == SR_OK) {
+               opts = g_variant_get_fixed_array(gvar_opts, &num_elements,
+                               sizeof(uint32_t));
+               if (num_elements) {
+                       printf("Scan options:\n");
+                       for (i = 0; i < num_elements; i++) {
+                               if (!(srci = sr_config_info_get(opts[i] & SR_CONF_MASK)))
+                                       continue;
+                               printf("    %s\n", srci->id);
+                       }
+               }
+               g_variant_unref(gvar_opts);
+       }
+}
+
 void show_dev_detail(void)
 {
+       struct sr_dev_driver *driver_from_opt, *driver;
        struct sr_dev_inst *sdi;
        const struct sr_config_info *srci;
        struct sr_channel *ch;
        struct sr_channel_group *channel_group, *cg;
-       GSList *devices, *cgl, *chl;
+       GSList *devices, *cgl, *chl, *channel_groups;
        GVariant *gvar_opts, *gvar_dict, *gvar_list, *gvar;
        gsize num_opts, num_elements;
        double dlow, dhigh, dcur_low, dcur_high;
        const uint64_t *uint64, p, q, low, high;
-       uint64_t cur_low, cur_high;
+       uint64_t tmp_uint64, cur_low, cur_high, cur_p, cur_q;
        const uint32_t *opts;
        const int32_t *int32;
        uint32_t key, o;
@@ -212,6 +279,11 @@ void show_dev_detail(void)
        char *tmp_str, *s, c;
        const char **stropts;
 
+       if (parse_driver(opt_drv, &driver_from_opt, NULL)) {
+               /* A driver was specified, report driver-wide options now. */
+               show_drv_detail(driver_from_opt);
+       }
+
        if (!(devices = device_scan())) {
                g_critical("No devices found.");
                return;
@@ -228,37 +300,27 @@ void show_dev_detail(void)
        g_slist_free(devices);
        print_dev_line(sdi);
 
+       driver = sr_dev_inst_driver_get(sdi);
+       channel_groups = sr_dev_inst_channel_groups_get(sdi);
+
        if (sr_dev_open(sdi) != SR_OK) {
                g_critical("Failed to open device.");
                return;
        }
 
-       if ((sr_config_list(sdi->driver, NULL, NULL, SR_CONF_SCAN_OPTIONS,
-                       &gvar_opts) == SR_OK)) {
-               opts = g_variant_get_fixed_array(gvar_opts, &num_elements,
-                               sizeof(int32_t));
-               printf("Supported driver options:\n");
-               for (i = 0; i < num_elements; i++) {
-                       if (!(srci = sr_config_info_get(opts[i])))
-                               continue;
-                       printf("    %s\n", srci->id);
-               }
-               g_variant_unref(gvar_opts);
-       }
-
        /* Selected channels and channel group may affect which options are
         * returned, or which values for them. */
        select_channels(sdi);
        channel_group = select_channel_group(sdi);
 
-       if ((sr_config_list(sdi->driver, sdi, channel_group, SR_CONF_DEVICE_OPTIONS,
-                       &gvar_opts)) != SR_OK)
+       if (sr_config_list(driver, sdi, channel_group, SR_CONF_DEVICE_OPTIONS,
+                       &gvar_opts) != SR_OK)
                /* Driver supports no device instance options. */
                return;
 
-       if (sdi->channel_groups) {
+       if (channel_groups) {
                printf("Channel groups:\n");
-               for (cgl = sdi->channel_groups; cgl; cgl = cgl->next) {
+               for (cgl = channel_groups; cgl; cgl = cgl->next) {
                        cg = cgl->data;
                        printf("    %s: channel%s", cg->name,
                                        g_slist_length(cg->channels) > 1 ? "s" : "");
@@ -271,7 +333,7 @@ void show_dev_detail(void)
        }
 
        printf("Supported configuration options");
-       if (sdi->channel_groups) {
+       if (channel_groups) {
                if (!channel_group)
                        printf(" across all channel groups");
                else
@@ -285,7 +347,7 @@ void show_dev_detail(void)
                        continue;
 
                if (key == SR_CONF_TRIGGER_MATCH) {
-                       if (sr_config_list(sdi->driver, sdi, channel_group, key,
+                       if (maybe_config_list(driver, sdi, channel_group, key,
                                        &gvar_list) != SR_OK) {
                                printf("\n");
                                continue;
@@ -326,25 +388,25 @@ void show_dev_detail(void)
                        printf("\n");
                        g_variant_unref(gvar_list);
 
-               } else if (key == SR_CONF_LIMIT_SAMPLES) {
+               } else if (key == SR_CONF_LIMIT_SAMPLES
+                               && config_key_has_cap(driver, sdi, cg, key, SR_CONF_LIST)) {
                        /* If implemented in config_list(), this denotes the
                         * maximum number of samples a device can send. This
                         * really applies only to logic analyzers, and then
                         * only to those that don't support compression, or
                         * have it turned off by default. The values returned
                         * are the low/high limits. */
-                       if (sr_config_list(sdi->driver, sdi, channel_group, key,
-                                       &gvar) != SR_OK) {
-                               continue;
+                       if (sr_config_list(driver, sdi, channel_group, key,
+                                       &gvar) == SR_OK) {
+                               g_variant_get(gvar, "(tt)", &low, &high);
+                               g_variant_unref(gvar);
+                               printf("    Maximum number of samples: %"PRIu64"\n", high);
                        }
-                       g_variant_get(gvar, "(tt)", &low, &high);
-                       g_variant_unref(gvar);
-                       printf("    Maximum number of samples: %"PRIu64"\n", high);
 
                } else if (key == SR_CONF_SAMPLERATE) {
                        /* Supported samplerates */
                        printf("    %s", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, channel_group, SR_CONF_SAMPLERATE,
+                       if (maybe_config_list(driver, sdi, channel_group, SR_CONF_SAMPLERATE,
                                        &gvar_dict) != SR_OK) {
                                printf("\n");
                                continue;
@@ -384,69 +446,45 @@ void show_dev_detail(void)
                        }
                        g_variant_unref(gvar_dict);
 
-               } else if (key == SR_CONF_BUFFERSIZE) {
-                       /* Supported buffer sizes */
-                       printf("    %s", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, channel_group,
-                                       SR_CONF_BUFFERSIZE, &gvar_list) != SR_OK) {
+               } else if (srci->datatype == SR_T_UINT64) {
+                       printf("    %s: ", srci->id);
+                       gvar = NULL;
+                       if (maybe_config_get(driver, sdi, channel_group, key,
+                                       &gvar) == SR_OK) {
+                               tmp_uint64 = g_variant_get_uint64(gvar);
+                               g_variant_unref(gvar);
+                       } else
+                               tmp_uint64 = 0;
+                       if (maybe_config_list(driver, sdi, channel_group,
+                                       key, &gvar_list) != SR_OK) {
+                               if (gvar) {
+                                       /* Can't list it, but we have a value to show. */
+                                       printf("%"PRIu64" (current)", tmp_uint64);
+                               }
                                printf("\n");
                                continue;
                        }
                        uint64 = g_variant_get_fixed_array(gvar_list,
                                        &num_elements, sizeof(uint64_t));
-                       printf(" - supported buffer sizes:\n");
-                       for (i = 0; i < num_elements; i++)
-                               printf("      %"PRIu64"\n", uint64[i]);
-                       g_variant_unref(gvar_list);
-
-               } else if (key == SR_CONF_TIMEBASE) {
-                       /* Supported time bases */
-                       printf("    %s", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, channel_group,
-                                       SR_CONF_TIMEBASE, &gvar_list) != SR_OK) {
-                               printf("\n");
-                               continue;
-                       }
-                       printf(" - supported time bases:\n");
-                       num_elements = g_variant_n_children(gvar_list);
+                       printf(" - supported values:\n");
                        for (i = 0; i < num_elements; i++) {
-                               gvar = g_variant_get_child_value(gvar_list, i);
-                               g_variant_get(gvar, "(tt)", &p, &q);
-                               s = sr_period_string(p * q);
-                               printf("      %s\n", s);
-                               g_free(s);
-                       }
-                       g_variant_unref(gvar_list);
-
-               } else if (key == SR_CONF_VDIV) {
-                       /* Supported volts/div values */
-                       printf("    %s", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, channel_group,
-                                       SR_CONF_VDIV, &gvar_list) != SR_OK) {
+                               printf("      %"PRIu64, uint64[i]);
+                               if (gvar && tmp_uint64 == uint64[i])
+                                       printf(" (current)");
                                printf("\n");
-                               continue;
-                       }
-                       printf(" - supported volts/div:\n");
-                       num_elements = g_variant_n_children(gvar_list);
-                       for (i = 0; i < num_elements; i++) {
-                               gvar = g_variant_get_child_value(gvar_list, i);
-                               g_variant_get(gvar, "(tt)", &p, &q);
-                               s = sr_voltage_string(p, q);
-                               printf("      %s\n", s);
-                               g_free(s);
                        }
                        g_variant_unref(gvar_list);
 
                } else if (srci->datatype == SR_T_STRING) {
                        printf("    %s: ", srci->id);
-                       if (sr_config_get(sdi->driver, sdi, channel_group, key,
+                       if (maybe_config_get(driver, sdi, channel_group, 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, channel_group, key,
+                       if (maybe_config_list(driver, sdi, channel_group, key,
                                        &gvar) != SR_OK) {
                                if (tmp_str) {
                                        /* Can't list it, but we have a value to show. */
@@ -472,13 +510,13 @@ void show_dev_detail(void)
 
                } else if (srci->datatype == SR_T_UINT64_RANGE) {
                        printf("    %s: ", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, channel_group, key,
+                       if (maybe_config_list(driver, sdi, channel_group, key,
                                        &gvar_list) != SR_OK) {
                                printf("\n");
                                continue;
                        }
 
-                       if (sr_config_get(sdi->driver, sdi, channel_group, key, &gvar) == SR_OK) {
+                       if (maybe_config_get(driver, sdi, channel_group, key, &gvar) == SR_OK) {
                                g_variant_get(gvar, "(tt)", &cur_low, &cur_high);
                                g_variant_unref(gvar);
                        } else {
@@ -502,7 +540,7 @@ void show_dev_detail(void)
 
                } else if (srci->datatype == SR_T_BOOL) {
                        printf("    %s: ", srci->id);
-                       if (sr_config_get(sdi->driver, sdi, channel_group, key,
+                       if (maybe_config_get(driver, sdi, channel_group, key,
                                        &gvar) == SR_OK) {
                                if (g_variant_get_boolean(gvar))
                                        printf("on (current), off\n");
@@ -514,13 +552,13 @@ void show_dev_detail(void)
 
                } else if (srci->datatype == SR_T_DOUBLE_RANGE) {
                        printf("    %s: ", srci->id);
-                       if (sr_config_list(sdi->driver, sdi, channel_group, key,
+                       if (maybe_config_list(driver, sdi, channel_group, key,
                                        &gvar_list) != SR_OK) {
                                printf("\n");
                                continue;
                        }
 
-                       if (sr_config_get(sdi->driver, sdi, channel_group, key, &gvar) == SR_OK) {
+                       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 {
@@ -544,12 +582,44 @@ void show_dev_detail(void)
 
                } else if (srci->datatype == SR_T_FLOAT) {
                        printf("    %s: ", srci->id);
-                       if (sr_config_get(sdi->driver, sdi, channel_group, key,
+                       if (maybe_config_get(driver, sdi, channel_group, key,
                                        &gvar) == SR_OK) {
                                printf("%f\n", g_variant_get_double(gvar));
                                g_variant_unref(gvar);
                        } else
-                               printf("on, off\n");
+                               printf("\n");
+
+               } else if (srci->datatype == SR_T_RATIONAL_PERIOD
+                               || srci->datatype == SR_T_RATIONAL_VOLT) {
+                       printf("    %s", srci->id);
+                       if (maybe_config_get(driver, sdi, channel_group, key,
+                                       &gvar) == SR_OK) {
+                               g_variant_get(gvar, "(tt)", &cur_p, &cur_q);
+                               g_variant_unref(gvar);
+                       } else
+                               cur_p = cur_q = 0;
+
+                       if (maybe_config_list(driver, sdi, channel_group,
+                                       key, &gvar_list) != SR_OK) {
+                               printf("\n");
+                               continue;
+                       }
+                       printf(" - supported values:\n");
+                       num_elements = g_variant_n_children(gvar_list);
+                       for (i = 0; i < num_elements; i++) {
+                               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);
+                               else
+                                       s = sr_voltage_string(p, q);
+                               printf("      %s", s);
+                               g_free(s);
+                               if (p == cur_p && q == cur_q)
+                                       printf(" (current)");
+                               printf("\n");
+                       }
+                       g_variant_unref(gvar_list);
 
                } else {
 
@@ -740,3 +810,42 @@ void show_output(void)
        g_strfreev(tok);
 }
 
+void show_transform(void)
+{
+       const struct sr_transform_module *tmod;
+       const struct sr_option **opts;
+       GSList *l;
+       int i;
+       char *s, **tok;
+
+       tok = g_strsplit(opt_transform_module, ":", 0);
+       if (!tok[0] || !(tmod = sr_transform_find(tok[0])))
+               g_critical("Transform module '%s' not found.", opt_transform_module);
+
+       printf("ID: %s\nName: %s\n", sr_transform_id_get(tmod),
+                       sr_transform_name_get(tmod));
+       printf("Description: %s\n", sr_transform_description_get(tmod));
+       if ((opts = sr_transform_options_get(tmod))) {
+               printf("Options:\n");
+               for (i = 0; opts[i]; i++) {
+                       printf("  %s: %s", opts[i]->id, opts[i]->desc);
+                       if (opts[i]->def) {
+                               s = g_variant_print(opts[i]->def, FALSE);
+                               printf(" (default %s", s);
+                               g_free(s);
+                               if (opts[i]->values) {
+                                       printf(", possible values ");
+                                       for (l = opts[i]->values; l; l = l->next) {
+                                               s = g_variant_print((GVariant *)l->data, FALSE);
+                                               printf("%s%s", s, l->next ? ", " : "");
+                                               g_free(s);
+                                       }
+                               }
+                               printf(")");
+                       }
+                       printf("\n");
+               }
+               sr_transform_options_free(opts);
+       }
+       g_strfreev(tok);
+}