/*
- * 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"
-/* 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 unitsize;
- char *probelist[SR_MAX_NUM_PROBES + 1];
- int *prevbits;
+ int num_enabled_channels;
+ GArray *channelindices;
GString *header;
- uint64_t prevsample;
+ uint8_t *prevsample;
int period;
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;
+ GVariant *gvar;
+ int num_channels, i;
char *samplerate_s, *frequency_s, *timestamp;
time_t t;
- if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
+ if (!(ctx = g_malloc0(sizeof(struct context)))) {
sr_err("%s: ctx malloc failed", __func__);
return SR_ERR_MALLOC;
}
o->internal = ctx;
- ctx->num_enabled_probes = 0;
+ ctx->num_enabled_channels = 0;
+ ctx->channelindices = g_array_new(FALSE, FALSE, sizeof(int));
- for (l = o->sdi->probes; l; l = l->next) {
- probe = l->data;
- if (!probe->enabled)
+ for (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 (!ch->enabled)
+ continue;
+ ctx->channelindices = g_array_append_val(
+ ctx->channelindices, ch->index);
+ ctx->num_enabled_channels++;
}
- if (ctx->num_enabled_probes > 94) {
- sr_err("VCD only supports 94 probes.");
+ if (ctx->num_enabled_channels > 94) {
+ sr_err("VCD only supports 94 channels.");
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->sdi->probes);
+ num_channels = g_slist_length(o->sdi->channels);
/* timestamp */
t = time(NULL);
g_string_append_printf(ctx->header, "$version %s %s $end\n",
PACKAGE, PACKAGE_VERSION);
- if (o->sdi->driver && sr_dev_has_option(o->sdi, SR_CONF_SAMPLERATE)) {
- o->sdi->driver->config_get(SR_CONF_SAMPLERATE,
- (const void **)&samplerate, o->sdi);
- ctx->samplerate = *samplerate;
+ 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);
+ ctx->num_enabled_channels, num_channels, samplerate_s);
g_free(samplerate_s);
}
g_string_append_printf(ctx->header, "$scope module %s $end\n", PACKAGE);
/* Wires / channels */
- for (i = 0; i < ctx->num_enabled_probes; 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(ctx->header, "$var wire 1 %c %s $end\n",
- (char)('!' + i), ctx->probelist[i]);
+ (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("%s: ctx->prevbits malloc failed", __func__);
- return SR_ERR_MALLOC;
- }
+ "$enddefinitions $end\n");
return SR_OK;
}
-static int event(struct sr_output *o, int event_type, uint8_t **data_out,
- uint64_t *length_out)
-{
- uint8_t *outbuf;
-
- 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;
- break;
- }
-
- return SR_OK;
-}
-
-static int data(struct sr_output *o, const uint8_t *data_in,
- uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
+static int receive(struct sr_output *o, const struct sr_datafeed_packet *packet,
+ GString **out)
{
+ const struct sr_datafeed_logic *logic;
struct context *ctx;
unsigned int i;
- int p, curbit, prevbit;
- uint64_t sample;
- static uint64_t samplecount = 0;
- GString *out;
- int first_sample = 0;
+ int p, curbit, prevbit, index;
+ uint8_t *sample;
+ gboolean timestamp_written;
+ *out = NULL;
+ if (!o || !o->internal)
+ return SR_ERR_BUG;
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);
+ *out = ctx->header;
ctx->header = NULL;
- first_sample = 1;
+ ctx->samplecount = 0;
+ } else {
+ *out = g_string_sized_new(512);
}
- for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
- samplecount++;
+ if (packet->type != SR_DF_LOGIC) {
+ if (packet->type == SR_DF_END)
+ /* Write final timestamp as length indicator. */
+ g_string_append_printf(*out, "#%.0f\n",
+ (double)ctx->samplecount /
+ ctx->samplerate * ctx->period);
+ return SR_OK;
+ }
- memcpy(&sample, data_in + i, ctx->unitsize);
+ logic = packet->payload;
- if (first_sample) {
- /* First packet. We neg to make sure sample is stored. */
- ctx->prevsample = ~sample;
- first_sample = 0;
+ if (!ctx->prevsample) {
+ /* Can't allocate this until we know the stream's unitsize. */
+ if (!(ctx->prevsample = g_malloc0(logic->unitsize))) {
+ g_free(ctx);
+ sr_err("%s: ctx->prevsample malloc failed", __func__);
+ return SR_ERR_MALLOC;
}
+ }
+
+ for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
+ sample = logic->data + i;
+ timestamp_written = FALSE;
+
+ for (p = 0; p < ctx->num_enabled_channels; p++) {
+ index = g_array_index(ctx->channelindices, int, p);
- for (p = 0; p < ctx->num_enabled_probes; p++) {
- curbit = (sample & ((uint64_t) (1 << p))) >> p;
- prevbit = (ctx->prevsample & ((uint64_t) (1 << p))) >> p;
+ 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)
+ if (prevbit == curbit && ctx->samplecount > 0)
continue;
+ /* Output timestamp of subsequent signal changes. */
+ if (!timestamp_written)
+ g_string_append_printf(*out, "#%.0f",
+ (double)ctx->samplecount /
+ ctx->samplerate * ctx->period);
+
/* 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));
+ g_string_append_c(*out, ' ');
+ g_string_append_c(*out, '0' + curbit);
+ g_string_append_c(*out, '!' + p);
+
+ timestamp_written = TRUE;
}
- ctx->prevsample = sample;
+ if (timestamp_written)
+ g_string_append_c(*out, '\n');
+
+ ctx->samplecount++;
+ memcpy(ctx->prevsample, sample, logic->unitsize);
}
- *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_array_free(ctx->channelindices, TRUE);
+ 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,
};