]>
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 | |
a944a84b UH |
28 | /* Message logging helpers with driver-specific prefix string. */ |
29 | #define DRIVER_LOG_DOMAIN "output/csv: " | |
30 | #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args) | |
31 | #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args) | |
32 | #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args) | |
33 | #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args) | |
34 | #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args) | |
35 | #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args) | |
36 | ||
02604ed6 UH |
37 | struct context { |
38 | unsigned int num_enabled_probes; | |
39 | unsigned int unitsize; | |
02604ed6 UH |
40 | uint64_t samplerate; |
41 | GString *header; | |
42 | char separator; | |
43 | }; | |
44 | ||
45 | /* | |
46 | * TODO: | |
47 | * - Option to specify delimiter character and/or string. | |
48 | * - Option to (not) print metadata as comments. | |
49 | * - Option to specify the comment character(s), e.g. # or ; or C/C++-style. | |
50 | * - Option to (not) print samplenumber / time as extra column. | |
51 | * - Option to "compress" output (only print changed samples, VCD-like). | |
52 | * - Option to print comma-separated bits, or whole bytes/words (for 8/16 | |
53 | * probe LAs) as ASCII/hex etc. etc. | |
54 | * - Trigger support. | |
55 | */ | |
56 | ||
57 | static int init(struct sr_output *o) | |
58 | { | |
59 | struct context *ctx; | |
60 | struct sr_probe *probe; | |
61 | GSList *l; | |
ec4063b8 | 62 | GVariant *gvar; |
02604ed6 | 63 | int num_probes; |
02604ed6 | 64 | time_t t; |
02604ed6 UH |
65 | |
66 | if (!o) { | |
a944a84b | 67 | sr_err("%s: o was NULL", __func__); |
02604ed6 UH |
68 | return SR_ERR_ARG; |
69 | } | |
70 | ||
5c3c1241 | 71 | if (!o->sdi) { |
a944a84b | 72 | sr_err("%s: o->sdi was NULL", __func__); |
02604ed6 UH |
73 | return SR_ERR_ARG; |
74 | } | |
75 | ||
5c3c1241 | 76 | if (!o->sdi->driver) { |
a944a84b | 77 | sr_err("%s: o->sdi->driver was NULL", __func__); |
02604ed6 UH |
78 | return SR_ERR_ARG; |
79 | } | |
80 | ||
81 | if (!(ctx = g_try_malloc0(sizeof(struct context)))) { | |
a944a84b | 82 | sr_err("%s: ctx malloc failed", __func__); |
02604ed6 UH |
83 | return SR_ERR_MALLOC; |
84 | } | |
85 | ||
86 | o->internal = ctx; | |
87 | ||
1c5b099a | 88 | /* Get the number of probes, and the unitsize. */ |
5c3c1241 | 89 | for (l = o->sdi->probes; l; l = l->next) { |
02604ed6 | 90 | probe = l->data; |
1c5b099a ML |
91 | if (probe->enabled) |
92 | ctx->num_enabled_probes++; | |
02604ed6 | 93 | } |
1c5b099a | 94 | |
02604ed6 UH |
95 | ctx->unitsize = (ctx->num_enabled_probes + 7) / 8; |
96 | ||
5c3c1241 | 97 | num_probes = g_slist_length(o->sdi->probes); |
02604ed6 | 98 | |
4d15e5c9 | 99 | if (sr_dev_has_option(o->sdi, SR_CONF_SAMPLERATE)) { |
ec4063b8 BV |
100 | o->sdi->driver->config_get(SR_CONF_SAMPLERATE, &gvar, o->sdi); |
101 | ctx->samplerate = g_variant_get_uint64(gvar); | |
102 | g_variant_unref(gvar); | |
5c3c1241 BV |
103 | } else |
104 | ctx->samplerate = 0; | |
02604ed6 UH |
105 | |
106 | ctx->separator = ','; | |
02604ed6 UH |
107 | ctx->header = g_string_sized_new(512); |
108 | ||
109 | t = time(NULL); | |
110 | ||
111 | /* Some metadata */ | |
112 | g_string_append_printf(ctx->header, "; CSV, generated by %s on %s", | |
113 | PACKAGE_STRING, ctime(&t)); | |
114 | g_string_append_printf(ctx->header, "; Samplerate: %"PRIu64"\n", | |
115 | ctx->samplerate); | |
116 | ||
117 | /* Columns / channels */ | |
118 | g_string_append_printf(ctx->header, "; Channels (%d/%d): ", | |
119 | ctx->num_enabled_probes, num_probes); | |
1c5b099a ML |
120 | for (l = o->sdi->probes; l; l = l->next) { |
121 | probe = l->data; | |
122 | if (probe->enabled) | |
123 | g_string_append_printf(ctx->header, "%s, ", probe->name); | |
124 | } | |
02604ed6 UH |
125 | g_string_append_printf(ctx->header, "\n"); |
126 | ||
5c3c1241 | 127 | return SR_OK; |
02604ed6 UH |
128 | } |
129 | ||
054e6709 | 130 | static int event(struct sr_output *o, int event_type, uint8_t **data_out, |
02604ed6 UH |
131 | uint64_t *length_out) |
132 | { | |
133 | struct context *ctx; | |
02604ed6 UH |
134 | |
135 | if (!o) { | |
a944a84b | 136 | sr_err("%s: o was NULL", __func__); |
02604ed6 UH |
137 | return SR_ERR_ARG; |
138 | } | |
139 | ||
140 | if (!(ctx = o->internal)) { | |
a944a84b | 141 | sr_err("%s: o->internal was NULL", __func__); |
02604ed6 UH |
142 | return SR_ERR_ARG; |
143 | } | |
144 | ||
145 | if (!data_out) { | |
a944a84b | 146 | sr_err("%s: data_out was NULL", __func__); |
02604ed6 UH |
147 | return SR_ERR_ARG; |
148 | } | |
149 | ||
150 | switch (event_type) { | |
151 | case SR_DF_TRIGGER: | |
a944a84b | 152 | sr_dbg("%s: SR_DF_TRIGGER event", __func__); |
02604ed6 UH |
153 | /* TODO */ |
154 | *data_out = NULL; | |
155 | *length_out = 0; | |
156 | break; | |
157 | case SR_DF_END: | |
a944a84b | 158 | sr_dbg("%s: SR_DF_END event", __func__); |
02604ed6 UH |
159 | /* TODO */ |
160 | *data_out = NULL; | |
161 | *length_out = 0; | |
162 | g_free(o->internal); | |
163 | o->internal = NULL; | |
164 | break; | |
165 | default: | |
a944a84b | 166 | sr_err("%s: unsupported event type: %d", __func__, event_type); |
02604ed6 UH |
167 | *data_out = NULL; |
168 | *length_out = 0; | |
169 | break; | |
170 | } | |
171 | ||
172 | return SR_OK; | |
173 | } | |
174 | ||
054e6709 UH |
175 | static int data(struct sr_output *o, const uint8_t *data_in, |
176 | uint64_t length_in, uint8_t **data_out, uint64_t *length_out) | |
02604ed6 UH |
177 | { |
178 | struct context *ctx; | |
179 | GString *outstr; | |
180 | uint64_t sample, i; | |
181 | int j; | |
182 | ||
183 | if (!o) { | |
a944a84b | 184 | sr_err("%s: o was NULL", __func__); |
02604ed6 UH |
185 | return SR_ERR_ARG; |
186 | } | |
187 | ||
188 | if (!(ctx = o->internal)) { | |
a944a84b | 189 | sr_err("%s: o->internal was NULL", __func__); |
02604ed6 UH |
190 | return SR_ERR_ARG; |
191 | } | |
192 | ||
193 | if (!data_in) { | |
a944a84b | 194 | sr_err("%s: data_in was NULL", __func__); |
02604ed6 UH |
195 | return SR_ERR_ARG; |
196 | } | |
197 | ||
198 | if (ctx->header) { | |
199 | /* First data packet. */ | |
200 | outstr = ctx->header; | |
201 | ctx->header = NULL; | |
202 | } else { | |
203 | outstr = g_string_sized_new(512); | |
204 | } | |
205 | ||
206 | for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) { | |
207 | memcpy(&sample, data_in + i, ctx->unitsize); | |
208 | for (j = ctx->num_enabled_probes - 1; j >= 0; j--) { | |
209 | g_string_append_printf(outstr, "%d%c", | |
210 | (int)((sample & (1 << j)) >> j), | |
211 | ctx->separator); | |
212 | } | |
213 | g_string_append_printf(outstr, "\n"); | |
214 | } | |
215 | ||
054e6709 | 216 | *data_out = (uint8_t *)outstr->str; |
02604ed6 UH |
217 | *length_out = outstr->len; |
218 | g_string_free(outstr, FALSE); | |
219 | ||
220 | return SR_OK; | |
221 | } | |
222 | ||
7c1d391c | 223 | SR_PRIV struct sr_output_format output_csv = { |
02604ed6 UH |
224 | .id = "csv", |
225 | .description = "Comma-separated values (CSV)", | |
226 | .df_type = SR_DF_LOGIC, | |
227 | .init = init, | |
228 | .data = data, | |
229 | .event = event, | |
230 | }; |