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

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012-2013 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 int32_t hwopts[] = {
	SR_CONF_CONN,
};

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 uni_t_ut61d_driver_info;
SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;

SR_PRIV struct dmm_info udmms[] = {
	{
		"UNI-T", "UT61D", 19230,
		FS9922_PACKET_SIZE, NULL,
		sr_fs9922_packet_valid, sr_fs9922_parse,
		NULL,
		&uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
	},
	{
		"Voltcraft", "VC-820", 2400,
		FS9721_PACKET_SIZE, NULL,
		sr_fs9721_packet_valid, sr_fs9721_parse,
		NULL,
		&voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
	},
};

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

	/* TODO: Use common code later. */

	return SR_OK;
}

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

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

static GSList *hw_scan(GSList *options, int dmm)
{
	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;

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

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

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

		devc->first_run = TRUE;

		if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
				udmms[dmm].vendor, udmms[dmm].device, NULL))) {
			sr_err("sr_dev_inst_new returned NULL.");
			return NULL;
		}
		sdi->priv = devc;
		sdi->driver = udmms[dmm].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(int dmm)
{
	return ((struct drv_context *)(udmms[dmm].di->priv))->instances;
}

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

	drvc = udmms[dmm].di->priv;
	devc = sdi->priv;

	if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb)) == SR_OK)
		sdi->status = SR_ST_ACTIVE;

	return ret;
}

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

	/* TODO */

	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;

	devc = sdi->priv;

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

	devc = sdi->priv;

	devc->cb_data = cb_data;

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

	sr_source_add(0, 0, 10 /* poll_timeout */,
		      udmms[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;

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

/* 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); }
#define HW_DEV_OPEN(X) \
static int hw_dev_open_##X(struct sr_dev_inst *sdi) { return hw_dev_open(sdi, 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) \
HW_DEV_OPEN(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_##ID_UPPER, \
	.dev_close = hw_dev_close, \
	.dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
	.dev_acquisition_stop = hw_dev_acquisition_stop, \
	.priv = NULL, \
};

DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2012-2013 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
	27	#define UNI_T_UT_D04_NEW "1a86.e008"
	28
	29	static const int32_t hwopts[] = {
	30	SR_CONF_CONN,
	31	};
	32
	33	static const int32_t hwcaps[] = {
	34	SR_CONF_MULTIMETER,
	35	SR_CONF_LIMIT_SAMPLES,
	36	SR_CONF_LIMIT_MSEC,
	37	SR_CONF_CONTINUOUS,
	38	};
	39
	40	SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
	41	SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
	42
	43	SR_PRIV struct dmm_info udmms[] = {
	44	{
	45	"UNI-T", "UT61D", 19230,
	46	FS9922_PACKET_SIZE, NULL,
	47	sr_fs9922_packet_valid, sr_fs9922_parse,
	48	NULL,
	49	&uni_t_ut61d_driver_info, receive_data_UNI_T_UT61D,
	50	},
	51	{
	52	"Voltcraft", "VC-820", 2400,
	53	FS9721_PACKET_SIZE, NULL,
	54	sr_fs9721_packet_valid, sr_fs9721_parse,
	55	NULL,
	56	&voltcraft_vc820_driver_info, receive_data_VOLTCRAFT_VC820,
	57	},
	58	};
	59
	60	static int clear_instances(int dmm)
	61	{
	62	(void)dmm;
	63
	64	/* TODO: Use common code later. */
	65
	66	return SR_OK;
	67	}
	68
	69	static int hw_init(struct sr_context *sr_ctx, int dmm)
	70	{
	71	sr_dbg("Selected '%s' subdriver.", udmms[dmm].di->name);
	72
	73	return std_hw_init(sr_ctx, udmms[dmm].di, DRIVER_LOG_DOMAIN);
	74	}
	75
	76	static GSList hw_scan(GSList options, int dmm)
	77	{
	78	GSList usb_devices, devices, *l;
	79	struct sr_dev_inst *sdi;
	80	struct dev_context *devc;
	81	struct drv_context *drvc;
	82	struct sr_usb_dev_inst *usb;
	83	struct sr_config *src;
	84	struct sr_probe *probe;
	85	const char *conn;
	86
	87	drvc = udmms[dmm].di->priv;
	88
	89	/* USB scan is always authoritative. */
	90	clear_instances(dmm);
	91
	92	conn = NULL;
	93	for (l = options; l; l = l->next) {
	94	src = l->data;
	95	switch (src->key) {
	96	case SR_CONF_CONN:
	97	conn = g_variant_get_string(src->data, NULL);
	98	break;
	99	}
	100	}
	101	if (!conn)
	102	conn = UNI_T_UT_D04_NEW;
	103
	104	devices = NULL;
	105	if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
	106	g_slist_free_full(usb_devices, g_free);
	107	return NULL;
	108	}
	109
	110	for (l = usb_devices; l; l = l->next) {
	111	usb = l->data;
	112
	113	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	114	sr_err("Device context malloc failed.");
	115	return NULL;
	116	}
	117
	118	devc->first_run = TRUE;
	119
	120	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
	121	udmms[dmm].vendor, udmms[dmm].device, NULL))) {
	122	sr_err("sr_dev_inst_new returned NULL.");
	123	return NULL;
	124	}
	125	sdi->priv = devc;
	126	sdi->driver = udmms[dmm].di;
	127	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
	128	return NULL;
	129	sdi->probes = g_slist_append(sdi->probes, probe);
	130
	131	devc->usb = usb;
	132
	133	drvc->instances = g_slist_append(drvc->instances, sdi);
	134	devices = g_slist_append(devices, sdi);
	135	}
	136
	137	return devices;
	138	}
	139
	140	static GSList *hw_dev_list(int dmm)
	141	{
	142	return ((struct drv_context *)(udmms[dmm].di->priv))->instances;
	143	}
	144
	145	static int hw_dev_open(struct sr_dev_inst *sdi, int dmm)
	146	{
	147	struct drv_context *drvc;
	148	struct dev_context *devc;
	149	int ret;
	150
	151	drvc = udmms[dmm].di->priv;
	152	devc = sdi->priv;
	153
	154	if ((ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb)) == SR_OK)
	155	sdi->status = SR_ST_ACTIVE;
	156
	157	return ret;
	158	}
	159
	160	static int hw_dev_close(struct sr_dev_inst *sdi)
	161	{
	162	(void)sdi;
	163
	164	/* TODO */
	165
	166	sdi->status = SR_ST_INACTIVE;
	167
	168	return SR_OK;
	169	}
	170
	171	static int hw_cleanup(int dmm)
	172	{
	173	clear_instances(dmm);
	174
	175	return SR_OK;
	176	}
	177
	178	static int config_set(int id, GVariant data, const struct sr_dev_inst sdi)
	179	{
	180	struct dev_context *devc;
	181
	182	devc = sdi->priv;
	183
	184	switch (id) {
	185	case SR_CONF_LIMIT_MSEC:
	186	/* TODO: Not yet implemented. */
	187	if (g_variant_get_uint64(data) == 0) {
	188	sr_err("Time limit cannot be 0.");
	189	return SR_ERR;
	190	}
	191	devc->limit_msec = g_variant_get_uint64(data);
	192	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	193	devc->limit_msec);
	194	break;
	195	case SR_CONF_LIMIT_SAMPLES:
	196	if (g_variant_get_uint64(data) == 0) {
	197	sr_err("Sample limit cannot be 0.");
	198	return SR_ERR;
	199	}
	200	devc->limit_samples = g_variant_get_uint64(data);
	201	sr_dbg("Setting sample limit to %" PRIu64 ".",
	202	devc->limit_samples);
	203	break;
	204	default:
	205	return SR_ERR_NA;
	206	}
	207
	208	return SR_OK;
	209	}
	210
	211	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi)
	212	{
	213	(void)sdi;
	214
	215	switch (key) {
	216	case SR_CONF_SCAN_OPTIONS:
	217	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	218	hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
	219	break;
	220	case SR_CONF_DEVICE_OPTIONS:
	221	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	222	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
	223	break;
	224	default:
	225	return SR_ERR_NA;
	226	}
	227
	228	return SR_OK;
	229	}
	230
	231	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	232	void *cb_data, int dmm)
	233	{
	234	struct dev_context *devc;
	235
	236	devc = sdi->priv;
	237
	238	devc->cb_data = cb_data;
	239
	240	/* Send header packet to the session bus. */
	241	std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
	242
	243	sr_source_add(0, 0, 10 /* poll_timeout */,
	244	udmms[dmm].receive_data, (void *)sdi);
	245
	246	return SR_OK;
	247	}
	248
	249	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	250	{
	251	struct sr_datafeed_packet packet;
	252
	253	(void)sdi;
	254
	255	sr_dbg("Stopping acquisition.");
	256
	257	/* Send end packet to the session bus. */
	258	sr_dbg("Sending SR_DF_END.");
	259	packet.type = SR_DF_END;
	260	sr_session_send(cb_data, &packet);
	261
	262	/* TODO? */
	263	sr_source_remove(0);
	264
	265	return SR_OK;
	266	}
	267
	268	/* Driver-specific API function wrappers */
	269	#define HW_INIT(X) \
	270	static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
	271	#define HW_CLEANUP(X) \
	272	static int hw_cleanup_##X(void) { return hw_cleanup(X); }
	273	#define HW_SCAN(X) \
	274	static GSList hw_scan_##X(GSList options) { return hw_scan(options, X); }
	275	#define HW_DEV_LIST(X) \
	276	static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
	277	#define CLEAR_INSTANCES(X) \
	278	static int clear_instances_##X(void) { return clear_instances(X); }
	279	#define HW_DEV_ACQUISITION_START(X) \
	280	static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
	281	void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
	282	#define HW_DEV_OPEN(X) \
	283	static int hw_dev_open_##X(struct sr_dev_inst *sdi) { return hw_dev_open(sdi, X); }
	284
	285	/* Driver structs and API function wrappers */
	286	#define DRV(ID, ID_UPPER, NAME, LONGNAME) \
	287	HW_INIT(ID_UPPER) \
	288	HW_CLEANUP(ID_UPPER) \
	289	HW_SCAN(ID_UPPER) \
	290	HW_DEV_LIST(ID_UPPER) \
	291	CLEAR_INSTANCES(ID_UPPER) \
	292	HW_DEV_ACQUISITION_START(ID_UPPER) \
	293	HW_DEV_OPEN(ID_UPPER) \
	294	SR_PRIV struct sr_dev_driver ID##_driver_info = { \
	295	.name = NAME, \
	296	.longname = LONGNAME, \
	297	.api_version = 1, \
	298	.init = hw_init_##ID_UPPER, \
	299	.cleanup = hw_cleanup_##ID_UPPER, \
	300	.scan = hw_scan_##ID_UPPER, \
	301	.dev_list = hw_dev_list_##ID_UPPER, \
	302	.dev_clear = clear_instances_##ID_UPPER, \
	303	.config_get = NULL, \
	304	.config_set = config_set, \
	305	.config_list = config_list, \
	306	.dev_open = hw_dev_open_##ID_UPPER, \
	307	.dev_close = hw_dev_close, \
	308	.dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
	309	.dev_acquisition_stop = hw_dev_acquisition_stop, \
	310	.priv = NULL, \
	311	};
	312
	313	DRV(uni_t_ut61d, UNI_T_UT61D, "uni-t-ut61d", "UNI-T UT61D")
	314	DRV(voltcraft_vc820, VOLTCRAFT_VC820, "voltcraft-vc820", "Voltcraft VC-820")