X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Ffluke-dmm%2Fapi.c;h=5a5323e5684388d2511282e452539d4b41ff5bbb;hb=91aea754aaed0f0f2a6fc4b2b875f0d0b7c01f8e;hp=b93b37fa7baccf3d963e1461ba51646503ed33be;hpb=4f958423d17c4c264ae02884888615df28c60f3d;p=libsigrok.git

diff --git a/hardware/fluke-dmm/api.c b/hardware/fluke-dmm/api.c
index b93b37fa..5a5323e5 100644
--- a/hardware/fluke-dmm/api.c
+++ b/hardware/fluke-dmm/api.c
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
  *
@@ -18,309 +18,304 @@
  */
 
 #include <glib.h>
-#include "libsigrok.h"
-#include "libsigrok-internal.h"
-#include "config.h"
-#include "fluke-dmm.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 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,
+};
 
-SR_PRIV struct sr_dev_driver driver_info;
-static struct sr_dev_driver *di = &driver_info;
+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" },
+	{ 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_context *sr_ctx)
+{
+	return std_init(sr_ctx, di, LOG_PREFIX);
+}
 
-/* Properly close and free all devices. */
-static int clear_instances(void)
+static GSList *fluke_scan(const char *conn, const char *serialcomm)
 {
 	struct sr_dev_inst *sdi;
 	struct drv_context *drvc;
 	struct dev_context *devc;
-	GSList *l;
+	struct sr_channel *probe;
+	struct sr_serial_dev_inst *serial;
+	GSList *devices;
+	int retry, len, i, s;
+	char buf[128], *b, **tokens;
 
-	if (!(drvc = di->priv))
-		return SR_OK;
+	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;
-	for (l = drvc->instances; l; l = l->next) {
-		if (!(sdi = l->data))
-			continue;
-		if (!(devc = sdi->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;
-		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(void)
-{
-	struct drv_context *drvc;
-
-	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
-		sr_err("fluke-dmm: driver context malloc failed.");
-		return SR_ERR;
-	}
-
-	di->priv = drvc;
-
-	return SR_OK;
-}
-
-static int serial_readline(int fd, char **buf, int *buflen, uint64_t timeout_ms)
-{
-	uint64_t start;
-	int maxlen, len;
+		}
 
-	timeout_ms *= 1000;
-	start = g_get_monotonic_time();
+		/* 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;
 
-	maxlen = *buflen;
-	*buflen = len = 0;
-	while(1) {
-		len = maxlen - *buflen - 1;
-		if (len < 1)
-			break;
-		len = serial_read(fd, *buf + *buflen, len);
-		if (len > 0) {
-			*buflen += len;
-			*(*buf + *buflen) = '\0';
-			if (*buflen > 0 && *(*buf + *buflen - 1) == '\r')
-				/* End of line */
+		/* 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];
+				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;
+			}
 		}
-		if (g_get_monotonic_time() - start > timeout_ms)
-			/* Timeout */
+		g_strfreev(tokens);
+		if (devices)
+			/* Found one. */
 			break;
-		g_usleep(2000);
 	}
+	serial_close(serial);
+	if (!devices)
+		sr_serial_dev_inst_free(serial);
 
-	/* Strip CRLF */
-	while (*buflen) {
-		if (*(*buf + *buflen - 1) == '\r' || *(*buf + *buflen - 1) == '\n')
-			*(*buf + --*buflen) = '\0';
-		else
-			break;
-	}
-	if (*buflen)
-		sr_dbg("fluke-dmm: received '%s'", *buf);
-
-	return SR_OK;
+	return devices;
 }
 
-static GSList *hw_scan(GSList *options)
+static GSList *scan(GSList *options)
 {
-	struct sr_dev_inst *sdi;
-	struct drv_context *drvc;
-	struct dev_context *devc;
-	struct sr_hwopt *opt;
-	struct sr_probe *probe;
+	struct sr_config *src;
 	GSList *l, *devices;
-	int len, fd, i;
+	int 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) {
-		opt = l->data;
-		switch (opt->hwopt) {
-		case SR_HWOPT_CONN:
-			conn = opt->value;
+		src = l->data;
+		switch (src->key) {
+		case SR_CONF_CONN:
+			conn = g_variant_get_string(src->data, NULL);
 			break;
-		case SR_HWOPT_SERIALCOMM:
-			serialcomm = opt->value;
+		case SR_CONF_SERIALCOMM:
+			serialcomm = g_variant_get_string(src->data, NULL);
 			break;
 		}
 	}
-	if (!conn) {
-		sr_dbg("fluke-dmm: no serial port provided");
-		return NULL;
-	}
-	if (!serialcomm) {
-		sr_dbg("fluke-dmm: no serial communication parameters provided");
+	if (!conn)
 		return NULL;
-	}
-
-	if ((fd = serial_open(conn, O_RDWR|O_NONBLOCK)) == -1) {
-		sr_err("fluke-dmm: unable to open %s: %s", conn, strerror(errno));
-		return NULL;
-	}
-
-	if (serial_set_paramstr(fd, serialcomm) != SR_OK) {
-		sr_err("fluke-dmm: unable to set serial parameters: %s",
-				strerror(errno));
-		return NULL;
-	}
 
-	serial_flush(fd);
-	if (serial_write(fd, "ID\r", 3) == -1) {
-		sr_err("fluke-dmm: unable to send identification string: %s",
-				strerror(errno));
-		return NULL;
-	}
-
-	len = 128;
-	buf = g_try_malloc(len);
-	serial_readline(fd, &buf, &len, 150);
-	if (!len)
-		return NULL;
-
-	if (len < 2 || buf[0] != '0' || buf[1] != '\r') {
-		sr_err("fluke-dmm: invalid response to identification string");
-		return NULL;
-	}
-
-	tokens = g_strsplit(buf + 2, ",", 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]))
-				continue;
-			if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "Fluke",
-					tokens[0] + 6, tokens[1])))
-				return NULL;
-			if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
-				sr_dbg("fluke-dmm: failed to malloc devc");
-				return NULL;
-			}
-			devc->profile = &supported_flukedmm[i];
-			devc->serial = sr_serial_dev_inst_new(conn, -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;
+	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);
 		}
 	}
-	g_strfreev(tokens);
-	g_free(buf);
-
-	serial_close(fd);
 
 	return devices;
 }
 
-static GSList *hw_dev_list(void)
+static GSList *dev_list(void)
 {
-	struct drv_context *drvc;
-
-	drvc = di->priv;
-
-	return drvc->instances;
+	return ((struct drv_context *)(di->priv))->instances;
 }
 
-static int hw_dev_open(struct sr_dev_inst *sdi)
+static int cleanup(void)
 {
-
-	/* TODO */
-
-	return SR_OK;
+	return std_dev_clear(di, NULL);
 }
 
-static int hw_dev_close(struct sr_dev_inst *sdi)
+static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
+		const struct sr_channel_group *cg)
 {
+	struct dev_context *devc;
 
-	/* TODO */
-
-	return SR_OK;
-}
+	(void)cg;
 
-static int hw_cleanup(void)
-{
+	if (sdi->status != SR_ST_ACTIVE)
+		return SR_ERR_DEV_CLOSED;
 
-	clear_instances();
+	if (!(devc = sdi->priv)) {
+		sr_err("sdi->priv was NULL.");
+		return SR_ERR_BUG;
+	}
 
-	/* TODO */
+	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 hw_info_get(int info_id, const void **data,
-       const struct sr_dev_inst *sdi)
+static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
+		const struct sr_channel_group *cg)
 {
-
-
-	switch (info_id) {
-	/* TODO */
+	(void)sdi;
+	(void)cg;
+
+	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_ARG;
+		return SR_ERR_NA;
 	}
 
 	return SR_OK;
 }
 
-static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
-		const void *value)
+static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 {
-	int ret;
+	struct dev_context *devc;
+	struct sr_serial_dev_inst *serial;
 
 	if (sdi->status != SR_ST_ACTIVE)
-		return SR_ERR;
+		return SR_ERR_DEV_CLOSED;
 
-	ret = SR_OK;
-	switch (hwcap) {
-	/* TODO */
-	default:
-		ret = SR_ERR_ARG;
+	if (!(devc = sdi->priv)) {
+		sr_err("sdi->priv was NULL.");
+		return SR_ERR_BUG;
 	}
 
-	return ret;
-}
+	devc->cb_data = cb_data;
 
-static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
-		void *cb_data)
-{
+	/* Send header packet to the session bus. */
+	std_session_send_df_header(cb_data, LOG_PREFIX);
 
-	/* TODO */
+	/* Poll every 100ms, or whenever some data comes in. */
+	serial = sdi->conn;
+	serial_source_add(serial, G_IO_IN, 50, fluke_receive_data, (void *)sdi);
+
+	if (serial_write(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(const struct sr_dev_inst *sdi,
-		void *cb_data)
+static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 {
-
-	(void)cb_data;
-
-	if (sdi->status != SR_ST_ACTIVE)
-		return SR_ERR;
-
-	/* TODO */
-
-	return SR_OK;
+	return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
+			sdi->conn, LOG_PREFIX);
 }
 
-SR_PRIV struct sr_dev_driver driver_info = {
+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,
-	.dev_open = hw_dev_open,
-	.dev_close = hw_dev_close,
-	.info_get = hw_info_get,
-	.dev_config_set = hw_dev_config_set,
-	.dev_acquisition_start = hw_dev_acquisition_start,
-	.dev_acquisition_stop = hw_dev_acquisition_stop,
+	.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,
 	.priv = NULL,
 };