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

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 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 <glib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <errno.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "agilent-dmm.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_SET,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_SET,
};

extern const struct agdmm_job agdmm_jobs_u12xx[];
extern const struct agdmm_recv agdmm_recvs_u123x[];
extern const struct agdmm_recv agdmm_recvs_u124x[];
extern const struct agdmm_recv agdmm_recvs_u125x[];

/* This works on all the Agilent U12xxA series, although the
 * U127xA can apparently also run at 19200/8n1. */
#define SERIALCOMM "9600/8n1"

static const struct agdmm_profile supported_agdmm[] = {
	{ AGILENT_U1231, "U1231A", agdmm_jobs_u12xx, agdmm_recvs_u123x },
	{ AGILENT_U1232, "U1232A", agdmm_jobs_u12xx, agdmm_recvs_u123x },
	{ AGILENT_U1233, "U1233A", agdmm_jobs_u12xx, agdmm_recvs_u123x },

	{ AGILENT_U1241, "U1241A", agdmm_jobs_u12xx, agdmm_recvs_u124x },
	{ AGILENT_U1242, "U1242A", agdmm_jobs_u12xx, agdmm_recvs_u124x },
	{ AGILENT_U1241, "U1241B", agdmm_jobs_u12xx, agdmm_recvs_u124x },
	{ AGILENT_U1242, "U1242B", agdmm_jobs_u12xx, agdmm_recvs_u124x },

	{ AGILENT_U1251, "U1251A", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	{ AGILENT_U1252, "U1252A", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	{ AGILENT_U1253, "U1253A", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	{ AGILENT_U1251, "U1251B", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	{ AGILENT_U1252, "U1252B", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	{ AGILENT_U1253, "U1253B", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	ALL_ZERO
};

SR_PRIV struct sr_dev_driver agdmm_driver_info;
static struct sr_dev_driver *di = &agdmm_driver_info;

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

static GSList *scan(GSList *options)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_config *src;
	struct sr_channel *ch;
	struct sr_serial_dev_inst *serial;
	GSList *l, *devices;
	int len, i;
	const char *conn, *serialcomm;
	char *buf, **tokens;

	drvc = di->priv;
	drvc->instances = NULL;

	devices = NULL;
	conn = serialcomm = NULL;
	for (l = options; l; l = l->next) {
		src = l->data;
		switch (src->key) {
		case SR_CONF_CONN:
			conn = g_variant_get_string(src->data, NULL);
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = g_variant_get_string(src->data, NULL);
			break;
		}
	}
	if (!conn)
		return NULL;
	if (!serialcomm)
		serialcomm = SERIALCOMM;

	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
		return NULL;

	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		return NULL;

	serial_flush(serial);
	if (serial_write_blocking(serial, "*IDN?\r\n", 7, SERIAL_WRITE_TIMEOUT_MS) < 7) {
		sr_err("Unable to send identification string.");
		return NULL;
	}

	len = 128;
	if (!(buf = g_try_malloc(len))) {
		sr_err("Serial buffer malloc failed.");
		return NULL;
	}
	serial_readline(serial, &buf, &len, 250);
	if (!len)
		return NULL;

	tokens = g_strsplit(buf, ",", 4);
	if (!strcmp("Agilent Technologies", tokens[0])
			&& tokens[1] && tokens[2] && tokens[3]) {
		for (i = 0; supported_agdmm[i].model; i++) {
			if (strcmp(supported_agdmm[i].modelname, tokens[1]))
				continue;
			sdi = sr_dev_inst_new();
			sdi->status = SR_ST_INACTIVE;
			sdi->vendor = g_strdup("Agilent");
			sdi->model = g_strdup(tokens[1]);
			sdi->version = g_strdup(tokens[3]);
			if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
				sr_err("Device context malloc failed.");
				return NULL;
			}
			devc->profile = &supported_agdmm[i];
			devc->cur_mq = -1;
			sdi->inst_type = SR_INST_SERIAL;
			sdi->conn = serial;
			sdi->priv = devc;
			sdi->driver = di;
			if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
				return NULL;
			sdi->channels = g_slist_append(sdi->channels, ch);
			drvc->instances = g_slist_append(drvc->instances, sdi);
			devices = g_slist_append(devices, sdi);
			break;
		}
	}
	g_strfreev(tokens);
	g_free(buf);

	serial_close(serial);
	if (!devices)
		sr_serial_dev_inst_free(serial);

	return devices;
}

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

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

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;

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

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	switch (key) {
	case SR_CONF_LIMIT_MSEC:
		/* TODO: not yet implemented */
		if (g_variant_get_uint64(data) == 0) {
			sr_err("LIMIT_MSEC can't be 0.");
			return SR_ERR;
		}
		devc->limit_msec = g_variant_get_uint64(data);
		sr_dbg("Setting time limit to %" PRIu64 "ms.",
		       devc->limit_msec);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		if (!sdi)
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
					drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
		else
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
					devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

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

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	devc->cb_data = cb_data;

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, LOG_PREFIX);

	/* Poll every 100ms, or whenever some data comes in. */
	serial = sdi->conn;
	serial_source_add(sdi->session, serial, G_IO_IN, 100,
			agdmm_receive_data, (void *)sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
			sdi->conn, LOG_PREFIX);
}

SR_PRIV struct sr_dev_driver agdmm_driver_info = {
	.name = "agilent-dmm",
	.longname = "Agilent U12xx series DMMs",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = dev_list,
	.dev_clear = NULL,
	.config_get = NULL,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = std_serial_dev_open,
	.dev_close = std_serial_dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2012 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
	20	#include <glib.h>
	21	#include <sys/types.h>
	22	#include <sys/stat.h>
	23	#include <fcntl.h>
	24	#include <string.h>
	25	#include <errno.h>
	26	#include "libsigrok.h"
	27	#include "libsigrok-internal.h"
	28	#include "agilent-dmm.h"
	29
	30	static const uint32_t scanopts[] = {
	31	SR_CONF_CONN,
	32	SR_CONF_SERIALCOMM,
	33	};
	34
	35	static const uint32_t drvopts[] = {
	36	SR_CONF_MULTIMETER,
	37	};
	38
	39	static const uint32_t devopts[] = {
	40	SR_CONF_CONTINUOUS \| SR_CONF_SET,
	41	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
	42	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
	43	};
	44
	45	extern const struct agdmm_job agdmm_jobs_u12xx[];
	46	extern const struct agdmm_recv agdmm_recvs_u123x[];
	47	extern const struct agdmm_recv agdmm_recvs_u124x[];
	48	extern const struct agdmm_recv agdmm_recvs_u125x[];
	49
	50	/* This works on all the Agilent U12xxA series, although the
	51	* U127xA can apparently also run at 19200/8n1. */
	52	#define SERIALCOMM "9600/8n1"
	53
	54	static const struct agdmm_profile supported_agdmm[] = {
	55	{ AGILENT_U1231, "U1231A", agdmm_jobs_u12xx, agdmm_recvs_u123x },
	56	{ AGILENT_U1232, "U1232A", agdmm_jobs_u12xx, agdmm_recvs_u123x },
	57	{ AGILENT_U1233, "U1233A", agdmm_jobs_u12xx, agdmm_recvs_u123x },
	58
	59	{ AGILENT_U1241, "U1241A", agdmm_jobs_u12xx, agdmm_recvs_u124x },
	60	{ AGILENT_U1242, "U1242A", agdmm_jobs_u12xx, agdmm_recvs_u124x },
	61	{ AGILENT_U1241, "U1241B", agdmm_jobs_u12xx, agdmm_recvs_u124x },
	62	{ AGILENT_U1242, "U1242B", agdmm_jobs_u12xx, agdmm_recvs_u124x },
	63
	64	{ AGILENT_U1251, "U1251A", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	65	{ AGILENT_U1252, "U1252A", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	66	{ AGILENT_U1253, "U1253A", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	67	{ AGILENT_U1251, "U1251B", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	68	{ AGILENT_U1252, "U1252B", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	69	{ AGILENT_U1253, "U1253B", agdmm_jobs_u12xx, agdmm_recvs_u125x },
	70	ALL_ZERO
	71	};
	72
	73	SR_PRIV struct sr_dev_driver agdmm_driver_info;
	74	static struct sr_dev_driver *di = &agdmm_driver_info;
	75
	76	static int init(struct sr_context *sr_ctx)
	77	{
	78	return std_init(sr_ctx, di, LOG_PREFIX);
	79	}
	80
	81	static GSList scan(GSList options)
	82	{
	83	struct sr_dev_inst *sdi;
	84	struct drv_context *drvc;
	85	struct dev_context *devc;
	86	struct sr_config *src;
	87	struct sr_channel *ch;
	88	struct sr_serial_dev_inst *serial;
	89	GSList l, devices;
	90	int len, i;
	91	const char conn, serialcomm;
	92	char buf, *tokens;
	93
	94	drvc = di->priv;
	95	drvc->instances = NULL;
	96
	97	devices = NULL;
	98	conn = serialcomm = NULL;
	99	for (l = options; l; l = l->next) {
	100	src = l->data;
	101	switch (src->key) {
	102	case SR_CONF_CONN:
	103	conn = g_variant_get_string(src->data, NULL);
	104	break;
	105	case SR_CONF_SERIALCOMM:
	106	serialcomm = g_variant_get_string(src->data, NULL);
	107	break;
	108	}
	109	}
	110	if (!conn)
	111	return NULL;
	112	if (!serialcomm)
	113	serialcomm = SERIALCOMM;
	114
	115	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	116	return NULL;
	117
	118	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	119	return NULL;
	120
	121	serial_flush(serial);
	122	if (serial_write_blocking(serial, "*IDN?\r\n", 7, SERIAL_WRITE_TIMEOUT_MS) < 7) {
	123	sr_err("Unable to send identification string.");
	124	return NULL;
	125	}
	126
	127	len = 128;
	128	if (!(buf = g_try_malloc(len))) {
	129	sr_err("Serial buffer malloc failed.");
	130	return NULL;
	131	}
	132	serial_readline(serial, &buf, &len, 250);
	133	if (!len)
	134	return NULL;
	135
	136	tokens = g_strsplit(buf, ",", 4);
	137	if (!strcmp("Agilent Technologies", tokens[0])
	138	&& tokens[1] && tokens[2] && tokens[3]) {
	139	for (i = 0; supported_agdmm[i].model; i++) {
	140	if (strcmp(supported_agdmm[i].modelname, tokens[1]))
	141	continue;
	142	sdi = sr_dev_inst_new();
	143	sdi->status = SR_ST_INACTIVE;
	144	sdi->vendor = g_strdup("Agilent");
	145	sdi->model = g_strdup(tokens[1]);
	146	sdi->version = g_strdup(tokens[3]);
	147	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	148	sr_err("Device context malloc failed.");
	149	return NULL;
	150	}
	151	devc->profile = &supported_agdmm[i];
	152	devc->cur_mq = -1;
	153	sdi->inst_type = SR_INST_SERIAL;
	154	sdi->conn = serial;
	155	sdi->priv = devc;
	156	sdi->driver = di;
	157	if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
	158	return NULL;
	159	sdi->channels = g_slist_append(sdi->channels, ch);
	160	drvc->instances = g_slist_append(drvc->instances, sdi);
	161	devices = g_slist_append(devices, sdi);
	162	break;
	163	}
	164	}
	165	g_strfreev(tokens);
	166	g_free(buf);
	167
	168	serial_close(serial);
	169	if (!devices)
	170	sr_serial_dev_inst_free(serial);
	171
	172	return devices;
	173	}
	174
	175	static GSList *dev_list(void)
	176	{
	177	return ((struct drv_context *)(di->priv))->instances;
	178	}
	179
	180	static int cleanup(void)
	181	{
	182	return std_dev_clear(di, NULL);
	183	}
	184
	185	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	186	const struct sr_channel_group *cg)
	187	{
	188	struct dev_context *devc;
	189
	190	(void)cg;
	191
	192	if (sdi->status != SR_ST_ACTIVE)
	193	return SR_ERR_DEV_CLOSED;
	194
	195	if (!(devc = sdi->priv)) {
	196	sr_err("sdi->priv was NULL.");
	197	return SR_ERR_BUG;
	198	}
	199
	200	switch (key) {
	201	case SR_CONF_LIMIT_MSEC:
	202	/* TODO: not yet implemented */
	203	if (g_variant_get_uint64(data) == 0) {
	204	sr_err("LIMIT_MSEC can't be 0.");
	205	return SR_ERR;
	206	}
	207	devc->limit_msec = g_variant_get_uint64(data);
	208	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	209	devc->limit_msec);
	210	break;
	211	case SR_CONF_LIMIT_SAMPLES:
	212	devc->limit_samples = g_variant_get_uint64(data);
	213	sr_dbg("Setting sample limit to %" PRIu64 ".",
	214	devc->limit_samples);
	215	break;
	216	default:
	217	return SR_ERR_NA;
	218	}
	219
	220	return SR_OK;
	221	}
	222
	223	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	224	const struct sr_channel_group *cg)
	225	{
	226	(void)sdi;
	227	(void)cg;
	228
	229	switch (key) {
	230	case SR_CONF_SCAN_OPTIONS:
	231	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	232	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	233	break;
	234	case SR_CONF_DEVICE_OPTIONS:
	235	if (!sdi)
	236	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	237	drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
	238	else
	239	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	240	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	241	break;
	242	default:
	243	return SR_ERR_NA;
	244	}
	245
	246	return SR_OK;
	247	}
	248
	249	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	250	{
	251	struct dev_context *devc;
	252	struct sr_serial_dev_inst *serial;
	253
	254	if (sdi->status != SR_ST_ACTIVE)
	255	return SR_ERR_DEV_CLOSED;
	256
	257	if (!(devc = sdi->priv)) {
	258	sr_err("sdi->priv was NULL.");
	259	return SR_ERR_BUG;
	260	}
	261
	262	devc->cb_data = cb_data;
	263
	264	/* Send header packet to the session bus. */
	265	std_session_send_df_header(cb_data, LOG_PREFIX);
	266
	267	/* Poll every 100ms, or whenever some data comes in. */
	268	serial = sdi->conn;
	269	serial_source_add(sdi->session, serial, G_IO_IN, 100,
	270	agdmm_receive_data, (void *)sdi);
	271
	272	return SR_OK;
	273	}
	274
	275	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	276	{
	277	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
	278	sdi->conn, LOG_PREFIX);
	279	}
	280
	281	SR_PRIV struct sr_dev_driver agdmm_driver_info = {
	282	.name = "agilent-dmm",
	283	.longname = "Agilent U12xx series DMMs",
	284	.api_version = 1,
	285	.init = init,
	286	.cleanup = cleanup,
	287	.scan = scan,
	288	.dev_list = dev_list,
	289	.dev_clear = NULL,
	290	.config_get = NULL,
	291	.config_set = config_set,
	292	.config_list = config_list,
	293	.dev_open = std_serial_dev_open,
	294	.dev_close = std_serial_dev_close,
	295	.dev_acquisition_start = dev_acquisition_start,
	296	.dev_acquisition_stop = dev_acquisition_stop,
	297	.priv = NULL,
	298	};