[libsigrok.git] / 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_u123x[];
extern const struct agdmm_recv agdmm_recvs_u123x[];
extern const struct agdmm_job agdmm_jobs_u125x[];
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_U1231A, "U1231A", agdmm_jobs_u123x, agdmm_recvs_u123x },
	{ AGILENT_U1232A, "U1232A", agdmm_jobs_u123x, agdmm_recvs_u123x },
	{ AGILENT_U1233A, "U1233A", agdmm_jobs_u123x, agdmm_recvs_u123x },
	{ AGILENT_U1251A, "U1251A", agdmm_jobs_u125x, agdmm_recvs_u125x },
	{ AGILENT_U1252A, "U1252A", agdmm_jobs_u125x, agdmm_recvs_u125x },
	{ AGILENT_U1253A, "U1253A", agdmm_jobs_u125x, agdmm_recvs_u125x },
	{ 0, NULL, NULL, NULL }
};

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

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

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_probe *probe;
	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, tokens[0],
					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 (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
				return NULL;
			sdi->probes = g_slist_append(sdi->probes, probe);
			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 dev_open(struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;

	serial = sdi->conn;
	if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
		return SR_ERR;

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_serial_dev_inst *serial;

	serial = sdi->conn;
	if (serial && serial->fd != -1) {
		serial_close(serial);
		sdi->status = SR_ST_INACTIVE;
	}

	return SR_OK;
}

static int cleanup(void)
{
	return dev_clear();
}

static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	struct dev_context *devc;

	(void)probe_group;

	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_probe_group *probe_group)
{
	(void)sdi;
	(void)probe_group;

	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;
	sr_source_add(serial->fd, 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_dev_acquisition_stop_serial(sdi, cb_data, 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 = dev_clear,
	.config_get = NULL,
	.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
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
8c0152f2 BV	42	extern const struct agdmm_job agdmm_jobs_u123x[];
	43	extern const struct agdmm_recv agdmm_recvs_u123x[];
	44	extern const struct agdmm_job agdmm_jobs_u125x[];
	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[] = {
74ac7d7f BV	52	{ AGILENT_U1231A, "U1231A", agdmm_jobs_u123x, agdmm_recvs_u123x },
	53	{ AGILENT_U1232A, "U1232A", agdmm_jobs_u123x, agdmm_recvs_u123x },
	54	{ AGILENT_U1233A, "U1233A", agdmm_jobs_u123x, agdmm_recvs_u123x },
	55	{ AGILENT_U1251A, "U1251A", agdmm_jobs_u125x, agdmm_recvs_u125x },
	56	{ AGILENT_U1252A, "U1252A", agdmm_jobs_u125x, agdmm_recvs_u125x },
	57	{ AGILENT_U1253A, "U1253A", agdmm_jobs_u125x, agdmm_recvs_u125x },
	58	{ 0, NULL, NULL, NULL }
e93cdf42 BV	59	};
	60
	61	SR_PRIV struct sr_dev_driver agdmm_driver_info;
	62	static struct sr_dev_driver *di = &agdmm_driver_info;
	63
3b412e3a	64	static int dev_clear(void)
e93cdf42	65	{
676c28a8	66	return std_dev_clear(di, NULL);
e93cdf42 BV	67	}
e93cdf42 BV	68
6078d2c9	69	static int init(struct sr_context *sr_ctx)
e93cdf42	70	{
f6beaac5	71	return std_init(sr_ctx, di, LOG_PREFIX);
e93cdf42 BV	72	}
e93cdf42 BV	73
6078d2c9	74	static GSList scan(GSList options)
e93cdf42 BV	75	{
	76	struct sr_dev_inst *sdi;
	77	struct drv_context *drvc;
	78	struct dev_context *devc;
1987b8d6	79	struct sr_config *src;
e93cdf42	80	struct sr_probe *probe;
109a3ba4	81	struct sr_serial_dev_inst *serial;
e93cdf42	82	GSList l, devices;
109a3ba4	83	int len, i;
e93cdf42 BV	84	const char conn, serialcomm;
	85	char buf, *tokens;
	86
	87	drvc = di->priv;
	88	drvc->instances = NULL;
	89
	90	devices = NULL;
	91	conn = serialcomm = NULL;
	92	for (l = options; l; l = l->next) {
1987b8d6 BV	93	src = l->data;
1987b8d6 BV	94	switch (src->key) {
1953564a	95	case SR_CONF_CONN:
e44ac12a	96	conn = g_variant_get_string(src->data, NULL);
e93cdf42	97	break;
1953564a	98	case SR_CONF_SERIALCOMM:
e44ac12a	99	serialcomm = g_variant_get_string(src->data, NULL);
e93cdf42 BV	100	break;
	101	}
	102	}
74ac7d7f	103	if (!conn)
e93cdf42	104	return NULL;
109a3ba4 BV	105	if (!serialcomm)
109a3ba4 BV	106	serialcomm = SERIALCOMM;
e93cdf42	107
109a3ba4	108	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
e93cdf42	109	return NULL;
e93cdf42	110
a54dd31e	111	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
e93cdf42	112	return NULL;
e93cdf42	113
109a3ba4 BV	114	serial_flush(serial);
109a3ba4 BV	115	if (serial_write(serial, "*IDN?\r\n", 7) == -1) {
38d326e8 UH	116	sr_err("Unable to send identification string: %s.",
38d326e8 UH	117	strerror(errno));
e93cdf42 BV	118	return NULL;
	119	}
	120
	121	len = 128;
886a52b6 UH	122	if (!(buf = g_try_malloc(len))) {
	123	sr_err("Serial buffer malloc failed.");
	124	return NULL;
	125	}
109a3ba4	126	serial_readline(serial, &buf, &len, 150);
e93cdf42 BV	127	if (!len)
	128	return NULL;
	129
	130	tokens = g_strsplit(buf, ",", 4);
	131	if (!strcmp("Agilent Technologies", tokens[0])
fbf07e02	132	&& tokens[1] && tokens[2] && tokens[3]) {
e93cdf42 BV	133	for (i = 0; supported_agdmm[i].model; i++) {
	134	if (strcmp(supported_agdmm[i].modelname, tokens[1]))
	135	continue;
	136	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, tokens[0],
	137	tokens[1], tokens[3])))
	138	return NULL;
	139	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
886a52b6	140	sr_err("Device context malloc failed.");
e93cdf42 BV	141	return NULL;
	142	}
	143	devc->profile = &supported_agdmm[i];
e93cdf42	144	devc->cur_mq = -1;
fb3a1505 BV	145	sdi->inst_type = SR_INST_SERIAL;
fb3a1505 BV	146	sdi->conn = serial;
e93cdf42 BV	147	sdi->priv = devc;
	148	sdi->driver = di;
	149	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
	150	return NULL;
	151	sdi->probes = g_slist_append(sdi->probes, probe);
	152	drvc->instances = g_slist_append(drvc->instances, sdi);
	153	devices = g_slist_append(devices, sdi);
	154	break;
	155	}
	156	}
	157	g_strfreev(tokens);
	158	g_free(buf);
	159
109a3ba4 BV	160	serial_close(serial);
	161	if (!devices)
	162	sr_serial_dev_inst_free(serial);
e93cdf42 BV	163
	164	return devices;
	165	}
	166
6078d2c9	167	static GSList *dev_list(void)
e93cdf42	168	{
0e94d524	169	return ((struct drv_context *)(di->priv))->instances;
e93cdf42 BV	170	}
e93cdf42 BV	171
6078d2c9	172	static int dev_open(struct sr_dev_inst *sdi)
e93cdf42	173	{
fb3a1505	174	struct sr_serial_dev_inst *serial;
e93cdf42	175
fb3a1505 BV	176	serial = sdi->conn;
fb3a1505 BV	177	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
e93cdf42	178	return SR_ERR;
109a3ba4	179
e93cdf42 BV	180	sdi->status = SR_ST_ACTIVE;
	181
	182	return SR_OK;
	183	}
	184
6078d2c9	185	static int dev_close(struct sr_dev_inst *sdi)
e93cdf42	186	{
fb3a1505	187	struct sr_serial_dev_inst *serial;
e93cdf42	188
fb3a1505 BV	189	serial = sdi->conn;
	190	if (serial && serial->fd != -1) {
	191	serial_close(serial);
e93cdf42 BV	192	sdi->status = SR_ST_INACTIVE;
	193	}
	194
	195	return SR_OK;
	196	}
	197
6078d2c9	198	static int cleanup(void)
e93cdf42	199	{
3b412e3a	200	return dev_clear();
e93cdf42 BV	201	}
e93cdf42 BV	202
8f996b89 ML	203	static int config_set(int id, GVariant data, const struct sr_dev_inst sdi,
8f996b89 ML	204	const struct sr_probe_group *probe_group)
e93cdf42 BV	205	{
	206	struct dev_context *devc;
	207
8f996b89 ML	208	(void)probe_group;
8f996b89 ML	209
e93cdf42	210	if (sdi->status != SR_ST_ACTIVE)
e73ffd42	211	return SR_ERR_DEV_CLOSED;
e93cdf42 BV	212
e93cdf42 BV	213	if (!(devc = sdi->priv)) {
38d326e8	214	sr_err("sdi->priv was NULL.");
e93cdf42 BV	215	return SR_ERR_BUG;
	216	}
	217
035a1078	218	switch (id) {
1953564a	219	case SR_CONF_LIMIT_MSEC:
e93cdf42	220	/* TODO: not yet implemented */
e44ac12a	221	if (g_variant_get_uint64(data) == 0) {
38d326e8	222	sr_err("LIMIT_MSEC can't be 0.");
e93cdf42 BV	223	return SR_ERR;
e93cdf42 BV	224	}
e44ac12a	225	devc->limit_msec = g_variant_get_uint64(data);
38d326e8	226	sr_dbg("Setting time limit to %" PRIu64 "ms.",
e93cdf42 BV	227	devc->limit_msec);
e93cdf42 BV	228	break;
1953564a	229	case SR_CONF_LIMIT_SAMPLES:
e44ac12a	230	devc->limit_samples = g_variant_get_uint64(data);
38d326e8	231	sr_dbg("Setting sample limit to %" PRIu64 ".",
e93cdf42 BV	232	devc->limit_samples);
	233	break;
	234	default:
bd6fbf62	235	return SR_ERR_NA;
e93cdf42 BV	236	}
	237
	238	return SR_OK;
	239	}
	240
8f996b89 ML	241	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi,
8f996b89 ML	242	const struct sr_probe_group *probe_group)
a1c743fc	243	{
a1c743fc	244	(void)sdi;
8f996b89	245	(void)probe_group;
a1c743fc BV	246
a1c743fc BV	247	switch (key) {
0d485e30	248	case SR_CONF_SCAN_OPTIONS:
e44ac12a BV	249	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
e44ac12a BV	250	hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
0d485e30	251	break;
9a6517d1	252	case SR_CONF_DEVICE_OPTIONS:
e44ac12a BV	253	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
e44ac12a BV	254	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
9a6517d1	255	break;
a1c743fc	256	default:
bd6fbf62	257	return SR_ERR_NA;
a1c743fc BV	258	}
	259
	260	return SR_OK;
	261	}
	262
6078d2c9	263	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
e93cdf42	264	{
e93cdf42	265	struct dev_context *devc;
fb3a1505	266	struct sr_serial_dev_inst *serial;
e93cdf42	267
e73ffd42 BV	268	if (sdi->status != SR_ST_ACTIVE)
	269	return SR_ERR_DEV_CLOSED;
	270
e93cdf42	271	if (!(devc = sdi->priv)) {
38d326e8	272	sr_err("sdi->priv was NULL.");
e93cdf42 BV	273	return SR_ERR_BUG;
	274	}
	275
e93cdf42 BV	276	devc->cb_data = cb_data;
	277
	278	/* Send header packet to the session bus. */
29a27196	279	std_session_send_df_header(cb_data, LOG_PREFIX);
e93cdf42	280
e93cdf42	281	/* Poll every 100ms, or whenever some data comes in. */
fb3a1505 BV	282	serial = sdi->conn;
fb3a1505 BV	283	sr_source_add(serial->fd, G_IO_IN, 100, agdmm_receive_data, (void *)sdi);
e93cdf42 BV	284
	285	return SR_OK;
	286	}
	287
6078d2c9	288	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
e93cdf42	289	{
f6beaac5	290	return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
29a27196	291	sdi->conn, LOG_PREFIX);
e93cdf42 BV	292	}
	293
	294	SR_PRIV struct sr_dev_driver agdmm_driver_info = {
	295	.name = "agilent-dmm",
	296	.longname = "Agilent U12xx series DMMs",
	297	.api_version = 1,
6078d2c9 UH	298	.init = init,
	299	.cleanup = cleanup,
	300	.scan = scan,
	301	.dev_list = dev_list,
3b412e3a	302	.dev_clear = dev_clear,
6fab7b8f	303	.config_get = NULL,
035a1078	304	.config_set = config_set,
a1c743fc	305	.config_list = config_list,
6078d2c9 UH	306	.dev_open = dev_open,
	307	.dev_close = dev_close,
	308	.dev_acquisition_start = dev_acquisition_start,
	309	.dev_acquisition_stop = dev_acquisition_stop,
e93cdf42 BV	310	.priv = NULL,
e93cdf42 BV	311	};