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