[libsigrok.git] / src / hardware / fluke-45 / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
 * Copyright (C) 2017 John Chajecki <subs@qcontinuum.plus.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 <config.h>
#include <glib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <stdint.h>
#include <stdbool.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "scpi.h"
#include "protocol.h"

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

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

static const uint32_t devopts[] = {
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_SET,
};

/* Vendor, model, number of channels, poll period */
static const struct fluke_scpi_dmm_model supported_models[] = {
	{ "FLUKE", "45", 2, 0 },
};

static struct sr_dev_driver fluke_45_driver_info;

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;
	const struct scpi_command *cmdset = fluke_45_cmdset;
	unsigned int i;
	const struct fluke_scpi_dmm_model *model = NULL;
	gchar *channel_name;
	char *response;

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->conn = scpi;

	/* Test for serial port ECHO enabled. */
	sr_scpi_get_string(scpi, "ECHO-TEST", &response);
	if (strcmp(response, "ECHO-TEST") == 0) {
		sr_err("Serial port ECHO is ON. Please turn it OFF!");
		return NULL;
	}

	/* Get device IDN. */
	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
		sr_info("Couldn't get IDN response, retrying.");
		sr_scpi_close(scpi);
		sr_scpi_open(scpi);
		if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
			sr_info("Couldn't get IDN response.");
			return NULL;
		}
	}

	/* Check IDN. */
	for (i = 0; i < ARRAY_SIZE(supported_models); i++) {
		if (!g_ascii_strcasecmp(hw_info->manufacturer,
					supported_models[i].vendor) &&
				!strcmp(hw_info->model, supported_models[i].model)) {
			model = &supported_models[i];
			break;
		}
	}
	if (!model) {
		sr_scpi_hw_info_free(hw_info);
		return NULL;
	}

	/* Set up device parameters. */
	sdi->vendor = g_strdup(model->vendor);
	sdi->model = g_strdup(model->model);
	sdi->version = g_strdup(hw_info->firmware_version);
	sdi->serial_num = g_strdup(hw_info->serial_number);
	sdi->conn = scpi;
	sdi->driver = &fluke_45_driver_info;
	sdi->inst_type = SR_INST_SCPI;

	devc = g_malloc0(sizeof(struct dev_context));
	devc->num_channels = model->num_channels;
	devc->cmdset = cmdset;

	/* Create channels. */
	for (i = 0; i < devc->num_channels; i++) {
		channel_name = g_strdup_printf("P%d", i + 1);
		sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, channel_name);
	}

	sdi->priv = devc;

	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;

	if ((ret = sr_scpi_open(scpi) < 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;

	return sr_scpi_close(scpi);
}

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;

	(void)cg;

	devc = sdi->priv;

	return sr_sw_limits_config_set(&devc->limits, key, data);
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
}

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 = sdi->priv;

	(void)cg;

	return sr_sw_limits_config_get(&devc->limits, key, data);
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct sr_scpi_dev_inst *scpi;
	struct dev_context *devc;
	int ret;

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

	sr_sw_limits_acquisition_start(&devc->limits);
	std_session_send_df_header(sdi);

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

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	struct sr_scpi_dev_inst *scpi;
	double d;

	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_double(scpi, NULL, &d);
	sr_scpi_source_remove(sdi->session, scpi);

	std_session_send_df_end(sdi);

	return SR_OK;
}

static struct sr_dev_driver fluke_45_driver_info = {
	.name = "fluke-45",
	.longname = "Fluke 45",
	.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(fluke_45_driver_info);
Commit	Line	Data
e756c595 J	1	/*
	2	* This file is part of the libsigrok project.
	3	*
ab2b21fb	4	* Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
e756c595 J	5	* Copyright (C) 2017 John Chajecki <subs@qcontinuum.plus.com>
	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation, either version 3 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
	21	#include <config.h>
ab2b21fb J	22	#include <glib.h>
	23	#include <sys/types.h>
	24	#include <sys/stat.h>
	25	#include <fcntl.h>
	26	#include <string.h>
	27	#include <stdint.h>
	28	#include <stdbool.h>
	29	#include <libsigrok/libsigrok.h>
	30	#include "libsigrok-internal.h"
	31	#include "scpi.h"
e756c595 J	32	#include "protocol.h"
e756c595 J	33
ab2b21fb J	34	static const uint32_t scanopts[] = {
	35	SR_CONF_CONN,
	36	SR_CONF_SERIALCOMM,
	37	};
e756c595	38
ab2b21fb J	39	static const uint32_t drvopts[] = {
	40	SR_CONF_MULTIMETER,
	41	};
e756c595	42
ab2b21fb J	43	static const uint32_t devopts[] = {
	44	SR_CONF_CONTINUOUS,
	45	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
	46	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
	47	};
e756c595	48
ab2b21fb J	49	/* Vendor, model, number of channels, poll period */
	50	static const struct fluke_scpi_dmm_model supported_models[] = {
	51	{ "FLUKE", "45", 2, 0 },
	52	};
e756c595	53
ab2b21fb	54	static struct sr_dev_driver fluke_45_driver_info;
e756c595	55
ab2b21fb	56	static struct sr_dev_inst probe_device(struct sr_scpi_dev_inst scpi)
e756c595	57	{
ab2b21fb J	58	struct dev_context *devc;
	59	struct sr_dev_inst *sdi;
	60	struct sr_scpi_hw_info *hw_info;
	61	const struct scpi_command *cmdset = fluke_45_cmdset;
	62	unsigned int i;
	63	const struct fluke_scpi_dmm_model *model = NULL;
	64	gchar *channel_name;
	65	char *response;
	66
	67	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	68	sdi->conn = scpi;
	69
	70	/* Test for serial port ECHO enabled. */
	71	sr_scpi_get_string(scpi, "ECHO-TEST", &response);
	72	if (strcmp(response, "ECHO-TEST") == 0) {
	73	sr_err("Serial port ECHO is ON. Please turn it OFF!");
	74	return NULL;
	75	}
e756c595	76
ab2b21fb J	77	/* Get device IDN. */
	78	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
	79	sr_info("Couldn't get IDN response, retrying.");
	80	sr_scpi_close(scpi);
	81	sr_scpi_open(scpi);
	82	if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
	83	sr_info("Couldn't get IDN response.");
	84	return NULL;
	85	}
	86	}
e756c595	87
ab2b21fb J	88	/* Check IDN. */
	89	for (i = 0; i < ARRAY_SIZE(supported_models); i++) {
	90	if (!g_ascii_strcasecmp(hw_info->manufacturer,
	91	supported_models[i].vendor) &&
	92	!strcmp(hw_info->model, supported_models[i].model)) {
	93	model = &supported_models[i];
	94	break;
	95	}
	96	}
	97	if (!model) {
	98	sr_scpi_hw_info_free(hw_info);
	99	return NULL;
	100	}
	101
	102	/* Set up device parameters. */
	103	sdi->vendor = g_strdup(model->vendor);
	104	sdi->model = g_strdup(model->model);
	105	sdi->version = g_strdup(hw_info->firmware_version);
	106	sdi->serial_num = g_strdup(hw_info->serial_number);
	107	sdi->conn = scpi;
	108	sdi->driver = &fluke_45_driver_info;
	109	sdi->inst_type = SR_INST_SCPI;
	110
	111	devc = g_malloc0(sizeof(struct dev_context));
	112	devc->num_channels = model->num_channels;
	113	devc->cmdset = cmdset;
	114
	115	/* Create channels. */
	116	for (i = 0; i < devc->num_channels; i++) {
	117	channel_name = g_strdup_printf("P%d", i + 1);
	118	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, channel_name);
	119	}
	120
	121	sdi->priv = devc;
	122
	123	return sdi;
e756c595 J	124	}
e756c595 J	125
ab2b21fb J	126	static GSList scan(struct sr_dev_driver di, GSList *options)
	127	{
	128	return sr_scpi_scan(di->context, options, probe_device);
	129	}
	130
	131	static int dev_open(struct sr_dev_inst *sdi)
e756c595	132	{
ab2b21fb J	133	struct sr_scpi_dev_inst *scpi;
ab2b21fb J	134	int ret;
e756c595	135
ab2b21fb J	136	scpi = sdi->conn;
	137
	138	if ((ret = sr_scpi_open(scpi) < 0)) {
	139	sr_err("Failed to open SCPI device: %s.", sr_strerror(ret));
	140	return SR_ERR;
	141	}
e756c595 J	142
	143	return SR_OK;
	144	}
	145
ab2b21fb	146	static int dev_close(struct sr_dev_inst *sdi)
e756c595	147	{
ab2b21fb	148	struct sr_scpi_dev_inst *scpi;
e756c595	149
ab2b21fb	150	scpi = sdi->conn;
e756c595	151
ab2b21fb J	152	if (!scpi)
ab2b21fb J	153	return SR_ERR_BUG;
e756c595	154
ab2b21fb	155	return sr_scpi_close(scpi);
e756c595 J	156	}
	157
	158	static int config_set(uint32_t key, GVariant *data,
	159	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	160	{
ab2b21fb	161	struct dev_context *devc;
e756c595	162
e756c595 J	163	(void)cg;
e756c595 J	164
ab2b21fb	165	devc = sdi->priv;
e756c595	166
ab2b21fb	167	return sr_sw_limits_config_set(&devc->limits, key, data);
e756c595 J	168	}
	169
	170	static int config_list(uint32_t key, GVariant **data,
	171	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	172	{
ab2b21fb J	173	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
ab2b21fb J	174	}
e756c595	175
ab2b21fb J	176	static int config_get(uint32_t key, GVariant **data,
	177	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	178	{
	179	struct dev_context *devc = sdi->priv;
e756c595	180
ab2b21fb	181	(void)cg;
e756c595	182
ab2b21fb	183	return sr_sw_limits_config_get(&devc->limits, key, data);
e756c595 J	184	}
	185
	186	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	187	{
ab2b21fb J	188	struct sr_scpi_dev_inst *scpi;
	189	struct dev_context *devc;
	190	int ret;
	191
	192	scpi = sdi->conn;
	193	devc = sdi->priv;
	194
	195	sr_sw_limits_acquisition_start(&devc->limits);
	196	std_session_send_df_header(sdi);
e756c595	197
ab2b21fb J	198	if ((ret = sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 10,
	199	fl45_scpi_receive_data, (void *)sdi)) != SR_OK)
	200	return ret;
e756c595 J	201
	202	return SR_OK;
	203	}
	204
	205	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	206	{
ab2b21fb J	207	struct sr_scpi_dev_inst *scpi;
ab2b21fb J	208	double d;
e756c595	209
ab2b21fb J	210	scpi = sdi->conn;
	211
	212	/*
	213	* A requested value is certainly on the way. Retrieve it now,
	214	* to avoid leaving the device in a state where it's not expecting
	215	* commands.
	216	*/
	217	sr_scpi_get_double(scpi, NULL, &d);
	218	sr_scpi_source_remove(sdi->session, scpi);
	219
	220	std_session_send_df_end(sdi);
e756c595 J	221
	222	return SR_OK;
	223	}
	224
ab2b21fb	225	static struct sr_dev_driver fluke_45_driver_info = {
e756c595 J	226	.name = "fluke-45",
	227	.longname = "Fluke 45",
	228	.api_version = 1,
	229	.init = std_init,
	230	.cleanup = std_cleanup,
	231	.scan = scan,
	232	.dev_list = std_dev_list,
	233	.dev_clear = std_dev_clear,
	234	.config_get = config_get,
	235	.config_set = config_set,
	236	.config_list = config_list,
	237	.dev_open = dev_open,
	238	.dev_close = dev_close,
	239	.dev_acquisition_start = dev_acquisition_start,
	240	.dev_acquisition_stop = dev_acquisition_stop,
	241	.context = NULL,
	242	};
e756c595	243	SR_REGISTER_DEV_DRIVER(fluke_45_driver_info);