[libsigrok.git] / src / hardware / kecheng-kc-330b / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 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 <string.h>
#include "protocol.h"

#define USB_CONN "1041.8101"
#define VENDOR "Kecheng"
#define USB_INTERFACE 0

static const uint32_t devopts[] = {
	SR_CONF_SOUNDLEVELMETER,
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_SAMPLE_INTERVAL | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_DATALOG | SR_CONF_GET,
	SR_CONF_SPL_WEIGHT_FREQ | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_SPL_WEIGHT_TIME | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_DATA_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
	{ 1, 8 },
	{ 1, 2 },
	{ 1, 1 },
	{ 2, 1 },
	{ 5, 1 },
	{ 10, 1 },
	{ 60, 1 },
};

static const char *weight_freq[] = {
	"A",
	"C",
};

static const char *weight_time[] = {
	"F",
	"S",
};

static const char *data_sources[] = {
	"Live",
	"Memory",
};

static int scan_kecheng(struct sr_dev_driver *di,
		struct sr_usb_dev_inst *usb, char **model)
{
	struct drv_context *drvc;
	int len, ret;
	unsigned char cmd, buf[32];

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

	cmd = CMD_IDENTIFY;
	ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
	if (ret != 0) {
		libusb_close(usb->devhdl);
		sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
		return SR_ERR;
	}

	ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
	if (ret != 0) {
		libusb_close(usb->devhdl);
		sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
		return SR_ERR;
	}

	libusb_close(usb->devhdl);
	usb->devhdl = NULL;

	if (len < 2 || buf[0] != (CMD_IDENTIFY | 0x80) || buf[1] > 30) {
		sr_dbg("Invalid response to Identify command");
		return SR_ERR;
	}

	buf[buf[1] + 2] = '\x0';
	*model = g_strndup((const gchar *)buf + 2, 30);

	return SR_OK;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	GSList *usb_devices, *devices, *l;
	char *model;

	(void)options;

	drvc = di->context;
	drvc->instances = NULL;

	devices = NULL;
	if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
		/* We have a list of sr_usb_dev_inst matching the connection
		 * string. Wrap them in sr_dev_inst and we're done. */
		for (l = usb_devices; l; l = l->next) {
			if (scan_kecheng(di, l->data, &model) != SR_OK)
				continue;
			sdi = g_malloc0(sizeof(struct sr_dev_inst));
			sdi->status = SR_ST_INACTIVE;
			sdi->vendor = g_strdup(VENDOR);
			sdi->model = model; /* Already g_strndup()'d. */
			sdi->driver = di;
			sdi->inst_type = SR_INST_USB;
			sdi->conn = l->data;
			sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
			devc = g_malloc0(sizeof(struct dev_context));
			sdi->priv = devc;
			devc->limit_samples = 0;
			/* The protocol provides no way to read the current
			 * settings, so we'll enforce these. */
			devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
			devc->alarm_low = DEFAULT_ALARM_LOW;
			devc->alarm_high = DEFAULT_ALARM_HIGH;
			devc->mqflags = DEFAULT_WEIGHT_TIME | DEFAULT_WEIGHT_FREQ;
			devc->data_source = DEFAULT_DATA_SOURCE;
			devc->config_dirty = FALSE;

			/* TODO: Set date/time? */

			drvc->instances = g_slist_append(drvc->instances, sdi);
			devices = g_slist_append(devices, sdi);
		}
		g_slist_free(usb_devices);
	} else
		g_slist_free_full(usb_devices, g_free);

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

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

	if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
		sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
		return SR_ERR;
	}

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

	return ret;
}

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

	usb = sdi->conn;

	if (!usb->devhdl)
		/*  Nothing to do. */
		return SR_OK;

	/* This allows a frontend to configure the device without ever
	 * doing an acquisition step. */
	devc = sdi->priv;
	if (!devc->config_dirty)
		kecheng_kc_330b_configure(sdi);

	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	libusb_close(usb->devhdl);
	usb->devhdl = NULL;
	sdi->status = SR_ST_INACTIVE;

	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;
	GVariant *rational[2];
	const uint64_t *si;

	(void)cg;

	devc = sdi->priv;
	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_SAMPLE_INTERVAL:
		si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
		rational[0] = g_variant_new_uint64(si[0]);
		rational[1] = g_variant_new_uint64(si[1]);
		*data = g_variant_new_tuple(rational, 2);
		break;
	case SR_CONF_DATALOG:
		/* There really isn't a way to be sure the device is logging. */
		return SR_ERR_NA;
		break;
	case SR_CONF_SPL_WEIGHT_FREQ:
		if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
			*data = g_variant_new_string("A");
		else
			*data = g_variant_new_string("C");
		break;
	case SR_CONF_SPL_WEIGHT_TIME:
		if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
			*data = g_variant_new_string("F");
		else
			*data = g_variant_new_string("S");
		break;
	case SR_CONF_DATA_SOURCE:
		if (devc->data_source == DATA_SOURCE_LIVE)
			*data = g_variant_new_string("Live");
		else
			*data = g_variant_new_string("Memory");
		break;
	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;
	uint64_t p, q;
	unsigned int i;
	int tmp, ret;
	const char *tmp_str;

	(void)cg;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	devc = sdi->priv;
	ret = SR_OK;
	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		sr_dbg("Setting sample limit to %" PRIu64 ".",
		       devc->limit_samples);
		break;
	case SR_CONF_SAMPLE_INTERVAL:
		g_variant_get(data, "(tt)", &p, &q);
		for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
			if (kecheng_kc_330b_sample_intervals[i][0] != p || kecheng_kc_330b_sample_intervals[i][1] != q)
				continue;
			devc->sample_interval = i;
			devc->config_dirty = TRUE;
			break;
		}
		if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
			ret = SR_ERR_ARG;
		break;
	case SR_CONF_SPL_WEIGHT_FREQ:
		tmp_str = g_variant_get_string(data, NULL);
		if (!strcmp(tmp_str, "A"))
			tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
		else if (!strcmp(tmp_str, "C"))
			tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
		else
			return SR_ERR_ARG;
		devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A | SR_MQFLAG_SPL_FREQ_WEIGHT_C);
		devc->mqflags |= tmp;
		devc->config_dirty = TRUE;
		break;
	case SR_CONF_SPL_WEIGHT_TIME:
		tmp_str = g_variant_get_string(data, NULL);
		if (!strcmp(tmp_str, "F"))
			tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
		else if (!strcmp(tmp_str, "S"))
			tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
		else
			return SR_ERR_ARG;
		devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F | SR_MQFLAG_SPL_TIME_WEIGHT_S);
		devc->mqflags |= tmp;
		devc->config_dirty = TRUE;
		break;
	case SR_CONF_DATA_SOURCE:
		tmp_str = g_variant_get_string(data, NULL);
		if (!strcmp(tmp_str, "Live"))
			devc->data_source = DATA_SOURCE_LIVE;
		else if (!strcmp(tmp_str, "Memory"))
			devc->data_source = DATA_SOURCE_MEMORY;
		else
			return SR_ERR;
		devc->config_dirty = TRUE;
		break;
	default:
		ret = SR_ERR_NA;
	}

	return ret;
}

static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	GVariant *tuple, *rational[2];
	GVariantBuilder gvb;
	unsigned int i;

	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	case SR_CONF_SAMPLE_INTERVAL:
		g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
		for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
			rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
			rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
			tuple = g_variant_new_tuple(rational, 2);
			g_variant_builder_add_value(&gvb, tuple);
		}
		*data = g_variant_builder_end(&gvb);
		break;
	case SR_CONF_SPL_WEIGHT_FREQ:
		*data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
		break;
	case SR_CONF_SPL_WEIGHT_TIME:
		*data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
		break;
	case SR_CONF_DATA_SOURCE:
		*data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di = sdi->driver;
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_meta meta;
	struct sr_config *src;
	struct sr_usb_dev_inst *usb;
	GVariant *gvar, *rational[2];
	const uint64_t *si;
	int req_len, buf_len, len, ret;
	unsigned char buf[9];

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	drvc = di->context;
	devc = sdi->priv;
	usb = sdi->conn;

	devc->num_samples = 0;

	std_session_send_df_header(sdi, LOG_PREFIX);

	if (devc->data_source == DATA_SOURCE_LIVE) {
		/* Force configuration. */
		kecheng_kc_330b_configure(sdi);

		if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
			return SR_ERR;
		if (ret != DEVICE_ACTIVE) {
			sr_err("Device is inactive");
			/* Still continue though, since the device will
			 * just return 30.0 until the user hits the button
			 * on the device -- and then start feeding good
			 * samples back. */
		}
	} else {
		if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
			return SR_ERR;
		devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
		devc->mqflags |= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
		devc->stored_samples = (buf[7] << 8) | buf[8];
		if (devc->stored_samples == 0) {
			/* Notify frontend of empty log by sending start/end packets. */
			std_session_send_df_end(sdi, LOG_PREFIX);
			return SR_OK;
		}

		if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
			devc->stored_samples = devc->limit_samples;

		si = kecheng_kc_330b_sample_intervals[buf[1]];
		rational[0] = g_variant_new_uint64(si[0]);
		rational[1] = g_variant_new_uint64(si[1]);
		gvar = g_variant_new_tuple(rational, 2);
		src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
		packet.type = SR_DF_META;
		packet.payload = &meta;
		meta.config = g_slist_append(NULL, src);
		sr_session_send(sdi, &packet);
		g_free(src);
	}

	if (!(devc->xfer = libusb_alloc_transfer(0)))
		return SR_ERR;

	usb_source_add(sdi->session, drvc->sr_ctx, 10,
		kecheng_kc_330b_handle_events, (void *)sdi);

	if (devc->data_source == DATA_SOURCE_LIVE) {
		buf[0] = CMD_GET_LIVE_SPL;
		buf_len = 1;
		devc->state = LIVE_SPL_WAIT;
		devc->last_live_request = g_get_monotonic_time() / 1000;
		req_len = 3;
	} else {
		buf[0] = CMD_GET_LOG_DATA;
		buf[1] = 0;
		buf[2] = 0;
		buf_len = 4;
		devc->state = LOG_DATA_WAIT;
		if (devc->stored_samples < 63)
			buf[3] = devc->stored_samples;
		else
			buf[3] = 63;
		/* Command ack byte + 2 bytes per sample. */
		req_len = 1 + buf[3] * 2;
	}

	ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
	if (ret != 0 || len != 1) {
		sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
		libusb_free_transfer(devc->xfer);
		return SR_ERR;
	}

	libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
			req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
	if (libusb_submit_transfer(devc->xfer) != 0) {
		libusb_free_transfer(devc->xfer);
		return SR_ERR;
	}

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	/* Signal USB transfer handler to clean up and stop. */
	sdi->status = SR_ST_STOPPING;

	devc = sdi->priv;
	if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
		/* The protocol doesn't have a command to clear stored data;
		 * it clears it whenever new configuration is set. That means
		 * we can't just configure the device any time we want when
		 * it's in DATA_SOURCE_MEMORY mode. The only safe time to do
		 * it is now, when we're sure we've pulled in all the stored
		 * data. */
		kecheng_kc_330b_configure(sdi);
	}

	return SR_OK;
}

static struct sr_dev_driver kecheng_kc_330b_driver_info = {
	.name = "kecheng-kc-330b",
	.longname = "Kecheng KC-330B",
	.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(kecheng_kc_330b_driver_info);
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 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 <string.h>
	22	#include "protocol.h"
	23
	24	#define USB_CONN "1041.8101"
	25	#define VENDOR "Kecheng"
	26	#define USB_INTERFACE 0
	27
	28	static const uint32_t devopts[] = {
	29	SR_CONF_SOUNDLEVELMETER,
	30	SR_CONF_CONTINUOUS,
	31	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	32	SR_CONF_SAMPLE_INTERVAL \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	33	SR_CONF_DATALOG \| SR_CONF_GET,
	34	SR_CONF_SPL_WEIGHT_FREQ \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	35	SR_CONF_SPL_WEIGHT_TIME \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	36	SR_CONF_DATA_SOURCE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	37	};
	38
	39	SR_PRIV const uint64_t kecheng_kc_330b_sample_intervals[][2] = {
	40	{ 1, 8 },
	41	{ 1, 2 },
	42	{ 1, 1 },
	43	{ 2, 1 },
	44	{ 5, 1 },
	45	{ 10, 1 },
	46	{ 60, 1 },
	47	};
	48
	49	static const char *weight_freq[] = {
	50	"A",
	51	"C",
	52	};
	53
	54	static const char *weight_time[] = {
	55	"F",
	56	"S",
	57	};
	58
	59	static const char *data_sources[] = {
	60	"Live",
	61	"Memory",
	62	};
	63
	64	static int scan_kecheng(struct sr_dev_driver *di,
	65	struct sr_usb_dev_inst usb, char *model)
	66	{
	67	struct drv_context *drvc;
	68	int len, ret;
	69	unsigned char cmd, buf[32];
	70
	71	drvc = di->context;
	72	if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
	73	return SR_ERR;
	74
	75	cmd = CMD_IDENTIFY;
	76	ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, &cmd, 1, &len, 5);
	77	if (ret != 0) {
	78	libusb_close(usb->devhdl);
	79	sr_dbg("Failed to send Identify command: %s", libusb_error_name(ret));
	80	return SR_ERR;
	81	}
	82
	83	ret = libusb_bulk_transfer(usb->devhdl, EP_IN, buf, 32, &len, 10);
	84	if (ret != 0) {
	85	libusb_close(usb->devhdl);
	86	sr_dbg("Failed to receive response: %s", libusb_error_name(ret));
	87	return SR_ERR;
	88	}
	89
	90	libusb_close(usb->devhdl);
	91	usb->devhdl = NULL;
	92
	93	if (len < 2 \|\| buf[0] != (CMD_IDENTIFY \| 0x80) \|\| buf[1] > 30) {
	94	sr_dbg("Invalid response to Identify command");
	95	return SR_ERR;
	96	}
	97
	98	buf[buf[1] + 2] = '\x0';
	99	model = g_strndup((const gchar )buf + 2, 30);
	100
	101	return SR_OK;
	102	}
	103
	104	static GSList scan(struct sr_dev_driver di, GSList *options)
	105	{
	106	struct drv_context *drvc;
	107	struct dev_context *devc;
	108	struct sr_dev_inst *sdi;
	109	GSList usb_devices, devices, *l;
	110	char *model;
	111
	112	(void)options;
	113
	114	drvc = di->context;
	115	drvc->instances = NULL;
	116
	117	devices = NULL;
	118	if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
	119	/* We have a list of sr_usb_dev_inst matching the connection
	120	* string. Wrap them in sr_dev_inst and we're done. */
	121	for (l = usb_devices; l; l = l->next) {
	122	if (scan_kecheng(di, l->data, &model) != SR_OK)
	123	continue;
	124	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	125	sdi->status = SR_ST_INACTIVE;
	126	sdi->vendor = g_strdup(VENDOR);
	127	sdi->model = model; /* Already g_strndup()'d. */
	128	sdi->driver = di;
	129	sdi->inst_type = SR_INST_USB;
	130	sdi->conn = l->data;
	131	sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "SPL");
	132	devc = g_malloc0(sizeof(struct dev_context));
	133	sdi->priv = devc;
	134	devc->limit_samples = 0;
	135	/* The protocol provides no way to read the current
	136	* settings, so we'll enforce these. */
	137	devc->sample_interval = DEFAULT_SAMPLE_INTERVAL;
	138	devc->alarm_low = DEFAULT_ALARM_LOW;
	139	devc->alarm_high = DEFAULT_ALARM_HIGH;
	140	devc->mqflags = DEFAULT_WEIGHT_TIME \| DEFAULT_WEIGHT_FREQ;
	141	devc->data_source = DEFAULT_DATA_SOURCE;
	142	devc->config_dirty = FALSE;
	143
	144	/* TODO: Set date/time? */
	145
	146	drvc->instances = g_slist_append(drvc->instances, sdi);
	147	devices = g_slist_append(devices, sdi);
	148	}
	149	g_slist_free(usb_devices);
	150	} else
	151	g_slist_free_full(usb_devices, g_free);
	152
	153	return devices;
	154	}
	155
	156	static int dev_open(struct sr_dev_inst *sdi)
	157	{
	158	struct sr_dev_driver *di = sdi->driver;
	159	struct drv_context *drvc = di->context;
	160	struct sr_usb_dev_inst *usb;
	161	int ret;
	162
	163	usb = sdi->conn;
	164
	165	if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
	166	return SR_ERR;
	167
	168	if ((ret = libusb_set_configuration(usb->devhdl, 1))) {
	169	sr_err("Failed to set configuration: %s.", libusb_error_name(ret));
	170	return SR_ERR;
	171	}
	172
	173	if ((ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
	174	sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
	175	return SR_ERR;
	176	}
	177	sdi->status = SR_ST_ACTIVE;
	178
	179	return ret;
	180	}
	181
	182	static int dev_close(struct sr_dev_inst *sdi)
	183	{
	184	struct dev_context *devc;
	185	struct sr_usb_dev_inst *usb;
	186
	187	usb = sdi->conn;
	188
	189	if (!usb->devhdl)
	190	/* Nothing to do. */
	191	return SR_OK;
	192
	193	/* This allows a frontend to configure the device without ever
	194	* doing an acquisition step. */
	195	devc = sdi->priv;
	196	if (!devc->config_dirty)
	197	kecheng_kc_330b_configure(sdi);
	198
	199	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	200	libusb_close(usb->devhdl);
	201	usb->devhdl = NULL;
	202	sdi->status = SR_ST_INACTIVE;
	203
	204	return SR_OK;
	205	}
	206
	207	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	208	const struct sr_channel_group *cg)
	209	{
	210	struct dev_context *devc;
	211	GVariant *rational[2];
	212	const uint64_t *si;
	213
	214	(void)cg;
	215
	216	devc = sdi->priv;
	217	switch (key) {
	218	case SR_CONF_LIMIT_SAMPLES:
	219	*data = g_variant_new_uint64(devc->limit_samples);
	220	break;
	221	case SR_CONF_SAMPLE_INTERVAL:
	222	si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
	223	rational[0] = g_variant_new_uint64(si[0]);
	224	rational[1] = g_variant_new_uint64(si[1]);
	225	*data = g_variant_new_tuple(rational, 2);
	226	break;
	227	case SR_CONF_DATALOG:
	228	/* There really isn't a way to be sure the device is logging. */
	229	return SR_ERR_NA;
	230	break;
	231	case SR_CONF_SPL_WEIGHT_FREQ:
	232	if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
	233	*data = g_variant_new_string("A");
	234	else
	235	*data = g_variant_new_string("C");
	236	break;
	237	case SR_CONF_SPL_WEIGHT_TIME:
	238	if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
	239	*data = g_variant_new_string("F");
	240	else
	241	*data = g_variant_new_string("S");
	242	break;
	243	case SR_CONF_DATA_SOURCE:
	244	if (devc->data_source == DATA_SOURCE_LIVE)
	245	*data = g_variant_new_string("Live");
	246	else
	247	*data = g_variant_new_string("Memory");
	248	break;
	249	default:
	250	return SR_ERR_NA;
	251	}
	252
	253	return SR_OK;
	254	}
	255
	256	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	257	const struct sr_channel_group *cg)
	258	{
	259	struct dev_context *devc;
	260	uint64_t p, q;
	261	unsigned int i;
	262	int tmp, ret;
	263	const char *tmp_str;
	264
	265	(void)cg;
	266
	267	if (sdi->status != SR_ST_ACTIVE)
	268	return SR_ERR_DEV_CLOSED;
	269
	270	devc = sdi->priv;
	271	ret = SR_OK;
	272	switch (key) {
	273	case SR_CONF_LIMIT_SAMPLES:
	274	devc->limit_samples = g_variant_get_uint64(data);
	275	sr_dbg("Setting sample limit to %" PRIu64 ".",
	276	devc->limit_samples);
	277	break;
	278	case SR_CONF_SAMPLE_INTERVAL:
	279	g_variant_get(data, "(tt)", &p, &q);
	280	for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
	281	if (kecheng_kc_330b_sample_intervals[i][0] != p \|\| kecheng_kc_330b_sample_intervals[i][1] != q)
	282	continue;
	283	devc->sample_interval = i;
	284	devc->config_dirty = TRUE;
	285	break;
	286	}
	287	if (i == ARRAY_SIZE(kecheng_kc_330b_sample_intervals))
	288	ret = SR_ERR_ARG;
	289	break;
	290	case SR_CONF_SPL_WEIGHT_FREQ:
	291	tmp_str = g_variant_get_string(data, NULL);
	292	if (!strcmp(tmp_str, "A"))
	293	tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_A;
	294	else if (!strcmp(tmp_str, "C"))
	295	tmp = SR_MQFLAG_SPL_FREQ_WEIGHT_C;
	296	else
	297	return SR_ERR_ARG;
	298	devc->mqflags &= ~(SR_MQFLAG_SPL_FREQ_WEIGHT_A \| SR_MQFLAG_SPL_FREQ_WEIGHT_C);
	299	devc->mqflags \|= tmp;
	300	devc->config_dirty = TRUE;
	301	break;
	302	case SR_CONF_SPL_WEIGHT_TIME:
	303	tmp_str = g_variant_get_string(data, NULL);
	304	if (!strcmp(tmp_str, "F"))
	305	tmp = SR_MQFLAG_SPL_TIME_WEIGHT_F;
	306	else if (!strcmp(tmp_str, "S"))
	307	tmp = SR_MQFLAG_SPL_TIME_WEIGHT_S;
	308	else
	309	return SR_ERR_ARG;
	310	devc->mqflags &= ~(SR_MQFLAG_SPL_TIME_WEIGHT_F \| SR_MQFLAG_SPL_TIME_WEIGHT_S);
	311	devc->mqflags \|= tmp;
	312	devc->config_dirty = TRUE;
	313	break;
	314	case SR_CONF_DATA_SOURCE:
	315	tmp_str = g_variant_get_string(data, NULL);
	316	if (!strcmp(tmp_str, "Live"))
	317	devc->data_source = DATA_SOURCE_LIVE;
	318	else if (!strcmp(tmp_str, "Memory"))
	319	devc->data_source = DATA_SOURCE_MEMORY;
	320	else
	321	return SR_ERR;
	322	devc->config_dirty = TRUE;
	323	break;
	324	default:
	325	ret = SR_ERR_NA;
	326	}
	327
	328	return ret;
	329	}
	330
	331	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	332	const struct sr_channel_group *cg)
	333	{
	334	GVariant tuple, rational[2];
	335	GVariantBuilder gvb;
	336	unsigned int i;
	337
	338	(void)sdi;
	339	(void)cg;
	340
	341	switch (key) {
	342	case SR_CONF_DEVICE_OPTIONS:
	343	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	344	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	345	break;
	346	case SR_CONF_SAMPLE_INTERVAL:
	347	g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
	348	for (i = 0; i < ARRAY_SIZE(kecheng_kc_330b_sample_intervals); i++) {
	349	rational[0] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][0]);
	350	rational[1] = g_variant_new_uint64(kecheng_kc_330b_sample_intervals[i][1]);
	351	tuple = g_variant_new_tuple(rational, 2);
	352	g_variant_builder_add_value(&gvb, tuple);
	353	}
	354	*data = g_variant_builder_end(&gvb);
	355	break;
	356	case SR_CONF_SPL_WEIGHT_FREQ:
	357	*data = g_variant_new_strv(weight_freq, ARRAY_SIZE(weight_freq));
	358	break;
	359	case SR_CONF_SPL_WEIGHT_TIME:
	360	*data = g_variant_new_strv(weight_time, ARRAY_SIZE(weight_time));
	361	break;
	362	case SR_CONF_DATA_SOURCE:
	363	*data = g_variant_new_strv(data_sources, ARRAY_SIZE(data_sources));
	364	break;
	365	default:
	366	return SR_ERR_NA;
	367	}
	368
	369	return SR_OK;
	370	}
	371
	372	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	373	{
	374	struct sr_dev_driver *di = sdi->driver;
	375	struct drv_context *drvc;
	376	struct dev_context *devc;
	377	struct sr_datafeed_packet packet;
	378	struct sr_datafeed_meta meta;
	379	struct sr_config *src;
	380	struct sr_usb_dev_inst *usb;
	381	GVariant gvar, rational[2];
	382	const uint64_t *si;
	383	int req_len, buf_len, len, ret;
	384	unsigned char buf[9];
	385
	386	if (sdi->status != SR_ST_ACTIVE)
	387	return SR_ERR_DEV_CLOSED;
	388
	389	drvc = di->context;
	390	devc = sdi->priv;
	391	usb = sdi->conn;
	392
	393	devc->num_samples = 0;
	394
	395	std_session_send_df_header(sdi, LOG_PREFIX);
	396
	397	if (devc->data_source == DATA_SOURCE_LIVE) {
	398	/* Force configuration. */
	399	kecheng_kc_330b_configure(sdi);
	400
	401	if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
	402	return SR_ERR;
	403	if (ret != DEVICE_ACTIVE) {
	404	sr_err("Device is inactive");
	405	/* Still continue though, since the device will
	406	* just return 30.0 until the user hits the button
	407	* on the device -- and then start feeding good
	408	* samples back. */
	409	}
	410	} else {
	411	if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
	412	return SR_ERR;
	413	devc->mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
	414	devc->mqflags \|= buf[5] ? SR_MQFLAG_SPL_FREQ_WEIGHT_C : SR_MQFLAG_SPL_FREQ_WEIGHT_A;
	415	devc->stored_samples = (buf[7] << 8) \| buf[8];
	416	if (devc->stored_samples == 0) {
	417	/* Notify frontend of empty log by sending start/end packets. */
	418	std_session_send_df_end(sdi, LOG_PREFIX);
	419	return SR_OK;
	420	}
	421
	422	if (devc->limit_samples && devc->limit_samples < devc->stored_samples)
	423	devc->stored_samples = devc->limit_samples;
	424
	425	si = kecheng_kc_330b_sample_intervals[buf[1]];
	426	rational[0] = g_variant_new_uint64(si[0]);
	427	rational[1] = g_variant_new_uint64(si[1]);
	428	gvar = g_variant_new_tuple(rational, 2);
	429	src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, gvar);
	430	packet.type = SR_DF_META;
	431	packet.payload = &meta;
	432	meta.config = g_slist_append(NULL, src);
	433	sr_session_send(sdi, &packet);
	434	g_free(src);
	435	}
	436
	437	if (!(devc->xfer = libusb_alloc_transfer(0)))
	438	return SR_ERR;
	439
	440	usb_source_add(sdi->session, drvc->sr_ctx, 10,
	441	kecheng_kc_330b_handle_events, (void *)sdi);
	442
	443	if (devc->data_source == DATA_SOURCE_LIVE) {
	444	buf[0] = CMD_GET_LIVE_SPL;
	445	buf_len = 1;
	446	devc->state = LIVE_SPL_WAIT;
	447	devc->last_live_request = g_get_monotonic_time() / 1000;
	448	req_len = 3;
	449	} else {
	450	buf[0] = CMD_GET_LOG_DATA;
	451	buf[1] = 0;
	452	buf[2] = 0;
	453	buf_len = 4;
	454	devc->state = LOG_DATA_WAIT;
	455	if (devc->stored_samples < 63)
	456	buf[3] = devc->stored_samples;
	457	else
	458	buf[3] = 63;
	459	/* Command ack byte + 2 bytes per sample. */
	460	req_len = 1 + buf[3] * 2;
	461	}
	462
	463	ret = libusb_bulk_transfer(usb->devhdl, EP_OUT, buf, buf_len, &len, 5);
	464	if (ret != 0 \|\| len != 1) {
	465	sr_dbg("Failed to start acquisition: %s", libusb_error_name(ret));
	466	libusb_free_transfer(devc->xfer);
	467	return SR_ERR;
	468	}
	469
	470	libusb_fill_bulk_transfer(devc->xfer, usb->devhdl, EP_IN, devc->buf,
	471	req_len, kecheng_kc_330b_receive_transfer, (void *)sdi, 15);
	472	if (libusb_submit_transfer(devc->xfer) != 0) {
	473	libusb_free_transfer(devc->xfer);
	474	return SR_ERR;
	475	}
	476
	477	return SR_OK;
	478	}
	479
	480	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	481	{
	482	struct dev_context *devc;
	483
	484	if (sdi->status != SR_ST_ACTIVE)
	485	return SR_ERR_DEV_CLOSED;
	486
	487	/* Signal USB transfer handler to clean up and stop. */
	488	sdi->status = SR_ST_STOPPING;
	489
	490	devc = sdi->priv;
	491	if (devc->data_source == DATA_SOURCE_MEMORY && devc->config_dirty) {
	492	/* The protocol doesn't have a command to clear stored data;
	493	* it clears it whenever new configuration is set. That means
	494	* we can't just configure the device any time we want when
	495	* it's in DATA_SOURCE_MEMORY mode. The only safe time to do
	496	* it is now, when we're sure we've pulled in all the stored
	497	* data. */
	498	kecheng_kc_330b_configure(sdi);
	499	}
	500
	501	return SR_OK;
	502	}
	503
	504	static struct sr_dev_driver kecheng_kc_330b_driver_info = {
	505	.name = "kecheng-kc-330b",
	506	.longname = "Kecheng KC-330B",
	507	.api_version = 1,
	508	.init = std_init,
	509	.cleanup = std_cleanup,
	510	.scan = scan,
	511	.dev_list = std_dev_list,
	512	.dev_clear = NULL,
	513	.config_get = config_get,
	514	.config_set = config_set,
	515	.config_list = config_list,
	516	.dev_open = dev_open,
	517	.dev_close = dev_close,
	518	.dev_acquisition_start = dev_acquisition_start,
	519	.dev_acquisition_stop = dev_acquisition_stop,
	520	.context = NULL,
	521	};
	522	SR_REGISTER_DEV_DRIVER(kecheng_kc_330b_driver_info);