[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 <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"

SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info;
SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info;

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.
 */

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

/**
 * 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;
	drvc->instances = NULL;
	conn = serialcomm = NULL;
	model = METRAHIT_NONE;
	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;
	drvc->instances = NULL;

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

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 cleanup(const struct sr_dev_driver *di)
{
	return std_dev_clear(di, NULL);
}

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 || !(devc = sdi->priv))
		return SR_ERR_ARG;

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

	if (!sdi || !cb_data || !(devc = sdi->priv))
		return SR_ERR_BUG;

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

	devc->cb_data = cb_data;
	devc->settings_ok = FALSE;
	devc->buflen = 0;

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, 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,
					  void *cb_data)
{
	struct dev_context *devc;
	struct sr_serial_dev_inst *serial;

	if (!sdi || !cb_data || !(devc = sdi->priv))
		return SR_ERR_BUG;

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

	devc->cb_data = cb_data;
	devc->settings_ok = FALSE;
	devc->buflen = 0;

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, 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, void *cb_data)
{
	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, cb_data, dev_close,
			sdi->conn, LOG_PREFIX);
}

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