2 * This file is part of the sigrok-cli project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #include "sigrok-cli.h"
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;
30 extern struct srd_session *srd_sess;
31 extern gint opt_loglevel;
34 static int opts_to_gvar(struct srd_decoder *dec, GHashTable *hash,
37 struct srd_decoder_option *o;
45 *options = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
46 (GDestroyNotify)g_variant_unref);
48 for (optl = dec->options; optl; optl = optl->next) {
50 if (!(val_str = g_hash_table_lookup(hash, o->id)))
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);
63 gvar = g_variant_new_int64(val_int);
65 g_critical("Unsupported type for option '%s' (%s)",
66 o->id, g_variant_get_type_string(o->def));
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);
78 static int move_hash_element(GHashTable *src, GHashTable *dest, void *key)
80 void *orig_key, *value;
82 if (!g_hash_table_lookup_extended(src, key, &orig_key, &value))
85 g_hash_table_steal(src, orig_key);
86 g_hash_table_insert(dest, orig_key, value);
91 static GHashTable *extract_probe_map(struct srd_decoder *dec, GHashTable *hash)
93 GHashTable *probe_map;
97 probe_map = g_hash_table_new_full(g_str_hash, g_str_equal,
100 for (l = dec->probes; l; l = l->next) {
102 move_hash_element(hash, probe_map, p->id);
104 for (l = dec->opt_probes; l; l = l->next) {
106 move_hash_element(hash, probe_map, p->id);
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
117 int register_pds(const char *opt_pds, char *opt_pd_annotations)
119 struct srd_decoder *dec;
120 GHashTable *pd_opthash, *options, *probes;
122 struct srd_decoder_inst *di;
124 char **pdtokens, **pdtok, *pd_name;
126 pd_ann_visible = g_hash_table_new_full(g_str_hash, g_str_equal,
128 pd_probe_maps = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
129 (GDestroyNotify)g_hash_table_destroy);
132 pd_opthash = options = probes = NULL;
133 pdtokens = g_strsplit(opt_pds, ",", 0);
134 for (pdtok = pdtokens; *pdtok; pdtok++) {
135 if (!(pd_opthash = parse_generic_arg(*pdtok, TRUE))) {
136 g_critical("Invalid protocol decoder option '%s'.", *pdtok);
140 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
141 g_hash_table_remove(pd_opthash, "sigrok_key");
142 if (srd_decoder_load(pd_name) != SRD_OK) {
143 g_critical("Failed to load protocol decoder %s.", pd_name);
147 dec = srd_decoder_get_by_id(pd_name);
149 /* Convert decoder option and probe values to GVariant. */
150 if (!opts_to_gvar(dec, pd_opthash, &options)) {
154 probes = extract_probe_map(dec, pd_opthash);
156 if (g_hash_table_size(pd_opthash) > 0) {
157 leftover = g_hash_table_get_keys(pd_opthash);
158 for (l = leftover; l; l = l->next)
159 g_critical("Unknown option or probe '%s'", (char *)l->data);
160 g_list_free(leftover);
164 if (!(di = srd_inst_new(srd_sess, pd_name, options))) {
165 g_critical("Failed to instantiate protocol decoder %s.", pd_name);
170 /* Save the probe setup for later. */
171 g_hash_table_insert(pd_probe_maps, g_strdup(di->inst_id), probes);
174 /* If no annotation list was specified, add them all in now.
175 * This will be pared down later to leave only the last PD
178 if (!opt_pd_annotations)
179 g_hash_table_insert(pd_ann_visible,
180 g_strdup(di->inst_id), GINT_TO_POINTER(-1));
183 g_strfreev(pdtokens);
185 g_hash_table_destroy(pd_opthash);
187 g_hash_table_destroy(options);
189 g_hash_table_destroy(probes);
196 static void map_pd_inst_probes(void *key, void *value, void *user_data)
198 GHashTable *probe_map;
199 GHashTable *probe_indices;
201 struct srd_decoder_inst *di;
205 struct sr_probe *probe;
210 probe_list = user_data;
212 di = srd_inst_find_by_id(srd_sess, key);
214 g_critical("Protocol decoder instance \"%s\" not found.",
218 probe_indices = g_hash_table_new_full(g_str_hash, g_str_equal, g_free,
219 (GDestroyNotify)g_variant_unref);
221 g_hash_table_iter_init(&iter, probe_map);
222 while (g_hash_table_iter_next(&iter, &probe_id, &probe_target)) {
223 probe = find_probe(probe_list, probe_target);
225 g_printerr("cli: No probe with name \"%s\" found.\n",
226 (char *)probe_target);
230 g_printerr("cli: Target probe \"%s\" not enabled.\n",
231 (char *)probe_target);
233 var = g_variant_new_int32(probe->index);
234 g_variant_ref_sink(var);
235 g_hash_table_insert(probe_indices, g_strdup(probe_id), var);
238 num_probes = g_slist_length(probe_list);
239 srd_inst_probe_set_all(di, probe_indices, (num_probes + 7) / 8);
242 void map_pd_probes(struct sr_dev_inst *sdi)
245 g_hash_table_foreach(pd_probe_maps, &map_pd_inst_probes,
247 g_hash_table_destroy(pd_probe_maps);
248 pd_probe_maps = NULL;
252 int setup_pd_stack(char *opt_pds, char *opt_pd_stack, char *opt_pd_annotations)
254 struct srd_decoder_inst *di_from, *di_to;
258 /* Set up the protocol decoder stack. */
259 pds = g_strsplit(opt_pds, ",", 0);
260 if (g_strv_length(pds) > 1) {
262 /* A stack setup was specified, use that. */
264 pds = g_strsplit(opt_pd_stack, ",", 0);
265 if (g_strv_length(pds) < 2) {
267 g_critical("Specify at least two protocol decoders to stack.");
272 /* First PD goes at the bottom of the stack. */
273 ids = g_strsplit(pds[0], ":", 0);
274 if (!(di_from = srd_inst_find_by_id(srd_sess, ids[0]))) {
276 g_critical("Cannot stack protocol decoder '%s': "
277 "instance not found.", pds[0]);
282 /* Every subsequent PD goes on top. */
283 for (i = 1; pds[i]; i++) {
284 ids = g_strsplit(pds[i], ":", 0);
285 if (!(di_to = srd_inst_find_by_id(srd_sess, ids[0]))) {
287 g_critical("Cannot stack protocol decoder '%s': "
288 "instance not found.", pds[i]);
292 if ((ret = srd_inst_stack(srd_sess, di_from, di_to)) != SRD_OK)
295 /* Don't show annotation from this PD. Only the last PD in
296 * the stack will be left on the annotation list (unless
297 * the annotation list was specifically provided).
299 if (!opt_pd_annotations)
300 g_hash_table_remove(pd_ann_visible,
311 int setup_pd_annotations(char *opt_pd_annotations)
314 struct srd_decoder *dec;
316 char **pds, **pdtok, **keyval, **ann_descr;
318 /* Set up custom list of PDs and annotations to show. */
319 pds = g_strsplit(opt_pd_annotations, ",", 0);
320 for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
321 keyval = g_strsplit(*pdtok, "=", 0);
322 if (!(dec = srd_decoder_get_by_id(keyval[0]))) {
323 g_critical("Protocol decoder '%s' not found.", keyval[0]);
326 if (!dec->annotations) {
327 g_critical("Protocol decoder '%s' has no annotations.", keyval[0]);
331 if (g_strv_length(keyval) == 2) {
332 for (l = dec->annotations; l; l = l->next, ann_class++) {
334 if (!canon_cmp(ann_descr[0], keyval[1]))
339 g_critical("Annotation '%s' not found "
340 "for protocol decoder '%s'.", keyval[1], keyval[0]);
343 g_debug("cli: Showing protocol decoder %s annotation "
344 "class %d (%s).", keyval[0], ann_class, ann_descr[0]);
346 /* No class specified: show all of them. */
348 g_debug("cli: Showing all annotation classes for protocol "
349 "decoder %s.", keyval[0]);
351 g_hash_table_insert(pd_ann_visible, g_strdup(keyval[0]), GINT_TO_POINTER(ann_class));
359 int setup_pd_meta(char *opt_pd_meta)
361 struct srd_decoder *dec;
364 pd_meta_visible = g_hash_table_new_full(g_str_hash, g_int_equal,
366 pds = g_strsplit(opt_pd_meta, ",", 0);
367 for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
368 if (!(dec = srd_decoder_get_by_id(*pdtok))) {
369 g_critical("Protocol decoder '%s' not found.", *pdtok);
372 g_debug("cli: Showing protocol decoder meta output from '%s'.", *pdtok);
373 g_hash_table_insert(pd_meta_visible, g_strdup(*pdtok), NULL);
380 int setup_pd_binary(char *opt_pd_binary)
383 struct srd_decoder *dec;
385 char **pds, **pdtok, **keyval, **bin_name;
387 pd_binary_visible = g_hash_table_new_full(g_str_hash, g_int_equal,
389 pds = g_strsplit(opt_pd_binary, ",", 0);
390 for (pdtok = pds; *pdtok && **pdtok; pdtok++) {
391 keyval = g_strsplit(*pdtok, "=", 0);
392 if (!(dec = srd_decoder_get_by_id(keyval[0]))) {
393 g_critical("Protocol decoder '%s' not found.", keyval[0]);
397 g_critical("Protocol decoder '%s' has no binary output.", keyval[0]);
401 if (g_strv_length(keyval) == 2) {
402 for (l = dec->binary; l; l = l->next, bin_class++) {
404 if (!strcmp(bin_name[0], keyval[1]))
409 g_critical("binary output '%s' not found "
410 "for protocol decoder '%s'.", keyval[1], keyval[0]);
413 g_debug("cli: Showing protocol decoder %s binary class "
414 "%d (%s).", keyval[0], bin_class, bin_name[0]);
416 /* No class specified: output all of them. */
418 g_debug("cli: Showing all binary classes for protocol "
419 "decoder %s.", keyval[0]);
421 g_hash_table_insert(pd_binary_visible, g_strdup(keyval[0]), GINT_TO_POINTER(bin_class));
429 void show_pd_annotations(struct srd_proto_data *pdata, void *cb_data)
431 struct srd_decoder *dec;
432 struct srd_proto_data_annotation *pda;
437 /* 'cb_data' is not used in this specific callback. */
443 if (!g_hash_table_lookup_extended(pd_ann_visible, pdata->pdo->di->inst_id,
445 /* Not in the list of PDs whose annotations we're showing. */
448 format = GPOINTER_TO_INT(ann_format);
449 dec = pdata->pdo->di->decoder;
451 if (format != -1 && pda->ann_format != format)
452 /* We don't want this particular format from the PD. */
455 if (opt_loglevel <= SR_LOG_WARN) {
456 /* Show only the longest annotation. */
457 printf("%s", pda->ann_text[0]);
458 } else if (opt_loglevel >= SR_LOG_INFO) {
459 /* Sample numbers and quotes around the longest annotation. */
460 printf("%"PRIu64"-%"PRIu64"", pdata->start_sample, pdata->end_sample);
461 if (opt_loglevel == SR_LOG_INFO) {
462 printf(" \"%s\"", pda->ann_text[0]);
464 /* Protocol decoder id, annotation class,
465 * all annotation strings. */
466 ann_descr = g_slist_nth_data(dec->annotations, pda->ann_format);
467 printf(" %s: %s:", pdata->pdo->proto_id, ann_descr[0]);
468 for (i = 0; pda->ann_text[i]; i++)
469 printf(" \"%s\"", pda->ann_text[i]);
476 void show_pd_meta(struct srd_proto_data *pdata, void *cb_data)
479 /* 'cb_data' is not used in this specific callback. */
482 if (!g_hash_table_lookup_extended(pd_meta_visible,
483 pdata->pdo->di->decoder->id, NULL, NULL))
484 /* Not in the list of PDs whose meta output we're showing. */
487 if (opt_loglevel > SR_LOG_WARN)
488 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
489 printf("%s: ", pdata->pdo->proto_id);
490 printf("%s: %s", pdata->pdo->meta_name, g_variant_print(pdata->data, FALSE));
495 void show_pd_binary(struct srd_proto_data *pdata, void *cb_data)
497 struct srd_proto_data_binary *pdb;
501 /* 'cb_data' is not used in this specific callback. */
504 if (!g_hash_table_lookup_extended(pd_binary_visible,
505 pdata->pdo->di->decoder->id, NULL, (void **)&classp))
506 /* Not in the list of PDs whose meta output we're showing. */
509 class = GPOINTER_TO_INT(classp);
511 if (class != -1 && class != pdb->bin_class)
512 /* Not showing this binary class. */
515 /* Just send the binary output to stdout, no embellishments. */
516 fwrite(pdb->data, pdb->size, 1, stdout);