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

SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;

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

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 GSList *dev_list(const struct sr_dev_driver *di)
{
	return ((struct drv_context *)(di->context))->instances;
}

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

	if (!(drvc = di->context)) {
		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 sr_dev_driver *di = sdi->driver;
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;

	if (!di->context) {
		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(const struct sr_dev_driver *di)
{
	int ret;
	struct drv_context *drvc;

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

	ret = std_dev_clear(di, NULL);
	g_free(drvc);

	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 sr_dev_driver *di = sdi->driver;
	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->context) {
		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 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->cb_data = cb_data;
	devc->num_samples = 0;

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