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/>.
20 #include "sigrok-cli.h"
23 #include <glib/gstdio.h>
27 static struct sr_output_format *output_format = NULL;
28 static int default_output_format = FALSE;
29 static char *output_format_param = NULL;
30 static GByteArray *savebuf;
31 static uint64_t limit_samples = 0;
32 static uint64_t limit_frames = 0;
34 extern gchar *opt_output_file;
35 extern gchar *opt_output_format;
36 extern gchar *opt_pds;
37 extern gboolean opt_wait_trigger;
38 extern gchar *opt_time;
39 extern gchar *opt_samples;
40 extern gchar *opt_frames;
41 extern gchar *opt_continuous;
42 extern gchar *opt_config;
43 extern gchar *opt_triggers;
45 extern struct srd_session *srd_sess;
49 static GArray *get_enabled_logic_probes(const struct sr_dev_inst *sdi)
51 struct sr_probe *probe;
55 probes = g_array_new(FALSE, FALSE, sizeof(int));
56 for (l = sdi->probes; l; l = l->next) {
58 if (probe->type != SR_PROBE_LOGIC)
60 if (probe->enabled != TRUE)
62 g_array_append_val(probes, probe->index);
68 static int set_limit_time(const struct sr_dev_inst *sdi)
74 if (!(time_msec = sr_parse_timestring(opt_time))) {
75 g_critical("Invalid time '%s'", opt_time);
79 if (sr_dev_has_option(sdi, SR_CONF_LIMIT_MSEC)) {
80 gvar = g_variant_new_uint64(time_msec);
81 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) {
82 g_critical("Failed to configure time limit.");
85 } else if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
86 /* Convert to samples based on the samplerate. */
87 sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar);
88 samplerate = g_variant_get_uint64(gvar);
89 g_variant_unref(gvar);
90 limit_samples = (samplerate) * time_msec / (uint64_t)1000;
91 if (limit_samples == 0) {
92 g_critical("Not enough time at this samplerate.");
95 gvar = g_variant_new_uint64(limit_samples);
96 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
97 g_critical("Failed to configure time-based sample limit.");
101 g_critical("This device does not support time limits.");
108 int setup_output_format(void)
113 struct sr_output_format **outputs;
117 if (opt_output_format && !strcmp(opt_output_format, "sigrok")) {
118 /* Doesn't really exist as an output module - this is
119 * the session save mode. */
120 g_free(opt_output_format);
121 opt_output_format = NULL;
124 if (!opt_output_format) {
125 opt_output_format = DEFAULT_OUTPUT_FORMAT;
126 /* we'll need to remember this so when saving to a file
127 * later, sigrok session format will be used.
129 default_output_format = TRUE;
132 fmtargs = parse_generic_arg(opt_output_format, TRUE);
133 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
135 g_critical("Invalid output format.");
138 outputs = sr_output_list();
139 for (i = 0; outputs[i]; i++) {
140 if (strcmp(outputs[i]->id, fmtspec))
142 g_hash_table_remove(fmtargs, "sigrok_key");
143 output_format = outputs[i];
144 g_hash_table_iter_init(&iter, fmtargs);
145 while (g_hash_table_iter_next(&iter, &key, &value)) {
146 /* only supporting one parameter per output module
147 * for now, and only its value */
148 output_format_param = g_strdup(value);
153 if (!output_format) {
154 g_critical("Invalid output format %s.", opt_output_format);
157 g_hash_table_destroy(fmtargs);
162 void datafeed_in(const struct sr_dev_inst *sdi,
163 const struct sr_datafeed_packet *packet, void *cb_data)
165 const struct sr_datafeed_meta *meta;
166 const struct sr_datafeed_logic *logic;
167 const struct sr_datafeed_analog *analog;
168 struct sr_config *src;
169 static struct sr_output *o = NULL;
170 static GArray *logic_probelist = NULL;
171 static uint64_t received_samples = 0;
172 static int unitsize = 0;
173 static int triggered = 0;
174 static FILE *outfile = NULL;
177 int sample_size, ret;
178 uint64_t samplerate, output_len, filter_out_len;
182 uint8_t *output_buf, *filter_out;
186 /* If the first packet to come in isn't a header, don't even try. */
187 if (packet->type != SR_DF_HEADER && o == NULL)
191 switch (packet->type) {
193 g_debug("cli: Received SR_DF_HEADER");
194 /* Initialize the output module. */
195 if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
196 g_critical("Output module malloc failed.");
199 o->format = output_format;
200 o->sdi = (struct sr_dev_inst *)sdi;
201 o->param = output_format_param;
202 if (o->format->init) {
203 if (o->format->init(o) != SR_OK) {
204 g_critical("Output format initialization failed.");
209 /* Prepare non-stdout output. */
211 if (opt_output_file) {
212 if (default_output_format) {
213 /* output file is in session format, so we'll
214 * keep a copy of everything as it comes in
215 * and save from there after the session. */
217 savebuf = g_byte_array_new();
219 /* saving to a file in whatever format was set
220 * with --format, so all we need is a filehandle */
221 outfile = g_fopen(opt_output_file, "wb");
225 /* Prepare for logic data. */
226 logic_probelist = get_enabled_logic_probes(sdi);
227 /* How many bytes we need to store the packed samples. */
228 unitsize = (logic_probelist->len + 7) / 8;
232 if (opt_pds && logic_probelist->len) {
233 if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE,
235 samplerate = g_variant_get_uint64(gvar);
236 g_variant_unref(gvar);
237 if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
238 g_variant_new_uint64(samplerate)) != SRD_OK) {
239 g_critical("Failed to configure decode session.");
243 if (srd_session_start(srd_sess) != SRD_OK) {
244 g_critical("Failed to start decode session.");
252 g_debug("cli: received SR_DF_META");
253 meta = packet->payload;
254 for (l = meta->config; l; l = l->next) {
257 case SR_CONF_SAMPLERATE:
258 samplerate = g_variant_get_uint64(src->data);
259 g_debug("cli: got samplerate %"PRIu64" Hz", samplerate);
262 if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
263 g_variant_new_uint64(samplerate)) != SRD_OK) {
264 g_critical("Failed to pass samplerate to decoder.");
269 case SR_CONF_SAMPLE_INTERVAL:
270 samplerate = g_variant_get_uint64(src->data);
271 g_debug("cli: got sample interval %"PRIu64" ms", samplerate);
274 /* Unknown metadata is not an error. */
281 g_debug("cli: received SR_DF_TRIGGER");
282 if (o->format->event)
283 o->format->event(o, SR_DF_TRIGGER, &output_buf,
289 logic = packet->payload;
290 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
291 sample_size = logic->unitsize;
292 if (logic->length == 0)
295 /* Don't store any samples until triggered. */
296 if (opt_wait_trigger && !triggered)
299 if (limit_samples && received_samples >= limit_samples)
302 ret = sr_filter_probes(sample_size, unitsize, logic_probelist,
303 logic->data, logic->length,
304 &filter_out, &filter_out_len);
309 * What comes out of the filter is guaranteed to be packed into the
310 * minimum size needed to support the number of samples at this sample
311 * size. however, the driver may have submitted too much. Cut off
312 * the buffer of the last packet according to the sample limit.
314 if (limit_samples && (received_samples + logic->length / sample_size >
315 limit_samples * sample_size))
316 filter_out_len = limit_samples * sample_size - received_samples;
318 if (opt_output_file && default_output_format) {
319 /* Saving to a session file. */
320 g_byte_array_append(savebuf, filter_out, filter_out_len);
324 end_sample = received_samples + filter_out_len / unitsize;
325 if (srd_session_send(srd_sess, received_samples, end_sample,
326 (uint8_t*)filter_out, filter_out_len) != SRD_OK)
331 if (o->format->data && packet->type == o->format->df_type)
332 o->format->data(o, filter_out, filter_out_len,
333 &output_buf, &output_len);
335 fwrite(output_buf, 1, output_len, outfile);
343 received_samples += logic->length / sample_size;
347 analog = packet->payload;
348 g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples);
349 if (analog->num_samples == 0)
352 if (limit_samples && received_samples >= limit_samples)
355 if (o->format->data && packet->type == o->format->df_type) {
356 o->format->data(o, (const uint8_t *)analog->data,
357 analog->num_samples * sizeof(float),
358 &output_buf, &output_len);
360 fwrite(output_buf, 1, output_len, outfile);
366 received_samples += analog->num_samples;
369 case SR_DF_FRAME_BEGIN:
370 g_debug("cli: received SR_DF_FRAME_BEGIN");
371 if (o->format->event) {
372 o->format->event(o, SR_DF_FRAME_BEGIN, &output_buf,
375 fwrite(output_buf, 1, output_len, outfile);
382 case SR_DF_FRAME_END:
383 g_debug("cli: received SR_DF_FRAME_END");
384 if (o->format->event) {
385 o->format->event(o, SR_DF_FRAME_END, &output_buf,
388 fwrite(output_buf, 1, output_len, outfile);
399 if (o && o->format->receive) {
400 if (o->format->receive(o, sdi, packet, &out) == SR_OK && out) {
401 fwrite(out->str, 1, out->len, outfile);
403 g_string_free(out, TRUE);
407 /* SR_DF_END needs to be handled after the output module's receive()
408 * is called, so it can properly clean up that module etc. */
409 if (packet->type == SR_DF_END) {
410 g_debug("cli: Received SR_DF_END");
412 if (o->format->event) {
413 o->format->event(o, SR_DF_END, &output_buf, &output_len);
416 fwrite(output_buf, 1, output_len, outfile);
422 if (limit_samples && received_samples < limit_samples)
423 g_warning("Device only sent %" PRIu64 " samples.",
427 g_warning("Device stopped after %" PRIu64 " samples.",
430 g_array_free(logic_probelist, TRUE);
432 if (o->format->cleanup)
433 o->format->cleanup(o);
437 if (outfile && outfile != stdout)
440 if (opt_output_file && default_output_format && savebuf->len) {
441 if (sr_session_save(opt_output_file, sdi, savebuf->data,
442 unitsize, savebuf->len / unitsize) != SR_OK)
443 g_critical("Failed to save session.");
444 g_byte_array_free(savebuf, TRUE);
450 int opt_to_gvar(char *key, char *value, struct sr_config *src)
452 const struct sr_config_info *srci;
454 uint64_t tmp_u64, p, q, low, high;
455 GVariant *rational[2], *range[2];
459 if (!(srci = sr_config_info_name_get(key))) {
460 g_critical("Unknown device option '%s'.", (char *) key);
463 src->key = srci->key;
465 if ((value == NULL) &&
466 (srci->datatype != SR_T_BOOL)) {
467 g_critical("Option '%s' needs a value.", (char *)key);
472 switch (srci->datatype) {
474 ret = sr_parse_sizestring(value, &tmp_u64);
477 src->data = g_variant_new_uint64(tmp_u64);
480 ret = sr_parse_sizestring(value, &tmp_u64);
483 src->data = g_variant_new_int32(tmp_u64);
486 src->data = g_variant_new_string(value);
492 tmp_bool = sr_parse_boolstring(value);
493 src->data = g_variant_new_boolean(tmp_bool);
496 tmp_double = strtof(value, NULL);
497 src->data = g_variant_new_double(tmp_double);
499 case SR_T_RATIONAL_PERIOD:
500 if ((ret = sr_parse_period(value, &p, &q)) != SR_OK)
502 rational[0] = g_variant_new_uint64(p);
503 rational[1] = g_variant_new_uint64(q);
504 src->data = g_variant_new_tuple(rational, 2);
506 case SR_T_RATIONAL_VOLT:
507 if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK)
509 rational[0] = g_variant_new_uint64(p);
510 rational[1] = g_variant_new_uint64(q);
511 src->data = g_variant_new_tuple(rational, 2);
513 case SR_T_UINT64_RANGE:
514 if (sscanf(value, "%"PRIu64"-%"PRIu64, &low, &high) != 2) {
518 range[0] = g_variant_new_uint64(low);
519 range[1] = g_variant_new_uint64(high);
520 src->data = g_variant_new_tuple(range, 2);
530 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
532 struct sr_config src;
533 struct sr_probe_group *pg;
538 g_hash_table_iter_init(&iter, args);
539 while (g_hash_table_iter_next(&iter, &key, &value)) {
540 if ((ret = opt_to_gvar(key, value, &src)) != 0)
542 pg = select_probe_group(sdi);
543 ret = sr_config_set(sdi, pg, src.key, src.data);
545 g_critical("Failed to set device option '%s'.", (char *)key);
553 void run_session(void)
558 struct sr_dev_inst *sdi;
559 uint64_t min_samples, max_samples;
563 devices = device_scan();
565 g_critical("No devices found.");
568 if (g_slist_length(devices) > 1) {
569 g_critical("sigrok-cli only supports one device for capturing.");
575 sr_session_datafeed_callback_add(datafeed_in, NULL);
577 if (sr_dev_open(sdi) != SR_OK) {
578 g_critical("Failed to open device.");
582 if (sr_session_dev_add(sdi) != SR_OK) {
583 g_critical("Failed to add device to session.");
584 sr_session_destroy();
589 if ((devargs = parse_generic_arg(opt_config, FALSE))) {
590 if (set_dev_options(sdi, devargs) != SR_OK)
592 g_hash_table_destroy(devargs);
596 if (select_probes(sdi) != SR_OK) {
597 g_critical("Failed to set probes.");
598 sr_session_destroy();
603 if (!(triggerlist = sr_parse_triggerstring(sdi, opt_triggers))) {
604 sr_session_destroy();
607 max_probes = g_slist_length(sdi->probes);
608 for (i = 0; i < max_probes; i++) {
609 if (triggerlist[i]) {
610 sr_dev_trigger_set(sdi, i, triggerlist[i]);
611 g_free(triggerlist[i]);
617 if (opt_continuous) {
618 if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) {
619 g_critical("This device does not support continuous sampling.");
620 sr_session_destroy();
626 if (set_limit_time(sdi) != SR_OK) {
627 sr_session_destroy();
633 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) {
634 g_critical("Invalid sample limit '%s'.", opt_samples);
635 sr_session_destroy();
638 if (sr_config_list(sdi->driver, sdi, NULL,
639 SR_CONF_LIMIT_SAMPLES, &gvar) == SR_OK) {
640 /* The device has no compression, or compression is turned
641 * off, and publishes its sample memory size. */
642 g_variant_get(gvar, "(tt)", &min_samples, &max_samples);
643 g_variant_unref(gvar);
644 if (limit_samples < min_samples) {
645 g_critical("The device stores at least %"PRIu64
646 " samples with the current settings.", min_samples);
648 if (limit_samples > max_samples) {
649 g_critical("The device can store only %"PRIu64
650 " samples with the current settings.", max_samples);
653 gvar = g_variant_new_uint64(limit_samples);
654 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
655 g_critical("Failed to configure sample limit.");
656 sr_session_destroy();
662 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) {
663 g_critical("Invalid sample limit '%s'.", opt_samples);
664 sr_session_destroy();
667 gvar = g_variant_new_uint64(limit_frames);
668 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
669 g_critical("Failed to configure frame limit.");
670 sr_session_destroy();
675 if (sr_session_start() != SR_OK) {
676 g_critical("Failed to start session.");
677 sr_session_destroy();
689 sr_session_datafeed_callback_remove_all();
690 sr_session_destroy();
691 g_slist_free(devices);