[libsigrok.git] / src / hardware / fluke-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 <config.h>
#include <glib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "fluke-dmm.h"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

static const uint32_t devopts[] = {
	SR_CONF_MULTIMETER,
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_SET,
};

static const 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_189, "189", 100, 1000 },
	{ FLUKE_287, "287", 100, 1000 },
	{ FLUKE_190, "199B", 1000, 3500 },
	{ FLUKE_289, "289", 100, 1000 },
};

static GSList *fluke_scan(struct sr_dev_driver *di, const char *conn,
		const char *serialcomm)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;
	GSList *devices;
	int retry, len, i, s;
	char buf[128], *b, **tokens;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

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

	drvc = di->context;
	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_blocking(serial, "ID\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
			sr_err("Unable to send ID string");
			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++);
				sdi = g_malloc0(sizeof(struct sr_dev_inst));
				sdi->status = SR_ST_INACTIVE;
				sdi->vendor = g_strdup("Fluke");
				sdi->model = g_strdup(tokens[0] + 6);
				sdi->version = g_strdup(tokens[1] + s);
				devc = g_malloc0(sizeof(struct dev_context));
				devc->profile = &supported_flukedmm[i];
				sdi->inst_type = SR_INST_SERIAL;
				sdi->conn = serial;
				sdi->priv = devc;
				sdi->driver = di;
				sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
				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 *scan(struct sr_dev_driver *di, 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 = 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;

	devices = NULL;
	if (serialcomm) {
		/* Use the provided comm specs. */
		devices = fluke_scan(di, conn, serialcomm);
	} else {
		for (i = 0; scan_conn[i]; i++) {
			if ((devices = fluke_scan(di, conn, scan_conn[i])))
				break;
			/* The Scopemeter 199B, at least, requires this
			 * after all the 115k/9.6k confusion. */
			g_usleep(5 * 1000);
		}
	}

	return devices;
}

static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	(void)cg;

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

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_LIMIT_MSEC:
		/* TODO: not yet implemented */
		devc->limit_msec = g_variant_get_uint64(data);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

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

	devc = sdi->priv;

	std_session_send_df_header(sdi, LOG_PREFIX);

	/* Poll every 100ms, or whenever some data comes in. */
	serial = sdi->conn;
	serial_source_add(sdi->session, serial, G_IO_IN, 50,
			fluke_receive_data, (void *)sdi);

	if (serial_write_blocking(serial, "QM\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
		sr_err("Unable to send QM.");
		return SR_ERR;
	}
	devc->cmd_sent_at = g_get_monotonic_time() / 1000;
	devc->expect_response = TRUE;

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
			sdi->conn, LOG_PREFIX);
}

static struct sr_dev_driver flukedmm_driver_info = {
	.name = "fluke-dmm",
	.longname = "Fluke 18x/28x series DMMs",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = NULL,
	.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,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(flukedmm_driver_info);
Commit	Line	Data
883a2e9e	1	/*
50985c20	2	* This file is part of the libsigrok project.
883a2e9e BV	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
6ec6c43b	20	#include <config.h>
883a2e9e	21	#include <glib.h>
4f958423 BV	22	#include <sys/types.h>
	23	#include <sys/stat.h>
	24	#include <fcntl.h>
	25	#include <string.h>
c1aae900	26	#include <libsigrok/libsigrok.h>
6f22a8ef UH	27	#include "libsigrok-internal.h"
6f22a8ef UH	28	#include "fluke-dmm.h"
883a2e9e	29
a0e0bb41	30	static const uint32_t scanopts[] = {
1953564a BV	31	SR_CONF_CONN,
1953564a BV	32	SR_CONF_SERIALCOMM,
d3f8f141 BV	33	};
d3f8f141 BV	34
f254bc4b	35	static const uint32_t devopts[] = {
1953564a	36	SR_CONF_MULTIMETER,
1953564a	37	SR_CONF_CONTINUOUS,
5827f61b BV	38	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
5827f61b BV	39	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
d3f8f141 BV	40	};
d3f8f141 BV	41
329733d9	42	static const char *scan_conn[] = {
9fa09680 BV	43	/* 287/289 */
	44	"115200/8n1",
	45	/* 187/189 */
	46	"9600/8n1",
	47	/* Scopemeter 190 series */
	48	"1200/8n1",
	49	NULL
	50	};
	51
4f958423	52	static const struct flukedmm_profile supported_flukedmm[] = {
d4b11de0	53	{ FLUKE_187, "187", 100, 1000 },
0bc3ab92	54	{ FLUKE_189, "189", 100, 1000 },
d4b11de0 BV	55	{ FLUKE_287, "287", 100, 1000 },
d4b11de0 BV	56	{ FLUKE_190, "199B", 1000, 3500 },
ba4dfbde	57	{ FLUKE_289, "289", 100, 1000 },
4f958423 BV	58	};
4f958423 BV	59
4f840ce9 ML	60	static GSList fluke_scan(struct sr_dev_driver di, const char *conn,
4f840ce9 ML	61	const char *serialcomm)
883a2e9e	62	{
4f958423	63	struct sr_dev_inst *sdi;
883a2e9e	64	struct drv_context *drvc;
4f958423	65	struct dev_context *devc;
58d03f03	66	struct sr_serial_dev_inst *serial;
41298320	67	GSList *devices;
58d03f03	68	int retry, len, i, s;
fb480d57	69	char buf[128], b, *tokens;
883a2e9e	70
91219afc	71	serial = sr_serial_dev_inst_new(conn, serialcomm);
58d03f03	72
50276118	73	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
4f958423	74	return NULL;
4f958423	75
41812aca	76	drvc = di->context;
fb480d57 BV	77	b = buf;
fb480d57 BV	78	retry = 0;
41298320	79	devices = NULL;
fb480d57 BV	80	/* We'll try the discovery sequence three times in case the device
	81	* is not in an idle state when we send ID. */
	82	while (!devices && retry < 3) {
	83	retry++;
58d03f03	84	serial_flush(serial);
20401400	85	if (serial_write_blocking(serial, "ID\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
50276118	86	sr_err("Unable to send ID string");
fb480d57 BV	87	continue;
fb480d57 BV	88	}
4f958423	89
fb480d57 BV	90	/* Response is first a CMD_ACK byte (ASCII '0' for OK,
	91	* or '1' to signify an error. */
	92	len = 128;
58d03f03	93	serial_readline(serial, &b, &len, 150);
fb480d57 BV	94	if (len != 1)
fb480d57 BV	95	continue;
41298320	96	if (buf[0] != '0')
fb480d57	97	continue;
4f958423	98
fb480d57 BV	99	/* If CMD_ACK was OK, ID string follows. */
fb480d57 BV	100	len = 128;
9fa09680	101	serial_readline(serial, &b, &len, 850);
fb480d57 BV	102	if (len < 10)
fb480d57 BV	103	continue;
9fa09680 BV	104	if (strcspn(buf, ",") < 15)
	105	/* Looks like it's comma-separated. */
	106	tokens = g_strsplit(buf, ",", 3);
	107	else
	108	/* Fluke 199B, at least, uses semicolon. */
	109	tokens = g_strsplit(buf, ";", 3);
fb480d57 BV	110	if (!strncmp("FLUKE", tokens[0], 5)
	111	&& tokens[1] && tokens[2]) {
	112	for (i = 0; supported_flukedmm[i].model; i++) {
	113	if (strcmp(supported_flukedmm[i].modelname, tokens[0] + 6))
	114	continue;
	115	/* Skip leading spaces in version number. */
	116	for (s = 0; tokens[1][s] == ' '; s++);
aac29cc1	117	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	118	sdi->status = SR_ST_INACTIVE;
	119	sdi->vendor = g_strdup("Fluke");
	120	sdi->model = g_strdup(tokens[0] + 6);
	121	sdi->version = g_strdup(tokens[1] + s);
f57d8ffe	122	devc = g_malloc0(sizeof(struct dev_context));
fb480d57	123	devc->profile = &supported_flukedmm[i];
771bd216	124	sdi->inst_type = SR_INST_SERIAL;
919681f0	125	sdi->conn = serial;
fb480d57 BV	126	sdi->priv = devc;
fb480d57 BV	127	sdi->driver = di;
5e23fcab	128	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
fb480d57 BV	129	drvc->instances = g_slist_append(drvc->instances, sdi);
	130	devices = g_slist_append(devices, sdi);
	131	break;
4f958423	132	}
4f958423	133	}
fb480d57	134	g_strfreev(tokens);
9fa09680 BV	135	if (devices)
	136	/* Found one. */
	137	break;
4f958423	138	}
58d03f03 BV	139	serial_close(serial);
	140	if (!devices)
	141	sr_serial_dev_inst_free(serial);
883a2e9e BV	142
	143	return devices;
	144	}
	145
4f840ce9	146	static GSList scan(struct sr_dev_driver di, GSList *options)
41298320	147	{
1987b8d6	148	struct sr_config *src;
41298320	149	GSList l, devices;
9fa09680	150	int i;
41298320 BV	151	const char conn, serialcomm;
	152
	153	conn = serialcomm = NULL;
	154	for (l = options; l; l = l->next) {
1987b8d6 BV	155	src = l->data;
1987b8d6 BV	156	switch (src->key) {
1953564a	157	case SR_CONF_CONN:
70424328	158	conn = g_variant_get_string(src->data, NULL);
41298320	159	break;
1953564a	160	case SR_CONF_SERIALCOMM:
70424328	161	serialcomm = g_variant_get_string(src->data, NULL);
41298320 BV	162	break;
	163	}
	164	}
	165	if (!conn)
	166	return NULL;
	167
f4d0020e	168	devices = NULL;
41298320 BV	169	if (serialcomm) {
41298320 BV	170	/* Use the provided comm specs. */
4f840ce9	171	devices = fluke_scan(di, conn, serialcomm);
41298320	172	} else {
9fa09680	173	for (i = 0; scan_conn[i]; i++) {
4f840ce9	174	if ((devices = fluke_scan(di, conn, scan_conn[i])))
9fa09680 BV	175	break;
	176	/* The Scopemeter 199B, at least, requires this
	177	* after all the 115k/9.6k confusion. */
1a46cc62	178	g_usleep(5 * 1000);
9fa09680	179	}
41298320 BV	180	}
	181
	182	return devices;
	183	}
	184
584560f1	185	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	186	const struct sr_channel_group *cg)
883a2e9e	187	{
d3f8f141	188	struct dev_context *devc;
883a2e9e	189
53b4680f	190	(void)cg;
8f996b89	191
883a2e9e	192	if (sdi->status != SR_ST_ACTIVE)
e73ffd42	193	return SR_ERR_DEV_CLOSED;
883a2e9e	194
b0baddef	195	devc = sdi->priv;
d3f8f141	196
584560f1	197	switch (key) {
1953564a	198	case SR_CONF_LIMIT_MSEC:
d3f8f141	199	/* TODO: not yet implemented */
70424328	200	devc->limit_msec = g_variant_get_uint64(data);
d3f8f141	201	break;
1953564a	202	case SR_CONF_LIMIT_SAMPLES:
70424328	203	devc->limit_samples = g_variant_get_uint64(data);
d3f8f141	204	break;
883a2e9e	205	default:
bd6fbf62	206	return SR_ERR_NA;
883a2e9e BV	207	}
883a2e9e BV	208
d3f8f141	209	return SR_OK;
883a2e9e BV	210	}
883a2e9e BV	211
584560f1	212	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	213	const struct sr_channel_group *cg)
a1c743fc	214	{
a1c743fc	215	(void)sdi;
53b4680f	216	(void)cg;
a1c743fc BV	217
a1c743fc BV	218	switch (key) {
0d485e30	219	case SR_CONF_SCAN_OPTIONS:
584560f1	220	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	221	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
0d485e30	222	break;
9a6517d1	223	case SR_CONF_DEVICE_OPTIONS:
584560f1	224	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	225	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
9a6517d1	226	break;
a1c743fc	227	default:
bd6fbf62	228	return SR_ERR_NA;
a1c743fc BV	229	}
	230
	231	return SR_OK;
	232	}
	233
695dc859	234	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
883a2e9e	235	{
d3f8f141	236	struct dev_context *devc;
919681f0	237	struct sr_serial_dev_inst *serial;
d3f8f141	238
e73ffd42 BV	239	if (sdi->status != SR_ST_ACTIVE)
	240	return SR_ERR_DEV_CLOSED;
	241
208c1d35	242	devc = sdi->priv;
d3f8f141	243
695dc859	244	std_session_send_df_header(sdi, LOG_PREFIX);
883a2e9e	245
d3f8f141	246	/* Poll every 100ms, or whenever some data comes in. */
919681f0	247	serial = sdi->conn;
102f1239 BV	248	serial_source_add(sdi->session, serial, G_IO_IN, 50,
102f1239 BV	249	fluke_receive_data, (void *)sdi);
d38d2ef0	250
20401400	251	if (serial_write_blocking(serial, "QM\r", 3, SERIAL_WRITE_TIMEOUT_MS) < 0) {
50276118	252	sr_err("Unable to send QM.");
d38d2ef0 BV	253	return SR_ERR;
	254	}
	255	devc->cmd_sent_at = g_get_monotonic_time() / 1000;
	256	devc->expect_response = TRUE;
883a2e9e BV	257
	258	return SR_OK;
	259	}
	260
695dc859	261	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
883a2e9e	262	{
6525d819	263	return std_serial_dev_acquisition_stop(sdi, std_serial_dev_close,
f6beaac5	264	sdi->conn, LOG_PREFIX);
883a2e9e BV	265	}
883a2e9e BV	266
dd5c48a6	267	static struct sr_dev_driver flukedmm_driver_info = {
883a2e9e BV	268	.name = "fluke-dmm",
	269	.longname = "Fluke 18x/28x series DMMs",
	270	.api_version = 1,
c2fdcc25	271	.init = std_init,
700d6b64	272	.cleanup = std_cleanup,
6078d2c9	273	.scan = scan,
c01bf34c	274	.dev_list = std_dev_list,
a6630742	275	.dev_clear = NULL,
6fab7b8f	276	.config_get = NULL,
035a1078	277	.config_set = config_set,
a1c743fc	278	.config_list = config_list,
854434de	279	.dev_open = std_serial_dev_open,
bf2c987f	280	.dev_close = std_serial_dev_close,
6078d2c9 UH	281	.dev_acquisition_start = dev_acquisition_start,
6078d2c9 UH	282	.dev_acquisition_stop = dev_acquisition_stop,
41812aca	283	.context = NULL,
883a2e9e	284	};
dd5c48a6	285	SR_REGISTER_DEV_DRIVER(flukedmm_driver_info);