[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_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;
			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 (!(ch = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "SPL")))
				return NULL;
			sdi->channels = g_slist_append(sdi->channels, ch);

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