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

/** 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_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(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) != 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 = &gmc_mh_1x_2x_rs232_driver_info;
		if (!(ch = sr_channel_new(0, SR_CHANNEL_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) != 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 < 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_channel_new(0, SR_CHANNEL_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);

			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);
	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(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;

	ret = SR_OK;

	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_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
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	};
	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 (;;) {
0714a010	93	rc = serial_read_nonblocking(serial, &result, 1);
f5792417 MH	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
e13e354f	201	if (serial_open(serial, SERIAL_RDWR) != SR_OK) {
f5792417 MH	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));
aac29cc1	226	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	227	sdi->status = SR_ST_INACTIVE;
	228	sdi->vendor = g_strdup(VENDOR_GMC);
	229	sdi->model = g_strdup(gmc_model_str(model));
f57d8ffe	230	devc = g_malloc0(sizeof(struct dev_context));
f5792417 MH	231	devc->model = model;
	232	devc->limit_samples = 0;
	233	devc->limit_msec = 0;
	234	devc->num_samples = 0;
	235	devc->elapsed_msec = g_timer_new();
	236	devc->settings_ok = FALSE;
f5792417 MH	237	sdi->conn = serial;
f5792417 MH	238	sdi->priv = devc;
6392d599	239	sdi->driver = &gmc_mh_1x_2x_rs232_driver_info;
3f239f08	240	if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
f5792417	241	return NULL;
ba7dd8bb	242	sdi->channels = g_slist_append(sdi->channels, ch);
f5792417 MH	243	drvc->instances = g_slist_append(drvc->instances, sdi);
	244	devices = g_slist_append(devices, sdi);
	245	}
7b4edcb6 MH	246
	247	return devices;
	248	}
	249
c90beca7 MH	250	/** Scan for Metrahit 2x in a bidirectional mode using Gossen Metrawatt 'BD 232' interface.
	251	*
	252	*/
	253	static GSList scan_2x_bd232(GSList options)
	254	{
	255	struct sr_dev_inst *sdi;
	256	struct drv_context *drvc;
	257	struct dev_context *devc;
	258	struct sr_config *src;
ba7dd8bb	259	struct sr_channel *ch;
c90beca7 MH	260	struct sr_serial_dev_inst *serial;
	261	GSList l, devices;
	262	const char conn, serialcomm;
	263	int cnt, byte;
	264	gint64 timeout_us;
	265
	266	sdi = NULL;
	267	devc = NULL;
	268	conn = serialcomm = NULL;
	269	devices = NULL;
	270
	271	drvc = (&gmc_mh_2x_bd232_driver_info)->priv;
	272	drvc->instances = NULL;
	273
	274	sr_spew("scan_2x_bd232() called!");
	275
	276	for (l = options; l; l = l->next) {
	277	src = l->data;
	278	switch (src->key) {
	279	case SR_CONF_CONN:
	280	conn = g_variant_get_string(src->data, NULL);
	281	break;
	282	case SR_CONF_SERIALCOMM:
	283	serialcomm = g_variant_get_string(src->data, NULL);
	284	break;
	285	}
	286	}
	287	if (!conn)
	288	return NULL;
	289	if (!serialcomm)
	290	serialcomm = SERIALCOMM_2X;
	291
	292	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	293	return NULL;
	294
e13e354f	295	if (serial_open(serial, SERIAL_RDWR) != SR_OK)
c90beca7 MH	296	goto exit_err;
c90beca7 MH	297
f57d8ffe	298	devc = g_malloc0(sizeof(struct dev_context));
c90beca7	299
aac29cc1	300	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	301	sdi->status = SR_ST_INACTIVE;
0af636be UH	302	sdi->vendor = g_strdup(VENDOR_GMC);
c90beca7 MH	303	sdi->priv = devc;
	304
	305	/* Send message 03 "Query multimeter version and status" */
	306	sdi->conn = serial;
	307	sdi->priv = devc;
	308	if (req_stat14(sdi, TRUE) != SR_OK)
	309	goto exit_err;
	310
	311	/* Wait for reply from device(s) for up to 2s. */
	312	timeout_us = g_get_monotonic_time() + 210001000;
	313
	314	while (timeout_us > g_get_monotonic_time()) {
	315	/* Receive reply (14 bytes) */
	316	devc->buflen = 0;
	317	for (cnt = 0; cnt < 14; cnt++) {
	318	byte = read_byte(serial, timeout_us);
	319	if (byte != -1)
	320	devc->buf[devc->buflen++] = (byte & MASK_6BITS);
	321	}
	322
	323	if (devc->buflen != 14)
	324	continue;
	325
	326	devc->addr = devc->buf[0];
	327	process_msg14(sdi);
	328	devc->buflen = 0;
	329
	330	if (devc->model != METRAHIT_NONE) {
	331	sr_spew("%s %s detected!", VENDOR_GMC, gmc_model_str(devc->model));
	332
	333	devc->elapsed_msec = g_timer_new();
	334
	335	sdi->model = g_strdup(gmc_model_str(devc->model));
	336	sdi->version = g_strdup_printf("Firmware %d.%d", devc->fw_ver_maj, devc->fw_ver_min);
	337	sdi->conn = serial;
	338	sdi->priv = devc;
	339	sdi->driver = &gmc_mh_2x_bd232_driver_info;
3f239f08	340	if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "P1")))
c90beca7	341	goto exit_err;
ba7dd8bb	342	sdi->channels = g_slist_append(sdi->channels, ch);
c90beca7 MH	343	drvc->instances = g_slist_append(drvc->instances, sdi);
	344	devices = g_slist_append(devices, sdi);
	345
f57d8ffe	346	devc = g_malloc0(sizeof(struct dev_context));
c90beca7	347
aac29cc1	348	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	349	sdi->status = SR_ST_INACTIVE;
0af636be UH	350	sdi->vendor = g_strdup(VENDOR_GMC);
c90beca7 MH	351	}
	352	};
	353
	354	/* Free last alloc if no device found */
	355	if (devc->model == METRAHIT_NONE) {
	356	g_free(devc);
	357	sr_dev_inst_free(sdi);
	358	}
	359
	360	return devices;
	361
	362	exit_err:
	363	sr_info("scan_2x_bd232(): Error!");
	364
	365	if (serial)
	366	sr_serial_dev_inst_free(serial);
	367	if (devc)
	368	g_free(devc);
	369	if (sdi)
	370	sr_dev_inst_free(sdi);
	371
	372	return NULL;
	373	}
	374
	375	/** Driver device list function */
	376	static GSList *dev_list_1x_2x_rs232(void)
	377	{
	378	return ((struct drv_context *)(gmc_mh_1x_2x_rs232_driver_info.priv))->instances;
	379	}
	380
	381	/** Driver device list function */
	382	static GSList *dev_list_2x_bd232(void)
7b4edcb6	383	{
c90beca7 MH	384	return ((struct drv_context *)(gmc_mh_2x_bd232_driver_info.priv))
c90beca7 MH	385	->instances;
7b4edcb6 MH	386	}
7b4edcb6 MH	387
7b4edcb6 MH	388	static int dev_close(struct sr_dev_inst *sdi)
7b4edcb6 MH	389	{
f5792417	390	struct dev_context *devc;
7b4edcb6	391
bf2c987f	392	std_serial_dev_close(sdi);
7b4edcb6 MH	393
	394	sdi->status = SR_ST_INACTIVE;
	395
f5792417 MH	396	/* Free dynamically allocated resources. */
	397	if ((devc = sdi->priv) && devc->elapsed_msec) {
	398	g_timer_destroy(devc->elapsed_msec);
	399	devc->elapsed_msec = NULL;
873e0c12	400	devc->model = METRAHIT_NONE;
f5792417 MH	401	}
f5792417 MH	402
7b4edcb6 MH	403	return SR_OK;
	404	}
	405
c90beca7 MH	406	static int cleanup_sm_rs232(void)
c90beca7 MH	407	{
a6630742	408	return std_dev_clear(&gmc_mh_1x_2x_rs232_driver_info, NULL);
c90beca7 MH	409	}
	410
	411	static int cleanup_2x_bd232(void)
7b4edcb6	412	{
a6630742	413	return std_dev_clear(&gmc_mh_2x_bd232_driver_info, NULL);
7b4edcb6 MH	414	}
7b4edcb6 MH	415
6392d599	416	/** Get value of configuration item */
584560f1 BV	417	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
584560f1 BV	418	const struct sr_channel_group *cg)
7b4edcb6 MH	419	{
7b4edcb6 MH	420	int ret;
fadd0707	421	struct dev_context *devc;
c90beca7	422
53b4680f	423	(void)cg;
c90beca7	424
6392d599	425	ret = SR_OK;
7b4edcb6	426
6392d599 MH	427	if (!sdi \|\| !(devc = sdi->priv))
	428	return SR_ERR_ARG;
	429
7b4edcb6 MH	430	ret = SR_OK;
7b4edcb6 MH	431	switch (key) {
6392d599 MH	432	case SR_CONF_LIMIT_SAMPLES:
	433	*data = g_variant_new_uint64(devc->limit_samples);
	434	break;
	435	case SR_CONF_LIMIT_MSEC:
	436	*data = g_variant_new_uint64(devc->limit_msec);
	437	break;
c90beca7 MH	438	case SR_CONF_POWER_OFF:
	439	*data = g_variant_new_boolean(FALSE);
	440	break;
7b4edcb6 MH	441	default:
	442	return SR_ERR_NA;
	443	}
	444
	445	return ret;
	446	}
	447
c90beca7	448	/** Implementation of config_list, auxiliary function for common parts, */
584560f1 BV	449	static int config_list_common(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
584560f1 BV	450	const struct sr_channel_group *cg)
7b4edcb6	451	{
c90beca7	452	(void)sdi;
53b4680f	453	(void)cg;
7b4edcb6	454
7b4edcb6	455	switch (key) {
c90beca7	456	case SR_CONF_SCAN_OPTIONS:
584560f1	457	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
5827f61b	458	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
f5792417	459	break;
7b4edcb6	460	default:
f5792417	461	return SR_ERR_NA;
7b4edcb6 MH	462	}
7b4edcb6 MH	463
f5792417	464	return SR_OK;
7b4edcb6 MH	465	}
7b4edcb6 MH	466
c90beca7	467	/** Implementation of config_list for Metrahit 1x/2x send mode */
584560f1	468	static int config_list_sm(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	469	const struct sr_channel_group *cg)
7b4edcb6	470	{
7b4edcb6	471	switch (key) {
c90beca7	472	case SR_CONF_DEVICE_OPTIONS:
584560f1	473	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
5827f61b	474	devopts_sm, ARRAY_SIZE(devopts_sm), sizeof(uint32_t));
f5792417	475	break;
c90beca7	476	default:
53b4680f	477	return config_list_common(key, data, sdi, cg);
c90beca7 MH	478	}
	479
	480	return SR_OK;
	481	}
	482
	483	/** Implementation of config_list for Metrahit 2x bidirectional mode */
584560f1	484	static int config_list_bd(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	485	const struct sr_channel_group *cg)
c90beca7	486	{
c90beca7	487	switch (key) {
f5792417	488	case SR_CONF_DEVICE_OPTIONS:
584560f1	489	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
5827f61b	490	devopts_bd, ARRAY_SIZE(devopts_bd), sizeof(uint32_t));
f5792417	491	break;
7b4edcb6	492	default:
53b4680f	493	return config_list_common(key, data, sdi, cg);
7b4edcb6 MH	494	}
7b4edcb6 MH	495
f5792417	496	return SR_OK;
7b4edcb6 MH	497	}
7b4edcb6 MH	498
c90beca7 MH	499	static int dev_acquisition_start_1x_2x_rs232(const struct sr_dev_inst *sdi,
c90beca7 MH	500	void *cb_data)
7b4edcb6	501	{
f5792417 MH	502	struct dev_context *devc;
	503	struct sr_serial_dev_inst *serial;
	504
	505	if (!sdi \|\| !cb_data \|\| !(devc = sdi->priv))
	506	return SR_ERR_BUG;
7b4edcb6 MH	507
	508	if (sdi->status != SR_ST_ACTIVE)
	509	return SR_ERR_DEV_CLOSED;
	510
f5792417 MH	511	devc->cb_data = cb_data;
	512	devc->settings_ok = FALSE;
	513	devc->buflen = 0;
	514
	515	/* Send header packet to the session bus. */
	516	std_session_send_df_header(cb_data, LOG_PREFIX);
	517
	518	/* Start timer, if required. */
	519	if (devc->limit_msec)
	520	g_timer_start(devc->elapsed_msec);
	521
	522	/* Poll every 40ms, or whenever some data comes in. */
	523	serial = sdi->conn;
102f1239 BV	524	serial_source_add(sdi->session, serial, G_IO_IN, 40,
102f1239 BV	525	gmc_mh_1x_2x_receive_data, (void *)sdi);
7b4edcb6 MH	526
	527	return SR_OK;
	528	}
	529
c90beca7 MH	530	static int dev_acquisition_start_2x_bd232(const struct sr_dev_inst *sdi,
	531	void *cb_data)
	532	{
	533	struct dev_context *devc;
	534	struct sr_serial_dev_inst *serial;
	535
	536	if (!sdi \|\| !cb_data \|\| !(devc = sdi->priv))
	537	return SR_ERR_BUG;
	538
	539	if (sdi->status != SR_ST_ACTIVE)
	540	return SR_ERR_DEV_CLOSED;
	541
	542	devc->cb_data = cb_data;
	543	devc->settings_ok = FALSE;
	544	devc->buflen = 0;
	545
	546	/* Send header packet to the session bus. */
	547	std_session_send_df_header(cb_data, LOG_PREFIX);
	548
	549	/* Start timer, if required. */
	550	if (devc->limit_msec)
	551	g_timer_start(devc->elapsed_msec);
	552
	553	/* Poll every 40ms, or whenever some data comes in. */
	554	serial = sdi->conn;
102f1239 BV	555	serial_source_add(sdi->session, serial, G_IO_IN, 40,
102f1239 BV	556	gmc_mh_2x_receive_data, (void *)sdi);
c90beca7 MH	557
	558	/* Send start message */
	559	return req_meas14(sdi);
	560	}
	561
27fd2eaa	562	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
7b4edcb6	563	{
f5792417	564	struct dev_context *devc;
7b4edcb6	565
f5792417 MH	566	/* Stop timer, if required. */
	567	if (sdi && (devc = sdi->priv) && devc->limit_msec)
	568	g_timer_stop(devc->elapsed_msec);
7b4edcb6	569
d43b0908	570	return std_serial_dev_acquisition_stop(sdi, cb_data, dev_close,
f5792417	571	sdi->conn, LOG_PREFIX);
7b4edcb6 MH	572	}
	573
	574	SR_PRIV struct sr_dev_driver gmc_mh_1x_2x_rs232_driver_info = {
	575	.name = "gmc-mh-1x-2x-rs232",
a90061e5	576	.longname = "Gossen Metrawatt Metrahit 1x/2x, RS232 interface",
7b4edcb6	577	.api_version = 1,
c90beca7 MH	578	.init = init_1x_2x_rs232,
	579	.cleanup = cleanup_sm_rs232,
	580	.scan = scan_1x_2x_rs232,
	581	.dev_list = dev_list_1x_2x_rs232,
a6630742	582	.dev_clear = NULL,
c90beca7 MH	583	.config_get = config_get,
	584	.config_set = config_set,
	585	.config_list = config_list_sm,
	586	.dev_open = std_serial_dev_open,
	587	.dev_close = dev_close,
	588	.dev_acquisition_start = dev_acquisition_start_1x_2x_rs232,
	589	.dev_acquisition_stop = dev_acquisition_stop,
	590	.priv = NULL,
	591	};
	592
	593	SR_PRIV struct sr_dev_driver gmc_mh_2x_bd232_driver_info = {
	594	.name = "gmc-mh-2x-bd232",
a90061e5	595	.longname = "Gossen Metrawatt Metrahit 2x, BD232/SI232-II interface",
c90beca7 MH	596	.api_version = 1,
	597	.init = init_2x_bd232,
	598	.cleanup = cleanup_2x_bd232,
	599	.scan = scan_2x_bd232,
	600	.dev_list = dev_list_2x_bd232,
a6630742	601	.dev_clear = NULL,
7b4edcb6 MH	602	.config_get = config_get,
7b4edcb6 MH	603	.config_set = config_set,
c90beca7	604	.config_list = config_list_bd,
854434de	605	.dev_open = std_serial_dev_open,
7b4edcb6	606	.dev_close = dev_close,
c90beca7	607	.dev_acquisition_start = dev_acquisition_start_2x_bd232,
27fd2eaa	608	.dev_acquisition_stop = dev_acquisition_stop,
7b4edcb6 MH	609	.priv = NULL,
7b4edcb6 MH	610	};