[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 "driver.h"

SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
static struct sr_dev_driver *cdi = &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(int dev_index, void *cb_data);

static void clear_instances(void)
{
	GSList *l;
	struct sr_dev_inst *sdi;
	struct context *ctx;

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

}

static int hw_init(void)
{

	/* Nothing to do. */

	return SR_OK;
}

static GSList *hw_scan(GSList *options)
{
	int ret;
	struct sr_dev_inst *sdi;
	struct context *ctx;
	GSList *devices;

	(void)options;
	devices = NULL;

	/* Allocate memory for our private driver context. */
	if (!(ctx = g_try_malloc(sizeof(struct context)))) {
		sr_err("la8: %s: struct context malloc failed", __func__);
		goto err_free_nothing;
	}

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

	/* Allocate memory where we'll store the de-mangled data. */
	if (!(ctx->final_buf = g_try_malloc(SDRAM_SIZE))) {
		sr_err("la8: %s: final_buf malloc failed", __func__);
		goto err_free_ctx;
	}

	/* Allocate memory for the FTDI context (ftdic) and initialize it. */
	if (!(ctx->ftdic = ftdi_new())) {
		sr_err("la8: %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("la8: Probing for VID/PID %04x:%04x.", USB_VENDOR_ID,
		       usb_pids[i]);
		ret = ftdi_usb_open_desc(ctx->ftdic, USB_VENDOR_ID,
					 usb_pids[i], USB_DESCRIPTION, NULL);
		if (ret == 0) {
			sr_dbg("la8: Found LA8 device (%04x:%04x).",
			       USB_VENDOR_ID, usb_pids[i]);
			ctx->usb_pid = usb_pids[i];
		}
	}

	if (ctx->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("la8: %s: sr_dev_inst_new failed", __func__);
		goto err_close_ftdic;
	}

	sdi->priv = ctx;

	devices = g_slist_append(devices, sdi);
	cdi->instances = g_slist_append(cdi->instances, sdi);

	sr_spew("la8: Device init successful.");

	/* Close device. We'll reopen it again when we need it. */
	(void) la8_close(ctx); /* Log, but ignore errors. */

	return devices;

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

	return NULL;
}

static int hw_dev_open(int dev_index)
{
	int ret;
	struct sr_dev_inst *sdi;
	struct context *ctx;

	if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
		sr_err("la8: %s: sdi was NULL", __func__);
		return SR_ERR_BUG;
	}

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

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

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

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

	/* Enable flow control in the FTDI chip. */
	if ((ret = ftdi_setflowctrl(ctx->ftdic, SIO_RTS_CTS_HS)) < 0) {
		sr_err("la8: %s: ftdi_setflowcontrol: (%d) %s",
		       __func__, ret, ftdi_get_error_string(ctx->ftdic));
		(void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
		goto err_dev_open_close_ftdic;
	}
	sr_dbg("la8: 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(ctx); /* Log, but ignore errors. */
	return SR_ERR;
}

static int hw_dev_close(int dev_index)
{
	struct sr_dev_inst *sdi;
	struct context *ctx;

	if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
		sr_err("la8: %s: sdi was NULL", __func__);
		return SR_ERR_BUG;
	}

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

	sr_dbg("la8: Closing device.");

	if (sdi->status == SR_ST_ACTIVE) {
		sr_dbg("la8: Status ACTIVE, closing device.");
		/* TODO: Really ignore errors here, or return SR_ERR? */
		(void) la8_close_usb_reset_sequencer(ctx); /* Ignore errors. */
	} else {
		sr_spew("la8: Status not ACTIVE, nothing to do.");
	}

	sdi->status = SR_ST_INACTIVE;

	sr_dbg("la8: Freeing sample buffer.");
	g_free(ctx->final_buf);

	return SR_OK;
}

static int hw_cleanup(void)
{

	clear_instances();

	return SR_OK;
}

static int hw_info_get(int info_id, const void **data,
       const struct sr_dev_inst *sdi)
{
	struct context *ctx;

	switch (info_id) {
	case SR_DI_INST:
		*data = sdi;
		sr_spew("la8: %s: Returning sdi.", __func__);
		break;
	case SR_DI_NUM_PROBES:
		*data = GINT_TO_POINTER(NUM_PROBES);
		sr_spew("la8: %s: Returning number of probes: %d.", __func__,
			NUM_PROBES);
		break;
	case SR_DI_PROBE_NAMES:
		*data = probe_names;
		sr_spew("la8: %s: Returning probenames.", __func__);
		break;
	case SR_DI_SAMPLERATES:
		fill_supported_samplerates_if_needed();
		*data = &samplerates;
		sr_spew("la8: %s: Returning samplerates.", __func__);
		break;
	case SR_DI_TRIGGER_TYPES:
		*data = (char *)TRIGGER_TYPES;
		sr_spew("la8: %s: Returning trigger types: %s.", __func__,
			TRIGGER_TYPES);
		break;
	case SR_DI_CUR_SAMPLERATE:
		if (sdi) {
			ctx = sdi->priv;
			*data = &ctx->cur_samplerate;
			sr_spew("la8: %s: Returning samplerate: %" PRIu64 "Hz.",
				__func__, ctx->cur_samplerate);
		} else
			return SR_ERR;
		break;
	}

	return SR_OK;
}

static int hw_dev_status_get(int dev_index)
{
	struct sr_dev_inst *sdi;

	if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
		sr_err("la8: %s: sdi was NULL, device not found", __func__);
		return SR_ST_NOT_FOUND;
	}

	sr_dbg("la8: Returning status: %d.", sdi->status);

	return sdi->status;
}

static const int *hw_hwcap_get_all(void)
{
	sr_spew("la8: Returning list of device capabilities.");

	return hwcaps;
}

static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
{
	struct sr_dev_inst *sdi;
	struct context *ctx;

	if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
		sr_err("la8: %s: sdi was NULL", __func__);
		return SR_ERR_BUG;
	}

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

	sr_spew("la8: %s: dev_index %d, hwcap %d", __func__, dev_index, hwcap);

	switch (hwcap) {
	case SR_HWCAP_SAMPLERATE:
		if (set_samplerate(sdi, *(const uint64_t *)value) == SR_ERR) {
			sr_err("la8: %s: setting samplerate failed.", __func__);
			return SR_ERR;
		}
		sr_dbg("la8: SAMPLERATE = %" PRIu64, ctx->cur_samplerate);
		break;
	case SR_HWCAP_PROBECONFIG:
		if (configure_probes(ctx, (const GSList *)value) != SR_OK) {
			sr_err("la8: %s: probe config failed.", __func__);
			return SR_ERR;
		}
		break;
	case SR_HWCAP_LIMIT_MSEC:
		if (*(const uint64_t *)value == 0) {
			sr_err("la8: %s: LIMIT_MSEC can't be 0.", __func__);
			return SR_ERR;
		}
		ctx->limit_msec = *(const uint64_t *)value;
		sr_dbg("la8: LIMIT_MSEC = %" PRIu64, ctx->limit_msec);
		break;
	case SR_HWCAP_LIMIT_SAMPLES:
		if (*(const uint64_t *)value < MIN_NUM_SAMPLES) {
			sr_err("la8: %s: LIMIT_SAMPLES too small.", __func__);
			return SR_ERR;
		}
		ctx->limit_samples = *(const uint64_t *)value;
		sr_dbg("la8: LIMIT_SAMPLES = %" PRIu64, ctx->limit_samples);
		break;
	default:
		/* Unknown capability, return SR_ERR. */
		sr_err("la8: %s: Unknown capability.", __func__);
		return SR_ERR;
		break;
	}

	return SR_OK;
}

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

	/* Avoid compiler errors. */
	(void)fd;
	(void)revents;

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

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

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

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

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

	sr_dbg("la8: 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(ctx, i);

	hw_dev_acquisition_stop(sdi->index, sdi);

	// return FALSE; /* FIXME? */
	return TRUE;
}

static int hw_dev_acquisition_start(int dev_index, void *cb_data)
{
	struct sr_dev_inst *sdi;
	struct context *ctx;
	struct sr_datafeed_packet packet;
	struct sr_datafeed_header header;
	struct sr_datafeed_meta_logic meta;
	uint8_t buf[4];
	int bytes_written;

	if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
		sr_err("la8: %s: sdi was NULL", __func__);
		return SR_ERR_BUG;
	}

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

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

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

	sr_dbg("la8: Starting acquisition.");

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

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

	if (bytes_written < 0) {
		sr_err("la8: Acquisition failed to start.");
		return SR_ERR;
	} else if (bytes_written != 4) {
		sr_err("la8: Acquisition failed to start.");
		return SR_ERR; /* TODO: Other error and return code? */
	}

	sr_dbg("la8: Acquisition started successfully.");

	ctx->session_dev_id = cb_data;

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

	/* Send metadata about the SR_DF_LOGIC packets to come. */
	packet.type = SR_DF_META_LOGIC;
	packet.payload = &meta;
	meta.samplerate = ctx->cur_samplerate;
	meta.num_probes = NUM_PROBES;
	sr_session_send(ctx->session_dev_id, &packet);

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

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

	return SR_OK;
}

static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
{
	struct sr_dev_inst *sdi;
	struct context *ctx;
	struct sr_datafeed_packet packet;

	sr_dbg("la8: Stopping acquisition.");

	if (!(sdi = sr_dev_inst_get(cdi->instances, dev_index))) {
		sr_err("la8: %s: sdi was NULL", __func__);
		return SR_ERR_BUG;
	}

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

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