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

	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;

		/* 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(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;
aeaad0b0	141
aeaad0b0	142	drvc = di->priv;
7ebe9b9e	143	conn = USB_VID_PID;
5874e88d	144
7ebe9b9e DE	145	for (node = options; node != NULL; node = node->next) {
	146	src = node->data;
	147	if (src->key == SR_CONF_CONN) {
	148	conn = g_variant_get_string(src->data, NULL);
	149	break;
	150	}
	151	}
	152	usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	153	devices = NULL;
5874e88d DE	154
	155	for (node = usb_devices; node != NULL; node = node->next) {
	156	usb = node->data;
	157
43db3436	158	/* Create sigrok device instance. */
c79d4444	159	sdi = dev_inst_new();
5874e88d	160	if (!sdi) {
5874e88d DE	161	sr_usb_dev_inst_free(usb);
	162	continue;
	163	}
	164	sdi->driver = di;
5874e88d DE	165	sdi->inst_type = SR_INST_USB;
5874e88d DE	166	sdi->conn = usb;
5874e88d	167
43db3436	168	/* Register device instance with driver. */
5874e88d DE	169	drvc->instances = g_slist_append(drvc->instances, sdi);
	170	devices = g_slist_append(devices, sdi);
	171	}
aeaad0b0	172
5874e88d	173	g_slist_free(usb_devices);
aeaad0b0 DE	174
	175	return devices;
	176	}
	177
	178	static GSList *dev_list(void)
	179	{
5874e88d DE	180	struct drv_context *drvc;
	181
	182	drvc = di->priv;
	183
	184	return drvc->instances;
	185	}
	186
	187	static void clear_dev_context(void *priv)
	188	{
	189	struct dev_context *devc;
	190
	191	devc = priv;
	192
	193	sr_dbg("Device context cleared.");
	194
	195	lwla_free_acquisition_state(devc->acquisition);
	196	g_free(devc);
aeaad0b0 DE	197	}
	198
	199	static int dev_clear(void)
	200	{
5874e88d	201	return std_dev_clear(di, &clear_dev_context);
aeaad0b0 DE	202	}
	203
	204	static int dev_open(struct sr_dev_inst *sdi)
	205	{
5874e88d	206	struct drv_context *drvc;
5874e88d DE	207	struct sr_usb_dev_inst *usb;
5874e88d DE	208	int ret;
aeaad0b0	209
5874e88d	210	drvc = di->priv;
aeaad0b0	211
5874e88d DE	212	if (!drvc) {
	213	sr_err("Driver was not initialized.");
	214	return SR_ERR;
	215	}
aeaad0b0	216
43db3436	217	usb = sdi->conn;
5874e88d DE	218
	219	ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
	220	if (ret != SR_OK)
	221	return ret;
	222
	223	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	224	if (ret < 0) {
	225	sr_err("Failed to claim interface: %s.",
	226	libusb_error_name(ret));
	227	return SR_ERR;
	228	}
	229
	230	sdi->status = SR_ST_INITIALIZING;
	231
5874e88d DE	232	ret = lwla_init_device(sdi);
	233
	234	if (ret == SR_OK)
	235	sdi->status = SR_ST_ACTIVE;
	236
	237	return ret;
aeaad0b0 DE	238	}
	239
	240	static int dev_close(struct sr_dev_inst *sdi)
	241	{
5874e88d	242	struct sr_usb_dev_inst *usb;
5874e88d DE	243
	244	if (!di->priv) {
	245	sr_err("Driver was not initialized.");
	246	return SR_ERR;
	247	}
	248
6358f0a9	249	usb = sdi->conn;
5874e88d DE	250	if (!usb->devhdl)
5874e88d DE	251	return SR_OK;
aeaad0b0	252
6358f0a9	253	sdi->status = SR_ST_INACTIVE;
5874e88d	254
6358f0a9 DE	255	/* Trigger download of the shutdown bitstream. */
6358f0a9 DE	256	if (lwla_set_clock_config(sdi) != SR_OK)
5874e88d DE	257	sr_err("Unable to shut down device.");
	258
	259	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	260	libusb_close(usb->devhdl);
	261
	262	usb->devhdl = NULL;
aeaad0b0 DE	263
	264	return SR_OK;
	265	}
	266
	267	static int cleanup(void)
	268	{
5874e88d	269	return dev_clear();
aeaad0b0 DE	270	}
aeaad0b0 DE	271
584560f1	272	static int config_get(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	273	const struct sr_channel_group *cg)
aeaad0b0	274	{
5874e88d	275	struct dev_context *devc;
e6e54bd2	276	size_t idx;
aeaad0b0	277
53b4680f	278	(void)cg;
aeaad0b0	279
5874e88d DE	280	if (!sdi)
	281	return SR_ERR_ARG;
	282
	283	devc = sdi->priv;
	284
aeaad0b0	285	switch (key) {
5874e88d DE	286	case SR_CONF_SAMPLERATE:
	287	*data = g_variant_new_uint64(devc->samplerate);
	288	break;
29d58767 DE	289	case SR_CONF_LIMIT_MSEC:
	290	*data = g_variant_new_uint64(devc->limit_msec);
	291	break;
5874e88d DE	292	case SR_CONF_LIMIT_SAMPLES:
	293	*data = g_variant_new_uint64(devc->limit_samples);
	294	break;
	295	case SR_CONF_EXTERNAL_CLOCK:
6358f0a9 DE	296	*data = g_variant_new_boolean(devc->cfg_clock_source
	297	== CLOCK_EXT_CLK);
	298	break;
	299	case SR_CONF_CLOCK_EDGE:
	300	idx = devc->cfg_clock_edge;
	301	if (idx >= G_N_ELEMENTS(signal_edge_names))
	302	return SR_ERR_BUG;
	303	*data = g_variant_new_string(signal_edge_names[idx]);
5874e88d	304	break;
e6e54bd2 DE	305	case SR_CONF_TRIGGER_SOURCE:
	306	idx = devc->cfg_trigger_source;
	307	if (idx >= G_N_ELEMENTS(trigger_source_names))
	308	return SR_ERR_BUG;
	309	*data = g_variant_new_string(trigger_source_names[idx]);
	310	break;
	311	case SR_CONF_TRIGGER_SLOPE:
	312	idx = devc->cfg_trigger_slope;
6358f0a9	313	if (idx >= G_N_ELEMENTS(signal_edge_names))
e6e54bd2	314	return SR_ERR_BUG;
6358f0a9	315	*data = g_variant_new_string(signal_edge_names[idx]);
e6e54bd2	316	break;
aeaad0b0 DE	317	default:
	318	return SR_ERR_NA;
	319	}
	320
5874e88d	321	return SR_OK;
aeaad0b0 DE	322	}
aeaad0b0 DE	323
e6e54bd2 DE	324	/* Helper for mapping a string-typed configuration value to an index
	325	* within a table of possible values.
	326	*/
	327	static int lookup_index(GVariant value, const char const *table, int len)
	328	{
	329	const char *entry;
	330	int i;
	331
	332	entry = g_variant_get_string(value, NULL);
	333	if (!entry)
	334	return -1;
	335
	336	/* Linear search is fine for very small tables. */
	337	for (i = 0; i < len; ++i) {
	338	if (strcmp(entry, table[i]) == 0)
	339	return i;
	340	}
	341	return -1;
	342	}
	343
584560f1	344	static int config_set(uint32_t key, GVariant data, const struct sr_dev_inst sdi,
53b4680f	345	const struct sr_channel_group *cg)
aeaad0b0	346	{
29d58767	347	uint64_t value;
5874e88d	348	struct dev_context *devc;
e6e54bd2	349	int idx;
aeaad0b0	350
53b4680f	351	(void)cg;
aeaad0b0	352
5874e88d DE	353	devc = sdi->priv;
5874e88d DE	354	if (!devc)
aeaad0b0 DE	355	return SR_ERR_DEV_CLOSED;
aeaad0b0 DE	356
aeaad0b0	357	switch (key) {
5874e88d	358	case SR_CONF_SAMPLERATE:
29d58767	359	value = g_variant_get_uint64(data);
29d58767 DE	360	if (value < samplerates[G_N_ELEMENTS(samplerates) - 1]
29d58767 DE	361	\|\| value > samplerates[0])
5874e88d	362	return SR_ERR_SAMPLERATE;
29d58767 DE	363	devc->samplerate = value;
	364	break;
	365	case SR_CONF_LIMIT_MSEC:
	366	value = g_variant_get_uint64(data);
	367	if (value > MAX_LIMIT_MSEC)
	368	return SR_ERR_ARG;
	369	devc->limit_msec = value;
5874e88d DE	370	break;
5874e88d DE	371	case SR_CONF_LIMIT_SAMPLES:
29d58767 DE	372	value = g_variant_get_uint64(data);
	373	if (value > MAX_LIMIT_SAMPLES)
	374	return SR_ERR_ARG;
	375	devc->limit_samples = value;
5874e88d DE	376	break;
5874e88d DE	377	case SR_CONF_EXTERNAL_CLOCK:
6358f0a9 DE	378	devc->cfg_clock_source = (g_variant_get_boolean(data))
	379	? CLOCK_EXT_CLK : CLOCK_INTERNAL;
	380	break;
	381	case SR_CONF_CLOCK_EDGE:
	382	idx = lookup_index(data, signal_edge_names,
	383	G_N_ELEMENTS(signal_edge_names));
	384	if (idx < 0)
	385	return SR_ERR_ARG;
	386	devc->cfg_clock_edge = idx;
5874e88d	387	break;
e6e54bd2 DE	388	case SR_CONF_TRIGGER_SOURCE:
	389	idx = lookup_index(data, trigger_source_names,
	390	G_N_ELEMENTS(trigger_source_names));
	391	if (idx < 0)
	392	return SR_ERR_ARG;
	393	devc->cfg_trigger_source = idx;
	394	break;
	395	case SR_CONF_TRIGGER_SLOPE:
6358f0a9 DE	396	idx = lookup_index(data, signal_edge_names,
6358f0a9 DE	397	G_N_ELEMENTS(signal_edge_names));
e6e54bd2 DE	398	if (idx < 0)
	399	return SR_ERR_ARG;
	400	devc->cfg_trigger_slope = idx;
	401	break;
aeaad0b0	402	default:
5874e88d	403	return SR_ERR_NA;
aeaad0b0 DE	404	}
aeaad0b0 DE	405
5874e88d	406	return SR_OK;
aeaad0b0 DE	407	}
aeaad0b0 DE	408
f3ca73ed	409	static int config_channel_set(const struct sr_dev_inst *sdi,
bbe7e48a	410	struct sr_channel *ch, unsigned int changes)
43db3436	411	{
ba7dd8bb	412	uint64_t channel_bit;
43db3436 DE	413	struct dev_context *devc;
	414
	415	devc = sdi->priv;
	416	if (!devc)
	417	return SR_ERR_DEV_CLOSED;
	418
3f239f08	419	if (ch->index < 0 \|\| ch->index >= NUM_CHANNELS) {
ba7dd8bb	420	sr_err("Channel index %d out of range.", ch->index);
43db3436 DE	421	return SR_ERR_BUG;
43db3436 DE	422	}
ba7dd8bb	423	channel_bit = (uint64_t)1 << ch->index;
43db3436	424
3f239f08	425	if ((changes & SR_CHANNEL_SET_ENABLED) != 0) {
ba7dd8bb UH	426	/* Enable or disable input channel for this channel. */
	427	if (ch->enabled)
	428	devc->channel_mask \|= channel_bit;
43db3436	429	else
ba7dd8bb	430	devc->channel_mask &= ~channel_bit;
43db3436 DE	431	}
43db3436 DE	432
43db3436 DE	433	return SR_OK;
	434	}
	435
ee38c8ba DE	436	static int config_commit(const struct sr_dev_inst *sdi)
	437	{
	438	if (sdi->status != SR_ST_ACTIVE) {
	439	sr_err("Device not ready (status %d).", (int)sdi->status);
	440	return SR_ERR;
	441	}
	442
6358f0a9	443	return lwla_set_clock_config(sdi);
ee38c8ba DE	444	}
ee38c8ba DE	445
584560f1	446	static int config_list(uint32_t key, GVariant *data, const struct sr_dev_inst sdi,
53b4680f	447	const struct sr_channel_group *cg)
aeaad0b0	448	{
5874e88d DE	449	GVariant *gvar;
5874e88d DE	450	GVariantBuilder gvb;
aeaad0b0 DE	451
aeaad0b0 DE	452	(void)sdi;
53b4680f	453	(void)cg;
aeaad0b0	454
aeaad0b0	455	switch (key) {
99c76642	456	case SR_CONF_SCAN_OPTIONS:
584560f1	457	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
a0e0bb41	458	scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
99c76642	459	break;
5874e88d	460	case SR_CONF_DEVICE_OPTIONS:
584560f1	461	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
f254bc4b	462	devopts, G_N_ELEMENTS(devopts), sizeof(uint32_t));
5874e88d DE	463	break;
	464	case SR_CONF_SAMPLERATE:
	465	g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
	466	gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
99c76642	467	samplerates, G_N_ELEMENTS(samplerates),
5874e88d DE	468	sizeof(uint64_t));
	469	g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
	470	*data = g_variant_builder_end(&gvb);
	471	break;
bbe7e48a BV	472	case SR_CONF_TRIGGER_MATCH:
	473	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	474	trigger_matches, ARRAY_SIZE(trigger_matches),
	475	sizeof(int32_t));
5874e88d	476	break;
e6e54bd2 DE	477	case SR_CONF_TRIGGER_SOURCE:
	478	*data = g_variant_new_strv(trigger_source_names,
	479	G_N_ELEMENTS(trigger_source_names));
	480	break;
	481	case SR_CONF_TRIGGER_SLOPE:
6358f0a9 DE	482	case SR_CONF_CLOCK_EDGE:
	483	*data = g_variant_new_strv(signal_edge_names,
	484	G_N_ELEMENTS(signal_edge_names));
e6e54bd2	485	break;
aeaad0b0 DE	486	default:
	487	return SR_ERR_NA;
	488	}
	489
5874e88d	490	return SR_OK;
aeaad0b0 DE	491	}
aeaad0b0 DE	492
5874e88d DE	493	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	494	{
	495	struct drv_context *drvc;
	496	struct dev_context *devc;
	497	struct acquisition_state *acq;
	498	int ret;
	499
aeaad0b0 DE	500	(void)cb_data;
	501
	502	if (sdi->status != SR_ST_ACTIVE)
	503	return SR_ERR_DEV_CLOSED;
	504
5874e88d DE	505	devc = sdi->priv;
	506	drvc = di->priv;
	507
	508	if (devc->acquisition) {
	509	sr_err("Acquisition still in progress?");
	510	return SR_ERR;
	511	}
	512	acq = lwla_alloc_acquisition_state();
	513	if (!acq)
	514	return SR_ERR_MALLOC;
	515
	516	devc->stopping_in_progress = FALSE;
	517	devc->transfer_error = FALSE;
	518
5874e88d DE	519	sr_info("Starting acquisition.");
	520
	521	devc->acquisition = acq;
bbe7e48a	522	lwla_convert_trigger(sdi);
5874e88d DE	523	ret = lwla_setup_acquisition(sdi);
5874e88d DE	524	if (ret != SR_OK) {
a84f6ad3	525	sr_err("Failed to set up acquisition.");
5874e88d DE	526	devc->acquisition = NULL;
	527	lwla_free_acquisition_state(acq);
	528	return ret;
	529	}
	530
	531	ret = lwla_start_acquisition(sdi);
	532	if (ret != SR_OK) {
a84f6ad3	533	sr_err("Failed to start acquisition.");
5874e88d DE	534	devc->acquisition = NULL;
	535	lwla_free_acquisition_state(acq);
	536	return ret;
	537	}
102f1239	538	usb_source_add(sdi->session, drvc->sr_ctx, 100, &lwla_receive_data,
5874e88d DE	539	(struct sr_dev_inst *)sdi);
	540
	541	sr_info("Waiting for data.");
	542
	543	/* Send header packet to the session bus. */
	544	std_session_send_df_header(sdi, LOG_PREFIX);
aeaad0b0 DE	545
	546	return SR_OK;
	547	}
	548
	549	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	550	{
	551	(void)cb_data;
	552
	553	if (sdi->status != SR_ST_ACTIVE)
	554	return SR_ERR_DEV_CLOSED;
	555
5874e88d DE	556	sr_dbg("Stopping acquisition.");
	557
	558	sdi->status = SR_ST_STOPPING;
aeaad0b0 DE	559
	560	return SR_OK;
	561	}
	562
	563	SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info = {
	564	.name = "sysclk-lwla",
5874e88d	565	.longname = "SysClk LWLA series",
aeaad0b0 DE	566	.api_version = 1,
	567	.init = init,
	568	.cleanup = cleanup,
	569	.scan = scan,
	570	.dev_list = dev_list,
	571	.dev_clear = dev_clear,
	572	.config_get = config_get,
	573	.config_set = config_set,
f3ca73ed	574	.config_channel_set = config_channel_set,
ee38c8ba	575	.config_commit = config_commit,
aeaad0b0 DE	576	.config_list = config_list,
	577	.dev_open = dev_open,
	578	.dev_close = dev_close,
	579	.dev_acquisition_start = dev_acquisition_start,
	580	.dev_acquisition_stop = dev_acquisition_stop,
	581	.priv = NULL,
	582	};