]> sigrok.org Git - libsigrok.git/blobdiff - output/vcd.c
Replace 'probe' with 'channel' in most places.
[libsigrok.git] / output / vcd.c
index 90493f05b88540e3f5e976c544b6b2fc6a5d95bc..59198357dfa204663ec03aa8faea7c1818495e4d 100644 (file)
 #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;
-       GArray *probeindices;
+       int num_enabled_channels;
+       GArray *channelindices;
        GString *header;
        uint8_t *prevsample;
        int period;
        uint64_t samplerate;
+       uint64_t samplecount;
        unsigned int unitsize;
 };
 
-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;
+       int num_channels, i;
        char *samplerate_s, *frequency_s, *timestamp;
        time_t t;
 
@@ -64,25 +58,27 @@ static int init(struct sr_output *o)
        }
 
        o->internal = ctx;
-       ctx->num_enabled_probes = 0;
-       ctx->probeindices = g_array_new(FALSE, FALSE, sizeof(int));
+       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_PROBE_LOGIC)
                        continue;
-               ctx->probeindices = g_array_append_val(
-                               ctx->probeindices, probe->index);
-               ctx->num_enabled_probes++;
+               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->unitsize = (ctx->num_enabled_probes + 7) / 8;
+       ctx->unitsize = (ctx->num_enabled_channels + 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);
@@ -95,19 +91,18 @@ static int init(struct sr_output *o)
        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, &gvar, o->sdi);
+       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);
-                       g_variant_unref(gvar);
                        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_variant_unref(gvar);
        }
 
        /* timescale */
@@ -130,16 +125,18 @@ static int init(struct sr_output *o)
        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)
+       for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
+               ch = l->data;
+               if (ch->type != SR_PROBE_LOGIC)
+                       continue;
+               if (!ch->enabled)
                        continue;
                g_string_append_printf(ctx->header, "$var wire 1 %c %s $end\n",
-                               (char)('!' + i), probe->name);
+                               (char)('!' + i), ch->name);
        }
 
        g_string_append(ctx->header, "$upscope $end\n"
-                       "$enddefinitions $end\n$dumpvars\n");
+                       "$enddefinitions $end\n");
 
        if (!(ctx->prevsample = g_try_malloc0(ctx->unitsize))) {
                g_string_free(ctx->header, TRUE);
@@ -151,63 +148,80 @@ static int init(struct sr_output *o)
        return SR_OK;
 }
 
-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_dev_inst *sdi,
+               const struct sr_datafeed_packet *packet, GString **out)
 {
        const struct sr_datafeed_logic *logic;
        struct context *ctx;
-       GString *text;
        unsigned int i;
        int p, curbit, prevbit, index;
        uint8_t *sample;
-       static uint64_t samplecount = 0;
+       gboolean timestamp_written;
 
        (void)sdi;
 
+       *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;
+               *out = ctx->header;
                ctx->header = NULL;
+               ctx->samplecount = 0;
        } else {
-               text = g_string_sized_new(512);
+               *out = g_string_sized_new(512);
+       }
+
+       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;
        }
 
        logic = packet->payload;
        for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
-               samplecount++;
-
                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++) {
-                       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;
+                       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(text, "#%" 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;
                }
 
+               if (timestamp_written)
+                       g_string_append_c(*out, '\n');
+
+               ctx->samplecount++;
                memcpy(ctx->prevsample, sample, ctx->unitsize);
        }
 
-       return text;
+       return SR_OK;
 }
 
 static int cleanup(struct sr_output *o)
@@ -228,6 +242,6 @@ struct sr_output_format output_vcd = {
        .description = "Value Change Dump (VCD)",
        .df_type = SR_DF_LOGIC,
        .init = init,
-       .recv = receive,
+       .receive = receive,
        .cleanup = cleanup,
 };