[libsigrok.git] / 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 <string.h>
#include "protocol.h"

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

static const int32_t hwcaps[] = {
	SR_CONF_SOUNDLEVELMETER,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_CONTINUOUS,
	SR_CONF_DATALOG,
	SR_CONF_SPL_WEIGHT_FREQ,
	SR_CONF_SPL_WEIGHT_TIME,
	SR_CONF_DATA_SOURCE,
};

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

SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
static struct sr_dev_driver *di = &kecheng_kc_330b_driver_info;


static int init(struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

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

	drvc = di->priv;
	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(GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_probe *probe;
	GSList *usb_devices, *devices, *l;
	char *model;

	(void)options;

	drvc = di->priv;
	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(l->data, &model) != SR_OK)
				continue;
			if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, VENDOR,
					model, NULL)))
				return NULL;
			g_free(model);
			sdi->driver = di;
			sdi->inst_type = SR_INST_USB;
			sdi->conn = l->data;
			if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "SPL")))
				return NULL;
			sdi->probes = g_slist_append(sdi->probes, probe);

			if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
				sr_dbg("Device context malloc failed.");
				return NULL;
			}
			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 GSList *dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

static int dev_clear(void)
{
	return std_dev_clear(di, NULL);
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct drv_context *drvc;
	struct sr_usb_dev_inst *usb;
	int ret;

	if (!(drvc = di->priv)) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	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;

	if (!di->priv) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	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 cleanup(void)
{
	int ret;
	struct drv_context *drvc;

	if (!(drvc = di->priv))
		/* Can get called on an unused driver, doesn't matter. */
		return SR_OK;

	ret = dev_clear();
	g_free(drvc);
	di->priv = NULL;

	return ret;
}

static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	struct dev_context *devc;
	GVariant *rational[2];
	const uint64_t *si;

	(void)probe_group;

	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(int key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	struct dev_context *devc;
	uint64_t p, q;
	unsigned int i;
	int tmp, ret;
	const char *tmp_str;

	(void)probe_group;

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

	if (!di->priv) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	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(int key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_probe_group *probe_group)
{
	GVariant *tuple, *rational[2];
	GVariantBuilder gvb;
	unsigned int i;

	(void)sdi;
	(void)probe_group;

	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_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,
		void *cb_data)
{
	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 stored_mqflags, req_len, buf_len, len, ret;
	unsigned char buf[9];

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

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

	devc->cb_data = cb_data;
	devc->num_samples = 0;

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, 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;
		stored_mqflags = buf[4] ? SR_MQFLAG_SPL_TIME_WEIGHT_S : SR_MQFLAG_SPL_TIME_WEIGHT_F;
		stored_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. */
			packet.type = SR_DF_END;
			sr_session_send(cb_data, &packet);
			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(devc->cb_data, &packet);
		g_free(src);
	}

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

	usb_source_add(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, void *cb_data)
{
	struct dev_context *devc;

	(void)cb_data;

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

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