[libsigrok.git] / hardware / agilent-dmm / api.c

/*
 * This file is part of the sigrok 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;

/* Properly close and free all devices. */
static int clear_instances(void)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	GSList *l;

	if (!(drvc = di->priv))
		return SR_OK;

	drvc = di->priv;
	for (l = drvc->instances; l; l = l->next) {
		if (!(sdi = l->data))
			continue;
		if (!(devc = sdi->priv))
			continue;
		sr_serial_dev_inst_free(devc->serial);
		sr_dev_inst_free(sdi);
	}
	g_slist_free(drvc->instances);
	drvc->instances = NULL;

	return SR_OK;
}

static int hw_init(struct sr_context *sr_ctx)
{
	return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
}

static GSList *hw_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[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->serial = serial;
			devc->cur_mq = -1;
			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 *hw_dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

static int hw_dev_open(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

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

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

static int hw_dev_close(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	devc = sdi->priv;

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

	return SR_OK;
}

static int hw_cleanup(void)
{

	clear_instances();

	return SR_OK;
}

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

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

	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:
		sr_err("Unknown capability: %d.", id);
		return SR_ERR;
		break;
	}

	return SR_OK;
}

static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
{

	(void)sdi;

	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_ARG;
	}

	return SR_OK;
}

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
		void *cb_data)
{
	struct dev_context *devc;

	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, DRIVER_LOG_DOMAIN);

	/* Poll every 100ms, or whenever some data comes in. */
	sr_source_add(devc->serial->fd, G_IO_IN, 100, agdmm_receive_data, (void *)sdi);

	return SR_OK;
}

static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
	       ((struct dev_context *)(sdi->priv))->serial, DRIVER_LOG_DOMAIN);
}

SR_PRIV struct sr_dev_driver agdmm_driver_info = {
	.name = "agilent-dmm",
	.longname = "Agilent U12xx series DMMs",
	.api_version = 1,
	.init = hw_init,
	.cleanup = hw_cleanup,
	.scan = hw_scan,
	.dev_list = hw_dev_list,
	.dev_clear = clear_instances,
	.config_get = NULL,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = hw_dev_open,
	.dev_close = hw_dev_close,
	.dev_acquisition_start = hw_dev_acquisition_start,
	.dev_acquisition_stop = hw_dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
	1	/*
	2	* This file is part of the sigrok 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	/* Properly close and free all devices. */
	65	static int clear_instances(void)
	66	{
	67	struct sr_dev_inst *sdi;
	68	struct drv_context *drvc;
	69	struct dev_context *devc;
	70	GSList *l;
	71
	72	if (!(drvc = di->priv))
	73	return SR_OK;
	74
	75	drvc = di->priv;
	76	for (l = drvc->instances; l; l = l->next) {
	77	if (!(sdi = l->data))
	78	continue;
	79	if (!(devc = sdi->priv))
	80	continue;
	81	sr_serial_dev_inst_free(devc->serial);
	82	sr_dev_inst_free(sdi);
	83	}
	84	g_slist_free(drvc->instances);
	85	drvc->instances = NULL;
	86
	87	return SR_OK;
	88	}
	89
	90	static int hw_init(struct sr_context *sr_ctx)
	91	{
	92	return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
	93	}
	94
	95	static GSList hw_scan(GSList options)
	96	{
	97	struct sr_dev_inst *sdi;
	98	struct drv_context *drvc;
	99	struct dev_context *devc;
	100	struct sr_config *src;
	101	struct sr_probe *probe;
	102	struct sr_serial_dev_inst *serial;
	103	GSList l, devices;
	104	int len, i;
	105	const char conn, serialcomm;
	106	char buf, *tokens;
	107
	108	drvc = di->priv;
	109	drvc->instances = NULL;
	110
	111	devices = NULL;
	112	conn = serialcomm = NULL;
	113	for (l = options; l; l = l->next) {
	114	src = l->data;
	115	switch (src->key) {
	116	case SR_CONF_CONN:
	117	conn = g_variant_get_string(src->data, NULL);
	118	break;
	119	case SR_CONF_SERIALCOMM:
	120	serialcomm = g_variant_get_string(src->data, NULL);
	121	break;
	122	}
	123	}
	124	if (!conn)
	125	return NULL;
	126	if (!serialcomm)
	127	serialcomm = SERIALCOMM;
	128
	129	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	130	return NULL;
	131
	132	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	133	return NULL;
	134
	135	serial_flush(serial);
	136	if (serial_write(serial, "*IDN?\r\n", 7) == -1) {
	137	sr_err("Unable to send identification string: %s.",
	138	strerror(errno));
	139	return NULL;
	140	}
	141
	142	len = 128;
	143	if (!(buf = g_try_malloc(len))) {
	144	sr_err("Serial buffer malloc failed.");
	145	return NULL;
	146	}
	147	serial_readline(serial, &buf, &len, 150);
	148	if (!len)
	149	return NULL;
	150
	151	tokens = g_strsplit(buf, ",", 4);
	152	if (!strcmp("Agilent Technologies", tokens[0])
	153	&& tokens[2] && tokens[3]) {
	154	for (i = 0; supported_agdmm[i].model; i++) {
	155	if (strcmp(supported_agdmm[i].modelname, tokens[1]))
	156	continue;
	157	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, tokens[0],
	158	tokens[1], tokens[3])))
	159	return NULL;
	160	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	161	sr_err("Device context malloc failed.");
	162	return NULL;
	163	}
	164	devc->profile = &supported_agdmm[i];
	165	devc->serial = serial;
	166	devc->cur_mq = -1;
	167	sdi->priv = devc;
	168	sdi->driver = di;
	169	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
	170	return NULL;
	171	sdi->probes = g_slist_append(sdi->probes, probe);
	172	drvc->instances = g_slist_append(drvc->instances, sdi);
	173	devices = g_slist_append(devices, sdi);
	174	break;
	175	}
	176	}
	177	g_strfreev(tokens);
	178	g_free(buf);
	179
	180	serial_close(serial);
	181	if (!devices)
	182	sr_serial_dev_inst_free(serial);
	183
	184	return devices;
	185	}
	186
	187	static GSList *hw_dev_list(void)
	188	{
	189	return ((struct drv_context *)(di->priv))->instances;
	190	}
	191
	192	static int hw_dev_open(struct sr_dev_inst *sdi)
	193	{
	194	struct dev_context *devc;
	195
	196	if (!(devc = sdi->priv)) {
	197	sr_err("sdi->priv was NULL.");
	198	return SR_ERR_BUG;
	199	}
	200
	201	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	202	return SR_ERR;
	203
	204	sdi->status = SR_ST_ACTIVE;
	205
	206	return SR_OK;
	207	}
	208
	209	static int hw_dev_close(struct sr_dev_inst *sdi)
	210	{
	211	struct dev_context *devc;
	212
	213	devc = sdi->priv;
	214
	215	if (devc->serial && devc->serial->fd != -1) {
	216	serial_close(devc->serial);
	217	sdi->status = SR_ST_INACTIVE;
	218	}
	219
	220	return SR_OK;
	221	}
	222
	223	static int hw_cleanup(void)
	224	{
	225
	226	clear_instances();
	227
	228	return SR_OK;
	229	}
	230
	231	static int config_set(int id, GVariant data, const struct sr_dev_inst sdi)
	232	{
	233	struct dev_context *devc;
	234
	235	if (sdi->status != SR_ST_ACTIVE)
	236	return SR_ERR;
	237
	238	if (!(devc = sdi->priv)) {
	239	sr_err("sdi->priv was NULL.");
	240	return SR_ERR_BUG;
	241	}
	242
	243	switch (id) {
	244	case SR_CONF_LIMIT_MSEC:
	245	/* TODO: not yet implemented */
	246	if (g_variant_get_uint64(data) == 0) {
	247	sr_err("LIMIT_MSEC can't be 0.");
	248	return SR_ERR;
	249	}
	250	devc->limit_msec = g_variant_get_uint64(data);
	251	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	252	devc->limit_msec);
	253	break;
	254	case SR_CONF_LIMIT_SAMPLES:
	255	devc->limit_samples = g_variant_get_uint64(data);
	256	sr_dbg("Setting sample limit to %" PRIu64 ".",
	257	devc->limit_samples);
	258	break;
	259	default:
	260	sr_err("Unknown capability: %d.", id);
	261	return SR_ERR;
	262	break;
	263	}
	264
	265	return SR_OK;
	266	}
	267
	268	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi)
	269	{
	270
	271	(void)sdi;
	272
	273	switch (key) {
	274	case SR_CONF_SCAN_OPTIONS:
	275	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	276	hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
	277	break;
	278	case SR_CONF_DEVICE_OPTIONS:
	279	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	280	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
	281	break;
	282	default:
	283	return SR_ERR_ARG;
	284	}
	285
	286	return SR_OK;
	287	}
	288
	289	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	290	void *cb_data)
	291	{
	292	struct dev_context *devc;
	293
	294	if (!(devc = sdi->priv)) {
	295	sr_err("sdi->priv was NULL.");
	296	return SR_ERR_BUG;
	297	}
	298
	299	devc->cb_data = cb_data;
	300
	301	/* Send header packet to the session bus. */
	302	std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
	303
	304	/* Poll every 100ms, or whenever some data comes in. */
	305	sr_source_add(devc->serial->fd, G_IO_IN, 100, agdmm_receive_data, (void *)sdi);
	306
	307	return SR_OK;
	308	}
	309
	310	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	311	{
	312	return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
	313	((struct dev_context *)(sdi->priv))->serial, DRIVER_LOG_DOMAIN);
	314	}
	315
	316	SR_PRIV struct sr_dev_driver agdmm_driver_info = {
	317	.name = "agilent-dmm",
	318	.longname = "Agilent U12xx series DMMs",
	319	.api_version = 1,
	320	.init = hw_init,
	321	.cleanup = hw_cleanup,
	322	.scan = hw_scan,
	323	.dev_list = hw_dev_list,
	324	.dev_clear = clear_instances,
	325	.config_get = NULL,
	326	.config_set = config_set,
	327	.config_list = config_list,
	328	.dev_open = hw_dev_open,
	329	.dev_close = hw_dev_close,
	330	.dev_acquisition_start = hw_dev_acquisition_start,
	331	.dev_acquisition_stop = hw_dev_acquisition_stop,
	332	.priv = NULL,
	333	};