]> sigrok.org Git - libsigrok.git/blob - output/output_vcd.c
VCD/Gnuplot: Store time/date in output.
[libsigrok.git] / output / output_vcd.c
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
19  */
20
21 #include <stdlib.h>
22 #include <string.h>
23 #include <glib.h>
24 #include <sigrok.h>
25 #include "config.h"
26
27 struct context {
28         int num_enabled_probes;
29         int unitsize;
30         char *probelist[65];
31         int *prevbits;
32         char *header;
33 };
34
35 const char *vcd_header = "\
36 $date\n  %s$end\n\
37 $version\n  %s\n$end\n%s\
38 $timescale\n  %i %s\n$end\n\
39 $scope module %s $end\n\
40 %s\
41 $upscope $end\n\
42 $enddefinitions $end\n\
43 $dumpvars\n";
44
45 const char *vcd_header_comment = "\
46 $comment\n  Acquisition with %d/%d probes at %s\n$end\n";
47
48 static int init(struct output *o)
49 {
50 /* Maximum header length */
51 #define MAX_HEADER_LEN 2048
52
53         struct context *ctx;
54         struct probe *probe;
55         GSList *l;
56         uint64_t samplerate;
57         int i, b, num_probes;
58         char *c, *samplerate_s;
59         char wbuf[1000], comment[128];
60         time_t t;
61
62         if (!(ctx = calloc(1, sizeof(struct context))))
63                 return SIGROK_ERR_MALLOC;
64         o->internal = ctx;
65         ctx->num_enabled_probes = 0;
66         for (l = o->device->probes; l; l = l->next) {
67                 probe = l->data;
68                 if (probe->enabled)
69                         ctx->probelist[ctx->num_enabled_probes++] = probe->name;
70         }
71
72         ctx->probelist[ctx->num_enabled_probes] = 0;
73         ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
74
75         /* TODO: Allow for configuration via o->param. */
76
77         if (!(ctx->header = calloc(1, MAX_HEADER_LEN + 1))) {
78                 free(ctx);
79                 return SIGROK_ERR_MALLOC;
80         }
81         num_probes = g_slist_length(o->device->probes);
82
83         comment[0] = '\0';
84         if (o->device->plugin) {
85                 /* TODO: Handle num_probes == 0, too many probes, etc. */
86                 /* TODO: Error handling. */
87                 samplerate = *((uint64_t *) o->device->plugin->get_device_info(
88                                 o->device->plugin_index, DI_CUR_SAMPLERATE));
89                 if (!((samplerate_s = sigrok_samplerate_string(samplerate)))) {
90                         free(ctx->header);
91                         free(ctx);
92                         return SIGROK_ERR;
93                 }
94                 /* TODO: Handle sprintf() errors. */
95                 snprintf(comment, 127, vcd_header_comment,
96                          ctx->num_enabled_probes, num_probes, samplerate_s);
97                 free(samplerate_s);
98         }
99
100         /* Wires / channels */
101         wbuf[0] = '\0';
102         for (i = 0; i < ctx->num_enabled_probes; i++) {
103                 c = (char *)&wbuf + strlen((char *)&wbuf);
104                 /* TODO: Needs fixing for very large number of probes. */
105                 /* TODO: Handle sprintf() errors. */
106                 sprintf(c, "$var wire 1 %c channel%s $end\n",
107                         (char)('!' + i), ctx->probelist[i]);
108         }
109
110         /* TODO: Date: File or signals? Make y/n configurable. */
111         t = time(NULL);
112         b = snprintf(ctx->header, MAX_HEADER_LEN, vcd_header, ctime(&t),
113                      PACKAGE_STRING, comment, 1, "ns", PACKAGE, (char *)&wbuf);
114         /* TODO: Handle snprintf() errors. */
115
116         if (!(ctx->prevbits = calloc(sizeof(int), num_probes))) {
117                 free(ctx->header);
118                 free(ctx);
119                 return SIGROK_ERR_MALLOC;
120         }
121
122         return SIGROK_OK;
123 }
124
125 static int event(struct output *o, int event_type, char **data_out,
126                  uint64_t *length_out)
127 {
128         struct context *ctx;
129         char *outbuf;
130         int outlen;
131
132         ctx = o->internal;
133         switch (event_type) {
134         case DF_TRIGGER:
135                 /* TODO */
136                 break;
137         case DF_END:
138                 outlen = strlen("$dumpoff\n$end\n");
139                 if (!(outbuf = malloc(outlen + 1)))
140                         return SIGROK_ERR_MALLOC;
141                 /* TODO: Bug? Drop the + 1? */
142                 /* TODO: Handle snprintf() errors. */
143                 snprintf(outbuf, outlen + 1, "$dumpoff\n$end\n");
144                 *data_out = outbuf;
145                 *length_out = outlen;
146                 free(o->internal);
147                 o->internal = NULL;
148                 break;
149         }
150
151         return SIGROK_OK;
152 }
153
154 static int data(struct output *o, char *data_in, uint64_t length_in,
155                 char **data_out, uint64_t *length_out)
156 {
157         struct context *ctx;
158         unsigned int i, outsize;
159         int p, curbit, prevbit;
160         uint64_t sample, prevsample;
161         char *outbuf, *c;
162
163         ctx = o->internal;
164         outsize = 0;
165         if (ctx->header)
166                 outsize = strlen(ctx->header);
167
168         /* FIXME: Use realloc(). */
169         if (!(outbuf = calloc(1, outsize + 1 + 10000)))
170                 return SIGROK_ERR_MALLOC; /* TODO: free()? What to free? */
171
172         outbuf[0] = '\0';
173         if (ctx->header) {
174                 /* The header is still here, this must be the first packet. */
175                 strncpy(outbuf, ctx->header, outsize);
176                 free(ctx->header);
177                 ctx->header = NULL;
178         }
179
180         /* TODO: Are disabled probes handled correctly? */
181
182         for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
183                 memcpy(&sample, data_in + i, ctx->unitsize);
184                 for (p = 0; p < ctx->num_enabled_probes; p++) {
185                         curbit = (sample & ((uint64_t) (1 << p))) != 0;
186                         if (i == 0) {
187                                 prevbit = ~curbit;
188                         } else {
189                                 memcpy(&prevsample, data_in + i - 1,
190                                        ctx->unitsize);
191                                 prevbit =
192                                     (prevsample & ((uint64_t) (1 << p))) != 0;
193                         }
194
195                         /* VCD only contains deltas/changes. */
196                         if (prevbit == curbit)
197                                 continue;
198
199                         /* FIXME: Only once per sample? */
200                         /* TODO: Is 'i' correct here? */
201                         c = outbuf + strlen(outbuf);
202                         sprintf(c, "#%i\n%i%c\n", i, curbit, (char)('!' + p));
203                 }
204
205                 /* TODO: Use realloc() if strlen(outbuf) is almost "full"... */
206         }
207
208         *data_out = outbuf;
209         *length_out = strlen(outbuf);
210
211         return SIGROK_OK;
212 }
213
214 struct output_format output_vcd = {
215         "vcd",
216         "Value Change Dump (VCD)",
217         init,
218         data,
219         event,
220 };