sigrok-cli.c

   1 /*
   2  * This file is part of the sigrok-cli project.
   3  *
   4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 #include "config.h"
  21 #ifdef HAVE_SRD
  22 #include <libsigrokdecode/libsigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
  23 #endif
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <unistd.h>
  27 #include <string.h>
  28 #include <time.h>
  29 #include <sys/time.h>
  30 #include <inttypes.h>
  31 #include <sys/types.h>
  32 #include <sys/stat.h>
  33 #include <errno.h>
  34 #include <glib.h>
  35 #include <glib/gstdio.h>
  36 #include <libsigrok/libsigrok.h>
  37 #include "sigrok-cli.h"
  38
  39 #define DEFAULT_OUTPUT_FORMAT "bits:width=64"
  40
  41 static struct sr_context *sr_ctx = NULL;
  42
  43 static uint64_t limit_samples = 0;
  44 static uint64_t limit_frames = 0;
  45 static struct sr_output_format *output_format = NULL;
  46 static int default_output_format = FALSE;
  47 static char *output_format_param = NULL;
  48 #ifdef HAVE_SRD
  49 static struct srd_session *srd_sess = NULL;
  50 static GHashTable *pd_ann_visible = NULL;
  51 #endif
  52 static GByteArray *savebuf;
  53
  54 static gboolean opt_version = FALSE;
  55 static gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
  56 static gboolean opt_scan_devs = FALSE;
  57 static gboolean opt_wait_trigger = FALSE;
  58 static gchar *opt_input_file = NULL;
  59 static gchar *opt_output_file = NULL;
  60 static gchar *opt_drv = NULL;
  61 static gchar *opt_config = NULL;
  62 static gchar *opt_probes = NULL;
  63 static gchar *opt_triggers = NULL;
  64 static gchar *opt_pds = NULL;
  65 #ifdef HAVE_SRD
  66 static gchar *opt_pd_stack = NULL;
  67 static gchar *opt_pd_annotations = NULL;
  68 #endif
  69 static gchar *opt_input_format = NULL;
  70 static gchar *opt_output_format = NULL;
  71 static gchar *opt_show = NULL;
  72 static gchar *opt_time = NULL;
  73 static gchar *opt_samples = NULL;
  74 static gchar *opt_frames = NULL;
  75 static gchar *opt_continuous = NULL;
  76 static gchar *opt_set = NULL;
  77
  78 static GOptionEntry optargs[] = {
  79         {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version,
  80                         "Show version and support list", NULL},
  81         {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel,
  82                         "Set loglevel (5 is most verbose)", NULL},
  83         {"driver", 'd', 0, G_OPTION_ARG_STRING, &opt_drv,
  84                         "The driver to use", NULL},
  85         {"config", 'c', 0, G_OPTION_ARG_STRING, &opt_config,
  86                         "Specify device configuration options", NULL},
  87         {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file,
  88                         "Load input from file", NULL},
  89         {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format,
  90                         "Input format", NULL},
  91         {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file,
  92                         "Save output to file", NULL},
  93         {"output-format", 'O', 0, G_OPTION_ARG_STRING, &opt_output_format,
  94                         "Output format", NULL},
  95         {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes,
  96                         "Probes to use", NULL},
  97         {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers,
  98                         "Trigger configuration", NULL},
  99         {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger,
 100                         "Wait for trigger", NULL},
 101 #ifdef HAVE_SRD
 102         {"protocol-decoders", 'P', 0, G_OPTION_ARG_STRING, &opt_pds,
 103                         "Protocol decoders to run", NULL},
 104         {"protocol-decoder-stack", 'S', 0, G_OPTION_ARG_STRING, &opt_pd_stack,
 105                         "Protocol decoder stack", NULL},
 106         {"protocol-decoder-annotations", 'A', 0, G_OPTION_ARG_STRING, &opt_pd_annotations,
 107                         "Protocol decoder annotation(s) to show", NULL},
 108 #endif
 109         {"scan", 0, 0, G_OPTION_ARG_NONE, &opt_scan_devs,
 110                         "Scan for devices", NULL},
 111         {"show", 0, 0, G_OPTION_ARG_NONE, &opt_show,
 112                         "Show device detail", NULL},
 113         {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time,
 114                         "How long to sample (ms)", NULL},
 115         {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples,
 116                         "Number of samples to acquire", NULL},
 117         {"frames", 0, 0, G_OPTION_ARG_STRING, &opt_frames,
 118                         "Number of frames to acquire", NULL},
 119         {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous,
 120                         "Sample continuously", NULL},
 121         {"set", 0, 0, G_OPTION_ARG_NONE, &opt_set, "Set device options only", NULL},
 122         {NULL, 0, 0, 0, NULL, NULL, NULL}
 123 };
 124
 125
 126 /* Convert driver options hash to GSList of struct sr_config. */
 127 static GSList *hash_to_hwopt(GHashTable *hash)
 128 {
 129         const struct sr_config_info *srci;
 130         struct sr_config *src;
 131         GList *gl, *keys;
 132         GSList *opts;
 133         char *key, *value;
 134
 135         keys = g_hash_table_get_keys(hash);
 136         opts = NULL;
 137         for (gl = keys; gl; gl = gl->next) {
 138                 key = gl->data;
 139                 if (!(srci = sr_config_info_name_get(key))) {
 140                         g_critical("Unknown option %s", key);
 141                         return NULL;
 142                 }
 143                 src = g_try_malloc(sizeof(struct sr_config));
 144                 src->key = srci->key;
 145                 value = g_hash_table_lookup(hash, key);
 146                 src->data = g_variant_new_string(value);
 147                 opts = g_slist_append(opts, src);
 148         }
 149         g_list_free(keys);
 150
 151         return opts;
 152 }
 153
 154 static void free_drvopts(struct sr_config *src)
 155 {
 156         g_variant_unref(src->data);
 157         g_free(src);
 158 }
 159
 160 static GSList *device_scan(void)
 161 {
 162         struct sr_dev_driver **drivers, *driver;
 163         GHashTable *drvargs;
 164         GSList *drvopts, *devices, *tmpdevs, *l;
 165         int i;
 166         char *drvname;
 167
 168         if (opt_drv) {
 169                 drvargs = parse_generic_arg(opt_drv, TRUE);
 170                 drvname = g_strdup(g_hash_table_lookup(drvargs, "sigrok_key"));
 171                 g_hash_table_remove(drvargs, "sigrok_key");
 172                 driver = NULL;
 173                 drivers = sr_driver_list();
 174                 for (i = 0; drivers[i]; i++) {
 175                         if (strcmp(drivers[i]->name, drvname))
 176                                 continue;
 177                         driver = drivers[i];
 178                 }
 179                 if (!driver) {
 180                         g_critical("Driver %s not found.", drvname);
 181                         return NULL;
 182                 }
 183                 g_free(drvname);
 184                 if (sr_driver_init(sr_ctx, driver) != SR_OK) {
 185                         g_critical("Failed to initialize driver.");
 186                         return NULL;
 187                 }
 188                 drvopts = NULL;
 189                 if (g_hash_table_size(drvargs) > 0) {
 190                         if (!(drvopts = hash_to_hwopt(drvargs))) {
 191                                 /* Unknown options, already logged. */
 192                                 g_hash_table_destroy(drvargs);
 193                                 return NULL;
 194                         }
 195                 }
 196                 g_hash_table_destroy(drvargs);
 197                 devices = sr_driver_scan(driver, drvopts);
 198                 g_slist_free_full(drvopts, (GDestroyNotify)free_drvopts);
 199         } else {
 200                 /* No driver specified, let them all scan on their own. */
 201                 devices = NULL;
 202                 drivers = sr_driver_list();
 203                 for (i = 0; drivers[i]; i++) {
 204                         driver = drivers[i];
 205                         if (sr_driver_init(sr_ctx, driver) != SR_OK) {
 206                                 g_critical("Failed to initialize driver.");
 207                                 return NULL;
 208                         }
 209                         tmpdevs = sr_driver_scan(driver, NULL);
 210                         for (l = tmpdevs; l; l = l->next)
 211                                 devices = g_slist_append(devices, l->data);
 212                         g_slist_free(tmpdevs);
 213                 }
 214         }
 215
 216         return devices;
 217 }
 218
 219 static void show_version(void)
 220 {
 221         struct sr_dev_driver **drivers;
 222         struct sr_input_format **inputs;
 223         struct sr_output_format **outputs;
 224         int i;
 225 #ifdef HAVE_SRD
 226         struct srd_decoder *dec;
 227         const GSList *l;
 228 #endif
 229
 230         printf("sigrok-cli %s\n\n", VERSION);
 231
 232         printf("Using libsigrok %s (lib version %s).\n",
 233                sr_package_version_string_get(), sr_lib_version_string_get());
 234 #ifdef HAVE_SRD
 235         printf("Using libsigrokdecode %s (lib version %s).\n\n",
 236                srd_package_version_string_get(), srd_lib_version_string_get());
 237 #endif
 238
 239         printf("Supported hardware drivers:\n");
 240         drivers = sr_driver_list();
 241         for (i = 0; drivers[i]; i++) {
 242                 printf("  %-20s %s\n", drivers[i]->name, drivers[i]->longname);
 243         }
 244         printf("\n");
 245
 246         printf("Supported input formats:\n");
 247         inputs = sr_input_list();
 248         for (i = 0; inputs[i]; i++)
 249                 printf("  %-20s %s\n", inputs[i]->id, inputs[i]->description);
 250         printf("\n");
 251
 252         printf("Supported output formats:\n");
 253         outputs = sr_output_list();
 254         for (i = 0; outputs[i]; i++)
 255                 printf("  %-20s %s\n", outputs[i]->id, outputs[i]->description);
 256         printf("  %-20s %s\n", "sigrok", "Default file output format");
 257         printf("\n");
 258
 259 #ifdef HAVE_SRD
 260         if (srd_init(NULL) == SRD_OK) {
 261                 printf("Supported protocol decoders:\n");
 262                 srd_decoder_load_all();
 263                 for (l = srd_decoder_list(); l; l = l->next) {
 264                         dec = l->data;
 265                         printf("  %-20s %s\n", dec->id, dec->longname);
 266                         /* Print protocol description upon "-l 3" or higher. */
 267                         if (opt_loglevel >= SR_LOG_INFO)
 268                                 printf("  %-20s %s\n", "", dec->desc);
 269                 }
 270                 srd_exit();
 271         }
 272         printf("\n");
 273 #endif
 274 }
 275
 276 static void print_dev_line(const struct sr_dev_inst *sdi)
 277 {
 278         struct sr_probe *probe;
 279         GSList *l;
 280         GString *s;
 281         GVariant *gvar;
 282
 283         s = g_string_sized_new(128);
 284         g_string_assign(s, sdi->driver->name);
 285         if (sr_config_get(sdi->driver, SR_CONF_CONN, &gvar, sdi) == SR_OK) {
 286                 g_string_append(s, ":conn=");
 287                 g_string_append(s, g_variant_get_string(gvar, NULL));
 288                 g_variant_unref(gvar);
 289         }
 290         g_string_append(s, " - ");
 291         if (sdi->vendor && sdi->vendor[0])
 292                 g_string_append_printf(s, "%s ", sdi->vendor);
 293         if (sdi->model && sdi->model[0])
 294                 g_string_append_printf(s, "%s ", sdi->model);
 295         if (sdi->version && sdi->version[0])
 296                 g_string_append_printf(s, "%s ", sdi->version);
 297         if (sdi->probes) {
 298                 if (g_slist_length(sdi->probes) == 1) {
 299                         probe = sdi->probes->data;
 300                         g_string_append_printf(s, "with 1 probe: %s", probe->name);
 301                 } else {
 302                         g_string_append_printf(s, "with %d probes:", g_slist_length(sdi->probes));
 303                         for (l = sdi->probes; l; l = l->next) {
 304                                 probe = l->data;
 305                                 g_string_append_printf(s, " %s", probe->name);
 306                         }
 307                 }
 308         }
 309         g_string_append_printf(s, "\n");
 310         printf("%s", s->str);
 311         g_string_free(s, TRUE);
 312
 313 }
 314
 315 static void show_dev_list(void)
 316 {
 317         struct sr_dev_inst *sdi;
 318         GSList *devices, *l;
 319
 320         if (!(devices = device_scan()))
 321                 return;
 322
 323         printf("The following devices were found:\n");
 324         for (l = devices; l; l = l->next) {
 325                 sdi = l->data;
 326                 print_dev_line(sdi);
 327         }
 328         g_slist_free(devices);
 329
 330 }
 331
 332 static void show_dev_detail(void)
 333 {
 334         struct sr_dev_inst *sdi;
 335         const struct sr_config_info *srci;
 336         GSList *devices;
 337         GVariant *gvar_opts, *gvar_dict, *gvar_list, *gvar;
 338         gsize num_opts, num_elements;
 339         const uint64_t *uint64, p, q, low, high;
 340         uint64_t cur_low, cur_high;
 341         const int32_t *opts;
 342         unsigned int num_devices, o, i;
 343         char *tmp_str;
 344         char *s;
 345         const char *charopts, **stropts;
 346
 347         if (!(devices = device_scan())) {
 348                 g_critical("No devices found.");
 349                 return;
 350         }
 351
 352         num_devices = g_slist_length(devices);
 353         if (num_devices > 1) {
 354                 g_critical("%d devices found. Use --scan to show them, "
 355                                 "and select one to show.", num_devices);
 356                 return;
 357         }
 358
 359         sdi = devices->data;
 360         print_dev_line(sdi);
 361
 362         if (sr_dev_open(sdi) != SR_OK) {
 363                 g_critical("Failed to open device.");
 364                 return;
 365         }
 366
 367         if ((sr_config_list(sdi->driver, SR_CONF_SCAN_OPTIONS, &gvar_opts,
 368                         NULL) == SR_OK)) {
 369                 opts = g_variant_get_fixed_array(gvar_opts, &num_elements,
 370                                 sizeof(int32_t));
 371                 printf("Supported driver options:\n");
 372                 for (i = 0; i < num_elements; i++) {
 373                         if (!(srci = sr_config_info_get(opts[i])))
 374                                 continue;
 375                         printf("    %s\n", srci->id);
 376                 }
 377                 g_variant_unref(gvar_opts);
 378         }
 379
 380         if ((sr_config_list(sdi->driver, SR_CONF_DEVICE_OPTIONS, &gvar_opts,
 381                         sdi) != SR_OK))
 382                 /* Driver supports no device instance options. */
 383                 return;
 384
 385         printf("Supported configuration options:\n");
 386         opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(int32_t));
 387         for (o = 0; o < num_opts; o++) {
 388                 if (!(srci = sr_config_info_get(opts[o])))
 389                         continue;
 390
 391                 if (srci->key == SR_CONF_TRIGGER_TYPE) {
 392                         if (sr_config_list(sdi->driver, srci->key, &gvar,
 393                                         sdi) != SR_OK) {
 394                                 printf("\n");
 395                                 continue;
 396                         }
 397                         charopts = g_variant_get_string(gvar, NULL);
 398                         printf("    Supported triggers: ");
 399                         while (*charopts) {
 400                                 printf("%c ", *charopts);
 401                                 charopts++;
 402                         }
 403                         printf("\n");
 404                         g_variant_unref(gvar);
 405
 406                 } else if (srci->key == SR_CONF_PATTERN_MODE) {
 407                         /* Pattern generator modes */
 408                         printf("    %s", srci->id);
 409                         if (sr_config_list(sdi->driver, srci->key, &gvar,
 410                                         sdi) == SR_OK) {
 411                                 printf(" - supported patterns:\n");
 412                                 stropts = g_variant_get_strv(gvar, &num_elements);
 413                                 for (i = 0; i < num_elements; i++)
 414                                         printf("      %s\n", stropts[i]);
 415                                 g_variant_unref(gvar);
 416                         } else {
 417                                 printf("\n");
 418                         }
 419
 420                 } else if (srci->key == SR_CONF_SAMPLERATE) {
 421                         /* Supported samplerates */
 422                         printf("    %s", srci->id);
 423                         if (sr_config_list(sdi->driver, SR_CONF_SAMPLERATE,
 424                                         &gvar_dict, sdi) != SR_OK) {
 425                                 printf("\n");
 426                                 continue;
 427                         }
 428                         if ((gvar_list = g_variant_lookup_value(gvar_dict,
 429                                         "samplerates", G_VARIANT_TYPE("at")))) {
 430                                 uint64 = g_variant_get_fixed_array(gvar_list,
 431                                                 &num_elements, sizeof(uint64_t));
 432                                 printf(" - supported samplerates:\n");
 433                                 for (i = 0; i < num_elements; i++) {
 434                                         if (!(s = sr_samplerate_string(uint64[i])))
 435                                                 continue;
 436                                         printf("      %s\n", s);
 437                                         g_free(s);
 438                                 }
 439                                 g_variant_unref(gvar_list);
 440                         } else if ((gvar_list = g_variant_lookup_value(gvar_dict,
 441                                         "samplerate-steps", G_VARIANT_TYPE("at")))) {
 442                                 uint64 = g_variant_get_fixed_array(gvar_list,
 443                                                 &num_elements, sizeof(uint64_t));
 444                                 /* low */
 445                                 if (!(s = sr_samplerate_string(uint64[0])))
 446                                         continue;
 447                                 printf(" (%s", s);
 448                                 g_free(s);
 449                                 /* high */
 450                                 if (!(s = sr_samplerate_string(uint64[1])))
 451                                         continue;
 452                                 printf(" - %s", s);
 453                                 g_free(s);
 454                                 /* step */
 455                                 if (!(s = sr_samplerate_string(uint64[2])))
 456                                         continue;
 457                                 printf(" in steps of %s)\n", s);
 458                                 g_free(s);
 459                                 g_variant_unref(gvar_list);
 460                         }
 461                         g_variant_unref(gvar_dict);
 462
 463                 } else if (srci->key == SR_CONF_BUFFERSIZE) {
 464                         /* Supported buffer sizes */
 465                         printf("    %s", srci->id);
 466                         if (sr_config_list(sdi->driver, SR_CONF_BUFFERSIZE,
 467                                         &gvar_list, sdi) != SR_OK) {
 468                                 printf("\n");
 469                                 continue;
 470                         }
 471                         uint64 = g_variant_get_fixed_array(gvar_list,
 472                                         &num_elements, sizeof(uint64_t));
 473                         printf(" - supported buffer sizes:\n");
 474                         for (i = 0; i < num_elements; i++)
 475                                 printf("      %"PRIu64"\n", uint64[i]);
 476                         g_variant_unref(gvar_list);
 477
 478                 } else if (srci->key == SR_CONF_TIMEBASE) {
 479                         /* Supported time bases */
 480                         printf("    %s", srci->id);
 481                         if (sr_config_list(sdi->driver, SR_CONF_TIMEBASE,
 482                                         &gvar_list, sdi) != SR_OK) {
 483                                 printf("\n");
 484                                 continue;
 485                         }
 486                         printf(" - supported time bases:\n");
 487                         num_elements = g_variant_n_children(gvar_list);
 488                         for (i = 0; i < num_elements; i++) {
 489                                 gvar = g_variant_get_child_value(gvar_list, i);
 490                                 g_variant_get(gvar, "(tt)", &p, &q);
 491                                 s = sr_period_string(p * q);
 492                                 printf("      %s\n", s);
 493                                 g_free(s);
 494                         }
 495                         g_variant_unref(gvar_list);
 496
 497                 } else if (srci->key == SR_CONF_VDIV) {
 498                         /* Supported volts/div values */
 499                         printf("    %s", srci->id);
 500                         if (sr_config_list(sdi->driver, SR_CONF_VDIV,
 501                                         &gvar_list, sdi) != SR_OK) {
 502                                 printf("\n");
 503                                 continue;
 504                         }
 505                         printf(" - supported volts/div:\n");
 506                         num_elements = g_variant_n_children(gvar_list);
 507                         for (i = 0; i < num_elements; i++) {
 508                                 gvar = g_variant_get_child_value(gvar_list, i);
 509                                 g_variant_get(gvar, "(tt)", &p, &q);
 510                                 s = sr_voltage_string(p, q);
 511                                 printf("      %s\n", s);
 512                                 g_free(s);
 513                         }
 514                         g_variant_unref(gvar_list);
 515
 516                 } else if (srci->datatype == SR_T_CHAR) {
 517                         printf("    %s: ", srci->id);
 518                         if (sr_config_get(sdi->driver, srci->key,
 519                                         &gvar, sdi) == SR_OK) {
 520                                 tmp_str = g_strdup(g_variant_get_string(gvar, NULL));
 521                                 g_variant_unref(gvar);
 522                         } else
 523                                 tmp_str = NULL;
 524
 525                         if (sr_config_list(sdi->driver, srci->key,
 526                                         &gvar, sdi) != SR_OK) {
 527                                 printf("\n");
 528                                 continue;
 529                         }
 530
 531                         stropts = g_variant_get_strv(gvar, &num_elements);
 532                         for (i = 0; i < num_elements; i++) {
 533                                 if (i)
 534                                         printf(", ");
 535                                 printf("%s", stropts[i]);
 536                                 if (tmp_str && !strcmp(tmp_str, stropts[i]))
 537                                         printf(" (current)");
 538                         }
 539                         printf("\n");
 540                         g_free(stropts);
 541                         g_free(tmp_str);
 542                         g_variant_unref(gvar);
 543
 544                 } else if (srci->datatype == SR_T_UINT64_RANGE) {
 545                         printf("    %s: ", srci->id);
 546                         if (sr_config_list(sdi->driver, srci->key,
 547                                         &gvar_list, sdi) != SR_OK) {
 548                                 printf("\n");
 549                                 continue;
 550                         }
 551
 552                         if (sr_config_get(sdi->driver, srci->key, &gvar, sdi) == SR_OK) {
 553                                 g_variant_get(gvar, "(tt)", &cur_low, &cur_high);
 554                                 g_variant_unref(gvar);
 555                         } else {
 556                                 cur_low = 0;
 557                                 cur_high = 0;
 558                         }
 559
 560                         num_elements = g_variant_n_children(gvar_list);
 561                         for (i = 0; i < num_elements; i++) {
 562                                 gvar = g_variant_get_child_value(gvar_list, i);
 563                                 g_variant_get(gvar, "(tt)", &low, &high);
 564                                 g_variant_unref(gvar);
 565                                 if (i)
 566                                         printf(", ");
 567                                 printf("%"PRIu64"-%"PRIu64, low, high);
 568                                 if (low == cur_low && high == cur_high)
 569                                         printf(" (current)");
 570                         }
 571                         printf("\n");
 572                         g_variant_unref(gvar_list);
 573
 574                 } else if (srci->datatype == SR_T_BOOL) {
 575                         printf("    %s: ", srci->id);
 576                         if (sr_config_get(sdi->driver, srci->key,
 577                                         &gvar, sdi) == SR_OK) {
 578                                 if (g_variant_get_boolean(gvar))
 579                                         printf("on (current), off\n");
 580                                 else
 581                                         printf("on, off (current)\n");
 582                                 g_variant_unref(gvar);
 583                         } else
 584                                 printf("on, off\n");
 585
 586                 } else {
 587
 588                         /* Everything else */
 589                         printf("    %s\n", srci->id);
 590                 }
 591         }
 592         g_variant_unref(gvar_opts);
 593
 594         sr_dev_close(sdi);
 595         g_slist_free(devices);
 596
 597 }
 598
 599 #ifdef HAVE_SRD
 600 static void show_pd_detail(void)
 601 {
 602         GSList *l;
 603         struct srd_decoder *dec;
 604         struct srd_decoder_option *o;
 605         char **pdtokens, **pdtok, *optsep, **ann, *val, *doc;
 606         struct srd_probe *p;
 607
 608         pdtokens = g_strsplit(opt_pds, ",", -1);
 609         for (pdtok = pdtokens; *pdtok; pdtok++) {
 610                 /* Strip options. */
 611                 if ((optsep = strchr(*pdtok, ':')))
 612                         *optsep = '\0';
 613                 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
 614                         g_critical("Protocol decoder %s not found.", *pdtok);
 615                         return;
 616                 }
 617                 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
 618                                 dec->id, dec->name, dec->longname, dec->desc);
 619                 printf("License: %s\n", dec->license);
 620                 printf("Annotations:\n");
 621                 if (dec->annotations) {
 622                         for (l = dec->annotations; l; l = l->next) {
 623                                 ann = l->data;
 624                                 printf("- %s\n  %s\n", ann[0], ann[1]);
 625                         }
 626                 } else {
 627                         printf("None.\n");
 628                 }
 629                 printf("Required probes:\n");
 630                 if (dec->probes) {
 631                         for (l = dec->probes; l; l = l->next) {
 632                                 p = l->data;
 633                                 printf("- %s (%s): %s\n",
 634                                        p->name, p->id, p->desc);
 635                         }
 636                 } else {
 637                         printf("None.\n");
 638                 }
 639                 printf("Optional probes:\n");
 640                 if (dec->opt_probes) {
 641                         for (l = dec->opt_probes; l; l = l->next) {
 642                                 p = l->data;
 643                                 printf("- %s (%s): %s\n",
 644                                        p->name, p->id, p->desc);
 645                         }
 646                 } else {
 647                         printf("None.\n");
 648                 }
 649                 if (dec->options) {
 650                         printf("Options:\n");
 651                         for (l = dec->options; l; l = l->next) {
 652                                 o = l->data;
 653                                 val = g_variant_print(o->def, FALSE);
 654                                 printf("- %s: %s (default %s)\n", o->id, o->desc, val);
 655                                 g_free(val);
 656                         }
 657                 }
 658                 if ((doc = srd_decoder_doc_get(dec))) {
 659                         printf("Documentation:\n%s\n",
 660                                doc[0] == '\n' ? doc + 1 : doc);
 661                         g_free(doc);
 662                 }
 663         }
 664
 665         g_strfreev(pdtokens);
 666 }
 667 #endif
 668
 669 static GArray *get_enabled_logic_probes(const struct sr_dev_inst *sdi)
 670 {
 671         struct sr_probe *probe;
 672         GArray *probes;
 673         GSList *l;
 674
 675         probes = g_array_new(FALSE, FALSE, sizeof(int));
 676         for (l = sdi->probes; l; l = l->next) {
 677                 probe = l->data;
 678                 if (probe->type != SR_PROBE_LOGIC)
 679                         continue;
 680                 if (probe->enabled != TRUE)
 681                         continue;
 682                 g_array_append_val(probes, probe->index);
 683         }
 684
 685         return probes;
 686 }
 687
 688 static void datafeed_in(const struct sr_dev_inst *sdi,
 689                 const struct sr_datafeed_packet *packet, void *cb_data)
 690 {
 691         const struct sr_datafeed_meta *meta;
 692         const struct sr_datafeed_logic *logic;
 693         const struct sr_datafeed_analog *analog;
 694         struct sr_config *src;
 695         static struct sr_output *o = NULL;
 696         static GArray *logic_probelist = NULL;
 697         static uint64_t received_samples = 0;
 698         static int unitsize = 0;
 699         static int triggered = 0;
 700         static FILE *outfile = NULL;
 701         GSList *l;
 702         GString *out;
 703         int sample_size, ret;
 704         uint64_t samplerate, output_len, filter_out_len;
 705         uint8_t *output_buf, *filter_out;
 706
 707         (void) cb_data;
 708
 709         /* If the first packet to come in isn't a header, don't even try. */
 710         if (packet->type != SR_DF_HEADER && o == NULL)
 711                 return;
 712
 713         sample_size = -1;
 714         switch (packet->type) {
 715         case SR_DF_HEADER:
 716                 g_debug("cli: Received SR_DF_HEADER");
 717                 /* Initialize the output module. */
 718                 if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
 719                         g_critical("Output module malloc failed.");
 720                         exit(1);
 721                 }
 722                 o->format = output_format;
 723                 o->sdi = (struct sr_dev_inst *)sdi;
 724                 o->param = output_format_param;
 725                 if (o->format->init) {
 726                         if (o->format->init(o) != SR_OK) {
 727                                 g_critical("Output format initialization failed.");
 728                                 exit(1);
 729                         }
 730                 }
 731
 732                 /* Prepare non-stdout output. */
 733                 outfile = stdout;
 734                 if (opt_output_file) {
 735                         if (default_output_format) {
 736                                 /* output file is in session format, so we'll
 737                                  * keep a copy of everything as it comes in
 738                                  * and save from there after the session. */
 739                                 outfile = NULL;
 740                                 savebuf = g_byte_array_new();
 741                         } else {
 742                                 /* saving to a file in whatever format was set
 743                                  * with --format, so all we need is a filehandle */
 744                                 outfile = g_fopen(opt_output_file, "wb");
 745                         }
 746                 }
 747
 748                 /* Prepare for logic data. */
 749                 logic_probelist = get_enabled_logic_probes(sdi);
 750                 /* How many bytes we need to store the packed samples. */
 751                 unitsize = (logic_probelist->len + 7) / 8;
 752
 753 #ifdef HAVE_SRD
 754                 GVariant *gvar;
 755                 if (opt_pds && logic_probelist->len) {
 756                         if (sr_config_get(sdi->driver, SR_CONF_SAMPLERATE,
 757                                         &gvar, sdi) != SR_OK) {
 758                                 g_critical("Unable to initialize protocol "
 759                                                 "decoders: no samplerate found.");
 760                                 break;
 761                         }
 762                         samplerate = g_variant_get_uint64(gvar);
 763                         g_variant_unref(gvar);
 764                         if (srd_session_config_set(srd_sess, SRD_CONF_NUM_PROBES,
 765                                                 g_variant_new_uint64(logic_probelist->len)) != SRD_OK) {
 766                                 g_critical("Failed to configure decode session.");
 767                                 break;
 768                         }
 769                         if (srd_session_config_set(srd_sess, SRD_CONF_UNITSIZE,
 770                                                 g_variant_new_uint64(unitsize)) != SRD_OK) {
 771                                 g_critical("Failed to configure decode session.");
 772                                 break;
 773                         }
 774                         if (srd_session_config_set(srd_sess, SRD_CONF_SAMPLERATE,
 775                                                 g_variant_new_uint64(samplerate)) != SRD_OK) {
 776                                 g_critical("Failed to configure decode session.");
 777                                 break;
 778                         }
 779                         if (srd_session_start(srd_sess) != SRD_OK) {
 780                                 g_critical("Failed to start decode session.");
 781                                 break;
 782                         }
 783                 }
 784 #endif
 785                 break;
 786
 787         case SR_DF_META:
 788                 g_debug("cli: received SR_DF_META");
 789                 meta = packet->payload;
 790                 for (l = meta->config; l; l = l->next) {
 791                         src = l->data;
 792                         switch (src->key) {
 793                         case SR_CONF_SAMPLERATE:
 794                                 samplerate = g_variant_get_uint64(src->data);
 795                                 g_debug("cli: got samplerate %"PRIu64" Hz", samplerate);
 796                                 break;
 797                         case SR_CONF_SAMPLE_INTERVAL:
 798                                 samplerate = g_variant_get_uint64(src->data);
 799                                 g_debug("cli: got sample interval %"PRIu64" ms", samplerate);
 800                                 break;
 801                         default:
 802                                 /* Unknown metadata is not an error. */
 803                                 break;
 804                         }
 805                 }
 806                 break;
 807
 808         case SR_DF_TRIGGER:
 809                 g_debug("cli: received SR_DF_TRIGGER");
 810                 if (o->format->event)
 811                         o->format->event(o, SR_DF_TRIGGER, &output_buf,
 812                                          &output_len);
 813                 triggered = 1;
 814                 break;
 815
 816         case SR_DF_LOGIC:
 817                 logic = packet->payload;
 818                 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
 819                 sample_size = logic->unitsize;
 820                 if (logic->length == 0)
 821                         break;
 822
 823                 /* Don't store any samples until triggered. */
 824                 if (opt_wait_trigger && !triggered)
 825                         break;
 826
 827                 if (limit_samples && received_samples >= limit_samples)
 828                         break;
 829
 830                 ret = sr_filter_probes(sample_size, unitsize, logic_probelist,
 831                                 logic->data, logic->length,
 832                                 &filter_out, &filter_out_len);
 833                 if (ret != SR_OK)
 834                         break;
 835
 836                 /* What comes out of the filter is guaranteed to be packed into the
 837                  * minimum size needed to support the number of samples at this sample
 838                  * size. however, the driver may have submitted too much -- cut off
 839                  * the buffer of the last packet according to the sample limit.
 840                  */
 841                 if (limit_samples && (received_samples + logic->length / sample_size >
 842                                 limit_samples * sample_size))
 843                         filter_out_len = limit_samples * sample_size - received_samples;
 844
 845                 if (opt_output_file && default_output_format) {
 846                         /* Saving to a session file. */
 847                         g_byte_array_append(savebuf, filter_out, filter_out_len);
 848                 } else {
 849                         if (opt_pds) {
 850 #ifdef HAVE_SRD
 851                                 if (srd_session_send(srd_sess, received_samples,
 852                                                 (uint8_t*)filter_out, filter_out_len) != SRD_OK)
 853                                         sr_session_stop();
 854 #endif
 855                         } else {
 856                                 output_len = 0;
 857                                 if (o->format->data && packet->type == o->format->df_type)
 858                                         o->format->data(o, filter_out, filter_out_len,
 859                                                         &output_buf, &output_len);
 860                                 if (output_len) {
 861                                         fwrite(output_buf, 1, output_len, outfile);
 862                                         fflush(outfile);
 863                                         g_free(output_buf);
 864                                 }
 865                         }
 866                 }
 867                 g_free(filter_out);
 868
 869                 received_samples += logic->length / sample_size;
 870                 break;
 871
 872         case SR_DF_ANALOG:
 873                 analog = packet->payload;
 874                 g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples);
 875                 if (analog->num_samples == 0)
 876                         break;
 877
 878                 if (limit_samples && received_samples >= limit_samples)
 879                         break;
 880
 881                 if (o->format->data && packet->type == o->format->df_type) {
 882                         o->format->data(o, (const uint8_t *)analog->data,
 883                                         analog->num_samples * sizeof(float),
 884                                         &output_buf, &output_len);
 885                         if (output_buf) {
 886                                 fwrite(output_buf, 1, output_len, outfile);
 887                                 fflush(outfile);
 888                                 g_free(output_buf);
 889                         }
 890                 }
 891
 892                 received_samples += analog->num_samples;
 893                 break;
 894
 895         case SR_DF_FRAME_BEGIN:
 896                 g_debug("cli: received SR_DF_FRAME_BEGIN");
 897                 if (o->format->event) {
 898                         o->format->event(o, SR_DF_FRAME_BEGIN, &output_buf,
 899                                          &output_len);
 900                         if (output_buf) {
 901                                 fwrite(output_buf, 1, output_len, outfile);
 902                                 fflush(outfile);
 903                                 g_free(output_buf);
 904                         }
 905                 }
 906                 break;
 907
 908         case SR_DF_FRAME_END:
 909                 g_debug("cli: received SR_DF_FRAME_END");
 910                 if (o->format->event) {
 911                         o->format->event(o, SR_DF_FRAME_END, &output_buf,
 912                                          &output_len);
 913                         if (output_buf) {
 914                                 fwrite(output_buf, 1, output_len, outfile);
 915                                 fflush(outfile);
 916                                 g_free(output_buf);
 917                         }
 918                 }
 919                 break;
 920
 921         default:
 922                 break;
 923         }
 924
 925         if (o && o->format->receive) {
 926                 if (o->format->receive(o, sdi, packet, &out) == SR_OK && out) {
 927                         fwrite(out->str, 1, out->len, outfile);
 928                         fflush(outfile);
 929                         g_string_free(out, TRUE);
 930                 }
 931         }
 932
 933         /* SR_DF_END needs to be handled after the output module's receive()
 934          * is called, so it can properly clean up that module etc. */
 935         if (packet->type == SR_DF_END) {
 936                 g_debug("cli: Received SR_DF_END");
 937
 938                 if (o->format->event) {
 939                         o->format->event(o, SR_DF_END, &output_buf, &output_len);
 940                         if (output_buf) {
 941                                 if (outfile)
 942                                         fwrite(output_buf, 1, output_len, outfile);
 943                                 g_free(output_buf);
 944                                 output_len = 0;
 945                         }
 946                 }
 947
 948                 if (limit_samples && received_samples < limit_samples)
 949                         g_warning("Device only sent %" PRIu64 " samples.",
 950                                received_samples);
 951
 952                 if (opt_continuous)
 953                         g_warning("Device stopped after %" PRIu64 " samples.",
 954                                received_samples);
 955
 956                 g_array_free(logic_probelist, TRUE);
 957
 958                 if (o->format->cleanup)
 959                         o->format->cleanup(o);
 960                 g_free(o);
 961                 o = NULL;
 962
 963                 if (outfile && outfile != stdout)
 964                         fclose(outfile);
 965
 966                 if (opt_output_file && default_output_format && savebuf->len) {
 967                         if (sr_session_save(opt_output_file, sdi, savebuf->data,
 968                                         unitsize, savebuf->len / unitsize) != SR_OK)
 969                                 g_critical("Failed to save session.");
 970                         g_byte_array_free(savebuf, FALSE);
 971                 }
 972         }
 973
 974 }
 975
 976 #ifdef HAVE_SRD
 977 static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash,
 978                 GHashTable **options)
 979 {
 980         struct srd_decoder_option *o;
 981         GSList *optl;
 982         GVariant *gvar;
 983         gint64 val_int;
 984         int ret;
 985         char *val_str, *conv;
 986
 987         ret = TRUE;
 988         *options = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
 989                         (GDestroyNotify)g_variant_unref);
 990
 991         for (optl = dec->options; optl; optl = optl->next) {
 992                 o = optl->data;
 993                 if (!(val_str = g_hash_table_lookup(hash, o->id)))
 994                         /* Not specified. */
 995                         continue;
 996                 if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_STRING)) {
 997                         gvar = g_variant_new_string(val_str);
 998                 } else if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_INT64)) {
 999                         val_int = strtoll(val_str, &conv, 0);
1000                         if (!conv || conv == val_str) {
1001                                 g_critical("Protocol decoder '%s' option '%s' "
1002                                                 "requires a number.", dec->name, o->id);
1003                                 ret = FALSE;
1004                                 break;
1005                         }
1006                         gvar = g_variant_new_int64(val_int);
1007                 } else {
1008                         g_critical("Unsupported type for option '%s' (%s)",
1009                                         o->id, g_variant_get_type_string(o->def));
1010                         ret = FALSE;
1011                         break;
1012                 }
1013                 g_variant_ref_sink(gvar);
1014                 g_hash_table_insert(*options, g_strdup(o->id), gvar);
1015                 g_hash_table_remove(hash, o->id);
1016         }
1017
1018         return ret;
1019 }
1020
1021 static int probes_to_gvar(struct srd_decoder *dec, GHashTable *hash,
1022                 GHashTable **probes)
1023 {
1024         struct srd_probe *p;
1025         GSList *all_probes, *l;
1026         GVariant *gvar;
1027         gint32 val_int;
1028         int ret;
1029         char *val_str, *conv;
1030
1031         ret = TRUE;
1032         *probes = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
1033                         (GDestroyNotify)g_variant_unref);
1034
1035         all_probes = g_slist_copy(dec->probes);
1036         all_probes = g_slist_concat(all_probes, g_slist_copy(dec->opt_probes));
1037         for (l = all_probes; l; l = l->next) {
1038                 p = l->data;
1039                 if (!(val_str = g_hash_table_lookup(hash, p->id)))
1040                         /* Not specified. */
1041                         continue;
1042                 val_int = strtoll(val_str, &conv, 10);
1043                 if (!conv || conv == val_str) {
1044                         g_critical("Protocol decoder '%s' probes '%s' "
1045                                         "is not a number.", dec->name, p->id);
1046                         ret = FALSE;
1047                         break;
1048                 }
1049                 gvar = g_variant_new_int32(val_int);
1050                 g_variant_ref_sink(gvar);
1051                 g_hash_table_insert(*probes, g_strdup(p->id), gvar);
1052                 g_hash_table_remove(hash, p->id);
1053         }
1054         g_slist_free(all_probes);
1055
1056         return ret;
1057 }
1058
1059 /* Register the given PDs for this session.
1060  * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
1061  * That will instantiate two SPI decoders on the clock but different data
1062  * lines.
1063  */
1064 static int register_pds(struct sr_dev *dev, const char *pdstring)
1065 {
1066         struct srd_decoder *dec;
1067         GHashTable *pd_opthash, *options, *probes;
1068         GList *leftover, *l;
1069         struct srd_decoder_inst *di;
1070         int ret;
1071         char **pdtokens, **pdtok, *pd_name;
1072
1073         (void)dev;
1074
1075         ret = 0;
1076         pd_ann_visible = g_hash_table_new_full(g_str_hash, g_int_equal,
1077                         g_free, NULL);
1078         pd_name = NULL;
1079         pd_opthash = options = probes = NULL;
1080         pdtokens = g_strsplit(pdstring, ",", 0);
1081         for (pdtok = pdtokens; *pdtok; pdtok++) {
1082                 if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) {
1083                         g_critical("Invalid protocol decoder option '%s'.", *pdtok);
1084                         break;
1085                 }
1086
1087                 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
1088                 g_hash_table_remove(pd_opthash, "sigrok_key");
1089                 if (srd_decoder_load(pd_name) != SRD_OK) {
1090                         g_critical("Failed to load protocol decoder %s.", pd_name);
1091                         ret = 1;
1092                         break;
1093                 }
1094                 dec = srd_decoder_get_by_id(pd_name);
1095
1096                 /* Convert decoder option and probe values to GVariant. */
1097                 if (!opts_to_gvar(dec, pd_opthash, &options)) {
1098                         ret = 1;
1099                         break;
1100                 }
1101                 if (!probes_to_gvar(dec, pd_opthash, &probes)) {
1102                         ret = 1;
1103                         break;
1104                 }
1105                 if (g_hash_table_size(pd_opthash) > 0) {
1106                         leftover = g_hash_table_get_keys(pd_opthash);
1107                         for (l = leftover; l; l = l->next)
1108                                 g_critical("Unknown option or probe '%s'", (char *)l->data);
1109                         g_list_free(leftover);
1110                         break;
1111                 }
1112
1113                 if (!(di = srd_inst_new(srd_sess, pd_name, options))) {
1114                         g_critical("Failed to instantiate protocol decoder %s.", pd_name);
1115                         ret = 1;
1116                         break;
1117                 }
1118
1119                 /* If no annotation list was specified, add them all in now.
1120                  * This will be pared down later to leave only the last PD
1121                  * in the stack.
1122                  */
1123                 if (!opt_pd_annotations)
1124                         g_hash_table_insert(pd_ann_visible,
1125                                             g_strdup(di->inst_id), NULL);
1126
1127                 /* Remap the probes if needed. */
1128                 if (srd_inst_probe_set_all(di, probes) != SRD_OK) {
1129                         ret = 1;
1130                         break;
1131                 }
1132         }
1133
1134         g_strfreev(pdtokens);
1135         if (pd_opthash)
1136                 g_hash_table_destroy(pd_opthash);
1137         if (options)
1138                 g_hash_table_destroy(options);
1139         if (probes)
1140                 g_hash_table_destroy(probes);
1141         if (pd_name)
1142                 g_free(pd_name);
1143
1144         return ret;
1145 }
1146
1147 int setup_pd_stack(void)
1148 {
1149         struct srd_decoder_inst *di_from, *di_to;
1150         int ret, i;
1151         char **pds, **ids;
1152
1153         /* Set up the protocol decoder stack. */
1154         pds = g_strsplit(opt_pds, ",", 0);
1155         if (g_strv_length(pds) > 1) {
1156                 if (opt_pd_stack) {
1157                         /* A stack setup was specified, use that. */
1158                         g_strfreev(pds);
1159                         pds = g_strsplit(opt_pd_stack, ",", 0);
1160                         if (g_strv_length(pds) < 2) {
1161                                 g_strfreev(pds);
1162                                 g_critical("Specify at least two protocol decoders to stack.");
1163                                 return 1;
1164                         }
1165                 }
1166
1167                 /* First PD goes at the bottom of the stack. */
1168                 ids = g_strsplit(pds[0], ":", 0);
1169                 if (!(di_from = srd_inst_find_by_id(srd_sess, ids[0]))) {
1170                         g_strfreev(ids);
1171                         g_critical("Cannot stack protocol decoder '%s': "
1172                                         "instance not found.", pds[0]);
1173                         return 1;
1174                 }
1175                 g_strfreev(ids);
1176
1177                 /* Every subsequent PD goes on top. */
1178                 for (i = 1; pds[i]; i++) {
1179                         ids = g_strsplit(pds[i], ":", 0);
1180                         if (!(di_to = srd_inst_find_by_id(srd_sess, ids[0]))) {
1181                                 g_strfreev(ids);
1182                                 g_critical("Cannot stack protocol decoder '%s': "
1183                                                 "instance not found.", pds[i]);
1184                                 return 1;
1185                         }
1186                         g_strfreev(ids);
1187                         if ((ret = srd_inst_stack(srd_sess, di_from, di_to)) != SRD_OK)
1188                                 return 1;
1189
1190                         /* Don't show annotation from this PD. Only the last PD in
1191                          * the stack will be left on the annotation list (unless
1192                          * the annotation list was specifically provided).
1193                          */
1194                         if (!opt_pd_annotations)
1195                                 g_hash_table_remove(pd_ann_visible,
1196                                                     di_from->inst_id);
1197
1198                         di_from = di_to;
1199                 }
1200         }
1201         g_strfreev(pds);
1202
1203         return 0;
1204 }
1205
1206 int setup_pd_annotations(void)
1207 {
1208         GSList *l;
1209         struct srd_decoder *dec;
1210         int ann;
1211         char **pds, **pdtok, **keyval, **ann_descr;
1212
1213         /* Set up custom list of PDs and annotations to show. */
1214         if (opt_pd_annotations) {
1215                 pds = g_strsplit(opt_pd_annotations, ",", 0);
1216                 for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
1217                         ann = 0;
1218                         keyval = g_strsplit(*pdtok, "=", 0);
1219                         if (!(dec = srd_decoder_get_by_id(keyval[0]))) {
1220                                 g_critical("Protocol decoder '%s' not found.", keyval[0]);
1221                                 return 1;
1222                         }
1223                         if (!dec->annotations) {
1224                                 g_critical("Protocol decoder '%s' has no annotations.", keyval[0]);
1225                                 return 1;
1226                         }
1227                         if (g_strv_length(keyval) == 2) {
1228                                 for (l = dec->annotations; l; l = l->next, ann++) {
1229                                         ann_descr = l->data;
1230                                         if (!canon_cmp(ann_descr[0], keyval[1]))
1231                                                 /* Found it. */
1232                                                 break;
1233                                 }
1234                                 if (!l) {
1235                                         g_critical("Annotation '%s' not found "
1236                                                         "for protocol decoder '%s'.", keyval[1], keyval[0]);
1237                                         return 1;
1238                                 }
1239                         }
1240                         g_debug("cli: showing protocol decoder annotation %d from '%s'", ann, keyval[0]);
1241                         g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann));
1242                         g_strfreev(keyval);
1243                 }
1244                 g_strfreev(pds);
1245         }
1246
1247         return 0;
1248 }
1249
1250 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
1251 {
1252         int i;
1253         char **annotations;
1254         gpointer ann_format;
1255
1256         /* 'cb_data' is not used in this specific callback. */
1257         (void)cb_data;
1258
1259         if (!pd_ann_visible)
1260                 return;
1261
1262         if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id,
1263                         NULL, &ann_format))
1264                 /* Not in the list of PDs whose annotations we're showing. */
1265                 return;
1266
1267         if (pdata->ann_format != GPOINTER_TO_INT(ann_format))
1268                 /* We don't want this particular format from the PD. */
1269                 return;
1270
1271         annotations = pdata->data;
1272         if (opt_loglevel > SR_LOG_WARN)
1273                 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
1274         printf("%s: ", pdata->pdo->proto_id);
1275         for (i = 0; annotations[i]; i++)
1276                 printf("\"%s\" ", annotations[i]);
1277         printf("\n");
1278         fflush(stdout);
1279 }
1280 #endif
1281
1282 int setup_output_format(void)
1283 {
1284         GHashTable *fmtargs;
1285         GHashTableIter iter;
1286         gpointer key, value;
1287         struct sr_output_format **outputs;
1288         int i;
1289         char *fmtspec;
1290
1291         if (opt_output_format && !strcmp(opt_output_format, "sigrok")) {
1292                 /* Doesn't really exist as an output module - this is
1293                  * the session save mode. */
1294                 g_free(opt_output_format);
1295                 opt_output_format = NULL;
1296         }
1297
1298         if (!opt_output_format) {
1299                 opt_output_format = DEFAULT_OUTPUT_FORMAT;
1300                 /* we'll need to remember this so when saving to a file
1301                  * later, sigrok session format will be used.
1302                  */
1303                 default_output_format = TRUE;
1304         }
1305
1306         fmtargs = parse_generic_arg(opt_output_format, TRUE);
1307         fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1308         if (!fmtspec) {
1309                 g_critical("Invalid output format.");
1310                 return 1;
1311         }
1312         outputs = sr_output_list();
1313         for (i = 0; outputs[i]; i++) {
1314                 if (strcmp(outputs[i]->id, fmtspec))
1315                         continue;
1316                 g_hash_table_remove(fmtargs, "sigrok_key");
1317                 output_format = outputs[i];
1318                 g_hash_table_iter_init(&iter, fmtargs);
1319                 while (g_hash_table_iter_next(&iter, &key, &value)) {
1320                         /* only supporting one parameter per output module
1321                          * for now, and only its value */
1322                         output_format_param = g_strdup(value);
1323                         break;
1324                 }
1325                 break;
1326         }
1327         if (!output_format) {
1328                 g_critical("Invalid output format %s.", opt_output_format);
1329                 return 1;
1330         }
1331         g_hash_table_destroy(fmtargs);
1332
1333         return 0;
1334 }
1335
1336 static int select_probes(struct sr_dev_inst *sdi)
1337 {
1338         struct sr_probe *probe;
1339         GSList *selected_probes, *l;
1340
1341         if (!opt_probes)
1342                 return SR_OK;
1343
1344         if (!(selected_probes = parse_probestring(sdi, opt_probes)))
1345                 return SR_ERR;
1346
1347         for (l = sdi->probes; l; l = l->next) {
1348                 probe = l->data;
1349                 if (g_slist_find(selected_probes, probe))
1350                         probe->enabled = TRUE;
1351                 else
1352                         probe->enabled = FALSE;
1353         }
1354         g_slist_free(selected_probes);
1355
1356         return SR_OK;
1357 }
1358
1359 /**
1360  * Return the input file format which the CLI tool should use.
1361  *
1362  * If the user specified -I / --input-format, use that one. Otherwise, try to
1363  * autodetect the format as good as possible. Failing that, return NULL.
1364  *
1365  * @param filename The filename of the input file. Must not be NULL.
1366  * @param opt The -I / --input-file option the user specified (or NULL).
1367  *
1368  * @return A pointer to the 'struct sr_input_format' that should be used,
1369  *         or NULL if no input format was selected or auto-detected.
1370  */
1371 static struct sr_input_format *determine_input_file_format(
1372                         const char *filename, const char *opt)
1373 {
1374         int i;
1375         struct sr_input_format **inputs;
1376
1377         /* If there are no input formats, return NULL right away. */
1378         inputs = sr_input_list();
1379         if (!inputs) {
1380                 g_critical("No supported input formats available.");
1381                 return NULL;
1382         }
1383
1384         /* If the user specified -I / --input-format, use that one. */
1385         if (opt) {
1386                 for (i = 0; inputs[i]; i++) {
1387                         if (strcasecmp(inputs[i]->id, opt))
1388                                 continue;
1389                         g_debug("Using user-specified input file format '%s'.",
1390                                         inputs[i]->id);
1391                         return inputs[i];
1392                 }
1393
1394                 /* The user specified an unknown input format, return NULL. */
1395                 g_critical("Error: specified input file format '%s' is "
1396                         "unknown.", opt);
1397                 return NULL;
1398         }
1399
1400         /* Otherwise, try to find an input module that can handle this file. */
1401         for (i = 0; inputs[i]; i++) {
1402                 if (inputs[i]->format_match(filename))
1403                         break;
1404         }
1405
1406         /* Return NULL if no input module wanted to touch this. */
1407         if (!inputs[i]) {
1408                 g_critical("Error: no matching input module found.");
1409                 return NULL;
1410         }
1411
1412         g_debug("cli: Autodetected '%s' input format for file '%s'.",
1413                 inputs[i]->id, filename);
1414
1415         return inputs[i];
1416 }
1417
1418 static void load_input_file_format(void)
1419 {
1420         GHashTable *fmtargs = NULL;
1421         struct stat st;
1422         struct sr_input *in;
1423         struct sr_input_format *input_format;
1424         char *fmtspec = NULL;
1425
1426         if (opt_input_format) {
1427                 fmtargs = parse_generic_arg(opt_input_format, TRUE);
1428                 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1429         }
1430
1431         if (!(input_format = determine_input_file_format(opt_input_file,
1432                                                    fmtspec))) {
1433                 /* The exact cause was already logged. */
1434                 return;
1435         }
1436
1437         if (fmtargs)
1438                 g_hash_table_remove(fmtargs, "sigrok_key");
1439
1440         if (stat(opt_input_file, &st) == -1) {
1441                 g_critical("Failed to load %s: %s", opt_input_file,
1442                         strerror(errno));
1443                 exit(1);
1444         }
1445
1446         /* Initialize the input module. */
1447         if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
1448                 g_critical("Failed to allocate input module.");
1449                 exit(1);
1450         }
1451         in->format = input_format;
1452         in->param = fmtargs;
1453         if (in->format->init) {
1454                 if (in->format->init(in, opt_input_file) != SR_OK) {
1455                         g_critical("Input format init failed.");
1456                         exit(1);
1457                 }
1458         }
1459
1460         if (select_probes(in->sdi) > 0)
1461                 return;
1462
1463         sr_session_new();
1464         sr_session_datafeed_callback_add(datafeed_in, NULL);
1465         if (sr_session_dev_add(in->sdi) != SR_OK) {
1466                 g_critical("Failed to use device.");
1467                 sr_session_destroy();
1468                 return;
1469         }
1470
1471         input_format->loadfile(in, opt_input_file);
1472
1473         sr_session_destroy();
1474
1475         if (fmtargs)
1476                 g_hash_table_destroy(fmtargs);
1477 }
1478
1479 static void load_input_file(void)
1480 {
1481
1482         if (sr_session_load(opt_input_file) == SR_OK) {
1483                 /* sigrok session file */
1484                 sr_session_datafeed_callback_add(datafeed_in, NULL);
1485                 sr_session_start();
1486                 sr_session_run();
1487                 sr_session_stop();
1488         }
1489         else {
1490                 /* fall back on input modules */
1491                 load_input_file_format();
1492         }
1493 }
1494
1495 static int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
1496 {
1497         const struct sr_config_info *srci;
1498         GHashTableIter iter;
1499         gpointer key, value;
1500         int ret;
1501         double tmp_double;
1502         uint64_t tmp_u64, p, q, low, high;
1503         gboolean tmp_bool;
1504         GVariant *val, *rational[2], *range[2];
1505
1506         g_hash_table_iter_init(&iter, args);
1507         while (g_hash_table_iter_next(&iter, &key, &value)) {
1508                 if (!(srci = sr_config_info_name_get(key))) {
1509                         g_critical("Unknown device option '%s'.", (char *) key);
1510                         return SR_ERR;
1511                 }
1512
1513                 if ((value == NULL) &&
1514                         (srci->datatype != SR_T_BOOL)) {
1515                         g_critical("Option '%s' needs a value.", (char *)key);
1516                         return SR_ERR;
1517                 }
1518                 val = NULL;
1519                 switch (srci->datatype) {
1520                 case SR_T_UINT64:
1521                         ret = sr_parse_sizestring(value, &tmp_u64);
1522                         if (ret != SR_OK)
1523                                 break;
1524                         val = g_variant_new_uint64(tmp_u64);
1525                         break;
1526                 case SR_T_CHAR:
1527                         val = g_variant_new_string(value);
1528                         break;
1529                 case SR_T_BOOL:
1530                         if (!value)
1531                                 tmp_bool = TRUE;
1532                         else
1533                                 tmp_bool = sr_parse_boolstring(value);
1534                         val = g_variant_new_boolean(tmp_bool);
1535                         break;
1536                 case SR_T_FLOAT:
1537                         tmp_double = strtof(value, NULL);
1538                         val = g_variant_new_double(tmp_double);
1539                         break;
1540                 case SR_T_RATIONAL_PERIOD:
1541                         if ((ret = sr_parse_period(value, &p, &q)) != SR_OK)
1542                                 break;
1543                         rational[0] = g_variant_new_uint64(p);
1544                         rational[1] = g_variant_new_uint64(q);
1545                         val = g_variant_new_tuple(rational, 2);
1546                         break;
1547                 case SR_T_RATIONAL_VOLT:
1548                         if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK)
1549                                 break;
1550                         rational[0] = g_variant_new_uint64(p);
1551                         rational[1] = g_variant_new_uint64(q);
1552                         val = g_variant_new_tuple(rational, 2);
1553                         break;
1554                 case SR_T_UINT64_RANGE:
1555                         if (sscanf(value, "%"PRIu64"-%"PRIu64, &low, &high) != 2) {
1556                                 ret = SR_ERR;
1557                                 break;
1558                         } else {
1559                                 range[0] = g_variant_new_uint64(low);
1560                                 range[1] = g_variant_new_uint64(high);
1561                                 val = g_variant_new_tuple(range, 2);
1562                         }
1563                         break;
1564                 default:
1565                         ret = SR_ERR;
1566                 }
1567                 if (val)
1568                         ret = sr_config_set(sdi, srci->key, val);
1569                 if (ret != SR_OK) {
1570                         g_critical("Failed to set device option '%s'.", (char *)key);
1571                         return ret;
1572                 }
1573         }
1574
1575         return SR_OK;
1576 }
1577
1578 static void set_options(void)
1579 {
1580         struct sr_dev_inst *sdi;
1581         GSList *devices;
1582         GHashTable *devargs;
1583
1584         if (!opt_config) {
1585                 g_critical("No setting specified.");
1586                 return;
1587         }
1588
1589         if (!(devargs = parse_generic_arg(opt_config, FALSE)))
1590                 return;
1591
1592         if (!(devices = device_scan())) {
1593                 g_critical("No devices found.");
1594                 return;
1595         }
1596         sdi = devices->data;
1597
1598         if (sr_dev_open(sdi) != SR_OK) {
1599                 g_critical("Failed to open device.");
1600                 return;
1601         }
1602
1603         set_dev_options(sdi, devargs);
1604
1605         sr_dev_close(sdi);
1606         g_slist_free(devices);
1607         g_hash_table_destroy(devargs);
1608
1609 }
1610
1611 static int set_limit_time(const struct sr_dev_inst *sdi)
1612 {
1613         GVariant *gvar;
1614         uint64_t time_msec;
1615         uint64_t samplerate;
1616
1617         if (!(time_msec = sr_parse_timestring(opt_time))) {
1618                 g_critical("Invalid time '%s'", opt_time);
1619                 return SR_ERR;
1620         }
1621
1622         if (sr_dev_has_option(sdi, SR_CONF_LIMIT_MSEC)) {
1623                 gvar = g_variant_new_uint64(time_msec);
1624                 if (sr_config_set(sdi, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) {
1625                         g_critical("Failed to configure time limit.");
1626                         return SR_ERR;
1627                 }
1628         } else if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
1629                 /* Convert to samples based on the samplerate.  */
1630                 sr_config_get(sdi->driver, SR_CONF_SAMPLERATE, &gvar, sdi);
1631                 samplerate = g_variant_get_uint64(gvar);
1632                 g_variant_unref(gvar);
1633                 limit_samples = (samplerate) * time_msec / (uint64_t)1000;
1634                 if (limit_samples == 0) {
1635                         g_critical("Not enough time at this samplerate.");
1636                         return SR_ERR;
1637                 }
1638                 gvar = g_variant_new_uint64(limit_samples);
1639                 if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
1640                         g_critical("Failed to configure time-based sample limit.");
1641                         return SR_ERR;
1642                 }
1643         } else {
1644                 g_critical("This device does not support time limits.");
1645                 return SR_ERR;
1646         }
1647
1648         return SR_OK;
1649 }
1650
1651 static void run_session(void)
1652 {
1653         GSList *devices;
1654         GHashTable *devargs;
1655         GVariant *gvar;
1656         struct sr_dev_inst *sdi;
1657         int max_probes, i;
1658         char **triggerlist;
1659
1660         devices = device_scan();
1661         if (!devices) {
1662                 g_critical("No devices found.");
1663                 return;
1664         }
1665         if (g_slist_length(devices) > 1) {
1666                 g_critical("sigrok-cli only supports one device for capturing.");
1667                 return;
1668         }
1669         sdi = devices->data;
1670
1671         sr_session_new();
1672         sr_session_datafeed_callback_add(datafeed_in, NULL);
1673
1674         if (sr_dev_open(sdi) != SR_OK) {
1675                 g_critical("Failed to open device.");
1676                 return;
1677         }
1678
1679         if (sr_session_dev_add(sdi) != SR_OK) {
1680                 g_critical("Failed to add device to session.");
1681                 sr_session_destroy();
1682                 return;
1683         }
1684
1685         if (opt_config) {
1686                 if ((devargs = parse_generic_arg(opt_config, FALSE))) {
1687                         if (set_dev_options(sdi, devargs) != SR_OK)
1688                                 return;
1689                         g_hash_table_destroy(devargs);
1690                 }
1691         }
1692
1693         if (select_probes(sdi) != SR_OK) {
1694                 g_critical("Failed to set probes.");
1695                 sr_session_destroy();
1696                 return;
1697         }
1698
1699         if (opt_triggers) {
1700                 if (!(triggerlist = sr_parse_triggerstring(sdi, opt_triggers))) {
1701                         sr_session_destroy();
1702                         return;
1703                 }
1704                 max_probes = g_slist_length(sdi->probes);
1705                 for (i = 0; i < max_probes; i++) {
1706                         if (triggerlist[i]) {
1707                                 sr_dev_trigger_set(sdi, i, triggerlist[i]);
1708                                 g_free(triggerlist[i]);
1709                         }
1710                 }
1711                 g_free(triggerlist);
1712         }
1713
1714         if (opt_continuous) {
1715                 if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) {
1716                         g_critical("This device does not support continuous sampling.");
1717                         sr_session_destroy();
1718                         return;
1719                 }
1720         }
1721
1722         if (opt_time) {
1723                 if (set_limit_time(sdi) != SR_OK) {
1724                         sr_session_destroy();
1725                         return;
1726                 }
1727         }
1728
1729         if (opt_samples) {
1730                 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) {
1731                         g_critical("Invalid sample limit '%s'.", opt_samples);
1732                         sr_session_destroy();
1733                         return;
1734                 }
1735                 gvar = g_variant_new_uint64(limit_samples);
1736                 if (sr_config_set(sdi, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
1737                         g_critical("Failed to configure sample limit.");
1738                         sr_session_destroy();
1739                         return;
1740                 }
1741         }
1742
1743         if (opt_frames) {
1744                 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) {
1745                         g_critical("Invalid sample limit '%s'.", opt_samples);
1746                         sr_session_destroy();
1747                         return;
1748                 }
1749                 gvar = g_variant_new_uint64(limit_frames);
1750                 if (sr_config_set(sdi, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
1751                         g_critical("Failed to configure frame limit.");
1752                         sr_session_destroy();
1753                         return;
1754                 }
1755         }
1756
1757         if (sr_session_start() != SR_OK) {
1758                 g_critical("Failed to start session.");
1759                 sr_session_destroy();
1760                 return;
1761         }
1762
1763         if (opt_continuous)
1764                 add_anykey();
1765
1766         sr_session_run();
1767
1768         if (opt_continuous)
1769                 clear_anykey();
1770
1771         sr_session_datafeed_callback_remove_all();
1772         sr_session_destroy();
1773         g_slist_free(devices);
1774
1775 }
1776
1777 static void logger(const gchar *log_domain, GLogLevelFlags log_level,
1778                    const gchar *message, gpointer cb_data)
1779 {
1780         (void)log_domain;
1781         (void)cb_data;
1782
1783         /*
1784          * All messages, warnings, errors etc. go to stderr (not stdout) in
1785          * order to not mess up the CLI tool data output, e.g. VCD output.
1786          */
1787         if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)
1788                         || opt_loglevel > SR_LOG_WARN) {
1789                 fprintf(stderr, "%s\n", message);
1790                 fflush(stderr);
1791         }
1792 }
1793
1794 int main(int argc, char **argv)
1795 {
1796         GOptionContext *context;
1797         GError *error;
1798         int ret;
1799         char *help;
1800
1801         g_log_set_default_handler(logger, NULL);
1802
1803         context = g_option_context_new(NULL);
1804         g_option_context_add_main_entries(context, optargs, NULL);
1805
1806         ret = 1;
1807         error = NULL;
1808         if (!g_option_context_parse(context, &argc, &argv, &error)) {
1809                 g_critical("%s", error->message);
1810                 goto done;
1811         }
1812
1813         /* Set the loglevel (amount of messages to output) for libsigrok. */
1814         if (sr_log_loglevel_set(opt_loglevel) != SR_OK)
1815                 goto done;
1816
1817         if (sr_init(&sr_ctx) != SR_OK)
1818                 goto done;
1819
1820 #ifdef HAVE_SRD
1821         /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
1822         if (srd_log_loglevel_set(opt_loglevel) != SRD_OK)
1823                 goto done;
1824
1825         if (opt_pds) {
1826                 if (srd_init(NULL) != SRD_OK)
1827                         goto done;
1828                 if (srd_session_new(&srd_sess) != SRD_OK) {
1829                         g_critical("Failed to create new decode session.");
1830                         goto done;
1831                 }
1832                 if (register_pds(NULL, opt_pds) != 0)
1833                         goto done;
1834                 if (srd_pd_output_callback_add(srd_sess, SRD_OUTPUT_ANN,
1835                                 show_pd_annotations, NULL) != SRD_OK)
1836                         goto done;
1837                 if (setup_pd_stack() != 0)
1838                         goto done;
1839                 if (setup_pd_annotations() != 0)
1840                         goto done;
1841         }
1842 #endif
1843
1844         if (setup_output_format() != 0)
1845                 goto done;
1846
1847         if (opt_version)
1848                 show_version();
1849         else if (opt_scan_devs)
1850                 show_dev_list();
1851 #ifdef HAVE_SRD
1852         else if (opt_pds && opt_show)
1853                 show_pd_detail();
1854 #endif
1855         else if (opt_show)
1856                 show_dev_detail();
1857         else if (opt_input_file)
1858                 load_input_file();
1859         else if (opt_set)
1860                 set_options();
1861         else if (opt_samples || opt_time || opt_frames || opt_continuous)
1862                 run_session();
1863         else {
1864                 help = g_option_context_get_help(context, TRUE, NULL);
1865                 printf("%s", help);
1866                 g_free(help);
1867         }
1868
1869 #ifdef HAVE_SRD
1870         if (opt_pds)
1871                 srd_exit();
1872 #endif
1873
1874         ret = 0;
1875
1876 done:
1877         if (sr_ctx)
1878                 sr_exit(sr_ctx);
1879
1880         g_option_context_free(context);
1881
1882         return ret;
1883 }