[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(const struct sr_dev_inst *sdi,
		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)
{
	struct sr_dev_inst *sdi;
	struct context *ctx;
	GSList *devices;
	unsigned int i;
	int ret;

	(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->driver = cdi;
	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(struct sr_dev_inst *sdi)
{
	struct context *ctx;
	int ret;

	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(struct sr_dev_inst *sdi)
{
	struct context *ctx;

	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_HWCAPS:
		*data = hwcaps;
		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;
	default:
		return SR_ERR_ARG;
	}

	return SR_OK;
}

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

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

	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, 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, sdi);

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

static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
		void *cb_data)
{
	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 (!(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, (void *)sdi);

	return SR_OK;
}

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

	sr_dbg("la8: Stopping acquisition.");

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