[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 USB_INTERFACE 0

static const uint32_t drvopts[] = {
	SR_CONF_SOUNDLEVELMETER,
};

static const uint32_t devopts[] = {
	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("Kecheng");
			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;
	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];
		*data = std_gvar_tuple_u64(si[0], si[1]);
		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;
	const char *tmp_str;

	(void)cg;

	devc = sdi->priv;
	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))
			return 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:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
	case SR_CONF_SAMPLE_INTERVAL:
		*data = std_gvar_tuple_array(ARRAY_AND_SIZE(kecheng_kc_330b_sample_intervals));
		break;
	case SR_CONF_SPL_WEIGHT_FREQ:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(weight_freq));
		break;
	case SR_CONF_SPL_WEIGHT_TIME:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(weight_time));
		break;
	case SR_CONF_DATA_SOURCE:
		*data = g_variant_new_strv(ARRAY_AND_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;
	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]];
		gvar = std_gvar_tuple_u64(si[0], si[1]);

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