[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 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(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;
	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)
{
	GVariant *tuple, *rational[2];
	GVariantBuilder gvb;
	unsigned int i;

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