]> sigrok.org Git - libsigrok.git/blobdiff - input/vcd.c
Initial driver for IKALOGIC Scanalogic-2
[libsigrok.git] / input / vcd.c
index b8b469791aaf617fe31955aec77dd8b7f11a73d1..b39793824c30e711f9398a1f14fafda702a5151c 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * This file is part of the sigrok project.
+ * This file is part of the libsigrok project.
  *
  * Copyright (C) 2012 Petteri Aimonen <jpa@sr.mail.kapsi.fi>
  *
  * 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:
@@ -48,6 +52,7 @@
  * - vector variables (bit vectors etc.)
  * - analog, integer and real number variables
  * - $dumpvars initial value declaration
+ * - $scope namespaces
  */
 
 /*  */
 #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)
+/* Message logging helpers with subsystem-specific prefix string. */
+#define LOG_PREFIX "input/vcd: "
+#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
+#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
+#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
+#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
+#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
+#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
 
 #define DEFAULT_NUM_PROBES 8
 
 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)
                {
-                       if (mode != 'N')
-                               sr_err("Unexpected EOF.");
+                       if (mode == '$')
+                               sr_err("Unexpected EOF, read started at %ld.", startpos);
                        return FALSE;
                }
                
@@ -165,19 +171,22 @@ struct context
        int maxprobes;
        int probecount;
        int downsample;
+       unsigned compress;
        int64_t skip;
-       struct probe probes[SR_MAX_NUM_PROBES];
+       GSList *probes;
 };
 
+static void free_probe(void *data)
+{
+       struct probe *probe = data;
+       g_free(probe->name);
+       g_free(probe->identifier);
+       g_free(probe);
+}
+
 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_slist_free_full(ctx->probes, free_probe);
        g_free(ctx);
 }
 
@@ -204,8 +213,10 @@ static void remove_empty_parts(gchar **parts)
  */
 static gboolean parse_header(FILE *file, struct context *ctx)
 {
+       uint64_t p, q;
        gchar *name = NULL, *contents = NULL;
        gboolean status = FALSE;
+       struct probe *probe;
 
        while (parse_section(file, &name, &contents))
        {
@@ -220,15 +231,14 @@ static gboolean parse_header(FILE *file, struct context *ctx)
                {
                        /* 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)
+                       if (sr_parse_period(contents, &p, &q) == SR_OK)
                        {
-                               ctx->samplerate = period.q / period.p;
-                               if (period.q % period.p != 0)
+                               ctx->samplerate = q / p;
+                               if (q % p != 0)
                                {
                                        /* Does not happen unless time value is non-standard */
                                        sr_warn("Inexact rounding of samplerate, %" PRIu64 " / %" PRIu64 " to %" PRIu64 " Hz.",
-                                               period.q, period.p, ctx->samplerate);
+                                               q, p, ctx->samplerate);
                                }
                                
                                sr_dbg("Samplerate: %" PRIu64, ctx->samplerate);
@@ -246,15 +256,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)
                        {
@@ -263,8 +273,10 @@ static gboolean parse_header(FILE *file, struct context *ctx)
                        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]);
+                               probe = g_malloc(sizeof(struct probe));
+                               probe->identifier = g_strdup(parts[2]);
+                               probe->name = g_strdup(parts[3]);
+                               ctx->probes = g_slist_append(ctx->probes, probe);
                                ctx->probecount++;
                        }
                        
@@ -304,7 +316,7 @@ static int format_match(const char *filename)
        return status;
 }
 
-static int init(struct sr_input *in)
+static int init(struct sr_input *in, const char *filename)
 {
        struct sr_probe *probe;
        int num_probes, i;
@@ -312,6 +324,8 @@ static int init(struct sr_input *in)
        char *param;
        struct context *ctx;
 
+       (void)filename;
+
        if (!(ctx = g_try_malloc0(sizeof(*ctx)))) {
                sr_err("Input format context malloc failed.");
                return SR_ERR_MALLOC;
@@ -342,6 +356,11 @@ static int init(struct sr_input *in)
                        }
                }
                
+               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;
@@ -412,7 +431,6 @@ static void parse_contents(FILE *file, const struct sr_dev_inst *sdi, struct con
        GString *token = g_string_sized_new(32);
        
        uint64_t prev_timestamp = 0;
-       uint64_t new_values = 0;
        uint64_t prev_values = 0;
        
        /* Read one space-delimited token at a time. */
@@ -434,41 +452,61 @@ static void parse_contents(FILE *file, const struct sr_dev_inst *sdi, struct con
                        if (ctx->skip < 0)
                        {
                                ctx->skip = timestamp;
+                               prev_timestamp = timestamp;
                        }
                        else if (ctx->skip > 0 && timestamp < (uint64_t)ctx->skip)
                        {
-                               prev_timestamp = ctx->skip - 1;
+                               prev_timestamp = ctx->skip;
                        }
                        else if (timestamp == prev_timestamp)
                        {
-                               /* This only occurs when ctx->downsample > 1 */
-                               if (prev_values != new_values)
-                               {
-                                       sr_warn("VCD downsampling hides a glitch at %" PRIu64, timestamp);
-                                       prev_values = new_values;
-                               }
+                               /* 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, new_values, timestamp - prev_timestamp);
-
+                               send_samples(sdi, prev_values, timestamp - prev_timestamp);
                                prev_timestamp = timestamp;
-                               prev_values = new_values;
                        }
                }
-               else if (token->str[0] == '$')
+               else if (token->str[0] == '$' && token->len > 1)
                {
                        /* This is probably a $dumpvars, $comment or similar.
-                        * For now, just skip it until $end. */
-                       read_until(file, NULL, '$');
+                        * $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;
+                       GSList *l;
+                       struct probe *probe;
+
                        bit = (token->str[0] == '1');
                
                        g_string_erase(token, 0, 1);
@@ -481,17 +519,19 @@ static void parse_contents(FILE *file, const struct sr_dev_inst *sdi, struct con
                                read_until(file, token, 'W');
                        }
                        
-                       for (i = 0; i < ctx->probecount; i++)
+                       for (i = 0, l = ctx->probes; i < ctx->probecount && l; i++, l = l->next)
                        {
-                               if (g_strcmp0(token->str, ctx->probes[i].identifier) == 0)
+                               probe = l->data;
+
+                               if (g_strcmp0(token->str, probe->identifier) == 0)
                                {
                                        sr_dbg("Probe %d new value %d.", i, bit);
                                
                                        /* Found our probe */
                                        if (bit)
-                                               new_values |= (1 << i);
+                                               prev_values |= (1 << i);
                                        else
-                                               new_values &= ~(1 << i);
+                                               prev_values &= ~(1 << i);
                                        
                                        break;
                                }
@@ -499,9 +539,13 @@ static void parse_contents(FILE *file, const struct sr_dev_inst *sdi, struct con
                        
                        if (i == ctx->probecount)
                        {
-                               sr_info("Did not find probe for identifier '%s'.", token->str);
+                               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);
        }
@@ -511,11 +555,12 @@ static void parse_contents(FILE *file, const struct sr_dev_inst *sdi, struct con
 
 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_meta meta;
+       struct sr_config *src;
        FILE *file;
        struct context *ctx;
+       uint64_t samplerate;
 
        ctx = in->internal;
 
@@ -530,18 +575,16 @@ 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, LOG_PREFIX);
 
        /* 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 / ctx->downsample;
-       meta.num_probes = ctx->probecount;
+       samplerate = ctx->samplerate / ctx->downsample;
+       src = sr_config_new(SR_CONF_SAMPLERATE, g_variant_new_uint64(samplerate));
+       meta.config = g_slist_append(NULL, src);
        sr_session_send(in->sdi, &packet);
+       sr_config_free(src);
 
        /* Parse the contents of the VCD file */
        parse_contents(file, in->sdi, ctx);