[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 <config.h>
#include <glib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <libsigrok/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_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
};

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

	drvc = di->context;
	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;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

	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;
	buf = g_malloc(len);
	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 = g_malloc0(sizeof(struct sr_dev_inst));
			sdi->status = SR_ST_INACTIVE;
			sdi->vendor = g_strdup("Agilent");
			sdi->model = g_strdup(tokens[1]);
			sdi->version = g_strdup(tokens[3]);
			devc = g_malloc0(sizeof(struct dev_context));
			devc->profile = &supported_agdmm[i];
			devc->cur_mq = -1;
			sdi->inst_type = SR_INST_SERIAL;
			sdi->conn = serial;
			sdi->priv = devc;
			sdi->driver = di;
			sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
			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 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;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_MSEC:
		/* TODO: not yet implemented */
		devc->limit_msec = g_variant_get_uint64(data);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		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)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)
{
	struct sr_serial_dev_inst *serial;

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

	std_session_send_df_header(sdi, 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)
{
	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
			sdi->conn, LOG_PREFIX);
}

static struct sr_dev_driver agdmm_driver_info = {
	.name = "agilent-dmm",
	.longname = "Agilent U12xx series DMMs",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_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,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(agdmm_driver_info);
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 <config.h>
	21	#include <glib.h>
	22	#include <sys/types.h>
	23	#include <sys/stat.h>
	24	#include <fcntl.h>
	25	#include <string.h>
	26	#include <libsigrok/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,
	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	static GSList scan(struct sr_dev_driver di, GSList *options)
	74	{
	75	struct sr_dev_inst *sdi;
	76	struct drv_context *drvc;
	77	struct dev_context *devc;
	78	struct sr_config *src;
	79	struct sr_serial_dev_inst *serial;
	80	GSList l, devices;
	81	int len, i;
	82	const char conn, serialcomm;
	83	char buf, *tokens;
	84
	85	drvc = di->context;
	86	drvc->instances = NULL;
	87
	88	devices = NULL;
	89	conn = serialcomm = NULL;
	90	for (l = options; l; l = l->next) {
	91	src = l->data;
	92	switch (src->key) {
	93	case SR_CONF_CONN:
	94	conn = g_variant_get_string(src->data, NULL);
	95	break;
	96	case SR_CONF_SERIALCOMM:
	97	serialcomm = g_variant_get_string(src->data, NULL);
	98	break;
	99	}
	100	}
	101	if (!conn)
	102	return NULL;
	103	if (!serialcomm)
	104	serialcomm = SERIALCOMM;
	105
	106	serial = sr_serial_dev_inst_new(conn, serialcomm);
	107
	108	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
	109	return NULL;
	110
	111	serial_flush(serial);
	112	if (serial_write_blocking(serial, "*IDN?\r\n", 7, SERIAL_WRITE_TIMEOUT_MS) < 7) {
	113	sr_err("Unable to send identification string.");
	114	return NULL;
	115	}
	116
	117	len = 128;
	118	buf = g_malloc(len);
	119	serial_readline(serial, &buf, &len, 250);
	120	if (!len)
	121	return NULL;
	122
	123	tokens = g_strsplit(buf, ",", 4);
	124	if (!strcmp("Agilent Technologies", tokens[0])
	125	&& tokens[1] && tokens[2] && tokens[3]) {
	126	for (i = 0; supported_agdmm[i].model; i++) {
	127	if (strcmp(supported_agdmm[i].modelname, tokens[1]))
	128	continue;
	129	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	130	sdi->status = SR_ST_INACTIVE;
	131	sdi->vendor = g_strdup("Agilent");
	132	sdi->model = g_strdup(tokens[1]);
	133	sdi->version = g_strdup(tokens[3]);
	134	devc = g_malloc0(sizeof(struct dev_context));
	135	devc->profile = &supported_agdmm[i];
	136	devc->cur_mq = -1;
	137	sdi->inst_type = SR_INST_SERIAL;
	138	sdi->conn = serial;
	139	sdi->priv = devc;
	140	sdi->driver = di;
	141	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	142	drvc->instances = g_slist_append(drvc->instances, sdi);
	143	devices = g_slist_append(devices, sdi);
	144	break;
	145	}
	146	}
	147	g_strfreev(tokens);
	148	g_free(buf);
	149
	150	serial_close(serial);
	151	if (!devices)
	152	sr_serial_dev_inst_free(serial);
	153
	154	return devices;
	155	}
	156
	157	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	158	const struct sr_channel_group *cg)
	159	{
	160	struct dev_context *devc;
	161
	162	(void)cg;
	163
	164	if (sdi->status != SR_ST_ACTIVE)
	165	return SR_ERR_DEV_CLOSED;
	166
	167	devc = sdi->priv;
	168
	169	switch (key) {
	170	case SR_CONF_LIMIT_MSEC:
	171	/* TODO: not yet implemented */
	172	devc->limit_msec = g_variant_get_uint64(data);
	173	break;
	174	case SR_CONF_LIMIT_SAMPLES:
	175	devc->limit_samples = g_variant_get_uint64(data);
	176	break;
	177	default:
	178	return SR_ERR_NA;
	179	}
	180
	181	return SR_OK;
	182	}
	183
	184	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	185	const struct sr_channel_group *cg)
	186	{
	187	(void)cg;
	188
	189	switch (key) {
	190	case SR_CONF_SCAN_OPTIONS:
	191	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	192	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	193	break;
	194	case SR_CONF_DEVICE_OPTIONS:
	195	if (!sdi)
	196	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	197	drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
	198	else
	199	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	200	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	201	break;
	202	default:
	203	return SR_ERR_NA;
	204	}
	205
	206	return SR_OK;
	207	}
	208
	209	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	210	{
	211	struct sr_serial_dev_inst *serial;
	212
	213	if (sdi->status != SR_ST_ACTIVE)
	214	return SR_ERR_DEV_CLOSED;
	215
	216	std_session_send_df_header(sdi, LOG_PREFIX);
	217
	218	/* Poll every 100ms, or whenever some data comes in. */
	219	serial = sdi->conn;
	220	serial_source_add(sdi->session, serial, G_IO_IN, 100,
	221	agdmm_receive_data, (void *)sdi);
	222
	223	return SR_OK;
	224	}
	225
	226	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	227	{
	228	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
	229	sdi->conn, LOG_PREFIX);
	230	}
	231
	232	static struct sr_dev_driver agdmm_driver_info = {
	233	.name = "agilent-dmm",
	234	.longname = "Agilent U12xx series DMMs",
	235	.api_version = 1,
	236	.init = std_init,
	237	.cleanup = std_cleanup,
	238	.scan = scan,
	239	.dev_list = std_dev_list,
	240	.dev_clear = NULL,
	241	.config_get = NULL,
	242	.config_set = config_set,
	243	.config_list = config_list,
	244	.dev_open = std_serial_dev_open,
	245	.dev_close = std_serial_dev_close,
	246	.dev_acquisition_start = dev_acquisition_start,
	247	.dev_acquisition_stop = dev_acquisition_stop,
	248	.context = NULL,
	249	};
	250	SR_REGISTER_DEV_DRIVER(agdmm_driver_info);