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 const struct sr_input_format *ia = a, *ib = b;
28 return strcmp(ia->id, ib->id);
31 static gint sort_outputs(gconstpointer a, gconstpointer b)
33 const struct sr_output_format *oa = a, *ob = b;
35 return strcmp(oa->id, ob->id);
38 static gint sort_drivers(gconstpointer a, gconstpointer b)
40 const struct sr_dev_driver *sdda = a, *sddb = b;
42 return strcmp(sdda->name, sddb->name);
46 static gint sort_pds(gconstpointer a, gconstpointer b)
48 const struct srd_decoder *sda = a, *sdb = b;
50 return strcmp(sda->id, sdb->id);
54 void show_version(void)
56 struct sr_dev_driver **drivers, *driver;
57 struct sr_input_format **inputs, *input;
58 struct sr_output_format **outputs, *output;
63 struct srd_decoder *dec;
66 printf("sigrok-cli %s\n\n", VERSION);
68 printf("Using libsigrok %s (lib version %s).\n",
69 sr_package_version_string_get(), sr_lib_version_string_get());
71 printf("Using libsigrokdecode %s (lib version %s).\n\n",
72 srd_package_version_string_get(), srd_lib_version_string_get());
75 printf("Supported hardware drivers:\n");
76 drivers = sr_driver_list();
77 for (sl = NULL, i = 0; drivers[i]; i++)
78 sl = g_slist_append(sl, drivers[i]);
79 sl = g_slist_sort(sl, sort_drivers);
80 for (l = sl; l; l = l->next) {
82 printf(" %-20s %s\n", driver->name, driver->longname);
87 printf("Supported input formats:\n");
88 inputs = sr_input_list();
89 for (sl = NULL, i = 0; inputs[i]; i++)
90 sl = g_slist_append(sl, inputs[i]);
91 sl = g_slist_sort(sl, sort_inputs);
92 for (l = sl; l; l = l->next) {
94 printf(" %-20s %s\n", input->id, input->description);
99 printf("Supported output formats:\n");
100 outputs = sr_output_list();
101 for (sl = NULL, i = 0; outputs[i]; i++)
102 sl = g_slist_append(sl, outputs[i]);
103 sl = g_slist_sort(sl, sort_outputs);
104 for (l = sl; l; l = l->next) {
106 printf(" %-20s %s\n", output->id, output->description);
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);
229 if (sr_dev_open(sdi) != SR_OK) {
230 g_critical("Failed to open device.");
234 if ((sr_config_list(sdi->driver, NULL, NULL, SR_CONF_SCAN_OPTIONS,
235 &gvar_opts) == SR_OK)) {
236 opts = g_variant_get_fixed_array(gvar_opts, &num_elements,
238 printf("Supported driver options:\n");
239 for (i = 0; i < num_elements; i++) {
240 if (!(srci = sr_config_info_get(opts[i])))
242 printf(" %s\n", srci->id);
244 g_variant_unref(gvar_opts);
247 /* Selected channels and channel group may affect which options are
248 * returned, or which values for them. */
249 select_channels(sdi);
250 channel_group = select_channel_group(sdi);
252 if ((sr_config_list(sdi->driver, sdi, channel_group, SR_CONF_DEVICE_OPTIONS,
253 &gvar_opts)) != SR_OK)
254 /* Driver supports no device instance options. */
257 if (sdi->channel_groups) {
258 printf("Channel groups:\n");
259 for (cgl = sdi->channel_groups; cgl; cgl = cgl->next) {
261 printf(" %s: channel%s", cg->name,
262 g_slist_length(cg->channels) > 1 ? "s" : "");
263 for (chl = cg->channels; chl; chl = chl->next) {
265 printf(" %s", ch->name);
271 printf("Supported configuration options");
272 if (sdi->channel_groups) {
274 printf(" across all channel groups");
276 printf(" on channel group %s", channel_group->name);
279 opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(int32_t));
280 for (o = 0; o < num_opts; o++) {
281 if (!(srci = sr_config_info_get(opts[o])))
284 if (srci->key == SR_CONF_TRIGGER_MATCH) {
285 if (sr_config_list(sdi->driver, sdi, channel_group, srci->key,
286 &gvar_list) != SR_OK) {
290 int32 = g_variant_get_fixed_array(gvar_list,
291 &num_elements, sizeof(int32_t));
292 printf(" Supported triggers: ");
293 for (i = 0; i < num_elements; i++) {
295 case SR_TRIGGER_ZERO:
301 case SR_TRIGGER_RISING:
304 case SR_TRIGGER_FALLING:
307 case SR_TRIGGER_EDGE:
310 case SR_TRIGGER_OVER:
313 case SR_TRIGGER_UNDER:
324 g_variant_unref(gvar_list);
326 } else if (srci->key == SR_CONF_LIMIT_SAMPLES) {
327 /* If implemented in config_list(), this denotes the
328 * maximum number of samples a device can send. This
329 * really applies only to logic analyzers, and then
330 * only to those that don't support compression, or
331 * have it turned off by default. The values returned
332 * are the low/high limits. */
333 if (sr_config_list(sdi->driver, sdi, channel_group, srci->key,
337 g_variant_get(gvar, "(tt)", &low, &high);
338 g_variant_unref(gvar);
339 printf(" Maximum number of samples: %"PRIu64"\n", high);
341 } else if (srci->key == SR_CONF_SAMPLERATE) {
342 /* Supported samplerates */
343 printf(" %s", srci->id);
344 if (sr_config_list(sdi->driver, sdi, channel_group, SR_CONF_SAMPLERATE,
345 &gvar_dict) != SR_OK) {
349 if ((gvar_list = g_variant_lookup_value(gvar_dict,
350 "samplerates", G_VARIANT_TYPE("at")))) {
351 uint64 = g_variant_get_fixed_array(gvar_list,
352 &num_elements, sizeof(uint64_t));
353 printf(" - supported samplerates:\n");
354 for (i = 0; i < num_elements; i++) {
355 if (!(s = sr_samplerate_string(uint64[i])))
360 g_variant_unref(gvar_list);
361 } else if ((gvar_list = g_variant_lookup_value(gvar_dict,
362 "samplerate-steps", G_VARIANT_TYPE("at")))) {
363 uint64 = g_variant_get_fixed_array(gvar_list,
364 &num_elements, sizeof(uint64_t));
366 if (!(s = sr_samplerate_string(uint64[0])))
371 if (!(s = sr_samplerate_string(uint64[1])))
376 if (!(s = sr_samplerate_string(uint64[2])))
378 printf(" in steps of %s)\n", s);
380 g_variant_unref(gvar_list);
382 g_variant_unref(gvar_dict);
384 } else if (srci->key == SR_CONF_BUFFERSIZE) {
385 /* Supported buffer sizes */
386 printf(" %s", srci->id);
387 if (sr_config_list(sdi->driver, sdi, channel_group,
388 SR_CONF_BUFFERSIZE, &gvar_list) != SR_OK) {
392 uint64 = g_variant_get_fixed_array(gvar_list,
393 &num_elements, sizeof(uint64_t));
394 printf(" - supported buffer sizes:\n");
395 for (i = 0; i < num_elements; i++)
396 printf(" %"PRIu64"\n", uint64[i]);
397 g_variant_unref(gvar_list);
399 } else if (srci->key == SR_CONF_TIMEBASE) {
400 /* Supported time bases */
401 printf(" %s", srci->id);
402 if (sr_config_list(sdi->driver, sdi, channel_group,
403 SR_CONF_TIMEBASE, &gvar_list) != SR_OK) {
407 printf(" - supported time bases:\n");
408 num_elements = g_variant_n_children(gvar_list);
409 for (i = 0; i < num_elements; i++) {
410 gvar = g_variant_get_child_value(gvar_list, i);
411 g_variant_get(gvar, "(tt)", &p, &q);
412 s = sr_period_string(p * q);
416 g_variant_unref(gvar_list);
418 } else if (srci->key == SR_CONF_VDIV) {
419 /* Supported volts/div values */
420 printf(" %s", srci->id);
421 if (sr_config_list(sdi->driver, sdi, channel_group,
422 SR_CONF_VDIV, &gvar_list) != SR_OK) {
426 printf(" - supported volts/div:\n");
427 num_elements = g_variant_n_children(gvar_list);
428 for (i = 0; i < num_elements; i++) {
429 gvar = g_variant_get_child_value(gvar_list, i);
430 g_variant_get(gvar, "(tt)", &p, &q);
431 s = sr_voltage_string(p, q);
435 g_variant_unref(gvar_list);
437 } else if (srci->datatype == SR_T_STRING) {
438 printf(" %s: ", srci->id);
439 if (sr_config_get(sdi->driver, sdi, channel_group, srci->key,
441 tmp_str = g_strdup(g_variant_get_string(gvar, NULL));
442 g_variant_unref(gvar);
446 if (sr_config_list(sdi->driver, sdi, channel_group, srci->key,
452 stropts = g_variant_get_strv(gvar, &num_elements);
453 for (i = 0; i < num_elements; i++) {
456 printf("%s", stropts[i]);
457 if (tmp_str && !strcmp(tmp_str, stropts[i]))
458 printf(" (current)");
463 g_variant_unref(gvar);
465 } else if (srci->datatype == SR_T_UINT64_RANGE) {
466 printf(" %s: ", srci->id);
467 if (sr_config_list(sdi->driver, sdi, channel_group, srci->key,
468 &gvar_list) != SR_OK) {
473 if (sr_config_get(sdi->driver, sdi, NULL, srci->key, &gvar) == SR_OK) {
474 g_variant_get(gvar, "(tt)", &cur_low, &cur_high);
475 g_variant_unref(gvar);
481 num_elements = g_variant_n_children(gvar_list);
482 for (i = 0; i < num_elements; i++) {
483 gvar = g_variant_get_child_value(gvar_list, i);
484 g_variant_get(gvar, "(tt)", &low, &high);
485 g_variant_unref(gvar);
488 printf("%"PRIu64"-%"PRIu64, low, high);
489 if (low == cur_low && high == cur_high)
490 printf(" (current)");
493 g_variant_unref(gvar_list);
495 } else if (srci->datatype == SR_T_BOOL) {
496 printf(" %s: ", srci->id);
497 if (sr_config_get(sdi->driver, sdi, NULL, srci->key,
499 if (g_variant_get_boolean(gvar))
500 printf("on (current), off\n");
502 printf("on, off (current)\n");
503 g_variant_unref(gvar);
507 } else if (srci->datatype == SR_T_DOUBLE_RANGE) {
508 printf(" %s: ", srci->id);
509 if (sr_config_list(sdi->driver, sdi, channel_group, srci->key,
510 &gvar_list) != SR_OK) {
515 if (sr_config_get(sdi->driver, sdi, NULL, srci->key, &gvar) == SR_OK) {
516 g_variant_get(gvar, "(dd)", &dcur_low, &dcur_high);
517 g_variant_unref(gvar);
523 num_elements = g_variant_n_children(gvar_list);
524 for (i = 0; i < num_elements; i++) {
525 gvar = g_variant_get_child_value(gvar_list, i);
526 g_variant_get(gvar, "(dd)", &dlow, &dhigh);
527 g_variant_unref(gvar);
530 printf("%.1f-%.1f", dlow, dhigh);
531 if (dlow == dcur_low && dhigh == dcur_high)
532 printf(" (current)");
535 g_variant_unref(gvar_list);
539 /* Everything else */
540 printf(" %s\n", srci->id);
543 g_variant_unref(gvar_opts);
546 g_slist_free(devices);
551 void show_pd_detail(void)
554 struct srd_decoder *dec;
555 struct srd_decoder_option *o;
556 char **pdtokens, **pdtok, *optsep, **ann, *val, *doc;
557 struct srd_channel *pdch;
558 struct srd_decoder_annotation_row *r;
560 pdtokens = g_strsplit(opt_pds, ",", -1);
561 for (pdtok = pdtokens; *pdtok; pdtok++) {
563 if ((optsep = strchr(*pdtok, ':')))
565 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
566 g_critical("Protocol decoder %s not found.", *pdtok);
569 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
570 dec->id, dec->name, dec->longname, dec->desc);
571 printf("License: %s\n", dec->license);
572 printf("Annotation classes:\n");
573 if (dec->annotations) {
574 for (l = dec->annotations; l; l = l->next) {
576 printf("- %s: %s\n", ann[0], ann[1]);
581 printf("Annotation rows:\n");
582 if (dec->annotation_rows) {
583 for (l = dec->annotation_rows; l; l = l->next) {
585 printf("- %s (%s): ", r->id, r->desc);
586 for (ll = r->ann_classes; ll; ll = ll->next)
587 printf("%d ", GPOINTER_TO_INT(ll->data));
593 printf("Required channels:\n");
595 for (l = dec->channels; l; l = l->next) {
597 printf("- %s (%s): %s\n",
598 pdch->id, pdch->name, pdch->desc);
603 printf("Optional channels:\n");
604 if (dec->opt_channels) {
605 for (l = dec->opt_channels; l; l = l->next) {
607 printf("- %s (%s): %s\n",
608 pdch->id, pdch->name, pdch->desc);
613 printf("Options:\n");
615 for (l = dec->options; l; l = l->next) {
617 printf("- %s: %s (", o->id, o->desc);
618 for (ol = o->values; ol; ol = ol->next) {
619 val = g_variant_print(ol->data, FALSE);
623 val = g_variant_print(o->def, FALSE);
624 printf("default %s)\n", val);
630 if ((doc = srd_decoder_doc_get(dec))) {
631 printf("Documentation:\n%s\n",
632 doc[0] == '\n' ? doc + 1 : doc);
637 g_strfreev(pdtokens);