[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 int hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
	0,
};

static const int hwcaps[] = {
	SR_CONF_MULTIMETER,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_LIMIT_MSEC,
	SR_CONF_CONTINUOUS,
	0,
};

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 = src->value;
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = src->value;
			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)
{
	struct drv_context *drvc;

	drvc = di->priv;

	return drvc->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;

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

	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, const void *value, 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 (*(const uint64_t *)value == 0) {
			sr_err("LIMIT_MSEC can't be 0.");
			return SR_ERR;
		}
		devc->limit_msec = *(const uint64_t *)value;
		sr_dbg("Setting time limit to %" PRIu64 "ms.",
		       devc->limit_msec);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = *(const uint64_t *)value;
		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, const void **data, const struct sr_dev_inst *sdi)
{

	(void)sdi;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = hwopts;
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = hwcaps;
		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 sr_datafeed_packet packet;
	struct sr_datafeed_header header;
	struct dev_context *devc;

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

	sr_dbg("Starting acquisition.");

	devc->cb_data = cb_data;

	/* Send header packet to the session bus. */
	sr_dbg("Sending SR_DF_HEADER.");
	packet.type = SR_DF_HEADER;
	packet.payload = (uint8_t *)&header;
	header.feed_version = 1;
	gettimeofday(&header.starttime, NULL);
	sr_session_send(devc->cb_data, &packet);

	/* 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)
{
	struct sr_datafeed_packet packet;
	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;
	}

	sr_dbg("Stopping acquisition.");

	sr_source_remove(devc->serial->fd);
	hw_dev_close((struct sr_dev_inst *)sdi);

	/* Send end packet to the session bus. */
	sr_dbg("Sending SR_DF_END.");
	packet.type = SR_DF_END;
	sr_session_send(cb_data, &packet);


	return SR_OK;
}

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_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 int hwopts[] = {
	31	SR_CONF_CONN,
	32	SR_CONF_SERIALCOMM,
	33	0,
	34	};
	35
	36	static const int hwcaps[] = {
	37	SR_CONF_MULTIMETER,
	38	SR_CONF_LIMIT_SAMPLES,
	39	SR_CONF_LIMIT_MSEC,
	40	SR_CONF_CONTINUOUS,
	41	0,
	42	};
	43
	44	extern const struct agdmm_job agdmm_jobs_u123x[];
	45	extern const struct agdmm_recv agdmm_recvs_u123x[];
	46	extern const struct agdmm_job agdmm_jobs_u125x[];
	47	extern const struct agdmm_recv agdmm_recvs_u125x[];
	48
	49	/* This works on all the Agilent U12xxA series, although the
	50	* U127xA can apparently also run at 19200/8n1. */
	51	#define SERIALCOMM "9600/8n1"
	52
	53	static const struct agdmm_profile supported_agdmm[] = {
	54	{ AGILENT_U1231A, "U1231A", agdmm_jobs_u123x, agdmm_recvs_u123x },
	55	{ AGILENT_U1232A, "U1232A", agdmm_jobs_u123x, agdmm_recvs_u123x },
	56	{ AGILENT_U1233A, "U1233A", agdmm_jobs_u123x, agdmm_recvs_u123x },
	57	{ AGILENT_U1251A, "U1251A", agdmm_jobs_u125x, agdmm_recvs_u125x },
	58	{ AGILENT_U1252A, "U1252A", agdmm_jobs_u125x, agdmm_recvs_u125x },
	59	{ AGILENT_U1253A, "U1253A", agdmm_jobs_u125x, agdmm_recvs_u125x },
	60	{ 0, NULL, NULL, NULL }
	61	};
	62
	63	SR_PRIV struct sr_dev_driver agdmm_driver_info;
	64	static struct sr_dev_driver *di = &agdmm_driver_info;
	65
	66	/* Properly close and free all devices. */
	67	static int clear_instances(void)
	68	{
	69	struct sr_dev_inst *sdi;
	70	struct drv_context *drvc;
	71	struct dev_context *devc;
	72	GSList *l;
	73
	74	if (!(drvc = di->priv))
	75	return SR_OK;
	76
	77	drvc = di->priv;
	78	for (l = drvc->instances; l; l = l->next) {
	79	if (!(sdi = l->data))
	80	continue;
	81	if (!(devc = sdi->priv))
	82	continue;
	83	sr_serial_dev_inst_free(devc->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 = src->value;
	120	break;
	121	case SR_CONF_SERIALCOMM:
	122	serialcomm = src->value;
	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->serial = serial;
	168	devc->cur_mq = -1;
	169	sdi->priv = devc;
	170	sdi->driver = di;
	171	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
	172	return NULL;
	173	sdi->probes = g_slist_append(sdi->probes, probe);
	174	drvc->instances = g_slist_append(drvc->instances, sdi);
	175	devices = g_slist_append(devices, sdi);
	176	break;
	177	}
	178	}
	179	g_strfreev(tokens);
	180	g_free(buf);
	181
	182	serial_close(serial);
	183	if (!devices)
	184	sr_serial_dev_inst_free(serial);
	185
	186	return devices;
	187	}
	188
	189	static GSList *hw_dev_list(void)
	190	{
	191	struct drv_context *drvc;
	192
	193	drvc = di->priv;
	194
	195	return drvc->instances;
	196	}
	197
	198	static int hw_dev_open(struct sr_dev_inst *sdi)
	199	{
	200	struct dev_context *devc;
	201
	202	if (!(devc = sdi->priv)) {
	203	sr_err("sdi->priv was NULL.");
	204	return SR_ERR_BUG;
	205	}
	206
	207	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	208	return SR_ERR;
	209
	210	sdi->status = SR_ST_ACTIVE;
	211
	212	return SR_OK;
	213	}
	214
	215	static int hw_dev_close(struct sr_dev_inst *sdi)
	216	{
	217	struct dev_context *devc;
	218
	219	if (!(devc = sdi->priv)) {
	220	sr_err("sdi->priv was NULL.");
	221	return SR_ERR_BUG;
	222	}
	223
	224	if (devc->serial && devc->serial->fd != -1) {
	225	serial_close(devc->serial);
	226	sdi->status = SR_ST_INACTIVE;
	227	}
	228
	229	return SR_OK;
	230	}
	231
	232	static int hw_cleanup(void)
	233	{
	234
	235	clear_instances();
	236
	237	return SR_OK;
	238	}
	239
	240	static int config_set(int id, const void value, const struct sr_dev_inst sdi)
	241	{
	242	struct dev_context *devc;
	243
	244	if (sdi->status != SR_ST_ACTIVE)
	245	return SR_ERR;
	246
	247	if (!(devc = sdi->priv)) {
	248	sr_err("sdi->priv was NULL.");
	249	return SR_ERR_BUG;
	250	}
	251
	252	switch (id) {
	253	case SR_CONF_LIMIT_MSEC:
	254	/* TODO: not yet implemented */
	255	if ((const uint64_t )value == 0) {
	256	sr_err("LIMIT_MSEC can't be 0.");
	257	return SR_ERR;
	258	}
	259	devc->limit_msec = (const uint64_t )value;
	260	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	261	devc->limit_msec);
	262	break;
	263	case SR_CONF_LIMIT_SAMPLES:
	264	devc->limit_samples = (const uint64_t )value;
	265	sr_dbg("Setting sample limit to %" PRIu64 ".",
	266	devc->limit_samples);
	267	break;
	268	default:
	269	sr_err("Unknown capability: %d.", id);
	270	return SR_ERR;
	271	break;
	272	}
	273
	274	return SR_OK;
	275	}
	276
	277	static int config_list(int key, const void *data, const struct sr_dev_inst sdi)
	278	{
	279
	280	(void)sdi;
	281
	282	switch (key) {
	283	case SR_CONF_SCAN_OPTIONS:
	284	*data = hwopts;
	285	break;
	286	case SR_CONF_DEVICE_OPTIONS:
	287	*data = hwcaps;
	288	break;
	289	default:
	290	return SR_ERR_ARG;
	291	}
	292
	293	return SR_OK;
	294	}
	295
	296	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	297	void *cb_data)
	298	{
	299	struct sr_datafeed_packet packet;
	300	struct sr_datafeed_header header;
	301	struct dev_context *devc;
	302
	303	if (!(devc = sdi->priv)) {
	304	sr_err("sdi->priv was NULL.");
	305	return SR_ERR_BUG;
	306	}
	307
	308	sr_dbg("Starting acquisition.");
	309
	310	devc->cb_data = cb_data;
	311
	312	/* Send header packet to the session bus. */
	313	sr_dbg("Sending SR_DF_HEADER.");
	314	packet.type = SR_DF_HEADER;
	315	packet.payload = (uint8_t *)&header;
	316	header.feed_version = 1;
	317	gettimeofday(&header.starttime, NULL);
	318	sr_session_send(devc->cb_data, &packet);
	319
	320	/* Poll every 100ms, or whenever some data comes in. */
	321	sr_source_add(devc->serial->fd, G_IO_IN, 100, agdmm_receive_data, (void *)sdi);
	322
	323	return SR_OK;
	324	}
	325
	326	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	327	{
	328	struct sr_datafeed_packet packet;
	329	struct dev_context *devc;
	330
	331	if (sdi->status != SR_ST_ACTIVE)
	332	return SR_ERR;
	333
	334	if (!(devc = sdi->priv)) {
	335	sr_err("sdi->priv was NULL.");
	336	return SR_ERR_BUG;
	337	}
	338
	339	sr_dbg("Stopping acquisition.");
	340
	341	sr_source_remove(devc->serial->fd);
	342	hw_dev_close((struct sr_dev_inst *)sdi);
	343
	344	/* Send end packet to the session bus. */
	345	sr_dbg("Sending SR_DF_END.");
	346	packet.type = SR_DF_END;
	347	sr_session_send(cb_data, &packet);
	348
	349
	350	return SR_OK;
	351	}
	352
	353	SR_PRIV struct sr_dev_driver agdmm_driver_info = {
	354	.name = "agilent-dmm",
	355	.longname = "Agilent U12xx series DMMs",
	356	.api_version = 1,
	357	.init = hw_init,
	358	.cleanup = hw_cleanup,
	359	.scan = hw_scan,
	360	.dev_list = hw_dev_list,
	361	.dev_clear = clear_instances,
	362	.config_set = config_set,
	363	.config_list = config_list,
	364	.dev_open = hw_dev_open,
	365	.dev_close = hw_dev_close,
	366	.dev_acquisition_start = hw_dev_acquisition_start,
	367	.dev_acquisition_stop = hw_dev_acquisition_stop,
	368	.priv = NULL,
	369	};