[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 drvopts[] = {
	SR_CONF_LOGIC_ANALYZER,
};

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

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

/* Names assigned to available edge slope choices. */
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;
			}
		}

		/* Skip if the device was not found. */
		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;
	GVariant *range[2];
	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;
				}

			range[0] = g_variant_new_double(
				voltage_thresholds[voltage_range].low);
			range[1] = g_variant_new_double(
				voltage_thresholds[voltage_range].high);
		} else {
			range[0] = g_variant_new_double(devc->cur_threshold);
			range[1] = g_variant_new_double(devc->cur_threshold);
		}
		*data = g_variant_new_tuple(range, 2);
		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, signal_edge_names,
		 		   ARRAY_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;
	double v;

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