2 * This file is part of the libsigrok project.
4 * Copyright (C) 2012 Petteri Aimonen <jpa@sr.mail.kapsi.fi>
5 * Copyright (C) 2014 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 3 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, see <http://www.gnu.org/licenses/>.
21 /* The VCD input module has the following options:
23 * numchannels: Maximum number of channels to use. The channels are
24 * detected in the same order as they are listed
25 * in the $var sections of the VCD file.
27 * skip: Allows skipping until given timestamp in the file.
28 * This can speed up analyzing of long captures.
30 * Value < 0: Skip until first timestamp listed in
33 * Value = 0: Do not skip, instead generate samples
34 * beginning from timestamp 0.
36 * Value > 0: Start at the given timestamp.
38 * downsample: Divide the samplerate by the given factor.
39 * This can speed up analyzing of long captures.
41 * compress: Compress idle periods longer than this value.
42 * This can speed up analyzing of long captures.
43 * Default 0 = don't compress.
45 * Based on Verilog standard IEEE Std 1364-2001 Version C
48 * - $var with 'wire' and 'reg' types of scalar variables
49 * - $timescale definition for samplerate
50 * - multiple character variable identifiers
52 * Most important unsupported features:
53 * - vector variables (bit vectors etc.)
54 * - analog, integer and real number variables
55 * - $dumpvars initial value declaration
57 * - more than 64 channels
65 #include <libsigrok/libsigrok.h>
66 #include "libsigrok-internal.h"
68 #define LOG_PREFIX "input/vcd"
70 #define DEFAULT_NUM_CHANNELS 8
71 #define CHUNKSIZE (1024 * 1024)
77 unsigned int maxchannels;
78 unsigned int channelcount;
82 gboolean skip_until_end;
84 size_t bytes_per_sample;
85 size_t samples_in_buffer;
87 uint8_t *current_levels;
96 * Reads a single VCD section from input file and parses it to name/contents.
97 * e.g. $timescale 1ps $end => "timescale" "1ps"
99 static gboolean parse_section(GString *buf, gchar **name, gchar **contents)
101 GString *sname, *scontent;
105 *name = *contents = NULL;
109 /* Skip any initial white-space. */
110 while (pos < buf->len && g_ascii_isspace(buf->str[pos]))
113 /* Section tag should start with $. */
114 if (buf->str[pos++] != '$')
117 sname = g_string_sized_new(32);
118 scontent = g_string_sized_new(128);
120 /* Read the section tag. */
121 while (pos < buf->len && !g_ascii_isspace(buf->str[pos]))
122 g_string_append_c(sname, buf->str[pos++]);
124 /* Skip whitespace before content. */
125 while (pos < buf->len && g_ascii_isspace(buf->str[pos]))
128 /* Read the content. */
129 while (pos < buf->len - 4 && strncmp(buf->str + pos, "$end", 4))
130 g_string_append_c(scontent, buf->str[pos++]);
132 if (sname->len && pos < buf->len - 4 && !strncmp(buf->str + pos, "$end", 4)) {
135 while (pos < buf->len && g_ascii_isspace(buf->str[pos]))
137 g_string_erase(buf, 0, pos);
140 *name = g_string_free(sname, !status);
141 *contents = g_string_free(scontent, !status);
143 g_strchomp(*contents);
148 static void free_channel(void *data)
150 struct vcd_channel *vcd_ch = data;
151 g_free(vcd_ch->name);
152 g_free(vcd_ch->identifier);
156 /* Remove empty parts from an array returned by g_strsplit. */
157 static void remove_empty_parts(gchar **parts)
160 gchar **dest = parts;
161 while (*src != NULL) {
171 * Parse VCD header to get values for context structure.
172 * The context structure should be zeroed before calling this.
174 static gboolean parse_header(const struct sr_input *in, GString *buf)
176 struct vcd_channel *vcd_ch;
180 gchar *name, *contents, **parts;
183 name = contents = NULL;
185 while (parse_section(buf, &name, &contents)) {
186 sr_dbg("Section '%s', contents '%s'.", name, contents);
188 if (g_strcmp0(name, "enddefinitions") == 0) {
191 } else if (g_strcmp0(name, "timescale") == 0) {
193 * The standard allows for values 1, 10 or 100
194 * and units s, ms, us, ns, ps and fs.
196 if (sr_parse_period(contents, &p, &q) == SR_OK) {
197 inc->samplerate = q / p;
199 /* Does not happen unless time value is non-standard */
200 sr_warn("Inexact rounding of samplerate, %" PRIu64 " / %" PRIu64 " to %" PRIu64 " Hz.",
201 q, p, inc->samplerate);
204 sr_dbg("Samplerate: %" PRIu64, inc->samplerate);
206 sr_err("Parsing timescale failed.");
208 } else if (g_strcmp0(name, "var") == 0) {
209 /* Format: $var type size identifier reference [opt. index] $end */
212 parts = g_strsplit_set(contents, " \r\n\t", 0);
213 remove_empty_parts(parts);
214 length = g_strv_length(parts);
216 if (length != 4 && length != 5)
217 sr_warn("$var section should have 4 or 5 items");
218 else if (g_strcmp0(parts[0], "reg") != 0 && g_strcmp0(parts[0], "wire") != 0)
219 sr_info("Unsupported signal type: '%s'", parts[0]);
220 else if (strtol(parts[1], NULL, 10) != 1)
221 sr_info("Unsupported signal size: '%s'", parts[1]);
222 else if (inc->channelcount >= inc->maxchannels)
223 sr_warn("Skipping '%s%s' because only %d channels requested.",
224 parts[3], parts[4] ? : "", inc->maxchannels);
226 vcd_ch = g_malloc(sizeof(struct vcd_channel));
227 vcd_ch->identifier = g_strdup(parts[2]);
229 vcd_ch->name = g_strdup(parts[3]);
231 vcd_ch->name = g_strconcat(parts[3], parts[4], NULL);
233 sr_info("Channel %d is '%s' identified by '%s'.",
234 inc->channelcount, vcd_ch->name, vcd_ch->identifier);
236 inc->channels = g_slist_append(inc->channels, vcd_ch);
252 * Compute how many bytes each sample will have and initialize the
253 * current levels. The current levels will be updated whenever VCD
256 inc->bytes_per_sample = (inc->channelcount + 7) / 8;
257 inc->current_levels = g_malloc0(inc->bytes_per_sample);
259 inc->got_header = status;
264 static int format_match(GHashTable *metadata)
266 GString *buf, *tmpbuf;
268 gchar *name, *contents;
270 buf = g_hash_table_lookup(metadata, GINT_TO_POINTER(SR_INPUT_META_HEADER));
271 tmpbuf = g_string_new_len(buf->str, buf->len);
274 * If we can parse the first section correctly,
275 * then it is assumed to be a VCD file.
277 status = parse_section(tmpbuf, &name, &contents);
278 g_string_free(tmpbuf, TRUE);
282 return status ? SR_OK : SR_ERR;
285 /* Send all accumulated bytes from inc->buffer. */
286 static void send_buffer(const struct sr_input *in)
289 struct sr_datafeed_packet packet;
290 struct sr_datafeed_logic logic;
294 if (inc->samples_in_buffer == 0)
297 packet.type = SR_DF_LOGIC;
298 packet.payload = &logic;
299 logic.unitsize = inc->bytes_per_sample;
300 logic.data = inc->buffer;
301 logic.length = inc->bytes_per_sample * inc->samples_in_buffer;
302 sr_session_send(in->sdi, &packet);
303 inc->samples_in_buffer = 0;
307 * Add N copies of the current sample to buffer.
308 * When the buffer fills up, automatically send it.
310 static void add_samples(const struct sr_input *in, size_t count)
313 size_t samples_per_chunk;
314 size_t space_left, i;
318 samples_per_chunk = CHUNKSIZE / inc->bytes_per_sample;
321 space_left = samples_per_chunk - inc->samples_in_buffer;
323 if (space_left > count)
326 p = inc->buffer + inc->samples_in_buffer * inc->bytes_per_sample;
327 for (i = 0; i < space_left; i++) {
328 memcpy(p, inc->current_levels, inc->bytes_per_sample);
329 p += inc->bytes_per_sample;
330 inc->samples_in_buffer++;
334 if (inc->samples_in_buffer == samples_per_chunk)
339 /* Parse a set of lines from the data section. */
340 static void parse_contents(const struct sr_input *in, char *data)
343 struct vcd_channel *vcd_ch;
345 uint64_t timestamp, prev_timestamp;
346 unsigned int bit, i, j;
352 /* Read one space-delimited token at a time. */
353 tokens = g_strsplit_set(data, " \t\r\n", 0);
354 remove_empty_parts(tokens);
355 for (i = 0; tokens[i]; i++) {
356 if (inc->skip_until_end) {
357 if (!strcmp(tokens[i], "$end")) {
358 /* Done with unhandled/unknown section. */
359 inc->skip_until_end = FALSE;
363 if (tokens[i][0] == '#' && g_ascii_isdigit(tokens[i][1])) {
364 /* Numeric value beginning with # is a new timestamp value */
365 timestamp = strtoull(tokens[i] + 1, NULL, 10);
367 if (inc->downsample > 1)
368 timestamp /= inc->downsample;
371 * Skip < 0 => skip until first timestamp.
372 * Skip = 0 => don't skip
373 * Skip > 0 => skip until timestamp >= skip.
376 inc->skip = timestamp;
377 prev_timestamp = timestamp;
378 } else if (inc->skip > 0 && timestamp < (uint64_t)inc->skip) {
379 prev_timestamp = inc->skip;
380 } else if (timestamp == prev_timestamp) {
381 /* Ignore repeated timestamps (e.g. sigrok outputs these) */
383 if (inc->compress != 0 && timestamp - prev_timestamp > inc->compress) {
384 /* Compress long idle periods */
385 prev_timestamp = timestamp - inc->compress;
388 sr_dbg("New timestamp: %" PRIu64, timestamp);
390 /* Generate samples from prev_timestamp up to timestamp - 1. */
391 add_samples(in, timestamp - prev_timestamp);
392 prev_timestamp = timestamp;
394 } else if (tokens[i][0] == '$' && tokens[i][1] != '\0') {
396 * This is probably a $dumpvars, $comment or similar.
397 * $dump* contain useful data.
399 if (g_strcmp0(tokens[i], "$dumpvars") == 0
400 || g_strcmp0(tokens[i], "$dumpon") == 0
401 || g_strcmp0(tokens[i], "$dumpoff") == 0
402 || g_strcmp0(tokens[i], "$end") == 0) {
403 /* Ignore, parse contents as normally. */
405 /* Ignore this and future lines until $end. */
406 inc->skip_until_end = TRUE;
409 } else if (strchr("bBrR", tokens[i][0]) != NULL) {
410 sr_dbg("Vector values not supported yet");
412 /* No tokens left, bail out */
415 /* Process next token */
417 } else if (strchr("01xXzZ", tokens[i][0]) != NULL) {
418 /* A new 1-bit sample value */
419 bit = (tokens[i][0] == '1');
422 * The identifier is either the next character, or, if
423 * there was whitespace after the bit, the next token.
425 if (tokens[i][1] == '\0') {
427 sr_dbg("Identifier missing!");
431 for (j = 1; tokens[i][j]; j++)
432 tokens[i][j - 1] = tokens[i][j];
433 tokens[i][j - 1] = '\0';
436 for (j = 0, l = inc->channels; j < inc->channelcount && l; j++, l = l->next) {
438 if (g_strcmp0(tokens[i], vcd_ch->identifier) == 0) {
439 /* Found our channel */
440 size_t byte_idx = (j / 8);
441 size_t bit_idx = j - 8 * byte_idx;
443 inc->current_levels[byte_idx] |= (uint8_t)1 << bit_idx;
445 inc->current_levels[byte_idx] &= ~((uint8_t)1 << bit_idx);
449 if (j == inc->channelcount)
450 sr_dbg("Did not find channel for identifier '%s'.", tokens[i]);
452 sr_warn("Skipping unknown token '%s'.", tokens[i]);
458 static int init(struct sr_input *in, GHashTable *options)
464 num_channels = g_variant_get_int32(g_hash_table_lookup(options, "numchannels"));
465 if (num_channels < 1) {
466 sr_err("Invalid value for numchannels: must be at least 1.");
469 inc = in->priv = g_malloc0(sizeof(struct context));
470 inc->maxchannels = num_channels;
472 inc->downsample = g_variant_get_int32(g_hash_table_lookup(options, "downsample"));
473 if (inc->downsample < 1)
476 inc->compress = g_variant_get_int32(g_hash_table_lookup(options, "compress"));
477 inc->skip = g_variant_get_int32(g_hash_table_lookup(options, "skip"));
478 inc->skip /= inc->downsample;
480 in->sdi = g_malloc0(sizeof(struct sr_dev_inst));
483 inc->buffer = g_malloc(CHUNKSIZE);
485 for (i = 0; i < num_channels; i++) {
486 snprintf(name, 16, "%d", i);
487 sr_channel_new(in->sdi, i, SR_CHANNEL_LOGIC, TRUE, name);
493 static gboolean have_header(GString *buf)
498 if (!(p = g_strstr_len(buf->str, buf->len, "$enddefinitions")))
500 pos = p - buf->str + 15;
501 while (pos < buf->len - 4 && g_ascii_isspace(buf->str[pos]))
503 if (!strncmp(buf->str + pos, "$end", 4))
509 static int process_buffer(struct sr_input *in)
511 struct sr_datafeed_packet packet;
512 struct sr_datafeed_meta meta;
513 struct sr_config *src;
520 std_session_send_df_header(in->sdi, LOG_PREFIX);
522 packet.type = SR_DF_META;
523 packet.payload = &meta;
524 samplerate = inc->samplerate / inc->downsample;
525 src = sr_config_new(SR_CONF_SAMPLERATE, g_variant_new_uint64(samplerate));
526 meta.config = g_slist_append(NULL, src);
527 sr_session_send(in->sdi, &packet);
528 g_slist_free(meta.config);
534 while ((p = g_strrstr_len(in->buf->str, in->buf->len, "\n"))) {
536 g_strstrip(in->buf->str);
537 if (in->buf->str[0] != '\0')
538 parse_contents(in, in->buf->str);
539 g_string_erase(in->buf, 0, p - in->buf->str + 1);
545 static int receive(struct sr_input *in, GString *buf)
550 g_string_append_len(in->buf, buf->str, buf->len);
553 if (!inc->got_header) {
554 if (!have_header(in->buf))
556 if (!parse_header(in, in->buf))
557 /* There was a header in there, but it was malformed. */
560 in->sdi_ready = TRUE;
561 /* sdi is ready, notify frontend. */
565 ret = process_buffer(in);
570 static int end(struct sr_input *in)
572 struct sr_datafeed_packet packet;
579 ret = process_buffer(in);
583 /* Send any samples that haven't been sent yet. */
587 packet.type = SR_DF_END;
588 sr_session_send(in->sdi, &packet);
594 static void cleanup(struct sr_input *in)
599 g_slist_free_full(inc->channels, free_channel);
602 g_free(inc->current_levels);
603 inc->current_levels = NULL;
606 static struct sr_option options[] = {
607 { "numchannels", "Number of channels", "Number of channels", NULL, NULL },
608 { "skip", "Skip", "Skip until timestamp", NULL, NULL },
609 { "downsample", "Downsample", "Divide samplerate by factor", NULL, NULL },
610 { "compress", "Compress", "Compress idle periods longer than this value", NULL, NULL },
614 static const struct sr_option *get_options(void)
616 if (!options[0].def) {
617 options[0].def = g_variant_ref_sink(g_variant_new_int32(DEFAULT_NUM_CHANNELS));
618 options[1].def = g_variant_ref_sink(g_variant_new_int32(-1));
619 options[2].def = g_variant_ref_sink(g_variant_new_int32(1));
620 options[3].def = g_variant_ref_sink(g_variant_new_int32(0));
626 SR_PRIV struct sr_input_module input_vcd = {
629 .desc = "Value Change Dump",
630 .exts = (const char*[]){"vcd", NULL},
631 .metadata = { SR_INPUT_META_HEADER | SR_INPUT_META_REQUIRED },
632 .options = get_options,
633 .format_match = format_match,