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 "sigrok-cli.h"
24 static gint sort_inputs(gconstpointer a, gconstpointer b)
26 return strcmp(sr_input_id_get((struct sr_input_module *)a),
27 sr_input_id_get((struct sr_input_module *)b));
30 static gint sort_outputs(gconstpointer a, gconstpointer b)
32 return strcmp(sr_output_id_get((struct sr_output_module *)a),
33 sr_output_id_get((struct sr_output_module *)b));
36 static gint sort_drivers(gconstpointer a, gconstpointer b)
38 const struct sr_dev_driver *sdda = a, *sddb = b;
40 return strcmp(sdda->name, sddb->name);
44 static gint sort_pds(gconstpointer a, gconstpointer b)
46 const struct srd_decoder *sda = a, *sdb = b;
48 return strcmp(sda->id, sdb->id);
52 void show_version(void)
54 struct sr_dev_driver **drivers, *driver;
55 const struct sr_input_module **inputs, *input;
56 const struct sr_output_module **outputs, *output;
61 struct srd_decoder *dec;
64 printf("sigrok-cli %s\n\n", VERSION);
66 printf("Using libsigrok %s (lib version %s).\n",
67 sr_package_version_string_get(), sr_lib_version_string_get());
69 printf("Using libsigrokdecode %s (lib version %s).\n\n",
70 srd_package_version_string_get(), srd_lib_version_string_get());
73 printf("Supported hardware drivers:\n");
74 drivers = sr_driver_list();
75 for (sl = NULL, i = 0; drivers[i]; i++)
76 sl = g_slist_append(sl, drivers[i]);
77 sl = g_slist_sort(sl, sort_drivers);
78 for (l = sl; l; l = l->next) {
80 printf(" %-20s %s\n", driver->name, driver->longname);
85 printf("Supported input formats:\n");
86 inputs = sr_input_list();
87 for (sl = NULL, i = 0; inputs[i]; i++)
88 sl = g_slist_append(sl, (gpointer)inputs[i]);
89 sl = g_slist_sort(sl, sort_inputs);
90 for (l = sl; l; l = l->next) {
92 printf(" %-20s %s\n", sr_input_id_get(input),
93 sr_input_description_get(input));
98 printf("Supported output formats:\n");
99 outputs = sr_output_list();
100 for (sl = NULL, i = 0; outputs[i]; i++)
101 sl = g_slist_append(sl, (gpointer)outputs[i]);
102 sl = g_slist_sort(sl, sort_outputs);
103 for (l = sl; l; l = l->next) {
105 printf(" %-20s %s\n", sr_output_id_get(output),
106 sr_output_description_get(output));
112 if (srd_init(NULL) == SRD_OK) {
113 printf("Supported protocol decoders:\n");
114 srd_decoder_load_all();
115 sl = g_slist_copy((GSList *)srd_decoder_list());
116 sl = g_slist_sort(sl, sort_pds);
117 for (l = sl; l; l = l->next) {
119 printf(" %-20s %s\n", dec->id, dec->longname);
120 /* Print protocol description upon "-l 3" or higher. */
121 if (opt_loglevel >= SR_LOG_INFO)
122 printf(" %-20s %s\n", "", dec->desc);
131 static gint sort_channels(gconstpointer a, gconstpointer b)
133 const struct sr_channel *pa = a, *pb = b;
135 return pa->index - pb->index;
138 static void print_dev_line(const struct sr_dev_inst *sdi)
140 struct sr_channel *ch;
145 s = g_string_sized_new(128);
146 g_string_assign(s, sdi->driver->name);
147 if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_CONN, &gvar) == SR_OK) {
148 g_string_append(s, ":conn=");
149 g_string_append(s, g_variant_get_string(gvar, NULL));
150 g_variant_unref(gvar);
152 g_string_append(s, " - ");
153 if (sdi->vendor && sdi->vendor[0])
154 g_string_append_printf(s, "%s ", sdi->vendor);
155 if (sdi->model && sdi->model[0])
156 g_string_append_printf(s, "%s ", sdi->model);
157 if (sdi->version && sdi->version[0])
158 g_string_append_printf(s, "%s ", sdi->version);
160 if (g_slist_length(sdi->channels) == 1) {
161 ch = sdi->channels->data;
162 g_string_append_printf(s, "with 1 channel: %s", ch->name);
164 sl = g_slist_sort(g_slist_copy(sdi->channels), sort_channels);
165 g_string_append_printf(s, "with %d channels:", g_slist_length(sl));
166 for (l = sl; l; l = l->next) {
168 g_string_append_printf(s, " %s", ch->name);
173 g_string_append_printf(s, "\n");
174 printf("%s", s->str);
175 g_string_free(s, TRUE);
179 void show_dev_list(void)
181 struct sr_dev_inst *sdi;
184 if (!(devices = device_scan()))
187 printf("The following devices were found:\n");
188 for (l = devices; l; l = l->next) {
192 g_slist_free(devices);
196 void show_dev_detail(void)
198 struct sr_dev_inst *sdi;
199 const struct sr_config_info *srci;
200 struct sr_channel *ch;
201 struct sr_channel_group *channel_group, *cg;
202 GSList *devices, *cgl, *chl;
203 GVariant *gvar_opts, *gvar_dict, *gvar_list, *gvar;
204 gsize num_opts, num_elements;
205 double dlow, dhigh, dcur_low, dcur_high;
206 const uint64_t *uint64, p, q, low, high;
207 uint64_t cur_low, cur_high;
208 const int32_t *int32, *opts;
209 unsigned int num_devices, o, i;
212 const char **stropts;
214 if (!(devices = device_scan())) {
215 g_critical("No devices found.");
219 num_devices = g_slist_length(devices);
220 if (num_devices > 1) {
221 g_critical("%d devices found. Use --scan to show them, "
222 "and select one to show.", num_devices);
227 g_slist_free(devices);
230 if (sr_dev_open(sdi) != SR_OK) {
231 g_critical("Failed to open device.");
235 if ((sr_config_list(sdi->driver, NULL, NULL, SR_CONF_SCAN_OPTIONS,
236 &gvar_opts) == SR_OK)) {
237 opts = g_variant_get_fixed_array(gvar_opts, &num_elements,
239 printf("Supported driver options:\n");
240 for (i = 0; i < num_elements; i++) {
241 if (!(srci = sr_config_info_get(opts[i])))
243 printf(" %s\n", srci->id);
245 g_variant_unref(gvar_opts);
248 /* Selected channels and channel group may affect which options are
249 * returned, or which values for them. */
250 select_channels(sdi);
251 channel_group = select_channel_group(sdi);
253 if ((sr_config_list(sdi->driver, sdi, channel_group, SR_CONF_DEVICE_OPTIONS,
254 &gvar_opts)) != SR_OK)
255 /* Driver supports no device instance options. */
258 if (sdi->channel_groups) {
259 printf("Channel groups:\n");
260 for (cgl = sdi->channel_groups; cgl; cgl = cgl->next) {
262 printf(" %s: channel%s", cg->name,
263 g_slist_length(cg->channels) > 1 ? "s" : "");
264 for (chl = cg->channels; chl; chl = chl->next) {
266 printf(" %s", ch->name);
272 printf("Supported configuration options");
273 if (sdi->channel_groups) {
275 printf(" across all channel groups");
277 printf(" on channel group %s", channel_group->name);
280 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(int32_t));
281 for (o = 0; o < num_opts; o++) {
282 if (!(srci = sr_config_info_get(opts[o])))
285 if (srci->key == SR_CONF_TRIGGER_MATCH) {
286 if (sr_config_list(sdi->driver, sdi, channel_group, srci->key,
287 &gvar_list) != SR_OK) {
291 int32 = g_variant_get_fixed_array(gvar_list,
292 &num_elements, sizeof(int32_t));
293 printf(" Supported triggers: ");
294 for (i = 0; i < num_elements; i++) {
296 case SR_TRIGGER_ZERO:
302 case SR_TRIGGER_RISING:
305 case SR_TRIGGER_FALLING:
308 case SR_TRIGGER_EDGE:
311 case SR_TRIGGER_OVER:
314 case SR_TRIGGER_UNDER:
325 g_variant_unref(gvar_list);
327 } else if (srci->key == SR_CONF_LIMIT_SAMPLES) {
328 /* If implemented in config_list(), this denotes the
329 * maximum number of samples a device can send. This
330 * really applies only to logic analyzers, and then
331 * only to those that don't support compression, or
332 * have it turned off by default. The values returned
333 * are the low/high limits. */
334 if (sr_config_list(sdi->driver, sdi, channel_group, srci->key,
338 g_variant_get(gvar, "(tt)", &low, &high);
339 g_variant_unref(gvar);
340 printf(" Maximum number of samples: %"PRIu64"\n", high);
342 } else if (srci->key == SR_CONF_SAMPLERATE) {
343 /* Supported samplerates */
344 printf(" %s", srci->id);
345 if (sr_config_list(sdi->driver, sdi, channel_group, SR_CONF_SAMPLERATE,
346 &gvar_dict) != SR_OK) {
350 if ((gvar_list = g_variant_lookup_value(gvar_dict,
351 "samplerates", G_VARIANT_TYPE("at")))) {
352 uint64 = g_variant_get_fixed_array(gvar_list,
353 &num_elements, sizeof(uint64_t));
354 printf(" - supported samplerates:\n");
355 for (i = 0; i < num_elements; i++) {
356 if (!(s = sr_samplerate_string(uint64[i])))
361 g_variant_unref(gvar_list);
362 } else if ((gvar_list = g_variant_lookup_value(gvar_dict,
363 "samplerate-steps", G_VARIANT_TYPE("at")))) {
364 uint64 = g_variant_get_fixed_array(gvar_list,
365 &num_elements, sizeof(uint64_t));
367 if (!(s = sr_samplerate_string(uint64[0])))
372 if (!(s = sr_samplerate_string(uint64[1])))
377 if (!(s = sr_samplerate_string(uint64[2])))
379 printf(" in steps of %s)\n", s);
381 g_variant_unref(gvar_list);
383 g_variant_unref(gvar_dict);
385 } else if (srci->key == SR_CONF_BUFFERSIZE) {
386 /* Supported buffer sizes */
387 printf(" %s", srci->id);
388 if (sr_config_list(sdi->driver, sdi, channel_group,
389 SR_CONF_BUFFERSIZE, &gvar_list) != SR_OK) {
393 uint64 = g_variant_get_fixed_array(gvar_list,
394 &num_elements, sizeof(uint64_t));
395 printf(" - supported buffer sizes:\n");
396 for (i = 0; i < num_elements; i++)
397 printf(" %"PRIu64"\n", uint64[i]);
398 g_variant_unref(gvar_list);
400 } else if (srci->key == SR_CONF_TIMEBASE) {
401 /* Supported time bases */
402 printf(" %s", srci->id);
403 if (sr_config_list(sdi->driver, sdi, channel_group,
404 SR_CONF_TIMEBASE, &gvar_list) != SR_OK) {
408 printf(" - supported time bases:\n");
409 num_elements = g_variant_n_children(gvar_list);
410 for (i = 0; i < num_elements; i++) {
411 gvar = g_variant_get_child_value(gvar_list, i);
412 g_variant_get(gvar, "(tt)", &p, &q);
413 s = sr_period_string(p * q);
417 g_variant_unref(gvar_list);
419 } else if (srci->key == SR_CONF_VDIV) {
420 /* Supported volts/div values */
421 printf(" %s", srci->id);
422 if (sr_config_list(sdi->driver, sdi, channel_group,
423 SR_CONF_VDIV, &gvar_list) != SR_OK) {
427 printf(" - supported volts/div:\n");
428 num_elements = g_variant_n_children(gvar_list);
429 for (i = 0; i < num_elements; i++) {
430 gvar = g_variant_get_child_value(gvar_list, i);
431 g_variant_get(gvar, "(tt)", &p, &q);
432 s = sr_voltage_string(p, q);
436 g_variant_unref(gvar_list);
438 } else if (srci->datatype == SR_T_STRING) {
439 printf(" %s: ", srci->id);
440 if (sr_config_get(sdi->driver, sdi, channel_group, srci->key,
442 tmp_str = g_strdup(g_variant_get_string(gvar, NULL));
443 g_variant_unref(gvar);
447 if (sr_config_list(sdi->driver, sdi, channel_group, srci->key,
453 stropts = g_variant_get_strv(gvar, &num_elements);
454 for (i = 0; i < num_elements; i++) {
457 printf("%s", stropts[i]);
458 if (tmp_str && !strcmp(tmp_str, stropts[i]))
459 printf(" (current)");
464 g_variant_unref(gvar);
466 } else if (srci->datatype == SR_T_UINT64_RANGE) {
467 printf(" %s: ", srci->id);
468 if (sr_config_list(sdi->driver, sdi, channel_group, srci->key,
469 &gvar_list) != SR_OK) {
474 if (sr_config_get(sdi->driver, sdi, NULL, srci->key, &gvar) == SR_OK) {
475 g_variant_get(gvar, "(tt)", &cur_low, &cur_high);
476 g_variant_unref(gvar);
482 num_elements = g_variant_n_children(gvar_list);
483 for (i = 0; i < num_elements; i++) {
484 gvar = g_variant_get_child_value(gvar_list, i);
485 g_variant_get(gvar, "(tt)", &low, &high);
486 g_variant_unref(gvar);
489 printf("%"PRIu64"-%"PRIu64, low, high);
490 if (low == cur_low && high == cur_high)
491 printf(" (current)");
494 g_variant_unref(gvar_list);
496 } else if (srci->datatype == SR_T_BOOL) {
497 printf(" %s: ", srci->id);
498 if (sr_config_get(sdi->driver, sdi, NULL, srci->key,
500 if (g_variant_get_boolean(gvar))
501 printf("on (current), off\n");
503 printf("on, off (current)\n");
504 g_variant_unref(gvar);
508 } else if (srci->datatype == SR_T_DOUBLE_RANGE) {
509 printf(" %s: ", srci->id);
510 if (sr_config_list(sdi->driver, sdi, channel_group, srci->key,
511 &gvar_list) != SR_OK) {
516 if (sr_config_get(sdi->driver, sdi, NULL, srci->key, &gvar) == SR_OK) {
517 g_variant_get(gvar, "(dd)", &dcur_low, &dcur_high);
518 g_variant_unref(gvar);
524 num_elements = g_variant_n_children(gvar_list);
525 for (i = 0; i < num_elements; i++) {
526 gvar = g_variant_get_child_value(gvar_list, i);
527 g_variant_get(gvar, "(dd)", &dlow, &dhigh);
528 g_variant_unref(gvar);
531 printf("%.1f-%.1f", dlow, dhigh);
532 if (dlow == dcur_low && dhigh == dcur_high)
533 printf(" (current)");
536 g_variant_unref(gvar_list);
540 /* Everything else */
541 printf(" %s\n", srci->id);
544 g_variant_unref(gvar_opts);
551 void show_pd_detail(void)
553 struct srd_decoder *dec;
554 struct srd_decoder_option *o;
555 struct srd_channel *pdch;
556 struct srd_decoder_annotation_row *r;
559 char **pdtokens, **pdtok, *optsep, **ann, *val, *doc;
561 pdtokens = g_strsplit(opt_pds, ",", -1);
562 for (pdtok = pdtokens; *pdtok; pdtok++) {
564 if ((optsep = strchr(*pdtok, ':')))
566 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
567 g_critical("Protocol decoder %s not found.", *pdtok);
570 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
571 dec->id, dec->name, dec->longname, dec->desc);
572 printf("License: %s\n", dec->license);
573 printf("Annotation classes:\n");
574 if (dec->annotations) {
575 for (l = dec->annotations; l; l = l->next) {
577 printf("- %s: %s\n", ann[0], ann[1]);
582 printf("Annotation rows:\n");
583 if (dec->annotation_rows) {
584 for (l = dec->annotation_rows; l; l = l->next) {
586 printf("- %s (%s): ", r->id, r->desc);
587 for (ll = r->ann_classes; ll; ll = ll->next) {
588 idx = GPOINTER_TO_INT(ll->data);
589 ann = g_slist_nth_data(dec->annotations, idx);
590 printf("%s", ann[0]);
599 printf("Required channels:\n");
601 for (l = dec->channels; l; l = l->next) {
603 printf("- %s (%s): %s\n",
604 pdch->id, pdch->name, pdch->desc);
609 printf("Optional channels:\n");
610 if (dec->opt_channels) {
611 for (l = dec->opt_channels; l; l = l->next) {
613 printf("- %s (%s): %s\n",
614 pdch->id, pdch->name, pdch->desc);
619 printf("Options:\n");
621 for (l = dec->options; l; l = l->next) {
623 printf("- %s: %s (", o->id, o->desc);
624 for (ol = o->values; ol; ol = ol->next) {
625 val = g_variant_print(ol->data, FALSE);
629 val = g_variant_print(o->def, FALSE);
630 printf("default %s)\n", val);
636 if ((doc = srd_decoder_doc_get(dec))) {
637 printf("Documentation:\n%s\n",
638 doc[0] == '\n' ? doc + 1 : doc);
643 g_strfreev(pdtokens);
647 void show_input(void)
649 const struct sr_input_module *imod;
650 const struct sr_option **opts;
655 tok = g_strsplit(opt_input_format, ":", 0);
656 if (!tok[0] || !(imod = sr_input_find(tok[0])))
657 g_critical("Input module '%s' not found.", opt_input_format);
659 printf("ID: %s\nName: %s\n", sr_input_id_get(imod),
660 sr_input_name_get(imod));
661 printf("Description: %s\n", sr_input_description_get(imod));
662 if ((opts = sr_input_options_get(imod))) {
663 printf("Options:\n");
664 for (i = 0; opts[i]; i++) {
665 printf(" %s: %s", opts[i]->id, opts[i]->desc);
667 s = g_variant_print(opts[i]->def, FALSE);
668 printf(" (default %s", s);
670 if (opts[i]->values) {
671 printf(", possible values ");
672 for (l = opts[i]->values; l; l = l->next) {
673 s = g_variant_print((GVariant *)l->data, FALSE);
674 printf("%s%s", s, l->next ? ", " : "");
682 sr_input_options_free(opts);
687 void show_output(void)
689 const struct sr_output_module *omod;
690 const struct sr_option **opts;
695 tok = g_strsplit(opt_output_format, ":", 0);
696 if (!tok[0] || !(omod = sr_output_find(tok[0])))
697 g_critical("Output module '%s' not found.", opt_output_format);
699 printf("ID: %s\nName: %s\n", sr_output_id_get(omod),
700 sr_output_name_get(omod));
701 printf("Description: %s\n", sr_output_description_get(omod));
702 if ((opts = sr_output_options_get(omod))) {
703 printf("Options:\n");
704 for (i = 0; opts[i]; i++) {
705 printf(" %s: %s", opts[i]->id, opts[i]->desc);
707 s = g_variant_print(opts[i]->def, FALSE);
708 printf(" (default %s", s);
710 if (opts[i]->values) {
711 printf(", possible values ");
712 for (l = opts[i]->values; l; l = l->next) {
713 s = g_variant_print((GVariant *)l->data, FALSE);
714 printf("%s%s", s, l->next ? ", " : "");
722 sr_output_options_free(opts);