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"
22 #include <glib/gstdio.h>
26 static struct sr_output_format *output_format = NULL;
27 static int default_output_format = FALSE;
28 static uint64_t limit_samples = 0;
29 static uint64_t limit_frames = 0;
31 extern gchar *opt_output_file;
32 extern gchar *opt_output_format;
33 extern gchar *opt_pds;
34 extern gboolean opt_wait_trigger;
35 extern gchar *opt_time;
36 extern gchar *opt_samples;
37 extern gchar *opt_frames;
38 extern gchar *opt_continuous;
39 extern gchar *opt_config;
40 extern gchar *opt_triggers;
42 extern struct srd_session *srd_sess;
45 static int set_limit_time(const struct sr_dev_inst *sdi)
51 if (!(time_msec = sr_parse_timestring(opt_time))) {
52 g_critical("Invalid time '%s'", opt_time);
56 if (sr_dev_has_option(sdi, SR_CONF_LIMIT_MSEC)) {
57 gvar = g_variant_new_uint64(time_msec);
58 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) {
59 g_critical("Failed to configure time limit.");
62 } else if (sr_dev_has_option(sdi, SR_CONF_SAMPLERATE)) {
63 /* Convert to samples based on the samplerate. */
64 sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar);
65 samplerate = g_variant_get_uint64(gvar);
66 g_variant_unref(gvar);
67 limit_samples = (samplerate) * time_msec / (uint64_t)1000;
68 if (limit_samples == 0) {
69 g_critical("Not enough time at this samplerate.");
72 gvar = g_variant_new_uint64(limit_samples);
73 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
74 g_critical("Failed to configure time-based sample limit.");
78 g_critical("This device does not support time limits.");
85 struct sr_output *setup_output_format(const struct sr_dev_inst *sdi)
89 struct sr_output_format **outputs;
93 if (opt_output_format && !strcmp(opt_output_format, "sigrok")) {
94 /* Doesn't really exist as an output module - this is
95 * the session save mode. */
96 g_free(opt_output_format);
97 opt_output_format = NULL;
100 if (!opt_output_format) {
101 opt_output_format = DEFAULT_OUTPUT_FORMAT;
102 /* we'll need to remember this so when saving to a file
103 * later, sigrok session format will be used.
105 default_output_format = TRUE;
108 fmtargs = parse_generic_arg(opt_output_format, TRUE);
109 fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
111 g_critical("Invalid output format.");
112 outputs = sr_output_list();
113 for (i = 0; outputs[i]; i++) {
114 if (strcmp(outputs[i]->id, fmtspec))
116 g_hash_table_remove(fmtargs, "sigrok_key");
117 output_format = outputs[i];
121 g_critical("Invalid output format '%s'.", opt_output_format);
122 o = sr_output_new(output_format, fmtargs, sdi);
123 g_hash_table_destroy(fmtargs);
128 void datafeed_in(const struct sr_dev_inst *sdi,
129 const struct sr_datafeed_packet *packet, void *cb_data)
131 const struct sr_datafeed_meta *meta;
132 const struct sr_datafeed_logic *logic;
133 const struct sr_datafeed_analog *analog;
134 struct sr_config *src;
135 struct sr_channel *ch;
136 static struct sr_output *o = NULL;
137 static uint64_t rcvd_samples_logic = 0;
138 static uint64_t rcvd_samples_analog = 0;
139 static uint64_t samplerate = 0;
140 static int triggered = 0;
141 static FILE *outfile = NULL;
152 /* If the first packet to come in isn't a header, don't even try. */
153 if (packet->type != SR_DF_HEADER && o == NULL)
156 switch (packet->type) {
158 g_debug("cli: Received SR_DF_HEADER");
159 o = setup_output_format(sdi);
161 /* Prepare non-stdout output. */
163 if (opt_output_file) {
164 if (default_output_format) {
167 /* saving to a file in whatever format was set
168 * with --format, so all we need is a filehandle */
169 outfile = g_fopen(opt_output_file, "wb");
172 rcvd_samples_logic = rcvd_samples_analog = 0;
174 if (sr_config_get(sdi->driver, sdi, NULL, SR_CONF_SAMPLERATE,
176 samplerate = g_variant_get_uint64(gvar);
177 g_variant_unref(gvar);
183 if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
184 g_variant_new_uint64(samplerate)) != SRD_OK) {
185 g_critical("Failed to configure decode session.");
189 if (srd_session_start(srd_sess) != SRD_OK) {
190 g_critical("Failed to start decode session.");
198 g_debug("cli: received SR_DF_META");
199 meta = packet->payload;
200 for (l = meta->config; l; l = l->next) {
203 case SR_CONF_SAMPLERATE:
204 samplerate = g_variant_get_uint64(src->data);
205 g_debug("cli: got samplerate %"PRIu64" Hz", samplerate);
208 if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
209 g_variant_new_uint64(samplerate)) != SRD_OK) {
210 g_critical("Failed to pass samplerate to decoder.");
215 case SR_CONF_SAMPLE_INTERVAL:
216 samplerate = g_variant_get_uint64(src->data);
217 g_debug("cli: got sample interval %"PRIu64" ms", samplerate);
220 /* Unknown metadata is not an error. */
227 g_debug("cli: received SR_DF_TRIGGER");
232 logic = packet->payload;
233 g_message("cli: received SR_DF_LOGIC, %"PRIu64" bytes", logic->length);
234 if (logic->length == 0)
237 /* Don't store any samples until triggered. */
238 if (opt_wait_trigger && !triggered)
241 if (limit_samples && rcvd_samples_logic >= limit_samples)
244 end_sample = rcvd_samples_logic + logic->length / logic->unitsize;
245 /* Cut off last packet according to the sample limit. */
246 if (limit_samples && end_sample > limit_samples)
247 end_sample = limit_samples;
248 input_len = (end_sample - rcvd_samples_logic) * logic->unitsize;
250 if (opt_output_file && default_output_format) {
251 /* Saving to a session file. */
252 if (rcvd_samples_logic == 0) {
253 /* First packet with logic data, init session file. */
254 channels = g_malloc(sizeof(char *) * g_slist_length(sdi->channels));
255 for (i = 0, l = sdi->channels; l; l = l->next) {
257 if (ch->enabled && ch->type == SR_CHANNEL_LOGIC)
258 channels[i++] = ch->name;
261 sr_session_save_init(opt_output_file, samplerate,
265 save_chunk_logic(logic->data, input_len, logic->unitsize);
269 if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample,
270 logic->data, input_len) != SRD_OK)
276 rcvd_samples_logic = end_sample;
280 analog = packet->payload;
281 g_message("cli: received SR_DF_ANALOG, %d samples", analog->num_samples);
282 if (analog->num_samples == 0)
285 if (limit_samples && rcvd_samples_analog >= limit_samples)
288 rcvd_samples_analog += analog->num_samples;
291 case SR_DF_FRAME_BEGIN:
292 g_debug("cli: received SR_DF_FRAME_BEGIN");
295 case SR_DF_FRAME_END:
296 g_debug("cli: received SR_DF_FRAME_END");
304 if (sr_output_send(o, packet, &out) == SR_OK && out) {
305 fwrite(out->str, 1, out->len, outfile);
307 g_string_free(out, TRUE);
311 /* SR_DF_END needs to be handled after the output module's receive()
312 * is called, so it can properly clean up that module. */
313 if (packet->type == SR_DF_END) {
314 g_debug("cli: Received SR_DF_END");
320 if (outfile && outfile != stdout)
323 if (opt_output_file && default_output_format)
324 /* Flush whatever is left out to the session file. */
325 save_chunk_logic(NULL, 0, 0);
328 if (rcvd_samples_logic > 0 && rcvd_samples_logic < limit_samples)
329 g_warning("Device only sent %" PRIu64 " samples.",
331 else if (rcvd_samples_analog > 0 && rcvd_samples_analog < limit_samples)
332 g_warning("Device only sent %" PRIu64 " samples.",
333 rcvd_samples_analog);
339 int opt_to_gvar(char *key, char *value, struct sr_config *src)
341 const struct sr_config_info *srci;
342 double tmp_double, dlow, dhigh;
343 uint64_t tmp_u64, p, q, low, high;
344 GVariant *rational[2], *range[2];
348 if (!(srci = sr_config_info_name_get(key))) {
349 g_critical("Unknown device option '%s'.", (char *) key);
352 src->key = srci->key;
354 if ((value == NULL) &&
355 (srci->datatype != SR_T_BOOL)) {
356 g_critical("Option '%s' needs a value.", (char *)key);
361 switch (srci->datatype) {
363 ret = sr_parse_sizestring(value, &tmp_u64);
366 src->data = g_variant_new_uint64(tmp_u64);
369 ret = sr_parse_sizestring(value, &tmp_u64);
372 src->data = g_variant_new_int32(tmp_u64);
375 src->data = g_variant_new_string(value);
381 tmp_bool = sr_parse_boolstring(value);
382 src->data = g_variant_new_boolean(tmp_bool);
385 tmp_double = strtof(value, NULL);
386 src->data = g_variant_new_double(tmp_double);
388 case SR_T_RATIONAL_PERIOD:
389 if ((ret = sr_parse_period(value, &p, &q)) != SR_OK)
391 rational[0] = g_variant_new_uint64(p);
392 rational[1] = g_variant_new_uint64(q);
393 src->data = g_variant_new_tuple(rational, 2);
395 case SR_T_RATIONAL_VOLT:
396 if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK)
398 rational[0] = g_variant_new_uint64(p);
399 rational[1] = g_variant_new_uint64(q);
400 src->data = g_variant_new_tuple(rational, 2);
402 case SR_T_UINT64_RANGE:
403 if (sscanf(value, "%"PRIu64"-%"PRIu64, &low, &high) != 2) {
407 range[0] = g_variant_new_uint64(low);
408 range[1] = g_variant_new_uint64(high);
409 src->data = g_variant_new_tuple(range, 2);
412 case SR_T_DOUBLE_RANGE:
413 if (sscanf(value, "%lf-%lf", &dlow, &dhigh) != 2) {
417 range[0] = g_variant_new_double(dlow);
418 range[1] = g_variant_new_double(dhigh);
419 src->data = g_variant_new_tuple(range, 2);
429 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
431 struct sr_config src;
432 struct sr_channel_group *cg;
437 g_hash_table_iter_init(&iter, args);
438 while (g_hash_table_iter_next(&iter, &key, &value)) {
439 if ((ret = opt_to_gvar(key, value, &src)) != 0)
441 cg = select_channel_group(sdi);
442 ret = sr_config_set(sdi, cg, src.key, src.data);
444 g_critical("Failed to set device option '%s'.", (char *)key);
452 void run_session(void)
457 struct sr_dev_inst *sdi;
458 uint64_t min_samples, max_samples;
462 devices = device_scan();
464 g_critical("No devices found.");
467 if (g_slist_length(devices) > 1) {
468 g_critical("sigrok-cli only supports one device for capturing.");
474 sr_session_datafeed_callback_add(datafeed_in, NULL);
476 if (sr_dev_open(sdi) != SR_OK) {
477 g_critical("Failed to open device.");
481 if (sr_session_dev_add(sdi) != SR_OK) {
482 g_critical("Failed to add device to session.");
483 sr_session_destroy();
488 if ((devargs = parse_generic_arg(opt_config, FALSE))) {
489 if (set_dev_options(sdi, devargs) != SR_OK)
491 g_hash_table_destroy(devargs);
495 if (select_channels(sdi) != SR_OK) {
496 g_critical("Failed to set channels.");
497 sr_session_destroy();
502 if (!(triggerlist = sr_parse_triggerstring(sdi, opt_triggers))) {
503 sr_session_destroy();
506 max_channels = g_slist_length(sdi->channels);
507 for (i = 0; i < max_channels; i++) {
508 if (triggerlist[i]) {
509 sr_dev_trigger_set(sdi, i, triggerlist[i]);
510 g_free(triggerlist[i]);
516 if (opt_continuous) {
517 if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) {
518 g_critical("This device does not support continuous sampling.");
519 sr_session_destroy();
525 if (set_limit_time(sdi) != SR_OK) {
526 sr_session_destroy();
532 if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) {
533 g_critical("Invalid sample limit '%s'.", opt_samples);
534 sr_session_destroy();
537 if (sr_config_list(sdi->driver, sdi, NULL,
538 SR_CONF_LIMIT_SAMPLES, &gvar) == SR_OK) {
539 /* The device has no compression, or compression is turned
540 * off, and publishes its sample memory size. */
541 g_variant_get(gvar, "(tt)", &min_samples, &max_samples);
542 g_variant_unref(gvar);
543 if (limit_samples < min_samples) {
544 g_critical("The device stores at least %"PRIu64
545 " samples with the current settings.", min_samples);
547 if (limit_samples > max_samples) {
548 g_critical("The device can store only %"PRIu64
549 " samples with the current settings.", max_samples);
552 gvar = g_variant_new_uint64(limit_samples);
553 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
554 g_critical("Failed to configure sample limit.");
555 sr_session_destroy();
561 if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) {
562 g_critical("Invalid sample limit '%s'.", opt_samples);
563 sr_session_destroy();
566 gvar = g_variant_new_uint64(limit_frames);
567 if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
568 g_critical("Failed to configure frame limit.");
569 sr_session_destroy();
574 if (sr_session_start() != SR_OK) {
575 g_critical("Failed to start session.");
576 sr_session_destroy();
588 sr_session_datafeed_callback_remove_all();
589 sr_session_destroy();
590 g_slist_free(devices);
594 void save_chunk_logic(uint8_t *data, uint64_t data_len, int unitsize)
596 static uint8_t *buf = NULL;
597 static int buf_len = 0;
598 static int last_unitsize = 0;
602 buf = g_malloc(SAVE_CHUNK_SIZE);
604 if (buf_len + data_len > SAVE_CHUNK_SIZE) {
605 max = (SAVE_CHUNK_SIZE - buf_len) / unitsize * unitsize;
606 memcpy(buf + buf_len, data, max);
607 sr_session_append(opt_output_file, buf, unitsize,
608 (buf_len + max) / unitsize);
609 memcpy(buf, data + max, data_len - max);
610 buf_len = data_len - max;
611 } else if (data_len == 0 && last_unitsize != 0) {
612 /* End of data, flush the buffer out. */
613 sr_session_append(opt_output_file, buf, last_unitsize,
614 buf_len / last_unitsize);
617 memcpy(buf + buf_len, data, data_len);
620 last_unitsize = unitsize;