output/vcd.c

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