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