[libsigrok.git] / src / hardware / scpi-dmm / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2018 Gerhard Sittig <gerhard.sittig@gmx.net>
 *
 * 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 <string.h>
#include "protocol.h"

static struct sr_dev_driver scpi_dmm_driver_info;

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

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

static const uint32_t devopts_generic[] = {
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_MEASURED_QUANTITY | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

static const struct scpi_command cmdset_agilent[] = {
	{ DMM_CMD_SETUP_REMOTE, "\n", },
	{ DMM_CMD_SETUP_FUNC, "CONF:%s", },
	{ DMM_CMD_QUERY_FUNC, "CONF?", },
	{ DMM_CMD_START_ACQ, "MEAS", },
	{ DMM_CMD_STOP_ACQ, "ABORT", },
	{ DMM_CMD_QUERY_VALUE, "READ?", },
	{ DMM_CMD_QUERY_PREC, "CONF?", },
	ALL_ZERO,
};

/*
 * cmdset_hp is used for the 34401A, which was added to this code after the
 * 34405A and 34465A. It differs in starting the measurement with INIT: using
 * MEAS without a trailing '?' (as used for the 34405A) is not valid for the
 * 34401A and gives an error.
 * I'm surprised the same instruction sequence doesn't work and INIT may
 * work for both, but I don't have the others to re-test.
 *
 * cmdset_hp also works well for the 34410A, using cmdset_agilent throws an
 * error on 'MEAS' without a '?'.
 *
 * On the 34401A,
 *  MEAS <optional parameters> ? configures, arms, triggers and waits
 *       for a reading
 *  CONF <parameters> configures
 *  INIT prepares for triggering (trigger mode is not set, assumed
 *       internal - external might time out)
 *  *OPC waits for completion, and
 *  READ? retrieves the result
 */
static const struct scpi_command cmdset_hp[] = {
	{ DMM_CMD_SETUP_REMOTE, "\n", },
	{ DMM_CMD_SETUP_FUNC, "CONF:%s", },
	{ DMM_CMD_QUERY_FUNC, "CONF?", },
	{ DMM_CMD_START_ACQ, "INIT", },
	{ DMM_CMD_STOP_ACQ, "ABORT", },
	{ DMM_CMD_QUERY_VALUE, "READ?", },
	{ DMM_CMD_QUERY_PREC, "CONF?", },
	ALL_ZERO,
};

static const struct scpi_command cmdset_gwinstek[] = {
	{ DMM_CMD_SETUP_REMOTE, "SYST:REM", },
	{ DMM_CMD_SETUP_FUNC, "CONF:%s", },
	{ DMM_CMD_QUERY_FUNC, "CONF:STAT:FUNC?", },
	{ DMM_CMD_START_ACQ, "*CLS;SYST:REM", },
	{ DMM_CMD_STOP_ACQ, "SYST:LOC", },
	{ DMM_CMD_QUERY_VALUE, "VAL1?", },
	{ DMM_CMD_QUERY_PREC, "SENS:DET:RATE?", },
	ALL_ZERO,
};

static const struct mqopt_item mqopts_agilent_34405a[] = {
	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
	{ SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, },
	{ SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
	{ SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, },
	{ SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, },
	{ SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
	{ SR_MQ_CAPACITANCE, 0, "CAP", "CAP ", NO_DFLT_PREC, },
	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
	{ SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP ", NO_DFLT_PREC, },
	{ SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, },
};

static const struct mqopt_item mqopts_agilent_34401a[] = {
	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
	{ SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, },
	{ SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
	{ SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, },
	{ SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, },
	{ SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES ", NO_DFLT_PREC, },
	{ SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
	{ SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, },
	{ SR_MQ_TIME, 0, "PER", "PER ", NO_DFLT_PREC, },
};

static const struct mqopt_item mqopts_gwinstek_gdm8200a[] = {
	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "01", NO_DFLT_PREC, },
	{ SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "02", NO_DFLT_PREC, },
	{ SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "03", NO_DFLT_PREC, },
	{ SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "04", NO_DFLT_PREC, },
	{ SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "05", NO_DFLT_PREC, }, /* mA */
	{ SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "06", NO_DFLT_PREC, }, /* mA */
	{ SR_MQ_RESISTANCE, 0, "RES", "07", NO_DFLT_PREC, },
	{ SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "16", NO_DFLT_PREC, },
	{ SR_MQ_CONTINUITY, 0, "CONT", "13", -1, },
	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC | SR_MQFLAG_DIODE, "DIOD", "17", -4, },
	{ SR_MQ_TEMPERATURE, 0, "TEMP", "09", NO_DFLT_PREC, }, /* Celsius */
	{ SR_MQ_TEMPERATURE, 0, "TEMP", "15", NO_DFLT_PREC, }, /* Fahrenheit */
	{ SR_MQ_FREQUENCY, 0, "FREQ", "08", NO_DFLT_PREC, },
	{ SR_MQ_TIME, 0, "PER", "14", NO_DFLT_PREC, },
};

SR_PRIV const struct scpi_dmm_model models[] = {
	{
		"Agilent", "34405A",
		1, 5, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
		scpi_dmm_get_meas_agilent,
		ARRAY_AND_SIZE(devopts_generic),
		0,
	},
	{
		"Agilent", "34410A",
		1, 6, cmdset_hp, ARRAY_AND_SIZE(mqopts_agilent_34405a),
		scpi_dmm_get_meas_agilent,
		ARRAY_AND_SIZE(devopts_generic),
		0,
	},
	{
		"Keysight", "34465A",
		1, 5, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
		scpi_dmm_get_meas_agilent,
		ARRAY_AND_SIZE(devopts_generic),
		0,
	},
	{
		"HP", "34401A",
		1, 6, cmdset_hp, ARRAY_AND_SIZE(mqopts_agilent_34401a),
		scpi_dmm_get_meas_agilent,
		ARRAY_AND_SIZE(devopts_generic),
		/* 34401A: typ. 1020ms for AC readings (default is 1000ms). */
		1000 * 1500,
	},
	{
		"GW", "GDM8251A",
		1, 6, cmdset_gwinstek, ARRAY_AND_SIZE(mqopts_gwinstek_gdm8200a),
		scpi_dmm_get_meas_gwinstek,
		ARRAY_AND_SIZE(devopts_generic),
		1000 * 2500,
	},
	{
		"GW", "GDM8255A",
		1, 6, cmdset_gwinstek, ARRAY_AND_SIZE(mqopts_gwinstek_gdm8200a),
		scpi_dmm_get_meas_gwinstek,
		ARRAY_AND_SIZE(devopts_generic),
		1000 * 2500,
	},
};

static const struct scpi_dmm_model *is_compatible(const char *vendor, const char *model)
{
	size_t i;
	const struct scpi_dmm_model *entry;

	for (i = 0; i < ARRAY_SIZE(models); i++) {
		entry = &models[i];
		if (!entry->vendor || !entry->model)
			continue;
		if (strcmp(vendor, entry->vendor) != 0)
			continue;
		if (strcmp(model, entry->model) != 0)
			continue;
		return entry;
	}

	return NULL;
}

static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
{
	struct sr_scpi_hw_info *hw_info;
	int ret;
	const char *vendor;
	const struct scpi_dmm_model *model;
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	size_t i;
	gchar *channel_name;

	scpi_dmm_cmd_delay(scpi);
	ret = sr_scpi_get_hw_id(scpi, &hw_info);
	if (ret != SR_OK) {
		sr_info("Could not get IDN response.");
		return NULL;
	}
	vendor = sr_vendor_alias(hw_info->manufacturer);
	model = is_compatible(vendor, hw_info->model);
	if (!model) {
		sr_scpi_hw_info_free(hw_info);
		return NULL;
	}

	sdi = g_malloc0(sizeof(*sdi));
	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->conn = scpi;
	sdi->driver = &scpi_dmm_driver_info;
	sdi->inst_type = SR_INST_SCPI;
	sr_scpi_hw_info_free(hw_info);
	if (model->read_timeout_us)  /* non-default read timeout */
		scpi->read_timeout_us = model->read_timeout_us;
	devc = g_malloc0(sizeof(*devc));
	sdi->priv = devc;
	devc->num_channels = model->num_channels;
	devc->cmdset = model->cmdset;
	devc->model = model;
	devc->precision = NULL;

	for (i = 0; i < devc->num_channels; i++) {
		channel_name = g_strdup_printf("P%zu", i + 1);
		sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, channel_name);
	}

	return sdi;
}

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

static int dev_open(struct sr_dev_inst *sdi)
{
	struct sr_scpi_dev_inst *scpi;
	int ret;

	scpi = sdi->conn;
	ret = sr_scpi_open(scpi);
	if (ret < 0) {
		sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
		return SR_ERR;
	}

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_scpi_dev_inst *scpi;

	scpi = sdi->conn;
	if (!scpi)
		return SR_ERR_BUG;

	sr_dbg("DIAG: sdi->status %d.", sdi->status - SR_ST_NOT_FOUND);
	if (sdi->status <= SR_ST_INACTIVE)
		return SR_OK;

	return sr_scpi_close(scpi);
}

static int config_get(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	enum sr_mq mq;
	enum sr_mqflag mqflag;
	GVariant *arr[2];
	int ret;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
	case SR_CONF_LIMIT_MSEC:
		return sr_sw_limits_config_get(&devc->limits, key, data);
	case SR_CONF_MEASURED_QUANTITY:
		ret = scpi_dmm_get_mq(sdi, &mq, &mqflag, NULL, NULL);
		if (ret != SR_OK)
			return ret;
		arr[0] = g_variant_new_uint32(mq);
		arr[1] = g_variant_new_uint64(mqflag);
		*data = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
		return SR_OK;
	default:
		return SR_ERR_NA;
	}
}

static int config_set(uint32_t key, GVariant *data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	enum sr_mq mq;
	enum sr_mqflag mqflag;
	GVariant *tuple_child;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
	case SR_CONF_LIMIT_MSEC:
		return sr_sw_limits_config_set(&devc->limits, key, data);
	case SR_CONF_MEASURED_QUANTITY:
		tuple_child = g_variant_get_child_value(data, 0);
		mq = g_variant_get_uint32(tuple_child);
		g_variant_unref(tuple_child);
		tuple_child = g_variant_get_child_value(data, 1);
		mqflag = g_variant_get_uint64(tuple_child);
		g_variant_unref(tuple_child);
		return scpi_dmm_set_mq(sdi, mq, mqflag);
	default:
		return SR_ERR_NA;
	}
}

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;
	GVariant *gvar, *arr[2];
	GVariantBuilder gvb;
	size_t i;

	(void)cg;

	devc = sdi ? sdi->priv : NULL;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
	case SR_CONF_DEVICE_OPTIONS:
		if (!devc)
			return STD_CONFIG_LIST(key, data, sdi, cg,
				scanopts, drvopts, devopts_generic);
		return std_opts_config_list(key, data, sdi, cg,
			ARRAY_AND_SIZE(scanopts), ARRAY_AND_SIZE(drvopts),
			devc->model->devopts, devc->model->devopts_size);
	case SR_CONF_MEASURED_QUANTITY:
		/* TODO Use std_gvar_measured_quantities() when available. */
		if (!devc)
			return SR_ERR_ARG;
		g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
		for (i = 0; i < devc->model->mqopt_size; i++) {
			arr[0] = g_variant_new_uint32(devc->model->mqopts[i].mq);
			arr[1] = g_variant_new_uint64(devc->model->mqopts[i].mqflag);
			gvar = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
			g_variant_builder_add_value(&gvb, gvar);
		}
		*data = g_variant_builder_end(&gvb);
		return SR_OK;
	default:
		(void)devc;
		return SR_ERR_NA;
	}
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct sr_scpi_dev_inst *scpi;
	struct dev_context *devc;
	int ret;
	const struct mqopt_item *item;
	const char *command;
	char *response;

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

	ret = scpi_dmm_get_mq(sdi, &devc->start_acq_mq.curr_mq,
		&devc->start_acq_mq.curr_mqflag, NULL, &item);
	if (ret != SR_OK)
		return ret;

	/*
	 * Query for current precision if DMM supports the command
	 */
	command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_QUERY_PREC);
	if (command && *command) {
		scpi_dmm_cmd_delay(scpi);
		ret = sr_scpi_get_string(scpi, command, &response);
		if (ret == SR_OK) {
			g_strstrip(response);
			if (devc->precision)
				g_free(devc->precision);
			devc->precision=g_strdup(response);
			g_free(response);
			sr_dbg("%s: Precision: '%s'", __func__, devc->precision);
		} else {
			sr_info("%s: Precision query ('%s') failed: %d",
				__func__, command, ret);
		}
	}

	command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_START_ACQ);
	if (command && *command) {
		scpi_dmm_cmd_delay(scpi);
		ret = sr_scpi_send(scpi, command);
		if (ret != SR_OK)
			return ret;
	}

	sr_sw_limits_acquisition_start(&devc->limits);
	ret = std_session_send_df_header(sdi);
	if (ret != SR_OK)
		return ret;

	ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
		scpi_dmm_receive_data, (void *)sdi);
	if (ret != SR_OK)
		return ret;

	return SR_OK;
}

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

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

	command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_STOP_ACQ);
	if (command && *command) {
		scpi_dmm_cmd_delay(scpi);
		(void)sr_scpi_send(scpi, command);
	}
	sr_scpi_source_remove(sdi->session, scpi);

	std_session_send_df_end(sdi);

	if (devc->precision) {
		g_free(devc->precision);
		devc->precision = NULL;
	}

	return SR_OK;
}

static struct sr_dev_driver scpi_dmm_driver_info = {
	.name = "scpi-dmm",
	.longname = "SCPI DMM",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = std_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(scpi_dmm_driver_info);
Commit	Line	Data
7a396ff5 GS	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2018 Gerhard Sittig <gerhard.sittig@gmx.net>
	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
3cdad416	20	#include <string.h>
7a396ff5 GS	21	#include "protocol.h"
7a396ff5 GS	22
0617bb5a GS	23	static struct sr_dev_driver scpi_dmm_driver_info;
0617bb5a GS	24
3cdad416 GS	25	static const uint32_t scanopts[] = {
3cdad416 GS	26	SR_CONF_CONN,
31e65c62	27	SR_CONF_SERIALCOMM,
3cdad416 GS	28	};
	29
	30	static const uint32_t drvopts[] = {
	31	SR_CONF_MULTIMETER,
	32	};
	33
1d2f9963	34	static const uint32_t devopts_generic[] = {
3cdad416 GS	35	SR_CONF_CONTINUOUS,
	36	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	37	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
	38	SR_CONF_MEASURED_QUANTITY \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	39	};
	40
	41	static const struct scpi_command cmdset_agilent[] = {
	42	{ DMM_CMD_SETUP_REMOTE, "\n", },
	43	{ DMM_CMD_SETUP_FUNC, "CONF:%s", },
	44	{ DMM_CMD_QUERY_FUNC, "CONF?", },
	45	{ DMM_CMD_START_ACQ, "MEAS", },
	46	{ DMM_CMD_STOP_ACQ, "ABORT", },
	47	{ DMM_CMD_QUERY_VALUE, "READ?", },
	48	{ DMM_CMD_QUERY_PREC, "CONF?", },
	49	ALL_ZERO,
	50	};
	51
a1619831	52	/*
1c8110db	53	* cmdset_hp is used for the 34401A, which was added to this code after the
a1619831 AG	54	* 34405A and 34465A. It differs in starting the measurement with INIT: using
a1619831 AG	55	* MEAS without a trailing '?' (as used for the 34405A) is not valid for the
1c8110db FS	56	* 34401A and gives an error.
	57	* I'm surprised the same instruction sequence doesn't work and INIT may
	58	* work for both, but I don't have the others to re-test.
a1619831	59	*
85cff5cf MW	60	* cmdset_hp also works well for the 34410A, using cmdset_agilent throws an
	61	* error on 'MEAS' without a '?'.
	62	*
1c8110db FS	63	* On the 34401A,
1c8110db FS	64	* MEAS <optional parameters> ? configures, arms, triggers and waits
a1619831 AG	65	* for a reading
a1619831 AG	66	* CONF <parameters> configures
1c8110db	67	* INIT prepares for triggering (trigger mode is not set, assumed
a1619831 AG	68	* internal - external might time out)
	69	* *OPC waits for completion, and
	70	* READ? retrieves the result
	71	*/
	72	static const struct scpi_command cmdset_hp[] = {
	73	{ DMM_CMD_SETUP_REMOTE, "\n", },
	74	{ DMM_CMD_SETUP_FUNC, "CONF:%s", },
	75	{ DMM_CMD_QUERY_FUNC, "CONF?", },
	76	{ DMM_CMD_START_ACQ, "INIT", },
	77	{ DMM_CMD_STOP_ACQ, "ABORT", },
	78	{ DMM_CMD_QUERY_VALUE, "READ?", },
	79	{ DMM_CMD_QUERY_PREC, "CONF?", },
	80	ALL_ZERO,
	81	};
	82
d0b602f0 TK	83	static const struct scpi_command cmdset_gwinstek[] = {
	84	{ DMM_CMD_SETUP_REMOTE, "SYST:REM", },
	85	{ DMM_CMD_SETUP_FUNC, "CONF:%s", },
	86	{ DMM_CMD_QUERY_FUNC, "CONF:STAT:FUNC?", },
	87	{ DMM_CMD_START_ACQ, "*CLS;SYST:REM", },
	88	{ DMM_CMD_STOP_ACQ, "SYST:LOC", },
	89	{ DMM_CMD_QUERY_VALUE, "VAL1?", },
	90	{ DMM_CMD_QUERY_PREC, "SENS:DET:RATE?", },
	91	ALL_ZERO,
	92	};
	93
64d03de1	94	static const struct mqopt_item mqopts_agilent_34405a[] = {
3cdad416 GS	95	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
	96	{ SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, },
	97	{ SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
	98	{ SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, },
	99	{ SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, },
3cdad416 GS	100	{ SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
	101	{ SR_MQ_CAPACITANCE, 0, "CAP", "CAP ", NO_DFLT_PREC, },
	102	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC \| SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
	103	{ SR_MQ_TEMPERATURE, 0, "TEMP", "TEMP ", NO_DFLT_PREC, },
	104	{ SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, },
	105	};
	106
a1619831 AG	107	static const struct mqopt_item mqopts_agilent_34401a[] = {
	108	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "VOLT ", NO_DFLT_PREC, },
	109	{ SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "VOLT:AC ", NO_DFLT_PREC, },
	110	{ SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "CURR ", NO_DFLT_PREC, },
	111	{ SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "CURR:AC ", NO_DFLT_PREC, },
	112	{ SR_MQ_RESISTANCE, 0, "RES", "RES ", NO_DFLT_PREC, },
	113	{ SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "FRES ", NO_DFLT_PREC, },
	114	{ SR_MQ_CONTINUITY, 0, "CONT", "CONT", -1, },
	115	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC \| SR_MQFLAG_DIODE, "DIOD", "DIOD", -4, },
	116	{ SR_MQ_FREQUENCY, 0, "FREQ", "FREQ ", NO_DFLT_PREC, },
	117	{ SR_MQ_TIME, 0, "PER", "PER ", NO_DFLT_PREC, },
	118	};
	119
d0b602f0 TK	120	static const struct mqopt_item mqopts_gwinstek_gdm8200a[] = {
	121	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC, "VOLT:DC", "01", NO_DFLT_PREC, },
	122	{ SR_MQ_VOLTAGE, SR_MQFLAG_AC, "VOLT:AC", "02", NO_DFLT_PREC, },
	123	{ SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "03", NO_DFLT_PREC, },
	124	{ SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "04", NO_DFLT_PREC, },
	125	{ SR_MQ_CURRENT, SR_MQFLAG_DC, "CURR:DC", "05", NO_DFLT_PREC, }, /* mA */
	126	{ SR_MQ_CURRENT, SR_MQFLAG_AC, "CURR:AC", "06", NO_DFLT_PREC, }, /* mA */
	127	{ SR_MQ_RESISTANCE, 0, "RES", "07", NO_DFLT_PREC, },
	128	{ SR_MQ_RESISTANCE, SR_MQFLAG_FOUR_WIRE, "FRES", "16", NO_DFLT_PREC, },
	129	{ SR_MQ_CONTINUITY, 0, "CONT", "13", -1, },
	130	{ SR_MQ_VOLTAGE, SR_MQFLAG_DC \| SR_MQFLAG_DIODE, "DIOD", "17", -4, },
	131	{ SR_MQ_TEMPERATURE, 0, "TEMP", "09", NO_DFLT_PREC, }, /* Celsius */
	132	{ SR_MQ_TEMPERATURE, 0, "TEMP", "15", NO_DFLT_PREC, }, /* Fahrenheit */
	133	{ SR_MQ_FREQUENCY, 0, "FREQ", "08", NO_DFLT_PREC, },
	134	{ SR_MQ_TIME, 0, "PER", "14", NO_DFLT_PREC, },
	135	};
	136
3cdad416 GS	137	SR_PRIV const struct scpi_dmm_model models[] = {
	138	{
	139	"Agilent", "34405A",
64d03de1	140	1, 5, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
3cdad416	141	scpi_dmm_get_meas_agilent,
1d2f9963	142	ARRAY_AND_SIZE(devopts_generic),
1c8110db	143	0,
3cdad416	144	},
85cff5cf MW	145	{
	146	"Agilent", "34410A",
	147	1, 6, cmdset_hp, ARRAY_AND_SIZE(mqopts_agilent_34405a),
	148	scpi_dmm_get_meas_agilent,
	149	ARRAY_AND_SIZE(devopts_generic),
	150	0,
	151	},
08e8c0e5 MW	152	{
	153	"Keysight", "34465A",
	154	1, 5, cmdset_agilent, ARRAY_AND_SIZE(mqopts_agilent_34405a),
	155	scpi_dmm_get_meas_agilent,
	156	ARRAY_AND_SIZE(devopts_generic),
1c8110db	157	0,
a1619831 AG	158	},
	159	{
	160	"HP", "34401A",
	161	1, 6, cmdset_hp, ARRAY_AND_SIZE(mqopts_agilent_34401a),
	162	scpi_dmm_get_meas_agilent,
	163	ARRAY_AND_SIZE(devopts_generic),
	164	/* 34401A: typ. 1020ms for AC readings (default is 1000ms). */
1c8110db	165	1000 * 1500,
08e8c0e5	166	},
d0b602f0 TK	167	{
	168	"GW", "GDM8251A",
	169	1, 6, cmdset_gwinstek, ARRAY_AND_SIZE(mqopts_gwinstek_gdm8200a),
	170	scpi_dmm_get_meas_gwinstek,
	171	ARRAY_AND_SIZE(devopts_generic),
	172	1000 * 2500,
	173	},
	174	{
	175	"GW", "GDM8255A",
	176	1, 6, cmdset_gwinstek, ARRAY_AND_SIZE(mqopts_gwinstek_gdm8200a),
	177	scpi_dmm_get_meas_gwinstek,
	178	ARRAY_AND_SIZE(devopts_generic),
	179	1000 * 2500,
	180	},
3cdad416 GS	181	};
	182
	183	static const struct scpi_dmm_model is_compatible(const char vendor, const char *model)
7a396ff5	184	{
3cdad416 GS	185	size_t i;
	186	const struct scpi_dmm_model *entry;
	187
	188	for (i = 0; i < ARRAY_SIZE(models); i++) {
	189	entry = &models[i];
	190	if (!entry->vendor \|\| !entry->model)
	191	continue;
	192	if (strcmp(vendor, entry->vendor) != 0)
	193	continue;
	194	if (strcmp(model, entry->model) != 0)
	195	continue;
	196	return entry;
	197	}
7a396ff5	198
3cdad416 GS	199	return NULL;
3cdad416 GS	200	}
7a396ff5	201
3cdad416 GS	202	static struct sr_dev_inst probe_device(struct sr_scpi_dev_inst scpi)
	203	{
	204	struct sr_scpi_hw_info *hw_info;
	205	int ret;
	206	const char *vendor;
	207	const struct scpi_dmm_model *model;
	208	struct sr_dev_inst *sdi;
	209	struct dev_context *devc;
	210	size_t i;
	211	gchar *channel_name;
	212
3cdad416	213	scpi_dmm_cmd_delay(scpi);
28877994	214	ret = sr_scpi_get_hw_id(scpi, &hw_info);
3cdad416 GS	215	if (ret != SR_OK) {
	216	sr_info("Could not get IDN response.");
	217	return NULL;
	218	}
	219	vendor = sr_vendor_alias(hw_info->manufacturer);
	220	model = is_compatible(vendor, hw_info->model);
	221	if (!model) {
	222	sr_scpi_hw_info_free(hw_info);
	223	return NULL;
	224	}
7a396ff5	225
3cdad416 GS	226	sdi = g_malloc0(sizeof(*sdi));
	227	sdi->vendor = g_strdup(hw_info->manufacturer);
	228	sdi->model = g_strdup(hw_info->model);
	229	sdi->version = g_strdup(hw_info->firmware_version);
	230	sdi->serial_num = g_strdup(hw_info->serial_number);
	231	sdi->conn = scpi;
	232	sdi->driver = &scpi_dmm_driver_info;
	233	sdi->inst_type = SR_INST_SCPI;
	234	sr_scpi_hw_info_free(hw_info);
1c8110db	235	if (model->read_timeout_us) /* non-default read timeout */
a1619831	236	scpi->read_timeout_us = model->read_timeout_us;
3cdad416 GS	237	devc = g_malloc0(sizeof(*devc));
	238	sdi->priv = devc;
	239	devc->num_channels = model->num_channels;
	240	devc->cmdset = model->cmdset;
	241	devc->model = model;
d0b602f0	242	devc->precision = NULL;
3cdad416 GS	243
	244	for (i = 0; i < devc->num_channels; i++) {
	245	channel_name = g_strdup_printf("P%zu", i + 1);
	246	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, channel_name);
	247	}
	248
	249	return sdi;
	250	}
7a396ff5	251
3cdad416 GS	252	static GSList scan(struct sr_dev_driver di, GSList *options)
	253	{
	254	return sr_scpi_scan(di->context, options, probe_device);
7a396ff5 GS	255	}
	256
	257	static int dev_open(struct sr_dev_inst *sdi)
	258	{
3cdad416 GS	259	struct sr_scpi_dev_inst *scpi;
3cdad416 GS	260	int ret;
7a396ff5	261
3cdad416 GS	262	scpi = sdi->conn;
	263	ret = sr_scpi_open(scpi);
	264	if (ret < 0) {
	265	sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
	266	return SR_ERR;
	267	}
7a396ff5 GS	268
	269	return SR_OK;
	270	}
	271
	272	static int dev_close(struct sr_dev_inst *sdi)
	273	{
3cdad416	274	struct sr_scpi_dev_inst *scpi;
7a396ff5	275
3cdad416 GS	276	scpi = sdi->conn;
	277	if (!scpi)
	278	return SR_ERR_BUG;
7a396ff5	279
3cdad416 GS	280	sr_dbg("DIAG: sdi->status %d.", sdi->status - SR_ST_NOT_FOUND);
	281	if (sdi->status <= SR_ST_INACTIVE)
	282	return SR_OK;
	283
	284	return sr_scpi_close(scpi);
7a396ff5 GS	285	}
	286
	287	static int config_get(uint32_t key, GVariant **data,
	288	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	289	{
3cdad416 GS	290	struct dev_context *devc;
	291	enum sr_mq mq;
	292	enum sr_mqflag mqflag;
	293	GVariant *arr[2];
7a396ff5 GS	294	int ret;
7a396ff5 GS	295
7a396ff5 GS	296	(void)cg;
7a396ff5 GS	297
3cdad416 GS	298	devc = sdi->priv;
3cdad416 GS	299
7a396ff5	300	switch (key) {
3cdad416 GS	301	case SR_CONF_LIMIT_SAMPLES:
	302	case SR_CONF_LIMIT_MSEC:
	303	return sr_sw_limits_config_get(&devc->limits, key, data);
	304	case SR_CONF_MEASURED_QUANTITY:
08f3b427	305	ret = scpi_dmm_get_mq(sdi, &mq, &mqflag, NULL, NULL);
3cdad416 GS	306	if (ret != SR_OK)
	307	return ret;
	308	arr[0] = g_variant_new_uint32(mq);
	309	arr[1] = g_variant_new_uint64(mqflag);
	310	*data = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
	311	return SR_OK;
7a396ff5 GS	312	default:
	313	return SR_ERR_NA;
	314	}
7a396ff5 GS	315	}
	316
	317	static int config_set(uint32_t key, GVariant *data,
	318	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	319	{
3cdad416 GS	320	struct dev_context *devc;
	321	enum sr_mq mq;
	322	enum sr_mqflag mqflag;
	323	GVariant *tuple_child;
7a396ff5	324
7a396ff5 GS	325	(void)cg;
7a396ff5 GS	326
3cdad416 GS	327	devc = sdi->priv;
3cdad416 GS	328
7a396ff5	329	switch (key) {
3cdad416 GS	330	case SR_CONF_LIMIT_SAMPLES:
	331	case SR_CONF_LIMIT_MSEC:
	332	return sr_sw_limits_config_set(&devc->limits, key, data);
	333	case SR_CONF_MEASURED_QUANTITY:
	334	tuple_child = g_variant_get_child_value(data, 0);
	335	mq = g_variant_get_uint32(tuple_child);
ff5fb185	336	g_variant_unref(tuple_child);
3cdad416 GS	337	tuple_child = g_variant_get_child_value(data, 1);
	338	mqflag = g_variant_get_uint64(tuple_child);
	339	g_variant_unref(tuple_child);
	340	return scpi_dmm_set_mq(sdi, mq, mqflag);
7a396ff5	341	default:
3cdad416	342	return SR_ERR_NA;
7a396ff5	343	}
7a396ff5 GS	344	}
	345
	346	static int config_list(uint32_t key, GVariant **data,
	347	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	348	{
3cdad416 GS	349	struct dev_context *devc;
	350	GVariant gvar, arr[2];
	351	GVariantBuilder gvb;
	352	size_t i;
7a396ff5	353
7a396ff5 GS	354	(void)cg;
7a396ff5 GS	355
3cdad416 GS	356	devc = sdi ? sdi->priv : NULL;
3cdad416 GS	357
7a396ff5	358	switch (key) {
3cdad416 GS	359	case SR_CONF_SCAN_OPTIONS:
3cdad416 GS	360	case SR_CONF_DEVICE_OPTIONS:
1d2f9963 GS	361	if (!devc)
	362	return STD_CONFIG_LIST(key, data, sdi, cg,
	363	scanopts, drvopts, devopts_generic);
	364	return std_opts_config_list(key, data, sdi, cg,
	365	ARRAY_AND_SIZE(scanopts), ARRAY_AND_SIZE(drvopts),
	366	devc->model->devopts, devc->model->devopts_size);
3cdad416 GS	367	case SR_CONF_MEASURED_QUANTITY:
	368	/* TODO Use std_gvar_measured_quantities() when available. */
	369	if (!devc)
	370	return SR_ERR_ARG;
	371	g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
	372	for (i = 0; i < devc->model->mqopt_size; i++) {
	373	arr[0] = g_variant_new_uint32(devc->model->mqopts[i].mq);
	374	arr[1] = g_variant_new_uint64(devc->model->mqopts[i].mqflag);
	375	gvar = g_variant_new_tuple(arr, ARRAY_SIZE(arr));
	376	g_variant_builder_add_value(&gvb, gvar);
	377	}
	378	*data = g_variant_builder_end(&gvb);
	379	return SR_OK;
7a396ff5	380	default:
3cdad416	381	(void)devc;
7a396ff5 GS	382	return SR_ERR_NA;
7a396ff5 GS	383	}
7a396ff5 GS	384	}
	385
	386	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	387	{
3cdad416 GS	388	struct sr_scpi_dev_inst *scpi;
	389	struct dev_context *devc;
	390	int ret;
08f3b427	391	const struct mqopt_item *item;
3cdad416	392	const char *command;
d0b602f0	393	char *response;
3cdad416 GS	394
	395	scpi = sdi->conn;
	396	devc = sdi->priv;
	397
	398	ret = scpi_dmm_get_mq(sdi, &devc->start_acq_mq.curr_mq,
08f3b427	399	&devc->start_acq_mq.curr_mqflag, NULL, &item);
3cdad416 GS	400	if (ret != SR_OK)
	401	return ret;
	402
d0b602f0 TK	403	/*
	404	* Query for current precision if DMM supports the command
	405	*/
	406	command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_QUERY_PREC);
	407	if (command && *command) {
	408	scpi_dmm_cmd_delay(scpi);
	409	ret = sr_scpi_get_string(scpi, command, &response);
	410	if (ret == SR_OK) {
	411	g_strstrip(response);
	412	if (devc->precision)
	413	g_free(devc->precision);
	414	devc->precision=g_strdup(response);
	415	g_free(response);
	416	sr_dbg("%s: Precision: '%s'", __func__, devc->precision);
	417	} else {
	418	sr_info("%s: Precision query ('%s') failed: %d",
	419	__func__, command, ret);
	420	}
	421	}
	422
3cdad416 GS	423	command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_START_ACQ);
3cdad416 GS	424	if (command && *command) {
3cdad416	425	scpi_dmm_cmd_delay(scpi);
28877994	426	ret = sr_scpi_send(scpi, command);
3cdad416 GS	427	if (ret != SR_OK)
	428	return ret;
	429	}
7a396ff5	430
3cdad416 GS	431	sr_sw_limits_acquisition_start(&devc->limits);
	432	ret = std_session_send_df_header(sdi);
	433	if (ret != SR_OK)
	434	return ret;
	435
	436	ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
	437	scpi_dmm_receive_data, (void *)sdi);
	438	if (ret != SR_OK)
	439	return ret;
7a396ff5 GS	440
	441	return SR_OK;
	442	}
	443
	444	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	445	{
3cdad416 GS	446	struct sr_scpi_dev_inst *scpi;
	447	struct dev_context *devc;
	448	const char *command;
	449
	450	scpi = sdi->conn;
	451	devc = sdi->priv;
7a396ff5	452
3cdad416 GS	453	command = sr_scpi_cmd_get(devc->cmdset, DMM_CMD_STOP_ACQ);
3cdad416 GS	454	if (command && *command) {
3cdad416	455	scpi_dmm_cmd_delay(scpi);
28877994	456	(void)sr_scpi_send(scpi, command);
3cdad416 GS	457	}
	458	sr_scpi_source_remove(sdi->session, scpi);
	459
	460	std_session_send_df_end(sdi);
7a396ff5	461
d0b602f0 TK	462	if (devc->precision) {
	463	g_free(devc->precision);
	464	devc->precision = NULL;
	465	}
	466
7a396ff5 GS	467	return SR_OK;
	468	}
	469
0617bb5a	470	static struct sr_dev_driver scpi_dmm_driver_info = {
7a396ff5 GS	471	.name = "scpi-dmm",
	472	.longname = "SCPI DMM",
	473	.api_version = 1,
	474	.init = std_init,
	475	.cleanup = std_cleanup,
	476	.scan = scan,
	477	.dev_list = std_dev_list,
	478	.dev_clear = std_dev_clear,
	479	.config_get = config_get,
	480	.config_set = config_set,
	481	.config_list = config_list,
	482	.dev_open = dev_open,
	483	.dev_close = dev_close,
	484	.dev_acquisition_start = dev_acquisition_start,
	485	.dev_acquisition_stop = dev_acquisition_stop,
	486	.context = NULL,
	487	};
7a396ff5	488	SR_REGISTER_DEV_DRIVER(scpi_dmm_driver_info);