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 <sigrok-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->device was NULL", __func__);
69 if (!o->device->plugin) {
70 sr_err("csv out: %s: o->device->plugin 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 /* TODO: Error handling. */
83 for (l = o->device->probes; l; l = l->next) {
87 ctx->probelist[ctx->num_enabled_probes++] = probe->name;
89 ctx->probelist[ctx->num_enabled_probes] = 0;
90 ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
92 num_probes = g_slist_length(o->device->probes);
94 if (sr_device_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) {
95 samplerate = *((uint64_t *) o->device->plugin->get_device_info(
96 o->device->plugin_index, SR_DI_CUR_SAMPLERATE));
97 /* TODO: Error checks. */
99 samplerate = 0; /* TODO: Error or set some value? */
101 ctx->samplerate = samplerate;
103 ctx->separator = ',';
105 ctx->header = g_string_sized_new(512);
110 g_string_append_printf(ctx->header, "; CSV, generated by %s on %s",
111 PACKAGE_STRING, ctime(&t));
112 g_string_append_printf(ctx->header, "; Samplerate: %"PRIu64"\n",
115 /* Columns / channels */
116 g_string_append_printf(ctx->header, "; Channels (%d/%d): ",
117 ctx->num_enabled_probes, num_probes);
118 for (i = 0; i < ctx->num_enabled_probes; i++)
119 g_string_append_printf(ctx->header, "%s, ", ctx->probelist[i]);
120 g_string_append_printf(ctx->header, "\n");
122 return 0; /* TODO: SR_OK? */
125 static int event(struct sr_output *o, int event_type, char **data_out,
126 uint64_t *length_out)
132 sr_err("csv out: %s: o was NULL", __func__);
136 if (!(ctx = o->internal)) {
137 sr_err("csv out: %s: o->internal was NULL", __func__);
142 sr_err("csv out: %s: data_out was NULL", __func__);
146 switch (event_type) {
148 sr_dbg("csv out: %s: SR_DF_TRIGGER event", __func__);
154 sr_dbg("csv out: %s: SR_DF_END event", __func__);
162 sr_err("csv out: %s: unsupported event type: %d", __func__,
172 static int data(struct sr_output *o, const char *data_in, uint64_t length_in,
173 char **data_out, uint64_t *length_out)
181 sr_err("csv out: %s: o was NULL", __func__);
185 if (!(ctx = o->internal)) {
186 sr_err("csv out: %s: o->internal was NULL", __func__);
191 sr_err("csv out: %s: data_in was NULL", __func__);
196 /* First data packet. */
197 outstr = ctx->header;
200 outstr = g_string_sized_new(512);
203 for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
204 memcpy(&sample, data_in + i, ctx->unitsize);
205 for (j = ctx->num_enabled_probes - 1; j >= 0; j--) {
206 g_string_append_printf(outstr, "%d%c",
207 (int)((sample & (1 << j)) >> j),
210 g_string_append_printf(outstr, "\n");
213 *data_out = outstr->str;
214 *length_out = outstr->len;
215 g_string_free(outstr, FALSE);
220 struct sr_output_format output_csv = {
222 .description = "Comma-separated values (CSV)",
223 .df_type = SR_DF_LOGIC,