2 * This file is part of the sigrok 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
25 #include "libsigrok.h"
26 #include "libsigrok-internal.h"
29 unsigned int num_enabled_probes;
30 unsigned int unitsize;
31 char *probelist[SR_MAX_NUM_PROBES + 1];
39 * - Option to specify delimiter character and/or string.
40 * - Option to (not) print metadata as comments.
41 * - Option to specify the comment character(s), e.g. # or ; or C/C++-style.
42 * - Option to (not) print samplenumber / time as extra column.
43 * - Option to "compress" output (only print changed samples, VCD-like).
44 * - Option to print comma-separated bits, or whole bytes/words (for 8/16
45 * probe LAs) as ASCII/hex etc. etc.
49 static int init(struct sr_output *o)
52 struct sr_probe *probe;
60 sr_err("csv out: %s: o was NULL", __func__);
65 sr_err("csv out: %s: o->sdi was NULL", __func__);
69 if (!o->sdi->driver) {
70 sr_err("csv out: %s: o->sdi->driver was NULL", __func__);
74 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
75 sr_err("csv out: %s: ctx malloc failed", __func__);
81 /* Get the number of probes, their names, and the unitsize. */
82 for (l = o->sdi->probes; l; l = l->next) {
86 ctx->probelist[ctx->num_enabled_probes++] = probe->name;
88 ctx->probelist[ctx->num_enabled_probes] = 0;
89 ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
91 num_probes = g_slist_length(o->sdi->probes);
93 if (sr_dev_has_hwcap(o->sdi, SR_HWCAP_SAMPLERATE)) {
94 o->sdi->driver->info_get(SR_DI_CUR_SAMPLERATE,
95 (const void **)&samplerate, o->sdi);
96 ctx->samplerate = *samplerate;
100 ctx->separator = ',';
101 ctx->header = g_string_sized_new(512);
106 g_string_append_printf(ctx->header, "; CSV, generated by %s on %s",
107 PACKAGE_STRING, ctime(&t));
108 g_string_append_printf(ctx->header, "; Samplerate: %"PRIu64"\n",
111 /* Columns / channels */
112 g_string_append_printf(ctx->header, "; Channels (%d/%d): ",
113 ctx->num_enabled_probes, num_probes);
114 for (i = 0; i < ctx->num_enabled_probes; i++)
115 g_string_append_printf(ctx->header, "%s, ", ctx->probelist[i]);
116 g_string_append_printf(ctx->header, "\n");
121 static int event(struct sr_output *o, int event_type, uint8_t **data_out,
122 uint64_t *length_out)
127 sr_err("csv out: %s: o was NULL", __func__);
131 if (!(ctx = o->internal)) {
132 sr_err("csv out: %s: o->internal was NULL", __func__);
137 sr_err("csv out: %s: data_out was NULL", __func__);
141 switch (event_type) {
143 sr_dbg("csv out: %s: SR_DF_TRIGGER event", __func__);
149 sr_dbg("csv out: %s: SR_DF_END event", __func__);
157 sr_err("csv out: %s: unsupported event type: %d", __func__,
167 static int data(struct sr_output *o, const uint8_t *data_in,
168 uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
176 sr_err("csv out: %s: o was NULL", __func__);
180 if (!(ctx = o->internal)) {
181 sr_err("csv out: %s: o->internal was NULL", __func__);
186 sr_err("csv out: %s: data_in was NULL", __func__);
191 /* First data packet. */
192 outstr = ctx->header;
195 outstr = g_string_sized_new(512);
198 for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
199 memcpy(&sample, data_in + i, ctx->unitsize);
200 for (j = ctx->num_enabled_probes - 1; j >= 0; j--) {
201 g_string_append_printf(outstr, "%d%c",
202 (int)((sample & (1 << j)) >> j),
205 g_string_append_printf(outstr, "\n");
208 *data_out = (uint8_t *)outstr->str;
209 *length_out = outstr->len;
210 g_string_free(outstr, FALSE);
215 SR_PRIV struct sr_output_format output_csv = {
217 .description = "Comma-separated values (CSV)",
218 .df_type = SR_DF_LOGIC,