[libsigrok.git] / src / hardware / dreamsourcelab-dslogic / api.c

/*
 * This file is part of the libsigrok project.
 *
 * 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/>.
 */

#include <config.h>
#include <math.h>
#include "protocol.h"

static const struct dslogic_profile supported_device[] = {
	/* DreamSourceLab DSLogic */
	{ 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
		"dreamsourcelab-dslogic-fx2.fw",
		0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
	/* DreamSourceLab DSCope */
	{ 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
		"dreamsourcelab-dscope-fx2.fw",
		0, "DreamSourceLab", "DSCope", 256 * 1024 * 1024},
	/* DreamSourceLab DSLogic Pro */
	{ 0x2a0e, 0x0003, "DreamSourceLab", "DSLogic Pro", NULL,
		"dreamsourcelab-dslogic-pro-fx2.fw",
		0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
	/* DreamSourceLab DSLogic Plus */
	{ 0x2a0e, 0x0020, "DreamSourceLab", "DSLogic Plus", NULL,
		"dreamsourcelab-dslogic-plus-fx2.fw",
		0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
	/* DreamSourceLab DSLogic Basic */
	{ 0x2a0e, 0x0021, "DreamSourceLab", "DSLogic Basic", NULL,
		"dreamsourcelab-dslogic-basic-fx2.fw",
		0, "DreamSourceLab", "DSLogic", 256 * 1024},

	ALL_ZERO
};

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

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

static const uint32_t devopts[] = {
	SR_CONF_CONTINUOUS | SR_CONF_SET | SR_CONF_GET,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_VOLTAGE_THRESHOLD | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_CONN | SR_CONF_GET,
	SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
	SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

static const char *const signal_edge_names[] = {
	[DS_EDGE_RISING] = "rising",
	[DS_EDGE_FALLING] = "falling",
};

static const struct {
	gdouble low;
	gdouble high;
} voltage_thresholds[] = {
	{ 0.7, 1.4 },
	{ 1.4, 3.6 },
};

static const uint64_t samplerates[] = {
	SR_KHZ(10),
	SR_KHZ(20),
	SR_KHZ(50),
	SR_KHZ(100),
	SR_KHZ(200),
	SR_KHZ(500),
	SR_MHZ(1),
	SR_MHZ(2),
	SR_MHZ(5),
	SR_MHZ(10),
	SR_MHZ(20),
	SR_MHZ(25),
	SR_MHZ(50),
	SR_MHZ(100),
	SR_MHZ(200),
	SR_MHZ(400),
};

static gboolean is_plausible(const struct libusb_device_descriptor *des)
{
	int i;

	for (i = 0; supported_device[i].vid; i++) {
		if (des->idVendor != supported_device[i].vid)
			continue;
		if (des->idProduct == supported_device[i].pid)
			return TRUE;
	}

	return FALSE;
}

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_channel *ch;
	struct sr_channel_group *cg;
	struct sr_config *src;
	const struct dslogic_profile *prof;
	GSList *l, *devices, *conn_devices;
	gboolean has_firmware;
	struct libusb_device_descriptor des;
	libusb_device **devlist;
	struct libusb_device_handle *hdl;
	int ret, i, j;
	const char *conn;
	char manufacturer[64], product[64], serial_num[64], connection_id[64];
	char channel_name[16];

	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 DSLogic compatible 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 (!is_plausible(&des))
			continue;

		if ((ret = libusb_open(devlist[i], &hdl)) < 0) {
			sr_warn("Failed to open potential device with "
				"VID:PID %04x:%04x: %s.", des.idVendor,
				des.idProduct, libusb_error_name(ret));
			continue;
		}

		if (des.iManufacturer == 0) {
			manufacturer[0] = '\0';
		} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
				des.iManufacturer, (unsigned char *) manufacturer,
				sizeof(manufacturer))) < 0) {
			sr_warn("Failed to get manufacturer string descriptor: %s.",
				libusb_error_name(ret));
			continue;
		}

		if (des.iProduct == 0) {
			product[0] = '\0';
		} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
				des.iProduct, (unsigned char *) product,
				sizeof(product))) < 0) {
			sr_warn("Failed to get product string descriptor: %s.",
				libusb_error_name(ret));
			continue;
		}

		if (des.iSerialNumber == 0) {
			serial_num[0] = '\0';
		} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
				des.iSerialNumber, (unsigned char *) serial_num,
				sizeof(serial_num))) < 0) {
			sr_warn("Failed to get serial number string descriptor: %s.",
				libusb_error_name(ret));
			continue;
		}

		usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));

		libusb_close(hdl);

		prof = NULL;
		for (j = 0; supported_device[j].vid; j++) {
			if (des.idVendor == supported_device[j].vid &&
					des.idProduct == supported_device[j].pid) {
				prof = &supported_device[j];
				break;
			}
		}

		if (!prof)
			continue;

		sdi = g_malloc0(sizeof(struct sr_dev_inst));
		sdi->status = SR_ST_INITIALIZING;
		sdi->vendor = g_strdup(prof->vendor);
		sdi->model = g_strdup(prof->model);
		sdi->version = g_strdup(prof->model_version);
		sdi->serial_num = g_strdup(serial_num);
		sdi->connection_id = g_strdup(connection_id);

		/* Logic channels, all in one channel group. */
		cg = g_malloc0(sizeof(struct sr_channel_group));
		cg->name = g_strdup("Logic");
		for (j = 0; j < 16; j++) {
			sprintf(channel_name, "%d", j);
			ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC,
						TRUE, channel_name);
			cg->channels = g_slist_append(cg->channels, ch);
		}
		sdi->channel_groups = g_slist_append(NULL, cg);

		devc = dslogic_dev_new();
		devc->profile = prof;
		sdi->priv = devc;
		devices = g_slist_append(devices, sdi);

		devc->samplerates = samplerates;
		devc->num_samplerates = ARRAY_SIZE(samplerates);
		has_firmware = usb_match_manuf_prod(devlist[i], "DreamSourceLab", "USB-based Instrument");

		if (has_firmware) {
			/* Already has the firmware, so fix the new address. */
			sr_dbg("Found a DSLogic device.");
			sdi->status = SR_ST_INACTIVE;
			sdi->inst_type = SR_INST_USB;
			sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
					libusb_get_device_address(devlist[i]), NULL);
		} else {
			if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
					USB_CONFIGURATION, prof->firmware) == SR_OK)
				/* Store when this device's FW was updated. */
				devc->fw_updated = g_get_monotonic_time();
			else
				sr_err("Firmware upload failed for "
				       "device %d.%d (logical).",
				       libusb_get_bus_number(devlist[i]),
				       libusb_get_device_address(devlist[i]));
			sdi->inst_type = SR_INST_USB;
			sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
					0xff, 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 dev_open(struct sr_dev_inst *sdi)
{
	struct sr_dev_driver *di = sdi->driver;
	struct sr_usb_dev_inst *usb;
	struct dev_context *devc;
	int ret;
	int64_t timediff_us, timediff_ms;

	devc = sdi->priv;
	usb = sdi->conn;

	/*
	 * 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.");
		/* Takes >= 300ms for the FX2 to be gone from the USB bus. */
		g_usleep(300 * 1000);
		timediff_ms = 0;
		while (timediff_ms < MAX_RENUM_DELAY_MS) {
			if ((ret = dslogic_dev_open(sdi, di)) == SR_OK)
				break;
			g_usleep(100 * 1000);

			timediff_us = g_get_monotonic_time() - devc->fw_updated;
			timediff_ms = timediff_us / 1000;
			sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
		}
		if (ret != SR_OK) {
			sr_err("Device failed to renumerate.");
			return SR_ERR;
		}
		sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
	} else {
		sr_info("Firmware upload was not needed.");
		ret = dslogic_dev_open(sdi, di);
	}

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

	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	if (ret != 0) {
		switch (ret) {
		case LIBUSB_ERROR_BUSY:
			sr_err("Unable to claim USB interface. Another "
			       "program or driver has already claimed it.");
			break;
		case LIBUSB_ERROR_NO_DEVICE:
			sr_err("Device has been disconnected.");
			break;
		default:
			sr_err("Unable to claim interface: %s.",
			       libusb_error_name(ret));
			break;
		}

		return SR_ERR;
	}


	if ((ret = dslogic_fpga_firmware_upload(sdi)) != SR_OK)
		return ret;

	if (devc->cur_samplerate == 0) {
		/* Samplerate hasn't been set; default to the slowest one. */
		devc->cur_samplerate = devc->samplerates[0];
	}

	if (devc->cur_threshold == 0.0)
		devc->cur_threshold = 1.5;

	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;

	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;
	unsigned int i, voltage_range;
	char str[128];

	(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;
		snprintf(str, 128, "%d.%d", usb->bus, usb->address);
		*data = g_variant_new_string(str);
		break;
	case SR_CONF_VOLTAGE_THRESHOLD:
		if (!strcmp(devc->profile->model, "DSLogic")) {
			voltage_range = 0;

			for (i = 0; i < ARRAY_SIZE(voltage_thresholds); i++)
				if (voltage_thresholds[i].low == devc->cur_threshold) {
					voltage_range = i;
					break;
				}
			*data = std_gvar_tuple_double(voltage_thresholds[voltage_range].low,
					voltage_thresholds[voltage_range].high);
		} else {
			*data = std_gvar_tuple_double(devc->cur_threshold, devc->cur_threshold);
		}
		break;
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(devc->cur_samplerate);
		break;
	case SR_CONF_CAPTURE_RATIO:
		*data = g_variant_new_uint64(devc->capture_ratio);
		break;
	case SR_CONF_EXTERNAL_CLOCK:
		*data = g_variant_new_boolean(devc->external_clock);
		break;
	case SR_CONF_CONTINUOUS:
		*data = g_variant_new_boolean(devc->continuous_mode);
		break;
	case SR_CONF_CLOCK_EDGE:
		i = devc->clock_edge;
		if (i >= ARRAY_SIZE(signal_edge_names))
			return SR_ERR_BUG;
		*data = g_variant_new_string(signal_edge_names[0]);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

/*
 * Helper for mapping a string-typed configuration value to an index
 * within a table of possible values.
 */
static int lookup_index(GVariant *value, const char *const *table, int len)
{
	const char *entry;
	int i;

	entry = g_variant_get_string(value, NULL);
	if (!entry)
		return -1;

	/* Linear search is fine for very small tables. */
	for (i = 0; i < len; i++) {
		if (strcmp(entry, table[i]) == 0)
			return i;
	}

	return -1;
}

static int config_set(uint32_t key, GVariant *data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	uint64_t arg;
	int i, ret;
	gdouble low, high;

	(void)cg;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;

	ret = SR_OK;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		arg = g_variant_get_uint64(data);
		for (i = 0; i < devc->num_samplerates; i++) {
			if (devc->samplerates[i] == arg) {
				devc->cur_samplerate = arg;
				break;
			}
		}
		if (i == devc->num_samplerates)
			ret = SR_ERR_ARG;
		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);
		ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
		break;
	case SR_CONF_VOLTAGE_THRESHOLD:
		g_variant_get(data, "(dd)", &low, &high);
		if (!strcmp(devc->profile->model, "DSLogic")) {
			for (i = 0; (unsigned int)i < ARRAY_SIZE(voltage_thresholds); i++) {
				if (fabs(voltage_thresholds[i].low - low) < 0.1 &&
				    fabs(voltage_thresholds[i].high - high) < 0.1) {
					devc->cur_threshold =
						voltage_thresholds[i].low;
					break;
				}
			}
			ret = dslogic_fpga_firmware_upload(sdi);
		} else {
			ret = dslogic_set_voltage_threshold(sdi, (low + high) / 2.0);
		}
		break;
	case SR_CONF_EXTERNAL_CLOCK:
		devc->external_clock = g_variant_get_boolean(data);
		break;
	case SR_CONF_CONTINUOUS:
		devc->continuous_mode = g_variant_get_boolean(data);
		break;
	case SR_CONF_CLOCK_EDGE:
		i = lookup_index(data, ARRAY_AND_SIZE(signal_edge_names));
		if (i < 0)
			return SR_ERR_ARG;
		devc->clock_edge = i;
		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)
{
	struct dev_context *devc;
	GVariant *gvar, *range[2];
	GVariantBuilder gvb;
	unsigned int i;

	devc = (sdi) ? sdi->priv : NULL;

	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_VOLTAGE_THRESHOLD:
		if (!strcmp(devc->profile->model, "DSLogic")) {
			g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
			for (i = 0; i < ARRAY_SIZE(voltage_thresholds); i++) {
				range[0] = g_variant_new_double(voltage_thresholds[i].low);
				range[1] = g_variant_new_double(voltage_thresholds[i].high);
				gvar = g_variant_new_tuple(range, 2);
				g_variant_builder_add_value(&gvb, gvar);
			}
			*data = g_variant_builder_end(&gvb);
		} else {
			*data = std_gvar_min_max_step_thresholds(0.0, 5.0, 0.1);
		}
		break;
	case SR_CONF_SAMPLERATE:
		*data = std_gvar_samplerates(devc->samplerates, devc->num_samplerates);
		break;
	case SR_CONF_CLOCK_EDGE:
		*data = g_variant_new_strv(ARRAY_AND_SIZE(signal_edge_names));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static struct sr_dev_driver dreamsourcelab_dslogic_driver_info = {
	.name = "dreamsourcelab-dslogic",
	.longname = "DreamSourceLab DSLogic",
	.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 = dslogic_acquisition_start,
	.dev_acquisition_stop = dslogic_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(dreamsourcelab_dslogic_driver_info);
Commit	Line	Data
adcb9951 JH	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
	5	* Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
	6	*
	7	* This program is free software: you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation, either version 3 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program. If not, see <http://www.gnu.org/licenses/>.
	19	*/
	20
	21	#include <config.h>
adcb9951	22	#include <math.h>
4bd770f5	23	#include "protocol.h"
adcb9951 JH	24
adcb9951 JH	25	static const struct dslogic_profile supported_device[] = {
6c317a8d	26	/* DreamSourceLab DSLogic */
adcb9951 JH	27	{ 0x2a0e, 0x0001, "DreamSourceLab", "DSLogic", NULL,
adcb9951 JH	28	"dreamsourcelab-dslogic-fx2.fw",
44b46d70	29	0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
6c317a8d	30	/* DreamSourceLab DSCope */
adcb9951 JH	31	{ 0x2a0e, 0x0002, "DreamSourceLab", "DSCope", NULL,
adcb9951 JH	32	"dreamsourcelab-dscope-fx2.fw",
44b46d70	33	0, "DreamSourceLab", "DSCope", 256 * 1024 * 1024},
6c317a8d	34	/* DreamSourceLab DSLogic Pro */
adcb9951 JH	35	{ 0x2a0e, 0x0003, "DreamSourceLab", "DSLogic Pro", NULL,
adcb9951 JH	36	"dreamsourcelab-dslogic-pro-fx2.fw",
44b46d70	37	0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
6c317a8d	38	/* DreamSourceLab DSLogic Plus */
adcb9951 JH	39	{ 0x2a0e, 0x0020, "DreamSourceLab", "DSLogic Plus", NULL,
adcb9951 JH	40	"dreamsourcelab-dslogic-plus-fx2.fw",
44b46d70	41	0, "DreamSourceLab", "DSLogic", 256 * 1024 * 1024},
6c317a8d	42	/* DreamSourceLab DSLogic Basic */
adcb9951 JH	43	{ 0x2a0e, 0x0021, "DreamSourceLab", "DSLogic Basic", NULL,
adcb9951 JH	44	"dreamsourcelab-dslogic-basic-fx2.fw",
44b46d70	45	0, "DreamSourceLab", "DSLogic", 256 * 1024},
adcb9951 JH	46
	47	ALL_ZERO
	48	};
	49
adcb9951 JH	50	static const uint32_t scanopts[] = {
	51	SR_CONF_CONN,
	52	};
	53
55fb76b3 UH	54	static const uint32_t drvopts[] = {
	55	SR_CONF_LOGIC_ANALYZER,
	56	};
	57
adcb9951 JH	58	static const uint32_t devopts[] = {
	59	SR_CONF_CONTINUOUS \| SR_CONF_SET \| SR_CONF_GET,
	60	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	61	SR_CONF_VOLTAGE_THRESHOLD \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	62	SR_CONF_CONN \| SR_CONF_GET,
	63	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	64	SR_CONF_TRIGGER_MATCH \| SR_CONF_LIST,
	65	SR_CONF_CAPTURE_RATIO \| SR_CONF_GET \| SR_CONF_SET,
	66	SR_CONF_EXTERNAL_CLOCK \| SR_CONF_GET \| SR_CONF_SET,
	67	SR_CONF_CLOCK_EDGE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	68	};
	69
adcb9951 JH	70	static const char *const signal_edge_names[] = {
	71	[DS_EDGE_RISING] = "rising",
	72	[DS_EDGE_FALLING] = "falling",
	73	};
	74
	75	static const struct {
adcb9951 JH	76	gdouble low;
adcb9951 JH	77	gdouble high;
7962b129	78	} voltage_thresholds[] = {
1ee70746 JH	79	{ 0.7, 1.4 },
1ee70746 JH	80	{ 1.4, 3.6 },
adcb9951 JH	81	};
	82
	83	static const uint64_t samplerates[] = {
	84	SR_KHZ(10),
	85	SR_KHZ(20),
	86	SR_KHZ(50),
	87	SR_KHZ(100),
	88	SR_KHZ(200),
	89	SR_KHZ(500),
	90	SR_MHZ(1),
	91	SR_MHZ(2),
	92	SR_MHZ(5),
	93	SR_MHZ(10),
	94	SR_MHZ(20),
	95	SR_MHZ(25),
	96	SR_MHZ(50),
	97	SR_MHZ(100),
	98	SR_MHZ(200),
	99	SR_MHZ(400),
	100	};
	101
	102	static gboolean is_plausible(const struct libusb_device_descriptor *des)
	103	{
	104	int i;
	105
	106	for (i = 0; supported_device[i].vid; i++) {
	107	if (des->idVendor != supported_device[i].vid)
	108	continue;
	109	if (des->idProduct == supported_device[i].pid)
	110	return TRUE;
	111	}
	112
	113	return FALSE;
	114	}
	115
	116	static GSList scan(struct sr_dev_driver di, GSList *options)
	117	{
	118	struct drv_context *drvc;
	119	struct dev_context *devc;
	120	struct sr_dev_inst *sdi;
	121	struct sr_usb_dev_inst *usb;
	122	struct sr_channel *ch;
	123	struct sr_channel_group *cg;
	124	struct sr_config *src;
	125	const struct dslogic_profile *prof;
	126	GSList l, devices, *conn_devices;
	127	gboolean has_firmware;
	128	struct libusb_device_descriptor des;
	129	libusb_device **devlist;
	130	struct libusb_device_handle *hdl;
	131	int ret, i, j;
	132	const char *conn;
	133	char manufacturer[64], product[64], serial_num[64], connection_id[64];
	134	char channel_name[16];
	135
	136	drvc = di->context;
	137
	138	conn = NULL;
	139	for (l = options; l; l = l->next) {
	140	src = l->data;
	141	switch (src->key) {
	142	case SR_CONF_CONN:
	143	conn = g_variant_get_string(src->data, NULL);
	144	break;
145	}
146	}
147	if (conn)
148	conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
149	else
150	conn_devices = NULL;
151
44b46d70	152	/* Find all DSLogic compatible devices and upload firmware to them. */
adcb9951 JH	153	devices = NULL;
	154	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	155	for (i = 0; devlist[i]; i++) {
	156	if (conn) {
	157	usb = NULL;
	158	for (l = conn_devices; l; l = l->next) {
	159	usb = l->data;
	160	if (usb->bus == libusb_get_bus_number(devlist[i])
	161	&& usb->address == libusb_get_device_address(devlist[i]))
	162	break;
	163	}
	164	if (!l)
	165	/* This device matched none of the ones that
	166	* matched the conn specification. */
	167	continue;
	168	}
	169
44b46d70	170	libusb_get_device_descriptor(devlist[i], &des);
adcb9951 JH	171
	172	if (!is_plausible(&des))
	173	continue;
	174
	175	if ((ret = libusb_open(devlist[i], &hdl)) < 0) {
	176	sr_warn("Failed to open potential device with "
	177	"VID:PID %04x:%04x: %s.", des.idVendor,
	178	des.idProduct, libusb_error_name(ret));
	179	continue;
	180	}
	181
	182	if (des.iManufacturer == 0) {
	183	manufacturer[0] = '\0';
	184	} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
	185	des.iManufacturer, (unsigned char *) manufacturer,
	186	sizeof(manufacturer))) < 0) {
	187	sr_warn("Failed to get manufacturer string descriptor: %s.",
	188	libusb_error_name(ret));
	189	continue;
	190	}
	191
	192	if (des.iProduct == 0) {
	193	product[0] = '\0';
	194	} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
	195	des.iProduct, (unsigned char *) product,
	196	sizeof(product))) < 0) {
	197	sr_warn("Failed to get product string descriptor: %s.",
	198	libusb_error_name(ret));
	199	continue;
	200	}
	201
	202	if (des.iSerialNumber == 0) {
	203	serial_num[0] = '\0';
	204	} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
	205	des.iSerialNumber, (unsigned char *) serial_num,
	206	sizeof(serial_num))) < 0) {
	207	sr_warn("Failed to get serial number string descriptor: %s.",
	208	libusb_error_name(ret));
	209	continue;
	210	}
	211
	212	usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
	213
	214	libusb_close(hdl);
	215
	216	prof = NULL;
	217	for (j = 0; supported_device[j].vid; j++) {
	218	if (des.idVendor == supported_device[j].vid &&
4984ca28	219	des.idProduct == supported_device[j].pid) {
adcb9951 JH	220	prof = &supported_device[j];
	221	break;
	222	}
	223	}
	224
adcb9951 JH	225	if (!prof)
	226	continue;
	227
	228	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	229	sdi->status = SR_ST_INITIALIZING;
	230	sdi->vendor = g_strdup(prof->vendor);
	231	sdi->model = g_strdup(prof->model);
	232	sdi->version = g_strdup(prof->model_version);
	233	sdi->serial_num = g_strdup(serial_num);
	234	sdi->connection_id = g_strdup(connection_id);
	235
	236	/* Logic channels, all in one channel group. */
	237	cg = g_malloc0(sizeof(struct sr_channel_group));
	238	cg->name = g_strdup("Logic");
	239	for (j = 0; j < 16; j++) {
84f6d40a	240	sprintf(channel_name, "%d", j);
adcb9951 JH	241	ch = sr_channel_new(sdi, j, SR_CHANNEL_LOGIC,
	242	TRUE, channel_name);
	243	cg->channels = g_slist_append(cg->channels, ch);
	244	}
	245	sdi->channel_groups = g_slist_append(NULL, cg);
	246
	247	devc = dslogic_dev_new();
	248	devc->profile = prof;
	249	sdi->priv = devc;
	250	devices = g_slist_append(devices, sdi);
	251
	252	devc->samplerates = samplerates;
	253	devc->num_samplerates = ARRAY_SIZE(samplerates);
3c749da1	254	has_firmware = usb_match_manuf_prod(devlist[i], "DreamSourceLab", "USB-based Instrument");
adcb9951 JH	255
	256	if (has_firmware) {
	257	/* Already has the firmware, so fix the new address. */
44b46d70	258	sr_dbg("Found a DSLogic device.");
adcb9951 JH	259	sdi->status = SR_ST_INACTIVE;
	260	sdi->inst_type = SR_INST_USB;
	261	sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
	262	libusb_get_device_address(devlist[i]), NULL);
	263	} else {
	264	if (ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
	265	USB_CONFIGURATION, prof->firmware) == SR_OK)
	266	/* Store when this device's FW was updated. */
	267	devc->fw_updated = g_get_monotonic_time();
	268	else
	269	sr_err("Firmware upload failed for "
	270	"device %d.%d (logical).",
	271	libusb_get_bus_number(devlist[i]),
	272	libusb_get_device_address(devlist[i]));
	273	sdi->inst_type = SR_INST_USB;
	274	sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
	275	0xff, NULL);
	276	}
	277	}
	278	libusb_free_device_list(devlist, 1);
	279	g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
	280
	281	return std_scan_complete(di, devices);
	282	}
	283
adcb9951 JH	284	static int dev_open(struct sr_dev_inst *sdi)
	285	{
	286	struct sr_dev_driver *di = sdi->driver;
	287	struct sr_usb_dev_inst *usb;
	288	struct dev_context *devc;
adcb9951 JH	289	int ret;
	290	int64_t timediff_us, timediff_ms;
	291
	292	devc = sdi->priv;
	293	usb = sdi->conn;
	294
	295	/*
	296	* If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
	297	* milliseconds for the FX2 to renumerate.
	298	*/
	299	ret = SR_ERR;
	300	if (devc->fw_updated > 0) {
	301	sr_info("Waiting for device to reset.");
	302	/* Takes >= 300ms for the FX2 to be gone from the USB bus. */
	303	g_usleep(300 * 1000);
	304	timediff_ms = 0;
	305	while (timediff_ms < MAX_RENUM_DELAY_MS) {
	306	if ((ret = dslogic_dev_open(sdi, di)) == SR_OK)
	307	break;
	308	g_usleep(100 * 1000);
	309
	310	timediff_us = g_get_monotonic_time() - devc->fw_updated;
	311	timediff_ms = timediff_us / 1000;
	312	sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
	313	}
	314	if (ret != SR_OK) {
	315	sr_err("Device failed to renumerate.");
	316	return SR_ERR;
	317	}
	318	sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
	319	} else {
	320	sr_info("Firmware upload was not needed.");
	321	ret = dslogic_dev_open(sdi, di);
	322	}
	323
	324	if (ret != SR_OK) {
	325	sr_err("Unable to open device.");
	326	return SR_ERR;
	327	}
	328
	329	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	330	if (ret != 0) {
	331	switch (ret) {
	332	case LIBUSB_ERROR_BUSY:
	333	sr_err("Unable to claim USB interface. Another "
	334	"program or driver has already claimed it.");
	335	break;
	336	case LIBUSB_ERROR_NO_DEVICE:
	337	sr_err("Device has been disconnected.");
	338	break;
	339	default:
	340	sr_err("Unable to claim interface: %s.",
	341	libusb_error_name(ret));
	342	break;
	343	}
	344
	345	return SR_ERR;
	346	}
	347
adcb9951	348
3566348b	349	if ((ret = dslogic_fpga_firmware_upload(sdi)) != SR_OK)
adcb9951 JH	350	return ret;
	351
	352	if (devc->cur_samplerate == 0) {
	353	/* Samplerate hasn't been set; default to the slowest one. */
	354	devc->cur_samplerate = devc->samplerates[0];
	355	}
	356
1ee70746 JH	357	if (devc->cur_threshold == 0.0)
	358	devc->cur_threshold = 1.5;
	359
adcb9951 JH	360	return SR_OK;
	361	}
	362
	363	static int dev_close(struct sr_dev_inst *sdi)
	364	{
	365	struct sr_usb_dev_inst *usb;
	366
	367	usb = sdi->conn;
	368
	369	if (!usb->devhdl)
f1ba6b4b	370	return SR_ERR_BUG;
adcb9951	371
44b46d70	372	sr_info("Closing device on %d.%d (logical) / %s (physical) interface %d.",
adcb9951 JH	373	usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
	374	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	375	libusb_close(usb->devhdl);
	376	usb->devhdl = NULL;
adcb9951 JH	377
	378	return SR_OK;
	379	}
	380
	381	static int config_get(uint32_t key, GVariant **data,
	382	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	383	{
	384	struct dev_context *devc;
	385	struct sr_usb_dev_inst *usb;
1ee70746	386	unsigned int i, voltage_range;
adcb9951 JH	387	char str[128];
	388
	389	(void)cg;
	390
	391	if (!sdi)
	392	return SR_ERR_ARG;
	393
	394	devc = sdi->priv;
	395
	396	switch (key) {
	397	case SR_CONF_CONN:
	398	if (!sdi->conn)
	399	return SR_ERR_ARG;
	400	usb = sdi->conn;
	401	if (usb->address == 255)
	402	/* Device still needs to re-enumerate after firmware
	403	* upload, so we don't know its (future) address. */
	404	return SR_ERR;
	405	snprintf(str, 128, "%d.%d", usb->bus, usb->address);
	406	*data = g_variant_new_string(str);
	407	break;
	408	case SR_CONF_VOLTAGE_THRESHOLD:
1ee70746 JH	409	if (!strcmp(devc->profile->model, "DSLogic")) {
	410	voltage_range = 0;
	411
7962b129 UH	412	for (i = 0; i < ARRAY_SIZE(voltage_thresholds); i++)
7962b129 UH	413	if (voltage_thresholds[i].low == devc->cur_threshold) {
1ee70746 JH	414	voltage_range = i;
	415	break;
	416	}
43995cda UH	417	*data = std_gvar_tuple_double(voltage_thresholds[voltage_range].low,
43995cda UH	418	voltage_thresholds[voltage_range].high);
1ee70746	419	} else {
43995cda	420	*data = std_gvar_tuple_double(devc->cur_threshold, devc->cur_threshold);
adcb9951 JH	421	}
	422	break;
	423	case SR_CONF_LIMIT_SAMPLES:
	424	*data = g_variant_new_uint64(devc->limit_samples);
	425	break;
	426	case SR_CONF_SAMPLERATE:
	427	*data = g_variant_new_uint64(devc->cur_samplerate);
	428	break;
	429	case SR_CONF_CAPTURE_RATIO:
	430	*data = g_variant_new_uint64(devc->capture_ratio);
	431	break;
	432	case SR_CONF_EXTERNAL_CLOCK:
	433	*data = g_variant_new_boolean(devc->external_clock);
	434	break;
	435	case SR_CONF_CONTINUOUS:
	436	*data = g_variant_new_boolean(devc->continuous_mode);
	437	break;
	438	case SR_CONF_CLOCK_EDGE:
	439	i = devc->clock_edge;
	440	if (i >= ARRAY_SIZE(signal_edge_names))
	441	return SR_ERR_BUG;
	442	*data = g_variant_new_string(signal_edge_names[0]);
	443	break;
	444	default:
	445	return SR_ERR_NA;
	446	}
	447
	448	return SR_OK;
	449	}
	450
	451	/*
	452	* Helper for mapping a string-typed configuration value to an index
	453	* within a table of possible values.
	454	*/
	455	static int lookup_index(GVariant value, const char const *table, int len)
	456	{
	457	const char *entry;
	458	int i;
	459
	460	entry = g_variant_get_string(value, NULL);
	461	if (!entry)
	462	return -1;
	463
	464	/* Linear search is fine for very small tables. */
	465	for (i = 0; i < len; i++) {
	466	if (strcmp(entry, table[i]) == 0)
	467	return i;
	468	}
	469
	470	return -1;
	471	}
	472
	473	static int config_set(uint32_t key, GVariant *data,
	474	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	475	{
	476	struct dev_context *devc;
	477	uint64_t arg;
	478	int i, ret;
	479	gdouble low, high;
	480
	481	(void)cg;
	482
	483	if (!sdi)
	484	return SR_ERR_ARG;
485
adcb9951 JH	486	devc = sdi->priv;
	487
	488	ret = SR_OK;
	489
	490	switch (key) {
	491	case SR_CONF_SAMPLERATE:
	492	arg = g_variant_get_uint64(data);
	493	for (i = 0; i < devc->num_samplerates; i++) {
	494	if (devc->samplerates[i] == arg) {
	495	devc->cur_samplerate = arg;
	496	break;
	497	}
	498	}
	499	if (i == devc->num_samplerates)
	500	ret = SR_ERR_ARG;
	501	break;
	502	case SR_CONF_LIMIT_SAMPLES:
	503	devc->limit_samples = g_variant_get_uint64(data);
	504	break;
	505	case SR_CONF_CAPTURE_RATIO:
	506	devc->capture_ratio = g_variant_get_uint64(data);
	507	ret = (devc->capture_ratio > 100) ? SR_ERR : SR_OK;
	508	break;
	509	case SR_CONF_VOLTAGE_THRESHOLD:
	510	g_variant_get(data, "(dd)", &low, &high);
1ee70746	511	if (!strcmp(devc->profile->model, "DSLogic")) {
7962b129 UH	512	for (i = 0; (unsigned int)i < ARRAY_SIZE(voltage_thresholds); i++) {
	513	if (fabs(voltage_thresholds[i].low - low) < 0.1 &&
	514	fabs(voltage_thresholds[i].high - high) < 0.1) {
1ee70746	515	devc->cur_threshold =
7962b129	516	voltage_thresholds[i].low;
1ee70746 JH	517	break;
1ee70746 JH	518	}
adcb9951	519	}
1ee70746 JH	520	ret = dslogic_fpga_firmware_upload(sdi);
	521	} else {
	522	ret = dslogic_set_voltage_threshold(sdi, (low + high) / 2.0);
adcb9951	523	}
adcb9951 JH	524	break;
	525	case SR_CONF_EXTERNAL_CLOCK:
	526	devc->external_clock = g_variant_get_boolean(data);
	527	break;
	528	case SR_CONF_CONTINUOUS:
	529	devc->continuous_mode = g_variant_get_boolean(data);
	530	break;
	531	case SR_CONF_CLOCK_EDGE:
53012da6	532	i = lookup_index(data, ARRAY_AND_SIZE(signal_edge_names));
adcb9951 JH	533	if (i < 0)
	534	return SR_ERR_ARG;
	535	devc->clock_edge = i;
	536	break;
	537	default:
	538	ret = SR_ERR_NA;
	539	}
	540
	541	return ret;
	542	}
	543
	544	static int config_list(uint32_t key, GVariant **data,
	545	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	546	{
e66d1892	547	struct dev_context *devc;
adcb9951 JH	548	GVariant gvar, range[2];
	549	GVariantBuilder gvb;
	550	unsigned int i;
	551
e66d1892	552	devc = (sdi) ? sdi->priv : NULL;
adcb9951 JH	553
	554	switch (key) {
	555	case SR_CONF_SCAN_OPTIONS:
adcb9951	556	case SR_CONF_DEVICE_OPTIONS:
e66d1892	557	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
adcb9951	558	case SR_CONF_VOLTAGE_THRESHOLD:
e66d1892	559	if (!strcmp(devc->profile->model, "DSLogic")) {
7bc3cfe6	560	g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
7962b129 UH	561	for (i = 0; i < ARRAY_SIZE(voltage_thresholds); i++) {
	562	range[0] = g_variant_new_double(voltage_thresholds[i].low);
	563	range[1] = g_variant_new_double(voltage_thresholds[i].high);
1ee70746 JH	564	gvar = g_variant_new_tuple(range, 2);
	565	g_variant_builder_add_value(&gvb, gvar);
	566	}
7bc3cfe6	567	*data = g_variant_builder_end(&gvb);
1ee70746	568	} else {
7bc3cfe6	569	*data = std_gvar_min_max_step_thresholds(0.0, 5.0, 0.1);
adcb9951	570	}
adcb9951 JH	571	break;
adcb9951 JH	572	case SR_CONF_SAMPLERATE:
463160cb	573	*data = std_gvar_samplerates(devc->samplerates, devc->num_samplerates);
adcb9951 JH	574	break;
adcb9951 JH	575	case SR_CONF_CLOCK_EDGE:
53012da6	576	*data = g_variant_new_strv(ARRAY_AND_SIZE(signal_edge_names));
adcb9951 JH	577	break;
	578	default:
	579	return SR_ERR_NA;
	580	}
	581
	582	return SR_OK;
	583	}
	584
44b46d70 UH	585	static struct sr_dev_driver dreamsourcelab_dslogic_driver_info = {
	586	.name = "dreamsourcelab-dslogic",
	587	.longname = "DreamSourceLab DSLogic",
adcb9951 JH	588	.api_version = 1,
	589	.init = std_init,
	590	.cleanup = std_cleanup,
	591	.scan = scan,
	592	.dev_list = std_dev_list,
8bf18daa	593	.dev_clear = std_dev_clear,
adcb9951 JH	594	.config_get = config_get,
	595	.config_set = config_set,
	596	.config_list = config_list,
	597	.dev_open = dev_open,
	598	.dev_close = dev_close,
4bd770f5 JH	599	.dev_acquisition_start = dslogic_acquisition_start,
4bd770f5 JH	600	.dev_acquisition_stop = dslogic_acquisition_stop,
adcb9951 JH	601	.context = NULL,
adcb9951 JH	602	};
44b46d70	603	SR_REGISTER_DEV_DRIVER(dreamsourcelab_dslogic_driver_info);