[sigrok-cli.git] / session.c

/*
 * 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 "sigrok-cli.h"
#include "config.h"
#include <glib.h>
#include <glib/gstdio.h>
#include <string.h>
#include <stdlib.h>

static struct sr_output_format *output_format = NULL;
static int default_output_format = FALSE;
static char *output_format_param = NULL;
static uint64_t limit_samples = 0;
static uint64_t limit_frames = 0;

extern gchar *opt_output_file;
extern gchar *opt_output_format;
extern gchar *opt_pds;
extern gboolean opt_wait_trigger;
extern gchar *opt_time;
extern gchar *opt_samples;
extern gchar *opt_frames;
extern gchar *opt_continuous;
extern gchar *opt_config;
extern gchar *opt_triggers;
#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;

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

	if (sr_dev_has_option(sdi, SR_CONF_LIMIT_MSEC)) {
		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_has_option(sdi, SR_CONF_SAMPLERATE)) {
		/* Convert to samples based on the samplerate.  */
		sr_config_get(sdi->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;
}

int setup_output_format(void)
{
	GHashTable *fmtargs;
	GHashTableIter iter;
	gpointer key, value;
	struct sr_output_format **outputs;
	int i;
	char *fmtspec;

	if (opt_output_format && !strcmp(opt_output_format, "sigrok")) {
		/* Doesn't really exist as an output module - this is
		 * the session save mode. */
		g_free(opt_output_format);
		opt_output_format = NULL;
	}

	if (!opt_output_format) {
		opt_output_format = DEFAULT_OUTPUT_FORMAT;
		/* we'll need to remember this so when saving to a file
		 * later, sigrok session format will be used.
		 */
		default_output_format = TRUE;
	}

	fmtargs = parse_generic_arg(opt_output_format, TRUE);
	fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key");
	if (!fmtspec) {
		g_critical("Invalid output format.");
		return 1;
	}
	outputs = sr_output_list();
	for (i = 0; outputs[i]; i++) {
		if (strcmp(outputs[i]->id, fmtspec))
			continue;
		g_hash_table_remove(fmtargs, "sigrok_key");
		output_format = outputs[i];
		g_hash_table_iter_init(&iter, fmtargs);
		while (g_hash_table_iter_next(&iter, &key, &value)) {
			/* only supporting one parameter per output module
			 * for now, and only its value */
			output_format_param = g_strdup(value);
			break;
		}
		break;
	}
	if (!output_format) {
		g_critical("Invalid output format %s.", opt_output_format);
		return 1;
	}
	g_hash_table_destroy(fmtargs);

	return 0;
}

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_config *src;
	struct sr_channel *ch;
	static struct sr_output *o = 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;
	int i;
	char **channels;

	(void) cb_data;

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

	switch (packet->type) {
	case SR_DF_HEADER:
		g_debug("cli: Received SR_DF_HEADER");
		/* Initialize the output module. */
		if (!(o = g_try_malloc(sizeof(struct sr_output)))) {
			g_critical("Output module malloc failed.");
			exit(1);
		}
		o->format = output_format;
		o->sdi = (struct sr_dev_inst *)sdi;
		o->param = output_format_param;
		if (o->format->init) {
			if (o->format->init(o) != SR_OK) {
				g_critical("Output format initialization failed.");
				exit(1);
			}
		}

		/* Prepare non-stdout output. */
		outfile = stdout;
		if (opt_output_file) {
			if (default_output_format) {
				outfile = NULL;
			} else {
				/* saving to a file in whatever format was set
				 * with --format, so all we need is a filehandle */
				outfile = g_fopen(opt_output_file, "wb");
			}
		}
		rcvd_samples_logic = rcvd_samples_analog = 0;

		if (sr_config_get(sdi->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", logic->length);
		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_output_file && default_output_format) {
			/* Saving to a session file. */
			if (rcvd_samples_logic == 0) {
				/* First packet with logic data, init session file. */
				channels = g_malloc(sizeof(char *) * g_slist_length(sdi->channels));
				for (i = 0, l = sdi->channels; l; l = l->next) {
					ch = l->data;
					if (ch->enabled && ch->type == SR_CHANNEL_LOGIC)
						channels[i++] = ch->name;
				}
				channels[i] = NULL;
				sr_session_save_init(opt_output_file, samplerate,
						channels);
				g_free(channels);
			}
			save_chunk_logic(logic->data, input_len, logic->unitsize);
		} else {
			if (opt_pds) {
#ifdef HAVE_SRD
				if (srd_session_send(srd_sess, rcvd_samples_logic, end_sample,
						logic->data, input_len) != SRD_OK)
					sr_session_stop();
#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 && o->format->receive) {
		if (o->format->receive(o, sdi, packet, &out) == SR_OK && out) {
			fwrite(out->str, 1, out->len, outfile);
			fflush(outfile);
			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->format->cleanup)
			o->format->cleanup(o);
		g_free(o);
		o = NULL;

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

		if (opt_output_file && default_output_format)
			/* Flush whatever is left out to the session file. */
			save_chunk_logic(NULL, 0, 0);

		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_config_info *srci;
	double tmp_double, dlow, dhigh;
	uint64_t tmp_u64, p, q, low, high;
	GVariant *rational[2], *range[2];
	gboolean tmp_bool;
	int ret;

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

	if ((value == NULL) &&
		(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_CHAR:
		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;
	default:
		ret = -1;
	}

	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);
		ret = sr_config_set(sdi, cg, src.key, src.data);
		if (ret != SR_OK) {
			g_critical("Failed to set device option '%s'.", (char *)key);
			return ret;
		}
	}

	return SR_OK;
}

void run_session(void)
{
	GSList *devices;
	GHashTable *devargs;
	GVariant *gvar;
	struct sr_dev_inst *sdi;
	uint64_t min_samples, max_samples;
	int max_channels, i;
	char **triggerlist;

	devices = device_scan();
	if (!devices) {
		g_critical("No devices found.");
		return;
	}
	if (g_slist_length(devices) > 1) {
		g_critical("sigrok-cli only supports one device for capturing.");
		return;
	}
	sdi = devices->data;

	sr_session_new();
	sr_session_datafeed_callback_add(datafeed_in, NULL);

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

	if (sr_session_dev_add(sdi) != SR_OK) {
		g_critical("Failed to add device to session.");
		sr_session_destroy();
		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();
		return;
	}

	if (opt_triggers) {
		if (!(triggerlist = sr_parse_triggerstring(sdi, opt_triggers))) {
			sr_session_destroy();
			return;
		}
		max_channels = g_slist_length(sdi->channels);
		for (i = 0; i < max_channels; i++) {
			if (triggerlist[i]) {
				sr_dev_trigger_set(sdi, i, triggerlist[i]);
				g_free(triggerlist[i]);
			}
		}
		g_free(triggerlist);
	}

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

	if (opt_time) {
		if (set_limit_time(sdi) != SR_OK) {
			sr_session_destroy();
			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();
			return;
		}
		if (sr_config_list(sdi->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 (sr_config_set(sdi, NULL, SR_CONF_LIMIT_SAMPLES, gvar) != SR_OK) {
			g_critical("Failed to configure sample limit.");
			sr_session_destroy();
			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();
			return;
		}
		gvar = g_variant_new_uint64(limit_frames);
		if (sr_config_set(sdi, NULL, SR_CONF_LIMIT_FRAMES, gvar) != SR_OK) {
			g_critical("Failed to configure frame limit.");
			sr_session_destroy();
			return;
		}
	}

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

	if (opt_continuous)
		add_anykey();

	sr_session_run();

	if (opt_continuous)
		clear_anykey();

	sr_session_datafeed_callback_remove_all();
	sr_session_destroy();
	g_slist_free(devices);

}

void save_chunk_logic(uint8_t *data, uint64_t data_len, int unitsize)
{
	static uint8_t *buf = NULL;
	static int buf_len = 0;
	static int last_unitsize = 0;
	int max;

	if (!buf)
		buf = g_malloc(SAVE_CHUNK_SIZE);

	if (buf_len + data_len > SAVE_CHUNK_SIZE) {
		max = (SAVE_CHUNK_SIZE - buf_len) / unitsize * unitsize;
		memcpy(buf + buf_len, data, max);
		sr_session_append(opt_output_file, buf, unitsize,
				(buf_len + max) / unitsize);
		memcpy(buf, data + max, data_len - max);
		buf_len = data_len - max;
	} else if (data_len == 0 && last_unitsize != 0) {
		/* End of data, flush the buffer out. */
		sr_session_append(opt_output_file, buf, last_unitsize,
				buf_len / last_unitsize);
	} else {
		/* Buffer chunk. */
		memcpy(buf + buf_len, data, data_len);
		buf_len += data_len;
	}
	last_unitsize = unitsize;

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