[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 <config.h>
#include <glib.h>
#include <glib/gstdio.h>
#include "protocol.h"
#include "dslogic.h"

#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)

#define USB_TIMEOUT 100

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), USB_TIMEOUT);

	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 dev_context *devc = sdi->priv;
	struct sr_usb_dev_inst *usb = sdi->conn;
	libusb_device_handle *devhdl = usb->devhdl;
	int cmd, ret;

	cmd = devc->dslogic ? DS_CMD_GET_REVID_VERSION : CMD_GET_REVID_VERSION;
	ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
		LIBUSB_ENDPOINT_IN, cmd, 0x0000, 0x0000, revid, 1, USB_TIMEOUT);

	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_dbg("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;
	/* Enable CTL2 clock. */
	cmd.flags |= (g_slist_length(devc->enabled_analog_channels) > 0) ? CMD_START_FLAGS_CLK_CTL2 : 0;

	/* 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), USB_TIMEOUT);
	if (ret < 0) {
		sr_err("Unable to send start command: %s.",
		       libusb_error_name(ret));
		return SR_ERR;
	}

	return SR_OK;
}

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->context;
	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++) {
		libusb_get_device_descriptor(devlist[i], &des);

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

		if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
			if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
				if ((ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE)) < 0) {
					sr_err("Failed to detach kernel driver: %s.",
						libusb_error_name(ret));
					return SR_ERR;
				}
			}
		}

		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->capture_ratio = 0;
	devc->sample_wide = FALSE;
	devc->dslogic_continuous_mode = FALSE;
	devc->dslogic_clock_edge = DS_EDGE_RISING;
	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 dev_context *devc;

	devc = sdi->priv;

	std_session_send_df_end(sdi);

	usb_source_remove(sdi->session, devc->ctx);

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

	/* Free the deinterlace buffers if we had them. */
	if (g_slist_length(devc->enabled_analog_channels) > 0) {
		g_free(devc->logic_buffer);
		g_free(devc->analog_buffer);
	}

	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 mso_send_data_proc(struct sr_dev_inst *sdi,
	uint8_t *data, size_t length, size_t sample_width)
{
	size_t i;
	struct dev_context *devc;
	struct sr_datafeed_analog analog;
	struct sr_analog_encoding encoding;
	struct sr_analog_meaning meaning;
	struct sr_analog_spec spec;

	(void)sample_width;

	devc = sdi->priv;

	length /= 2;

	/* Send the logic */
	for (i = 0; i < length; i++) {
		devc->logic_buffer[i] = data[i * 2];
		/* Rescale to -10V - +10V from 0-255. */
		devc->analog_buffer[i] = (data[i * 2 + 1] - 128.0f) / 12.8f;
	};

	const struct sr_datafeed_logic logic = {
		.length = length,
		.unitsize = 1,
		.data = devc->logic_buffer
	};

	const struct sr_datafeed_packet logic_packet = {
		.type = SR_DF_LOGIC,
		.payload = &logic
	};

	sr_session_send(sdi, &logic_packet);

	sr_analog_init(&analog, &encoding, &meaning, &spec, 2);
	analog.meaning->channels = devc->enabled_analog_channels;
	analog.meaning->mq = SR_MQ_VOLTAGE;
	analog.meaning->unit = SR_UNIT_VOLT;
	analog.meaning->mqflags = 0 /* SR_MQFLAG_DC */;
	analog.num_samples = length;
	analog.data = devc->analog_buffer;

	const struct sr_datafeed_packet analog_packet = {
		.type = SR_DF_ANALOG,
		.payload = &analog
	};

	sr_session_send(sdi, &analog_packet);
}

SR_PRIV void la_send_data_proc(struct sr_dev_inst *sdi,
	uint8_t *data, size_t length, size_t sample_width)
{
	const struct sr_datafeed_logic logic = {
		.length = length,
		.unitsize = sample_width,
		.data = data
	};

	const struct sr_datafeed_packet packet = {
		.type = SR_DF_LOGIC,
		.payload = &logic
	};

	sr_session_send(sdi, &packet);
}

SR_PRIV void LIBUSB_CALL 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;
	unsigned int num_samples;
	int trigger_offset, cur_sample_count, unitsize;
	int pre_trigger_samples;

	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_dbg("receive_transfer(): status %s received %d bytes.",
		libusb_error_name(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. */
			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;

			if (devc->dslogic && devc->trigger_pos > devc->sent_samples
				&& devc->trigger_pos <= devc->sent_samples + num_samples) {
					/* DSLogic trigger in this block. Send trigger position. */
					trigger_offset = devc->trigger_pos - devc->sent_samples;
					/* Pre-trigger samples. */
					devc->send_data_proc(sdi, (uint8_t *)transfer->buffer,
						trigger_offset * unitsize, unitsize);
					devc->sent_samples += trigger_offset;
					/* Trigger position. */
					devc->trigger_pos = 0;
					packet.type = SR_DF_TRIGGER;
					packet.payload = NULL;
					sr_session_send(sdi, &packet);
					/* Post trigger samples. */
					num_samples -= trigger_offset;
					devc->send_data_proc(sdi, (uint8_t *)transfer->buffer
							+ trigger_offset * unitsize, num_samples * unitsize, unitsize);
					devc->sent_samples += num_samples;
			} else {
				devc->send_data_proc(sdi, (uint8_t *)transfer->buffer,
					num_samples * unitsize, unitsize);
				devc->sent_samples += num_samples;
			}
		}
	} else {
		trigger_offset = soft_trigger_logic_check(devc->stl,
			transfer->buffer, transfer->actual_length, &pre_trigger_samples);
		if (trigger_offset > -1) {
			devc->sent_samples += pre_trigger_samples;
			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;

			devc->send_data_proc(sdi, (uint8_t *)transfer->buffer
					+ trigger_offset * unitsize,
					num_samples * unitsize, unitsize);
			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;

	if (devc->dslogic)
		return dslogic_get_number_of_transfers(devc);

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