[libsigrok.git] / hardware / chronovu-la8 / api.c

/*
 * This file is part of the sigrok project.
 *
 * Copyright (C) 2011-2012 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 <ftdi.h>
#include <glib.h>
#include <string.h>
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include "protocol.h"

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

/*
 * The ChronoVu LA8 can have multiple PIDs. Older versions shipped with
 * a standard FTDI USB VID/PID of 0403:6001, newer ones have 0403:8867.
 */ 
static const uint16_t usb_pids[] = {
	0x6001,
	0x8867,
};

/* Function prototypes. */
static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data);

static int clear_instances(void)
{
	GSList *l;
	struct sr_dev_inst *sdi;
	struct drv_context *drvc;
	struct dev_context *devc;

	drvc = di->priv;

	/* Properly close all devices. */
	for (l = drvc->instances; l; l = l->next) {
		if (!(sdi = l->data)) {
			/* Log error, but continue cleaning up the rest. */
			sr_err("%s: sdi was NULL, continuing.", __func__);
			continue;
		}
		if (sdi->priv) {
			devc = sdi->priv;
			ftdi_free(devc->ftdic);
		}
		sr_dev_inst_free(sdi);
	}
	g_slist_free(drvc->instances);
	drvc->instances = NULL;

	return SR_OK;
}

static int hw_init(struct sr_context *sr_ctx)
{
	return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
}

static GSList *hw_scan(GSList *options)
{
	struct sr_dev_inst *sdi;
	struct sr_probe *probe;
	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_malloc(sizeof(struct dev_context)))) {
		sr_err("Device context malloc failed.");
		goto err_free_nothing;
	}

	/* Set some sane defaults. */
	devc->ftdic = NULL;
	devc->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
	devc->limit_msec = 0;
	devc->limit_samples = 0;
	devc->session_dev_id = NULL;
	memset(devc->mangled_buf, 0, BS);
	devc->final_buf = NULL;
	devc->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
	devc->trigger_mask = 0x00; /* All probes are "don't care". */
	devc->trigger_timeout = 10; /* Default to 10s trigger timeout. */
	devc->trigger_found = 0;
	devc->done = 0;
	devc->block_counter = 0;
	devc->divcount = 0; /* 10ns sample period == 100MHz samplerate */
	devc->usb_pid = 0;

	/* Allocate memory where we'll store the de-mangled data. */
	if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
		sr_err("final_buf malloc failed.");
		goto err_free_devc;
	}

	/* Allocate memory for the FTDI context (ftdic) and initialize it. */
	if (!(devc->ftdic = ftdi_new())) {
		sr_err("%s: ftdi_new failed.", __func__);
		goto err_free_final_buf;
	}

	/* Check for the device and temporarily open it. */
	for (i = 0; i < ARRAY_SIZE(usb_pids); i++) {
		sr_dbg("Probing for VID/PID %04x:%04x.", USB_VENDOR_ID,
		       usb_pids[i]);
		ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
					 usb_pids[i], USB_DESCRIPTION, NULL);
		if (ret == 0) {
			sr_dbg("Found LA8 device (%04x:%04x).",
			       USB_VENDOR_ID, usb_pids[i]);
			devc->usb_pid = usb_pids[i];
		}
	}

	if (devc->usb_pid == 0)
		goto err_free_ftdic;

	/* Register the device with libsigrok. */
	sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
			USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
	if (!sdi) {
		sr_err("%s: sr_dev_inst_new failed.", __func__);
		goto err_close_ftdic;
	}
	sdi->driver = di;
	sdi->priv = devc;

	for (i = 0; probe_names[i]; i++) {
		if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
					   probe_names[i])))
			return NULL;
		sdi->probes = g_slist_append(sdi->probes, probe);
	}

	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. */
	(void) la8_close(devc); /* Log, but ignore errors. */

	return devices;

err_close_ftdic:
	(void) la8_close(devc); /* Log, but ignore errors. */
err_free_ftdic:
	ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
err_free_final_buf:
	g_free(devc->final_buf);
err_free_devc:
	g_free(devc);
err_free_nothing:

	return NULL;
}

static GSList *hw_dev_list(void)
{
	struct drv_context *drvc;

	drvc = di->priv;

	return drvc->instances;
}

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

	if (!(devc = sdi->priv)) {
		sr_err("%s: sdi->priv was NULL.", __func__);
		return SR_ERR_BUG;
	}

	sr_dbg("Opening LA8 device (%04x:%04x).", USB_VENDOR_ID,
	       devc->usb_pid);

	/* Open the device. */
	if ((ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
			devc->usb_pid, USB_DESCRIPTION, NULL)) < 0) {
		sr_err("%s: ftdi_usb_open_desc: (%d) %s",
		       __func__, ret, ftdi_get_error_string(devc->ftdic));
		(void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
		return SR_ERR;
	}
	sr_dbg("Device opened successfully.");

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

	/* Enable flow control in the FTDI chip. */
	if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
		sr_err("%s: ftdi_setflowcontrol: (%d) %s",
		       __func__, ret, ftdi_get_error_string(devc->ftdic));
		(void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
		goto err_dev_open_close_ftdic;
	}
	sr_dbg("FTDI flow control enabled successfully.");

	/* Wait 100ms. */
	g_usleep(100 * 1000);

	sdi->status = SR_ST_ACTIVE;

	return SR_OK;

err_dev_open_close_ftdic:
	(void) la8_close(devc); /* Log, but ignore errors. */
	return SR_ERR;
}

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

	if (!(devc = sdi->priv)) {
		sr_err("%s: sdi->priv was NULL.", __func__);
		return SR_ERR_BUG;
	}

	sr_dbg("Closing device.");

	if (sdi->status == SR_ST_ACTIVE) {
		sr_dbg("Status ACTIVE, closing device.");
		(void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
	} else {
		sr_spew("Status not ACTIVE, nothing to do.");
	}

	sdi->status = SR_ST_INACTIVE;

	sr_dbg("Freeing sample buffer.");
	g_free(devc->final_buf);

	return SR_OK;
}

static int hw_cleanup(void)
{
	if (!di->priv)
		/* Can get called on an unused driver, doesn't matter. */
		return SR_OK;

	clear_instances();

	return SR_OK;
}

static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	switch (id) {
	case SR_CONF_SAMPLERATE:
		if (sdi) {
			devc = sdi->priv;
			*data = &devc->cur_samplerate;
			sr_spew("%s: Returning samplerate: %" PRIu64 "Hz.",
				__func__, devc->cur_samplerate);
		} else
			return SR_ERR;
		break;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

	if (!(devc = sdi->priv)) {
		sr_err("%s: sdi->priv was NULL.", __func__);
		return SR_ERR_BUG;
	}

	switch (id) {
	case SR_CONF_SAMPLERATE:
		if (set_samplerate(sdi, *(const uint64_t *)value) == SR_ERR) {
			sr_err("%s: setting samplerate failed.", __func__);
			return SR_ERR;
		}
		sr_dbg("SAMPLERATE = %" PRIu64, devc->cur_samplerate);
		break;
	case SR_CONF_LIMIT_MSEC:
		if (*(const uint64_t *)value == 0) {
			sr_err("%s: LIMIT_MSEC can't be 0.", __func__);
			return SR_ERR;
		}
		devc->limit_msec = *(const uint64_t *)value;
		sr_dbg("LIMIT_MSEC = %" PRIu64, devc->limit_msec);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		if (*(const uint64_t *)value < MIN_NUM_SAMPLES) {
			sr_err("%s: LIMIT_SAMPLES too small.", __func__);
			return SR_ERR;
		}
		devc->limit_samples = *(const uint64_t *)value;
		sr_dbg("LIMIT_SAMPLES = %" PRIu64, devc->limit_samples);
		break;
	default:
		/* Unknown capability, return SR_ERR. */
		sr_err("%s: Unknown capability: %d.", __func__, id);
		return SR_ERR;
		break;
	}

	return SR_OK;
}

static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
{

	(void)sdi;

	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		*data = hwcaps;
		break;
	case SR_CONF_SAMPLERATE:
		fill_supported_samplerates_if_needed();
		*data = &samplerates;
		break;
	case SR_CONF_TRIGGER_TYPE:
		*data = (char *)TRIGGER_TYPE;
		break;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

static int receive_data(int fd, int revents, void *cb_data)
{
	int i, ret;
	struct sr_dev_inst *sdi;
	struct dev_context *devc;

	(void)fd;
	(void)revents;

	if (!(sdi = cb_data)) {
		sr_err("%s: cb_data was NULL.", __func__);
		return FALSE;
	}

	if (!(devc = sdi->priv)) {
		sr_err("%s: sdi->priv was NULL.", __func__);
		return FALSE;
	}

	if (!devc->ftdic) {
		sr_err("%s: devc->ftdic was NULL.", __func__);
		return FALSE;
	}

	/* Get one block of data. */
	if ((ret = la8_read_block(devc)) < 0) {
		sr_err("%s: la8_read_block error: %d.", __func__, ret);
		hw_dev_acquisition_stop(sdi, sdi);
		return FALSE;
	}

	/* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
	if (devc->block_counter != (NUM_BLOCKS - 1)) {
		devc->block_counter++;
		return TRUE;
	}

	sr_dbg("Sampling finished, sending data to session bus now.");

	/* All data was received and demangled, send it to the session bus. */
	for (i = 0; i < NUM_BLOCKS; i++)
		send_block_to_session_bus(devc, i);

	hw_dev_acquisition_stop(sdi, sdi);

	return TRUE;
}

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
				    void *cb_data)
{
	struct dev_context *devc;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_header header;
	uint8_t buf[4];
	int bytes_written;

	if (!(devc = sdi->priv)) {
		sr_err("%s: sdi->priv was NULL.", __func__);
		return SR_ERR_BUG;
	}

	if (!devc->ftdic) {
		sr_err("%s: devc->ftdic was NULL.", __func__);
		return SR_ERR_BUG;
	}

	devc->divcount = samplerate_to_divcount(devc->cur_samplerate);
	if (devc->divcount == 0xff) {
		sr_err("%s: Invalid divcount/samplerate.", __func__);
		return SR_ERR;
	}

	if (configure_probes(sdi) != SR_OK) {
		sr_err("Failed to configure probes.");
		return SR_ERR;
	}

	sr_dbg("Starting acquisition.");

	/* Fill acquisition parameters into buf[]. */
	buf[0] = devc->divcount;
	buf[1] = 0xff; /* This byte must always be 0xff. */
	buf[2] = devc->trigger_pattern;
	buf[3] = devc->trigger_mask;

	/* Start acquisition. */
	bytes_written = la8_write(devc, buf, 4);

	if (bytes_written < 0) {
		sr_err("Acquisition failed to start: %d.", bytes_written);
		return SR_ERR;
	} else if (bytes_written != 4) {
		sr_err("Acquisition failed to start: %d.", bytes_written);
		return SR_ERR;
	}

	sr_dbg("Acquisition started successfully.");

	devc->session_dev_id = cb_data;

	/* Send header packet to the session bus. */
	sr_dbg("Sending SR_DF_HEADER.");
	packet.type = SR_DF_HEADER;
	packet.payload = &header;
	header.feed_version = 1;
	gettimeofday(&header.starttime, NULL);
	sr_session_send(devc->session_dev_id, &packet);

	/* Time when we should be done (for detecting trigger timeouts). */
	devc->done = (devc->divcount + 1) * 0.08388608 + time(NULL)
			+ devc->trigger_timeout;
	devc->block_counter = 0;
	devc->trigger_found = 0;

	/* Hook up a dummy handler to receive data from the LA8. */
	sr_source_add(-1, G_IO_IN, 0, receive_data, (void *)sdi);

	return SR_OK;
}

static int hw_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 chronovu_la8_driver_info = {
	.name = "chronovu-la8",
	.longname = "ChronoVu LA8",
	.api_version = 1,
	.init = hw_init,
	.cleanup = hw_cleanup,
	.scan = hw_scan,
	.dev_list = hw_dev_list,
	.dev_clear = clear_instances,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = hw_dev_open,
	.dev_close = hw_dev_close,
	.dev_acquisition_start = hw_dev_acquisition_start,
	.dev_acquisition_stop = hw_dev_acquisition_stop,
	.priv = NULL,
};
Commit	Line	Data
	1	/*
	2	* This file is part of the sigrok project.
	3	*
	4	* Copyright (C) 2011-2012 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 <ftdi.h>
	22	#include <glib.h>
	23	#include <string.h>
	24	#include "libsigrok.h"
	25	#include "libsigrok-internal.h"
	26	#include "protocol.h"
	27
	28	SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
	29	static struct sr_dev_driver *di = &chronovu_la8_driver_info;
	30
	31	/*
	32	* The ChronoVu LA8 can have multiple PIDs. Older versions shipped with
	33	* a standard FTDI USB VID/PID of 0403:6001, newer ones have 0403:8867.
	34	*/
	35	static const uint16_t usb_pids[] = {
	36	0x6001,
	37	0x8867,
	38	};
	39
	40	/* Function prototypes. */
	41	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data);
	42
	43	static int clear_instances(void)
	44	{
	45	GSList *l;
	46	struct sr_dev_inst *sdi;
	47	struct drv_context *drvc;
	48	struct dev_context *devc;
	49
	50	drvc = di->priv;
	51
	52	/* Properly close all devices. */
	53	for (l = drvc->instances; l; l = l->next) {
	54	if (!(sdi = l->data)) {
	55	/* Log error, but continue cleaning up the rest. */
	56	sr_err("%s: sdi was NULL, continuing.", __func__);
	57	continue;
	58	}
	59	if (sdi->priv) {
	60	devc = sdi->priv;
	61	ftdi_free(devc->ftdic);
	62	}
	63	sr_dev_inst_free(sdi);
	64	}
	65	g_slist_free(drvc->instances);
	66	drvc->instances = NULL;
	67
	68	return SR_OK;
	69	}
	70
	71	static int hw_init(struct sr_context *sr_ctx)
	72	{
	73	return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
	74	}
	75
	76	static GSList hw_scan(GSList options)
	77	{
	78	struct sr_dev_inst *sdi;
	79	struct sr_probe *probe;
	80	struct drv_context *drvc;
	81	struct dev_context *devc;
	82	GSList *devices;
	83	unsigned int i;
	84	int ret;
	85
	86	(void)options;
	87
	88	drvc = di->priv;
	89
	90	devices = NULL;
	91
	92	/* Allocate memory for our private device context. */
	93	if (!(devc = g_try_malloc(sizeof(struct dev_context)))) {
	94	sr_err("Device context malloc failed.");
	95	goto err_free_nothing;
	96	}
	97
	98	/* Set some sane defaults. */
	99	devc->ftdic = NULL;
	100	devc->cur_samplerate = SR_MHZ(100); /* 100MHz == max. samplerate */
	101	devc->limit_msec = 0;
	102	devc->limit_samples = 0;
	103	devc->session_dev_id = NULL;
	104	memset(devc->mangled_buf, 0, BS);
	105	devc->final_buf = NULL;
	106	devc->trigger_pattern = 0x00; /* Value irrelevant, see trigger_mask. */
	107	devc->trigger_mask = 0x00; /* All probes are "don't care". */
	108	devc->trigger_timeout = 10; /* Default to 10s trigger timeout. */
	109	devc->trigger_found = 0;
	110	devc->done = 0;
	111	devc->block_counter = 0;
	112	devc->divcount = 0; /* 10ns sample period == 100MHz samplerate */
	113	devc->usb_pid = 0;
	114
	115	/* Allocate memory where we'll store the de-mangled data. */
	116	if (!(devc->final_buf = g_try_malloc(SDRAM_SIZE))) {
	117	sr_err("final_buf malloc failed.");
	118	goto err_free_devc;
	119	}
	120
	121	/* Allocate memory for the FTDI context (ftdic) and initialize it. */
	122	if (!(devc->ftdic = ftdi_new())) {
	123	sr_err("%s: ftdi_new failed.", __func__);
	124	goto err_free_final_buf;
	125	}
	126
	127	/* Check for the device and temporarily open it. */
	128	for (i = 0; i < ARRAY_SIZE(usb_pids); i++) {
	129	sr_dbg("Probing for VID/PID %04x:%04x.", USB_VENDOR_ID,
	130	usb_pids[i]);
	131	ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
	132	usb_pids[i], USB_DESCRIPTION, NULL);
	133	if (ret == 0) {
	134	sr_dbg("Found LA8 device (%04x:%04x).",
	135	USB_VENDOR_ID, usb_pids[i]);
	136	devc->usb_pid = usb_pids[i];
	137	}
	138	}
	139
	140	if (devc->usb_pid == 0)
	141	goto err_free_ftdic;
	142
	143	/* Register the device with libsigrok. */
	144	sdi = sr_dev_inst_new(0, SR_ST_INITIALIZING,
	145	USB_VENDOR_NAME, USB_MODEL_NAME, USB_MODEL_VERSION);
	146	if (!sdi) {
	147	sr_err("%s: sr_dev_inst_new failed.", __func__);
	148	goto err_close_ftdic;
	149	}
	150	sdi->driver = di;
	151	sdi->priv = devc;
	152
	153	for (i = 0; probe_names[i]; i++) {
	154	if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
	155	probe_names[i])))
	156	return NULL;
	157	sdi->probes = g_slist_append(sdi->probes, probe);
	158	}
	159
	160	devices = g_slist_append(devices, sdi);
	161	drvc->instances = g_slist_append(drvc->instances, sdi);
	162
	163	/* Close device. We'll reopen it again when we need it. */
	164	(void) la8_close(devc); /* Log, but ignore errors. */
	165
	166	return devices;
	167
	168	err_close_ftdic:
	169	(void) la8_close(devc); /* Log, but ignore errors. */
	170	err_free_ftdic:
	171	ftdi_free(devc->ftdic); /* NOT free() or g_free()! */
	172	err_free_final_buf:
	173	g_free(devc->final_buf);
	174	err_free_devc:
	175	g_free(devc);
	176	err_free_nothing:
	177
	178	return NULL;
	179	}
	180
	181	static GSList *hw_dev_list(void)
	182	{
	183	struct drv_context *drvc;
	184
	185	drvc = di->priv;
	186
	187	return drvc->instances;
	188	}
	189
	190	static int hw_dev_open(struct sr_dev_inst *sdi)
	191	{
	192	struct dev_context *devc;
	193	int ret;
	194
	195	if (!(devc = sdi->priv)) {
	196	sr_err("%s: sdi->priv was NULL.", __func__);
	197	return SR_ERR_BUG;
	198	}
	199
	200	sr_dbg("Opening LA8 device (%04x:%04x).", USB_VENDOR_ID,
	201	devc->usb_pid);
	202
	203	/* Open the device. */
	204	if ((ret = ftdi_usb_open_desc(devc->ftdic, USB_VENDOR_ID,
	205	devc->usb_pid, USB_DESCRIPTION, NULL)) < 0) {
	206	sr_err("%s: ftdi_usb_open_desc: (%d) %s",
	207	__func__, ret, ftdi_get_error_string(devc->ftdic));
	208	(void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
	209	return SR_ERR;
	210	}
	211	sr_dbg("Device opened successfully.");
	212
	213	/* Purge RX/TX buffers in the FTDI chip. */
	214	if ((ret = ftdi_usb_purge_buffers(devc->ftdic)) < 0) {
	215	sr_err("%s: ftdi_usb_purge_buffers: (%d) %s",
	216	__func__, ret, ftdi_get_error_string(devc->ftdic));
	217	(void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
	218	goto err_dev_open_close_ftdic;
	219	}
	220	sr_dbg("FTDI buffers purged successfully.");
	221
	222	/* Enable flow control in the FTDI chip. */
	223	if ((ret = ftdi_setflowctrl(devc->ftdic, SIO_RTS_CTS_HS)) < 0) {
	224	sr_err("%s: ftdi_setflowcontrol: (%d) %s",
	225	__func__, ret, ftdi_get_error_string(devc->ftdic));
	226	(void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
	227	goto err_dev_open_close_ftdic;
	228	}
	229	sr_dbg("FTDI flow control enabled successfully.");
	230
	231	/* Wait 100ms. */
	232	g_usleep(100 * 1000);
	233
	234	sdi->status = SR_ST_ACTIVE;
	235
	236	return SR_OK;
	237
	238	err_dev_open_close_ftdic:
	239	(void) la8_close(devc); /* Log, but ignore errors. */
	240	return SR_ERR;
	241	}
	242
	243	static int hw_dev_close(struct sr_dev_inst *sdi)
	244	{
	245	struct dev_context *devc;
	246
	247	if (!(devc = sdi->priv)) {
	248	sr_err("%s: sdi->priv was NULL.", __func__);
	249	return SR_ERR_BUG;
	250	}
	251
	252	sr_dbg("Closing device.");
	253
	254	if (sdi->status == SR_ST_ACTIVE) {
	255	sr_dbg("Status ACTIVE, closing device.");
	256	(void) la8_close_usb_reset_sequencer(devc); /* Ignore errors. */
	257	} else {
	258	sr_spew("Status not ACTIVE, nothing to do.");
	259	}
	260
	261	sdi->status = SR_ST_INACTIVE;
	262
	263	sr_dbg("Freeing sample buffer.");
	264	g_free(devc->final_buf);
	265
	266	return SR_OK;
	267	}
	268
	269	static int hw_cleanup(void)
	270	{
	271	if (!di->priv)
	272	/* Can get called on an unused driver, doesn't matter. */
	273	return SR_OK;
	274
	275	clear_instances();
	276
	277	return SR_OK;
	278	}
	279
	280	static int config_get(int id, const void *data, const struct sr_dev_inst sdi)
	281	{
	282	struct dev_context *devc;
	283
	284	switch (id) {
	285	case SR_CONF_SAMPLERATE:
	286	if (sdi) {
	287	devc = sdi->priv;
	288	*data = &devc->cur_samplerate;
	289	sr_spew("%s: Returning samplerate: %" PRIu64 "Hz.",
	290	__func__, devc->cur_samplerate);
	291	} else
	292	return SR_ERR;
	293	break;
	294	default:
	295	return SR_ERR_ARG;
	296	}
	297
	298	return SR_OK;
	299	}
	300
	301	static int config_set(int id, const void value, const struct sr_dev_inst sdi)
	302	{
	303	struct dev_context *devc;
	304
	305	if (!(devc = sdi->priv)) {
	306	sr_err("%s: sdi->priv was NULL.", __func__);
	307	return SR_ERR_BUG;
	308	}
	309
	310	switch (id) {
	311	case SR_CONF_SAMPLERATE:
	312	if (set_samplerate(sdi, (const uint64_t )value) == SR_ERR) {
	313	sr_err("%s: setting samplerate failed.", __func__);
	314	return SR_ERR;
	315	}
	316	sr_dbg("SAMPLERATE = %" PRIu64, devc->cur_samplerate);
	317	break;
	318	case SR_CONF_LIMIT_MSEC:
	319	if ((const uint64_t )value == 0) {
	320	sr_err("%s: LIMIT_MSEC can't be 0.", __func__);
	321	return SR_ERR;
	322	}
	323	devc->limit_msec = (const uint64_t )value;
	324	sr_dbg("LIMIT_MSEC = %" PRIu64, devc->limit_msec);
	325	break;
	326	case SR_CONF_LIMIT_SAMPLES:
	327	if ((const uint64_t )value < MIN_NUM_SAMPLES) {
	328	sr_err("%s: LIMIT_SAMPLES too small.", __func__);
	329	return SR_ERR;
	330	}
	331	devc->limit_samples = (const uint64_t )value;
	332	sr_dbg("LIMIT_SAMPLES = %" PRIu64, devc->limit_samples);
	333	break;
	334	default:
	335	/* Unknown capability, return SR_ERR. */
	336	sr_err("%s: Unknown capability: %d.", __func__, id);
	337	return SR_ERR;
	338	break;
	339	}
	340
	341	return SR_OK;
	342	}
	343
	344	static int config_list(int key, const void *data, const struct sr_dev_inst sdi)
	345	{
	346
	347	(void)sdi;
	348
	349	switch (key) {
	350	case SR_CONF_DEVICE_OPTIONS:
	351	*data = hwcaps;
	352	break;
	353	case SR_CONF_SAMPLERATE:
	354	fill_supported_samplerates_if_needed();
	355	*data = &samplerates;
	356	break;
	357	case SR_CONF_TRIGGER_TYPE:
	358	data = (char )TRIGGER_TYPE;
	359	break;
	360	default:
	361	return SR_ERR_ARG;
	362	}
	363
	364	return SR_OK;
	365	}
	366
	367	static int receive_data(int fd, int revents, void *cb_data)
	368	{
	369	int i, ret;
	370	struct sr_dev_inst *sdi;
	371	struct dev_context *devc;
	372
	373	(void)fd;
	374	(void)revents;
	375
	376	if (!(sdi = cb_data)) {
	377	sr_err("%s: cb_data was NULL.", __func__);
	378	return FALSE;
	379	}
	380
	381	if (!(devc = sdi->priv)) {
	382	sr_err("%s: sdi->priv was NULL.", __func__);
	383	return FALSE;
	384	}
	385
	386	if (!devc->ftdic) {
	387	sr_err("%s: devc->ftdic was NULL.", __func__);
	388	return FALSE;
	389	}
	390
	391	/* Get one block of data. */
	392	if ((ret = la8_read_block(devc)) < 0) {
	393	sr_err("%s: la8_read_block error: %d.", __func__, ret);
	394	hw_dev_acquisition_stop(sdi, sdi);
	395	return FALSE;
	396	}
	397
	398	/* We need to get exactly NUM_BLOCKS blocks (i.e. 8MB) of data. */
	399	if (devc->block_counter != (NUM_BLOCKS - 1)) {
	400	devc->block_counter++;
	401	return TRUE;
	402	}
	403
	404	sr_dbg("Sampling finished, sending data to session bus now.");
	405
	406	/* All data was received and demangled, send it to the session bus. */
	407	for (i = 0; i < NUM_BLOCKS; i++)
	408	send_block_to_session_bus(devc, i);
	409
	410	hw_dev_acquisition_stop(sdi, sdi);
	411
	412	return TRUE;
	413	}
	414
	415	static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
	416	void *cb_data)
	417	{
	418	struct dev_context *devc;
	419	struct sr_datafeed_packet packet;
	420	struct sr_datafeed_header header;
	421	uint8_t buf[4];
	422	int bytes_written;
	423
	424	if (!(devc = sdi->priv)) {
	425	sr_err("%s: sdi->priv was NULL.", __func__);
	426	return SR_ERR_BUG;
	427	}
	428
	429	if (!devc->ftdic) {
	430	sr_err("%s: devc->ftdic was NULL.", __func__);
	431	return SR_ERR_BUG;
	432	}
	433
	434	devc->divcount = samplerate_to_divcount(devc->cur_samplerate);
	435	if (devc->divcount == 0xff) {
	436	sr_err("%s: Invalid divcount/samplerate.", __func__);
	437	return SR_ERR;
	438	}
	439
	440	if (configure_probes(sdi) != SR_OK) {
	441	sr_err("Failed to configure probes.");
	442	return SR_ERR;
	443	}
	444
	445	sr_dbg("Starting acquisition.");
	446
	447	/* Fill acquisition parameters into buf[]. */
	448	buf[0] = devc->divcount;
	449	buf[1] = 0xff; /* This byte must always be 0xff. */
	450	buf[2] = devc->trigger_pattern;
	451	buf[3] = devc->trigger_mask;
	452
	453	/* Start acquisition. */
	454	bytes_written = la8_write(devc, buf, 4);
	455
	456	if (bytes_written < 0) {
	457	sr_err("Acquisition failed to start: %d.", bytes_written);
	458	return SR_ERR;
	459	} else if (bytes_written != 4) {
	460	sr_err("Acquisition failed to start: %d.", bytes_written);
	461	return SR_ERR;
	462	}
	463
	464	sr_dbg("Acquisition started successfully.");
	465
	466	devc->session_dev_id = cb_data;
	467
	468	/* Send header packet to the session bus. */
	469	sr_dbg("Sending SR_DF_HEADER.");
	470	packet.type = SR_DF_HEADER;
	471	packet.payload = &header;
	472	header.feed_version = 1;
	473	gettimeofday(&header.starttime, NULL);
	474	sr_session_send(devc->session_dev_id, &packet);
	475
	476	/* Time when we should be done (for detecting trigger timeouts). */
	477	devc->done = (devc->divcount + 1) * 0.08388608 + time(NULL)
	478	+ devc->trigger_timeout;
	479	devc->block_counter = 0;
	480	devc->trigger_found = 0;
	481
	482	/* Hook up a dummy handler to receive data from the LA8. */
	483	sr_source_add(-1, G_IO_IN, 0, receive_data, (void *)sdi);
	484
	485	return SR_OK;
	486	}
	487
	488	static int hw_dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	489	{
	490	struct sr_datafeed_packet packet;
	491
	492	(void)sdi;
	493
	494	sr_dbg("Stopping acquisition.");
	495	sr_source_remove(-1);
	496
	497	/* Send end packet to the session bus. */
	498	sr_dbg("Sending SR_DF_END.");
	499	packet.type = SR_DF_END;
	500	sr_session_send(cb_data, &packet);
	501
	502	return SR_OK;
	503	}
	504
	505	SR_PRIV struct sr_dev_driver chronovu_la8_driver_info = {
	506	.name = "chronovu-la8",
	507	.longname = "ChronoVu LA8",
	508	.api_version = 1,
	509	.init = hw_init,
	510	.cleanup = hw_cleanup,
	511	.scan = hw_scan,
	512	.dev_list = hw_dev_list,
	513	.dev_clear = clear_instances,
	514	.config_get = config_get,
	515	.config_set = config_set,
	516	.config_list = config_list,
	517	.dev_open = hw_dev_open,
	518	.dev_close = hw_dev_close,
	519	.dev_acquisition_start = hw_dev_acquisition_start,
	520	.dev_acquisition_stop = hw_dev_acquisition_stop,
	521	.priv = NULL,
	522	};