[libsigrok.git] / src / hardware / lecroy-xstream / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2017 Sven Schnelle <svens@stackframe.org>
 *
 * 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 <stdlib.h>
#include "scpi.h"
#include "protocol.h"

static struct sr_dev_driver lecroy_xstream_driver_info;

static const char *manufacturers[] = {
	"LECROY",
};

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
};

static const uint32_t drvopts[] = {
	SR_CONF_OSCILLOSCOPE,
};

static const uint32_t devopts[] = {
	SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_SAMPLERATE | SR_CONF_GET,
	SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_NUM_HDIV | SR_CONF_GET,
	SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

static const uint32_t analog_devopts[] = {
	SR_CONF_NUM_VDIV | SR_CONF_GET,
	SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

static int check_manufacturer(const char *manufacturer)
{
	unsigned int i;

	for (i = 0; i < ARRAY_SIZE(manufacturers); i++)
		if (!strcmp(manufacturer, manufacturers[i]))
			return SR_OK;

	return SR_ERR;
}

static struct sr_dev_inst *probe_serial_device(struct sr_scpi_dev_inst *scpi)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct sr_scpi_hw_info *hw_info;

	sdi = NULL;
	devc = NULL;
	hw_info = NULL;

	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
		sr_info("Couldn't get IDN response.");
		goto fail;
	}

	if (check_manufacturer(hw_info->manufacturer) != SR_OK)
		goto fail;

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->vendor = g_strdup(hw_info->manufacturer);
	sdi->model = g_strdup(hw_info->model);
	sdi->version = g_strdup(hw_info->firmware_version);
	sdi->serial_num = g_strdup(hw_info->serial_number);
	sdi->driver = &lecroy_xstream_driver_info;
	sdi->inst_type = SR_INST_SCPI;
	sdi->conn = scpi;

	sr_scpi_hw_info_free(hw_info);
	hw_info = NULL;

	devc = g_malloc0(sizeof(struct dev_context));

	sdi->priv = devc;

	if (lecroy_xstream_init_device(sdi) != SR_OK)
		goto fail;

	return sdi;

fail:
	sr_scpi_hw_info_free(hw_info);
	sr_dev_inst_free(sdi);
	g_free(devc);

	return NULL;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	return sr_scpi_scan(di->context, options, probe_serial_device);
}

static void clear_helper(void *priv)
{
	struct dev_context *devc;

	devc = priv;

	lecroy_xstream_state_free(devc->model_state);

	g_free(devc->analog_groups);

	g_free(devc);
}

static int dev_clear(const struct sr_dev_driver *di)
{
	return std_dev_clear(di, clear_helper);
}

static int dev_open(struct sr_dev_inst *sdi)
{
	if (sdi->status != SR_ST_ACTIVE && sr_scpi_open(sdi->conn) != SR_OK)
		return SR_ERR;

	if (lecroy_xstream_state_get(sdi) != SR_OK)
		return SR_ERR;

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	if (sdi->status == SR_ST_INACTIVE)
		return SR_OK;

	sr_scpi_close(sdi->conn);

	sdi->status = SR_ST_INACTIVE;

	return SR_OK;
}

static int config_get(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	int ret;
	unsigned int i;
	struct dev_context *devc;
	const struct scope_config *model;
	struct scope_state *state;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;

	ret = SR_ERR_NA;
	model = devc->model_config;
	state = devc->model_state;
	*data = NULL;

	switch (key) {
	case SR_CONF_NUM_HDIV:
		*data = g_variant_new_int32(model->num_xdivs);
		ret = SR_OK;
		break;
	case SR_CONF_TIMEBASE:
		*data = g_variant_new("(tt)",
				model->timebases[state->timebase].p,
				model->timebases[state->timebase].q);
		ret = SR_OK;
		break;
	case SR_CONF_NUM_VDIV:
		for (i = 0; i < model->analog_channels; i++) {
			if (cg != devc->analog_groups[i])
				continue;
			*data = g_variant_new_int32(model->num_ydivs);
			ret = SR_OK;
		}
		break;
	case SR_CONF_VDIV:
		for (i = 0; i < model->analog_channels; i++) {
			if (cg != devc->analog_groups[i])
				continue;
			*data = g_variant_new("(tt)",
				model->vdivs[state->analog_channels[i].vdiv].p,
				model->vdivs[state->analog_channels[i].vdiv].q);
			ret = SR_OK;
		}
		break;
	case SR_CONF_TRIGGER_SOURCE:
		*data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
		ret = SR_OK;
		break;
	case SR_CONF_TRIGGER_SLOPE:
		*data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
		ret = SR_OK;
		break;
	case SR_CONF_HORIZ_TRIGGERPOS:
		*data = g_variant_new_double(state->horiz_triggerpos);
		ret = SR_OK;
		break;
	case SR_CONF_COUPLING:
		for (i = 0; i < model->analog_channels; i++) {
			if (cg != devc->analog_groups[i])
				continue;
			*data = g_variant_new_string((*model->coupling_options)[state->analog_channels[i].coupling]);
			ret = SR_OK;
		}
		break;
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(state->sample_rate);
		ret = SR_OK;
		break;
	case SR_CONF_ENABLED:
		*data = g_variant_new_boolean(FALSE);
		ret = SR_OK;
		break;
	default:
		ret = SR_ERR_NA;
	}

	return ret;
}

static GVariant *build_tuples(const struct sr_rational *array, unsigned int n)
{
	unsigned int i;
	GVariant *rational[2];
	GVariantBuilder gvb;

	g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);

	for (i = 0; i < n; i++) {
		rational[0] = g_variant_new_uint64(array[i].p);
		rational[1] = g_variant_new_uint64(array[i].q);

		/* FIXME: Valgrind reports a memory leak here. */
		g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
	}

	return g_variant_builder_end(&gvb);
}

static int config_set(uint32_t key, GVariant *data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	int ret;
	unsigned int i, j;
	char command[MAX_COMMAND_SIZE];
	struct dev_context *devc;
	const struct scope_config *model;
	struct scope_state *state;
	const char *tmp;
	int64_t p;
	uint64_t q;
	double tmp_d;
	gboolean update_sample_rate;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;

	model = devc->model_config;
	state = devc->model_state;
	update_sample_rate = FALSE;

	ret = SR_ERR_NA;

	switch (key) {
	case SR_CONF_LIMIT_FRAMES:
		devc->frame_limit = g_variant_get_uint64(data);
		ret = SR_OK;
		break;
	case SR_CONF_TRIGGER_SOURCE:
		tmp = g_variant_get_string(data, NULL);
		for (i = 0; (*model->trigger_sources)[i]; i++) {
			if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
				continue;
			state->trigger_source = i;
			g_snprintf(command, sizeof(command),
					"SET TRIGGER SOURCE %s",
					(*model->trigger_sources)[i]);

			ret = sr_scpi_send(sdi->conn, command);
			break;
		}
		break;
	case SR_CONF_VDIV:
		g_variant_get(data, "(tt)", &p, &q);

		for (i = 0; i < model->num_vdivs; i++) {
			if (p != model->vdivs[i].p || q != model->vdivs[i].q)
				continue;
			for (j = 1; j <= model->analog_channels; j++) {
				if (cg != devc->analog_groups[j - 1])
					continue;
				state->analog_channels[j - 1].vdiv = i;
				g_snprintf(command, sizeof(command),
						"C%d:VDIV %E", j, (float)p/q);

				if (sr_scpi_send(sdi->conn, command) != SR_OK ||
				    sr_scpi_get_opc(sdi->conn) != SR_OK)
					return SR_ERR;

				break;
			}

			ret = SR_OK;
			break;
		}
		break;
	case SR_CONF_TIMEBASE:
		g_variant_get(data, "(tt)", &p, &q);

		for (i = 0; i < model->num_timebases; i++) {
			if (p != model->timebases[i].p ||
			    q != model->timebases[i].q)
				continue;
			state->timebase = i;
			g_snprintf(command, sizeof(command),
					"TIME_DIV %E", (float)p/q);

			ret = sr_scpi_send(sdi->conn, command);
			update_sample_rate = TRUE;
			break;
		}
		break;
	case SR_CONF_HORIZ_TRIGGERPOS:
		tmp_d = g_variant_get_double(data);

		if (tmp_d < 0.0 || tmp_d > 1.0)
			return SR_ERR;

		state->horiz_triggerpos = tmp_d;
		tmp_d = -(tmp_d - 0.5) *
			((double)model->timebases[state->timebase].p /
			 model->timebases[state->timebase].q)
			 * model->num_xdivs;

		g_snprintf(command, sizeof(command), "TRIG POS %e S", tmp_d);

		ret = sr_scpi_send(sdi->conn, command);
		break;
	case SR_CONF_TRIGGER_SLOPE:
		tmp = g_variant_get_string(data, NULL);
		for (i = 0; (*model->trigger_slopes)[i]; i++) {
			if (g_strcmp0(tmp, (*model->trigger_slopes)[i]) != 0)
				continue;
			state->trigger_slope = i;
			g_snprintf(command, sizeof(command),
					"SET TRIGGER SLOPE %s",
					(*model->trigger_slopes)[i]);

			ret = sr_scpi_send(sdi->conn, command);
			break;
		}
		break;
	case SR_CONF_COUPLING:
		tmp = g_variant_get_string(data, NULL);

		for (i = 0; (*model->coupling_options)[i]; i++) {
			if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
				continue;
			for (j = 1; j <= model->analog_channels; j++) {
				if (cg != devc->analog_groups[j - 1])
					continue;
				state->analog_channels[j - 1].coupling = i;

				g_snprintf(command, sizeof(command),
						"C%d:COUPLING %s", j, tmp);

				if (sr_scpi_send(sdi->conn, command) != SR_OK ||
				    sr_scpi_get_opc(sdi->conn) != SR_OK)
					return SR_ERR;
				break;
			}

			ret = SR_OK;
			break;
		}
		break;
	default:
		ret = SR_ERR_NA;
		break;
	}

	if (ret == SR_OK)
		ret = sr_scpi_get_opc(sdi->conn);

	if (ret == SR_OK && update_sample_rate)
		ret = lecroy_xstream_update_sample_rate(sdi);

	return ret;
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc = NULL;
	const struct scope_config *model = NULL;

	(void)cg;

	/* SR_CONF_SCAN_OPTIONS is always valid, regardless of sdi or channel group. */
	if (key == SR_CONF_SCAN_OPTIONS) {
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		return SR_OK;
	}

	/* If sdi is NULL, nothing except SR_CONF_DEVICE_OPTIONS can be provided. */
	if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
		return SR_OK;
	}

        /* Every other option requires a valid device instance. */
        if (!sdi)
                return SR_ERR_ARG;

	devc = sdi->priv;
	model = devc->model_config;

	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		if (!cg) {
			/* If cg is NULL, only the SR_CONF_DEVICE_OPTIONS that are not
			 * specific to a channel group must be returned. */
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
					devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
                        return SR_OK;
		}
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
			analog_devopts, ARRAY_SIZE(analog_devopts),
			sizeof(uint32_t));
		break;
	case SR_CONF_COUPLING:
		*data = g_variant_new_strv(*model->coupling_options,
			   g_strv_length((char **)*model->coupling_options));
		break;
	case SR_CONF_TRIGGER_SOURCE:
		if (!model)
			return SR_ERR_ARG;
		*data = g_variant_new_strv(*model->trigger_sources,
			   g_strv_length((char **)*model->trigger_sources));
		break;
	case SR_CONF_TRIGGER_SLOPE:
		if (!model)
			return SR_ERR_ARG;
		*data = g_variant_new_strv(*model->trigger_slopes,
			   g_strv_length((char **)*model->trigger_slopes));
		break;
	case SR_CONF_TIMEBASE:
		if (!model)
			return SR_ERR_ARG;
		*data = build_tuples(model->timebases, model->num_timebases);
		break;
	case SR_CONF_VDIV:
		if (!model)
			return SR_ERR_ARG;
		*data = build_tuples(model->vdivs, model->num_vdivs);
		break;
	default:
		return SR_ERR_NA;
	}
	return SR_OK;
}

SR_PRIV int lecroy_xstream_request_data(const struct sr_dev_inst *sdi)
{
	char command[MAX_COMMAND_SIZE];
	struct sr_channel *ch;
	struct dev_context *devc;

	devc = sdi->priv;

	ch = devc->current_channel->data;

	if (ch->type != SR_CHANNEL_ANALOG)
		return SR_ERR;

	g_snprintf(command, sizeof(command),
		"COMM_FORMAT DEF9,WORD,BIN;C%d:WAVEFORM?", ch->index + 1);
	return sr_scpi_send(sdi->conn, command);
}

static int setup_channels(const struct sr_dev_inst *sdi)
{
	GSList *l;
	gboolean setup_changed;
	char command[MAX_COMMAND_SIZE];
	struct scope_state *state;
	struct sr_channel *ch;
	struct dev_context *devc;
	struct sr_scpi_dev_inst *scpi;

	devc = sdi->priv;
	scpi = sdi->conn;
	state = devc->model_state;
	setup_changed = FALSE;

	for (l = sdi->channels; l; l = l->next) {
		ch = l->data;
		switch (ch->type) {
		case SR_CHANNEL_ANALOG:
			if (ch->enabled == state->analog_channels[ch->index].state)
				break;
			g_snprintf(command, sizeof(command), "C%d:TRACE %s",
				   ch->index + 1, ch->enabled ? "ON" : "OFF");

			if (sr_scpi_send(scpi, command) != SR_OK)
				return SR_ERR;
			state->analog_channels[ch->index].state = ch->enabled;
			setup_changed = TRUE;
			break;
		default:
			return SR_ERR;
		}
	}

	if (setup_changed && lecroy_xstream_update_sample_rate(sdi) != SR_OK)
		return SR_ERR;

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	GSList *l;
	struct sr_channel *ch;
	struct dev_context *devc;
	int ret;
	struct sr_scpi_dev_inst *scpi;

	devc = sdi->priv;
	scpi = sdi->conn;
	/* Preset empty results. */
	g_slist_free(devc->enabled_channels);
	devc->enabled_channels = NULL;

	/*
	 * Contruct the list of enabled channels. Determine the highest
	 * number of digital pods involved in the acquisition.
	 */

	for (l = sdi->channels; l; l = l->next) {
		ch = l->data;
		if (!ch->enabled)
			continue;
		/* Only add a single digital channel per group (pod). */
		devc->enabled_channels = g_slist_append(
			devc->enabled_channels, ch);
	}

	if (!devc->enabled_channels)
		return SR_ERR;

	/*
	 * Configure the analog channels and the
	 * corresponding digital pods.
	 */
	if (setup_channels(sdi) != SR_OK) {
		sr_err("Failed to setup channel configuration!");
		ret = SR_ERR;
		goto free_enabled;
	}

	/*
	 * Start acquisition on the first enabled channel. The
	 * receive routine will continue driving the acquisition.
	 */
	sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
			lecroy_xstream_receive_data, (void *)sdi);

	std_session_send_df_header(sdi);

	devc->current_channel = devc->enabled_channels;

	return lecroy_xstream_request_data(sdi);

free_enabled:
	g_slist_free(devc->enabled_channels);
	devc->enabled_channels = NULL;

	return ret;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_scpi_dev_inst *scpi;

	std_session_send_df_end(sdi);

	devc = sdi->priv;

	devc->num_frames = 0;
	g_slist_free(devc->enabled_channels);
	devc->enabled_channels = NULL;
	scpi = sdi->conn;
	sr_scpi_source_remove(sdi->session, scpi);

	return SR_OK;
}

static struct sr_dev_driver lecroy_xstream_driver_info = {
	.name = "lecroy-xstream",
	.longname = "LeCroy X-Stream",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = dev_clear,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(lecroy_xstream_driver_info);
Commit	Line	Data
e3b83c5e SS	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2017 Sven Schnelle <svens@stackframe.org>
	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
	20	#include <config.h>
3f2c7c94 SS	21	#include <stdlib.h>
3f2c7c94 SS	22	#include "scpi.h"
e3b83c5e SS	23	#include "protocol.h"
e3b83c5e SS	24
3f2c7c94 SS	25	static struct sr_dev_driver lecroy_xstream_driver_info;
	26
	27	static const char *manufacturers[] = {
	28	"LECROY",
	29	};
	30
	31	static const uint32_t scanopts[] = {
	32	SR_CONF_CONN,
	33	};
	34
90230cfa SA	35	static const uint32_t drvopts[] = {
	36	SR_CONF_OSCILLOSCOPE,
	37	};
	38
	39	static const uint32_t devopts[] = {
	40	SR_CONF_LIMIT_FRAMES \| SR_CONF_GET \| SR_CONF_SET,
86621306	41	SR_CONF_SAMPLERATE \| SR_CONF_GET,
90230cfa SA	42	SR_CONF_TIMEBASE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
90230cfa SA	43	SR_CONF_NUM_HDIV \| SR_CONF_GET,
90230cfa	44	SR_CONF_HORIZ_TRIGGERPOS \| SR_CONF_GET \| SR_CONF_SET,
86621306 UH	45	SR_CONF_TRIGGER_SOURCE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
86621306 UH	46	SR_CONF_TRIGGER_SLOPE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
90230cfa SA	47	};
	48
	49	static const uint32_t analog_devopts[] = {
	50	SR_CONF_NUM_VDIV \| SR_CONF_GET,
90230cfa	51	SR_CONF_VDIV \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
86621306	52	SR_CONF_COUPLING \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
90230cfa SA	53	};
90230cfa SA	54
3f2c7c94 SS	55	static int check_manufacturer(const char *manufacturer)
	56	{
	57	unsigned int i;
	58
	59	for (i = 0; i < ARRAY_SIZE(manufacturers); i++)
	60	if (!strcmp(manufacturer, manufacturers[i]))
	61	return SR_OK;
	62
	63	return SR_ERR;
	64	}
	65
	66	static struct sr_dev_inst probe_serial_device(struct sr_scpi_dev_inst scpi)
	67	{
	68	struct sr_dev_inst *sdi;
	69	struct dev_context *devc;
	70	struct sr_scpi_hw_info *hw_info;
	71
	72	sdi = NULL;
	73	devc = NULL;
	74	hw_info = NULL;
	75
3f2c7c94 SS	76	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
	77	sr_info("Couldn't get IDN response.");
	78	goto fail;
	79	}
	80
	81	if (check_manufacturer(hw_info->manufacturer) != SR_OK)
	82	goto fail;
	83
	84	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	85	sdi->vendor = g_strdup(hw_info->manufacturer);
	86	sdi->model = g_strdup(hw_info->model);
	87	sdi->version = g_strdup(hw_info->firmware_version);
	88	sdi->serial_num = g_strdup(hw_info->serial_number);
	89	sdi->driver = &lecroy_xstream_driver_info;
	90	sdi->inst_type = SR_INST_SCPI;
	91	sdi->conn = scpi;
	92
	93	sr_scpi_hw_info_free(hw_info);
	94	hw_info = NULL;
	95
	96	devc = g_malloc0(sizeof(struct dev_context));
	97
	98	sdi->priv = devc;
	99
	100	if (lecroy_xstream_init_device(sdi) != SR_OK)
	101	goto fail;
	102
	103	return sdi;
	104
	105	fail:
	106	sr_scpi_hw_info_free(hw_info);
4bf93988	107	sr_dev_inst_free(sdi);
3f2c7c94 SS	108	g_free(devc);
	109
	110	return NULL;
	111	}
e3b83c5e SS	112
	113	static GSList scan(struct sr_dev_driver di, GSList *options)
	114	{
3f2c7c94 SS	115	return sr_scpi_scan(di->context, options, probe_serial_device);
	116	}
	117
	118	static void clear_helper(void *priv)
	119	{
	120	struct dev_context *devc;
e3b83c5e	121
3f2c7c94	122	devc = priv;
e3b83c5e	123
3f2c7c94	124	lecroy_xstream_state_free(devc->model_state);
e3b83c5e	125
3f2c7c94	126	g_free(devc->analog_groups);
e3b83c5e	127
3f2c7c94	128	g_free(devc);
e3b83c5e SS	129	}
	130
	131	static int dev_clear(const struct sr_dev_driver *di)
	132	{
3f2c7c94	133	return std_dev_clear(di, clear_helper);
e3b83c5e SS	134	}
	135
	136	static int dev_open(struct sr_dev_inst *sdi)
	137	{
3f2c7c94 SS	138	if (sdi->status != SR_ST_ACTIVE && sr_scpi_open(sdi->conn) != SR_OK)
3f2c7c94 SS	139	return SR_ERR;
e3b83c5e	140
3f2c7c94 SS	141	if (lecroy_xstream_state_get(sdi) != SR_OK)
3f2c7c94 SS	142	return SR_ERR;
e3b83c5e SS	143
	144	sdi->status = SR_ST_ACTIVE;
	145
	146	return SR_OK;
	147	}
	148
	149	static int dev_close(struct sr_dev_inst *sdi)
	150	{
3f2c7c94 SS	151	if (sdi->status == SR_ST_INACTIVE)
3f2c7c94 SS	152	return SR_OK;
e3b83c5e	153
3f2c7c94	154	sr_scpi_close(sdi->conn);
e3b83c5e SS	155
	156	sdi->status = SR_ST_INACTIVE;
	157
	158	return SR_OK;
	159	}
	160
	161	static int config_get(uint32_t key, GVariant **data,
ea257cdc	162	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
e3b83c5e SS	163	{
e3b83c5e SS	164	int ret;
3f2c7c94 SS	165	unsigned int i;
	166	struct dev_context *devc;
	167	const struct scope_config *model;
	168	struct scope_state *state;
e3b83c5e	169
3f2c7c94 SS	170	if (!sdi)
	171	return SR_ERR_ARG;
	172
	173	devc = sdi->priv;
e3b83c5e	174
3f2c7c94 SS	175	ret = SR_ERR_NA;
	176	model = devc->model_config;
	177	state = devc->model_state;
	178	*data = NULL;
ea257cdc	179
e3b83c5e	180	switch (key) {
3f2c7c94 SS	181	case SR_CONF_NUM_HDIV:
	182	*data = g_variant_new_int32(model->num_xdivs);
	183	ret = SR_OK;
	184	break;
	185	case SR_CONF_TIMEBASE:
	186	*data = g_variant_new("(tt)",
ea257cdc UH	187	model->timebases[state->timebase].p,
ea257cdc UH	188	model->timebases[state->timebase].q);
3f2c7c94 SS	189	ret = SR_OK;
	190	break;
	191	case SR_CONF_NUM_VDIV:
	192	for (i = 0; i < model->analog_channels; i++) {
	193	if (cg != devc->analog_groups[i])
	194	continue;
	195	*data = g_variant_new_int32(model->num_ydivs);
	196	ret = SR_OK;
	197	}
	198	break;
	199	case SR_CONF_VDIV:
	200	for (i = 0; i < model->analog_channels; i++) {
	201	if (cg != devc->analog_groups[i])
	202	continue;
	203	*data = g_variant_new("(tt)",
ea257cdc UH	204	model->vdivs[state->analog_channels[i].vdiv].p,
ea257cdc UH	205	model->vdivs[state->analog_channels[i].vdiv].q);
3f2c7c94 SS	206	ret = SR_OK;
	207	}
	208	break;
	209	case SR_CONF_TRIGGER_SOURCE:
	210	data = g_variant_new_string((model->trigger_sources)[state->trigger_source]);
	211	ret = SR_OK;
	212	break;
	213	case SR_CONF_TRIGGER_SLOPE:
	214	data = g_variant_new_string((model->trigger_slopes)[state->trigger_slope]);
	215	ret = SR_OK;
	216	break;
	217	case SR_CONF_HORIZ_TRIGGERPOS:
	218	*data = g_variant_new_double(state->horiz_triggerpos);
	219	ret = SR_OK;
	220	break;
	221	case SR_CONF_COUPLING:
3f2c7c94	222	for (i = 0; i < model->analog_channels; i++) {
ea257cdc	223	if (cg != devc->analog_groups[i])
3f2c7c94	224	continue;
3f2c7c94 SS	225	data = g_variant_new_string((model->coupling_options)[state->analog_channels[i].coupling]);
	226	ret = SR_OK;
	227	}
	228	break;
	229	case SR_CONF_SAMPLERATE:
	230	*data = g_variant_new_uint64(state->sample_rate);
	231	ret = SR_OK;
	232	break;
	233	case SR_CONF_ENABLED:
	234	*data = g_variant_new_boolean(FALSE);
	235	ret = SR_OK;
	236	break;
e3b83c5e	237	default:
3f2c7c94	238	ret = SR_ERR_NA;
e3b83c5e	239	}
ea257cdc	240
e3b83c5e SS	241	return ret;
	242	}
	243
3f2c7c94 SS	244	static GVariant build_tuples(const struct sr_rational array, unsigned int n)
	245	{
	246	unsigned int i;
	247	GVariant *rational[2];
	248	GVariantBuilder gvb;
	249
	250	g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
	251
	252	for (i = 0; i < n; i++) {
	253	rational[0] = g_variant_new_uint64(array[i].p);
	254	rational[1] = g_variant_new_uint64(array[i].q);
	255
	256	/* FIXME: Valgrind reports a memory leak here. */
	257	g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
	258	}
	259
	260	return g_variant_builder_end(&gvb);
	261	}
	262
ea257cdc UH	263	static int config_set(uint32_t key, GVariant *data,
ea257cdc UH	264	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
e3b83c5e SS	265	{
e3b83c5e SS	266	int ret;
3f2c7c94 SS	267	unsigned int i, j;
	268	char command[MAX_COMMAND_SIZE];
	269	struct dev_context *devc;
	270	const struct scope_config *model;
	271	struct scope_state *state;
	272	const char *tmp;
	273	int64_t p;
	274	uint64_t q;
	275	double tmp_d;
	276	gboolean update_sample_rate;
e3b83c5e	277
3f2c7c94 SS	278	if (!sdi)
3f2c7c94 SS	279	return SR_ERR_ARG;
e3b83c5e	280
3f2c7c94 SS	281	devc = sdi->priv;
	282
	283	model = devc->model_config;
	284	state = devc->model_state;
	285	update_sample_rate = FALSE;
	286
	287	ret = SR_ERR_NA;
e3b83c5e	288
e3b83c5e	289	switch (key) {
3f2c7c94 SS	290	case SR_CONF_LIMIT_FRAMES:
	291	devc->frame_limit = g_variant_get_uint64(data);
	292	ret = SR_OK;
	293	break;
	294	case SR_CONF_TRIGGER_SOURCE:
	295	tmp = g_variant_get_string(data, NULL);
	296	for (i = 0; (*model->trigger_sources)[i]; i++) {
	297	if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
	298	continue;
	299	state->trigger_source = i;
	300	g_snprintf(command, sizeof(command),
	301	"SET TRIGGER SOURCE %s",
	302	(*model->trigger_sources)[i]);
	303
	304	ret = sr_scpi_send(sdi->conn, command);
	305	break;
	306	}
	307	break;
	308	case SR_CONF_VDIV:
	309	g_variant_get(data, "(tt)", &p, &q);
	310
	311	for (i = 0; i < model->num_vdivs; i++) {
	312	if (p != model->vdivs[i].p \|\| q != model->vdivs[i].q)
	313	continue;
	314	for (j = 1; j <= model->analog_channels; j++) {
	315	if (cg != devc->analog_groups[j - 1])
	316	continue;
	317	state->analog_channels[j - 1].vdiv = i;
	318	g_snprintf(command, sizeof(command),
	319	"C%d:VDIV %E", j, (float)p/q);
	320
	321	if (sr_scpi_send(sdi->conn, command) != SR_OK \|\|
	322	sr_scpi_get_opc(sdi->conn) != SR_OK)
	323	return SR_ERR;
	324
	325	break;
	326	}
	327
	328	ret = SR_OK;
	329	break;
	330	}
	331	break;
	332	case SR_CONF_TIMEBASE:
	333	g_variant_get(data, "(tt)", &p, &q);
	334
	335	for (i = 0; i < model->num_timebases; i++) {
	336	if (p != model->timebases[i].p \|\|
	337	q != model->timebases[i].q)
	338	continue;
	339	state->timebase = i;
	340	g_snprintf(command, sizeof(command),
	341	"TIME_DIV %E", (float)p/q);
	342
	343	ret = sr_scpi_send(sdi->conn, command);
	344	update_sample_rate = TRUE;
	345	break;
	346	}
	347	break;
	348	case SR_CONF_HORIZ_TRIGGERPOS:
	349	tmp_d = g_variant_get_double(data);
	350
	351	if (tmp_d < 0.0 \|\| tmp_d > 1.0)
	352	return SR_ERR;
	353
354	state->horiz_triggerpos = tmp_d;
355	tmp_d = -(tmp_d - 0.5) *
356	((double)model->timebases[state->timebase].p /
357	model->timebases[state->timebase].q)
358	* model->num_xdivs;
359
360	g_snprintf(command, sizeof(command), "TRIG POS %e S", tmp_d);
361
362	ret = sr_scpi_send(sdi->conn, command);
363	break;
364	case SR_CONF_TRIGGER_SLOPE:
365	tmp = g_variant_get_string(data, NULL);
366	for (i = 0; (*model->trigger_slopes)[i]; i++) {
367	if (g_strcmp0(tmp, (*model->trigger_slopes)[i]) != 0)
368	continue;
369	state->trigger_slope = i;
370	g_snprintf(command, sizeof(command),
371	"SET TRIGGER SLOPE %s",
372	(*model->trigger_slopes)[i]);
373
374	ret = sr_scpi_send(sdi->conn, command);
375	break;
376	}
377	break;
378	case SR_CONF_COUPLING:
3f2c7c94 SS	379	tmp = g_variant_get_string(data, NULL);
	380
	381	for (i = 0; (*model->coupling_options)[i]; i++) {
	382	if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
	383	continue;
	384	for (j = 1; j <= model->analog_channels; j++) {
	385	if (cg != devc->analog_groups[j - 1])
	386	continue;
ea257cdc	387	state->analog_channels[j - 1].coupling = i;
3f2c7c94 SS	388
	389	g_snprintf(command, sizeof(command),
	390	"C%d:COUPLING %s", j, tmp);
	391
	392	if (sr_scpi_send(sdi->conn, command) != SR_OK \|\|
	393	sr_scpi_get_opc(sdi->conn) != SR_OK)
	394	return SR_ERR;
	395	break;
	396	}
	397
	398	ret = SR_OK;
	399	break;
	400	}
	401	break;
e3b83c5e SS	402	default:
e3b83c5e SS	403	ret = SR_ERR_NA;
3f2c7c94	404	break;
e3b83c5e SS	405	}
e3b83c5e SS	406
3f2c7c94 SS	407	if (ret == SR_OK)
	408	ret = sr_scpi_get_opc(sdi->conn);
	409
	410	if (ret == SR_OK && update_sample_rate)
	411	ret = lecroy_xstream_update_sample_rate(sdi);
	412
e3b83c5e SS	413	return ret;
	414	}
	415
ea257cdc UH	416	static int config_list(uint32_t key, GVariant **data,
ea257cdc UH	417	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
e3b83c5e	418	{
3f2c7c94 SS	419	struct dev_context *devc = NULL;
3f2c7c94 SS	420	const struct scope_config *model = NULL;
ea257cdc	421
e3b83c5e SS	422	(void)cg;
e3b83c5e SS	423
90230cfa SA	424	/* SR_CONF_SCAN_OPTIONS is always valid, regardless of sdi or channel group. */
	425	if (key == SR_CONF_SCAN_OPTIONS) {
	426	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	427	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	428	return SR_OK;
3f2c7c94 SS	429	}
3f2c7c94 SS	430
90230cfa SA	431	/* If sdi is NULL, nothing except SR_CONF_DEVICE_OPTIONS can be provided. */
90230cfa SA	432	if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
3f2c7c94	433	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
90230cfa SA	434	drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
	435	return SR_OK;
	436	}
	437
	438	/* Every other option requires a valid device instance. */
	439	if (!sdi)
	440	return SR_ERR_ARG;
	441
	442	devc = sdi->priv;
	443	model = devc->model_config;
	444
	445	switch (key) {
3f2c7c94 SS	446	case SR_CONF_DEVICE_OPTIONS:
3f2c7c94 SS	447	if (!cg) {
90230cfa SA	448	/* If cg is NULL, only the SR_CONF_DEVICE_OPTIONS that are not
90230cfa SA	449	* specific to a channel group must be returned. */
3f2c7c94	450	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
90230cfa SA	451	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
90230cfa SA	452	return SR_OK;
3f2c7c94 SS	453	}
3f2c7c94 SS	454	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
90230cfa	455	analog_devopts, ARRAY_SIZE(analog_devopts),
ea257cdc	456	sizeof(uint32_t));
3f2c7c94 SS	457	break;
	458	case SR_CONF_COUPLING:
	459	data = g_variant_new_strv(model->coupling_options,
	460	g_strv_length((char *)model->coupling_options));
	461	break;
	462	case SR_CONF_TRIGGER_SOURCE:
	463	if (!model)
	464	return SR_ERR_ARG;
	465	data = g_variant_new_strv(model->trigger_sources,
	466	g_strv_length((char *)model->trigger_sources));
	467	break;
	468	case SR_CONF_TRIGGER_SLOPE:
	469	if (!model)
	470	return SR_ERR_ARG;
	471	data = g_variant_new_strv(model->trigger_slopes,
	472	g_strv_length((char *)model->trigger_slopes));
	473	break;
	474	case SR_CONF_TIMEBASE:
	475	if (!model)
	476	return SR_ERR_ARG;
	477	*data = build_tuples(model->timebases, model->num_timebases);
	478	break;
	479	case SR_CONF_VDIV:
	480	if (!model)
	481	return SR_ERR_ARG;
	482	*data = build_tuples(model->vdivs, model->num_vdivs);
	483	break;
e3b83c5e SS	484	default:
	485	return SR_ERR_NA;
	486	}
3f2c7c94 SS	487	return SR_OK;
3f2c7c94 SS	488	}
e3b83c5e	489
3f2c7c94 SS	490	SR_PRIV int lecroy_xstream_request_data(const struct sr_dev_inst *sdi)
	491	{
	492	char command[MAX_COMMAND_SIZE];
	493	struct sr_channel *ch;
	494	struct dev_context *devc;
	495
	496	devc = sdi->priv;
	497
	498	ch = devc->current_channel->data;
	499
	500	if (ch->type != SR_CHANNEL_ANALOG)
	501	return SR_ERR;
	502
	503	g_snprintf(command, sizeof(command),
ea257cdc	504	"COMM_FORMAT DEF9,WORD,BIN;C%d:WAVEFORM?", ch->index + 1);
3f2c7c94 SS	505	return sr_scpi_send(sdi->conn, command);
	506	}
	507
6d13a46c	508	static int setup_channels(const struct sr_dev_inst *sdi)
3f2c7c94 SS	509	{
	510	GSList *l;
	511	gboolean setup_changed;
	512	char command[MAX_COMMAND_SIZE];
	513	struct scope_state *state;
	514	struct sr_channel *ch;
	515	struct dev_context *devc;
	516	struct sr_scpi_dev_inst *scpi;
	517
	518	devc = sdi->priv;
	519	scpi = sdi->conn;
	520	state = devc->model_state;
	521	setup_changed = FALSE;
	522
	523	for (l = sdi->channels; l; l = l->next) {
	524	ch = l->data;
	525	switch (ch->type) {
	526	case SR_CHANNEL_ANALOG:
	527	if (ch->enabled == state->analog_channels[ch->index].state)
	528	break;
	529	g_snprintf(command, sizeof(command), "C%d:TRACE %s",
ea257cdc	530	ch->index + 1, ch->enabled ? "ON" : "OFF");
3f2c7c94 SS	531
	532	if (sr_scpi_send(scpi, command) != SR_OK)
	533	return SR_ERR;
	534	state->analog_channels[ch->index].state = ch->enabled;
	535	setup_changed = TRUE;
	536	break;
	537	default:
	538	return SR_ERR;
	539	}
	540	}
	541
	542	if (setup_changed && lecroy_xstream_update_sample_rate(sdi) != SR_OK)
	543	return SR_ERR;
	544
	545	return SR_OK;
e3b83c5e SS	546	}
	547
	548	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	549	{
3f2c7c94 SS	550	GSList *l;
	551	struct sr_channel *ch;
	552	struct dev_context *devc;
	553	int ret;
	554	struct sr_scpi_dev_inst *scpi;
	555
3f2c7c94 SS	556	devc = sdi->priv;
	557	scpi = sdi->conn;
	558	/* Preset empty results. */
	559	g_slist_free(devc->enabled_channels);
	560	devc->enabled_channels = NULL;
	561
	562	/*
	563	* Contruct the list of enabled channels. Determine the highest
	564	* number of digital pods involved in the acquisition.
	565	*/
	566
	567	for (l = sdi->channels; l; l = l->next) {
	568	ch = l->data;
	569	if (!ch->enabled)
	570	continue;
	571	/* Only add a single digital channel per group (pod). */
	572	devc->enabled_channels = g_slist_append(
	573	devc->enabled_channels, ch);
	574	}
e3b83c5e	575
3f2c7c94 SS	576	if (!devc->enabled_channels)
	577	return SR_ERR;
	578
	579	/*
	580	* Configure the analog channels and the
	581	* corresponding digital pods.
	582	*/
6d13a46c	583	if (setup_channels(sdi) != SR_OK) {
3f2c7c94 SS	584	sr_err("Failed to setup channel configuration!");
	585	ret = SR_ERR;
	586	goto free_enabled;
	587	}
	588
	589	/*
	590	* Start acquisition on the first enabled channel. The
	591	* receive routine will continue driving the acquisition.
	592	*/
	593	sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
	594	lecroy_xstream_receive_data, (void *)sdi);
	595
	596	std_session_send_df_header(sdi);
	597
	598	devc->current_channel = devc->enabled_channels;
	599
	600	return lecroy_xstream_request_data(sdi);
	601
	602	free_enabled:
	603	g_slist_free(devc->enabled_channels);
	604	devc->enabled_channels = NULL;
ea257cdc	605
3f2c7c94	606	return ret;
e3b83c5e SS	607	}
	608
	609	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	610	{
3f2c7c94 SS	611	struct dev_context *devc;
	612	struct sr_scpi_dev_inst *scpi;
	613
	614	std_session_send_df_end(sdi);
	615
3f2c7c94 SS	616	devc = sdi->priv;
	617
	618	devc->num_frames = 0;
	619	g_slist_free(devc->enabled_channels);
	620	devc->enabled_channels = NULL;
	621	scpi = sdi->conn;
	622	sr_scpi_source_remove(sdi->session, scpi);
e3b83c5e SS	623
	624	return SR_OK;
	625	}
	626
3f2c7c94	627	static struct sr_dev_driver lecroy_xstream_driver_info = {
e3b83c5e	628	.name = "lecroy-xstream",
bb08570f	629	.longname = "LeCroy X-Stream",
e3b83c5e SS	630	.api_version = 1,
	631	.init = std_init,
	632	.cleanup = std_cleanup,
	633	.scan = scan,
	634	.dev_list = std_dev_list,
	635	.dev_clear = dev_clear,
	636	.config_get = config_get,
	637	.config_set = config_set,
	638	.config_list = config_list,
	639	.dev_open = dev_open,
	640	.dev_close = dev_close,
	641	.dev_acquisition_start = dev_acquisition_start,
	642	.dev_acquisition_stop = dev_acquisition_stop,
	643	.context = NULL,
	644	};
e3b83c5e	645	SR_REGISTER_DEV_DRIVER(lecroy_xstream_driver_info);