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

static const int32_t hwcaps[] = {
	SR_CONF_MULTIMETER,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_LIMIT_MSEC,
	SR_CONF_CONTINUOUS,
};

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_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 | SERIAL_NONBLOCK) != SR_OK)
		return NULL;

	serial_flush(serial);
	if (serial_write(serial, "*IDN?\r\n", 7) == -1) {
		sr_err("Unable to send identification string: %s.",
		       strerror(errno));
		return NULL;
	}

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