[libsigrok.git] / 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 int32_t hwopts[] = {
	SR_CONF_CONN,
};

static const int32_t hwcaps[] = {
	SR_CONF_LOGIC_ANALYZER,
	SR_CONF_SAMPLERATE,
	SR_CONF_EXTERNAL_CLOCK,
	SR_CONF_TRIGGER_TYPE,
	SR_CONF_LIMIT_MSEC,
	SR_CONF_LIMIT_SAMPLES,
};

/* 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),
};

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_probe_list(int num_probes)
{
	GSList *list;
	struct sr_probe *probe;
	int i;
	char name[8];

	list = NULL;

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

		probe = sr_probe_new(i - 1, SR_PROBE_LOGIC, TRUE, name);
		list = g_slist_prepend(list, probe);
	}

	return list;
}

static struct sr_dev_inst *dev_inst_new(int device_index)
{
	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(device_index, 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 probe configuration. */
	devc->channel_mask = ALL_CHANNELS_MASK;
	devc->samplerate = DEFAULT_SAMPLERATE;

	sdi->priv = devc;
	sdi->probes = gen_probe_list(NUM_PROBES);

	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;
	int device_index;

	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;
	device_index = g_slist_length(drvc->instances);

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

		/* Create sigrok device instance. */
		sdi = dev_inst_new(device_index);
		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;
	struct dev_context *devc;

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

	usb  = sdi->conn;
	devc = sdi->priv;

	if (!usb->devhdl)
		return SR_OK;

	/* Trigger download of the shutdown bitstream. */
	devc->selected_clock_source = CLOCK_SOURCE_NONE;

	if (lwla_set_clock_source(sdi) != SR_OK)
		sr_err("Unable to shut down device.");

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

	usb->devhdl = NULL;
	sdi->status = SR_ST_INACTIVE;

	return SR_OK;
}

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

static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
		      const struct sr_probe_group *probe_group)
{
	struct dev_context *devc;

	(void)probe_group;

	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->selected_clock_source
						>= CLOCK_SOURCE_EXT_RISE);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
		      const struct sr_probe_group *probe_group)
{
	uint64_t value;
	struct dev_context *devc;

	(void)probe_group;

	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:
		if (g_variant_get_boolean(data)) {
			sr_info("Enabling external clock.");
			/* TODO: Allow the external clock to be inverted */
			devc->selected_clock_source = CLOCK_SOURCE_EXT_RISE;
		} else {
			sr_info("Disabling external clock.");
			devc->selected_clock_source = CLOCK_SOURCE_INT;
		}
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_probe_set(const struct sr_dev_inst *sdi,
			    struct sr_probe *probe, unsigned int changes)
{
	uint64_t probe_bit;
	uint64_t trigger_mask;
	uint64_t trigger_values;
	uint64_t trigger_edge_mask;
	struct dev_context *devc;

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

	if (probe->index < 0 || probe->index >= NUM_PROBES) {
		sr_err("Probe index %d out of range.", probe->index);
		return SR_ERR_BUG;
	}
	probe_bit = (uint64_t)1 << probe->index;

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

	if ((changes & SR_PROBE_SET_TRIGGER) != 0) {
		trigger_mask = devc->trigger_mask & ~probe_bit;
		trigger_values = devc->trigger_values & ~probe_bit;
		trigger_edge_mask = devc->trigger_edge_mask & ~probe_bit;

		if (probe->trigger && probe->trigger[0] != '\0') {
			if (probe->trigger[1] != '\0') {
				sr_warn("Trigger configuration \"%s\" with "
					"multiple stages is not supported.",
					probe->trigger);
				return SR_ERR_ARG;
			}
			/* Enable trigger for this probe. */
			trigger_mask |= probe_bit;

			/* Configure edge mask and trigger value. */
			switch (probe->trigger[0]) {
			case '1': trigger_values |= probe_bit;
			case '0': break;

			case 'r': trigger_values |= probe_bit;
			case 'f': trigger_edge_mask |= probe_bit;
				  break;
			default:
				sr_warn("Trigger type '%c' is not supported.",
					probe->trigger[0]);
				return SR_ERR_ARG;
			}
		}
		/* Store validated trigger setup. */
		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)
{
	if (sdi->status != SR_ST_ACTIVE) {
		sr_err("Device not ready (status %d).", (int)sdi->status);
		return SR_ERR;
	}

	return lwla_set_clock_source(sdi);
}

static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
		       const struct sr_probe_group *probe_group)
{
	GVariant *gvar;
	GVariantBuilder gvb;

	(void)sdi;
	(void)probe_group;

	switch (key) {
	case SR_CONF_SCAN_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwopts, G_N_ELEMENTS(hwopts), sizeof(int32_t));
		break;
	case SR_CONF_DEVICE_OPTIONS:
		*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
				hwcaps, G_N_ELEMENTS(hwcaps), sizeof(int32_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_TYPE:
		*data = g_variant_new_string(TRIGGER_TYPES);
		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;
	ret = lwla_setup_acquisition(sdi);
	if (ret != SR_OK) {
		sr_err("Failed to set up aquisition.");
		devc->acquisition = NULL;
		lwla_free_acquisition_state(acq);
		return ret;
	}

	ret = lwla_start_acquisition(sdi);
	if (ret != SR_OK) {
		sr_err("Failed to start aquisition.");
		devc->acquisition = NULL;
		lwla_free_acquisition_state(acq);
		return ret;
	}
	usb_source_add(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_probe_set = config_probe_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
99c76642 DE	28	static const int32_t hwopts[] = {
	29	SR_CONF_CONN,
	30	};
	31
5874e88d DE	32	static const int32_t hwcaps[] = {
	33	SR_CONF_LOGIC_ANALYZER,
	34	SR_CONF_SAMPLERATE,
	35	SR_CONF_EXTERNAL_CLOCK,
	36	SR_CONF_TRIGGER_TYPE,
29d58767	37	SR_CONF_LIMIT_MSEC,
5874e88d DE	38	SR_CONF_LIMIT_SAMPLES,
	39	};
	40
	41	/* The hardware supports more samplerates than these, but these are the
	42	* options hardcoded into the vendor's Windows GUI.
	43	*/
	44	static const uint64_t samplerates[] = {
	45	SR_MHZ(125), SR_MHZ(100),
	46	SR_MHZ(50), SR_MHZ(20), SR_MHZ(10),
	47	SR_MHZ(5), SR_MHZ(2), SR_MHZ(1),
	48	SR_KHZ(500), SR_KHZ(200), SR_KHZ(100),
	49	SR_KHZ(50), SR_KHZ(20), SR_KHZ(10),
	50	SR_KHZ(5), SR_KHZ(2), SR_KHZ(1),
	51	SR_HZ(500), SR_HZ(200), SR_HZ(100),
	52	};
aeaad0b0 DE	53
aeaad0b0 DE	54	SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info;
5874e88d	55	static struct sr_dev_driver *const di = &sysclk_lwla_driver_info;
aeaad0b0 DE	56
	57	static int init(struct sr_context *sr_ctx)
	58	{
	59	return std_init(sr_ctx, di, LOG_PREFIX);
	60	}
	61
5874e88d DE	62	static GSList *gen_probe_list(int num_probes)
	63	{
	64	GSList *list;
	65	struct sr_probe *probe;
	66	int i;
	67	char name[8];
	68
	69	list = NULL;
	70
	71	for (i = num_probes; i > 0; --i) {
	72	/* The LWLA series simply number probes from CH1 to CHxx. */
1f98295d	73	g_snprintf(name, sizeof(name), "CH%d", i);
5874e88d DE	74
	75	probe = sr_probe_new(i - 1, SR_PROBE_LOGIC, TRUE, name);
	76	list = g_slist_prepend(list, probe);
	77	}
	78
	79	return list;
	80	}
	81
43db3436 DE	82	static struct sr_dev_inst *dev_inst_new(int device_index)
	83	{
	84	struct sr_dev_inst *sdi;
	85	struct dev_context *devc;
	86
	87	/* Allocate memory for our private driver context. */
	88	devc = g_try_new0(struct dev_context, 1);
	89	if (!devc) {
	90	sr_err("Device context malloc failed.");
	91	return NULL;
	92	}
	93
	94	/* Register the device with libsigrok. */
	95	sdi = sr_dev_inst_new(device_index, SR_ST_INACTIVE,
	96	VENDOR_NAME, MODEL_NAME, NULL);
	97	if (!sdi) {
	98	sr_err("Failed to instantiate device.");
	99	g_free(devc);
	100	return NULL;
	101	}
	102
	103	/* Enable all channels to match the default probe configuration. */
	104	devc->channel_mask = ALL_CHANNELS_MASK;
	105	devc->samplerate = DEFAULT_SAMPLERATE;
	106
	107	sdi->priv = devc;
	108	sdi->probes = gen_probe_list(NUM_PROBES);
	109
	110	return sdi;
	111	}
	112
aeaad0b0 DE	113	static GSList scan(GSList options)
aeaad0b0 DE	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;
5874e88d	121	int device_index;
aeaad0b0	122
aeaad0b0	123	drvc = di->priv;
7ebe9b9e	124	conn = USB_VID_PID;
5874e88d	125
7ebe9b9e DE	126	for (node = options; node != NULL; node = node->next) {
	127	src = node->data;
	128	if (src->key == SR_CONF_CONN) {
	129	conn = g_variant_get_string(src->data, NULL);
	130	break;
	131	}
	132	}
	133	usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn);
	134	devices = NULL;
50cad98d	135	device_index = g_slist_length(drvc->instances);
5874e88d DE	136
	137	for (node = usb_devices; node != NULL; node = node->next) {
	138	usb = node->data;
	139
43db3436 DE	140	/* Create sigrok device instance. */
43db3436 DE	141	sdi = dev_inst_new(device_index);
5874e88d	142	if (!sdi) {
5874e88d DE	143	sr_usb_dev_inst_free(usb);
	144	continue;
	145	}
	146	sdi->driver = di;
5874e88d DE	147	sdi->inst_type = SR_INST_USB;
5874e88d DE	148	sdi->conn = usb;
5874e88d	149
43db3436	150	/* Register device instance with driver. */
5874e88d DE	151	drvc->instances = g_slist_append(drvc->instances, sdi);
	152	devices = g_slist_append(devices, sdi);
	153	}
aeaad0b0	154
5874e88d	155	g_slist_free(usb_devices);
aeaad0b0 DE	156
	157	return devices;
	158	}
	159
	160	static GSList *dev_list(void)
	161	{
5874e88d DE	162	struct drv_context *drvc;
	163
	164	drvc = di->priv;
	165
	166	return drvc->instances;
	167	}
	168
	169	static void clear_dev_context(void *priv)
	170	{
	171	struct dev_context *devc;
	172
	173	devc = priv;
	174
	175	sr_dbg("Device context cleared.");
	176
	177	lwla_free_acquisition_state(devc->acquisition);
	178	g_free(devc);
aeaad0b0 DE	179	}
	180
	181	static int dev_clear(void)
	182	{
5874e88d	183	return std_dev_clear(di, &clear_dev_context);
aeaad0b0 DE	184	}
	185
	186	static int dev_open(struct sr_dev_inst *sdi)
	187	{
5874e88d	188	struct drv_context *drvc;
5874e88d DE	189	struct sr_usb_dev_inst *usb;
5874e88d DE	190	int ret;
aeaad0b0	191
5874e88d	192	drvc = di->priv;
aeaad0b0	193
5874e88d DE	194	if (!drvc) {
	195	sr_err("Driver was not initialized.");
	196	return SR_ERR;
	197	}
aeaad0b0	198
43db3436	199	usb = sdi->conn;
5874e88d DE	200
	201	ret = sr_usb_open(drvc->sr_ctx->libusb_ctx, usb);
	202	if (ret != SR_OK)
	203	return ret;
	204
	205	ret = libusb_claim_interface(usb->devhdl, USB_INTERFACE);
	206	if (ret < 0) {
	207	sr_err("Failed to claim interface: %s.",
	208	libusb_error_name(ret));
	209	return SR_ERR;
	210	}
	211
	212	sdi->status = SR_ST_INITIALIZING;
	213
5874e88d DE	214	ret = lwla_init_device(sdi);
	215
	216	if (ret == SR_OK)
	217	sdi->status = SR_ST_ACTIVE;
	218
	219	return ret;
aeaad0b0 DE	220	}
	221
	222	static int dev_close(struct sr_dev_inst *sdi)
	223	{
5874e88d DE	224	struct sr_usb_dev_inst *usb;
	225	struct dev_context *devc;
	226
	227	if (!di->priv) {
	228	sr_err("Driver was not initialized.");
	229	return SR_ERR;
	230	}
	231
	232	usb = sdi->conn;
	233	devc = sdi->priv;
aeaad0b0	234
5874e88d DE	235	if (!usb->devhdl)
5874e88d DE	236	return SR_OK;
aeaad0b0	237
5874e88d DE	238	/* Trigger download of the shutdown bitstream. */
	239	devc->selected_clock_source = CLOCK_SOURCE_NONE;
	240
	241	if (lwla_set_clock_source(sdi) != SR_OK)
	242	sr_err("Unable to shut down device.");
	243
	244	libusb_release_interface(usb->devhdl, USB_INTERFACE);
	245	libusb_close(usb->devhdl);
	246
	247	usb->devhdl = NULL;
aeaad0b0 DE	248	sdi->status = SR_ST_INACTIVE;
	249
	250	return SR_OK;
	251	}
	252
	253	static int cleanup(void)
	254	{
5874e88d	255	return dev_clear();
aeaad0b0 DE	256	}
	257
	258	static int config_get(int key, GVariant *data, const struct sr_dev_inst sdi,
5874e88d	259	const struct sr_probe_group *probe_group)
aeaad0b0	260	{
5874e88d	261	struct dev_context *devc;
aeaad0b0	262
aeaad0b0 DE	263	(void)probe_group;
aeaad0b0 DE	264
5874e88d DE	265	if (!sdi)
	266	return SR_ERR_ARG;
	267
	268	devc = sdi->priv;
	269
aeaad0b0	270	switch (key) {
5874e88d DE	271	case SR_CONF_SAMPLERATE:
	272	*data = g_variant_new_uint64(devc->samplerate);
	273	break;
29d58767 DE	274	case SR_CONF_LIMIT_MSEC:
	275	*data = g_variant_new_uint64(devc->limit_msec);
	276	break;
5874e88d DE	277	case SR_CONF_LIMIT_SAMPLES:
	278	*data = g_variant_new_uint64(devc->limit_samples);
	279	break;
	280	case SR_CONF_EXTERNAL_CLOCK:
	281	*data = g_variant_new_boolean(devc->selected_clock_source
	282	>= CLOCK_SOURCE_EXT_RISE);
	283	break;
aeaad0b0 DE	284	default:
	285	return SR_ERR_NA;
	286	}
	287
5874e88d	288	return SR_OK;
aeaad0b0 DE	289	}
	290
	291	static int config_set(int key, GVariant data, const struct sr_dev_inst sdi,
5874e88d	292	const struct sr_probe_group *probe_group)
aeaad0b0	293	{
29d58767	294	uint64_t value;
5874e88d	295	struct dev_context *devc;
aeaad0b0	296
aeaad0b0 DE	297	(void)probe_group;
aeaad0b0 DE	298
5874e88d DE	299	devc = sdi->priv;
5874e88d DE	300	if (!devc)
aeaad0b0 DE	301	return SR_ERR_DEV_CLOSED;
aeaad0b0 DE	302
aeaad0b0	303	switch (key) {
5874e88d	304	case SR_CONF_SAMPLERATE:
29d58767	305	value = g_variant_get_uint64(data);
29d58767 DE	306	if (value < samplerates[G_N_ELEMENTS(samplerates) - 1]
29d58767 DE	307	\|\| value > samplerates[0])
5874e88d	308	return SR_ERR_SAMPLERATE;
29d58767 DE	309	devc->samplerate = value;
	310	break;
	311	case SR_CONF_LIMIT_MSEC:
	312	value = g_variant_get_uint64(data);
	313	if (value > MAX_LIMIT_MSEC)
	314	return SR_ERR_ARG;
	315	devc->limit_msec = value;
5874e88d DE	316	break;
5874e88d DE	317	case SR_CONF_LIMIT_SAMPLES:
29d58767 DE	318	value = g_variant_get_uint64(data);
	319	if (value > MAX_LIMIT_SAMPLES)
	320	return SR_ERR_ARG;
	321	devc->limit_samples = value;
5874e88d DE	322	break;
	323	case SR_CONF_EXTERNAL_CLOCK:
	324	if (g_variant_get_boolean(data)) {
	325	sr_info("Enabling external clock.");
	326	/* TODO: Allow the external clock to be inverted */
	327	devc->selected_clock_source = CLOCK_SOURCE_EXT_RISE;
	328	} else {
	329	sr_info("Disabling external clock.");
	330	devc->selected_clock_source = CLOCK_SOURCE_INT;
	331	}
5874e88d	332	break;
aeaad0b0	333	default:
5874e88d	334	return SR_ERR_NA;
aeaad0b0 DE	335	}
aeaad0b0 DE	336
5874e88d	337	return SR_OK;
aeaad0b0 DE	338	}
aeaad0b0 DE	339
43db3436 DE	340	static int config_probe_set(const struct sr_dev_inst *sdi,
	341	struct sr_probe *probe, unsigned int changes)
	342	{
	343	uint64_t probe_bit;
	344	uint64_t trigger_mask;
	345	uint64_t trigger_values;
	346	uint64_t trigger_edge_mask;
	347	struct dev_context *devc;
	348
	349	devc = sdi->priv;
	350	if (!devc)
	351	return SR_ERR_DEV_CLOSED;
	352
	353	if (probe->index < 0 \|\| probe->index >= NUM_PROBES) {
	354	sr_err("Probe index %d out of range.", probe->index);
	355	return SR_ERR_BUG;
	356	}
	357	probe_bit = (uint64_t)1 << probe->index;
	358
	359	if ((changes & SR_PROBE_SET_ENABLED) != 0) {
	360	/* Enable or disable input channel for this probe. */
	361	if (probe->enabled)
	362	devc->channel_mask \|= probe_bit;
	363	else
	364	devc->channel_mask &= ~probe_bit;
	365	}
	366
	367	if ((changes & SR_PROBE_SET_TRIGGER) != 0) {
	368	trigger_mask = devc->trigger_mask & ~probe_bit;
	369	trigger_values = devc->trigger_values & ~probe_bit;
	370	trigger_edge_mask = devc->trigger_edge_mask & ~probe_bit;
	371
	372	if (probe->trigger && probe->trigger[0] != '\0') {
	373	if (probe->trigger[1] != '\0') {
	374	sr_warn("Trigger configuration \"%s\" with "
	375	"multiple stages is not supported.",
	376	probe->trigger);
	377	return SR_ERR_ARG;
	378	}
	379	/* Enable trigger for this probe. */
	380	trigger_mask \|= probe_bit;
	381
	382	/* Configure edge mask and trigger value. */
	383	switch (probe->trigger[0]) {
	384	case '1': trigger_values \|= probe_bit;
	385	case '0': break;
	386
	387	case 'r': trigger_values \|= probe_bit;
	388	case 'f': trigger_edge_mask \|= probe_bit;
	389	break;
	390	default:
	391	sr_warn("Trigger type '%c' is not supported.",
	392	probe->trigger[0]);
	393	return SR_ERR_ARG;
	394	}
	395	}
	396	/* Store validated trigger setup. */
	397	devc->trigger_mask = trigger_mask;
	398	devc->trigger_values = trigger_values;
	399	devc->trigger_edge_mask = trigger_edge_mask;
	400	}
	401
	402	return SR_OK;
	403	}
404
ee38c8ba DE	405	static int config_commit(const struct sr_dev_inst *sdi)
	406	{
	407	if (sdi->status != SR_ST_ACTIVE) {
	408	sr_err("Device not ready (status %d).", (int)sdi->status);
	409	return SR_ERR;
	410	}
	411
	412	return lwla_set_clock_source(sdi);
	413	}
	414
aeaad0b0	415	static int config_list(int key, GVariant *data, const struct sr_dev_inst sdi,
5874e88d	416	const struct sr_probe_group *probe_group)
aeaad0b0	417	{
5874e88d DE	418	GVariant *gvar;
5874e88d DE	419	GVariantBuilder gvb;
aeaad0b0 DE	420
aeaad0b0 DE	421	(void)sdi;
aeaad0b0 DE	422	(void)probe_group;
aeaad0b0 DE	423
aeaad0b0	424	switch (key) {
99c76642 DE	425	case SR_CONF_SCAN_OPTIONS:
	426	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
	427	hwopts, G_N_ELEMENTS(hwopts), sizeof(int32_t));
	428	break;
5874e88d DE	429	case SR_CONF_DEVICE_OPTIONS:
5874e88d DE	430	*data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
99c76642	431	hwcaps, G_N_ELEMENTS(hwcaps), sizeof(int32_t));
5874e88d DE	432	break;
	433	case SR_CONF_SAMPLERATE:
	434	g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}"));
	435	gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
99c76642	436	samplerates, G_N_ELEMENTS(samplerates),
5874e88d DE	437	sizeof(uint64_t));
	438	g_variant_builder_add(&gvb, "{sv}", "samplerates", gvar);
	439	*data = g_variant_builder_end(&gvb);
	440	break;
	441	case SR_CONF_TRIGGER_TYPE:
	442	*data = g_variant_new_string(TRIGGER_TYPES);
	443	break;
aeaad0b0 DE	444	default:
	445	return SR_ERR_NA;
	446	}
	447
5874e88d	448	return SR_OK;
aeaad0b0 DE	449	}
aeaad0b0 DE	450
5874e88d DE	451	static int dev_acquisition_start(const struct sr_dev_inst sdi, void cb_data)
	452	{
	453	struct drv_context *drvc;
	454	struct dev_context *devc;
	455	struct acquisition_state *acq;
	456	int ret;
	457
aeaad0b0 DE	458	(void)cb_data;
	459
	460	if (sdi->status != SR_ST_ACTIVE)
	461	return SR_ERR_DEV_CLOSED;
	462
5874e88d DE	463	devc = sdi->priv;
	464	drvc = di->priv;
	465
	466	if (devc->acquisition) {
	467	sr_err("Acquisition still in progress?");
	468	return SR_ERR;
	469	}
	470	acq = lwla_alloc_acquisition_state();
	471	if (!acq)
	472	return SR_ERR_MALLOC;
	473
	474	devc->stopping_in_progress = FALSE;
	475	devc->transfer_error = FALSE;
	476
5874e88d DE	477	sr_info("Starting acquisition.");
	478
	479	devc->acquisition = acq;
	480	ret = lwla_setup_acquisition(sdi);
	481	if (ret != SR_OK) {
	482	sr_err("Failed to set up aquisition.");
	483	devc->acquisition = NULL;
	484	lwla_free_acquisition_state(acq);
	485	return ret;
	486	}
	487
	488	ret = lwla_start_acquisition(sdi);
	489	if (ret != SR_OK) {
	490	sr_err("Failed to start aquisition.");
	491	devc->acquisition = NULL;
	492	lwla_free_acquisition_state(acq);
	493	return ret;
	494	}
	495	usb_source_add(drvc->sr_ctx, 100, &lwla_receive_data,
	496	(struct sr_dev_inst *)sdi);
	497
	498	sr_info("Waiting for data.");
	499
	500	/* Send header packet to the session bus. */
	501	std_session_send_df_header(sdi, LOG_PREFIX);
aeaad0b0 DE	502
	503	return SR_OK;
	504	}
	505
	506	static int dev_acquisition_stop(struct sr_dev_inst sdi, void cb_data)
	507	{
	508	(void)cb_data;
	509
	510	if (sdi->status != SR_ST_ACTIVE)
	511	return SR_ERR_DEV_CLOSED;
	512
5874e88d DE	513	sr_dbg("Stopping acquisition.");
	514
	515	sdi->status = SR_ST_STOPPING;
aeaad0b0 DE	516
	517	return SR_OK;
	518	}
	519
	520	SR_PRIV struct sr_dev_driver sysclk_lwla_driver_info = {
	521	.name = "sysclk-lwla",
5874e88d	522	.longname = "SysClk LWLA series",
aeaad0b0 DE	523	.api_version = 1,
	524	.init = init,
	525	.cleanup = cleanup,
	526	.scan = scan,
	527	.dev_list = dev_list,
	528	.dev_clear = dev_clear,
	529	.config_get = config_get,
	530	.config_set = config_set,
43db3436	531	.config_probe_set = config_probe_set,
ee38c8ba	532	.config_commit = config_commit,
aeaad0b0 DE	533	.config_list = config_list,
	534	.dev_open = dev_open,
	535	.dev_close = dev_close,
	536	.dev_acquisition_start = dev_acquisition_start,
	537	.dev_acquisition_stop = dev_acquisition_stop,
	538	.priv = NULL,
	539	};