[libsigrok.git] / hardware / fluke-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 "fluke-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,
};

SR_PRIV struct sr_dev_driver flukedmm_driver_info;
static struct sr_dev_driver *di = &flukedmm_driver_info;

static char *scan_conn[] = {
	/* 287/289 */
	"115200/8n1",
	/* 187/189 */
	"9600/8n1",
	/* Scopemeter 190 series */
	"1200/8n1",
	NULL
};

static const struct flukedmm_profile supported_flukedmm[] = {
	{ FLUKE_187, "187", 100, 1000 },
	{ FLUKE_287, "287", 100, 1000 },
	{ FLUKE_190, "199B", 1000, 3500 },
};


/* 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 *fluke_scan(const char *conn, const char *serialcomm)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_probe *probe;
	struct sr_serial_dev_inst *serial;
	GSList *devices;
	int retry, len, i, s;
	char buf[128], *b, **tokens;

	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
		return NULL;

	if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
		return NULL;

	drvc = di->priv;
	b = buf;
	retry = 0;
	devices = NULL;
	/* We'll try the discovery sequence three times in case the device
	 * is not in an idle state when we send ID. */
	while (!devices && retry < 3) {
		retry++;
		serial_flush(serial);
		if (serial_write(serial, "ID\r", 3) == -1) {
			sr_err("Unable to send ID string: %s.",
			       strerror(errno));
			continue;
		}

		/* Response is first a CMD_ACK byte (ASCII '0' for OK,
		 * or '1' to signify an error. */
		len = 128;
		serial_readline(serial, &b, &len, 150);
		if (len != 1)
			continue;
		if (buf[0] != '0')
			continue;

		/* If CMD_ACK was OK, ID string follows. */
		len = 128;
		serial_readline(serial, &b, &len, 850);
		if (len < 10)
			continue;
		if (strcspn(buf, ",") < 15)
			/* Looks like it's comma-separated. */
			tokens = g_strsplit(buf, ",", 3);
		else
			/* Fluke 199B, at least, uses semicolon. */
			tokens = g_strsplit(buf, ";", 3);
		if (!strncmp("FLUKE", tokens[0], 5)
				&& tokens[1] && tokens[2]) {
			for (i = 0; supported_flukedmm[i].model; i++) {
				if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
					continue;
				/* Skip leading spaces in version number. */
				for (s = 0; tokens[1][s] == ' '; s++);
				if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Fluke",
						tokens[0] + 6, tokens[1] + s)))
					return NULL;
				if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
					sr_err("Device context malloc failed.");
					return NULL;
				}
				devc->profile = &supported_flukedmm[i];
				devc->serial = 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);
		if (devices)
			/* Found one. */
			break;
	}
	serial_close(serial);
	if (!devices)
		sr_serial_dev_inst_free(serial);

	return devices;
}

static GSList *hw_scan(GSList *options)
{
	struct sr_config *src;
	GSList *l, *devices;
	int i;
	const char *conn, *serialcomm;

	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) {
		/* Use the provided comm specs. */
		devices = fluke_scan(conn, serialcomm);
	} else {
		for (i = 0; scan_conn[i]; i++) {
			if ((devices = fluke_scan(conn, scan_conn[i])))
				break;
			/* The Scopemeter 199B, at least, requires this
			 * after all the 115k/9.6k confusion. */
			g_usleep(5000);
		}
	}

	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, 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 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, 50, fluke_receive_data, (void *)sdi);

	if (serial_write(devc->serial, "QM\r", 3) == -1) {
		sr_err("Unable to send QM: %s.", strerror(errno));
		return SR_ERR;
	}
	devc->cmd_sent_at = g_get_monotonic_time() / 1000;
	devc->expect_response = TRUE;

	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 flukedmm_driver_info = {
	.name = "fluke-dmm",
	.longname = "Fluke 18x/28x 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 "fluke-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	SR_PRIV struct sr_dev_driver flukedmm_driver_info;
	45	static struct sr_dev_driver *di = &flukedmm_driver_info;
	46
	47	static char *scan_conn[] = {
	48	/* 287/289 */
	49	"115200/8n1",
	50	/* 187/189 */
	51	"9600/8n1",
	52	/* Scopemeter 190 series */
	53	"1200/8n1",
	54	NULL
	55	};
	56
	57	static const struct flukedmm_profile supported_flukedmm[] = {
	58	{ FLUKE_187, "187", 100, 1000 },
	59	{ FLUKE_287, "287", 100, 1000 },
	60	{ FLUKE_190, "199B", 1000, 3500 },
	61	};
	62
	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 fluke_scan(const char conn, const char *serialcomm)
	96	{
	97	struct sr_dev_inst *sdi;
	98	struct drv_context *drvc;
	99	struct dev_context *devc;
	100	struct sr_probe *probe;
	101	struct sr_serial_dev_inst *serial;
	102	GSList *devices;
	103	int retry, len, i, s;
	104	char buf[128], b, *tokens;
	105
	106	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	107	return NULL;
	108
	109	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	110	return NULL;
	111
	112	drvc = di->priv;
	113	b = buf;
	114	retry = 0;
	115	devices = NULL;
	116	/* We'll try the discovery sequence three times in case the device
	117	* is not in an idle state when we send ID. */
	118	while (!devices && retry < 3) {
	119	retry++;
	120	serial_flush(serial);
	121	if (serial_write(serial, "ID\r", 3) == -1) {
	122	sr_err("Unable to send ID string: %s.",
	123	strerror(errno));
	124	continue;
	125	}
	126
	127	/* Response is first a CMD_ACK byte (ASCII '0' for OK,
	128	* or '1' to signify an error. */
	129	len = 128;
	130	serial_readline(serial, &b, &len, 150);
	131	if (len != 1)
	132	continue;
	133	if (buf[0] != '0')
	134	continue;
	135
	136	/* If CMD_ACK was OK, ID string follows. */
	137	len = 128;
	138	serial_readline(serial, &b, &len, 850);
	139	if (len < 10)
	140	continue;
	141	if (strcspn(buf, ",") < 15)
	142	/* Looks like it's comma-separated. */
	143	tokens = g_strsplit(buf, ",", 3);
	144	else
	145	/* Fluke 199B, at least, uses semicolon. */
	146	tokens = g_strsplit(buf, ";", 3);
	147	if (!strncmp("FLUKE", tokens[0], 5)
	148	&& tokens[1] && tokens[2]) {
	149	for (i = 0; supported_flukedmm[i].model; i++) {
	150	if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
	151	continue;
	152	/* Skip leading spaces in version number. */
	153	for (s = 0; tokens[1][s] == ' '; s++);
	154	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Fluke",
	155	tokens[0] + 6, tokens[1] + s)))
	156	return NULL;
	157	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	158	sr_err("Device context malloc failed.");
	159	return NULL;
	160	}
	161	devc->profile = &supported_flukedmm[i];
	162	devc->serial = serial;
	163	sdi->priv = devc;
	164	sdi->driver = di;
	165	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
	166	return NULL;
	167	sdi->probes = g_slist_append(sdi->probes, probe);
	168	drvc->instances = g_slist_append(drvc->instances, sdi);
	169	devices = g_slist_append(devices, sdi);
	170	break;
	171	}
	172	}
	173	g_strfreev(tokens);
	174	if (devices)
	175	/* Found one. */
	176	break;
	177	}
	178	serial_close(serial);
	179	if (!devices)
	180	sr_serial_dev_inst_free(serial);
	181
	182	return devices;
	183	}
	184
	185	static GSList hw_scan(GSList options)
	186	{
	187	struct sr_config *src;
	188	GSList l, devices;
	189	int i;
	190	const char conn, serialcomm;
	191
	192	conn = serialcomm = NULL;
	193	for (l = options; l; l = l->next) {
	194	src = l->data;
	195	switch (src->key) {
	196	case SR_CONF_CONN:
	197	conn = src->value;
	198	break;
	199	case SR_CONF_SERIALCOMM:
	200	serialcomm = src->value;
	201	break;
	202	}
	203	}
	204	if (!conn)
	205	return NULL;
	206
	207	if (serialcomm) {
	208	/* Use the provided comm specs. */
	209	devices = fluke_scan(conn, serialcomm);
	210	} else {
	211	for (i = 0; scan_conn[i]; i++) {
	212	if ((devices = fluke_scan(conn, scan_conn[i])))
	213	break;
	214	/* The Scopemeter 199B, at least, requires this
	215	* after all the 115k/9.6k confusion. */
	216	g_usleep(5000);
	217	}
	218	}
	219
	220	return devices;
	221	}
	222
	223	static GSList *hw_dev_list(void)
	224	{
	225	return ((struct drv_context *)(di->priv))->instances;
	226	}
	227
	228	static int hw_dev_open(struct sr_dev_inst *sdi)
	229	{
	230	struct dev_context *devc;
	231
	232	if (!(devc = sdi->priv)) {
	233	sr_err("sdi->priv was NULL.");
	234	return SR_ERR_BUG;
	235	}
	236
	237	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	238	return SR_ERR;
	239
	240	sdi->status = SR_ST_ACTIVE;
	241
	242	return SR_OK;
	243	}
	244
	245	static int hw_dev_close(struct sr_dev_inst *sdi)
	246	{
	247	struct dev_context *devc;
	248
	249	devc = sdi->priv;
	250
	251	if (devc->serial && devc->serial->fd != -1) {
	252	serial_close(devc->serial);
	253	sdi->status = SR_ST_INACTIVE;
	254	}
	255
	256	return SR_OK;
	257	}
	258
	259	static int hw_cleanup(void)
	260	{
	261
	262	clear_instances();
	263
	264	return SR_OK;
	265	}
	266
	267	static int config_set(int id, const void value, const struct sr_dev_inst sdi)
	268	{
	269	struct dev_context *devc;
	270
	271	if (sdi->status != SR_ST_ACTIVE)
	272	return SR_ERR;
	273
	274	if (!(devc = sdi->priv)) {
	275	sr_err("sdi->priv was NULL.");
	276	return SR_ERR_BUG;
	277	}
	278
	279	switch (id) {
	280	case SR_CONF_LIMIT_MSEC:
	281	/* TODO: not yet implemented */
	282	if ((const uint64_t )value == 0) {
	283	sr_err("LIMIT_MSEC can't be 0.");
	284	return SR_ERR;
	285	}
	286	devc->limit_msec = (const uint64_t )value;
	287	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	288	devc->limit_msec);
	289	break;
	290	case SR_CONF_LIMIT_SAMPLES:
	291	devc->limit_samples = (const uint64_t )value;
	292	sr_dbg("Setting sample limit to %" PRIu64 ".",
	293	devc->limit_samples);
	294	break;
	295	default:
	296	sr_err("Unknown capability: %d.", id);
	297	return SR_ERR;
	298	break;
	299	}
	300
	301	return SR_OK;
	302	}
	303
	304	static int config_list(int key, const void *data, const struct sr_dev_inst sdi)
	305	{
	306
	307	(void)sdi;
	308
	309	switch (key) {
	310	case SR_CONF_SCAN_OPTIONS:
	311	*data = hwopts;
	312	break;
	313	case SR_CONF_DEVICE_OPTIONS:
	314	*data = hwcaps;
	315	break;
	316	default:
	317	return SR_ERR_ARG;
	318	}
	319
	320	return SR_OK;
	321	}
	322
	323	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	324	void *cb_data)
	325	{
	326	struct dev_context *devc;
	327
	328	if (!(devc = sdi->priv)) {
	329	sr_err("sdi->priv was NULL.");
	330	return SR_ERR_BUG;
	331	}
	332
	333	devc->cb_data = cb_data;
	334
	335	/* Send header packet to the session bus. */
	336	std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
	337
	338	/* Poll every 100ms, or whenever some data comes in. */
	339	sr_source_add(devc->serial->fd, G_IO_IN, 50, fluke_receive_data, (void *)sdi);
	340
	341	if (serial_write(devc->serial, "QM\r", 3) == -1) {
	342	sr_err("Unable to send QM: %s.", strerror(errno));
	343	return SR_ERR;
	344	}
	345	devc->cmd_sent_at = g_get_monotonic_time() / 1000;
	346	devc->expect_response = TRUE;
	347
	348	return SR_OK;
	349	}
	350
	351	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	352	{
	353	struct sr_datafeed_packet packet;
	354	struct dev_context *devc;
	355
	356	if (sdi->status != SR_ST_ACTIVE)
	357	return SR_ERR;
	358
	359	if (!(devc = sdi->priv)) {
	360	sr_err("sdi->priv was NULL.");
	361	return SR_ERR_BUG;
	362	}
	363
	364	sr_dbg("Stopping acquisition.");
	365
	366	sr_source_remove(devc->serial->fd);
	367	hw_dev_close((struct sr_dev_inst *)sdi);
	368
	369	/* Send end packet to the session bus. */
	370	sr_dbg("Sending SR_DF_END.");
	371	packet.type = SR_DF_END;
	372	sr_session_send(cb_data, &packet);
	373
	374	return SR_OK;
	375	}
	376
	377	SR_PRIV struct sr_dev_driver flukedmm_driver_info = {
	378	.name = "fluke-dmm",
	379	.longname = "Fluke 18x/28x series DMMs",
	380	.api_version = 1,
	381	.init = hw_init,
	382	.cleanup = hw_cleanup,
	383	.scan = hw_scan,
	384	.dev_list = hw_dev_list,
	385	.dev_clear = clear_instances,
	386	.config_get = NULL,
	387	.config_set = config_set,
	388	.config_list = config_list,
	389	.dev_open = hw_dev_open,
	390	.dev_close = hw_dev_close,
	391	.dev_acquisition_start = hw_dev_acquisition_start,
	392	.dev_acquisition_stop = hw_dev_acquisition_stop,
	393	.priv = NULL,
	394	};