[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;
	struct sr_serial_dev_inst *serial;
	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;
		serial = sdi->conn;
		sr_serial_dev_inst_free(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->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 *hw_dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

static int hw_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 hw_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 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:
		return SR_ERR_NA;
	}

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

	return SR_OK;
}

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

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