[libsigrok.git] / src / hardware / gmc-mh-1x-2x / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013, 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
 *
 * 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/>.
 */

/** @file
 *  Gossen Metrawatt Metrahit 1x/2x drivers
 *  @internal
 */

#include <config.h>
#include <string.h>
#include "protocol.h"

/* Serial communication parameters for Metrahit 1x/2x with 'RS232' adaptor */
#define SERIALCOMM_1X_RS232 "8228/6n1/dtr=1/rts=1/flow=0" /* =8192, closer with divider */
#define SERIALCOMM_2X_RS232 "9600/6n1/dtr=1/rts=1/flow=0"
#define SERIALCOMM_2X "9600/8n1/dtr=1/rts=1/flow=0"
#define VENDOR_GMC "Gossen Metrawatt"

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

/** Hardware capabilities for Metrahit 1x/2x devices in send mode. */
static const uint32_t devopts_sm[] = {
	SR_CONF_MULTIMETER,
	SR_CONF_THERMOMETER,    /**< All GMC 1x/2x multimeters seem to support this */
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
};

/** Hardware capabilities for Metrahit 2x devices in bidirectional Mode. */
static const uint32_t devopts_bd[] = {
	SR_CONF_MULTIMETER,
	SR_CONF_THERMOMETER,    /**< All GMC 1x/2x multimeters seem to support this */
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_POWER_OFF | SR_CONF_GET | SR_CONF_SET,
};

/* TODO:
 * - For the 29S SR_CONF_ENERGYMETER, too.
 * - SR_CONF_PATTERN_MODE for some 2x devices
 * - SR_CONF_DATALOG for 22M, 26M, 29S and storage adaptors.
 * Need to implement device-specific lists.
 */

/**
 * Read single byte from serial port.
 *
 * @retval -1 Timeout or error.
 * @retval other Byte.
 */
static int read_byte(struct sr_serial_dev_inst *serial, gint64 timeout)
{
	uint8_t result = 0;
	int rc = 0;

	for (;;) {
		rc = serial_read_nonblocking(serial, &result, 1);
		if (rc == 1) {
			sr_spew("read: 0x%02x/%d", result, result);
			return result;
		}
		if (g_get_monotonic_time() > timeout)
			return -1;
		g_usleep(2000);
	}
}

/**
 * Try to detect GMC 1x/2x multimeter model in send mode for max. 1 second.
 *
 * @param serial Configured, open serial port.
 *
 * @retval NULL Detection failed.
 * @retval other Model code.
 */
static enum model scan_model_sm(struct sr_serial_dev_inst *serial)
{
	int byte, bytecnt, cnt;
	enum model model;
	gint64 timeout_us;

	model = METRAHIT_NONE;
	timeout_us = g_get_monotonic_time() + (1 * 1000 * 1000);

	/*
	 * Try to find message consisting of device code and several
	 * (at least 4) data bytes.
	 */
	for (bytecnt = 0; bytecnt < 100; bytecnt++) {
		byte = read_byte(serial, timeout_us);
		if ((byte == -1) || (timeout_us < g_get_monotonic_time()))
			break;
		if ((byte & MSGID_MASK) == MSGID_INF) {
			if (!(model = gmc_decode_model_sm(byte & MSGC_MASK)))
				break;
			/* Now expect (at least) 4 data bytes. */
			for (cnt = 0; cnt < 4; cnt++) {
				byte = read_byte(serial, timeout_us);
				if ((byte == -1) ||
						((byte & MSGID_MASK) != MSGID_DATA))
				{
					model = METRAHIT_NONE;
					bytecnt = 100;
					break;
				}
			}
			break;
		}
	}

	return model;
}

/**
 * Scan for Metrahit 1x and Metrahit 2x in send mode using Gossen Metrawatt
 * 'RS232' interface.
 *
 * The older 1x models use 8192 baud and the newer 2x 9600 baud.
 * The DMM usually sends up to about 20 messages per second. However, depending
 * on configuration and measurement mode the intervals can be much larger and
 * then the detection might not work.
 */
static GSList *scan_1x_2x_rs232(struct sr_dev_driver *di, GSList *options)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_config *src;
	struct sr_serial_dev_inst *serial;
	GSList *l, *devices;
	const char *conn, *serialcomm;
	enum model model;
	gboolean serialcomm_given;

	devices = NULL;
	drvc = di->context;
	conn = serialcomm = NULL;
	serialcomm_given = FALSE;

	sr_spew("scan_1x_2x_rs232() called!");

	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);
			serialcomm_given = TRUE;
			break;
		}
	}
	if (!conn)
		return NULL;
	if (!serialcomm)
		serialcomm = SERIALCOMM_2X_RS232;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

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

	serial_flush(serial);

	model = scan_model_sm(serial);

	/*
	 * If detection failed and no user-supplied parameters,
	 * try second baud rate.
	 */
	if ((model == METRAHIT_NONE) && !serialcomm_given) {
		serialcomm = SERIALCOMM_1X_RS232;
		g_free(serial->serialcomm);
		serial->serialcomm = g_strdup(serialcomm);
		if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
			serial_flush(serial);
			model = scan_model_sm(serial);
		}
	}

	if (model != METRAHIT_NONE) {
		sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(model));
		sdi = g_malloc0(sizeof(struct sr_dev_inst));
		sdi->status = SR_ST_INACTIVE;
		sdi->vendor = g_strdup(VENDOR_GMC);
		sdi->model = g_strdup(gmc_model_str(model));
		devc = g_malloc0(sizeof(struct dev_context));
		devc->model = model;
		devc->limit_samples = 0;
		devc->limit_msec = 0;
		devc->num_samples = 0;
		devc->elapsed_msec = g_timer_new();
		devc->settings_ok = FALSE;
		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);
	}

	return devices;
}

/**
 * Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt
 * 'BD 232' interface.
 */
static GSList *scan_2x_bd232(struct sr_dev_driver *di, GSList *options)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_config *src;
	struct sr_serial_dev_inst *serial;
	GSList *l, *devices;
	const char *conn, *serialcomm;
	int cnt, byte;
	gint64 timeout_us;

	sdi = NULL;
	devc = NULL;
	conn = serialcomm = NULL;
	devices = NULL;

	drvc = di->context;

	sr_spew("scan_2x_bd232() called!");

	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;
	if (!serialcomm)
		serialcomm = SERIALCOMM_2X;

	serial = sr_serial_dev_inst_new(conn, serialcomm);

	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
		goto exit_err;

	devc = g_malloc0(sizeof(struct dev_context));

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup(VENDOR_GMC);
	sdi->priv = devc;

	/* Send message 03 "Query multimeter version and status" */
	sdi->conn = serial;
	if (req_stat14(sdi, TRUE) != SR_OK)
		goto exit_err;

	/* Wait for reply from device(s) for up to 2s. */
	timeout_us = g_get_monotonic_time() + (2 * 1000 * 1000);

	while (timeout_us > g_get_monotonic_time()) {
		/* Receive reply (14 bytes) */
		devc->buflen = 0;
		for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) {
			byte = read_byte(serial, timeout_us);
			if (byte != -1)
				devc->buf[devc->buflen++] = (byte & MASK_6BITS);
		}

		if (devc->buflen != GMC_REPLY_SIZE)
			continue;

		devc->addr = devc->buf[0];
		process_msg14(sdi);
		devc->buflen = 0;

		if (devc->model != METRAHIT_NONE) {
			sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
			devc->elapsed_msec = g_timer_new();
			sdi->model = g_strdup(gmc_model_str(devc->model));
			sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
			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);
			devc = g_malloc0(sizeof(struct dev_context));
			sdi = g_malloc0(sizeof(struct sr_dev_inst));
			sdi->status = SR_ST_INACTIVE;
			sdi->vendor = g_strdup(VENDOR_GMC);
		}
	};

	/* Free last alloc if no device found */
	if (devc->model == METRAHIT_NONE) {
		g_free(devc);
		sr_dev_inst_free(sdi);
	}

	return devices;

exit_err:
	sr_info("scan_2x_bd232(): Error!");

	if (serial)
		sr_serial_dev_inst_free(serial);
	g_free(devc);
	if (sdi)
		sr_dev_inst_free(sdi);

	return NULL;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	std_serial_dev_close(sdi);

	sdi->status = SR_ST_INACTIVE;

	/* Free dynamically allocated resources. */
	if ((devc = sdi->priv) && devc->elapsed_msec) {
		g_timer_destroy(devc->elapsed_msec);
		devc->elapsed_msec = NULL;
		devc->model = METRAHIT_NONE;
	}

	return SR_OK;
}

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

	(void)cg;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;

	ret = SR_OK;
	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_LIMIT_MSEC:
		*data = g_variant_new_uint64(devc->limit_msec);
		break;
	case SR_CONF_POWER_OFF:
		*data = g_variant_new_boolean(FALSE);
		break;
	default:
		return SR_ERR_NA;
	}

	return ret;
}

/** Implementation of config_list, auxiliary function for common parts. */
static int config_list_common(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;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

/** Implementation of config_list for Metrahit 1x/2x send mode */
static int config_list_sm(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
			  const struct sr_channel_group *cg)
{
	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t));
		break;
	default:
		return config_list_common(key, data, sdi, cg);
	}

	return SR_OK;
}

/** Implementation of config_list for Metrahit 2x bidirectional mode */
static int config_list_bd(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
			  const struct sr_channel_group *cg)
{
	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t));
		break;
	default:
		return config_list_common(key, data, sdi, cg);
	}

	return SR_OK;
}

static int dev_acquisition_start_1x_2x_rs232(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;
	devc->settings_ok = FALSE;
	devc->buflen = 0;

	std_session_send_df_header(sdi, LOG_PREFIX);

	/* Start timer, if required. */
	if (devc->limit_msec)
		g_timer_start(devc->elapsed_msec);

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

	return SR_OK;
}

static int dev_acquisition_start_2x_bd232(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;
	devc->settings_ok = FALSE;
	devc->buflen = 0;

	std_session_send_df_header(sdi, LOG_PREFIX);

	/* Start timer, if required. */
	if (devc->limit_msec)
		g_timer_start(devc->elapsed_msec);

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

	/* Send start message */
	return req_meas14(sdi);
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	/* Stop timer, if required. */
	if (sdi && (devc = sdi->priv) && devc->limit_msec)
		g_timer_stop(devc->elapsed_msec);

	return std_serial_dev_acquisition_stop(sdi, dev_close,
			sdi->conn, LOG_PREFIX);
}

static struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
	.name = "gmc-mh-1x-2x-rs232",
	.longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan_1x_2x_rs232,
	.dev_list = std_dev_list,
	.dev_clear = NULL,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list_sm,
	.dev_open = std_serial_dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(gmc_mh_1x_2x_rs232_driver_info);

static struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
	.name = "gmc-mh-2x-bd232",
	.longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan_2x_bd232,
	.dev_list = std_dev_list,
	.dev_clear = NULL,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list_bd,
	.dev_open = std_serial_dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start_2x_bd232,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(gmc_mh_2x_bd232_driver_info);
Commit	Line	Data
7b4edcb6 MH	1	/*
	2	* This file is part of the libsigrok project.
	3	*
c90beca7	4	* Copyright (C) 2013, 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
7b4edcb6 MH	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
6392d599 MH	20	/** @file
6392d599 MH	21	* Gossen Metrawatt Metrahit 1x/2x drivers
c90beca7	22	* @internal
6392d599 MH	23	*/
6392d599 MH	24
6ec6c43b	25	#include <config.h>
f5792417	26	#include <string.h>
7b4edcb6 MH	27	#include "protocol.h"
7b4edcb6 MH	28
f5792417 MH	29	/* Serial communication parameters for Metrahit 1x/2x with 'RS232' adaptor */
	30	#define SERIALCOMM_1X_RS232 "8228/6n1/dtr=1/rts=1/flow=0" /* =8192, closer with divider */
	31	#define SERIALCOMM_2X_RS232 "9600/6n1/dtr=1/rts=1/flow=0"
6392d599	32	#define SERIALCOMM_2X "9600/8n1/dtr=1/rts=1/flow=0"
f5792417 MH	33	#define VENDOR_GMC "Gossen Metrawatt"
f5792417 MH	34
a0e0bb41	35	static const uint32_t scanopts[] = {
f5792417 MH	36	SR_CONF_CONN,
	37	SR_CONF_SERIALCOMM,
	38	};
	39
c90beca7	40	/** Hardware capabilities for Metrahit 1x/2x devices in send mode. */
f254bc4b	41	static const uint32_t devopts_sm[] = {
f5792417	42	SR_CONF_MULTIMETER,
6392d599	43	SR_CONF_THERMOMETER, /*< All GMC 1x/2x multimeters seem to support this /
f5792417	44	SR_CONF_CONTINUOUS,
5827f61b BV	45	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
5827f61b BV	46	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
f5792417 MH	47	};
f5792417 MH	48
c90beca7	49	/** Hardware capabilities for Metrahit 2x devices in bidirectional Mode. */
f254bc4b	50	static const uint32_t devopts_bd[] = {
c90beca7 MH	51	SR_CONF_MULTIMETER,
c90beca7 MH	52	SR_CONF_THERMOMETER, /*< All GMC 1x/2x multimeters seem to support this /
c90beca7	53	SR_CONF_CONTINUOUS,
5827f61b BV	54	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	55	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
	56	SR_CONF_POWER_OFF \| SR_CONF_GET \| SR_CONF_SET,
c90beca7 MH	57	};
c90beca7 MH	58
6392d599 MH	59	/* TODO:
	60	* - For the 29S SR_CONF_ENERGYMETER, too.
	61	* - SR_CONF_PATTERN_MODE for some 2x devices
	62	* - SR_CONF_DATALOG for 22M, 26M, 29S and storage adaptors.
	63	* Need to implement device-specific lists.
	64	*/
	65
fc348b77 UH	66	/**
	67	* Read single byte from serial port.
	68	*
	69	* @retval -1 Timeout or error.
	70	* @retval other Byte.
f5792417 MH	71	*/
f5792417 MH	72	static int read_byte(struct sr_serial_dev_inst *serial, gint64 timeout)
7b4edcb6	73	{
fc348b77	74	uint8_t result = 0;
f5792417 MH	75	int rc = 0;
	76
	77	for (;;) {
0714a010	78	rc = serial_read_nonblocking(serial, &result, 1);
f5792417 MH	79	if (rc == 1) {
	80	sr_spew("read: 0x%02x/%d", result, result);
	81	return result;
	82	}
	83	if (g_get_monotonic_time() > timeout)
	84	return -1;
	85	g_usleep(2000);
	86	}
	87	}
	88
fc348b77 UH	89	/**
fc348b77 UH	90	* Try to detect GMC 1x/2x multimeter model in send mode for max. 1 second.
f5792417	91	*
fc348b77 UH	92	* @param serial Configured, open serial port.
	93	*
	94	* @retval NULL Detection failed.
	95	* @retval other Model code.
f5792417 MH	96	*/
	97	static enum model scan_model_sm(struct sr_serial_dev_inst *serial)
	98	{
	99	int byte, bytecnt, cnt;
	100	enum model model;
	101	gint64 timeout_us;
	102
873e0c12	103	model = METRAHIT_NONE;
1a46cc62	104	timeout_us = g_get_monotonic_time() + (1 * 1000 * 1000);
f5792417	105
fc348b77 UH	106	/*
	107	* Try to find message consisting of device code and several
	108	* (at least 4) data bytes.
	109	*/
f5792417 MH	110	for (bytecnt = 0; bytecnt < 100; bytecnt++) {
	111	byte = read_byte(serial, timeout_us);
	112	if ((byte == -1) \|\| (timeout_us < g_get_monotonic_time()))
	113	break;
	114	if ((byte & MSGID_MASK) == MSGID_INF) {
873e0c12	115	if (!(model = gmc_decode_model_sm(byte & MSGC_MASK)))
f5792417	116	break;
fc348b77	117	/* Now expect (at least) 4 data bytes. */
f5792417 MH	118	for (cnt = 0; cnt < 4; cnt++) {
	119	byte = read_byte(serial, timeout_us);
	120	if ((byte == -1) \|\|
c90beca7	121	((byte & MSGID_MASK) != MSGID_DATA))
f5792417	122	{
873e0c12	123	model = METRAHIT_NONE;
f5792417 MH	124	bytecnt = 100;
	125	break;
	126	}
	127	}
	128	break;
	129	}
	130	}
7b4edcb6	131
f5792417 MH	132	return model;
	133	}
	134
fc348b77 UH	135	/**
	136	* Scan for Metrahit 1x and Metrahit 2x in send mode using Gossen Metrawatt
	137	* 'RS232' interface.
	138	*
	139	* The older 1x models use 8192 baud and the newer 2x 9600 baud.
	140	* The DMM usually sends up to about 20 messages per second. However, depending
	141	* on configuration and measurement mode the intervals can be much larger and
	142	* then the detection might not work.
f5792417	143	*/
4f840ce9	144	static GSList scan_1x_2x_rs232(struct sr_dev_driver di, GSList *options)
f5792417 MH	145	{
	146	struct sr_dev_inst *sdi;
	147	struct drv_context *drvc;
	148	struct dev_context *devc;
	149	struct sr_config *src;
f5792417 MH	150	struct sr_serial_dev_inst *serial;
	151	GSList l, devices;
	152	const char conn, serialcomm;
	153	enum model model;
	154	gboolean serialcomm_given;
7b4edcb6 MH	155
7b4edcb6 MH	156	devices = NULL;
41812aca	157	drvc = di->context;
f5792417	158	conn = serialcomm = NULL;
f5792417 MH	159	serialcomm_given = FALSE;
f5792417 MH	160
c90beca7	161	sr_spew("scan_1x_2x_rs232() called!");
f5792417 MH	162
	163	for (l = options; l; l = l->next) {
	164	src = l->data;
	165	switch (src->key) {
	166	case SR_CONF_CONN:
	167	conn = g_variant_get_string(src->data, NULL);
	168	break;
	169	case SR_CONF_SERIALCOMM:
	170	serialcomm = g_variant_get_string(src->data, NULL);
	171	serialcomm_given = TRUE;
	172	break;
	173	}
	174	}
	175	if (!conn)
	176	return NULL;
	177	if (!serialcomm)
	178	serialcomm = SERIALCOMM_2X_RS232;
	179
91219afc	180	serial = sr_serial_dev_inst_new(conn, serialcomm);
f5792417	181
e13e354f	182	if (serial_open(serial, SERIAL_RDWR) != SR_OK) {
f5792417 MH	183	sr_serial_dev_inst_free(serial);
	184	return NULL;
	185	}
7b4edcb6	186
f5792417 MH	187	serial_flush(serial);
	188
	189	model = scan_model_sm(serial);
	190
fc348b77 UH	191	/*
	192	* If detection failed and no user-supplied parameters,
	193	* try second baud rate.
	194	*/
873e0c12	195	if ((model == METRAHIT_NONE) && !serialcomm_given) {
f5792417 MH	196	serialcomm = SERIALCOMM_1X_RS232;
	197	g_free(serial->serialcomm);
	198	serial->serialcomm = g_strdup(serialcomm);
	199	if (serial_set_paramstr(serial, serialcomm) == SR_OK) {
	200	serial_flush(serial);
	201	model = scan_model_sm(serial);
	202	}
	203	}
	204
873e0c12 UH	205	if (model != METRAHIT_NONE) {
873e0c12 UH	206	sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(model));
aac29cc1	207	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	208	sdi->status = SR_ST_INACTIVE;
	209	sdi->vendor = g_strdup(VENDOR_GMC);
	210	sdi->model = g_strdup(gmc_model_str(model));
f57d8ffe	211	devc = g_malloc0(sizeof(struct dev_context));
f5792417 MH	212	devc->model = model;
	213	devc->limit_samples = 0;
	214	devc->limit_msec = 0;
	215	devc->num_samples = 0;
	216	devc->elapsed_msec = g_timer_new();
	217	devc->settings_ok = FALSE;
f5792417 MH	218	sdi->conn = serial;
f5792417 MH	219	sdi->priv = devc;
4f840ce9	220	sdi->driver = di;
5e23fcab	221	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
f5792417 MH	222	drvc->instances = g_slist_append(drvc->instances, sdi);
	223	devices = g_slist_append(devices, sdi);
	224	}
7b4edcb6 MH	225
	226	return devices;
	227	}
	228
1a863916 UH	229	/**
	230	* Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt
	231	* 'BD 232' interface.
c90beca7	232	*/
4f840ce9	233	static GSList scan_2x_bd232(struct sr_dev_driver di, GSList *options)
c90beca7 MH	234	{
	235	struct sr_dev_inst *sdi;
	236	struct drv_context *drvc;
	237	struct dev_context *devc;
	238	struct sr_config *src;
c90beca7 MH	239	struct sr_serial_dev_inst *serial;
	240	GSList l, devices;
	241	const char conn, serialcomm;
	242	int cnt, byte;
	243	gint64 timeout_us;
	244
	245	sdi = NULL;
	246	devc = NULL;
	247	conn = serialcomm = NULL;
	248	devices = NULL;
	249
41812aca	250	drvc = di->context;
c90beca7 MH	251
	252	sr_spew("scan_2x_bd232() called!");
	253
	254	for (l = options; l; l = l->next) {
	255	src = l->data;
	256	switch (src->key) {
	257	case SR_CONF_CONN:
	258	conn = g_variant_get_string(src->data, NULL);
	259	break;
	260	case SR_CONF_SERIALCOMM:
	261	serialcomm = g_variant_get_string(src->data, NULL);
	262	break;
	263	}
	264	}
	265	if (!conn)
	266	return NULL;
	267	if (!serialcomm)
	268	serialcomm = SERIALCOMM_2X;
	269
91219afc	270	serial = sr_serial_dev_inst_new(conn, serialcomm);
c90beca7	271
e13e354f	272	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
c90beca7 MH	273	goto exit_err;
c90beca7 MH	274
f57d8ffe	275	devc = g_malloc0(sizeof(struct dev_context));
c90beca7	276
aac29cc1	277	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	278	sdi->status = SR_ST_INACTIVE;
0af636be UH	279	sdi->vendor = g_strdup(VENDOR_GMC);
c90beca7 MH	280	sdi->priv = devc;
	281
	282	/* Send message 03 "Query multimeter version and status" */
	283	sdi->conn = serial;
c90beca7 MH	284	if (req_stat14(sdi, TRUE) != SR_OK)
	285	goto exit_err;
	286
	287	/* Wait for reply from device(s) for up to 2s. */
1a46cc62	288	timeout_us = g_get_monotonic_time() + (2 * 1000 * 1000);
c90beca7 MH	289
	290	while (timeout_us > g_get_monotonic_time()) {
	291	/* Receive reply (14 bytes) */
	292	devc->buflen = 0;
07ffa5b3	293	for (cnt = 0; cnt < GMC_REPLY_SIZE; cnt++) {
c90beca7 MH	294	byte = read_byte(serial, timeout_us);
	295	if (byte != -1)
	296	devc->buf[devc->buflen++] = (byte & MASK_6BITS);
	297	}
	298
07ffa5b3	299	if (devc->buflen != GMC_REPLY_SIZE)
c90beca7 MH	300	continue;
	301
	302	devc->addr = devc->buf[0];
	303	process_msg14(sdi);
	304	devc->buflen = 0;
	305
	306	if (devc->model != METRAHIT_NONE) {
	307	sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
c90beca7	308	devc->elapsed_msec = g_timer_new();
c90beca7 MH	309	sdi->model = g_strdup(gmc_model_str(devc->model));
	310	sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
	311	sdi->conn = serial;
	312	sdi->priv = devc;
4f840ce9	313	sdi->driver = di;
5e23fcab	314	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
c90beca7 MH	315	drvc->instances = g_slist_append(drvc->instances, sdi);
c90beca7 MH	316	devices = g_slist_append(devices, sdi);
f57d8ffe	317	devc = g_malloc0(sizeof(struct dev_context));
aac29cc1	318	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	319	sdi->status = SR_ST_INACTIVE;
0af636be UH	320	sdi->vendor = g_strdup(VENDOR_GMC);
c90beca7 MH	321	}
	322	};
	323
	324	/* Free last alloc if no device found */
	325	if (devc->model == METRAHIT_NONE) {
	326	g_free(devc);
	327	sr_dev_inst_free(sdi);
	328	}
	329
	330	return devices;
	331
	332	exit_err:
	333	sr_info("scan_2x_bd232(): Error!");
	334
	335	if (serial)
	336	sr_serial_dev_inst_free(serial);
b1f83103	337	g_free(devc);
c90beca7 MH	338	if (sdi)
	339	sr_dev_inst_free(sdi);
	340
	341	return NULL;
	342	}
	343
7b4edcb6 MH	344	static int dev_close(struct sr_dev_inst *sdi)
7b4edcb6 MH	345	{
f5792417	346	struct dev_context *devc;
7b4edcb6	347
bf2c987f	348	std_serial_dev_close(sdi);
7b4edcb6 MH	349
	350	sdi->status = SR_ST_INACTIVE;
	351
f5792417 MH	352	/* Free dynamically allocated resources. */
	353	if ((devc = sdi->priv) && devc->elapsed_msec) {
	354	g_timer_destroy(devc->elapsed_msec);
	355	devc->elapsed_msec = NULL;
873e0c12	356	devc->model = METRAHIT_NONE;
f5792417 MH	357	}
f5792417 MH	358
7b4edcb6 MH	359	return SR_OK;
	360	}
	361
584560f1 BV	362	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
584560f1 BV	363	const struct sr_channel_group *cg)
7b4edcb6 MH	364	{
7b4edcb6 MH	365	int ret;
fadd0707	366	struct dev_context *devc;
c90beca7	367
53b4680f	368	(void)cg;
c90beca7	369
709468ba	370	if (!sdi)
6392d599 MH	371	return SR_ERR_ARG;
6392d599 MH	372
709468ba UH	373	devc = sdi->priv;
709468ba UH	374
7b4edcb6 MH	375	ret = SR_OK;
7b4edcb6 MH	376	switch (key) {
6392d599 MH	377	case SR_CONF_LIMIT_SAMPLES:
	378	*data = g_variant_new_uint64(devc->limit_samples);
	379	break;
	380	case SR_CONF_LIMIT_MSEC:
	381	*data = g_variant_new_uint64(devc->limit_msec);
	382	break;
c90beca7 MH	383	case SR_CONF_POWER_OFF:
	384	*data = g_variant_new_boolean(FALSE);
	385	break;
7b4edcb6 MH	386	default:
	387	return SR_ERR_NA;
	388	}
	389
	390	return ret;
	391	}
	392
1a863916	393	/** Implementation of config_list, auxiliary function for common parts. */
584560f1 BV	394	static int config_list_common(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
584560f1 BV	395	const struct sr_channel_group *cg)
7b4edcb6	396	{
c90beca7	397	(void)sdi;
53b4680f	398	(void)cg;
7b4edcb6	399
7b4edcb6	400	switch (key) {
c90beca7	401	case SR_CONF_SCAN_OPTIONS:
584560f1	402	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
5827f61b	403	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
f5792417	404	break;
7b4edcb6	405	default:
f5792417	406	return SR_ERR_NA;
7b4edcb6 MH	407	}
7b4edcb6 MH	408
f5792417	409	return SR_OK;
7b4edcb6 MH	410	}
7b4edcb6 MH	411
c90beca7	412	/** Implementation of config_list for Metrahit 1x/2x send mode */
584560f1	413	static int config_list_sm(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	414	const struct sr_channel_group *cg)
7b4edcb6	415	{
7b4edcb6	416	switch (key) {
c90beca7	417	case SR_CONF_DEVICE_OPTIONS:
584560f1	418	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
5827f61b	419	devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t));
f5792417	420	break;
c90beca7	421	default:
53b4680f	422	return config_list_common(key, data, sdi, cg);
c90beca7 MH	423	}
	424
	425	return SR_OK;
	426	}
	427
	428	/** Implementation of config_list for Metrahit 2x bidirectional mode */
584560f1	429	static int config_list_bd(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	430	const struct sr_channel_group *cg)
c90beca7	431	{
c90beca7	432	switch (key) {
f5792417	433	case SR_CONF_DEVICE_OPTIONS:
584560f1	434	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
5827f61b	435	devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t));
f5792417	436	break;
7b4edcb6	437	default:
53b4680f	438	return config_list_common(key, data, sdi, cg);
7b4edcb6 MH	439	}
7b4edcb6 MH	440
f5792417	441	return SR_OK;
7b4edcb6 MH	442	}
7b4edcb6 MH	443
695dc859	444	static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi)
7b4edcb6	445	{
f5792417 MH	446	struct dev_context *devc;
	447	struct sr_serial_dev_inst *serial;
	448
7b4edcb6 MH	449	if (sdi->status != SR_ST_ACTIVE)
	450	return SR_ERR_DEV_CLOSED;
	451
208c1d35	452	devc = sdi->priv;
f5792417 MH	453	devc->settings_ok = FALSE;
	454	devc->buflen = 0;
	455
695dc859	456	std_session_send_df_header(sdi, LOG_PREFIX);
f5792417 MH	457
	458	/* Start timer, if required. */
	459	if (devc->limit_msec)
	460	g_timer_start(devc->elapsed_msec);
	461
	462	/* Poll every 40ms, or whenever some data comes in. */
	463	serial = sdi->conn;
102f1239 BV	464	serial_source_add(sdi->session, serial, G_IO_IN, 40,
102f1239 BV	465	gmc_mh_1x_2x_receive_data, (void *)sdi);
7b4edcb6 MH	466
	467	return SR_OK;
	468	}
	469
695dc859	470	static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi)
c90beca7 MH	471	{
	472	struct dev_context *devc;
	473	struct sr_serial_dev_inst *serial;
	474
c90beca7 MH	475	if (sdi->status != SR_ST_ACTIVE)
	476	return SR_ERR_DEV_CLOSED;
	477
208c1d35	478	devc = sdi->priv;
c90beca7 MH	479	devc->settings_ok = FALSE;
	480	devc->buflen = 0;
	481
695dc859	482	std_session_send_df_header(sdi, LOG_PREFIX);
c90beca7 MH	483
	484	/* Start timer, if required. */
	485	if (devc->limit_msec)
	486	g_timer_start(devc->elapsed_msec);
	487
	488	/* Poll every 40ms, or whenever some data comes in. */
	489	serial = sdi->conn;
102f1239 BV	490	serial_source_add(sdi->session, serial, G_IO_IN, 40,
102f1239 BV	491	gmc_mh_2x_receive_data, (void *)sdi);
c90beca7 MH	492
	493	/* Send start message */
	494	return req_meas14(sdi);
	495	}
	496
695dc859	497	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
7b4edcb6	498	{
f5792417	499	struct dev_context *devc;
7b4edcb6	500
f5792417 MH	501	/* Stop timer, if required. */
	502	if (sdi && (devc = sdi->priv) && devc->limit_msec)
	503	g_timer_stop(devc->elapsed_msec);
7b4edcb6	504
6525d819	505	return std_serial_dev_acquisition_stop(sdi, dev_close,
f5792417	506	sdi->conn, LOG_PREFIX);
7b4edcb6 MH	507	}
7b4edcb6 MH	508
dd5c48a6	509	static struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
7b4edcb6	510	.name = "gmc-mh-1x-2x-rs232",
a90061e5	511	.longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
7b4edcb6	512	.api_version = 1,
c2fdcc25	513	.init = std_init,
700d6b64	514	.cleanup = std_cleanup,
c90beca7	515	.scan = scan_1x_2x_rs232,
c01bf34c	516	.dev_list = std_dev_list,
a6630742	517	.dev_clear = NULL,
c90beca7 MH	518	.config_get = config_get,
	519	.config_set = config_set,
	520	.config_list = config_list_sm,
	521	.dev_open = std_serial_dev_open,
	522	.dev_close = dev_close,
	523	.dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
	524	.dev_acquisition_stop = dev_acquisition_stop,
41812aca	525	.context = NULL,
c90beca7	526	};
dd5c48a6	527	SR_REGISTER_DEV_DRIVER(gmc_mh_1x_2x_rs232_driver_info);
c90beca7	528
dd5c48a6	529	static struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
c90beca7	530	.name = "gmc-mh-2x-bd232",
a90061e5	531	.longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
c90beca7	532	.api_version = 1,
c2fdcc25	533	.init = std_init,
700d6b64	534	.cleanup = std_cleanup,
c90beca7	535	.scan = scan_2x_bd232,
c01bf34c	536	.dev_list = std_dev_list,
a6630742	537	.dev_clear = NULL,
7b4edcb6 MH	538	.config_get = config_get,
7b4edcb6 MH	539	.config_set = config_set,
c90beca7	540	.config_list = config_list_bd,
854434de	541	.dev_open = std_serial_dev_open,
7b4edcb6	542	.dev_close = dev_close,
c90beca7	543	.dev_acquisition_start = dev_acquisition_start_2x_bd232,
27fd2eaa	544	.dev_acquisition_stop = dev_acquisition_stop,
41812aca	545	.context = NULL,
7b4edcb6	546	};
dd5c48a6	547	SR_REGISTER_DEV_DRIVER(gmc_mh_2x_bd232_driver_info);