[libsigrok.git] / src / hardware / lecroy-xstream / protocol.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 <math.h>
#include <stdlib.h>
#include "scpi.h"
#include "protocol.h"

SR_PRIV void lecroy_queue_logic_data(struct dev_context *devc,
				  size_t group, GByteArray *pod_data);
SR_PRIV void lecroy_send_logic_packet(struct sr_dev_inst *sdi,
				   struct dev_context *devc);
SR_PRIV void lecroy_cleanup_logic_data(struct dev_context *devc);

struct lecroy_wavedesc_2_x {
	uint16_t comm_type;
	uint16_t comm_order; /* 1 - little endian */
	uint32_t wave_descriptor_length;
	uint32_t user_text_len;
	uint32_t res_desc1;
	uint32_t trigtime_array_length;
	uint32_t ris_time1_array_length;
	uint32_t res_array1;
	uint32_t wave_array1_length;
	uint32_t wave_array2_length;
	uint32_t wave_array3_length;
	uint32_t wave_array4_length;
	char instrument_name[16];
	uint32_t instrument_number;
	char trace_label[16];
	uint32_t reserved;
	uint32_t wave_array_count;
	uint32_t points_per_screen;
	uint32_t first_valid_point;
	uint32_t last_valid_point;
	uint32_t first_point;
	uint32_t sparsing_factor;
	uint32_t segment_index;
	uint32_t subarray_count;
	uint32_t sweeps_per_acq;
	uint16_t points_per_pair;
	uint16_t pair_offset;
	float vertical_gain;
	float vertical_offset;
	float max_value;
	float min_value;
	uint16_t nominal_bits;
	uint16_t nom_subarray_count;
	float horiz_interval;
	double horiz_offset;
	double pixel_offset;
	char vertunit[48];
	char horunit[48];
	uint32_t reserved1;
	double trigger_time;
} __attribute__((packed));

struct lecroy_wavedesc {
	char descriptor_name[16];
	char template_name[16];
	union {
		struct lecroy_wavedesc_2_x version_2_x;
	};
} __attribute__((packed));

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

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

static const char *lecroy_coupling_options[] = {
	"A1M", // AC with 1 MOhm termination
	"D50",  // DC with 50 Ohm termination
	"D1M", // DC with 1 MOhm termination
	"GND",
	"OVL",
	NULL,
};

static const char *scope_trigger_slopes[] = {
	"POS",
	"NEG",
	NULL,
};

static const char *lecroy_xstream_trigger_sources[] = {
	"C1",
	"C2",
	"C3",
	"C4",
	"LINE",
	"EXT",
	NULL,
};

static const struct sr_rational lecroy_timebases[] = {
	/* picoseconds */
	{ 20, 1000000000000 },
	{ 50, 1000000000000 },
	{ 100, 1000000000000 },
	{ 200, 1000000000000 },
	{ 500, 1000000000000 },
	/* nanoseconds */
	{ 1, 1000000000 },
	{ 2, 1000000000 },
	{ 5, 1000000000 },
	{ 10, 1000000000 },
	{ 20, 1000000000 },
	{ 50, 1000000000 },
	{ 100, 1000000000 },
	{ 200, 1000000000 },
	{ 500, 1000000000 },
	/* microseconds */
	{ 1, 1000000 },
	{ 2, 1000000 },
	{ 5, 1000000 },
	{ 10, 1000000 },
	{ 20, 1000000 },
	{ 50, 1000000 },
	{ 100, 1000000 },
	{ 200, 1000000 },
	{ 500, 1000000 },
	/* milliseconds */
	{ 1, 1000 },
	{ 2, 1000 },
	{ 5, 1000 },
	{ 10, 1000 },
	{ 20, 1000 },
	{ 50, 1000 },
	{ 100, 1000 },
	{ 200, 1000 },
	{ 500, 1000 },
	/* seconds */
	{ 1, 1 },
	{ 2, 1 },
	{ 5, 1 },
	{ 10, 1 },
	{ 20, 1 },
	{ 50, 1 },
	{ 100, 1 },
	{ 200, 1 },
	{ 500, 1 },
	{ 1000, 1 },
};

static const struct sr_rational lecroy_vdivs[] = {
	/* millivolts */
	{ 1, 1000 },
	{ 2, 1000 },
	{ 5, 1000 },
	{ 10, 1000 },
	{ 20, 1000 },
	{ 50, 1000 },
	{ 100, 1000 },
	{ 200, 1000 },
	{ 500, 1000 },
	/* volts */
	{ 1, 1 },
	{ 2, 1 },
	{ 5, 1 },
	{ 10, 1 },
	{ 20, 1 },
	{ 50, 1 },
};

static const char *scope_analog_channel_names[] = {
	"CH1",
	"CH2",
	"CH3",
	"CH4",
};

static const struct scope_config scope_models[] = {
	{
		.name = { "WP7000", "WP7100", "WP7200", "WP7300" },

		.analog_channels = 4,
		.analog_names = &scope_analog_channel_names,

		.devopts = &lecroy_devopts,
		.num_devopts = ARRAY_SIZE(lecroy_devopts),

		.analog_devopts = &lecroy_analog_devopts,
		.num_analog_devopts = ARRAY_SIZE(lecroy_analog_devopts),

		.coupling_options = &lecroy_coupling_options,
		.trigger_sources = &lecroy_xstream_trigger_sources,
		.trigger_slopes = &scope_trigger_slopes,

		.timebases = lecroy_timebases,
		.num_timebases = ARRAY_SIZE(lecroy_timebases),

		.vdivs = lecroy_vdivs,
		.num_vdivs = ARRAY_SIZE(lecroy_vdivs),

		.num_xdivs = 10,
		.num_ydivs = 8,
	},
};

static void scope_state_dump(const struct scope_config *config,
			     struct scope_state *state)
{
	unsigned int i;
	char *tmp;

	for (i = 0; i < config->analog_channels; i++) {
		tmp = sr_voltage_string(config->vdivs[state->analog_channels[i].vdiv].p,
					config->vdivs[state->analog_channels[i].vdiv].q);
		sr_info("State of analog channel %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
			i + 1, state->analog_channels[i].state ? "On" : "Off",
			(*config->coupling_options)[state->analog_channels[i].coupling],
			tmp, state->analog_channels[i].vertical_offset);
	}

	tmp = sr_period_string_f(1.0/(((float)config->timebases[state->timebase].p) /
				      ((float)config->timebases[state->timebase].q)), 0);
	sr_info("Current timebase: %s", tmp);
	g_free(tmp);

	tmp = sr_samplerate_string(state->sample_rate);
	sr_info("Current samplerate: %s", tmp);
	g_free(tmp);

	sr_info("Current trigger: %s (source), %s (slope) %.2f (offset)",
		(*config->trigger_sources)[state->trigger_source],
		(*config->trigger_slopes)[state->trigger_slope],
		state->horiz_triggerpos);
}

static int scope_state_get_array_option(const char *resp,
					const char *(*array)[],
					int *result)
{
	unsigned int i;

	for (i = 0; (*array)[i]; i++) {
		if (!g_strcmp0(resp, (*array)[i])) {
			*result = i;
			return SR_OK;
		}
	}

	return SR_ERR;
}

/**
 * This function takes a value of the form "2.000E-03" and returns the index
 * of an array where a matching pair was found.
 *
 * @param value The string to be parsed.
 * @param array The array of s/f pairs.
 * @param array_len The number of pairs in the array.
 * @param result The index at which a matching pair was found.
 *
 * @return SR_ERR on any parsing error, SR_OK otherwise.
 */
static int array_float_get(gchar *value, const struct sr_rational *aval,
		int array_len, unsigned int *result)
{
	struct sr_rational rval;

	if (sr_parse_rational(value, &rval) != SR_OK)
		return SR_ERR;

	for (int i = 0; i < array_len; i++) {
		if (sr_rational_eq(&rval, aval+i)) {
			*result = i;
			return SR_OK;
		}
	}

	return SR_ERR;
}

static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
				    const struct scope_config *config,
				    struct scope_state *state)
{
	unsigned int i, j;
	char command[MAX_COMMAND_SIZE];
	char *tmp_str;

	for (i = 0; i < config->analog_channels; i++) {
		g_snprintf(command, sizeof(command), "C%d:TRACE?", i+1);

		if (sr_scpi_get_bool(scpi, command,
					&state->analog_channels[i].state) != SR_OK)
			return SR_ERR;

		g_snprintf(command, sizeof(command), "C%d:VDIV?", i+1);

		if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
			return SR_ERR;

                if (array_float_get(tmp_str, lecroy_vdivs, ARRAY_SIZE(lecroy_vdivs),
				    &j) != SR_OK) {
			g_free(tmp_str);
			sr_err("Could not determine array index for vertical div scale.");
			return SR_ERR;
		}

		g_free(tmp_str);
		state->analog_channels[i].vdiv = j;

		g_snprintf(command, sizeof(command), "C%d:OFFSET?", i+1);

		if (sr_scpi_get_float(scpi, command, &state->analog_channels[i].vertical_offset) != SR_OK)
			return SR_ERR;

		g_snprintf(command, sizeof(command), "C%d:COUPLING?", i+1);

		if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
			return SR_ERR;


		if (scope_state_get_array_option(tmp_str, config->coupling_options,
					 &state->analog_channels[i].coupling) != SR_OK)
			return SR_ERR;

		g_free(tmp_str);
	}

	return SR_OK;
}

SR_PRIV int lecroy_xstream_update_sample_rate(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct scope_state *state;
	const struct scope_config *config;
	float memsize, timediv;

	devc = sdi->priv;
	state = devc->model_state;
	config = devc->model_config;

	if (sr_scpi_get_float(sdi->conn, "MEMORY_SIZE?", &memsize) != SR_OK)
			return SR_ERR;

	if (sr_scpi_get_float(sdi->conn, "TIME_DIV?", &timediv) != SR_OK)
		return SR_ERR;

	state->sample_rate = 1/((timediv * config->num_xdivs) / memsize);

	return SR_OK;
}

SR_PRIV int lecroy_xstream_state_get(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct scope_state *state
;	const struct scope_config *config;
	unsigned int i;
	char *tmp_str, *tmp_str2, *tmpp, *p, *key;
	char command[MAX_COMMAND_SIZE];
	char *trig_source = NULL;

	devc = sdi->priv;
	config = devc->model_config;
	state = devc->model_state;

	sr_info("Fetching scope state");

	if (analog_channel_state_get(sdi->conn, config, state) != SR_OK)
		return SR_ERR;

	if (sr_scpi_get_string(sdi->conn, "TIME_DIV?", &tmp_str) != SR_OK)
		return SR_ERR;

	if (array_float_get(tmp_str, lecroy_timebases, ARRAY_SIZE(lecroy_timebases),
			    &i) != SR_OK) {
		g_free(tmp_str);
		sr_err("Could not determine array index for timbase scale.");
		return SR_ERR;
	}
	g_free(tmp_str);
	state->timebase = i;

	if (sr_scpi_get_string(sdi->conn, "TRIG_SELECT?", &tmp_str) != SR_OK)
		return SR_ERR;

	tmp_str2 = tmp_str;
	i = 0;
	while((p = strtok_r(tmp_str2, ",", &tmpp))) {
		tmp_str2 = NULL;
		if (i == 0) {
			/* trigger type */
		} else if (i & 1) {
			key = p;
			/* key */
		} else if (!(i & 1)) {
			if (!strcmp(key, "SR"))
				trig_source = p;
		}
		i++;
	}

	if (!trig_source || scope_state_get_array_option(trig_source, config->trigger_sources,
							&state->trigger_source) != SR_OK)
		return SR_ERR;


	g_snprintf(command, sizeof(command), "%s:TRIG_SLOPE?", trig_source);
	if (sr_scpi_get_string(sdi->conn, command, &tmp_str) != SR_OK)
		return SR_ERR;

	if (scope_state_get_array_option(tmp_str,
		config->trigger_slopes, &state->trigger_slope) != SR_OK)
		return SR_ERR;

	if (sr_scpi_get_float(sdi->conn, "TRIG_DELAY?",	&state->horiz_triggerpos) != SR_OK)
		return SR_ERR;

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

	sr_info("Fetching finished.");

	scope_state_dump(config, state);

	return SR_OK;
}

static struct scope_state *scope_state_new(const struct scope_config *config)
{
	struct scope_state *state;

	state = g_malloc0(sizeof(struct scope_state));
	state->analog_channels = g_malloc0_n(config->analog_channels,
			sizeof(struct analog_channel_state));
	return state;
}

SR_PRIV void lecroy_xstream_state_free(struct scope_state *state)
{
	g_free(state->analog_channels);
	g_free(state);
}

SR_PRIV int lecroy_xstream_init_device(struct sr_dev_inst *sdi)
{
	char command[MAX_COMMAND_SIZE];
	int model_index;
	unsigned int i, j;
	struct sr_channel *ch;
	struct dev_context *devc;
	gboolean channel_enabled;

	devc = sdi->priv;
	model_index = -1;

	/* Find the exact model. */
	for (i = 0; i < ARRAY_SIZE(scope_models); i++) {
		for (j = 0; scope_models[i].name[j]; j++) {
			if (!strcmp(sdi->model, scope_models[i].name[j])) {
				model_index = i;
				break;
			}
		}
		if (model_index != -1)
			break;
	}

	if (model_index == -1) {
		sr_dbg("Unsupported LECROY device.");
		return SR_ERR_NA;
	}

	devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group*) *
					scope_models[model_index].analog_channels);

	/* Add analog channels. */
	for (i = 0; i < scope_models[model_index].analog_channels; i++) {

		g_snprintf(command, sizeof(command), "C%d:TRACE?", i+1);

		if (sr_scpi_get_bool(sdi->conn, command, &channel_enabled) != SR_OK)
			return SR_ERR;

		g_snprintf(command, sizeof(command), "C%d:VDIV?", i+1);

		ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, channel_enabled,
			   (*scope_models[model_index].analog_names)[i]);

		devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));

		devc->analog_groups[i]->name = g_strdup(
			(char *)(*scope_models[model_index].analog_names)[i]);
		devc->analog_groups[i]->channels = g_slist_append(NULL, ch);

		sdi->channel_groups = g_slist_append(sdi->channel_groups,
						   devc->analog_groups[i]);
	}

	devc->model_config = &scope_models[model_index];
	devc->frame_limit = 0;

	if (!(devc->model_state = scope_state_new(devc->model_config)))
		return SR_ERR_MALLOC;

	/* Set the desired response mode. */
	sr_scpi_send(sdi->conn, "COMM_HEADER OFF,WORD,BIN");

	return SR_OK;
}

static int lecroy_waveform_2_x_to_analog(GByteArray *data,
					 struct lecroy_wavedesc *desc,
					 struct sr_datafeed_analog *analog)
{
	struct sr_analog_encoding *encoding = analog->encoding;
	struct sr_analog_meaning *meaning = analog->meaning;
	struct sr_analog_spec *spec = analog->spec;
	float *data_float;
	int16_t *waveform_data;
	unsigned int i, num_samples;

	data_float  = g_malloc(desc->version_2_x.wave_array_count * sizeof(float));
	num_samples = desc->version_2_x.wave_array_count;

	waveform_data = (int16_t *)(data->data +
				    + desc->version_2_x.wave_descriptor_length
				    + desc->version_2_x.user_text_len);

	for(i = 0; i  < num_samples; i++)
		data_float[i] = (float)waveform_data[i]
			* desc->version_2_x.vertical_gain
			+ desc->version_2_x.vertical_offset;


	analog->data = data_float;
	analog->num_samples = num_samples;

	encoding->unitsize = sizeof(float);
	encoding->is_signed = TRUE;
	encoding->is_float = TRUE;
	encoding->is_bigendian = FALSE;
	encoding->scale.p = 1;
	encoding->scale.q = 1;
	encoding->offset.p = 0;
	encoding->offset.q = 1;

	encoding->digits = 6;
	encoding->is_digits_decimal = FALSE;

	if (strcmp(desc->version_2_x.vertunit, "A")) {
		meaning->mq = SR_MQ_CURRENT;
		meaning->unit = SR_UNIT_AMPERE;
	} else {
		/* default to voltage */
		meaning->mq = SR_MQ_VOLTAGE;
		meaning->unit = SR_UNIT_VOLT;
	}

	meaning->mqflags = 0;
	spec->spec_digits = 3;
	return SR_OK;
}

static int lecroy_waveform_to_analog(GByteArray *data,
				     struct sr_datafeed_analog *analog)
{
	struct lecroy_wavedesc *desc;

	if (data->len < sizeof(struct lecroy_wavedesc))
		return SR_ERR;

	desc = (struct lecroy_wavedesc *)data->data;

	if (!strncmp(desc->template_name, "LECROY_2_2", 16) ||
	    !strncmp(desc->template_name, "LECROY_2_3", 16)) {
		return lecroy_waveform_2_x_to_analog(data, desc, analog);
	}

	sr_err("Waveformat template '%.16s' not supported\n", desc->template_name);
	return SR_ERR;
}

SR_PRIV int lecroy_xstream_receive_data(int fd, int revents, void *cb_data)
{
	struct sr_channel *ch;
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct sr_datafeed_packet packet;
	GByteArray *data;
	struct sr_datafeed_analog analog;
	struct sr_analog_encoding encoding;
	struct sr_analog_meaning meaning;
	struct sr_analog_spec spec;
	char buf[8];
	(void)fd;
	(void)revents;

	data = NULL;

	if (!(sdi = cb_data))
		return TRUE;

	if (!(devc = sdi->priv))
		return TRUE;

	ch = devc->current_channel->data;

	/*
	 * Send "frame begin" packet upon reception of data for the
	 * first enabled channel.
	 */
	if (devc->current_channel == devc->enabled_channels) {
		packet.type = SR_DF_FRAME_BEGIN;
		sr_session_send(sdi, &packet);
	}

	if (ch->type != SR_CHANNEL_ANALOG)
		return SR_ERR;
	/*
	 * Pass on the received data of the channel(s).
	 */
	if (sr_scpi_read_data(sdi->conn, buf, 4) != 4) {
		sr_err("reading header failed\n");
		return TRUE;
	}

	if (sr_scpi_get_block(sdi->conn, NULL, &data) != SR_OK) {
		if (data)
			g_byte_array_free(data, TRUE);
		return TRUE;
	}

	analog.encoding = &encoding;
	analog.meaning = &meaning;
	analog.spec = &spec;

	if (lecroy_waveform_to_analog(data, &analog) != SR_OK)
		return SR_ERR;

	meaning.channels = g_slist_append(NULL, ch);
	packet.payload = &analog;
	packet.type = SR_DF_ANALOG;
	sr_session_send(sdi, &packet);

	g_byte_array_free(data, TRUE);
	data = NULL;

	g_slist_free(meaning.channels);
	g_free(analog.data);


	/*
	 * Advance to the next enabled channel. When data for all enabled
	 * channels was received, then flush potentially queued logic data,
	 * and send the "frame end" packet.
	 */
	if (devc->current_channel->next) {
		devc->current_channel = devc->current_channel->next;
		lecroy_xstream_request_data(sdi);
		return TRUE;
	}

	packet.type = SR_DF_FRAME_END;
	sr_session_send(sdi, &packet);

	/*
	 * End of frame was reached. Stop acquisition after the specified
	 * number of frames, or continue reception by starting over at
	 * the first enabled channel.
	 */
	if (++devc->num_frames == devc->frame_limit) {
		sdi->driver->dev_acquisition_stop(sdi);
	} else {
		devc->current_channel = devc->enabled_channels;
		lecroy_xstream_request_data(sdi);
	}

	return TRUE;
}
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 <math.h>
	22	#include <stdlib.h>
	23	#include "scpi.h"
e3b83c5e SS	24	#include "protocol.h"
e3b83c5e SS	25
3f2c7c94 SS	26	SR_PRIV void lecroy_queue_logic_data(struct dev_context *devc,
	27	size_t group, GByteArray *pod_data);
	28	SR_PRIV void lecroy_send_logic_packet(struct sr_dev_inst *sdi,
	29	struct dev_context *devc);
	30	SR_PRIV void lecroy_cleanup_logic_data(struct dev_context *devc);
	31
	32	struct lecroy_wavedesc_2_x {
	33	uint16_t comm_type;
	34	uint16_t comm_order; /* 1 - little endian */
	35	uint32_t wave_descriptor_length;
	36	uint32_t user_text_len;
	37	uint32_t res_desc1;
	38	uint32_t trigtime_array_length;
	39	uint32_t ris_time1_array_length;
	40	uint32_t res_array1;
	41	uint32_t wave_array1_length;
	42	uint32_t wave_array2_length;
	43	uint32_t wave_array3_length;
	44	uint32_t wave_array4_length;
	45	char instrument_name[16];
	46	uint32_t instrument_number;
	47	char trace_label[16];
	48	uint32_t reserved;
	49	uint32_t wave_array_count;
	50	uint32_t points_per_screen;
	51	uint32_t first_valid_point;
	52	uint32_t last_valid_point;
	53	uint32_t first_point;
	54	uint32_t sparsing_factor;
	55	uint32_t segment_index;
	56	uint32_t subarray_count;
	57	uint32_t sweeps_per_acq;
	58	uint16_t points_per_pair;
	59	uint16_t pair_offset;
	60	float vertical_gain;
	61	float vertical_offset;
	62	float max_value;
	63	float min_value;
	64	uint16_t nominal_bits;
	65	uint16_t nom_subarray_count;
	66	float horiz_interval;
	67	double horiz_offset;
	68	double pixel_offset;
	69	char vertunit[48];
	70	char horunit[48];
	71	uint32_t reserved1;
	72	double trigger_time;
	73	} __attribute__((packed));
	74
	75	struct lecroy_wavedesc {
	76	char descriptor_name[16];
	77	char template_name[16];
	78	union {
	79	struct lecroy_wavedesc_2_x version_2_x;
	80	};
	81	} __attribute__((packed));
	82
	83	static const uint32_t lecroy_devopts[] = {
	84	SR_CONF_OSCILLOSCOPE,
	85	SR_CONF_LIMIT_FRAMES \| SR_CONF_GET \| SR_CONF_SET,
	86	SR_CONF_TRIGGER_SOURCE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	87	SR_CONF_TIMEBASE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	88	SR_CONF_NUM_HDIV \| SR_CONF_GET,
	89	SR_CONF_TRIGGER_SLOPE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
90	SR_CONF_HORIZ_TRIGGERPOS \| SR_CONF_GET \| SR_CONF_SET,
91	SR_CONF_SAMPLERATE \| SR_CONF_GET,
92	};
93
94	static const uint32_t lecroy_analog_devopts[] = {
95	SR_CONF_NUM_VDIV \| SR_CONF_GET,
96	SR_CONF_COUPLING \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
97	SR_CONF_VDIV \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
98	};
99
100	static const char *lecroy_coupling_options[] = {
101	"A1M", // AC with 1 MOhm termination
102	"D50", // DC with 50 Ohm termination
103	"D1M", // DC with 1 MOhm termination
104	"GND",
105	"OVL",
106	NULL,
107	};
108
109	static const char *scope_trigger_slopes[] = {
110	"POS",
111	"NEG",
112	NULL,
113	};
114
115	static const char *lecroy_xstream_trigger_sources[] = {
116	"C1",
117	"C2",
118	"C3",
119	"C4",
120	"LINE",
121	"EXT",
122	NULL,
123	};
124
125	static const struct sr_rational lecroy_timebases[] = {
126	/* picoseconds */
127	{ 20, 1000000000000 },
128	{ 50, 1000000000000 },
129	{ 100, 1000000000000 },
130	{ 200, 1000000000000 },
131	{ 500, 1000000000000 },
132	/* nanoseconds */
133	{ 1, 1000000000 },
134	{ 2, 1000000000 },
135	{ 5, 1000000000 },
136	{ 10, 1000000000 },
137	{ 20, 1000000000 },
138	{ 50, 1000000000 },
139	{ 100, 1000000000 },
140	{ 200, 1000000000 },
141	{ 500, 1000000000 },
142	/* microseconds */
143	{ 1, 1000000 },
144	{ 2, 1000000 },
145	{ 5, 1000000 },
146	{ 10, 1000000 },
147	{ 20, 1000000 },
148	{ 50, 1000000 },
149	{ 100, 1000000 },
150	{ 200, 1000000 },
151	{ 500, 1000000 },
152	/* milliseconds */
153	{ 1, 1000 },
154	{ 2, 1000 },
155	{ 5, 1000 },
156	{ 10, 1000 },
157	{ 20, 1000 },
158	{ 50, 1000 },
159	{ 100, 1000 },
160	{ 200, 1000 },
161	{ 500, 1000 },
162	/* seconds */
163	{ 1, 1 },
164	{ 2, 1 },
165	{ 5, 1 },
166	{ 10, 1 },
167	{ 20, 1 },
168	{ 50, 1 },
169	{ 100, 1 },
170	{ 200, 1 },
171	{ 500, 1 },
172	{ 1000, 1 },
173	};
174
175	static const struct sr_rational lecroy_vdivs[] = {
176	/* millivolts */
177	{ 1, 1000 },
178	{ 2, 1000 },
179	{ 5, 1000 },
180	{ 10, 1000 },
181	{ 20, 1000 },
182	{ 50, 1000 },
183	{ 100, 1000 },
184	{ 200, 1000 },
185	{ 500, 1000 },
186	/* volts */
187	{ 1, 1 },
188	{ 2, 1 },
189	{ 5, 1 },
190	{ 10, 1 },
191	{ 20, 1 },
192	{ 50, 1 },
193	};
194
195	static const char *scope_analog_channel_names[] = {
196	"CH1",
197	"CH2",
198	"CH3",
199	"CH4",
200	};
201
202	static const struct scope_config scope_models[] = {
203	{
204	.name = { "WP7000", "WP7100", "WP7200", "WP7300" },
205
206	.analog_channels = 4,
207	.analog_names = &scope_analog_channel_names,
208
209	.devopts = &lecroy_devopts,
210	.num_devopts = ARRAY_SIZE(lecroy_devopts),
211
212	.analog_devopts = &lecroy_analog_devopts,
213	.num_analog_devopts = ARRAY_SIZE(lecroy_analog_devopts),
214
215	.coupling_options = &lecroy_coupling_options,
216	.trigger_sources = &lecroy_xstream_trigger_sources,
217	.trigger_slopes = &scope_trigger_slopes,
218
219	.timebases = lecroy_timebases,
220	.num_timebases = ARRAY_SIZE(lecroy_timebases),
221
222	.vdivs = lecroy_vdivs,
223	.num_vdivs = ARRAY_SIZE(lecroy_vdivs),
224
225	.num_xdivs = 10,
226	.num_ydivs = 8,
227	},
228	};
229
230	static void scope_state_dump(const struct scope_config *config,
231	struct scope_state *state)
232	{
233	unsigned int i;
234	char *tmp;
235
236	for (i = 0; i < config->analog_channels; i++) {
237	tmp = sr_voltage_string(config->vdivs[state->analog_channels[i].vdiv].p,
238	config->vdivs[state->analog_channels[i].vdiv].q);
239	sr_info("State of analog channel %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
240	i + 1, state->analog_channels[i].state ? "On" : "Off",
241	(*config->coupling_options)[state->analog_channels[i].coupling],
242	tmp, state->analog_channels[i].vertical_offset);
243	}
244
245	tmp = sr_period_string_f(1.0/(((float)config->timebases[state->timebase].p) /
246	((float)config->timebases[state->timebase].q)), 0);
247	sr_info("Current timebase: %s", tmp);
248	g_free(tmp);
249
250	tmp = sr_samplerate_string(state->sample_rate);
251	sr_info("Current samplerate: %s", tmp);
252	g_free(tmp);
253
254	sr_info("Current trigger: %s (source), %s (slope) %.2f (offset)",
255	(*config->trigger_sources)[state->trigger_source],
256	(*config->trigger_slopes)[state->trigger_slope],
257	state->horiz_triggerpos);
258	}
259
260	static int scope_state_get_array_option(const char *resp,
261	const char (array)[],
262	int *result)
263	{
264	unsigned int i;
265
266	for (i = 0; (*array)[i]; i++) {
267	if (!g_strcmp0(resp, (*array)[i])) {
268	*result = i;
269	return SR_OK;
270	}
271	}
272
273	return SR_ERR;
274	}
275
276	/**
277	* This function takes a value of the form "2.000E-03" and returns the index
278	* of an array where a matching pair was found.
279	*
280	* @param value The string to be parsed.
281	* @param array The array of s/f pairs.
282	* @param array_len The number of pairs in the array.
283	* @param result The index at which a matching pair was found.
284	*
285	* @return SR_ERR on any parsing error, SR_OK otherwise.
286	*/
287	static int array_float_get(gchar value, const struct sr_rational aval,
288	int array_len, unsigned int *result)
289	{
290	struct sr_rational rval;
291
292	if (sr_parse_rational(value, &rval) != SR_OK)
293	return SR_ERR;
294
295	for (int i = 0; i < array_len; i++) {
296	if (sr_rational_eq(&rval, aval+i)) {
297	*result = i;
298	return SR_OK;
299	}
300	}
301
302	return SR_ERR;
303	}
304
305	static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
306	const struct scope_config *config,
307	struct scope_state *state)
308	{
309	unsigned int i, j;
310	char command[MAX_COMMAND_SIZE];
311	char *tmp_str;
312
313	for (i = 0; i < config->analog_channels; i++) {
314	g_snprintf(command, sizeof(command), "C%d:TRACE?", i+1);
315
316	if (sr_scpi_get_bool(scpi, command,
317	&state->analog_channels[i].state) != SR_OK)
318	return SR_ERR;
319
320	g_snprintf(command, sizeof(command), "C%d:VDIV?", i+1);
321
322	if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
323	return SR_ERR;
324
325	if (array_float_get(tmp_str, lecroy_vdivs, ARRAY_SIZE(lecroy_vdivs),
326	&j) != SR_OK) {
327	g_free(tmp_str);
328	sr_err("Could not determine array index for vertical div scale.");
329	return SR_ERR;
330	}
331
332	g_free(tmp_str);
333	state->analog_channels[i].vdiv = j;
334
335	g_snprintf(command, sizeof(command), "C%d:OFFSET?", i+1);
336
337	if (sr_scpi_get_float(scpi, command, &state->analog_channels[i].vertical_offset) != SR_OK)
338	return SR_ERR;
339
340	g_snprintf(command, sizeof(command), "C%d:COUPLING?", i+1);
341
342	if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
343	return SR_ERR;
344
345
346	if (scope_state_get_array_option(tmp_str, config->coupling_options,
347	&state->analog_channels[i].coupling) != SR_OK)
348	return SR_ERR;
349
350	g_free(tmp_str);
351	}
352
353	return SR_OK;
354	}
355
356	SR_PRIV int lecroy_xstream_update_sample_rate(const struct sr_dev_inst *sdi)
e3b83c5e	357	{
e3b83c5e	358	struct dev_context *devc;
3f2c7c94 SS	359	struct scope_state *state;
	360	const struct scope_config *config;
	361	float memsize, timediv;
	362
	363	devc = sdi->priv;
	364	state = devc->model_state;
	365	config = devc->model_config;
	366
	367	if (sr_scpi_get_float(sdi->conn, "MEMORY_SIZE?", &memsize) != SR_OK)
	368	return SR_ERR;
	369
	370	if (sr_scpi_get_float(sdi->conn, "TIME_DIV?", &timediv) != SR_OK)
	371	return SR_ERR;
	372
	373	state->sample_rate = 1/((timediv * config->num_xdivs) / memsize);
	374
	375	return SR_OK;
	376	}
	377
	378	SR_PRIV int lecroy_xstream_state_get(struct sr_dev_inst *sdi)
	379	{
	380	struct dev_context *devc;
	381	struct scope_state *state
	382	; const struct scope_config *config;
	383	unsigned int i;
	384	char tmp_str, tmp_str2, tmpp, p, *key;
	385	char command[MAX_COMMAND_SIZE];
	386	char *trig_source = NULL;
	387
	388	devc = sdi->priv;
	389	config = devc->model_config;
	390	state = devc->model_state;
	391
	392	sr_info("Fetching scope state");
	393
	394	if (analog_channel_state_get(sdi->conn, config, state) != SR_OK)
	395	return SR_ERR;
	396
	397	if (sr_scpi_get_string(sdi->conn, "TIME_DIV?", &tmp_str) != SR_OK)
	398	return SR_ERR;
	399
	400	if (array_float_get(tmp_str, lecroy_timebases, ARRAY_SIZE(lecroy_timebases),
	401	&i) != SR_OK) {
	402	g_free(tmp_str);
	403	sr_err("Could not determine array index for timbase scale.");
	404	return SR_ERR;
	405	}
	406	g_free(tmp_str);
	407	state->timebase = i;
	408
	409	if (sr_scpi_get_string(sdi->conn, "TRIG_SELECT?", &tmp_str) != SR_OK)
	410	return SR_ERR;
	411
	412	tmp_str2 = tmp_str;
	413	i = 0;
	414	while((p = strtok_r(tmp_str2, ",", &tmpp))) {
	415	tmp_str2 = NULL;
	416	if (i == 0) {
	417	/* trigger type */
	418	} else if (i & 1) {
	419	key = p;
	420	/* key */
	421	} else if (!(i & 1)) {
	422	if (!strcmp(key, "SR"))
423	trig_source = p;
424	}
425	i++;
426	}
427
428	if (!trig_source \|\| scope_state_get_array_option(trig_source, config->trigger_sources,
429	&state->trigger_source) != SR_OK)
430	return SR_ERR;
431
e3b83c5e	432
3f2c7c94 SS	433	g_snprintf(command, sizeof(command), "%s:TRIG_SLOPE?", trig_source);
	434	if (sr_scpi_get_string(sdi->conn, command, &tmp_str) != SR_OK)
	435	return SR_ERR;
	436
	437	if (scope_state_get_array_option(tmp_str,
	438	config->trigger_slopes, &state->trigger_slope) != SR_OK)
	439	return SR_ERR;
	440
	441	if (sr_scpi_get_float(sdi->conn, "TRIG_DELAY?", &state->horiz_triggerpos) != SR_OK)
	442	return SR_ERR;
	443
	444	if (lecroy_xstream_update_sample_rate(sdi) != SR_OK)
	445	return SR_ERR;
	446
	447	sr_info("Fetching finished.");
	448
	449	scope_state_dump(config, state);
	450
	451	return SR_OK;
	452	}
	453
	454	static struct scope_state scope_state_new(const struct scope_config config)
	455	{
	456	struct scope_state *state;
	457
	458	state = g_malloc0(sizeof(struct scope_state));
	459	state->analog_channels = g_malloc0_n(config->analog_channels,
	460	sizeof(struct analog_channel_state));
	461	return state;
	462	}
	463
	464	SR_PRIV void lecroy_xstream_state_free(struct scope_state *state)
	465	{
	466	g_free(state->analog_channels);
	467	g_free(state);
	468	}
	469
	470	SR_PRIV int lecroy_xstream_init_device(struct sr_dev_inst *sdi)
	471	{
	472	char command[MAX_COMMAND_SIZE];
	473	int model_index;
	474	unsigned int i, j;
	475	struct sr_channel *ch;
	476	struct dev_context *devc;
	477	gboolean channel_enabled;
	478
	479	devc = sdi->priv;
	480	model_index = -1;
	481
	482	/* Find the exact model. */
	483	for (i = 0; i < ARRAY_SIZE(scope_models); i++) {
	484	for (j = 0; scope_models[i].name[j]; j++) {
	485	if (!strcmp(sdi->model, scope_models[i].name[j])) {
	486	model_index = i;
	487	break;
	488	}
	489	}
	490	if (model_index != -1)
	491	break;
	492	}
	493
	494	if (model_index == -1) {
	495	sr_dbg("Unsupported LECROY device.");
	496	return SR_ERR_NA;
497	}
498
499	devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group)
500	scope_models[model_index].analog_channels);
501
502	/* Add analog channels. */
503	for (i = 0; i < scope_models[model_index].analog_channels; i++) {
504
505	g_snprintf(command, sizeof(command), "C%d:TRACE?", i+1);
506
507	if (sr_scpi_get_bool(sdi->conn, command, &channel_enabled) != SR_OK)
508	return SR_ERR;
509
510	g_snprintf(command, sizeof(command), "C%d:VDIV?", i+1);
511
512	ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, channel_enabled,
513	(*scope_models[model_index].analog_names)[i]);
514
515	devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
516
517	devc->analog_groups[i]->name = g_strdup(
518	(char )(scope_models[model_index].analog_names)[i]);
519	devc->analog_groups[i]->channels = g_slist_append(NULL, ch);
520
521	sdi->channel_groups = g_slist_append(sdi->channel_groups,
522	devc->analog_groups[i]);
523	}
524
525	devc->model_config = &scope_models[model_index];
526	devc->frame_limit = 0;
527
528	if (!(devc->model_state = scope_state_new(devc->model_config)))
529	return SR_ERR_MALLOC;
530
d0b913ea SA	531	/* Set the desired response mode. */
	532	sr_scpi_send(sdi->conn, "COMM_HEADER OFF,WORD,BIN");
	533
3f2c7c94 SS	534	return SR_OK;
	535	}
	536
	537	static int lecroy_waveform_2_x_to_analog(GByteArray *data,
	538	struct lecroy_wavedesc *desc,
	539	struct sr_datafeed_analog *analog)
	540	{
	541	struct sr_analog_encoding *encoding = analog->encoding;
	542	struct sr_analog_meaning *meaning = analog->meaning;
	543	struct sr_analog_spec *spec = analog->spec;
	544	float *data_float;
	545	int16_t *waveform_data;
	546	unsigned int i, num_samples;
	547
	548	data_float = g_malloc(desc->version_2_x.wave_array_count * sizeof(float));
	549	num_samples = desc->version_2_x.wave_array_count;
	550
	551	waveform_data = (int16_t *)(data->data +
	552	+ desc->version_2_x.wave_descriptor_length
	553	+ desc->version_2_x.user_text_len);
	554
	555	for(i = 0; i < num_samples; i++)
	556	data_float[i] = (float)waveform_data[i]
	557	* desc->version_2_x.vertical_gain
	558	+ desc->version_2_x.vertical_offset;
	559
	560
	561	analog->data = data_float;
	562	analog->num_samples = num_samples;
	563
	564	encoding->unitsize = sizeof(float);
	565	encoding->is_signed = TRUE;
	566	encoding->is_float = TRUE;
	567	encoding->is_bigendian = FALSE;
	568	encoding->scale.p = 1;
	569	encoding->scale.q = 1;
	570	encoding->offset.p = 0;
	571	encoding->offset.q = 1;
	572
	573	encoding->digits = 6;
	574	encoding->is_digits_decimal = FALSE;
	575
	576	if (strcmp(desc->version_2_x.vertunit, "A")) {
	577	meaning->mq = SR_MQ_CURRENT;
	578	meaning->unit = SR_UNIT_AMPERE;
	579	} else {
	580	/* default to voltage */
	581	meaning->mq = SR_MQ_VOLTAGE;
	582	meaning->unit = SR_UNIT_VOLT;
	583	}
	584
	585	meaning->mqflags = 0;
	586	spec->spec_digits = 3;
	587	return SR_OK;
	588	}
	589
	590	static int lecroy_waveform_to_analog(GByteArray *data,
	591	struct sr_datafeed_analog *analog)
	592	{
	593	struct lecroy_wavedesc *desc;
	594
	595	if (data->len < sizeof(struct lecroy_wavedesc))
	596	return SR_ERR;
	597
598	desc = (struct lecroy_wavedesc *)data->data;
599
600	if (!strncmp(desc->template_name, "LECROY_2_2", 16) \|\|
601	!strncmp(desc->template_name, "LECROY_2_3", 16)) {
602	return lecroy_waveform_2_x_to_analog(data, desc, analog);
603	}
604
605	sr_err("Waveformat template '%.16s' not supported\n", desc->template_name);
606	return SR_ERR;
607	}
608
609	SR_PRIV int lecroy_xstream_receive_data(int fd, int revents, void *cb_data)
610	{
611	struct sr_channel *ch;
612	struct sr_dev_inst *sdi;
613	struct dev_context *devc;
614	struct sr_datafeed_packet packet;
615	GByteArray *data;
616	struct sr_datafeed_analog analog;
617	struct sr_analog_encoding encoding;
618	struct sr_analog_meaning meaning;
619	struct sr_analog_spec spec;
620	char buf[8];
e3b83c5e	621	(void)fd;
3f2c7c94 SS	622	(void)revents;
	623
	624	data = NULL;
e3b83c5e SS	625
	626	if (!(sdi = cb_data))
	627	return TRUE;
	628
	629	if (!(devc = sdi->priv))
	630	return TRUE;
	631
3f2c7c94 SS	632	ch = devc->current_channel->data;
	633
	634	/*
	635	* Send "frame begin" packet upon reception of data for the
	636	* first enabled channel.
	637	*/
	638	if (devc->current_channel == devc->enabled_channels) {
	639	packet.type = SR_DF_FRAME_BEGIN;
	640	sr_session_send(sdi, &packet);
	641	}
	642
	643	if (ch->type != SR_CHANNEL_ANALOG)
	644	return SR_ERR;
	645	/*
	646	* Pass on the received data of the channel(s).
	647	*/
	648	if (sr_scpi_read_data(sdi->conn, buf, 4) != 4) {
	649	sr_err("reading header failed\n");
	650	return TRUE;
	651	}
	652
	653	if (sr_scpi_get_block(sdi->conn, NULL, &data) != SR_OK) {
	654	if (data)
	655	g_byte_array_free(data, TRUE);
	656	return TRUE;
	657	}
	658
	659	analog.encoding = &encoding;
	660	analog.meaning = &meaning;
	661	analog.spec = &spec;
	662
	663	if (lecroy_waveform_to_analog(data, &analog) != SR_OK)
	664	return SR_ERR;
	665
	666	meaning.channels = g_slist_append(NULL, ch);
	667	packet.payload = &analog;
	668	packet.type = SR_DF_ANALOG;
	669	sr_session_send(sdi, &packet);
	670
	671	g_byte_array_free(data, TRUE);
	672	data = NULL;
	673
	674	g_slist_free(meaning.channels);
	675	g_free(analog.data);
	676
	677
	678	/*
	679	* Advance to the next enabled channel. When data for all enabled
	680	* channels was received, then flush potentially queued logic data,
	681	* and send the "frame end" packet.
	682	*/
	683	if (devc->current_channel->next) {
	684	devc->current_channel = devc->current_channel->next;
	685	lecroy_xstream_request_data(sdi);
	686	return TRUE;
	687	}
	688
	689	packet.type = SR_DF_FRAME_END;
	690	sr_session_send(sdi, &packet);
	691
	692	/*
	693	* End of frame was reached. Stop acquisition after the specified
	694	* number of frames, or continue reception by starting over at
	695	* the first enabled channel.
696	*/
697	if (++devc->num_frames == devc->frame_limit) {
698	sdi->driver->dev_acquisition_stop(sdi);
699	} else {
700	devc->current_channel = devc->enabled_channels;
701	lecroy_xstream_request_data(sdi);
e3b83c5e SS	702	}
	703
	704	return TRUE;
	705	}