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