[libsigrok.git] / src / hardware / kingst-la2016 / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2020 Florian Schmidt <schmidt_florian@gmx.de>
 * Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * 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/>.
 */

/*
 * This driver implementation initially was derived from the
 * src/hardware/saleae-logic16/ source code.
 */

#include <config.h>

#include <libsigrok/libsigrok.h>
#include <string.h>

#include "libsigrok-internal.h"
#include "protocol.h"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
};

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

static const uint32_t devopts[] = {
	/* TODO: SR_CONF_CONTINUOUS, */
	SR_CONF_CONN | SR_CONF_GET,
	SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_SET | SR_CONF_GET | SR_CONF_LIST,
	SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_LOGIC_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_LOGIC_THRESHOLD_CUSTOM | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
	SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
};

static const int32_t trigger_matches[] = {
	SR_TRIGGER_ZERO,
	SR_TRIGGER_ONE,
	SR_TRIGGER_RISING,
	SR_TRIGGER_FALLING,
};

static const char *channel_names[] = {
	"0", "1", "2", "3", "4", "5", "6", "7",
	"8", "9", "10", "11", "12", "13", "14", "15",
};

static const uint64_t samplerates_la2016[] = {
	SR_KHZ(20),
	SR_KHZ(50),
	SR_KHZ(100),
	SR_KHZ(200),
	SR_KHZ(500),
	SR_MHZ(1),
	SR_MHZ(2),
	SR_MHZ(4),
	SR_MHZ(5),
	SR_MHZ(8),
	SR_MHZ(10),
	SR_MHZ(20),
	SR_MHZ(50),
	SR_MHZ(100),
	SR_MHZ(200),
};

static const uint64_t samplerates_la1016[] = {
	SR_KHZ(20),
	SR_KHZ(50),
	SR_KHZ(100),
	SR_KHZ(200),
	SR_KHZ(500),
	SR_MHZ(1),
	SR_MHZ(2),
	SR_MHZ(4),
	SR_MHZ(5),
	SR_MHZ(8),
	SR_MHZ(10),
	SR_MHZ(20),
	SR_MHZ(50),
	SR_MHZ(100),
};

static const float logic_threshold_value[] = {
	1.58,
	2.5,
	1.165,
	1.5,
	1.25,
	0.9,
	0.75,
	0.60,
	0.45,
};

static const char *logic_threshold[] = {
	"TTL 5V",
	"CMOS 5V",
	"CMOS 3.3V",
	"CMOS 3.0V",
	"CMOS 2.5V",
	"CMOS 1.8V",
	"CMOS 1.5V",
	"CMOS 1.2V",
	"CMOS 0.9V",
	"USER",
};

#define LOGIC_THRESHOLD_IDX_USER	(ARRAY_SIZE(logic_threshold) - 1)

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_usb_dev_inst *usb;
	struct sr_config *src;
	GSList *l;
	GSList *devices;
	GSList *conn_devices;
	struct libusb_device_descriptor des;
	libusb_device **devlist;
	unsigned int i, j;
	const char *conn;
	char connection_id[64];
	uint64_t fw_uploaded;
	unsigned int dev_addr;

	drvc = di->context;

	conn = NULL;
	for (l = options; l; l = l->next) {
		src = l->data;
		switch (src->key) {
		case SR_CONF_CONN:
			conn = g_variant_get_string(src->data, NULL);
			break;
		}
	}
	if (conn)
		conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	else
		conn_devices = NULL;

	/* Find all LA2016 devices, optionally upload firmware to them. */
	devices = NULL;
	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	for (i = 0; devlist[i]; i++) {
		if (conn) {
			usb = NULL;
			for (l = conn_devices; l; l = l->next) {
				usb = l->data;
				if (usb->bus == libusb_get_bus_number(devlist[i]) &&
				    usb->address == libusb_get_device_address(devlist[i]))
					break;
			}
			if (!l) {
				/*
				 * A connection parameter was specified and
				 * this device does not match the filter.
				 */
				continue;
			}
		}

		libusb_get_device_descriptor(devlist[i], &des);

		if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
			continue;

		if (des.idVendor != LA2016_VID || des.idProduct != LA2016_PID)
			continue;

		/* USB identification matches, a device was found. */
		sr_dbg("Found a device (USB identification).");
		sdi = g_malloc0(sizeof(struct sr_dev_inst));
		sdi->status = SR_ST_INITIALIZING;
		sdi->connection_id = g_strdup(connection_id);

		fw_uploaded = 0;
		dev_addr = libusb_get_device_address(devlist[i]);
		if (des.iProduct != LA2016_IPRODUCT_INDEX) {
			sr_info("Device at '%s' has no firmware loaded.", connection_id);

			if (la2016_upload_firmware(drvc->sr_ctx, devlist[i], des.idProduct) != SR_OK) {
				sr_err("MCU firmware upload failed.");
				g_free(sdi->connection_id);
				g_free(sdi);
				continue;
			}
			fw_uploaded = g_get_monotonic_time();
			/* Will re-enumerate. Mark as "unknown address yet". */
			dev_addr = 0xff;
		}

		sdi->vendor = g_strdup("Kingst");
		sdi->model = g_strdup("LA2016");

		for (j = 0; j < ARRAY_SIZE(channel_names); j++)
			sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE, channel_names[j]);

		devices = g_slist_append(devices, sdi);

		devc = g_malloc0(sizeof(struct dev_context));
		sdi->priv = devc;
		devc->fw_uploaded = fw_uploaded;
		devc->threshold_voltage_idx = 0;
		devc->threshold_voltage = logic_threshold_value[devc->threshold_voltage_idx];

		sdi->status = SR_ST_INACTIVE;
		sdi->inst_type = SR_INST_USB;

		sdi->conn = sr_usb_dev_inst_new(
			libusb_get_bus_number(devlist[i]),
			dev_addr, NULL);
	}
	libusb_free_device_list(devlist, 1);
	g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);

	return std_scan_complete(di, devices);
}

static int la2016_dev_open(struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di;
	libusb_device **devlist;
	struct sr_usb_dev_inst *usb;
	struct libusb_device_descriptor des;
	struct drv_context *drvc;
	int ret, i, device_count;
	char connection_id[64];

	di = sdi->driver;
	drvc = di->context;
	usb = sdi->conn;
	ret = SR_ERR;

	device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	if (device_count < 0) {
		sr_err("Failed to get device list: %s.", libusb_error_name(device_count));
		return SR_ERR;
	}

	for (i = 0; i < device_count; i++) {
		libusb_get_device_descriptor(devlist[i], &des);

		if (des.idVendor != LA2016_VID || des.idProduct != LA2016_PID)
			continue;
		if (des.iProduct != LA2016_IPRODUCT_INDEX)
			continue;

		if ((sdi->status == SR_ST_INITIALIZING) || (sdi->status == SR_ST_INACTIVE)) {
			/* Check physical USB bus/port address. */
			if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
				continue;

			if (strcmp(sdi->connection_id, connection_id)) {
				/* Not the device we looked up before. */
				continue;
			}
		}

		if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
			if (usb->address == 0xff) {
				/*
				 * First encounter after firmware upload.
				 * Grab current address after enumeration.
				 */
				usb->address = libusb_get_device_address(devlist[i]);
			}
		} else {
			sr_err("Failed to open device: %s.", libusb_error_name(ret));
			ret = SR_ERR;
			break;
		}

		ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
		if (ret == LIBUSB_ERROR_BUSY) {
			sr_err("Cannot claim USB interface. Another program or driver using it?");
			ret = SR_ERR;
			break;
		} else if (ret == LIBUSB_ERROR_NO_DEVICE) {
			sr_err("Device has been disconnected.");
			ret = SR_ERR;
			break;
		} else if (ret != 0) {
			sr_err("Cannot claim USB interface: %s.", libusb_error_name(ret));
			ret = SR_ERR;
			break;
		}

		if ((ret = la2016_init_device(sdi)) != SR_OK) {
			sr_err("Cannot initialize device.");
			break;
		}

		sr_info("Opened device on %d.%d (logical) / %s (physical), interface %d.",
			usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);

		ret = SR_OK;

		break;
	}

	libusb_free_device_list(devlist, 1);

	if (ret != SR_OK) {
		if (usb->devhdl) {
			libusb_release_interface(usb->devhdl, USB_INTERFACE);
			libusb_close(usb->devhdl);
			usb->devhdl = NULL;
		}
		return SR_ERR;
	}

	return SR_OK;
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	uint64_t reset_done, now, elapsed_ms;
	int ret;

	devc = sdi->priv;

	/*
	 * When the sigrok driver recently has uploaded MCU firmware,
	 * then wait for the FX2 to re-enumerate. Allow the USB device
	 * to vanish before it reappears. Timeouts are rough estimates
	 * after all, the imprecise time of the last check (potentially
	 * executes after the total check period) simplifies code paths
	 * with optional diagnostics. And increases the probability of
	 * successfully detecting "late/slow" devices.
	 */
	if (devc->fw_uploaded) {
		sr_info("Waiting for device to reset after firmware upload.");
		now = g_get_monotonic_time();
		reset_done = devc->fw_uploaded + RENUM_GONE_DELAY_MS * 1000;
		if (now < reset_done)
			g_usleep(reset_done - now);
		do {
			now = g_get_monotonic_time();
			elapsed_ms = (now - devc->fw_uploaded) / 1000;
			sr_spew("Waited %" PRIu64 "ms.", elapsed_ms);
			ret = la2016_dev_open(sdi);
			if (ret == SR_OK) {
				devc->fw_uploaded = 0;
				break;
			}
			g_usleep(RENUM_POLL_INTERVAL_MS * 1000);
		} while (elapsed_ms < RENUM_CHECK_PERIOD_MS);
		if (ret != SR_OK) {
			sr_err("Device failed to re-enumerate.");
			return SR_ERR;
		}
		sr_info("Device came back after %" PRIi64 "ms.", elapsed_ms);
	} else {
		ret = la2016_dev_open(sdi);
	}

	if (ret != SR_OK) {
		sr_err("Cannot open device.");
		return SR_ERR;
	}

	return SR_OK;
}

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

	usb = sdi->conn;

	if (!usb->devhdl)
		return SR_ERR_BUG;

	la2016_deinit_device(sdi);

	sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
		usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
	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;
	struct sr_usb_dev_inst *usb;
	double rounded;
	const char *label;

	(void)cg;

	if (!sdi)
		return SR_ERR_ARG;
	devc = sdi->priv;

	switch (key) {
	case SR_CONF_CONN:
		if (!sdi->conn)
			return SR_ERR_ARG;
		usb = sdi->conn;
		if (usb->address == 0xff) {
			/*
			 * Device still needs to re-enumerate after firmware
			 * upload, so we don't know its (future) address.
			 */
			return SR_ERR;
		}
		*data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
		break;
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(devc->cur_samplerate);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_CAPTURE_RATIO:
		*data = g_variant_new_uint64(devc->capture_ratio);
		break;
	case SR_CONF_VOLTAGE_THRESHOLD:
		rounded = (int)(devc->threshold_voltage / 0.1) * 0.1;
		*data = std_gvar_tuple_double(rounded, rounded + 0.1);
		return SR_OK;
	case SR_CONF_LOGIC_THRESHOLD:
		label = logic_threshold[devc->threshold_voltage_idx];
		*data = g_variant_new_string(label);
		break;
	case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
		*data = g_variant_new_double(devc->threshold_voltage);
		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;
	double low, high;
	int idx;

	(void)cg;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		devc->cur_samplerate = g_variant_get_uint64(data);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	case SR_CONF_CAPTURE_RATIO:
		devc->capture_ratio = g_variant_get_uint64(data);
		break;
	case SR_CONF_VOLTAGE_THRESHOLD:
		g_variant_get(data, "(dd)", &low, &high);
		devc->threshold_voltage = (low + high) / 2.0;
		devc->threshold_voltage_idx = LOGIC_THRESHOLD_IDX_USER;
		break;
	case SR_CONF_LOGIC_THRESHOLD: {
		if ((idx = std_str_idx(data, ARRAY_AND_SIZE(logic_threshold))) < 0)
			return SR_ERR_ARG;
		if (idx != LOGIC_THRESHOLD_IDX_USER) {
			devc->threshold_voltage = logic_threshold_value[idx];
		}
		devc->threshold_voltage_idx = idx;
		break;
	}
	case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
		devc->threshold_voltage = g_variant_get_double(data);
		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)
{
	struct dev_context *devc;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
	case SR_CONF_DEVICE_OPTIONS:
		return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	case SR_CONF_SAMPLERATE:
		if (!sdi)
			return SR_ERR_ARG;
		devc = sdi->priv;
		if (devc->max_samplerate == SR_MHZ(200)) {
			*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_la2016));
		} else {
			*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_la1016));
		}
		break;
	case SR_CONF_LIMIT_SAMPLES:
		*data = std_gvar_tuple_u64(LA2016_NUM_SAMPLES_MIN, LA2016_NUM_SAMPLES_MAX);
		break;
	case SR_CONF_VOLTAGE_THRESHOLD:
		*data = std_gvar_min_max_step_thresholds(
			LA2016_THR_VOLTAGE_MIN,
			LA2016_THR_VOLTAGE_MAX, 0.1);
		break;
	case SR_CONF_TRIGGER_MATCH:
		*data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
		break;
	case SR_CONF_LOGIC_THRESHOLD:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(logic_threshold));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

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

	devc = sdi->priv;
	devc->cur_channels = 0;
	for (GSList *l = sdi->channels; l; l = l->next) {
		struct sr_channel *ch = (struct sr_channel*)l->data;
		if (ch->enabled == FALSE)
			continue;
		devc->cur_channels |= 1 << ch->index;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di;
	struct drv_context *drvc;
	struct dev_context *devc;
	int ret;

	di = sdi->driver;
	drvc = di->context;
	devc = sdi->priv;

	if (configure_channels(sdi) != SR_OK) {
		sr_err("Cannot configure channels.");
		return SR_ERR;
	}

	devc->convbuffer_size = LA2016_CONVBUFFER_SIZE;
	if (!(devc->convbuffer = g_try_malloc(devc->convbuffer_size))) {
		sr_err("Cannot allocate conversion buffer.");
		return SR_ERR_MALLOC;
	}

	if ((ret = la2016_setup_acquisition(sdi)) != SR_OK) {
		g_free(devc->convbuffer);
		devc->convbuffer = NULL;
		return ret;
	}

	devc->ctx = drvc->sr_ctx;

	if ((ret = la2016_start_acquisition(sdi)) != SR_OK) {
		la2016_abort_acquisition(sdi);
		return ret;
	}

	devc->completion_seen = FALSE;
	usb_source_add(sdi->session, drvc->sr_ctx, 50,
		la2016_receive_data, (void *)sdi);

	std_session_send_df_header(sdi);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi)
{
	int ret;

	ret = la2016_abort_acquisition(sdi);

	return ret;
}

static struct sr_dev_driver kingst_la2016_driver_info = {
	.name = "kingst-la2016",
	.longname = "Kingst LA2016",
	.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(kingst_la2016_driver_info);
Commit	Line	Data
f2cd2deb FS	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2020 Florian Schmidt <schmidt_florian@gmx.de>
	5	* Copyright (C) 2013 Marcus Comstedt <marcus@mc.pp.se>
	6	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
	7	* Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
	8	*
	9	* This program is free software: you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation, either version 3 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	21	*/
	22
96dc954e GS	23	/*
	24	* This driver implementation initially was derived from the
	25	* src/hardware/saleae-logic16/ source code.
	26	*/
f2cd2deb FS	27
f2cd2deb FS	28	#include <config.h>
a7740b06	29
a7740b06	30	#include <libsigrok/libsigrok.h>
f2cd2deb	31	#include <string.h>
a7740b06	32
f2cd2deb FS	33	#include "libsigrok-internal.h"
	34	#include "protocol.h"
	35
	36	static const uint32_t scanopts[] = {
	37	SR_CONF_CONN,
	38	};
	39
	40	static const uint32_t drvopts[] = {
	41	SR_CONF_LOGIC_ANALYZER,
	42	};
	43
	44	static const uint32_t devopts[] = {
	45	/* TODO: SR_CONF_CONTINUOUS, */
	46	SR_CONF_CONN \| SR_CONF_GET,
	47	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	48	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET \| SR_CONF_GET \| SR_CONF_LIST,
	49	SR_CONF_VOLTAGE_THRESHOLD \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	50	SR_CONF_LOGIC_THRESHOLD \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	51	SR_CONF_LOGIC_THRESHOLD_CUSTOM \| SR_CONF_GET \| SR_CONF_SET,
	52	SR_CONF_TRIGGER_MATCH \| SR_CONF_LIST,
	53	SR_CONF_CAPTURE_RATIO \| SR_CONF_GET \| SR_CONF_SET,
	54	};
	55
	56	static const int32_t trigger_matches[] = {
	57	SR_TRIGGER_ZERO,
	58	SR_TRIGGER_ONE,
	59	SR_TRIGGER_RISING,
	60	SR_TRIGGER_FALLING,
	61	};
	62
	63	static const char *channel_names[] = {
955ab604 GS	64	"0", "1", "2", "3", "4", "5", "6", "7",
955ab604 GS	65	"8", "9", "10", "11", "12", "13", "14", "15",
f2cd2deb FS	66	};
f2cd2deb FS	67
8b172e78	68	static const uint64_t samplerates_la2016[] = {
f2cd2deb FS	69	SR_KHZ(20),
	70	SR_KHZ(50),
	71	SR_KHZ(100),
	72	SR_KHZ(200),
	73	SR_KHZ(500),
	74	SR_MHZ(1),
	75	SR_MHZ(2),
	76	SR_MHZ(4),
	77	SR_MHZ(5),
	78	SR_MHZ(8),
	79	SR_MHZ(10),
	80	SR_MHZ(20),
	81	SR_MHZ(50),
	82	SR_MHZ(100),
	83	SR_MHZ(200),
	84	};
	85
8b172e78 KG	86	static const uint64_t samplerates_la1016[] = {
	87	SR_KHZ(20),
	88	SR_KHZ(50),
	89	SR_KHZ(100),
	90	SR_KHZ(200),
	91	SR_KHZ(500),
	92	SR_MHZ(1),
	93	SR_MHZ(2),
	94	SR_MHZ(4),
	95	SR_MHZ(5),
	96	SR_MHZ(8),
	97	SR_MHZ(10),
	98	SR_MHZ(20),
	99	SR_MHZ(50),
	100	SR_MHZ(100),
	101	};
	102
f2cd2deb FS	103	static const float logic_threshold_value[] = {
	104	1.58,
	105	2.5,
	106	1.165,
	107	1.5,
	108	1.25,
	109	0.9,
	110	0.75,
	111	0.60,
	112	0.45,
	113	};
	114
	115	static const char *logic_threshold[] = {
	116	"TTL 5V",
	117	"CMOS 5V",
	118	"CMOS 3.3V",
	119	"CMOS 3.0V",
	120	"CMOS 2.5V",
	121	"CMOS 1.8V",
	122	"CMOS 1.5V",
	123	"CMOS 1.2V",
	124	"CMOS 0.9V",
	125	"USER",
	126	};
	127
da2cb50d	128	#define LOGIC_THRESHOLD_IDX_USER (ARRAY_SIZE(logic_threshold) - 1)
f2cd2deb	129
f2cd2deb FS	130	static GSList scan(struct sr_dev_driver di, GSList *options)
	131	{
	132	struct drv_context *drvc;
	133	struct dev_context *devc;
	134	struct sr_dev_inst *sdi;
	135	struct sr_usb_dev_inst *usb;
	136	struct sr_config *src;
	137	GSList *l;
	138	GSList *devices;
	139	GSList *conn_devices;
	140	struct libusb_device_descriptor des;
	141	libusb_device **devlist;
	142	unsigned int i, j;
	143	const char *conn;
	144	char connection_id[64];
22cb067a	145	uint64_t fw_uploaded;
f2cd2deb FS	146	unsigned int dev_addr;
	147
	148	drvc = di->context;
	149
	150	conn = NULL;
	151	for (l = options; l; l = l->next) {
	152	src = l->data;
	153	switch (src->key) {
	154	case SR_CONF_CONN:
	155	conn = g_variant_get_string(src->data, NULL);
	156	break;
	157	}
	158	}
	159	if (conn)
	160	conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	161	else
	162	conn_devices = NULL;
	163
96dc954e	164	/* Find all LA2016 devices, optionally upload firmware to them. */
f2cd2deb FS	165	devices = NULL;
	166	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	167	for (i = 0; devlist[i]; i++) {
	168	if (conn) {
	169	usb = NULL;
	170	for (l = conn_devices; l; l = l->next) {
	171	usb = l->data;
955ab604 GS	172	if (usb->bus == libusb_get_bus_number(devlist[i]) &&
955ab604 GS	173	usb->address == libusb_get_device_address(devlist[i]))
f2cd2deb FS	174	break;
f2cd2deb FS	175	}
955ab604	176	if (!l) {
96dc954e GS	177	/*
	178	* A connection parameter was specified and
	179	* this device does not match the filter.
	180	*/
f2cd2deb	181	continue;
955ab604	182	}
f2cd2deb FS	183	}
	184
	185	libusb_get_device_descriptor(devlist[i], &des);
	186
	187	if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
	188	continue;
	189
	190	if (des.idVendor != LA2016_VID \|\| des.idProduct != LA2016_PID)
	191	continue;
	192
96dc954e	193	/* USB identification matches, a device was found. */
cf057ac4	194	sr_dbg("Found a device (USB identification).");
f2cd2deb FS	195	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	196	sdi->status = SR_ST_INITIALIZING;
	197	sdi->connection_id = g_strdup(connection_id);
	198
22cb067a	199	fw_uploaded = 0;
f2cd2deb	200	dev_addr = libusb_get_device_address(devlist[i]);
852c7d14	201	if (des.iProduct != LA2016_IPRODUCT_INDEX) {
91f73872	202	sr_info("Device at '%s' has no firmware loaded.", connection_id);
f2cd2deb FS	203
f2cd2deb FS	204	if (la2016_upload_firmware(drvc->sr_ctx, devlist[i], des.idProduct) != SR_OK) {
91f73872	205	sr_err("MCU firmware upload failed.");
f2cd2deb FS	206	g_free(sdi->connection_id);
	207	g_free(sdi);
	208	continue;
	209	}
22cb067a	210	fw_uploaded = g_get_monotonic_time();
96dc954e GS	211	/* Will re-enumerate. Mark as "unknown address yet". */
96dc954e GS	212	dev_addr = 0xff;
f2cd2deb FS	213	}
	214
	215	sdi->vendor = g_strdup("Kingst");
	216	sdi->model = g_strdup("LA2016");
	217
	218	for (j = 0; j < ARRAY_SIZE(channel_names); j++)
	219	sr_channel_new(sdi, j, SR_CHANNEL_LOGIC, TRUE, channel_names[j]);
	220
	221	devices = g_slist_append(devices, sdi);
	222
	223	devc = g_malloc0(sizeof(struct dev_context));
	224	sdi->priv = devc;
22cb067a	225	devc->fw_uploaded = fw_uploaded;
f2cd2deb FS	226	devc->threshold_voltage_idx = 0;
	227	devc->threshold_voltage = logic_threshold_value[devc->threshold_voltage_idx];
	228
	229	sdi->status = SR_ST_INACTIVE;
	230	sdi->inst_type = SR_INST_USB;
	231
	232	sdi->conn = sr_usb_dev_inst_new(
	233	libusb_get_bus_number(devlist[i]),
	234	dev_addr, NULL);
	235	}
	236	libusb_free_device_list(devlist, 1);
	237	g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
	238
	239	return std_scan_complete(di, devices);
	240	}
	241
	242	static int la2016_dev_open(struct sr_dev_inst *sdi)
	243	{
	244	struct sr_dev_driver *di;
	245	libusb_device **devlist;
	246	struct sr_usb_dev_inst *usb;
	247	struct libusb_device_descriptor des;
	248	struct drv_context *drvc;
	249	int ret, i, device_count;
	250	char connection_id[64];
	251
	252	di = sdi->driver;
	253	drvc = di->context;
	254	usb = sdi->conn;
	255	ret = SR_ERR;
	256
	257	device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	258	if (device_count < 0) {
	259	sr_err("Failed to get device list: %s.", libusb_error_name(device_count));
	260	return SR_ERR;
	261	}
	262
	263	for (i = 0; i < device_count; i++) {
	264	libusb_get_device_descriptor(devlist[i], &des);
	265
852c7d14 GS	266	if (des.idVendor != LA2016_VID \|\| des.idProduct != LA2016_PID)
	267	continue;
	268	if (des.iProduct != LA2016_IPRODUCT_INDEX)
f2cd2deb FS	269	continue;
	270
	271	if ((sdi->status == SR_ST_INITIALIZING) \|\| (sdi->status == SR_ST_INACTIVE)) {
96dc954e	272	/* Check physical USB bus/port address. */
f2cd2deb FS	273	if (usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)) < 0)
	274	continue;
	275
96dc954e GS	276	if (strcmp(sdi->connection_id, connection_id)) {
96dc954e GS	277	/* Not the device we looked up before. */
f2cd2deb	278	continue;
96dc954e	279	}
f2cd2deb FS	280	}
	281
	282	if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
96dc954e	283	if (usb->address == 0xff) {
f2cd2deb	284	/*
96dc954e GS	285	* First encounter after firmware upload.
96dc954e GS	286	* Grab current address after enumeration.
f2cd2deb FS	287	*/
f2cd2deb FS	288	usb->address = libusb_get_device_address(devlist[i]);
96dc954e	289	}
f2cd2deb FS	290	} else {
	291	sr_err("Failed to open device: %s.", libusb_error_name(ret));
	292	ret = SR_ERR;
	293	break;
	294	}
	295
	296	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	297	if (ret == LIBUSB_ERROR_BUSY) {
91f73872	298	sr_err("Cannot claim USB interface. Another program or driver using it?");
f2cd2deb FS	299	ret = SR_ERR;
	300	break;
	301	} else if (ret == LIBUSB_ERROR_NO_DEVICE) {
	302	sr_err("Device has been disconnected.");
	303	ret = SR_ERR;
	304	break;
	305	} else if (ret != 0) {
91f73872	306	sr_err("Cannot claim USB interface: %s.", libusb_error_name(ret));
f2cd2deb FS	307	ret = SR_ERR;
	308	break;
	309	}
	310
	311	if ((ret = la2016_init_device(sdi)) != SR_OK) {
91f73872	312	sr_err("Cannot initialize device.");
f2cd2deb FS	313	break;
	314	}
	315
	316	sr_info("Opened device on %d.%d (logical) / %s (physical), interface %d.",
	317	usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
	318
	319	ret = SR_OK;
	320
	321	break;
	322	}
	323
	324	libusb_free_device_list(devlist, 1);
	325
	326	if (ret != SR_OK) {
	327	if (usb->devhdl) {
	328	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	329	libusb_close(usb->devhdl);
	330	usb->devhdl = NULL;
	331	}
	332	return SR_ERR;
	333	}
	334
	335	return SR_OK;
	336	}
	337
	338	static int dev_open(struct sr_dev_inst *sdi)
	339	{
	340	struct dev_context *devc;
22cb067a	341	uint64_t reset_done, now, elapsed_ms;
f2cd2deb FS	342	int ret;
	343
	344	devc = sdi->priv;
	345
	346	/*
22cb067a GS	347	* When the sigrok driver recently has uploaded MCU firmware,
	348	* then wait for the FX2 to re-enumerate. Allow the USB device
	349	* to vanish before it reappears. Timeouts are rough estimates
	350	* after all, the imprecise time of the last check (potentially
	351	* executes after the total check period) simplifies code paths
	352	* with optional diagnostics. And increases the probability of
	353	* successfully detecting "late/slow" devices.
f2cd2deb	354	*/
22cb067a	355	if (devc->fw_uploaded) {
f2cd2deb	356	sr_info("Waiting for device to reset after firmware upload.");
f2cd2deb	357	now = g_get_monotonic_time();
22cb067a GS	358	reset_done = devc->fw_uploaded + RENUM_GONE_DELAY_MS * 1000;
22cb067a GS	359	if (now < reset_done)
f2cd2deb	360	g_usleep(reset_done - now);
22cb067a GS	361	do {
	362	now = g_get_monotonic_time();
	363	elapsed_ms = (now - devc->fw_uploaded) / 1000;
	364	sr_spew("Waited %" PRIu64 "ms.", elapsed_ms);
	365	ret = la2016_dev_open(sdi);
	366	if (ret == SR_OK) {
	367	devc->fw_uploaded = 0;
f2cd2deb	368	break;
22cb067a GS	369	}
	370	g_usleep(RENUM_POLL_INTERVAL_MS * 1000);
	371	} while (elapsed_ms < RENUM_CHECK_PERIOD_MS);
f2cd2deb FS	372	if (ret != SR_OK) {
	373	sr_err("Device failed to re-enumerate.");
	374	return SR_ERR;
	375	}
22cb067a	376	sr_info("Device came back after %" PRIi64 "ms.", elapsed_ms);
955ab604	377	} else {
f2cd2deb	378	ret = la2016_dev_open(sdi);
955ab604	379	}
f2cd2deb FS	380
f2cd2deb FS	381	if (ret != SR_OK) {
91f73872	382	sr_err("Cannot open device.");
f2cd2deb FS	383	return SR_ERR;
	384	}
	385
	386	return SR_OK;
	387	}
	388
	389	static int dev_close(struct sr_dev_inst *sdi)
	390	{
	391	struct sr_usb_dev_inst *usb;
	392
	393	usb = sdi->conn;
	394
	395	if (!usb->devhdl)
	396	return SR_ERR_BUG;
	397
	398	la2016_deinit_device(sdi);
	399
	400	sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
	401	usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
	402	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	403	libusb_close(usb->devhdl);
	404	usb->devhdl = NULL;
	405
	406	return SR_OK;
	407	}
	408
955ab604 GS	409	static int config_get(uint32_t key, GVariant **data,
955ab604 GS	410	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
f2cd2deb FS	411	{
	412	struct dev_context *devc;
	413	struct sr_usb_dev_inst *usb;
	414	double rounded;
da2cb50d	415	const char *label;
f2cd2deb FS	416
	417	(void)cg;
	418
	419	if (!sdi)
	420	return SR_ERR_ARG;
	421	devc = sdi->priv;
	422
	423	switch (key) {
	424	case SR_CONF_CONN:
	425	if (!sdi->conn)
	426	return SR_ERR_ARG;
	427	usb = sdi->conn;
96dc954e GS	428	if (usb->address == 0xff) {
	429	/*
	430	* Device still needs to re-enumerate after firmware
	431	* upload, so we don't know its (future) address.
	432	*/
f2cd2deb	433	return SR_ERR;
955ab604	434	}
f2cd2deb FS	435	*data = g_variant_new_printf("%d.%d", usb->bus, usb->address);
	436	break;
	437	case SR_CONF_SAMPLERATE:
	438	*data = g_variant_new_uint64(devc->cur_samplerate);
	439	break;
	440	case SR_CONF_LIMIT_SAMPLES:
	441	*data = g_variant_new_uint64(devc->limit_samples);
	442	break;
	443	case SR_CONF_CAPTURE_RATIO:
	444	*data = g_variant_new_uint64(devc->capture_ratio);
	445	break;
	446	case SR_CONF_VOLTAGE_THRESHOLD:
	447	rounded = (int)(devc->threshold_voltage / 0.1) * 0.1;
	448	*data = std_gvar_tuple_double(rounded, rounded + 0.1);
	449	return SR_OK;
	450	case SR_CONF_LOGIC_THRESHOLD:
da2cb50d GS	451	label = logic_threshold[devc->threshold_voltage_idx];
da2cb50d GS	452	*data = g_variant_new_string(label);
f2cd2deb FS	453	break;
	454	case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
	455	*data = g_variant_new_double(devc->threshold_voltage);
	456	break;
955ab604	457
f2cd2deb FS	458	default:
	459	return SR_ERR_NA;
	460	}
	461
	462	return SR_OK;
	463	}
	464
955ab604 GS	465	static int config_set(uint32_t key, GVariant *data,
955ab604 GS	466	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
f2cd2deb FS	467	{
	468	struct dev_context *devc;
	469	double low, high;
	470	int idx;
	471
	472	(void)cg;
	473
	474	devc = sdi->priv;
	475
	476	switch (key) {
	477	case SR_CONF_SAMPLERATE:
	478	devc->cur_samplerate = g_variant_get_uint64(data);
	479	break;
	480	case SR_CONF_LIMIT_SAMPLES:
	481	devc->limit_samples = g_variant_get_uint64(data);
	482	break;
	483	case SR_CONF_CAPTURE_RATIO:
	484	devc->capture_ratio = g_variant_get_uint64(data);
	485	break;
	486	case SR_CONF_VOLTAGE_THRESHOLD:
	487	g_variant_get(data, "(dd)", &low, &high);
	488	devc->threshold_voltage = (low + high) / 2.0;
da2cb50d	489	devc->threshold_voltage_idx = LOGIC_THRESHOLD_IDX_USER;
f2cd2deb FS	490	break;
f2cd2deb FS	491	case SR_CONF_LOGIC_THRESHOLD: {
da2cb50d	492	if ((idx = std_str_idx(data, ARRAY_AND_SIZE(logic_threshold))) < 0)
f2cd2deb	493	return SR_ERR_ARG;
da2cb50d	494	if (idx != LOGIC_THRESHOLD_IDX_USER) {
f2cd2deb FS	495	devc->threshold_voltage = logic_threshold_value[idx];
	496	}
	497	devc->threshold_voltage_idx = idx;
	498	break;
	499	}
	500	case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
	501	devc->threshold_voltage = g_variant_get_double(data);
	502	break;
	503	default:
	504	return SR_ERR_NA;
	505	}
	506
	507	return SR_OK;
	508	}
	509
955ab604 GS	510	static int config_list(uint32_t key, GVariant **data,
955ab604 GS	511	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
f2cd2deb	512	{
8b172e78 KG	513	struct dev_context *devc;
8b172e78 KG	514
f2cd2deb FS	515	switch (key) {
	516	case SR_CONF_SCAN_OPTIONS:
	517	case SR_CONF_DEVICE_OPTIONS:
	518	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	519	case SR_CONF_SAMPLERATE:
fb28e72d MW	520	if (!sdi)
	521	return SR_ERR_ARG;
	522	devc = sdi->priv;
8b172e78 KG	523	if (devc->max_samplerate == SR_MHZ(200)) {
8b172e78 KG	524	*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_la2016));
1ed93110	525	} else {
8b172e78 KG	526	*data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates_la1016));
8b172e78 KG	527	}
f2cd2deb FS	528	break;
	529	case SR_CONF_LIMIT_SAMPLES:
	530	*data = std_gvar_tuple_u64(LA2016_NUM_SAMPLES_MIN, LA2016_NUM_SAMPLES_MAX);
	531	break;
	532	case SR_CONF_VOLTAGE_THRESHOLD:
	533	*data = std_gvar_min_max_step_thresholds(
	534	LA2016_THR_VOLTAGE_MIN,
	535	LA2016_THR_VOLTAGE_MAX, 0.1);
	536	break;
	537	case SR_CONF_TRIGGER_MATCH:
	538	*data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
	539	break;
	540	case SR_CONF_LOGIC_THRESHOLD:
da2cb50d	541	*data = g_variant_new_strv(ARRAY_AND_SIZE(logic_threshold));
f2cd2deb FS	542	break;
	543	default:
	544	return SR_ERR_NA;
	545	}
	546
	547	return SR_OK;
	548	}
	549
f2cd2deb FS	550	static int configure_channels(const struct sr_dev_inst *sdi)
	551	{
	552	struct dev_context *devc;
	553
	554	devc = sdi->priv;
	555	devc->cur_channels = 0;
f2cd2deb FS	556	for (GSList *l = sdi->channels; l; l = l->next) {
	557	struct sr_channel ch = (struct sr_channel)l->data;
	558	if (ch->enabled == FALSE)
	559	continue;
955ab604	560	devc->cur_channels \|= 1 << ch->index;
f2cd2deb FS	561	}
	562
	563	return SR_OK;
	564	}
	565
	566	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	567	{
	568	struct sr_dev_driver *di;
	569	struct drv_context *drvc;
	570	struct dev_context *devc;
	571	int ret;
	572
	573	di = sdi->driver;
	574	drvc = di->context;
	575	devc = sdi->priv;
	576
	577	if (configure_channels(sdi) != SR_OK) {
91f73872	578	sr_err("Cannot configure channels.");
f2cd2deb FS	579	return SR_ERR;
	580	}
	581
852c7d14	582	devc->convbuffer_size = LA2016_CONVBUFFER_SIZE;
f2cd2deb	583	if (!(devc->convbuffer = g_try_malloc(devc->convbuffer_size))) {
91f73872	584	sr_err("Cannot allocate conversion buffer.");
f2cd2deb FS	585	return SR_ERR_MALLOC;
	586	}
	587
	588	if ((ret = la2016_setup_acquisition(sdi)) != SR_OK) {
	589	g_free(devc->convbuffer);
	590	devc->convbuffer = NULL;
	591	return ret;
	592	}
	593
	594	devc->ctx = drvc->sr_ctx;
	595
	596	if ((ret = la2016_start_acquisition(sdi)) != SR_OK) {
3ebc1cb2	597	la2016_abort_acquisition(sdi);
f2cd2deb FS	598	return ret;
	599	}
	600
cf057ac4	601	devc->completion_seen = FALSE;
388438e4 GS	602	usb_source_add(sdi->session, drvc->sr_ctx, 50,
388438e4 GS	603	la2016_receive_data, (void *)sdi);
f2cd2deb FS	604
	605	std_session_send_df_header(sdi);
	606
	607	return SR_OK;
	608	}
	609
	610	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	611	{
	612	int ret;
	613
	614	ret = la2016_abort_acquisition(sdi);
f2cd2deb FS	615
	616	return ret;
	617	}
	618
	619	static struct sr_dev_driver kingst_la2016_driver_info = {
	620	.name = "kingst-la2016",
	621	.longname = "Kingst LA2016",
	622	.api_version = 1,
	623	.init = std_init,
	624	.cleanup = std_cleanup,
	625	.scan = scan,
	626	.dev_list = std_dev_list,
	627	.dev_clear = std_dev_clear,
	628	.config_get = config_get,
	629	.config_set = config_set,
	630	.config_list = config_list,
	631	.dev_open = dev_open,
	632	.dev_close = dev_close,
	633	.dev_acquisition_start = dev_acquisition_start,
	634	.dev_acquisition_stop = dev_acquisition_stop,
	635	.context = NULL,
	636	};
	637	SR_REGISTER_DEV_DRIVER(kingst_la2016_driver_info);