[libsigrok.git] / src / hardware / ikalogic-scanaplus / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
 *
 * 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 2 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include "protocol.h"

#define USB_VENDOR_ID			0x0403
#define USB_DEVICE_ID			0x6014
#define USB_VENDOR_NAME			"IKALOGIC"
#define USB_MODEL_NAME			"ScanaPLUS"
#define USB_IPRODUCT			"SCANAPLUS"

#define SAMPLE_BUF_SIZE			(8 * 1024 * 1024)

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

/* Channels are numbered 1-9. */
static const char *channel_names[] = {
	"1", "2", "3", "4", "5", "6", "7", "8", "9",
	NULL,
};

/* Note: The IKALOGIC ScanaPLUS always samples at 100MHz. */
static uint64_t samplerates[1] = { SR_MHZ(100) };

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

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

static void clear_helper(void *priv)
{
	struct dev_context *devc;

	devc = priv;

	ftdi_free(devc->ftdic);
	g_free(devc->compressed_buf);
	g_free(devc->sample_buf);
	g_free(devc);
}

static int dev_clear(void)
{
	return std_dev_clear(di, clear_helper);
}

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

static GSList *scan(GSList *options)
{
	struct sr_dev_inst *sdi;
	struct sr_channel *ch;
	struct drv_context *drvc;
	struct dev_context *devc;
	GSList *devices;
	unsigned int i;
	int ret;

	(void)options;

	drvc = di->priv;

	devices = NULL;

	/* Allocate memory for our private device context. */
	devc = g_malloc0(sizeof(struct dev_context));

	/* Allocate memory for the incoming compressed samples. */
	if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
		sr_err("compressed_buf malloc failed.");
		goto err_free_devc;
	}

	/* Allocate memory for the uncompressed samples. */
	if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
		sr_err("sample_buf malloc failed.");
		goto err_free_compressed_buf;
	}

	/* Allocate memory for the FTDI context (ftdic) and initialize it. */
	if (!(devc->ftdic = ftdi_new())) {
		sr_err("Failed to initialize libftdi.");
		goto err_free_sample_buf;
	}

	/* Check for the device and temporarily open it. */
	ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
				 USB_IPRODUCT, NULL);
	if (ret < 0) {
		/* Log errors, except for -3 ("device not found"). */
		if (ret != -3)
			sr_err("Failed to open device (%d): %s", ret,
			       ftdi_get_error_string(devc->ftdic));
		goto err_free_ftdic;
	}

	/* Register the device with libsigrok. */
	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INITIALIZING;
	sdi->vendor = g_strdup(USB_VENDOR_NAME);
	sdi->model = g_strdup(USB_MODEL_NAME);
	sdi->driver = di;
	sdi->priv = devc;

	for (i = 0; channel_names[i]; i++) {
		ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
				    channel_names[i]);
		sdi->channels = g_slist_append(sdi->channels, ch);
	}

	devices = g_slist_append(devices, sdi);
	drvc->instances = g_slist_append(drvc->instances, sdi);

	/* Close device. We'll reopen it again when we need it. */
	scanaplus_close(devc);

	return devices;

	scanaplus_close(devc);
err_free_ftdic:
	ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
err_free_sample_buf:
	g_free(devc->sample_buf);
err_free_compressed_buf:
	g_free(devc->compressed_buf);
err_free_devc:
	g_free(devc);

	return NULL;
}

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

static int dev_open(struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	int ret;

	devc = sdi->priv;

	/* Select interface A, otherwise communication will fail. */
	ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
	if (ret < 0) {
		sr_err("Failed to set FTDI interface A (%d): %s", ret,
		       ftdi_get_error_string(devc->ftdic));
		return SR_ERR;
	}
	sr_dbg("FTDI chip interface A set successfully.");

	/* Open the device. */
	ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
				 USB_IPRODUCT, NULL);
	if (ret < 0) {
		sr_err("Failed to open device (%d): %s", ret,
		       ftdi_get_error_string(devc->ftdic));
		return SR_ERR;
	}
	sr_dbg("FTDI device opened successfully.");

	/* Purge RX/TX buffers in the FTDI chip. */
	if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
		sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}
	sr_dbg("FTDI chip buffers purged successfully.");

	/* Reset the FTDI bitmode. */
	ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
	if (ret < 0) {
		sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}
	sr_dbg("FTDI chip bitmode reset successfully.");

	/* Set FTDI bitmode to "sync FIFO". */
	ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
	if (ret < 0) {
		sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}
	sr_dbg("FTDI chip sync FIFO mode entered successfully.");

	/* Set the FTDI latency timer to 2. */
	ret = ftdi_set_latency_timer(devc->ftdic, 2);
	if (ret < 0) {
		sr_err("Failed to set FTDI latency timer (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}
	sr_dbg("FTDI chip latency timer set successfully.");

	/* Set the FTDI read data chunk size to 64kB. */
	ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
	if (ret < 0) {
		sr_err("Failed to set FTDI read data chunk size (%d): %s.",
		       ret, ftdi_get_error_string(devc->ftdic));
		goto err_dev_open_close_ftdic;
	}
	sr_dbg("FTDI chip read data chunk size set successfully.");

	/* Get the ScanaPLUS device ID from the FTDI EEPROM. */
	if ((ret = scanaplus_get_device_id(devc)) < 0) {
		sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
		goto err_dev_open_close_ftdic;
	}
	sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
	       devc->devid[0], devc->devid[1], devc->devid[2]);

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;

err_dev_open_close_ftdic:
	scanaplus_close(devc);
	return SR_ERR;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	int ret;
	struct dev_context *devc;

	ret = SR_OK;
	devc = sdi->priv;

	if (sdi->status == SR_ST_ACTIVE) {
		sr_dbg("Status ACTIVE, closing device.");
		ret = scanaplus_close(devc);
	} else {
		sr_spew("Status not ACTIVE, nothing to do.");
	}

	sdi->status = SR_ST_INACTIVE;

	return ret;
}

static int cleanup(void)
{
	return dev_clear();
}

static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		/* The ScanaPLUS samplerate is 100MHz and can't be changed. */
		*data = g_variant_new_uint64(SR_MHZ(100));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	(void)cg;

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

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		if (g_variant_get_uint64(data) != SR_MHZ(100)) {
			sr_err("ScanaPLUS only supports samplerate = 100MHz.");
			return SR_ERR_ARG;
		}
		/* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
		break;
	case SR_CONF_LIMIT_MSEC:
		if (g_variant_get_uint64(data) == 0)
			return SR_ERR_ARG;
		devc->limit_msec = g_variant_get_uint64(data);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		if (g_variant_get_uint64(data) == 0)
			return SR_ERR_ARG;
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	GVariant *gvar;
	GVariantBuilder gvb;

	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	case SR_CONF_SAMPLERATE:
		g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
		gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
				samplerates, ARRAY_SIZE(samplerates),
				sizeof(uint64_t));
		g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
		*data = g_variant_builder_end(&gvb);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
{
	int ret;
	struct dev_context *devc;

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

	if (!(devc = sdi->priv))
		return SR_ERR_BUG;

	if (!devc->ftdic)
		return SR_ERR_BUG;

	/* TODO: Configure channels later (thresholds etc.). */

	devc->cb_data = cb_data;

	/* Properly reset internal variables before every new acquisition. */
	devc->compressed_bytes_ignored = 0;
	devc->samples_sent = 0;
	devc->bytes_received = 0;

	if ((ret = scanaplus_init(devc)) < 0)
		return ret;

	if ((ret = scanaplus_start_acquisition(devc)) < 0)
		return ret;

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

	/* Hook up a dummy handler to receive data from the device. */
	sr_session_source_add(sdi->session, -1, G_IO_IN, 0, scanaplus_receive_data, (void *)sdi);

	return SR_OK;
}

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

	(void)cb_data;

	sr_dbg("Stopping acquisition.");
	sr_session_source_remove(sdi->session, -1);

	/* Send end packet to the session bus. */
	sr_dbg("Sending SR_DF_END.");
	packet.type = SR_DF_END;
	sr_session_send(sdi, &packet);

	return SR_OK;
}

SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info = {
	.name = "ikalogic-scanaplus",
	.longname = "IKALOGIC ScanaPLUS",
	.api_version = 1,
	.init = init,
	.cleanup = cleanup,
	.scan = scan,
	.dev_list = dev_list,
	.dev_clear = dev_clear,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
fdf4a1f5 UH	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
	20
	21	#include "protocol.h"
	22
ab4bb6eb UH	23	#define USB_VENDOR_ID 0x0403
ab4bb6eb UH	24	#define USB_DEVICE_ID 0x6014
ce95428c	25	#define USB_VENDOR_NAME "IKALOGIC"
ab4bb6eb UH	26	#define USB_MODEL_NAME "ScanaPLUS"
	27	#define USB_IPRODUCT "SCANAPLUS"
	28
	29	#define SAMPLE_BUF_SIZE (8 * 1024 * 1024)
	30
f254bc4b	31	static const uint32_t devopts[] = {
ab4bb6eb	32	SR_CONF_LOGIC_ANALYZER,
5827f61b BV	33	SR_CONF_LIMIT_SAMPLES \| SR_CONF_SET,
	34	SR_CONF_LIMIT_MSEC \| SR_CONF_SET,
	35	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
ab4bb6eb UH	36	};
ab4bb6eb UH	37
ba7dd8bb UH	38	/* Channels are numbered 1-9. */
ba7dd8bb UH	39	static const char *channel_names[] = {
ab4bb6eb UH	40	"1", "2", "3", "4", "5", "6", "7", "8", "9",
	41	NULL,
	42	};
	43
ce95428c	44	/* Note: The IKALOGIC ScanaPLUS always samples at 100MHz. */
ab4bb6eb UH	45	static uint64_t samplerates[1] = { SR_MHZ(100) };
ab4bb6eb UH	46
fdf4a1f5 UH	47	SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
	48	static struct sr_dev_driver *di = &ikalogic_scanaplus_driver_info;
	49
ab4bb6eb UH	50	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data);
	51
	52	static void clear_helper(void *priv)
	53	{
	54	struct dev_context *devc;
	55
	56	devc = priv;
	57
	58	ftdi_free(devc->ftdic);
	59	g_free(devc->compressed_buf);
	60	g_free(devc->sample_buf);
f817f05a	61	g_free(devc);
ab4bb6eb UH	62	}
	63
	64	static int dev_clear(void)
	65	{
	66	return std_dev_clear(di, clear_helper);
	67	}
	68
fdf4a1f5 UH	69	static int init(struct sr_context *sr_ctx)
fdf4a1f5 UH	70	{
ab4bb6eb	71	return std_init(sr_ctx, di, LOG_PREFIX);
fdf4a1f5 UH	72	}
	73
	74	static GSList scan(GSList options)
	75	{
ab4bb6eb	76	struct sr_dev_inst *sdi;
ba7dd8bb	77	struct sr_channel *ch;
fdf4a1f5	78	struct drv_context *drvc;
ab4bb6eb	79	struct dev_context *devc;
fdf4a1f5	80	GSList *devices;
ab4bb6eb UH	81	unsigned int i;
ab4bb6eb UH	82	int ret;
fdf4a1f5 UH	83
	84	(void)options;
	85
fdf4a1f5	86	drvc = di->priv;
ab4bb6eb UH	87
	88	devices = NULL;
	89
	90	/* Allocate memory for our private device context. */
f57d8ffe	91	devc = g_malloc0(sizeof(struct dev_context));
ab4bb6eb UH	92
	93	/* Allocate memory for the incoming compressed samples. */
	94	if (!(devc->compressed_buf = g_try_malloc0(COMPRESSED_BUF_SIZE))) {
	95	sr_err("compressed_buf malloc failed.");
	96	goto err_free_devc;
	97	}
	98
	99	/* Allocate memory for the uncompressed samples. */
	100	if (!(devc->sample_buf = g_try_malloc0(SAMPLE_BUF_SIZE))) {
	101	sr_err("sample_buf malloc failed.");
	102	goto err_free_compressed_buf;
	103	}
	104
	105	/* Allocate memory for the FTDI context (ftdic) and initialize it. */
	106	if (!(devc->ftdic = ftdi_new())) {
	107	sr_err("Failed to initialize libftdi.");
	108	goto err_free_sample_buf;
	109	}
	110
	111	/* Check for the device and temporarily open it. */
	112	ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
	113	USB_IPRODUCT, NULL);
	114	if (ret < 0) {
	115	/* Log errors, except for -3 ("device not found"). */
	116	if (ret != -3)
	117	sr_err("Failed to open device (%d): %s", ret,
	118	ftdi_get_error_string(devc->ftdic));
	119	goto err_free_ftdic;
	120	}
	121
	122	/* Register the device with libsigrok. */
aac29cc1	123	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	124	sdi->status = SR_ST_INITIALIZING;
	125	sdi->vendor = g_strdup(USB_VENDOR_NAME);
	126	sdi->model = g_strdup(USB_MODEL_NAME);
ab4bb6eb UH	127	sdi->driver = di;
	128	sdi->priv = devc;
	129
ba7dd8bb	130	for (i = 0; channel_names[i]; i++) {
c368e6f3 UH	131	ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
c368e6f3 UH	132	channel_names[i]);
ba7dd8bb	133	sdi->channels = g_slist_append(sdi->channels, ch);
ab4bb6eb UH	134	}
	135
	136	devices = g_slist_append(devices, sdi);
	137	drvc->instances = g_slist_append(drvc->instances, sdi);
	138
	139	/* Close device. We'll reopen it again when we need it. */
	140	scanaplus_close(devc);
fdf4a1f5 UH	141
fdf4a1f5 UH	142	return devices;
ab4bb6eb	143
ab4bb6eb UH	144	scanaplus_close(devc);
	145	err_free_ftdic:
	146	ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
	147	err_free_sample_buf:
	148	g_free(devc->sample_buf);
	149	err_free_compressed_buf:
	150	g_free(devc->compressed_buf);
	151	err_free_devc:
	152	g_free(devc);
ab4bb6eb UH	153
ab4bb6eb UH	154	return NULL;
fdf4a1f5 UH	155	}
	156
	157	static GSList *dev_list(void)
	158	{
	159	return ((struct drv_context *)(di->priv))->instances;
	160	}
	161
fdf4a1f5 UH	162	static int dev_open(struct sr_dev_inst *sdi)
fdf4a1f5 UH	163	{
ab4bb6eb UH	164	struct dev_context *devc;
	165	int ret;
	166
	167	devc = sdi->priv;
	168
	169	/* Select interface A, otherwise communication will fail. */
	170	ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
	171	if (ret < 0) {
	172	sr_err("Failed to set FTDI interface A (%d): %s", ret,
	173	ftdi_get_error_string(devc->ftdic));
	174	return SR_ERR;
	175	}
	176	sr_dbg("FTDI chip interface A set successfully.");
	177
	178	/* Open the device. */
	179	ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
	180	USB_IPRODUCT, NULL);
	181	if (ret < 0) {
	182	sr_err("Failed to open device (%d): %s", ret,
	183	ftdi_get_error_string(devc->ftdic));
	184	return SR_ERR;
	185	}
	186	sr_dbg("FTDI device opened successfully.");
	187
	188	/* Purge RX/TX buffers in the FTDI chip. */
	189	if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
	190	sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
	191	ret, ftdi_get_error_string(devc->ftdic));
	192	goto err_dev_open_close_ftdic;
	193	}
	194	sr_dbg("FTDI chip buffers purged successfully.");
	195
	196	/* Reset the FTDI bitmode. */
	197	ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
	198	if (ret < 0) {
	199	sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
	200	ret, ftdi_get_error_string(devc->ftdic));
	201	goto err_dev_open_close_ftdic;
	202	}
	203	sr_dbg("FTDI chip bitmode reset successfully.");
	204
	205	/* Set FTDI bitmode to "sync FIFO". */
	206	ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
	207	if (ret < 0) {
	208	sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
	209	ret, ftdi_get_error_string(devc->ftdic));
	210	goto err_dev_open_close_ftdic;
	211	}
	212	sr_dbg("FTDI chip sync FIFO mode entered successfully.");
	213
	214	/* Set the FTDI latency timer to 2. */
	215	ret = ftdi_set_latency_timer(devc->ftdic, 2);
	216	if (ret < 0) {
	217	sr_err("Failed to set FTDI latency timer (%d): %s.",
	218	ret, ftdi_get_error_string(devc->ftdic));
	219	goto err_dev_open_close_ftdic;
	220	}
	221	sr_dbg("FTDI chip latency timer set successfully.");
	222
	223	/* Set the FTDI read data chunk size to 64kB. */
	224	ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
	225	if (ret < 0) {
	226	sr_err("Failed to set FTDI read data chunk size (%d): %s.",
	227	ret, ftdi_get_error_string(devc->ftdic));
228	goto err_dev_open_close_ftdic;
229	}
230	sr_dbg("FTDI chip read data chunk size set successfully.");
231
232	/* Get the ScanaPLUS device ID from the FTDI EEPROM. */
233	if ((ret = scanaplus_get_device_id(devc)) < 0) {
234	sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
235	goto err_dev_open_close_ftdic;
236	}
237	sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
238	devc->devid[0], devc->devid[1], devc->devid[2]);
fdf4a1f5 UH	239
	240	sdi->status = SR_ST_ACTIVE;
	241
	242	return SR_OK;
ab4bb6eb UH	243
	244	err_dev_open_close_ftdic:
	245	scanaplus_close(devc);
	246	return SR_ERR;
fdf4a1f5 UH	247	}
	248
	249	static int dev_close(struct sr_dev_inst *sdi)
	250	{
ab4bb6eb UH	251	int ret;
	252	struct dev_context *devc;
	253
	254	ret = SR_OK;
	255	devc = sdi->priv;
	256
	257	if (sdi->status == SR_ST_ACTIVE) {
	258	sr_dbg("Status ACTIVE, closing device.");
	259	ret = scanaplus_close(devc);
	260	} else {
	261	sr_spew("Status not ACTIVE, nothing to do.");
	262	}
fdf4a1f5 UH	263
	264	sdi->status = SR_ST_INACTIVE;
	265
ab4bb6eb	266	return ret;
fdf4a1f5 UH	267	}
	268
	269	static int cleanup(void)
	270	{
	271	return dev_clear();
	272	}
	273
584560f1	274	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	275	const struct sr_channel_group *cg)
fdf4a1f5	276	{
fdf4a1f5	277	(void)sdi;
53b4680f	278	(void)cg;
fdf4a1f5	279
584560f1	280	switch (key) {
ab4bb6eb UH	281	case SR_CONF_SAMPLERATE:
	282	/* The ScanaPLUS samplerate is 100MHz and can't be changed. */
	283	*data = g_variant_new_uint64(SR_MHZ(100));
	284	break;
fdf4a1f5 UH	285	default:
	286	return SR_ERR_NA;
	287	}
	288
ab4bb6eb	289	return SR_OK;
fdf4a1f5 UH	290	}
fdf4a1f5 UH	291
584560f1	292	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	293	const struct sr_channel_group *cg)
fdf4a1f5	294	{
ab4bb6eb	295	struct dev_context *devc;
fdf4a1f5	296
53b4680f	297	(void)cg;
d3c74a6f	298
fdf4a1f5 UH	299	if (sdi->status != SR_ST_ACTIVE)
	300	return SR_ERR_DEV_CLOSED;
	301
ab4bb6eb UH	302	devc = sdi->priv;
ab4bb6eb UH	303
584560f1	304	switch (key) {
ab4bb6eb UH	305	case SR_CONF_SAMPLERATE:
	306	if (g_variant_get_uint64(data) != SR_MHZ(100)) {
	307	sr_err("ScanaPLUS only supports samplerate = 100MHz.");
	308	return SR_ERR_ARG;
	309	}
	310	/* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
	311	break;
	312	case SR_CONF_LIMIT_MSEC:
	313	if (g_variant_get_uint64(data) == 0)
	314	return SR_ERR_ARG;
	315	devc->limit_msec = g_variant_get_uint64(data);
	316	break;
	317	case SR_CONF_LIMIT_SAMPLES:
	318	if (g_variant_get_uint64(data) == 0)
	319	return SR_ERR_ARG;
	320	devc->limit_samples = g_variant_get_uint64(data);
	321	break;
fdf4a1f5	322	default:
ab4bb6eb	323	return SR_ERR_NA;
fdf4a1f5 UH	324	}
fdf4a1f5 UH	325
ab4bb6eb	326	return SR_OK;
fdf4a1f5 UH	327	}
fdf4a1f5 UH	328
584560f1	329	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	330	const struct sr_channel_group *cg)
fdf4a1f5	331	{
ab4bb6eb UH	332	GVariant *gvar;
ab4bb6eb UH	333	GVariantBuilder gvb;
fdf4a1f5 UH	334
fdf4a1f5 UH	335	(void)sdi;
53b4680f	336	(void)cg;
fdf4a1f5	337
fdf4a1f5	338	switch (key) {
ab4bb6eb	339	case SR_CONF_DEVICE_OPTIONS:
584560f1	340	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	341	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
ab4bb6eb UH	342	break;
	343	case SR_CONF_SAMPLERATE:
	344	g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
	345	gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
	346	samplerates, ARRAY_SIZE(samplerates),
	347	sizeof(uint64_t));
	348	g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
	349	*data = g_variant_builder_end(&gvb);
	350	break;
fdf4a1f5 UH	351	default:
	352	return SR_ERR_NA;
	353	}
	354
ab4bb6eb	355	return SR_OK;
fdf4a1f5 UH	356	}
	357
	358	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	359	{
ab4bb6eb UH	360	int ret;
ab4bb6eb UH	361	struct dev_context *devc;
fdf4a1f5 UH	362
	363	if (sdi->status != SR_ST_ACTIVE)
	364	return SR_ERR_DEV_CLOSED;
	365
ab4bb6eb UH	366	if (!(devc = sdi->priv))
	367	return SR_ERR_BUG;
	368
	369	if (!devc->ftdic)
	370	return SR_ERR_BUG;
	371
ba7dd8bb	372	/* TODO: Configure channels later (thresholds etc.). */
ab4bb6eb UH	373
	374	devc->cb_data = cb_data;
	375
	376	/* Properly reset internal variables before every new acquisition. */
	377	devc->compressed_bytes_ignored = 0;
	378	devc->samples_sent = 0;
	379	devc->bytes_received = 0;
	380
	381	if ((ret = scanaplus_init(devc)) < 0)
	382	return ret;
	383
	384	if ((ret = scanaplus_start_acquisition(devc)) < 0)
	385	return ret;
	386
	387	/* Send header packet to the session bus. */
102f1239	388	std_session_send_df_header(sdi, LOG_PREFIX);
ab4bb6eb UH	389
ab4bb6eb UH	390	/* Hook up a dummy handler to receive data from the device. */
102f1239	391	sr_session_source_add(sdi->session, -1, G_IO_IN, 0, scanaplus_receive_data, (void *)sdi);
ab4bb6eb	392
fdf4a1f5 UH	393	return SR_OK;
	394	}
	395
	396	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	397	{
ab4bb6eb	398	struct sr_datafeed_packet packet;
fdf4a1f5	399
102f1239	400	(void)cb_data;
ab4bb6eb UH	401
ab4bb6eb UH	402	sr_dbg("Stopping acquisition.");
102f1239	403	sr_session_source_remove(sdi->session, -1);
ab4bb6eb UH	404
	405	/* Send end packet to the session bus. */
	406	sr_dbg("Sending SR_DF_END.");
	407	packet.type = SR_DF_END;
102f1239	408	sr_session_send(sdi, &packet);
fdf4a1f5 UH	409
	410	return SR_OK;
	411	}
	412
	413	SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info = {
	414	.name = "ikalogic-scanaplus",
ce95428c	415	.longname = "IKALOGIC ScanaPLUS",
fdf4a1f5 UH	416	.api_version = 1,
	417	.init = init,
	418	.cleanup = cleanup,
	419	.scan = scan,
	420	.dev_list = dev_list,
	421	.dev_clear = dev_clear,
	422	.config_get = config_get,
	423	.config_set = config_set,
	424	.config_list = config_list,
	425	.dev_open = dev_open,
	426	.dev_close = dev_close,
	427	.dev_acquisition_start = dev_acquisition_start,
	428	.dev_acquisition_stop = dev_acquisition_stop,
	429	.priv = NULL,
	430	};