[libsigrok.git] / 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 int32_t hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

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

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


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

/** Init driver gmc_mh_1x_2x_rs232. */
static int init_1x_2x_rs232(struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, &gmc_mh_1x_2x_rs232_driver_info, LOG_PREFIX);
}

/** Init driver gmc_mh_2x_bd232. */
static int init_2x_bd232(struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, &gmc_mh_2x_bd232_driver_info, 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(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(GSList *options)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_config *src;
	struct sr_channel *ch;
	struct sr_serial_dev_inst *serial;
	GSList *l, *devices;
	const char *conn, *serialcomm;
	enum model model;
	gboolean serialcomm_given;

	devices = NULL;
	drvc = (&gmc_mh_1x_2x_rs232_driver_info)->priv;
	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;

	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
		return NULL;

	if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != 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));
		if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_GMC,
				gmc_model_str(model), "")))
			return NULL;
		if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
			sr_err("Device context malloc failed.");
			return NULL;
		}
		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 = &gmc_mh_1x_2x_rs232_driver_info;
		if (!(ch = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
			return NULL;
		sdi->channels = g_slist_append(sdi->channels, ch);
		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(GSList *options)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_config *src;
	struct sr_channel *ch;
	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 = (&gmc_mh_2x_bd232_driver_info)->priv;
	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;

	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
		return NULL;

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

	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
		sr_err("Device context malloc failed.");
		goto exit_err;
	}

	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_GMC, NULL, NULL)))
		goto exit_err;

	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 < 14; cnt++) {
			byte = read_byte(serial, timeout_us);
			if (byte != -1)
				devc->buf[devc->buflen++] = (byte & MASK_6BITS);
		}

		if (devc->buflen != 14)
			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 = &gmc_mh_2x_bd232_driver_info;
			if (!(ch = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
				goto exit_err;
			sdi->channels = g_slist_append(sdi->channels, ch);
			drvc->instances = g_slist_append(drvc->instances, sdi);
			devices = g_slist_append(devices, sdi);

			if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
				sr_err("Device context malloc failed.");
				goto exit_err;
			}

			if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR_GMC, NULL, NULL)))
				goto exit_err;
		}
	};

	/* 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);
	if (devc)
		g_free(devc);
	if (sdi)
		sr_dev_inst_free(sdi);

	return NULL;
}

/** Driver device list function */
static GSList *dev_list_1x_2x_rs232(void)
{
	return ((struct drv_context *)(gmc_mh_1x_2x_rs232_driver_info.priv))->instances;
}

/** Driver device list function */
static GSList *dev_list_2x_bd232(void)
{
	return ((struct drv_context *)(gmc_mh_2x_bd232_driver_info.priv))
			->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_sm_rs232(void)
{
	return std_dev_clear(&gmc_mh_1x_2x_rs232_driver_info, NULL);
}

static int cleanup_2x_bd232(void)
{
	return std_dev_clear(&gmc_mh_2x_bd232_driver_info, NULL);
}

/** Get value of configuration item */
static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
		      const struct sr_channel_group *cg)
{
	int ret;
	struct dev_context *devc;

	(void)sdi;
	(void)data;
	(void)cg;

	ret = SR_OK;

	(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(int 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_INT32,
						  hwopts, ARRAY_SIZE(hwopts), sizeof(int32_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(int key, GVariant **data, const struct sr_dev_inst *sdi,
			  const struct sr_channel_group *cg)
{
	(void)sdi;

	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
						  hwcaps_sm, ARRAY_SIZE(hwcaps_sm), sizeof(int32_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(int key, GVariant **data, const struct sr_dev_inst *sdi,
			  const struct sr_channel_group *cg)
{
	(void)sdi;

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