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

/*
 * This file is part of the libsigrok 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 int32_t hwopts[] = {
	SR_CONF_CONN,
	SR_CONF_SERIALCOMM,
};

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

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_ut61d_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,
		sr_fs9721_details_c2c1_00_temp_celsius,
		&voltcraft_vc840_ser_driver_info,
		receive_data_VOLTCRAFT_VC840_SER,
	},
	{
		"UNI-T", "UT61D (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
		2400, FS9922_PACKET_SIZE, NULL,
		sr_fs9922_packet_valid, sr_fs9922_parse, NULL,
		&uni_t_ut61d_ser_driver_info, receive_data_UNI_T_UT61D_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;
	struct sr_serial_dev_inst *serial;
	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;
		serial = sdi->conn;
		sr_serial_dev_inst_free(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;
	}

	sdi->inst_type = SR_INST_SERIAL;
	sdi->conn = 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 = 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) {
		/* 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 sr_serial_dev_inst *serial;

	serial = sdi->conn;
	if (serial_open(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 sr_serial_dev_inst *serial;

	serial = sdi->conn;
	if (serial && serial->fd != -1) {
		serial_close(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, GVariant *data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

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

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

	switch (id) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		break;
	case SR_CONF_LIMIT_MSEC:
		devc->limit_msec = g_variant_get_uint64(data);
		sr_dbg("Setting time limit to %" PRIu64 "ms.",
		       devc->limit_msec);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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

	(void)sdi;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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

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

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