src/output/bits.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 Bert Vermeulen <bert@biot.com>
   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 3 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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include <glib.h>
  23 #include <libsigrok/libsigrok.h>
  24 #include "libsigrok-internal.h"
  25
  26 #define LOG_PREFIX "output/bits"
  27
  28 #define DEFAULT_SAMPLES_PER_LINE 64
  29
  30 struct context {
  31         unsigned int num_enabled_channels;
  32         int spl;
  33         int spl_cnt;
  34         int trigger;
  35         uint64_t samplerate;
  36         int *channel_index;
  37         char **channel_names;
  38         gboolean header_done;
  39         GString **lines;
  40 };
  41
  42 static int init(struct sr_output *o, GHashTable *options)
  43 {
  44         struct context *ctx;
  45         struct sr_channel *ch;
  46         GSList *l;
  47         unsigned int i, j;
  48
  49         if (!o || !o->sdi)
  50                 return SR_ERR_ARG;
  51
  52         ctx = g_malloc0(sizeof(struct context));
  53         o->priv = ctx;
  54         ctx->trigger = -1;
  55         ctx->spl = g_variant_get_uint32(g_hash_table_lookup(options, "width"));
  56
  57         for (l = o->sdi->channels; l; l = l->next) {
  58                 ch = l->data;
  59                 if (ch->type != SR_CHANNEL_LOGIC)
  60                         continue;
  61                 if (!ch->enabled)
  62                         continue;
  63                 ctx->num_enabled_channels++;
  64         }
  65         ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
  66         ctx->channel_names = g_malloc(sizeof(char *) * ctx->num_enabled_channels);
  67         ctx->lines = g_malloc(sizeof(GString *) * ctx->num_enabled_channels);
  68
  69         j = 0;
  70         for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
  71                 ch = l->data;
  72                 if (ch->type != SR_CHANNEL_LOGIC)
  73                         continue;
  74                 if (!ch->enabled)
  75                         continue;
  76                 ctx->channel_index[j] = ch->index;
  77                 ctx->channel_names[j] = ch->name;
  78                 ctx->lines[j] = g_string_sized_new(80);
  79                 g_string_printf(ctx->lines[j], "%s:", ch->name);
  80                 j++;
  81         }
  82
  83         return SR_OK;
  84 }
  85
  86 static GString *gen_header(const struct sr_output *o)
  87 {
  88         struct context *ctx;
  89         GVariant *gvar;
  90         GString *header;
  91         int num_channels;
  92         char *samplerate_s;
  93
  94         ctx = o->priv;
  95         if (ctx->samplerate == 0) {
  96                 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
  97                                 &gvar) == SR_OK) {
  98                         ctx->samplerate = g_variant_get_uint64(gvar);
  99                         g_variant_unref(gvar);
 100                 }
 101         }
 102
 103         header = g_string_sized_new(512);
 104         g_string_printf(header, "%s %s\n", PACKAGE_NAME, SR_PACKAGE_VERSION_STRING);
 105         num_channels = g_slist_length(o->sdi->channels);
 106         g_string_append_printf(header, "Acquisition with %d/%d channels",
 107                         ctx->num_enabled_channels, num_channels);
 108         if (ctx->samplerate != 0) {
 109                 samplerate_s = sr_samplerate_string(ctx->samplerate);
 110                 g_string_append_printf(header, " at %s", samplerate_s);
 111                 g_free(samplerate_s);
 112         }
 113         g_string_append_printf(header, "\n");
 114
 115         return header;
 116 }
 117
 118 static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
 119                 GString **out)
 120 {
 121         const struct sr_datafeed_meta *meta;
 122         const struct sr_datafeed_logic *logic;
 123         const struct sr_config *src;
 124         struct context *ctx;
 125         GSList *l;
 126         int idx, offset;
 127         uint64_t i, j;
 128         gchar *p, c;
 129
 130         *out = NULL;
 131         if (!o || !o->sdi)
 132                 return SR_ERR_ARG;
 133         if (!(ctx = o->priv))
 134                 return SR_ERR_ARG;
 135
 136         switch (packet->type) {
 137         case SR_DF_META:
 138                 meta = packet->payload;
 139                 for (l = meta->config; l; l = l->next) {
 140                         src = l->data;
 141                         if (src->key != SR_CONF_SAMPLERATE)
 142                                 continue;
 143                         ctx->samplerate = g_variant_get_uint64(src->data);
 144                 }
 145                 break;
 146         case SR_DF_TRIGGER:
 147                 ctx->trigger = ctx->spl_cnt;
 148                 break;
 149         case SR_DF_LOGIC:
 150                 if (!ctx->header_done) {
 151                         *out = gen_header(o);
 152                         ctx->header_done = TRUE;
 153                 } else
 154                         *out = g_string_sized_new(512);
 155
 156                 logic = packet->payload;
 157                 for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
 158                         ctx->spl_cnt++;
 159                         for (j = 0; j < ctx->num_enabled_channels; j++) {
 160                                 idx = ctx->channel_index[j];
 161                                 p = logic->data + i + idx / 8;
 162                                 c = (*p & (1 << (idx % 8))) ? '1' : '0';
 163                                 g_string_append_c(ctx->lines[j], c);
 164
 165                                 if (ctx->spl_cnt == ctx->spl) {
 166                                         /* Flush line buffers. */
 167                                         g_string_append_len(*out, ctx->lines[j]->str, ctx->lines[j]->len);
 168                                         g_string_append_c(*out, '\n');
 169                                         if (j == ctx->num_enabled_channels  - 1 && ctx->trigger > -1) {
 170                                                 offset = ctx->trigger + ctx->trigger / 8;
 171                                                 g_string_append_printf(*out, "T:%*s^ %d\n", offset, "", ctx->trigger);
 172                                                 ctx->trigger = -1;
 173                                         }
 174                                         g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]);
 175                                 } else if ((ctx->spl_cnt & 7) == 0) {
 176                                         /* Add a space every 8th bit. */
 177                                         g_string_append_c(ctx->lines[j], ' ');
 178                                 }
 179                         }
 180                         if (ctx->spl_cnt == ctx->spl)
 181                                 /* Line buffers were already flushed. */
 182                                 ctx->spl_cnt = 0;
 183                 }
 184                 break;
 185         case SR_DF_END:
 186                 if (ctx->spl_cnt) {
 187                         /* Line buffers need flushing. */
 188                         *out = g_string_sized_new(512);
 189                         for (i = 0; i < ctx->num_enabled_channels; i++) {
 190                                 g_string_append_len(*out, ctx->lines[i]->str, ctx->lines[i]->len);
 191                                 g_string_append_c(*out, '\n');
 192                         }
 193                 }
 194                 break;
 195         }
 196
 197         return SR_OK;
 198 }
 199
 200 static int cleanup(struct sr_output *o)
 201 {
 202         struct context *ctx;
 203         unsigned int i;
 204
 205         if (!o)
 206                 return SR_ERR_ARG;
 207
 208         if (!(ctx = o->priv))
 209                 return SR_OK;
 210
 211         g_free(ctx->channel_index);
 212         g_free(ctx->channel_names);
 213         for (i = 0; i < ctx->num_enabled_channels; i++)
 214                 g_string_free(ctx->lines[i], TRUE);
 215         g_free(ctx->lines);
 216         g_free(ctx);
 217         o->priv = NULL;
 218
 219         return SR_OK;
 220 }
 221
 222 static struct sr_option options[] = {
 223         { "width", "Width", "Number of samples per line", NULL, NULL },
 224         ALL_ZERO
 225 };
 226
 227 static const struct sr_option *get_options(void)
 228 {
 229         if (!options[0].def) {
 230                 options[0].def = g_variant_new_uint32(DEFAULT_SAMPLES_PER_LINE);
 231                 g_variant_ref_sink(options[0].def);
 232         }
 233
 234         return options;
 235 }
 236
 237 SR_PRIV struct sr_output_module output_bits = {
 238         .id = "bits",
 239         .name = "Bits",
 240         .desc = "0/1 digits",
 241         .exts = (const char*[]){"txt", NULL},
 242         .flags = 0,
 243         .options = get_options,
 244         .init = init,
 245         .receive = receive,
 246         .cleanup = cleanup,
 247 };