decode.c

   1 /*
   2  * This file is part of the sigrok-cli project.
   3  *
   4  * Copyright (C) 2013 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 "sigrok-cli.h"
  21 #include "config.h"
  22 #include <glib.h>
  23
  24 #ifdef HAVE_SRD
  25 static GHashTable *pd_ann_visible = NULL;
  26 static GHashTable *pd_meta_visible = NULL;
  27 static GHashTable *pd_binary_visible = NULL;
  28 static GHashTable *pd_probe_maps = NULL;
  29
  30 extern struct srd_session *srd_sess;
  31 extern gint opt_loglevel;
  32
  33
  34 static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash,
  35                 GHashTable **options)
  36 {
  37         struct srd_decoder_option *o;
  38         GSList *optl;
  39         GVariant *gvar;
  40         gint64 val_int;
  41         int ret;
  42         char *val_str, *conv;
  43
  44         ret = TRUE;
  45         *options = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
  46                         (GDestroyNotify)g_variant_unref);
  47
  48         for (optl = dec->options; optl; optl = optl->next) {
  49                 o = optl->data;
  50                 if (!(val_str = g_hash_table_lookup(hash, o->id)))
  51                         /* Not specified. */
  52                         continue;
  53                 if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_STRING)) {
  54                         gvar = g_variant_new_string(val_str);
  55                 } else if (g_variant_is_of_type(o->def, G_VARIANT_TYPE_INT64)) {
  56                         val_int = strtoll(val_str, &conv, 0);
  57                         if (!conv || conv == val_str) {
  58                                 g_critical("Protocol decoder '%s' option '%s' "
  59                                                 "requires a number.", dec->name, o->id);
  60                                 ret = FALSE;
  61                                 break;
  62                         }
  63                         gvar = g_variant_new_int64(val_int);
  64                 } else {
  65                         g_critical("Unsupported type for option '%s' (%s)",
  66                                         o->id, g_variant_get_type_string(o->def));
  67                         ret = FALSE;
  68                         break;
  69                 }
  70                 g_variant_ref_sink(gvar);
  71                 g_hash_table_insert(*options, g_strdup(o->id), gvar);
  72                 g_hash_table_remove(hash, o->id);
  73         }
  74
  75         return ret;
  76 }
  77
  78 static int move_hash_element(GHashTable *src, GHashTable *dest, void *key)
  79 {
  80         void *orig_key, *value;
  81
  82         if (!g_hash_table_lookup_extended(src, key, &orig_key, &value))
  83                 /* Not specified. */
  84                 return FALSE;
  85         g_hash_table_steal(src, orig_key);
  86         g_hash_table_insert(dest, orig_key, value);
  87
  88         return TRUE;
  89 }
  90
  91 static GHashTable *extract_probe_map(struct srd_decoder *dec, GHashTable *hash)
  92 {
  93         GHashTable *probe_map;
  94         struct srd_probe *p;
  95         GSList *l;
  96
  97         probe_map = g_hash_table_new_full(g_str_hash, g_str_equal,
  98                                           g_free, g_free);
  99
 100         for (l = dec->probes; l; l = l->next) {
 101                 p = l->data;
 102                 move_hash_element(hash, probe_map, p->id);
 103         }
 104         for (l = dec->opt_probes; l; l = l->next) {
 105                 p = l->data;
 106                 move_hash_element(hash, probe_map, p->id);
 107         }
 108
 109         return probe_map;
 110 }
 111
 112 /* Register the given PDs for this session.
 113  * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
 114  * That will instantiate two SPI decoders on the clock but different data
 115  * lines.
 116  */
 117 int register_pds(const char *opt_pds, char *opt_pd_annotations)
 118 {
 119         struct srd_decoder *dec;
 120         GHashTable *pd_opthash, *options, *probes;
 121         GList *leftover, *l;
 122         struct srd_decoder_inst *di;
 123         int ret;
 124         char **pdtokens, **pdtok, *pd_name;
 125
 126         pd_ann_visible = g_hash_table_new_full(g_str_hash, g_str_equal,
 127                                                g_free, NULL);
 128         ret = 0;
 129         pd_name = NULL;
 130         pd_opthash = options = probes = pd_probe_maps = NULL;
 131         pdtokens = g_strsplit(opt_pds, ",", 0);
 132         for (pdtok = pdtokens; *pdtok; pdtok++) {
 133                 if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) {
 134                         g_critical("Invalid protocol decoder option '%s'.", *pdtok);
 135                         break;
 136                 }
 137
 138                 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
 139                 g_hash_table_remove(pd_opthash, "sigrok_key");
 140                 if (srd_decoder_load(pd_name) != SRD_OK) {
 141                         g_critical("Failed to load protocol decoder %s.", pd_name);
 142                         ret = 1;
 143                         break;
 144                 }
 145                 dec = srd_decoder_get_by_id(pd_name);
 146
 147                 /* Convert decoder option and probe values to GVariant. */
 148                 if (!opts_to_gvar(dec, pd_opthash, &options)) {
 149                         ret = 1;
 150                         break;
 151                 }
 152                 probes = extract_probe_map(dec, pd_opthash);
 153
 154                 if (g_hash_table_size(pd_opthash) > 0) {
 155                         leftover = g_hash_table_get_keys(pd_opthash);
 156                         for (l = leftover; l; l = l->next)
 157                                 g_critical("Unknown option or probe '%s'", (char *)l->data);
 158                         g_list_free(leftover);
 159                         break;
 160                 }
 161
 162                 if (!(di = srd_inst_new(srd_sess, pd_name, options))) {
 163                         g_critical("Failed to instantiate protocol decoder %s.", pd_name);
 164                         ret = 1;
 165                         break;
 166                 }
 167
 168                 if (pdtok == pdtokens) {
 169                         /* Save the probe setup for later, but only on the first
 170                          * decoder -- stacked decoders don't get probes. */
 171                         pd_probe_maps = g_hash_table_new_full(g_str_hash,
 172                                         g_str_equal, g_free, (GDestroyNotify)g_hash_table_destroy);
 173                         g_hash_table_insert(pd_probe_maps, g_strdup(di->inst_id), probes);
 174                         probes = NULL;
 175                 }
 176
 177                 /* If no annotation list was specified, add them all in now.
 178                  * This will be pared down later to leave only the last PD
 179                  * in the stack.
 180                  */
 181                 if (!opt_pd_annotations)
 182                         g_hash_table_insert(pd_ann_visible,
 183                                             g_strdup(di->inst_id), GINT_TO_POINTER(-1));
 184         }
 185
 186         g_strfreev(pdtokens);
 187         if (pd_opthash)
 188                 g_hash_table_destroy(pd_opthash);
 189         if (options)
 190                 g_hash_table_destroy(options);
 191         if (probes)
 192                 g_hash_table_destroy(probes);
 193         if (pd_name)
 194                 g_free(pd_name);
 195
 196         return ret;
 197 }
 198
 199 static void map_pd_inst_probes(void *key, void *value, void *user_data)
 200 {
 201         GHashTable *probe_map;
 202         GHashTable *probe_indices;
 203         GSList *probe_list;
 204         struct srd_decoder_inst *di;
 205         GVariant *var;
 206         void *probe_id;
 207         void *probe_target;
 208         struct sr_probe *probe;
 209         GHashTableIter iter;
 210         int num_probes;
 211
 212         probe_map = value;
 213         probe_list = user_data;
 214
 215         di = srd_inst_find_by_id(srd_sess, key);
 216         if (!di) {
 217                 g_critical("Protocol decoder instance \"%s\" not found.",
 218                            (char *)key);
 219                 return;
 220         }
 221         probe_indices = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
 222                                               (GDestroyNotify)g_variant_unref);
 223
 224         g_hash_table_iter_init(&iter, probe_map);
 225         while (g_hash_table_iter_next(&iter, &probe_id, &probe_target)) {
 226                 probe = find_probe(probe_list, probe_target);
 227                 if (!probe) {
 228                         g_printerr("cli: No probe with name \"%s\" found.\n",
 229                                    (char *)probe_target);
 230                         continue;
 231                 }
 232                 if (!probe->enabled)
 233                         g_printerr("cli: Target probe \"%s\" not enabled.\n",
 234                                    (char *)probe_target);
 235
 236                 var = g_variant_new_int32(probe->index);
 237                 g_variant_ref_sink(var);
 238                 g_hash_table_insert(probe_indices, g_strdup(probe_id), var);
 239         }
 240
 241         num_probes = g_slist_length(probe_list);
 242         srd_inst_probe_set_all(di, probe_indices, (num_probes + 7) / 8);
 243 }
 244
 245 void map_pd_probes(struct sr_dev_inst *sdi)
 246 {
 247         if (pd_probe_maps) {
 248                 g_hash_table_foreach(pd_probe_maps, &map_pd_inst_probes,
 249                                      sdi->probes);
 250                 g_hash_table_destroy(pd_probe_maps);
 251                 pd_probe_maps = NULL;
 252         }
 253 }
 254
 255 int setup_pd_stack(char *opt_pds, char *opt_pd_stack, char *opt_pd_annotations)
 256 {
 257         struct srd_decoder_inst *di_from, *di_to;
 258         int ret, i;
 259         char **pds, **ids;
 260
 261         /* Set up the protocol decoder stack. */
 262         pds = g_strsplit(opt_pds, ",", 0);
 263         if (g_strv_length(pds) > 1) {
 264                 if (opt_pd_stack) {
 265                         /* A stack setup was specified, use that. */
 266                         g_strfreev(pds);
 267                         pds = g_strsplit(opt_pd_stack, ",", 0);
 268                         if (g_strv_length(pds) < 2) {
 269                                 g_strfreev(pds);
 270                                 g_critical("Specify at least two protocol decoders to stack.");
 271                                 return 1;
 272                         }
 273                 }
 274
 275                 /* First PD goes at the bottom of the stack. */
 276                 ids = g_strsplit(pds[0], ":", 0);
 277                 if (!(di_from = srd_inst_find_by_id(srd_sess, ids[0]))) {
 278                         g_strfreev(ids);
 279                         g_critical("Cannot stack protocol decoder '%s': "
 280                                         "instance not found.", pds[0]);
 281                         return 1;
 282                 }
 283                 g_strfreev(ids);
 284
 285                 /* Every subsequent PD goes on top. */
 286                 for (i = 1; pds[i]; i++) {
 287                         ids = g_strsplit(pds[i], ":", 0);
 288                         if (!(di_to = srd_inst_find_by_id(srd_sess, ids[0]))) {
 289                                 g_strfreev(ids);
 290                                 g_critical("Cannot stack protocol decoder '%s': "
 291                                                 "instance not found.", pds[i]);
 292                                 return 1;
 293                         }
 294                         g_strfreev(ids);
 295                         if ((ret = srd_inst_stack(srd_sess, di_from, di_to)) != SRD_OK)
 296                                 return 1;
 297
 298                         /* Don't show annotation from this PD. Only the last PD in
 299                          * the stack will be left on the annotation list (unless
 300                          * the annotation list was specifically provided).
 301                          */
 302                         if (!opt_pd_annotations)
 303                                 g_hash_table_remove(pd_ann_visible,
 304                                                     di_from->inst_id);
 305
 306                         di_from = di_to;
 307                 }
 308         }
 309         g_strfreev(pds);
 310
 311         return 0;
 312 }
 313
 314 int setup_pd_annotations(char *opt_pd_annotations)
 315 {
 316         GSList *l;
 317         struct srd_decoder *dec;
 318         int ann_class;
 319         char **pds, **pdtok, **keyval, **ann_descr;
 320
 321         /* Set up custom list of PDs and annotations to show. */
 322         pds = g_strsplit(opt_pd_annotations, ",", 0);
 323         for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
 324                 keyval = g_strsplit(*pdtok, "=", 0);
 325                 if (!(dec = srd_decoder_get_by_id(keyval[0]))) {
 326                         g_critical("Protocol decoder '%s' not found.", keyval[0]);
 327                         return 1;
 328                 }
 329                 if (!dec->annotations) {
 330                         g_critical("Protocol decoder '%s' has no annotations.", keyval[0]);
 331                         return 1;
 332                 }
 333                 ann_class = 0;
 334                 if (g_strv_length(keyval) == 2) {
 335                         for (l = dec->annotations; l; l = l->next, ann_class++) {
 336                                 ann_descr = l->data;
 337                                 if (!canon_cmp(ann_descr[0], keyval[1]))
 338                                         /* Found it. */
 339                                         break;
 340                         }
 341                         if (!l) {
 342                                 g_critical("Annotation '%s' not found "
 343                                                 "for protocol decoder '%s'.", keyval[1], keyval[0]);
 344                                 return 1;
 345                         }
 346                         g_debug("cli: Showing protocol decoder %s annotation "
 347                                         "class %d (%s).", keyval[0], ann_class, ann_descr[0]);
 348                 } else {
 349                         /* No class specified: show all of them. */
 350                         ann_class = -1;
 351                         g_debug("cli: Showing all annotation classes for protocol "
 352                                         "decoder %s.", keyval[0]);
 353                 }
 354                 g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann_class));
 355                 g_strfreev(keyval);
 356         }
 357         g_strfreev(pds);
 358
 359         return 0;
 360 }
 361
 362 int setup_pd_meta(char *opt_pd_meta)
 363 {
 364         struct srd_decoder *dec;
 365         char **pds, **pdtok;
 366
 367         pd_meta_visible = g_hash_table_new_full(g_str_hash, g_int_equal,
 368                         g_free, NULL);
 369         pds = g_strsplit(opt_pd_meta, ",", 0);
 370         for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
 371                 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
 372                         g_critical("Protocol decoder '%s' not found.", *pdtok);
 373                         return 1;
 374                 }
 375                 g_debug("cli: Showing protocol decoder meta output from '%s'.", *pdtok);
 376                 g_hash_table_insert(pd_meta_visible, g_strdup(*pdtok), NULL);
 377         }
 378         g_strfreev(pds);
 379
 380         return 0;
 381 }
 382
 383 int setup_pd_binary(char *opt_pd_binary)
 384 {
 385         GSList *l;
 386         struct srd_decoder *dec;
 387         int bin_class;
 388         char **pds, **pdtok, **keyval, **bin_name;
 389
 390         pd_binary_visible = g_hash_table_new_full(g_str_hash, g_int_equal,
 391                         g_free, NULL);
 392         pds = g_strsplit(opt_pd_binary, ",", 0);
 393         for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
 394                 keyval = g_strsplit(*pdtok, "=", 0);
 395                 if (!(dec = srd_decoder_get_by_id(keyval[0]))) {
 396                         g_critical("Protocol decoder '%s' not found.", keyval[0]);
 397                         return 1;
 398                 }
 399                 if (!dec->binary) {
 400                         g_critical("Protocol decoder '%s' has no binary output.", keyval[0]);
 401                         return 1;
 402                 }
 403                 bin_class = 0;
 404                 if (g_strv_length(keyval) == 2) {
 405                         for (l = dec->binary; l; l = l->next, bin_class++) {
 406                                 bin_name = l->data;
 407                                 if (!strcmp(bin_name[0], keyval[1]))
 408                                         /* Found it. */
 409                                         break;
 410                         }
 411                         if (!l) {
 412                                 g_critical("binary output '%s' not found "
 413                                                 "for protocol decoder '%s'.", keyval[1], keyval[0]);
 414                                 return 1;
 415                         }
 416                         g_debug("cli: Showing protocol decoder %s binary class "
 417                                         "%d (%s).", keyval[0], bin_class, bin_name[0]);
 418                 } else {
 419                         /* No class specified: output all of them. */
 420                         bin_class = -1;
 421                         g_debug("cli: Showing all binary classes for protocol "
 422                                         "decoder %s.", keyval[0]);
 423                 }
 424                 g_hash_table_insert(pd_binary_visible, g_strdup(keyval[0]), GINT_TO_POINTER(bin_class));
 425                 g_strfreev(keyval);
 426         }
 427         g_strfreev(pds);
 428
 429         return 0;
 430 }
 431
 432 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
 433 {
 434         struct srd_decoder *dec;
 435         struct srd_proto_data_annotation *pda;
 436         gpointer ann_format;
 437         int format, i;
 438         char **ann_descr;
 439
 440         /* 'cb_data' is not used in this specific callback. */
 441         (void)cb_data;
 442
 443         if (!pd_ann_visible)
 444                 return;
 445
 446         if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id,
 447                         NULL, &ann_format))
 448                 /* Not in the list of PDs whose annotations we're showing. */
 449                 return;
 450
 451         format = GPOINTER_TO_INT(ann_format);
 452         dec = pdata->pdo->di->decoder;
 453         pda = pdata->data;
 454         if (format != -1 && pda->ann_format != format)
 455                 /* We don't want this particular format from the PD. */
 456                 return;
 457
 458         if (opt_loglevel <= SR_LOG_WARN) {
 459                 /* Show only the longest annotation. */
 460                 printf("%s", pda->ann_text[0]);
 461         } else if (opt_loglevel >= SR_LOG_INFO) {
 462                 /* Sample numbers and quotes around the longest annotation. */
 463                 printf("%"PRIu64"-%"PRIu64"", pdata->start_sample, pdata->end_sample);
 464                 if (opt_loglevel == SR_LOG_INFO) {
 465                         printf(" \"%s\"", pda->ann_text[0]);
 466                 } else {
 467                         /* Protocol decoder id, annotation class,
 468                          * all annotation strings. */
 469                         ann_descr = g_slist_nth_data(dec->annotations, pda->ann_format);
 470                         printf(" %s: %s:", pdata->pdo->proto_id, ann_descr[0]);
 471                         for (i = 0; pda->ann_text[i]; i++)
 472                                 printf(" \"%s\"", pda->ann_text[i]);
 473                 }
 474         }
 475         printf("\n");
 476         fflush(stdout);
 477 }
 478
 479 void show_pd_meta(struct srd_proto_data *pdata, void *cb_data)
 480 {
 481
 482         /* 'cb_data' is not used in this specific callback. */
 483         (void)cb_data;
 484
 485         if (!g_hash_table_lookup_extended(pd_meta_visible,
 486                         pdata->pdo->di->decoder->id, NULL, NULL))
 487                 /* Not in the list of PDs whose meta output we're showing. */
 488                 return;
 489
 490         if (opt_loglevel > SR_LOG_WARN)
 491                 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
 492         printf("%s: ", pdata->pdo->proto_id);
 493         printf("%s: %s", pdata->pdo->meta_name, g_variant_print(pdata->data, FALSE));
 494         printf("\n");
 495         fflush(stdout);
 496 }
 497
 498 void show_pd_binary(struct srd_proto_data *pdata, void *cb_data)
 499 {
 500         struct srd_proto_data_binary *pdb;
 501         gpointer classp;
 502         int class;
 503
 504         /* 'cb_data' is not used in this specific callback. */
 505         (void)cb_data;
 506
 507         if (!g_hash_table_lookup_extended(pd_binary_visible,
 508                         pdata->pdo->di->decoder->id, NULL, (void **)&classp))
 509                 /* Not in the list of PDs whose meta output we're showing. */
 510                 return;
 511
 512         class = GPOINTER_TO_INT(classp);
 513         pdb = pdata->data;
 514         if (class != -1 && class != pdb->bin_class)
 515                 /* Not showing this binary class. */
 516                 return;
 517
 518         /* Just send the binary output to stdout, no embellishments. */
 519         fwrite(pdb->data, pdb->size, 1, stdout);
 520         fflush(stdout);
 521 }
 522 #endif
 523