[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 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->final_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_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 channels 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_channel_names[i]; i++) {
		if (!(ch = sr_probe_new(i, SR_PROBE_LOGIC, TRUE,
					   chronovu_la8_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. */
	(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 *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;

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

	return SR_OK;
}

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)
{
	struct dev_context *devc;

	(void)cg;

	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,
		const struct sr_channel_group *cg)
{
	struct dev_context *devc;

	(void)cg;

	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,
		const struct sr_channel_group *cg)
{
	GVariant *gvar, *grange[2];
	GVariantBuilder gvb;

	(void)sdi;
	(void)cg;

	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_LIMIT_SAMPLES:
		grange[0] = g_variant_new_uint64(0);
		grange[1] = g_variant_new_uint64(MAX_NUM_SAMPLES);
		*data = g_variant_new_tuple(grange, 2);
		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);
		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);

	dev_acquisition_stop(sdi, sdi);

	return TRUE;
}

static int 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_channels(sdi) != SR_OK) {
		sr_err("Failed to configure channels.");
		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, LOG_PREFIX);

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