[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_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-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)
{
	struct sr_datafeed_packet packet;
	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;
	}

	sr_dbg("Stopping acquisition.");

	sr_source_remove(devc->serial->fd);
	hw_dev_close((struct sr_dev_inst *)sdi);

	/* Send end packet to the session bus. */
	sr_dbg("Sending SR_DF_END.");
	packet.type = SR_DF_END;
	sr_session_send(cb_data, &packet);

	return SR_OK;
}

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