090fdce8f32fea1b408f25e6199ff446d2472db1
[sigrok-cli.git] / session.c
1 /*
2  * This file is part of the sigrok-cli project.
3  *
4  * Copyright (C) 2013 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 "sigrok-cli.h"
21 #include <glib.h>
22 #include <glib/gstdio.h>
23 #include <string.h>
24 #include <stdlib.h>
25
26 static uint64_t limit_samples = 0;
27 static uint64_t limit_frames = 0;
28 static char *srzip_and_filename = NULL;
29
30 #ifdef HAVE_SRD
31 extern struct srd_session *srd_sess;
32 #endif
33
34 static int set_limit_time(const struct sr_dev_inst *sdi)
35 {
36         GVariant *gvar;
37         uint64_t time_msec;
38         uint64_t samplerate;
39         struct sr_dev_driver *driver;
40
41         driver = sr_dev_inst_driver_get(sdi);
42
43         if (!(time_msec = sr_parse_timestring(opt_time))) {
44                 g_critical("Invalid time '%s'", opt_time);
45                 return SR_ERR;
46         }
47
48         if (config_key_has_cap(driver, sdi, NULL, SR_CONF_LIMIT_MSEC, SR_CONF_SET)) {
49                 gvar = g_variant_new_uint64(time_msec);
50                 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) {
51                         g_critical("Failed to configure time limit.");
52                         return SR_ERR;
53                 }
54         } else if (config_key_has_cap(driver, sdi, NULL, SR_CONF_SAMPLERATE,
55                         SR_CONF_GET | SR_CONF_SET)) {
56                 /* Convert to samples based on the samplerate.  */
57                 sr_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar);
58                 samplerate = g_variant_get_uint64(gvar);
59                 g_variant_unref(gvar);
60                 limit_samples = (samplerate) * time_msec / (uint64_t)1000;
61                 if (limit_samples == 0) {
62                         g_critical("Not enough time at this samplerate.");
63                         return SR_ERR;
64                 }
65                 gvar = g_variant_new_uint64(limit_samples);
66                 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
67                         g_critical("Failed to configure time-based sample limit.");
68                         return SR_ERR;
69                 }
70         } else {
71                 g_critical("This device does not support time limits.");
72                 return SR_ERR;
73         }
74
75         return SR_OK;
76 }
77
78 const struct sr_output *setup_output_format(const struct sr_dev_inst *sdi)
79 {
80         const struct sr_output_module *omod;
81         const struct sr_option **options;
82         const struct sr_output *o;
83         GHashTable *fmtargs, *fmtopts;
84         int size;
85         char *fmtspec;
86
87         if (!opt_output_format) {
88                 if (opt_output_file) {
89                         size = strlen(opt_output_file) + 32;
90                         srzip_and_filename = g_malloc(size);
91                         snprintf(srzip_and_filename, size, "srzip:filename=%s", opt_output_file);
92                         opt_output_format = srzip_and_filename;
93                 } else {
94                         opt_output_format = DEFAULT_OUTPUT_FORMAT;
95                 }
96         }
97
98         fmtargs = parse_generic_arg(opt_output_format, TRUE);
99         fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
100         if (!fmtspec)
101                 g_critical("Invalid output format.");
102         if (!(omod = sr_output_find(fmtspec)))
103                 g_critical("Unknown output module '%s'.", fmtspec);
104         g_hash_table_remove(fmtargs, "sigrok_key");
105         if ((options = sr_output_options_get(omod))) {
106                 fmtopts = generic_arg_to_opt(options, fmtargs);
107                 sr_output_options_free(options);
108         } else
109                 fmtopts = NULL;
110         o = sr_output_new(omod, fmtopts, sdi);
111         if (fmtopts)
112                 g_hash_table_destroy(fmtopts);
113         g_hash_table_destroy(fmtargs);
114
115         return o;
116 }
117
118 const struct sr_transform *setup_transform_module(const struct sr_dev_inst *sdi)
119 {
120         const struct sr_transform_module *tmod;
121         const struct sr_option **options;
122         const struct sr_transform *t;
123         GHashTable *fmtargs, *fmtopts;
124         char *fmtspec;
125
126         if (!opt_transform_module)
127                 opt_transform_module = "nop";
128
129         fmtargs = parse_generic_arg(opt_transform_module, TRUE);
130         fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
131         if (!fmtspec)
132                 g_critical("Invalid transform module.");
133         if (!(tmod = sr_transform_find(fmtspec)))
134                 g_critical("Unknown transform module '%s'.", fmtspec);
135         g_hash_table_remove(fmtargs, "sigrok_key");
136         if ((options = sr_transform_options_get(tmod))) {
137                 fmtopts = generic_arg_to_opt(options, fmtargs);
138                 sr_transform_options_free(options);
139         } else
140                 fmtopts = NULL;
141         t = sr_transform_new(tmod, fmtopts, sdi);
142         if (fmtopts)
143                 g_hash_table_destroy(fmtopts);
144         g_hash_table_destroy(fmtargs);
145
146         return t;
147 }
148
149 void datafeed_in(const struct sr_dev_inst *sdi,
150                 const struct sr_datafeed_packet *packet, void *cb_data)
151 {
152         const struct sr_datafeed_meta *meta;
153         const struct sr_datafeed_logic *logic;
154         const struct sr_datafeed_analog *analog;
155         struct sr_session *session;
156         struct sr_config *src;
157         static const struct sr_output *o = NULL;
158         static const struct sr_output *oa = NULL;
159         static uint64_t rcvd_samples_logic = 0;
160         static uint64_t rcvd_samples_analog = 0;
161         static uint64_t samplerate = 0;
162         static int triggered = 0;
163         static FILE *outfile = NULL;
164         GSList *l;
165         GString *out;
166         GVariant *gvar;
167         uint64_t end_sample;
168         uint64_t input_len;
169         struct sr_dev_driver *driver;
170
171         driver = sr_dev_inst_driver_get(sdi);
172
173         /* If the first packet to come in isn't a header, don't even try. */
174         if (packet->type != SR_DF_HEADER && o == NULL)
175                 return;
176
177         session = cb_data;
178         switch (packet->type) {
179         case SR_DF_HEADER:
180                 g_debug("cli: Received SR_DF_HEADER.");
181                 if (!(o = setup_output_format(sdi)))
182                         g_critical("Failed to initialize output module.");
183
184                 /* Set up backup analog output module. */
185                 oa = sr_output_new(sr_output_find("analog"), NULL, sdi);
186
187                 if (opt_output_file)
188                         outfile = g_fopen(opt_output_file, "wb");
189                 else
190                         outfile = stdout;
191
192                 rcvd_samples_logic = rcvd_samples_analog = 0;
193
194                 if (maybe_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE,
195                                 &gvar) == SR_OK) {
196                         samplerate = g_variant_get_uint64(gvar);
197                         g_variant_unref(gvar);
198                 }
199
200 #ifdef HAVE_SRD
201                 if (opt_pds) {
202                         if (samplerate) {
203                                 if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
204                                                 g_variant_new_uint64(samplerate)) != SRD_OK) {
205                                         g_critical("Failed to configure decode session.");
206                                         break;
207                                 }
208                         }
209                         if (srd_session_start(srd_sess) != SRD_OK) {
210                                 g_critical("Failed to start decode session.");
211                                 break;
212                         }
213                 }
214 #endif
215                 break;
216
217         case SR_DF_META:
218                 g_debug("cli: Received SR_DF_META.");
219                 meta = packet->payload;
220                 for (l = meta->config; l; l = l->next) {
221                         src = l->data;
222                         switch (src->key) {
223                         case SR_CONF_SAMPLERATE:
224                                 samplerate = g_variant_get_uint64(src->data);
225                                 g_debug("cli: Got samplerate %"PRIu64" Hz.", samplerate);
226 #ifdef HAVE_SRD
227                                 if (opt_pds) {
228                                         if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
229                                                         g_variant_new_uint64(samplerate)) != SRD_OK) {
230                                                 g_critical("Failed to pass samplerate to decoder.");
231                                         }
232                                 }
233 #endif
234                                 break;
235                         case SR_CONF_SAMPLE_INTERVAL:
236                                 samplerate = g_variant_get_uint64(src->data);
237                                 g_debug("cli: Got sample interval %"PRIu64" ms.", samplerate);
238                                 break;
239                         default:
240                                 /* Unknown metadata is not an error. */
241                                 break;
242                         }
243                 }
244                 break;
245
246         case SR_DF_TRIGGER:
247                 g_debug("cli: Received SR_DF_TRIGGER.");
248                 triggered = 1;
249                 break;
250
251         case SR_DF_LOGIC:
252                 logic = packet->payload;
253                 g_message("cli: Received SR_DF_LOGIC (%"PRIu64" bytes, unitsize = %d).",
254                                 logic->length, logic->unitsize);
255                 if (logic->length == 0)
256                         break;
257
258                 /* Don't store any samples until triggered. */
259                 if (opt_wait_trigger && !triggered)
260                         break;
261
262                 if (limit_samples && rcvd_samples_logic >= limit_samples)
263                         break;
264
265                 end_sample = rcvd_samples_logic + logic->length / logic->unitsize;
266                 /* Cut off last packet according to the sample limit. */
267                 if (limit_samples && end_sample > limit_samples)
268                         end_sample = limit_samples;
269                 input_len = (end_sample - rcvd_samples_logic) * logic->unitsize;
270
271                 if (opt_pds) {
272 #ifdef HAVE_SRD
273                         if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample,
274                                         logic->data, input_len) != SRD_OK)
275                                 sr_session_stop(session);
276 #endif
277                 }
278
279                 rcvd_samples_logic = end_sample;
280                 break;
281
282         case SR_DF_ANALOG:
283                 analog = packet->payload;
284                 g_message("cli: Received SR_DF_ANALOG (%d samples).", analog->num_samples);
285                 if (analog->num_samples == 0)
286                         break;
287
288                 if (limit_samples && rcvd_samples_analog >= limit_samples)
289                         break;
290
291                 rcvd_samples_analog += analog->num_samples;
292                 break;
293
294         case SR_DF_FRAME_BEGIN:
295                 g_debug("cli: Received SR_DF_FRAME_BEGIN.");
296                 break;
297
298         case SR_DF_FRAME_END:
299                 g_debug("cli: Received SR_DF_FRAME_END.");
300                 break;
301
302         default:
303                 break;
304         }
305
306         if (o && outfile && !opt_pds) {
307                 if (sr_output_send(o, packet, &out) == SR_OK) {
308                         if (!out || (out->len == 0
309                                         && !opt_output_format
310                                         && packet->type == SR_DF_ANALOG)) {
311                                 /* The user didn't specify an output module,
312                                  * but needs to see this analog data. */
313                                 sr_output_send(oa, packet, &out);
314                         }
315                         if (out && out->len > 0) {
316                                 fwrite(out->str, 1, out->len, outfile);
317                                 fflush(outfile);
318                         }
319                         if (out)
320                                 g_string_free(out, TRUE);
321                 }
322         }
323
324         /* SR_DF_END needs to be handled after the output module's receive()
325          * is called, so it can properly clean up that module. */
326         if (packet->type == SR_DF_END) {
327                 g_debug("cli: Received SR_DF_END.");
328
329                 if (o) {
330                         sr_output_free(o);
331                         if (srzip_and_filename)
332                                 g_free(srzip_and_filename);
333                 }
334                 o = NULL;
335
336                 sr_output_free(oa);
337                 oa = NULL;
338
339                 if (outfile && outfile != stdout)
340                         fclose(outfile);
341
342                 if (limit_samples) {
343                         if (rcvd_samples_logic > 0 && rcvd_samples_logic < limit_samples)
344                                 g_warning("Device only sent %" PRIu64 " samples.",
345                                            rcvd_samples_logic);
346                         else if (rcvd_samples_analog > 0 && rcvd_samples_analog < limit_samples)
347                                 g_warning("Device only sent %" PRIu64 " samples.",
348                                            rcvd_samples_analog);
349                 }
350         }
351
352 }
353
354 int opt_to_gvar(char *key, char *value, struct sr_config *src)
355 {
356         const struct sr_config_info *srci;
357         double tmp_double, dlow, dhigh;
358         uint64_t tmp_u64, p, q, low, high;
359         GVariant *rational[2], *range[2];
360         GVariantBuilder *vbl;
361         gboolean tmp_bool;
362         gchar **keyval;
363         int ret;
364
365         if (!(srci = sr_config_info_name_get(key))) {
366                 g_critical("Unknown device option '%s'.", (char *) key);
367                 return -1;
368         }
369         src->key = srci->key;
370
371         if ((value == NULL || strlen(value) == 0) &&
372                 (srci->datatype != SR_T_BOOL)) {
373                 g_critical("Option '%s' needs a value.", (char *)key);
374                 return -1;
375         }
376
377         ret = 0;
378         switch (srci->datatype) {
379         case SR_T_UINT64:
380                 ret = sr_parse_sizestring(value, &tmp_u64);
381                 if (ret != 0)
382                         break;
383                 src->data = g_variant_new_uint64(tmp_u64);
384                 break;
385         case SR_T_INT32:
386                 ret = sr_parse_sizestring(value, &tmp_u64);
387                 if (ret != 0)
388                         break;
389                 src->data = g_variant_new_int32(tmp_u64);
390                 break;
391         case SR_T_STRING:
392                 src->data = g_variant_new_string(value);
393                 break;
394         case SR_T_BOOL:
395                 if (!value)
396                         tmp_bool = TRUE;
397                 else
398                         tmp_bool = sr_parse_boolstring(value);
399                 src->data = g_variant_new_boolean(tmp_bool);
400                 break;
401         case SR_T_FLOAT:
402                 tmp_double = strtof(value, NULL);
403                 src->data = g_variant_new_double(tmp_double);
404                 break;
405         case SR_T_RATIONAL_PERIOD:
406                 if ((ret = sr_parse_period(value, &p, &q)) != SR_OK)
407                         break;
408                 rational[0] = g_variant_new_uint64(p);
409                 rational[1] = g_variant_new_uint64(q);
410                 src->data = g_variant_new_tuple(rational, 2);
411                 break;
412         case SR_T_RATIONAL_VOLT:
413                 if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK)
414                         break;
415                 rational[0] = g_variant_new_uint64(p);
416                 rational[1] = g_variant_new_uint64(q);
417                 src->data = g_variant_new_tuple(rational, 2);
418                 break;
419         case SR_T_UINT64_RANGE:
420                 if (sscanf(value, "%"PRIu64"-%"PRIu64, &low, &high) != 2) {
421                         ret = -1;
422                         break;
423                 } else {
424                         range[0] = g_variant_new_uint64(low);
425                         range[1] = g_variant_new_uint64(high);
426                         src->data = g_variant_new_tuple(range, 2);
427                 }
428                 break;
429         case SR_T_DOUBLE_RANGE:
430                 if (sscanf(value, "%lf-%lf", &dlow, &dhigh) != 2) {
431                         ret = -1;
432                         break;
433                 } else {
434                         range[0] = g_variant_new_double(dlow);
435                         range[1] = g_variant_new_double(dhigh);
436                         src->data = g_variant_new_tuple(range, 2);
437                 }
438                 break;
439         case SR_T_KEYVALUE:
440                 /* Expects the argument to be in the form of key=value. */
441                 keyval = g_strsplit(value, "=", 2);
442                 if (!keyval[0] || !keyval[1]) {
443                         g_strfreev(keyval);
444                         ret = -1;
445                         break;
446                 } else {
447                         vbl = g_variant_builder_new(G_VARIANT_TYPE_DICTIONARY);
448                         g_variant_builder_add(vbl, "{ss}",
449                                               keyval[0], keyval[1]);
450                         src->data = g_variant_builder_end(vbl);
451                         g_strfreev(keyval);
452                 }
453                 break;
454         default:
455                 g_critical("Unknown data type specified for option '%s' "
456                            "(driver implementation bug?).", key);
457                 ret = -1;
458         }
459
460         if (ret < 0)
461                 g_critical("Invalid value: '%s' for option '%s'", value, key);
462
463         return ret;
464 }
465
466 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
467 {
468         struct sr_config src;
469         struct sr_channel_group *cg;
470         GHashTableIter iter;
471         gpointer key, value;
472         int ret;
473
474         g_hash_table_iter_init(&iter, args);
475         while (g_hash_table_iter_next(&iter, &key, &value)) {
476                 if ((ret = opt_to_gvar(key, value, &src)) != 0)
477                         return ret;
478                 cg = select_channel_group(sdi);
479                 if ((ret = maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, cg,
480                                 src.key, src.data)) != SR_OK) {
481                         g_critical("Failed to set device option '%s': %s.",
482                                    (char *)key, sr_strerror(ret));
483                         return ret;
484                 }
485         }
486
487         return SR_OK;
488 }
489
490 void run_session(void)
491 {
492         GSList *devices, *real_devices, *sd;
493         GHashTable *devargs;
494         GVariant *gvar;
495         struct sr_session *session;
496         struct sr_trigger *trigger;
497         struct sr_dev_inst *sdi;
498         uint64_t min_samples, max_samples;
499         gsize n_elements, i;
500         const uint32_t *dev_opts;
501         int is_demo_dev;
502         struct sr_dev_driver *driver;
503         const struct sr_transform *t;
504
505         devices = device_scan();
506         if (!devices) {
507                 g_critical("No devices found.");
508                 return;
509         }
510
511         real_devices = NULL;
512         for (sd = devices; sd; sd = sd->next) {
513                 sdi = sd->data;
514
515                 driver = sr_dev_inst_driver_get(sdi);
516
517                 if (sr_config_list(driver, sdi, NULL, SR_CONF_DEVICE_OPTIONS, &gvar) != SR_OK) {
518                         g_critical("Failed to query list device options.");
519                         return;
520                 }
521
522                 dev_opts = g_variant_get_fixed_array(gvar, &n_elements, sizeof(uint32_t));
523
524                 is_demo_dev = 0;
525                 for (i = 0; i < n_elements; i++) {
526                         if (dev_opts[i] == SR_CONF_DEMO_DEV)
527                                 is_demo_dev = 1;
528                 }
529
530                 g_variant_unref(gvar);
531
532                 if (!is_demo_dev)
533                         real_devices = g_slist_append(real_devices, sdi);
534         }
535
536         if (g_slist_length(devices) > 1) {
537                 if (g_slist_length(real_devices) != 1) {
538                         g_critical("sigrok-cli only supports one device for capturing.");
539                         return;
540                 } else {
541                         /* We only have one non-demo device. */
542                         g_slist_free(devices);
543                         devices = real_devices;
544                         real_devices = NULL;
545                 }
546         }
547
548         sdi = devices->data;
549         g_slist_free(devices);
550         g_slist_free(real_devices);
551
552         sr_session_new(&session);
553         sr_session_datafeed_callback_add(session, datafeed_in, NULL);
554
555         if (sr_dev_open(sdi) != SR_OK) {
556                 g_critical("Failed to open device.");
557                 return;
558         }
559
560         if (sr_session_dev_add(session, sdi) != SR_OK) {
561                 g_critical("Failed to add device to session.");
562                 sr_session_destroy(session);
563                 return;
564         }
565
566         if (opt_config) {
567                 if ((devargs = parse_generic_arg(opt_config, FALSE))) {
568                         if (set_dev_options(sdi, devargs) != SR_OK)
569                                 return;
570                         g_hash_table_destroy(devargs);
571                 }
572         }
573
574         if (select_channels(sdi) != SR_OK) {
575                 g_critical("Failed to set channels.");
576                 sr_session_destroy(session);
577                 return;
578         }
579
580         if (opt_triggers) {
581                 if (!parse_triggerstring(sdi, opt_triggers, &trigger)) {
582                         sr_session_destroy(session);
583                         return;
584                 }
585                 if (sr_session_trigger_set(session, trigger) != SR_OK) {
586                         sr_session_destroy(session);
587                         return;
588                 }
589         }
590
591         if (opt_continuous) {
592                 if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) {
593                         g_critical("This device does not support continuous sampling.");
594                         sr_session_destroy(session);
595                         return;
596                 }
597         }
598
599         if (opt_time) {
600                 if (set_limit_time(sdi) != SR_OK) {
601                         sr_session_destroy(session);
602                         return;
603                 }
604         }
605
606         if (opt_samples) {
607                 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) {
608                         g_critical("Invalid sample limit '%s'.", opt_samples);
609                         sr_session_destroy(session);
610                         return;
611                 }
612                 if (maybe_config_list(driver, sdi, NULL, SR_CONF_LIMIT_SAMPLES,
613                                 &gvar) == SR_OK) {
614                         /* The device has no compression, or compression is turned
615                          * off, and publishes its sample memory size. */
616                         g_variant_get(gvar, "(tt)", &min_samples, &max_samples);
617                         g_variant_unref(gvar);
618                         if (limit_samples < min_samples) {
619                                 g_critical("The device stores at least %"PRIu64
620                                                 " samples with the current settings.", min_samples);
621                         }
622                         if (limit_samples > max_samples) {
623                                 g_critical("The device can store only %"PRIu64
624                                                 " samples with the current settings.", max_samples);
625                         }
626                 }
627                 gvar = g_variant_new_uint64(limit_samples);
628                 if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
629                         g_critical("Failed to configure sample limit.");
630                         sr_session_destroy(session);
631                         return;
632                 }
633         }
634
635         if (opt_frames) {
636                 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) {
637                         g_critical("Invalid sample limit '%s'.", opt_samples);
638                         sr_session_destroy(session);
639                         return;
640                 }
641                 gvar = g_variant_new_uint64(limit_frames);
642                 if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
643                         g_critical("Failed to configure frame limit.");
644                         sr_session_destroy(session);
645                         return;
646                 }
647         }
648
649         if (!(t = setup_transform_module(sdi)))
650                 g_critical("Failed to initialize transform module.");
651
652         if (sr_session_start(session) != SR_OK) {
653                 g_critical("Failed to start session.");
654                 sr_session_destroy(session);
655                 return;
656         }
657
658         if (opt_continuous)
659                 add_anykey(session);
660
661         sr_session_run(session);
662
663         if (opt_continuous)
664                 clear_anykey();
665
666         sr_session_datafeed_callback_remove_all(session);
667         sr_session_destroy(session);
668
669 }
670