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