]> sigrok.org Git - libsigrok.git/blobdiff - src/input/vcd.c
Use driver name as the log prefix in standard functions
[libsigrok.git] / src / input / vcd.c
index 54e9c73359854d222670ad838efb700a6cc74520..3b8aba8206b71e64a048df2b1c7b3ed1b874de95 100644 (file)
@@ -67,7 +67,6 @@
 
 #define LOG_PREFIX "input/vcd"
 
-#define DEFAULT_NUM_CHANNELS 8
 #define CHUNKSIZE (1024 * 1024)
 
 struct context {
@@ -106,6 +105,10 @@ static gboolean parse_section(GString *buf, gchar **name, gchar **contents)
        status = FALSE;
        pos = 0;
 
+       /* Skip UTF8 BOM */
+       if (buf->len >= 3 && !strncmp(buf->str, "\xef\xbb\xbf", 3))
+               pos = 3;
+
        /* Skip any initial white-space. */
        while (pos < buf->len && g_ascii_isspace(buf->str[pos]))
                pos++;
@@ -206,27 +209,35 @@ static gboolean parse_header(const struct sr_input *in, GString *buf)
                                sr_err("Parsing timescale failed.");
                        }
                } else if (g_strcmp0(name, "var") == 0) {
-                       /* Format: $var type size identifier reference $end */
+                       /* Format: $var type size identifier reference [opt. index] $end */
+                       unsigned int length;
+
                        parts = g_strsplit_set(contents, " \r\n\t", 0);
                        remove_empty_parts(parts);
+                       length = g_strv_length(parts);
 
-                       if (g_strv_length(parts) != 4)
-                               sr_warn("$var section should have 4 items");
+                       if (length != 4 && length != 5)
+                               sr_warn("$var section should have 4 or 5 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 (inc->channelcount >= inc->maxchannels)
-                               sr_warn("Skipping '%s' because only %d channels requested.",
-                                               parts[3], inc->maxchannels);
+                       else if (inc->maxchannels && inc->channelcount >= inc->maxchannels)
+                               sr_warn("Skipping '%s%s' because only %d channels requested.",
+                                       parts[3], parts[4] ? : "", inc->maxchannels);
                        else {
-                               sr_info("Channel %d is '%s' identified by '%s'.",
-                                               inc->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]);
+                               if (length == 4)
+                                       vcd_ch->name = g_strdup(parts[3]);
+                               else
+                                       vcd_ch->name = g_strconcat(parts[3], parts[4], NULL);
+
+                               sr_info("Channel %d is '%s' identified by '%s'.",
+                                               inc->channelcount, vcd_ch->name, vcd_ch->identifier);
+
+                               sr_channel_new(in->sdi, inc->channelcount++, SR_CHANNEL_LOGIC, TRUE, vcd_ch->name);
                                inc->channels = g_slist_append(inc->channels, vcd_ch);
-                               inc->channelcount++;
                        }
 
                        g_strfreev(parts);
@@ -328,14 +339,36 @@ static void add_samples(const struct sr_input *in, size_t count)
        }
 }
 
+/* Set the channel level depending on the identifier and parsed value. */
+static void process_bit(struct context *inc, char *identifier, unsigned int bit)
+{
+       GSList *l;
+       struct vcd_channel *vcd_ch;
+       unsigned int j;
+
+       for (j = 0, l = inc->channels; j < inc->channelcount && l; j++, l = l->next) {
+               vcd_ch = l->data;
+               if (g_strcmp0(identifier, vcd_ch->identifier) == 0) {
+                       /* Found our channel. */
+                       size_t byte_idx = (j / 8);
+                       size_t bit_idx = j - 8 * byte_idx;
+                       if (bit)
+                               inc->current_levels[byte_idx] |= (uint8_t)1 << bit_idx;
+                       else
+                               inc->current_levels[byte_idx] &= ~((uint8_t)1 << bit_idx);
+                       break;
+               }
+       }
+       if (j == inc->channelcount)
+               sr_dbg("Did not find channel for identifier '%s'.", identifier);
+}
+
 /* Parse a set of lines from the data section. */
 static void parse_contents(const struct sr_input *in, char *data)
 {
        struct context *inc;
-       struct vcd_channel *vcd_ch;
-       GSList *l;
        uint64_t timestamp, prev_timestamp;
-       unsigned int bit, i, j;
+       unsigned int bit, i;
        char **tokens;
 
        inc = in->priv;
@@ -398,10 +431,31 @@ static void parse_contents(const struct sr_input *in, char *data)
                                inc->skip_until_end = TRUE;
                                break;
                        }
-               } else if (strchr("bBrR", tokens[i][0]) != NULL) {
-                       /* A vector value, not supported yet. */
-                       break;
+               } else if (strchr("rR", tokens[i][0]) != NULL) {
+                       sr_dbg("Real type vector values not supported yet!");
+                       if (!tokens[++i])
+                               /* No tokens left, bail out */
+                               break;
+                       else
+                               /* Process next token */
+                               continue;
+               } else if (strchr("bB", tokens[i][0]) != NULL) {
+                       bit = (tokens[i][1] == '1');
+
+                       /*
+                        * Bail out if a) char after 'b' is NUL, or b) there is
+                        * a second character after 'b', or c) there is no
+                        * identifier.
+                        */
+                       if (!tokens[i][1] || tokens[i][2] || !tokens[++i]) {
+                               sr_dbg("Unexpected vector format!");
+                               break;
+                       }
+
+                       process_bit(inc, tokens[i], bit);
                } else if (strchr("01xXzZ", tokens[i][0]) != NULL) {
+                       char *identifier;
+
                        /* A new 1-bit sample value */
                        bit = (tokens[i][0] == '1');
 
@@ -410,30 +464,15 @@ static void parse_contents(const struct sr_input *in, char *data)
                         * there was whitespace after the bit, the next token.
                         */
                        if (tokens[i][1] == '\0') {
-                               if (!tokens[++i])
-                                       /* Missing identifier */
-                                       continue;
-                       } else {
-                               for (j = 1; tokens[i][j]; j++)
-                                       tokens[i][j - 1] = tokens[i][j];
-                               tokens[i][j - 1] = '\0';
-                       }
-
-                       for (j = 0, l = inc->channels; j < inc->channelcount && l; j++, l = l->next) {
-                               vcd_ch = l->data;
-                               if (g_strcmp0(tokens[i], vcd_ch->identifier) == 0) {
-                                       /* Found our channel */
-                                       size_t byte_idx = (j / 8);
-                                       size_t bit_idx = j - 8 * byte_idx;
-                                       if (bit)
-                                               inc->current_levels[byte_idx] |= (uint8_t)1 << bit_idx;
-                                       else
-                                               inc->current_levels[byte_idx] &= ~((uint8_t)1 << bit_idx);
+                               if (!tokens[++i]) {
+                                       sr_dbg("Identifier missing!");
                                        break;
                                }
+                               identifier = tokens[i];
+                       } else {
+                               identifier = tokens[i] + 1;
                        }
-                       if (j == inc->channelcount)
-                               sr_dbg("Did not find channel for identifier '%s'.", tokens[i]);
+                       process_bit(inc, identifier, bit);
                } else {
                        sr_warn("Skipping unknown token '%s'.", tokens[i]);
                }
@@ -443,18 +482,11 @@ static void parse_contents(const struct sr_input *in, char *data)
 
 static int init(struct sr_input *in, GHashTable *options)
 {
-       int num_channels, i;
-       char name[16];
        struct context *inc;
 
-       num_channels = g_variant_get_int32(g_hash_table_lookup(options, "numchannels"));
-       if (num_channels < 1) {
-               sr_err("Invalid value for numchannels: must be at least 1.");
-               return SR_ERR_ARG;
-       }
        inc = in->priv = g_malloc0(sizeof(struct context));
-       inc->maxchannels = num_channels;
 
+       inc->maxchannels = g_variant_get_int32(g_hash_table_lookup(options, "numchannels"));
        inc->downsample = g_variant_get_int32(g_hash_table_lookup(options, "downsample"));
        if (inc->downsample < 1)
                inc->downsample = 1;
@@ -468,11 +500,6 @@ static int init(struct sr_input *in, GHashTable *options)
 
        inc->buffer = g_malloc(CHUNKSIZE);
 
-       for (i = 0; i < num_channels; i++) {
-               snprintf(name, 16, "%d", i);
-               sr_channel_new(in->sdi, i, SR_CHANNEL_LOGIC, TRUE, name);
-       }
-
        return SR_OK;
 }
 
@@ -503,7 +530,7 @@ static int process_buffer(struct sr_input *in)
 
        inc = in->priv;
        if (!inc->started) {
-               std_session_send_df_header(in->sdi, LOG_PREFIX);
+               std_session_send_df_header(in->sdi);
 
                packet.type = SR_DF_META;
                packet.payload = &meta;
@@ -555,7 +582,6 @@ static int receive(struct sr_input *in, GString *buf)
 
 static int end(struct sr_input *in)
 {
-       struct sr_datafeed_packet packet;
        struct context *inc;
        int ret;
 
@@ -569,10 +595,8 @@ static int end(struct sr_input *in)
        /* Send any samples that haven't been sent yet. */
        send_buffer(in);
 
-       if (inc->started) {
-               packet.type = SR_DF_END;
-               sr_session_send(in->sdi, &packet);
-       }
+       if (inc->started)
+               std_session_send_df_end(in->sdi);
 
        return ret;
 }
@@ -589,6 +613,17 @@ static void cleanup(struct sr_input *in)
        inc->current_levels = NULL;
 }
 
+static int reset(struct sr_input *in)
+{
+       struct context *inc = in->priv;
+
+       cleanup(in);
+       inc->started = FALSE;
+       g_string_truncate(in->buf, 0);
+
+       return SR_OK;
+}
+
 static struct sr_option options[] = {
        { "numchannels", "Number of channels", "Number of channels", NULL, NULL },
        { "skip", "Skip", "Skip until timestamp", NULL, NULL },
@@ -600,7 +635,7 @@ static struct sr_option options[] = {
 static const struct sr_option *get_options(void)
 {
        if (!options[0].def) {
-               options[0].def = g_variant_ref_sink(g_variant_new_int32(DEFAULT_NUM_CHANNELS));
+               options[0].def = g_variant_ref_sink(g_variant_new_int32(0));
                options[1].def = g_variant_ref_sink(g_variant_new_int32(-1));
                options[2].def = g_variant_ref_sink(g_variant_new_int32(1));
                options[3].def = g_variant_ref_sink(g_variant_new_int32(0));
@@ -621,4 +656,5 @@ SR_PRIV struct sr_input_module input_vcd = {
        .receive = receive,
        .end = end,
        .cleanup = cleanup,
+       .reset = reset,
 };