[libsigrok.git] / src / hardware / scpi-pps / protocol.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 <stdarg.h>
#include "protocol.h"

SR_PRIV char *scpi_cmd_get(const struct sr_dev_inst *sdi, int command)
{
	struct dev_context *devc;
	unsigned int i;
	char *cmd;

	devc = sdi->priv;
	cmd = NULL;
	for (i = 0; i < devc->device->num_commands; i++) {
		if (devc->device->commands[i].command == command) {
			cmd = devc->device->commands[i].string;
			break;
		}
	}

	return cmd;
}

SR_PRIV int scpi_cmd(const struct sr_dev_inst *sdi, int command, ...)
{
	struct sr_scpi_dev_inst *scpi;
	va_list args;
	int ret;
	char *cmd;

	if (!(cmd = scpi_cmd_get(sdi, command))) {
		/* Device does not implement this command, that's OK. */
		return SR_OK_CONTINUE;
	}

	scpi = sdi->conn;
	va_start(args, command);
	ret = sr_scpi_send_variadic(scpi, cmd, args);
	va_end(args);

	return ret;
}

SR_PRIV int scpi_cmd_resp(const struct sr_dev_inst *sdi, GVariant **gvar,
		const GVariantType *gvtype, int command, ...)
{
	struct sr_scpi_dev_inst *scpi;
	va_list args;
	double d;
	int ret;
	char *cmd, *s;

	if (!(cmd = scpi_cmd_get(sdi, command))) {
		/* Device does not implement this command, that's OK. */
		return SR_OK_CONTINUE;
	}

	scpi = sdi->conn;
	va_start(args, command);
	ret = sr_scpi_send_variadic(scpi, cmd, args);
	va_end(args);
	if (ret != SR_OK)
		return ret;

	if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_BOOLEAN)) {
		if ((ret = sr_scpi_get_string(scpi, NULL, &s)) != SR_OK)
			return ret;
		if (!strcasecmp(s, "ON") || !strcasecmp(s, "1") || !strcasecmp(s, "YES"))
			*gvar = g_variant_new_boolean(TRUE);
		else if (!strcasecmp(s, "OFF") || !strcasecmp(s, "0") || !strcasecmp(s, "NO"))
			*gvar = g_variant_new_boolean(FALSE);
		else
			ret = SR_ERR;
	} if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_DOUBLE)) {
		if ((ret = sr_scpi_get_double(scpi, NULL, &d)) == SR_OK)
			*gvar = g_variant_new_double(d);
	} if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_STRING)) {
		if ((ret = sr_scpi_get_string(scpi, NULL, &s)) == SR_OK)
			*gvar = g_variant_new_string(s);
	}

	return ret;
}

SR_PRIV int select_channel(const struct sr_dev_inst *sdi, struct sr_channel *ch)
{
	struct dev_context *devc;
	struct pps_channel *cur_pch, *new_pch;
	int ret;

	if (g_slist_length(sdi->channels) == 1)
		return SR_OK;

	devc = sdi->priv;
	if (ch == devc->cur_channel)
		return SR_OK;

	new_pch = ch->priv;
	if (devc->cur_channel) {
		cur_pch = devc->cur_channel->priv;
		if (cur_pch->hw_output_idx == new_pch->hw_output_idx) {
			/* Same underlying output channel. */
			devc->cur_channel = ch;
			return SR_OK;
		}
	}

	if ((ret = scpi_cmd(sdi, SCPI_CMD_SELECT_CHANNEL, new_pch->hwname)) == SR_OK)
		devc->cur_channel = ch;

	return ret;
}

SR_PRIV struct sr_channel *next_enabled_channel(const struct sr_dev_inst *sdi,
		struct sr_channel *cur_channel)
{
	struct sr_channel *next_channel;
	GSList *l;

	next_channel = cur_channel;
	do {
		l = g_slist_find(sdi->channels, next_channel);
		if (l && l->next)
			next_channel = l->next->data;
		else
			next_channel = sdi->channels->data;
	} while (!next_channel->enabled);

	return next_channel;
}

SR_PRIV int scpi_pps_receive_data(int fd, int revents, void *cb_data)
{
	struct dev_context *devc;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_analog analog;
	const struct sr_dev_inst *sdi;
	struct sr_channel *next_channel;
	struct sr_scpi_dev_inst *scpi;
	struct pps_channel *pch;
	float f;
	int cmd;

	(void)fd;
	(void)revents;

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

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

	scpi = sdi->conn;

	/* Retrieve requested value for this state. */
	if (sr_scpi_get_float(scpi, NULL, &f) == SR_OK) {
		pch = devc->cur_channel->priv;
		packet.type = SR_DF_ANALOG;
		packet.payload = &analog;
		analog.channels = g_slist_append(NULL, devc->cur_channel);
		analog.num_samples = 1;
		analog.mq = pch->mq;
		if (pch->mq == SR_MQ_VOLTAGE)
			analog.unit = SR_UNIT_VOLT;
		else if (pch->mq == SR_MQ_CURRENT)
			analog.unit = SR_UNIT_AMPERE;
		else if (pch->mq == SR_MQ_POWER)
			analog.unit = SR_UNIT_WATT;
		analog.mqflags = SR_MQFLAG_DC;
		analog.data = &f;
		sr_session_send(sdi, &packet);
		g_slist_free(analog.channels);
	}

	if (g_slist_length(sdi->channels) > 1) {
		next_channel = next_enabled_channel(sdi, devc->cur_channel);
		if (select_channel(sdi, next_channel) != SR_OK) {
			sr_err("Failed to select channel %s", next_channel->name);
			return FALSE;
		}
	}

	pch = devc->cur_channel->priv;
	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);

	return TRUE;
}
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 BV	20	#include <string.h>
9e45cd41 BV	21	#include <stdarg.h>
ca1a7cb5 BV	22	#include "protocol.h"
ca1a7cb5 BV	23
478c8d92	24	SR_PRIV char scpi_cmd_get(const struct sr_dev_inst sdi, int command)
9e45cd41	25	{
9e45cd41	26	struct dev_context *devc;
9e45cd41	27	unsigned int i;
9e45cd41 BV	28	char *cmd;
	29
	30	devc = sdi->priv;
	31	cmd = NULL;
	32	for (i = 0; i < devc->device->num_commands; i++) {
	33	if (devc->device->commands[i].command == command) {
	34	cmd = devc->device->commands[i].string;
	35	break;
	36	}
	37	}
478c8d92 BV	38
	39	return cmd;
	40	}
	41
	42	SR_PRIV int scpi_cmd(const struct sr_dev_inst *sdi, int command, ...)
	43	{
	44	struct sr_scpi_dev_inst *scpi;
	45	va_list args;
	46	int ret;
	47	char *cmd;
	48
	49	if (!(cmd = scpi_cmd_get(sdi, command))) {
9e45cd41 BV	50	/* Device does not implement this command, that's OK. */
	51	return SR_OK_CONTINUE;
	52	}
	53
	54	scpi = sdi->conn;
	55	va_start(args, command);
	56	ret = sr_scpi_send_variadic(scpi, cmd, args);
	57	va_end(args);
	58
	59	return ret;
	60	}
	61
478c8d92 BV	62	SR_PRIV int scpi_cmd_resp(const struct sr_dev_inst sdi, GVariant *gvar,
	63	const GVariantType *gvtype, int command, ...)
	64	{
	65	struct sr_scpi_dev_inst *scpi;
	66	va_list args;
	67	double d;
	68	int ret;
	69	char cmd, s;
	70
	71	if (!(cmd = scpi_cmd_get(sdi, command))) {
	72	/* Device does not implement this command, that's OK. */
	73	return SR_OK_CONTINUE;
	74	}
	75
	76	scpi = sdi->conn;
	77	va_start(args, command);
	78	ret = sr_scpi_send_variadic(scpi, cmd, args);
	79	va_end(args);
	80	if (ret != SR_OK)
	81	return ret;
	82
	83	if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_BOOLEAN)) {
	84	if ((ret = sr_scpi_get_string(scpi, NULL, &s)) != SR_OK)
	85	return ret;
	86	if (!strcasecmp(s, "ON") \|\| !strcasecmp(s, "1") \|\| !strcasecmp(s, "YES"))
	87	*gvar = g_variant_new_boolean(TRUE);
	88	else if (!strcasecmp(s, "OFF") \|\| !strcasecmp(s, "0") \|\| !strcasecmp(s, "NO"))
	89	*gvar = g_variant_new_boolean(FALSE);
	90	else
	91	ret = SR_ERR;
	92	} if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_DOUBLE)) {
	93	if ((ret = sr_scpi_get_double(scpi, NULL, &d)) == SR_OK)
	94	*gvar = g_variant_new_double(d);
	95	} if (g_variant_type_equal(gvtype, G_VARIANT_TYPE_STRING)) {
	96	if ((ret = sr_scpi_get_string(scpi, NULL, &s)) == SR_OK)
	97	*gvar = g_variant_new_string(s);
	98	}
	99
	100	return ret;
	101	}
	102
60475cd7 BV	103	SR_PRIV int select_channel(const struct sr_dev_inst sdi, struct sr_channel ch)
	104	{
	105	struct dev_context *devc;
624503ae	106	struct pps_channel cur_pch, new_pch;
60475cd7 BV	107	int ret;
	108
	109	if (g_slist_length(sdi->channels) == 1)
	110	return SR_OK;
	111
	112	devc = sdi->priv;
	113	if (ch == devc->cur_channel)
	114	return SR_OK;
	115
624503ae BV	116	new_pch = ch->priv;
	117	if (devc->cur_channel) {
	118	cur_pch = devc->cur_channel->priv;
	119	if (cur_pch->hw_output_idx == new_pch->hw_output_idx) {
	120	/* Same underlying output channel. */
	121	devc->cur_channel = ch;
	122	return SR_OK;
	123	}
	124	}
	125
	126	if ((ret = scpi_cmd(sdi, SCPI_CMD_SELECT_CHANNEL, new_pch->hwname)) == SR_OK)
60475cd7 BV	127	devc->cur_channel = ch;
	128
	129	return ret;
	130	}
	131
624503ae BV	132	SR_PRIV struct sr_channel next_enabled_channel(const struct sr_dev_inst sdi,
	133	struct sr_channel *cur_channel)
	134	{
	135	struct sr_channel *next_channel;
	136	GSList *l;
	137
	138	next_channel = cur_channel;
	139	do {
	140	l = g_slist_find(sdi->channels, next_channel);
	141	if (l && l->next)
	142	next_channel = l->next->data;
	143	else
	144	next_channel = sdi->channels->data;
	145	} while (!next_channel->enabled);
	146
	147	return next_channel;
	148	}
	149
ca1a7cb5 BV	150	SR_PRIV int scpi_pps_receive_data(int fd, int revents, void *cb_data)
ca1a7cb5 BV	151	{
ca1a7cb5	152	struct dev_context *devc;
9e45cd41 BV	153	struct sr_datafeed_packet packet;
	154	struct sr_datafeed_analog analog;
	155	const struct sr_dev_inst *sdi;
60475cd7	156	struct sr_channel *next_channel;
9e45cd41	157	struct sr_scpi_dev_inst *scpi;
01b0257a	158	struct pps_channel *pch;
9e45cd41	159	float f;
01b0257a	160	int cmd;
ca1a7cb5 BV	161
ca1a7cb5 BV	162	(void)fd;
9e45cd41	163	(void)revents;
ca1a7cb5 BV	164
	165	if (!(sdi = cb_data))
	166	return TRUE;
	167
	168	if (!(devc = sdi->priv))
	169	return TRUE;
	170
9e45cd41 BV	171	scpi = sdi->conn;
	172
	173	/* Retrieve requested value for this state. */
	174	if (sr_scpi_get_float(scpi, NULL, &f) == SR_OK) {
01b0257a	175	pch = devc->cur_channel->priv;
9e45cd41 BV	176	packet.type = SR_DF_ANALOG;
	177	packet.payload = &analog;
	178	analog.channels = g_slist_append(NULL, devc->cur_channel);
	179	analog.num_samples = 1;
01b0257a BV	180	analog.mq = pch->mq;
01b0257a BV	181	if (pch->mq == SR_MQ_VOLTAGE)
9e45cd41	182	analog.unit = SR_UNIT_VOLT;
01b0257a	183	else if (pch->mq == SR_MQ_CURRENT)
9e45cd41	184	analog.unit = SR_UNIT_AMPERE;
01b0257a BV	185	else if (pch->mq == SR_MQ_POWER)
01b0257a BV	186	analog.unit = SR_UNIT_WATT;
9e45cd41 BV	187	analog.mqflags = SR_MQFLAG_DC;
	188	analog.data = &f;
	189	sr_session_send(sdi, &packet);
	190	g_slist_free(analog.channels);
	191	}
	192
60475cd7	193	if (g_slist_length(sdi->channels) > 1) {
624503ae BV	194	next_channel = next_enabled_channel(sdi, devc->cur_channel);
624503ae BV	195	if (select_channel(sdi, next_channel) != SR_OK) {
60475cd7 BV	196	sr_err("Failed to select channel %s", next_channel->name);
	197	return FALSE;
	198	}
	199	}
01b0257a BV	200
	201	pch = devc->cur_channel->priv;
	202	if (pch->mq == SR_MQ_VOLTAGE)
	203	cmd = SCPI_CMD_GET_MEAS_VOLTAGE;
	204	else if (pch->mq == SR_MQ_CURRENT)
	205	cmd = SCPI_CMD_GET_MEAS_CURRENT;
	206	else if (pch->mq == SR_MQ_POWER)
	207	cmd = SCPI_CMD_GET_MEAS_POWER;
	208	else
	209	return SR_ERR;
624503ae	210	scpi_cmd(sdi, cmd);
ca1a7cb5 BV	211
	212	return TRUE;
	213	}