[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 int32_t trigger_matches[] = {
	SR_TRIGGER_ZERO,
	SR_TRIGGER_ONE,
	SR_TRIGGER_RISING,
	SR_TRIGGER_FALLING,
	SR_TRIGGER_EDGE,
};

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

static const double thresholds[][2] = {
	{ 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 < NUM_CHANNELS; 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 = thresholds[1][0];

	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;
	int idx;

	(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_VOLTAGE_THRESHOLD:
		if (!strcmp(devc->profile->model, "DSLogic")) {
			if ((idx = std_double_tuple_idx_d0(devc->cur_threshold,
					ARRAY_AND_SIZE(thresholds))) < 0)
				return SR_ERR_BUG;
			*data = std_gvar_tuple_double(thresholds[idx][0],
					thresholds[idx][1]);
		} 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:
		idx = devc->clock_edge;
		if (idx >= (int)ARRAY_SIZE(signal_edges))
			return SR_ERR_BUG;
		*data = g_variant_new_string(signal_edges[0]);
		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;
	int idx;
	gdouble low, high;

	(void)cg;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		if ((idx = std_u64_idx(data, devc->samplerates, devc->num_samplerates)) < 0)
			return SR_ERR_ARG;
		devc->cur_samplerate = devc->samplerates[idx];
		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:
		if (!strcmp(devc->profile->model, "DSLogic")) {
			if ((idx = std_double_tuple_idx(data, ARRAY_AND_SIZE(thresholds))) < 0)
				return SR_ERR_ARG;
			devc->cur_threshold = thresholds[idx][0];
			return dslogic_fpga_firmware_upload(sdi);
		} else {
			g_variant_get(data, "(dd)", &low, &high);
			return 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:
		if ((idx = std_str_idx(data, ARRAY_AND_SIZE(signal_edges))) < 0)
			return SR_ERR_ARG;
		devc->clock_edge = idx;
		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;

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