21e3ad939afbe5b0ba0bb25f1100e36c60c98763
[sigrok-cli.git] / sigrok-cli.c
1 /*
2  * This file is part of the sigrok 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 <sigrokdecode.h> /* First, so we avoid a _POSIX_C_SOURCE warning. */
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <unistd.h>
24 #include <string.h>
25 #include <time.h>
26 #include <sys/time.h>
27 #include <inttypes.h>
28 #include <sys/types.h>
29 #include <sys/stat.h>
30 #include <errno.h>
31 #include <glib.h>
32 #include <glib/gstdio.h>
33 #include <sigrok.h>
34 #include "sigrok-cli.h"
35 #include "config.h"
36
37 #define DEFAULT_OUTPUT_FORMAT "bits:width=64"
38
39 extern struct sr_hwcap_option sr_hwcap_options[];
40
41 static gboolean debug = 0;
42 static uint64_t limit_samples = 0;
43 static struct sr_output_format *output_format = NULL;
44 static int default_output_format = FALSE;
45 static char *output_format_param = NULL;
46 static char *input_format_param = NULL;
47 static GData *pd_ann_visible = NULL;
48
49 static gboolean opt_version = FALSE;
50 static gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */
51 static gboolean opt_list_devices = FALSE;
52 static gboolean opt_wait_trigger = FALSE;
53 static gchar *opt_input_file = NULL;
54 static gchar *opt_output_file = NULL;
55 static gchar *opt_device = NULL;
56 static gchar *opt_probes = NULL;
57 static gchar *opt_triggers = NULL;
58 static gchar *opt_pds = NULL;
59 static gchar *opt_pd_stack = NULL;
60 static gchar *opt_input_format = NULL;
61 static gchar *opt_format = NULL;
62 static gchar *opt_time = NULL;
63 static gchar *opt_samples = NULL;
64 static gchar *opt_continuous = NULL;
65
66 static GOptionEntry optargs[] = {
67         {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version, "Show version and support list", NULL},
68         {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel, "Select libsigrok loglevel", NULL},
69         {"list-devices", 'D', 0, G_OPTION_ARG_NONE, &opt_list_devices, "List devices", NULL},
70         {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file, "Load input from file", NULL},
71         {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file, "Save output to file", NULL},
72         {"device", 'd', 0, G_OPTION_ARG_STRING, &opt_device, "Use device ID", NULL},
73         {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes, "Probes to use", NULL},
74         {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers, "Trigger configuration", NULL},
75         {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger, "Wait for trigger", NULL},
76         {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds, "Protocol decoder sequence", NULL},
77         {"protocol-decoder-stack", 's', 0, G_OPTION_ARG_STRING, &opt_pd_stack, "Protocol decoder stack", NULL},
78         {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format, "Input format", NULL},
79         {"format", 'f', 0, G_OPTION_ARG_STRING, &opt_format, "Output format", NULL},
80         {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time, "How long to sample (ms)", NULL},
81         {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples, "Number of samples to acquire", NULL},
82         {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous, "Sample continuously", NULL},
83         {NULL, 0, 0, 0, NULL, NULL, NULL}
84 };
85
86 static void show_version(void)
87 {
88         GSList *plugins, *p, *l;
89         struct sr_device_plugin *plugin;
90         struct sr_input_format **inputs;
91         struct sr_output_format **outputs;
92         struct srd_decoder *dec;
93         int i;
94
95         printf("sigrok-cli %s\n\n", VERSION);
96         printf("Supported hardware drivers:\n");
97         plugins = sr_list_hwplugins();
98         for (p = plugins; p; p = p->next) {
99                 plugin = p->data;
100                 printf("  %-20s %s\n", plugin->name, plugin->longname);
101         }
102         printf("\n");
103
104         printf("Supported input formats:\n");
105         inputs = sr_input_list();
106         for (i = 0; inputs[i]; i++)
107                 printf("  %-20s %s\n", inputs[i]->id, inputs[i]->description);
108         printf("\n");
109
110         printf("Supported output formats:\n");
111         outputs = sr_output_list();
112         for (i = 0; outputs[i]; i++)
113                 printf("  %-20s %s\n", outputs[i]->id, outputs[i]->description);
114         printf("\n");
115
116         /* TODO: Error handling. */
117         srd_init(NULL);
118
119         printf("Supported protocol decoders:\n");
120         for (l = srd_list_decoders(); l; l = l->next) {
121                 dec = l->data;
122                 printf("  %-20s %s\n", dec->id, dec->longname);
123         }
124         printf("\n");
125
126         srd_exit();
127 }
128
129 static void print_device_line(const struct sr_device *device)
130 {
131         const struct sr_device_instance *sdi;
132
133         sr_device_get_info(device, SR_DI_INSTANCE, (const void **)&sdi);
134
135         if (sdi->vendor && sdi->vendor[0])
136                 printf("%s ", sdi->vendor);
137         if (sdi->model && sdi->model[0])
138                 printf("%s ", sdi->model);
139         if (sdi->version && sdi->version[0])
140                 printf("%s ", sdi->version);
141         if (device->probes)
142                 printf("with %d probes", g_slist_length(device->probes));
143         printf("\n");
144 }
145
146 static void show_device_list(void)
147 {
148         struct sr_device *device, *demo_device;
149         GSList *devices, *l;
150         int devcnt;
151
152         devcnt = 0;
153         devices = sr_device_list();
154
155         if (g_slist_length(devices) == 0)
156                 return;
157
158         printf("The following devices were found:\nID    Device\n");
159         demo_device = NULL;
160         for (l = devices; l; l = l->next) {
161                 device = l->data;
162                 if (sr_device_has_hwcap(device, SR_HWCAP_DEMO_DEVICE)) {
163                         demo_device = device;
164                         continue;
165                 }
166                 printf("%-3d   ", devcnt++);
167                 print_device_line(device);
168         }
169         if (demo_device) {
170                 printf("demo  ");
171                 print_device_line(demo_device);
172         }
173 }
174
175 static void show_device_detail(void)
176 {
177         struct sr_device *device;
178         struct sr_hwcap_option *hwo;
179         const struct sr_samplerates *samplerates;
180         int cap, *capabilities, i;
181         char *s, *title;
182         const char *charopts, **stropts;
183
184         device = parse_devicestring(opt_device);
185         if (!device) {
186                 printf("No such device. Use -D to list all devices.\n");
187                 return;
188         }
189
190         print_device_line(device);
191
192         if (sr_device_get_info(device, SR_DI_TRIGGER_TYPES,
193                                         (const void **)&charopts) == SR_OK) {
194                 printf("Supported triggers: ");
195                 while (*charopts) {
196                         printf("%c ", *charopts);
197                         charopts++;
198                 }
199                 printf("\n");
200         }
201
202         title = "Supported options:\n";
203         capabilities = device->plugin->get_capabilities();
204         for (cap = 0; capabilities[cap]; cap++) {
205                 if (!(hwo = sr_find_hwcap_option(capabilities[cap])))
206                         continue;
207
208                 if (title) {
209                         printf("%s", title);
210                         title = NULL;
211                 }
212
213                 if (hwo->capability == SR_HWCAP_PATTERN_MODE) {
214                         printf("    %s", hwo->shortname);
215                         if (sr_device_get_info(device, SR_DI_PATTERNMODES,
216                                         (const void **)&stropts) == SR_OK) {
217                                 printf(" - supported modes:\n");
218                                 for (i = 0; stropts[i]; i++)
219                                         printf("      %s\n", stropts[i]);
220                         } else {
221                                 printf("\n");
222                         }
223                 } else if (hwo->capability == SR_HWCAP_SAMPLERATE) {
224                         printf("    %s", hwo->shortname);
225                         /* Supported samplerates */
226                         if (sr_device_get_info(device, SR_DI_SAMPLERATES,
227                                         (const void **)&samplerates) != SR_OK) {
228                                 printf("\n");
229                                 continue;
230                         }
231
232                         if (samplerates->step) {
233                                 /* low */
234                                 if (!(s = sr_samplerate_string(samplerates->low)))
235                                         continue;
236                                 printf(" (%s", s);
237                                 g_free(s);
238                                 /* high */
239                                 if (!(s = sr_samplerate_string(samplerates->high)))
240                                         continue;
241                                 printf(" - %s", s);
242                                 g_free(s);
243                                 /* step */
244                                 if (!(s = sr_samplerate_string(samplerates->step)))
245                                         continue;
246                                 printf(" in steps of %s)\n", s);
247                                 g_free(s);
248                         } else {
249                                 printf(" - supported samplerates:\n");
250                                 for (i = 0; samplerates->list[i]; i++) {
251                                         printf("      %7s\n", sr_samplerate_string(samplerates->list[i]));
252                                 }
253                         }
254                 } else {
255                         printf("    %s\n", hwo->shortname);
256                 }
257         }
258 }
259
260 static void show_pd_detail(void)
261 {
262         GSList *l;
263         struct srd_decoder *dec;
264         char **pdtokens, **pdtok, **ann, *doc;
265
266         pdtokens = g_strsplit(opt_pds, ",", -1);
267         for (pdtok = pdtokens; *pdtok; pdtok++) {
268                 if (!(dec = srd_get_decoder_by_id(*pdtok))) {
269                         printf("Protocol decoder %s not found.", *pdtok);
270                         return;
271                 }
272                 printf("ID: %s\nName: %s\nLong name: %s\nDescription: %s\n",
273                                 dec->id, dec->name, dec->longname, dec->desc);
274                 printf("License: %s\n", dec->license);
275                 if (dec->annotations) {
276                         printf("Annotations:\n");
277                         for (l = dec->annotations; l; l = l->next) {
278                                 ann = l->data;
279                                 printf("- %s\n  %s\n", ann[0], ann[1]);
280                         }
281                 }
282                 if ((doc = srd_decoder_doc(dec))) {
283                         printf("Documentation:\n%s\n", doc[0] == '\n' ? doc+1 : doc);
284                         g_free(doc);
285                 }
286         }
287
288         g_strfreev(pdtokens);
289
290 }
291
292 static void datafeed_in(struct sr_device *device, struct sr_datafeed_packet *packet)
293 {
294         static struct sr_output *o = NULL;
295         static int probelist[SR_MAX_NUM_PROBES] = { 0 };
296         static uint64_t received_samples = 0;
297         static int unitsize = 0;
298         static int triggered = 0;
299         static FILE *outfile = NULL;
300         struct sr_probe *probe;
301         struct sr_datafeed_header *header;
302         struct sr_datafeed_logic *logic;
303         int num_enabled_probes, sample_size, ret, i;
304         uint64_t output_len, filter_out_len;
305         char *output_buf, *filter_out;
306
307         /* If the first packet to come in isn't a header, don't even try. */
308         if (packet->type != SR_DF_HEADER && o == NULL)
309                 return;
310
311         sample_size = -1;
312         switch (packet->type) {
313         case SR_DF_HEADER:
314                 g_message("cli: Received SR_DF_HEADER");
315                 /* Initialize the output module. */
316                 if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
317                         printf("Output module malloc failed.\n");
318                         exit(1);
319                 }
320                 o->format = output_format;
321                 o->device = device;
322                 o->param = output_format_param;
323                 if (o->format->init) {
324                         if (o->format->init(o) != SR_OK) {
325                                 printf("Output format initialization failed.\n");
326                                 exit(1);
327                         }
328                 }
329
330                 header = packet->payload;
331                 num_enabled_probes = 0;
332                 for (i = 0; i < header->num_logic_probes; i++) {
333                         probe = g_slist_nth_data(device->probes, i);
334                         if (probe->enabled)
335                                 probelist[num_enabled_probes++] = probe->index;
336                 }
337                 /* How many bytes we need to store num_enabled_probes bits */
338                 unitsize = (num_enabled_probes + 7) / 8;
339
340                 outfile = stdout;
341                 if (opt_output_file) {
342                         if (default_output_format) {
343                                 /* output file is in session format, which means we'll
344                                  * dump everything in the datastore as it comes in,
345                                  * and save from there after the session. */
346                                 outfile = NULL;
347                                 ret = sr_datastore_new(unitsize, &(device->datastore));
348                                 if (ret != SR_OK) {
349                                         printf("Failed to create datastore.\n");
350                                         exit(1);
351                                 }
352                         } else {
353                                 /* saving to a file in whatever format was set
354                                  * with --format, so all we need is a filehandle */
355                                 outfile = g_fopen(opt_output_file, "wb");
356                         }
357                 }
358                 if (opt_pds)
359                         srd_session_start(num_enabled_probes, unitsize,
360                                         header->samplerate);
361                 break;
362         case SR_DF_END:
363                 g_message("cli: Received SR_DF_END");
364                 if (!o) {
365                         g_message("cli: double end!");
366                         break;
367                 }
368                 if (o->format->event) {
369                         o->format->event(o, SR_DF_END, &output_buf, &output_len);
370                         if (output_len) {
371                                 if (outfile)
372                                         fwrite(output_buf, 1, output_len, outfile);
373                                 g_free(output_buf);
374                                 output_len = 0;
375                         }
376                 }
377                 if (limit_samples && received_samples < limit_samples)
378                         printf("Device only sent %" PRIu64 " samples.\n",
379                                received_samples);
380                 if (opt_continuous)
381                         printf("Device stopped after %" PRIu64 " samples.\n",
382                                received_samples);
383                 sr_session_halt();
384                 if (outfile && outfile != stdout)
385                         fclose(outfile);
386                 g_free(o);
387                 o = NULL;
388                 break;
389         case SR_DF_TRIGGER:
390                 g_message("cli: received SR_DF_TRIGGER");
391                 if (o->format->event)
392                         o->format->event(o, SR_DF_TRIGGER, &output_buf,
393                                          &output_len);
394                 triggered = 1;
395                 break;
396         case SR_DF_LOGIC:
397                 logic = packet->payload;
398                 sample_size = logic->unitsize;
399                 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
400                 break;
401         }
402
403         /* not supporting anything but SR_DF_LOGIC for now */
404
405         if (sample_size == -1 || logic->length == 0)
406                 return;
407
408         /* Don't store any samples until triggered. */
409         if (opt_wait_trigger && !triggered)
410                 return;
411
412         if (limit_samples && received_samples >= limit_samples)
413                 return;
414
415         /* TODO: filters only support SR_DF_LOGIC */
416         ret = sr_filter_probes(sample_size, unitsize, probelist,
417                                    logic->data, logic->length,
418                                    &filter_out, &filter_out_len);
419         if (ret != SR_OK)
420                 return;
421
422         /* what comes out of the filter is guaranteed to be packed into the
423          * minimum size needed to support the number of samples at this sample
424          * size. however, the driver may have submitted too much -- cut off
425          * the buffer of the last packet according to the sample limit.
426          */
427         if (limit_samples && (received_samples + logic->length / sample_size >
428                         limit_samples * sample_size))
429                 filter_out_len = limit_samples * sample_size - received_samples;
430
431         if (device->datastore)
432                 sr_datastore_put(device->datastore, filter_out,
433                                  filter_out_len, sample_size, probelist);
434
435         if (opt_output_file && default_output_format)
436                 /* saving to a session file, don't need to do anything else
437                  * to this data for now. */
438                 goto cleanup;
439
440         if (opt_pds) {
441                 if (srd_session_feed(received_samples, (uint8_t*)filter_out,
442                                 filter_out_len) != SRD_OK)
443                         sr_session_halt();
444         } else {
445                 output_len = 0;
446                 if (o->format->data && packet->type == o->format->df_type)
447                         o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len);
448                 if (output_len) {
449                         fwrite(output_buf, 1, output_len, outfile);
450                         g_free(output_buf);
451                 }
452         }
453
454 cleanup:
455         g_free(filter_out);
456         received_samples += logic->length / sample_size;
457
458 }
459
460 /* Register the given PDs for this session.
461  * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
462  * That will instantiate two SPI decoders on the clock but different data
463  * lines.
464  */
465 static int register_pds(struct sr_device *device, const char *pdstring)
466 {
467         GHashTable *pd_opthash;
468         struct srd_decoder_inst *di;
469         char **pdtokens, **pdtok, *pd_name;
470
471         /* Avoid compiler warnings. */
472         (void)device;
473
474         g_datalist_init(&pd_ann_visible);
475         pdtokens = g_strsplit(pdstring, ",", -1);
476         pd_opthash = NULL;
477         pd_name = NULL;
478
479         for (pdtok = pdtokens; *pdtok; pdtok++) {
480                 if (!(pd_opthash = parse_generic_arg(*pdtok))) {
481                         fprintf(stderr, "Invalid protocol decoder option '%s'.\n", *pdtok);
482                         goto err_out;
483                 }
484
485                 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
486                 g_hash_table_remove(pd_opthash, "sigrok_key");
487                 if (!(di = srd_inst_new(pd_name, pd_opthash))) {
488                         fprintf(stderr, "Failed to instantiate PD %s\n", pd_name);
489                         goto err_out;
490                 }
491                 g_datalist_set_data(&pd_ann_visible, di->inst_id, pd_name);
492
493                 /* Any keys left in the options hash are probes, where the key
494                  * is the probe name as specified in the decoder class, and the
495                  * value is the probe number i.e. the order in which the PD's
496                  * incoming samples are arranged. */
497                 if (srd_inst_set_probes(di, pd_opthash) != SRD_OK)
498                         goto err_out;
499                 g_hash_table_destroy(pd_opthash);
500                 pd_opthash = NULL;
501         }
502
503 err_out:
504         g_strfreev(pdtokens);
505         if (pd_opthash)
506                 g_hash_table_destroy(pd_opthash);
507         if (pd_name)
508                 g_free(pd_name);
509
510         return 0;
511 }
512
513 void show_pd_annotation(struct srd_proto_data *pdata, void *user_data)
514 {
515         int i;
516         char **annotations;
517
518         /* 'user_data' is not used in this specific callback. */
519         (void)user_data;
520
521         if (pdata->ann_format != 0) {
522                 /* CLI only shows the default annotation format. */
523                 return;
524         }
525
526         if (!g_datalist_get_data(&pd_ann_visible, pdata->pdo->di->inst_id)) {
527                 /* Not in the list of PDs whose annotations we're showing. */
528                 return;
529         }
530
531         annotations = pdata->data;
532         if (opt_loglevel > SR_LOG_WARN)
533                 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
534         printf("%s: ", pdata->pdo->proto_id);
535         for (i = 0; annotations[i]; i++)
536                 printf("\"%s\" ", annotations[i]);
537         printf("\n");
538
539 }
540
541 static int select_probes(struct sr_device *device)
542 {
543         struct sr_probe *probe;
544         char **probelist;
545         int max_probes, i;
546
547         if (!opt_probes)
548                 return SR_OK;
549
550         /*
551          * This only works because a device by default initializes
552          * and enables all its probes.
553          */
554         max_probes = g_slist_length(device->probes);
555         probelist = parse_probestring(max_probes, opt_probes);
556         if (!probelist) {
557                 return SR_ERR;
558         }
559
560         for (i = 0; i < max_probes; i++) {
561                 if (probelist[i]) {
562                         sr_device_probe_name(device, i + 1, probelist[i]);
563                         g_free(probelist[i]);
564                 } else {
565                         probe = sr_device_probe_find(device, i + 1);
566                         probe->enabled = FALSE;
567                 }
568         }
569         g_free(probelist);
570
571         return SR_OK;
572 }
573
574 /**
575  * Return the input file format which the CLI tool should use.
576  *
577  * If the user specified -I / --input-format, use that one. Otherwise, try to
578  * autodetect the format as good as possible. Failing that, return NULL.
579  *
580  * @param filename The filename of the input file. Must not be NULL.
581  * @param opt The -I / --input-file option the user specified (or NULL).
582  *
583  * @return A pointer to the 'struct sr_input_format' that should be used,
584  *         or NULL if no input format was selected or auto-detected.
585  */
586 static struct sr_input_format *determine_input_file_format(
587                         const char *filename, const char *opt)
588 {
589         int i;
590         struct sr_input_format **inputs;
591
592         /* If there are no input formats, return NULL right away. */
593         inputs = sr_input_list();
594         if (!inputs) {
595                 fprintf(stderr, "cli: %s: no supported input formats "
596                         "available", __func__);
597                 return NULL;
598         }
599
600         /* If the user specified -I / --input-format, use that one. */
601         if (opt) {
602                 for (i = 0; inputs[i]; i++) {
603                         if (strcasecmp(inputs[i]->id, opt_input_format))
604                                 continue;
605                         printf("Using user-specified input file format"
606                                " '%s'.\n", inputs[i]->id);
607                         return inputs[i];
608                 }
609
610                 /* The user specified an unknown input format, return NULL. */
611                 fprintf(stderr, "Error: Specified input file format '%s' is "
612                         "unknown.\n", opt_input_format);
613                 return NULL;
614         }
615
616         /* Otherwise, try to find an input module that can handle this file. */
617         for (i = 0; inputs[i]; i++) {
618                 if (inputs[i]->format_match(filename))
619                         break;
620         }
621
622         /* Return NULL if no input module wanted to touch this. */
623         if (!inputs[i]) {
624                 fprintf(stderr, "Error: No matching input module found.\n");
625                 return NULL;
626         }
627                 
628         printf("Using input file format '%s'.\n", inputs[i]->id);
629         return inputs[i];
630 }
631
632 static void load_input_file_format(void)
633 {
634         struct stat st;
635         struct sr_input *in;
636         struct sr_input_format *input_format;
637
638         input_format = determine_input_file_format(opt_input_file,
639                                                    opt_input_format);
640         if (!input_format) {
641                 fprintf(stderr, "Error: Couldn't detect input file format.\n");
642                 return;
643         }
644
645         if (stat(opt_input_file, &st) == -1) {
646                 printf("Failed to load %s: %s\n", opt_input_file,
647                         strerror(errno));
648                 exit(1);
649         }
650
651         /* Initialize the input module. */
652         if (!(in = g_try_malloc(sizeof(struct sr_input)))) {
653                 printf("Failed to allocate input module.\n");
654                 exit(1);
655         }
656         in->format = input_format;
657         in->param = input_format_param;
658         if (in->format->init) {
659                 if (in->format->init(in) != SR_OK) {
660                         printf("Input format init failed.\n");
661                         exit(1);
662                 }
663         }
664
665         if (select_probes(in->vdevice) > 0)
666             return;
667
668         sr_session_new();
669         sr_session_datafeed_callback_add(datafeed_in);
670         if (sr_session_device_add(in->vdevice) != SR_OK) {
671                 printf("Failed to use device.\n");
672                 sr_session_destroy();
673                 return;
674         }
675
676         input_format->loadfile(in, opt_input_file);
677         if (opt_output_file && default_output_format) {
678                 if (sr_session_save(opt_output_file) != SR_OK)
679                         printf("Failed to save session.\n");
680         }
681         sr_session_destroy();
682
683 }
684
685 static void load_input_file(void)
686 {
687
688         if (sr_session_load(opt_input_file) == SR_OK) {
689                 /* sigrok session file */
690                 sr_session_datafeed_callback_add(datafeed_in);
691                 sr_session_start();
692                 sr_session_run();
693                 sr_session_stop();
694         }
695         else {
696                 /* fall back on input modules */
697                 load_input_file_format();
698         }
699
700 }
701
702 int num_real_devices(void)
703 {
704         struct sr_device *device;
705         GSList *devices, *l;
706         int num_devices;
707
708         num_devices = 0;
709         devices = sr_device_list();
710         for (l = devices; l; l = l->next) {
711                 device = l->data;
712                 if (!sr_device_has_hwcap(device, SR_HWCAP_DEMO_DEVICE))
713                         num_devices++;
714         }
715
716         return num_devices;
717 }
718
719 static int set_device_options(struct sr_device *device, GHashTable *args)
720 {
721         GHashTableIter iter;
722         gpointer key, value;
723         int ret, i;
724         uint64_t tmp_u64;
725         gboolean found;
726         gboolean tmp_bool;
727
728         g_hash_table_iter_init(&iter, args);
729         while (g_hash_table_iter_next(&iter, &key, &value)) {
730                 found = FALSE;
731                 for (i = 0; sr_hwcap_options[i].capability; i++) {
732                         if (strcmp(sr_hwcap_options[i].shortname, key))
733                                 continue;
734                         if ((value == NULL) && 
735                             (sr_hwcap_options[i].type != SR_T_BOOL)) {
736                                 printf("Option '%s' needs a value.\n", (char *)key);
737                                 return SR_ERR;
738                         }
739                         found = TRUE;
740                         switch (sr_hwcap_options[i].type) {
741                         case SR_T_UINT64:
742                                 ret = sr_parse_sizestring(value, &tmp_u64);
743                                 if (ret != SR_OK)
744                                         break;
745                                 ret = device->plugin-> set_configuration(device-> plugin_index,
746                                                 sr_hwcap_options[i]. capability, &tmp_u64);
747                                 break;
748                         case SR_T_CHAR:
749                                 ret = device->plugin-> set_configuration(device-> plugin_index,
750                                                 sr_hwcap_options[i]. capability, value);
751                                 break;
752                         case SR_T_BOOL:
753                                 if (!value)
754                                         tmp_bool = TRUE;
755                                 else 
756                                         tmp_bool = sr_parse_boolstring(value);
757                                 ret = device->plugin-> set_configuration(device-> plugin_index,
758                                                 sr_hwcap_options[i]. capability, 
759                                                 GINT_TO_POINTER(tmp_bool));
760                                 break;
761                         default:
762                                 ret = SR_ERR;
763                         }
764
765                         if (ret != SR_OK) {
766                                 printf("Failed to set device option '%s'.\n", (char *)key);
767                                 return ret;
768                         }
769                         else
770                                 break;
771                 }
772                 if (!found) {
773                         printf("Unknown device option '%s'.\n", (char *) key);
774                         return SR_ERR;
775                 }
776         }
777
778         return SR_OK;
779 }
780
781 static void run_session(void)
782 {
783         struct sr_device *device;
784         GHashTable *devargs;
785         int num_devices, max_probes, *capabilities, i;
786         uint64_t time_msec;
787         char **probelist, *devspec;
788
789         devargs = NULL;
790         if (opt_device) {
791                 devargs = parse_generic_arg(opt_device);
792                 devspec = g_hash_table_lookup(devargs, "sigrok_key");
793                 device = parse_devicestring(devspec);
794                 if (!device) {
795                         g_warning("Device not found.");
796                         return;
797                 }
798                 g_hash_table_remove(devargs, "sigrok_key");
799         } else {
800                 num_devices = num_real_devices();
801                 if (num_devices == 1) {
802                         /* No device specified, but there is only one. */
803                         devargs = NULL;
804                         device = parse_devicestring("0");
805                 } else if (num_devices == 0) {
806                         printf("No devices found.\n");
807                         return;
808                 } else {
809                         printf("%d devices found, please select one.\n", num_devices);
810                         return;
811                 }
812         }
813
814         sr_session_new();
815         sr_session_datafeed_callback_add(datafeed_in);
816
817         if (sr_session_device_add(device) != SR_OK) {
818                 printf("Failed to use device.\n");
819                 sr_session_destroy();
820                 return;
821         }
822
823         if (devargs) {
824                 if (set_device_options(device, devargs) != SR_OK) {
825                         sr_session_destroy();
826                         return;
827                 }
828                 g_hash_table_destroy(devargs);
829         }
830
831         if (select_probes(device) != SR_OK)
832             return;
833
834         if (opt_continuous) {
835                 capabilities = device->plugin->get_capabilities();
836                 if (!sr_has_hwcap(capabilities, SR_HWCAP_CONTINUOUS)) {
837                         printf("This device does not support continuous sampling.");
838                         sr_session_destroy();
839                         return;
840                 }
841         }
842
843         if (opt_triggers) {
844                 probelist = sr_parse_triggerstring(device, opt_triggers);
845                 if (!probelist) {
846                         sr_session_destroy();
847                         return;
848                 }
849
850                 max_probes = g_slist_length(device->probes);
851                 for (i = 0; i < max_probes; i++) {
852                         if (probelist[i]) {
853                                 sr_device_trigger_set(device, i + 1, probelist[i]);
854                                 g_free(probelist[i]);
855                         }
856                 }
857                 g_free(probelist);
858         }
859
860         if (opt_time) {
861                 time_msec = sr_parse_timestring(opt_time);
862                 if (time_msec == 0) {
863                         printf("Invalid time '%s'\n", opt_time);
864                         sr_session_destroy();
865                         return;
866                 }
867
868                 capabilities = device->plugin->get_capabilities();
869                 if (sr_has_hwcap(capabilities, SR_HWCAP_LIMIT_MSEC)) {
870                         if (device->plugin->set_configuration(device->plugin_index,
871                                                           SR_HWCAP_LIMIT_MSEC, &time_msec) != SR_OK) {
872                                 printf("Failed to configure time limit.\n");
873                                 sr_session_destroy();
874                                 return;
875                         }
876                 }
877                 else {
878                         /* time limit set, but device doesn't support this...
879                          * convert to samples based on the samplerate.
880                          */
881                         limit_samples = 0;
882                         if (sr_device_has_hwcap(device, SR_HWCAP_SAMPLERATE)) {
883                                 const uint64_t *samplerate;
884
885                                 sr_device_get_info(device, SR_DI_CUR_SAMPLERATE,
886                                                 (const void **)&samplerate);
887                                 limit_samples = (*samplerate) * time_msec / (uint64_t)1000;
888                         }
889                         if (limit_samples == 0) {
890                                 printf("Not enough time at this samplerate.\n");
891                                 sr_session_destroy();
892                                 return;
893                         }
894
895                         if (device->plugin->set_configuration(device->plugin_index,
896                                                   SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK) {
897                                 printf("Failed to configure time-based sample limit.\n");
898                                 sr_session_destroy();
899                                 return;
900                         }
901                 }
902         }
903
904         if (opt_samples) {
905                 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)
906                         || (device->plugin->set_configuration(device->plugin_index,
907                                         SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK)) {
908                         printf("Failed to configure sample limit.\n");
909                         sr_session_destroy();
910                         return;
911                 }
912         }
913
914         if (device->plugin->set_configuration(device->plugin_index,
915                   SR_HWCAP_PROBECONFIG, (char *)device->probes) != SR_OK) {
916                 printf("Failed to configure probes.\n");
917                 sr_session_destroy();
918                 return;
919         }
920
921         if (sr_session_start() != SR_OK) {
922                 printf("Failed to start session.\n");
923                 sr_session_destroy();
924                 return;
925         }
926
927         if (opt_continuous)
928                 add_anykey();
929
930         sr_session_run();
931
932         if (opt_continuous)
933                 clear_anykey();
934
935         if (opt_output_file && default_output_format) {
936                 if (sr_session_save(opt_output_file) != SR_OK)
937                         printf("Failed to save session.\n");
938         }
939         sr_session_destroy();
940
941 }
942
943 static void logger(const gchar *log_domain, GLogLevelFlags log_level,
944                    const gchar *message, gpointer user_data)
945 {
946         /* Avoid compiler warnings. */
947         (void)log_domain;
948         (void)user_data;
949
950         /*
951          * All messages, warnings, errors etc. go to stderr (not stdout) in
952          * order to not mess up the CLI tool data output, e.g. VCD output.
953          */
954         if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_WARNING)) {
955                 fprintf(stderr, "%s\n", message);
956                 fflush(stderr);
957         } else {
958                 if ((log_level & G_LOG_LEVEL_MESSAGE && debug == 1)
959                     || debug == 2) {
960                         printf("%s\n", message);
961                         fflush(stderr);
962                 }
963         }
964 }
965
966 int main(int argc, char **argv)
967 {
968         GOptionContext *context;
969         GError *error;
970         GHashTable *fmtargs;
971         GHashTableIter iter;
972         gpointer key, value;
973         struct sr_output_format **outputs;
974         struct srd_decoder_inst *di_from, *di_to;
975         int i, ret;
976         char *fmtspec, **pds;
977
978         g_log_set_default_handler(logger, NULL);
979         if (getenv("SIGROK_DEBUG"))
980                 debug = strtol(getenv("SIGROK_DEBUG"), NULL, 10);
981
982         error = NULL;
983         context = g_option_context_new(NULL);
984         g_option_context_add_main_entries(context, optargs, NULL);
985
986         if (!g_option_context_parse(context, &argc, &argv, &error)) {
987                 g_warning("%s", error->message);
988                 return 1;
989         }
990
991         /* Set the loglevel (amount of messages to output) for libsigrok. */
992         if (sr_log_loglevel_set(opt_loglevel) != SR_OK) {
993                 fprintf(stderr, "cli: %s: sr_log_loglevel_set(%d) failed\n",
994                         __func__, opt_loglevel);
995                 return 1;
996         }
997
998         /* Set the loglevel (amount of messages to output) for libsigrokdecode. */
999         if (srd_log_loglevel_set(opt_loglevel) != SRD_OK) {
1000                 fprintf(stderr, "cli: %s: srd_log_loglevel_set(%d) failed\n",
1001                         __func__, opt_loglevel);
1002                 return 1;
1003         }
1004
1005         if (sr_init() != SR_OK)
1006                 return 1;
1007
1008         if (opt_pds) {
1009                 if (srd_init(NULL) != SRD_OK) {
1010                         printf("Failed to initialize sigrokdecode\n");
1011                         return 1;
1012                 }
1013                 if (register_pds(NULL, opt_pds) != 0) {
1014                         printf("Failed to register protocol decoders\n");
1015                         return 1;
1016                 }
1017                 if (srd_register_callback(SRD_OUTPUT_ANN,
1018                                 show_pd_annotation, NULL) != SRD_OK) {
1019                         printf("Failed to register protocol decoder callback\n");
1020                         return 1;
1021                 }
1022         }
1023
1024         if (opt_pd_stack) {
1025                 pds = g_strsplit(opt_pd_stack, ",", 0);
1026                 if (g_strv_length(pds) < 2) {
1027                         printf("Specify at least two protocol decoders to stack.\n");
1028                         return 1;
1029                 }
1030
1031                 if (!(di_from = srd_inst_find_by_id(pds[0]))) {
1032                         printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[0]);
1033                         return 1;
1034                 }
1035                 for (i = 1; pds[i]; i++) {
1036                         if (!(di_to = srd_inst_find_by_id(pds[i]))) {
1037                                 printf("Cannot stack protocol decoder '%s': instance not found.\n", pds[i]);
1038                                 return 1;
1039                         }
1040                         if ((ret = srd_inst_stack(di_from, di_to) != SRD_OK))
1041                                 return ret;
1042
1043                         /* Don't show annotation from this PD. Only the last PD in
1044                          * the stack will be left on the annotation list.
1045                          */
1046                         g_datalist_remove_data(&pd_ann_visible, di_from->inst_id);
1047
1048                         di_from = di_to;
1049                 }
1050                 g_strfreev(pds);
1051         }
1052
1053         if (!opt_format) {
1054                 opt_format = DEFAULT_OUTPUT_FORMAT;
1055                 /* we'll need to remember this so when saving to a file
1056                  * later, sigrok session format will be used.
1057                  */
1058                 default_output_format = TRUE;
1059         }
1060         fmtargs = parse_generic_arg(opt_format);
1061         fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
1062         if (!fmtspec) {
1063                 printf("Invalid output format.\n");
1064                 return 1;
1065         }
1066         outputs = sr_output_list();
1067         for (i = 0; outputs[i]; i++) {
1068                 if (strcmp(outputs[i]->id, fmtspec))
1069                         continue;
1070                 g_hash_table_remove(fmtargs, "sigrok_key");
1071                 output_format = outputs[i];
1072                 g_hash_table_iter_init(&iter, fmtargs);
1073                 while (g_hash_table_iter_next(&iter, &key, &value)) {
1074                         /* only supporting one parameter per output module
1075                          * for now, and only its value */
1076                         output_format_param = g_strdup(value);
1077                         break;
1078                 }
1079                 break;
1080         }
1081         if (!output_format) {
1082                 printf("invalid output format %s\n", opt_format);
1083                 return 1;
1084         }
1085
1086         if (opt_version)
1087                 show_version();
1088         else if (opt_list_devices)
1089                 show_device_list();
1090         else if (opt_input_file)
1091                 load_input_file();
1092         else if (opt_samples || opt_time || opt_continuous)
1093                 run_session();
1094         else if (opt_device)
1095                 show_device_detail();
1096         else if (opt_pds)
1097                 show_pd_detail();
1098         else
1099                 printf("%s", g_option_context_get_help(context, TRUE, NULL));
1100
1101         if (opt_pds)
1102                 srd_exit();
1103
1104         g_option_context_free(context);
1105         g_hash_table_destroy(fmtargs);
1106         sr_exit();
1107
1108         return 0;
1109 }