[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++) {
		if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
					   channel_names[i])))
			return NULL;
		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++) {
3f239f08	131	if (!(ch = sr_channel_new(i, SR_CHANNEL_LOGIC, TRUE,
ba7dd8bb	132	channel_names[i])))
ab4bb6eb	133	return NULL;
ba7dd8bb	134	sdi->channels = g_slist_append(sdi->channels, ch);
ab4bb6eb UH	135	}
	136
	137	devices = g_slist_append(devices, sdi);
	138	drvc->instances = g_slist_append(drvc->instances, sdi);
	139
	140	/* Close device. We'll reopen it again when we need it. */
	141	scanaplus_close(devc);
fdf4a1f5 UH	142
fdf4a1f5 UH	143	return devices;
ab4bb6eb	144
ab4bb6eb UH	145	scanaplus_close(devc);
	146	err_free_ftdic:
	147	ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
	148	err_free_sample_buf:
	149	g_free(devc->sample_buf);
	150	err_free_compressed_buf:
	151	g_free(devc->compressed_buf);
	152	err_free_devc:
	153	g_free(devc);
ab4bb6eb UH	154
ab4bb6eb UH	155	return NULL;
fdf4a1f5 UH	156	}
	157
	158	static GSList *dev_list(void)
	159	{
	160	return ((struct drv_context *)(di->priv))->instances;
	161	}
	162
fdf4a1f5 UH	163	static int dev_open(struct sr_dev_inst *sdi)
fdf4a1f5 UH	164	{
ab4bb6eb UH	165	struct dev_context *devc;
	166	int ret;
	167
	168	devc = sdi->priv;
	169
	170	/* Select interface A, otherwise communication will fail. */
	171	ret = ftdi_set_interface(devc->ftdic, INTERFACE_A);
	172	if (ret < 0) {
	173	sr_err("Failed to set FTDI interface A (%d): %s", ret,
	174	ftdi_get_error_string(devc->ftdic));
	175	return SR_ERR;
	176	}
	177	sr_dbg("FTDI chip interface A set successfully.");
	178
	179	/* Open the device. */
	180	ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID, USB_DEVICE_ID,
	181	USB_IPRODUCT, NULL);
	182	if (ret < 0) {
	183	sr_err("Failed to open device (%d): %s", ret,
	184	ftdi_get_error_string(devc->ftdic));
	185	return SR_ERR;
	186	}
	187	sr_dbg("FTDI device opened successfully.");
	188
	189	/* Purge RX/TX buffers in the FTDI chip. */
	190	if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
	191	sr_err("Failed to purge FTDI RX/TX buffers (%d): %s.",
	192	ret, ftdi_get_error_string(devc->ftdic));
	193	goto err_dev_open_close_ftdic;
	194	}
	195	sr_dbg("FTDI chip buffers purged successfully.");
	196
	197	/* Reset the FTDI bitmode. */
	198	ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_RESET);
	199	if (ret < 0) {
	200	sr_err("Failed to reset the FTDI chip bitmode (%d): %s.",
	201	ret, ftdi_get_error_string(devc->ftdic));
	202	goto err_dev_open_close_ftdic;
	203	}
	204	sr_dbg("FTDI chip bitmode reset successfully.");
	205
	206	/* Set FTDI bitmode to "sync FIFO". */
	207	ret = ftdi_set_bitmode(devc->ftdic, 0xff, BITMODE_SYNCFF);
	208	if (ret < 0) {
	209	sr_err("Failed to put FTDI chip into sync FIFO mode (%d): %s.",
	210	ret, ftdi_get_error_string(devc->ftdic));
	211	goto err_dev_open_close_ftdic;
	212	}
	213	sr_dbg("FTDI chip sync FIFO mode entered successfully.");
	214
	215	/* Set the FTDI latency timer to 2. */
	216	ret = ftdi_set_latency_timer(devc->ftdic, 2);
	217	if (ret < 0) {
	218	sr_err("Failed to set FTDI latency timer (%d): %s.",
	219	ret, ftdi_get_error_string(devc->ftdic));
	220	goto err_dev_open_close_ftdic;
	221	}
	222	sr_dbg("FTDI chip latency timer set successfully.");
	223
	224	/* Set the FTDI read data chunk size to 64kB. */
	225	ret = ftdi_read_data_set_chunksize(devc->ftdic, 64 * 1024);
	226	if (ret < 0) {
	227	sr_err("Failed to set FTDI read data chunk size (%d): %s.",
	228	ret, ftdi_get_error_string(devc->ftdic));
229	goto err_dev_open_close_ftdic;
230	}
231	sr_dbg("FTDI chip read data chunk size set successfully.");
232
233	/* Get the ScanaPLUS device ID from the FTDI EEPROM. */
234	if ((ret = scanaplus_get_device_id(devc)) < 0) {
235	sr_err("Failed to get ScanaPLUS device ID: %d.", ret);
236	goto err_dev_open_close_ftdic;
237	}
238	sr_dbg("Received ScanaPLUS device ID successfully: %02x %02x %02x.",
239	devc->devid[0], devc->devid[1], devc->devid[2]);
fdf4a1f5 UH	240
	241	sdi->status = SR_ST_ACTIVE;
	242
	243	return SR_OK;
ab4bb6eb UH	244
	245	err_dev_open_close_ftdic:
	246	scanaplus_close(devc);
	247	return SR_ERR;
fdf4a1f5 UH	248	}
	249
	250	static int dev_close(struct sr_dev_inst *sdi)
	251	{
ab4bb6eb UH	252	int ret;
	253	struct dev_context *devc;
	254
	255	ret = SR_OK;
	256	devc = sdi->priv;
	257
	258	if (sdi->status == SR_ST_ACTIVE) {
	259	sr_dbg("Status ACTIVE, closing device.");
	260	ret = scanaplus_close(devc);
	261	} else {
	262	sr_spew("Status not ACTIVE, nothing to do.");
	263	}
fdf4a1f5 UH	264
	265	sdi->status = SR_ST_INACTIVE;
	266
ab4bb6eb	267	return ret;
fdf4a1f5 UH	268	}
	269
	270	static int cleanup(void)
	271	{
	272	return dev_clear();
	273	}
	274
584560f1	275	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	276	const struct sr_channel_group *cg)
fdf4a1f5	277	{
fdf4a1f5	278	(void)sdi;
53b4680f	279	(void)cg;
fdf4a1f5	280
584560f1	281	switch (key) {
ab4bb6eb UH	282	case SR_CONF_SAMPLERATE:
	283	/* The ScanaPLUS samplerate is 100MHz and can't be changed. */
	284	*data = g_variant_new_uint64(SR_MHZ(100));
	285	break;
fdf4a1f5 UH	286	default:
	287	return SR_ERR_NA;
	288	}
	289
ab4bb6eb	290	return SR_OK;
fdf4a1f5 UH	291	}
fdf4a1f5 UH	292
584560f1	293	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	294	const struct sr_channel_group *cg)
fdf4a1f5	295	{
ab4bb6eb	296	struct dev_context *devc;
fdf4a1f5	297
53b4680f	298	(void)cg;
d3c74a6f	299
fdf4a1f5 UH	300	if (sdi->status != SR_ST_ACTIVE)
	301	return SR_ERR_DEV_CLOSED;
	302
ab4bb6eb UH	303	devc = sdi->priv;
ab4bb6eb UH	304
584560f1	305	switch (key) {
ab4bb6eb UH	306	case SR_CONF_SAMPLERATE:
	307	if (g_variant_get_uint64(data) != SR_MHZ(100)) {
	308	sr_err("ScanaPLUS only supports samplerate = 100MHz.");
	309	return SR_ERR_ARG;
	310	}
	311	/* Nothing to do, the ScanaPLUS samplerate is always 100MHz. */
	312	break;
	313	case SR_CONF_LIMIT_MSEC:
	314	if (g_variant_get_uint64(data) == 0)
	315	return SR_ERR_ARG;
	316	devc->limit_msec = g_variant_get_uint64(data);
	317	break;
	318	case SR_CONF_LIMIT_SAMPLES:
	319	if (g_variant_get_uint64(data) == 0)
	320	return SR_ERR_ARG;
	321	devc->limit_samples = g_variant_get_uint64(data);
	322	break;
fdf4a1f5	323	default:
ab4bb6eb	324	return SR_ERR_NA;
fdf4a1f5 UH	325	}
fdf4a1f5 UH	326
ab4bb6eb	327	return SR_OK;
fdf4a1f5 UH	328	}
fdf4a1f5 UH	329
584560f1	330	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	331	const struct sr_channel_group *cg)
fdf4a1f5	332	{
ab4bb6eb UH	333	GVariant *gvar;
ab4bb6eb UH	334	GVariantBuilder gvb;
fdf4a1f5 UH	335
fdf4a1f5 UH	336	(void)sdi;
53b4680f	337	(void)cg;
fdf4a1f5	338
fdf4a1f5	339	switch (key) {
ab4bb6eb	340	case SR_CONF_DEVICE_OPTIONS:
584560f1	341	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	342	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
ab4bb6eb UH	343	break;
	344	case SR_CONF_SAMPLERATE:
	345	g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
	346	gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
	347	samplerates, ARRAY_SIZE(samplerates),
	348	sizeof(uint64_t));
	349	g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
	350	*data = g_variant_builder_end(&gvb);
	351	break;
fdf4a1f5 UH	352	default:
	353	return SR_ERR_NA;
	354	}
	355
ab4bb6eb	356	return SR_OK;
fdf4a1f5 UH	357	}
	358
	359	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	360	{
ab4bb6eb UH	361	int ret;
ab4bb6eb UH	362	struct dev_context *devc;
fdf4a1f5 UH	363
	364	if (sdi->status != SR_ST_ACTIVE)
	365	return SR_ERR_DEV_CLOSED;
	366
ab4bb6eb UH	367	if (!(devc = sdi->priv))
	368	return SR_ERR_BUG;
	369
	370	if (!devc->ftdic)
	371	return SR_ERR_BUG;
	372
ba7dd8bb	373	/* TODO: Configure channels later (thresholds etc.). */
ab4bb6eb UH	374
	375	devc->cb_data = cb_data;
	376
	377	/* Properly reset internal variables before every new acquisition. */
	378	devc->compressed_bytes_ignored = 0;
	379	devc->samples_sent = 0;
	380	devc->bytes_received = 0;
	381
	382	if ((ret = scanaplus_init(devc)) < 0)
	383	return ret;
	384
	385	if ((ret = scanaplus_start_acquisition(devc)) < 0)
	386	return ret;
	387
	388	/* Send header packet to the session bus. */
102f1239	389	std_session_send_df_header(sdi, LOG_PREFIX);
ab4bb6eb UH	390
ab4bb6eb UH	391	/* Hook up a dummy handler to receive data from the device. */
102f1239	392	sr_session_source_add(sdi->session, -1, G_IO_IN, 0, scanaplus_receive_data, (void *)sdi);
ab4bb6eb	393
fdf4a1f5 UH	394	return SR_OK;
	395	}
	396
	397	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	398	{
ab4bb6eb	399	struct sr_datafeed_packet packet;
fdf4a1f5	400
102f1239	401	(void)cb_data;
ab4bb6eb UH	402
ab4bb6eb UH	403	sr_dbg("Stopping acquisition.");
102f1239	404	sr_session_source_remove(sdi->session, -1);
ab4bb6eb UH	405
	406	/* Send end packet to the session bus. */
	407	sr_dbg("Sending SR_DF_END.");
	408	packet.type = SR_DF_END;
102f1239	409	sr_session_send(sdi, &packet);
fdf4a1f5 UH	410
	411	return SR_OK;
	412	}
	413
	414	SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info = {
	415	.name = "ikalogic-scanaplus",
ce95428c	416	.longname = "IKALOGIC ScanaPLUS",
fdf4a1f5 UH	417	.api_version = 1,
	418	.init = init,
	419	.cleanup = cleanup,
	420	.scan = scan,
	421	.dev_list = dev_list,
	422	.dev_clear = dev_clear,
	423	.config_get = config_get,
	424	.config_set = config_set,
	425	.config_list = config_list,
	426	.dev_open = dev_open,
	427	.dev_close = dev_close,
	428	.dev_acquisition_start = dev_acquisition_start,
	429	.dev_acquisition_stop = dev_acquisition_stop,
	430	.priv = NULL,
	431	};