]>
Commit | Line | Data |
---|---|---|
4c9ffa83 | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
4c9ffa83 UH |
3 | * |
4 | * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de> | |
13d8e03c | 5 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> |
4c9ffa83 UH |
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 | |
2ea1fdf1 | 18 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
4c9ffa83 UH |
19 | */ |
20 | ||
6ec6c43b | 21 | #include <config.h> |
4c9ffa83 UH |
22 | #include <stdlib.h> |
23 | #include <string.h> | |
24 | #include <glib.h> | |
c1aae900 | 25 | #include <libsigrok/libsigrok.h> |
45c59c8b | 26 | #include "libsigrok-internal.h" |
4c9ffa83 | 27 | |
3544f848 | 28 | #define LOG_PREFIX "output/vcd" |
a944a84b | 29 | |
4c9ffa83 | 30 | struct context { |
ba7dd8bb | 31 | int num_enabled_channels; |
b050fc48 | 32 | uint8_t *prevsample; |
6cb45d96 | 33 | gboolean header_done; |
b33e7d70 | 34 | int period; |
6cb45d96 | 35 | int *channel_index; |
b33e7d70 | 36 | uint64_t samplerate; |
563080a8 | 37 | uint64_t samplecount; |
4c9ffa83 UH |
38 | }; |
39 | ||
a755b0e1 | 40 | static int init(struct sr_output *o, GHashTable *options) |
4c9ffa83 | 41 | { |
4c9ffa83 | 42 | struct context *ctx; |
ba7dd8bb | 43 | struct sr_channel *ch; |
4c9ffa83 | 44 | GSList *l; |
6cb45d96 | 45 | int num_enabled_channels, i; |
757b8c62 | 46 | |
a755b0e1 BV |
47 | (void)options; |
48 | ||
6cb45d96 | 49 | num_enabled_channels = 0; |
ba7dd8bb UH |
50 | for (l = o->sdi->channels; l; l = l->next) { |
51 | ch = l->data; | |
3f239f08 | 52 | if (ch->type != SR_CHANNEL_LOGIC) |
3699a8a1 | 53 | continue; |
ba7dd8bb | 54 | if (!ch->enabled) |
757b8c62 | 55 | continue; |
6cb45d96 | 56 | num_enabled_channels++; |
4c9ffa83 | 57 | } |
6cb45d96 | 58 | if (num_enabled_channels > 94) { |
ba7dd8bb | 59 | sr_err("VCD only supports 94 channels."); |
e46b8fb1 | 60 | return SR_ERR; |
fbf1ff5d | 61 | } |
4c9ffa83 | 62 | |
6cb45d96 | 63 | ctx = g_malloc0(sizeof(struct context)); |
d686c5ec | 64 | o->priv = ctx; |
6cb45d96 BV |
65 | ctx->num_enabled_channels = num_enabled_channels; |
66 | ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels); | |
67 | ||
68 | /* Once more to map the enabled channels. */ | |
69 | for (i = 0, l = o->sdi->channels; l; l = l->next) { | |
70 | ch = l->data; | |
71 | if (ch->type != SR_CHANNEL_LOGIC) | |
72 | continue; | |
73 | if (!ch->enabled) | |
74 | continue; | |
75 | ctx->channel_index[i++] = ch->index; | |
76 | } | |
77 | ||
78 | return SR_OK; | |
79 | } | |
80 | ||
a755b0e1 | 81 | static GString *gen_header(const struct sr_output *o) |
6cb45d96 BV |
82 | { |
83 | struct context *ctx; | |
84 | struct sr_channel *ch; | |
85 | GVariant *gvar; | |
86 | GString *header; | |
87 | GSList *l; | |
88 | time_t t; | |
89 | int num_channels, i; | |
90 | char *samplerate_s, *frequency_s, *timestamp; | |
91 | ||
d686c5ec | 92 | ctx = o->priv; |
6cb45d96 | 93 | header = g_string_sized_new(512); |
ba7dd8bb | 94 | num_channels = g_slist_length(o->sdi->channels); |
4c9ffa83 | 95 | |
fbf1ff5d BV |
96 | /* timestamp */ |
97 | t = time(NULL); | |
133a37bf | 98 | timestamp = g_strdup(ctime(&t)); |
8cd15dd4 | 99 | timestamp[strlen(timestamp) - 1] = 0; |
6cb45d96 | 100 | g_string_printf(header, "$date %s $end\n", timestamp); |
133a37bf | 101 | g_free(timestamp); |
4c9ffa83 | 102 | |
fbf1ff5d | 103 | /* generator */ |
6cb45d96 | 104 | g_string_append_printf(header, "$version %s %s $end\n", |
b9eb8e1a | 105 | PACKAGE_NAME, SR_PACKAGE_VERSION_STRING); |
6cb45d96 BV |
106 | g_string_append_printf(header, "$comment\n Acquisition with " |
107 | "%d/%d channels", ctx->num_enabled_channels, num_channels); | |
108 | ||
109 | if (ctx->samplerate == 0) { | |
110 | if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE, | |
111 | &gvar) == SR_OK) { | |
112 | ctx->samplerate = g_variant_get_uint64(gvar); | |
113 | g_variant_unref(gvar); | |
6b5e3cee | 114 | } |
6cb45d96 BV |
115 | } |
116 | if (ctx->samplerate != 0) { | |
117 | samplerate_s = sr_samplerate_string(ctx->samplerate); | |
118 | g_string_append_printf(header, " at %s", samplerate_s); | |
133a37bf | 119 | g_free(samplerate_s); |
7aae7462 | 120 | } |
6cb45d96 | 121 | g_string_append_printf(header, "\n$end\n"); |
4c9ffa83 | 122 | |
fbf1ff5d BV |
123 | /* timescale */ |
124 | /* VCD can only handle 1/10/100 (s - fs), so scale up first */ | |
59df0c77 UH |
125 | if (ctx->samplerate > SR_MHZ(1)) |
126 | ctx->period = SR_GHZ(1); | |
127 | else if (ctx->samplerate > SR_KHZ(1)) | |
128 | ctx->period = SR_MHZ(1); | |
fbf1ff5d | 129 | else |
59df0c77 | 130 | ctx->period = SR_KHZ(1); |
6984cfb2 | 131 | frequency_s = sr_period_string(1, ctx->period); |
6cb45d96 | 132 | g_string_append_printf(header, "$timescale %s $end\n", frequency_s); |
133a37bf | 133 | g_free(frequency_s); |
fbf1ff5d BV |
134 | |
135 | /* scope */ | |
b9eb8e1a | 136 | g_string_append_printf(header, "$scope module %s $end\n", PACKAGE_NAME); |
fbf1ff5d | 137 | |
4c9ffa83 | 138 | /* Wires / channels */ |
8cd15dd4 | 139 | for (i = 0, l = o->sdi->channels; l; l = l->next) { |
ba7dd8bb | 140 | ch = l->data; |
3f239f08 | 141 | if (ch->type != SR_CHANNEL_LOGIC) |
3699a8a1 | 142 | continue; |
ba7dd8bb | 143 | if (!ch->enabled) |
d601c0e9 | 144 | continue; |
6cb45d96 | 145 | g_string_append_printf(header, "$var wire 1 %c %s $end\n", |
ba7dd8bb | 146 | (char)('!' + i), ch->name); |
8cd15dd4 | 147 | i++; |
4c9ffa83 UH |
148 | } |
149 | ||
6cb45d96 | 150 | g_string_append(header, "$upscope $end\n$enddefinitions $end\n"); |
4c9ffa83 | 151 | |
6cb45d96 | 152 | return header; |
4c9ffa83 UH |
153 | } |
154 | ||
a755b0e1 | 155 | static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet, |
dba3e682 | 156 | GString **out) |
4c9ffa83 | 157 | { |
6cb45d96 | 158 | const struct sr_datafeed_meta *meta; |
d5585e32 | 159 | const struct sr_datafeed_logic *logic; |
6cb45d96 BV |
160 | const struct sr_config *src; |
161 | GSList *l; | |
4c9ffa83 | 162 | struct context *ctx; |
fbf1ff5d | 163 | unsigned int i; |
ba6568c5 | 164 | int p, curbit, prevbit, index; |
b050fc48 | 165 | uint8_t *sample; |
2b6363b4 | 166 | gboolean timestamp_written; |
4c9ffa83 | 167 | |
17f63de6 | 168 | *out = NULL; |
d686c5ec | 169 | if (!o || !o->priv) |
191c7e5f | 170 | return SR_ERR_BUG; |
d686c5ec | 171 | ctx = o->priv; |
d5585e32 | 172 | |
6cb45d96 BV |
173 | switch (packet->type) { |
174 | case SR_DF_META: | |
175 | meta = packet->payload; | |
176 | for (l = meta->config; l; l = l->next) { | |
177 | src = l->data; | |
178 | if (src->key != SR_CONF_SAMPLERATE) | |
179 | continue; | |
180 | ctx->samplerate = g_variant_get_uint64(src->data); | |
181 | } | |
182 | break; | |
183 | case SR_DF_LOGIC: | |
184 | logic = packet->payload; | |
185 | ||
186 | if (!ctx->header_done) { | |
187 | *out = gen_header(o); | |
188 | ctx->header_done = TRUE; | |
189 | } else { | |
190 | *out = g_string_sized_new(512); | |
191 | } | |
2b78ffea | 192 | |
6cb45d96 BV |
193 | if (!ctx->prevsample) { |
194 | /* Can't allocate this until we know the stream's unitsize. */ | |
195 | ctx->prevsample = g_malloc0(logic->unitsize); | |
2b78ffea | 196 | } |
2b78ffea | 197 | |
6cb45d96 BV |
198 | for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) { |
199 | sample = logic->data + i; | |
200 | timestamp_written = FALSE; | |
08b488b8 | 201 | |
6cb45d96 | 202 | for (p = 0; p < ctx->num_enabled_channels; p++) { |
8cd15dd4 UH |
203 | /* |
204 | * TODO Check whether the mapping from | |
205 | * data image positions to channel numbers | |
206 | * is required. Experiments suggest that | |
207 | * the data image "is dense", and packs | |
208 | * bits of enabled channels, and leaves no | |
209 | * room for positions of disabled channels. | |
210 | */ | |
211 | /* index = ctx->channel_index[p]; */ | |
212 | index = p; | |
2b6363b4 | 213 | |
6cb45d96 BV |
214 | curbit = ((unsigned)sample[index / 8] |
215 | >> (index % 8)) & 1; | |
216 | prevbit = ((unsigned)ctx->prevsample[index / 8] | |
217 | >> (index % 8)) & 1; | |
fbe2f794 | 218 | |
6cb45d96 BV |
219 | /* VCD only contains deltas/changes of signals. */ |
220 | if (prevbit == curbit && ctx->samplecount > 0) | |
221 | continue; | |
4c9ffa83 | 222 | |
6cb45d96 BV |
223 | /* Output timestamp of subsequent signal changes. */ |
224 | if (!timestamp_written) | |
225 | g_string_append_printf(*out, "#%.0f", | |
226 | (double)ctx->samplecount / | |
227 | ctx->samplerate * ctx->period); | |
2b6363b4 | 228 | |
6cb45d96 BV |
229 | /* Output which signal changed to which value. */ |
230 | g_string_append_c(*out, ' '); | |
231 | g_string_append_c(*out, '0' + curbit); | |
232 | g_string_append_c(*out, '!' + p); | |
2b6363b4 | 233 | |
6cb45d96 BV |
234 | timestamp_written = TRUE; |
235 | } | |
08b488b8 | 236 | |
6cb45d96 BV |
237 | if (timestamp_written) |
238 | g_string_append_c(*out, '\n'); | |
2b6363b4 | 239 | |
6cb45d96 BV |
240 | ctx->samplecount++; |
241 | memcpy(ctx->prevsample, sample, logic->unitsize); | |
242 | } | |
243 | break; | |
244 | case SR_DF_END: | |
245 | /* Write final timestamp as length indicator. */ | |
246 | *out = g_string_sized_new(512); | |
247 | g_string_printf(*out, "#%.0f\n", | |
248 | (double)ctx->samplecount / ctx->samplerate * ctx->period); | |
249 | break; | |
4c9ffa83 UH |
250 | } |
251 | ||
17f63de6 | 252 | return SR_OK; |
d5585e32 BV |
253 | } |
254 | ||
255 | static int cleanup(struct sr_output *o) | |
256 | { | |
257 | struct context *ctx; | |
258 | ||
d686c5ec | 259 | if (!o || !o->priv) |
d5585e32 BV |
260 | return SR_ERR_ARG; |
261 | ||
d686c5ec | 262 | ctx = o->priv; |
2b78ffea | 263 | g_free(ctx->prevsample); |
6cb45d96 | 264 | g_free(ctx->channel_index); |
d5585e32 | 265 | g_free(ctx); |
4c9ffa83 | 266 | |
e46b8fb1 | 267 | return SR_OK; |
4c9ffa83 UH |
268 | } |
269 | ||
a755b0e1 | 270 | struct sr_output_module output_vcd = { |
cdb3573c | 271 | .id = "vcd", |
a755b0e1 | 272 | .name = "VCD", |
8cd15dd4 | 273 | .desc = "Value Change Dump data", |
8a174d23 | 274 | .exts = (const char*[]){"vcd", NULL}, |
3cd4b381 | 275 | .flags = 0, |
a755b0e1 | 276 | .options = NULL, |
d494a4aa | 277 | .init = init, |
17f63de6 | 278 | .receive = receive, |
bbe6e336 | 279 | .cleanup = cleanup, |
4c9ffa83 | 280 | }; |