[libsigrok.git] / src / hardware / demo / api.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
 * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
 * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.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 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */

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

#define DEFAULT_NUM_LOGIC_CHANNELS	8
#define DEFAULT_LOGIC_PATTERN		PATTERN_SIGROK

#define DEFAULT_NUM_ANALOG_CHANNELS	4
#define DEFAULT_ANALOG_AMPLITUDE	10

/* Note: No spaces allowed because of sigrok-cli. */
static const char *logic_pattern_str[] = {
	"sigrok",
	"random",
	"incremental",
	"walking-one",
	"walking-zero",
	"all-low",
	"all-high",
	"squid",
	"graycode",
};

static const uint32_t scanopts[] = {
	SR_CONF_NUM_LOGIC_CHANNELS,
	SR_CONF_NUM_ANALOG_CHANNELS,
	SR_CONF_LIMIT_FRAMES,
};

static const uint32_t drvopts[] = {
	SR_CONF_DEMO_DEV,
	SR_CONF_LOGIC_ANALYZER,
	SR_CONF_OSCILLOSCOPE,
};

static const uint32_t devopts[] = {
	SR_CONF_CONTINUOUS,
	SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_LIMIT_MSEC | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_AVERAGING | SR_CONF_GET | SR_CONF_SET,
	SR_CONF_AVG_SAMPLES | SR_CONF_GET | SR_CONF_SET,
};

static const uint32_t devopts_cg_logic[] = {
	SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
};

static const uint32_t devopts_cg_analog_group[] = {
	SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
};

static const uint32_t devopts_cg_analog_channel[] = {
	SR_CONF_PATTERN_MODE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
	SR_CONF_AMPLITUDE | SR_CONF_GET | SR_CONF_SET,
};

static const uint64_t samplerates[] = {
	SR_HZ(1),
	SR_GHZ(1),
	SR_HZ(1),
};

static GSList *scan(struct sr_dev_driver *di, GSList *options)
{
	struct dev_context *devc;
	struct sr_dev_inst *sdi;
	struct sr_channel *ch;
	struct sr_channel_group *cg, *acg;
	struct sr_config *src;
	struct analog_gen *ag;
	GSList *l;
	int num_logic_channels, num_analog_channels, pattern, i;
	uint64_t limit_frames;
	char channel_name[16];

	num_logic_channels = DEFAULT_NUM_LOGIC_CHANNELS;
	num_analog_channels = DEFAULT_NUM_ANALOG_CHANNELS;
	limit_frames = DEFAULT_LIMIT_FRAMES;
	for (l = options; l; l = l->next) {
		src = l->data;
		switch (src->key) {
		case SR_CONF_NUM_LOGIC_CHANNELS:
			num_logic_channels = g_variant_get_int32(src->data);
			break;
		case SR_CONF_NUM_ANALOG_CHANNELS:
			num_analog_channels = g_variant_get_int32(src->data);
			break;
		case SR_CONF_LIMIT_FRAMES:
			limit_frames = g_variant_get_uint64(src->data);
			break;
		}
	}

	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	sdi->status = SR_ST_INACTIVE;
	sdi->model = g_strdup("Demo device");

	devc = g_malloc0(sizeof(struct dev_context));
	devc->cur_samplerate = SR_KHZ(200);
	devc->num_logic_channels = num_logic_channels;
	devc->logic_unitsize = (devc->num_logic_channels + 7) / 8;
	devc->all_logic_channels_mask = 1UL << 0;
	devc->all_logic_channels_mask <<= devc->num_logic_channels;
	devc->all_logic_channels_mask--;
	devc->logic_pattern = DEFAULT_LOGIC_PATTERN;
	devc->num_analog_channels = num_analog_channels;
	devc->limit_frames = limit_frames;

	if (num_logic_channels > 0) {
		/* Logic channels, all in one channel group. */
		cg = g_malloc0(sizeof(struct sr_channel_group));
		cg->name = g_strdup("Logic");
		for (i = 0; i < num_logic_channels; i++) {
			sprintf(channel_name, "D%d", i);
			ch = sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name);
			cg->channels = g_slist_append(cg->channels, ch);
		}
		sdi->channel_groups = g_slist_append(NULL, cg);
	}

	/* Analog channels, channel groups and pattern generators. */
	devc->ch_ag = g_hash_table_new(g_direct_hash, g_direct_equal);
	if (num_analog_channels > 0) {
		pattern = 0;
		/* An "Analog" channel group with all analog channels in it. */
		acg = g_malloc0(sizeof(struct sr_channel_group));
		acg->name = g_strdup("Analog");
		sdi->channel_groups = g_slist_append(sdi->channel_groups, acg);

		for (i = 0; i < num_analog_channels; i++) {
			snprintf(channel_name, 16, "A%d", i);
			ch = sr_channel_new(sdi, i + num_logic_channels, SR_CHANNEL_ANALOG,
					TRUE, channel_name);
			acg->channels = g_slist_append(acg->channels, ch);

			/* Every analog channel gets its own channel group as well. */
			cg = g_malloc0(sizeof(struct sr_channel_group));
			cg->name = g_strdup(channel_name);
			cg->channels = g_slist_append(NULL, ch);
			sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);

			/* Every channel gets a generator struct. */
			ag = g_malloc(sizeof(struct analog_gen));
			ag->ch = ch;
			ag->amplitude = DEFAULT_ANALOG_AMPLITUDE;
			sr_analog_init(&ag->packet, &ag->encoding, &ag->meaning, &ag->spec, 2);
			ag->packet.meaning->channels = cg->channels;
			ag->packet.meaning->mq = 0;
			ag->packet.meaning->mqflags = 0;
			ag->packet.meaning->unit = SR_UNIT_VOLT;
			ag->packet.data = ag->pattern_data;
			ag->pattern = pattern;
			ag->avg_val = 0.0f;
			ag->num_avgs = 0;
			g_hash_table_insert(devc->ch_ag, ch, ag);

			if (++pattern == ARRAY_SIZE(analog_pattern_str))
				pattern = 0;
		}
	}

	sdi->priv = devc;

	return std_scan_complete(di, g_slist_append(NULL, sdi));
}

static void clear_helper(struct dev_context *devc)
{
	GHashTableIter iter;
	void *value;

	/* Analog generators. */
	g_hash_table_iter_init(&iter, devc->ch_ag);
	while (g_hash_table_iter_next(&iter, NULL, &value))
		g_free(value);
	g_hash_table_unref(devc->ch_ag);
}

static int dev_clear(const struct sr_dev_driver *di)
{
	return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
}

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;
	struct sr_channel *ch;
	struct analog_gen *ag;
	int pattern;

	if (!sdi)
		return SR_ERR_ARG;

	devc = sdi->priv;
	switch (key) {
	case SR_CONF_SAMPLERATE:
		*data = g_variant_new_uint64(devc->cur_samplerate);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		*data = g_variant_new_uint64(devc->limit_samples);
		break;
	case SR_CONF_LIMIT_MSEC:
		*data = g_variant_new_uint64(devc->limit_msec);
		break;
	case SR_CONF_LIMIT_FRAMES:
		*data = g_variant_new_uint64(devc->limit_frames);
		break;
	case SR_CONF_AVERAGING:
		*data = g_variant_new_boolean(devc->avg);
		break;
	case SR_CONF_AVG_SAMPLES:
		*data = g_variant_new_uint64(devc->avg_samples);
		break;
	case SR_CONF_PATTERN_MODE:
		if (!cg)
			return SR_ERR_CHANNEL_GROUP;
		/* Any channel in the group will do. */
		ch = cg->channels->data;
		if (ch->type == SR_CHANNEL_LOGIC) {
			pattern = devc->logic_pattern;
			*data = g_variant_new_string(logic_pattern_str[pattern]);
		} else if (ch->type == SR_CHANNEL_ANALOG) {
			ag = g_hash_table_lookup(devc->ch_ag, ch);
			pattern = ag->pattern;
			*data = g_variant_new_string(analog_pattern_str[pattern]);
		} else
			return SR_ERR_BUG;
		break;
	case SR_CONF_AMPLITUDE:
		if (!cg)
			return SR_ERR_CHANNEL_GROUP;
		/* Any channel in the group will do. */
		ch = cg->channels->data;
		if (ch->type != SR_CHANNEL_ANALOG)
			return SR_ERR_ARG;
		ag = g_hash_table_lookup(devc->ch_ag, ch);
		*data = g_variant_new_double(ag->amplitude);
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_set(uint32_t key, GVariant *data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct dev_context *devc;
	struct analog_gen *ag;
	struct sr_channel *ch;
	GSList *l;
	int logic_pattern, analog_pattern;

	devc = sdi->priv;

	switch (key) {
	case SR_CONF_SAMPLERATE:
		devc->cur_samplerate = g_variant_get_uint64(data);
		break;
	case SR_CONF_LIMIT_SAMPLES:
		devc->limit_msec = 0;
		devc->limit_samples = g_variant_get_uint64(data);
		break;
	case SR_CONF_LIMIT_MSEC:
		devc->limit_msec = g_variant_get_uint64(data);
		devc->limit_samples = 0;
		break;
	case SR_CONF_LIMIT_FRAMES:
		devc->limit_frames = g_variant_get_uint64(data);
		break;
	case SR_CONF_AVERAGING:
		devc->avg = g_variant_get_boolean(data);
		sr_dbg("%s averaging", devc->avg ? "Enabling" : "Disabling");
		break;
	case SR_CONF_AVG_SAMPLES:
		devc->avg_samples = g_variant_get_uint64(data);
		sr_dbg("Setting averaging rate to %" PRIu64, devc->avg_samples);
		break;
	case SR_CONF_PATTERN_MODE:
		if (!cg)
			return SR_ERR_CHANNEL_GROUP;
		logic_pattern = std_str_idx(data, ARRAY_AND_SIZE(logic_pattern_str));
		analog_pattern = std_str_idx(data, ARRAY_AND_SIZE(analog_pattern_str));
		if (logic_pattern < 0 && analog_pattern < 0)
			return SR_ERR_ARG;
		for (l = cg->channels; l; l = l->next) {
			ch = l->data;
			if (ch->type == SR_CHANNEL_LOGIC) {
				if (logic_pattern == -1)
					return SR_ERR_ARG;
				sr_dbg("Setting logic pattern to %s",
						logic_pattern_str[logic_pattern]);
				devc->logic_pattern = logic_pattern;
				/* Might as well do this now, these are static. */
				if (logic_pattern == PATTERN_ALL_LOW)
					memset(devc->logic_data, 0x00, LOGIC_BUFSIZE);
				else if (logic_pattern == PATTERN_ALL_HIGH)
					memset(devc->logic_data, 0xff, LOGIC_BUFSIZE);
			} else if (ch->type == SR_CHANNEL_ANALOG) {
				if (analog_pattern == -1)
					return SR_ERR_ARG;
				sr_dbg("Setting analog pattern for channel %s to %s",
						ch->name, analog_pattern_str[analog_pattern]);
				ag = g_hash_table_lookup(devc->ch_ag, ch);
				ag->pattern = analog_pattern;
			} else
				return SR_ERR_BUG;
		}
		break;
	case SR_CONF_AMPLITUDE:
		if (!cg)
			return SR_ERR_CHANNEL_GROUP;
		for (l = cg->channels; l; l = l->next) {
			ch = l->data;
			if (ch->type != SR_CHANNEL_ANALOG)
				return SR_ERR_ARG;
			ag = g_hash_table_lookup(devc->ch_ag, ch);
			ag->amplitude = g_variant_get_double(data);
		}
		break;
	default:
		return SR_ERR_NA;
	}

	return SR_OK;
}

static int config_list(uint32_t key, GVariant **data,
	const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
{
	struct sr_channel *ch;

	if (!cg) {
		switch (key) {
		case SR_CONF_SCAN_OPTIONS:
		case SR_CONF_DEVICE_OPTIONS:
			return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
		case SR_CONF_SAMPLERATE:
			*data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
			break;
		default:
			return SR_ERR_NA;
		}
	} else {
		ch = cg->channels->data;
		switch (key) {
		case SR_CONF_DEVICE_OPTIONS:
			if (ch->type == SR_CHANNEL_LOGIC)
				*data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_logic));
			else if (ch->type == SR_CHANNEL_ANALOG) {
				if (strcmp(cg->name, "Analog") == 0)
					*data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog_group));
				else
					*data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog_channel));
			}
			else
				return SR_ERR_BUG;
			break;
		case SR_CONF_PATTERN_MODE:
			/* The analog group (with all 4 channels) shall not have a pattern property. */
			if (strcmp(cg->name, "Analog") == 0)
				return SR_ERR_NA;

			if (ch->type == SR_CHANNEL_LOGIC)
				*data = g_variant_new_strv(ARRAY_AND_SIZE(logic_pattern_str));
			else if (ch->type == SR_CHANNEL_ANALOG)
				*data = g_variant_new_strv(ARRAY_AND_SIZE(analog_pattern_str));
			else
				return SR_ERR_BUG;
			break;
		default:
			return SR_ERR_NA;
		}
	}

	return SR_OK;
}

static int dev_acquisition_start(const struct sr_dev_inst *sdi)
{
	struct dev_context *devc;
	GSList *l;
	struct sr_channel *ch;
	int bitpos;
	uint8_t mask;
	GHashTableIter iter;
	void *value;

	devc = sdi->priv;
	devc->sent_samples = 0;
	devc->sent_frame_samples = 0;

	/*
	 * Determine the numbers of logic and analog channels that are
	 * involved in the acquisition. Determine an offset and a mask to
	 * remove excess logic data content before datafeed submission.
	 */
	devc->enabled_logic_channels = 0;
	devc->enabled_analog_channels = 0;
	for (l = sdi->channels; l; l = l->next) {
		ch = l->data;
		if (!ch->enabled)
			continue;
		if (ch->type == SR_CHANNEL_ANALOG) {
			devc->enabled_analog_channels++;
			continue;
		}
		if (ch->type != SR_CHANNEL_LOGIC)
			continue;
		/*
		 * TODO: Need we create a channel map here, such that the
		 * session datafeed packets will have a dense representation
		 * of the enabled channels' data? For example store channels
		 * D3 and D5 in bit positions 0 and 1 respectively, when all
		 * other channels are disabled? The current implementation
		 * generates a sparse layout, might provide data for logic
		 * channels that are disabled while it might suppress data
		 * from enabled channels at the same time.
		 */
		devc->enabled_logic_channels++;
	}
	devc->first_partial_logic_index = devc->enabled_logic_channels / 8;
	bitpos = devc->enabled_logic_channels % 8;
	mask = (1 << bitpos) - 1;
	devc->first_partial_logic_mask = mask;
	sr_dbg("num logic %zu, partial off %zu, mask 0x%02x.",
		devc->enabled_logic_channels,
		devc->first_partial_logic_index,
		devc->first_partial_logic_mask);

	/*
	 * Have the waveform for analog patterns pre-generated. It's
	 * supposed to be periodic, so the generator just needs to
	 * access the prepared sample data (DDS style).
	 */
	g_hash_table_iter_init(&iter, devc->ch_ag);
	while (g_hash_table_iter_next(&iter, NULL, &value))
		demo_generate_analog_pattern(value, devc->cur_samplerate);

	sr_session_source_add(sdi->session, -1, 0, 100,
			demo_prepare_data, (struct sr_dev_inst *)sdi);

	std_session_send_df_header(sdi);

	if (devc->limit_frames > 0)
		std_session_send_frame_begin(sdi);

	/* We use this timestamp to decide how many more samples to send. */
	devc->start_us = g_get_monotonic_time();
	devc->spent_us = 0;
	devc->step = 0;

	return SR_OK;
}

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

	sr_session_source_remove(sdi->session, -1);

	devc = sdi->priv;
	if (devc->limit_frames > 0)
		std_session_send_frame_end(sdi);

	std_session_send_df_end(sdi);

	return SR_OK;
}

static struct sr_dev_driver demo_driver_info = {
	.name = "demo",
	.longname = "Demo driver and pattern generator",
	.api_version = 1,
	.init = std_init,
	.cleanup = std_cleanup,
	.scan = scan,
	.dev_list = std_dev_list,
	.dev_clear = dev_clear,
	.config_get = config_get,
	.config_set = config_set,
	.config_list = config_list,
	.dev_open = std_dummy_dev_open,
	.dev_close = std_dummy_dev_close,
	.dev_acquisition_start = dev_acquisition_start,
	.dev_acquisition_stop = dev_acquisition_stop,
	.context = NULL,
};
SR_REGISTER_DEV_DRIVER(demo_driver_info);
Commit	Line	Data
	1	/*
	2	* This file is part of the libsigrok project.
	3	*
	4	* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
	5	* Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
	6	* Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
	7	* Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com>
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, see <http://www.gnu.org/licenses/>.
	21	*/
	22
	23	#include <config.h>
	24	#include <stdlib.h>
	25	#include <string.h>
	26	#include <math.h>
	27	#include <libsigrok/libsigrok.h>
	28	#include "libsigrok-internal.h"
	29	#include "protocol.h"
	30
	31	#define DEFAULT_NUM_LOGIC_CHANNELS 8
	32	#define DEFAULT_LOGIC_PATTERN PATTERN_SIGROK
	33
	34	#define DEFAULT_NUM_ANALOG_CHANNELS 4
	35	#define DEFAULT_ANALOG_AMPLITUDE 10
	36
	37	/* Note: No spaces allowed because of sigrok-cli. */
	38	static const char *logic_pattern_str[] = {
	39	"sigrok",
	40	"random",
	41	"incremental",
	42	"walking-one",
	43	"walking-zero",
	44	"all-low",
	45	"all-high",
	46	"squid",
	47	"graycode",
	48	};
	49
	50	static const uint32_t scanopts[] = {
	51	SR_CONF_NUM_LOGIC_CHANNELS,
	52	SR_CONF_NUM_ANALOG_CHANNELS,
	53	SR_CONF_LIMIT_FRAMES,
	54	};
	55
	56	static const uint32_t drvopts[] = {
	57	SR_CONF_DEMO_DEV,
	58	SR_CONF_LOGIC_ANALYZER,
	59	SR_CONF_OSCILLOSCOPE,
	60	};
	61
	62	static const uint32_t devopts[] = {
	63	SR_CONF_CONTINUOUS,
	64	SR_CONF_LIMIT_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	65	SR_CONF_LIMIT_MSEC \| SR_CONF_GET \| SR_CONF_SET,
	66	SR_CONF_LIMIT_FRAMES \| SR_CONF_GET \| SR_CONF_SET,
	67	SR_CONF_SAMPLERATE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	68	SR_CONF_AVERAGING \| SR_CONF_GET \| SR_CONF_SET,
	69	SR_CONF_AVG_SAMPLES \| SR_CONF_GET \| SR_CONF_SET,
	70	};
	71
	72	static const uint32_t devopts_cg_logic[] = {
	73	SR_CONF_PATTERN_MODE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	74	};
	75
	76	static const uint32_t devopts_cg_analog_group[] = {
	77	SR_CONF_AMPLITUDE \| SR_CONF_GET \| SR_CONF_SET,
	78	};
	79
	80	static const uint32_t devopts_cg_analog_channel[] = {
	81	SR_CONF_PATTERN_MODE \| SR_CONF_GET \| SR_CONF_SET \| SR_CONF_LIST,
	82	SR_CONF_AMPLITUDE \| SR_CONF_GET \| SR_CONF_SET,
	83	};
	84
	85	static const uint64_t samplerates[] = {
	86	SR_HZ(1),
	87	SR_GHZ(1),
	88	SR_HZ(1),
	89	};
	90
	91	static GSList scan(struct sr_dev_driver di, GSList *options)
	92	{
	93	struct dev_context *devc;
	94	struct sr_dev_inst *sdi;
	95	struct sr_channel *ch;
	96	struct sr_channel_group cg, acg;
	97	struct sr_config *src;
	98	struct analog_gen *ag;
	99	GSList *l;
	100	int num_logic_channels, num_analog_channels, pattern, i;
	101	uint64_t limit_frames;
	102	char channel_name[16];
	103
	104	num_logic_channels = DEFAULT_NUM_LOGIC_CHANNELS;
	105	num_analog_channels = DEFAULT_NUM_ANALOG_CHANNELS;
	106	limit_frames = DEFAULT_LIMIT_FRAMES;
	107	for (l = options; l; l = l->next) {
	108	src = l->data;
	109	switch (src->key) {
	110	case SR_CONF_NUM_LOGIC_CHANNELS:
	111	num_logic_channels = g_variant_get_int32(src->data);
	112	break;
	113	case SR_CONF_NUM_ANALOG_CHANNELS:
	114	num_analog_channels = g_variant_get_int32(src->data);
	115	break;
	116	case SR_CONF_LIMIT_FRAMES:
	117	limit_frames = g_variant_get_uint64(src->data);
	118	break;
	119	}
	120	}
	121
	122	sdi = g_malloc0(sizeof(struct sr_dev_inst));
	123	sdi->status = SR_ST_INACTIVE;
	124	sdi->model = g_strdup("Demo device");
	125
	126	devc = g_malloc0(sizeof(struct dev_context));
	127	devc->cur_samplerate = SR_KHZ(200);
	128	devc->num_logic_channels = num_logic_channels;
	129	devc->logic_unitsize = (devc->num_logic_channels + 7) / 8;
	130	devc->all_logic_channels_mask = 1UL << 0;
	131	devc->all_logic_channels_mask <<= devc->num_logic_channels;
	132	devc->all_logic_channels_mask--;
	133	devc->logic_pattern = DEFAULT_LOGIC_PATTERN;
	134	devc->num_analog_channels = num_analog_channels;
	135	devc->limit_frames = limit_frames;
	136
	137	if (num_logic_channels > 0) {
	138	/* Logic channels, all in one channel group. */
	139	cg = g_malloc0(sizeof(struct sr_channel_group));
	140	cg->name = g_strdup("Logic");
	141	for (i = 0; i < num_logic_channels; i++) {
	142	sprintf(channel_name, "D%d", i);
	143	ch = sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name);
	144	cg->channels = g_slist_append(cg->channels, ch);
	145	}
	146	sdi->channel_groups = g_slist_append(NULL, cg);
	147	}
	148
	149	/* Analog channels, channel groups and pattern generators. */
	150	devc->ch_ag = g_hash_table_new(g_direct_hash, g_direct_equal);
	151	if (num_analog_channels > 0) {
	152	pattern = 0;
	153	/* An "Analog" channel group with all analog channels in it. */
	154	acg = g_malloc0(sizeof(struct sr_channel_group));
	155	acg->name = g_strdup("Analog");
	156	sdi->channel_groups = g_slist_append(sdi->channel_groups, acg);
	157
	158	for (i = 0; i < num_analog_channels; i++) {
	159	snprintf(channel_name, 16, "A%d", i);
	160	ch = sr_channel_new(sdi, i + num_logic_channels, SR_CHANNEL_ANALOG,
	161	TRUE, channel_name);
	162	acg->channels = g_slist_append(acg->channels, ch);
	163
	164	/* Every analog channel gets its own channel group as well. */
	165	cg = g_malloc0(sizeof(struct sr_channel_group));
	166	cg->name = g_strdup(channel_name);
	167	cg->channels = g_slist_append(NULL, ch);
	168	sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
	169
	170	/* Every channel gets a generator struct. */
	171	ag = g_malloc(sizeof(struct analog_gen));
	172	ag->ch = ch;
	173	ag->amplitude = DEFAULT_ANALOG_AMPLITUDE;
	174	sr_analog_init(&ag->packet, &ag->encoding, &ag->meaning, &ag->spec, 2);
	175	ag->packet.meaning->channels = cg->channels;
	176	ag->packet.meaning->mq = 0;
	177	ag->packet.meaning->mqflags = 0;
	178	ag->packet.meaning->unit = SR_UNIT_VOLT;
	179	ag->packet.data = ag->pattern_data;
	180	ag->pattern = pattern;
	181	ag->avg_val = 0.0f;
	182	ag->num_avgs = 0;
	183	g_hash_table_insert(devc->ch_ag, ch, ag);
	184
	185	if (++pattern == ARRAY_SIZE(analog_pattern_str))
	186	pattern = 0;
	187	}
	188	}
	189
	190	sdi->priv = devc;
	191
	192	return std_scan_complete(di, g_slist_append(NULL, sdi));
	193	}
	194
	195	static void clear_helper(struct dev_context *devc)
	196	{
	197	GHashTableIter iter;
	198	void *value;
	199
	200	/* Analog generators. */
	201	g_hash_table_iter_init(&iter, devc->ch_ag);
	202	while (g_hash_table_iter_next(&iter, NULL, &value))
	203	g_free(value);
	204	g_hash_table_unref(devc->ch_ag);
	205	}
	206
	207	static int dev_clear(const struct sr_dev_driver *di)
	208	{
	209	return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
	210	}
	211
	212	static int config_get(uint32_t key, GVariant **data,
	213	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	214	{
	215	struct dev_context *devc;
	216	struct sr_channel *ch;
	217	struct analog_gen *ag;
	218	int pattern;
	219
	220	if (!sdi)
	221	return SR_ERR_ARG;
	222
	223	devc = sdi->priv;
	224	switch (key) {
	225	case SR_CONF_SAMPLERATE:
	226	*data = g_variant_new_uint64(devc->cur_samplerate);
	227	break;
	228	case SR_CONF_LIMIT_SAMPLES:
	229	*data = g_variant_new_uint64(devc->limit_samples);
	230	break;
	231	case SR_CONF_LIMIT_MSEC:
	232	*data = g_variant_new_uint64(devc->limit_msec);
	233	break;
	234	case SR_CONF_LIMIT_FRAMES:
	235	*data = g_variant_new_uint64(devc->limit_frames);
	236	break;
	237	case SR_CONF_AVERAGING:
	238	*data = g_variant_new_boolean(devc->avg);
	239	break;
	240	case SR_CONF_AVG_SAMPLES:
	241	*data = g_variant_new_uint64(devc->avg_samples);
	242	break;
	243	case SR_CONF_PATTERN_MODE:
	244	if (!cg)
	245	return SR_ERR_CHANNEL_GROUP;
	246	/* Any channel in the group will do. */
	247	ch = cg->channels->data;
	248	if (ch->type == SR_CHANNEL_LOGIC) {
	249	pattern = devc->logic_pattern;
	250	*data = g_variant_new_string(logic_pattern_str[pattern]);
	251	} else if (ch->type == SR_CHANNEL_ANALOG) {
	252	ag = g_hash_table_lookup(devc->ch_ag, ch);
	253	pattern = ag->pattern;
	254	*data = g_variant_new_string(analog_pattern_str[pattern]);
	255	} else
	256	return SR_ERR_BUG;
	257	break;
	258	case SR_CONF_AMPLITUDE:
	259	if (!cg)
	260	return SR_ERR_CHANNEL_GROUP;
	261	/* Any channel in the group will do. */
	262	ch = cg->channels->data;
	263	if (ch->type != SR_CHANNEL_ANALOG)
	264	return SR_ERR_ARG;
	265	ag = g_hash_table_lookup(devc->ch_ag, ch);
	266	*data = g_variant_new_double(ag->amplitude);
	267	break;
	268	default:
	269	return SR_ERR_NA;
	270	}
	271
	272	return SR_OK;
	273	}
	274
	275	static int config_set(uint32_t key, GVariant *data,
	276	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	277	{
	278	struct dev_context *devc;
	279	struct analog_gen *ag;
	280	struct sr_channel *ch;
	281	GSList *l;
	282	int logic_pattern, analog_pattern;
	283
	284	devc = sdi->priv;
	285
	286	switch (key) {
	287	case SR_CONF_SAMPLERATE:
	288	devc->cur_samplerate = g_variant_get_uint64(data);
	289	break;
	290	case SR_CONF_LIMIT_SAMPLES:
	291	devc->limit_msec = 0;
	292	devc->limit_samples = g_variant_get_uint64(data);
	293	break;
	294	case SR_CONF_LIMIT_MSEC:
	295	devc->limit_msec = g_variant_get_uint64(data);
	296	devc->limit_samples = 0;
	297	break;
	298	case SR_CONF_LIMIT_FRAMES:
	299	devc->limit_frames = g_variant_get_uint64(data);
	300	break;
	301	case SR_CONF_AVERAGING:
	302	devc->avg = g_variant_get_boolean(data);
	303	sr_dbg("%s averaging", devc->avg ? "Enabling" : "Disabling");
	304	break;
	305	case SR_CONF_AVG_SAMPLES:
	306	devc->avg_samples = g_variant_get_uint64(data);
	307	sr_dbg("Setting averaging rate to %" PRIu64, devc->avg_samples);
	308	break;
	309	case SR_CONF_PATTERN_MODE:
	310	if (!cg)
	311	return SR_ERR_CHANNEL_GROUP;
	312	logic_pattern = std_str_idx(data, ARRAY_AND_SIZE(logic_pattern_str));
	313	analog_pattern = std_str_idx(data, ARRAY_AND_SIZE(analog_pattern_str));
	314	if (logic_pattern < 0 && analog_pattern < 0)
	315	return SR_ERR_ARG;
	316	for (l = cg->channels; l; l = l->next) {
	317	ch = l->data;
	318	if (ch->type == SR_CHANNEL_LOGIC) {
	319	if (logic_pattern == -1)
	320	return SR_ERR_ARG;
	321	sr_dbg("Setting logic pattern to %s",
	322	logic_pattern_str[logic_pattern]);
	323	devc->logic_pattern = logic_pattern;
	324	/* Might as well do this now, these are static. */
	325	if (logic_pattern == PATTERN_ALL_LOW)
	326	memset(devc->logic_data, 0x00, LOGIC_BUFSIZE);
	327	else if (logic_pattern == PATTERN_ALL_HIGH)
	328	memset(devc->logic_data, 0xff, LOGIC_BUFSIZE);
	329	} else if (ch->type == SR_CHANNEL_ANALOG) {
	330	if (analog_pattern == -1)
	331	return SR_ERR_ARG;
	332	sr_dbg("Setting analog pattern for channel %s to %s",
	333	ch->name, analog_pattern_str[analog_pattern]);
	334	ag = g_hash_table_lookup(devc->ch_ag, ch);
	335	ag->pattern = analog_pattern;
	336	} else
	337	return SR_ERR_BUG;
	338	}
	339	break;
	340	case SR_CONF_AMPLITUDE:
	341	if (!cg)
	342	return SR_ERR_CHANNEL_GROUP;
	343	for (l = cg->channels; l; l = l->next) {
	344	ch = l->data;
	345	if (ch->type != SR_CHANNEL_ANALOG)
	346	return SR_ERR_ARG;
	347	ag = g_hash_table_lookup(devc->ch_ag, ch);
	348	ag->amplitude = g_variant_get_double(data);
	349	}
	350	break;
	351	default:
	352	return SR_ERR_NA;
	353	}
	354
	355	return SR_OK;
	356	}
	357
	358	static int config_list(uint32_t key, GVariant **data,
	359	const struct sr_dev_inst sdi, const struct sr_channel_group cg)
	360	{
	361	struct sr_channel *ch;
	362
	363	if (!cg) {
	364	switch (key) {
	365	case SR_CONF_SCAN_OPTIONS:
	366	case SR_CONF_DEVICE_OPTIONS:
	367	return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
	368	case SR_CONF_SAMPLERATE:
	369	*data = std_gvar_samplerates_steps(ARRAY_AND_SIZE(samplerates));
	370	break;
	371	default:
	372	return SR_ERR_NA;
	373	}
	374	} else {
	375	ch = cg->channels->data;
	376	switch (key) {
	377	case SR_CONF_DEVICE_OPTIONS:
	378	if (ch->type == SR_CHANNEL_LOGIC)
	379	*data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_logic));
	380	else if (ch->type == SR_CHANNEL_ANALOG) {
	381	if (strcmp(cg->name, "Analog") == 0)
	382	*data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog_group));
	383	else
	384	*data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog_channel));
	385	}
	386	else
	387	return SR_ERR_BUG;
	388	break;
	389	case SR_CONF_PATTERN_MODE:
	390	/* The analog group (with all 4 channels) shall not have a pattern property. */
	391	if (strcmp(cg->name, "Analog") == 0)
	392	return SR_ERR_NA;
	393
	394	if (ch->type == SR_CHANNEL_LOGIC)
	395	*data = g_variant_new_strv(ARRAY_AND_SIZE(logic_pattern_str));
	396	else if (ch->type == SR_CHANNEL_ANALOG)
	397	*data = g_variant_new_strv(ARRAY_AND_SIZE(analog_pattern_str));
	398	else
	399	return SR_ERR_BUG;
	400	break;
	401	default:
	402	return SR_ERR_NA;
	403	}
	404	}
	405
	406	return SR_OK;
	407	}
	408
	409	static int dev_acquisition_start(const struct sr_dev_inst *sdi)
	410	{
	411	struct dev_context *devc;
	412	GSList *l;
	413	struct sr_channel *ch;
	414	int bitpos;
	415	uint8_t mask;
	416	GHashTableIter iter;
	417	void *value;
	418
	419	devc = sdi->priv;
	420	devc->sent_samples = 0;
	421	devc->sent_frame_samples = 0;
	422
	423	/*
	424	* Determine the numbers of logic and analog channels that are
	425	* involved in the acquisition. Determine an offset and a mask to
	426	* remove excess logic data content before datafeed submission.
	427	*/
	428	devc->enabled_logic_channels = 0;
	429	devc->enabled_analog_channels = 0;
	430	for (l = sdi->channels; l; l = l->next) {
	431	ch = l->data;
	432	if (!ch->enabled)
	433	continue;
	434	if (ch->type == SR_CHANNEL_ANALOG) {
	435	devc->enabled_analog_channels++;
	436	continue;
	437	}
	438	if (ch->type != SR_CHANNEL_LOGIC)
	439	continue;
	440	/*
	441	* TODO: Need we create a channel map here, such that the
	442	* session datafeed packets will have a dense representation
	443	* of the enabled channels' data? For example store channels
	444	* D3 and D5 in bit positions 0 and 1 respectively, when all
	445	* other channels are disabled? The current implementation
	446	* generates a sparse layout, might provide data for logic
	447	* channels that are disabled while it might suppress data
	448	* from enabled channels at the same time.
	449	*/
	450	devc->enabled_logic_channels++;
	451	}
	452	devc->first_partial_logic_index = devc->enabled_logic_channels / 8;
	453	bitpos = devc->enabled_logic_channels % 8;
	454	mask = (1 << bitpos) - 1;
	455	devc->first_partial_logic_mask = mask;
	456	sr_dbg("num logic %zu, partial off %zu, mask 0x%02x.",
	457	devc->enabled_logic_channels,
	458	devc->first_partial_logic_index,
	459	devc->first_partial_logic_mask);
	460
	461	/*
	462	* Have the waveform for analog patterns pre-generated. It's
	463	* supposed to be periodic, so the generator just needs to
	464	* access the prepared sample data (DDS style).
	465	*/
	466	g_hash_table_iter_init(&iter, devc->ch_ag);
	467	while (g_hash_table_iter_next(&iter, NULL, &value))
	468	demo_generate_analog_pattern(value, devc->cur_samplerate);
	469
	470	sr_session_source_add(sdi->session, -1, 0, 100,
	471	demo_prepare_data, (struct sr_dev_inst *)sdi);
	472
	473	std_session_send_df_header(sdi);
	474
	475	if (devc->limit_frames > 0)
	476	std_session_send_frame_begin(sdi);
	477
	478	/* We use this timestamp to decide how many more samples to send. */
	479	devc->start_us = g_get_monotonic_time();
	480	devc->spent_us = 0;
	481	devc->step = 0;
	482
	483	return SR_OK;
	484	}
	485
	486	static int dev_acquisition_stop(struct sr_dev_inst *sdi)
	487	{
	488	struct dev_context *devc;
	489
	490	sr_session_source_remove(sdi->session, -1);
	491
	492	devc = sdi->priv;
	493	if (devc->limit_frames > 0)
	494	std_session_send_frame_end(sdi);
	495
	496	std_session_send_df_end(sdi);
	497
	498	return SR_OK;
	499	}
	500
	501	static struct sr_dev_driver demo_driver_info = {
	502	.name = "demo",
	503	.longname = "Demo driver and pattern generator",
	504	.api_version = 1,
	505	.init = std_init,
	506	.cleanup = std_cleanup,
	507	.scan = scan,
	508	.dev_list = std_dev_list,
	509	.dev_clear = dev_clear,
	510	.config_get = config_get,
	511	.config_set = config_set,
	512	.config_list = config_list,
	513	.dev_open = std_dummy_dev_open,
	514	.dev_close = std_dummy_dev_close,
	515	.dev_acquisition_start = dev_acquisition_start,
	516	.dev_acquisition_stop = dev_acquisition_stop,
	517	.context = NULL,
	518	};
	519	SR_REGISTER_DEV_DRIVER(demo_driver_info);