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

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

	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 < 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 = 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);
	if (devc)
		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->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(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;

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