session.c - chromiumos/third_party/libsigrok-cli - Git at Google

 /*
  * This file is part of the sigrok-cli project.
  *
  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */

 #include <config.h>
 #include <glib.h>
 #include <glib/gstdio.h>
 #include <string.h>
 #include <stdlib.h>
 #include "sigrok-cli.h"

 static uint64_t limit_samples = 0;
 static uint64_t limit_frames = 0;

 #ifdef HAVE_SRD
 extern struct srd_session *srd_sess;
 #endif

 static int set_limit_time(const struct sr_dev_inst *sdi)
 {
 	GVariant *gvar;
 	uint64_t time_msec;
 	uint64_t samplerate;
 	struct sr_dev_driver *driver;

 	driver = sr_dev_inst_driver_get(sdi);

 	if (!(time_msec = sr_parse_timestring(opt_time))) {
 		g_critical("Invalid time '%s'", opt_time);
 		return SR_ERR;
 	}

 	if (sr_dev_config_capabilities_list(sdi, NULL, SR_CONF_LIMIT_MSEC)
 			& SR_CONF_SET) {
 		gvar = g_variant_new_uint64(time_msec);
 		if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) {
 			g_critical("Failed to configure time limit.");
 			return SR_ERR;
 		}
 	} else if (sr_dev_config_capabilities_list(sdi, NULL, SR_CONF_SAMPLERATE)
 			& (SR_CONF_GET | SR_CONF_SET)) {
 		/* Convert to samples based on the samplerate. */
 		sr_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar);
 		samplerate = g_variant_get_uint64(gvar);
 		g_variant_unref(gvar);
 		limit_samples = (samplerate) * time_msec / (uint64_t)1000;
 		if (limit_samples == 0) {
 			g_critical("Not enough time at this samplerate.");
 			return SR_ERR;
 		}
 		gvar = g_variant_new_uint64(limit_samples);
 		if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
 			g_critical("Failed to configure time-based sample limit.");
 			return SR_ERR;
 		}
 	} else {
 		g_critical("This device does not support time limits.");
 		return SR_ERR;
 	}

 	return SR_OK;
 }

 const struct sr_output *setup_output_format(const struct sr_dev_inst *sdi, FILE **outfile)
 {
 	const struct sr_output_module *omod;
 	const struct sr_option **options;
 	const struct sr_output *o;
 	GHashTable *fmtargs, *fmtopts;
 	char *fmtspec;

 	if (!opt_output_format) {
 		if (opt_output_file) {
 			opt_output_format = DEFAULT_OUTPUT_FORMAT_FILE;
 		} else {
 			opt_output_format = DEFAULT_OUTPUT_FORMAT_NOFILE;
 		}
 	}

 	fmtargs = parse_generic_arg(opt_output_format, TRUE);
 	fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
 	if (!fmtspec)
 		g_critical("Invalid output format.");
 	if (!(omod = sr_output_find(fmtspec)))
 		g_critical("Unknown output module '%s'.", fmtspec);
 	g_hash_table_remove(fmtargs, "sigrok_key");
 	if ((options = sr_output_options_get(omod))) {
 		fmtopts = generic_arg_to_opt(options, fmtargs);
 		sr_output_options_free(options);
 	} else
 		fmtopts = NULL;
 	o = sr_output_new(omod, fmtopts, sdi, opt_output_file);

 	if (opt_output_file) {
 		if (!sr_output_test_flag(omod, SR_OUTPUT_INTERNAL_IO_HANDLING))
 			*outfile = g_fopen(opt_output_file, "wb");
 		else
 			*outfile = NULL;
 	} else {
 		*outfile = stdout;
 	}

 	if (fmtopts)
 		g_hash_table_destroy(fmtopts);
 	g_hash_table_destroy(fmtargs);

 	return o;
 }

 const struct sr_transform *setup_transform_module(const struct sr_dev_inst *sdi)
 {
 	const struct sr_transform_module *tmod;
 	const struct sr_option **options;
 	const struct sr_transform *t;
 	GHashTable *fmtargs, *fmtopts;
 	char *fmtspec;

 	if (!opt_transform_module)
 		opt_transform_module = "nop";

 	fmtargs = parse_generic_arg(opt_transform_module, TRUE);
 	fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
 	if (!fmtspec)
 		g_critical("Invalid transform module.");
 	if (!(tmod = sr_transform_find(fmtspec)))
 		g_critical("Unknown transform module '%s'.", fmtspec);
 	g_hash_table_remove(fmtargs, "sigrok_key");
 	if ((options = sr_transform_options_get(tmod))) {
 		fmtopts = generic_arg_to_opt(options, fmtargs);
 		sr_transform_options_free(options);
 	} else
 		fmtopts = NULL;
 	t = sr_transform_new(tmod, fmtopts, sdi);
 	if (fmtopts)
 		g_hash_table_destroy(fmtopts);
 	g_hash_table_destroy(fmtargs);

 	return t;
 }

 void datafeed_in(const struct sr_dev_inst *sdi,
 		const struct sr_datafeed_packet *packet, void *cb_data)
 {
 	const struct sr_datafeed_meta *meta;
 	const struct sr_datafeed_logic *logic;
 	const struct sr_datafeed_analog *analog;
 	struct sr_session *session;
 	struct sr_config *src;
 	static const struct sr_output *o = NULL;
 	static const struct sr_output *oa = NULL;
 	static uint64_t rcvd_samples_logic = 0;
 	static uint64_t rcvd_samples_analog = 0;
 	static uint64_t samplerate = 0;
 	static int triggered = 0;
 	static FILE *outfile = NULL;
 	GSList *l;
 	GString *out;
 	GVariant *gvar;
 	uint64_t end_sample;
 	uint64_t input_len;
 	struct sr_dev_driver *driver;

 	driver = sr_dev_inst_driver_get(sdi);

 	/* If the first packet to come in isn't a header, don't even try. */
 	if (packet->type != SR_DF_HEADER && !o)
 		return;

 	session = cb_data;
 	switch (packet->type) {
 	case SR_DF_HEADER:
 		g_debug("cli: Received SR_DF_HEADER.");
 		if (!(o = setup_output_format(sdi, &outfile)))
 			g_critical("Failed to initialize output module.");

 		/* Set up backup analog output module. */
 		oa = sr_output_new(sr_output_find("analog"), NULL, sdi, NULL);

 		rcvd_samples_logic = rcvd_samples_analog = 0;

 		if (maybe_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE,
 				&gvar) == SR_OK) {
 			samplerate = g_variant_get_uint64(gvar);
 			g_variant_unref(gvar);
 		}

 #ifdef HAVE_SRD
 		if (opt_pds) {
 			if (samplerate) {
 				if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
 						g_variant_new_uint64(samplerate)) != SRD_OK) {
 					g_critical("Failed to configure decode session.");
 					break;
 				}
 			}
 			if (srd_session_start(srd_sess) != SRD_OK) {
 				g_critical("Failed to start decode session.");
 				break;
 			}
 		}
 #endif
 		break;

 	case SR_DF_META:
 		g_debug("cli: Received SR_DF_META.");
 		meta = packet->payload;
 		for (l = meta->config; l; l = l->next) {
 			src = l->data;
 			switch (src->key) {
 			case SR_CONF_SAMPLERATE:
 				samplerate = g_variant_get_uint64(src->data);
 				g_debug("cli: Got samplerate %"PRIu64" Hz.", samplerate);
 #ifdef HAVE_SRD
 				if (opt_pds) {
 					if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
 							g_variant_new_uint64(samplerate)) != SRD_OK) {
 						g_critical("Failed to pass samplerate to decoder.");
 					}
 				}
 #endif
 				break;
 			case SR_CONF_SAMPLE_INTERVAL:
 				samplerate = g_variant_get_uint64(src->data);
 				g_debug("cli: Got sample interval %"PRIu64" ms.", samplerate);
 				break;
 			default:
 				/* Unknown metadata is not an error. */
 				break;
 			}
 		}
 		break;

 	case SR_DF_TRIGGER:
 		g_debug("cli: Received SR_DF_TRIGGER.");
 		triggered = 1;
 		break;

 	case SR_DF_LOGIC:
 		logic = packet->payload;
 		g_message("cli: Received SR_DF_LOGIC (%"PRIu64" bytes, unitsize = %d).",
 				logic->length, logic->unitsize);
 		if (logic->length == 0)
 			break;

 		/* Don't store any samples until triggered. */
 		if (opt_wait_trigger && !triggered)
 			break;

 		if (limit_samples && rcvd_samples_logic >= limit_samples)
 			break;

 		end_sample = rcvd_samples_logic + logic->length / logic->unitsize;
 		/* Cut off last packet according to the sample limit. */
 		if (limit_samples && end_sample > limit_samples)
 			end_sample = limit_samples;
 		input_len = (end_sample - rcvd_samples_logic) * logic->unitsize;

 		if (opt_pds) {
 #ifdef HAVE_SRD
 			if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample,
 					logic->data, input_len, logic->unitsize) != SRD_OK)
 				sr_session_stop(session);
 #endif
 		}

 		rcvd_samples_logic = end_sample;
 		break;

 	case SR_DF_ANALOG:
 		analog = packet->payload;
 		g_message("cli: Received SR_DF_ANALOG (%d samples).", analog->num_samples);
 		if (analog->num_samples == 0)
 			break;

 		if (limit_samples && rcvd_samples_analog >= limit_samples)
 			break;

 		rcvd_samples_analog += analog->num_samples;
 		break;

 	case SR_DF_FRAME_BEGIN:
 		g_debug("cli: Received SR_DF_FRAME_BEGIN.");
 		break;

 	case SR_DF_FRAME_END:
 		g_debug("cli: Received SR_DF_FRAME_END.");
 		break;

 	default:
 		break;
 	}

 	if (o && !opt_pds) {
 		if (sr_output_send(o, packet, &out) == SR_OK) {
 			if (!out || (out->len == 0
 					&& !opt_output_format
 					&& packet->type == SR_DF_ANALOG)) {
 				/*
 				 * The user didn't specify an output module,
 				 * but needs to see this analog data.
 				 */
 				sr_output_send(oa, packet, &out);
 			}
 			if (outfile && out && out->len > 0) {
 				fwrite(out->str, 1, out->len, outfile);
 				fflush(outfile);
 			}
 			if (out)
 				g_string_free(out, TRUE);
 		}
 	}

 	/*
 	 * SR_DF_END needs to be handled after the output module's receive()
 	 * is called, so it can properly clean up that module.
 	 */
 	if (packet->type == SR_DF_END) {
 		g_debug("cli: Received SR_DF_END.");

 		if (o)
 			sr_output_free(o);
 		o = NULL;

 		sr_output_free(oa);
 		oa = NULL;

 		if (outfile && outfile != stdout)
 			fclose(outfile);

 		if (limit_samples) {
 			if (rcvd_samples_logic > 0 && rcvd_samples_logic < limit_samples)
 				g_warning("Device only sent %" PRIu64 " samples.",
 					   rcvd_samples_logic);
 			else if (rcvd_samples_analog > 0 && rcvd_samples_analog < limit_samples)
 				g_warning("Device only sent %" PRIu64 " samples.",
 					   rcvd_samples_analog);
 		}
 	}

 }

 int opt_to_gvar(char *key, char *value, struct sr_config *src)
 {
 	const struct sr_key_info *srci, *srmqi;
 	double tmp_double, dlow, dhigh;
 	uint64_t tmp_u64, p, q, low, high, mqflags;
 	uint32_t mq;
 	GVariant *rational[2], *range[2], *gtup[2];
 	GVariantBuilder *vbl;
 	gboolean tmp_bool;
 	gchar **keyval;
 	int ret, i;

 	if (!(srci = sr_key_info_name_get(SR_KEY_CONFIG, key))) {
 		g_critical("Unknown device option '%s'.", (char *) key);
 		return -1;
 	}
 	src->key = srci->key;

 	if ((!value || strlen(value) == 0) &&
 		(srci->datatype != SR_T_BOOL)) {
 		g_critical("Option '%s' needs a value.", (char *)key);
 		return -1;
 	}

 	ret = 0;
 	switch (srci->datatype) {
 	case SR_T_UINT64:
 		ret = sr_parse_sizestring(value, &tmp_u64);
 		if (ret != 0)
 			break;
 		src->data = g_variant_new_uint64(tmp_u64);
 		break;
 	case SR_T_INT32:
 		ret = sr_parse_sizestring(value, &tmp_u64);
 		if (ret != 0)
 			break;
 		src->data = g_variant_new_int32(tmp_u64);
 		break;
 	case SR_T_STRING:
 		src->data = g_variant_new_string(value);
 		break;
 	case SR_T_BOOL:
 		if (!value)
 			tmp_bool = TRUE;
 		else
 			tmp_bool = sr_parse_boolstring(value);
 		src->data = g_variant_new_boolean(tmp_bool);
 		break;
 	case SR_T_FLOAT:
 		tmp_double = strtof(value, NULL);
 		src->data = g_variant_new_double(tmp_double);
 		break;
 	case SR_T_RATIONAL_PERIOD:
 		if ((ret = sr_parse_period(value, &p, &q)) != SR_OK)
 			break;
 		rational[0] = g_variant_new_uint64(p);
 		rational[1] = g_variant_new_uint64(q);
 		src->data = g_variant_new_tuple(rational, 2);
 		break;
 	case SR_T_RATIONAL_VOLT:
 		if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK)
 			break;
 		rational[0] = g_variant_new_uint64(p);
 		rational[1] = g_variant_new_uint64(q);
 		src->data = g_variant_new_tuple(rational, 2);
 		break;
 	case SR_T_UINT64_RANGE:
 		if (sscanf(value, "%"PRIu64"-%"PRIu64, &low, &high) != 2) {
 			ret = -1;
 			break;
 		} else {
 			range[0] = g_variant_new_uint64(low);
 			range[1] = g_variant_new_uint64(high);
 			src->data = g_variant_new_tuple(range, 2);
 		}
 		break;
 	case SR_T_DOUBLE_RANGE:
 		if (sscanf(value, "%lf-%lf", &dlow, &dhigh) != 2) {
 			ret = -1;
 			break;
 		} else {
 			range[0] = g_variant_new_double(dlow);
 			range[1] = g_variant_new_double(dhigh);
 			src->data = g_variant_new_tuple(range, 2);
 		}
 		break;
 	case SR_T_KEYVALUE:
 		/* Expects the argument to be in the form of key=value. */
 		keyval = g_strsplit(value, "=", 2);
 		if (!keyval[0] || !keyval[1]) {
 			g_strfreev(keyval);
 			ret = -1;
 			break;
 		} else {
 			vbl = g_variant_builder_new(G_VARIANT_TYPE_DICTIONARY);
 			g_variant_builder_add(vbl, "{ss}",
 					      keyval[0], keyval[1]);
 			src->data = g_variant_builder_end(vbl);
 			g_strfreev(keyval);
 		}
 		break;
 	case SR_T_MQ:
 		/*
 		  Argument is MQ id e.g. ("voltage") optionally followed by one
 		  or more /<mqflag> e.g. "/ac".
 		 */
 		keyval = g_strsplit(value, "/", 0);
 		if (!keyval[0] || !(srmqi = sr_key_info_name_get(SR_KEY_MQ, keyval[0]))) {
 			g_strfreev(keyval);
 			ret = -1;
 			break;
 		}
 		mq = srmqi->key;
 		mqflags = 0;
 		for (i = 1; keyval[i]; i++) {
 			if (!(srmqi = sr_key_info_name_get(SR_KEY_MQFLAGS, keyval[i]))) {
 				ret = -1;
 				break;
 			}
 			mqflags |= srmqi->key;
 		}
 		g_strfreev(keyval);
 		if (ret != -1) {
 			gtup[0] = g_variant_new_uint32(mq);
 			gtup[1] = g_variant_new_uint64(mqflags);
 			src->data = g_variant_new_tuple(gtup, 2);
 		}
 		break;
 	default:
 		g_critical("Unknown data type specified for option '%s' "
 			   "(driver implementation bug?).", key);
 		ret = -1;
 	}

 	if (ret < 0)
 		g_critical("Invalid value: '%s' for option '%s'", value, key);

 	return ret;
 }

 int set_dev_options(struct sr_dev_inst *sdi, GHashTable *args)
 {
 	struct sr_config src;
 	struct sr_channel_group *cg;
 	GHashTableIter iter;
 	gpointer key, value;
 	int ret;

 	g_hash_table_iter_init(&iter, args);
 	while (g_hash_table_iter_next(&iter, &key, &value)) {
 		if ((ret = opt_to_gvar(key, value, &src)) != 0)
 			return ret;
 		cg = select_channel_group(sdi);
 		if ((ret = maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, cg,
 				src.key, src.data)) != SR_OK) {
 			g_critical("Failed to set device option '%s': %s.",
 				   (char *)key, sr_strerror(ret));
 			return ret;
 		}
 	}

 	return SR_OK;
 }

 void run_session(void)
 {
 	GSList *devices, *real_devices, *sd;
 	GHashTable *devargs;
 	GVariant *gvar;
 	struct sr_session *session;
 	struct sr_trigger *trigger;
 	struct sr_dev_inst *sdi;
 	uint64_t min_samples, max_samples;
 	GArray *dev_opts;
 	guint i;
 	int is_demo_dev;
 	struct sr_dev_driver *driver;
 	const struct sr_transform *t;
 	GMainLoop *main_loop;

 	devices = device_scan();
 	if (!devices) {
 		g_critical("No devices found.");
 		return;
 	}

 	real_devices = NULL;
 	for (sd = devices; sd; sd = sd->next) {
 		sdi = sd->data;

 		driver = sr_dev_inst_driver_get(sdi);

 		if (!(dev_opts = sr_dev_options(driver, sdi, NULL))) {
 			g_critical("Failed to query list device options.");
 			return;
 		}

 		is_demo_dev = 0;
 		for (i = 0; i < dev_opts->len; i++) {
 			if (g_array_index(dev_opts, uint32_t, i) == SR_CONF_DEMO_DEV)
 				is_demo_dev = 1;
 		}

 		g_array_free(dev_opts, TRUE);

 		if (!is_demo_dev)
 			real_devices = g_slist_append(real_devices, sdi);
 	}

 	if (g_slist_length(devices) > 1) {
 		if (g_slist_length(real_devices) != 1) {
 			g_critical("sigrok-cli only supports one device for capturing.");
 			return;
 		} else {
 			/* We only have one non-demo device. */
 			g_slist_free(devices);
 			devices = real_devices;
 			real_devices = NULL;
 		}
 	}

 	sdi = devices->data;
 	g_slist_free(devices);
 	g_slist_free(real_devices);

 	sr_session_new(sr_ctx, &session);
 	sr_session_datafeed_callback_add(session, datafeed_in, NULL);

 	if (sr_dev_open(sdi) != SR_OK) {
 		g_critical("Failed to open device.");
 		return;
 	}

 	if (sr_session_dev_add(session, sdi) != SR_OK) {
 		g_critical("Failed to add device to session.");
 		sr_session_destroy(session);
 		return;
 	}

 	if (opt_config) {
 		if ((devargs = parse_generic_arg(opt_config, FALSE))) {
 			if (set_dev_options(sdi, devargs) != SR_OK)
 				return;
 			g_hash_table_destroy(devargs);
 		}
 	}

 	if (select_channels(sdi) != SR_OK) {
 		g_critical("Failed to set channels.");
 		sr_session_destroy(session);
 		return;
 	}

 	trigger = NULL;
 	if (opt_triggers) {
 		if (!parse_triggerstring(sdi, opt_triggers, &trigger)) {
 			sr_session_destroy(session);
 			return;
 		}
 		if (sr_session_trigger_set(session, trigger) != SR_OK) {
 			sr_session_destroy(session);
 			return;
 		}
 	}

 	if (opt_continuous) {
 		if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) {
 			g_critical("This device does not support continuous sampling.");
 			sr_session_destroy(session);
 			return;
 		}
 	}

 	if (opt_time) {
 		if (set_limit_time(sdi) != SR_OK) {
 			sr_session_destroy(session);
 			return;
 		}
 	}

 	if (opt_samples) {
 		if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) {
 			g_critical("Invalid sample limit '%s'.", opt_samples);
 			sr_session_destroy(session);
 			return;
 		}
 		if (maybe_config_list(driver, sdi, NULL, SR_CONF_LIMIT_SAMPLES,
 				&gvar) == SR_OK) {
 			/*
 			 * The device has no compression, or compression is turned
 			 * off, and publishes its sample memory size.
 			 */
 			g_variant_get(gvar, "(tt)", &min_samples, &max_samples);
 			g_variant_unref(gvar);
 			if (limit_samples < min_samples) {
 				g_critical("The device stores at least %"PRIu64
 						" samples with the current settings.", min_samples);
 			}
 			if (limit_samples > max_samples) {
 				g_critical("The device can store only %"PRIu64
 						" samples with the current settings.", max_samples);
 			}
 		}
 		gvar = g_variant_new_uint64(limit_samples);
 		if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
 			g_critical("Failed to configure sample limit.");
 			sr_session_destroy(session);
 			return;
 		}
 	}

 	if (opt_frames) {
 		if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) {
 			g_critical("Invalid sample limit '%s'.", opt_samples);
 			sr_session_destroy(session);
 			return;
 		}
 		gvar = g_variant_new_uint64(limit_frames);
 		if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
 			g_critical("Failed to configure frame limit.");
 			sr_session_destroy(session);
 			return;
 		}
 	}

 	if (!(t = setup_transform_module(sdi)))
 		g_critical("Failed to initialize transform module.");

 	main_loop = g_main_loop_new(NULL, FALSE);

 	sr_session_stopped_callback_set(session,
 		(sr_session_stopped_callback)g_main_loop_quit, main_loop);

 	if (sr_session_start(session) != SR_OK) {
 		g_critical("Failed to start session.");
 		g_main_loop_unref(main_loop);
 		sr_session_destroy(session);
 		return;
 	}

 	if (opt_continuous)
 		add_anykey(session);

 	g_main_loop_run(main_loop);

 	if (opt_continuous)
 		clear_anykey();

 	if (trigger)
 		sr_trigger_free(trigger);

 	sr_session_datafeed_callback_remove_all(session);
 	g_main_loop_unref(main_loop);
 	sr_session_destroy(session);
 }
	/*
	* This file is part of the sigrok-cli project.
	*
	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
	*
	* This program is free software: you can redistribute it and/or modify
	* it under the terms of the GNU General Public License as published by
	* the Free Software Foundation, either version 3 of the License, or
	* (at your option) any later version.
	*
	* This program is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU General Public License for more details.
	*
	* You should have received a copy of the GNU General Public License
	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	*/

	#include <config.h>
	#include <glib.h>
	#include <glib/gstdio.h>
	#include <string.h>
	#include <stdlib.h>
	#include "sigrok-cli.h"

	static uint64_t limit_samples = 0;
	static uint64_t limit_frames = 0;

	#ifdef HAVE_SRD
	extern struct srd_session *srd_sess;
	#endif

	static int set_limit_time(const struct sr_dev_inst *sdi)
	{
	GVariant *gvar;
	uint64_t time_msec;
	uint64_t samplerate;
	struct sr_dev_driver *driver;

	driver = sr_dev_inst_driver_get(sdi);

	if (!(time_msec = sr_parse_timestring(opt_time))) {
	g_critical("Invalid time '%s'", opt_time);
	return SR_ERR;
	}

	if (sr_dev_config_capabilities_list(sdi, NULL, SR_CONF_LIMIT_MSEC)
	& SR_CONF_SET) {
	gvar = g_variant_new_uint64(time_msec);
	if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_MSEC, gvar) != SR_OK) {
	g_critical("Failed to configure time limit.");
	return SR_ERR;
	}
	} else if (sr_dev_config_capabilities_list(sdi, NULL, SR_CONF_SAMPLERATE)
	& (SR_CONF_GET \| SR_CONF_SET)) {
	/* Convert to samples based on the samplerate. */
	sr_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE, &gvar);
	samplerate = g_variant_get_uint64(gvar);
	g_variant_unref(gvar);
	limit_samples = (samplerate) * time_msec / (uint64_t)1000;
	if (limit_samples == 0) {
	g_critical("Not enough time at this samplerate.");
	return SR_ERR;
	}
	gvar = g_variant_new_uint64(limit_samples);
	if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
	g_critical("Failed to configure time-based sample limit.");
	return SR_ERR;
	}
	} else {
	g_critical("This device does not support time limits.");
	return SR_ERR;
	}

	return SR_OK;
	}

	const struct sr_output setup_output_format(const struct sr_dev_inst sdi, FILE **outfile)
	{
	const struct sr_output_module *omod;
	const struct sr_option **options;
	const struct sr_output *o;
	GHashTable fmtargs, fmtopts;
	char *fmtspec;

	if (!opt_output_format) {
	if (opt_output_file) {
	opt_output_format = DEFAULT_OUTPUT_FORMAT_FILE;
	} else {
	opt_output_format = DEFAULT_OUTPUT_FORMAT_NOFILE;
	}
	}

	fmtargs = parse_generic_arg(opt_output_format, TRUE);
	fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
	if (!fmtspec)
	g_critical("Invalid output format.");
	if (!(omod = sr_output_find(fmtspec)))
	g_critical("Unknown output module '%s'.", fmtspec);
	g_hash_table_remove(fmtargs, "sigrok_key");
	if ((options = sr_output_options_get(omod))) {
	fmtopts = generic_arg_to_opt(options, fmtargs);
	sr_output_options_free(options);
	} else
	fmtopts = NULL;
	o = sr_output_new(omod, fmtopts, sdi, opt_output_file);

	if (opt_output_file) {
	if (!sr_output_test_flag(omod, SR_OUTPUT_INTERNAL_IO_HANDLING))
	*outfile = g_fopen(opt_output_file, "wb");
	else
	*outfile = NULL;
	} else {
	*outfile = stdout;
	}

	if (fmtopts)
	g_hash_table_destroy(fmtopts);
	g_hash_table_destroy(fmtargs);

	return o;
	}

	const struct sr_transform setup_transform_module(const struct sr_dev_inst sdi)
	{
	const struct sr_transform_module *tmod;
	const struct sr_option **options;
	const struct sr_transform *t;
	GHashTable fmtargs, fmtopts;
	char *fmtspec;

	if (!opt_transform_module)
	opt_transform_module = "nop";

	fmtargs = parse_generic_arg(opt_transform_module, TRUE);
	fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
	if (!fmtspec)
	g_critical("Invalid transform module.");
	if (!(tmod = sr_transform_find(fmtspec)))
	g_critical("Unknown transform module '%s'.", fmtspec);
	g_hash_table_remove(fmtargs, "sigrok_key");
	if ((options = sr_transform_options_get(tmod))) {
	fmtopts = generic_arg_to_opt(options, fmtargs);
	sr_transform_options_free(options);
	} else
	fmtopts = NULL;
	t = sr_transform_new(tmod, fmtopts, sdi);
	if (fmtopts)
	g_hash_table_destroy(fmtopts);
	g_hash_table_destroy(fmtargs);

	return t;
	}

	void datafeed_in(const struct sr_dev_inst *sdi,
	const struct sr_datafeed_packet packet, void cb_data)
	{
	const struct sr_datafeed_meta *meta;
	const struct sr_datafeed_logic *logic;
	const struct sr_datafeed_analog *analog;
	struct sr_session *session;
	struct sr_config *src;
	static const struct sr_output *o = NULL;
	static const struct sr_output *oa = NULL;
	static uint64_t rcvd_samples_logic = 0;
	static uint64_t rcvd_samples_analog = 0;
	static uint64_t samplerate = 0;
	static int triggered = 0;
	static FILE *outfile = NULL;
	GSList *l;
	GString *out;
	GVariant *gvar;
	uint64_t end_sample;
	uint64_t input_len;
	struct sr_dev_driver *driver;

	driver = sr_dev_inst_driver_get(sdi);

	/* If the first packet to come in isn't a header, don't even try. */
	if (packet->type != SR_DF_HEADER && !o)
	return;

	session = cb_data;
	switch (packet->type) {
	case SR_DF_HEADER:
	g_debug("cli: Received SR_DF_HEADER.");
	if (!(o = setup_output_format(sdi, &outfile)))
	g_critical("Failed to initialize output module.");

	/* Set up backup analog output module. */
	oa = sr_output_new(sr_output_find("analog"), NULL, sdi, NULL);

	rcvd_samples_logic = rcvd_samples_analog = 0;

	if (maybe_config_get(driver, sdi, NULL, SR_CONF_SAMPLERATE,
	&gvar) == SR_OK) {
	samplerate = g_variant_get_uint64(gvar);
	g_variant_unref(gvar);
	}

	#ifdef HAVE_SRD
	if (opt_pds) {
	if (samplerate) {
	if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
	g_variant_new_uint64(samplerate)) != SRD_OK) {
	g_critical("Failed to configure decode session.");
	break;
	}
	}
	if (srd_session_start(srd_sess) != SRD_OK) {
	g_critical("Failed to start decode session.");
	break;
	}
	}
	#endif
	break;

	case SR_DF_META:
	g_debug("cli: Received SR_DF_META.");
	meta = packet->payload;
	for (l = meta->config; l; l = l->next) {
	src = l->data;
	switch (src->key) {
	case SR_CONF_SAMPLERATE:
	samplerate = g_variant_get_uint64(src->data);
	g_debug("cli: Got samplerate %"PRIu64" Hz.", samplerate);
	#ifdef HAVE_SRD
	if (opt_pds) {
	if (srd_session_metadata_set(srd_sess, SRD_CONF_SAMPLERATE,
	g_variant_new_uint64(samplerate)) != SRD_OK) {
	g_critical("Failed to pass samplerate to decoder.");
	}
	}
	#endif
	break;
	case SR_CONF_SAMPLE_INTERVAL:
	samplerate = g_variant_get_uint64(src->data);
	g_debug("cli: Got sample interval %"PRIu64" ms.", samplerate);
	break;
	default:
	/* Unknown metadata is not an error. */
	break;
	}
	}
	break;

	case SR_DF_TRIGGER:
	g_debug("cli: Received SR_DF_TRIGGER.");
	triggered = 1;
	break;

	case SR_DF_LOGIC:
	logic = packet->payload;
	g_message("cli: Received SR_DF_LOGIC (%"PRIu64" bytes, unitsize = %d).",
	logic->length, logic->unitsize);
	if (logic->length == 0)
	break;

	/* Don't store any samples until triggered. */
	if (opt_wait_trigger && !triggered)
	break;

	if (limit_samples && rcvd_samples_logic >= limit_samples)
	break;

	end_sample = rcvd_samples_logic + logic->length / logic->unitsize;
	/* Cut off last packet according to the sample limit. */
	if (limit_samples && end_sample > limit_samples)
	end_sample = limit_samples;
	input_len = (end_sample - rcvd_samples_logic) * logic->unitsize;

	if (opt_pds) {
	#ifdef HAVE_SRD
	if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample,
	logic->data, input_len, logic->unitsize) != SRD_OK)
	sr_session_stop(session);
	#endif
	}

	rcvd_samples_logic = end_sample;
	break;

	case SR_DF_ANALOG:
	analog = packet->payload;
	g_message("cli: Received SR_DF_ANALOG (%d samples).", analog->num_samples);
	if (analog->num_samples == 0)
	break;

	if (limit_samples && rcvd_samples_analog >= limit_samples)
	break;

	rcvd_samples_analog += analog->num_samples;
	break;

	case SR_DF_FRAME_BEGIN:
	g_debug("cli: Received SR_DF_FRAME_BEGIN.");
	break;

	case SR_DF_FRAME_END:
	g_debug("cli: Received SR_DF_FRAME_END.");
	break;

	default:
	break;
	}

	if (o && !opt_pds) {
	if (sr_output_send(o, packet, &out) == SR_OK) {
	if (!out \|\| (out->len == 0
	&& !opt_output_format
	&& packet->type == SR_DF_ANALOG)) {
	/*
	* The user didn't specify an output module,
	* but needs to see this analog data.
	*/
	sr_output_send(oa, packet, &out);
	}
	if (outfile && out && out->len > 0) {
	fwrite(out->str, 1, out->len, outfile);
	fflush(outfile);
	}
	if (out)
	g_string_free(out, TRUE);
	}
	}

	/*
	* SR_DF_END needs to be handled after the output module's receive()
	* is called, so it can properly clean up that module.
	*/
	if (packet->type == SR_DF_END) {
	g_debug("cli: Received SR_DF_END.");

	if (o)
	sr_output_free(o);
	o = NULL;

	sr_output_free(oa);
	oa = NULL;

	if (outfile && outfile != stdout)
	fclose(outfile);

	if (limit_samples) {
	if (rcvd_samples_logic > 0 && rcvd_samples_logic < limit_samples)
	g_warning("Device only sent %" PRIu64 " samples.",
	rcvd_samples_logic);
	else if (rcvd_samples_analog > 0 && rcvd_samples_analog < limit_samples)
	g_warning("Device only sent %" PRIu64 " samples.",
	rcvd_samples_analog);
	}
	}

	}

	int opt_to_gvar(char key, char value, struct sr_config *src)
	{
	const struct sr_key_info srci, srmqi;
	double tmp_double, dlow, dhigh;
	uint64_t tmp_u64, p, q, low, high, mqflags;
	uint32_t mq;
	GVariant rational[2], range[2], *gtup[2];
	GVariantBuilder *vbl;
	gboolean tmp_bool;
	gchar **keyval;
	int ret, i;

	if (!(srci = sr_key_info_name_get(SR_KEY_CONFIG, key))) {
	g_critical("Unknown device option '%s'.", (char *) key);
	return -1;
	}
	src->key = srci->key;

	if ((!value \|\| strlen(value) == 0) &&
	(srci->datatype != SR_T_BOOL)) {
	g_critical("Option '%s' needs a value.", (char *)key);
	return -1;
	}

	ret = 0;
	switch (srci->datatype) {
	case SR_T_UINT64:
	ret = sr_parse_sizestring(value, &tmp_u64);
	if (ret != 0)
	break;
	src->data = g_variant_new_uint64(tmp_u64);
	break;
	case SR_T_INT32:
	ret = sr_parse_sizestring(value, &tmp_u64);
	if (ret != 0)
	break;
	src->data = g_variant_new_int32(tmp_u64);
	break;
	case SR_T_STRING:
	src->data = g_variant_new_string(value);
	break;
	case SR_T_BOOL:
	if (!value)
	tmp_bool = TRUE;
	else
	tmp_bool = sr_parse_boolstring(value);
	src->data = g_variant_new_boolean(tmp_bool);
	break;
	case SR_T_FLOAT:
	tmp_double = strtof(value, NULL);
	src->data = g_variant_new_double(tmp_double);
	break;
	case SR_T_RATIONAL_PERIOD:
	if ((ret = sr_parse_period(value, &p, &q)) != SR_OK)
	break;
	rational[0] = g_variant_new_uint64(p);
	rational[1] = g_variant_new_uint64(q);
	src->data = g_variant_new_tuple(rational, 2);
	break;
	case SR_T_RATIONAL_VOLT:
	if ((ret = sr_parse_voltage(value, &p, &q)) != SR_OK)
	break;
	rational[0] = g_variant_new_uint64(p);
	rational[1] = g_variant_new_uint64(q);
	src->data = g_variant_new_tuple(rational, 2);
	break;
	case SR_T_UINT64_RANGE:
	if (sscanf(value, "%"PRIu64"-%"PRIu64, &low, &high) != 2) {
	ret = -1;
	break;
	} else {
	range[0] = g_variant_new_uint64(low);
	range[1] = g_variant_new_uint64(high);
	src->data = g_variant_new_tuple(range, 2);
	}
	break;
	case SR_T_DOUBLE_RANGE:
	if (sscanf(value, "%lf-%lf", &dlow, &dhigh) != 2) {
	ret = -1;
	break;
	} else {
	range[0] = g_variant_new_double(dlow);
	range[1] = g_variant_new_double(dhigh);
	src->data = g_variant_new_tuple(range, 2);
	}
	break;
	case SR_T_KEYVALUE:
	/* Expects the argument to be in the form of key=value. */
	keyval = g_strsplit(value, "=", 2);
	if (!keyval[0] \|\| !keyval[1]) {
	g_strfreev(keyval);
	ret = -1;
	break;
	} else {
	vbl = g_variant_builder_new(G_VARIANT_TYPE_DICTIONARY);
	g_variant_builder_add(vbl, "{ss}",
	keyval[0], keyval[1]);
	src->data = g_variant_builder_end(vbl);
	g_strfreev(keyval);
	}
	break;
	case SR_T_MQ:
	/*
	Argument is MQ id e.g. ("voltage") optionally followed by one
	or more /<mqflag> e.g. "/ac".
	*/
	keyval = g_strsplit(value, "/", 0);
	if (!keyval[0] \|\| !(srmqi = sr_key_info_name_get(SR_KEY_MQ, keyval[0]))) {
	g_strfreev(keyval);
	ret = -1;
	break;
	}
	mq = srmqi->key;
	mqflags = 0;
	for (i = 1; keyval[i]; i++) {
	if (!(srmqi = sr_key_info_name_get(SR_KEY_MQFLAGS, keyval[i]))) {
	ret = -1;
	break;
	}
	mqflags \|= srmqi->key;
	}
	g_strfreev(keyval);
	if (ret != -1) {
	gtup[0] = g_variant_new_uint32(mq);
	gtup[1] = g_variant_new_uint64(mqflags);
	src->data = g_variant_new_tuple(gtup, 2);
	}
	break;
	default:
	g_critical("Unknown data type specified for option '%s' "
	"(driver implementation bug?).", key);
	ret = -1;
	}

	if (ret < 0)
	g_critical("Invalid value: '%s' for option '%s'", value, key);

	return ret;
	}

	int set_dev_options(struct sr_dev_inst sdi, GHashTable args)
	{
	struct sr_config src;
	struct sr_channel_group *cg;
	GHashTableIter iter;
	gpointer key, value;
	int ret;

	g_hash_table_iter_init(&iter, args);
	while (g_hash_table_iter_next(&iter, &key, &value)) {
	if ((ret = opt_to_gvar(key, value, &src)) != 0)
	return ret;
	cg = select_channel_group(sdi);
	if ((ret = maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, cg,
	src.key, src.data)) != SR_OK) {
	g_critical("Failed to set device option '%s': %s.",
	(char *)key, sr_strerror(ret));
	return ret;
	}
	}

	return SR_OK;
	}

	void run_session(void)
	{
	GSList devices, real_devices, *sd;
	GHashTable *devargs;
	GVariant *gvar;
	struct sr_session *session;
	struct sr_trigger *trigger;
	struct sr_dev_inst *sdi;
	uint64_t min_samples, max_samples;
	GArray *dev_opts;
	guint i;
	int is_demo_dev;
	struct sr_dev_driver *driver;
	const struct sr_transform *t;
	GMainLoop *main_loop;

	devices = device_scan();
	if (!devices) {
	g_critical("No devices found.");
	return;
	}

	real_devices = NULL;
	for (sd = devices; sd; sd = sd->next) {
	sdi = sd->data;

	driver = sr_dev_inst_driver_get(sdi);

	if (!(dev_opts = sr_dev_options(driver, sdi, NULL))) {
	g_critical("Failed to query list device options.");
	return;
	}

	is_demo_dev = 0;
	for (i = 0; i < dev_opts->len; i++) {
	if (g_array_index(dev_opts, uint32_t, i) == SR_CONF_DEMO_DEV)
	is_demo_dev = 1;
	}

	g_array_free(dev_opts, TRUE);

	if (!is_demo_dev)
	real_devices = g_slist_append(real_devices, sdi);
	}

	if (g_slist_length(devices) > 1) {
	if (g_slist_length(real_devices) != 1) {
	g_critical("sigrok-cli only supports one device for capturing.");
	return;
	} else {
	/* We only have one non-demo device. */
	g_slist_free(devices);
	devices = real_devices;
	real_devices = NULL;
	}
	}

	sdi = devices->data;
	g_slist_free(devices);
	g_slist_free(real_devices);

	sr_session_new(sr_ctx, &session);
	sr_session_datafeed_callback_add(session, datafeed_in, NULL);

	if (sr_dev_open(sdi) != SR_OK) {
	g_critical("Failed to open device.");
	return;
	}

	if (sr_session_dev_add(session, sdi) != SR_OK) {
	g_critical("Failed to add device to session.");
	sr_session_destroy(session);
	return;
	}

	if (opt_config) {
	if ((devargs = parse_generic_arg(opt_config, FALSE))) {
	if (set_dev_options(sdi, devargs) != SR_OK)
	return;
	g_hash_table_destroy(devargs);
	}
	}

	if (select_channels(sdi) != SR_OK) {
	g_critical("Failed to set channels.");
	sr_session_destroy(session);
	return;
	}

	trigger = NULL;
	if (opt_triggers) {
	if (!parse_triggerstring(sdi, opt_triggers, &trigger)) {
	sr_session_destroy(session);
	return;
	}
	if (sr_session_trigger_set(session, trigger) != SR_OK) {
	sr_session_destroy(session);
	return;
	}
	}

	if (opt_continuous) {
	if (!sr_dev_has_option(sdi, SR_CONF_CONTINUOUS)) {
	g_critical("This device does not support continuous sampling.");
	sr_session_destroy(session);
	return;
	}
	}

	if (opt_time) {
	if (set_limit_time(sdi) != SR_OK) {
	sr_session_destroy(session);
	return;
	}
	}

	if (opt_samples) {
	if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK)) {
	g_critical("Invalid sample limit '%s'.", opt_samples);
	sr_session_destroy(session);
	return;
	}
	if (maybe_config_list(driver, sdi, NULL, SR_CONF_LIMIT_SAMPLES,
	&gvar) == SR_OK) {
	/*
	* The device has no compression, or compression is turned
	* off, and publishes its sample memory size.
	*/
	g_variant_get(gvar, "(tt)", &min_samples, &max_samples);
	g_variant_unref(gvar);
	if (limit_samples < min_samples) {
	g_critical("The device stores at least %"PRIu64
	" samples with the current settings.", min_samples);
	}
	if (limit_samples > max_samples) {
	g_critical("The device can store only %"PRIu64
	" samples with the current settings.", max_samples);
	}
	}
	gvar = g_variant_new_uint64(limit_samples);
	if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
	g_critical("Failed to configure sample limit.");
	sr_session_destroy(session);
	return;
	}
	}

	if (opt_frames) {
	if ((sr_parse_sizestring(opt_frames, &limit_frames) != SR_OK)) {
	g_critical("Invalid sample limit '%s'.", opt_samples);
	sr_session_destroy(session);
	return;
	}
	gvar = g_variant_new_uint64(limit_frames);
	if (maybe_config_set(sr_dev_inst_driver_get(sdi), sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
	g_critical("Failed to configure frame limit.");
	sr_session_destroy(session);
	return;
	}
	}

	if (!(t = setup_transform_module(sdi)))
	g_critical("Failed to initialize transform module.");

	main_loop = g_main_loop_new(NULL, FALSE);

	sr_session_stopped_callback_set(session,
	(sr_session_stopped_callback)g_main_loop_quit, main_loop);

	if (sr_session_start(session) != SR_OK) {
	g_critical("Failed to start session.");
	g_main_loop_unref(main_loop);
	sr_session_destroy(session);
	return;
	}

	if (opt_continuous)
	add_anykey(session);

	g_main_loop_run(main_loop);

	if (opt_continuous)
	clear_anykey();

	if (trigger)
	sr_trigger_free(trigger);

	sr_session_datafeed_callback_remove_all(session);
	g_main_loop_unref(main_loop);
	sr_session_destroy(session);
	}