[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/>.
 */

/* mostly stolen from src/hardware/saleae-logic16/ */

#include <config.h>
#include <glib.h>
#include <libusb.h>
#include <stdlib.h>
#include <string.h>
#include <math.h>
#include <libsigrok/libsigrok.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 MAX_NUM_LOGIC_THRESHOLD_ENTRIES ARRAY_SIZE(logic_threshold)

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];
	int64_t fw_updated;
	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 and 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) {
				/* This device matched none of the ones that
				 * matched the conn specification. */
				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;

		/* Already has the firmware */
		sr_dbg("Found a LA2016 device.");
		sdi = g_malloc0(sizeof(struct sr_dev_inst));
		sdi->status = SR_ST_INITIALIZING;
		sdi->connection_id = g_strdup(connection_id);

		fw_updated = 0;
		dev_addr = libusb_get_device_address(devlist[i]);
		if (des.iProduct != 2) {
			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("uC firmware upload failed!");
				g_free(sdi->connection_id);
				g_free(sdi);
				continue;
			}
			fw_updated = g_get_monotonic_time();
			dev_addr = 0xff; /* to mark that we don't know address yet... ugly */
		}

		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_updated = fw_updated;
		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 || des.iProduct != 2)
			continue;

		if ((sdi->status == SR_ST_INITIALIZING) || (sdi->status == SR_ST_INACTIVE)) {
			/*
			 * Check device by its 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))
				/* This is not the one. */
				continue;
		}

		if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
			if (usb->address == 0xff)
				/*
				 * First time we touch this device after FW
				 * upload, so we don't know the address yet.
				 */
				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("Unable to claim USB interface. Another "
			       "program or driver has already claimed 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("Unable to claim interface: %s.", libusb_error_name(ret));
			ret = SR_ERR;
			break;
		}

		if ((ret = la2016_init_device(sdi)) != SR_OK) {
			sr_err("Failed to init 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;
	int64_t timediff_us, timediff_ms;
	uint64_t reset_done;
	uint64_t now;
	int ret;

	devc = sdi->priv;

	/*
	 * If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
	 * milliseconds for the FX2 to renumerate.
	 */
	ret = SR_ERR;
	if (devc->fw_updated > 0) {
		sr_info("Waiting for device to reset after firmware upload.");
		/* Takes >= 2000ms for the uC to be gone from the USB bus. */
		reset_done = devc->fw_updated + 18 * (uint64_t)1e5; /* 1.8 seconds */
		now = g_get_monotonic_time();
		if (reset_done > now)
			g_usleep(reset_done - now);
		timediff_ms = 0;
		while (timediff_ms < MAX_RENUM_DELAY_MS) {
			g_usleep(200 * 1000);

			timediff_us = g_get_monotonic_time() - devc->fw_updated;
			timediff_ms = timediff_us / 1000;

			if ((ret = la2016_dev_open(sdi)) == SR_OK)
				break;
			sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
		}
		if (ret != SR_OK) {
			sr_err("Device failed to re-enumerate.");
			return SR_ERR;
		}
		sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
	} else {
		ret = la2016_dev_open(sdi);
	}

	if (ret != SR_OK) {
		sr_err("Unable to 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;

	(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 == 255) {
			/* 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:
		*data = g_variant_new_string(logic_threshold[devc->threshold_voltage_idx]);
		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 = MAX_NUM_LOGIC_THRESHOLD_ENTRIES - 1; /* USER */
		break;
	case SR_CONF_LOGIC_THRESHOLD: {
		if ((idx = std_str_idx(data, logic_threshold, MAX_NUM_LOGIC_THRESHOLD_ENTRIES)) < 0)
			return SR_ERR_ARG;
		if (idx == MAX_NUM_LOGIC_THRESHOLD_ENTRIES - 1) {
			/* user threshold */
		} else {
			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(logic_threshold, MAX_NUM_LOGIC_THRESHOLD_ENTRIES);
		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;
	devc->num_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;
		devc->num_channels++;
	}

	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("Failed to configure channels.");
		return SR_ERR;
	}

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