[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"

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

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

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 *devices, *l;
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	struct drv_context *drvc;
	struct sr_probe *probe;
	struct libusb_device *ldev;
	int i, devcnt;

	(void)options;

	drvc = di->priv;

	devices = NULL;

	if (!(l = sr_usb_find(drvc->sr_ctx->libusb_ctx, "1a86.e008")))
		return NULL;

	for (i = 0; i < (int)g_slist_length(l); i++) {
		ldev = (struct libusb_device *)l->data;

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

		devcnt = g_slist_length(drvc->instances);
		if (!(sdi = sr_dev_inst_new(devcnt, 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 = sr_usb_dev_inst_new(
				libusb_get_bus_number(ldev),
				libusb_get_device_address(ldev), NULL);
		drvc->instances = g_slist_append(drvc->instances, l->data);
		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 dev_context *devc;

	devc = sdi->priv;

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