X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=output%2Foutput_vcd.c;h=1c5d723d1abd9664ab40368d953c719851cfe809;hb=120b259ea8f17b74deca3ba4b71e78771539bde8;hp=a147f5a962a71056ee36b48d169f27962b2dfa23;hpb=e273a9040e10c1297c758fe35eb522bd5470e708;p=libsigrok.git

diff --git a/output/output_vcd.c b/output/output_vcd.c
index a147f5a9..1c5d723d 100644
--- a/output/output_vcd.c
+++ b/output/output_vcd.c
@@ -2,6 +2,7 @@
  * This file is part of the sigrok project.
  *
  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2011 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
@@ -29,174 +30,192 @@ struct context {
 	int unitsize;
 	char *probelist[65];
 	int *prevbits;
-	char *header;
+	GString *header;
+	uint64_t prevsample;
+	int period;
+	uint64_t samplerate;
 };
 
-const char *vcd_header = "\
-$date\n  %s\n$end\n\
-$version\n  %s\n$end\n\
-$comment\n  Acquisition with %d/%d probes at %s\n$end\n\
-$timescale\n  %i %s\n$end\n\
-$scope module %s $end\n\
-%s\
-$upscope $end\n\
-$enddefinitions $end\n\
-$dumpvars\n";
-
-static int init(struct output *o)
-{
-/* Maximum header length */
-#define MAX_HEADER_LEN 2048
+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 probe *probe;
+	struct sr_probe *probe;
 	GSList *l;
-	uint64_t samplerate;
-	int i, b, num_probes;
-	char *c, *samplerate_s;
-	char wbuf[1000];
+	int num_probes, i;
+	char *samplerate_s, *frequency_s, *timestamp;
+	time_t t;
+
+	if (!(ctx = calloc(1, sizeof(struct context))))
+		return SR_ERR_MALLOC;
 
-	ctx = malloc(sizeof(struct context));
-	if (ctx == NULL)
-		return SIGROK_ERR_MALLOC;
 	o->internal = ctx;
 	ctx->num_enabled_probes = 0;
+
 	for (l = o->device->probes; l; l = l->next) {
 		probe = l->data;
-		if (probe->enabled)
-			ctx->probelist[ctx->num_enabled_probes++] = probe->name;
+		if (!probe->enabled)
+			continue;
+		ctx->probelist[ctx->num_enabled_probes++] = probe->name;
+	}
+	if (ctx->num_enabled_probes > 94) {
+		g_warning("VCD only supports 94 probes.");
+		return SR_ERR;
 	}
 
 	ctx->probelist[ctx->num_enabled_probes] = 0;
 	ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
+	ctx->header = g_string_sized_new(512);
+	num_probes = g_slist_length(o->device->probes);
 
-	/* TODO: Allow for configuration via o->param. */
+	/* timestamp */
+	t = time(NULL);
+	timestamp = strdup(ctime(&t));
+	timestamp[strlen(timestamp)-1] = 0;
+	g_string_printf(ctx->header, "$date %s $end\n", timestamp);
+	free(timestamp);
+
+	/* generator */
+	g_string_append_printf(ctx->header, "$version %s %s $end\n",
+			PACKAGE, PACKAGE_VERSION);
+
+	if (o->device->plugin && sr_device_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) {
+		ctx->samplerate = *((uint64_t *) o->device->plugin->get_device_info(
+				o->device->plugin_index, SR_DI_CUR_SAMPLERATE));
+		if (!((samplerate_s = sr_samplerate_string(ctx->samplerate)))) {
+			g_string_free(ctx->header, TRUE);
+			free(ctx);
+			return SR_ERR;
+		}
+		g_string_append_printf(ctx->header, vcd_header_comment,
+				 ctx->num_enabled_probes, num_probes, samplerate_s);
+		free(samplerate_s);
+	}
 
-	ctx->header = calloc(1, MAX_HEADER_LEN + 1);
-	if (ctx->header == NULL)
-		return SIGROK_ERR_MALLOC;
-	num_probes = g_slist_length(o->device->probes);
-	/* TODO: Handle num_probes == 0, too many probes, etc. */
-	samplerate = *((uint64_t *) o->device->plugin->get_device_info(
-			o->device->plugin_index, DI_CUR_SAMPLERATE));
+	/* 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);
+		free(ctx);
+		return SR_ERR;
+	}
+	g_string_append_printf(ctx->header, "$timescale %s $end\n", frequency_s);
+	free(frequency_s);
 
-	if ((samplerate_s = sigrok_samplerate_string(samplerate)) == NULL)
-		return -1; /* FIXME */
+	/* scope */
+	g_string_append_printf(ctx->header, "$scope module %s $end\n", PACKAGE);
 
 	/* Wires / channels */
-	wbuf[0] = '\0';
 	for (i = 0; i < ctx->num_enabled_probes; i++) {
-		c = (char *)&wbuf + strlen((char *)&wbuf);
-		sprintf(c, "$var wire 1 %c channel%s $end\n",
-			(char)('!' + i), ctx->probelist[i]);
+		g_string_append_printf(ctx->header, "$var wire 1 %c %s $end\n",
+				(char)('!' + i), ctx->probelist[i]);
 	}
 
-	/* TODO: Date: File or signals? Make y/n configurable. */
-	b = snprintf(ctx->header, MAX_HEADER_LEN, vcd_header, "TODO: Date",
-		     PACKAGE_STRING, ctx->num_enabled_probes, num_probes,
-		     samplerate_s, 1, "ns", PACKAGE, (char *)&wbuf);
-	/* TODO: Handle snprintf errors. */
-
-	free(samplerate_s);
+	g_string_append(ctx->header, "$upscope $end\n"
+			"$enddefinitions $end\n$dumpvars\n");
 
-	ctx->prevbits = calloc(sizeof(int), num_probes);
-	if (ctx->prevbits == NULL)
-		return SIGROK_ERR_MALLOC;
+	if (!(ctx->prevbits = calloc(sizeof(int), num_probes))) {
+		g_string_free(ctx->header, TRUE);
+		free(ctx);
+		return SR_ERR_MALLOC;
+	}
 
-	return 0;
+	return SR_OK;
 }
 
-static int event(struct output *o, int event_type, char **data_out,
+static int event(struct sr_output *o, int event_type, char **data_out,
 		 uint64_t *length_out)
 {
 	struct context *ctx;
 	char *outbuf;
-	int outlen;
 
 	ctx = o->internal;
 	switch (event_type) {
-	case DF_TRIGGER:
-		break;
-	case DF_END:
-		outlen = strlen("$dumpoff\n$end\n");
-		outbuf = malloc(outlen + 1);
-		if (outbuf == NULL)
-			return SIGROK_ERR_MALLOC;
-		snprintf(outbuf, outlen + 1, "$dumpoff\n$end\n");
+	case SR_DF_END:
+		outbuf = strdup("$dumpoff\n$end\n");
 		*data_out = outbuf;
-		*length_out = outlen;
+		*length_out = strlen(outbuf);
 		free(o->internal);
 		o->internal = NULL;
 		break;
+	default:
+		*data_out = NULL;
+		*length_out = 0;
+		break;
 	}
 
-	return SIGROK_OK;
+	return SR_OK;
 }
 
-static int data(struct output *o, char *data_in, uint64_t length_in,
+static int data(struct sr_output *o, const char *data_in, uint64_t length_in,
 		char **data_out, uint64_t *length_out)
 {
 	struct context *ctx;
-	unsigned int offset, outsize;
+	unsigned int i;
 	int p, curbit, prevbit;
-	uint64_t sample, prevsample;
-	char *outbuf, *c;
+	uint64_t sample;
+	static uint64_t samplecount = 0;
+	GString *out;
+	int first_sample = 0;
 
 	ctx = o->internal;
-	outsize = 0;
-	if (ctx->header)
-		outsize = strlen(ctx->header);
-	outbuf = calloc(1, outsize + 1 + 10000); /* FIXME: Use realloc(). */
-	if (outbuf == NULL)
-		return SIGROK_ERR_MALLOC;
+	out = g_string_sized_new(512);
+
 	if (ctx->header) {
 		/* The header is still here, this must be the first packet. */
-		strncpy(outbuf, ctx->header, outsize);
-		free(ctx->header);
+		g_string_append(out, ctx->header->str);
+		g_string_free(ctx->header, TRUE);
 		ctx->header = NULL;
-	} else {
-		outbuf[0] = 0;
+		first_sample = 1;
 	}
 
-	/* TODO: Are disabled probes handled correctly? */
+	for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
+		samplecount++;
+
+		memcpy(&sample, data_in + i, ctx->unitsize);
+
+		if (first_sample) {
+			/* First packet. We neg to make sure sample is stored. */
+			ctx->prevsample = ~sample;
+			first_sample = 0;
+		}
 
-	for (offset = 0; offset <= length_in - ctx->unitsize;
-	     offset += ctx->unitsize) {
-		memcpy(&sample, data_in + offset, ctx->unitsize);
 		for (p = 0; p < ctx->num_enabled_probes; p++) {
-			curbit = (sample & ((uint64_t) (1 << p))) != 0;
-			if (offset == 0) {
-				prevbit = ~curbit;
-			} else {
-				memcpy(&prevsample, data_in + offset - 1,
-				       ctx->unitsize);
-				prevbit =
-				    (prevsample & ((uint64_t) (1 << p))) != 0;
-			}
-
-			if (prevbit != curbit) {
-				/* FIXME: Only once per sample? */
-				c = outbuf + strlen(outbuf);
-				sprintf(c, "#%i\n", offset * 1 /* TODO */);
-
-				c = outbuf + strlen(outbuf);
-				sprintf(c, "%i%c\n", curbit,
-					(char)('!' + p /* FIXME? */));
-			}
+			curbit = (sample & ((uint64_t) (1 << p))) >> p;
+			prevbit = (ctx->prevsample & ((uint64_t) (1 << p))) >> p;
+
+			/* 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));
 		}
 
-		/* TODO: Use realloc() if strlen(outbuf) is almost "full"... */
+		ctx->prevsample = sample;
 	}
 
-	*data_out = outbuf;
-	*length_out = strlen(outbuf);
+	*data_out = out->str;
+	*length_out = out->len;
+	g_string_free(out, FALSE);
 
-	return SIGROK_OK;
+	return SR_OK;
 }
 
-struct output_format output_vcd = {
+struct sr_output_format output_vcd = {
 	"vcd",
 	"Value Change Dump (VCD)",
+	SR_DF_LOGIC,
 	init,
 	data,
 	event,