2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 /* Based on Verilog standard IEEE Std 1364-2001 Version C */
26 #include "libsigrok.h"
27 #include "libsigrok-internal.h"
29 /* Message logging helpers with driver-specific prefix string. */
30 #define DRIVER_LOG_DOMAIN "input/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)
38 #define DEFAULT_NUM_PROBES 8
40 /* Read until specific type of character occurs in file.
41 * Skip input if dest is NULL.
43 * 'W' read until whitespace
44 * 'N' read until non-whitespace, and ungetc() the character
47 static gboolean read_until(FILE *file, GString *dest, char mode)
57 sr_err("Unexpected EOF.");
61 if (mode == 'W' && g_ascii_isspace(c))
64 if (mode == 'N' && !g_ascii_isspace(c))
72 prev[0] = prev[1]; prev[1] = prev[2]; prev[2] = prev[3]; prev[3] = c;
73 if (prev[0] == '$' && prev[1] == 'e' && prev[2] == 'n' && prev[3] == 'd')
76 g_string_truncate(dest, dest->len - 3);
83 g_string_append_c(dest, c);
87 /* Reads a single VCD section from input file and parses it to structure.
88 * e.g. $timescale 1ps $end => "timescale" "1ps"
90 static gboolean parse_section(FILE *file, gchar **name, gchar **contents)
93 GString *sname, *scontents;
95 /* Skip any initial white-space */
96 if (!read_until(file, NULL, 'N')) return FALSE;
98 /* Section tag should start with $. */
99 if (fgetc(file) != '$')
101 sr_err("Expected $ at beginning of section.");
105 /* Read the section tag */
106 sname = g_string_sized_new(32);
107 status = read_until(file, sname, 'W');
109 /* Skip whitespace before content */
110 status = status && read_until(file, NULL, 'N');
112 /* Read the content */
113 scontents = g_string_sized_new(128);
114 status = status && read_until(file, scontents, '$');
115 g_strchomp(scontents->str);
117 /* Release strings if status is FALSE, return them if status is TRUE */
118 *name = g_string_free(sname, !status);
119 *contents = g_string_free(scontents, !status);
134 struct probe probes[SR_MAX_NUM_PROBES];
137 static void release_context(struct context *ctx)
140 for (i = 0; i < ctx->probecount; i++)
142 g_free(ctx->probes[i].name); ctx->probes[i].name = NULL;
143 g_free(ctx->probes[i].identifier); ctx->probes[i].identifier = NULL;
149 /* Remove empty parts from an array returned by g_strsplit. */
150 static void remove_empty_parts(gchar **parts)
153 gchar **dest = parts;
167 /* Parse VCD header to get values for context structure.
168 * The context structure should be zeroed before calling this.
170 static gboolean parse_header(FILE *file, struct context *ctx)
172 gchar *name = NULL, *contents = NULL;
173 gboolean status = FALSE;
175 while (parse_section(file, &name, &contents))
177 sr_dbg("Section '%s', contents '%s'.", name, contents);
179 if (g_strcmp0(name, "enddefinitions") == 0)
184 else if (g_strcmp0(name, "timescale") == 0)
186 /* The standard allows for values 1, 10 or 100
187 * and units s, ms, us, ns, ps and fs. */
188 struct sr_rational period;
189 if (sr_parse_period(contents, &period) == SR_OK)
191 ctx->samplerate = period.q / period.p;
192 if (period.q % period.p != 0)
194 /* Does not happen unless time value is non-standard */
195 sr_warn("Inexact rounding of samplerate, %" PRIu64 " / %" PRIu64 " to %" PRIu64 ".",
196 period.q, period.p, ctx->samplerate);
199 sr_dbg("Samplerate: %" PRIu64, ctx->samplerate);
203 sr_err("Parsing timescale failed.");
206 else if (g_strcmp0(name, "var") == 0)
208 /* Format: $var type size identifier reference $end */
209 gchar **parts = g_strsplit_set(contents, " \r\n\t", 0);
210 remove_empty_parts(parts);
212 if (g_strv_length(parts) != 4)
214 sr_err("$var section should have 4 items");
216 else if (g_strcmp0(parts[0], "reg") != 0 && g_strcmp0(parts[0], "wire") != 0)
218 sr_warn("Unsupported signal type: '%s'", parts[0]);
220 else if (strtol(parts[1], NULL, 10) != 1)
222 sr_warn("Unsupported signal size: '%s'", parts[1]);
224 else if (ctx->probecount >= ctx->maxprobes)
226 sr_warn("Skipping '%s' because only %d probes requested.", parts[3], ctx->maxprobes);
230 sr_info("Probe %d is '%s' identified by '%s'.", ctx->probecount, parts[3], parts[2]);
231 ctx->probes[ctx->probecount].identifier = g_strdup(parts[2]);
232 ctx->probes[ctx->probecount].name = g_strdup(parts[3]);
239 g_free(name); name = NULL;
240 g_free(contents); contents = NULL;
249 static int format_match(const char *filename)
252 gchar *name = NULL, *contents = NULL;
255 file = fopen(filename, "r");
259 /* If we can parse the first section correctly,
260 * then it is assumed to be a VCD file.
262 status = parse_section(file, &name, &contents);
263 status = status && (*name != '\0');
272 static int init(struct sr_input *in)
274 struct sr_probe *probe;
276 char name[SR_MAX_PROBENAME_LEN + 1];
280 if (!(ctx = g_try_malloc0(sizeof(*ctx)))) {
281 sr_err("Input format context malloc failed.");
282 return SR_ERR_MALLOC;
285 num_probes = DEFAULT_NUM_PROBES;
289 param = g_hash_table_lookup(in->param, "numprobes");
291 num_probes = strtoul(param, NULL, 10);
294 release_context(ctx);
300 /* Maximum number of probes to parse from the VCD */
301 ctx->maxprobes = num_probes;
303 /* Create a virtual device. */
304 in->sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, NULL, NULL, NULL);
307 for (i = 0; i < num_probes; i++) {
308 snprintf(name, SR_MAX_PROBENAME_LEN, "%d", i);
310 if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, name)))
312 release_context(ctx);
316 in->sdi->probes = g_slist_append(in->sdi->probes, probe);
322 #define CHUNKSIZE 1024
324 /* Send N samples of the given value. */
325 static void send_samples(const struct sr_dev_inst *sdi, uint64_t sample, uint64_t count)
327 struct sr_datafeed_packet packet;
328 struct sr_datafeed_logic logic;
329 uint64_t buffer[CHUNKSIZE];
331 unsigned chunksize = CHUNKSIZE;
333 if (count < chunksize)
336 for (i = 0; i < chunksize; i++)
341 packet.type = SR_DF_LOGIC;
342 packet.payload = &logic;
343 logic.unitsize = sizeof(uint64_t);
348 if (count < chunksize)
351 logic.length = sizeof(uint64_t) * chunksize;
353 sr_session_send(sdi, &packet);
358 /* Parse the data section of VCD */
359 static void parse_contents(FILE *file, const struct sr_dev_inst *sdi, struct context *ctx)
361 GString *token = g_string_sized_new(32);
363 gboolean first = TRUE;
364 uint64_t prev_timestamp = 0;
365 uint64_t prev_values = 0;
367 /* Read one space-delimited token at a time. */
368 while (read_until(file, NULL, 'N') && read_until(file, token, 'W'))
370 if (token->str[0] == '#' && g_ascii_isdigit(token->str[1]))
372 /* Numeric value beginning with # is a new timestamp value */
374 timestamp = strtoull(token->str + 1, NULL, 10);
382 sr_dbg("New timestamp: %" PRIu64, timestamp);
384 /* Generate samples from prev_timestamp up to timestamp - 1. */
385 send_samples(sdi, prev_values, timestamp - prev_timestamp);
388 prev_timestamp = timestamp;
390 else if (token->str[0] == '$')
392 /* This is probably a $dumpvars, $comment or similar.
393 * For now, just skip it until $end. */
394 read_until(file, NULL, '$');
396 else if (strchr("01xXzZ", token->str[0]) != NULL)
398 /* A new 1-bit sample value */
400 bit = (token->str[0] == '1');
402 g_string_erase(token, 0, 1);
405 /* There was a space between value and identifier.
408 read_until(file, NULL, 'N');
409 read_until(file, token, 'W');
412 for (i = 0; i < ctx->probecount; i++)
414 if (g_strcmp0(token->str, ctx->probes[i].identifier) == 0)
416 sr_dbg("Probe %d new value %d.", i, bit);
418 /* Found our probe */
420 prev_values |= (1 << i);
422 prev_values &= ~(1 << i);
428 if (i == ctx->probecount)
430 sr_info("Did not find probe for identifier '%s'.", token->str);
434 g_string_truncate(token, 0);
437 g_string_free(token, TRUE);
440 static int loadfile(struct sr_input *in, const char *filename)
442 struct sr_datafeed_header header;
443 struct sr_datafeed_packet packet;
444 struct sr_datafeed_meta_logic meta;
450 if ((file = fopen(filename, "r")) == NULL)
453 if (!parse_header(file, ctx))
455 sr_err("VCD parsing failed");
460 /* Send header packet to the session bus. */
461 header.feed_version = 1;
462 gettimeofday(&header.starttime, NULL);
463 packet.type = SR_DF_HEADER;
464 packet.payload = &header;
465 sr_session_send(in->sdi, &packet);
467 /* Send metadata about the SR_DF_LOGIC packets to come. */
468 packet.type = SR_DF_META_LOGIC;
469 packet.payload = &meta;
470 meta.samplerate = ctx->samplerate;
471 meta.num_probes = ctx->probecount;
472 sr_session_send(in->sdi, &packet);
474 /* Parse the contents of the VCD file */
475 parse_contents(file, in->sdi, ctx);
477 /* Send end packet to the session bus. */
478 packet.type = SR_DF_END;
479 sr_session_send(in->sdi, &packet);
482 release_context(ctx);
488 SR_PRIV struct sr_input_format input_vcd = {
490 .description = "Value Change Dump",
491 .format_match = format_match,
493 .loadfile = loadfile,