X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=input%2Fvcd.c;h=a9963f7e7682dc136575f785f9471f2e439b7d61;hb=4afdfd4628e9955af02a3ea619ecdfe469f9a9e2;hp=40a7f16c9177ac53b7634bbc0eaa086b1da4a98d;hpb=99eaa20695b2e6c41721072c84215331bbd3f3bf;p=libsigrok.git diff --git a/input/vcd.c b/input/vcd.c index 40a7f16c..a9963f7e 100644 --- a/input/vcd.c +++ b/input/vcd.c @@ -1,7 +1,7 @@ /* * This file is part of the sigrok project. * - * Copyright (C) 2010-2012 Bert Vermeulen + * Copyright (C) 2012 Petteri Aimonen * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -17,11 +17,50 @@ * along with this program. If not, see . */ -/* Based on Verilog standard IEEE Std 1364-2001 Version C */ +/* The VCD input module has the following options: + * + * numprobes: Maximum number of probes to use. The probes are + * detected in the same order as they are listed + * in the $var sections of the VCD file. + * + * skip: Allows skipping until given timestamp in the file. + * This can speed up analyzing of long captures. + * + * Value < 0: Skip until first timestamp listed in + * the file. (default) + * + * Value = 0: Do not skip, instead generate samples + * beginning from timestamp 0. + * + * Value > 0: Start at the given timestamp. + * + * downsample: Divide the samplerate by the given factor. + * This can speed up analyzing of long captures. + * + * compress: Compress idle periods longer than this value. + * This can speed up analyzing of long captures. + * Default 0 = don't compress. + * + * Based on Verilog standard IEEE Std 1364-2001 Version C + * + * Supported features: + * - $var with 'wire' and 'reg' types of scalar variables + * - $timescale definition for samplerate + * - multiple character variable identifiers + * + * Most important unsupported features: + * - vector variables (bit vectors etc.) + * - analog, integer and real number variables + * - $dumpvars initial value declaration + * - $scope namespaces + */ + +/* */ #include #include #include +#include #include "libsigrok.h" #include "libsigrok-internal.h" @@ -46,13 +85,15 @@ static gboolean read_until(FILE *file, GString *dest, char mode) { char prev[4] = ""; + long startpos = ftell(file); for(;;) { int c = fgetc(file); if (c == EOF) { - sr_err("Unexpected EOF."); + if (mode == '$') + sr_err("Unexpected EOF, read started at %ld.", startpos); return FALSE; } @@ -129,9 +170,24 @@ struct context uint64_t samplerate; int maxprobes; int probecount; + int downsample; + unsigned compress; + int64_t skip; struct probe probes[SR_MAX_NUM_PROBES]; }; +static void release_context(struct context *ctx) +{ + int i; + for (i = 0; i < ctx->probecount; i++) + { + g_free(ctx->probes[i].name); ctx->probes[i].name = NULL; + g_free(ctx->probes[i].identifier); ctx->probes[i].identifier = NULL; + } + + g_free(ctx); +} + /* Remove empty parts from an array returned by g_strsplit. */ static void remove_empty_parts(gchar **parts) { @@ -178,7 +234,7 @@ static gboolean parse_header(FILE *file, struct context *ctx) if (period.q % period.p != 0) { /* Does not happen unless time value is non-standard */ - sr_warn("Inexact rounding of samplerate, %" PRIu64 " / %" PRIu64 " to %" PRIu64 ".", + sr_warn("Inexact rounding of samplerate, %" PRIu64 " / %" PRIu64 " to %" PRIu64 " Hz.", period.q, period.p, ctx->samplerate); } @@ -197,15 +253,15 @@ static gboolean parse_header(FILE *file, struct context *ctx) if (g_strv_length(parts) != 4) { - sr_err("$var section should have 4 items"); + sr_warn("$var section should have 4 items"); } else if (g_strcmp0(parts[0], "reg") != 0 && g_strcmp0(parts[0], "wire") != 0) { - sr_warn("Unsupported signal type: '%s'", parts[0]); + sr_info("Unsupported signal type: '%s'", parts[0]); } else if (strtol(parts[1], NULL, 10) != 1) { - sr_warn("Unsupported signal size: '%s'", parts[1]); + sr_info("Unsupported signal size: '%s'", parts[1]); } else if (ctx->probecount >= ctx->maxprobes) { @@ -270,13 +326,37 @@ static int init(struct sr_input *in) num_probes = DEFAULT_NUM_PROBES; ctx->samplerate = 0; + ctx->downsample = 1; + ctx->skip = -1; if (in->param) { param = g_hash_table_lookup(in->param, "numprobes"); if (param) { num_probes = strtoul(param, NULL, 10); if (num_probes < 1) + { + release_context(ctx); return SR_ERR; + } + } + + param = g_hash_table_lookup(in->param, "downsample"); + if (param) { + ctx->downsample = strtoul(param, NULL, 10); + if (ctx->downsample < 1) + { + ctx->downsample = 1; + } + } + + param = g_hash_table_lookup(in->param, "compress"); + if (param) { + ctx->compress = strtoul(param, NULL, 10); + } + + param = g_hash_table_lookup(in->param, "skip"); + if (param) { + ctx->skip = strtoul(param, NULL, 10) / ctx->downsample; } } @@ -291,21 +371,184 @@ static int init(struct sr_input *in) snprintf(name, SR_MAX_PROBENAME_LEN, "%d", i); if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, name))) + { + release_context(ctx); return SR_ERR; + } + in->sdi->probes = g_slist_append(in->sdi->probes, probe); } return SR_OK; } -static int loadfile(struct sr_input *in, const char *filename) +#define CHUNKSIZE 1024 + +/* Send N samples of the given value. */ +static void send_samples(const struct sr_dev_inst *sdi, uint64_t sample, uint64_t count) { - struct sr_datafeed_header header; struct sr_datafeed_packet packet; - struct sr_datafeed_meta_logic meta; struct sr_datafeed_logic logic; + uint64_t buffer[CHUNKSIZE]; + uint64_t i; + unsigned chunksize = CHUNKSIZE; + + if (count < chunksize) + chunksize = count; + + for (i = 0; i < chunksize; i++) + { + buffer[i] = sample; + } + + packet.type = SR_DF_LOGIC; + packet.payload = &logic; + logic.unitsize = sizeof(uint64_t); + logic.data = buffer; + + while (count) + { + if (count < chunksize) + chunksize = count; + + logic.length = sizeof(uint64_t) * chunksize; + + sr_session_send(sdi, &packet); + count -= chunksize; + } +} + +/* Parse the data section of VCD */ +static void parse_contents(FILE *file, const struct sr_dev_inst *sdi, struct context *ctx) +{ + GString *token = g_string_sized_new(32); + + uint64_t prev_timestamp = 0; + uint64_t prev_values = 0; + + /* Read one space-delimited token at a time. */ + while (read_until(file, NULL, 'N') && read_until(file, token, 'W')) + { + if (token->str[0] == '#' && g_ascii_isdigit(token->str[1])) + { + /* Numeric value beginning with # is a new timestamp value */ + uint64_t timestamp; + timestamp = strtoull(token->str + 1, NULL, 10); + + if (ctx->downsample > 1) + timestamp /= ctx->downsample; + + /* Skip < 0 => skip until first timestamp. + * Skip = 0 => don't skip + * Skip > 0 => skip until timestamp >= skip. + */ + if (ctx->skip < 0) + { + ctx->skip = timestamp; + prev_timestamp = timestamp; + } + else if (ctx->skip > 0 && timestamp < (uint64_t)ctx->skip) + { + prev_timestamp = ctx->skip; + } + else if (timestamp == prev_timestamp) + { + /* Ignore repeated timestamps (e.g. sigrok outputs these) */ + } + else + { + if (ctx->compress != 0 && timestamp - prev_timestamp > ctx->compress) + { + /* Compress long idle periods */ + prev_timestamp = timestamp - ctx->compress; + } + + sr_dbg("New timestamp: %" PRIu64, timestamp); + + /* Generate samples from prev_timestamp up to timestamp - 1. */ + send_samples(sdi, prev_values, timestamp - prev_timestamp); + prev_timestamp = timestamp; + } + } + else if (token->str[0] == '$' && token->len > 1) + { + /* This is probably a $dumpvars, $comment or similar. + * $dump* contain useful data, but other tags will be skipped until $end. */ + if (g_strcmp0(token->str, "$dumpvars") == 0 || + g_strcmp0(token->str, "$dumpon") == 0 || + g_strcmp0(token->str, "$dumpoff") == 0 || + g_strcmp0(token->str, "$end") == 0) + { + /* Ignore, parse contents as normally. */ + } + else + { + /* Skip until $end */ + read_until(file, NULL, '$'); + } + } + else if (strchr("bBrR", token->str[0]) != NULL) + { + /* A vector value. Skip it and also the following identifier. */ + read_until(file, NULL, 'N'); + read_until(file, NULL, 'W'); + } + else if (strchr("01xXzZ", token->str[0]) != NULL) + { + /* A new 1-bit sample value */ + int i, bit; + bit = (token->str[0] == '1'); + + g_string_erase(token, 0, 1); + if (token->len == 0) + { + /* There was a space between value and identifier. + * Read in the rest. + */ + read_until(file, NULL, 'N'); + read_until(file, token, 'W'); + } + + for (i = 0; i < ctx->probecount; i++) + { + if (g_strcmp0(token->str, ctx->probes[i].identifier) == 0) + { + sr_dbg("Probe %d new value %d.", i, bit); + + /* Found our probe */ + if (bit) + prev_values |= (1 << i); + else + prev_values &= ~(1 << i); + + break; + } + } + + if (i == ctx->probecount) + { + sr_dbg("Did not find probe for identifier '%s'.", token->str); + } + } + else + { + sr_warn("Skipping unknown token '%s'.", token->str); + } + + g_string_truncate(token, 0); + } + + g_string_free(token, TRUE); +} + +static int loadfile(struct sr_input *in, const char *filename) +{ + struct sr_datafeed_packet packet; + struct sr_datafeed_meta meta; + struct sr_config *src; FILE *file; struct context *ctx; + uint64_t samplerate; ctx = in->internal; @@ -320,35 +563,25 @@ static int loadfile(struct sr_input *in, const char *filename) } /* Send header packet to the session bus. */ - header.feed_version = 1; - gettimeofday(&header.starttime, NULL); - packet.type = SR_DF_HEADER; - packet.payload = &header; - sr_session_send(in->sdi, &packet); + std_session_send_df_header(in->sdi, DRIVER_LOG_DOMAIN); /* Send metadata about the SR_DF_LOGIC packets to come. */ - packet.type = SR_DF_META_LOGIC; + packet.type = SR_DF_META; packet.payload = &meta; - meta.samplerate = ctx->samplerate; - meta.num_probes = ctx->probecount; + samplerate = ctx->samplerate / ctx->downsample; + src = sr_config_make(SR_CONF_SAMPLERATE, (const void *)&samplerate); + meta.config = g_slist_append(NULL, src); sr_session_send(in->sdi, &packet); - /* Chop up the input file into chunks & send it to the session bus. */ -/* packet.type = SR_DF_LOGIC; - packet.payload = &logic; - logic.unitsize = (num_probes + 7) / 8; - logic.data = buffer; - while ((size = read(fd, buffer, CHUNKSIZE)) > 0) { - logic.length = size; - sr_session_send(in->sdi, &packet); - } - close(fd); -*/ + /* Parse the contents of the VCD file */ + parse_contents(file, in->sdi, ctx); + /* Send end packet to the session bus. */ packet.type = SR_DF_END; sr_session_send(in->sdi, &packet); - g_free(ctx); + fclose(file); + release_context(ctx); in->internal = NULL; return SR_OK;