[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_INTERFACE 0
#define VICTOR_ENDPOINT (LIBUSB_ENDPOINT_IN | 1)

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

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

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

	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)
{
	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
}

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