]> sigrok.org Git - libsigrok.git/blobdiff - input/vcd.c
Replace 'probe' with 'channel' in most places.
[libsigrok.git] / input / vcd.c
index b10da20be90fcc2667a68092f829a44ba8c54f52..88bc2ff67f1824e6824991231736329dc1aa0241 100644 (file)
@@ -19,7 +19,7 @@
 
 /* The VCD input module has the following options:
  *
- * numprobes:   Maximum number of probes to use. The probes are
+ * numchannels: Maximum number of channels to use. The channels are
  *              detected in the same order as they are listed
  *              in the $var sections of the VCD file.
  *
@@ -53,7 +53,7 @@
  * - analog, integer and real number variables
  * - $dumpvars initial value declaration
  * - $scope namespaces
- * - more than 64 probes
+ * - more than 64 channels
  */
 
 #include <stdlib.h>
 #include "libsigrok.h"
 #include "libsigrok-internal.h"
 
-/* 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 LOG_PREFIX "input/vcd"
 
 #define DEFAULT_NUM_PROBES 8
 #define CHUNKSIZE 1024
 
 struct context {
        uint64_t samplerate;
-       int maxprobes;
-       int probecount;
+       int maxchannels;
+       int channelcount;
        int downsample;
        unsigned compress;
        int64_t skip;
-       GSList *probes;
+       GSList *channels;
 };
 
-struct probe {
+struct vcd_channel {
        gchar *name;
        gchar *identifier;
 };
@@ -100,31 +93,32 @@ struct probe {
  */
 static gboolean read_until(FILE *file, GString *dest, char mode)
 {
+       int  c;
        char prev[4] = "";
-       long startpos = ftell(file);
+
        for(;;) {
-               int c = fgetc(file);
+               c = fgetc(file);
 
                if (c == EOF) {
                        if (mode == '$')
-                               sr_err("Unexpected EOF, read started at %ld.", startpos);
+                               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;
                        }
                }
@@ -142,45 +136,45 @@ 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 */      
+
+       /* 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 */ 
+       /* 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;
 }
 
-static void free_probe(void *data)
+static void free_channel(void *data)
 {
-       struct probe *probe = data;
-       g_free(probe->name);
-       g_free(probe->identifier);
-       g_free(probe);
+       struct vcd_channel *vcd_ch = data;
+       g_free(vcd_ch->name);
+       g_free(vcd_ch->identifier);
+       g_free(vcd_ch);
 }
 
 static void release_context(struct context *ctx)
 {
-       g_slist_free_full(ctx->probes, free_probe);
+       g_slist_free_full(ctx->channels, free_channel);
        g_free(ctx);
 }
 
@@ -194,7 +188,7 @@ static void remove_empty_parts(gchar **parts)
                        *dest++ = *src;
                src++;
        }
-       
+
        *dest = NULL;
 }
 
@@ -207,11 +201,11 @@ static gboolean parse_header(FILE *file, struct context *ctx)
        uint64_t p, q;
        gchar *name = NULL, *contents = NULL;
        gboolean status = FALSE;
-       struct probe *probe;
+       struct vcd_channel *vcd_ch;
 
        while (parse_section(file, &name, &contents)) {
                sr_dbg("Section '%s', contents '%s'.", name, contents);
-       
+
                if (g_strcmp0(name, "enddefinitions") == 0) {
                        status = TRUE;
                        break;
@@ -227,7 +221,7 @@ static gboolean parse_header(FILE *file, struct context *ctx)
                                        sr_warn("Inexact rounding of samplerate, %" PRIu64 " / %" PRIu64 " to %" PRIu64 " Hz.",
                                                q, p, ctx->samplerate);
                                }
-                               
+
                                sr_dbg("Samplerate: %" PRIu64, ctx->samplerate);
                        } else {
                                sr_err("Parsing timescale failed.");
@@ -236,34 +230,34 @@ static gboolean parse_header(FILE *file, struct context *ctx)
                        /* 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_warn("$var section should have 4 items");
                        else if (g_strcmp0(parts[0], "reg") != 0 && g_strcmp0(parts[0], "wire") != 0)
                                sr_info("Unsupported signal type: '%s'", parts[0]);
                        else if (strtol(parts[1], NULL, 10) != 1)
                                sr_info("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 if (ctx->channelcount >= ctx->maxchannels)
+                               sr_warn("Skipping '%s' because only %d channels requested.", parts[3], ctx->maxchannels);
                        else {
-                               sr_info("Probe %d is '%s' identified by '%s'.", ctx->probecount, parts[3], parts[2]);
-                               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++;
+                               sr_info("Channel %d is '%s' identified by '%s'.", ctx->channelcount, parts[3], parts[2]);
+                               vcd_ch = g_malloc(sizeof(struct vcd_channel));
+                               vcd_ch->identifier = g_strdup(parts[2]);
+                               vcd_ch->name = g_strdup(parts[3]);
+                               ctx->channels = g_slist_append(ctx->channels, vcd_ch);
+                               ctx->channelcount++;
                        }
-                       
+
                        g_strfreev(parts);
                }
-               
+
                g_free(name); name = NULL;
                g_free(contents); contents = NULL;
        }
-       
+
        g_free(name);
        g_free(contents);
-       
+
        return status;
 }
 
@@ -272,7 +266,7 @@ 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;
@@ -283,18 +277,18 @@ static int format_match(const char *filename)
         */
        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, const char *filename)
 {
-       struct sr_probe *probe;
-       int num_probes, i;
+       struct sr_channel *ch;
+       int num_channels, i;
        char name[SR_MAX_PROBENAME_LEN + 1];
        char *param;
        struct context *ctx;
@@ -306,56 +300,56 @@ static int init(struct sr_input *in, const char *filename)
                return SR_ERR_MALLOC;
        }
 
-       num_probes = DEFAULT_NUM_PROBES;
+       num_channels = DEFAULT_NUM_PROBES;
        ctx->samplerate = 0;
        ctx->downsample = 1;
        ctx->skip = -1;
 
        if (in->param) {
-               param = g_hash_table_lookup(in->param, "numprobes");
+               param = g_hash_table_lookup(in->param, "numchannels");
                if (param) {
-                       num_probes = strtoul(param, NULL, 10);
-                       if (num_probes < 1) {
+                       num_channels = strtoul(param, NULL, 10);
+                       if (num_channels < 1) {
                                release_context(ctx);
                                return SR_ERR;
-                       } else if (num_probes > 64) {
-                               sr_err("No more than 64 probes supported.");
+                       } else if (num_channels > 64) {
+                               sr_err("No more than 64 channels supported.");
                                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;
        }
-       
-       /* Maximum number of probes to parse from the VCD */
-       ctx->maxprobes = num_probes;
+
+       /* Maximum number of channels to parse from the VCD */
+       ctx->maxchannels = num_channels;
 
        /* 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++) {
+       for (i = 0; i < num_channels; i++) {
                snprintf(name, SR_MAX_PROBENAME_LEN, "%d", i);
-               
-               if (!(probe = sr_probe_new(i, SR_PROBE_LOGIC, TRUE, name))) {
+
+               if (!(ch = 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);
+
+               in->sdi->channels = g_slist_append(in->sdi->channels, ch);
        }
 
        return SR_OK;
@@ -369,24 +363,24 @@ static void send_samples(const struct sr_dev_inst *sdi, uint64_t sample, uint64_
        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;        
+       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;
        }
@@ -396,20 +390,20 @@ static void send_samples(const struct sr_dev_inst *sdi, uint64_t sample, uint64_
 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
@@ -430,9 +424,9 @@ static void parse_contents(FILE *file, const struct sr_dev_inst *sdi, struct con
                                        /* 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;
@@ -458,10 +452,10 @@ static void parse_contents(FILE *file, const struct sr_dev_inst *sdi, struct con
                        /* A new 1-bit sample value */
                        int i, bit;
                        GSList *l;
-                       struct probe *probe;
+                       struct vcd_channel *vcd_ch;
 
                        bit = (token->str[0] == '1');
-               
+
                        g_string_erase(token, 0, 1);
                        if (token->len == 0) {
                                /* There was a space between value and identifier.
@@ -470,32 +464,30 @@ static void parse_contents(FILE *file, const struct sr_dev_inst *sdi, struct con
                                read_until(file, NULL, 'N');
                                read_until(file, token, 'W');
                        }
-                       
-                       for (i = 0, l = ctx->probes; i < ctx->probecount && l; i++, l = l->next) {
-                               probe = l->data;
-
-                               if (g_strcmp0(token->str, probe->identifier) == 0) {
-                                       sr_dbg("Probe %d new value %d.", i, bit);
-                               
-                                       /* Found our probe */
+
+                       for (i = 0, l = ctx->channels; i < ctx->channelcount && l; i++, l = l->next) {
+                               vcd_ch = l->data;
+
+                               if (g_strcmp0(token->str, vcd_ch->identifier) == 0) {
+                                       /* Found our channel */
                                        if (bit)
-                                               prev_values |= (1 << i);
+                                               prev_values |= (uint64_t)1 << i;
                                        else
-                                               prev_values &= ~(1 << i);
-                                       
+                                               prev_values &= ~((uint64_t)1 << i);
+
                                        break;
                                }
                        }
-                       
-                       if (i == ctx->probecount)
-                               sr_dbg("Did not find probe for identifier '%s'.", token->str);
+
+                       if (i == ctx->channelcount)
+                               sr_dbg("Did not find channel for identifier '%s'.", token->str);
                } else {
                        sr_warn("Skipping unknown token '%s'.", token->str);
                }
-               
+
                g_string_truncate(token, 0);
        }
-       
+
        g_string_free(token, TRUE);
 }
 
@@ -533,7 +525,7 @@ static int loadfile(struct sr_input *in, const char *filename)
 
        /* 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);