output/vcd.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  */
  21
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <glib.h>
  25 #include "config.h" /* Needed for PACKAGE and others. */
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28
  29 /* Message logging helpers with driver-specific prefix string. */
  30 #define DRIVER_LOG_DOMAIN "output/vcd: "
  31 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  32 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  33 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  34 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  35 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  36 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  37
  38 struct context {
  39         int num_enabled_probes;
  40         int probeindices[SR_MAX_NUM_PROBES + 1];
  41         GString *header;
  42         uint8_t *prevsample;
  43         int period;
  44         uint64_t samplerate;
  45         unsigned int unitsize;
  46 };
  47
  48 static const char *vcd_header_comment = "\
  49 $comment\n  Acquisition with %d/%d probes at %s\n$end\n";
  50
  51 static int init(struct sr_output *o)
  52 {
  53         struct context *ctx;
  54         struct sr_probe *probe;
  55         GSList *l;
  56         GVariant *gvar;
  57         int num_probes, i;
  58         char *samplerate_s, *frequency_s, *timestamp;
  59         time_t t;
  60
  61         if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
  62                 sr_err("%s: ctx malloc failed", __func__);
  63                 return SR_ERR_MALLOC;
  64         }
  65
  66         o->internal = ctx;
  67         ctx->num_enabled_probes = 0;
  68
  69         for (l = o->sdi->probes; l; l = l->next) {
  70                 probe = l->data;
  71                 if (!probe->enabled)
  72                         continue;
  73                 ctx->probeindices[ctx->num_enabled_probes] = probe->index;
  74                 ctx->num_enabled_probes++;
  75         }
  76         if (ctx->num_enabled_probes > 94) {
  77                 sr_err("VCD only supports 94 probes.");
  78                 return SR_ERR;
  79         }
  80
  81         ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
  82         ctx->header = g_string_sized_new(512);
  83         num_probes = g_slist_length(o->sdi->probes);
  84
  85         /* timestamp */
  86         t = time(NULL);
  87         timestamp = g_strdup(ctime(&t));
  88         timestamp[strlen(timestamp)-1] = 0;
  89         g_string_printf(ctx->header, "$date %s $end\n", timestamp);
  90         g_free(timestamp);
  91
  92         /* generator */
  93         g_string_append_printf(ctx->header, "$version %s %s $end\n",
  94                         PACKAGE, PACKAGE_VERSION);
  95
  96         if (o->sdi->driver && sr_dev_has_option(o->sdi, SR_CONF_SAMPLERATE)) {
  97                 o->sdi->driver->config_get(SR_CONF_SAMPLERATE, &gvar, o->sdi);
  98                 ctx->samplerate = g_variant_get_uint64(gvar);
  99                 if (!((samplerate_s = sr_samplerate_string(ctx->samplerate)))) {
 100                         g_string_free(ctx->header, TRUE);
 101                         g_free(ctx);
 102                         g_variant_unref(gvar);
 103                         return SR_ERR;
 104                 }
 105                 g_string_append_printf(ctx->header, vcd_header_comment,
 106                                  ctx->num_enabled_probes, num_probes, samplerate_s);
 107                 g_free(samplerate_s);
 108                 g_variant_unref(gvar);
 109         }
 110
 111         /* timescale */
 112         /* VCD can only handle 1/10/100 (s - fs), so scale up first */
 113         if (ctx->samplerate > SR_MHZ(1))
 114                 ctx->period = SR_GHZ(1);
 115         else if (ctx->samplerate > SR_KHZ(1))
 116                 ctx->period = SR_MHZ(1);
 117         else
 118                 ctx->period = SR_KHZ(1);
 119         if (!(frequency_s = sr_period_string(ctx->period))) {
 120                 g_string_free(ctx->header, TRUE);
 121                 g_free(ctx);
 122                 return SR_ERR;
 123         }
 124         g_string_append_printf(ctx->header, "$timescale %s $end\n", frequency_s);
 125         g_free(frequency_s);
 126
 127         /* scope */
 128         g_string_append_printf(ctx->header, "$scope module %s $end\n", PACKAGE);
 129
 130         /* Wires / channels */
 131         for (i = 0, l = o->sdi->probes; l; l = l->next, i++) {
 132                 probe = l->data;
 133                 if (!probe->enabled)
 134                         continue;
 135                 g_string_append_printf(ctx->header, "$var wire 1 %c %s $end\n",
 136                                 (char)('!' + i), probe->name);
 137         }
 138
 139         g_string_append(ctx->header, "$upscope $end\n"
 140                         "$enddefinitions $end\n$dumpvars\n");
 141
 142         if (!(ctx->prevsample = g_try_malloc0(ctx->unitsize))) {
 143                 g_string_free(ctx->header, TRUE);
 144                 g_free(ctx);
 145                 sr_err("%s: ctx->prevsample malloc failed", __func__);
 146                 return SR_ERR_MALLOC;
 147         }
 148
 149         return SR_OK;
 150 }
 151
 152 static GString *receive(struct sr_output *o, const struct sr_dev_inst *sdi,
 153                 const struct sr_datafeed_packet *packet)
 154 {
 155         const struct sr_datafeed_logic *logic;
 156         struct context *ctx;
 157         GString *text;
 158         unsigned int i;
 159         int p, curbit, prevbit, index;
 160         uint8_t *sample;
 161         static uint64_t samplecount = 0;
 162
 163         (void)sdi;
 164
 165         if (!o || !o->internal)
 166                 return NULL;
 167         ctx = o->internal;
 168
 169         if (packet->type == SR_DF_END) {
 170                 text = g_string_sized_new(16);
 171                 g_string_printf(text, "$dumpoff\n$end\n");
 172                 return text;
 173         } else if (packet->type != SR_DF_LOGIC)
 174                 return NULL;
 175
 176         if (ctx->header) {
 177                 /* The header is still here, this must be the first packet. */
 178                 text = ctx->header;
 179                 ctx->header = NULL;
 180         } else {
 181                 text = g_string_sized_new(512);
 182         }
 183
 184         logic = packet->payload;
 185         for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
 186                 samplecount++;
 187
 188                 sample = logic->data + i;
 189
 190                 for (p = 0; p < ctx->num_enabled_probes; p++) {
 191                         index = ctx->probeindices[p % 8];
 192                         curbit = (sample[p / 8] & (((uint8_t) 1) << index)) >> index;
 193                         prevbit = (ctx->prevsample[p / 8] & (((uint64_t) 1) << index)) >> index;
 194
 195                         /* VCD only contains deltas/changes of signals. */
 196                         if (prevbit == curbit)
 197                                 continue;
 198
 199                         /* Output which signal changed to which value. */
 200                         g_string_append_printf(text, "#%" PRIu64 "\n%i%c\n",
 201                                         (uint64_t)(((float)samplecount / ctx->samplerate)
 202                                         * ctx->period), curbit, (char)('!' + p));
 203                 }
 204
 205                 memcpy(ctx->prevsample, sample, ctx->unitsize);
 206         }
 207
 208         return text;
 209 }
 210
 211 static int cleanup(struct sr_output *o)
 212 {
 213         struct context *ctx;
 214
 215         if (!o || !o->internal)
 216                 return SR_ERR_ARG;
 217
 218         ctx = o->internal;
 219         g_free(ctx);
 220
 221         return SR_OK;
 222 }
 223
 224 struct sr_output_format output_vcd = {
 225         .id = "vcd",
 226         .description = "Value Change Dump (VCD)",
 227         .df_type = SR_DF_LOGIC,
 228         .init = init,
 229         .recv = receive,
 230         .cleanup = cleanup,
 231 };