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

/*
 * This file is part of the libsigrok 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 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 /* TODO */,
		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", "VC-820", 19200 /* TODO */,
		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, uddms[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;

	(void)options;

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

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