[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 <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,
};

SR_PRIV struct sr_dev_driver flukedmm_driver_info;

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

static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

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 GSList *dev_list(const struct sr_dev_driver *di)
{
	return ((struct drv_context *)(di->context))->instances;
}

static int cleanup(const struct sr_dev_driver *di)
{
	return std_dev_clear(di, NULL);
}

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;

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

	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, void *cb_data)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

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

	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, 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, void *cb_data)
{
	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
			sdi->conn, LOG_PREFIX);
}

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