[libsigrok.git] / hardware / uni-t-dmm / api.c

/*
 * This file is part of the sigrok project.
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <stdlib.h>
#include <string.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"

#define UNI_T_UT_D04_NEW "1a86.e008"

static const int hwopts[] = {
	SR_CONF_CONN,
	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 uni_t_ut61d_driver_info;
SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;

static struct sr_dev_driver *di_ut61d = &uni_t_ut61d_driver_info;
static struct sr_dev_driver *di_vc820 = &voltcraft_vc820_driver_info;

/* After hw_init() this will point to a device-specific entry (see above). */
static struct sr_dev_driver *di = NULL;

static int clear_instances(void)
{
	/* TODO: Use common code later. */

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

	if (dmm == UNI_T_UT61D)
		di = di_ut61d;
	else if (dmm == VOLTCRAFT_VC820)
		di = di_vc820;
	sr_dbg("Selected '%s' subdriver.", di->name);

	drvc->sr_ctx = sr_ctx;
	di->priv = drvc;

	return SR_OK;
}

static int hw_init_ut61d(struct sr_context *sr_ctx)
{
	return hw_init(sr_ctx, UNI_T_UT61D);
}

static int hw_init_vc820(struct sr_context *sr_ctx)
{
	return hw_init(sr_ctx, VOLTCRAFT_VC820);
}

static GSList *hw_scan(GSList *options)
{
	GSList *usb_devices, *devices, *l;
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct drv_context *drvc;
	struct sr_usb_dev_inst *usb;
	struct sr_config *src;
	struct sr_probe *probe;
	const char *conn;

	(void)options;

	drvc = di->priv;

	/* USB scan is always authoritative. */
	clear_instances();

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

	devices = NULL;
	if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
		g_slist_free_full(usb_devices, g_free);
		return NULL;
	}

	for (l = usb_devices; l; l = l->next) {
		usb = l->data;

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

		if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
				di->longname, NULL, NULL))) {
			sr_err("sr_dev_inst_new returned NULL.");
			return NULL;
		}
		sdi->priv = devc;
		sdi->driver = di;
		if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
			return NULL;
		sdi->probes = g_slist_append(sdi->probes, probe);

		devc->usb = usb;

		drvc->instances = g_slist_append(drvc->instances, sdi);
		devices = g_slist_append(devices, sdi);
	}

	return devices;
}

static GSList *hw_dev_list(void)
{
	struct drv_context *drvc;

	drvc = di->priv;

	return drvc->instances;
}

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

	drvc = di->priv;
	devc = sdi->priv;

	return sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb);
}

static int hw_dev_close(struct sr_dev_inst *sdi)
{
	(void)sdi;

	/* TODO */

	return SR_OK;
}

static int hw_cleanup(void)
{
	clear_instances();

	return SR_OK;
}

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

	devc = sdi->priv;

	switch (id) {
	case SR_CONF_LIMIT_MSEC:
		/* TODO: Not yet implemented. */
		if (*(const uint64_t *)value == 0) {
			sr_err("Time limit cannot be 0.");
			return SR_ERR;
		}
		devc->limit_msec = *(const uint64_t *)value;
		sr_dbg("Setting time limit to %" PRIu64 "ms.",
		       devc->limit_msec);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		if (*(const uint64_t *)value == 0) {
			sr_err("Sample limit cannot be 0.");
			return SR_ERR;
		}
		devc->limit_samples = *(const uint64_t *)value;
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		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)
{
	struct sr_datafeed_packet packet;
	struct sr_datafeed_header header;
	struct dev_context *devc;

	devc = sdi->priv;

	sr_dbg("Starting acquisition.");

	devc->cb_data = cb_data;

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

	if (!strcmp(di->name, "uni-t-ut61d")) {
		sr_source_add(0, 0, 10 /* poll_timeout */,
			      uni_t_ut61d_receive_data, (void *)sdi);
	} else if (!strcmp(di->name, "voltcraft-vc820")) {
		sr_source_add(0, 0, 10 /* poll_timeout */,
			      voltcraft_vc820_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;

	(void)sdi;

	sr_dbg("Stopping acquisition.");

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

	/* TODO? */
	sr_source_remove(0);

	return SR_OK;
}

SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info = {
	.name = "uni-t-ut61d",
	.longname = "UNI-T UT61D",
	.api_version = 1,
	.init = hw_init_ut61d,
	.cleanup = hw_cleanup,
	.scan = hw_scan,
	.dev_list = hw_dev_list,
	.dev_clear = clear_instances,
	.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,
	.dev_acquisition_stop = hw_dev_acquisition_stop,
	.priv = NULL,
};

SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info = {
	.name = "voltcraft-vc820",
	.longname = "Voltcraft VC-820",
	.api_version = 1,
	.init = hw_init_vc820,
	.cleanup = hw_cleanup,
	.scan = hw_scan,
	.dev_list = hw_dev_list,
	.dev_clear = clear_instances,
	.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,
	.dev_acquisition_stop = hw_dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
79081ec8 UH	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#include <stdlib.h>
	22	#include <string.h>
	23	#include "libsigrok.h"
	24	#include "libsigrok-internal.h"
	25	#include "protocol.h"
	26
388f9d3e UH	27	#define UNI_T_UT_D04_NEW "1a86.e008"
388f9d3e UH	28
73365eae	29	static const int hwopts[] = {
431ec7ca	30	SR_CONF_CONN,
73365eae UH	31	0,
	32	};
	33
79081ec8	34	static const int hwcaps[] = {
1953564a BV	35	SR_CONF_MULTIMETER,
	36	SR_CONF_LIMIT_SAMPLES,
	37	SR_CONF_LIMIT_MSEC,
	38	SR_CONF_CONTINUOUS,
79081ec8 UH	39	0,
	40	};
	41
fdbcb86d	42	SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
fdbcb86d	43	SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
6ac5f892 UH	44
6ac5f892 UH	45	static struct sr_dev_driver *di_ut61d = &uni_t_ut61d_driver_info;
fdbcb86d	46	static struct sr_dev_driver *di_vc820 = &voltcraft_vc820_driver_info;
79081ec8	47
6ac5f892 UH	48	/* After hw_init() this will point to a device-specific entry (see above). */
	49	static struct sr_dev_driver *di = NULL;
	50
79081ec8 UH	51	static int clear_instances(void)
	52	{
	53	/* TODO: Use common code later. */
	54
	55	return SR_OK;
	56	}
	57
34f06b90	58	static int hw_init(struct sr_context *sr_ctx, int dmm)
79081ec8	59	{
79081ec8 UH	60	struct drv_context *drvc;
	61
	62	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
	63	sr_err("Driver context malloc failed.");
	64	return SR_ERR_MALLOC;
	65	}
	66
fdbcb86d	67	if (dmm == UNI_T_UT61D)
6ac5f892	68	di = di_ut61d;
fdbcb86d	69	else if (dmm == VOLTCRAFT_VC820)
6ac5f892	70	di = di_vc820;
8c1adf37	71	sr_dbg("Selected '%s' subdriver.", di->name);
6ac5f892	72
1ebe4b4e	73	drvc->sr_ctx = sr_ctx;
6ac5f892	74	di->priv = drvc;
79081ec8 UH	75
	76	return SR_OK;
	77	}
	78
34f06b90	79	static int hw_init_ut61d(struct sr_context *sr_ctx)
fdbcb86d	80	{
34f06b90	81	return hw_init(sr_ctx, UNI_T_UT61D);
fdbcb86d UH	82	}
fdbcb86d UH	83
34f06b90	84	static int hw_init_vc820(struct sr_context *sr_ctx)
fdbcb86d	85	{
34f06b90	86	return hw_init(sr_ctx, VOLTCRAFT_VC820);
fdbcb86d UH	87	}
fdbcb86d UH	88
6ac5f892	89	static GSList hw_scan(GSList options)
79081ec8	90	{
388f9d3e	91	GSList usb_devices, devices, *l;
79081ec8	92	struct sr_dev_inst *sdi;
41d9427f	93	struct dev_context *devc;
79081ec8	94	struct drv_context *drvc;
388f9d3e	95	struct sr_usb_dev_inst *usb;
431ec7ca	96	struct sr_config *src;
41d9427f	97	struct sr_probe *probe;
388f9d3e	98	const char *conn;
79081ec8 UH	99
	100	(void)options;
	101
6ac5f892	102	drvc = di->priv;
79081ec8	103
388f9d3e UH	104	/* USB scan is always authoritative. */
	105	clear_instances();
	106
	107	conn = NULL;
	108	for (l = options; l; l = l->next) {
431ec7ca BV	109	src = l->data;
	110	switch (src->key) {
	111	case SR_CONF_CONN:
	112	conn = src->value;
388f9d3e UH	113	break;
	114	}
	115	}
	116	if (!conn)
	117	conn = UNI_T_UT_D04_NEW;
41d9427f	118
388f9d3e UH	119	devices = NULL;
	120	if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
	121	g_slist_free_full(usb_devices, g_free);
79081ec8	122	return NULL;
388f9d3e	123	}
79081ec8	124
388f9d3e UH	125	for (l = usb_devices; l; l = l->next) {
388f9d3e UH	126	usb = l->data;
41d9427f UH	127
	128	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	129	sr_err("Device context malloc failed.");
	130	return NULL;
	131	}
	132
388f9d3e	133	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
41d9427f UH	134	di->longname, NULL, NULL))) {
	135	sr_err("sr_dev_inst_new returned NULL.");
	136	return NULL;
	137	}
	138	sdi->priv = devc;
6ac5f892	139	sdi->driver = di;
41d9427f UH	140	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
	141	return NULL;
	142	sdi->probes = g_slist_append(sdi->probes, probe);
388f9d3e UH	143
	144	devc->usb = usb;
	145
	146	drvc->instances = g_slist_append(drvc->instances, sdi);
41d9427f	147	devices = g_slist_append(devices, sdi);
79081ec8 UH	148	}
	149
	150	return devices;
	151	}
	152
6ac5f892	153	static GSList *hw_dev_list(void)
79081ec8 UH	154	{
	155	struct drv_context *drvc;
	156
6ac5f892	157	drvc = di->priv;
79081ec8 UH	158
	159	return drvc->instances;
	160	}
	161
	162	static int hw_dev_open(struct sr_dev_inst *sdi)
	163	{
388f9d3e	164	struct drv_context *drvc;
41d9427f UH	165	struct dev_context *devc;
41d9427f UH	166
388f9d3e	167	drvc = di->priv;
41d9427f UH	168	devc = sdi->priv;
41d9427f UH	169
388f9d3e	170	return sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb);
79081ec8 UH	171	}
	172
	173	static int hw_dev_close(struct sr_dev_inst *sdi)
	174	{
	175	(void)sdi;
	176
	177	/* TODO */
	178
	179	return SR_OK;
	180	}
	181
	182	static int hw_cleanup(void)
	183	{
	184	clear_instances();
	185
79081ec8 UH	186	return SR_OK;
	187	}
	188
035a1078	189	static int config_set(int id, const void value, const struct sr_dev_inst sdi)
79081ec8 UH	190	{
	191	struct dev_context *devc;
	192
	193	devc = sdi->priv;
	194
035a1078	195	switch (id) {
1953564a	196	case SR_CONF_LIMIT_MSEC:
79081ec8 UH	197	/* TODO: Not yet implemented. */
	198	if ((const uint64_t )value == 0) {
	199	sr_err("Time limit cannot be 0.");
	200	return SR_ERR;
	201	}
	202	devc->limit_msec = (const uint64_t )value;
	203	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	204	devc->limit_msec);
	205	break;
1953564a	206	case SR_CONF_LIMIT_SAMPLES:
79081ec8 UH	207	if ((const uint64_t )value == 0) {
	208	sr_err("Sample limit cannot be 0.");
	209	return SR_ERR;
	210	}
	211	devc->limit_samples = (const uint64_t )value;
	212	sr_dbg("Setting sample limit to %" PRIu64 ".",
	213	devc->limit_samples);
	214	break;
	215	default:
035a1078	216	sr_err("Unknown capability: %d.", id);
79081ec8 UH	217	return SR_ERR;
	218	break;
	219	}
	220
	221	return SR_OK;
	222	}
	223
a1c743fc BV	224	static int config_list(int key, const void *data, const struct sr_dev_inst sdi)
	225	{
	226
	227	(void)sdi;
	228
	229	switch (key) {
0d485e30 BV	230	case SR_CONF_SCAN_OPTIONS:
	231	*data = hwopts;
	232	break;
9a6517d1 BV	233	case SR_CONF_DEVICE_OPTIONS:
	234	*data = hwcaps;
	235	break;
a1c743fc BV	236	default:
	237	return SR_ERR_ARG;
	238	}
	239
	240	return SR_OK;
	241	}
	242
79081ec8	243	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
6ac5f892	244	void *cb_data)
79081ec8 UH	245	{
	246	struct sr_datafeed_packet packet;
	247	struct sr_datafeed_header header;
79081ec8 UH	248	struct dev_context *devc;
	249
	250	devc = sdi->priv;
	251
	252	sr_dbg("Starting acquisition.");
	253
	254	devc->cb_data = cb_data;
	255
	256	/* Send header packet to the session bus. */
	257	sr_dbg("Sending SR_DF_HEADER.");
	258	packet.type = SR_DF_HEADER;
	259	packet.payload = (uint8_t *)&header;
	260	header.feed_version = 1;
	261	gettimeofday(&header.starttime, NULL);
	262	sr_session_send(devc->cb_data, &packet);
	263
6ac5f892	264	if (!strcmp(di->name, "uni-t-ut61d")) {
fdbcb86d UH	265	sr_source_add(0, 0, 10 /* poll_timeout */,
fdbcb86d UH	266	uni_t_ut61d_receive_data, (void *)sdi);
6ac5f892	267	} else if (!strcmp(di->name, "voltcraft-vc820")) {
fdbcb86d UH	268	sr_source_add(0, 0, 10 /* poll_timeout */,
	269	voltcraft_vc820_receive_data, (void *)sdi);
	270	}
79081ec8 UH	271
	272	return SR_OK;
	273	}
	274
69b07d14	275	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
79081ec8 UH	276	{
	277	struct sr_datafeed_packet packet;
	278
	279	(void)sdi;
	280
	281	sr_dbg("Stopping acquisition.");
	282
	283	/* Send end packet to the session bus. */
	284	sr_dbg("Sending SR_DF_END.");
	285	packet.type = SR_DF_END;
	286	sr_session_send(cb_data, &packet);
	287
	288	/* TODO? */
	289	sr_source_remove(0);
	290
	291	return SR_OK;
	292	}
	293
fdbcb86d UH	294	SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info = {
	295	.name = "uni-t-ut61d",
	296	.longname = "UNI-T UT61D",
	297	.api_version = 1,
	298	.init = hw_init_ut61d,
	299	.cleanup = hw_cleanup,
6ac5f892 UH	300	.scan = hw_scan,
6ac5f892 UH	301	.dev_list = hw_dev_list,
fdbcb86d	302	.dev_clear = clear_instances,
035a1078	303	.config_set = config_set,
a1c743fc	304	.config_list = config_list,
fdbcb86d UH	305	.dev_open = hw_dev_open,
fdbcb86d UH	306	.dev_close = hw_dev_close,
6ac5f892	307	.dev_acquisition_start = hw_dev_acquisition_start,
fdbcb86d UH	308	.dev_acquisition_stop = hw_dev_acquisition_stop,
	309	.priv = NULL,
	310	};
	311
	312	SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info = {
	313	.name = "voltcraft-vc820",
	314	.longname = "Voltcraft VC-820",
79081ec8	315	.api_version = 1,
fdbcb86d	316	.init = hw_init_vc820,
79081ec8	317	.cleanup = hw_cleanup,
6ac5f892 UH	318	.scan = hw_scan,
6ac5f892 UH	319	.dev_list = hw_dev_list,
79081ec8	320	.dev_clear = clear_instances,
035a1078	321	.config_set = config_set,
a1c743fc	322	.config_list = config_list,
79081ec8 UH	323	.dev_open = hw_dev_open,
79081ec8 UH	324	.dev_close = hw_dev_close,
6ac5f892	325	.dev_acquisition_start = hw_dev_acquisition_start,
79081ec8 UH	326	.dev_acquisition_stop = hw_dev_acquisition_stop,
	327	.priv = NULL,
	328	};