[libsigrok.git] / hardware / serial-dmm / api.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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/>.
 */

#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <errno.h>
#include <glib.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"

static const int hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
	0,
};

static const int hwcaps[] = {
	SR_CONF_MULTIMETER,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_LIMIT_MSEC,
	SR_CONF_CONTINUOUS,
	0,
};

SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
SR_PRIV struct sr_dev_driver metex_me31_driver_info;
SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
SR_PRIV struct sr_dev_driver va_va18b_driver_info;
SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;

SR_PRIV struct dmm_info dmms[] = {
	{
		"Digitek", "DT4000ZC", "2400/8n1", 2400,
		FS9721_PACKET_SIZE, NULL,
		sr_fs9721_packet_valid, sr_fs9721_parse,
		dmm_details_dt4000zc,
		&digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
	},
	{
		"TekPower", "TP4000ZC", "2400/8n1", 2400,
		FS9721_PACKET_SIZE, NULL,
		sr_fs9721_packet_valid, sr_fs9721_parse,
		dmm_details_tp4000zc,
		&tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
	},
	{
		"Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
		METEX14_PACKET_SIZE, sr_metex14_packet_request,
		sr_metex14_packet_valid, sr_metex14_parse,
		NULL,
		&metex_me31_driver_info, receive_data_METEX_ME31,
	},
	{
		"Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
		METEX14_PACKET_SIZE, sr_metex14_packet_request,
		sr_metex14_packet_valid, sr_metex14_parse,
		NULL,
		&peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
	},
	{
		"MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
		METEX14_PACKET_SIZE, sr_metex14_packet_request,
		sr_metex14_packet_valid, sr_metex14_parse,
		NULL,
		&mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
	},
	{
		"V&A", "VA18B", "2400/8n1", 2400,
		FS9721_PACKET_SIZE, NULL,
		sr_fs9721_packet_valid, sr_fs9721_parse,
		dmm_details_va18b,
		&va_va18b_driver_info, receive_data_VA_VA18B,
	},
	{
		"Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
		METEX14_PACKET_SIZE, sr_metex14_packet_request,
		sr_metex14_packet_valid, sr_metex14_parse,
		NULL,
		&metex_m3640d_driver_info, receive_data_METEX_M3640D,
	},
	{
		"PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
		METEX14_PACKET_SIZE, sr_metex14_packet_request,
		sr_metex14_packet_valid, sr_metex14_parse,
		NULL,
		&peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
	},
	{
		"PCE", "PCE-DM32", "2400/8n1", 2400,
		FS9721_PACKET_SIZE, NULL,
		sr_fs9721_packet_valid, sr_fs9721_parse,
		dmm_details_pce_dm32,
		&pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
	},
	{
		"RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
		METEX14_PACKET_SIZE, sr_metex14_packet_request,
		sr_metex14_packet_valid, sr_metex14_parse,
		NULL,
		&radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
	},
	{
		"RadioShack", "22-805", "600/7n2/rts=0/dtr=1", 600,
		METEX14_PACKET_SIZE, sr_metex14_packet_request,
		sr_metex14_packet_valid, sr_metex14_parse,
		NULL,
		&radioshack_22_805_driver_info, receive_data_RADIOSHACK_22_805,
	},
	{
		"RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
		RS9LCD_PACKET_SIZE, NULL,
		sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
		NULL,
		&radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
	},
	{
		"Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
		2400, FS9721_PACKET_SIZE, NULL,
		sr_fs9721_packet_valid, sr_fs9721_parse,
		NULL,
		&voltcraft_vc820_ser_driver_info,
		receive_data_VOLTCRAFT_VC820_SER,
	},
	{
		"Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
		2400, FS9721_PACKET_SIZE, NULL,
		sr_fs9721_packet_valid, sr_fs9721_parse,
		NULL,
		&voltcraft_vc840_ser_driver_info,
		receive_data_VOLTCRAFT_VC840_SER,
	},
	{
		/* Note: ES51922 baudrate is actually 19230! */
		"UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
		19200, ES51922_PACKET_SIZE, NULL,
		sr_es51922_packet_valid, sr_es51922_parse, NULL,
		&uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
	},
};

/* Properly close and free all devices. */
static int clear_instances(int dmm)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	GSList *l;
	struct sr_dev_driver *di;

	di = dmms[dmm].di;

	if (!(drvc = di->priv))
		return SR_OK;

	drvc = di->priv;
	for (l = drvc->instances; l; l = l->next) {
		if (!(sdi = l->data))
			continue;
		if (!(devc = sdi->priv))
			continue;
		sr_serial_dev_inst_free(devc->serial);
		sr_dev_inst_free(sdi);
	}
	g_slist_free(drvc->instances);
	drvc->instances = NULL;

	return SR_OK;
}

static int hw_init(struct sr_context *sr_ctx, int dmm)
{
	sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);

	return std_hw_init(sr_ctx, dmms[dmm].di, DRIVER_LOG_DOMAIN);
}

static GSList *scan(const char *conn, const char *serialcomm, int dmm)
{
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_probe *probe;
	struct sr_serial_dev_inst *serial;
	GSList *devices;
	int dropped, ret;
	size_t len;
	uint8_t buf[128];

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

	if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
		return NULL;

	sr_info("Probing serial port %s.", conn);

	drvc = dmms[dmm].di->priv;
	devices = NULL;
	serial_flush(serial);

	/* Request a packet if the DMM requires this. */
	if (dmms[dmm].packet_request) {
		if ((ret = dmms[dmm].packet_request(serial)) < 0) {
			sr_err("Failed to request packet: %d.", ret);
			return FALSE;
		}
	}

	/*
	 * There's no way to get an ID from the multimeter. It just sends data
	 * periodically (or upon request), so the best we can do is check if
	 * the packets match the expected format.
	 */

	/* Let's get a bit of data and see if we can find a packet. */
	len = sizeof(buf);
	ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
				   dmms[dmm].packet_valid, 1000,
				   dmms[dmm].baudrate);
	if (ret != SR_OK)
		goto scan_cleanup;

	/*
	 * If we dropped more than two packets worth of data, something is
	 * wrong. We shouldn't quit however, since the dropped bytes might be
	 * just zeroes at the beginning of the stream. Those can occur as a
	 * combination of the nonstandard cable that ships with some devices
	 * and the serial port or USB to serial adapter.
	 */
	dropped = len - dmms[dmm].packet_size;
	if (dropped > 2 * dmms[dmm].packet_size)
		sr_warn("Had to drop too much data.");

	sr_info("Found device on port %s.", conn);

	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
				    dmms[dmm].device, "")))
		goto scan_cleanup;

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

	devc->serial = serial;

	sdi->priv = devc;
	sdi->driver = dmms[dmm].di;
	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
		goto scan_cleanup;
	sdi->probes = g_slist_append(sdi->probes, probe);
	drvc->instances = g_slist_append(drvc->instances, sdi);
	devices = g_slist_append(devices, sdi);

scan_cleanup:
	serial_close(serial);

	return devices;
}

static GSList *hw_scan(GSList *options, int dmm)
{
	struct sr_config *src;
	GSList *l, *devices;
	const char *conn, *serialcomm;

	conn = serialcomm = NULL;
	for (l = options; l; l = l->next) {
		src = l->data;
		switch (src->key) {
		case SR_CONF_CONN:
			conn = src->value;
			break;
		case SR_CONF_SERIALCOMM:
			serialcomm = src->value;
			break;
		}
	}
	if (!conn)
		return NULL;

	if (serialcomm) {
		/* Use the provided comm specs. */
		devices = scan(conn, serialcomm, dmm);
	} else {
		/* Try the default. */
		devices = scan(conn, dmms[dmm].conn, dmm);
	}

	return devices;
}

static GSList *hw_dev_list(int dmm)
{
	return ((struct drv_context *)(dmms[dmm].di->priv))->instances;
}

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

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
		return SR_ERR;

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;
}

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

	devc = sdi->priv;

	if (devc->serial && devc->serial->fd != -1) {
		serial_close(devc->serial);
		sdi->status = SR_ST_INACTIVE;
	}

	return SR_OK;
}

static int hw_cleanup(int dmm)
{
	clear_instances(dmm);

	return SR_OK;
}

static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

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

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	switch (id) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = *(const uint64_t *)value;
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		break;
	case SR_CONF_LIMIT_MSEC:
		devc->limit_msec = *(const uint64_t *)value;
		sr_dbg("Setting time limit to %" PRIu64 "ms.",
		       devc->limit_msec);
		break;
	default:
		sr_err("Unknown capability: %d.", id);
		return SR_ERR;
		break;
	}

	return SR_OK;
}

static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
{

	(void)sdi;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = hwopts;
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = hwcaps;
		break;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
				    void *cb_data, int dmm)
{
	struct dev_context *devc;

	if (!(devc = sdi->priv)) {
		sr_err("sdi->priv was NULL.");
		return SR_ERR_BUG;
	}

	devc->cb_data = cb_data;

	/*
	 * Reset the number of samples to take. If we've already collected our
	 * quota, but we start a new session, and don't reset this, we'll just
	 * quit without acquiring any new samples.
	 */
	devc->num_samples = 0;
	devc->starttime = g_get_monotonic_time();

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);

	/* Poll every 50ms, or whenever some data comes in. */
	sr_source_add(devc->serial->fd, G_IO_IN, 50,
		      dmms[dmm].receive_data, (void *)sdi);

	return SR_OK;
}

static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
	       ((struct dev_context *)(sdi->priv))->serial, DRIVER_LOG_DOMAIN);
}

/* Driver-specific API function wrappers */
#define HW_INIT(X) \
static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
#define HW_CLEANUP(X) \
static int hw_cleanup_##X(void) { return hw_cleanup(X); }
#define HW_SCAN(X) \
static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
#define HW_DEV_LIST(X) \
static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
#define CLEAR_INSTANCES(X) \
static int clear_instances_##X(void) { return clear_instances(X); }
#define HW_DEV_ACQUISITION_START(X) \
static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }

/* Driver structs and API function wrappers */
#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
HW_INIT(ID_UPPER) \
HW_CLEANUP(ID_UPPER) \
HW_SCAN(ID_UPPER) \
HW_DEV_LIST(ID_UPPER) \
CLEAR_INSTANCES(ID_UPPER) \
HW_DEV_ACQUISITION_START(ID_UPPER) \
SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	.name = NAME, \
	.longname = LONGNAME, \
	.api_version = 1, \
	.init = hw_init_##ID_UPPER, \
	.cleanup = hw_cleanup_##ID_UPPER, \
	.scan = hw_scan_##ID_UPPER, \
	.dev_list = hw_dev_list_##ID_UPPER, \
	.dev_clear = clear_instances_##ID_UPPER, \
	.config_get = NULL, \
	.config_set = config_set, \
	.config_list = config_list, \
	.dev_open = hw_dev_open, \
	.dev_close = hw_dev_close, \
	.dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
	.dev_acquisition_stop = hw_dev_acquisition_stop, \
	.priv = NULL, \
};

DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
DRV(radioshack_22_805, RADIOSHACK_22_805, "radioshack-22-805", "RadioShack 22-805")
DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")
Commit	Line	Data
	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
	5	* Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
	6	* Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
	7	*
	8	* This program is free software: you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation, either version 3 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	20	*/
	21
	22	#include <sys/types.h>
	23	#include <sys/stat.h>
	24	#include <fcntl.h>
	25	#include <string.h>
	26	#include <errno.h>
	27	#include <glib.h>
	28	#include "libsigrok.h"
	29	#include "libsigrok-internal.h"
	30	#include "protocol.h"
	31
	32	static const int hwopts[] = {
	33	SR_CONF_CONN,
	34	SR_CONF_SERIALCOMM,
	35	0,
	36	};
	37
	38	static const int hwcaps[] = {
	39	SR_CONF_MULTIMETER,
	40	SR_CONF_LIMIT_SAMPLES,
	41	SR_CONF_LIMIT_MSEC,
	42	SR_CONF_CONTINUOUS,
	43	0,
	44	};
	45
	46	SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
	47	SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
	48	SR_PRIV struct sr_dev_driver metex_me31_driver_info;
	49	SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
	50	SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
	51	SR_PRIV struct sr_dev_driver va_va18b_driver_info;
	52	SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
	53	SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
	54	SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
	55	SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
	56	SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
	57	SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
	58	SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
	59	SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
	60	SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
	61
	62	SR_PRIV struct dmm_info dmms[] = {
	63	{
	64	"Digitek", "DT4000ZC", "2400/8n1", 2400,
	65	FS9721_PACKET_SIZE, NULL,
	66	sr_fs9721_packet_valid, sr_fs9721_parse,
	67	dmm_details_dt4000zc,
	68	&digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
	69	},
	70	{
	71	"TekPower", "TP4000ZC", "2400/8n1", 2400,
	72	FS9721_PACKET_SIZE, NULL,
	73	sr_fs9721_packet_valid, sr_fs9721_parse,
	74	dmm_details_tp4000zc,
	75	&tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
	76	},
	77	{
	78	"Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
	79	METEX14_PACKET_SIZE, sr_metex14_packet_request,
	80	sr_metex14_packet_valid, sr_metex14_parse,
	81	NULL,
	82	&metex_me31_driver_info, receive_data_METEX_ME31,
	83	},
	84	{
	85	"Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
	86	METEX14_PACKET_SIZE, sr_metex14_packet_request,
	87	sr_metex14_packet_valid, sr_metex14_parse,
	88	NULL,
	89	&peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
	90	},
	91	{
	92	"MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
	93	METEX14_PACKET_SIZE, sr_metex14_packet_request,
	94	sr_metex14_packet_valid, sr_metex14_parse,
	95	NULL,
	96	&mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
	97	},
	98	{
	99	"V&A", "VA18B", "2400/8n1", 2400,
	100	FS9721_PACKET_SIZE, NULL,
	101	sr_fs9721_packet_valid, sr_fs9721_parse,
	102	dmm_details_va18b,
	103	&va_va18b_driver_info, receive_data_VA_VA18B,
	104	},
	105	{
	106	"Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
	107	METEX14_PACKET_SIZE, sr_metex14_packet_request,
	108	sr_metex14_packet_valid, sr_metex14_parse,
	109	NULL,
	110	&metex_m3640d_driver_info, receive_data_METEX_M3640D,
	111	},
	112	{
	113	"PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
	114	METEX14_PACKET_SIZE, sr_metex14_packet_request,
	115	sr_metex14_packet_valid, sr_metex14_parse,
	116	NULL,
	117	&peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
	118	},
	119	{
	120	"PCE", "PCE-DM32", "2400/8n1", 2400,
	121	FS9721_PACKET_SIZE, NULL,
	122	sr_fs9721_packet_valid, sr_fs9721_parse,
	123	dmm_details_pce_dm32,
	124	&pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
	125	},
	126	{
	127	"RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
	128	METEX14_PACKET_SIZE, sr_metex14_packet_request,
	129	sr_metex14_packet_valid, sr_metex14_parse,
	130	NULL,
	131	&radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
	132	},
	133	{
	134	"RadioShack", "22-805", "600/7n2/rts=0/dtr=1", 600,
	135	METEX14_PACKET_SIZE, sr_metex14_packet_request,
	136	sr_metex14_packet_valid, sr_metex14_parse,
	137	NULL,
	138	&radioshack_22_805_driver_info, receive_data_RADIOSHACK_22_805,
	139	},
	140	{
	141	"RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
	142	RS9LCD_PACKET_SIZE, NULL,
	143	sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
	144	NULL,
	145	&radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
	146	},
	147	{
	148	"Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
	149	2400, FS9721_PACKET_SIZE, NULL,
	150	sr_fs9721_packet_valid, sr_fs9721_parse,
	151	NULL,
	152	&voltcraft_vc820_ser_driver_info,
	153	receive_data_VOLTCRAFT_VC820_SER,
	154	},
	155	{
	156	"Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
	157	2400, FS9721_PACKET_SIZE, NULL,
	158	sr_fs9721_packet_valid, sr_fs9721_parse,
	159	NULL,
	160	&voltcraft_vc840_ser_driver_info,
	161	receive_data_VOLTCRAFT_VC840_SER,
	162	},
	163	{
	164	/* Note: ES51922 baudrate is actually 19230! */
	165	"UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
	166	19200, ES51922_PACKET_SIZE, NULL,
	167	sr_es51922_packet_valid, sr_es51922_parse, NULL,
	168	&uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
	169	},
	170	};
	171
	172	/* Properly close and free all devices. */
	173	static int clear_instances(int dmm)
	174	{
	175	struct sr_dev_inst *sdi;
	176	struct drv_context *drvc;
	177	struct dev_context *devc;
	178	GSList *l;
	179	struct sr_dev_driver *di;
	180
	181	di = dmms[dmm].di;
	182
	183	if (!(drvc = di->priv))
	184	return SR_OK;
	185
	186	drvc = di->priv;
	187	for (l = drvc->instances; l; l = l->next) {
	188	if (!(sdi = l->data))
	189	continue;
	190	if (!(devc = sdi->priv))
	191	continue;
	192	sr_serial_dev_inst_free(devc->serial);
	193	sr_dev_inst_free(sdi);
	194	}
	195	g_slist_free(drvc->instances);
	196	drvc->instances = NULL;
	197
	198	return SR_OK;
	199	}
	200
	201	static int hw_init(struct sr_context *sr_ctx, int dmm)
	202	{
	203	sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
	204
	205	return std_hw_init(sr_ctx, dmms[dmm].di, DRIVER_LOG_DOMAIN);
	206	}
	207
	208	static GSList scan(const char conn, const char *serialcomm, int dmm)
	209	{
	210	struct sr_dev_inst *sdi;
	211	struct drv_context *drvc;
	212	struct dev_context *devc;
	213	struct sr_probe *probe;
	214	struct sr_serial_dev_inst *serial;
	215	GSList *devices;
	216	int dropped, ret;
	217	size_t len;
	218	uint8_t buf[128];
	219
	220	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	221	return NULL;
	222
	223	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	224	return NULL;
	225
	226	sr_info("Probing serial port %s.", conn);
	227
	228	drvc = dmms[dmm].di->priv;
	229	devices = NULL;
	230	serial_flush(serial);
	231
	232	/* Request a packet if the DMM requires this. */
	233	if (dmms[dmm].packet_request) {
	234	if ((ret = dmms[dmm].packet_request(serial)) < 0) {
	235	sr_err("Failed to request packet: %d.", ret);
	236	return FALSE;
	237	}
	238	}
	239
	240	/*
	241	* There's no way to get an ID from the multimeter. It just sends data
	242	* periodically (or upon request), so the best we can do is check if
	243	* the packets match the expected format.
	244	*/
	245
	246	/* Let's get a bit of data and see if we can find a packet. */
	247	len = sizeof(buf);
	248	ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
	249	dmms[dmm].packet_valid, 1000,
	250	dmms[dmm].baudrate);
	251	if (ret != SR_OK)
	252	goto scan_cleanup;
	253
	254	/*
	255	* If we dropped more than two packets worth of data, something is
	256	* wrong. We shouldn't quit however, since the dropped bytes might be
	257	* just zeroes at the beginning of the stream. Those can occur as a
	258	* combination of the nonstandard cable that ships with some devices
	259	* and the serial port or USB to serial adapter.
	260	*/
	261	dropped = len - dmms[dmm].packet_size;
	262	if (dropped > 2 * dmms[dmm].packet_size)
	263	sr_warn("Had to drop too much data.");
	264
	265	sr_info("Found device on port %s.", conn);
	266
	267	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
	268	dmms[dmm].device, "")))
	269	goto scan_cleanup;
	270
	271	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	272	sr_err("Device context malloc failed.");
	273	goto scan_cleanup;
	274	}
	275
	276	devc->serial = serial;
	277
	278	sdi->priv = devc;
	279	sdi->driver = dmms[dmm].di;
	280	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
	281	goto scan_cleanup;
	282	sdi->probes = g_slist_append(sdi->probes, probe);
	283	drvc->instances = g_slist_append(drvc->instances, sdi);
	284	devices = g_slist_append(devices, sdi);
	285
	286	scan_cleanup:
	287	serial_close(serial);
	288
	289	return devices;
	290	}
	291
	292	static GSList hw_scan(GSList options, int dmm)
	293	{
	294	struct sr_config *src;
	295	GSList l, devices;
	296	const char conn, serialcomm;
	297
	298	conn = serialcomm = NULL;
	299	for (l = options; l; l = l->next) {
	300	src = l->data;
	301	switch (src->key) {
	302	case SR_CONF_CONN:
	303	conn = src->value;
	304	break;
	305	case SR_CONF_SERIALCOMM:
	306	serialcomm = src->value;
	307	break;
	308	}
	309	}
	310	if (!conn)
	311	return NULL;
	312
	313	if (serialcomm) {
	314	/* Use the provided comm specs. */
	315	devices = scan(conn, serialcomm, dmm);
	316	} else {
	317	/* Try the default. */
	318	devices = scan(conn, dmms[dmm].conn, dmm);
	319	}
	320
	321	return devices;
	322	}
	323
	324	static GSList *hw_dev_list(int dmm)
	325	{
	326	return ((struct drv_context *)(dmms[dmm].di->priv))->instances;
	327	}
	328
	329	static int hw_dev_open(struct sr_dev_inst *sdi)
	330	{
	331	struct dev_context *devc;
	332
	333	if (!(devc = sdi->priv)) {
	334	sr_err("sdi->priv was NULL.");
	335	return SR_ERR_BUG;
	336	}
	337
	338	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	339	return SR_ERR;
	340
	341	sdi->status = SR_ST_ACTIVE;
	342
	343	return SR_OK;
	344	}
	345
	346	static int hw_dev_close(struct sr_dev_inst *sdi)
	347	{
	348	struct dev_context *devc;
	349
	350	devc = sdi->priv;
	351
	352	if (devc->serial && devc->serial->fd != -1) {
	353	serial_close(devc->serial);
	354	sdi->status = SR_ST_INACTIVE;
	355	}
	356
	357	return SR_OK;
	358	}
	359
	360	static int hw_cleanup(int dmm)
	361	{
	362	clear_instances(dmm);
	363
	364	return SR_OK;
	365	}
	366
	367	static int config_set(int id, const void value, const struct sr_dev_inst sdi)
	368	{
	369	struct dev_context *devc;
	370
	371	if (sdi->status != SR_ST_ACTIVE)
	372	return SR_ERR;
	373
	374	if (!(devc = sdi->priv)) {
	375	sr_err("sdi->priv was NULL.");
	376	return SR_ERR_BUG;
	377	}
	378
	379	switch (id) {
	380	case SR_CONF_LIMIT_SAMPLES:
	381	devc->limit_samples = (const uint64_t )value;
	382	sr_dbg("Setting sample limit to %" PRIu64 ".",
	383	devc->limit_samples);
	384	break;
	385	case SR_CONF_LIMIT_MSEC:
	386	devc->limit_msec = (const uint64_t )value;
	387	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	388	devc->limit_msec);
	389	break;
	390	default:
	391	sr_err("Unknown capability: %d.", id);
	392	return SR_ERR;
	393	break;
	394	}
	395
	396	return SR_OK;
	397	}
	398
	399	static int config_list(int key, const void *data, const struct sr_dev_inst sdi)
	400	{
	401
	402	(void)sdi;
	403
	404	switch (key) {
	405	case SR_CONF_SCAN_OPTIONS:
	406	*data = hwopts;
	407	break;
	408	case SR_CONF_DEVICE_OPTIONS:
	409	*data = hwcaps;
	410	break;
	411	default:
	412	return SR_ERR_ARG;
	413	}
	414
	415	return SR_OK;
	416	}
	417
	418	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	419	void *cb_data, int dmm)
	420	{
	421	struct dev_context *devc;
	422
	423	if (!(devc = sdi->priv)) {
	424	sr_err("sdi->priv was NULL.");
	425	return SR_ERR_BUG;
	426	}
	427
	428	devc->cb_data = cb_data;
	429
	430	/*
	431	* Reset the number of samples to take. If we've already collected our
	432	* quota, but we start a new session, and don't reset this, we'll just
	433	* quit without acquiring any new samples.
	434	*/
	435	devc->num_samples = 0;
	436	devc->starttime = g_get_monotonic_time();
	437
	438	/* Send header packet to the session bus. */
	439	std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
	440
	441	/* Poll every 50ms, or whenever some data comes in. */
	442	sr_source_add(devc->serial->fd, G_IO_IN, 50,
	443	dmms[dmm].receive_data, (void *)sdi);
	444
	445	return SR_OK;
	446	}
	447
	448	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	449	{
	450	return std_hw_dev_acquisition_stop_serial(sdi, cb_data, hw_dev_close,
	451	((struct dev_context *)(sdi->priv))->serial, DRIVER_LOG_DOMAIN);
	452	}
	453
	454	/* Driver-specific API function wrappers */
	455	#define HW_INIT(X) \
	456	static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
	457	#define HW_CLEANUP(X) \
	458	static int hw_cleanup_##X(void) { return hw_cleanup(X); }
	459	#define HW_SCAN(X) \
	460	static GSList hw_scan_##X(GSList options) { return hw_scan(options, X); }
	461	#define HW_DEV_LIST(X) \
	462	static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
	463	#define CLEAR_INSTANCES(X) \
	464	static int clear_instances_##X(void) { return clear_instances(X); }
	465	#define HW_DEV_ACQUISITION_START(X) \
	466	static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
	467	void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
	468
	469	/* Driver structs and API function wrappers */
	470	#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
	471	HW_INIT(ID_UPPER) \
	472	HW_CLEANUP(ID_UPPER) \
	473	HW_SCAN(ID_UPPER) \
	474	HW_DEV_LIST(ID_UPPER) \
	475	CLEAR_INSTANCES(ID_UPPER) \
	476	HW_DEV_ACQUISITION_START(ID_UPPER) \
	477	SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	478	.name = NAME, \
	479	.longname = LONGNAME, \
	480	.api_version = 1, \
	481	.init = hw_init_##ID_UPPER, \
	482	.cleanup = hw_cleanup_##ID_UPPER, \
	483	.scan = hw_scan_##ID_UPPER, \
	484	.dev_list = hw_dev_list_##ID_UPPER, \
	485	.dev_clear = clear_instances_##ID_UPPER, \
	486	.config_get = NULL, \
	487	.config_set = config_set, \
	488	.config_list = config_list, \
	489	.dev_open = hw_dev_open, \
	490	.dev_close = hw_dev_close, \
	491	.dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
	492	.dev_acquisition_stop = hw_dev_acquisition_stop, \
	493	.priv = NULL, \
	494	};
	495
	496	DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
	497	DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
	498	DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
	499	DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
	500	DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
	501	DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
	502	DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
	503	DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
	504	DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
	505	DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
	506	DRV(radioshack_22_805, RADIOSHACK_22_805, "radioshack-22-805", "RadioShack 22-805")
	507	DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
	508	DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
	509	DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
	510	DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")