2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
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 3 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, see <http://www.gnu.org/licenses/>.
24 #include <libsigrok/libsigrok.h>
25 #include "libsigrok-internal.h"
27 #define LOG_PREFIX "output/hex"
29 #define DEFAULT_SAMPLES_PER_LINE 192
32 unsigned int num_enabled_channels;
46 static int init(struct sr_output *o, GHashTable *options)
49 struct sr_channel *ch;
56 ctx = g_malloc0(sizeof(struct context));
59 ctx->spl = g_variant_get_uint32(g_hash_table_lookup(options, "width"));
61 for (l = o->sdi->channels; l; l = l->next) {
63 if (ch->type != SR_CHANNEL_LOGIC)
67 ctx->num_enabled_channels++;
69 ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
70 ctx->channel_names = g_malloc(sizeof(char *) * ctx->num_enabled_channels);
71 ctx->lines = g_malloc(sizeof(GString *) * ctx->num_enabled_channels);
72 ctx->sample_buf = g_malloc(ctx->num_enabled_channels);
75 for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
77 if (ch->type != SR_CHANNEL_LOGIC)
81 ctx->channel_index[j] = ch->index;
82 ctx->channel_names[j] = ch->name;
83 ctx->lines[j] = g_string_sized_new(80);
84 ctx->sample_buf[j] = 0;
85 g_string_printf(ctx->lines[j], "%s:", ch->name);
92 static GString *gen_header(const struct sr_output *o)
101 if (ctx->samplerate == 0) {
102 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
104 ctx->samplerate = g_variant_get_uint64(gvar);
105 g_variant_unref(gvar);
109 header = g_string_sized_new(512);
110 g_string_printf(header, "%s %s\n", PACKAGE_NAME, SR_PACKAGE_VERSION_STRING);
111 num_channels = g_slist_length(o->sdi->channels);
112 g_string_append_printf(header, "Acquisition with %d/%d channels",
113 ctx->num_enabled_channels, num_channels);
114 if (ctx->samplerate != 0) {
115 samplerate_s = sr_samplerate_string(ctx->samplerate);
116 g_string_append_printf(header, " at %s", samplerate_s);
117 g_free(samplerate_s);
119 g_string_append_printf(header, "\n");
124 static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
127 const struct sr_datafeed_meta *meta;
128 const struct sr_datafeed_logic *logic;
129 const struct sr_config *src;
132 int idx, pos, offset;
139 if (!(ctx = o->priv))
142 switch (packet->type) {
144 meta = packet->payload;
145 for (l = meta->config; l; l = l->next) {
147 if (src->key != SR_CONF_SAMPLERATE)
149 ctx->samplerate = g_variant_get_uint64(src->data);
153 ctx->trigger = ctx->spl_cnt;
156 if (!ctx->header_done) {
157 *out = gen_header(o);
158 ctx->header_done = TRUE;
160 *out = g_string_sized_new(512);
162 logic = packet->payload;
163 for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
165 pos = ctx->spl_cnt & 7;
166 for (j = 0; j < ctx->num_enabled_channels; j++) {
167 idx = ctx->channel_index[j];
168 p = logic->data + i + idx / 8;
169 ctx->sample_buf[j] <<= 1;
170 if (*p & (1 << (idx % 8)))
171 ctx->sample_buf[j] |= 1;
172 if (ctx->spl_cnt && pos == 0) {
173 /* Buffered a byte's worth, output hex. */
174 g_string_append_printf(ctx->lines[j], "%.2x ",
176 ctx->sample_buf[j] = 0;
179 if (ctx->spl_cnt == ctx->spl) {
180 /* Flush line buffers. */
181 g_string_append_len(*out, ctx->lines[j]->str, ctx->lines[j]->len);
182 g_string_append_c(*out, '\n');
183 if (j == ctx->num_enabled_channels - 1 && ctx->trigger > -1) {
185 * Sample data lines have one character per nibble,
186 * plus one separator per byte. Align trigger marker
189 offset = ctx->trigger / 4 + ctx->trigger / 8;
190 g_string_append_printf(*out, "T:%*s^ %d\n", offset, "", ctx->trigger);
193 g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]);
196 if (ctx->spl_cnt == ctx->spl)
197 /* Line buffers were already flushed. */
203 /* Line buffers need flushing. */
204 *out = g_string_sized_new(512);
205 for (i = 0; i < ctx->num_enabled_channels; i++) {
206 if (ctx->spl_cnt & 7)
207 g_string_append_printf(ctx->lines[i], "%.2x ",
208 ctx->sample_buf[i] << (8 - (ctx->spl_cnt & 7)));
209 g_string_append_len(*out, ctx->lines[i]->str, ctx->lines[i]->len);
210 g_string_append_c(*out, '\n');
219 static int cleanup(struct sr_output *o)
227 if (!(ctx = o->priv))
230 g_free(ctx->channel_index);
231 g_free(ctx->sample_buf);
232 g_free(ctx->channel_names);
233 for (i = 0; i < ctx->num_enabled_channels; i++)
234 g_string_free(ctx->lines[i], TRUE);
242 static struct sr_option options[] = {
243 { "width", "Width", "Number of samples per line", NULL, NULL },
247 static const struct sr_option *get_options(void)
249 if (!options[0].def) {
250 options[0].def = g_variant_new_uint32(DEFAULT_SAMPLES_PER_LINE);
251 g_variant_ref_sink(options[0].def);
257 SR_PRIV struct sr_output_module output_hex = {
259 .name = "Hexadecimal",
260 .desc = "Hexadecimal digits logic data",
261 .exts = (const char*[]){"txt", NULL},
263 .options = get_options,