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

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <string.h>
#include "protocol.h"

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

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

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

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

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

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

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

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

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

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

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

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

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

	return SR_OK;
}

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

	(void)options;

	drvc = di->context;

	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->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? */

			devices = g_slist_append(devices, sdi);
		}
		g_slist_free(usb_devices);
	} else
		g_slist_free_full(usb_devices, g_free);

	return std_scan_complete(di, devices);
}

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

	usb = sdi->conn;

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

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

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

	return ret;
}

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

	usb = sdi->conn;

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

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

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

	return SR_OK;
}

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

	(void)cg;

	devc = sdi->priv;
	switch (key) {
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_SAMPLE_INTERVAL:
		si = kecheng_kc_330b_sample_intervals[devc->sample_interval];
		rational[0] = g_variant_new_uint64(si[0]);
		rational[1] = g_variant_new_uint64(si[1]);
		*data = g_variant_new_tuple(rational, 2);
		break;
	case SR_CONF_DATALOG:
		/* There really isn't a way to be sure the device is logging. */
		return SR_ERR_NA;
		break;
	case SR_CONF_SPL_WEIGHT_FREQ:
		if (devc->mqflags & SR_MQFLAG_SPL_FREQ_WEIGHT_A)
			*data = g_variant_new_string("A");
		else
			*data = g_variant_new_string("C");
		break;
	case SR_CONF_SPL_WEIGHT_TIME:
		if (devc->mqflags & SR_MQFLAG_SPL_TIME_WEIGHT_F)
			*data = g_variant_new_string("F");
		else
			*data = g_variant_new_string("S");
		break;
	case SR_CONF_DATA_SOURCE:
		if (devc->data_source == DATA_SOURCE_LIVE)
			*data = g_variant_new_string("Live");
		else
			*data = g_variant_new_string("Memory");
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	uint64_t p, q;
	unsigned int i;
	int tmp, ret;
	const char *tmp_str;

	(void)cg;

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

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

	return ret;
}

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

	(void)sdi;
	(void)cg;

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

	return SR_OK;
}

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

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

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

	devc->num_samples = 0;

	std_session_send_df_header(sdi);

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

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

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

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

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

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

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

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

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

	return SR_OK;
}

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

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

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

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

	return SR_OK;
}

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