--list-supported: Show detailed library/feature info.
[sigrok-cli.git] / show.c
blobc93a6be4c8c397bf7096857880bb17b9c6963f3e
1 /*
2 * This file is part of the sigrok-cli project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #include <config.h>
21 #include <glib.h>
22 #include <string.h>
23 #include "sigrok-cli.h"
25 static gint sort_inputs(gconstpointer a, gconstpointer b)
27 return strcmp(sr_input_id_get((struct sr_input_module *)a),
28 sr_input_id_get((struct sr_input_module *)b));
31 static gint sort_outputs(gconstpointer a, gconstpointer b)
33 return strcmp(sr_output_id_get((struct sr_output_module *)a),
34 sr_output_id_get((struct sr_output_module *)b));
37 static gint sort_transforms(gconstpointer a, gconstpointer b)
39 return strcmp(sr_transform_id_get((struct sr_transform_module *)a),
40 sr_transform_id_get((struct sr_transform_module *)b));
43 static gint sort_drivers(gconstpointer a, gconstpointer b)
45 const struct sr_dev_driver *sdda = a, *sddb = b;
47 return strcmp(sdda->name, sddb->name);
50 #ifdef HAVE_SRD
51 static gint sort_pds(gconstpointer a, gconstpointer b)
53 const struct srd_decoder *sda = a, *sdb = b;
55 return strcmp(sda->id, sdb->id);
57 #endif
59 void show_version(void)
61 GString *s;
62 GSList *l, *l_orig, *m;
63 char *str;
64 const char *lib, *version;
66 printf("sigrok-cli %s\n\n", SC_PACKAGE_VERSION_STRING);
68 printf("Libraries and features:\n");
70 printf("- libsigrok %s/%s (rt: %s/%s).\n",
71 SR_PACKAGE_VERSION_STRING, SR_LIB_VERSION_STRING,
72 sr_package_version_string_get(), sr_lib_version_string_get());
74 s = g_string_sized_new(200);
75 g_string_append(s, " - Libs:\n");
76 l_orig = sr_buildinfo_libs_get();
77 for (l = l_orig; l; l = l->next) {
78 m = l->data;
79 lib = m->data;
80 version = m->next->data;
81 g_string_append_printf(s, " - %s %s\n", lib, version);
82 g_slist_free_full(m, g_free);
84 g_slist_free(l_orig);
85 s->str[s->len - 1] = '\0';
86 printf("%s\n", s->str);
87 g_string_free(s, TRUE);
89 str = sr_buildinfo_host_get();
90 printf(" - Host: %s.\n", str);
91 g_free(str);
93 str = sr_buildinfo_scpi_backends_get();
94 printf(" - SCPI backends: %s.\n", str);
95 g_free(str);
97 printf("- libsigrokdecode %s/%s (rt: %s/%s).\n",
98 SRD_PACKAGE_VERSION_STRING, SRD_LIB_VERSION_STRING,
99 srd_package_version_string_get(), srd_lib_version_string_get());
101 s = g_string_sized_new(200);
102 g_string_append(s, " - Libs:\n");
103 l_orig = srd_buildinfo_libs_get();
104 for (l = l_orig; l; l = l->next) {
105 m = l->data;
106 lib = m->data;
107 version = m->next->data;
108 g_string_append_printf(s, " - %s %s\n", lib, version);
109 g_slist_free_full(m, g_free);
111 g_slist_free(l_orig);
112 s->str[s->len - 1] = '\0';
113 printf("%s\n", s->str);
114 g_string_free(s, TRUE);
116 str = srd_buildinfo_host_get();
117 printf(" - Host: %s.\n", str);
118 g_free(str);
121 void show_supported(void)
123 struct sr_dev_driver **drivers, *driver;
124 const struct sr_input_module **inputs, *input;
125 const struct sr_output_module **outputs, *output;
126 const struct sr_transform_module **transforms, *transform;
127 const GSList *l;
128 GSList *sl;
129 int i;
130 #ifdef HAVE_SRD
131 struct srd_decoder *dec;
132 #endif
134 printf("Supported hardware drivers:\n");
135 drivers = sr_driver_list(sr_ctx);
136 for (sl = NULL, i = 0; drivers[i]; i++)
137 sl = g_slist_append(sl, drivers[i]);
138 sl = g_slist_sort(sl, sort_drivers);
139 for (l = sl; l; l = l->next) {
140 driver = l->data;
141 printf(" %-20s %s\n", driver->name, driver->longname);
143 printf("\n");
144 g_slist_free(sl);
146 printf("Supported input formats:\n");
147 inputs = sr_input_list();
148 for (sl = NULL, i = 0; inputs[i]; i++)
149 sl = g_slist_append(sl, (gpointer)inputs[i]);
150 sl = g_slist_sort(sl, sort_inputs);
151 for (l = sl; l; l = l->next) {
152 input = l->data;
153 printf(" %-20s %s\n", sr_input_id_get(input),
154 sr_input_description_get(input));
156 printf("\n");
157 g_slist_free(sl);
159 printf("Supported output formats:\n");
160 outputs = sr_output_list();
161 for (sl = NULL, i = 0; outputs[i]; i++)
162 sl = g_slist_append(sl, (gpointer)outputs[i]);
163 sl = g_slist_sort(sl, sort_outputs);
164 for (l = sl; l; l = l->next) {
165 output = l->data;
166 printf(" %-20s %s\n", sr_output_id_get(output),
167 sr_output_description_get(output));
169 printf("\n");
170 g_slist_free(sl);
172 printf("Supported transform modules:\n");
173 transforms = sr_transform_list();
174 for (sl = NULL, i = 0; transforms[i]; i++)
175 sl = g_slist_append(sl, (gpointer)transforms[i]);
176 sl = g_slist_sort(sl, sort_transforms);
177 for (l = sl; l; l = l->next) {
178 transform = l->data;
179 printf(" %-20s %s\n", sr_transform_id_get(transform),
180 sr_transform_description_get(transform));
182 printf("\n");
183 g_slist_free(sl);
185 #ifdef HAVE_SRD
186 if (srd_init(NULL) == SRD_OK) {
187 printf("Supported protocol decoders:\n");
188 srd_decoder_load_all();
189 sl = g_slist_copy((GSList *)srd_decoder_list());
190 sl = g_slist_sort(sl, sort_pds);
191 for (l = sl; l; l = l->next) {
192 dec = l->data;
193 printf(" %-20s %s\n", dec->id, dec->longname);
194 /* Print protocol description upon "-l 3" or higher. */
195 if (opt_loglevel >= SR_LOG_INFO)
196 printf(" %-20s %s\n", "", dec->desc);
198 g_slist_free(sl);
199 srd_exit();
201 printf("\n");
202 #endif
205 static gint sort_channels(gconstpointer a, gconstpointer b)
207 const struct sr_channel *pa = a, *pb = b;
209 return pa->index - pb->index;
212 static void print_dev_line(const struct sr_dev_inst *sdi)
214 struct sr_channel *ch;
215 GSList *sl, *l, *channels;
216 GString *s;
217 GVariant *gvar;
218 struct sr_dev_driver *driver;
219 const char *vendor, *model, *version;
221 driver = sr_dev_inst_driver_get(sdi);
222 vendor = sr_dev_inst_vendor_get(sdi);
223 model = sr_dev_inst_model_get(sdi);
224 version = sr_dev_inst_version_get(sdi);
225 channels = sr_dev_inst_channels_get(sdi);
227 s = g_string_sized_new(128);
228 g_string_assign(s, driver->name);
229 if (maybe_config_get(driver, sdi, NULL, SR_CONF_CONN, &gvar) == SR_OK) {
230 g_string_append(s, ":conn=");
231 g_string_append(s, g_variant_get_string(gvar, NULL));
232 g_variant_unref(gvar);
234 g_string_append(s, " - ");
235 if (vendor && vendor[0])
236 g_string_append_printf(s, "%s ", vendor);
237 if (model && model[0])
238 g_string_append_printf(s, "%s ", model);
239 if (version && version[0])
240 g_string_append_printf(s, "%s ", version);
241 if (channels) {
242 if (g_slist_length(channels) == 1) {
243 ch = channels->data;
244 g_string_append_printf(s, "with 1 channel: %s", ch->name);
245 } else {
246 sl = g_slist_sort(g_slist_copy(channels), sort_channels);
247 g_string_append_printf(s, "with %d channels:", g_slist_length(sl));
248 for (l = sl; l; l = l->next) {
249 ch = l->data;
250 g_string_append_printf(s, " %s", ch->name);
252 g_slist_free(sl);
255 g_string_append_printf(s, "\n");
256 printf("%s", s->str);
257 g_string_free(s, TRUE);
261 void show_dev_list(void)
263 struct sr_dev_inst *sdi;
264 GSList *devices, *l;
266 if (!(devices = device_scan()))
267 return;
269 printf("The following devices were found:\n");
270 for (l = devices; l; l = l->next) {
271 sdi = l->data;
272 print_dev_line(sdi);
274 g_slist_free(devices);
278 void show_drv_detail(struct sr_dev_driver *driver)
280 const struct sr_key_info *srci;
281 GArray *opts;
282 guint i;
284 if ((opts = sr_dev_options(driver, NULL, NULL))) {
285 if (opts->len > 0) {
286 printf("Driver functions:\n");
287 for (i = 0; i < opts->len; i++) {
288 if (!(srci = sr_key_info_get(SR_KEY_CONFIG,
289 g_array_index(opts, uint32_t, i))))
290 continue;
291 printf(" %s\n", srci->name);
294 g_array_free(opts, TRUE);
297 if ((opts = sr_driver_scan_options_list(driver))) {
298 if (opts->len > 0) {
299 printf("Scan options:\n");
300 for (i = 0; i < opts->len; i++) {
301 if (!(srci = sr_key_info_get(SR_KEY_CONFIG,
302 g_array_index(opts, uint32_t, i))))
303 continue;
304 printf(" %s\n", srci->id);
307 g_array_free(opts, TRUE);
311 void show_dev_detail(void)
313 struct sr_dev_driver *driver_from_opt, *driver;
314 struct sr_dev_inst *sdi;
315 const struct sr_key_info *srci, *srmqi, *srmqfi;
316 struct sr_channel *ch;
317 struct sr_channel_group *channel_group, *cg;
318 GSList *devices, *cgl, *chl, *channel_groups;
319 GVariant *gvar_dict, *gvar_list, *gvar;
320 gsize num_elements;
321 double dlow, dhigh, dcur_low, dcur_high;
322 const uint64_t *uint64, p, q, low, high;
323 uint64_t tmp_uint64, mask, cur_low, cur_high, cur_p, cur_q;
324 GArray *opts;
325 const int32_t *int32;
326 uint32_t key, o, cur_mq, mq;
327 uint64_t cur_mqflags, mqflags;
328 unsigned int num_devices, i, j;
329 char *tmp_str, *s, c;
330 const char **stropts;
332 if (parse_driver(opt_drv, &driver_from_opt, NULL)) {
333 /* A driver was specified, report driver-wide options now. */
334 show_drv_detail(driver_from_opt);
337 if (!(devices = device_scan())) {
338 g_critical("No devices found.");
339 return;
342 num_devices = g_slist_length(devices);
343 if (num_devices > 1) {
344 g_critical("%d devices found. Use --scan to show them, "
345 "and select one to show.", num_devices);
346 return;
349 sdi = devices->data;
350 g_slist_free(devices);
351 print_dev_line(sdi);
353 driver = sr_dev_inst_driver_get(sdi);
354 channel_groups = sr_dev_inst_channel_groups_get(sdi);
356 if (sr_dev_open(sdi) != SR_OK) {
357 g_critical("Failed to open device.");
358 return;
362 * Selected channels and channel group may affect which options are
363 * returned, or which values for them.
365 select_channels(sdi);
366 channel_group = select_channel_group(sdi);
368 if (!(opts = sr_dev_options(driver, sdi, channel_group)))
369 /* Driver supports no device instance options. */
370 return;
372 if (channel_groups) {
373 printf("Channel groups:\n");
374 for (cgl = channel_groups; cgl; cgl = cgl->next) {
375 cg = cgl->data;
376 printf(" %s: channel%s", cg->name,
377 g_slist_length(cg->channels) > 1 ? "s" : "");
378 for (chl = cg->channels; chl; chl = chl->next) {
379 ch = chl->data;
380 printf(" %s", ch->name);
382 printf("\n");
386 printf("Supported configuration options");
387 if (channel_groups) {
388 if (!channel_group)
389 printf(" across all channel groups");
390 else
391 printf(" on channel group %s", channel_group->name);
393 printf(":\n");
394 for (o = 0; o < opts->len; o++) {
395 key = g_array_index(opts, uint32_t, o);
396 if (!(srci = sr_key_info_get(SR_KEY_CONFIG, key)))
397 continue;
399 if (key == SR_CONF_TRIGGER_MATCH) {
400 if (maybe_config_list(driver, sdi, channel_group, key,
401 &gvar_list) != SR_OK) {
402 printf("\n");
403 continue;
405 int32 = g_variant_get_fixed_array(gvar_list,
406 &num_elements, sizeof(int32_t));
407 printf(" Supported triggers: ");
408 for (i = 0; i < num_elements; i++) {
409 switch (int32[i]) {
410 case SR_TRIGGER_ZERO:
411 c = '0';
412 break;
413 case SR_TRIGGER_ONE:
414 c = '1';
415 break;
416 case SR_TRIGGER_RISING:
417 c = 'r';
418 break;
419 case SR_TRIGGER_FALLING:
420 c = 'f';
421 break;
422 case SR_TRIGGER_EDGE:
423 c = 'e';
424 break;
425 case SR_TRIGGER_OVER:
426 c = 'o';
427 break;
428 case SR_TRIGGER_UNDER:
429 c = 'u';
430 break;
431 default:
432 c = 0;
433 break;
435 if (c)
436 printf("%c ", c);
438 printf("\n");
439 g_variant_unref(gvar_list);
441 } else if (key == SR_CONF_LIMIT_SAMPLES
442 && (sr_dev_config_capabilities_list(sdi, NULL, key)
443 & SR_CONF_LIST)) {
445 * If implemented in config_list(), this denotes the
446 * maximum number of samples a device can send. This
447 * really applies only to logic analyzers, and then
448 * only to those that don't support compression, or
449 * have it turned off by default. The values returned
450 * are the low/high limits.
452 if (sr_config_list(driver, sdi, channel_group, key,
453 &gvar) == SR_OK) {
454 g_variant_get(gvar, "(tt)", &low, &high);
455 g_variant_unref(gvar);
456 printf(" Maximum number of samples: %"PRIu64"\n", high);
459 } else if (key == SR_CONF_SAMPLERATE) {
460 /* Supported samplerates */
461 printf(" %s", srci->id);
462 if (maybe_config_list(driver, sdi, channel_group, SR_CONF_SAMPLERATE,
463 &gvar_dict) != SR_OK) {
464 printf("\n");
465 continue;
467 if ((gvar_list = g_variant_lookup_value(gvar_dict,
468 "samplerates", G_VARIANT_TYPE("at")))) {
469 uint64 = g_variant_get_fixed_array(gvar_list,
470 &num_elements, sizeof(uint64_t));
471 printf(" - supported samplerates:\n");
472 for (i = 0; i < num_elements; i++) {
473 if (!(s = sr_samplerate_string(uint64[i])))
474 continue;
475 printf(" %s\n", s);
476 g_free(s);
478 g_variant_unref(gvar_list);
479 } else if ((gvar_list = g_variant_lookup_value(gvar_dict,
480 "samplerate-steps", G_VARIANT_TYPE("at")))) {
481 uint64 = g_variant_get_fixed_array(gvar_list,
482 &num_elements, sizeof(uint64_t));
483 /* low */
484 if (!(s = sr_samplerate_string(uint64[0])))
485 continue;
486 printf(" (%s", s);
487 g_free(s);
488 /* high */
489 if (!(s = sr_samplerate_string(uint64[1])))
490 continue;
491 printf(" - %s", s);
492 g_free(s);
493 /* step */
494 if (!(s = sr_samplerate_string(uint64[2])))
495 continue;
496 printf(" in steps of %s)\n", s);
497 g_free(s);
498 g_variant_unref(gvar_list);
500 g_variant_unref(gvar_dict);
502 } else if (srci->datatype == SR_T_UINT64) {
503 printf(" %s: ", srci->id);
504 gvar = NULL;
505 if (maybe_config_get(driver, sdi, channel_group, key,
506 &gvar) == SR_OK) {
507 tmp_uint64 = g_variant_get_uint64(gvar);
508 g_variant_unref(gvar);
509 } else
510 tmp_uint64 = 0;
511 if (maybe_config_list(driver, sdi, channel_group,
512 key, &gvar_list) != SR_OK) {
513 if (gvar) {
514 /* Can't list it, but we have a value to show. */
515 printf("%"PRIu64" (current)", tmp_uint64);
517 printf("\n");
518 continue;
520 uint64 = g_variant_get_fixed_array(gvar_list,
521 &num_elements, sizeof(uint64_t));
522 printf(" - supported values:\n");
523 for (i = 0; i < num_elements; i++) {
524 printf(" %"PRIu64, uint64[i]);
525 if (gvar && tmp_uint64 == uint64[i])
526 printf(" (current)");
527 printf("\n");
529 g_variant_unref(gvar_list);
531 } else if (srci->datatype == SR_T_STRING) {
532 printf(" %s: ", srci->id);
533 if (maybe_config_get(driver, sdi, channel_group, key,
534 &gvar) == SR_OK) {
535 tmp_str = g_strdup(g_variant_get_string(gvar, NULL));
536 g_variant_unref(gvar);
537 } else
538 tmp_str = NULL;
540 if (maybe_config_list(driver, sdi, channel_group, key,
541 &gvar) != SR_OK) {
542 if (tmp_str) {
543 /* Can't list it, but we have a value to show. */
544 printf("%s (current)", tmp_str);
546 printf("\n");
547 g_free(tmp_str);
548 continue;
551 stropts = g_variant_get_strv(gvar, &num_elements);
552 for (i = 0; i < num_elements; i++) {
553 if (i)
554 printf(", ");
555 printf("%s", stropts[i]);
556 if (tmp_str && !strcmp(tmp_str, stropts[i]))
557 printf(" (current)");
559 printf("\n");
560 g_free(stropts);
561 g_free(tmp_str);
562 g_variant_unref(gvar);
564 } else if (srci->datatype == SR_T_UINT64_RANGE) {
565 printf(" %s: ", srci->id);
566 if (maybe_config_list(driver, sdi, channel_group, key,
567 &gvar_list) != SR_OK) {
568 printf("\n");
569 continue;
572 if (maybe_config_get(driver, sdi, channel_group, key, &gvar) == SR_OK) {
573 g_variant_get(gvar, "(tt)", &cur_low, &cur_high);
574 g_variant_unref(gvar);
575 } else {
576 cur_low = 0;
577 cur_high = 0;
580 num_elements = g_variant_n_children(gvar_list);
581 for (i = 0; i < num_elements; i++) {
582 gvar = g_variant_get_child_value(gvar_list, i);
583 g_variant_get(gvar, "(tt)", &low, &high);
584 g_variant_unref(gvar);
585 if (i)
586 printf(", ");
587 printf("%"PRIu64"-%"PRIu64, low, high);
588 if (low == cur_low && high == cur_high)
589 printf(" (current)");
591 printf("\n");
592 g_variant_unref(gvar_list);
594 } else if (srci->datatype == SR_T_BOOL) {
595 printf(" %s: ", srci->id);
596 if (maybe_config_get(driver, sdi, channel_group, key,
597 &gvar) == SR_OK) {
598 if (g_variant_get_boolean(gvar))
599 printf("on (current), off\n");
600 else
601 printf("on, off (current)\n");
602 g_variant_unref(gvar);
603 } else
604 printf("on, off\n");
606 } else if (srci->datatype == SR_T_DOUBLE_RANGE) {
607 printf(" %s: ", srci->id);
608 if (maybe_config_list(driver, sdi, channel_group, key,
609 &gvar_list) != SR_OK) {
610 printf("\n");
611 continue;
614 if (maybe_config_get(driver, sdi, channel_group, key, &gvar) == SR_OK) {
615 g_variant_get(gvar, "(dd)", &dcur_low, &dcur_high);
616 g_variant_unref(gvar);
617 } else {
618 dcur_low = 0;
619 dcur_high = 0;
622 num_elements = g_variant_n_children(gvar_list);
623 for (i = 0; i < num_elements; i++) {
624 gvar = g_variant_get_child_value(gvar_list, i);
625 g_variant_get(gvar, "(dd)", &dlow, &dhigh);
626 g_variant_unref(gvar);
627 if (i)
628 printf(", ");
629 printf("%.1f-%.1f", dlow, dhigh);
630 if (dlow == dcur_low && dhigh == dcur_high)
631 printf(" (current)");
633 printf("\n");
634 g_variant_unref(gvar_list);
636 } else if (srci->datatype == SR_T_FLOAT) {
637 printf(" %s: ", srci->id);
638 if (maybe_config_get(driver, sdi, channel_group, key,
639 &gvar) == SR_OK) {
640 printf("%f\n", g_variant_get_double(gvar));
641 g_variant_unref(gvar);
642 } else
643 printf("\n");
645 } else if (srci->datatype == SR_T_RATIONAL_PERIOD
646 || srci->datatype == SR_T_RATIONAL_VOLT) {
647 printf(" %s", srci->id);
648 if (maybe_config_get(driver, sdi, channel_group, key,
649 &gvar) == SR_OK) {
650 g_variant_get(gvar, "(tt)", &cur_p, &cur_q);
651 g_variant_unref(gvar);
652 } else
653 cur_p = cur_q = 0;
655 if (maybe_config_list(driver, sdi, channel_group,
656 key, &gvar_list) != SR_OK) {
657 printf("\n");
658 continue;
660 printf(" - supported values:\n");
661 num_elements = g_variant_n_children(gvar_list);
662 for (i = 0; i < num_elements; i++) {
663 gvar = g_variant_get_child_value(gvar_list, i);
664 g_variant_get(gvar, "(tt)", &p, &q);
665 if (srci->datatype == SR_T_RATIONAL_PERIOD)
666 s = sr_period_string(p, q);
667 else
668 s = sr_voltage_string(p, q);
669 printf(" %s", s);
670 g_free(s);
671 if (p == cur_p && q == cur_q)
672 printf(" (current)");
673 printf("\n");
675 g_variant_unref(gvar_list);
677 } else if (srci->datatype == SR_T_MQ) {
678 printf(" %s: ", srci->id);
679 if (maybe_config_get(driver, sdi, channel_group, key,
680 &gvar) == SR_OK
681 && g_variant_is_of_type(gvar, G_VARIANT_TYPE_TUPLE)
682 && g_variant_n_children(gvar) == 2) {
683 g_variant_get(gvar, "(ut)", &cur_mq, &cur_mqflags);
684 g_variant_unref(gvar);
685 } else
686 cur_mq = cur_mqflags = 0;
688 if (maybe_config_list(driver, sdi, channel_group,
689 key, &gvar_list) != SR_OK) {
690 printf("\n");
691 continue;
693 printf(" - supported measurements:\n");
694 num_elements = g_variant_n_children(gvar_list);
695 for (i = 0; i < num_elements; i++) {
696 printf(" ");
697 gvar = g_variant_get_child_value(gvar_list, i);
698 g_variant_get(gvar, "(ut)", &mq, &mqflags);
699 if ((srmqi = sr_key_info_get(SR_KEY_MQ, mq)))
700 printf("%s", srmqi->id);
701 else
702 printf("%d", mq);
703 for (j = 0, mask = 1; j < 32; j++, mask <<= 1) {
704 if (!(mqflags & mask))
705 continue;
706 if ((srmqfi = sr_key_info_get(SR_KEY_MQFLAGS, mqflags & mask)))
707 printf("/%s", srmqfi->id);
708 else
709 printf("/%" PRIu64, mqflags & mask);
711 if (mq == cur_mq && mqflags == cur_mqflags)
712 printf(" (current)");
713 printf("\n");
715 g_variant_unref(gvar_list);
717 } else {
719 /* Everything else */
720 printf(" %s\n", srci->id);
723 g_array_free(opts, TRUE);
725 sr_dev_close(sdi);
729 #ifdef HAVE_SRD
730 static void show_pd_detail_single(const char *pd)
732 struct srd_decoder *dec;
733 struct srd_decoder_option *o;
734 struct srd_channel *pdch;
735 struct srd_decoder_annotation_row *r;
736 GSList *l, *ll, *ol;
737 int idx;
738 char **pdtokens, **pdtok, *optsep, **ann, **bin, *val, *doc, *str;
740 pdtokens = g_strsplit(pd, ",", -1);
741 for (pdtok = pdtokens; *pdtok; pdtok++) {
742 /* Strip options. */
743 if ((optsep = strchr(*pdtok, ':')))
744 *optsep = '\0';
745 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
746 g_critical("Protocol decoder %s not found.", *pdtok);
747 return;
749 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
750 dec->id, dec->name, dec->longname, dec->desc);
751 printf("License: %s\n", dec->license);
752 printf("Possible decoder input IDs:\n");
753 if (dec->inputs) {
754 for (l = dec->inputs; l; l = l->next) {
755 str = l->data;
756 printf("- %s\n", str);
758 } else {
759 printf("None.\n");
761 printf("Possible decoder output IDs:\n");
762 if (dec->outputs) {
763 for (l = dec->outputs; l; l = l->next) {
764 str = l->data;
765 printf("- %s\n", str);
767 } else {
768 printf("None.\n");
770 printf("Annotation classes:\n");
771 if (dec->annotations) {
772 for (l = dec->annotations; l; l = l->next) {
773 ann = l->data;
774 printf("- %s: %s\n", ann[0], ann[1]);
776 } else {
777 printf("None.\n");
779 printf("Annotation rows:\n");
780 if (dec->annotation_rows) {
781 for (l = dec->annotation_rows; l; l = l->next) {
782 r = l->data;
783 printf("- %s (%s): ", r->id, r->desc);
784 for (ll = r->ann_classes; ll; ll = ll->next) {
785 idx = GPOINTER_TO_INT(ll->data);
786 ann = g_slist_nth_data(dec->annotations, idx);
787 printf("%s", ann[0]);
788 if (ll->next)
789 printf(", ");
791 printf("\n");
793 } else {
794 printf("None.\n");
796 printf("Binary classes:\n");
797 if (dec->binary) {
798 for (l = dec->binary; l; l = l->next) {
799 bin = l->data;
800 printf("- %s: %s\n", bin[0], bin[1]);
802 } else {
803 printf("None.\n");
805 printf("Required channels:\n");
806 if (dec->channels) {
807 for (l = dec->channels; l; l = l->next) {
808 pdch = l->data;
809 printf("- %s (%s): %s\n",
810 pdch->id, pdch->name, pdch->desc);
812 } else {
813 printf("None.\n");
815 printf("Optional channels:\n");
816 if (dec->opt_channels) {
817 for (l = dec->opt_channels; l; l = l->next) {
818 pdch = l->data;
819 printf("- %s (%s): %s\n",
820 pdch->id, pdch->name, pdch->desc);
822 } else {
823 printf("None.\n");
825 printf("Options:\n");
826 if (dec->options) {
827 for (l = dec->options; l; l = l->next) {
828 o = l->data;
829 printf("- %s: %s (", o->id, o->desc);
830 for (ol = o->values; ol; ol = ol->next) {
831 val = g_variant_print(ol->data, FALSE);
832 printf("%s, ", val);
833 g_free(val);
835 val = g_variant_print(o->def, FALSE);
836 printf("default %s)\n", val);
837 g_free(val);
839 } else {
840 printf("None.\n");
842 if ((doc = srd_decoder_doc_get(dec))) {
843 printf("Documentation:\n%s\n",
844 doc[0] == '\n' ? doc + 1 : doc);
845 g_free(doc);
849 g_strfreev(pdtokens);
852 void show_pd_detail(void)
854 for (int i = 0; opt_pds[i]; i++)
855 show_pd_detail_single(opt_pds[i]);
857 #endif
859 void show_input(void)
861 const struct sr_input_module *imod;
862 const struct sr_option **opts;
863 GSList *l;
864 int i;
865 char *s, **tok;
867 tok = g_strsplit(opt_input_format, ":", 0);
868 if (!tok[0] || !(imod = sr_input_find(tok[0])))
869 g_critical("Input module '%s' not found.", opt_input_format);
871 printf("ID: %s\nName: %s\n", sr_input_id_get(imod),
872 sr_input_name_get(imod));
873 printf("Description: %s\n", sr_input_description_get(imod));
874 if ((opts = sr_input_options_get(imod))) {
875 printf("Options:\n");
876 for (i = 0; opts[i]; i++) {
877 printf(" %s: %s", opts[i]->id, opts[i]->desc);
878 if (opts[i]->def) {
879 s = g_variant_print(opts[i]->def, FALSE);
880 printf(" (default %s", s);
881 g_free(s);
882 if (opts[i]->values) {
883 printf(", possible values ");
884 for (l = opts[i]->values; l; l = l->next) {
885 s = g_variant_print((GVariant *)l->data, FALSE);
886 printf("%s%s", s, l->next ? ", " : "");
887 g_free(s);
890 printf(")");
892 printf("\n");
894 sr_input_options_free(opts);
896 g_strfreev(tok);
899 void show_output(void)
901 const struct sr_output_module *omod;
902 const struct sr_option **opts;
903 GSList *l;
904 int i;
905 char *s, **tok;
907 tok = g_strsplit(opt_output_format, ":", 0);
908 if (!tok[0] || !(omod = sr_output_find(tok[0])))
909 g_critical("Output module '%s' not found.", opt_output_format);
911 printf("ID: %s\nName: %s\n", sr_output_id_get(omod),
912 sr_output_name_get(omod));
913 printf("Description: %s\n", sr_output_description_get(omod));
914 if ((opts = sr_output_options_get(omod))) {
915 printf("Options:\n");
916 for (i = 0; opts[i]; i++) {
917 printf(" %s: %s", opts[i]->id, opts[i]->desc);
918 if (opts[i]->def) {
919 s = g_variant_print(opts[i]->def, FALSE);
920 printf(" (default %s", s);
921 g_free(s);
922 if (opts[i]->values) {
923 printf(", possible values ");
924 for (l = opts[i]->values; l; l = l->next) {
925 s = g_variant_print((GVariant *)l->data, FALSE);
926 printf("%s%s", s, l->next ? ", " : "");
927 g_free(s);
930 printf(")");
932 printf("\n");
934 sr_output_options_free(opts);
936 g_strfreev(tok);
939 void show_transform(void)
941 const struct sr_transform_module *tmod;
942 const struct sr_option **opts;
943 GSList *l;
944 int i;
945 char *s, **tok;
947 tok = g_strsplit(opt_transform_module, ":", 0);
948 if (!tok[0] || !(tmod = sr_transform_find(tok[0])))
949 g_critical("Transform module '%s' not found.", opt_transform_module);
951 printf("ID: %s\nName: %s\n", sr_transform_id_get(tmod),
952 sr_transform_name_get(tmod));
953 printf("Description: %s\n", sr_transform_description_get(tmod));
954 if ((opts = sr_transform_options_get(tmod))) {
955 printf("Options:\n");
956 for (i = 0; opts[i]; i++) {
957 printf(" %s: %s", opts[i]->id, opts[i]->desc);
958 if (opts[i]->def) {
959 s = g_variant_print(opts[i]->def, FALSE);
960 printf(" (default %s", s);
961 g_free(s);
962 if (opts[i]->values) {
963 printf(", possible values ");
964 for (l = opts[i]->values; l; l = l->next) {
965 s = g_variant_print((GVariant *)l->data, FALSE);
966 printf("%s%s", s, l->next ? ", " : "");
967 g_free(s);
970 printf(")");
972 printf("\n");
974 sr_transform_options_free(opts);
976 g_strfreev(tok);