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