2 * This file is part of the sigrok project.
4 * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
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.
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.
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
28 int num_enabled_probes;
35 const char *vcd_header = "\
37 $version\n %s\n$end\n%s\
38 $timescale\n %i %s\n$end\n\
39 $scope module %s $end\n\
42 $enddefinitions $end\n\
45 const char *vcd_header_comment = "\
46 $comment\n Acquisition with %d/%d probes at %s\n$end\n";
48 static int init(struct output *o)
50 /* Maximum header length */
51 #define MAX_HEADER_LEN 2048
58 char *c, *samplerate_s;
59 char wbuf[1000], comment[128];
62 if (!(ctx = calloc(1, sizeof(struct context))))
63 return SIGROK_ERR_MALLOC;
66 ctx->num_enabled_probes = 0;
68 for (l = o->device->probes; l; l = l->next) {
72 ctx->probelist[ctx->num_enabled_probes++] = probe->name;
75 ctx->probelist[ctx->num_enabled_probes] = 0;
76 ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
78 /* TODO: Allow for configuration via o->param. */
80 if (!(ctx->header = calloc(1, MAX_HEADER_LEN + 1))) {
82 return SIGROK_ERR_MALLOC;
84 num_probes = g_slist_length(o->device->probes);
87 if (o->device->plugin) {
88 /* TODO: Handle num_probes == 0, too many probes, etc. */
89 /* TODO: Error handling. */
90 samplerate = *((uint64_t *) o->device->plugin->get_device_info(
91 o->device->plugin_index, DI_CUR_SAMPLERATE));
92 if (!((samplerate_s = sigrok_samplerate_string(samplerate)))) {
97 /* TODO: Handle sprintf() errors. */
98 snprintf(comment, 127, vcd_header_comment,
99 ctx->num_enabled_probes, num_probes, samplerate_s);
103 /* Wires / channels */
105 for (i = 0; i < ctx->num_enabled_probes; i++) {
106 c = (char *)&wbuf + strlen((char *)&wbuf);
107 /* TODO: Needs fixing for very large number of probes. */
108 /* TODO: Handle sprintf() errors. */
109 sprintf(c, "$var wire 1 %c channel%s $end\n",
110 (char)('!' + i), ctx->probelist[i]);
113 /* TODO: Date: File or signals? Make y/n configurable. */
115 b = snprintf(ctx->header, MAX_HEADER_LEN, vcd_header, ctime(&t),
116 PACKAGE_STRING, comment, 1, "ns", PACKAGE, (char *)&wbuf);
117 /* TODO: Handle snprintf() errors. */
119 if (!(ctx->prevbits = calloc(sizeof(int), num_probes))) {
122 return SIGROK_ERR_MALLOC;
128 static int event(struct output *o, int event_type, char **data_out,
129 uint64_t *length_out)
136 switch (event_type) {
141 outlen = strlen("$dumpoff\n$end\n");
142 if (!(outbuf = malloc(outlen + 1)))
143 return SIGROK_ERR_MALLOC;
144 /* TODO: Bug? Drop the + 1? */
145 /* TODO: Handle snprintf() errors. */
146 snprintf(outbuf, outlen + 1, "$dumpoff\n$end\n");
148 *length_out = outlen;
157 static int data(struct output *o, char *data_in, uint64_t length_in,
158 char **data_out, uint64_t *length_out)
161 unsigned int i, outsize;
162 int p, curbit, prevbit;
163 uint64_t sample, prevsample;
164 static uint64_t samplecount = 0;
170 outsize = strlen(ctx->header);
172 /* FIXME: Use realloc(). */
173 if (!(outbuf = calloc(1, outsize + 1 + 10000)))
174 return SIGROK_ERR_MALLOC; /* TODO: free()? What to free? */
178 /* The header is still here, this must be the first packet. */
179 strncpy(outbuf, ctx->header, outsize);
184 /* TODO: Are disabled probes handled correctly? */
186 for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
188 memcpy(&sample, data_in + i, ctx->unitsize);
192 memcpy(&prevsample, data_in + i - 1, ctx->unitsize);
194 for (p = 0; p < ctx->num_enabled_probes; p++) {
195 curbit = (sample & ((uint64_t) (1 << p))) >> p;
196 prevbit = (prevsample & ((uint64_t) (1 << p))) >> p;
198 /* VCD only contains deltas/changes of signals. */
199 if (prevbit == curbit)
202 /* Output which signal changed to which value. */
203 c = outbuf + strlen(outbuf);
204 sprintf(c, "#%" PRIu64 "\n%i%c\n", samplecount,
205 curbit, (char)('!' + p));
208 /* TODO: Use realloc() if strlen(outbuf) is almost "full"... */
212 *length_out = strlen(outbuf);
217 struct output_format output_vcd = {
219 "Value Change Dump (VCD)",