[libsigrok.git] / src / hardware / yokogawa-dlm / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2014 abraxa (Soeren Apel) <soeren@apelpie.net>
 * Based on the Hameg HMO driver by poljar (Damir Jelić) <poljarinho@gmail.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 <stdlib.h>
#include "protocol.h"

SR_PRIV struct sr_dev_driver yokogawa_dlm_driver_info;
static struct sr_dev_driver *di = &yokogawa_dlm_driver_info;

static char *MANUFACTURER_ID = "YOKOGAWA";
static char *MANUFACTURER_NAME = "Yokogawa";

enum {
	CG_INVALID = -1,
	CG_NONE,
	CG_ANALOG,
	CG_DIGITAL,
};

static int init(struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static struct sr_dev_inst *probe_usbtmc_device(struct sr_scpi_dev_inst *scpi)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct sr_scpi_hw_info *hw_info;
	char *model_name;
	int model_index;

	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 (strcmp(hw_info->manufacturer, MANUFACTURER_ID) != 0)
		goto fail;

	if (dlm_model_get(hw_info->model, &model_name, &model_index) != SR_OK)
		goto fail;

	if (!(sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, MANUFACTURER_NAME,
				    model_name, NULL)))
		goto fail;

	sr_scpi_hw_info_free(hw_info);
	hw_info = NULL;

	if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
		goto fail;

	sdi->driver = di;
	sdi->priv = devc;
	sdi->inst_type = SR_INST_SCPI;
	sdi->conn = scpi;

	if (dlm_device_init(sdi, model_index) != SR_OK)
		goto fail;

	sr_scpi_close(sdi->conn);

	sdi->status = SR_ST_INACTIVE;
	return sdi;

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

	return NULL;
}

static GSList *scan(GSList *options)
{
	return sr_scpi_scan(di->priv, options, probe_usbtmc_device);
}

static GSList *dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

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

	devc = priv;

	dlm_scope_state_destroy(devc->model_state);

	g_free(devc->analog_groups);
	g_free(devc->digital_groups);
	g_free(devc);
}

static int dev_clear(void)
{
	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 (dlm_scope_state_query(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 cleanup(void)
{
	dev_clear();

	return SR_OK;
}

/**
 * Check which category a given channel group belongs to.
 *
 * @param devc Our internal device context.
 * @param cg   The channel group to check.
 *
 * @retval CG_NONE    cg is NULL
 * @retval CG_ANALOG  cg is an analog group
 * @retval CG_DIGITAL cg is a digital group
 * @retval CG_INVALID cg is something else
 */
static int check_channel_group(struct dev_context *devc,
			     const struct sr_channel_group *cg)
{
	unsigned int i;
	struct scope_config *model;

	model = devc->model_config;

	if (!cg)
		return CG_NONE;

	for (i = 0; i < model->analog_channels; ++i)
		if (cg == devc->analog_groups[i])
			return CG_ANALOG;

	for (i = 0; i < model->pods; ++i)
		if (cg == devc->digital_groups[i])
			return CG_DIGITAL;

	sr_err("Invalid channel group specified.");
	return CG_INVALID;
}

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

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

	if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
		return SR_ERR;

	ret = SR_ERR_NA;
	model = devc->model_config;
	state = devc->model_state;

	switch (key) {
	case SR_CONF_NUM_TIMEBASE:
		*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][0],
				      (*model->timebases)[state->timebase][1]);
		ret = SR_OK;
		break;
	case SR_CONF_NUM_VDIV:
		if (cg_type == CG_NONE) {
			sr_err("No channel group specified.");
			return SR_ERR_CHANNEL_GROUP;
		} else if (cg_type == CG_ANALOG) {
				*data = g_variant_new_int32(model->num_ydivs);
				ret = SR_OK;
				break;
		} else {
			ret = SR_ERR_NA;
		}
		break;
	case SR_CONF_VDIV:
		ret = SR_ERR_NA;
		if (cg_type == CG_NONE) {
			sr_err("No channel group specified.");
			return SR_ERR_CHANNEL_GROUP;
		} else if (cg_type != CG_ANALOG)
			break;

		for (i = 0; i < model->analog_channels; ++i) {
			if (cg != devc->analog_groups[i])
				continue;
			*data = g_variant_new("(tt)",
					      (*model->vdivs)[state->analog_states[i].vdiv][0],
					      (*model->vdivs)[state->analog_states[i].vdiv][1]);
			ret = SR_OK;
			break;
		}
		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:
		ret = SR_ERR_NA;
		if (cg_type == CG_NONE) {
			sr_err("No channel group specified.");
			return SR_ERR_CHANNEL_GROUP;
		} else if (cg_type != CG_ANALOG)
			break;

		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_states[i].coupling]);
			ret = SR_OK;
			break;
		}
		break;
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(state->sample_rate);
		ret = SR_OK;
		break;
	default:
		ret = SR_ERR_NA;
	}

	return ret;
}

static GVariant *build_tuples(const uint64_t (*array)[][2], 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][0]);
		rational[1] = g_variant_new_uint64((*array)[i][1]);

		/* 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(int key, GVariant *data, const struct sr_dev_inst *sdi,
		      const struct sr_channel_group *cg)
{
	int ret, cg_type;
	unsigned int i, j;
	char float_str[30];
	struct dev_context *devc;
	struct scope_config *model;
	struct scope_state *state;
	const char *tmp;
	uint64_t p, q;
	double tmp_d;
	gboolean update_sample_rate;

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

	if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
		return SR_ERR;

	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;
			/* TODO: A and B trigger support possible? */
			ret = dlm_trigger_source_set(sdi->conn, (*model->trigger_sources)[i]);
			break;
		}
		break;
	case SR_CONF_VDIV:
		if (cg_type == CG_NONE) {
			sr_err("No channel group specified.");
			return SR_ERR_CHANNEL_GROUP;
		}

		g_variant_get(data, "(tt)", &p, &q);

		for (i = 0; i < model->num_vdivs; i++) {
			if (p != (*model->vdivs)[i][0] ||
			    q != (*model->vdivs)[i][1])
				continue;
			for (j = 1; j <= model->analog_channels; ++j) {
				if (cg != devc->analog_groups[j - 1])
					continue;
				state->analog_states[j - 1].vdiv = i;
				g_ascii_formatd(float_str, sizeof(float_str),
						"%E", (float) p / q);
				if (dlm_analog_chan_vdiv_set(sdi->conn, j, float_str) != 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][0] ||
			    q != (*model->timebases)[i][1])
				continue;
			state->timebase = i;
			g_ascii_formatd(float_str, sizeof(float_str),
					"%E", (float) p / q);
			ret = dlm_timebase_set(sdi->conn, float_str);
			update_sample_rate = TRUE;
			break;
		}
		break;
	case SR_CONF_HORIZ_TRIGGERPOS:
		tmp_d = g_variant_get_double(data);

		/* TODO: Check if the calculation makes sense for the DLM. */
		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][0] /
			(*model->timebases)[state->timebase][1])
			 * model->num_xdivs;

		g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
		ret = dlm_horiz_trigger_pos_set(sdi->conn, float_str);
		break;
	case SR_CONF_TRIGGER_SLOPE:
		tmp = g_variant_get_string(data, NULL);

		if (!tmp || !(tmp[0] == 'f' || tmp[0] == 'r'))
			return SR_ERR_ARG;

		/* Note: See dlm_trigger_slopes[] in protocol.c. */
		state->trigger_slope = (tmp[0] == 'r') ?
				SLOPE_POSITIVE : SLOPE_NEGATIVE;

		ret = dlm_trigger_slope_set(sdi->conn, state->trigger_slope);
		break;
	case SR_CONF_COUPLING:
		if (cg_type == CG_NONE) {
			sr_err("No channel group specified.");
			return SR_ERR_CHANNEL_GROUP;
		}

		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_states[j-1].coupling = i;

				if (dlm_analog_chan_coupl_set(sdi->conn, j, tmp) != 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 = dlm_sample_rate_query(sdi);

	return ret;
}

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

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

	if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
		return SR_ERR;

	model = devc->model_config;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = NULL;
		break;
	case SR_CONF_DEVICE_OPTIONS:
		if (cg_type == CG_NONE) {
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				model->hw_caps, model->num_hwcaps, sizeof(int32_t));
		} else if (cg_type == CG_ANALOG) {
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				model->analog_hwcaps, model->num_analog_hwcaps,	sizeof(int32_t));
		} else {
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				NULL, 0, sizeof(int32_t));
		}
		break;
	case SR_CONF_COUPLING:
		if (cg_type == CG_NONE)
			return SR_ERR_CHANNEL_GROUP;
		*data = g_variant_new_strv(*model->coupling_options,
			   g_strv_length((char **)*model->coupling_options));
		break;
	case SR_CONF_TRIGGER_SOURCE:
		*data = g_variant_new_strv(*model->trigger_sources,
			   g_strv_length((char **)*model->trigger_sources));
		break;
	case SR_CONF_TRIGGER_SLOPE:
		*data = g_variant_new_strv(*model->trigger_slopes,
			   g_strv_length((char **)*model->trigger_slopes));
		break;
	case SR_CONF_TIMEBASE:
		*data = build_tuples(model->timebases, model->num_timebases);
		break;
	case SR_CONF_VDIV:
		if (cg_type == CG_NONE)
			return SR_ERR_CHANNEL_GROUP;
		*data = build_tuples(model->vdivs, model->num_vdivs);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dlm_check_channels(GSList *channels)
{
	GSList *l;
	struct sr_channel *ch;
	gboolean enabled_pod1, enabled_chan4;

	enabled_pod1 = enabled_chan4 = FALSE;

	/* Note: On the DLM2000, CH4 and Logic are shared. */
	/* TODO Handle non-DLM2000 models. */
	for (l = channels; l; l = l->next) {
		ch = l->data;
		switch (ch->type) {
		case SR_CHANNEL_ANALOG:
			if (ch->index == 3)
				enabled_chan4 = TRUE;
			break;
		case SR_CHANNEL_LOGIC:
			enabled_pod1 = TRUE;
			break;
		default:
			return SR_ERR;
		}
	}

	if (enabled_pod1 && enabled_chan4)
		return SR_ERR;

	return SR_OK;
}

static int dlm_setup_channels(const struct sr_dev_inst *sdi)
{
	GSList *l;
	unsigned int i;
	gboolean *pod_enabled, setup_changed;
	struct scope_state *state;
	struct scope_config *model;
	struct sr_channel *ch;
	struct dev_context *devc;
	struct sr_scpi_dev_inst *scpi;

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

	pod_enabled = g_try_malloc0(sizeof(gboolean) * model->pods);

	for (l = sdi->channels; l; l = l->next) {
		ch = l->data;
		switch (ch->type) {
		case SR_CHANNEL_ANALOG:
			if (ch->enabled == state->analog_states[ch->index].state)
				break;

			if (dlm_analog_chan_state_set(scpi, ch->index + 1,
						      ch->enabled) != SR_OK)
				return SR_ERR;

			state->analog_states[ch->index].state = ch->enabled;
			setup_changed = TRUE;
			break;
		case SR_CHANNEL_LOGIC:
			if (ch->enabled)
				pod_enabled[ch->index / 8] = TRUE;

			if (ch->enabled == state->digital_states[ch->index])
				break;

			if (dlm_digital_chan_state_set(scpi, ch->index + 1,
						       ch->enabled) != SR_OK)
				return SR_ERR;

			state->digital_states[ch->index] = ch->enabled;
			setup_changed = TRUE;
			break;
		default:
			return SR_ERR;
		}
	}

	for (i = 1; i <= model->pods; ++i) {
		if (state->pod_states[i - 1] == pod_enabled[i - 1])
			continue;

		if (dlm_digital_pod_state_set(scpi, i,
					      pod_enabled[i - 1]) != SR_OK)
			return SR_ERR;

		state->pod_states[i - 1] = pod_enabled[i - 1];
		setup_changed = TRUE;
	}

	g_free(pod_enabled);

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

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
{
	GSList *l;
	gboolean digital_added;
	struct sr_channel *ch;
	struct dev_context *devc;
	struct sr_scpi_dev_inst *scpi;

	(void)cb_data;

	if (sdi->status != SR_ST_ACTIVE) return SR_ERR_DEV_CLOSED;

	scpi = sdi->conn;
	devc = sdi->priv;
	digital_added = FALSE;

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

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

	if (!devc->enabled_channels)
		return SR_ERR;

	if (dlm_check_channels(devc->enabled_channels) != SR_OK) {
		sr_err("Invalid channel configuration specified!");
		return SR_ERR_NA;
	}

	if (dlm_setup_channels(sdi) != SR_OK) {
		sr_err("Failed to setup channel configuration!");
		return SR_ERR;
	}

	/* Request data for the first enabled channel. */
	devc->current_channel = devc->enabled_channels;
	dlm_channel_data_request(sdi);

	/* Call our callback when data comes in or after 50ms. */
	sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
			dlm_data_receive, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	struct dev_context *devc;
	struct sr_datafeed_packet packet;

	(void)cb_data;

	packet.type = SR_DF_END;
	packet.payload = NULL;
	sr_session_send(sdi, &packet);

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	devc = sdi->priv;

	devc->num_frames = 0;
	g_slist_free(devc->enabled_channels);
	devc->enabled_channels = NULL;

	sr_scpi_source_remove(sdi->session, sdi->conn);

	return SR_OK;
}

SR_PRIV struct sr_dev_driver yokogawa_dlm_driver_info = {
	.name = "yokogawa-dlm",
	.longname = "Yokogawa DL/DLM driver",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = 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,
	.priv = NULL,
};
Commit	Line	Data
10763937 SA	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2014 abraxa (Soeren Apel) <soeren@apelpie.net>
	5	* Based on the Hameg HMO driver by poljar (Damir Jelić) <poljarinho@gmail.com>
	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation, either version 3 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
	21	#include <stdlib.h>
	22	#include "protocol.h"
	23
8ab929d6 SA	24	SR_PRIV struct sr_dev_driver yokogawa_dlm_driver_info;
	25	static struct sr_dev_driver *di = &yokogawa_dlm_driver_info;
	26
	27	static char *MANUFACTURER_ID = "YOKOGAWA";
	28	static char *MANUFACTURER_NAME = "Yokogawa";
	29
	30	enum {
	31	CG_INVALID = -1,
	32	CG_NONE,
	33	CG_ANALOG,
	34	CG_DIGITAL,
	35	};
	36
	37	static int init(struct sr_context *sr_ctx)
	38	{
	39	return std_init(sr_ctx, di, LOG_PREFIX);
	40	}
	41
	42	static struct sr_dev_inst probe_usbtmc_device(struct sr_scpi_dev_inst scpi)
	43	{
	44	struct sr_dev_inst *sdi;
	45	struct dev_context *devc;
	46	struct sr_scpi_hw_info *hw_info;
	47	char *model_name;
	48	int model_index;
	49
	50	sdi = NULL;
	51	devc = NULL;
	52	hw_info = NULL;
	53
	54	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
	55	sr_info("Couldn't get IDN response.");
	56	goto fail;
	57	}
	58
	59	if (strcmp(hw_info->manufacturer, MANUFACTURER_ID) != 0)
	60	goto fail;
	61
	62	if (dlm_model_get(hw_info->model, &model_name, &model_index) != SR_OK)
	63	goto fail;
	64
	65	if (!(sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, MANUFACTURER_NAME,
	66	model_name, NULL)))
	67	goto fail;
	68
	69	sr_scpi_hw_info_free(hw_info);
	70	hw_info = NULL;
	71
	72	if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
	73	goto fail;
	74
	75	sdi->driver = di;
	76	sdi->priv = devc;
	77	sdi->inst_type = SR_INST_SCPI;
	78	sdi->conn = scpi;
	79
	80	if (dlm_device_init(sdi, model_index) != SR_OK)
	81	goto fail;
	82
	83	sr_scpi_close(sdi->conn);
	84
	85	sdi->status = SR_ST_INACTIVE;
	86	return sdi;
	87
88	fail:
89	if (hw_info)
90	sr_scpi_hw_info_free(hw_info);
91	if (sdi)
92	sr_dev_inst_free(sdi);
93	if (devc)
94	g_free(devc);
95
96	return NULL;
97	}
98
99	static GSList scan(GSList options)
100	{
101	return sr_scpi_scan(di->priv, options, probe_usbtmc_device);
102	}
103
104	static GSList *dev_list(void)
105	{
106	return ((struct drv_context *)(di->priv))->instances;
107	}
108
109	static void clear_helper(void *priv)
110	{
111	struct dev_context *devc;
112
113	devc = priv;
114
115	dlm_scope_state_destroy(devc->model_state);
116
117	g_free(devc->analog_groups);
118	g_free(devc->digital_groups);
119	g_free(devc);
120	}
121
122	static int dev_clear(void)
123	{
124	return std_dev_clear(di, clear_helper);
125	}
126
127	static int dev_open(struct sr_dev_inst *sdi)
128	{
129	if (sdi->status != SR_ST_ACTIVE && sr_scpi_open(sdi->conn) != SR_OK)
130	return SR_ERR;
131
132	if (dlm_scope_state_query(sdi) != SR_OK)
133	return SR_ERR;
134
135	sdi->status = SR_ST_ACTIVE;
136
137	return SR_OK;
138	}
139
140	static int dev_close(struct sr_dev_inst *sdi)
141	{
142	if (sdi->status == SR_ST_INACTIVE)
143	return SR_OK;
144
145	sr_scpi_close(sdi->conn);
146
147	sdi->status = SR_ST_INACTIVE;
148
149	return SR_OK;
150	}
151
152	static int cleanup(void)
153	{
154	dev_clear();
155
156	return SR_OK;
157	}
158
159	/**
160	* Check which category a given channel group belongs to.
161	*
162	* @param devc Our internal device context.
163	* @param cg The channel group to check.
164	*
165	* @retval CG_NONE cg is NULL
166	* @retval CG_ANALOG cg is an analog group
167	* @retval CG_DIGITAL cg is a digital group
168	* @retval CG_INVALID cg is something else
169	*/
170	static int check_channel_group(struct dev_context *devc,
171	const struct sr_channel_group *cg)
172	{
173	unsigned int i;
174	struct scope_config *model;
175
176	model = devc->model_config;
177
178	if (!cg)
179	return CG_NONE;
180
181	for (i = 0; i < model->analog_channels; ++i)
182	if (cg == devc->analog_groups[i])
183	return CG_ANALOG;
184
185	for (i = 0; i < model->pods; ++i)
186	if (cg == devc->digital_groups[i])
187	return CG_DIGITAL;
188
189	sr_err("Invalid channel group specified.");
190	return CG_INVALID;
191	}
192
193	static int config_get(int key, GVariant *data, const struct sr_dev_inst sdi,
194	const struct sr_channel_group *cg)
195	{
196	int ret, cg_type;
197	unsigned int i;
198	struct dev_context *devc;
199	struct scope_config *model;
200	struct scope_state *state;
201
202	if (!sdi \|\| !(devc = sdi->priv))
203	return SR_ERR_ARG;
204
205	if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
206	return SR_ERR;
207
208	ret = SR_ERR_NA;
209	model = devc->model_config;
210	state = devc->model_state;
211
212	switch (key) {
213	case SR_CONF_NUM_TIMEBASE:
214	*data = g_variant_new_int32(model->num_xdivs);
215	ret = SR_OK;
216	break;
217	case SR_CONF_TIMEBASE:
218	*data = g_variant_new("(tt)",
219	(*model->timebases)[state->timebase][0],
220	(*model->timebases)[state->timebase][1]);
221	ret = SR_OK;
222	break;
223	case SR_CONF_NUM_VDIV:
224	if (cg_type == CG_NONE) {
225	sr_err("No channel group specified.");
226	return SR_ERR_CHANNEL_GROUP;
227	} else if (cg_type == CG_ANALOG) {
228	*data = g_variant_new_int32(model->num_ydivs);
229	ret = SR_OK;
230	break;
231	} else {
232	ret = SR_ERR_NA;
233	}
234	break;
235	case SR_CONF_VDIV:
236	ret = SR_ERR_NA;
237	if (cg_type == CG_NONE) {
238	sr_err("No channel group specified.");
239	return SR_ERR_CHANNEL_GROUP;
240	} else if (cg_type != CG_ANALOG)
241	break;
242
243	for (i = 0; i < model->analog_channels; ++i) {
244	if (cg != devc->analog_groups[i])
245	continue;
246	*data = g_variant_new("(tt)",
247	(*model->vdivs)[state->analog_states[i].vdiv][0],
248	(*model->vdivs)[state->analog_states[i].vdiv][1]);
249	ret = SR_OK;
250	break;
251	}
252	break;
253	case SR_CONF_TRIGGER_SOURCE:
254	data = g_variant_new_string((model->trigger_sources)[state->trigger_source]);
255	ret = SR_OK;
256	break;
257	case SR_CONF_TRIGGER_SLOPE:
258	data = g_variant_new_string((model->trigger_slopes)[state->trigger_slope]);
259	ret = SR_OK;
260	break;
261	case SR_CONF_HORIZ_TRIGGERPOS:
262	*data = g_variant_new_double(state->horiz_triggerpos);
263	ret = SR_OK;
264	break;
265	case SR_CONF_COUPLING:
266	ret = SR_ERR_NA;
267	if (cg_type == CG_NONE) {
268	sr_err("No channel group specified.");
269	return SR_ERR_CHANNEL_GROUP;
270	} else if (cg_type != CG_ANALOG)
271	break;
272
273	for (i = 0; i < model->analog_channels; ++i) {
274	if (cg != devc->analog_groups[i])
275	continue;
276	data = g_variant_new_string((model->coupling_options)[state->analog_states[i].coupling]);
277	ret = SR_OK;
278	break;
279	}
280	break;
281	case SR_CONF_SAMPLERATE:
282	*data = g_variant_new_uint64(state->sample_rate);
283	ret = SR_OK;
284	break;
285	default:
286	ret = SR_ERR_NA;
287	}
288
289	return ret;
290	}
291
292	static GVariant build_tuples(const uint64_t (array)[][2], unsigned int n)
293	{
294	unsigned int i;
295	GVariant *rational[2];
296	GVariantBuilder gvb;
297
298	g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
299
300	for (i = 0; i < n; i++) {
301	rational[0] = g_variant_new_uint64((*array)[i][0]);
302	rational[1] = g_variant_new_uint64((*array)[i][1]);
303
304	/* FIXME: Valgrind reports a memory leak here. */
305	g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
306	}
307
308	return g_variant_builder_end(&gvb);
309	}
310
311	static int config_set(int key, GVariant data, const struct sr_dev_inst sdi,
312	const struct sr_channel_group *cg)
313	{
314	int ret, cg_type;
315	unsigned int i, j;
316	char float_str[30];
317	struct dev_context *devc;
318	struct scope_config *model;
319	struct scope_state *state;
320	const char *tmp;
321	uint64_t p, q;
322	double tmp_d;
323	gboolean update_sample_rate;
324
325	if (!sdi \|\| !(devc = sdi->priv))
326	return SR_ERR_ARG;
327
328	if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
329	return SR_ERR;
330
331	model = devc->model_config;
332	state = devc->model_state;
333	update_sample_rate = FALSE;
334
335	ret = SR_ERR_NA;
336
337	switch (key) {
338	case SR_CONF_LIMIT_FRAMES:
339	devc->frame_limit = g_variant_get_uint64(data);
340	ret = SR_OK;
341	break;
342	case SR_CONF_TRIGGER_SOURCE:
343	tmp = g_variant_get_string(data, NULL);
344	for (i = 0; (*model->trigger_sources)[i]; i++) {
345	if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
346	continue;
347	state->trigger_source = i;
348	/* TODO: A and B trigger support possible? */
349	ret = dlm_trigger_source_set(sdi->conn, (*model->trigger_sources)[i]);
350	break;
351	}
352	break;
353	case SR_CONF_VDIV:
354	if (cg_type == CG_NONE) {
355	sr_err("No channel group specified.");
356	return SR_ERR_CHANNEL_GROUP;
357	}
358
359	g_variant_get(data, "(tt)", &p, &q);
360
361	for (i = 0; i < model->num_vdivs; i++) {
362	if (p != (*model->vdivs)[i][0] \|\|
363	q != (*model->vdivs)[i][1])
364	continue;
365	for (j = 1; j <= model->analog_channels; ++j) {
366	if (cg != devc->analog_groups[j - 1])
367	continue;
368	state->analog_states[j - 1].vdiv = i;
369	g_ascii_formatd(float_str, sizeof(float_str),
370	"%E", (float) p / q);
371	if (dlm_analog_chan_vdiv_set(sdi->conn, j, float_str) != SR_OK \|\|
372	sr_scpi_get_opc(sdi->conn) != SR_OK)
373	return SR_ERR;
374
375	break;
376	}
377
378	ret = SR_OK;
379	break;
380	}
381	break;
382	case SR_CONF_TIMEBASE:
383	g_variant_get(data, "(tt)", &p, &q);
384
385	for (i = 0; i < model->num_timebases; i++) {
386	if (p != (*model->timebases)[i][0] \|\|
387	q != (*model->timebases)[i][1])
388	continue;
389	state->timebase = i;
390	g_ascii_formatd(float_str, sizeof(float_str),
391	"%E", (float) p / q);
392	ret = dlm_timebase_set(sdi->conn, float_str);
393	update_sample_rate = TRUE;
394	break;
395	}
396	break;
397	case SR_CONF_HORIZ_TRIGGERPOS:
398	tmp_d = g_variant_get_double(data);
399
400	/* TODO: Check if the calculation makes sense for the DLM. */
401	if (tmp_d < 0.0 \|\| tmp_d > 1.0)
402	return SR_ERR;
403
404	state->horiz_triggerpos = tmp_d;
405	tmp_d = -(tmp_d - 0.5) *
406	((double) (*model->timebases)[state->timebase][0] /
407	(*model->timebases)[state->timebase][1])
408	* model->num_xdivs;
409
410	g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
411	ret = dlm_horiz_trigger_pos_set(sdi->conn, float_str);
412	break;
413	case SR_CONF_TRIGGER_SLOPE:
414	tmp = g_variant_get_string(data, NULL);
415
416	if (!tmp \|\| !(tmp[0] == 'f' \|\| tmp[0] == 'r'))
417	return SR_ERR_ARG;
418
419	/* Note: See dlm_trigger_slopes[] in protocol.c. */
420	state->trigger_slope = (tmp[0] == 'r') ?
421	SLOPE_POSITIVE : SLOPE_NEGATIVE;
422
423	ret = dlm_trigger_slope_set(sdi->conn, state->trigger_slope);
424	break;
425	case SR_CONF_COUPLING:
426	if (cg_type == CG_NONE) {
427	sr_err("No channel group specified.");
428	return SR_ERR_CHANNEL_GROUP;
429	}
430
431	tmp = g_variant_get_string(data, NULL);
432
433	for (i = 0; (*model->coupling_options)[i]; i++) {
434	if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
435	continue;
436	for (j = 1; j <= model->analog_channels; ++j) {
437	if (cg != devc->analog_groups[j - 1])
438	continue;
439	state->analog_states[j-1].coupling = i;
440
441	if (dlm_analog_chan_coupl_set(sdi->conn, j, tmp) != SR_OK \|\|
442	sr_scpi_get_opc(sdi->conn) != SR_OK)
443	return SR_ERR;
444	break;
445	}
446
447	ret = SR_OK;
448	break;
449	}
450	break;
451	default:
452	ret = SR_ERR_NA;
453	break;
454	}
455
456	if (ret == SR_OK)
457	ret = sr_scpi_get_opc(sdi->conn);
458
459	if (ret == SR_OK && update_sample_rate)
460	ret = dlm_sample_rate_query(sdi);
461
462	return ret;
463	}
464
465	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi,
466	const struct sr_channel_group *cg)
467	{
468	int cg_type;
469	struct dev_context *devc;
470	struct scope_config *model;
471
472	if (!sdi \|\| !(devc = sdi->priv))
473	return SR_ERR_ARG;
474
475	if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
476	return SR_ERR;
477
478	model = devc->model_config;
479
480	switch (key) {
481	case SR_CONF_SCAN_OPTIONS:
482	*data = NULL;
483	break;
484	case SR_CONF_DEVICE_OPTIONS:
485	if (cg_type == CG_NONE) {
486	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
487	model->hw_caps, model->num_hwcaps, sizeof(int32_t));
488	} else if (cg_type == CG_ANALOG) {
489	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
490	model->analog_hwcaps, model->num_analog_hwcaps, sizeof(int32_t));
491	} else {
492	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
493	NULL, 0, sizeof(int32_t));
494	}
495	break;
496	case SR_CONF_COUPLING:
497	if (cg_type == CG_NONE)
498	return SR_ERR_CHANNEL_GROUP;
499	data = g_variant_new_strv(model->coupling_options,
500	g_strv_length((char *)model->coupling_options));
501	break;
502	case SR_CONF_TRIGGER_SOURCE:
503	data = g_variant_new_strv(model->trigger_sources,
504	g_strv_length((char *)model->trigger_sources));
505	break;
506	case SR_CONF_TRIGGER_SLOPE:
507	data = g_variant_new_strv(model->trigger_slopes,
508	g_strv_length((char *)model->trigger_slopes));
509	break;
510	case SR_CONF_TIMEBASE:
511	*data = build_tuples(model->timebases, model->num_timebases);
512	break;
513	case SR_CONF_VDIV:
514	if (cg_type == CG_NONE)
515	return SR_ERR_CHANNEL_GROUP;
516	*data = build_tuples(model->vdivs, model->num_vdivs);
517	break;
518	default:
519	return SR_ERR_NA;
520	}
521
522	return SR_OK;
523	}
524
525	static int dlm_check_channels(GSList *channels)
526	{
527	GSList *l;
528	struct sr_channel *ch;
529	gboolean enabled_pod1, enabled_chan4;
530
531	enabled_pod1 = enabled_chan4 = FALSE;
532
533	/* Note: On the DLM2000, CH4 and Logic are shared. */
534	/* TODO Handle non-DLM2000 models. */
535	for (l = channels; l; l = l->next) {
536	ch = l->data;
537	switch (ch->type) {
538	case SR_CHANNEL_ANALOG:
539	if (ch->index == 3)
540	enabled_chan4 = TRUE;
541	break;
542	case SR_CHANNEL_LOGIC:
543	enabled_pod1 = TRUE;
544	break;
545	default:
546	return SR_ERR;
547	}
548	}
549
550	if (enabled_pod1 && enabled_chan4)
551	return SR_ERR;
552
553	return SR_OK;
554	}
555
556	static int dlm_setup_channels(const struct sr_dev_inst *sdi)
557	{
558	GSList *l;
559	unsigned int i;
560	gboolean *pod_enabled, setup_changed;
561	struct scope_state *state;
562	struct scope_config *model;
563	struct sr_channel *ch;
564	struct dev_context *devc;
565	struct sr_scpi_dev_inst *scpi;
566
567	devc = sdi->priv;
568	scpi = sdi->conn;
569	state = devc->model_state;
570	model = devc->model_config;
571	setup_changed = FALSE;
572
573	pod_enabled = g_try_malloc0(sizeof(gboolean) * model->pods);
574
575	for (l = sdi->channels; l; l = l->next) {
576	ch = l->data;
577	switch (ch->type) {
578	case SR_CHANNEL_ANALOG:
579	if (ch->enabled == state->analog_states[ch->index].state)
580	break;
581
582	if (dlm_analog_chan_state_set(scpi, ch->index + 1,
583	ch->enabled) != SR_OK)
584	return SR_ERR;
585
586	state->analog_states[ch->index].state = ch->enabled;
587	setup_changed = TRUE;
588	break;
589	case SR_CHANNEL_LOGIC:
590	if (ch->enabled)
591	pod_enabled[ch->index / 8] = TRUE;
592
593	if (ch->enabled == state->digital_states[ch->index])
594	break;
595
596	if (dlm_digital_chan_state_set(scpi, ch->index + 1,
597	ch->enabled) != SR_OK)
598	return SR_ERR;
599
600	state->digital_states[ch->index] = ch->enabled;
601	setup_changed = TRUE;
602	break;
603	default:
604	return SR_ERR;
605	}
606	}
607
608	for (i = 1; i <= model->pods; ++i) {
609	if (state->pod_states[i - 1] == pod_enabled[i - 1])
610	continue;
611
612	if (dlm_digital_pod_state_set(scpi, i,
613	pod_enabled[i - 1]) != SR_OK)
614	return SR_ERR;
615
616	state->pod_states[i - 1] = pod_enabled[i - 1];
617	setup_changed = TRUE;
618	}
619
620	g_free(pod_enabled);
621
622	if (setup_changed && dlm_sample_rate_query(sdi) != SR_OK)
623	return SR_ERR;
624
625	return SR_OK;
626	}
627
628	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
629	{
630	GSList *l;
631	gboolean digital_added;
632	struct sr_channel *ch;
633	struct dev_context *devc;
634	struct sr_scpi_dev_inst *scpi;
635
636	(void)cb_data;
637
638	if (sdi->status != SR_ST_ACTIVE) return SR_ERR_DEV_CLOSED;
639
640	scpi = sdi->conn;
641	devc = sdi->priv;
642	digital_added = FALSE;
643
644	g_slist_free(devc->enabled_channels);
645	devc->enabled_channels = NULL;
646
647	for (l = sdi->channels; l; l = l->next) {
648	ch = l->data;
649	if (!ch->enabled)
650	continue;
651	/* Only add a single digital channel. */
652	if (ch->type != SR_CHANNEL_LOGIC \|\| !digital_added) {
653	devc->enabled_channels = g_slist_append(
654	devc->enabled_channels, ch);
655	if (ch->type == SR_CHANNEL_LOGIC)
656	digital_added = TRUE;
657	}
658	}
659
660	if (!devc->enabled_channels)
661	return SR_ERR;
662
663	if (dlm_check_channels(devc->enabled_channels) != SR_OK) {
664	sr_err("Invalid channel configuration specified!");
665	return SR_ERR_NA;
666	}
667
668	if (dlm_setup_channels(sdi) != SR_OK) {
669	sr_err("Failed to setup channel configuration!");
670	return SR_ERR;
671	}
672
af3487ec SA	673	/* Request data for the first enabled channel. */
	674	devc->current_channel = devc->enabled_channels;
	675	dlm_channel_data_request(sdi);
	676
8ab929d6	677	/* Call our callback when data comes in or after 50ms. */
af3487ec	678	sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
8ab929d6 SA	679	dlm_data_receive, (void *)sdi);
	680
	681	return SR_OK;
	682	}
	683
	684	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	685	{
	686	struct dev_context *devc;
8ab929d6 SA	687	struct sr_datafeed_packet packet;
	688
	689	(void)cb_data;
	690
	691	packet.type = SR_DF_END;
	692	packet.payload = NULL;
	693	sr_session_send(sdi, &packet);
	694
	695	if (sdi->status != SR_ST_ACTIVE)
	696	return SR_ERR_DEV_CLOSED;
	697
	698	devc = sdi->priv;
	699
	700	devc->num_frames = 0;
	701	g_slist_free(devc->enabled_channels);
	702	devc->enabled_channels = NULL;
af3487ec SA	703
af3487ec SA	704	sr_scpi_source_remove(sdi->session, sdi->conn);
8ab929d6 SA	705
	706	return SR_OK;
	707	}
10763937 SA	708
	709	SR_PRIV struct sr_dev_driver yokogawa_dlm_driver_info = {
	710	.name = "yokogawa-dlm",
	711	.longname = "Yokogawa DL/DLM driver",
	712	.api_version = 1,
8ab929d6 SA	713	.init = init,
	714	.cleanup = cleanup,
	715	.scan = scan,
	716	.dev_list = dev_list,
	717	.dev_clear = dev_clear,
	718	.config_get = config_get,
	719	.config_set = config_set,
	720	.config_list = config_list,
	721	.dev_open = dev_open,
	722	.dev_close = dev_close,
	723	.dev_acquisition_start = dev_acquisition_start,
	724	.dev_acquisition_stop = dev_acquisition_stop,
10763937 SA	725	.priv = NULL,
10763937 SA	726	};