[libsigrok.git] / 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 int32_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);
}

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_probe_new(i, SR_PROBE_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(int id, GVariant **data, const struct sr_dev_inst *sdi,
		const struct sr_channel_group *cg)
{
	(void)sdi;
	(void)cg;

	switch (id) {
	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(int id, 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 (id) {
	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(int 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_INT32,
				hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_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(cb_data, LOG_PREFIX);

	/* Hook up a dummy handler to receive data from the device. */
	sr_source_add(-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)sdi;

	sr_dbg("Stopping acquisition.");
	sr_source_remove(-1);

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