860c2ef9fc15db8f20cd46f3a84d37d258428ea1
[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();
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                                 free(s);
238                                 /* high */
239                                 if (!(s = sr_samplerate_string(samplerates->high)))
240                                         continue;
241                                 printf(" - %s", s);
242                                 free(s);
243                                 /* step */
244                                 if (!(s = sr_samplerate_string(samplerates->step)))
245                                         continue;
246                                 printf(" in steps of %s)\n", s);
247                                 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 = 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                                 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                 free(o);
387                 o = NULL;
388                 break;
389         case SR_DF_TRIGGER:
390                 g_message("cli: received SR_DF_TRIGGER at %"PRIu64" ms",
391                                 packet->timeoffset / 1000000);
392                 if (o->format->event)
393                         o->format->event(o, SR_DF_TRIGGER, &output_buf,
394                                          &output_len);
395                 triggered = 1;
396                 break;
397         case SR_DF_LOGIC:
398                 logic = packet->payload;
399                 sample_size = logic->unitsize;
400                 g_message("cli: received SR_DF_LOGIC at %f ms duration %f ms, %"PRIu64" bytes",
401                                 packet->timeoffset / 1000000.0, packet->duration / 1000000.0,
402                                 logic->length);
403                 break;
404         case SR_DF_ANALOG:
405                 break;
406         }
407
408         /* not supporting anything but SR_DF_LOGIC for now */
409
410         if (sample_size == -1 || logic->length == 0)
411                 return;
412
413         /* Don't store any samples until triggered. */
414         if (opt_wait_trigger && !triggered)
415                 return;
416
417         if (limit_samples && received_samples >= limit_samples)
418                 return;
419
420         /* TODO: filters only support SR_DF_LOGIC */
421         ret = sr_filter_probes(sample_size, unitsize, probelist,
422                                    logic->data, logic->length,
423                                    &filter_out, &filter_out_len);
424         if (ret != SR_OK)
425                 return;
426
427         /* what comes out of the filter is guaranteed to be packed into the
428          * minimum size needed to support the number of samples at this sample
429          * size. however, the driver may have submitted too much -- cut off
430          * the buffer of the last packet according to the sample limit.
431          */
432         if (limit_samples && (received_samples + logic->length / sample_size >
433                         limit_samples * sample_size))
434                 filter_out_len = limit_samples * sample_size - received_samples;
435
436         if (device->datastore)
437                 sr_datastore_put(device->datastore, filter_out,
438                                  filter_out_len, sample_size, probelist);
439
440         if (opt_output_file && default_output_format)
441                 /* saving to a session file, don't need to do anything else
442                  * to this data for now. */
443                 goto cleanup;
444
445         if (opt_pds) {
446                 if (srd_session_feed(received_samples, (uint8_t*)filter_out,
447                                 filter_out_len) != SRD_OK)
448                         sr_session_halt();
449         } else {
450                 output_len = 0;
451                 if (o->format->data && packet->type == o->format->df_type)
452                         o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len);
453                 if (output_len) {
454                         fwrite(output_buf, 1, output_len, outfile);
455                         free(output_buf);
456                 }
457         }
458
459 cleanup:
460         g_free(filter_out);
461         received_samples += logic->length / sample_size;
462
463 }
464
465 /* Register the given PDs for this session.
466  * Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5"
467  * That will instantiate two SPI decoders on the clock but different data
468  * lines.
469  */
470 static int register_pds(struct sr_device *device, const char *pdstring)
471 {
472         GHashTable *pd_opthash;
473         struct srd_decoder_instance *di;
474         char **pdtokens, **pdtok, *pd_name;
475
476         /* Avoid compiler warnings. */
477         (void)device;
478
479         g_datalist_init(&pd_ann_visible);
480         pdtokens = g_strsplit(pdstring, ",", -1);
481         pd_opthash = NULL;
482         pd_name = NULL;
483
484         for (pdtok = pdtokens; *pdtok; pdtok++) {
485                 if (!(pd_opthash = parse_generic_arg(*pdtok))) {
486                         fprintf(stderr, "Invalid protocol decoder option '%s'.\n", *pdtok);
487                         goto err_out;
488                 }
489
490                 pd_name = g_strdup(g_hash_table_lookup(pd_opthash, "sigrok_key"));
491                 g_hash_table_remove(pd_opthash, "sigrok_key");
492                 if (!(di = srd_instance_new(pd_name, pd_opthash))) {
493                         fprintf(stderr, "Failed to instantiate PD %s\n", pd_name);
494                         goto err_out;
495                 }
496                 g_datalist_set_data(&pd_ann_visible, di->instance_id, pd_name);
497
498                 /* Any keys left in the options hash are probes, where the key
499                  * is the probe name as specified in the decoder class, and the
500                  * value is the probe number i.e. the order in which the PD's
501                  * incoming samples are arranged. */
502                 if (srd_instance_set_probes(di, pd_opthash) != SRD_OK)
503                         goto err_out;
504                 g_hash_table_destroy(pd_opthash);
505                 pd_opthash = NULL;
506         }
507
508 err_out:
509         g_strfreev(pdtokens);
510         if (pd_opthash)
511                 g_hash_table_destroy(pd_opthash);
512         if (pd_name)
513                 g_free(pd_name);
514
515         return 0;
516 }
517
518 void show_pd_annotation(struct srd_proto_data *pdata)
519 {
520         int i;
521         char **annotations;
522
523         if (pdata->ann_format != 0) {
524                 /* CLI only shows the default annotation format. */
525                 return;
526         }
527
528         if (!g_datalist_get_data(&pd_ann_visible, pdata->pdo->di->instance_id)) {
529                 /* Not in the list of PDs whose annotations we're showing. */
530                 return;
531         }
532
533         annotations = pdata->data;
534         if (opt_loglevel > SR_LOG_WARN)
535                 printf("%"PRIu64"-%"PRIu64" ", pdata->start_sample, pdata->end_sample);
536         printf("%s: ", pdata->pdo->proto_id);
537         for (i = 0; annotations[i]; i++)
538                 printf("\"%s\" ", annotations[i]);
539         printf("\n");
540
541 }
542
543 static int select_probes(struct sr_device *device)
544 {
545         struct sr_probe *probe;
546         char **probelist;
547         int max_probes, i;
548
549         if (!opt_probes)
550                 return SR_OK;
551
552         /*
553          * This only works because a device by default initializes
554          * and enables all its probes.
555          */
556         max_probes = g_slist_length(device->probes);
557         probelist = parse_probestring(max_probes, opt_probes);
558         if (!probelist) {
559                 return SR_ERR;
560         }
561
562         for (i = 0; i < max_probes; i++) {
563                 if (probelist[i]) {
564                         sr_device_probe_name(device, i + 1, probelist[i]);
565                         g_free(probelist[i]);
566                 } else {
567                         probe = sr_device_probe_find(device, i + 1);
568                         probe->enabled = FALSE;
569                 }
570         }
571         g_free(probelist);
572
573         return SR_OK;
574 }
575
576 /**
577  * Return the input file format which the CLI tool should use.
578  *
579  * If the user specified -I / --input-format, use that one. Otherwise, try to
580  * autodetect the format as good as possible. Failing that, return NULL.
581  *
582  * @param filename The filename of the input file. Must not be NULL.
583  * @param opt The -I / --input-file option the user specified (or NULL).
584  *
585  * @return A pointer to the 'struct sr_input_format' that should be used,
586  *         or NULL if no input format was selected or auto-detected.
587  */
588 static struct sr_input_format *determine_input_file_format(
589                         const char *filename, const char *opt)
590 {
591         int i;
592         struct sr_input_format **inputs;
593
594         /* If there are no input formats, return NULL right away. */
595         inputs = sr_input_list();
596         if (!inputs) {
597                 fprintf(stderr, "cli: %s: no supported input formats "
598                         "available", __func__);
599                 return NULL;
600         }
601
602         /* If the user specified -I / --input-format, use that one. */
603         if (opt) {
604                 for (i = 0; inputs[i]; i++) {
605                         if (strcasecmp(inputs[i]->id, opt_input_format))
606                                 continue;
607                         printf("Using user-specified input file format"
608                                " '%s'.\n", inputs[i]->id);
609                         return inputs[i];
610                 }
611
612                 /* The user specified an unknown input format, return NULL. */
613                 fprintf(stderr, "Error: Specified input file format '%s' is "
614                         "unknown.\n", opt_input_format);
615                 return NULL;
616         }
617
618         /* Otherwise, try to find an input module that can handle this file. */
619         for (i = 0; inputs[i]; i++) {
620                 if (inputs[i]->format_match(filename))
621                         break;
622         }
623
624         /* Return NULL if no input module wanted to touch this. */
625         if (!inputs[i]) {
626                 fprintf(stderr, "Error: No matching input module found.\n");
627                 return NULL;
628         }
629                 
630         printf("Using input file format '%s'.\n", inputs[i]->id);
631         return inputs[i];
632 }
633
634 static void load_input_file_format(void)
635 {
636         struct stat st;
637         struct sr_input *in;
638         struct sr_input_format *input_format;
639
640         input_format = determine_input_file_format(opt_input_file,
641                                                    opt_input_format);
642         if (!input_format) {
643                 fprintf(stderr, "Error: Couldn't detect input file format.\n");
644                 return;
645         }
646
647         if (stat(opt_input_file, &st) == -1) {
648                 printf("Failed to load %s: %s\n", opt_input_file,
649                         strerror(errno));
650                 exit(1);
651         }
652
653         /* Initialize the input module. */
654         if (!(in = malloc(sizeof(struct sr_input)))) {
655                 printf("Failed to allocate input module.\n");
656                 exit(1);
657         }
658         in->format = input_format;
659         in->param = input_format_param;
660         if (in->format->init) {
661                 if (in->format->init(in) != SR_OK) {
662                         printf("Input format init failed.\n");
663                         exit(1);
664                 }
665         }
666
667         if (select_probes(in->vdevice) > 0)
668             return;
669
670         sr_session_new();
671         sr_session_datafeed_callback_add(datafeed_in);
672         if (sr_session_device_add(in->vdevice) != SR_OK) {
673                 printf("Failed to use device.\n");
674                 sr_session_destroy();
675                 return;
676         }
677
678         input_format->loadfile(in, opt_input_file);
679         if (opt_output_file && default_output_format) {
680                 if (sr_session_save(opt_output_file) != SR_OK)
681                         printf("Failed to save session.\n");
682         }
683         sr_session_destroy();
684
685 }
686
687 static void load_input_file(void)
688 {
689
690         if (sr_session_load(opt_input_file) == SR_OK) {
691                 /* sigrok session file */
692                 sr_session_datafeed_callback_add(datafeed_in);
693                 sr_session_start();
694                 sr_session_run();
695                 sr_session_stop();
696         }
697         else {
698                 /* fall back on input modules */
699                 load_input_file_format();
700         }
701
702 }
703
704 int num_real_devices(void)
705 {
706         struct sr_device *device;
707         GSList *devices, *l;
708         int num_devices;
709
710         num_devices = 0;
711         devices = sr_device_list();
712         for (l = devices; l; l = l->next) {
713                 device = l->data;
714                 if (!sr_device_has_hwcap(device, SR_HWCAP_DEMO_DEVICE))
715                         num_devices++;
716         }
717
718         return num_devices;
719 }
720
721 static int set_device_options(struct sr_device *device, GHashTable *args)
722 {
723         GHashTableIter iter;
724         gpointer key, value;
725         int ret, i;
726         uint64_t tmp_u64;
727         gboolean found;
728         gboolean tmp_bool;
729
730         g_hash_table_iter_init(&iter, args);
731         while (g_hash_table_iter_next(&iter, &key, &value)) {
732                 found = FALSE;
733                 for (i = 0; sr_hwcap_options[i].capability; i++) {
734                         if (strcmp(sr_hwcap_options[i].shortname, key))
735                                 continue;
736                         if ((value == NULL) && 
737                             (sr_hwcap_options[i].type != SR_T_BOOL)) {
738                                 printf("Option '%s' needs a value.\n", (char *)key);
739                                 return SR_ERR;
740                         }
741                         found = TRUE;
742                         switch (sr_hwcap_options[i].type) {
743                         case SR_T_UINT64:
744                                 ret = sr_parse_sizestring(value, &tmp_u64);
745                                 if (ret != SR_OK)
746                                         break;
747                                 ret = device->plugin-> set_configuration(device-> plugin_index,
748                                                 sr_hwcap_options[i]. capability, &tmp_u64);
749                                 break;
750                         case SR_T_CHAR:
751                                 ret = device->plugin-> set_configuration(device-> plugin_index,
752                                                 sr_hwcap_options[i]. capability, value);
753                                 break;
754                         case SR_T_BOOL:
755                                 if (!value)
756                                         tmp_bool = TRUE;
757                                 else 
758                                         tmp_bool = sr_parse_boolstring(value);
759                                 ret = device->plugin-> set_configuration(device-> plugin_index,
760                                                 sr_hwcap_options[i]. capability, 
761                                                 GINT_TO_POINTER(tmp_bool));
762                                 break;
763                         default:
764                                 ret = SR_ERR;
765                         }
766
767                         if (ret != SR_OK) {
768                                 printf("Failed to set device option '%s'.\n", (char *)key);
769                                 return ret;
770                         }
771                         else
772                                 break;
773                 }
774                 if (!found) {
775                         printf("Unknown device option '%s'.\n", (char *) key);
776                         return SR_ERR;
777                 }
778         }
779
780         return SR_OK;
781 }
782
783 static void run_session(void)
784 {
785         struct sr_device *device;
786         GHashTable *devargs;
787         int num_devices, max_probes, *capabilities, i;
788         uint64_t time_msec;
789         char **probelist, *devspec;
790
791         devargs = NULL;
792         if (opt_device) {
793                 devargs = parse_generic_arg(opt_device);
794                 devspec = g_hash_table_lookup(devargs, "sigrok_key");
795                 device = parse_devicestring(devspec);
796                 if (!device) {
797                         g_warning("Device not found.");
798                         return;
799                 }
800                 g_hash_table_remove(devargs, "sigrok_key");
801         } else {
802                 num_devices = num_real_devices();
803                 if (num_devices == 1) {
804                         /* No device specified, but there is only one. */
805                         devargs = NULL;
806                         device = parse_devicestring("0");
807                 } else if (num_devices == 0) {
808                         printf("No devices found.\n");
809                         return;
810                 } else {
811                         printf("%d devices found, please select one.\n", num_devices);
812                         return;
813                 }
814         }
815
816         sr_session_new();
817         sr_session_datafeed_callback_add(datafeed_in);
818
819         if (sr_session_device_add(device) != SR_OK) {
820                 printf("Failed to use device.\n");
821                 sr_session_destroy();
822                 return;
823         }
824
825         if (devargs) {
826                 if (set_device_options(device, devargs) != SR_OK) {
827                         sr_session_destroy();
828                         return;
829                 }
830                 g_hash_table_destroy(devargs);
831         }
832
833         if (select_probes(device) != SR_OK)
834             return;
835
836         if (opt_continuous) {
837                 capabilities = device->plugin->get_capabilities();
838                 if (!sr_find_hwcap(capabilities, SR_HWCAP_CONTINUOUS)) {
839                         printf("This device does not support continuous sampling.");
840                         sr_session_destroy();
841                         return;
842                 }
843         }
844
845         if (opt_triggers) {
846                 probelist = sr_parse_triggerstring(device, opt_triggers);
847                 if (!probelist) {
848                         sr_session_destroy();
849                         return;
850                 }
851
852                 max_probes = g_slist_length(device->probes);
853                 for (i = 0; i < max_probes; i++) {
854                         if (probelist[i]) {
855                                 sr_device_trigger_set(device, i + 1, probelist[i]);
856                                 g_free(probelist[i]);
857                         }
858                 }
859                 g_free(probelist);
860         }
861
862         if (opt_time) {
863                 time_msec = sr_parse_timestring(opt_time);
864                 if (time_msec == 0) {
865                         printf("Invalid time '%s'\n", opt_time);
866                         sr_session_destroy();
867                         return;
868                 }
869
870                 capabilities = device->plugin->get_capabilities();
871                 if (sr_find_hwcap(capabilities, SR_HWCAP_LIMIT_MSEC)) {
872                         if (device->plugin->set_configuration(device->plugin_index,
873                                                           SR_HWCAP_LIMIT_MSEC, &time_msec) != SR_OK) {
874                                 printf("Failed to configure time limit.\n");
875                                 sr_session_destroy();
876                                 return;
877                         }
878                 }
879                 else {
880                         /* time limit set, but device doesn't support this...
881                          * convert to samples based on the samplerate.
882                          */
883                         limit_samples = 0;
884                         if (sr_device_has_hwcap(device, SR_HWCAP_SAMPLERATE)) {
885                                 const uint64_t *samplerate;
886
887                                 sr_device_get_info(device, SR_DI_CUR_SAMPLERATE,
888                                                                    (const void **) &samplerate);
889                                 limit_samples = (*samplerate) * 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_by_id(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_by_id(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 }