2 * This file is part of the libsigrok project.
4 * Copyright (C) 2011 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
24 #include "config.h" /* Needed for PACKAGE_STRING and others. */
25 #include "libsigrok.h"
26 #include "libsigrok-internal.h"
28 /* Message logging helpers with subsystem-specific prefix string. */
29 #define LOG_PREFIX "output/csv: "
30 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
31 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
32 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
33 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
34 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
35 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
38 unsigned int num_enabled_probes;
39 unsigned int unitsize;
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.
57 static int init(struct sr_output *o)
60 struct sr_probe *probe;
67 sr_err("%s: o was NULL", __func__);
72 sr_err("%s: o->sdi was NULL", __func__);
76 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
77 sr_err("%s: ctx malloc failed", __func__);
83 /* Get the number of probes, and the unitsize. */
84 for (l = o->sdi->probes; l; l = l->next) {
87 ctx->num_enabled_probes++;
90 ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
92 num_probes = g_slist_length(o->sdi->probes);
94 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
96 ctx->samplerate = g_variant_get_uint64(gvar);
97 g_variant_unref(gvar);
101 ctx->separator = ',';
102 ctx->header = g_string_sized_new(512);
107 g_string_append_printf(ctx->header, "; CSV, generated by %s on %s",
108 PACKAGE_STRING, ctime(&t));
109 g_string_append_printf(ctx->header, "; Samplerate: %"PRIu64"\n",
112 /* Columns / channels */
113 g_string_append_printf(ctx->header, "; Channels (%d/%d): ",
114 ctx->num_enabled_probes, num_probes);
115 for (l = o->sdi->probes; l; l = l->next) {
118 g_string_append_printf(ctx->header, "%s, ", probe->name);
120 g_string_append_printf(ctx->header, "\n");
125 static int event(struct sr_output *o, int event_type, uint8_t **data_out,
126 uint64_t *length_out)
131 sr_err("%s: o was NULL", __func__);
135 if (!(ctx = o->internal)) {
136 sr_err("%s: o->internal was NULL", __func__);
141 sr_err("%s: data_out was NULL", __func__);
145 switch (event_type) {
147 sr_dbg("%s: SR_DF_TRIGGER event", __func__);
153 sr_dbg("%s: SR_DF_END event", __func__);
161 sr_err("%s: unsupported event type: %d", __func__, event_type);
170 static int data(struct sr_output *o, const uint8_t *data_in,
171 uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
175 uint64_t sample, i, j;
178 sr_err("%s: o was NULL", __func__);
182 if (!(ctx = o->internal)) {
183 sr_err("%s: o->internal was NULL", __func__);
188 sr_err("%s: data_in was NULL", __func__);
193 /* First data packet. */
194 outstr = ctx->header;
197 outstr = g_string_sized_new(512);
200 for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
201 memcpy(&sample, data_in + i, ctx->unitsize);
202 for (j = 0; j < ctx->num_enabled_probes; j++) {
203 g_string_append_printf(outstr, "%d%c",
204 (int)((sample & (1 << j)) >> j),
207 g_string_append_printf(outstr, "\n");
210 *data_out = (uint8_t *)outstr->str;
211 *length_out = outstr->len;
212 g_string_free(outstr, FALSE);
217 SR_PRIV struct sr_output_format output_csv = {
219 .description = "Comma-separated values (CSV)",
220 .df_type = SR_DF_LOGIC,