[libsigrok.git] / output / vcd.c

/*
 * This file is part of the libsigrok project.
 *
 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
 * Copyright (C) 2013 Bert Vermeulen <bert@biot.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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#include <stdlib.h>
#include <string.h>
#include <glib.h>
#include "config.h" /* Needed for PACKAGE and others. */
#include "libsigrok.h"
#include "libsigrok-internal.h"

/* Message logging helpers with subsystem-specific prefix string. */
#define LOG_PREFIX "output/vcd: "
#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)

struct context {
	int num_enabled_probes;
	GArray *probeindices;
	GString *header;
	uint8_t *prevsample;
	int period;
	uint64_t samplerate;
	unsigned int unitsize;
};

static const char *vcd_header_comment = "\
$comment\n  Acquisition with %d/%d probes at %s\n$end\n";

static int init(struct sr_output *o)
{
	struct context *ctx;
	struct sr_probe *probe;
	GSList *l;
	GVariant *gvar;
	int num_probes, i;
	char *samplerate_s, *frequency_s, *timestamp;
	time_t t;

	if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
		sr_err("%s: ctx malloc failed", __func__);
		return SR_ERR_MALLOC;
	}

	o->internal = ctx;
	ctx->num_enabled_probes = 0;
	ctx->probeindices = g_array_new(FALSE, FALSE, sizeof(int));

	for (l = o->sdi->probes; l; l = l->next) {
		probe = l->data;
		if (!probe->enabled)
			continue;
		ctx->probeindices = g_array_append_val(
				ctx->probeindices, probe->index);
		ctx->num_enabled_probes++;
	}
	if (ctx->num_enabled_probes > 94) {
		sr_err("VCD only supports 94 probes.");
		return SR_ERR;
	}

	ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
	ctx->header = g_string_sized_new(512);
	num_probes = g_slist_length(o->sdi->probes);

	/* timestamp */
	t = time(NULL);
	timestamp = g_strdup(ctime(&t));
	timestamp[strlen(timestamp)-1] = 0;
	g_string_printf(ctx->header, "$date %s $end\n", timestamp);
	g_free(timestamp);

	/* generator */
	g_string_append_printf(ctx->header, "$version %s %s $end\n",
			PACKAGE, PACKAGE_VERSION);

	if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
			&gvar) == SR_OK) {
		ctx->samplerate = g_variant_get_uint64(gvar);
		g_variant_unref(gvar);
		if (!((samplerate_s = sr_samplerate_string(ctx->samplerate)))) {
			g_string_free(ctx->header, TRUE);
			g_free(ctx);
			return SR_ERR;
		}
		g_string_append_printf(ctx->header, vcd_header_comment,
				 ctx->num_enabled_probes, num_probes, samplerate_s);
		g_free(samplerate_s);
	}

	/* timescale */
	/* VCD can only handle 1/10/100 (s - fs), so scale up first */
	if (ctx->samplerate > SR_MHZ(1))
		ctx->period = SR_GHZ(1);
	else if (ctx->samplerate > SR_KHZ(1))
		ctx->period = SR_MHZ(1);
	else
		ctx->period = SR_KHZ(1);
	if (!(frequency_s = sr_period_string(ctx->period))) {
		g_string_free(ctx->header, TRUE);
		g_free(ctx);
		return SR_ERR;
	}
	g_string_append_printf(ctx->header, "$timescale %s $end\n", frequency_s);
	g_free(frequency_s);

	/* scope */
	g_string_append_printf(ctx->header, "$scope module %s $end\n", PACKAGE);

	/* Wires / channels */
	for (i = 0, l = o->sdi->probes; l; l = l->next, i++) {
		probe = l->data;
		if (!probe->enabled)
			continue;
		g_string_append_printf(ctx->header, "$var wire 1 %c %s $end\n",
				(char)('!' + i), probe->name);
	}

	g_string_append(ctx->header, "$upscope $end\n"
			"$enddefinitions $end\n$dumpvars\n");

	if (!(ctx->prevsample = g_try_malloc0(ctx->unitsize))) {
		g_string_free(ctx->header, TRUE);
		g_free(ctx);
		sr_err("%s: ctx->prevsample malloc failed", __func__);
		return SR_ERR_MALLOC;
	}

	return SR_OK;
}

static int receive(struct sr_output *o, const struct sr_dev_inst *sdi,
		const struct sr_datafeed_packet *packet, GString **out)
{
	const struct sr_datafeed_logic *logic;
	struct context *ctx;
	unsigned int i;
	int p, curbit, prevbit, index;
	uint8_t *sample;
	static uint64_t samplecount = 0;

	(void)sdi;

	*out = NULL;
	if (!o || !o->internal)
		return SR_ERR_ARG;
	ctx = o->internal;

	if (packet->type == SR_DF_END) {
		*out = g_string_new("$dumpoff\n$end\n");
		return SR_OK;
	} else if (packet->type != SR_DF_LOGIC)
		return SR_OK;

	if (ctx->header) {
		/* The header is still here, this must be the first packet. */
		*out = ctx->header;
		ctx->header = NULL;
	} else {
		*out = g_string_sized_new(512);
	}

	logic = packet->payload;
	for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
		samplecount++;

		sample = logic->data + i;

		for (p = 0; p < ctx->num_enabled_probes; p++) {
			index = g_array_index(ctx->probeindices, int, p);
			curbit = (sample[p / 8] & (((uint8_t) 1) << index)) >> index;
			prevbit = (ctx->prevsample[p / 8] & (((uint64_t) 1) << index)) >> index;

			/* VCD only contains deltas/changes of signals. */
			if (prevbit == curbit)
				continue;

			/* Output which signal changed to which value. */
			g_string_append_printf(*out, "#%" PRIu64 "\n%i%c\n",
					(uint64_t)(((float)samplecount / ctx->samplerate)
					* ctx->period), curbit, (char)('!' + p));
		}

		memcpy(ctx->prevsample, sample, ctx->unitsize);
	}

	return SR_OK;
}

static int cleanup(struct sr_output *o)
{
	struct context *ctx;

	if (!o || !o->internal)
		return SR_ERR_ARG;

	ctx = o->internal;
	g_free(ctx);

	return SR_OK;
}

struct sr_output_format output_vcd = {
	.id = "vcd",
	.description = "Value Change Dump (VCD)",
	.df_type = SR_DF_LOGIC,
	.init = init,
	.receive = receive,
	.cleanup = cleanup,
};
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) 2013 Bert Vermeulen <bert@biot.com>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	20	*/
	21
	22	#include <stdlib.h>
	23	#include <string.h>
	24	#include <glib.h>
	25	#include "config.h" /* Needed for PACKAGE and others. */
	26	#include "libsigrok.h"
	27	#include "libsigrok-internal.h"
	28
	29	/* Message logging helpers with subsystem-specific prefix string. */
	30	#define LOG_PREFIX "output/vcd: "
	31	#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
	32	#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
	33	#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
	34	#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
	35	#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
	36	#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
	37
	38	struct context {
	39	int num_enabled_probes;
	40	GArray *probeindices;
	41	GString *header;
	42	uint8_t *prevsample;
	43	int period;
	44	uint64_t samplerate;
	45	unsigned int unitsize;
	46	};
	47
	48	static const char *vcd_header_comment = "\
	49	$comment\n Acquisition with %d/%d probes at %s\n$end\n";
	50
	51	static int init(struct sr_output *o)
	52	{
	53	struct context *ctx;
	54	struct sr_probe *probe;
	55	GSList *l;
	56	GVariant *gvar;
	57	int num_probes, i;
	58	char samplerate_s, frequency_s, *timestamp;
	59	time_t t;
	60
	61	if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
	62	sr_err("%s: ctx malloc failed", __func__);
	63	return SR_ERR_MALLOC;
	64	}
	65
	66	o->internal = ctx;
	67	ctx->num_enabled_probes = 0;
	68	ctx->probeindices = g_array_new(FALSE, FALSE, sizeof(int));
	69
	70	for (l = o->sdi->probes; l; l = l->next) {
	71	probe = l->data;
	72	if (!probe->enabled)
	73	continue;
	74	ctx->probeindices = g_array_append_val(
	75	ctx->probeindices, probe->index);
	76	ctx->num_enabled_probes++;
	77	}
	78	if (ctx->num_enabled_probes > 94) {
	79	sr_err("VCD only supports 94 probes.");
	80	return SR_ERR;
	81	}
	82
	83	ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
	84	ctx->header = g_string_sized_new(512);
	85	num_probes = g_slist_length(o->sdi->probes);
	86
	87	/* timestamp */
	88	t = time(NULL);
	89	timestamp = g_strdup(ctime(&t));
	90	timestamp[strlen(timestamp)-1] = 0;
	91	g_string_printf(ctx->header, "$date %s $end\n", timestamp);
	92	g_free(timestamp);
	93
	94	/* generator */
	95	g_string_append_printf(ctx->header, "$version %s %s $end\n",
	96	PACKAGE, PACKAGE_VERSION);
	97
	98	if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
	99	&gvar) == SR_OK) {
	100	ctx->samplerate = g_variant_get_uint64(gvar);
	101	g_variant_unref(gvar);
	102	if (!((samplerate_s = sr_samplerate_string(ctx->samplerate)))) {
	103	g_string_free(ctx->header, TRUE);
	104	g_free(ctx);
	105	return SR_ERR;
	106	}
	107	g_string_append_printf(ctx->header, vcd_header_comment,
	108	ctx->num_enabled_probes, num_probes, samplerate_s);
	109	g_free(samplerate_s);
	110	}
	111
	112	/* timescale */
	113	/* VCD can only handle 1/10/100 (s - fs), so scale up first */
	114	if (ctx->samplerate > SR_MHZ(1))
	115	ctx->period = SR_GHZ(1);
	116	else if (ctx->samplerate > SR_KHZ(1))
	117	ctx->period = SR_MHZ(1);
	118	else
	119	ctx->period = SR_KHZ(1);
	120	if (!(frequency_s = sr_period_string(ctx->period))) {
	121	g_string_free(ctx->header, TRUE);
	122	g_free(ctx);
	123	return SR_ERR;
	124	}
	125	g_string_append_printf(ctx->header, "$timescale %s $end\n", frequency_s);
	126	g_free(frequency_s);
	127
	128	/* scope */
	129	g_string_append_printf(ctx->header, "$scope module %s $end\n", PACKAGE);
	130
	131	/* Wires / channels */
	132	for (i = 0, l = o->sdi->probes; l; l = l->next, i++) {
	133	probe = l->data;
	134	if (!probe->enabled)
	135	continue;
	136	g_string_append_printf(ctx->header, "$var wire 1 %c %s $end\n",
	137	(char)('!' + i), probe->name);
	138	}
	139
	140	g_string_append(ctx->header, "$upscope $end\n"
	141	"$enddefinitions $end\n$dumpvars\n");
	142
	143	if (!(ctx->prevsample = g_try_malloc0(ctx->unitsize))) {
	144	g_string_free(ctx->header, TRUE);
	145	g_free(ctx);
	146	sr_err("%s: ctx->prevsample malloc failed", __func__);
	147	return SR_ERR_MALLOC;
	148	}
	149
	150	return SR_OK;
	151	}
	152
	153	static int receive(struct sr_output o, const struct sr_dev_inst sdi,
	154	const struct sr_datafeed_packet packet, GString *out)
	155	{
	156	const struct sr_datafeed_logic *logic;
	157	struct context *ctx;
	158	unsigned int i;
	159	int p, curbit, prevbit, index;
	160	uint8_t *sample;
	161	static uint64_t samplecount = 0;
	162
	163	(void)sdi;
	164
	165	*out = NULL;
	166	if (!o \|\| !o->internal)
	167	return SR_ERR_ARG;
	168	ctx = o->internal;
	169
	170	if (packet->type == SR_DF_END) {
	171	*out = g_string_new("$dumpoff\n$end\n");
	172	return SR_OK;
	173	} else if (packet->type != SR_DF_LOGIC)
	174	return SR_OK;
	175
	176	if (ctx->header) {
	177	/* The header is still here, this must be the first packet. */
	178	*out = ctx->header;
	179	ctx->header = NULL;
	180	} else {
	181	*out = g_string_sized_new(512);
	182	}
	183
	184	logic = packet->payload;
	185	for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
	186	samplecount++;
	187
	188	sample = logic->data + i;
	189
	190	for (p = 0; p < ctx->num_enabled_probes; p++) {
	191	index = g_array_index(ctx->probeindices, int, p);
	192	curbit = (sample[p / 8] & (((uint8_t) 1) << index)) >> index;
	193	prevbit = (ctx->prevsample[p / 8] & (((uint64_t) 1) << index)) >> index;
	194
	195	/* VCD only contains deltas/changes of signals. */
	196	if (prevbit == curbit)
	197	continue;
	198
	199	/* Output which signal changed to which value. */
	200	g_string_append_printf(*out, "#%" PRIu64 "\n%i%c\n",
	201	(uint64_t)(((float)samplecount / ctx->samplerate)
	202	* ctx->period), curbit, (char)('!' + p));
	203	}
	204
	205	memcpy(ctx->prevsample, sample, ctx->unitsize);
	206	}
	207
	208	return SR_OK;
	209	}
	210
	211	static int cleanup(struct sr_output *o)
	212	{
	213	struct context *ctx;
	214
	215	if (!o \|\| !o->internal)
	216	return SR_ERR_ARG;
	217
	218	ctx = o->internal;
	219	g_free(ctx);
	220
	221	return SR_OK;
	222	}
	223
	224	struct sr_output_format output_vcd = {
	225	.id = "vcd",
	226	.description = "Value Change Dump (VCD)",
	227	.df_type = SR_DF_LOGIC,
	228	.init = init,
	229	.receive = receive,
	230	.cleanup = cleanup,
	231	};