[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 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;
	serial_source_add(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 = dev_clear,
	.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 int32_t hwopts[] = {
	31	SR_CONF_CONN,
	32	SR_CONF_SERIALCOMM,
	33	};
	34
	35	static const int32_t hwcaps[] = {
	36	SR_CONF_MULTIMETER,
	37	SR_CONF_LIMIT_SAMPLES,
	38	SR_CONF_LIMIT_MSEC,
	39	SR_CONF_CONTINUOUS,
	40	};
	41
	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[];
	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_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 }
	59	};
	60
	61	SR_PRIV struct sr_dev_driver agdmm_driver_info;
	62	static struct sr_dev_driver *di = &agdmm_driver_info;
	63
	64	static int dev_clear(void)
	65	{
	66	return std_dev_clear(di, NULL);
	67	}
	68
	69	static int init(struct sr_context *sr_ctx)
	70	{
	71	return std_init(sr_ctx, di, LOG_PREFIX);
	72	}
	73
	74	static GSList scan(GSList options)
	75	{
	76	struct sr_dev_inst *sdi;
	77	struct drv_context *drvc;
	78	struct dev_context *devc;
	79	struct sr_config *src;
	80	struct sr_probe *probe;
	81	struct sr_serial_dev_inst *serial;
	82	GSList l, devices;
	83	int len, i;
	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) {
	93	src = l->data;
	94	switch (src->key) {
	95	case SR_CONF_CONN:
	96	conn = g_variant_get_string(src->data, NULL);
	97	break;
	98	case SR_CONF_SERIALCOMM:
	99	serialcomm = g_variant_get_string(src->data, NULL);
	100	break;
	101	}
	102	}
	103	if (!conn)
	104	return NULL;
	105	if (!serialcomm)
	106	serialcomm = SERIALCOMM;
	107
	108	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	109	return NULL;
	110
	111	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	112	return NULL;
	113
	114	serial_flush(serial);
	115	if (serial_write(serial, "*IDN?\r\n", 7) == -1) {
	116	sr_err("Unable to send identification string: %s.",
	117	strerror(errno));
	118	return NULL;
	119	}
	120
	121	len = 128;
	122	if (!(buf = g_try_malloc(len))) {
	123	sr_err("Serial buffer malloc failed.");
	124	return NULL;
	125	}
	126	serial_readline(serial, &buf, &len, 150);
	127	if (!len)
	128	return NULL;
	129
	130	tokens = g_strsplit(buf, ",", 4);
	131	if (!strcmp("Agilent Technologies", tokens[0])
	132	&& tokens[1] && tokens[2] && tokens[3]) {
	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)))) {
	140	sr_err("Device context malloc failed.");
	141	return NULL;
	142	}
	143	devc->profile = &supported_agdmm[i];
	144	devc->cur_mq = -1;
	145	sdi->inst_type = SR_INST_SERIAL;
	146	sdi->conn = serial;
	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
	160	serial_close(serial);
	161	if (!devices)
	162	sr_serial_dev_inst_free(serial);
	163
	164	return devices;
	165	}
	166
	167	static GSList *dev_list(void)
	168	{
	169	return ((struct drv_context *)(di->priv))->instances;
	170	}
	171
	172	static int cleanup(void)
	173	{
	174	return dev_clear();
	175	}
	176
	177	static int config_set(int id, GVariant data, const struct sr_dev_inst sdi,
	178	const struct sr_probe_group *probe_group)
	179	{
	180	struct dev_context *devc;
	181
	182	(void)probe_group;
	183
	184	if (sdi->status != SR_ST_ACTIVE)
	185	return SR_ERR_DEV_CLOSED;
	186
	187	if (!(devc = sdi->priv)) {
	188	sr_err("sdi->priv was NULL.");
	189	return SR_ERR_BUG;
	190	}
	191
	192	switch (id) {
	193	case SR_CONF_LIMIT_MSEC:
	194	/* TODO: not yet implemented */
	195	if (g_variant_get_uint64(data) == 0) {
	196	sr_err("LIMIT_MSEC can't be 0.");
	197	return SR_ERR;
	198	}
	199	devc->limit_msec = g_variant_get_uint64(data);
	200	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	201	devc->limit_msec);
	202	break;
	203	case SR_CONF_LIMIT_SAMPLES:
	204	devc->limit_samples = g_variant_get_uint64(data);
	205	sr_dbg("Setting sample limit to %" PRIu64 ".",
	206	devc->limit_samples);
	207	break;
	208	default:
	209	return SR_ERR_NA;
	210	}
	211
	212	return SR_OK;
	213	}
	214
	215	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi,
	216	const struct sr_probe_group *probe_group)
	217	{
	218	(void)sdi;
	219	(void)probe_group;
	220
	221	switch (key) {
	222	case SR_CONF_SCAN_OPTIONS:
	223	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	224	hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
	225	break;
	226	case SR_CONF_DEVICE_OPTIONS:
	227	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	228	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
	229	break;
	230	default:
	231	return SR_ERR_NA;
	232	}
	233
	234	return SR_OK;
	235	}
	236
	237	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	238	{
	239	struct dev_context *devc;
	240	struct sr_serial_dev_inst *serial;
	241
	242	if (sdi->status != SR_ST_ACTIVE)
	243	return SR_ERR_DEV_CLOSED;
	244
	245	if (!(devc = sdi->priv)) {
	246	sr_err("sdi->priv was NULL.");
	247	return SR_ERR_BUG;
	248	}
	249
	250	devc->cb_data = cb_data;
	251
	252	/* Send header packet to the session bus. */
	253	std_session_send_df_header(cb_data, LOG_PREFIX);
	254
	255	/* Poll every 100ms, or whenever some data comes in. */
	256	serial = sdi->conn;
	257	serial_source_add(serial, G_IO_IN, 100, agdmm_receive_data, (void *)sdi);
	258
	259	return SR_OK;
	260	}
	261
	262	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	263	{
	264	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
	265	sdi->conn, LOG_PREFIX);
	266	}
	267
	268	SR_PRIV struct sr_dev_driver agdmm_driver_info = {
	269	.name = "agilent-dmm",
	270	.longname = "Agilent U12xx series DMMs",
	271	.api_version = 1,
	272	.init = init,
	273	.cleanup = cleanup,
	274	.scan = scan,
	275	.dev_list = dev_list,
	276	.dev_clear = dev_clear,
	277	.config_get = NULL,
	278	.config_set = config_set,
	279	.config_list = config_list,
	280	.dev_open = std_serial_dev_open,
	281	.dev_close = std_serial_dev_close,
	282	.dev_acquisition_start = dev_acquisition_start,
	283	.dev_acquisition_stop = dev_acquisition_stop,
	284	.priv = NULL,
	285	};