[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 hwcaps[] = {
	SR_HWCAP_MULTIMETER,
	SR_HWCAP_LIMIT_SAMPLES,
	SR_HWCAP_LIMIT_MSEC,
	SR_HWCAP_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_hwopt *opt;
	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) {
		opt = l->data;
		switch (opt->hwopt) {
		case SR_HWOPT_CONN:
			conn = opt->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 hw_info_get(int info_id, const void **data,
		       const struct sr_dev_inst *sdi)
{
	(void)sdi;

	sr_spew("Backend requested info_id %d.", info_id);

	switch (info_id) {
	case SR_DI_HWCAPS:
		*data = hwcaps;
		sr_spew("%s: Returning hwcaps.", __func__);
		break;
	case SR_DI_SAMPLERATES:
		/* TODO: Get rid of this. */
		*data = NULL;
		sr_spew("%s: Returning samplerates.", __func__);
		return SR_ERR_ARG;
		break;
	case SR_DI_CUR_SAMPLERATE:
		/* TODO: Get rid of this. */
		*data = NULL;
		sr_spew("%s: Returning current samplerate.", __func__);
		return SR_ERR_ARG;
		break;
	default:
		return SR_ERR_ARG;
		break;
	}

	return SR_OK;
}

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

	devc = sdi->priv;

	switch (hwcap) {
	case SR_HWCAP_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_HWCAP_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.", 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;

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

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

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

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,
	.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,
};
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
79081ec8 UH	29	static const int hwcaps[] = {
	30	SR_HWCAP_MULTIMETER,
	31	SR_HWCAP_LIMIT_SAMPLES,
	32	SR_HWCAP_LIMIT_MSEC,
	33	SR_HWCAP_CONTINUOUS,
	34	0,
	35	};
	36
fdbcb86d	37	SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
fdbcb86d	38	SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
6ac5f892 UH	39
6ac5f892 UH	40	static struct sr_dev_driver *di_ut61d = &uni_t_ut61d_driver_info;
fdbcb86d	41	static struct sr_dev_driver *di_vc820 = &voltcraft_vc820_driver_info;
79081ec8	42
6ac5f892 UH	43	/* After hw_init() this will point to a device-specific entry (see above). */
	44	static struct sr_dev_driver *di = NULL;
	45
79081ec8 UH	46	static int clear_instances(void)
	47	{
	48	/* TODO: Use common code later. */
	49
	50	return SR_OK;
	51	}
	52
34f06b90	53	static int hw_init(struct sr_context *sr_ctx, int dmm)
79081ec8	54	{
79081ec8 UH	55	struct drv_context *drvc;
	56
	57	if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
	58	sr_err("Driver context malloc failed.");
	59	return SR_ERR_MALLOC;
	60	}
	61
fdbcb86d	62	if (dmm == UNI_T_UT61D)
6ac5f892	63	di = di_ut61d;
fdbcb86d	64	else if (dmm == VOLTCRAFT_VC820)
6ac5f892	65	di = di_vc820;
8c1adf37	66	sr_dbg("Selected '%s' subdriver.", di->name);
6ac5f892	67
1ebe4b4e	68	drvc->sr_ctx = sr_ctx;
6ac5f892	69	di->priv = drvc;
79081ec8 UH	70
	71	return SR_OK;
	72	}
	73
34f06b90	74	static int hw_init_ut61d(struct sr_context *sr_ctx)
fdbcb86d	75	{
34f06b90	76	return hw_init(sr_ctx, UNI_T_UT61D);
fdbcb86d UH	77	}
fdbcb86d UH	78
34f06b90	79	static int hw_init_vc820(struct sr_context *sr_ctx)
fdbcb86d	80	{
34f06b90	81	return hw_init(sr_ctx, VOLTCRAFT_VC820);
fdbcb86d UH	82	}
fdbcb86d UH	83
6ac5f892	84	static GSList hw_scan(GSList options)
79081ec8	85	{
388f9d3e	86	GSList usb_devices, devices, *l;
79081ec8	87	struct sr_dev_inst *sdi;
41d9427f	88	struct dev_context *devc;
79081ec8	89	struct drv_context *drvc;
388f9d3e UH	90	struct sr_usb_dev_inst *usb;
388f9d3e UH	91	struct sr_hwopt *opt;
41d9427f	92	struct sr_probe *probe;
388f9d3e	93	const char *conn;
79081ec8 UH	94
	95	(void)options;
	96
6ac5f892	97	drvc = di->priv;
79081ec8	98
388f9d3e UH	99	/* USB scan is always authoritative. */
	100	clear_instances();
	101
	102	conn = NULL;
	103	for (l = options; l; l = l->next) {
	104	opt = l->data;
	105	switch (opt->hwopt) {
	106	case SR_HWOPT_CONN:
	107	conn = opt->value;
	108	break;
	109	}
	110	}
	111	if (!conn)
	112	conn = UNI_T_UT_D04_NEW;
41d9427f	113
388f9d3e UH	114	devices = NULL;
	115	if (!(usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
	116	g_slist_free_full(usb_devices, g_free);
79081ec8	117	return NULL;
388f9d3e	118	}
79081ec8	119
388f9d3e UH	120	for (l = usb_devices; l; l = l->next) {
388f9d3e UH	121	usb = l->data;
41d9427f UH	122
	123	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
	124	sr_err("Device context malloc failed.");
	125	return NULL;
	126	}
	127
388f9d3e	128	if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE,
41d9427f UH	129	di->longname, NULL, NULL))) {
	130	sr_err("sr_dev_inst_new returned NULL.");
	131	return NULL;
	132	}
	133	sdi->priv = devc;
6ac5f892	134	sdi->driver = di;
41d9427f UH	135	if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
	136	return NULL;
	137	sdi->probes = g_slist_append(sdi->probes, probe);
388f9d3e UH	138
	139	devc->usb = usb;
	140
	141	drvc->instances = g_slist_append(drvc->instances, sdi);
41d9427f	142	devices = g_slist_append(devices, sdi);
79081ec8 UH	143	}
	144
	145	return devices;
	146	}
	147
6ac5f892	148	static GSList *hw_dev_list(void)
79081ec8 UH	149	{
	150	struct drv_context *drvc;
	151
6ac5f892	152	drvc = di->priv;
79081ec8 UH	153
	154	return drvc->instances;
	155	}
	156
	157	static int hw_dev_open(struct sr_dev_inst *sdi)
	158	{
388f9d3e	159	struct drv_context *drvc;
41d9427f UH	160	struct dev_context *devc;
41d9427f UH	161
388f9d3e	162	drvc = di->priv;
41d9427f UH	163	devc = sdi->priv;
41d9427f UH	164
388f9d3e	165	return sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb);
79081ec8 UH	166	}
	167
	168	static int hw_dev_close(struct sr_dev_inst *sdi)
	169	{
	170	(void)sdi;
	171
	172	/* TODO */
	173
	174	return SR_OK;
	175	}
	176
	177	static int hw_cleanup(void)
	178	{
	179	clear_instances();
	180
79081ec8 UH	181	return SR_OK;
	182	}
	183
	184	static int hw_info_get(int info_id, const void **data,
	185	const struct sr_dev_inst *sdi)
	186	{
	187	(void)sdi;
	188
	189	sr_spew("Backend requested info_id %d.", info_id);
	190
	191	switch (info_id) {
	192	case SR_DI_HWCAPS:
	193	*data = hwcaps;
	194	sr_spew("%s: Returning hwcaps.", __func__);
	195	break;
79081ec8 UH	196	case SR_DI_SAMPLERATES:
	197	/* TODO: Get rid of this. */
	198	*data = NULL;
	199	sr_spew("%s: Returning samplerates.", __func__);
	200	return SR_ERR_ARG;
	201	break;
	202	case SR_DI_CUR_SAMPLERATE:
	203	/* TODO: Get rid of this. */
	204	*data = NULL;
	205	sr_spew("%s: Returning current samplerate.", __func__);
	206	return SR_ERR_ARG;
	207	break;
	208	default:
79081ec8 UH	209	return SR_ERR_ARG;
	210	break;
	211	}
	212
	213	return SR_OK;
	214	}
	215
	216	static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
	217	const void *value)
	218	{
	219	struct dev_context *devc;
	220
	221	devc = sdi->priv;
	222
	223	switch (hwcap) {
	224	case SR_HWCAP_LIMIT_MSEC:
	225	/* TODO: Not yet implemented. */
	226	if ((const uint64_t )value == 0) {
	227	sr_err("Time limit cannot be 0.");
	228	return SR_ERR;
	229	}
	230	devc->limit_msec = (const uint64_t )value;
	231	sr_dbg("Setting time limit to %" PRIu64 "ms.",
	232	devc->limit_msec);
	233	break;
	234	case SR_HWCAP_LIMIT_SAMPLES:
	235	if ((const uint64_t )value == 0) {
	236	sr_err("Sample limit cannot be 0.");
	237	return SR_ERR;
	238	}
	239	devc->limit_samples = (const uint64_t )value;
	240	sr_dbg("Setting sample limit to %" PRIu64 ".",
	241	devc->limit_samples);
	242	break;
	243	default:
	244	sr_err("Unknown capability: %d.", hwcap);
	245	return SR_ERR;
	246	break;
	247	}
	248
	249	return SR_OK;
	250	}
	251
	252	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
6ac5f892	253	void *cb_data)
79081ec8 UH	254	{
	255	struct sr_datafeed_packet packet;
	256	struct sr_datafeed_header header;
	257	struct sr_datafeed_meta_analog meta;
	258	struct dev_context *devc;
	259
	260	devc = sdi->priv;
	261
	262	sr_dbg("Starting acquisition.");
	263
	264	devc->cb_data = cb_data;
	265
	266	/* Send header packet to the session bus. */
	267	sr_dbg("Sending SR_DF_HEADER.");
	268	packet.type = SR_DF_HEADER;
	269	packet.payload = (uint8_t *)&header;
	270	header.feed_version = 1;
	271	gettimeofday(&header.starttime, NULL);
	272	sr_session_send(devc->cb_data, &packet);
	273
	274	/* Send metadata about the SR_DF_ANALOG packets to come. */
	275	sr_dbg("Sending SR_DF_META_ANALOG.");
	276	packet.type = SR_DF_META_ANALOG;
	277	packet.payload = &meta;
	278	meta.num_probes = 1;
	279	sr_session_send(devc->cb_data, &packet);
	280
6ac5f892	281	if (!strcmp(di->name, "uni-t-ut61d")) {
fdbcb86d UH	282	sr_source_add(0, 0, 10 /* poll_timeout */,
fdbcb86d UH	283	uni_t_ut61d_receive_data, (void *)sdi);
6ac5f892	284	} else if (!strcmp(di->name, "voltcraft-vc820")) {
fdbcb86d UH	285	sr_source_add(0, 0, 10 /* poll_timeout */,
	286	voltcraft_vc820_receive_data, (void *)sdi);
	287	}
79081ec8 UH	288
	289	return SR_OK;
	290	}
	291
69b07d14	292	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
79081ec8 UH	293	{
	294	struct sr_datafeed_packet packet;
	295
	296	(void)sdi;
	297
	298	sr_dbg("Stopping acquisition.");
	299
	300	/* Send end packet to the session bus. */
	301	sr_dbg("Sending SR_DF_END.");
	302	packet.type = SR_DF_END;
	303	sr_session_send(cb_data, &packet);
	304
	305	/* TODO? */
	306	sr_source_remove(0);
	307
	308	return SR_OK;
	309	}
	310
fdbcb86d UH	311	SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info = {
	312	.name = "uni-t-ut61d",
	313	.longname = "UNI-T UT61D",
	314	.api_version = 1,
	315	.init = hw_init_ut61d,
	316	.cleanup = hw_cleanup,
6ac5f892 UH	317	.scan = hw_scan,
6ac5f892 UH	318	.dev_list = hw_dev_list,
fdbcb86d UH	319	.dev_clear = clear_instances,
	320	.dev_open = hw_dev_open,
	321	.dev_close = hw_dev_close,
	322	.info_get = hw_info_get,
	323	.dev_config_set = hw_dev_config_set,
6ac5f892	324	.dev_acquisition_start = hw_dev_acquisition_start,
fdbcb86d UH	325	.dev_acquisition_stop = hw_dev_acquisition_stop,
	326	.priv = NULL,
	327	};
	328
	329	SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info = {
	330	.name = "voltcraft-vc820",
	331	.longname = "Voltcraft VC-820",
79081ec8	332	.api_version = 1,
fdbcb86d	333	.init = hw_init_vc820,
79081ec8	334	.cleanup = hw_cleanup,
6ac5f892 UH	335	.scan = hw_scan,
6ac5f892 UH	336	.dev_list = hw_dev_list,
79081ec8 UH	337	.dev_clear = clear_instances,
	338	.dev_open = hw_dev_open,
	339	.dev_close = hw_dev_close,
	340	.info_get = hw_info_get,
	341	.dev_config_set = hw_dev_config_set,
6ac5f892	342	.dev_acquisition_start = hw_dev_acquisition_start,
79081ec8 UH	343	.dev_acquisition_stop = hw_dev_acquisition_stop,
	344	.priv = NULL,
	345	};