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

SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;

static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

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;
	drvc->instances = NULL;

	devices = NULL;
	if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, USB_CONN))) {
		/* We have a list of sr_usb_dev_inst matching the connection
		 * string. Wrap them in sr_dev_inst and we're done. */
		for (l = usb_devices; l; l = l->next) {
			if (scan_kecheng(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->driver = di;
			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? */

			drvc->instances = g_slist_append(drvc->instances, sdi);
			devices = g_slist_append(devices, sdi);
		}
		g_slist_free(usb_devices);
	} else
		g_slist_free_full(usb_devices, g_free);

	return devices;
}

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

	if (!(drvc = di->context)) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	usb = sdi->conn;

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

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

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

	return ret;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di = sdi->driver;
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;

	if (!di->context) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	usb = sdi->conn;

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

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

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

	return SR_OK;
}

static int 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 sr_dev_driver *di = sdi->driver;
	struct dev_context *devc;
	uint64_t p, q;
	unsigned int i;
	int tmp, ret;
	const char *tmp_str;

	(void)cg;

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

	if (!di->context) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

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

	return ret;
}

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

	(void)sdi;
	(void)cg;

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

	return SR_OK;
}

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

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

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

	devc->num_samples = 0;

	std_session_send_df_header(sdi, LOG_PREFIX);

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

		if (kecheng_kc_330b_status_get(sdi, &ret) != SR_OK)
			return SR_ERR;
		if (ret != DEVICE_ACTIVE) {
			sr_err("Device is inactive");
			/* Still continue though, since the device will
			 * just return 30.0 until the user hits the button
			 * on the device -- and then start feeding good
			 * samples back. */
		}
	} else {
		if (kecheng_kc_330b_log_info_get(sdi, buf) != SR_OK)
			return SR_ERR;
		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, LOG_PREFIX);
			return SR_OK;
		}

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

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

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

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

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

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

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

	return SR_OK;
}

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

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

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

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

	return SR_OK;
}

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