[libsigrok.git] / src / hardware / sysclk-lwla / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2014 Daniel Elstner <daniel.kitta@gmail.com>
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#include <config.h>
#include <glib.h>
#include <libusb.h>
#include <stdlib.h>
#include <string.h>
#include <libsigrok/libsigrok.h>
#include "libsigrok-internal.h"
#include "protocol.h"

static const uint32_t scanopts[] = {
	SR_CONF_CONN,
};

static const uint32_t devopts[] = {
	SR_CONF_LOGIC_ANALYZER,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_EXTERNAL_CLOCK | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_CLOCK_EDGE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
	SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

static const int32_t trigger_matches[] = {
	SR_TRIGGER_ZERO,
	SR_TRIGGER_ONE,
	SR_TRIGGER_RISING,
	SR_TRIGGER_FALLING,
};

/* The hardware supports more samplerates than these, but these are the
 * options hardcoded into the vendor's Windows GUI.
 */
static const uint64_t samplerates[] = {
	SR_MHZ(125), SR_MHZ(100),
	SR_MHZ(50),  SR_MHZ(20),  SR_MHZ(10),
	SR_MHZ(5),   SR_MHZ(2),   SR_MHZ(1),
	SR_KHZ(500), SR_KHZ(200), SR_KHZ(100),
	SR_KHZ(50),  SR_KHZ(20),  SR_KHZ(10),
	SR_KHZ(5),   SR_KHZ(2),   SR_KHZ(1),
	SR_HZ(500),  SR_HZ(200),  SR_HZ(100),
};

/* Names assigned to available trigger sources.  Indices must match
 * trigger_source enum values.
 */
static const char *const trigger_source_names[] = { "CH", "TRG" };

/* Names assigned to available trigger slope choices.  Indices must
 * match the signal_edge enum values.
 */
static const char *const signal_edge_names[] = { "r", "f" };

SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info;
static struct sr_dev_driver *const di = &sysclk_lwla_driver_info;

static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static struct sr_dev_inst *dev_inst_new(void)
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;
	int i;
	char name[8];

	/* Allocate memory for our private driver context. */
	devc = g_malloc0(sizeof(struct dev_context));

	/* Register the device with libsigrok. */
	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->vendor = g_strdup(VENDOR_NAME);
	sdi->model = g_strdup(MODEL_NAME);

	/* Enable all channels to match the default channel configuration. */
	devc->channel_mask = ALL_CHANNELS_MASK;
	devc->samplerate = DEFAULT_SAMPLERATE;

	sdi->priv = devc;
	for (i = 0; i < NUM_CHANNELS; ++i) {
		/* The LWLA series simply number channels from CH1 to CHxx. */
		g_snprintf(name, sizeof(name), "CH%d", i + 1);
		sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, name);
	}

	return sdi;
}

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	GSList *usb_devices, *devices, *node;
	struct drv_context *drvc;
	struct sr_dev_inst *sdi;
	struct sr_usb_dev_inst *usb;
	struct sr_config *src;
	const char *conn;

	drvc = di->context;
	conn = USB_VID_PID;

	for (node = options; node != NULL; node = node->next) {
		src = node->data;
		if (src->key == SR_CONF_CONN) {
			conn = g_variant_get_string(src->data, NULL);
			break;
		}
	}
	usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	devices = NULL;

	for (node = usb_devices; node != NULL; node = node->next) {
		usb = node->data;

		/* Create sigrok device instance. */
		sdi = dev_inst_new();
		if (!sdi) {
			sr_usb_dev_inst_free(usb);
			continue;
		}
		sdi->driver = di;
		sdi->inst_type = SR_INST_USB;
		sdi->conn = usb;

		/* Register device instance with driver. */
		drvc->instances = g_slist_append(drvc->instances, sdi);
		devices = g_slist_append(devices, sdi);
	}

	g_slist_free(usb_devices);

	return devices;
}

static GSList *dev_list(const struct sr_dev_driver *di)
{
	struct drv_context *drvc;

	drvc = di->context;

	return drvc->instances;
}

static void clear_dev_context(void *priv)
{
	struct dev_context *devc;

	devc = priv;

	sr_dbg("Device context cleared.");

	lwla_free_acquisition_state(devc->acquisition);
	g_free(devc);
}

static int dev_clear(const struct sr_dev_driver *di)
{
	return std_dev_clear(di, &clear_dev_context);
}

static int dev_open(struct sr_dev_inst *sdi)
{
	struct drv_context *drvc;
	struct sr_usb_dev_inst *usb;
	int ret;

	drvc = di->context;

	if (!drvc) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}
	if (sdi->status != SR_ST_INACTIVE) {
		sr_err("Device already open.");
		return SR_ERR;
	}
	usb = sdi->conn;

	ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
	if (ret != SR_OK)
		return ret;

	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	if (ret < 0) {
		sr_err("Failed to claim interface: %s.",
			libusb_error_name(ret));
		sr_usb_close(usb);
		return SR_ERR;
	}
	sdi->status = SR_ST_ACTIVE;

	ret = lwla_init_device(sdi);
	if (ret != SR_OK) {
		sr_usb_close(usb);
		sdi->status = SR_ST_INACTIVE;
	}
	return ret;
}

static int dev_close(struct sr_dev_inst *sdi)
{
	struct sr_usb_dev_inst *usb;
	struct dev_context *devc;
	int ret;

	if (!di->context) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}
	usb = sdi->conn;
	devc = sdi->priv;

	if (sdi->status == SR_ST_INACTIVE)
		return SR_OK;

	if (devc && devc->acquisition) {
		sr_err("Attempt to close device during acquisition.");
		return SR_ERR;
	}
	sdi->status = SR_ST_INACTIVE;

	/* Trigger download of the shutdown bitstream. */
	ret = lwla_set_clock_config(sdi);
	if (ret != SR_OK)
		sr_err("Unable to shut down device.");

	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	sr_usb_close(usb);

	return ret;
}

static int cleanup(const struct sr_dev_driver *di)
{
	return dev_clear(di);
}

static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
		      const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	size_t idx;

	(void)cg;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(devc->samplerate);
		break;
	case SR_CONF_LIMIT_MSEC:
		*data = g_variant_new_uint64(devc->limit_msec);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_EXTERNAL_CLOCK:
		*data = g_variant_new_boolean(devc->cfg_clock_source
						== CLOCK_EXT_CLK);
		break;
	case SR_CONF_CLOCK_EDGE:
		idx = devc->cfg_clock_edge;
		if (idx >= ARRAY_SIZE(signal_edge_names))
			return SR_ERR_BUG;
		*data = g_variant_new_string(signal_edge_names[idx]);
		break;
	case SR_CONF_TRIGGER_SOURCE:
		idx = devc->cfg_trigger_source;
		if (idx >= ARRAY_SIZE(trigger_source_names))
			return SR_ERR_BUG;
		*data = g_variant_new_string(trigger_source_names[idx]);
		break;
	case SR_CONF_TRIGGER_SLOPE:
		idx = devc->cfg_trigger_slope;
		if (idx >= ARRAY_SIZE(signal_edge_names))
			return SR_ERR_BUG;
		*data = g_variant_new_string(signal_edge_names[idx]);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

/* Helper for mapping a string-typed configuration value to an index
 * within a table of possible values.
 */
static int lookup_index(GVariant *value, const char *const *table, int len)
{
	const char *entry;
	int i;

	entry = g_variant_get_string(value, NULL);
	if (!entry)
		return -1;

	/* Linear search is fine for very small tables. */
	for (i = 0; i < len; ++i) {
		if (strcmp(entry, table[i]) == 0)
			return i;
	}
	return -1;
}

static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
		      const struct sr_channel_group *cg)
{
	uint64_t value;
	struct dev_context *devc;
	int idx;

	(void)cg;

	devc = sdi->priv;
	if (!devc)
		return SR_ERR_DEV_CLOSED;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		value = g_variant_get_uint64(data);
		if (value < samplerates[ARRAY_SIZE(samplerates) - 1]
				|| value > samplerates[0])
			return SR_ERR_SAMPLERATE;
		devc->samplerate = value;
		break;
	case SR_CONF_LIMIT_MSEC:
		value = g_variant_get_uint64(data);
		if (value > MAX_LIMIT_MSEC)
			return SR_ERR_ARG;
		devc->limit_msec = value;
		break;
	case SR_CONF_LIMIT_SAMPLES:
		value = g_variant_get_uint64(data);
		if (value > MAX_LIMIT_SAMPLES)
			return SR_ERR_ARG;
		devc->limit_samples = value;
		break;
	case SR_CONF_EXTERNAL_CLOCK:
		devc->cfg_clock_source = (g_variant_get_boolean(data))
			? CLOCK_EXT_CLK : CLOCK_INTERNAL;
		break;
	case SR_CONF_CLOCK_EDGE:
		idx = lookup_index(data, signal_edge_names,
				   ARRAY_SIZE(signal_edge_names));
		if (idx < 0)
			return SR_ERR_ARG;
		devc->cfg_clock_edge = idx;
		break;
	case SR_CONF_TRIGGER_SOURCE:
		idx = lookup_index(data, trigger_source_names,
				   ARRAY_SIZE(trigger_source_names));
		if (idx < 0)
			return SR_ERR_ARG;
		devc->cfg_trigger_source = idx;
		break;
	case SR_CONF_TRIGGER_SLOPE:
		idx = lookup_index(data, signal_edge_names,
				   ARRAY_SIZE(signal_edge_names));
		if (idx < 0)
			return SR_ERR_ARG;
		devc->cfg_trigger_slope = idx;
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_channel_set(const struct sr_dev_inst *sdi,
		struct sr_channel *ch, unsigned int changes)
{
	uint64_t channel_bit;
	struct dev_context *devc;

	devc = sdi->priv;
	if (!devc)
		return SR_ERR_DEV_CLOSED;

	if (ch->index < 0 || ch->index >= NUM_CHANNELS) {
		sr_err("Channel index %d out of range.", ch->index);
		return SR_ERR_BUG;
	}
	channel_bit = (uint64_t)1 << ch->index;

	if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
		/* Enable or disable input channel for this channel. */
		if (ch->enabled)
			devc->channel_mask |= channel_bit;
		else
			devc->channel_mask &= ~channel_bit;
	}

	return SR_OK;
}

static int prepare_trigger_masks(const struct sr_dev_inst *sdi)
{
	uint64_t trigger_mask;
	uint64_t trigger_values;
	uint64_t trigger_edge_mask;
	uint64_t channel_bit;
	struct dev_context *devc;
	struct sr_trigger *trigger;
	struct sr_trigger_stage *stage;
	struct sr_trigger_match *match;
	const GSList *node;

	devc = sdi->priv;

	trigger = sr_session_trigger_get(sdi->session);
	if (!trigger || !trigger->stages)
		return SR_OK;

	if (trigger->stages->next) {
		sr_err("This device only supports 1 trigger stage.");
		return SR_ERR_ARG;
	}
	stage = trigger->stages->data;

	trigger_mask = 0;
	trigger_values = 0;
	trigger_edge_mask = 0;

	for (node = stage->matches; node; node = node->next) {
		match = node->data;

		if (!match->channel->enabled)
			continue; /* ignore disabled channel */

		channel_bit = (uint64_t)1 << match->channel->index;
		trigger_mask |= channel_bit;

		switch (match->match) {
		case SR_TRIGGER_ZERO:
			break;
		case SR_TRIGGER_ONE:
			trigger_values |= channel_bit;
			break;
		case SR_TRIGGER_RISING:
			trigger_values |= channel_bit;
			/* Fall through for edge mask. */
		case SR_TRIGGER_FALLING:
			trigger_edge_mask |= channel_bit;
			break;
		default:
			sr_err("Unsupported trigger match for CH%d.",
				match->channel->index + 1);
			return SR_ERR_ARG;
		}
	}
	devc->trigger_mask = trigger_mask;
	devc->trigger_values = trigger_values;
	devc->trigger_edge_mask = trigger_edge_mask;

	return SR_OK;
}

static int config_commit(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	int rc;

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

	devc = sdi->priv;
	if (devc->acquisition) {
		sr_err("Acquisition still in progress?");
		return SR_ERR;
	}
	rc = prepare_trigger_masks(sdi);
	if (rc != SR_OK)
		return rc;

	return lwla_set_clock_config(sdi);
}

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

	(void)sdi;
	(void)cg;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
				devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
		break;
	case SR_CONF_SAMPLERATE:
		g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
		gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
				samplerates, ARRAY_SIZE(samplerates),
				sizeof(uint64_t));
		g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
		*data = g_variant_builder_end(&gvb);
		break;
	case SR_CONF_TRIGGER_MATCH:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				trigger_matches, ARRAY_SIZE(trigger_matches),
				sizeof(int32_t));
		break;
	case SR_CONF_TRIGGER_SOURCE:
		*data = g_variant_new_strv(trigger_source_names,
					   ARRAY_SIZE(trigger_source_names));
		break;
	case SR_CONF_TRIGGER_SLOPE:
	case SR_CONF_CLOCK_EDGE:
		*data = g_variant_new_strv(signal_edge_names,
					   ARRAY_SIZE(signal_edge_names));
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
{
	struct drv_context *drvc;
	struct dev_context *devc;
	struct acquisition_state *acq;
	int ret;

	(void)cb_data;

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

	devc = sdi->priv;
	drvc = di->context;

	if (devc->acquisition) {
		sr_err("Acquisition still in progress?");
		return SR_ERR;
	}
	acq = lwla_alloc_acquisition_state();
	if (!acq)
		return SR_ERR_MALLOC;

	devc->cancel_requested = FALSE;
	devc->stopping_in_progress = FALSE;
	devc->transfer_error = FALSE;

	sr_info("Starting acquisition.");

	devc->acquisition = acq;
	ret = lwla_setup_acquisition(sdi);
	if (ret != SR_OK) {
		sr_err("Failed to set up acquisition.");
		devc->acquisition = NULL;
		lwla_free_acquisition_state(acq);
		return ret;
	}

	ret = lwla_start_acquisition(sdi);
	if (ret != SR_OK) {
		sr_err("Failed to start acquisition.");
		devc->acquisition = NULL;
		lwla_free_acquisition_state(acq);
		return ret;
	}
	usb_source_add(sdi->session, drvc->sr_ctx, 100, &lwla_receive_data,
		       (struct sr_dev_inst *)sdi);

	sr_info("Waiting for data.");

	/* Send header packet to the session bus. */
	std_session_send_df_header(sdi, LOG_PREFIX);

	return SR_OK;
}

static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
{
	struct dev_context *devc;

	(void)cb_data;
	devc = sdi->priv;

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

	if (devc->acquisition && !devc->cancel_requested) {
		devc->cancel_requested = TRUE;
		sr_dbg("Stopping acquisition.");
	}
	return SR_OK;
}

SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info = {
	.name = "sysclk-lwla",
	.longname = "SysClk LWLA series",
	.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_channel_set = config_channel_set,
	.config_commit = config_commit,
	.config_list = config_list,
	.dev_open = dev_open,
	.dev_close = dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
Commit	Line	Data
aeaad0b0 DE	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2014 Daniel Elstner <daniel.kitta@gmail.com>
	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 3 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, see <http://www.gnu.org/licenses/>.
	18	*/
	19
6ec6c43b	20	#include <config.h>
5874e88d DE	21	#include <glib.h>
	22	#include <libusb.h>
	23	#include <stdlib.h>
	24	#include <string.h>
c1aae900	25	#include <libsigrok/libsigrok.h>
515ab088 UH	26	#include "libsigrok-internal.h"
515ab088 UH	27	#include "protocol.h"
5874e88d	28
a0e0bb41	29	static const uint32_t scanopts[] = {
99c76642 DE	30	SR_CONF_CONN,
	31	};
	32
f254bc4b	33	static const uint32_t devopts[] = {
5874e88d	34	SR_CONF_LOGIC_ANALYZER,
5827f61b BV	35	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	36	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
	37	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	38	SR_CONF_EXTERNAL_CLOCK \| SR_CONF_GET \| SR_CONF_SET,
	39	SR_CONF_CLOCK_EDGE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	40	SR_CONF_TRIGGER_MATCH \| SR_CONF_LIST,
	41	SR_CONF_TRIGGER_SOURCE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	42	SR_CONF_TRIGGER_SLOPE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
5874e88d DE	43	};
5874e88d DE	44
bbe7e48a BV	45	static const int32_t trigger_matches[] = {
	46	SR_TRIGGER_ZERO,
	47	SR_TRIGGER_ONE,
	48	SR_TRIGGER_RISING,
	49	SR_TRIGGER_FALLING,
	50	};
	51
5874e88d DE	52	/* The hardware supports more samplerates than these, but these are the
	53	* options hardcoded into the vendor's Windows GUI.
	54	*/
	55	static const uint64_t samplerates[] = {
	56	SR_MHZ(125), SR_MHZ(100),
	57	SR_MHZ(50), SR_MHZ(20), SR_MHZ(10),
	58	SR_MHZ(5), SR_MHZ(2), SR_MHZ(1),
	59	SR_KHZ(500), SR_KHZ(200), SR_KHZ(100),
	60	SR_KHZ(50), SR_KHZ(20), SR_KHZ(10),
	61	SR_KHZ(5), SR_KHZ(2), SR_KHZ(1),
	62	SR_HZ(500), SR_HZ(200), SR_HZ(100),
	63	};
aeaad0b0	64
e6e54bd2 DE	65	/* Names assigned to available trigger sources. Indices must match
	66	* trigger_source enum values.
	67	*/
	68	static const char *const trigger_source_names[] = { "CH", "TRG" };
	69
	70	/* Names assigned to available trigger slope choices. Indices must
6358f0a9	71	* match the signal_edge enum values.
e6e54bd2	72	*/
6358f0a9	73	static const char *const signal_edge_names[] = { "r", "f" };
e6e54bd2	74
aeaad0b0	75	SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info;
5874e88d	76	static struct sr_dev_driver *const di = &sysclk_lwla_driver_info;
aeaad0b0	77
4f840ce9	78	static int init(struct sr_dev_driver di, struct sr_context sr_ctx)
aeaad0b0 DE	79	{
	80	return std_init(sr_ctx, di, LOG_PREFIX);
	81	}
	82
0af636be	83	static struct sr_dev_inst *dev_inst_new(void)
43db3436 DE	84	{
	85	struct sr_dev_inst *sdi;
	86	struct dev_context *devc;
5e23fcab ML	87	int i;
5e23fcab ML	88	char name[8];
43db3436 DE	89
43db3436 DE	90	/* Allocate memory for our private driver context. */
f57d8ffe	91	devc = g_malloc0(sizeof(struct dev_context));
43db3436 DE	92
43db3436 DE	93	/* Register the device with libsigrok. */
aac29cc1	94	sdi = g_malloc0(sizeof(struct sr_dev_inst));
0af636be UH	95	sdi->status = SR_ST_INACTIVE;
	96	sdi->vendor = g_strdup(VENDOR_NAME);
	97	sdi->model = g_strdup(MODEL_NAME);
43db3436	98
ba7dd8bb	99	/* Enable all channels to match the default channel configuration. */
43db3436 DE	100	devc->channel_mask = ALL_CHANNELS_MASK;
	101	devc->samplerate = DEFAULT_SAMPLERATE;
	102
	103	sdi->priv = devc;
fe473123	104	for (i = 0; i < NUM_CHANNELS; ++i) {
5e23fcab	105	/* The LWLA series simply number channels from CH1 to CHxx. */
fe473123 DE	106	g_snprintf(name, sizeof(name), "CH%d", i + 1);
fe473123 DE	107	sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, name);
5e23fcab	108	}
43db3436 DE	109
	110	return sdi;
	111	}
	112
4f840ce9	113	static GSList scan(struct sr_dev_driver di, GSList *options)
aeaad0b0	114	{
5874e88d	115	GSList usb_devices, devices, *node;
aeaad0b0	116	struct drv_context *drvc;
5874e88d	117	struct sr_dev_inst *sdi;
5874e88d	118	struct sr_usb_dev_inst *usb;
7ebe9b9e DE	119	struct sr_config *src;
7ebe9b9e DE	120	const char *conn;
aeaad0b0	121
41812aca	122	drvc = di->context;
7ebe9b9e	123	conn = USB_VID_PID;
5874e88d	124
7ebe9b9e DE	125	for (node = options; node != NULL; node = node->next) {
	126	src = node->data;
	127	if (src->key == SR_CONF_CONN) {
	128	conn = g_variant_get_string(src->data, NULL);
	129	break;
	130	}
	131	}
	132	usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	133	devices = NULL;
5874e88d DE	134
	135	for (node = usb_devices; node != NULL; node = node->next) {
	136	usb = node->data;
	137
43db3436	138	/* Create sigrok device instance. */
c79d4444	139	sdi = dev_inst_new();
5874e88d	140	if (!sdi) {
5874e88d DE	141	sr_usb_dev_inst_free(usb);
	142	continue;
	143	}
	144	sdi->driver = di;
5874e88d DE	145	sdi->inst_type = SR_INST_USB;
5874e88d DE	146	sdi->conn = usb;
5874e88d	147
43db3436	148	/* Register device instance with driver. */
5874e88d DE	149	drvc->instances = g_slist_append(drvc->instances, sdi);
	150	devices = g_slist_append(devices, sdi);
	151	}
aeaad0b0	152
5874e88d	153	g_slist_free(usb_devices);
aeaad0b0 DE	154
	155	return devices;
	156	}
	157
4f840ce9	158	static GSList dev_list(const struct sr_dev_driver di)
aeaad0b0	159	{
5874e88d DE	160	struct drv_context *drvc;
5874e88d DE	161
41812aca	162	drvc = di->context;
5874e88d DE	163
	164	return drvc->instances;
	165	}
	166
	167	static void clear_dev_context(void *priv)
	168	{
	169	struct dev_context *devc;
	170
	171	devc = priv;
	172
	173	sr_dbg("Device context cleared.");
	174
	175	lwla_free_acquisition_state(devc->acquisition);
	176	g_free(devc);
aeaad0b0 DE	177	}
aeaad0b0 DE	178
4f840ce9	179	static int dev_clear(const struct sr_dev_driver *di)
aeaad0b0	180	{
5874e88d	181	return std_dev_clear(di, &clear_dev_context);
aeaad0b0 DE	182	}
	183
	184	static int dev_open(struct sr_dev_inst *sdi)
	185	{
5874e88d	186	struct drv_context *drvc;
5874e88d DE	187	struct sr_usb_dev_inst *usb;
5874e88d DE	188	int ret;
aeaad0b0	189
41812aca	190	drvc = di->context;
aeaad0b0	191
5874e88d DE	192	if (!drvc) {
	193	sr_err("Driver was not initialized.");
	194	return SR_ERR;
	195	}
c81069b3 DE	196	if (sdi->status != SR_ST_INACTIVE) {
	197	sr_err("Device already open.");
	198	return SR_ERR;
	199	}
43db3436	200	usb = sdi->conn;
5874e88d DE	201
	202	ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
	203	if (ret != SR_OK)
	204	return ret;
	205
	206	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	207	if (ret < 0) {
	208	sr_err("Failed to claim interface: %s.",
	209	libusb_error_name(ret));
c81069b3	210	sr_usb_close(usb);
5874e88d DE	211	return SR_ERR;
5874e88d DE	212	}
c81069b3	213	sdi->status = SR_ST_ACTIVE;
5874e88d	214
5874e88d	215	ret = lwla_init_device(sdi);
c81069b3 DE	216	if (ret != SR_OK) {
	217	sr_usb_close(usb);
	218	sdi->status = SR_ST_INACTIVE;
	219	}
5874e88d	220	return ret;
aeaad0b0 DE	221	}
	222
	223	static int dev_close(struct sr_dev_inst *sdi)
	224	{
5874e88d	225	struct sr_usb_dev_inst *usb;
c81069b3 DE	226	struct dev_context *devc;
c81069b3 DE	227	int ret;
5874e88d	228
41812aca	229	if (!di->context) {
5874e88d DE	230	sr_err("Driver was not initialized.");
	231	return SR_ERR;
	232	}
6358f0a9	233	usb = sdi->conn;
c81069b3 DE	234	devc = sdi->priv;
	235
	236	if (sdi->status == SR_ST_INACTIVE)
5874e88d	237	return SR_OK;
aeaad0b0	238
c81069b3 DE	239	if (devc && devc->acquisition) {
	240	sr_err("Attempt to close device during acquisition.");
	241	return SR_ERR;
	242	}
6358f0a9	243	sdi->status = SR_ST_INACTIVE;
5874e88d	244
6358f0a9	245	/* Trigger download of the shutdown bitstream. */
c81069b3 DE	246	ret = lwla_set_clock_config(sdi);
c81069b3 DE	247	if (ret != SR_OK)
5874e88d DE	248	sr_err("Unable to shut down device.");
	249
	250	libusb_release_interface(usb->devhdl, USB_INTERFACE);
c81069b3	251	sr_usb_close(usb);
5874e88d	252
c81069b3	253	return ret;
aeaad0b0 DE	254	}
aeaad0b0 DE	255
4f840ce9	256	static int cleanup(const struct sr_dev_driver *di)
aeaad0b0	257	{
4f840ce9	258	return dev_clear(di);
aeaad0b0 DE	259	}
aeaad0b0 DE	260
584560f1	261	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	262	const struct sr_channel_group *cg)
aeaad0b0	263	{
5874e88d	264	struct dev_context *devc;
e6e54bd2	265	size_t idx;
aeaad0b0	266
53b4680f	267	(void)cg;
aeaad0b0	268
5874e88d DE	269	if (!sdi)
	270	return SR_ERR_ARG;
	271
	272	devc = sdi->priv;
	273
aeaad0b0	274	switch (key) {
5874e88d DE	275	case SR_CONF_SAMPLERATE:
	276	*data = g_variant_new_uint64(devc->samplerate);
	277	break;
29d58767 DE	278	case SR_CONF_LIMIT_MSEC:
	279	*data = g_variant_new_uint64(devc->limit_msec);
	280	break;
5874e88d DE	281	case SR_CONF_LIMIT_SAMPLES:
	282	*data = g_variant_new_uint64(devc->limit_samples);
	283	break;
	284	case SR_CONF_EXTERNAL_CLOCK:
6358f0a9 DE	285	*data = g_variant_new_boolean(devc->cfg_clock_source
	286	== CLOCK_EXT_CLK);
	287	break;
	288	case SR_CONF_CLOCK_EDGE:
	289	idx = devc->cfg_clock_edge;
ce3ecb70	290	if (idx >= ARRAY_SIZE(signal_edge_names))
6358f0a9 DE	291	return SR_ERR_BUG;
6358f0a9 DE	292	*data = g_variant_new_string(signal_edge_names[idx]);
5874e88d	293	break;
e6e54bd2 DE	294	case SR_CONF_TRIGGER_SOURCE:
e6e54bd2 DE	295	idx = devc->cfg_trigger_source;
ce3ecb70	296	if (idx >= ARRAY_SIZE(trigger_source_names))
e6e54bd2 DE	297	return SR_ERR_BUG;
	298	*data = g_variant_new_string(trigger_source_names[idx]);
	299	break;
	300	case SR_CONF_TRIGGER_SLOPE:
	301	idx = devc->cfg_trigger_slope;
ce3ecb70	302	if (idx >= ARRAY_SIZE(signal_edge_names))
e6e54bd2	303	return SR_ERR_BUG;
6358f0a9	304	*data = g_variant_new_string(signal_edge_names[idx]);
e6e54bd2	305	break;
aeaad0b0 DE	306	default:
	307	return SR_ERR_NA;
	308	}
	309
5874e88d	310	return SR_OK;
aeaad0b0 DE	311	}
aeaad0b0 DE	312
e6e54bd2 DE	313	/* Helper for mapping a string-typed configuration value to an index
	314	* within a table of possible values.
	315	*/
	316	static int lookup_index(GVariant value, const char const *table, int len)
	317	{
	318	const char *entry;
	319	int i;
	320
	321	entry = g_variant_get_string(value, NULL);
	322	if (!entry)
	323	return -1;
	324
	325	/* Linear search is fine for very small tables. */
	326	for (i = 0; i < len; ++i) {
	327	if (strcmp(entry, table[i]) == 0)
	328	return i;
	329	}
	330	return -1;
	331	}
	332
584560f1	333	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	334	const struct sr_channel_group *cg)
aeaad0b0	335	{
29d58767	336	uint64_t value;
5874e88d	337	struct dev_context *devc;
e6e54bd2	338	int idx;
aeaad0b0	339
53b4680f	340	(void)cg;
aeaad0b0	341
5874e88d DE	342	devc = sdi->priv;
5874e88d DE	343	if (!devc)
aeaad0b0 DE	344	return SR_ERR_DEV_CLOSED;
aeaad0b0 DE	345
aeaad0b0	346	switch (key) {
5874e88d	347	case SR_CONF_SAMPLERATE:
29d58767	348	value = g_variant_get_uint64(data);
ce3ecb70	349	if (value < samplerates[ARRAY_SIZE(samplerates) - 1]
29d58767	350	\|\| value > samplerates[0])
5874e88d	351	return SR_ERR_SAMPLERATE;
29d58767 DE	352	devc->samplerate = value;
	353	break;
	354	case SR_CONF_LIMIT_MSEC:
	355	value = g_variant_get_uint64(data);
	356	if (value > MAX_LIMIT_MSEC)
	357	return SR_ERR_ARG;
	358	devc->limit_msec = value;
5874e88d DE	359	break;
5874e88d DE	360	case SR_CONF_LIMIT_SAMPLES:
29d58767 DE	361	value = g_variant_get_uint64(data);
	362	if (value > MAX_LIMIT_SAMPLES)
	363	return SR_ERR_ARG;
	364	devc->limit_samples = value;
5874e88d DE	365	break;
5874e88d DE	366	case SR_CONF_EXTERNAL_CLOCK:
6358f0a9 DE	367	devc->cfg_clock_source = (g_variant_get_boolean(data))
	368	? CLOCK_EXT_CLK : CLOCK_INTERNAL;
	369	break;
	370	case SR_CONF_CLOCK_EDGE:
	371	idx = lookup_index(data, signal_edge_names,
ce3ecb70	372	ARRAY_SIZE(signal_edge_names));
6358f0a9 DE	373	if (idx < 0)
	374	return SR_ERR_ARG;
	375	devc->cfg_clock_edge = idx;
5874e88d	376	break;
e6e54bd2 DE	377	case SR_CONF_TRIGGER_SOURCE:
e6e54bd2 DE	378	idx = lookup_index(data, trigger_source_names,
ce3ecb70	379	ARRAY_SIZE(trigger_source_names));
e6e54bd2 DE	380	if (idx < 0)
	381	return SR_ERR_ARG;
	382	devc->cfg_trigger_source = idx;
	383	break;
	384	case SR_CONF_TRIGGER_SLOPE:
6358f0a9	385	idx = lookup_index(data, signal_edge_names,
ce3ecb70	386	ARRAY_SIZE(signal_edge_names));
e6e54bd2 DE	387	if (idx < 0)
	388	return SR_ERR_ARG;
	389	devc->cfg_trigger_slope = idx;
	390	break;
aeaad0b0	391	default:
5874e88d	392	return SR_ERR_NA;
aeaad0b0 DE	393	}
aeaad0b0 DE	394
5874e88d	395	return SR_OK;
aeaad0b0 DE	396	}
aeaad0b0 DE	397
f3ca73ed	398	static int config_channel_set(const struct sr_dev_inst *sdi,
bbe7e48a	399	struct sr_channel *ch, unsigned int changes)
43db3436	400	{
ba7dd8bb	401	uint64_t channel_bit;
43db3436 DE	402	struct dev_context *devc;
	403
	404	devc = sdi->priv;
	405	if (!devc)
	406	return SR_ERR_DEV_CLOSED;
	407
3f239f08	408	if (ch->index < 0 \|\| ch->index >= NUM_CHANNELS) {
ba7dd8bb	409	sr_err("Channel index %d out of range.", ch->index);
43db3436 DE	410	return SR_ERR_BUG;
43db3436 DE	411	}
ba7dd8bb	412	channel_bit = (uint64_t)1 << ch->index;
43db3436	413
3f239f08	414	if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
ba7dd8bb UH	415	/* Enable or disable input channel for this channel. */
	416	if (ch->enabled)
	417	devc->channel_mask \|= channel_bit;
43db3436	418	else
ba7dd8bb	419	devc->channel_mask &= ~channel_bit;
43db3436 DE	420	}
43db3436 DE	421
43db3436 DE	422	return SR_OK;
	423	}
	424
225d3cb0 DE	425	static int prepare_trigger_masks(const struct sr_dev_inst *sdi)
	426	{
	427	uint64_t trigger_mask;
	428	uint64_t trigger_values;
	429	uint64_t trigger_edge_mask;
	430	uint64_t channel_bit;
	431	struct dev_context *devc;
	432	struct sr_trigger *trigger;
	433	struct sr_trigger_stage *stage;
	434	struct sr_trigger_match *match;
	435	const GSList *node;
	436
	437	devc = sdi->priv;
	438
	439	trigger = sr_session_trigger_get(sdi->session);
	440	if (!trigger \|\| !trigger->stages)
	441	return SR_OK;
	442
	443	if (trigger->stages->next) {
	444	sr_err("This device only supports 1 trigger stage.");
	445	return SR_ERR_ARG;
	446	}
	447	stage = trigger->stages->data;
	448
	449	trigger_mask = 0;
	450	trigger_values = 0;
	451	trigger_edge_mask = 0;
	452
	453	for (node = stage->matches; node; node = node->next) {
	454	match = node->data;
	455
	456	if (!match->channel->enabled)
	457	continue; /* ignore disabled channel */
	458
	459	channel_bit = (uint64_t)1 << match->channel->index;
	460	trigger_mask \|= channel_bit;
	461
	462	switch (match->match) {
	463	case SR_TRIGGER_ZERO:
	464	break;
	465	case SR_TRIGGER_ONE:
	466	trigger_values \|= channel_bit;
	467	break;
	468	case SR_TRIGGER_RISING:
	469	trigger_values \|= channel_bit;
	470	/* Fall through for edge mask. */
	471	case SR_TRIGGER_FALLING:
	472	trigger_edge_mask \|= channel_bit;
	473	break;
	474	default:
	475	sr_err("Unsupported trigger match for CH%d.",
	476	match->channel->index + 1);
	477	return SR_ERR_ARG;
	478	}
	479	}
	480	devc->trigger_mask = trigger_mask;
	481	devc->trigger_values = trigger_values;
	482	devc->trigger_edge_mask = trigger_edge_mask;
	483
	484	return SR_OK;
	485	}
	486
ee38c8ba DE	487	static int config_commit(const struct sr_dev_inst *sdi)
ee38c8ba DE	488	{
225d3cb0 DE	489	struct dev_context *devc;
	490	int rc;
	491
	492	if (sdi->status != SR_ST_ACTIVE)
	493	return SR_ERR_DEV_CLOSED;
	494
	495	devc = sdi->priv;
	496	if (devc->acquisition) {
	497	sr_err("Acquisition still in progress?");
ee38c8ba DE	498	return SR_ERR;
ee38c8ba DE	499	}
225d3cb0 DE	500	rc = prepare_trigger_masks(sdi);
	501	if (rc != SR_OK)
	502	return rc;
ee38c8ba	503
6358f0a9	504	return lwla_set_clock_config(sdi);
ee38c8ba DE	505	}
ee38c8ba DE	506
584560f1	507	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	508	const struct sr_channel_group *cg)
aeaad0b0	509	{
5874e88d DE	510	GVariant *gvar;
5874e88d DE	511	GVariantBuilder gvb;
aeaad0b0 DE	512
aeaad0b0 DE	513	(void)sdi;
53b4680f	514	(void)cg;
aeaad0b0	515
aeaad0b0	516	switch (key) {
99c76642	517	case SR_CONF_SCAN_OPTIONS:
584560f1	518	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	519	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
99c76642	520	break;
5874e88d	521	case SR_CONF_DEVICE_OPTIONS:
584560f1	522	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
ce3ecb70	523	devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
5874e88d DE	524	break;
	525	case SR_CONF_SAMPLERATE:
	526	g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
	527	gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
ce3ecb70	528	samplerates, ARRAY_SIZE(samplerates),
5874e88d DE	529	sizeof(uint64_t));
	530	g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
	531	*data = g_variant_builder_end(&gvb);
	532	break;
bbe7e48a BV	533	case SR_CONF_TRIGGER_MATCH:
	534	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	535	trigger_matches, ARRAY_SIZE(trigger_matches),
	536	sizeof(int32_t));
5874e88d	537	break;
e6e54bd2 DE	538	case SR_CONF_TRIGGER_SOURCE:
e6e54bd2 DE	539	*data = g_variant_new_strv(trigger_source_names,
ce3ecb70	540	ARRAY_SIZE(trigger_source_names));
e6e54bd2 DE	541	break;
e6e54bd2 DE	542	case SR_CONF_TRIGGER_SLOPE:
6358f0a9 DE	543	case SR_CONF_CLOCK_EDGE:
6358f0a9 DE	544	*data = g_variant_new_strv(signal_edge_names,
ce3ecb70	545	ARRAY_SIZE(signal_edge_names));
e6e54bd2	546	break;
aeaad0b0 DE	547	default:
	548	return SR_ERR_NA;
	549	}
	550
5874e88d	551	return SR_OK;
aeaad0b0 DE	552	}
aeaad0b0 DE	553
5874e88d DE	554	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	555	{
	556	struct drv_context *drvc;
	557	struct dev_context *devc;
	558	struct acquisition_state *acq;
	559	int ret;
	560
aeaad0b0 DE	561	(void)cb_data;
	562
	563	if (sdi->status != SR_ST_ACTIVE)
	564	return SR_ERR_DEV_CLOSED;
	565
5874e88d	566	devc = sdi->priv;
41812aca	567	drvc = di->context;
5874e88d DE	568
	569	if (devc->acquisition) {
	570	sr_err("Acquisition still in progress?");
	571	return SR_ERR;
	572	}
	573	acq = lwla_alloc_acquisition_state();
	574	if (!acq)
	575	return SR_ERR_MALLOC;
	576
c81069b3	577	devc->cancel_requested = FALSE;
5874e88d DE	578	devc->stopping_in_progress = FALSE;
	579	devc->transfer_error = FALSE;
	580
5874e88d DE	581	sr_info("Starting acquisition.");
	582
	583	devc->acquisition = acq;
	584	ret = lwla_setup_acquisition(sdi);
	585	if (ret != SR_OK) {
a84f6ad3	586	sr_err("Failed to set up acquisition.");
5874e88d DE	587	devc->acquisition = NULL;
	588	lwla_free_acquisition_state(acq);
	589	return ret;
	590	}
	591
	592	ret = lwla_start_acquisition(sdi);
	593	if (ret != SR_OK) {
a84f6ad3	594	sr_err("Failed to start acquisition.");
5874e88d DE	595	devc->acquisition = NULL;
	596	lwla_free_acquisition_state(acq);
	597	return ret;
	598	}
102f1239	599	usb_source_add(sdi->session, drvc->sr_ctx, 100, &lwla_receive_data,
5874e88d DE	600	(struct sr_dev_inst *)sdi);
	601
	602	sr_info("Waiting for data.");
	603
	604	/* Send header packet to the session bus. */
	605	std_session_send_df_header(sdi, LOG_PREFIX);
aeaad0b0 DE	606
	607	return SR_OK;
	608	}
	609
	610	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	611	{
c81069b3 DE	612	struct dev_context *devc;
c81069b3 DE	613
aeaad0b0	614	(void)cb_data;
c81069b3	615	devc = sdi->priv;
aeaad0b0 DE	616
	617	if (sdi->status != SR_ST_ACTIVE)
	618	return SR_ERR_DEV_CLOSED;
	619
c81069b3 DE	620	if (devc->acquisition && !devc->cancel_requested) {
	621	devc->cancel_requested = TRUE;
	622	sr_dbg("Stopping acquisition.");
	623	}
aeaad0b0 DE	624	return SR_OK;
	625	}
	626
	627	SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info = {
	628	.name = "sysclk-lwla",
5874e88d	629	.longname = "SysClk LWLA series",
aeaad0b0 DE	630	.api_version = 1,
	631	.init = init,
	632	.cleanup = cleanup,
	633	.scan = scan,
	634	.dev_list = dev_list,
	635	.dev_clear = dev_clear,
	636	.config_get = config_get,
	637	.config_set = config_set,
f3ca73ed	638	.config_channel_set = config_channel_set,
ee38c8ba	639	.config_commit = config_commit,
aeaad0b0 DE	640	.config_list = config_list,
	641	.dev_open = dev_open,
	642	.dev_close = dev_close,
	643	.dev_acquisition_start = dev_acquisition_start,
	644	.dev_acquisition_stop = dev_acquisition_stop,
41812aca	645	.context = NULL,
aeaad0b0	646	};