[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 |= (devc->profile->dev_caps & DEV_CAPS_AX_ANALOG) ? 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;
}

/**
 * Check the USB configuration to determine if this is an fx2lafw device.
 *
 * @return TRUE if the device's configuration profile matches fx2lafw
 *         configuration, FALSE otherwise.
 */
SR_PRIV gboolean match_manuf_prod(libusb_device *dev, const char *manufacturer,
		const char *product)
{
	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. */
		libusb_get_device_descriptor(dev, &des);

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

		if (libusb_get_string_descriptor_ascii(hdl,
				des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
			break;
		if (strcmp((const char *)strdesc, manufacturer))
			break;

		if (libusb_get_string_descriptor_ascii(hdl,
				des.iProduct, strdesc, sizeof(strdesc)) < 0)
			break;
		if (strcmp((const char *)strdesc, product))
			break;

		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->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->trigger_en = 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 dev_context *devc;

	devc = sdi->priv;

	std_session_send_df_end(sdi, LOG_PREFIX);

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

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

	/* Free the deinterlace buffers if we had them */
	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 dev_context *devc,
	uint8_t *data, size_t length, size_t sample_width)
{
	size_t i;
	sample_width = sample_width;
	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(devc->cb_data, &logic_packet);

	const struct sr_datafeed_analog_old analog = {
		.channels = devc->enabled_analog_channels,
		.num_samples = length,
		.mq = SR_MQ_VOLTAGE,
		.unit = SR_UNIT_VOLT,
		.mqflags = 0 /*SR_MQFLAG_DC*/,
		.data = devc->analog_buffer
	};

	const struct sr_datafeed_packet analog_packet = {
		.type = SR_DF_ANALOG_OLD,
		.payload = &analog
	};
	sr_session_send(devc->cb_data, &analog_packet);

}

SR_PRIV void la_send_data_proc(struct dev_context *devc,
	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(devc->cb_data, &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;
	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_en)
		devc->trigger_fired = TRUE;
	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;

			devc->send_data_proc(devc,
						(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(devc,
						(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;

	/* 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 BL	128	/* Enable CTL2 clock. */
7fb90f94 BL	129	cmd.flags \|= (devc->profile->dev_caps & DEV_CAPS_AX_ANALOG) ? 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
	144	/**
	145	* Check the USB configuration to determine if this is an fx2lafw device.
	146	*
a7d7f93c	147	* @return TRUE if the device's configuration profile matches fx2lafw
6fcf3f0a	148	* configuration, FALSE otherwise.
2f937611	149	*/
a7d7f93c BV	150	SR_PRIV gboolean match_manuf_prod(libusb_device dev, const char manufacturer,
a7d7f93c BV	151	const char *product)
2f937611 UH	152	{
	153	struct libusb_device_descriptor des;
	154	struct libusb_device_handle *hdl;
	155	gboolean ret;
	156	unsigned char strdesc[64];
	157
	158	hdl = NULL;
	159	ret = FALSE;
	160	while (!ret) {
	161	/* Assume the FW has not been loaded, unless proven wrong. */
2a8f2d41	162	libusb_get_device_descriptor(dev, &des);
2f937611 UH	163
	164	if (libusb_open(dev, &hdl) != 0)
	165	break;
	166
	167	if (libusb_get_string_descriptor_ascii(hdl,
a7d7f93c	168	des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
2f937611	169	break;
bc497772	170	if (strcmp((const char *)strdesc, manufacturer))
2f937611 UH	171	break;
	172
	173	if (libusb_get_string_descriptor_ascii(hdl,
	174	des.iProduct, strdesc, sizeof(strdesc)) < 0)
	175	break;
bc497772	176	if (strcmp((const char *)strdesc, product))
2f937611 UH	177	break;
2f937611 UH	178
2f937611 UH	179	ret = TRUE;
	180	}
	181	if (hdl)
	182	libusb_close(hdl);
	183
	184	return ret;
	185	}
	186
	187	SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst sdi, struct sr_dev_driver di)
	188	{
	189	libusb_device **devlist;
	190	struct sr_usb_dev_inst *usb;
	191	struct libusb_device_descriptor des;
	192	struct dev_context *devc;
	193	struct drv_context *drvc;
	194	struct version_info vi;
5e2c86eb	195	int ret, i, device_count;
2f937611	196	uint8_t revid;
5e2c86eb	197	char connection_id[64];
2f937611	198
41812aca	199	drvc = di->context;
2f937611 UH	200	devc = sdi->priv;
	201	usb = sdi->conn;
	202
	203	if (sdi->status == SR_ST_ACTIVE)
	204	/* Device is already in use. */
	205	return SR_ERR;
	206
2f937611 UH	207	device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
	208	if (device_count < 0) {
	209	sr_err("Failed to get device list: %s.",
	210	libusb_error_name(device_count));
	211	return SR_ERR;
	212	}
	213
	214	for (i = 0; i < device_count; i++) {
2a8f2d41	215	libusb_get_device_descriptor(devlist[i], &des);
2f937611 UH	216
	217	if (des.idVendor != devc->profile->vid
	218	\|\| des.idProduct != devc->profile->pid)
	219	continue;
	220
5e2c86eb SA	221	if ((sdi->status == SR_ST_INITIALIZING) \|\|
5e2c86eb SA	222	(sdi->status == SR_ST_INACTIVE)) {
2f937611	223	/*
5e2c86eb	224	* Check device by its physical USB bus/port address.
2f937611	225	*/
5e2c86eb SA	226	usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
5e2c86eb SA	227	if (strcmp(sdi->connection_id, connection_id))
2f937611 UH	228	/* This is not the one. */
	229	continue;
	230	}
	231
	232	if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
	233	if (usb->address == 0xff)
	234	/*
	235	* First time we touch this device after FW
	236	* upload, so we don't know the address yet.
	237	*/
	238	usb->address = libusb_get_device_address(devlist[i]);
	239	} else {
	240	sr_err("Failed to open device: %s.",
	241	libusb_error_name(ret));
	242	break;
	243	}
	244
dc2903bb	245	if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
c11a1e61 UH	246	if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
c11a1e61 UH	247	if ((ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE)) < 0) {
dc2903bb UH	248	sr_err("Failed to detach kernel driver: %s.",
	249	libusb_error_name(ret));
	250	return SR_ERR;
	251	}
	252	}
	253	}
	254
2f937611 UH	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;
7bfcb25c	307	devc->capture_ratio = 0;
87b545fb	308	devc->sample_wide = FALSE;
3db03efa	309	devc->trigger_en = FALSE;
335122f0	310	devc->stl = NULL;
2f937611 UH	311
	312	return devc;
	313	}
	314
	315	SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc)
	316	{
	317	int i;
	318
b0ccd64d	319	devc->acq_aborted = TRUE;
2f937611 UH	320
	321	for (i = devc->num_transfers - 1; i >= 0; i--) {
	322	if (devc->transfers[i])
	323	libusb_cancel_transfer(devc->transfers[i]);
	324	}
	325	}
	326
102f1239	327	static void finish_acquisition(struct sr_dev_inst *sdi)
2f937611	328	{
102f1239 BV	329	struct dev_context *devc;
	330
	331	devc = sdi->priv;
2f937611	332
3be42bc2	333	std_session_send_df_end(sdi, LOG_PREFIX);
2f937611 UH	334
2f937611 UH	335	/* Remove fds from polling. */
102f1239	336	usb_source_remove(sdi->session, devc->ctx);
2f937611 UH	337
	338	devc->num_transfers = 0;
	339	g_free(devc->transfers);
335122f0	340
7e5ccff2 JH	341	/* Free the deinterlace buffers if we had them */
	342	g_free(devc->logic_buffer);
	343	g_free(devc->analog_buffer);
	344
335122f0 BV	345	if (devc->stl) {
	346	soft_trigger_logic_free(devc->stl);
	347	devc->stl = NULL;
	348	}
2f937611 UH	349	}
	350
	351	static void free_transfer(struct libusb_transfer *transfer)
	352	{
9615eeb5	353	struct sr_dev_inst *sdi;
2f937611 UH	354	struct dev_context *devc;
	355	unsigned int i;
	356
9615eeb5 BV	357	sdi = transfer->user_data;
9615eeb5 BV	358	devc = sdi->priv;
2f937611 UH	359
	360	g_free(transfer->buffer);
	361	transfer->buffer = NULL;
	362	libusb_free_transfer(transfer);
	363
	364	for (i = 0; i < devc->num_transfers; i++) {
	365	if (devc->transfers[i] == transfer) {
	366	devc->transfers[i] = NULL;
	367	break;
	368	}
	369	}
	370
	371	devc->submitted_transfers--;
	372	if (devc->submitted_transfers == 0)
102f1239	373	finish_acquisition(sdi);
2f937611 UH	374	}
	375
	376	static void resubmit_transfer(struct libusb_transfer *transfer)
	377	{
	378	int ret;
	379
	380	if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
	381	return;
	382
9615eeb5	383	sr_err("%s: %s", __func__, libusb_error_name(ret));
2f937611	384	free_transfer(transfer);
2f937611	385
9615eeb5 BV	386	}
9615eeb5 BV	387
7e5ccff2 JH	388	SR_PRIV void mso_send_data_proc(struct dev_context *devc,
	389	uint8_t *data, size_t length, size_t sample_width)
	390	{
	391	size_t i;
	392	sample_width = sample_width;
	393	length /= 2;
	394
7e5ccff2 JH	395	/* Send the logic */
	396	for(i = 0; i < length; i++) {
	397	devc->logic_buffer[i] = data[i * 2];
7fb90f94 BL	398	/* Rescale to -10V - +10V from 0-255. */
7fb90f94 BL	399	devc->analog_buffer[i] = data[i * 2 + 1] - 128.0f / 12.8f;
7e5ccff2 JH	400	};
	401
	402	const struct sr_datafeed_logic logic = {
	403	.length = length,
	404	.unitsize = 1,
	405	.data = devc->logic_buffer
	406	};
	407
	408	const struct sr_datafeed_packet logic_packet = {
	409	.type = SR_DF_LOGIC,
	410	.payload = &logic
	411	};
	412	sr_session_send(devc->cb_data, &logic_packet);
	413
	414	const struct sr_datafeed_analog_old analog = {
7fb90f94	415	.channels = devc->enabled_analog_channels,
7e5ccff2 JH	416	.num_samples = length,
	417	.mq = SR_MQ_VOLTAGE,
	418	.unit = SR_UNIT_VOLT,
7fb90f94	419	.mqflags = 0 /SR_MQFLAG_DC/,
7e5ccff2 JH	420	.data = devc->analog_buffer
	421	};
	422
	423	const struct sr_datafeed_packet analog_packet = {
	424	.type = SR_DF_ANALOG_OLD,
	425	.payload = &analog
	426	};
7e5ccff2 JH	427	sr_session_send(devc->cb_data, &analog_packet);
	428
	429	}
	430
	431	SR_PRIV void la_send_data_proc(struct dev_context *devc,
7b5d1c64 JH	432	uint8_t *data, size_t length, size_t sample_width)
	433	{
	434	const struct sr_datafeed_logic logic = {
	435	.length = length,
	436	.unitsize = sample_width,
	437	.data = data
	438	};
	439
	440	const struct sr_datafeed_packet packet = {
	441	.type = SR_DF_LOGIC,
	442	.payload = &logic
	443	};
	444
7e5ccff2	445	sr_session_send(devc->cb_data, &packet);
7b5d1c64 JH	446	}
7b5d1c64 JH	447
55462b8b	448	SR_PRIV void LIBUSB_CALL fx2lafw_receive_transfer(struct libusb_transfer *transfer)
2f937611	449	{
9615eeb5 BV	450	struct sr_dev_inst *sdi;
9615eeb5 BV	451	struct dev_context *devc;
2f937611	452	gboolean packet_has_error = FALSE;
9615eeb5 BV	453	unsigned int num_samples;
9615eeb5 BV	454	int trigger_offset, cur_sample_count, unitsize;
7bfcb25c	455	int pre_trigger_samples;
2f937611	456
9615eeb5 BV	457	sdi = transfer->user_data;
9615eeb5 BV	458	devc = sdi->priv;
2f937611 UH	459
	460	/*
	461	* If acquisition has already ended, just free any queued up
	462	* transfer that come in.
	463	*/
b0ccd64d	464	if (devc->acq_aborted) {
2f937611 UH	465	free_transfer(transfer);
	466	return;
	467	}
	468
0f262763 UH	469	sr_dbg("receive_transfer(): status %s received %d bytes.",
0f262763 UH	470	libusb_error_name(transfer->status), transfer->actual_length);
2f937611 UH	471
2f937611 UH	472	/* Save incoming transfer before reusing the transfer struct. */
9615eeb5 BV	473	unitsize = devc->sample_wide ? 2 : 1;
9615eeb5 BV	474	cur_sample_count = transfer->actual_length / unitsize;
2f937611 UH	475
	476	switch (transfer->status) {
	477	case LIBUSB_TRANSFER_NO_DEVICE:
	478	fx2lafw_abort_acquisition(devc);
	479	free_transfer(transfer);
	480	return;
	481	case LIBUSB_TRANSFER_COMPLETED:
	482	case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
	483	break;
	484	default:
	485	packet_has_error = TRUE;
	486	break;
	487	}
	488
	489	if (transfer->actual_length == 0 \|\| packet_has_error) {
	490	devc->empty_transfer_count++;
	491	if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
	492	/*
	493	* The FX2 gave up. End the acquisition, the frontend
	494	* will work out that the samplecount is short.
	495	*/
	496	fx2lafw_abort_acquisition(devc);
	497	free_transfer(transfer);
	498	} else {
	499	resubmit_transfer(transfer);
	500	}
	501	return;
	502	} else {
	503	devc->empty_transfer_count = 0;
	504	}
3db03efa DA	505	if (devc->trigger_en)
3db03efa DA	506	devc->trigger_fired = TRUE;
9615eeb5	507	if (devc->trigger_fired) {
2f663c82	508	if (!devc->limit_samples \|\| devc->sent_samples < devc->limit_samples) {
9615eeb5	509	/* Send the incoming transfer to the session bus. */
2f663c82	510	if (devc->limit_samples && devc->sent_samples + cur_sample_count > devc->limit_samples)
9615eeb5 BV	511	num_samples = devc->limit_samples - devc->sent_samples;
	512	else
	513	num_samples = cur_sample_count;
7b5d1c64	514
7e5ccff2	515	devc->send_data_proc(devc,
7b5d1c64 JH	516	(uint8_t*)transfer->buffer,
	517	num_samples * unitsize,
	518	unitsize);
649e9e16	519	devc->sent_samples += num_samples;
9615eeb5 BV	520	}
9615eeb5 BV	521	} else {
335122f0	522	trigger_offset = soft_trigger_logic_check(devc->stl,
7bfcb25c	523	transfer->buffer, transfer->actual_length, &pre_trigger_samples);
9615eeb5	524	if (trigger_offset > -1) {
7bfcb25c	525	devc->sent_samples += pre_trigger_samples;
9615eeb5 BV	526	num_samples = cur_sample_count - trigger_offset;
	527	if (devc->limit_samples &&
	528	num_samples > devc->limit_samples - devc->sent_samples)
	529	num_samples = devc->limit_samples - devc->sent_samples;
7b5d1c64	530
7e5ccff2	531	devc->send_data_proc(devc,
7b5d1c64 JH	532	(uint8_t)transfer->buffer + trigger_offset unitsize,
	533	num_samples * unitsize,
	534	unitsize);
9615eeb5 BV	535	devc->sent_samples += num_samples;
	536
	537	devc->trigger_fired = TRUE;
2f937611	538	}
06b5d7f7 BV	539	}
	540
	541	if (devc->limit_samples && devc->sent_samples >= devc->limit_samples) {
	542	fx2lafw_abort_acquisition(devc);
	543	free_transfer(transfer);
9615eeb5 BV	544	} else
9615eeb5 BV	545	resubmit_transfer(transfer);
2f937611 UH	546	}
	547
	548	static unsigned int to_bytes_per_ms(unsigned int samplerate)
	549	{
	550	return samplerate / 1000;
	551	}
	552
	553	SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc)
	554	{
	555	size_t s;
	556
	557	/*
	558	* The buffer should be large enough to hold 10ms of data and
	559	* a multiple of 512.
	560	*/
	561	s = 10 * to_bytes_per_ms(devc->cur_samplerate);
	562	return (s + 511) & ~511;
	563	}
	564
	565	SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc)
	566	{
	567	unsigned int n;
	568
	569	/* Total buffer size should be able to hold about 500ms of data. */
	570	n = (500 * to_bytes_per_ms(devc->cur_samplerate) /
	571	fx2lafw_get_buffer_size(devc));
	572
	573	if (n > NUM_SIMUL_TRANSFERS)
	574	return NUM_SIMUL_TRANSFERS;
	575
	576	return n;
	577	}
	578
	579	SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc)
	580	{
	581	size_t total_size;
	582	unsigned int timeout;
	583
	584	total_size = fx2lafw_get_buffer_size(devc) *
	585	fx2lafw_get_number_of_transfers(devc);
	586	timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
	587	return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
	588	}