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

/* Protocol commands */
#define CMD_GET_FW_VERSION		0xb0
#define CMD_START			0xb1
#define CMD_GET_REVID_VERSION		0xb2

#define CMD_START_FLAGS_WIDE_POS	5
#define CMD_START_FLAGS_CLK_SRC_POS	6

#define CMD_START_FLAGS_SAMPLE_8BIT	(0 << CMD_START_FLAGS_WIDE_POS)
#define CMD_START_FLAGS_SAMPLE_16BIT	(1 << CMD_START_FLAGS_WIDE_POS)

#define CMD_START_FLAGS_CLK_30MHZ	(0 << CMD_START_FLAGS_CLK_SRC_POS)
#define CMD_START_FLAGS_CLK_48MHZ	(1 << CMD_START_FLAGS_CLK_SRC_POS)

#pragma pack(push, 1)

struct version_info {
	uint8_t major;
	uint8_t minor;
};

struct cmd_start_acquisition {
	uint8_t flags;
	uint8_t sample_delay_h;
	uint8_t sample_delay_l;
};

#pragma pack(pop)

static int command_get_fw_version(libusb_device_handle *devhdl,
				  struct version_info *vi)
{
	int ret;

	ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
		LIBUSB_ENDPOINT_IN, CMD_GET_FW_VERSION, 0x0000, 0x0000,
		(unsigned char *)vi, sizeof(struct version_info), 100);

	if (ret < 0) {
		sr_err("Unable to get version info: %s.",
		       libusb_error_name(ret));
		return SR_ERR;
	}

	return SR_OK;
}

static int command_get_revid_version(struct sr_dev_inst *sdi, uint8_t *revid)
{
	struct sr_usb_dev_inst *usb = sdi->conn;
	libusb_device_handle *devhdl = usb->devhdl;
	int ret;

	ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
		LIBUSB_ENDPOINT_IN, CMD_GET_REVID_VERSION, 0x0000, 0x0000,
		revid, 1, 100);

	if (ret < 0) {
		sr_err("Unable to get REVID: %s.", libusb_error_name(ret));
		return SR_ERR;
	}

	return SR_OK;
}

SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	struct sr_usb_dev_inst *usb;
	uint64_t samplerate;
	struct cmd_start_acquisition cmd;
	int delay, ret;

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

	/* Compute the sample rate. */
	if (devc->sample_wide && samplerate > MAX_16BIT_SAMPLE_RATE) {
		sr_err("Unable to sample at %" PRIu64 "Hz "
		       "when collecting 16-bit samples.", samplerate);
		return SR_ERR;
	}

	delay = 0;
	cmd.flags = cmd.sample_delay_h = cmd.sample_delay_l = 0;
	if ((SR_MHZ(48) % samplerate) == 0) {
		cmd.flags = CMD_START_FLAGS_CLK_48MHZ;
		delay = SR_MHZ(48) / samplerate - 1;
		if (delay > MAX_SAMPLE_DELAY)
			delay = 0;
	}

	if (delay == 0 && (SR_MHZ(30) % samplerate) == 0) {
		cmd.flags = CMD_START_FLAGS_CLK_30MHZ;
		delay = SR_MHZ(30) / samplerate - 1;
	}

	sr_info("GPIF delay = %d, clocksource = %sMHz.", delay,
		(cmd.flags & CMD_START_FLAGS_CLK_48MHZ) ? "48" : "30");

	if (delay <= 0 || delay > MAX_SAMPLE_DELAY) {
		sr_err("Unable to sample at %" PRIu64 "Hz.", samplerate);
		return SR_ERR;
	}

	cmd.sample_delay_h = (delay >> 8) & 0xff;
	cmd.sample_delay_l = delay & 0xff;

	/* Select the sampling width. */
	cmd.flags |= devc->sample_wide ? CMD_START_FLAGS_SAMPLE_16BIT :
		CMD_START_FLAGS_SAMPLE_8BIT;

	/* Send the control message. */
	ret = libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
			LIBUSB_ENDPOINT_OUT, CMD_START, 0x0000, 0x0000,
			(unsigned char *)&cmd, sizeof(cmd), 100);
	if (ret < 0) {
		sr_err("Unable to send start command: %s.",
		       libusb_error_name(ret));
		return SR_ERR;
	}

	return SR_OK;
}

/**
 * Check the USB configuration to determine if this is an fx2lafw device.
 *
 * @return TRUE if the device's configuration profile match fx2lafw
 *         configuration, FALSE otherwise.
 */
SR_PRIV gboolean fx2lafw_check_conf_profile(libusb_device *dev)
{
	struct libusb_device_descriptor des;
	struct libusb_device_handle *hdl;
	gboolean ret;
	unsigned char strdesc[64];

	hdl = NULL;
	ret = FALSE;
	while (!ret) {
		/* Assume the FW has not been loaded, unless proven wrong. */
		if (libusb_get_device_descriptor(dev, &des) != 0)
			break;

		if (libusb_open(dev, &hdl) != 0)
			break;

		if (libusb_get_string_descriptor_ascii(hdl,
		    des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
			break;
		if (strncmp((const char *)strdesc, "sigrok", 6))
			break;

		if (libusb_get_string_descriptor_ascii(hdl,
				des.iProduct, strdesc, sizeof(strdesc)) < 0)
			break;
		if (strncmp((const char *)strdesc, "fx2lafw", 7))
			break;

		/* If we made it here, it must be an fx2lafw. */
		ret = TRUE;
	}
	if (hdl)
		libusb_close(hdl);

	return ret;
}

SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di)
{
	libusb_device **devlist;
	struct sr_usb_dev_inst *usb;
	struct libusb_device_descriptor des;
	struct dev_context *devc;
	struct drv_context *drvc;
	struct version_info vi;
	int ret, i, device_count;
	uint8_t revid;
	char connection_id[64];

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

	if (sdi->status == SR_ST_ACTIVE)
		/* Device is already in use. */
		return SR_ERR;

	device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	if (device_count < 0) {
		sr_err("Failed to get device list: %s.",
		       libusb_error_name(device_count));
		return SR_ERR;
	}

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

		if (des.idVendor != devc->profile->vid
		    || des.idProduct != devc->profile->pid)
			continue;

		if ((sdi->status == SR_ST_INITIALIZING) ||
				(sdi->status == SR_ST_INACTIVE)) {
			/*
			 * Check device by its physical USB bus/port address.
			 */
			usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
			if (strcmp(sdi->connection_id, connection_id))
				/* This is not the one. */
				continue;
		}

		if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
			if (usb->address == 0xff)
				/*
				 * First time we touch this device after FW
				 * upload, so we don't know the address yet.
				 */
				usb->address = libusb_get_device_address(devlist[i]);
		} else {
			sr_err("Failed to open device: %s.",
			       libusb_error_name(ret));
			break;
		}

		ret = command_get_fw_version(usb->devhdl, &vi);
		if (ret != SR_OK) {
			sr_err("Failed to get firmware version.");
			break;
		}

		ret = command_get_revid_version(sdi, &revid);
		if (ret != SR_OK) {
			sr_err("Failed to get REVID.");
			break;
		}

		/*
		 * Changes in major version mean incompatible/API changes, so
		 * bail out if we encounter an incompatible version.
		 * Different minor versions are OK, they should be compatible.
		 */
		if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
			sr_err("Expected firmware version %d.x, "
			       "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
			       vi.major, vi.minor);
			break;
		}

		sdi->status = SR_ST_ACTIVE;
		sr_info("Opened device on %d.%d (logical) / %s (physical), "
			"interface %d, firmware %d.%d.",
			usb->bus, usb->address, connection_id,
			USB_INTERFACE, vi.major, vi.minor);

		sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
			revid, (revid != 1) ? " (FX2)" : "A (FX2LP)");

		break;
	}
	libusb_free_device_list(devlist, 1);

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

	return SR_OK;
}

SR_PRIV struct dev_context *fx2lafw_dev_new(void)
{
	struct dev_context *devc;

	devc = g_malloc0(sizeof(struct dev_context));
	devc->profile = NULL;
	devc->fw_updated = 0;
	devc->cur_samplerate = 0;
	devc->limit_samples = 0;
	devc->sample_wide = FALSE;
	devc->stl = NULL;

	return devc;
}

SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc)
{
	int i;

	devc->acq_aborted = TRUE;

	for (i = devc->num_transfers - 1; i >= 0; i--) {
		if (devc->transfers[i])
			libusb_cancel_transfer(devc->transfers[i]);
	}
}

static void finish_acquisition(struct sr_dev_inst *sdi)
{
	struct sr_datafeed_packet packet;
	struct dev_context *devc;

	devc = sdi->priv;

	/* Terminate session. */
	packet.type = SR_DF_END;
	sr_session_send(sdi, &packet);

	/* Remove fds from polling. */
	usb_source_remove(sdi->session, devc->ctx);

	devc->num_transfers = 0;
	g_free(devc->transfers);

	if (devc->stl) {
		soft_trigger_logic_free(devc->stl);
		devc->stl = NULL;
	}
}

static void free_transfer(struct libusb_transfer *transfer)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	unsigned int i;

	sdi = transfer->user_data;
	devc = sdi->priv;

	g_free(transfer->buffer);
	transfer->buffer = NULL;
	libusb_free_transfer(transfer);

	for (i = 0; i < devc->num_transfers; i++) {
		if (devc->transfers[i] == transfer) {
			devc->transfers[i] = NULL;
			break;
		}
	}

	devc->submitted_transfers--;
	if (devc->submitted_transfers == 0)
		finish_acquisition(sdi);
}

static void resubmit_transfer(struct libusb_transfer *transfer)
{
	int ret;

	if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
		return;

	sr_err("%s: %s", __func__, libusb_error_name(ret));
	free_transfer(transfer);

}

SR_PRIV void fx2lafw_receive_transfer(struct libusb_transfer *transfer)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	gboolean packet_has_error = FALSE;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_logic logic;
	unsigned int num_samples;
	int trigger_offset, cur_sample_count, unitsize;

	sdi = transfer->user_data;
	devc = sdi->priv;

	/*
	 * If acquisition has already ended, just free any queued up
	 * transfer that come in.
	 */
	if (devc->acq_aborted) {
		free_transfer(transfer);
		return;
	}

	sr_info("receive_transfer(): status %d received %d bytes.",
		transfer->status, transfer->actual_length);

	/* Save incoming transfer before reusing the transfer struct. */
	unitsize = devc->sample_wide ? 2 : 1;
	cur_sample_count = transfer->actual_length / unitsize;

	switch (transfer->status) {
	case LIBUSB_TRANSFER_NO_DEVICE:
		fx2lafw_abort_acquisition(devc);
		free_transfer(transfer);
		return;
	case LIBUSB_TRANSFER_COMPLETED:
	case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
		break;
	default:
		packet_has_error = TRUE;
		break;
	}

	if (transfer->actual_length == 0 || packet_has_error) {
		devc->empty_transfer_count++;
		if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
			/*
			 * The FX2 gave up. End the acquisition, the frontend
			 * will work out that the samplecount is short.
			 */
			fx2lafw_abort_acquisition(devc);
			free_transfer(transfer);
		} else {
			resubmit_transfer(transfer);
		}
		return;
	} else {
		devc->empty_transfer_count = 0;
	}

	if (devc->trigger_fired) {
		if (!devc->limit_samples || devc->sent_samples < devc->limit_samples) {
			/* Send the incoming transfer to the session bus. */
			packet.type = SR_DF_LOGIC;
			packet.payload = &logic;
			if (devc->limit_samples && devc->sent_samples + cur_sample_count > devc->limit_samples)
				num_samples = devc->limit_samples - devc->sent_samples;
			else
				num_samples = cur_sample_count;
			logic.length = num_samples * unitsize;
			logic.unitsize = unitsize;
			logic.data = transfer->buffer;
			sr_session_send(devc->cb_data, &packet);
			devc->sent_samples += num_samples;
		}
	} else {
		trigger_offset = soft_trigger_logic_check(devc->stl,
				transfer->buffer, transfer->actual_length, NULL);
		if (trigger_offset > -1) {
			packet.type = SR_DF_LOGIC;
			packet.payload = &logic;
			num_samples = cur_sample_count - trigger_offset;
			if (devc->limit_samples &&
					num_samples > devc->limit_samples - devc->sent_samples)
				num_samples = devc->limit_samples - devc->sent_samples;
			logic.length = num_samples * unitsize;
			logic.unitsize = unitsize;
			logic.data = transfer->buffer + trigger_offset * unitsize;
			sr_session_send(devc->cb_data, &packet);
			devc->sent_samples += num_samples;

			devc->trigger_fired = TRUE;
		}
	}

	if (devc->limit_samples && devc->sent_samples >= devc->limit_samples) {
		fx2lafw_abort_acquisition(devc);
		free_transfer(transfer);
	} else
		resubmit_transfer(transfer);
}

static unsigned int to_bytes_per_ms(unsigned int samplerate)
{
	return samplerate / 1000;
}

SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc)
{
	size_t s;

	/*
	 * The buffer should be large enough to hold 10ms of data and
	 * a multiple of 512.
	 */
	s = 10 * to_bytes_per_ms(devc->cur_samplerate);
	return (s + 511) & ~511;
}

SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc)
{
	unsigned int n;

	/* Total buffer size should be able to hold about 500ms of data. */
	n = (500 * to_bytes_per_ms(devc->cur_samplerate) /
		fx2lafw_get_buffer_size(devc));

	if (n > NUM_SIMUL_TRANSFERS)
		return NUM_SIMUL_TRANSFERS;

	return n;
}

SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc)
{
	size_t total_size;
	unsigned int timeout;

	total_size = fx2lafw_get_buffer_size(devc) *
			fx2lafw_get_number_of_transfers(devc);
	timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
	return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
}
Commit	Line	Data
2f937611 UH	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	/* Protocol commands */
	24	#define CMD_GET_FW_VERSION 0xb0
	25	#define CMD_START 0xb1
	26	#define CMD_GET_REVID_VERSION 0xb2
	27
	28	#define CMD_START_FLAGS_WIDE_POS 5
	29	#define CMD_START_FLAGS_CLK_SRC_POS 6
	30
	31	#define CMD_START_FLAGS_SAMPLE_8BIT (0 << CMD_START_FLAGS_WIDE_POS)
	32	#define CMD_START_FLAGS_SAMPLE_16BIT (1 << CMD_START_FLAGS_WIDE_POS)
	33
	34	#define CMD_START_FLAGS_CLK_30MHZ (0 << CMD_START_FLAGS_CLK_SRC_POS)
	35	#define CMD_START_FLAGS_CLK_48MHZ (1 << CMD_START_FLAGS_CLK_SRC_POS)
	36
	37	#pragma pack(push, 1)
	38
	39	struct version_info {
	40	uint8_t major;
	41	uint8_t minor;
	42	};
	43
	44	struct cmd_start_acquisition {
	45	uint8_t flags;
	46	uint8_t sample_delay_h;
	47	uint8_t sample_delay_l;
	48	};
	49
	50	#pragma pack(pop)
	51
	52	static int command_get_fw_version(libusb_device_handle *devhdl,
	53	struct version_info *vi)
	54	{
	55	int ret;
	56
	57	ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR \|
	58	LIBUSB_ENDPOINT_IN, CMD_GET_FW_VERSION, 0x0000, 0x0000,
	59	(unsigned char *)vi, sizeof(struct version_info), 100);
	60
	61	if (ret < 0) {
	62	sr_err("Unable to get version info: %s.",
	63	libusb_error_name(ret));
	64	return SR_ERR;
65	}
66
67	return SR_OK;
68	}
69
a54edb1d	70	static int command_get_revid_version(struct sr_dev_inst sdi, uint8_t revid)
2f937611	71	{
a54edb1d ML	72	struct sr_usb_dev_inst *usb = sdi->conn;
a54edb1d ML	73	libusb_device_handle *devhdl = usb->devhdl;
2f937611 UH	74	int ret;
	75
	76	ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR \|
	77	LIBUSB_ENDPOINT_IN, CMD_GET_REVID_VERSION, 0x0000, 0x0000,
	78	revid, 1, 100);
	79
	80	if (ret < 0) {
	81	sr_err("Unable to get REVID: %s.", libusb_error_name(ret));
	82	return SR_ERR;
	83	}
	84
	85	return SR_OK;
	86	}
	87
a54edb1d	88	SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi)
2f937611	89	{
81a34976 BV	90	struct dev_context *devc;
	91	struct sr_usb_dev_inst *usb;
	92	uint64_t samplerate;
	93	struct cmd_start_acquisition cmd;
	94	int delay, ret;
	95
	96	devc = sdi->priv;
	97	usb = sdi->conn;
	98	samplerate = devc->cur_samplerate;
2f937611 UH	99
2f937611 UH	100	/* Compute the sample rate. */
81a34976	101	if (devc->sample_wide && samplerate > MAX_16BIT_SAMPLE_RATE) {
2f937611 UH	102	sr_err("Unable to sample at %" PRIu64 "Hz "
	103	"when collecting 16-bit samples.", samplerate);
	104	return SR_ERR;
	105	}
	106
81a34976 BV	107	delay = 0;
81a34976 BV	108	cmd.flags = cmd.sample_delay_h = cmd.sample_delay_l = 0;
2f937611 UH	109	if ((SR_MHZ(48) % samplerate) == 0) {
	110	cmd.flags = CMD_START_FLAGS_CLK_48MHZ;
	111	delay = SR_MHZ(48) / samplerate - 1;
	112	if (delay > MAX_SAMPLE_DELAY)
	113	delay = 0;
	114	}
	115
	116	if (delay == 0 && (SR_MHZ(30) % samplerate) == 0) {
	117	cmd.flags = CMD_START_FLAGS_CLK_30MHZ;
	118	delay = SR_MHZ(30) / samplerate - 1;
	119	}
	120
	121	sr_info("GPIF delay = %d, clocksource = %sMHz.", delay,
	122	(cmd.flags & CMD_START_FLAGS_CLK_48MHZ) ? "48" : "30");
	123
	124	if (delay <= 0 \|\| delay > MAX_SAMPLE_DELAY) {
	125	sr_err("Unable to sample at %" PRIu64 "Hz.", samplerate);
	126	return SR_ERR;
	127	}
	128
	129	cmd.sample_delay_h = (delay >> 8) & 0xff;
	130	cmd.sample_delay_l = delay & 0xff;
	131
	132	/* Select the sampling width. */
81a34976	133	cmd.flags \|= devc->sample_wide ? CMD_START_FLAGS_SAMPLE_16BIT :
2f937611 UH	134	CMD_START_FLAGS_SAMPLE_8BIT;
	135
	136	/* Send the control message. */
81a34976	137	ret = libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR \|
2f937611 UH	138	LIBUSB_ENDPOINT_OUT, CMD_START, 0x0000, 0x0000,
	139	(unsigned char *)&cmd, sizeof(cmd), 100);
	140	if (ret < 0) {
	141	sr_err("Unable to send start command: %s.",
	142	libusb_error_name(ret));
	143	return SR_ERR;
	144	}
	145
	146	return SR_OK;
	147	}
	148
	149	/**
	150	* Check the USB configuration to determine if this is an fx2lafw device.
	151	*
	152	* @return TRUE if the device's configuration profile match fx2lafw
	153	* configuration, FALSE otherwise.
	154	*/
	155	SR_PRIV gboolean fx2lafw_check_conf_profile(libusb_device *dev)
	156	{
	157	struct libusb_device_descriptor des;
	158	struct libusb_device_handle *hdl;
	159	gboolean ret;
	160	unsigned char strdesc[64];
	161
	162	hdl = NULL;
	163	ret = FALSE;
	164	while (!ret) {
	165	/* Assume the FW has not been loaded, unless proven wrong. */
	166	if (libusb_get_device_descriptor(dev, &des) != 0)
	167	break;
	168
	169	if (libusb_open(dev, &hdl) != 0)
	170	break;
	171
	172	if (libusb_get_string_descriptor_ascii(hdl,
	173	des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
	174	break;
	175	if (strncmp((const char *)strdesc, "sigrok", 6))
	176	break;
	177
	178	if (libusb_get_string_descriptor_ascii(hdl,
	179	des.iProduct, strdesc, sizeof(strdesc)) < 0)
	180	break;
	181	if (strncmp((const char *)strdesc, "fx2lafw", 7))
	182	break;
	183
	184	/* If we made it here, it must be an fx2lafw. */
	185	ret = TRUE;
	186	}
	187	if (hdl)
	188	libusb_close(hdl);
	189
	190	return ret;
	191	}
	192
	193	SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst sdi, struct sr_dev_driver di)
	194	{
	195	libusb_device **devlist;
	196	struct sr_usb_dev_inst *usb;
	197	struct libusb_device_descriptor des;
	198	struct dev_context *devc;
	199	struct drv_context *drvc;
	200	struct version_info vi;
5e2c86eb	201	int ret, i, device_count;
2f937611	202	uint8_t revid;
5e2c86eb	203	char connection_id[64];
2f937611 UH	204
	205	drvc = di->priv;
	206	devc = sdi->priv;
	207	usb = sdi->conn;
	208
	209	if (sdi->status == SR_ST_ACTIVE)
	210	/* Device is already in use. */
	211	return SR_ERR;
	212
2f937611 UH	213	device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	214	if (device_count < 0) {
	215	sr_err("Failed to get device list: %s.",
	216	libusb_error_name(device_count));
	217	return SR_ERR;
	218	}
	219
	220	for (i = 0; i < device_count; i++) {
	221	if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
	222	sr_err("Failed to get device descriptor: %s.",
	223	libusb_error_name(ret));
	224	continue;
	225	}
	226
	227	if (des.idVendor != devc->profile->vid
	228	\|\| des.idProduct != devc->profile->pid)
	229	continue;
	230
5e2c86eb SA	231	if ((sdi->status == SR_ST_INITIALIZING) \|\|
5e2c86eb SA	232	(sdi->status == SR_ST_INACTIVE)) {
2f937611	233	/*
5e2c86eb	234	* Check device by its physical USB bus/port address.
2f937611	235	*/
5e2c86eb SA	236	usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
5e2c86eb SA	237	if (strcmp(sdi->connection_id, connection_id))
2f937611 UH	238	/* This is not the one. */
	239	continue;
	240	}
	241
	242	if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
	243	if (usb->address == 0xff)
	244	/*
	245	* First time we touch this device after FW
	246	* upload, so we don't know the address yet.
	247	*/
	248	usb->address = libusb_get_device_address(devlist[i]);
	249	} else {
	250	sr_err("Failed to open device: %s.",
	251	libusb_error_name(ret));
	252	break;
	253	}
	254
	255	ret = command_get_fw_version(usb->devhdl, &vi);
	256	if (ret != SR_OK) {
	257	sr_err("Failed to get firmware version.");
	258	break;
	259	}
	260
a54edb1d	261	ret = command_get_revid_version(sdi, &revid);
2f937611 UH	262	if (ret != SR_OK) {
	263	sr_err("Failed to get REVID.");
	264	break;
	265	}
	266
	267	/*
	268	* Changes in major version mean incompatible/API changes, so
	269	* bail out if we encounter an incompatible version.
	270	* Different minor versions are OK, they should be compatible.
	271	*/
	272	if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
	273	sr_err("Expected firmware version %d.x, "
	274	"got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
	275	vi.major, vi.minor);
	276	break;
	277	}
	278
	279	sdi->status = SR_ST_ACTIVE;
5e2c86eb	280	sr_info("Opened device on %d.%d (logical) / %s (physical), "
2f937611	281	"interface %d, firmware %d.%d.",
5e2c86eb	282	usb->bus, usb->address, connection_id,
2f937611 UH	283	USB_INTERFACE, vi.major, vi.minor);
	284
	285	sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
	286	revid, (revid != 1) ? " (FX2)" : "A (FX2LP)");
	287
	288	break;
	289	}
	290	libusb_free_device_list(devlist, 1);
	291
	292	if (sdi->status != SR_ST_ACTIVE)
	293	return SR_ERR;
	294
	295	return SR_OK;
	296	}
	297
2f937611 UH	298	SR_PRIV struct dev_context *fx2lafw_dev_new(void)
	299	{
	300	struct dev_context *devc;
	301
f57d8ffe	302	devc = g_malloc0(sizeof(struct dev_context));
2f937611 UH	303	devc->profile = NULL;
	304	devc->fw_updated = 0;
	305	devc->cur_samplerate = 0;
	306	devc->limit_samples = 0;
87b545fb	307	devc->sample_wide = FALSE;
335122f0	308	devc->stl = NULL;
2f937611 UH	309
	310	return devc;
	311	}
	312
	313	SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc)
	314	{
	315	int i;
	316
b0ccd64d	317	devc->acq_aborted = TRUE;
2f937611 UH	318
	319	for (i = devc->num_transfers - 1; i >= 0; i--) {
	320	if (devc->transfers[i])
	321	libusb_cancel_transfer(devc->transfers[i]);
	322	}
	323	}
	324
102f1239	325	static void finish_acquisition(struct sr_dev_inst *sdi)
2f937611 UH	326	{
2f937611 UH	327	struct sr_datafeed_packet packet;
102f1239 BV	328	struct dev_context *devc;
	329
	330	devc = sdi->priv;
2f937611 UH	331
	332	/* Terminate session. */
	333	packet.type = SR_DF_END;
102f1239	334	sr_session_send(sdi, &packet);
2f937611 UH	335
2f937611 UH	336	/* Remove fds from polling. */
102f1239	337	usb_source_remove(sdi->session, devc->ctx);
2f937611 UH	338
	339	devc->num_transfers = 0;
	340	g_free(devc->transfers);
335122f0 BV	341
	342	if (devc->stl) {
	343	soft_trigger_logic_free(devc->stl);
	344	devc->stl = NULL;
	345	}
2f937611 UH	346	}
	347
	348	static void free_transfer(struct libusb_transfer *transfer)
	349	{
9615eeb5	350	struct sr_dev_inst *sdi;
2f937611 UH	351	struct dev_context *devc;
	352	unsigned int i;
	353
9615eeb5 BV	354	sdi = transfer->user_data;
9615eeb5 BV	355	devc = sdi->priv;
2f937611 UH	356
	357	g_free(transfer->buffer);
	358	transfer->buffer = NULL;
	359	libusb_free_transfer(transfer);
	360
	361	for (i = 0; i < devc->num_transfers; i++) {
	362	if (devc->transfers[i] == transfer) {
	363	devc->transfers[i] = NULL;
	364	break;
	365	}
	366	}
	367
	368	devc->submitted_transfers--;
	369	if (devc->submitted_transfers == 0)
102f1239	370	finish_acquisition(sdi);
2f937611 UH	371	}
	372
	373	static void resubmit_transfer(struct libusb_transfer *transfer)
	374	{
	375	int ret;
	376
	377	if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
	378	return;
	379
9615eeb5	380	sr_err("%s: %s", __func__, libusb_error_name(ret));
2f937611	381	free_transfer(transfer);
2f937611	382
9615eeb5 BV	383	}
9615eeb5 BV	384
2f937611 UH	385	SR_PRIV void fx2lafw_receive_transfer(struct libusb_transfer *transfer)
2f937611 UH	386	{
9615eeb5 BV	387	struct sr_dev_inst *sdi;
9615eeb5 BV	388	struct dev_context *devc;
2f937611 UH	389	gboolean packet_has_error = FALSE;
	390	struct sr_datafeed_packet packet;
	391	struct sr_datafeed_logic logic;
9615eeb5 BV	392	unsigned int num_samples;
9615eeb5 BV	393	int trigger_offset, cur_sample_count, unitsize;
2f937611	394
9615eeb5 BV	395	sdi = transfer->user_data;
9615eeb5 BV	396	devc = sdi->priv;
2f937611 UH	397
	398	/*
	399	* If acquisition has already ended, just free any queued up
	400	* transfer that come in.
	401	*/
b0ccd64d	402	if (devc->acq_aborted) {
2f937611 UH	403	free_transfer(transfer);
	404	return;
	405	}
	406
	407	sr_info("receive_transfer(): status %d received %d bytes.",
	408	transfer->status, transfer->actual_length);
	409
	410	/* Save incoming transfer before reusing the transfer struct. */
9615eeb5 BV	411	unitsize = devc->sample_wide ? 2 : 1;
9615eeb5 BV	412	cur_sample_count = transfer->actual_length / unitsize;
2f937611 UH	413
	414	switch (transfer->status) {
	415	case LIBUSB_TRANSFER_NO_DEVICE:
	416	fx2lafw_abort_acquisition(devc);
	417	free_transfer(transfer);
	418	return;
	419	case LIBUSB_TRANSFER_COMPLETED:
	420	case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
	421	break;
	422	default:
	423	packet_has_error = TRUE;
	424	break;
	425	}
	426
	427	if (transfer->actual_length == 0 \|\| packet_has_error) {
	428	devc->empty_transfer_count++;
	429	if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
	430	/*
	431	* The FX2 gave up. End the acquisition, the frontend
	432	* will work out that the samplecount is short.
	433	*/
	434	fx2lafw_abort_acquisition(devc);
	435	free_transfer(transfer);
	436	} else {
	437	resubmit_transfer(transfer);
	438	}
	439	return;
	440	} else {
	441	devc->empty_transfer_count = 0;
	442	}
	443
9615eeb5	444	if (devc->trigger_fired) {
2f663c82	445	if (!devc->limit_samples \|\| devc->sent_samples < devc->limit_samples) {
9615eeb5 BV	446	/* Send the incoming transfer to the session bus. */
	447	packet.type = SR_DF_LOGIC;
	448	packet.payload = &logic;
2f663c82	449	if (devc->limit_samples && devc->sent_samples + cur_sample_count > devc->limit_samples)
9615eeb5 BV	450	num_samples = devc->limit_samples - devc->sent_samples;
	451	else
	452	num_samples = cur_sample_count;
	453	logic.length = num_samples * unitsize;
	454	logic.unitsize = unitsize;
	455	logic.data = transfer->buffer;
	456	sr_session_send(devc->cb_data, &packet);
649e9e16	457	devc->sent_samples += num_samples;
9615eeb5 BV	458	}
9615eeb5 BV	459	} else {
335122f0	460	trigger_offset = soft_trigger_logic_check(devc->stl,
fe5a7355	461	transfer->buffer, transfer->actual_length, NULL);
9615eeb5 BV	462	if (trigger_offset > -1) {
	463	packet.type = SR_DF_LOGIC;
	464	packet.payload = &logic;
	465	num_samples = cur_sample_count - trigger_offset;
	466	if (devc->limit_samples &&
	467	num_samples > devc->limit_samples - devc->sent_samples)
	468	num_samples = devc->limit_samples - devc->sent_samples;
	469	logic.length = num_samples * unitsize;
	470	logic.unitsize = unitsize;
	471	logic.data = transfer->buffer + trigger_offset * unitsize;
	472	sr_session_send(devc->cb_data, &packet);
	473	devc->sent_samples += num_samples;
	474
	475	devc->trigger_fired = TRUE;
2f937611	476	}
06b5d7f7 BV	477	}
	478
	479	if (devc->limit_samples && devc->sent_samples >= devc->limit_samples) {
	480	fx2lafw_abort_acquisition(devc);
	481	free_transfer(transfer);
9615eeb5 BV	482	} else
9615eeb5 BV	483	resubmit_transfer(transfer);
2f937611 UH	484	}
	485
	486	static unsigned int to_bytes_per_ms(unsigned int samplerate)
	487	{
	488	return samplerate / 1000;
	489	}
	490
	491	SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc)
	492	{
	493	size_t s;
	494
	495	/*
	496	* The buffer should be large enough to hold 10ms of data and
	497	* a multiple of 512.
	498	*/
	499	s = 10 * to_bytes_per_ms(devc->cur_samplerate);
	500	return (s + 511) & ~511;
	501	}
	502
	503	SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc)
	504	{
	505	unsigned int n;
	506
	507	/* Total buffer size should be able to hold about 500ms of data. */
	508	n = (500 * to_bytes_per_ms(devc->cur_samplerate) /
	509	fx2lafw_get_buffer_size(devc));
	510
	511	if (n > NUM_SIMUL_TRANSFERS)
	512	return NUM_SIMUL_TRANSFERS;
	513
	514	return n;
	515	}
	516
	517	SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc)
	518	{
	519	size_t total_size;
	520	unsigned int timeout;
	521
	522	total_size = fx2lafw_get_buffer_size(devc) *
	523	fx2lafw_get_number_of_transfers(devc);
	524	timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
	525	return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
	526	}