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