[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 "protocol.h"
#include "libsigrok.h"
#include "libsigrok-internal.h"
#include <glib.h>
#include <libusb.h>
#include <stdlib.h>
#include <string.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_context *sr_ctx)
{
	return std_init(sr_ctx, di, LOG_PREFIX);
}

static GSList *gen_channel_list(int num_channels)
{
	GSList *list;
	struct sr_channel *ch;
	int i;
	char name[8];

	list = NULL;

	for (i = num_channels; i > 0; --i) {
		/* The LWLA series simply number channels from CH1 to CHxx. */
		g_snprintf(name, sizeof(name), "CH%d", i);

		ch = sr_channel_new(i - 1, SR_CHANNEL_LOGIC, TRUE, name);
		list = g_slist_prepend(list, ch);
	}

	return list;
}

static struct sr_dev_inst *dev_inst_new()
{
	struct sr_dev_inst *sdi;
	struct dev_context *devc;

	/* Allocate memory for our private driver context. */
	devc = g_try_new0(struct dev_context, 1);
	if (!devc) {
		sr_err("Device context malloc failed.");
		return NULL;
	}

	/* Register the device with libsigrok. */
	sdi = sr_dev_inst_new(SR_ST_INACTIVE,
			      VENDOR_NAME, MODEL_NAME, NULL);
	if (!sdi) {
		sr_err("Failed to instantiate device.");
		g_free(devc);
		return NULL;
	}

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

	sdi->priv = devc;
	sdi->channels = gen_channel_list(NUM_CHANNELS);

	return sdi;
}

static GSList *scan(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;
	char connection_id[64];

	drvc = di->priv;
	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;

		usb_get_port_path(libusb_get_device(usb->devhdl),
				connection_id, sizeof(connection_id));

		/* 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;
		sdi->connection_id = g_strdup(connection_id);

		/* 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(void)
{
	struct drv_context *drvc;

	drvc = di->priv;

	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(void)
{
	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->priv;

	if (!drvc) {
		sr_err("Driver was not initialized.");
		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));
		return SR_ERR;
	}

	sdi->status = SR_ST_INITIALIZING;

	ret = lwla_init_device(sdi);

	if (ret == SR_OK)
		sdi->status = SR_ST_ACTIVE;

	return ret;
}

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

	if (!di->priv) {
		sr_err("Driver was not initialized.");
		return SR_ERR;
	}

	usb = sdi->conn;
	if (!usb->devhdl)
		return SR_OK;

	sdi->status = SR_ST_INACTIVE;

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

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

	usb->devhdl = NULL;

	return SR_OK;
}

static int cleanup(void)
{
	return dev_clear();
}

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 >= G_N_ELEMENTS(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 >= G_N_ELEMENTS(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 >= G_N_ELEMENTS(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[G_N_ELEMENTS(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,
				   G_N_ELEMENTS(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,
				   G_N_ELEMENTS(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,
				   G_N_ELEMENTS(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 config_commit(const struct sr_dev_inst *sdi)
{
	if (sdi->status != SR_ST_ACTIVE) {
		sr_err("Device not ready (status %d).", (int)sdi->status);
		return SR_ERR;
	}

	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, G_N_ELEMENTS(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, G_N_ELEMENTS(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,
					   G_N_ELEMENTS(trigger_source_names));
		break;
	case SR_CONF_TRIGGER_SLOPE:
	case SR_CONF_CLOCK_EDGE:
		*data = g_variant_new_strv(signal_edge_names,
					   G_N_ELEMENTS(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->priv;

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

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

	sr_info("Starting acquisition.");

	devc->acquisition = acq;
	lwla_convert_trigger(sdi);
	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)
{
	(void)cb_data;

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

	sr_dbg("Stopping acquisition.");

	sdi->status = SR_ST_STOPPING;

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