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

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_channel *ch;
	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;
			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;
			if (!(ch = sr_channel_new(0, SR_CHANNEL_ANALOG, TRUE, "SPL")))
				return NULL;
			sdi->channels = g_slist_append(sdi->channels, ch);
			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 GSList *dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

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 = std_dev_clear(di, NULL);
	g_free(drvc);
	di->priv = NULL;

	return ret;
}

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;

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