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

/*
 * This file is part of the libsigrok 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;

/*
 * This will be initialized via config_list()/SR_CONF_SAMPLERATE.
 *
 * Min: 1 sample per 0.01us -> sample time is 0.084s, samplerate 100MHz
 * Max: 1 sample per 2.55us -> sample time is 21.391s, samplerate 392.15kHz
 */
SR_PRIV uint64_t chronovu_la8_samplerates[255] = { 0 };

/* Note: Continuous sampling is not supported by the hardware. */
SR_PRIV const int32_t chronovu_la8_hwcaps[] = {
	SR_CONF_LOGIC_ANALYZER,
	SR_CONF_SAMPLERATE,
	SR_CONF_LIMIT_MSEC, /* TODO: Not yet implemented. */
	SR_CONF_LIMIT_SAMPLES, /* TODO: Not yet implemented. */
};

/*
 * 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->cb_data = 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; chronovu_la8_probe_names[i]; i++) {
		if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
					   chronovu_la8_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)
{
	return ((struct drv_context *)(di->priv))->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;

	devc = sdi->priv;

	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;

	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, GVariant **data, const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;

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

	return SR_OK;
}

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

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	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, g_variant_get_uint64(data)) == 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 (g_variant_get_uint64(data) == 0) {
			sr_err("%s: LIMIT_MSEC can't be 0.", __func__);
			return SR_ERR;
		}
		devc->limit_msec = g_variant_get_uint64(data);
		sr_dbg("LIMIT_MSEC = %" PRIu64, devc->limit_msec);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		if (g_variant_get_uint64(data) < MIN_NUM_SAMPLES) {
			sr_err("%s: LIMIT_SAMPLES too small.", __func__);
			return SR_ERR;
		}
		devc->limit_samples = g_variant_get_uint64(data);
		sr_dbg("LIMIT_SAMPLES = %" PRIu64, devc->limit_samples);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
{
	GVariant *gvar;
	GVariantBuilder gvb;

	(void)sdi;

	switch (key) {
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				chronovu_la8_hwcaps,
				ARRAY_SIZE(chronovu_la8_hwcaps),
				sizeof(int32_t));
		break;
	case SR_CONF_SAMPLERATE:
		fill_supported_samplerates_if_needed();
		g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
		gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
				chronovu_la8_samplerates,
				ARRAY_SIZE(chronovu_la8_samplerates),
				sizeof(uint64_t));
		g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
		*data = g_variant_builder_end(&gvb);
		break;
	case SR_CONF_TRIGGER_TYPE:
		*data = g_variant_new_string(TRIGGER_TYPE);
		break;
	default:
		return SR_ERR_NA;
	}

	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;
	uint8_t buf[4];
	int bytes_written;

	if (sdi->status != SR_ST_ACTIVE)
		return SR_ERR_DEV_CLOSED;

	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;
	}

	/* 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("Hardware acquisition started successfully.");

	devc->cb_data = cb_data;

	/* Send header packet to the session bus. */
	std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);

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