[libsigrok.git] / src / hardware / fx2lafw / 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 "protocol.h"

static const struct fx2lafw_profile supported_fx2[] = {
	/*
	 * CWAV USBee AX
	 * EE Electronics ESLA201A
	 * ARMFLY AX-Pro
	 */
	{ 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
		FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
		0, NULL, NULL},
	/*
	 * CWAV USBee DX
	 * XZL-Studio DX
	 */
	{ 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
		FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
		DEV_CAPS_16BIT, NULL, NULL },

	/*
	 * CWAV USBee SX
	 */
	{ 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
		FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
		0, NULL, NULL},

	/*
	 * Saleae Logic
	 * EE Electronics ESLA100
	 * Robomotic MiniLogic
	 * Robomotic BugLogic 3
	 */
	{ 0x0925, 0x3881, "Saleae", "Logic", NULL,
		FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
		0, NULL, NULL},

	/*
	 * Default Cypress FX2 without EEPROM, e.g.:
	 * Lcsoft Mini Board
	 * Braintechnology USB Interface V2.x
	 */
	{ 0x04B4, 0x8613, "Cypress", "FX2", NULL,
		FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
		DEV_CAPS_16BIT, NULL, NULL },

	/*
	 * Braintechnology USB-LPS
	 */
	{ 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
		FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
		DEV_CAPS_16BIT, NULL, NULL },

	{ 0, 0, 0, 0, 0, 0, 0, 0, 0 }
};

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

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

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

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

static const uint64_t samplerates[] = {
	SR_KHZ(20),
	SR_KHZ(25),
	SR_KHZ(50),
	SR_KHZ(100),
	SR_KHZ(200),
	SR_KHZ(250),
	SR_KHZ(500),
	SR_MHZ(1),
	SR_MHZ(2),
	SR_MHZ(3),
	SR_MHZ(4),
	SR_MHZ(6),
	SR_MHZ(8),
	SR_MHZ(12),
	SR_MHZ(16),
	SR_MHZ(24),
};

SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
static struct sr_dev_driver *di = &fx2lafw_driver_info;

static int init(struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static GSList *scan(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_config *src;
	const struct fx2lafw_profile *prof;
	GSList *l, *devices, *conn_devices;
	struct libusb_device_descriptor des;
	libusb_device **devlist;
	struct libusb_device_handle *hdl;
	int num_logic_channels, ret, i, j;
	const char *conn;
	char manufacturer[64], product[64], serial_num[64], connection_id[64];

	drvc = di->priv;

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

		if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
			sr_warn("Failed to get device descriptor: %s.",
				libusb_error_name(ret));
			continue;
		}

		if ((ret = libusb_open(devlist[i], &hdl)) < 0)
			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_fx2[j].vid; j++) {
			if (des.idVendor == supported_fx2[j].vid &&
					des.idProduct == supported_fx2[j].pid &&
					(!supported_fx2[j].usb_manufacturer ||
					 !strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
					(!supported_fx2[j].usb_manufacturer ||
					 !strcmp(product, supported_fx2[j].usb_product))) {
				prof = &supported_fx2[j];
				break;
			}
		}

		/* Skip if the device was not found. */
		if (!prof)
			continue;

		sdi = sr_dev_inst_new();
		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->driver = di;
		sdi->serial_num = g_strdup(serial_num);
		sdi->connection_id = g_strdup(connection_id);

		/* Fill in channellist according to this device's profile. */
		num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
		for (j = 0; j < num_logic_channels; j++) {
			if (!(ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
					channel_names[j])))
				return NULL;
			sdi->channels = g_slist_append(sdi->channels, ch);
		}

		devc = fx2lafw_dev_new();
		devc->profile = prof;
		devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
		sdi->priv = devc;
		drvc->instances = g_slist_append(drvc->instances, sdi);
		devices = g_slist_append(devices, sdi);

		if (fx2lafw_check_conf_profile(devlist[i])) {
			/* Already has the firmware, so fix the new address. */
			sr_dbg("Found an fx2lafw 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(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 devices;
}

static GSList *dev_list(void)
{
	return ((struct drv_context *)(di->priv))->instances;
}

static int dev_open(struct sr_dev_inst *sdi)
{
	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 = fx2lafw_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 = fx2lafw_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 (devc->cur_samplerate == 0) {
		/* Samplerate hasn't been set; default to the slowest one. */
		devc->cur_samplerate = samplerates[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 == NULL)
		return SR_ERR;

	sr_info("fx2lafw: 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;
	sdi->status = SR_ST_INACTIVE;

	return SR_OK;
}

static int cleanup(void)
{
	int ret;
	struct drv_context *drvc;

	if (!(drvc = di->priv))
		return SR_OK;

	ret = std_dev_clear(di, NULL);

	g_free(drvc);
	di->priv = NULL;

	return ret;
}

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;
	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_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(devc->cur_samplerate);
		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;
	uint64_t arg;
	unsigned int i;
	int ret;

	(void)cg;

	if (!sdi)
		return SR_ERR_ARG;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR;

	devc = sdi->priv;

	ret = SR_OK;

	switch (key) {
		case SR_CONF_SAMPLERATE:
			arg = g_variant_get_uint64(data);
			for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
				if (samplerates[i] == arg) {
					devc->cur_samplerate = arg;
					break;
				}
			}
			if (i == ARRAY_SIZE(samplerates))
				ret = SR_ERR_ARG;
			break;
		case SR_CONF_LIMIT_SAMPLES:
			devc->limit_samples = g_variant_get_uint64(data);
			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)
{
	GVariant *gvar;
	GVariantBuilder gvb;

	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		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"), samplerates,
				ARRAY_SIZE(samplerates), sizeof(uint64_t));
		g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
		*data = g_variant_builder_end(&gvb);
		break;
	case SR_CONF_TRIGGER_MATCH:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
				sizeof(int32_t));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int receive_data(int fd, int revents, void *cb_data)
{
	struct timeval tv;
	struct drv_context *drvc;

	(void)fd;
	(void)revents;
	(void)cb_data;

	drvc = di->priv;

	tv.tv_sec = tv.tv_usec = 0;
	libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);

	return TRUE;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
{
	struct dev_context *devc;
	struct drv_context *drvc;
	struct sr_usb_dev_inst *usb;
	struct sr_trigger *trigger;
	struct libusb_transfer *transfer;
	unsigned int i, timeout, num_transfers;
	int ret;
	unsigned char *buf;
	size_t size;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

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

	devc->cb_data = cb_data;
	devc->sent_samples = 0;
	devc->acq_aborted = FALSE;
	devc->empty_transfer_count = 0;

	if ((trigger = sr_session_trigger_get(sdi->session))) {
		devc->stl = soft_trigger_logic_new(sdi, trigger);
		devc->trigger_fired = FALSE;
	} else
		devc->trigger_fired = TRUE;

	timeout = fx2lafw_get_timeout(devc);
	num_transfers = fx2lafw_get_number_of_transfers(devc);
	size = fx2lafw_get_buffer_size(devc);
	devc->submitted_transfers = 0;

	devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
	if (!devc->transfers) {
		sr_err("USB transfers malloc failed.");
		return SR_ERR_MALLOC;
	}

	devc->num_transfers = num_transfers;
	for (i = 0; i < num_transfers; i++) {
		if (!(buf = g_try_malloc(size))) {
			sr_err("USB transfer buffer malloc failed.");
			return SR_ERR_MALLOC;
		}
		transfer = libusb_alloc_transfer(0);
		libusb_fill_bulk_transfer(transfer, usb->devhdl,
				2 | LIBUSB_ENDPOINT_IN, buf, size,
				fx2lafw_receive_transfer, (void *)sdi, timeout);
		if ((ret = libusb_submit_transfer(transfer)) != 0) {
			sr_err("Failed to submit transfer: %s.",
			       libusb_error_name(ret));
			libusb_free_transfer(transfer);
			g_free(buf);
			fx2lafw_abort_acquisition(devc);
			return SR_ERR;
		}
		devc->transfers[i] = transfer;
		devc->submitted_transfers++;
	}

	devc->ctx = drvc->sr_ctx;

	usb_source_add(sdi->session, devc->ctx, timeout, receive_data, NULL);

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, LOG_PREFIX);

	if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
		fx2lafw_abort_acquisition(devc);
		return ret;
	}

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	(void)cb_data;

	fx2lafw_abort_acquisition(sdi->priv);

	return SR_OK;
}

SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
	.name = "fx2lafw",
	.longname = "fx2lafw (generic driver for FX2 based LAs)",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = dev_list,
	.dev_clear = NULL,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
	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 "protocol.h"
	22
	23	static const struct fx2lafw_profile supported_fx2[] = {
	24	/*
	25	* CWAV USBee AX
	26	* EE Electronics ESLA201A
	27	* ARMFLY AX-Pro
	28	*/
	29	{ 0x08a9, 0x0014, "CWAV", "USBee AX", NULL,
	30	FIRMWARE_DIR "/fx2lafw-cwav-usbeeax.fw",
	31	0, NULL, NULL},
	32	/*
	33	* CWAV USBee DX
	34	* XZL-Studio DX
	35	*/
	36	{ 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
	37	FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
	38	DEV_CAPS_16BIT, NULL, NULL },
	39
	40	/*
	41	* CWAV USBee SX
	42	*/
	43	{ 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
	44	FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
	45	0, NULL, NULL},
	46
	47	/*
	48	* Saleae Logic
	49	* EE Electronics ESLA100
	50	* Robomotic MiniLogic
	51	* Robomotic BugLogic 3
	52	*/
	53	{ 0x0925, 0x3881, "Saleae", "Logic", NULL,
	54	FIRMWARE_DIR "/fx2lafw-saleae-logic.fw",
	55	0, NULL, NULL},
	56
	57	/*
	58	* Default Cypress FX2 without EEPROM, e.g.:
	59	* Lcsoft Mini Board
	60	* Braintechnology USB Interface V2.x
	61	*/
	62	{ 0x04B4, 0x8613, "Cypress", "FX2", NULL,
	63	FIRMWARE_DIR "/fx2lafw-cypress-fx2.fw",
	64	DEV_CAPS_16BIT, NULL, NULL },
	65
	66	/*
	67	* Braintechnology USB-LPS
	68	*/
	69	{ 0x16d0, 0x0498, "Braintechnology", "USB-LPS", NULL,
	70	FIRMWARE_DIR "/fx2lafw-braintechnology-usb-lps.fw",
	71	DEV_CAPS_16BIT, NULL, NULL },
	72
	73	{ 0, 0, 0, 0, 0, 0, 0, 0, 0 }
	74	};
	75
	76	static const uint32_t scanopts[] = {
	77	SR_CONF_CONN,
	78	};
	79
	80	static const uint32_t devopts[] = {
	81	SR_CONF_LOGIC_ANALYZER,
	82	SR_CONF_CONTINUOUS,
	83	SR_CONF_CONN \| SR_CONF_GET,
	84	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	85	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	86	SR_CONF_TRIGGER_MATCH \| SR_CONF_LIST,
	87	};
	88
	89	static const char *channel_names[] = {
	90	"0", "1", "2", "3", "4", "5", "6", "7",
	91	"8", "9", "10", "11", "12", "13", "14", "15",
	92	NULL,
	93	};
	94
	95	static const int32_t soft_trigger_matches[] = {
	96	SR_TRIGGER_ZERO,
	97	SR_TRIGGER_ONE,
	98	SR_TRIGGER_RISING,
	99	SR_TRIGGER_FALLING,
	100	SR_TRIGGER_EDGE,
	101	};
	102
	103	static const uint64_t samplerates[] = {
	104	SR_KHZ(20),
	105	SR_KHZ(25),
	106	SR_KHZ(50),
	107	SR_KHZ(100),
	108	SR_KHZ(200),
	109	SR_KHZ(250),
	110	SR_KHZ(500),
	111	SR_MHZ(1),
	112	SR_MHZ(2),
	113	SR_MHZ(3),
	114	SR_MHZ(4),
	115	SR_MHZ(6),
	116	SR_MHZ(8),
	117	SR_MHZ(12),
	118	SR_MHZ(16),
	119	SR_MHZ(24),
	120	};
	121
	122	SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
	123	static struct sr_dev_driver *di = &fx2lafw_driver_info;
	124
	125	static int init(struct sr_context *sr_ctx)
	126	{
	127	return std_init(sr_ctx, di, LOG_PREFIX);
	128	}
	129
	130	static GSList scan(GSList options)
	131	{
	132	struct drv_context *drvc;
	133	struct dev_context *devc;
	134	struct sr_dev_inst *sdi;
	135	struct sr_usb_dev_inst *usb;
	136	struct sr_channel *ch;
	137	struct sr_config *src;
	138	const struct fx2lafw_profile *prof;
	139	GSList l, devices, *conn_devices;
	140	struct libusb_device_descriptor des;
	141	libusb_device **devlist;
	142	struct libusb_device_handle *hdl;
	143	int num_logic_channels, ret, i, j;
	144	const char *conn;
	145	char manufacturer[64], product[64], serial_num[64], connection_id[64];
	146
	147	drvc = di->priv;
	148
	149	conn = NULL;
	150	for (l = options; l; l = l->next) {
	151	src = l->data;
	152	switch (src->key) {
	153	case SR_CONF_CONN:
	154	conn = g_variant_get_string(src->data, NULL);
	155	break;
	156	}
	157	}
	158	if (conn)
	159	conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	160	else
	161	conn_devices = NULL;
	162
	163	/* Find all fx2lafw compatible devices and upload firmware to them. */
	164	devices = NULL;
	165	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	166	for (i = 0; devlist[i]; i++) {
	167	if (conn) {
	168	usb = NULL;
	169	for (l = conn_devices; l; l = l->next) {
	170	usb = l->data;
	171	if (usb->bus == libusb_get_bus_number(devlist[i])
	172	&& usb->address == libusb_get_device_address(devlist[i]))
	173	break;
	174	}
	175	if (!l)
	176	/* This device matched none of the ones that
	177	* matched the conn specification. */
	178	continue;
	179	}
	180
	181	if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
	182	sr_warn("Failed to get device descriptor: %s.",
	183	libusb_error_name(ret));
	184	continue;
	185	}
	186
	187	if ((ret = libusb_open(devlist[i], &hdl)) < 0)
	188	continue;
	189
	190	if (des.iManufacturer == 0) {
	191	manufacturer[0] = '\0';
	192	} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
	193	des.iManufacturer, (unsigned char *) manufacturer,
	194	sizeof(manufacturer))) < 0) {
	195	sr_warn("Failed to get manufacturer string descriptor: %s.",
	196	libusb_error_name(ret));
	197	continue;
	198	}
	199
	200	if (des.iProduct == 0) {
	201	product[0] = '\0';
	202	} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
	203	des.iProduct, (unsigned char *) product,
	204	sizeof(product))) < 0) {
	205	sr_warn("Failed to get product string descriptor: %s.",
	206	libusb_error_name(ret));
	207	continue;
	208	}
	209
	210	if (des.iSerialNumber == 0) {
	211	serial_num[0] = '\0';
	212	} else if ((ret = libusb_get_string_descriptor_ascii(hdl,
	213	des.iSerialNumber, (unsigned char *) serial_num,
	214	sizeof(serial_num))) < 0) {
	215	sr_warn("Failed to get serial number string descriptor: %s.",
	216	libusb_error_name(ret));
	217	continue;
	218	}
	219
	220	usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
	221
	222	libusb_close(hdl);
	223
	224	prof = NULL;
	225	for (j = 0; supported_fx2[j].vid; j++) {
	226	if (des.idVendor == supported_fx2[j].vid &&
	227	des.idProduct == supported_fx2[j].pid &&
	228	(!supported_fx2[j].usb_manufacturer \|\|
	229	!strcmp(manufacturer, supported_fx2[j].usb_manufacturer)) &&
	230	(!supported_fx2[j].usb_manufacturer \|\|
	231	!strcmp(product, supported_fx2[j].usb_product))) {
	232	prof = &supported_fx2[j];
	233	break;
	234	}
	235	}
	236
	237	/* Skip if the device was not found. */
	238	if (!prof)
	239	continue;
	240
	241	sdi = sr_dev_inst_new();
	242	sdi->status = SR_ST_INITIALIZING;
	243	sdi->vendor = g_strdup(prof->vendor);
	244	sdi->model = g_strdup(prof->model);
	245	sdi->version = g_strdup(prof->model_version);
	246	sdi->driver = di;
	247	sdi->serial_num = g_strdup(serial_num);
	248	sdi->connection_id = g_strdup(connection_id);
	249
	250	/* Fill in channellist according to this device's profile. */
	251	num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
	252	for (j = 0; j < num_logic_channels; j++) {
	253	if (!(ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
	254	channel_names[j])))
	255	return NULL;
	256	sdi->channels = g_slist_append(sdi->channels, ch);
	257	}
	258
	259	devc = fx2lafw_dev_new();
	260	devc->profile = prof;
	261	devc->sample_wide = (prof->dev_caps & DEV_CAPS_16BIT) != 0;
	262	sdi->priv = devc;
	263	drvc->instances = g_slist_append(drvc->instances, sdi);
	264	devices = g_slist_append(devices, sdi);
	265
	266	if (fx2lafw_check_conf_profile(devlist[i])) {
	267	/* Already has the firmware, so fix the new address. */
	268	sr_dbg("Found an fx2lafw device.");
	269	sdi->status = SR_ST_INACTIVE;
	270	sdi->inst_type = SR_INST_USB;
	271	sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
	272	libusb_get_device_address(devlist[i]), NULL);
	273	} else {
	274	if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
	275	prof->firmware) == SR_OK)
	276	/* Store when this device's FW was updated. */
	277	devc->fw_updated = g_get_monotonic_time();
	278	else
	279	sr_err("Firmware upload failed for "
	280	"device %d.%d (logical).",
	281	libusb_get_bus_number(devlist[i]),
	282	libusb_get_device_address(devlist[i]));
	283	sdi->inst_type = SR_INST_USB;
	284	sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
	285	0xff, NULL);
	286	}
	287	}
	288	libusb_free_device_list(devlist, 1);
	289	g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
	290
	291	return devices;
	292	}
	293
	294	static GSList *dev_list(void)
	295	{
	296	return ((struct drv_context *)(di->priv))->instances;
	297	}
	298
	299	static int dev_open(struct sr_dev_inst *sdi)
	300	{
	301	struct sr_usb_dev_inst *usb;
	302	struct dev_context *devc;
	303	int ret;
	304	int64_t timediff_us, timediff_ms;
	305
	306	devc = sdi->priv;
	307	usb = sdi->conn;
	308
	309	/*
	310	* If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
	311	* milliseconds for the FX2 to renumerate.
	312	*/
	313	ret = SR_ERR;
	314	if (devc->fw_updated > 0) {
	315	sr_info("Waiting for device to reset.");
	316	/* Takes >= 300ms for the FX2 to be gone from the USB bus. */
	317	g_usleep(300 * 1000);
	318	timediff_ms = 0;
	319	while (timediff_ms < MAX_RENUM_DELAY_MS) {
	320	if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
	321	break;
	322	g_usleep(100 * 1000);
	323
	324	timediff_us = g_get_monotonic_time() - devc->fw_updated;
	325	timediff_ms = timediff_us / 1000;
	326	sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
	327	}
	328	if (ret != SR_OK) {
	329	sr_err("Device failed to renumerate.");
	330	return SR_ERR;
	331	}
	332	sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
	333	} else {
	334	sr_info("Firmware upload was not needed.");
	335	ret = fx2lafw_dev_open(sdi, di);
	336	}
	337
	338	if (ret != SR_OK) {
	339	sr_err("Unable to open device.");
	340	return SR_ERR;
	341	}
	342
	343	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	344	if (ret != 0) {
	345	switch (ret) {
	346	case LIBUSB_ERROR_BUSY:
	347	sr_err("Unable to claim USB interface. Another "
	348	"program or driver has already claimed it.");
	349	break;
	350	case LIBUSB_ERROR_NO_DEVICE:
	351	sr_err("Device has been disconnected.");
	352	break;
	353	default:
	354	sr_err("Unable to claim interface: %s.",
	355	libusb_error_name(ret));
	356	break;
	357	}
	358
	359	return SR_ERR;
	360	}
	361
	362	if (devc->cur_samplerate == 0) {
	363	/* Samplerate hasn't been set; default to the slowest one. */
	364	devc->cur_samplerate = samplerates[0];
	365	}
	366
	367	return SR_OK;
	368	}
	369
	370	static int dev_close(struct sr_dev_inst *sdi)
	371	{
	372	struct sr_usb_dev_inst *usb;
	373
	374	usb = sdi->conn;
	375	if (usb->devhdl == NULL)
	376	return SR_ERR;
	377
	378	sr_info("fx2lafw: Closing device on %d.%d (logical) / %s (physical) interface %d.",
	379	usb->bus, usb->address, sdi->connection_id, USB_INTERFACE);
	380	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	381	libusb_close(usb->devhdl);
	382	usb->devhdl = NULL;
	383	sdi->status = SR_ST_INACTIVE;
	384
	385	return SR_OK;
	386	}
	387
	388	static int cleanup(void)
	389	{
	390	int ret;
	391	struct drv_context *drvc;
	392
	393	if (!(drvc = di->priv))
	394	return SR_OK;
	395
	396	ret = std_dev_clear(di, NULL);
	397
	398	g_free(drvc);
	399	di->priv = NULL;
	400
	401	return ret;
	402	}
	403
	404	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	405	const struct sr_channel_group *cg)
	406	{
	407	struct dev_context *devc;
	408	struct sr_usb_dev_inst *usb;
	409	char str[128];
	410
	411	(void)cg;
	412
	413	if (!sdi)
	414	return SR_ERR_ARG;
	415
	416	devc = sdi->priv;
	417
	418	switch (key) {
	419	case SR_CONF_CONN:
	420	if (!sdi->conn)
	421	return SR_ERR_ARG;
	422	usb = sdi->conn;
	423	if (usb->address == 255)
	424	/* Device still needs to re-enumerate after firmware
	425	* upload, so we don't know its (future) address. */
	426	return SR_ERR;
	427	snprintf(str, 128, "%d.%d", usb->bus, usb->address);
	428	*data = g_variant_new_string(str);
	429	break;
	430	case SR_CONF_LIMIT_SAMPLES:
	431	*data = g_variant_new_uint64(devc->limit_samples);
	432	break;
	433	case SR_CONF_SAMPLERATE:
	434	*data = g_variant_new_uint64(devc->cur_samplerate);
	435	break;
	436	default:
	437	return SR_ERR_NA;
	438	}
	439
	440	return SR_OK;
	441	}
	442
	443	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
	444	const struct sr_channel_group *cg)
	445	{
	446	struct dev_context *devc;
	447	uint64_t arg;
	448	unsigned int i;
	449	int ret;
	450
	451	(void)cg;
	452
	453	if (!sdi)
	454	return SR_ERR_ARG;
	455
	456	if (sdi->status != SR_ST_ACTIVE)
	457	return SR_ERR;
	458
	459	devc = sdi->priv;
	460
	461	ret = SR_OK;
	462
	463	switch (key) {
	464	case SR_CONF_SAMPLERATE:
	465	arg = g_variant_get_uint64(data);
	466	for (i = 0; i < ARRAY_SIZE(samplerates); i++) {
	467	if (samplerates[i] == arg) {
	468	devc->cur_samplerate = arg;
	469	break;
	470	}
	471	}
	472	if (i == ARRAY_SIZE(samplerates))
	473	ret = SR_ERR_ARG;
	474	break;
	475	case SR_CONF_LIMIT_SAMPLES:
	476	devc->limit_samples = g_variant_get_uint64(data);
	477	break;
	478	default:
	479	ret = SR_ERR_NA;
	480	}
	481
	482	return ret;
	483	}
	484
	485	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
	486	const struct sr_channel_group *cg)
	487	{
	488	GVariant *gvar;
	489	GVariantBuilder gvb;
	490
	491	(void)sdi;
	492	(void)cg;
	493
	494	switch (key) {
	495	case SR_CONF_SCAN_OPTIONS:
	496	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	497	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
	498	break;
	499	case SR_CONF_DEVICE_OPTIONS:
	500	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
	501	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
	502	break;
	503	case SR_CONF_SAMPLERATE:
	504	g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
	505	gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
	506	ARRAY_SIZE(samplerates), sizeof(uint64_t));
	507	g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
	508	*data = g_variant_builder_end(&gvb);
	509	break;
	510	case SR_CONF_TRIGGER_MATCH:
	511	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	512	soft_trigger_matches, ARRAY_SIZE(soft_trigger_matches),
	513	sizeof(int32_t));
	514	break;
	515	default:
	516	return SR_ERR_NA;
	517	}
	518
	519	return SR_OK;
	520	}
	521
	522	static int receive_data(int fd, int revents, void *cb_data)
	523	{
	524	struct timeval tv;
	525	struct drv_context *drvc;
	526
	527	(void)fd;
	528	(void)revents;
	529	(void)cb_data;
	530
	531	drvc = di->priv;
	532
	533	tv.tv_sec = tv.tv_usec = 0;
	534	libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	535
	536	return TRUE;
	537	}
	538
	539	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	540	{
	541	struct dev_context *devc;
	542	struct drv_context *drvc;
	543	struct sr_usb_dev_inst *usb;
	544	struct sr_trigger *trigger;
	545	struct libusb_transfer *transfer;
	546	unsigned int i, timeout, num_transfers;
	547	int ret;
	548	unsigned char *buf;
	549	size_t size;
	550
	551	if (sdi->status != SR_ST_ACTIVE)
	552	return SR_ERR_DEV_CLOSED;
	553
	554	drvc = di->priv;
	555	devc = sdi->priv;
	556	usb = sdi->conn;
	557
	558	devc->cb_data = cb_data;
	559	devc->sent_samples = 0;
	560	devc->acq_aborted = FALSE;
	561	devc->empty_transfer_count = 0;
	562
	563	if ((trigger = sr_session_trigger_get(sdi->session))) {
	564	devc->stl = soft_trigger_logic_new(sdi, trigger);
	565	devc->trigger_fired = FALSE;
	566	} else
	567	devc->trigger_fired = TRUE;
	568
	569	timeout = fx2lafw_get_timeout(devc);
	570	num_transfers = fx2lafw_get_number_of_transfers(devc);
	571	size = fx2lafw_get_buffer_size(devc);
	572	devc->submitted_transfers = 0;
	573
	574	devc->transfers = g_try_malloc0(sizeof(devc->transfers) num_transfers);
	575	if (!devc->transfers) {
	576	sr_err("USB transfers malloc failed.");
	577	return SR_ERR_MALLOC;
	578	}
	579
	580	devc->num_transfers = num_transfers;
	581	for (i = 0; i < num_transfers; i++) {
	582	if (!(buf = g_try_malloc(size))) {
	583	sr_err("USB transfer buffer malloc failed.");
	584	return SR_ERR_MALLOC;
	585	}
	586	transfer = libusb_alloc_transfer(0);
	587	libusb_fill_bulk_transfer(transfer, usb->devhdl,
	588	2 \| LIBUSB_ENDPOINT_IN, buf, size,
	589	fx2lafw_receive_transfer, (void *)sdi, timeout);
	590	if ((ret = libusb_submit_transfer(transfer)) != 0) {
	591	sr_err("Failed to submit transfer: %s.",
	592	libusb_error_name(ret));
	593	libusb_free_transfer(transfer);
	594	g_free(buf);
	595	fx2lafw_abort_acquisition(devc);
	596	return SR_ERR;
	597	}
	598	devc->transfers[i] = transfer;
	599	devc->submitted_transfers++;
	600	}
	601
	602	devc->ctx = drvc->sr_ctx;
	603
	604	usb_source_add(sdi->session, devc->ctx, timeout, receive_data, NULL);
	605
	606	/* Send header packet to the session bus. */
	607	std_session_send_df_header(cb_data, LOG_PREFIX);
	608
	609	if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
	610	fx2lafw_abort_acquisition(devc);
	611	return ret;
	612	}
	613
	614	return SR_OK;
	615	}
	616
	617	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	618	{
	619	(void)cb_data;
	620
	621	fx2lafw_abort_acquisition(sdi->priv);
	622
	623	return SR_OK;
	624	}
	625
	626	SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
	627	.name = "fx2lafw",
	628	.longname = "fx2lafw (generic driver for FX2 based LAs)",
	629	.api_version = 1,
	630	.init = init,
	631	.cleanup = cleanup,
	632	.scan = scan,
	633	.dev_list = dev_list,
	634	.dev_clear = NULL,
	635	.config_get = config_get,
	636	.config_set = config_set,
	637	.config_list = config_list,
	638	.dev_open = dev_open,
	639	.dev_close = dev_close,
	640	.dev_acquisition_start = dev_acquisition_start,
	641	.dev_acquisition_stop = dev_acquisition_stop,
	642	.priv = NULL,
	643	};