2 * This file is part of the libsigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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
25 #include "config.h" /* Needed for PACKAGE and others. */
26 #include "libsigrok.h"
27 #include "libsigrok-internal.h"
29 /* Message logging helpers with subsystem-specific prefix string. */
30 #define LOG_PREFIX "output/vcd: "
31 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
32 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
33 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
34 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
35 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
36 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
39 int num_enabled_probes;
45 unsigned int unitsize;
48 static const char *vcd_header_comment = "\
49 $comment\n Acquisition with %d/%d probes at %s\n$end\n";
51 static int init(struct sr_output *o)
54 struct sr_probe *probe;
58 char *samplerate_s, *frequency_s, *timestamp;
61 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
62 sr_err("%s: ctx malloc failed", __func__);
67 ctx->num_enabled_probes = 0;
68 ctx->probeindices = g_array_new(FALSE, FALSE, sizeof(int));
70 for (l = o->sdi->probes; l; l = l->next) {
74 ctx->probeindices = g_array_append_val(
75 ctx->probeindices, probe->index);
76 ctx->num_enabled_probes++;
78 if (ctx->num_enabled_probes > 94) {
79 sr_err("VCD only supports 94 probes.");
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);
89 timestamp = g_strdup(ctime(&t));
90 timestamp[strlen(timestamp)-1] = 0;
91 g_string_printf(ctx->header, "$date %s $end\n", timestamp);
95 g_string_append_printf(ctx->header, "$version %s %s $end\n",
96 PACKAGE, PACKAGE_VERSION);
98 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
100 ctx->samplerate = g_variant_get_uint64(gvar);
101 g_variant_unref(gvar);
102 if (!((samplerate_s = sr_samplerate_string(ctx->samplerate)))) {
103 g_string_free(ctx->header, TRUE);
107 g_string_append_printf(ctx->header, vcd_header_comment,
108 ctx->num_enabled_probes, num_probes, samplerate_s);
109 g_free(samplerate_s);
113 /* VCD can only handle 1/10/100 (s - fs), so scale up first */
114 if (ctx->samplerate > SR_MHZ(1))
115 ctx->period = SR_GHZ(1);
116 else if (ctx->samplerate > SR_KHZ(1))
117 ctx->period = SR_MHZ(1);
119 ctx->period = SR_KHZ(1);
120 if (!(frequency_s = sr_period_string(ctx->period))) {
121 g_string_free(ctx->header, TRUE);
125 g_string_append_printf(ctx->header, "$timescale %s $end\n", frequency_s);
129 g_string_append_printf(ctx->header, "$scope module %s $end\n", PACKAGE);
131 /* Wires / channels */
132 for (i = 0, l = o->sdi->probes; l; l = l->next, i++) {
136 g_string_append_printf(ctx->header, "$var wire 1 %c %s $end\n",
137 (char)('!' + i), probe->name);
140 g_string_append(ctx->header, "$upscope $end\n"
141 "$enddefinitions $end\n$dumpvars\n");
143 if (!(ctx->prevsample = g_try_malloc0(ctx->unitsize))) {
144 g_string_free(ctx->header, TRUE);
146 sr_err("%s: ctx->prevsample malloc failed", __func__);
147 return SR_ERR_MALLOC;
153 static int receive(struct sr_output *o, const struct sr_dev_inst *sdi,
154 const struct sr_datafeed_packet *packet, GString **out)
156 const struct sr_datafeed_logic *logic;
159 int p, curbit, prevbit, index;
161 static uint64_t samplecount = 0;
166 if (!o || !o->internal)
170 if (packet->type == SR_DF_END) {
171 *out = g_string_new("$dumpoff\n$end\n");
173 } else if (packet->type != SR_DF_LOGIC)
177 /* The header is still here, this must be the first packet. */
181 *out = g_string_sized_new(512);
184 logic = packet->payload;
185 for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
188 sample = logic->data + i;
190 for (p = 0; p < ctx->num_enabled_probes; p++) {
191 index = g_array_index(ctx->probeindices, int, p);
192 curbit = (sample[p / 8] & (((uint8_t) 1) << index)) >> index;
193 prevbit = (ctx->prevsample[p / 8] & (((uint8_t) 1) << index)) >> index;
195 /* VCD only contains deltas/changes of signals. */
196 if (prevbit == curbit)
199 /* Output which signal changed to which value. */
200 g_string_append_printf(*out, "#%" PRIu64 "\n%i%c\n",
201 (uint64_t)(((float)samplecount / ctx->samplerate)
202 * ctx->period), curbit, (char)('!' + p));
205 memcpy(ctx->prevsample, sample, ctx->unitsize);
211 static int cleanup(struct sr_output *o)
215 if (!o || !o->internal)
224 struct sr_output_format output_vcd = {
226 .description = "Value Change Dump (VCD)",
227 .df_type = SR_DF_LOGIC,