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

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <string.h>
#include "protocol.h"

SR_PRIV struct sr_dev_driver scpi_pps_driver_info;
static struct sr_dev_driver *di = &scpi_pps_driver_info;
extern unsigned int num_pps_profiles;
extern const struct scpi_pps pps_profiles[];

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

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

static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
{
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_scpi_hw_info *hw_info;
	struct sr_channel_group *cg;
	struct sr_channel *ch;
	const struct scpi_pps *device;
	const struct channel_group_spec *cgs;
	struct pps_channel_group *pcg;
	GRegex *model_re;
	GMatchInfo *model_mi;
	uint64_t mask;
	unsigned int i, j;
	const char *vendor;

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

	device = NULL;
	for (i = 0; i < num_pps_profiles; i++) {
		vendor = get_vendor(hw_info->manufacturer);
		if (strcasecmp(vendor, pps_profiles[i].vendor))
			continue;
		model_re = g_regex_new(pps_profiles[i].model, 0, 0, NULL);
		if (g_regex_match(model_re, hw_info->model, 0, &model_mi))
			device = &pps_profiles[i];
		g_match_info_unref(model_mi);
		g_regex_unref(model_re);
		if (device)
			break;
	}
	if (!device) {
		sr_scpi_hw_info_free(hw_info);
		return NULL;
	}

	sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, vendor, hw_info->model,
			hw_info->firmware_version);
	sdi->conn = scpi;
	sdi->driver = di;
	sdi->inst_type = SR_INST_SCPI;
	devc = g_malloc0(sizeof(struct dev_context));
	devc->device = device;
	sdi->priv = devc;

	for (i = 0; i < device->num_channels; i++) {
		ch = sr_channel_new(i, SR_CHANNEL_ANALOG, TRUE,
				device->channels[i].name);
		sdi->channels = g_slist_append(sdi->channels, ch);
	}

	for (i = 0; i < device->num_channel_groups; i++) {
		cgs = &device->channel_groups[i];
		cg = g_malloc0(sizeof(struct sr_channel_group));
		cg->name = g_strdup(cgs->name);
		for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
			if (cgs->channel_index_mask & mask) {
				ch = g_slist_nth_data(sdi->channels, j);
				cg->channels = g_slist_append(cg->channels, ch);
			}
		}
		pcg = g_malloc0(sizeof(struct pps_channel_group));
		pcg->features = cgs->features;
		cg->priv = pcg;
		sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
	}

	/* SCPI devices commonly lock the panel keys when accessed remotely. */
	scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
	sr_scpi_close(scpi);

	return sdi;
}

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

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

static int dev_clear(void)
{
	return std_dev_clear(di, NULL);
}

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

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

	scpi = sdi->conn;
	if (sr_scpi_open(scpi) < 0)
		return SR_ERR;

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

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

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

	scpi = sdi->conn;
	if (scpi) {
		scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
		sr_scpi_close(scpi);
		sdi->status = SR_ST_INACTIVE;
	}

	return SR_OK;
}

static int cleanup(void)
{
	return SR_OK;
}

static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	struct sr_scpi_dev_inst *scpi;
	struct sr_channel *ch;
	const GVariantType *gvtype;
	unsigned int i;
	int cmd, ret;
	char *s;

	if (!sdi)
		return SR_ERR_ARG;

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

	if (cg) {
		/*
		 * These options only apply to channel groups with a single
		 * channel -- they're per-channel settings for the device.
		 */
		if (g_slist_length(cg->channels) > 1)
			return SR_ERR_NA;

		/*
		 * Config keys are handled below depending on whether a channel
		 * group was provided by the frontend. However some of these
		 * take a CG on one PPS but not on others. Check the device's
		 * profile for that here, and NULL out the channel group as needed.
		 */
		for (i = 0; i < devc->device->num_devopts; i++) {
			if (devc->device->devopts[i] == key) {
				cg = NULL;
				break;
			}
		}

		ch = cg->channels->data;
	}

	gvtype = NULL;
	cmd = -1;
	switch (key) {
	case SR_CONF_OUTPUT_ENABLED:
		gvtype = G_VARIANT_TYPE_BOOLEAN;
		cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
		break;
	case SR_CONF_OUTPUT_VOLTAGE:
		gvtype = G_VARIANT_TYPE_DOUBLE;
		cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
		break;
	case SR_CONF_OUTPUT_VOLTAGE_MAX:
		gvtype = G_VARIANT_TYPE_DOUBLE;
		cmd = SCPI_CMD_GET_VOLTAGE_MAX;
		break;
	case SR_CONF_OUTPUT_CURRENT:
		gvtype = G_VARIANT_TYPE_DOUBLE;
		cmd = SCPI_CMD_GET_MEAS_CURRENT;
		break;
	case SR_CONF_OUTPUT_CURRENT_MAX:
		gvtype = G_VARIANT_TYPE_DOUBLE;
		cmd = SCPI_CMD_GET_CURRENT_MAX;
		break;
	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
		gvtype = G_VARIANT_TYPE_BOOLEAN;
		cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
		break;
	case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
		gvtype = G_VARIANT_TYPE_BOOLEAN;
		cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
		break;
	case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
		gvtype = G_VARIANT_TYPE_DOUBLE;
		cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
		break;
	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
		gvtype = G_VARIANT_TYPE_BOOLEAN;
		cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
		break;
	case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
		gvtype = G_VARIANT_TYPE_BOOLEAN;
		cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
		break;
	case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
		gvtype = G_VARIANT_TYPE_DOUBLE;
		cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
		break;
	case SR_CONF_OVER_TEMPERATURE_PROTECTION:
		gvtype = G_VARIANT_TYPE_BOOLEAN;
		cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
		break;
	}
	if (gvtype) {
		if (cg)
			ret = scpi_cmd_resp(sdi, data, gvtype, cmd, ch->name);
		else
			ret = scpi_cmd_resp(sdi, data, gvtype, cmd);
	} else if (cg) {
		switch (key) {
		case SR_CONF_OUTPUT_REGULATION:
			ret = SR_ERR;
			if (scpi_cmd(sdi, SCPI_CMD_GET_OUTPUT_REGULATION, ch->name) == SR_OK) {
				if (sr_scpi_get_string(scpi, NULL, &s) == SR_OK) {
					if (strcmp(s, "CC") && strcmp(s, "CV") && strcmp(s, "UR")) {
						sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
					} else {
						*data = g_variant_new_string(s);
						g_free(s);
						ret = SR_OK;
					}
				}
			}
			break;
		default:
			ret = SR_ERR_NA;
		}
	} else
		ret = SR_ERR_NA;

	return ret;
}

static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct sr_channel *ch;
	double d;
	int ret;
	const char *s;

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

	ret = SR_OK;
	if (!cg) {
		switch (key) {
		/* No channel group: global options. */
		case SR_CONF_OUTPUT_ENABLED:
			s = g_variant_get_boolean(data) ? "ON" : "OFF";
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLED, s);
			break;
		case SR_CONF_OUTPUT_VOLTAGE_MAX:
			d = g_variant_get_double(data);
			ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_MAX, d);
			break;
		case SR_CONF_OUTPUT_CURRENT_MAX:
			d = g_variant_get_double(data);
			ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_MAX, d);
			break;
		case SR_CONF_OVER_TEMPERATURE_PROTECTION:
			s = g_variant_get_boolean(data) ? "ON" : "OFF";
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION, s);
			break;
		default:
			ret = SR_ERR_NA;
		}
	} else {
		/* Channel group specified. */
		if (!sdi)
			return SR_ERR_ARG;
		if (g_slist_length(cg->channels) > 1)
			return SR_ERR_NA;
		ch = cg->channels->data;
		switch (key) {
		case SR_CONF_OUTPUT_ENABLED:
			s = g_variant_get_boolean(data) ? "ON" : "OFF";
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLED, ch->name, s);
			break;
		case SR_CONF_OUTPUT_VOLTAGE_MAX:
			d = g_variant_get_double(data);
			ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_MAX, ch->name, d);
			break;
		case SR_CONF_OUTPUT_CURRENT_MAX:
			d = g_variant_get_double(data);
			ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_MAX, ch->name, d);
			break;
		case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
			s = g_variant_get_boolean(data) ? "ON" : "OFF";
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLED,
					ch->name, s);
			break;
		case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
			d = g_variant_get_double(data);
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
					ch->name, d);
			break;
		case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
			s = g_variant_get_boolean(data) ? "ON" : "OFF";
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLED,
					ch->name, s);
			break;
		case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
			d = g_variant_get_double(data);
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD,
					ch->name, d);
			break;
		default:
			ret = SR_ERR_NA;
		}
	}

	return ret;
}

static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	struct sr_channel *ch;
	struct channel_spec *ch_spec;
	GVariant *gvar;
	GVariantBuilder gvb;
	int ret, i;
	const char *s[16];

	/* Always available, even without sdi. */
	if (key == SR_CONF_SCAN_OPTIONS) {
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(int32_t));
		return SR_OK;
	}

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

	ret = SR_OK;
	if (!cg) {
		/* No channel group: global options. */
		switch (key) {
		case SR_CONF_DEVICE_OPTIONS:
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
					devc->device->devopts, devc->device->num_devopts,
					sizeof(int32_t));
			break;
		case SR_CONF_OUTPUT_CHANNEL_CONFIG:
			/* Not used. */
			i = 0;
			if (devc->device->features & PPS_INDEPENDENT)
				s[i++] = "Independent";
			if (devc->device->features & PPS_SERIES)
				s[i++] = "Series";
			if (devc->device->features & PPS_PARALLEL)
				s[i++] = "Parallel";
			if (i == 0) {
				/*
				 * Shouldn't happen: independent-only devices
				 * shouldn't advertise this option at all.
				 */
				return SR_ERR_NA;
			}
			*data = g_variant_new_strv(s, i);
			break;
		default:
			return SR_ERR_NA;
		}
	} else {
		/* Channel group specified. */
		if (!sdi)
			return SR_ERR_ARG;
		/*
		 * Per-channel-group options depending on a channel are actually
		 * done with the first channel. Channel groups in PPS can have
		 * more than one channel, but they will typically be of equal
		 * specification for use in series or parallel mode. Drop requests
		 * for groups with more than one channel just to make sure.
		 */
		if (g_slist_length(cg->channels) > 1)
			return SR_ERR_NA;
		ch = cg->channels->data;

		switch (key) {
		case SR_CONF_DEVICE_OPTIONS:
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
					devc->device->devopts_cg, devc->device->num_devopts_cg,
					sizeof(int32_t));
			break;
		case SR_CONF_OUTPUT_VOLTAGE_MAX:
			ch_spec = &(devc->device->channels[ch->index]);
			g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
			/* Min, max, write resolution. */
			for (i = 0; i < 3; i++) {
				gvar = g_variant_new_double(ch_spec->voltage[i]);
				g_variant_builder_add_value(&gvb, gvar);
			}
			*data = g_variant_builder_end(&gvb);
			break;
		case SR_CONF_OUTPUT_CURRENT_MAX:
			g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
			/* Min, max, step. */
			for (i = 0; i < 3; i++) {
				ch_spec = &(devc->device->channels[ch->index]);
				gvar = g_variant_new_double(ch_spec->current[i]);
				g_variant_builder_add_value(&gvb, gvar);
			}
			*data = g_variant_builder_end(&gvb);
			break;
		default:
			return SR_ERR_NA;
		}
	}

	return ret;
}

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

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

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

	if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100,
			scpi_pps_receive_data, (void *)sdi)) != SR_OK)
		return ret;
	std_session_send_df_header(sdi, LOG_PREFIX);

	/* Prime the pipe. */
	devc->state = STATE_VOLTAGE;
	ch = sdi->channels->data;
	devc->cur_channel = ch;
	scpi_cmd(sdi, SCPI_CMD_GET_MEAS_VOLTAGE, ch->name);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	struct dev_context *devc;
	struct sr_scpi_dev_inst *scpi;
	float f;

	(void)cb_data;

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

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

	/*
	 * A requested value is certainly on the way. Retrieve it now,
	 * to avoid leaving the device in a state where it's not expecting
	 * commands.
	 */
	sr_scpi_get_float(scpi, NULL, &f);
	sr_scpi_source_remove(sdi->session, scpi);

	/* Just in case something is queued up. */
	devc->state = STATE_STOP;

	return SR_OK;
}

SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
	.name = "scpi-pps",
	.longname = "SCPI PPS",
	.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
ca1a7cb5 BV	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
	5	*
	6	* This program is free software: you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation, either version 3 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
9e45cd41	20	#include <string.h>
ca1a7cb5 BV	21	#include "protocol.h"
	22
	23	SR_PRIV struct sr_dev_driver scpi_pps_driver_info;
	24	static struct sr_dev_driver *di = &scpi_pps_driver_info;
d4eabea8 BV	25	extern unsigned int num_pps_profiles;
d4eabea8 BV	26	extern const struct scpi_pps pps_profiles[];
9e45cd41 BV	27
	28	static const int32_t scanopts[] = {
	29	SR_CONF_CONN,
	30	SR_CONF_SERIALCOMM,
	31	};
ca1a7cb5 BV	32
	33	static int init(struct sr_context *sr_ctx)
	34	{
	35	return std_init(sr_ctx, di, LOG_PREFIX);
	36	}
	37
9e45cd41	38	static struct sr_dev_inst probe_device(struct sr_scpi_dev_inst scpi)
ca1a7cb5	39	{
9e45cd41 BV	40	struct dev_context *devc;
	41	struct sr_dev_inst *sdi;
	42	struct sr_scpi_hw_info *hw_info;
	43	struct sr_channel_group *cg;
	44	struct sr_channel *ch;
	45	const struct scpi_pps *device;
	46	const struct channel_group_spec *cgs;
	47	struct pps_channel_group *pcg;
58b77c41 BV	48	GRegex *model_re;
58b77c41 BV	49	GMatchInfo *model_mi;
9e45cd41 BV	50	uint64_t mask;
9e45cd41 BV	51	unsigned int i, j;
22c18b03	52	const char *vendor;
9e45cd41 BV	53
	54	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
	55	sr_info("Couldn't get IDN response.");
	56	return NULL;
	57	}
	58
	59	device = NULL;
	60	for (i = 0; i < num_pps_profiles; i++) {
22c18b03	61	vendor = get_vendor(hw_info->manufacturer);
58b77c41	62	if (strcasecmp(vendor, pps_profiles[i].vendor))
22c18b03	63	continue;
58b77c41 BV	64	model_re = g_regex_new(pps_profiles[i].model, 0, 0, NULL);
58b77c41 BV	65	if (g_regex_match(model_re, hw_info->model, 0, &model_mi))
9e45cd41	66	device = &pps_profiles[i];
58b77c41 BV	67	g_match_info_unref(model_mi);
	68	g_regex_unref(model_re);
	69	if (device)
9e45cd41	70	break;
9e45cd41 BV	71	}
	72	if (!device) {
	73	sr_scpi_hw_info_free(hw_info);
	74	return NULL;
	75	}
	76
58b77c41 BV	77	sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, vendor, hw_info->model,
58b77c41 BV	78	hw_info->firmware_version);
9e45cd41 BV	79	sdi->conn = scpi;
	80	sdi->driver = di;
	81	sdi->inst_type = SR_INST_SCPI;
	82	devc = g_malloc0(sizeof(struct dev_context));
	83	devc->device = device;
	84	sdi->priv = devc;
	85
	86	for (i = 0; i < device->num_channels; i++) {
	87	ch = sr_channel_new(i, SR_CHANNEL_ANALOG, TRUE,
	88	device->channels[i].name);
	89	sdi->channels = g_slist_append(sdi->channels, ch);
	90	}
ca1a7cb5	91
9e45cd41 BV	92	for (i = 0; i < device->num_channel_groups; i++) {
	93	cgs = &device->channel_groups[i];
	94	cg = g_malloc0(sizeof(struct sr_channel_group));
	95	cg->name = g_strdup(cgs->name);
	96	for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
	97	if (cgs->channel_index_mask & mask) {
	98	ch = g_slist_nth_data(sdi->channels, j);
	99	cg->channels = g_slist_append(cg->channels, ch);
	100	}
	101	}
	102	pcg = g_malloc0(sizeof(struct pps_channel_group));
	103	pcg->features = cgs->features;
	104	cg->priv = pcg;
	105	sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
	106	}
ca1a7cb5	107
9e45cd41 BV	108	/* SCPI devices commonly lock the panel keys when accessed remotely. */
	109	scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
	110	sr_scpi_close(scpi);
ca1a7cb5	111
9e45cd41 BV	112	return sdi;
9e45cd41 BV	113	}
ca1a7cb5	114
9e45cd41 BV	115	static GSList scan(GSList options)
	116	{
	117	return sr_scpi_scan(di->priv, options, probe_device);
ca1a7cb5 BV	118	}
	119
	120	static GSList *dev_list(void)
	121	{
	122	return ((struct drv_context *)(di->priv))->instances;
	123	}
	124
	125	static int dev_clear(void)
	126	{
	127	return std_dev_clear(di, NULL);
	128	}
	129
	130	static int dev_open(struct sr_dev_inst *sdi)
	131	{
9e45cd41 BV	132	struct sr_scpi_dev_inst *scpi;
	133
	134	if (sdi->status != SR_ST_ACTIVE)
	135	return SR_ERR;
ca1a7cb5	136
9e45cd41 BV	137	scpi = sdi->conn;
	138	if (sr_scpi_open(scpi) < 0)
	139	return SR_ERR;
ca1a7cb5 BV	140
	141	sdi->status = SR_ST_ACTIVE;
	142
	143	return SR_OK;
	144	}
	145
	146	static int dev_close(struct sr_dev_inst *sdi)
	147	{
9e45cd41	148	struct sr_scpi_dev_inst *scpi;
ca1a7cb5	149
9e45cd41 BV	150	if (sdi->status != SR_ST_ACTIVE)
9e45cd41 BV	151	return SR_ERR_DEV_CLOSED;
ca1a7cb5	152
9e45cd41 BV	153	scpi = sdi->conn;
	154	if (scpi) {
	155	scpi_cmd(sdi, SCPI_CMD_KEY_UNLOCK);
	156	sr_scpi_close(scpi);
	157	sdi->status = SR_ST_INACTIVE;
	158	}
ca1a7cb5 BV	159
	160	return SR_OK;
	161	}
	162
	163	static int cleanup(void)
	164	{
ca1a7cb5 BV	165	return SR_OK;
	166	}
	167
	168	static int config_get(int key, GVariant *data, const struct sr_dev_inst sdi,
	169	const struct sr_channel_group *cg)
	170	{
9e45cd41 BV	171	struct dev_context *devc;
	172	struct sr_scpi_dev_inst *scpi;
	173	struct sr_channel *ch;
478c8d92 BV	174	const GVariantType *gvtype;
	175	unsigned int i;
	176	int cmd, ret;
9e45cd41	177	char *s;
ca1a7cb5	178
9e45cd41 BV	179	if (!sdi)
	180	return SR_ERR_ARG;
	181
	182	devc = sdi->priv;
	183	scpi = sdi->conn;
ca1a7cb5	184
478c8d92	185	if (cg) {
9e45cd41 BV	186	/*
	187	* These options only apply to channel groups with a single
	188	* channel -- they're per-channel settings for the device.
	189	*/
	190	if (g_slist_length(cg->channels) > 1)
	191	return SR_ERR_NA;
478c8d92 BV	192
	193	/*
	194	* Config keys are handled below depending on whether a channel
	195	* group was provided by the frontend. However some of these
	196	* take a CG on one PPS but not on others. Check the device's
	197	* profile for that here, and NULL out the channel group as needed.
	198	*/
	199	for (i = 0; i < devc->device->num_devopts; i++) {
	200	if (devc->device->devopts[i] == key) {
	201	cg = NULL;
	202	break;
	203	}
	204	}
	205
9e45cd41	206	ch = cg->channels->data;
478c8d92	207	}
9e45cd41	208
478c8d92 BV	209	gvtype = NULL;
	210	cmd = -1;
	211	switch (key) {
	212	case SR_CONF_OUTPUT_ENABLED:
	213	gvtype = G_VARIANT_TYPE_BOOLEAN;
	214	cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
	215	break;
	216	case SR_CONF_OUTPUT_VOLTAGE:
	217	gvtype = G_VARIANT_TYPE_DOUBLE;
	218	cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
	219	break;
	220	case SR_CONF_OUTPUT_VOLTAGE_MAX:
	221	gvtype = G_VARIANT_TYPE_DOUBLE;
	222	cmd = SCPI_CMD_GET_VOLTAGE_MAX;
	223	break;
	224	case SR_CONF_OUTPUT_CURRENT:
	225	gvtype = G_VARIANT_TYPE_DOUBLE;
	226	cmd = SCPI_CMD_GET_MEAS_CURRENT;
	227	break;
	228	case SR_CONF_OUTPUT_CURRENT_MAX:
	229	gvtype = G_VARIANT_TYPE_DOUBLE;
	230	cmd = SCPI_CMD_GET_CURRENT_MAX;
	231	break;
	232	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
	233	gvtype = G_VARIANT_TYPE_BOOLEAN;
	234	cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
	235	break;
	236	case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
	237	gvtype = G_VARIANT_TYPE_BOOLEAN;
	238	cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
	239	break;
	240	case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
	241	gvtype = G_VARIANT_TYPE_DOUBLE;
	242	cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
	243	break;
	244	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
	245	gvtype = G_VARIANT_TYPE_BOOLEAN;
	246	cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
	247	break;
	248	case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
	249	gvtype = G_VARIANT_TYPE_BOOLEAN;
	250	cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
	251	break;
	252	case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
	253	gvtype = G_VARIANT_TYPE_DOUBLE;
	254	cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
	255	break;
	256	case SR_CONF_OVER_TEMPERATURE_PROTECTION:
	257	gvtype = G_VARIANT_TYPE_BOOLEAN;
	258	cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
	259	break;
	260	}
	261	if (gvtype) {
	262	if (cg)
	263	ret = scpi_cmd_resp(sdi, data, gvtype, cmd, ch->name);
	264	else
	265	ret = scpi_cmd_resp(sdi, data, gvtype, cmd);
	266	} else if (cg) {
9e45cd41 BV	267	switch (key) {
	268	case SR_CONF_OUTPUT_REGULATION:
	269	ret = SR_ERR;
	270	if (scpi_cmd(sdi, SCPI_CMD_GET_OUTPUT_REGULATION, ch->name) == SR_OK) {
	271	if (sr_scpi_get_string(scpi, NULL, &s) == SR_OK) {
	272	if (strcmp(s, "CC") && strcmp(s, "CV") && strcmp(s, "UR")) {
	273	sr_dbg("Unknown response to SCPI_CMD_GET_OUTPUT_REGULATION: %s", s);
	274	} else {
	275	*data = g_variant_new_string(s);
	276	g_free(s);
	277	ret = SR_OK;
	278	}
	279	}
	280	}
	281	break;
9e45cd41	282	default:
478c8d92	283	ret = SR_ERR_NA;
9e45cd41	284	}
478c8d92 BV	285	} else
478c8d92 BV	286	ret = SR_ERR_NA;
ca1a7cb5 BV	287
	288	return ret;
	289	}
	290
	291	static int config_set(int key, GVariant data, const struct sr_dev_inst sdi,
	292	const struct sr_channel_group *cg)
	293	{
9e45cd41 BV	294	struct sr_channel *ch;
9e45cd41 BV	295	double d;
ca1a7cb5	296	int ret;
9e45cd41	297	const char *s;
ca1a7cb5 BV	298
	299	if (sdi->status != SR_ST_ACTIVE)
	300	return SR_ERR_DEV_CLOSED;
	301
	302	ret = SR_OK;
9e45cd41 BV	303	if (!cg) {
	304	switch (key) {
	305	/* No channel group: global options. */
478c8d92	306	case SR_CONF_OUTPUT_ENABLED:
9e45cd41	307	s = g_variant_get_boolean(data) ? "ON" : "OFF";
478c8d92	308	ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLED, s);
9e45cd41	309	break;
478c8d92 BV	310	case SR_CONF_OUTPUT_VOLTAGE_MAX:
	311	d = g_variant_get_double(data);
	312	ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_MAX, d);
	313	break;
	314	case SR_CONF_OUTPUT_CURRENT_MAX:
	315	d = g_variant_get_double(data);
	316	ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_MAX, d);
	317	break;
	318	case SR_CONF_OVER_TEMPERATURE_PROTECTION:
	319	s = g_variant_get_boolean(data) ? "ON" : "OFF";
	320	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION, s);
9e45cd41 BV	321	break;
	322	default:
	323	ret = SR_ERR_NA;
	324	}
	325	} else {
	326	/* Channel group specified. */
	327	if (!sdi)
	328	return SR_ERR_ARG;
	329	if (g_slist_length(cg->channels) > 1)
	330	return SR_ERR_NA;
	331	ch = cg->channels->data;
	332	switch (key) {
478c8d92 BV	333	case SR_CONF_OUTPUT_ENABLED:
	334	s = g_variant_get_boolean(data) ? "ON" : "OFF";
	335	ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLED, ch->name, s);
	336	break;
9e45cd41 BV	337	case SR_CONF_OUTPUT_VOLTAGE_MAX:
9e45cd41 BV	338	d = g_variant_get_double(data);
478c8d92	339	ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_MAX, ch->name, d);
9e45cd41 BV	340	break;
	341	case SR_CONF_OUTPUT_CURRENT_MAX:
	342	d = g_variant_get_double(data);
478c8d92	343	ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_MAX, ch->name, d);
9e45cd41 BV	344	break;
	345	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
	346	s = g_variant_get_boolean(data) ? "ON" : "OFF";
478c8d92 BV	347	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLED,
478c8d92 BV	348	ch->name, s);
9e45cd41 BV	349	break;
	350	case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
	351	d = g_variant_get_double(data);
478c8d92 BV	352	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD,
478c8d92 BV	353	ch->name, d);
9e45cd41 BV	354	break;
	355	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
	356	s = g_variant_get_boolean(data) ? "ON" : "OFF";
478c8d92 BV	357	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLED,
478c8d92 BV	358	ch->name, s);
9e45cd41 BV	359	break;
	360	case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
	361	d = g_variant_get_double(data);
478c8d92 BV	362	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD,
478c8d92 BV	363	ch->name, d);
9e45cd41 BV	364	break;
	365	default:
	366	ret = SR_ERR_NA;
	367	}
ca1a7cb5 BV	368	}
	369
	370	return ret;
	371	}
	372
	373	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi,
	374	const struct sr_channel_group *cg)
	375	{
9e45cd41 BV	376	struct dev_context *devc;
	377	struct sr_channel *ch;
	378	struct channel_spec *ch_spec;
	379	GVariant *gvar;
	380	GVariantBuilder gvb;
	381	int ret, i;
	382	const char *s[16];
	383
	384	/* Always available, even without sdi. */
	385	if (key == SR_CONF_SCAN_OPTIONS) {
	386	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	387	scanopts, ARRAY_SIZE(scanopts), sizeof(int32_t));
	388	return SR_OK;
	389	}
ca1a7cb5	390
9e45cd41 BV	391	if (!sdi)
	392	return SR_ERR_ARG;
	393	devc = sdi->priv;
ca1a7cb5 BV	394
ca1a7cb5 BV	395	ret = SR_OK;
9e45cd41 BV	396	if (!cg) {
	397	/* No channel group: global options. */
	398	switch (key) {
	399	case SR_CONF_DEVICE_OPTIONS:
	400	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	401	devc->device->devopts, devc->device->num_devopts,
	402	sizeof(int32_t));
	403	break;
	404	case SR_CONF_OUTPUT_CHANNEL_CONFIG:
478c8d92	405	/* Not used. */
9e45cd41 BV	406	i = 0;
	407	if (devc->device->features & PPS_INDEPENDENT)
	408	s[i++] = "Independent";
	409	if (devc->device->features & PPS_SERIES)
	410	s[i++] = "Series";
	411	if (devc->device->features & PPS_PARALLEL)
	412	s[i++] = "Parallel";
	413	if (i == 0) {
	414	/*
	415	* Shouldn't happen: independent-only devices
	416	* shouldn't advertise this option at all.
	417	*/
	418	return SR_ERR_NA;
	419	}
	420	*data = g_variant_new_strv(s, i);
	421	break;
	422	default:
	423	return SR_ERR_NA;
	424	}
	425	} else {
	426	/* Channel group specified. */
	427	if (!sdi)
	428	return SR_ERR_ARG;
	429	/*
	430	* Per-channel-group options depending on a channel are actually
	431	* done with the first channel. Channel groups in PPS can have
	432	* more than one channel, but they will typically be of equal
	433	* specification for use in series or parallel mode. Drop requests
	434	* for groups with more than one channel just to make sure.
	435	*/
	436	if (g_slist_length(cg->channels) > 1)
	437	return SR_ERR_NA;
	438	ch = cg->channels->data;
	439
	440	switch (key) {
	441	case SR_CONF_DEVICE_OPTIONS:
	442	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	443	devc->device->devopts_cg, devc->device->num_devopts_cg,
	444	sizeof(int32_t));
	445	break;
	446	case SR_CONF_OUTPUT_VOLTAGE_MAX:
	447	ch_spec = &(devc->device->channels[ch->index]);
	448	g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
	449	/* Min, max, write resolution. */
	450	for (i = 0; i < 3; i++) {
	451	gvar = g_variant_new_double(ch_spec->voltage[i]);
	452	g_variant_builder_add_value(&gvb, gvar);
	453	}
	454	*data = g_variant_builder_end(&gvb);
	455	break;
	456	case SR_CONF_OUTPUT_CURRENT_MAX:
	457	g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
	458	/* Min, max, step. */
	459	for (i = 0; i < 3; i++) {
	460	ch_spec = &(devc->device->channels[ch->index]);
	461	gvar = g_variant_new_double(ch_spec->current[i]);
	462	g_variant_builder_add_value(&gvb, gvar);
	463	}
	464	*data = g_variant_builder_end(&gvb);
	465	break;
	466	default:
	467	return SR_ERR_NA;
	468	}
ca1a7cb5 BV	469	}
	470
	471	return ret;
	472	}
	473
	474	static int dev_acquisition_start(const struct sr_dev_inst *sdi,
9e45cd41	475	void *cb_data)
ca1a7cb5	476	{
9e45cd41 BV	477	struct dev_context *devc;
	478	struct sr_scpi_dev_inst *scpi;
	479	struct sr_channel *ch;
	480	int ret;
ca1a7cb5 BV	481
	482	if (sdi->status != SR_ST_ACTIVE)
	483	return SR_ERR_DEV_CLOSED;
	484
9e45cd41 BV	485	devc = sdi->priv;
	486	scpi = sdi->conn;
	487	devc->cb_data = cb_data;
	488
	489	if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 100,
	490	scpi_pps_receive_data, (void *)sdi)) != SR_OK)
	491	return ret;
	492	std_session_send_df_header(sdi, LOG_PREFIX);
	493
	494	/* Prime the pipe. */
	495	devc->state = STATE_VOLTAGE;
	496	ch = sdi->channels->data;
	497	devc->cur_channel = ch;
	498	scpi_cmd(sdi, SCPI_CMD_GET_MEAS_VOLTAGE, ch->name);
ca1a7cb5 BV	499
	500	return SR_OK;
	501	}
	502
	503	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	504	{
9e45cd41 BV	505	struct dev_context *devc;
	506	struct sr_scpi_dev_inst *scpi;
	507	float f;
	508
ca1a7cb5 BV	509	(void)cb_data;
	510
	511	if (sdi->status != SR_ST_ACTIVE)
	512	return SR_ERR_DEV_CLOSED;
	513
9e45cd41 BV	514	devc = sdi->priv;
	515	scpi = sdi->conn;
	516
	517	/*
	518	* A requested value is certainly on the way. Retrieve it now,
	519	* to avoid leaving the device in a state where it's not expecting
	520	* commands.
	521	*/
	522	sr_scpi_get_float(scpi, NULL, &f);
	523	sr_scpi_source_remove(sdi->session, scpi);
	524
	525	/* Just in case something is queued up. */
	526	devc->state = STATE_STOP;
ca1a7cb5 BV	527
	528	return SR_OK;
	529	}
	530
	531	SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
	532	.name = "scpi-pps",
	533	.longname = "SCPI PPS",
	534	.api_version = 1,
	535	.init = init,
	536	.cleanup = cleanup,
	537	.scan = scan,
	538	.dev_list = dev_list,
	539	.dev_clear = dev_clear,
	540	.config_get = config_get,
	541	.config_set = config_set,
	542	.config_list = config_list,
	543	.dev_open = dev_open,
	544	.dev_close = dev_close,
	545	.dev_acquisition_start = dev_acquisition_start,
	546	.dev_acquisition_stop = dev_acquisition_stop,
	547	.priv = NULL,
	548	};