[libsigrok.git] / 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 },
	/*
	 * CWAV USBee DX
	 * XZL-Studio DX
	 */
	{ 0x08a9, 0x0015, "CWAV", "USBee DX", NULL,
		FIRMWARE_DIR "/fx2lafw-cwav-usbeedx.fw",
		DEV_CAPS_16BIT },

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

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

	/*
	 * 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 },

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

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

static const int32_t hwopts[] = {
	SR_CONF_CONN,
};

static const int32_t hwcaps[] = {
	SR_CONF_LOGIC_ANALYZER,
	SR_CONF_TRIGGER_TYPE,
	SR_CONF_SAMPLERATE,

	/* These are really implemented in the driver, not the hardware. */
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_CONTINUOUS,
};

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

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;
	int devcnt, num_logic_channels, ret, i, j;
	const char *conn;

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

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

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

		devcnt = g_slist_length(drvc->instances);
		sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
			prof->vendor, prof->model, prof->model_version);
		if (!sdi)
			return NULL;
		sdi->driver = di;

		/* 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;
		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.", devcnt);
			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 %d on %d.%d interface %d.",
		sdi->index, usb->bus, usb->address, 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(int id, 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 (id) {
	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(int id, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	int ret;

	(void)cg;

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

	devc = sdi->priv;

	if (id == SR_CONF_SAMPLERATE) {
		devc->cur_samplerate = g_variant_get_uint64(data);
		ret = SR_OK;
	} else if (id == SR_CONF_LIMIT_SAMPLES) {
		devc->limit_samples = g_variant_get_uint64(data);
		ret = SR_OK;
	} else {
		ret = SR_ERR_NA;
	}

	return ret;
}

static int config_list(int 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_INT32,
				hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_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_TYPE:
		*data = g_variant_new_string(TRIGGER_TYPE);
		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 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;

	/* Configures devc->trigger_* and devc->sample_wide */
	if (fx2lafw_configure_channels(sdi) != SR_OK) {
		sr_err("Failed to configure channels.");
		return SR_ERR;
	}

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

	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, devc, 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(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 },
	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 },
	39
	40	/*
	41	* CWAV USBee SX
	42	*/
	43	{ 0x08a9, 0x0009, "CWAV", "USBee SX", NULL,
	44	FIRMWARE_DIR "/fx2lafw-cwav-usbeesx.fw",
	45	0 },
	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 },
	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 },
	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 },
	72
	73	{ 0, 0, 0, 0, 0, 0, 0 }
	74	};
	75
	76	static const int32_t hwopts[] = {
	77	SR_CONF_CONN,
	78	};
	79
	80	static const int32_t hwcaps[] = {
	81	SR_CONF_LOGIC_ANALYZER,
	82	SR_CONF_TRIGGER_TYPE,
	83	SR_CONF_SAMPLERATE,
	84
	85	/* These are really implemented in the driver, not the hardware. */
	86	SR_CONF_LIMIT_SAMPLES,
	87	SR_CONF_CONTINUOUS,
	88	};
	89
	90	static const char *channel_names[] = {
	91	"0", "1", "2", "3", "4", "5", "6", "7",
	92	"8", "9", "10", "11", "12", "13", "14", "15",
	93	NULL,
	94	};
	95
	96	static const uint64_t samplerates[] = {
	97	SR_KHZ(20),
	98	SR_KHZ(25),
	99	SR_KHZ(50),
	100	SR_KHZ(100),
	101	SR_KHZ(200),
	102	SR_KHZ(250),
	103	SR_KHZ(500),
	104	SR_MHZ(1),
	105	SR_MHZ(2),
	106	SR_MHZ(3),
	107	SR_MHZ(4),
	108	SR_MHZ(6),
	109	SR_MHZ(8),
	110	SR_MHZ(12),
	111	SR_MHZ(16),
	112	SR_MHZ(24),
	113	};
	114
	115	SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
	116	static struct sr_dev_driver *di = &fx2lafw_driver_info;
	117
	118	static int init(struct sr_context *sr_ctx)
	119	{
	120	return std_init(sr_ctx, di, LOG_PREFIX);
	121	}
	122
	123	static GSList scan(GSList options)
	124	{
	125	struct drv_context *drvc;
	126	struct dev_context *devc;
	127	struct sr_dev_inst *sdi;
	128	struct sr_usb_dev_inst *usb;
	129	struct sr_channel *ch;
	130	struct sr_config *src;
	131	const struct fx2lafw_profile *prof;
	132	GSList l, devices, *conn_devices;
	133	struct libusb_device_descriptor des;
	134	libusb_device **devlist;
	135	int devcnt, num_logic_channels, ret, i, j;
	136	const char *conn;
	137
	138	drvc = di->priv;
	139
	140	conn = NULL;
	141	for (l = options; l; l = l->next) {
	142	src = l->data;
	143	switch (src->key) {
	144	case SR_CONF_CONN:
	145	conn = g_variant_get_string(src->data, NULL);
	146	break;
	147	}
	148	}
	149	if (conn)
	150	conn_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	151	else
	152	conn_devices = NULL;
	153
	154	/* Find all fx2lafw compatible devices and upload firmware to them. */
	155	devices = NULL;
	156	libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	157	for (i = 0; devlist[i]; i++) {
	158	if (conn) {
	159	usb = NULL;
	160	for (l = conn_devices; l; l = l->next) {
	161	usb = l->data;
	162	if (usb->bus == libusb_get_bus_number(devlist[i])
	163	&& usb->address == libusb_get_device_address(devlist[i]))
	164	break;
	165	}
	166	if (!l)
	167	/* This device matched none of the ones that
	168	* matched the conn specification. */
	169	continue;
	170	}
	171
	172	if ((ret = libusb_get_device_descriptor( devlist[i], &des)) != 0) {
	173	sr_warn("Failed to get device descriptor: %s.",
	174	libusb_error_name(ret));
	175	continue;
	176	}
	177
	178	prof = NULL;
	179	for (j = 0; supported_fx2[j].vid; j++) {
	180	if (des.idVendor == supported_fx2[j].vid &&
	181	des.idProduct == supported_fx2[j].pid) {
	182	prof = &supported_fx2[j];
	183	}
	184	}
	185
	186	/* Skip if the device was not found. */
	187	if (!prof)
	188	continue;
	189
	190	devcnt = g_slist_length(drvc->instances);
	191	sdi = sr_dev_inst_new(devcnt, SR_ST_INITIALIZING,
	192	prof->vendor, prof->model, prof->model_version);
	193	if (!sdi)
	194	return NULL;
	195	sdi->driver = di;
	196
	197	/* Fill in channellist according to this device's profile. */
	198	num_logic_channels = prof->dev_caps & DEV_CAPS_16BIT ? 16 : 8;
	199	for (j = 0; j < num_logic_channels; j++) {
	200	if (!(ch = sr_channel_new(j, SR_CHANNEL_LOGIC, TRUE,
	201	channel_names[j])))
	202	return NULL;
	203	sdi->channels = g_slist_append(sdi->channels, ch);
	204	}
	205
	206	devc = fx2lafw_dev_new();
	207	devc->profile = prof;
	208	sdi->priv = devc;
	209	drvc->instances = g_slist_append(drvc->instances, sdi);
	210	devices = g_slist_append(devices, sdi);
	211
	212	if (fx2lafw_check_conf_profile(devlist[i])) {
	213	/* Already has the firmware, so fix the new address. */
	214	sr_dbg("Found an fx2lafw device.");
	215	sdi->status = SR_ST_INACTIVE;
	216	sdi->inst_type = SR_INST_USB;
	217	sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
	218	libusb_get_device_address(devlist[i]), NULL);
	219	} else {
	220	if (ezusb_upload_firmware(devlist[i], USB_CONFIGURATION,
	221	prof->firmware) == SR_OK)
	222	/* Store when this device's FW was updated. */
	223	devc->fw_updated = g_get_monotonic_time();
	224	else
	225	sr_err("Firmware upload failed for "
	226	"device %d.", devcnt);
	227	sdi->inst_type = SR_INST_USB;
	228	sdi->conn = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
	229	0xff, NULL);
	230	}
	231	}
	232	libusb_free_device_list(devlist, 1);
	233	g_slist_free_full(conn_devices, (GDestroyNotify)sr_usb_dev_inst_free);
	234
	235	return devices;
	236	}
	237
	238	static GSList *dev_list(void)
	239	{
	240	return ((struct drv_context *)(di->priv))->instances;
	241	}
	242
	243	static int dev_open(struct sr_dev_inst *sdi)
	244	{
	245	struct sr_usb_dev_inst *usb;
	246	struct dev_context *devc;
	247	int ret;
	248	int64_t timediff_us, timediff_ms;
	249
	250	devc = sdi->priv;
	251	usb = sdi->conn;
	252
	253	/*
	254	* If the firmware was recently uploaded, wait up to MAX_RENUM_DELAY_MS
	255	* milliseconds for the FX2 to renumerate.
	256	*/
	257	ret = SR_ERR;
	258	if (devc->fw_updated > 0) {
	259	sr_info("Waiting for device to reset.");
	260	/* Takes >= 300ms for the FX2 to be gone from the USB bus. */
	261	g_usleep(300 * 1000);
	262	timediff_ms = 0;
	263	while (timediff_ms < MAX_RENUM_DELAY_MS) {
	264	if ((ret = fx2lafw_dev_open(sdi, di)) == SR_OK)
	265	break;
	266	g_usleep(100 * 1000);
	267
	268	timediff_us = g_get_monotonic_time() - devc->fw_updated;
	269	timediff_ms = timediff_us / 1000;
	270	sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
	271	}
	272	if (ret != SR_OK) {
	273	sr_err("Device failed to renumerate.");
	274	return SR_ERR;
	275	}
	276	sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
	277	} else {
	278	sr_info("Firmware upload was not needed.");
	279	ret = fx2lafw_dev_open(sdi, di);
	280	}
	281
	282	if (ret != SR_OK) {
	283	sr_err("Unable to open device.");
	284	return SR_ERR;
	285	}
	286
	287	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	288	if (ret != 0) {
	289	switch (ret) {
	290	case LIBUSB_ERROR_BUSY:
	291	sr_err("Unable to claim USB interface. Another "
	292	"program or driver has already claimed it.");
	293	break;
	294	case LIBUSB_ERROR_NO_DEVICE:
	295	sr_err("Device has been disconnected.");
	296	break;
	297	default:
	298	sr_err("Unable to claim interface: %s.",
	299	libusb_error_name(ret));
	300	break;
	301	}
	302
	303	return SR_ERR;
	304	}
	305
	306	if (devc->cur_samplerate == 0) {
	307	/* Samplerate hasn't been set; default to the slowest one. */
	308	devc->cur_samplerate = samplerates[0];
	309	}
	310
	311	return SR_OK;
	312	}
	313
	314	static int dev_close(struct sr_dev_inst *sdi)
	315	{
	316	struct sr_usb_dev_inst *usb;
	317
	318	usb = sdi->conn;
	319	if (usb->devhdl == NULL)
	320	return SR_ERR;
	321
	322	sr_info("fx2lafw: Closing device %d on %d.%d interface %d.",
	323	sdi->index, usb->bus, usb->address, USB_INTERFACE);
	324	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	325	libusb_close(usb->devhdl);
	326	usb->devhdl = NULL;
	327	sdi->status = SR_ST_INACTIVE;
	328
	329	return SR_OK;
	330	}
	331
	332	static int cleanup(void)
	333	{
	334	int ret;
	335	struct drv_context *drvc;
	336
	337	if (!(drvc = di->priv))
	338	return SR_OK;
	339
	340
	341	ret = std_dev_clear(di, NULL);
	342
	343	g_free(drvc);
	344	di->priv = NULL;
	345
	346	return ret;
	347	}
	348
	349	static int config_get(int id, GVariant *data, const struct sr_dev_inst sdi,
	350	const struct sr_channel_group *cg)
	351	{
	352	struct dev_context *devc;
	353	struct sr_usb_dev_inst *usb;
	354	char str[128];
	355
	356	(void)cg;
	357
	358	if (!sdi)
	359	return SR_ERR_ARG;
	360
	361	devc = sdi->priv;
	362
	363	switch (id) {
	364	case SR_CONF_CONN:
	365	if (!sdi->conn)
	366	return SR_ERR_ARG;
	367	usb = sdi->conn;
	368	if (usb->address == 255)
	369	/* Device still needs to re-enumerate after firmware
	370	* upload, so we don't know its (future) address. */
	371	return SR_ERR;
	372	snprintf(str, 128, "%d.%d", usb->bus, usb->address);
	373	*data = g_variant_new_string(str);
	374	break;
	375	case SR_CONF_LIMIT_SAMPLES:
	376	*data = g_variant_new_uint64(devc->limit_samples);
	377	break;
	378	case SR_CONF_SAMPLERATE:
	379	*data = g_variant_new_uint64(devc->cur_samplerate);
	380	break;
	381	default:
	382	return SR_ERR_NA;
	383	}
	384
	385	return SR_OK;
	386	}
	387
	388	static int config_set(int id, GVariant data, const struct sr_dev_inst sdi,
	389	const struct sr_channel_group *cg)
	390	{
	391	struct dev_context *devc;
	392	int ret;
	393
	394	(void)cg;
	395
	396	if (sdi->status != SR_ST_ACTIVE)
	397	return SR_ERR;
	398
	399	devc = sdi->priv;
	400
	401	if (id == SR_CONF_SAMPLERATE) {
	402	devc->cur_samplerate = g_variant_get_uint64(data);
	403	ret = SR_OK;
	404	} else if (id == SR_CONF_LIMIT_SAMPLES) {
	405	devc->limit_samples = g_variant_get_uint64(data);
	406	ret = SR_OK;
	407	} else {
	408	ret = SR_ERR_NA;
	409	}
	410
	411	return ret;
	412	}
	413
	414	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi,
	415	const struct sr_channel_group *cg)
	416	{
	417	GVariant *gvar;
	418	GVariantBuilder gvb;
	419
	420	(void)sdi;
	421	(void)cg;
	422
	423	switch (key) {
	424	case SR_CONF_SCAN_OPTIONS:
	425	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	426	hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
	427	break;
	428	case SR_CONF_DEVICE_OPTIONS:
	429	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	430	hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
	431	break;
	432	case SR_CONF_SAMPLERATE:
	433	g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
	434	gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates,
	435	ARRAY_SIZE(samplerates), sizeof(uint64_t));
	436	g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
	437	*data = g_variant_builder_end(&gvb);
	438	break;
	439	case SR_CONF_TRIGGER_TYPE:
	440	*data = g_variant_new_string(TRIGGER_TYPE);
	441	break;
	442	default:
	443	return SR_ERR_NA;
	444	}
	445
	446	return SR_OK;
	447	}
	448
	449	static int receive_data(int fd, int revents, void *cb_data)
	450	{
	451	struct timeval tv;
	452	struct drv_context *drvc;
	453
	454	(void)fd;
	455	(void)revents;
	456	(void)cb_data;
	457
	458	drvc = di->priv;
	459
	460	tv.tv_sec = tv.tv_usec = 0;
	461	libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
	462
	463	return TRUE;
	464	}
	465
	466	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	467	{
	468	struct dev_context *devc;
	469	struct drv_context *drvc;
	470	struct sr_usb_dev_inst *usb;
	471	struct libusb_transfer *transfer;
	472	unsigned int i, timeout, num_transfers;
	473	int ret;
	474	unsigned char *buf;
	475	size_t size;
	476
	477	if (sdi->status != SR_ST_ACTIVE)
	478	return SR_ERR_DEV_CLOSED;
	479
	480	drvc = di->priv;
	481	devc = sdi->priv;
	482	usb = sdi->conn;
	483
	484	/* Configures devc->trigger_* and devc->sample_wide */
	485	if (fx2lafw_configure_channels(sdi) != SR_OK) {
	486	sr_err("Failed to configure channels.");
	487	return SR_ERR;
	488	}
	489
	490	devc->cb_data = cb_data;
	491	devc->sent_samples = 0;
	492	devc->acq_aborted = FALSE;
	493	devc->empty_transfer_count = 0;
	494
	495	timeout = fx2lafw_get_timeout(devc);
	496	num_transfers = fx2lafw_get_number_of_transfers(devc);
	497	size = fx2lafw_get_buffer_size(devc);
	498	devc->submitted_transfers = 0;
	499
	500	devc->transfers = g_try_malloc0(sizeof(devc->transfers) num_transfers);
	501	if (!devc->transfers) {
	502	sr_err("USB transfers malloc failed.");
	503	return SR_ERR_MALLOC;
	504	}
	505
	506	devc->num_transfers = num_transfers;
	507	for (i = 0; i < num_transfers; i++) {
	508	if (!(buf = g_try_malloc(size))) {
	509	sr_err("USB transfer buffer malloc failed.");
	510	return SR_ERR_MALLOC;
	511	}
	512	transfer = libusb_alloc_transfer(0);
	513	libusb_fill_bulk_transfer(transfer, usb->devhdl,
	514	2 \| LIBUSB_ENDPOINT_IN, buf, size,
	515	fx2lafw_receive_transfer, devc, timeout);
	516	if ((ret = libusb_submit_transfer(transfer)) != 0) {
	517	sr_err("Failed to submit transfer: %s.",
	518	libusb_error_name(ret));
	519	libusb_free_transfer(transfer);
	520	g_free(buf);
	521	fx2lafw_abort_acquisition(devc);
	522	return SR_ERR;
	523	}
	524	devc->transfers[i] = transfer;
	525	devc->submitted_transfers++;
	526	}
	527
	528	devc->ctx = drvc->sr_ctx;
	529
	530	usb_source_add(devc->ctx, timeout, receive_data, NULL);
	531
	532	/* Send header packet to the session bus. */
	533	std_session_send_df_header(cb_data, LOG_PREFIX);
	534
	535	if ((ret = fx2lafw_command_start_acquisition(sdi)) != SR_OK) {
	536	fx2lafw_abort_acquisition(devc);
	537	return ret;
	538	}
	539
	540	return SR_OK;
	541	}
	542
	543	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	544	{
	545	(void)cb_data;
	546
	547	fx2lafw_abort_acquisition(sdi->priv);
	548
	549	return SR_OK;
	550	}
	551
	552	SR_PRIV struct sr_dev_driver fx2lafw_driver_info = {
	553	.name = "fx2lafw",
	554	.longname = "fx2lafw (generic driver for FX2 based LAs)",
	555	.api_version = 1,
	556	.init = init,
	557	.cleanup = cleanup,
	558	.scan = scan,
	559	.dev_list = dev_list,
	560	.dev_clear = NULL,
	561	.config_get = config_get,
	562	.config_set = config_set,
	563	.config_list = config_list,
	564	.dev_open = dev_open,
	565	.dev_close = dev_close,
	566	.dev_acquisition_start = dev_acquisition_start,
	567	.dev_acquisition_stop = dev_acquisition_stop,
	568	.priv = NULL,
	569	};