]> sigrok.org Git - libsigrok.git/blobdiff - output/output_vcd.c
add DF_ANALOG, and an analog output module
[libsigrok.git] / output / output_vcd.c
index 767e398dc5bfec7abe078b187417cebe99173108..190e9e4561fa47c44baa6a788dddc6b9690572a9 100644 (file)
@@ -33,9 +33,8 @@ struct context {
 };
 
 const char *vcd_header = "\
-$date\n  %s\n$end\n\
-$version\n  %s\n$end\n\
-$comment\n  Acquisition with %d/%d probes at %s\n$end\n\
+$date\n  %s$end\n\
+$version\n  %s\n$end\n%s\
 $timescale\n  %i %s\n$end\n\
 $scope module %s $end\n\
 %s\
@@ -43,6 +42,9 @@ $upscope $end\n\
 $enddefinitions $end\n\
 $dumpvars\n";
 
+const char *vcd_header_comment = "\
+$comment\n  Acquisition with %d/%d probes at %s\n$end\n";
+
 static int init(struct output *o)
 {
 /* Maximum header length */
@@ -54,17 +56,20 @@ static int init(struct output *o)
        uint64_t samplerate;
        int i, b, num_probes;
        char *c, *samplerate_s;
-       char wbuf[1000];
+       char wbuf[1000], comment[128];
+       time_t t;
 
-       ctx = malloc(sizeof(struct context));
-       if (ctx == NULL)
+       if (!(ctx = calloc(1, sizeof(struct context))))
                return SIGROK_ERR_MALLOC;
+
        o->internal = ctx;
        ctx->num_enabled_probes = 0;
+
        for (l = o->device->probes; l; l = l->next) {
                probe = l->data;
-               if (probe->enabled)
-                       ctx->probelist[ctx->num_enabled_probes++] = probe->name;
+               if (!probe->enabled)
+                       continue;
+               ctx->probelist[ctx->num_enabled_probes++] = probe->name;
        }
 
        ctx->probelist[ctx->num_enabled_probes] = 0;
@@ -72,38 +77,52 @@ static int init(struct output *o)
 
        /* TODO: Allow for configuration via o->param. */
 
-       ctx->header = calloc(1, MAX_HEADER_LEN + 1);
-       if (ctx->header == NULL)
+       if (!(ctx->header = calloc(1, MAX_HEADER_LEN + 1))) {
+               free(ctx);
                return SIGROK_ERR_MALLOC;
+       }
        num_probes = g_slist_length(o->device->probes);
-       /* TODO: Handle num_probes == 0, too many probes, etc. */
-       samplerate = *((uint64_t *) o->device->plugin->get_device_info(
-                       o->device->plugin_index, DI_CUR_SAMPLERATE));
 
-       if ((samplerate_s = sigrok_samplerate_string(samplerate)) == NULL)
-               return -1; // FIXME
+       comment[0] = '\0';
+       if (o->device->plugin) {
+               /* TODO: Handle num_probes == 0, too many probes, etc. */
+               /* TODO: Error handling. */
+               samplerate = *((uint64_t *) o->device->plugin->get_device_info(
+                               o->device->plugin_index, DI_CUR_SAMPLERATE));
+               if (!((samplerate_s = sigrok_samplerate_string(samplerate)))) {
+                       free(ctx->header);
+                       free(ctx);
+                       return SIGROK_ERR;
+               }
+               /* TODO: Handle sprintf() errors. */
+               snprintf(comment, 127, vcd_header_comment,
+                        ctx->num_enabled_probes, num_probes, samplerate_s);
+               free(samplerate_s);
+       }
 
        /* Wires / channels */
        wbuf[0] = '\0';
        for (i = 0; i < ctx->num_enabled_probes; i++) {
                c = (char *)&wbuf + strlen((char *)&wbuf);
+               /* TODO: Needs fixing for very large number of probes. */
+               /* TODO: Handle sprintf() errors. */
                sprintf(c, "$var wire 1 %c channel%s $end\n",
-                        (char)('!' + i), ctx->probelist[i]);
+                       (char)('!' + i), ctx->probelist[i]);
        }
 
-       /* TODO: date: File or signals? Make y/n configurable. */
-       b = snprintf(ctx->header, MAX_HEADER_LEN, vcd_header, "TODO: Date",
-                    PACKAGE_STRING, ctx->num_enabled_probes, num_probes,
-                    samplerate_s, 1, "ns", PACKAGE, (char *)&wbuf);
-       /* TODO: Handle snprintf errors. */
+       /* TODO: Date: File or signals? Make y/n configurable. */
+       t = time(NULL);
+       b = snprintf(ctx->header, MAX_HEADER_LEN, vcd_header, ctime(&t),
+                    PACKAGE_STRING, comment, 1, "ns", PACKAGE, (char *)&wbuf);
+       /* TODO: Handle snprintf() errors. */
 
-       free(samplerate_s);
-
-       ctx->prevbits = calloc(sizeof(int), num_probes);
-       if (ctx->prevbits == NULL)
+       if (!(ctx->prevbits = calloc(sizeof(int), num_probes))) {
+               free(ctx->header);
+               free(ctx);
                return SIGROK_ERR_MALLOC;
+       }
 
-       return 0;
+       return SIGROK_OK;
 }
 
 static int event(struct output *o, int event_type, char **data_out,
@@ -114,14 +133,16 @@ static int event(struct output *o, int event_type, char **data_out,
        int outlen;
 
        ctx = o->internal;
-       switch(event_type) {
+       switch (event_type) {
        case DF_TRIGGER:
+               /* TODO */
                break;
        case DF_END:
                outlen = strlen("$dumpoff\n$end\n");
-               outbuf = malloc(outlen + 1);
-               if (outbuf == NULL)
+               if (!(outbuf = malloc(outlen + 1)))
                        return SIGROK_ERR_MALLOC;
+               /* TODO: Bug? Drop the + 1? */
+               /* TODO: Handle snprintf() errors. */
                snprintf(outbuf, outlen + 1, "$dumpoff\n$end\n");
                *data_out = outbuf;
                *length_out = outlen;
@@ -137,49 +158,54 @@ static int data(struct output *o, char *data_in, uint64_t length_in,
                char **data_out, uint64_t *length_out)
 {
        struct context *ctx;
-       int offset, outsize, p, curbit, prevbit;
+       unsigned int i, outsize;
+       int p, curbit, prevbit;
        uint64_t sample, prevsample;
+       static uint64_t samplecount = 0;
        char *outbuf, *c;
 
        ctx = o->internal;
-       outsize = strlen(ctx->header);
-       outbuf = calloc(1, outsize + 1 + 10000); // FIXME: Use realloc().
-       if (outbuf == NULL)
-               return SIGROK_ERR_MALLOC;
+       outsize = 0;
+       if (ctx->header)
+               outsize = strlen(ctx->header);
+
+       /* FIXME: Use realloc(). */
+       if (!(outbuf = calloc(1, outsize + 1 + 10000)))
+               return SIGROK_ERR_MALLOC; /* TODO: free()? What to free? */
+
+       outbuf[0] = '\0';
        if (ctx->header) {
                /* The header is still here, this must be the first packet. */
                strncpy(outbuf, ctx->header, outsize);
                free(ctx->header);
                ctx->header = NULL;
-       } else {
-               outbuf[0] = 0;
        }
 
        /* TODO: Are disabled probes handled correctly? */
 
-       for (offset = 0; offset <= length_in - ctx->unitsize;
-                                               offset += ctx->unitsize) {
-               memcpy(&sample, data_in + offset, ctx->unitsize);
+       for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
+               samplecount++;
+               memcpy(&sample, data_in + i, ctx->unitsize);
+               if (i == 0)
+                       prevsample = sample;
+               else
+                       memcpy(&prevsample, data_in + i - 1, ctx->unitsize);
+
                for (p = 0; p < ctx->num_enabled_probes; p++) {
-                       curbit = (sample & ((uint64_t) (1 << p))) != 0;
-                       if (offset == 0) {
-                               prevbit = ~curbit;
-                       } else {
-                               memcpy(&prevsample, data_in + offset - 1, ctx->unitsize);
-                               prevbit = (prevsample & ((uint64_t) (1 << p))) != 0;
-                       }
-
-                       if (prevbit != curbit) {
-                               /* FIXME: Only once per sample? */
-                               c = outbuf + strlen(outbuf);
-                               sprintf(c, "#%i\n", offset * 1 /* TODO */);
-
-                               c = outbuf + strlen(outbuf);
-                               sprintf(c, "%i%c\n", curbit, (char)('!' + p /* FIXME? */));
-                       }
+                       curbit = (sample & ((uint64_t) (1 << p))) >> p;
+                       prevbit = (prevsample & ((uint64_t) (1 << p))) >> p;
+
+                       /* VCD only contains deltas/changes of signals. */
+                       if (prevbit == curbit)
+                               continue;
+
+                       /* Output which signal changed to which value. */
+                       c = outbuf + strlen(outbuf);
+                       sprintf(c, "#%" PRIu64 "\n%i%c\n", samplecount,
+                               curbit, (char)('!' + p));
                }
 
-               /* TODO: Do a realloc() here if strlen(outbuf) is almost "full"... */
+               /* TODO: Use realloc() if strlen(outbuf) is almost "full"... */
        }
 
        *data_out = outbuf;
@@ -191,6 +217,7 @@ static int data(struct output *o, char *data_in, uint64_t length_in,
 struct output_format output_vcd = {
        "vcd",
        "Value Change Dump (VCD)",
+       DF_LOGIC,
        init,
        data,
        event,