X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=output%2Fvcd.c;h=87f8049603d6ff3733c91643e5d67188e72110ae;hb=00ebcbf48a775e56b6e73a39e69af390db547865;hp=0ede5fe7a42318bee28d83e481347107aff9fbab;hpb=d601c0e9b37be9174c8a4447aa05aeb7be82be73;p=libsigrok.git

diff --git a/output/vcd.c b/output/vcd.c
index 0ede5fe7..87f80496 100644
--- a/output/vcd.c
+++ b/output/vcd.c
@@ -26,87 +26,102 @@
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* Message logging helpers with driver-specific prefix string. */
-#define DRIVER_LOG_DOMAIN "output/vcd: "
-#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
-#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
+#define LOG_PREFIX "output/vcd"
 
 struct context {
-	int num_enabled_probes;
-	int probeindices[SR_MAX_NUM_PROBES + 1];
-	GString *header;
+	int num_enabled_channels;
+	GArray *channelindices;
 	uint8_t *prevsample;
+	gboolean header_done;
 	int period;
+	int *channel_index;
 	uint64_t samplerate;
-	unsigned int unitsize;
+	uint64_t samplecount;
 };
 
-static const char *vcd_header_comment = "\
-$comment\n  Acquisition with %d/%d probes at %s\n$end\n";
+static const char *const vcd_header_comment =
+	"$comment\n  Acquisition with %d/%d channels at %s\n$end\n";
 
 static int init(struct sr_output *o)
 {
 	struct context *ctx;
-	struct sr_probe *probe;
+	struct sr_channel *ch;
 	GSList *l;
-	GVariant *gvar;
-	int num_probes, i;
-	char *samplerate_s, *frequency_s, *timestamp;
-	time_t t;
+	int num_enabled_channels, i;
 
-	if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
-		sr_err("%s: ctx malloc failed", __func__);
-		return SR_ERR_MALLOC;
+	num_enabled_channels = 0;
+	for (l = o->sdi->channels; l; l = l->next) {
+		ch = l->data;
+		if (ch->type != SR_CHANNEL_LOGIC)
+			continue;
+		if (!ch->enabled)
+			continue;
+		num_enabled_channels++;
+	}
+	if (num_enabled_channels > 94) {
+		sr_err("VCD only supports 94 channels.");
+		return SR_ERR;
 	}
 
+	ctx = g_malloc0(sizeof(struct context));
 	o->internal = ctx;
-	ctx->num_enabled_probes = 0;
+	ctx->num_enabled_channels = num_enabled_channels;
+	ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
 
-	for (l = o->sdi->probes; l; l = l->next) {
-		probe = l->data;
-		if (!probe->enabled)
+	/* Once more to map the enabled channels. */
+	for (i = 0, l = o->sdi->channels; l; l = l->next) {
+		ch = l->data;
+		if (ch->type != SR_CHANNEL_LOGIC)
 			continue;
-		ctx->probeindices[ctx->num_enabled_probes] = probe->index;
-		ctx->num_enabled_probes++;
-	}
-	if (ctx->num_enabled_probes > 94) {
-		sr_err("VCD only supports 94 probes.");
-		return SR_ERR;
+		if (!ch->enabled)
+			continue;
+		ctx->channel_index[i++] = ch->index;
 	}
 
-	ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
-	ctx->header = g_string_sized_new(512);
-	num_probes = g_slist_length(o->sdi->probes);
+	return SR_OK;
+}
+
+static GString *gen_header(struct sr_output *o)
+{
+	struct context *ctx;
+	struct sr_channel *ch;
+	GVariant *gvar;
+	GString *header;
+	GSList *l;
+	time_t t;
+	int num_channels, i;
+	char *samplerate_s, *frequency_s, *timestamp;
+
+	ctx = o->internal;
+	header = g_string_sized_new(512);
+	num_channels = g_slist_length(o->sdi->channels);
 
 	/* 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_string_printf(header, "$date %s $end\n", timestamp);
 	g_free(timestamp);
 
 	/* generator */
-	g_string_append_printf(ctx->header, "$version %s %s $end\n",
+	g_string_append_printf(header, "$version %s %s $end\n",
 			PACKAGE, PACKAGE_VERSION);
+	g_string_append_printf(header, "$comment\n  Acquisition with "
+			"%d/%d channels", ctx->num_enabled_channels, num_channels);
 
-	if (o->sdi->driver && sr_dev_has_option(o->sdi, SR_CONF_SAMPLERATE)) {
-		o->sdi->driver->config_get(SR_CONF_SAMPLERATE, &gvar, o->sdi);
-		ctx->samplerate = g_variant_get_uint64(gvar);
-		if (!((samplerate_s = sr_samplerate_string(ctx->samplerate)))) {
-			g_string_free(ctx->header, TRUE);
-			g_free(ctx);
+	if (ctx->samplerate == 0) {
+		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);
-			return SR_ERR;
 		}
-		g_string_append_printf(ctx->header, vcd_header_comment,
-				 ctx->num_enabled_probes, num_probes, samplerate_s);
+	}
+	if (ctx->samplerate != 0) {
+		samplerate_s = sr_samplerate_string(ctx->samplerate);
+		g_string_append_printf(header, " at %s", samplerate_s);
 		g_free(samplerate_s);
-		g_variant_unref(gvar);
 	}
+	g_string_append_printf(header, "\n$end\n");
 
 	/* timescale */
 	/* VCD can only handle 1/10/100 (s - fs), so scale up first */
@@ -116,96 +131,118 @@ static int init(struct sr_output *o)
 		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);
+	frequency_s = sr_period_string(ctx->period);
+	g_string_append_printf(header, "$timescale %s $end\n", frequency_s);
 	g_free(frequency_s);
 
 	/* scope */
-	g_string_append_printf(ctx->header, "$scope module %s $end\n", PACKAGE);
+	g_string_append_printf(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)
+	for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
+		ch = l->data;
+		if (ch->type != SR_CHANNEL_LOGIC)
 			continue;
-		g_string_append_printf(ctx->header, "$var wire 1 %c %s $end\n",
-				(char)('!' + i), probe->name);
+		if (!ch->enabled)
+			continue;
+		g_string_append_printf(header, "$var wire 1 %c %s $end\n",
+				(char)('!' + i), ch->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;
-	}
+	g_string_append(header, "$upscope $end\n$enddefinitions $end\n");
 
-	return SR_OK;
+	return header;
 }
 
-static GString *receive(struct sr_output *o, const struct sr_dev_inst *sdi,
-		const struct sr_datafeed_packet *packet)
+static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
+		GString **out)
 {
+	const struct sr_datafeed_meta *meta;
 	const struct sr_datafeed_logic *logic;
+	const struct sr_config *src;
+	GSList *l;
 	struct context *ctx;
-	GString *text;
 	unsigned int i;
 	int p, curbit, prevbit, index;
 	uint8_t *sample;
-	static uint64_t samplecount = 0;
-
-	(void)sdi;
+	gboolean timestamp_written;
 
+	*out = NULL;
 	if (!o || !o->internal)
-		return NULL;
+		return SR_ERR_BUG;
 	ctx = o->internal;
 
-	if (packet->type == SR_DF_END) {
-		text = g_string_sized_new(16);
-		g_string_printf(text, "$dumpoff\n$end\n");
-		return text;
-	} else if (packet->type != SR_DF_LOGIC)
-		return NULL;
-
-	if (ctx->header) {
-		/* The header is still here, this must be the first packet. */
-		text = ctx->header;
-		ctx->header = NULL;
-	} else {
-		text = g_string_sized_new(512);
-	}
+	switch (packet->type) {
+	case SR_DF_META:
+		meta = packet->payload;
+		for (l = meta->config; l; l = l->next) {
+			src = l->data;
+			if (src->key != SR_CONF_SAMPLERATE)
+				continue;
+			ctx->samplerate = g_variant_get_uint64(src->data);
+		}
+		break;
+	case SR_DF_LOGIC:
+		logic = packet->payload;
+
+		if (!ctx->header_done) {
+			*out = gen_header(o);
+			ctx->header_done = TRUE;
+		} else {
+			*out = g_string_sized_new(512);
+		}
+
+		if (!ctx->prevsample) {
+			/* Can't allocate this until we know the stream's unitsize. */
+			ctx->prevsample = g_malloc0(logic->unitsize);
+		}
 
-	logic = packet->payload;
-	for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
-		samplecount++;
+		for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
+			sample = logic->data + i;
+			timestamp_written = FALSE;
 
-		sample = logic->data + i;
+			for (p = 0; p < ctx->num_enabled_channels; p++) {
+				index = ctx->channel_index[p];
 
-		for (p = 0; p < ctx->num_enabled_probes; p++) {
-			index = ctx->probeindices[p % 8];
-			curbit = (sample[p / 8] & (((uint8_t) 1) << index)) >> index;
-			prevbit = (ctx->prevsample[p / 8] & (((uint64_t) 1) << index)) >> index;
+				curbit = ((unsigned)sample[index / 8]
+						>> (index % 8)) & 1;
+				prevbit = ((unsigned)ctx->prevsample[index / 8]
+						>> (index % 8)) & 1;
 
-			/* VCD only contains deltas/changes of signals. */
-			if (prevbit == curbit)
-				continue;
+				/* VCD only contains deltas/changes of signals. */
+				if (prevbit == curbit && ctx->samplecount > 0)
+					continue;
 
-			/* Output which signal changed to which value. */
-			g_string_append_printf(text, "#%" PRIu64 "\n%i%c\n",
-					(uint64_t)(((float)samplecount / ctx->samplerate)
-					* ctx->period), curbit, (char)('!' + p));
-		}
+				/* Output timestamp of subsequent signal changes. */
+				if (!timestamp_written)
+					g_string_append_printf(*out, "#%.0f",
+						(double)ctx->samplecount /
+							ctx->samplerate * ctx->period);
 
-		memcpy(ctx->prevsample, sample, ctx->unitsize);
+				/* Output which signal changed to which value. */
+				g_string_append_c(*out, ' ');
+				g_string_append_c(*out, '0' + curbit);
+				g_string_append_c(*out, '!' + p);
+
+				timestamp_written = TRUE;
+			}
+
+			if (timestamp_written)
+				g_string_append_c(*out, '\n');
+
+			ctx->samplecount++;
+			memcpy(ctx->prevsample, sample, logic->unitsize);
+		}
+		break;
+	case SR_DF_END:
+		/* Write final timestamp as length indicator. */
+		*out = g_string_sized_new(512);
+		g_string_printf(*out, "#%.0f\n",
+				(double)ctx->samplecount / ctx->samplerate * ctx->period);
+		break;
 	}
 
-	return text;
+	return SR_OK;
 }
 
 static int cleanup(struct sr_output *o)
@@ -216,6 +253,8 @@ static int cleanup(struct sr_output *o)
 		return SR_ERR_ARG;
 
 	ctx = o->internal;
+	g_free(ctx->prevsample);
+	g_free(ctx->channel_index);
 	g_free(ctx);
 
 	return SR_OK;
@@ -224,8 +263,7 @@ static int cleanup(struct sr_output *o)
 struct sr_output_format output_vcd = {
 	.id = "vcd",
 	.description = "Value Change Dump (VCD)",
-	.df_type = SR_DF_LOGIC,
 	.init = init,
-	.recv = receive,
+	.receive = receive,
 	.cleanup = cleanup,
 };