]>
Commit | Line | Data |
---|---|---|
02604ed6 | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
02604ed6 UH |
3 | * |
4 | * Copyright (C) 2011 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> | |
545f9786 | 24 | #include "config.h" /* Needed for PACKAGE_STRING and others. */ |
45c59c8b BV |
25 | #include "libsigrok.h" |
26 | #include "libsigrok-internal.h" | |
02604ed6 | 27 | |
3544f848 | 28 | #define LOG_PREFIX "output/csv" |
a944a84b | 29 | |
02604ed6 UH |
30 | struct context { |
31 | unsigned int num_enabled_probes; | |
32 | unsigned int unitsize; | |
02604ed6 UH |
33 | uint64_t samplerate; |
34 | GString *header; | |
35 | char separator; | |
36 | }; | |
37 | ||
38 | /* | |
39 | * TODO: | |
40 | * - Option to specify delimiter character and/or string. | |
41 | * - Option to (not) print metadata as comments. | |
42 | * - Option to specify the comment character(s), e.g. # or ; or C/C++-style. | |
43 | * - Option to (not) print samplenumber / time as extra column. | |
44 | * - Option to "compress" output (only print changed samples, VCD-like). | |
45 | * - Option to print comma-separated bits, or whole bytes/words (for 8/16 | |
46 | * probe LAs) as ASCII/hex etc. etc. | |
47 | * - Trigger support. | |
48 | */ | |
49 | ||
50 | static int init(struct sr_output *o) | |
51 | { | |
52 | struct context *ctx; | |
53 | struct sr_probe *probe; | |
54 | GSList *l; | |
ec4063b8 | 55 | GVariant *gvar; |
02604ed6 | 56 | int num_probes; |
02604ed6 | 57 | time_t t; |
02604ed6 | 58 | |
4829d37d | 59 | if (!o) |
02604ed6 | 60 | return SR_ERR_ARG; |
02604ed6 | 61 | |
4829d37d | 62 | if (!o->sdi) |
02604ed6 | 63 | return SR_ERR_ARG; |
02604ed6 | 64 | |
4829d37d | 65 | ctx = g_try_malloc0(sizeof(struct context)); |
02604ed6 UH |
66 | o->internal = ctx; |
67 | ||
1c5b099a | 68 | /* Get the number of probes, and the unitsize. */ |
5c3c1241 | 69 | for (l = o->sdi->probes; l; l = l->next) { |
02604ed6 | 70 | probe = l->data; |
3699a8a1 BV |
71 | if (probe->type != SR_PROBE_LOGIC) |
72 | continue; | |
73 | if (!probe->enabled) | |
74 | continue; | |
75 | ctx->num_enabled_probes++; | |
02604ed6 | 76 | } |
1c5b099a | 77 | |
02604ed6 UH |
78 | ctx->unitsize = (ctx->num_enabled_probes + 7) / 8; |
79 | ||
5c3c1241 | 80 | num_probes = g_slist_length(o->sdi->probes); |
02604ed6 | 81 | |
d3c74a6f BV |
82 | if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE, |
83 | &gvar) == SR_OK) { | |
ec4063b8 BV |
84 | ctx->samplerate = g_variant_get_uint64(gvar); |
85 | g_variant_unref(gvar); | |
5c3c1241 BV |
86 | } else |
87 | ctx->samplerate = 0; | |
02604ed6 UH |
88 | |
89 | ctx->separator = ','; | |
02604ed6 UH |
90 | ctx->header = g_string_sized_new(512); |
91 | ||
92 | t = time(NULL); | |
93 | ||
94 | /* Some metadata */ | |
95 | g_string_append_printf(ctx->header, "; CSV, generated by %s on %s", | |
96 | PACKAGE_STRING, ctime(&t)); | |
97 | g_string_append_printf(ctx->header, "; Samplerate: %"PRIu64"\n", | |
98 | ctx->samplerate); | |
99 | ||
100 | /* Columns / channels */ | |
101 | g_string_append_printf(ctx->header, "; Channels (%d/%d): ", | |
102 | ctx->num_enabled_probes, num_probes); | |
1c5b099a ML |
103 | for (l = o->sdi->probes; l; l = l->next) { |
104 | probe = l->data; | |
3699a8a1 BV |
105 | if (probe->type != SR_PROBE_LOGIC) |
106 | continue; | |
107 | if (!probe->enabled) | |
108 | continue; | |
109 | g_string_append_printf(ctx->header, "%s, ", probe->name); | |
1c5b099a | 110 | } |
02604ed6 UH |
111 | g_string_append_printf(ctx->header, "\n"); |
112 | ||
5c3c1241 | 113 | return SR_OK; |
02604ed6 UH |
114 | } |
115 | ||
4829d37d BV |
116 | static int receive(struct sr_output *o, const struct sr_dev_inst *sdi, |
117 | const struct sr_datafeed_packet *packet, GString **out) | |
02604ed6 | 118 | { |
4829d37d | 119 | const struct sr_datafeed_logic *logic; |
02604ed6 | 120 | struct context *ctx; |
e96cf218 BV |
121 | uint64_t i, j; |
122 | gchar *p, c; | |
02604ed6 | 123 | |
4829d37d | 124 | (void)sdi; |
02604ed6 | 125 | |
4829d37d BV |
126 | *out = NULL; |
127 | if (!o || !o->sdi) | |
02604ed6 | 128 | return SR_ERR_ARG; |
4829d37d | 129 | if (!(ctx = o->internal)) |
02604ed6 | 130 | return SR_ERR_ARG; |
02604ed6 | 131 | |
4829d37d BV |
132 | switch (packet->type) { |
133 | case SR_DF_LOGIC: | |
134 | logic = packet->payload; | |
135 | if (ctx->header) { | |
136 | /* | |
137 | * First data packet: prime the output with the | |
138 | * previously prepared header. | |
139 | */ | |
140 | *out = ctx->header; | |
141 | ctx->header = NULL; | |
142 | } else { | |
143 | *out = g_string_sized_new(512); | |
144 | } | |
145 | ||
146 | for (i = 0; i <= logic->length - ctx->unitsize; i += ctx->unitsize) { | |
4829d37d | 147 | for (j = 0; j < ctx->num_enabled_probes; j++) { |
e96cf218 BV |
148 | p = logic->data + i + j / 8; |
149 | c = *p & (1 << (j % 8)); | |
150 | g_string_append_c(*out, c ? '1' : '0'); | |
151 | g_string_append_c(*out, ctx->separator); | |
4829d37d BV |
152 | } |
153 | g_string_append_printf(*out, "\n"); | |
154 | } | |
02604ed6 UH |
155 | break; |
156 | case SR_DF_END: | |
02604ed6 UH |
157 | g_free(o->internal); |
158 | o->internal = NULL; | |
159 | break; | |
02604ed6 UH |
160 | } |
161 | ||
162 | return SR_OK; | |
163 | } | |
164 | ||
4829d37d | 165 | static int cleanup(struct sr_output *o) |
02604ed6 UH |
166 | { |
167 | struct context *ctx; | |
02604ed6 | 168 | |
4829d37d | 169 | if (!o || !o->sdi) |
02604ed6 | 170 | return SR_ERR_ARG; |
02604ed6 | 171 | |
4829d37d BV |
172 | if (o->internal) { |
173 | ctx = o->internal; | |
174 | if (ctx->header) | |
175 | g_string_free(ctx->header, TRUE); | |
176 | g_free(o->internal); | |
177 | o->internal = NULL; | |
02604ed6 UH |
178 | } |
179 | ||
02604ed6 UH |
180 | return SR_OK; |
181 | } | |
182 | ||
7c1d391c | 183 | SR_PRIV struct sr_output_format output_csv = { |
02604ed6 UH |
184 | .id = "csv", |
185 | .description = "Comma-separated values (CSV)", | |
186 | .df_type = SR_DF_LOGIC, | |
187 | .init = init, | |
4829d37d BV |
188 | .receive = receive, |
189 | .cleanup = cleanup, | |
02604ed6 | 190 | }; |