/*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
*
* Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
+ * 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
#include "libsigrok.h"
#include "libsigrok-internal.h"
+#define LOG_PREFIX "output/vcd"
+
struct context {
- int num_enabled_probes;
- int unitsize;
- char *probelist[SR_MAX_NUM_PROBES + 1];
- int *prevbits;
- GString *header;
- uint64_t prevsample;
+ int num_enabled_channels;
+ GArray *channelindices;
+ uint8_t *prevsample;
+ gboolean header_done;
int period;
+ int *channel_index;
uint64_t samplerate;
+ 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;
- uint64_t *samplerate;
- 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("vcd out: %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->probelist[ctx->num_enabled_probes++] = probe->name;
- }
- if (ctx->num_enabled_probes > 94) {
- sr_err("vcd out: VCD only supports 94 probes.");
- return SR_ERR;
+ if (!ch->enabled)
+ continue;
+ ctx->channel_index[i++] = ch->index;
}
- 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->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);
-
- if (o->sdi->driver && sr_dev_has_hwcap(o->sdi, SR_HWCAP_SAMPLERATE)) {
- o->sdi->driver->info_get(SR_DI_CUR_SAMPLERATE,
- (const void **)&samplerate, o->sdi);
- ctx->samplerate = *samplerate;
- if (!((samplerate_s = sr_samplerate_string(ctx->samplerate)))) {
- g_string_free(ctx->header, TRUE);
- g_free(ctx);
- return SR_ERR;
+ g_string_append_printf(header, "$comment\n Acquisition with "
+ "%d/%d channels", ctx->num_enabled_channels, num_channels);
+
+ 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);
}
- 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_string_append_printf(header, "\n$end\n");
/* timescale */
/* VCD can only handle 1/10/100 (s - fs), so scale up first */
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; i < ctx->num_enabled_probes; i++) {
- g_string_append_printf(ctx->header, "$var wire 1 %c %s $end\n",
- (char)('!' + i), ctx->probelist[i]);
+ for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
+ ch = l->data;
+ if (ch->type != SR_CHANNEL_LOGIC)
+ continue;
+ 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->prevbits = g_try_malloc0(sizeof(int) * num_probes))) {
- g_string_free(ctx->header, TRUE);
- g_free(ctx);
- sr_err("vcd out: %s: ctx->prevbits malloc failed", __func__);
- return SR_ERR_MALLOC;
- }
+ g_string_append(header, "$upscope $end\n$enddefinitions $end\n");
- return SR_OK;
+ return header;
}
-static int event(struct sr_output *o, int event_type, uint8_t **data_out,
- uint64_t *length_out)
+static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
+ GString **out)
{
- uint8_t *outbuf;
+ const struct sr_datafeed_meta *meta;
+ const struct sr_datafeed_logic *logic;
+ const struct sr_config *src;
+ GSList *l;
+ struct context *ctx;
+ unsigned int i;
+ int p, curbit, prevbit, index;
+ uint8_t *sample;
+ gboolean timestamp_written;
- switch (event_type) {
- case SR_DF_END:
- outbuf = (uint8_t *)g_strdup("$dumpoff\n$end\n");
- *data_out = outbuf;
- *length_out = strlen((const char *)outbuf);
- g_free(o->internal);
- o->internal = NULL;
- break;
- default:
- *data_out = NULL;
- *length_out = 0;
+ *out = NULL;
+ if (!o || !o->internal)
+ return SR_ERR_BUG;
+ ctx = o->internal;
+
+ 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);
+ }
- return SR_OK;
-}
+ if (!ctx->prevsample) {
+ /* Can't allocate this until we know the stream's unitsize. */
+ ctx->prevsample = g_malloc0(logic->unitsize);
+ }
-static int data(struct sr_output *o, const uint8_t *data_in,
- uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
-{
- struct context *ctx;
- unsigned int i;
- int p, curbit, prevbit;
- uint64_t sample;
- static uint64_t samplecount = 0;
- GString *out;
- int first_sample = 0;
+ for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
+ sample = logic->data + i;
+ timestamp_written = FALSE;
- ctx = o->internal;
- out = g_string_sized_new(512);
-
- if (ctx->header) {
- /* The header is still here, this must be the first packet. */
- g_string_append(out, ctx->header->str);
- g_string_free(ctx->header, TRUE);
- ctx->header = NULL;
- first_sample = 1;
- }
+ for (p = 0; p < ctx->num_enabled_channels; p++) {
+ index = ctx->channel_index[p];
- for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
- samplecount++;
+ curbit = ((unsigned)sample[index / 8]
+ >> (index % 8)) & 1;
+ prevbit = ((unsigned)ctx->prevsample[index / 8]
+ >> (index % 8)) & 1;
- memcpy(&sample, data_in + i, ctx->unitsize);
+ /* VCD only contains deltas/changes of signals. */
+ if (prevbit == curbit && ctx->samplecount > 0)
+ continue;
- if (first_sample) {
- /* First packet. We neg to make sure sample is stored. */
- ctx->prevsample = ~sample;
- first_sample = 0;
- }
+ /* Output timestamp of subsequent signal changes. */
+ if (!timestamp_written)
+ g_string_append_printf(*out, "#%.0f",
+ (double)ctx->samplecount /
+ ctx->samplerate * ctx->period);
- for (p = 0; p < ctx->num_enabled_probes; p++) {
- curbit = (sample & ((uint64_t) (1 << p))) >> p;
- prevbit = (ctx->prevsample & ((uint64_t) (1 << p))) >> p;
+ /* 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);
- /* VCD only contains deltas/changes of signals. */
- if (prevbit == curbit)
- continue;
+ timestamp_written = TRUE;
+ }
- /* 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));
- }
+ if (timestamp_written)
+ g_string_append_c(*out, '\n');
- ctx->prevsample = sample;
+ 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;
}
- *data_out = (uint8_t *)out->str;
- *length_out = out->len;
- g_string_free(out, FALSE);
+ 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->prevsample);
+ g_free(ctx->channel_index);
+ 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,
- .data = data,
- .event = event,
+ .receive = receive,
+ .cleanup = cleanup,
};
projects / libsigrok.git / blobdiff