[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 uint32_t scanopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static struct pps_channel_instance pci[] = {
	{ SR_MQ_VOLTAGE, SCPI_CMD_GET_MEAS_VOLTAGE, "V" },
	{ SR_MQ_CURRENT, SCPI_CMD_GET_MEAS_CURRENT, "I" },
	{ SR_MQ_POWER, SCPI_CMD_GET_MEAS_POWER, "P" },
};

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;
	struct pps_channel *pch;
	struct channel_spec *channels;
	struct channel_group_spec *channel_groups, *cgs;
	struct pps_channel_group *pcg;
	GRegex *model_re;
	GMatchInfo *model_mi;
	GSList *l;
	uint64_t mask;
	unsigned int num_channels, num_channel_groups, ch_num, ch_idx, i, j;
	int ret;
	const char *vendor;
	char ch_name[16];

	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(SR_ST_ACTIVE, vendor, hw_info->model,
			hw_info->firmware_version);
	sdi->conn = scpi;
	sdi->driver = di;
	sdi->inst_type = SR_INST_SCPI;
	sdi->serial_num = g_strdup(hw_info->serial_number);

	devc = g_malloc0(sizeof(struct dev_context));
	devc->device = device;
	sdi->priv = devc;

	if (device->num_channels) {
		/* Static channels and groups. */
		channels = device->channels;
		num_channels = device->num_channels;
		channel_groups = device->channel_groups;
		num_channel_groups = device->num_channel_groups;
	} else {
		/* Channels and groups need to be probed. */
		ret = device->probe_channels(sdi, hw_info, &channels, &num_channels,
				&channel_groups, &num_channel_groups);
		if (ret != SR_OK) {
			sr_err("Failed to probe for channels.");
			return NULL;
		}
		/*
		 * Since these were dynamically allocated, we'll need to free them
		 * later.
		 */
		devc->channels = channels;
		devc->channel_groups = channel_groups;
	}

	ch_idx = 0;
	for (ch_num = 0; ch_num < num_channels; ch_num++) {
		/* Create one channel per measurable output unit. */
		for (i = 0; i < ARRAY_SIZE(pci); i++) {
			if (!scpi_cmd_get(sdi, pci[i].command))
				continue;
			g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
					channels[ch_num].name);
			ch = sr_channel_new(ch_idx++, SR_CHANNEL_ANALOG, TRUE, ch_name);
			pch = g_malloc0(sizeof(struct pps_channel));
			pch->hw_output_idx = ch_num;
			pch->hwname = channels[ch_num].name;
			pch->mq = pci[i].mq;
			ch->priv = pch;
			sdi->channels = g_slist_append(sdi->channels, ch);
		}
	}

	for (i = 0; i < num_channel_groups; i++) {
		cgs = &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) {
				for (l = sdi->channels; l; l = l->next) {
					ch = l->data;
					pch = ch->priv;
					if (pch->hw_output_idx == 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);
	}

	sr_scpi_hw_info_free(hw_info);
	hw_info = NULL;

	scpi_cmd(sdi, SCPI_CMD_LOCAL);
	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 dev_context *devc;
	struct sr_scpi_dev_inst *scpi;
	GVariant *beeper;

	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;

	scpi_cmd(sdi, SCPI_CMD_REMOTE);
	devc = sdi->priv;
	devc->beeper_was_set = FALSE;
	if (scpi_cmd_resp(sdi, &beeper, G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
		if (g_variant_get_boolean(beeper)) {
			devc->beeper_was_set = TRUE;
			scpi_cmd(sdi, SCPI_CMD_BEEPER_DISABLE);
		}
		g_variant_unref(beeper);
	}

	return SR_OK;
}

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

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

	devc = sdi->priv;
	scpi = sdi->conn;
	if (scpi) {
		if (devc->beeper_was_set)
			scpi_cmd(sdi, SCPI_CMD_BEEPER_ENABLE);
		scpi_cmd(sdi, SCPI_CMD_LOCAL);
		sr_scpi_close(scpi);
		sdi->status = SR_ST_INACTIVE;
	}

	return SR_OK;
}

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

	devc = priv;
	g_free(devc->channels);
	g_free(devc->channel_groups);
	g_free(devc);
}

static int cleanup(void)
{
	return std_dev_clear(di, clear_helper);
}

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;
	const GVariantType *gvtype;
	unsigned int i;
	int cmd, ret;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;

	if (cg) {
		/*
		 * These options only apply to channel groups with a single
		 * channel -- they're per-channel settings for the device.
		 */

		/*
		 * 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;
			}
		}
	}

	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_TARGET:
		gvtype = G_VARIANT_TYPE_DOUBLE;
		cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
		break;
	case SR_CONF_OUTPUT_CURRENT:
		gvtype = G_VARIANT_TYPE_DOUBLE;
		cmd = SCPI_CMD_GET_MEAS_CURRENT;
		break;
	case SR_CONF_OUTPUT_CURRENT_LIMIT:
		gvtype = G_VARIANT_TYPE_DOUBLE;
		cmd = SCPI_CMD_GET_CURRENT_LIMIT;
		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;
	case SR_CONF_OUTPUT_REGULATION:
		gvtype = G_VARIANT_TYPE_STRING;
		cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
	}
	if (gvtype) {
		if (cg)
			select_channel(sdi, cg->channels->data);
		ret = scpi_cmd_resp(sdi, data, gvtype, cmd);
	} else
		ret = SR_ERR_NA;

	return ret;
}

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

	if (!sdi)
		return SR_ERR_ARG;

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

	if (cg)
		/* Channel group specified. */
		select_channel(sdi, cg->channels->data);

	ret = SR_OK;
	switch (key) {
	case SR_CONF_OUTPUT_ENABLED:
		if (g_variant_get_boolean(data))
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLE);
		else
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_DISABLE);
		break;
	case SR_CONF_OUTPUT_VOLTAGE_TARGET:
		d = g_variant_get_double(data);
		ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_TARGET, d);
		break;
	case SR_CONF_OUTPUT_CURRENT_LIMIT:
		d = g_variant_get_double(data);
		ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_LIMIT, d);
		break;
	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
		if (g_variant_get_boolean(data))
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
		else
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
		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, d);
		break;
	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
		if (g_variant_get_boolean(data))
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
		else
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
		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, d);
		break;
	case SR_CONF_OVER_TEMPERATURE_PROTECTION:
		if (g_variant_get_boolean(data))
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
		else
			ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
		break;
	default:
		ret = SR_ERR_NA;
	}

	return ret;
}

static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	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_UINT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_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_UINT32,
					devc->device->devopts, devc->device->num_devopts,
					sizeof(uint32_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. */
		/*
		 * 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.
		 */
		ch = cg->channels->data;

		switch (key) {
		case SR_CONF_DEVICE_OPTIONS:
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
					devc->device->devopts_cg, devc->device->num_devopts_cg,
					sizeof(uint32_t));
			break;
		case SR_CONF_OUTPUT_VOLTAGE_TARGET:
			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_LIMIT:
			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;
	struct pps_channel *pch;
	int cmd, 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, 10,
			scpi_pps_receive_data, (void *)sdi)) != SR_OK)
		return ret;
	std_session_send_df_header(sdi, LOG_PREFIX);

	/* Prime the pipe with the first channel's fetch. */
	ch = next_enabled_channel(sdi, NULL);
	pch = ch->priv;
	if ((ret = select_channel(sdi, ch)) != SR_OK)
		return ret;
	if (pch->mq == SR_MQ_VOLTAGE)
		cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
	else if (pch->mq == SR_MQ_CURRENT)
		cmd = SCPI_CMD_GET_MEAS_CURRENT;
	else if (pch->mq == SR_MQ_POWER)
		cmd = SCPI_CMD_GET_MEAS_POWER;
	else
		return SR_ERR;
	scpi_cmd(sdi, cmd, pch->hwname);

	return SR_OK;
}

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

	(void)cb_data;

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

	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);

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

	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	27
584560f1	28	static const uint32_t scanopts[] = {
9e45cd41 BV	29	SR_CONF_CONN,
	30	SR_CONF_SERIALCOMM,
	31	};
ca1a7cb5	32
01b0257a BV	33	static struct pps_channel_instance pci[] = {
	34	{ SR_MQ_VOLTAGE, SCPI_CMD_GET_MEAS_VOLTAGE, "V" },
	35	{ SR_MQ_CURRENT, SCPI_CMD_GET_MEAS_CURRENT, "I" },
	36	{ SR_MQ_POWER, SCPI_CMD_GET_MEAS_POWER, "P" },
	37	};
	38
ca1a7cb5 BV	39	static int init(struct sr_context *sr_ctx)
	40	{
	41	return std_init(sr_ctx, di, LOG_PREFIX);
	42	}
	43
9e45cd41	44	static struct sr_dev_inst probe_device(struct sr_scpi_dev_inst scpi)
ca1a7cb5	45	{
9e45cd41 BV	46	struct dev_context *devc;
	47	struct sr_dev_inst *sdi;
	48	struct sr_scpi_hw_info *hw_info;
	49	struct sr_channel_group *cg;
	50	struct sr_channel *ch;
	51	const struct scpi_pps *device;
01b0257a	52	struct pps_channel *pch;
4a471029 BV	53	struct channel_spec *channels;
4a471029 BV	54	struct channel_group_spec channel_groups, cgs;
9e45cd41	55	struct pps_channel_group *pcg;
58b77c41 BV	56	GRegex *model_re;
58b77c41 BV	57	GMatchInfo *model_mi;
01b0257a	58	GSList *l;
9e45cd41	59	uint64_t mask;
4a471029 BV	60	unsigned int num_channels, num_channel_groups, ch_num, ch_idx, i, j;
4a471029 BV	61	int ret;
22c18b03	62	const char *vendor;
01b0257a	63	char ch_name[16];
9e45cd41 BV	64
	65	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
	66	sr_info("Couldn't get IDN response.");
	67	return NULL;
	68	}
	69
	70	device = NULL;
	71	for (i = 0; i < num_pps_profiles; i++) {
22c18b03	72	vendor = get_vendor(hw_info->manufacturer);
58b77c41	73	if (strcasecmp(vendor, pps_profiles[i].vendor))
22c18b03	74	continue;
58b77c41 BV	75	model_re = g_regex_new(pps_profiles[i].model, 0, 0, NULL);
58b77c41 BV	76	if (g_regex_match(model_re, hw_info->model, 0, &model_mi))
9e45cd41	77	device = &pps_profiles[i];
58b77c41 BV	78	g_match_info_unref(model_mi);
	79	g_regex_unref(model_re);
	80	if (device)
9e45cd41	81	break;
9e45cd41 BV	82	}
	83	if (!device) {
	84	sr_scpi_hw_info_free(hw_info);
	85	return NULL;
	86	}
	87
aed4ad0b	88	sdi = sr_dev_inst_new(SR_ST_ACTIVE, vendor, hw_info->model,
58b77c41	89	hw_info->firmware_version);
9e45cd41 BV	90	sdi->conn = scpi;
	91	sdi->driver = di;
	92	sdi->inst_type = SR_INST_SCPI;
d08667c5 SA	93	sdi->serial_num = g_strdup(hw_info->serial_number);
d08667c5 SA	94
9e45cd41 BV	95	devc = g_malloc0(sizeof(struct dev_context));
	96	devc->device = device;
	97	sdi->priv = devc;
	98
4a471029 BV	99	if (device->num_channels) {
	100	/* Static channels and groups. */
	101	channels = device->channels;
	102	num_channels = device->num_channels;
	103	channel_groups = device->channel_groups;
	104	num_channel_groups = device->num_channel_groups;
	105	} else {
	106	/* Channels and groups need to be probed. */
	107	ret = device->probe_channels(sdi, hw_info, &channels, &num_channels,
	108	&channel_groups, &num_channel_groups);
	109	if (ret != SR_OK) {
	110	sr_err("Failed to probe for channels.");
	111	return NULL;
	112	}
	113	/*
	114	* Since these were dynamically allocated, we'll need to free them
	115	* later.
	116	*/
	117	devc->channels = channels;
	118	devc->channel_groups = channel_groups;
	119	}
	120
01b0257a	121	ch_idx = 0;
4a471029	122	for (ch_num = 0; ch_num < num_channels; ch_num++) {
01b0257a	123	/* Create one channel per measurable output unit. */
01b0257a BV	124	for (i = 0; i < ARRAY_SIZE(pci); i++) {
	125	if (!scpi_cmd_get(sdi, pci[i].command))
	126	continue;
	127	g_snprintf(ch_name, 16, "%s%s", pci[i].prefix,
4a471029	128	channels[ch_num].name);
01b0257a BV	129	ch = sr_channel_new(ch_idx++, SR_CHANNEL_ANALOG, TRUE, ch_name);
	130	pch = g_malloc0(sizeof(struct pps_channel));
	131	pch->hw_output_idx = ch_num;
4a471029	132	pch->hwname = channels[ch_num].name;
01b0257a BV	133	pch->mq = pci[i].mq;
	134	ch->priv = pch;
	135	sdi->channels = g_slist_append(sdi->channels, ch);
	136	}
9e45cd41	137	}
ca1a7cb5	138
4a471029 BV	139	for (i = 0; i < num_channel_groups; i++) {
4a471029 BV	140	cgs = &channel_groups[i];
9e45cd41 BV	141	cg = g_malloc0(sizeof(struct sr_channel_group));
	142	cg->name = g_strdup(cgs->name);
	143	for (j = 0, mask = 1; j < 64; j++, mask <<= 1) {
	144	if (cgs->channel_index_mask & mask) {
01b0257a BV	145	for (l = sdi->channels; l; l = l->next) {
	146	ch = l->data;
	147	pch = ch->priv;
	148	if (pch->hw_output_idx == j)
	149	cg->channels = g_slist_append(cg->channels, ch);
	150	}
9e45cd41 BV	151	}
	152	}
	153	pcg = g_malloc0(sizeof(struct pps_channel_group));
	154	pcg->features = cgs->features;
	155	cg->priv = pcg;
	156	sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
	157	}
ca1a7cb5	158
4a471029 BV	159	sr_scpi_hw_info_free(hw_info);
	160	hw_info = NULL;
	161
60475cd7	162	scpi_cmd(sdi, SCPI_CMD_LOCAL);
9e45cd41	163	sr_scpi_close(scpi);
ca1a7cb5	164
9e45cd41 BV	165	return sdi;
9e45cd41 BV	166	}
ca1a7cb5	167
9e45cd41 BV	168	static GSList scan(GSList options)
	169	{
	170	return sr_scpi_scan(di->priv, options, probe_device);
ca1a7cb5 BV	171	}
	172
	173	static GSList *dev_list(void)
	174	{
	175	return ((struct drv_context *)(di->priv))->instances;
	176	}
	177
	178	static int dev_clear(void)
	179	{
	180	return std_dev_clear(di, NULL);
	181	}
	182
	183	static int dev_open(struct sr_dev_inst *sdi)
	184	{
ee2860ee	185	struct dev_context *devc;
9e45cd41	186	struct sr_scpi_dev_inst *scpi;
ee2860ee	187	GVariant *beeper;
9e45cd41 BV	188
	189	if (sdi->status != SR_ST_ACTIVE)
	190	return SR_ERR;
ca1a7cb5	191
9e45cd41 BV	192	scpi = sdi->conn;
	193	if (sr_scpi_open(scpi) < 0)
	194	return SR_ERR;
ca1a7cb5 BV	195
	196	sdi->status = SR_ST_ACTIVE;
	197
60475cd7	198	scpi_cmd(sdi, SCPI_CMD_REMOTE);
ee2860ee BV	199	devc = sdi->priv;
	200	devc->beeper_was_set = FALSE;
	201	if (scpi_cmd_resp(sdi, &beeper, G_VARIANT_TYPE_BOOLEAN, SCPI_CMD_BEEPER) == SR_OK) {
	202	if (g_variant_get_boolean(beeper)) {
	203	devc->beeper_was_set = TRUE;
	204	scpi_cmd(sdi, SCPI_CMD_BEEPER_DISABLE);
	205	}
	206	g_variant_unref(beeper);
	207	}
60475cd7	208
ca1a7cb5 BV	209	return SR_OK;
	210	}
	211
	212	static int dev_close(struct sr_dev_inst *sdi)
	213	{
9e45cd41	214	struct sr_scpi_dev_inst *scpi;
ee2860ee	215	struct dev_context *devc;
ca1a7cb5	216
9e45cd41 BV	217	if (sdi->status != SR_ST_ACTIVE)
9e45cd41 BV	218	return SR_ERR_DEV_CLOSED;
ca1a7cb5	219
ee2860ee	220	devc = sdi->priv;
9e45cd41 BV	221	scpi = sdi->conn;
9e45cd41 BV	222	if (scpi) {
ee2860ee BV	223	if (devc->beeper_was_set)
ee2860ee BV	224	scpi_cmd(sdi, SCPI_CMD_BEEPER_ENABLE);
60475cd7	225	scpi_cmd(sdi, SCPI_CMD_LOCAL);
9e45cd41 BV	226	sr_scpi_close(scpi);
	227	sdi->status = SR_ST_INACTIVE;
	228	}
ca1a7cb5 BV	229
	230	return SR_OK;
	231	}
	232
4a471029 BV	233	static void clear_helper(void *priv)
	234	{
	235	struct dev_context *devc;
	236
	237	devc = priv;
	238	g_free(devc->channels);
	239	g_free(devc->channel_groups);
	240	g_free(devc);
	241	}
	242
ca1a7cb5 BV	243	static int cleanup(void)
ca1a7cb5 BV	244	{
4a471029	245	return std_dev_clear(di, clear_helper);
ca1a7cb5 BV	246	}
ca1a7cb5 BV	247
584560f1	248	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
ca1a7cb5 BV	249	const struct sr_channel_group *cg)
ca1a7cb5 BV	250	{
9e45cd41	251	struct dev_context *devc;
478c8d92 BV	252	const GVariantType *gvtype;
	253	unsigned int i;
	254	int cmd, ret;
ca1a7cb5	255
9e45cd41 BV	256	if (!sdi)
	257	return SR_ERR_ARG;
	258
	259	devc = sdi->priv;
ca1a7cb5	260
478c8d92	261	if (cg) {
9e45cd41 BV	262	/*
	263	* These options only apply to channel groups with a single
	264	* channel -- they're per-channel settings for the device.
	265	*/
478c8d92 BV	266
	267	/*
	268	* Config keys are handled below depending on whether a channel
	269	* group was provided by the frontend. However some of these
	270	* take a CG on one PPS but not on others. Check the device's
	271	* profile for that here, and NULL out the channel group as needed.
	272	*/
	273	for (i = 0; i < devc->device->num_devopts; i++) {
	274	if (devc->device->devopts[i] == key) {
	275	cg = NULL;
	276	break;
	277	}
	278	}
478c8d92	279	}
9e45cd41	280
478c8d92 BV	281	gvtype = NULL;
	282	cmd = -1;
	283	switch (key) {
	284	case SR_CONF_OUTPUT_ENABLED:
	285	gvtype = G_VARIANT_TYPE_BOOLEAN;
	286	cmd = SCPI_CMD_GET_OUTPUT_ENABLED;
	287	break;
	288	case SR_CONF_OUTPUT_VOLTAGE:
	289	gvtype = G_VARIANT_TYPE_DOUBLE;
	290	cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
	291	break;
ca95e90f	292	case SR_CONF_OUTPUT_VOLTAGE_TARGET:
478c8d92	293	gvtype = G_VARIANT_TYPE_DOUBLE;
ca95e90f	294	cmd = SCPI_CMD_GET_VOLTAGE_TARGET;
478c8d92 BV	295	break;
	296	case SR_CONF_OUTPUT_CURRENT:
	297	gvtype = G_VARIANT_TYPE_DOUBLE;
	298	cmd = SCPI_CMD_GET_MEAS_CURRENT;
	299	break;
ca95e90f	300	case SR_CONF_OUTPUT_CURRENT_LIMIT:
478c8d92	301	gvtype = G_VARIANT_TYPE_DOUBLE;
ca95e90f	302	cmd = SCPI_CMD_GET_CURRENT_LIMIT;
478c8d92 BV	303	break;
	304	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
	305	gvtype = G_VARIANT_TYPE_BOOLEAN;
	306	cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ENABLED;
	307	break;
	308	case SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE:
	309	gvtype = G_VARIANT_TYPE_BOOLEAN;
	310	cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_ACTIVE;
	311	break;
	312	case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
	313	gvtype = G_VARIANT_TYPE_DOUBLE;
	314	cmd = SCPI_CMD_GET_OVER_VOLTAGE_PROTECTION_THRESHOLD;
	315	break;
	316	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
	317	gvtype = G_VARIANT_TYPE_BOOLEAN;
	318	cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ENABLED;
	319	break;
	320	case SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE:
	321	gvtype = G_VARIANT_TYPE_BOOLEAN;
	322	cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_ACTIVE;
	323	break;
	324	case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
	325	gvtype = G_VARIANT_TYPE_DOUBLE;
	326	cmd = SCPI_CMD_GET_OVER_CURRENT_PROTECTION_THRESHOLD;
	327	break;
	328	case SR_CONF_OVER_TEMPERATURE_PROTECTION:
	329	gvtype = G_VARIANT_TYPE_BOOLEAN;
	330	cmd = SCPI_CMD_GET_OVER_TEMPERATURE_PROTECTION;
	331	break;
60475cd7 BV	332	case SR_CONF_OUTPUT_REGULATION:
	333	gvtype = G_VARIANT_TYPE_STRING;
	334	cmd = SCPI_CMD_GET_OUTPUT_REGULATION;
478c8d92 BV	335	}
	336	if (gvtype) {
	337	if (cg)
60475cd7 BV	338	select_channel(sdi, cg->channels->data);
60475cd7 BV	339	ret = scpi_cmd_resp(sdi, data, gvtype, cmd);
478c8d92 BV	340	} else
478c8d92 BV	341	ret = SR_ERR_NA;
ca1a7cb5 BV	342
	343	return ret;
	344	}
	345
584560f1	346	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
ca1a7cb5 BV	347	const struct sr_channel_group *cg)
ca1a7cb5 BV	348	{
9e45cd41	349	double d;
ca1a7cb5	350	int ret;
ca1a7cb5	351
fdedbfcd BV	352	if (!sdi)
	353	return SR_ERR_ARG;
	354
ca1a7cb5 BV	355	if (sdi->status != SR_ST_ACTIVE)
	356	return SR_ERR_DEV_CLOSED;
	357
60475cd7	358	if (cg)
9e45cd41	359	/* Channel group specified. */
60475cd7 BV	360	select_channel(sdi, cg->channels->data);
	361
	362	ret = SR_OK;
	363	switch (key) {
	364	case SR_CONF_OUTPUT_ENABLED:
	365	if (g_variant_get_boolean(data))
	366	ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_ENABLE);
	367	else
	368	ret = scpi_cmd(sdi, SCPI_CMD_SET_OUTPUT_DISABLE);
	369	break;
	370	case SR_CONF_OUTPUT_VOLTAGE_TARGET:
	371	d = g_variant_get_double(data);
	372	ret = scpi_cmd(sdi, SCPI_CMD_SET_VOLTAGE_TARGET, d);
	373	break;
	374	case SR_CONF_OUTPUT_CURRENT_LIMIT:
	375	d = g_variant_get_double(data);
	376	ret = scpi_cmd(sdi, SCPI_CMD_SET_CURRENT_LIMIT, d);
	377	break;
	378	case SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED:
	379	if (g_variant_get_boolean(data))
	380	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_ENABLE);
	381	else
	382	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_DISABLE);
	383	break;
	384	case SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD:
	385	d = g_variant_get_double(data);
	386	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_VOLTAGE_PROTECTION_THRESHOLD, d);
	387	break;
	388	case SR_CONF_OVER_CURRENT_PROTECTION_ENABLED:
	389	if (g_variant_get_boolean(data))
	390	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_ENABLE);
	391	else
	392	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_DISABLE);
	393	break;
	394	case SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD:
	395	d = g_variant_get_double(data);
	396	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_CURRENT_PROTECTION_THRESHOLD, d);
	397	break;
	398	case SR_CONF_OVER_TEMPERATURE_PROTECTION:
	399	if (g_variant_get_boolean(data))
	400	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_ENABLE);
	401	else
	402	ret = scpi_cmd(sdi, SCPI_CMD_SET_OVER_TEMPERATURE_PROTECTION_DISABLE);
	403	break;
	404	default:
	405	ret = SR_ERR_NA;
ca1a7cb5 BV	406	}
	407
	408	return ret;
	409	}
	410
584560f1	411	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
ca1a7cb5 BV	412	const struct sr_channel_group *cg)
ca1a7cb5 BV	413	{
9e45cd41 BV	414	struct dev_context *devc;
	415	struct sr_channel *ch;
	416	struct channel_spec *ch_spec;
	417	GVariant *gvar;
	418	GVariantBuilder gvb;
	419	int ret, i;
	420	const char *s[16];
	421
	422	/* Always available, even without sdi. */
	423	if (key == SR_CONF_SCAN_OPTIONS) {
584560f1 BV	424	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
584560f1 BV	425	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
9e45cd41 BV	426	return SR_OK;
9e45cd41 BV	427	}
ca1a7cb5	428
9e45cd41 BV	429	if (!sdi)
	430	return SR_ERR_ARG;
	431	devc = sdi->priv;
ca1a7cb5 BV	432
ca1a7cb5 BV	433	ret = SR_OK;
9e45cd41 BV	434	if (!cg) {
	435	/* No channel group: global options. */
	436	switch (key) {
	437	case SR_CONF_DEVICE_OPTIONS:
584560f1	438	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
9e45cd41	439	devc->device->devopts, devc->device->num_devopts,
584560f1	440	sizeof(uint32_t));
9e45cd41 BV	441	break;
9e45cd41 BV	442	case SR_CONF_OUTPUT_CHANNEL_CONFIG:
478c8d92	443	/* Not used. */
9e45cd41 BV	444	i = 0;
	445	if (devc->device->features & PPS_INDEPENDENT)
	446	s[i++] = "Independent";
	447	if (devc->device->features & PPS_SERIES)
	448	s[i++] = "Series";
	449	if (devc->device->features & PPS_PARALLEL)
	450	s[i++] = "Parallel";
	451	if (i == 0) {
	452	/*
	453	* Shouldn't happen: independent-only devices
	454	* shouldn't advertise this option at all.
	455	*/
	456	return SR_ERR_NA;
	457	}
	458	*data = g_variant_new_strv(s, i);
	459	break;
	460	default:
	461	return SR_ERR_NA;
	462	}
	463	} else {
	464	/* Channel group specified. */
9e45cd41 BV	465	/*
	466	* Per-channel-group options depending on a channel are actually
	467	* done with the first channel. Channel groups in PPS can have
	468	* more than one channel, but they will typically be of equal
01b0257a	469	* specification for use in series or parallel mode.
9e45cd41	470	*/
9e45cd41 BV	471	ch = cg->channels->data;
	472
	473	switch (key) {
	474	case SR_CONF_DEVICE_OPTIONS:
584560f1	475	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
9e45cd41	476	devc->device->devopts_cg, devc->device->num_devopts_cg,
584560f1	477	sizeof(uint32_t));
9e45cd41	478	break;
ca95e90f	479	case SR_CONF_OUTPUT_VOLTAGE_TARGET:
9e45cd41 BV	480	ch_spec = &(devc->device->channels[ch->index]);
	481	g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
	482	/* Min, max, write resolution. */
	483	for (i = 0; i < 3; i++) {
	484	gvar = g_variant_new_double(ch_spec->voltage[i]);
	485	g_variant_builder_add_value(&gvb, gvar);
	486	}
	487	*data = g_variant_builder_end(&gvb);
	488	break;
ca95e90f	489	case SR_CONF_OUTPUT_CURRENT_LIMIT:
9e45cd41 BV	490	g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
	491	/* Min, max, step. */
	492	for (i = 0; i < 3; i++) {
	493	ch_spec = &(devc->device->channels[ch->index]);
	494	gvar = g_variant_new_double(ch_spec->current[i]);
	495	g_variant_builder_add_value(&gvb, gvar);
	496	}
	497	*data = g_variant_builder_end(&gvb);
	498	break;
	499	default:
	500	return SR_ERR_NA;
	501	}
ca1a7cb5 BV	502	}
	503
	504	return ret;
	505	}
	506
	507	static int dev_acquisition_start(const struct sr_dev_inst *sdi,
9e45cd41	508	void *cb_data)
ca1a7cb5	509	{
9e45cd41 BV	510	struct dev_context *devc;
	511	struct sr_scpi_dev_inst *scpi;
	512	struct sr_channel *ch;
01b0257a BV	513	struct pps_channel *pch;
01b0257a BV	514	int cmd, ret;
ca1a7cb5 BV	515
	516	if (sdi->status != SR_ST_ACTIVE)
	517	return SR_ERR_DEV_CLOSED;
	518
9e45cd41 BV	519	devc = sdi->priv;
	520	scpi = sdi->conn;
	521	devc->cb_data = cb_data;
	522
01b0257a	523	if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
9e45cd41 BV	524	scpi_pps_receive_data, (void *)sdi)) != SR_OK)
	525	return ret;
	526	std_session_send_df_header(sdi, LOG_PREFIX);
	527
01b0257a	528	/* Prime the pipe with the first channel's fetch. */
984e4b0d	529	ch = next_enabled_channel(sdi, NULL);
01b0257a	530	pch = ch->priv;
984e4b0d BV	531	if ((ret = select_channel(sdi, ch)) != SR_OK)
984e4b0d BV	532	return ret;
01b0257a BV	533	if (pch->mq == SR_MQ_VOLTAGE)
	534	cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
	535	else if (pch->mq == SR_MQ_CURRENT)
	536	cmd = SCPI_CMD_GET_MEAS_CURRENT;
	537	else if (pch->mq == SR_MQ_POWER)
	538	cmd = SCPI_CMD_GET_MEAS_POWER;
	539	else
	540	return SR_ERR;
	541	scpi_cmd(sdi, cmd, pch->hwname);
ca1a7cb5 BV	542
	543	return SR_OK;
	544	}
	545
	546	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	547	{
bf48cceb	548	struct sr_datafeed_packet packet;
9e45cd41 BV	549	struct sr_scpi_dev_inst *scpi;
	550	float f;
	551
ca1a7cb5 BV	552	(void)cb_data;
	553
	554	if (sdi->status != SR_ST_ACTIVE)
	555	return SR_ERR_DEV_CLOSED;
	556
9e45cd41 BV	557	scpi = sdi->conn;
	558
	559	/*
	560	* A requested value is certainly on the way. Retrieve it now,
	561	* to avoid leaving the device in a state where it's not expecting
	562	* commands.
	563	*/
	564	sr_scpi_get_float(scpi, NULL, &f);
	565	sr_scpi_source_remove(sdi->session, scpi);
	566
bf48cceb BV	567	packet.type = SR_DF_END;
	568	sr_session_send(sdi, &packet);
	569
ca1a7cb5 BV	570	return SR_OK;
	571	}
	572
	573	SR_PRIV struct sr_dev_driver scpi_pps_driver_info = {
	574	.name = "scpi-pps",
	575	.longname = "SCPI PPS",
	576	.api_version = 1,
	577	.init = init,
	578	.cleanup = cleanup,
	579	.scan = scan,
	580	.dev_list = dev_list,
	581	.dev_clear = dev_clear,
	582	.config_get = config_get,
	583	.config_set = config_set,
	584	.config_list = config_list,
	585	.dev_open = dev_open,
	586	.dev_close = dev_close,
	587	.dev_acquisition_start = dev_acquisition_start,
	588	.dev_acquisition_stop = dev_acquisition_stop,
	589	.priv = NULL,
	590	};