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 #define LOG_PREFIX "output/vcd"
  30
  31 struct context {
  32         int num_enabled_probes;
  33         GArray *probeindices;
  34         GString *header;
  35         uint8_t *prevsample;
  36         int period;
  37         uint64_t samplerate;
  38         unsigned int unitsize;
  39 };
  40
  41 static const char *vcd_header_comment = "\
  42 $comment\n  Acquisition with %d/%d probes at %s\n$end\n";
  43
  44 static int init(struct sr_output *o)
  45 {
  46         struct context *ctx;
  47         struct sr_probe *probe;
  48         GSList *l;
  49         GVariant *gvar;
  50         int num_probes, i;
  51         char *samplerate_s, *frequency_s, *timestamp;
  52         time_t t;
  53
  54         if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
  55                 sr_err("%s: ctx malloc failed", __func__);
  56                 return SR_ERR_MALLOC;
  57         }
  58
  59         o->internal = ctx;
  60         ctx->num_enabled_probes = 0;
  61         ctx->probeindices = g_array_new(FALSE, FALSE, sizeof(int));
  62
  63         for (l = o->sdi->probes; l; l = l->next) {
  64                 probe = l->data;
  65                 if (!probe->enabled)
  66                         continue;
  67                 ctx->probeindices = g_array_append_val(
  68                                 ctx->probeindices, probe->index);
  69                 ctx->num_enabled_probes++;
  70         }
  71         if (ctx->num_enabled_probes > 94) {
  72                 sr_err("VCD only supports 94 probes.");
  73                 return SR_ERR;
  74         }
  75
  76         ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
  77         ctx->header = g_string_sized_new(512);
  78         num_probes = g_slist_length(o->sdi->probes);
  79
  80         /* timestamp */
  81         t = time(NULL);
  82         timestamp = g_strdup(ctime(&t));
  83         timestamp[strlen(timestamp)-1] = 0;
  84         g_string_printf(ctx->header, "$date %s $end\n", timestamp);
  85         g_free(timestamp);
  86
  87         /* generator */
  88         g_string_append_printf(ctx->header, "$version %s %s $end\n",
  89                         PACKAGE, PACKAGE_VERSION);
  90
  91         if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
  92                         &gvar) == SR_OK) {
  93                 ctx->samplerate = g_variant_get_uint64(gvar);
  94                 g_variant_unref(gvar);
  95                 if (!((samplerate_s = sr_samplerate_string(ctx->samplerate)))) {
  96                         g_string_free(ctx->header, TRUE);
  97                         g_free(ctx);
  98                         return SR_ERR;
  99                 }
 100                 g_string_append_printf(ctx->header, vcd_header_comment,
 101                                  ctx->num_enabled_probes, num_probes, samplerate_s);
 102                 g_free(samplerate_s);
 103         }
 104
 105         /* timescale */
 106         /* VCD can only handle 1/10/100 (s - fs), so scale up first */
 107         if (ctx->samplerate > SR_MHZ(1))
 108                 ctx->period = SR_GHZ(1);
 109         else if (ctx->samplerate > SR_KHZ(1))
 110                 ctx->period = SR_MHZ(1);
 111         else
 112                 ctx->period = SR_KHZ(1);
 113         if (!(frequency_s = sr_period_string(ctx->period))) {
 114                 g_string_free(ctx->header, TRUE);
 115                 g_free(ctx);
 116                 return SR_ERR;
 117         }
 118         g_string_append_printf(ctx->header, "$timescale %s $end\n", frequency_s);
 119         g_free(frequency_s);
 120
 121         /* scope */
 122         g_string_append_printf(ctx->header, "$scope module %s $end\n", PACKAGE);
 123
 124         /* Wires / channels */
 125         for (i = 0, l = o->sdi->probes; l; l = l->next, i++) {
 126                 probe = l->data;
 127                 if (!probe->enabled)
 128                         continue;
 129                 g_string_append_printf(ctx->header, "$var wire 1 %c %s $end\n",
 130                                 (char)('!' + i), probe->name);
 131         }
 132
 133         g_string_append(ctx->header, "$upscope $end\n"
 134                         "$enddefinitions $end\n$dumpvars\n");
 135
 136         if (!(ctx->prevsample = g_try_malloc0(ctx->unitsize))) {
 137                 g_string_free(ctx->header, TRUE);
 138                 g_free(ctx);
 139                 sr_err("%s: ctx->prevsample malloc failed", __func__);
 140                 return SR_ERR_MALLOC;
 141         }
 142
 143         return SR_OK;
 144 }
 145
 146 static int receive(struct sr_output *o, const struct sr_dev_inst *sdi,
 147                 const struct sr_datafeed_packet *packet, GString **out)
 148 {
 149         const struct sr_datafeed_logic *logic;
 150         struct context *ctx;
 151         unsigned int i;
 152         int p, curbit, prevbit, index;
 153         uint8_t *sample;
 154         static uint64_t samplecount = 0;
 155
 156         (void)sdi;
 157
 158         *out = NULL;
 159         if (!o || !o->internal)
 160                 return SR_ERR_ARG;
 161         ctx = o->internal;
 162
 163         if (packet->type == SR_DF_END) {
 164                 *out = g_string_new("$dumpoff\n$end\n");
 165                 return SR_OK;
 166         } else if (packet->type != SR_DF_LOGIC)
 167                 return SR_OK;
 168
 169         if (ctx->header) {
 170                 /* The header is still here, this must be the first packet. */
 171                 *out = ctx->header;
 172                 ctx->header = NULL;
 173         } else {
 174                 *out = g_string_sized_new(512);
 175         }
 176
 177         logic = packet->payload;
 178         for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
 179                 samplecount++;
 180
 181                 sample = logic->data + i;
 182
 183                 for (p = 0; p < ctx->num_enabled_probes; p++) {
 184                         index = g_array_index(ctx->probeindices, int, p);
 185                         curbit = (sample[p / 8] & (((uint8_t) 1) << index)) >> index;
 186                         prevbit = (ctx->prevsample[p / 8] & (((uint8_t) 1) << index)) >> index;
 187
 188                         /* VCD only contains deltas/changes of signals. */
 189                         if (prevbit == curbit)
 190                                 continue;
 191
 192                         /* Output which signal changed to which value. */
 193                         g_string_append_printf(*out, "#%" PRIu64 "\n%i%c\n",
 194                                         (uint64_t)(((float)samplecount / ctx->samplerate)
 195                                         * ctx->period), curbit, (char)('!' + p));
 196                 }
 197
 198                 memcpy(ctx->prevsample, sample, ctx->unitsize);
 199         }
 200
 201         return SR_OK;
 202 }
 203
 204 static int cleanup(struct sr_output *o)
 205 {
 206         struct context *ctx;
 207
 208         if (!o || !o->internal)
 209                 return SR_ERR_ARG;
 210
 211         ctx = o->internal;
 212         g_free(ctx);
 213
 214         return SR_OK;
 215 }
 216
 217 struct sr_output_format output_vcd = {
 218         .id = "vcd",
 219         .description = "Value Change Dump (VCD)",
 220         .df_type = SR_DF_LOGIC,
 221         .init = init,
 222         .receive = receive,
 223         .cleanup = cleanup,
 224 };