+++ /dev/null
-/*
- * This file is part of the sigrok project.
- *
- * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
- *
- * 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
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- */
-
-/* Based on Verilog standard IEEE Std 1364-2001 Version C */
-
-#include <stdlib.h>
-#include <glib.h>
-#include <stdio.h>
-#include "libsigrok.h"
-#include "libsigrok-internal.h"
-
-/* Message logging helpers with driver-specific prefix string. */
-#define DRIVER_LOG_DOMAIN "input/vcd: "
-#define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
-#define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
-#define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
-
-#define DEFAULT_NUM_PROBES 8
-
-/* Read until specific type of character occurs in file.
- * Skip input if dest is NULL.
- * Modes:
- * 'W' read until whitespace
- * 'N' read until non-whitespace, and ungetc() the character
- * '$' read until $end
- */
-static gboolean read_until(FILE *file, GString *dest, char mode)
-{
- char prev[4] = "";
- for(;;)
- {
- int c = fgetc(file);
-
- if (c == EOF)
- {
- sr_err("Unexpected EOF.");
- return FALSE;
- }
-
- if (mode == 'W' && g_ascii_isspace(c))
- return TRUE;
-
- if (mode == 'N' && !g_ascii_isspace(c))
- {
- ungetc(c, file);
- return TRUE;
- }
-
- if (mode == '$')
- {
- prev[0] = prev[1]; prev[1] = prev[2]; prev[2] = prev[3]; prev[3] = c;
- if (prev[0] == '$' && prev[1] == 'e' && prev[2] == 'n' && prev[3] == 'd')
- {
- if (dest != NULL)
- g_string_truncate(dest, dest->len - 3);
-
- return TRUE;
- }
- }
-
- if (dest != NULL)
- g_string_append_c(dest, c);
- }
-}
-
-/* Reads a single VCD section from input file and parses it to structure.
- * e.g. $timescale 1ps $end => "timescale" "1ps"
- */
-static gboolean parse_section(FILE *file, gchar **name, gchar **contents)
-{
- gboolean status;
- GString *sname, *scontents;
-
- /* Skip any initial white-space */
- if (!read_until(file, NULL, 'N')) return FALSE;
-
- /* Section tag should start with $. */
- if (fgetc(file) != '$')
- {
- sr_err("Expected $ at beginning of section.");
- return FALSE;
- }
-
- /* Read the section tag */
- sname = g_string_sized_new(32);
- status = read_until(file, sname, 'W');
-
- /* Skip whitespace before content */
- status = status && read_until(file, NULL, 'N');
-
- /* Read the content */
- scontents = g_string_sized_new(128);
- status = status && read_until(file, scontents, '$');
- g_strchomp(scontents->str);
-
- /* Release strings if status is FALSE, return them if status is TRUE */
- *name = g_string_free(sname, !status);
- *contents = g_string_free(scontents, !status);
- return status;
-}
-
-struct probe
-{
- gchar *name;
- gchar *identifier;
-};
-
-struct context
-{
- uint64_t samplerate;
- int maxprobes;
- int probecount;
- struct probe probes[SR_MAX_NUM_PROBES];
-};
-
-/* Remove empty parts from an array returned by g_strsplit. */
-static void remove_empty_parts(gchar **parts)
-{
- gchar **src = parts;
- gchar **dest = parts;
- while (*src != NULL)
- {
- if (**src != '\0')
- {
- *dest++ = *src;
- }
-
- src++;
- }
-
- *dest = NULL;
-}
-
-/* Parse VCD header to get values for context structure.
- * The context structure should be zeroed before calling this.
- */
-static gboolean parse_header(FILE *file, struct context *ctx)
-{
- gchar *name = NULL, *contents = NULL;
- gboolean status = FALSE;
-
- while (parse_section(file, &name, &contents))
- {
- sr_dbg("Section '%s', contents '%s'.", name, contents);
-
- if (g_strcmp0(name, "enddefinitions") == 0)
- {
- status = TRUE;
- break;
- }
- else if (g_strcmp0(name, "timescale") == 0)
- {
- /* The standard allows for values 1, 10 or 100
- * and units s, ms, us, ns, ps and fs. */
- struct sr_rational period;
- if (sr_parse_period(contents, &period) == SR_OK)
- {
- ctx->samplerate = period.q / period.p;
- 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 ".",
- period.q, period.p, ctx->samplerate);
- }
-
- sr_dbg("Samplerate: %" PRIu64, ctx->samplerate);
- }
- else
- {
- sr_err("Parsing timescale failed.");
- }
- }
- else if (g_strcmp0(name, "var") == 0)
- {
- /* Format: $var type size identifier reference $end */
- gchar **parts = g_strsplit_set(contents, " \r\n\t", 0);
- remove_empty_parts(parts);
-
- if (g_strv_length(parts) != 4)
- {
- sr_err("$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]);
- }
- else if (strtol(parts[1], NULL, 10) != 1)
- {
- sr_warn("Unsupported signal size: '%s'", parts[1]);
- }
- else if (ctx->probecount >= ctx->maxprobes)
- {
- sr_warn("Skipping '%s' because only %d probes requested.", parts[3], ctx->maxprobes);
- }
- else
- {
- sr_info("Probe %d is '%s' identified by '%s'.", ctx->probecount, parts[3], parts[2]);
- ctx->probes[ctx->probecount].identifier = g_strdup(parts[2]);
- ctx->probes[ctx->probecount].name = g_strdup(parts[3]);
- ctx->probecount++;
- }
-
- g_strfreev(parts);
- }
-
- g_free(name); name = NULL;
- g_free(contents); contents = NULL;
- }
-
- g_free(name);
- g_free(contents);
-
- return status;
-}
-
-static int format_match(const char *filename)
-{
- FILE *file;
- gchar *name = NULL, *contents = NULL;
- gboolean status;
-
- file = fopen(filename, "r");
- if (file == NULL)
- return FALSE;
-
- /* If we can parse the first section correctly,
- * then it is assumed to be a VCD file.
- */
- status = parse_section(file, &name, &contents);
- status = status && (*name != '\0');
-
- g_free(name);
- g_free(contents);
- fclose(file);
-
- return status;
-}
-
-static int init(struct sr_input *in)
-{
- struct sr_probe *probe;
- int num_probes, i;
- char name[SR_MAX_PROBENAME_LEN + 1];
- char *param;
- struct context *ctx;
-
- if (!(ctx = g_try_malloc0(sizeof(*ctx)))) {
- sr_err("Input format context malloc failed.");
- return SR_ERR_MALLOC;
- }
-
- num_probes = DEFAULT_NUM_PROBES;
- ctx->samplerate = 0;
-
- if (in->param) {
- param = g_hash_table_lookup(in->param, "numprobes");
- if (param) {
- num_probes = strtoul(param, NULL, 10);
- if (num_probes < 1)
- return SR_ERR;
- }
- }
-
- /* Maximum number of probes to parse from the VCD */
- ctx->maxprobes = num_probes;
-
- /* Create a virtual device. */
- in->sdi = sr_dev_inst_new(0, SR_ST_ACTIVE, NULL, NULL, NULL);
- in->internal = ctx;
-
- for (i = 0; i < num_probes; i++) {
- snprintf(name, SR_MAX_PROBENAME_LEN, "%d", i);
-
- if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, name)))
- 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)
-{
- struct sr_datafeed_header header;
- struct sr_datafeed_packet packet;
- struct sr_datafeed_meta_logic meta;
- struct sr_datafeed_logic logic;
- FILE *file;
- struct context *ctx;
-
- ctx = in->internal;
-
- if ((file = fopen(filename, "r")) == NULL)
- return SR_ERR;
-
- if (!parse_header(file, ctx))
- {
- sr_err("VCD parsing failed");
- fclose(file);
- return SR_ERR;
- }
-
- /* 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);
-
- /* Send metadata about the SR_DF_LOGIC packets to come. */
- packet.type = SR_DF_META_LOGIC;
- packet.payload = &meta;
- meta.samplerate = ctx->samplerate;
- meta.num_probes = ctx->probecount;
- 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);
-*/
- /* Send end packet to the session bus. */
- packet.type = SR_DF_END;
- sr_session_send(in->sdi, &packet);
-
- g_free(ctx);
- in->internal = NULL;
-
- return SR_OK;
-}
-
-SR_PRIV struct sr_input_format input_vcd = {
- .id = "vcd",
- .description = "Value Change Dump",
- .format_match = format_match,
- .init = init,
- .loadfile = loadfile,
-};
projects / libsigrok.git / blobdiff