[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 hwcaps[] = {
	SR_CONF_LOGIC_ANALYZER,
	SR_CONF_SAMPLERATE,
	SR_CONF_LIMIT_MSEC,
	SR_CONF_LIMIT_SAMPLES,
	SR_CONF_CONTINUOUS, // TODO?
};

/* 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. */
	if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
		sr_err("Device context malloc failed.");
		goto err_free_nothing;
	}

	/* 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 = sr_dev_inst_new(0, SR_ST_INITIALIZING,
			USB_VENDOR_NAME, USB_MODEL_NAME, NULL);
	if (!sdi) {
		sr_err("Failed to create device instance.");
		goto err_close_ftdic;
	}
	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;

err_close_ftdic:
	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);
err_free_nothing:

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