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