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

	return SR_OK;
}

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)
		return SR_ERR_BUG;

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

	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;

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

	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;

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