2 * This file is part of the sigrok-cli project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
22 #include <glib/gstdio.h>
25 #include "sigrok-cli.h"
27 static uint64_t limit_samples
= 0;
28 static uint64_t limit_frames
= 0;
31 extern struct srd_session
*srd_sess
;
34 static int set_limit_time(const struct sr_dev_inst
*sdi
)
39 struct sr_dev_driver
*driver
;
41 driver
= sr_dev_inst_driver_get(sdi
);
43 if (!(time_msec
= sr_parse_timestring(opt_time
))) {
44 g_critical("Invalid time '%s'", opt_time
);
48 if (sr_dev_config_capabilities_list(sdi
, NULL
, SR_CONF_LIMIT_MSEC
)
50 gvar
= g_variant_new_uint64(time_msec
);
51 if (sr_config_set(sdi
, NULL
, SR_CONF_LIMIT_MSEC
, gvar
) != SR_OK
) {
52 g_critical("Failed to configure time limit.");
55 } else if (sr_dev_config_capabilities_list(sdi
, NULL
, SR_CONF_SAMPLERATE
)
56 & (SR_CONF_GET
| SR_CONF_SET
)) {
57 /* Convert to samples based on the samplerate. */
58 sr_config_get(driver
, sdi
, NULL
, SR_CONF_SAMPLERATE
, &gvar
);
59 samplerate
= g_variant_get_uint64(gvar
);
60 g_variant_unref(gvar
);
61 limit_samples
= (samplerate
) * time_msec
/ (uint64_t)1000;
62 if (limit_samples
== 0) {
63 g_critical("Not enough time at this samplerate.");
66 gvar
= g_variant_new_uint64(limit_samples
);
67 if (sr_config_set(sdi
, NULL
, SR_CONF_LIMIT_SAMPLES
, gvar
) != SR_OK
) {
68 g_critical("Failed to configure time-based sample limit.");
72 g_critical("This device does not support time limits.");
79 const struct sr_output
*setup_output_format(const struct sr_dev_inst
*sdi
, FILE **outfile
)
81 const struct sr_output_module
*omod
;
82 const struct sr_option
**options
;
83 const struct sr_output
*o
;
84 GHashTable
*fmtargs
, *fmtopts
;
87 if (!opt_output_format
) {
88 if (opt_output_file
) {
89 opt_output_format
= DEFAULT_OUTPUT_FORMAT_FILE
;
91 opt_output_format
= DEFAULT_OUTPUT_FORMAT_NOFILE
;
95 fmtargs
= parse_generic_arg(opt_output_format
, TRUE
);
96 fmtspec
= g_hash_table_lookup(fmtargs
, "sigrok_key");
98 g_critical("Invalid output format.");
99 if (!(omod
= sr_output_find(fmtspec
)))
100 g_critical("Unknown output module '%s'.", fmtspec
);
101 g_hash_table_remove(fmtargs
, "sigrok_key");
102 if ((options
= sr_output_options_get(omod
))) {
103 fmtopts
= generic_arg_to_opt(options
, fmtargs
);
104 sr_output_options_free(options
);
107 o
= sr_output_new(omod
, fmtopts
, sdi
, opt_output_file
);
109 if (opt_output_file
) {
110 if (!sr_output_test_flag(omod
, SR_OUTPUT_INTERNAL_IO_HANDLING
))
111 *outfile
= g_fopen(opt_output_file
, "wb");
119 g_hash_table_destroy(fmtopts
);
120 g_hash_table_destroy(fmtargs
);
125 const struct sr_transform
*setup_transform_module(const struct sr_dev_inst
*sdi
)
127 const struct sr_transform_module
*tmod
;
128 const struct sr_option
**options
;
129 const struct sr_transform
*t
;
130 GHashTable
*fmtargs
, *fmtopts
;
133 if (!opt_transform_module
)
134 opt_transform_module
= "nop";
136 fmtargs
= parse_generic_arg(opt_transform_module
, TRUE
);
137 fmtspec
= g_hash_table_lookup(fmtargs
, "sigrok_key");
139 g_critical("Invalid transform module.");
140 if (!(tmod
= sr_transform_find(fmtspec
)))
141 g_critical("Unknown transform module '%s'.", fmtspec
);
142 g_hash_table_remove(fmtargs
, "sigrok_key");
143 if ((options
= sr_transform_options_get(tmod
))) {
144 fmtopts
= generic_arg_to_opt(options
, fmtargs
);
145 sr_transform_options_free(options
);
148 t
= sr_transform_new(tmod
, fmtopts
, sdi
);
150 g_hash_table_destroy(fmtopts
);
151 g_hash_table_destroy(fmtargs
);
156 void datafeed_in(const struct sr_dev_inst
*sdi
,
157 const struct sr_datafeed_packet
*packet
, void *cb_data
)
159 const struct sr_datafeed_meta
*meta
;
160 const struct sr_datafeed_logic
*logic
;
161 const struct sr_datafeed_analog
*analog
;
162 struct sr_session
*session
;
163 struct sr_config
*src
;
164 static const struct sr_output
*o
= NULL
;
165 static const struct sr_output
*oa
= NULL
;
166 static uint64_t rcvd_samples_logic
= 0;
167 static uint64_t rcvd_samples_analog
= 0;
168 static uint64_t samplerate
= 0;
169 static int triggered
= 0;
170 static FILE *outfile
= NULL
;
176 struct sr_dev_driver
*driver
;
178 driver
= sr_dev_inst_driver_get(sdi
);
180 /* If the first packet to come in isn't a header, don't even try. */
181 if (packet
->type
!= SR_DF_HEADER
&& !o
)
185 switch (packet
->type
) {
187 g_debug("cli: Received SR_DF_HEADER.");
188 if (!(o
= setup_output_format(sdi
, &outfile
)))
189 g_critical("Failed to initialize output module.");
191 /* Set up backup analog output module. */
192 oa
= sr_output_new(sr_output_find("analog"), NULL
, sdi
, NULL
);
194 rcvd_samples_logic
= rcvd_samples_analog
= 0;
196 if (maybe_config_get(driver
, sdi
, NULL
, SR_CONF_SAMPLERATE
,
198 samplerate
= g_variant_get_uint64(gvar
);
199 g_variant_unref(gvar
);
205 if (srd_session_metadata_set(srd_sess
, SRD_CONF_SAMPLERATE
,
206 g_variant_new_uint64(samplerate
)) != SRD_OK
) {
207 g_critical("Failed to configure decode session.");
211 if (srd_session_start(srd_sess
) != SRD_OK
) {
212 g_critical("Failed to start decode session.");
220 g_debug("cli: Received SR_DF_META.");
221 meta
= packet
->payload
;
222 for (l
= meta
->config
; l
; l
= l
->next
) {
225 case SR_CONF_SAMPLERATE
:
226 samplerate
= g_variant_get_uint64(src
->data
);
227 g_debug("cli: Got samplerate %"PRIu64
" Hz.", samplerate
);
230 if (srd_session_metadata_set(srd_sess
, SRD_CONF_SAMPLERATE
,
231 g_variant_new_uint64(samplerate
)) != SRD_OK
) {
232 g_critical("Failed to pass samplerate to decoder.");
237 case SR_CONF_SAMPLE_INTERVAL
:
238 samplerate
= g_variant_get_uint64(src
->data
);
239 g_debug("cli: Got sample interval %"PRIu64
" ms.", samplerate
);
242 /* Unknown metadata is not an error. */
249 g_debug("cli: Received SR_DF_TRIGGER.");
254 logic
= packet
->payload
;
255 g_message("cli: Received SR_DF_LOGIC (%"PRIu64
" bytes, unitsize = %d).",
256 logic
->length
, logic
->unitsize
);
257 if (logic
->length
== 0)
260 /* Don't store any samples until triggered. */
261 if (opt_wait_trigger
&& !triggered
)
264 if (limit_samples
&& rcvd_samples_logic
>= limit_samples
)
267 end_sample
= rcvd_samples_logic
+ logic
->length
/ logic
->unitsize
;
268 /* Cut off last packet according to the sample limit. */
269 if (limit_samples
&& end_sample
> limit_samples
)
270 end_sample
= limit_samples
;
271 input_len
= (end_sample
- rcvd_samples_logic
) * logic
->unitsize
;
275 if (srd_session_send(srd_sess
, rcvd_samples_logic
, end_sample
,
276 logic
->data
, input_len
, logic
->unitsize
) != SRD_OK
)
277 sr_session_stop(session
);
281 rcvd_samples_logic
= end_sample
;
285 analog
= packet
->payload
;
286 g_message("cli: Received SR_DF_ANALOG (%d samples).", analog
->num_samples
);
287 if (analog
->num_samples
== 0)
290 if (limit_samples
&& rcvd_samples_analog
>= limit_samples
)
293 rcvd_samples_analog
+= analog
->num_samples
;
296 case SR_DF_FRAME_BEGIN
:
297 g_debug("cli: Received SR_DF_FRAME_BEGIN.");
300 case SR_DF_FRAME_END
:
301 g_debug("cli: Received SR_DF_FRAME_END.");
309 if (sr_output_send(o
, packet
, &out
) == SR_OK
) {
310 if (!out
|| (out
->len
== 0
311 && !opt_output_format
312 && packet
->type
== SR_DF_ANALOG
)) {
314 * The user didn't specify an output module,
315 * but needs to see this analog data.
317 sr_output_send(oa
, packet
, &out
);
319 if (outfile
&& out
&& out
->len
> 0) {
320 fwrite(out
->str
, 1, out
->len
, outfile
);
324 g_string_free(out
, TRUE
);
329 * SR_DF_END needs to be handled after the output module's receive()
330 * is called, so it can properly clean up that module.
332 if (packet
->type
== SR_DF_END
) {
333 g_debug("cli: Received SR_DF_END.");
342 if (outfile
&& outfile
!= stdout
)
346 if (rcvd_samples_logic
> 0 && rcvd_samples_logic
< limit_samples
)
347 g_warning("Device only sent %" PRIu64
" samples.",
349 else if (rcvd_samples_analog
> 0 && rcvd_samples_analog
< limit_samples
)
350 g_warning("Device only sent %" PRIu64
" samples.",
351 rcvd_samples_analog
);
357 int opt_to_gvar(char *key
, char *value
, struct sr_config
*src
)
359 const struct sr_key_info
*srci
, *srmqi
;
360 double tmp_double
, dlow
, dhigh
;
361 uint64_t tmp_u64
, p
, q
, low
, high
, mqflags
;
363 GVariant
*rational
[2], *range
[2], *gtup
[2];
364 GVariantBuilder
*vbl
;
369 if (!(srci
= sr_key_info_name_get(SR_KEY_CONFIG
, key
))) {
370 g_critical("Unknown device option '%s'.", (char *) key
);
373 src
->key
= srci
->key
;
375 if ((!value
|| strlen(value
) == 0) &&
376 (srci
->datatype
!= SR_T_BOOL
)) {
377 g_critical("Option '%s' needs a value.", (char *)key
);
382 switch (srci
->datatype
) {
384 ret
= sr_parse_sizestring(value
, &tmp_u64
);
387 src
->data
= g_variant_new_uint64(tmp_u64
);
390 ret
= sr_parse_sizestring(value
, &tmp_u64
);
393 src
->data
= g_variant_new_int32(tmp_u64
);
396 src
->data
= g_variant_new_string(value
);
402 tmp_bool
= sr_parse_boolstring(value
);
403 src
->data
= g_variant_new_boolean(tmp_bool
);
406 tmp_double
= strtof(value
, NULL
);
407 src
->data
= g_variant_new_double(tmp_double
);
409 case SR_T_RATIONAL_PERIOD
:
410 if ((ret
= sr_parse_period(value
, &p
, &q
)) != SR_OK
)
412 rational
[0] = g_variant_new_uint64(p
);
413 rational
[1] = g_variant_new_uint64(q
);
414 src
->data
= g_variant_new_tuple(rational
, 2);
416 case SR_T_RATIONAL_VOLT
:
417 if ((ret
= sr_parse_voltage(value
, &p
, &q
)) != SR_OK
)
419 rational
[0] = g_variant_new_uint64(p
);
420 rational
[1] = g_variant_new_uint64(q
);
421 src
->data
= g_variant_new_tuple(rational
, 2);
423 case SR_T_UINT64_RANGE
:
424 if (sscanf(value
, "%"PRIu64
"-%"PRIu64
, &low
, &high
) != 2) {
428 range
[0] = g_variant_new_uint64(low
);
429 range
[1] = g_variant_new_uint64(high
);
430 src
->data
= g_variant_new_tuple(range
, 2);
433 case SR_T_DOUBLE_RANGE
:
434 if (sscanf(value
, "%lf-%lf", &dlow
, &dhigh
) != 2) {
438 range
[0] = g_variant_new_double(dlow
);
439 range
[1] = g_variant_new_double(dhigh
);
440 src
->data
= g_variant_new_tuple(range
, 2);
444 /* Expects the argument to be in the form of key=value. */
445 keyval
= g_strsplit(value
, "=", 2);
446 if (!keyval
[0] || !keyval
[1]) {
451 vbl
= g_variant_builder_new(G_VARIANT_TYPE_DICTIONARY
);
452 g_variant_builder_add(vbl
, "{ss}",
453 keyval
[0], keyval
[1]);
454 src
->data
= g_variant_builder_end(vbl
);
460 Argument is MQ id e.g. ("voltage") optionally followed by one
461 or more /<mqflag> e.g. "/ac".
463 keyval
= g_strsplit(value
, "/", 0);
464 if (!keyval
[0] || !(srmqi
= sr_key_info_name_get(SR_KEY_MQ
, keyval
[0]))) {
471 for (i
= 1; keyval
[i
]; i
++) {
472 if (!(srmqi
= sr_key_info_name_get(SR_KEY_MQFLAGS
, keyval
[i
]))) {
476 mqflags
|= srmqi
->key
;
480 gtup
[0] = g_variant_new_uint32(mq
);
481 gtup
[1] = g_variant_new_uint64(mqflags
);
482 src
->data
= g_variant_new_tuple(gtup
, 2);
486 g_critical("Unknown data type specified for option '%s' "
487 "(driver implementation bug?).", key
);
492 g_critical("Invalid value: '%s' for option '%s'", value
, key
);
497 int set_dev_options(struct sr_dev_inst
*sdi
, GHashTable
*args
)
499 struct sr_config src
;
500 struct sr_channel_group
*cg
;
505 g_hash_table_iter_init(&iter
, args
);
506 while (g_hash_table_iter_next(&iter
, &key
, &value
)) {
507 if ((ret
= opt_to_gvar(key
, value
, &src
)) != 0)
509 cg
= select_channel_group(sdi
);
510 if ((ret
= maybe_config_set(sr_dev_inst_driver_get(sdi
), sdi
, cg
,
511 src
.key
, src
.data
)) != SR_OK
) {
512 g_critical("Failed to set device option '%s': %s.",
513 (char *)key
, sr_strerror(ret
));
521 void run_session(void)
523 GSList
*devices
, *real_devices
, *sd
;
526 struct sr_session
*session
;
527 struct sr_trigger
*trigger
;
528 struct sr_dev_inst
*sdi
;
529 uint64_t min_samples
, max_samples
;
533 struct sr_dev_driver
*driver
;
534 const struct sr_transform
*t
;
535 GMainLoop
*main_loop
;
537 devices
= device_scan();
539 g_critical("No devices found.");
544 for (sd
= devices
; sd
; sd
= sd
->next
) {
547 driver
= sr_dev_inst_driver_get(sdi
);
549 if (!(dev_opts
= sr_dev_options(driver
, sdi
, NULL
))) {
550 g_critical("Failed to query list device options.");
555 for (i
= 0; i
< dev_opts
->len
; i
++) {
556 if (g_array_index(dev_opts
, uint32_t, i
) == SR_CONF_DEMO_DEV
)
560 g_array_free(dev_opts
, TRUE
);
563 real_devices
= g_slist_append(real_devices
, sdi
);
566 if (g_slist_length(devices
) > 1) {
567 if (g_slist_length(real_devices
) != 1) {
568 g_critical("sigrok-cli only supports one device for capturing.");
571 /* We only have one non-demo device. */
572 g_slist_free(devices
);
573 devices
= real_devices
;
579 g_slist_free(devices
);
580 g_slist_free(real_devices
);
582 sr_session_new(sr_ctx
, &session
);
583 sr_session_datafeed_callback_add(session
, datafeed_in
, NULL
);
585 if (sr_dev_open(sdi
) != SR_OK
) {
586 g_critical("Failed to open device.");
590 if (sr_session_dev_add(session
, sdi
) != SR_OK
) {
591 g_critical("Failed to add device to session.");
592 sr_session_destroy(session
);
597 if ((devargs
= parse_generic_arg(opt_config
, FALSE
))) {
598 if (set_dev_options(sdi
, devargs
) != SR_OK
)
600 g_hash_table_destroy(devargs
);
604 if (select_channels(sdi
) != SR_OK
) {
605 g_critical("Failed to set channels.");
606 sr_session_destroy(session
);
612 if (!parse_triggerstring(sdi
, opt_triggers
, &trigger
)) {
613 sr_session_destroy(session
);
616 if (sr_session_trigger_set(session
, trigger
) != SR_OK
) {
617 sr_session_destroy(session
);
622 if (opt_continuous
) {
623 if (!sr_dev_has_option(sdi
, SR_CONF_CONTINUOUS
)) {
624 g_critical("This device does not support continuous sampling.");
625 sr_session_destroy(session
);
631 if (set_limit_time(sdi
) != SR_OK
) {
632 sr_session_destroy(session
);
638 if ((sr_parse_sizestring(opt_samples
, &limit_samples
) != SR_OK
)) {
639 g_critical("Invalid sample limit '%s'.", opt_samples
);
640 sr_session_destroy(session
);
643 if (maybe_config_list(driver
, sdi
, NULL
, SR_CONF_LIMIT_SAMPLES
,
646 * The device has no compression, or compression is turned
647 * off, and publishes its sample memory size.
649 g_variant_get(gvar
, "(tt)", &min_samples
, &max_samples
);
650 g_variant_unref(gvar
);
651 if (limit_samples
< min_samples
) {
652 g_critical("The device stores at least %"PRIu64
653 " samples with the current settings.", min_samples
);
655 if (limit_samples
> max_samples
) {
656 g_critical("The device can store only %"PRIu64
657 " samples with the current settings.", max_samples
);
660 gvar
= g_variant_new_uint64(limit_samples
);
661 if (maybe_config_set(sr_dev_inst_driver_get(sdi
), sdi
, NULL
, SR_CONF_LIMIT_SAMPLES
, gvar
) != SR_OK
) {
662 g_critical("Failed to configure sample limit.");
663 sr_session_destroy(session
);
669 if ((sr_parse_sizestring(opt_frames
, &limit_frames
) != SR_OK
)) {
670 g_critical("Invalid sample limit '%s'.", opt_samples
);
671 sr_session_destroy(session
);
674 gvar
= g_variant_new_uint64(limit_frames
);
675 if (maybe_config_set(sr_dev_inst_driver_get(sdi
), sdi
, NULL
, SR_CONF_LIMIT_FRAMES
, gvar
) != SR_OK
) {
676 g_critical("Failed to configure frame limit.");
677 sr_session_destroy(session
);
682 if (!(t
= setup_transform_module(sdi
)))
683 g_critical("Failed to initialize transform module.");
685 main_loop
= g_main_loop_new(NULL
, FALSE
);
687 sr_session_stopped_callback_set(session
,
688 (sr_session_stopped_callback
)g_main_loop_quit
, main_loop
);
690 if (sr_session_start(session
) != SR_OK
) {
691 g_critical("Failed to start session.");
692 g_main_loop_unref(main_loop
);
693 sr_session_destroy(session
);
700 g_main_loop_run(main_loop
);
706 sr_trigger_free(trigger
);
708 sr_session_datafeed_callback_remove_all(session
);
709 g_main_loop_unref(main_loop
);
710 sr_session_destroy(session
);