[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 <glib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <errno.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"

static const int hwopts[] = {
	SR_HWOPT_CONN,
	SR_HWOPT_SERIALCOMM,
	0,
};

static const int hwcaps[] = {
	SR_HWCAP_MULTIMETER,
	SR_HWCAP_LIMIT_SAMPLES,
	SR_HWCAP_CONTINUOUS,
	0,
};

static const char *probe_names[] = {
	"Probe",
	NULL,
};

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

/* 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)
{
	struct drv_context *drvc;

	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
		sr_err("Driver context malloc failed.");
		return SR_ERR_MALLOC;
	}

	sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);

	drvc->sr_ctx = sr_ctx;
	dmms[dmm].di->priv = drvc;

	return SR_OK;
}

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 port %s.", conn);

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

	/*
	 * There's no way to get an ID from the multimeter. It just sends data
	 * periodically, 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);

	/* 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;
		}
	}

	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 this device 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;
	devc->subdriver = dmm;

	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_hwopt *opt;
	GSList *l, *devices;
	const char *conn, *serialcomm;

	conn = serialcomm = NULL;
	for (l = options; l; l = l->next) {
		opt = l->data;
		switch (opt->hwopt) {
		case SR_HWOPT_CONN:
			conn = opt->value;
			break;
		case SR_HWOPT_SERIALCOMM:
			serialcomm = opt->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)
{
	struct drv_context *drvc;

	drvc = dmms[dmm].di->priv;

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

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

	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 hw_info_get(int info_id, const void **data,
		       const struct sr_dev_inst *sdi)
{
	(void)sdi;

	switch (info_id) {
	case SR_DI_HWOPTS:
		*data = hwopts;
		break;
	case SR_DI_HWCAPS:
		*data = hwcaps;
		break;
	case SR_DI_NUM_PROBES:
		*data = GINT_TO_POINTER(1);
		break;
	case SR_DI_PROBE_NAMES:
		*data = probe_names;
		break;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
			     const void *value)
{
	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 (hwcap) {
	case SR_HWCAP_LIMIT_SAMPLES:
		devc->limit_samples = *(const uint64_t *)value;
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		break;
	default:
		sr_err("Unknown capability: %d.", hwcap);
		return SR_ERR;
		break;
	}

	return SR_OK;
}

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
				    void *cb_data)
{
	struct sr_datafeed_packet packet;
	struct sr_datafeed_header header;
	struct sr_datafeed_meta_analog meta;
	struct dev_context *devc;

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

	sr_dbg("Starting acquisition.");

	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;

	/* Send header packet to the session bus. */
	sr_dbg("Sending SR_DF_HEADER.");
	packet.type = SR_DF_HEADER;
	packet.payload = (uint8_t *)&header;
	header.feed_version = 1;
	gettimeofday(&header.starttime, NULL);
	sr_session_send(devc->cb_data, &packet);

	/* Send metadata about the SR_DF_ANALOG packets to come. */
	sr_dbg("Sending SR_DF_META_ANALOG.");
	packet.type = SR_DF_META_ANALOG;
	packet.payload = &meta;
	meta.num_probes = 1;
	sr_session_send(devc->cb_data, &packet);

	/* Poll every 50ms, or whenever some data comes in. */
	sr_source_add(devc->serial->fd, G_IO_IN, 50,
		      dmms[devc->subdriver].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); }

/* 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) \
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, \
	.dev_open = hw_dev_open, \
	.dev_close = hw_dev_close, \
	.info_get = hw_info_get, \
	.dev_config_set = hw_dev_config_set, \
	.dev_acquisition_start = hw_dev_acquisition_start, \
	.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")
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 <glib.h>
	23	#include <sys/types.h>
	24	#include <sys/stat.h>
	25	#include <fcntl.h>
	26	#include <string.h>
	27	#include <errno.h>
	28	#include "libsigrok.h"
	29	#include "libsigrok-internal.h"
	30	#include "protocol.h"
	31
	32	static const int hwopts[] = {
	33	SR_HWOPT_CONN,
	34	SR_HWOPT_SERIALCOMM,
	35	0,
	36	};
	37
	38	static const int hwcaps[] = {
	39	SR_HWCAP_MULTIMETER,
	40	SR_HWCAP_LIMIT_SAMPLES,
	41	SR_HWCAP_CONTINUOUS,
	42	0,
	43	};
	44
	45	static const char *probe_names[] = {
	46	"Probe",
	47	NULL,
	48	};
	49
	50	SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
	51	SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
	52	SR_PRIV struct sr_dev_driver metex_me31_driver_info;
	53	SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
	54	SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
	55	SR_PRIV struct sr_dev_driver va_va18b_driver_info;
	56	SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
	57	SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
	58	SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
	59	SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
	60	SR_PRIV struct sr_dev_driver radioshack_22_812_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-812", "4800/8n1/rts=0/dtr=1", 4800,
	135	RS9LCD_PACKET_SIZE, NULL,
	136	sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
	137	NULL,
	138	&radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
	139	},
	140	};
	141
	142	/* Properly close and free all devices. */
	143	static int clear_instances(int dmm)
	144	{
	145	struct sr_dev_inst *sdi;
	146	struct drv_context *drvc;
	147	struct dev_context *devc;
	148	GSList *l;
	149	struct sr_dev_driver *di;
	150
	151	di = dmms[dmm].di;
	152
	153	if (!(drvc = di->priv))
	154	return SR_OK;
	155
	156	drvc = di->priv;
	157	for (l = drvc->instances; l; l = l->next) {
	158	if (!(sdi = l->data))
	159	continue;
	160	if (!(devc = sdi->priv))
	161	continue;
	162	sr_serial_dev_inst_free(devc->serial);
	163	sr_dev_inst_free(sdi);
	164	}
	165	g_slist_free(drvc->instances);
	166	drvc->instances = NULL;
	167
	168	return SR_OK;
	169	}
	170
	171	static int hw_init(struct sr_context *sr_ctx, int dmm)
	172	{
	173	struct drv_context *drvc;
	174
	175	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
	176	sr_err("Driver context malloc failed.");
	177	return SR_ERR_MALLOC;
	178	}
	179
	180	sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
	181
	182	drvc->sr_ctx = sr_ctx;
	183	dmms[dmm].di->priv = drvc;
	184
	185	return SR_OK;
	186	}
	187
	188	static GSList scan(const char conn, const char *serialcomm, int dmm)
	189	{
	190	struct sr_dev_inst *sdi;
	191	struct drv_context *drvc;
	192	struct dev_context *devc;
	193	struct sr_probe *probe;
	194	struct sr_serial_dev_inst *serial;
	195	GSList *devices;
	196	int dropped, ret;
	197	size_t len;
	198	uint8_t buf[128];
	199
	200	if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
	201	return NULL;
	202
	203	if (serial_open(serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	204	return NULL;
	205
	206	sr_info("Probing port %s.", conn);
	207
	208	drvc = dmms[dmm].di->priv;
	209	devices = NULL;
	210	serial_flush(serial);
	211
	212	/*
	213	* There's no way to get an ID from the multimeter. It just sends data
	214	* periodically, so the best we can do is check if the packets match
	215	* the expected format.
	216	*/
	217
	218	/* Let's get a bit of data and see if we can find a packet. */
	219	len = sizeof(buf);
	220
	221	/* Request a packet if the DMM requires this. */
	222	if (dmms[dmm].packet_request) {
	223	if ((ret = dmms[dmm].packet_request(serial)) < 0) {
	224	sr_err("Failed to request packet: %d.", ret);
	225	return FALSE;
	226	}
	227	}
	228
	229	ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
	230	dmms[dmm].packet_valid, 1000,
	231	dmms[dmm].baudrate);
	232	if (ret != SR_OK)
	233	goto scan_cleanup;
	234
	235	/*
	236	* If we dropped more than two packets worth of data, something is
	237	* wrong. We shouldn't quit however, since the dropped bytes might be
	238	* just zeroes at the beginning of the stream. Those can occur as a
	239	* combination of the nonstandard cable that ships with this device and
	240	* the serial port or USB to serial adapter.
	241	*/
	242	dropped = len - dmms[dmm].packet_size;
	243	if (dropped > 2 * dmms[dmm].packet_size)
	244	sr_warn("Had to drop too much data.");
	245
	246	sr_info("Found device on port %s.", conn);
	247
	248	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
	249	dmms[dmm].device, "")))
	250	goto scan_cleanup;
	251
	252	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	253	sr_err("Device context malloc failed.");
	254	goto scan_cleanup;
	255	}
	256
	257	devc->serial = serial;
	258	devc->subdriver = dmm;
	259
	260	sdi->priv = devc;
	261	sdi->driver = dmms[dmm].di;
	262	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
	263	goto scan_cleanup;
	264	sdi->probes = g_slist_append(sdi->probes, probe);
	265	drvc->instances = g_slist_append(drvc->instances, sdi);
	266	devices = g_slist_append(devices, sdi);
	267
	268	scan_cleanup:
	269	serial_close(serial);
	270
	271	return devices;
	272	}
	273
	274	static GSList hw_scan(GSList options, int dmm)
	275	{
	276	struct sr_hwopt *opt;
	277	GSList l, devices;
	278	const char conn, serialcomm;
	279
	280	conn = serialcomm = NULL;
	281	for (l = options; l; l = l->next) {
	282	opt = l->data;
	283	switch (opt->hwopt) {
	284	case SR_HWOPT_CONN:
	285	conn = opt->value;
	286	break;
	287	case SR_HWOPT_SERIALCOMM:
	288	serialcomm = opt->value;
	289	break;
	290	}
	291	}
	292	if (!conn)
	293	return NULL;
	294
	295	if (serialcomm) {
	296	/* Use the provided comm specs. */
	297	devices = scan(conn, serialcomm, dmm);
	298	} else {
	299	/* Try the default. */
	300	devices = scan(conn, dmms[dmm].conn, dmm);
	301	}
	302
	303	return devices;
	304	}
	305
	306	static GSList *hw_dev_list(int dmm)
	307	{
	308	struct drv_context *drvc;
	309
	310	drvc = dmms[dmm].di->priv;
	311
	312	return drvc->instances;
	313	}
	314
	315	static int hw_dev_open(struct sr_dev_inst *sdi)
	316	{
	317	struct dev_context *devc;
	318
	319	if (!(devc = sdi->priv)) {
	320	sr_err("sdi->priv was NULL.");
	321	return SR_ERR_BUG;
	322	}
	323
	324	if (serial_open(devc->serial, SERIAL_RDWR \| SERIAL_NONBLOCK) != SR_OK)
	325	return SR_ERR;
	326
	327	sdi->status = SR_ST_ACTIVE;
	328
	329	return SR_OK;
	330	}
	331
	332	static int hw_dev_close(struct sr_dev_inst *sdi)
	333	{
	334	struct dev_context *devc;
	335
	336	if (!(devc = sdi->priv)) {
	337	sr_err("sdi->priv was NULL.");
	338	return SR_ERR_BUG;
	339	}
	340
	341	if (devc->serial && devc->serial->fd != -1) {
	342	serial_close(devc->serial);
	343	sdi->status = SR_ST_INACTIVE;
	344	}
	345
	346	return SR_OK;
	347	}
	348
	349	static int hw_cleanup(int dmm)
	350	{
	351	clear_instances(dmm);
	352
	353	return SR_OK;
	354	}
	355
	356	static int hw_info_get(int info_id, const void **data,
	357	const struct sr_dev_inst *sdi)
	358	{
	359	(void)sdi;
	360
	361	switch (info_id) {
	362	case SR_DI_HWOPTS:
	363	*data = hwopts;
	364	break;
	365	case SR_DI_HWCAPS:
	366	*data = hwcaps;
	367	break;
	368	case SR_DI_NUM_PROBES:
	369	*data = GINT_TO_POINTER(1);
	370	break;
	371	case SR_DI_PROBE_NAMES:
	372	*data = probe_names;
	373	break;
	374	default:
	375	return SR_ERR_ARG;
	376	}
	377
	378	return SR_OK;
	379	}
	380
	381	static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
	382	const void *value)
	383	{
	384	struct dev_context *devc;
	385
	386	if (sdi->status != SR_ST_ACTIVE)
	387	return SR_ERR;
	388
	389	if (!(devc = sdi->priv)) {
	390	sr_err("sdi->priv was NULL.");
	391	return SR_ERR_BUG;
	392	}
	393
	394	switch (hwcap) {
	395	case SR_HWCAP_LIMIT_SAMPLES:
	396	devc->limit_samples = (const uint64_t )value;
	397	sr_dbg("Setting sample limit to %" PRIu64 ".",
	398	devc->limit_samples);
	399	break;
	400	default:
	401	sr_err("Unknown capability: %d.", hwcap);
	402	return SR_ERR;
	403	break;
	404	}
	405
	406	return SR_OK;
	407	}
	408
	409	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	410	void *cb_data)
	411	{
	412	struct sr_datafeed_packet packet;
	413	struct sr_datafeed_header header;
	414	struct sr_datafeed_meta_analog meta;
	415	struct dev_context *devc;
	416
	417	if (!(devc = sdi->priv)) {
	418	sr_err("sdi->priv was NULL.");
	419	return SR_ERR_BUG;
	420	}
	421
	422	sr_dbg("Starting acquisition.");
	423
	424	devc->cb_data = cb_data;
	425
	426	/*
	427	* Reset the number of samples to take. If we've already collected our
	428	* quota, but we start a new session, and don't reset this, we'll just
	429	* quit without acquiring any new samples.
	430	*/
	431	devc->num_samples = 0;
	432
	433	/* Send header packet to the session bus. */
	434	sr_dbg("Sending SR_DF_HEADER.");
	435	packet.type = SR_DF_HEADER;
	436	packet.payload = (uint8_t *)&header;
	437	header.feed_version = 1;
	438	gettimeofday(&header.starttime, NULL);
	439	sr_session_send(devc->cb_data, &packet);
	440
	441	/* Send metadata about the SR_DF_ANALOG packets to come. */
	442	sr_dbg("Sending SR_DF_META_ANALOG.");
	443	packet.type = SR_DF_META_ANALOG;
	444	packet.payload = &meta;
	445	meta.num_probes = 1;
	446	sr_session_send(devc->cb_data, &packet);
	447
	448	/* Poll every 50ms, or whenever some data comes in. */
	449	sr_source_add(devc->serial->fd, G_IO_IN, 50,
	450	dmms[devc->subdriver].receive_data, (void *)sdi);
	451
	452	return SR_OK;
	453	}
	454
	455	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	456	{
	457	struct sr_datafeed_packet packet;
	458	struct dev_context *devc;
	459
	460	if (sdi->status != SR_ST_ACTIVE)
	461	return SR_ERR;
	462
	463	if (!(devc = sdi->priv)) {
	464	sr_err("sdi->priv was NULL.");
	465	return SR_ERR_BUG;
	466	}
	467
	468	sr_dbg("Stopping acquisition.");
	469
	470	sr_source_remove(devc->serial->fd);
	471	hw_dev_close((struct sr_dev_inst *)sdi);
	472
	473	/* Send end packet to the session bus. */
	474	sr_dbg("Sending SR_DF_END.");
	475	packet.type = SR_DF_END;
	476	sr_session_send(cb_data, &packet);
	477
	478	return SR_OK;
	479	}
	480
	481	/* Driver-specific API function wrappers */
	482	#define HW_INIT(X) \
	483	static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
	484	#define HW_CLEANUP(X) \
	485	static int hw_cleanup_##X(void) { return hw_cleanup(X); }
	486	#define HW_SCAN(X) \
	487	static GSList hw_scan_##X(GSList options) { return hw_scan(options, X); }
	488	#define HW_DEV_LIST(X) \
	489	static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
	490	#define CLEAR_INSTANCES(X) \
	491	static int clear_instances_##X(void) { return clear_instances(X); }
	492
	493	/* Driver structs and API function wrappers */
	494	#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
	495	HW_INIT(ID_UPPER) \
	496	HW_CLEANUP(ID_UPPER) \
	497	HW_SCAN(ID_UPPER) \
	498	HW_DEV_LIST(ID_UPPER) \
	499	CLEAR_INSTANCES(ID_UPPER) \
	500	SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	501	.name = NAME, \
	502	.longname = LONGNAME, \
	503	.api_version = 1, \
	504	.init = hw_init_##ID_UPPER, \
	505	.cleanup = hw_cleanup_##ID_UPPER, \
	506	.scan = hw_scan_##ID_UPPER, \
	507	.dev_list = hw_dev_list_##ID_UPPER, \
	508	.dev_clear = clear_instances_##ID_UPPER, \
	509	.dev_open = hw_dev_open, \
	510	.dev_close = hw_dev_close, \
	511	.info_get = hw_info_get, \
	512	.dev_config_set = hw_dev_config_set, \
	513	.dev_acquisition_start = hw_dev_acquisition_start, \
	514	.dev_acquisition_stop = hw_dev_acquisition_stop, \
	515	.priv = NULL, \
	516	};
	517
	518	DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
	519	DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
	520	DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
	521	DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
	522	DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
	523	DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
	524	DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
	525	DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
	526	DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
	527	DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
	528	DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")