[libsigrok.git] / src / hardware / victor-dmm / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <glib.h>
#include <libusb.h>
#include <stdlib.h>
#include <string.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "protocol.h"

#define VICTOR_VID 0x1244
#define VICTOR_PID 0xd237
#define VICTOR_VENDOR "Victor"
#define VICTOR_INTERFACE 0
#define VICTOR_ENDPOINT (LIBUSB_ENDPOINT_IN | 1)

static const uint32_t drvopts[] = {
	SR_CONF_MULTIMETER,
};

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
};

static const uint32_t devopts[] = {
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_SET,
	SR_CONF_CONN | SR_CONF_GET,
};

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct libusb_device_descriptor des;
	libusb_device **devlist;
	GSList *devices;
	int i;
	char connection_id[64];

	(void)options;

	drvc = di->context;

	devices = NULL;
	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	for (i = 0; devlist[i]; i++) {
		libusb_get_device_descriptor(devlist[i], &des);

		if (des.idVendor != VICTOR_VID || des.idProduct != VICTOR_PID)
			continue;

		usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));

		sdi = g_malloc0(sizeof(struct sr_dev_inst));
		sdi->status = SR_ST_INACTIVE;
		sdi->vendor = g_strdup(VICTOR_VENDOR);
		sdi->connection_id = g_strdup(connection_id);
		devc = g_malloc0(sizeof(struct dev_context));
		sr_sw_limits_init(&devc->limits);
		sdi->priv = devc;

		sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
		sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
				libusb_get_device_address(devlist[i]), NULL);
		sdi->inst_type = SR_INST_USB;

		devices = g_slist_append(devices, sdi);
	}
	libusb_free_device_list(devlist, 1);

	return std_scan_complete(di, devices);
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di = sdi->driver;
	struct drv_context *drvc = di->context;
	struct sr_usb_dev_inst *usb;
	int ret;

	usb = sdi->conn;

	ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
	if (ret != SR_OK)
		return ret;

	/* The device reports as HID class, so the kernel would have
	 * claimed it. */
	if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
		if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
			sr_err("Failed to detach kernel driver: %s.",
			       libusb_error_name(ret));
			return SR_ERR;
		}
	}

	if ((ret = libusb_claim_interface(usb->devhdl,
			VICTOR_INTERFACE))) {
		sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
		return SR_ERR;
	}

	return SR_OK;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_usb_dev_inst *usb;

	usb = sdi->conn;

	if (!usb->devhdl)
		return SR_ERR_BUG;

	libusb_release_interface(usb->devhdl, VICTOR_INTERFACE);
	libusb_close(usb->devhdl);
	usb->devhdl = NULL;

	return SR_OK;
}

static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc = sdi->priv;
	struct sr_usb_dev_inst *usb;
	char str[128];

	(void)cg;

	switch (key) {
	case SR_CONF_CONN:
		if (!sdi || !sdi->conn)
			return SR_ERR_ARG;
		usb = sdi->conn;
		snprintf(str, 128, "%d.%d", usb->bus, usb->address);
		*data = g_variant_new_string(str);
		break;
	case SR_CONF_LIMIT_SAMPLES:
	case SR_CONF_LIMIT_MSEC:
		return sr_sw_limits_config_get(&devc->limits, key, data);
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	(void)cg;

	devc = sdi->priv;

	return sr_sw_limits_config_set(&devc->limits, key, data);
}

static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		if (!sdi)
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
					drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
		else
			*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
					devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
{
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	int ret;

	sdi = transfer->user_data;
	devc = sdi->priv;
	if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
		/* USB device was unplugged. */
		sr_dev_acquisition_stop(sdi);
	} else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
		sr_dbg("Got %d-byte packet.", transfer->actual_length);
		if (transfer->actual_length == DMM_DATA_SIZE) {
			victor_dmm_receive_data(sdi, transfer->buffer);
			if (sr_sw_limits_check(&devc->limits))
				sr_dev_acquisition_stop(sdi);
		}
	}
	/* Anything else is either an error or a timeout, which is fine:
	 * we were just going to send another transfer request anyway. */

	if (sdi->status == SR_ST_ACTIVE) {
		/* Send the same request again. */
		if ((ret = libusb_submit_transfer(transfer) != 0)) {
			sr_err("Unable to resubmit transfer: %s.",
			       libusb_error_name(ret));
			g_free(transfer->buffer);
			libusb_free_transfer(transfer);
			sr_dev_acquisition_stop(sdi);
		}
	} else {
		/* This was the last transfer we're going to receive, so
		 * clean up now. */
		g_free(transfer->buffer);
		libusb_free_transfer(transfer);
	}
}

static int handle_events(int fd, int revents, void *cb_data)
{
	struct dev_context *devc;
	struct drv_context *drvc;
	struct sr_dev_inst *sdi;
	struct sr_dev_driver *di;
	struct timeval tv;

	(void)fd;
	(void)revents;

	sdi = cb_data;
	devc = sdi->priv;
	di = sdi->driver;
	drvc = di->context;

	if (sr_sw_limits_check(&devc->limits))
		sr_dev_acquisition_stop(sdi);

	if (sdi->status == SR_ST_STOPPING) {
		usb_source_remove(sdi->session, drvc->sr_ctx);
		dev_close(sdi);
		std_session_send_df_end(sdi);
	}

	memset(&tv, 0, sizeof(struct timeval));
	libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
					       NULL);

	return TRUE;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di = sdi->driver;
	struct drv_context *drvc = di->context;
	struct sr_usb_dev_inst *usb;
	struct libusb_transfer *transfer;
	int ret;
	unsigned char *buf;

	usb = sdi->conn;

	std_session_send_df_header(sdi);

	usb_source_add(sdi->session, drvc->sr_ctx, 100,
			handle_events, (void *)sdi);

	buf = g_malloc(DMM_DATA_SIZE);
	transfer = libusb_alloc_transfer(0);
	/* Each transfer request gets 100ms to arrive before it's restarted.
	 * The device only sends 1 transfer/second no matter how many
	 * times you ask, but we want to keep step with the USB events
	 * handling above. */
	libusb_fill_interrupt_transfer(transfer, usb->devhdl,
			VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
			(struct sr_dev_inst *)sdi, 100);
	if ((ret = libusb_submit_transfer(transfer) != 0)) {
		sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
		libusb_free_transfer(transfer);
		g_free(buf);
		return SR_ERR;
	}

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	sdi->status = SR_ST_STOPPING;

	return SR_OK;
}

static struct sr_dev_driver victor_dmm_driver_info = {
	.name = "victor-dmm",
	.longname = "Victor DMMs",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = NULL,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(victor_dmm_driver_info);
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
	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 3 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, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#include <config.h>
	21	#include <glib.h>
	22	#include <libusb.h>
	23	#include <stdlib.h>
	24	#include <string.h>
	25	#include <libsigrok/libsigrok.h>
	26	#include "libsigrok-internal.h"
	27	#include "protocol.h"
	28
	29	#define VICTOR_VID 0x1244
	30	#define VICTOR_PID 0xd237
	31	#define VICTOR_VENDOR "Victor"
	32	#define VICTOR_INTERFACE 0
	33	#define VICTOR_ENDPOINT (LIBUSB_ENDPOINT_IN \| 1)
	34
	35	static const uint32_t drvopts[] = {
	36	SR_CONF_MULTIMETER,
	37	};
	38
	39	static const uint32_t scanopts[] = {
	40	SR_CONF_CONN,
	41	};
	42
	43	static const uint32_t devopts[] = {
	44	SR_CONF_CONTINUOUS,
	45	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
	46	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
	47	SR_CONF_CONN \| SR_CONF_GET,
	48	};
	49
	50	static GSList scan(struct sr_dev_driver di, GSList *options)
	51	{
	52	struct drv_context *drvc;
	53	struct dev_context *devc;
	54	struct sr_dev_inst *sdi;
	55	struct libusb_device_descriptor des;
	56	libusb_device **devlist;
	57	GSList *devices;
	58	int i;
	59	char connection_id[64];
	60
	61	(void)options;
	62
	63	drvc = di->context;
	64
	65	devices = NULL;
	66	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	67	for (i = 0; devlist[i]; i++) {
	68	libusb_get_device_descriptor(devlist[i], &des);
	69
	70	if (des.idVendor != VICTOR_VID \|\| des.idProduct != VICTOR_PID)
	71	continue;
	72
	73	usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
	74
	75	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	76	sdi->status = SR_ST_INACTIVE;
	77	sdi->vendor = g_strdup(VICTOR_VENDOR);
	78	sdi->connection_id = g_strdup(connection_id);
	79	devc = g_malloc0(sizeof(struct dev_context));
	80	sr_sw_limits_init(&devc->limits);
	81	sdi->priv = devc;
	82
	83	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
	84	sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
	85	libusb_get_device_address(devlist[i]), NULL);
	86	sdi->inst_type = SR_INST_USB;
	87
	88	devices = g_slist_append(devices, sdi);
	89	}
	90	libusb_free_device_list(devlist, 1);
	91
	92	return std_scan_complete(di, devices);
	93	}
	94
	95	static int dev_open(struct sr_dev_inst *sdi)
	96	{
	97	struct sr_dev_driver *di = sdi->driver;
	98	struct drv_context *drvc = di->context;
	99	struct sr_usb_dev_inst *usb;
	100	int ret;
	101
	102	usb = sdi->conn;
	103
	104	ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
	105	if (ret != SR_OK)
	106	return ret;
	107
	108	/* The device reports as HID class, so the kernel would have
	109	* claimed it. */
	110	if (libusb_kernel_driver_active(usb->devhdl, 0) == 1) {
	111	if ((ret = libusb_detach_kernel_driver(usb->devhdl, 0)) < 0) {
	112	sr_err("Failed to detach kernel driver: %s.",
	113	libusb_error_name(ret));
	114	return SR_ERR;
	115	}
	116	}
	117
	118	if ((ret = libusb_claim_interface(usb->devhdl,
	119	VICTOR_INTERFACE))) {
	120	sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
	121	return SR_ERR;
	122	}
	123
	124	return SR_OK;
	125	}
	126
	127	static int dev_close(struct sr_dev_inst *sdi)
	128	{
	129	struct sr_usb_dev_inst *usb;
	130
	131	usb = sdi->conn;
	132
	133	if (!usb->devhdl)
	134	return SR_ERR_BUG;
	135
	136	libusb_release_interface(usb->devhdl, VICTOR_INTERFACE);
	137	libusb_close(usb->devhdl);
	138	usb->devhdl = NULL;
	139
	140	return SR_OK;
	141	}
	142
	143	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	144	const struct sr_channel_group *cg)
	145	{
	146	struct dev_context *devc = sdi->priv;
	147	struct sr_usb_dev_inst *usb;
	148	char str[128];
	149
	150	(void)cg;
	151
	152	switch (key) {
	153	case SR_CONF_CONN:
	154	if (!sdi \|\| !sdi->conn)
	155	return SR_ERR_ARG;
	156	usb = sdi->conn;
	157	snprintf(str, 128, "%d.%d", usb->bus, usb->address);
	158	*data = g_variant_new_string(str);
	159	break;
	160	case SR_CONF_LIMIT_SAMPLES:
	161	case SR_CONF_LIMIT_MSEC:
	162	return sr_sw_limits_config_get(&devc->limits, key, data);
	163	default:
	164	return SR_ERR_NA;
	165	}
	166
	167	return SR_OK;
	168	}
	169
	170	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	171	const struct sr_channel_group *cg)
	172	{
	173	struct dev_context *devc;
	174
	175	(void)cg;
	176
	177	devc = sdi->priv;
	178
	179	return sr_sw_limits_config_set(&devc->limits, key, data);
	180	}
	181
	182	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	183	const struct sr_channel_group *cg)
	184	{
	185	(void)sdi;
	186	(void)cg;
	187
	188	switch (key) {
	189	case SR_CONF_SCAN_OPTIONS:
	190	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	191	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	192	break;
	193	case SR_CONF_DEVICE_OPTIONS:
	194	if (!sdi)
	195	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	196	drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
	197	else
	198	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	199	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	200	break;
	201	default:
	202	return SR_ERR_NA;
	203	}
	204
	205	return SR_OK;
	206	}
	207
	208	static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
	209	{
	210	struct dev_context *devc;
	211	struct sr_dev_inst *sdi;
	212	int ret;
	213
	214	sdi = transfer->user_data;
	215	devc = sdi->priv;
	216	if (transfer->status == LIBUSB_TRANSFER_NO_DEVICE) {
	217	/* USB device was unplugged. */
	218	sr_dev_acquisition_stop(sdi);
	219	} else if (transfer->status == LIBUSB_TRANSFER_COMPLETED) {
	220	sr_dbg("Got %d-byte packet.", transfer->actual_length);
	221	if (transfer->actual_length == DMM_DATA_SIZE) {
	222	victor_dmm_receive_data(sdi, transfer->buffer);
	223	if (sr_sw_limits_check(&devc->limits))
	224	sr_dev_acquisition_stop(sdi);
	225	}
	226	}
	227	/* Anything else is either an error or a timeout, which is fine:
	228	* we were just going to send another transfer request anyway. */
	229
	230	if (sdi->status == SR_ST_ACTIVE) {
	231	/* Send the same request again. */
	232	if ((ret = libusb_submit_transfer(transfer) != 0)) {
	233	sr_err("Unable to resubmit transfer: %s.",
	234	libusb_error_name(ret));
	235	g_free(transfer->buffer);
	236	libusb_free_transfer(transfer);
	237	sr_dev_acquisition_stop(sdi);
	238	}
	239	} else {
	240	/* This was the last transfer we're going to receive, so
	241	* clean up now. */
	242	g_free(transfer->buffer);
	243	libusb_free_transfer(transfer);
	244	}
	245	}
	246
	247	static int handle_events(int fd, int revents, void *cb_data)
	248	{
	249	struct dev_context *devc;
	250	struct drv_context *drvc;
	251	struct sr_dev_inst *sdi;
	252	struct sr_dev_driver *di;
	253	struct timeval tv;
	254
	255	(void)fd;
	256	(void)revents;
	257
	258	sdi = cb_data;
	259	devc = sdi->priv;
	260	di = sdi->driver;
	261	drvc = di->context;
	262
	263	if (sr_sw_limits_check(&devc->limits))
	264	sr_dev_acquisition_stop(sdi);
	265
	266	if (sdi->status == SR_ST_STOPPING) {
	267	usb_source_remove(sdi->session, drvc->sr_ctx);
	268	dev_close(sdi);
	269	std_session_send_df_end(sdi);
	270	}
	271
	272	memset(&tv, 0, sizeof(struct timeval));
	273	libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
	274	NULL);
	275
	276	return TRUE;
	277	}
	278
	279	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	280	{
	281	struct sr_dev_driver *di = sdi->driver;
	282	struct drv_context *drvc = di->context;
	283	struct sr_usb_dev_inst *usb;
	284	struct libusb_transfer *transfer;
	285	int ret;
	286	unsigned char *buf;
	287
	288	usb = sdi->conn;
	289
	290	std_session_send_df_header(sdi);
	291
	292	usb_source_add(sdi->session, drvc->sr_ctx, 100,
	293	handle_events, (void *)sdi);
	294
	295	buf = g_malloc(DMM_DATA_SIZE);
	296	transfer = libusb_alloc_transfer(0);
	297	/* Each transfer request gets 100ms to arrive before it's restarted.
	298	* The device only sends 1 transfer/second no matter how many
	299	* times you ask, but we want to keep step with the USB events
	300	* handling above. */
	301	libusb_fill_interrupt_transfer(transfer, usb->devhdl,
	302	VICTOR_ENDPOINT, buf, DMM_DATA_SIZE, receive_transfer,
	303	(struct sr_dev_inst *)sdi, 100);
	304	if ((ret = libusb_submit_transfer(transfer) != 0)) {
	305	sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
	306	libusb_free_transfer(transfer);
	307	g_free(buf);
	308	return SR_ERR;
	309	}
	310
	311	return SR_OK;
	312	}
	313
	314	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	315	{
	316	sdi->status = SR_ST_STOPPING;
	317
	318	return SR_OK;
	319	}
	320
	321	static struct sr_dev_driver victor_dmm_driver_info = {
	322	.name = "victor-dmm",
	323	.longname = "Victor DMMs",
	324	.api_version = 1,
	325	.init = std_init,
	326	.cleanup = std_cleanup,
	327	.scan = scan,
	328	.dev_list = std_dev_list,
	329	.dev_clear = NULL,
	330	.config_get = config_get,
	331	.config_set = config_set,
	332	.config_list = config_list,
	333	.dev_open = dev_open,
	334	.dev_close = dev_close,
	335	.dev_acquisition_start = dev_acquisition_start,
	336	.dev_acquisition_stop = dev_acquisition_stop,
	337	.context = NULL,
	338	};
	339	SR_REGISTER_DEV_DRIVER(victor_dmm_driver_info);