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.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 samples_per_line;
  33         int spl_cnt;
  34         int trigger;
  35         int *channel_index;
  36         char **channel_names;
  37         GString **lines;
  38         GString *header;
  39 };
  40
  41 static int init(struct sr_output *o)
  42 {
  43         struct context *ctx;
  44         struct sr_channel *ch;
  45         GSList *l;
  46         GVariant *gvar;
  47         uint64_t samplerate;
  48         unsigned int i, j;
  49         int spl, num_channels;
  50         char *samplerate_s;
  51
  52         if (!o || !o->sdi)
  53                 return SR_ERR_ARG;
  54         ctx = g_malloc0(sizeof(struct context));
  55         o->internal = ctx;
  56         ctx->trigger = -1;
  57
  58         if (o->param && o->param[0]) {
  59                 if ((spl = strtoul(o->param, NULL, 10)) < 1)
  60                         return SR_ERR_ARG;
  61         } else
  62                 spl = DEFAULT_SAMPLES_PER_LINE;
  63         ctx->samples_per_line = spl;
  64
  65         for (l = o->sdi->channels; l; l = l->next) {
  66                 ch = l->data;
  67                 if (ch->type != SR_CHANNEL_LOGIC)
  68                         continue;
  69                 if (!ch->enabled)
  70                         continue;
  71                 ctx->num_enabled_channels++;
  72         }
  73         ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
  74         ctx->channel_names = g_malloc(sizeof(char *) * ctx->num_enabled_channels);
  75         ctx->lines = g_malloc(sizeof(GString *) * ctx->num_enabled_channels);
  76
  77         j = 0;
  78         for (i = 0, l = o->sdi->channels; l; l = l->next, i++) {
  79                 ch = l->data;
  80                 if (ch->type != SR_CHANNEL_LOGIC)
  81                         continue;
  82                 if (!ch->enabled)
  83                         continue;
  84                 ctx->channel_index[j] = ch->index;
  85                 ctx->channel_names[j] = ch->name;
  86                 ctx->lines[j] = g_string_sized_new(80);
  87                 g_string_printf(ctx->lines[j], "%s:", ch->name);
  88                 j++;
  89         }
  90
  91         ctx->header = g_string_sized_new(512);
  92         g_string_printf(ctx->header, "%s\n", PACKAGE_STRING);
  93         num_channels = g_slist_length(o->sdi->channels);
  94         if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
  95                         &gvar) == SR_OK) {
  96                 samplerate = g_variant_get_uint64(gvar);
  97                 samplerate_s = sr_samplerate_string(samplerate);
  98                 g_string_append_printf(ctx->header, "Acquisition with %d/%d channels at %s\n",
  99                          ctx->num_enabled_channels, num_channels, samplerate_s);
 100                 g_free(samplerate_s);
 101                 g_variant_unref(gvar);
 102         }
 103
 104         return SR_OK;
 105 }
 106
 107 static int receive(struct sr_output *o, const struct sr_dev_inst *sdi,
 108                 const struct sr_datafeed_packet *packet, GString **out)
 109 {
 110         const struct sr_datafeed_logic *logic;
 111         struct context *ctx;
 112         int idx, offset;
 113         uint64_t i, j;
 114         gchar *p, c;
 115
 116         (void)sdi;
 117
 118         *out = NULL;
 119         if (!o || !o->sdi)
 120                 return SR_ERR_ARG;
 121         if (!(ctx = o->internal))
 122                 return SR_ERR_ARG;
 123
 124         switch (packet->type) {
 125         case SR_DF_TRIGGER:
 126                 ctx->trigger = ctx->spl_cnt;
 127                 break;
 128         case SR_DF_LOGIC:
 129                 if (ctx->header) {
 130                         /* The header is still here, this must be the first packet. */
 131                         *out = ctx->header;
 132                         ctx->header = NULL;
 133                 } else
 134                         *out = g_string_sized_new(512);
 135
 136                 logic = packet->payload;
 137                 for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
 138                         ctx->spl_cnt++;
 139                         for (j = 0; j < ctx->num_enabled_channels; j++) {
 140                                 idx = ctx->channel_index[j];
 141                                 p = logic->data + i + idx / 8;
 142                                 c = (*p & (1 << (idx % 8))) ? '1' : '0';
 143                                 g_string_append_c(ctx->lines[j], c);
 144
 145                                 if (ctx->spl_cnt == ctx->samples_per_line) {
 146                                         /* Flush line buffers. */
 147                                         g_string_append_len(*out, ctx->lines[j]->str, ctx->lines[j]->len);
 148                                         g_string_append_c(*out, '\n');
 149                                         if (j == ctx->num_enabled_channels  - 1 && ctx->trigger > -1) {
 150                                                 offset = ctx->trigger + ctx->trigger / 8;
 151                                                 g_string_append_printf(*out, "T:%*s^ %d\n", offset, "", ctx->trigger);
 152                                                 ctx->trigger = -1;
 153                                         }
 154                                         g_string_printf(ctx->lines[j], "%s:", ctx->channel_names[j]);
 155                                 } else if ((ctx->spl_cnt & 7) == 0) {
 156                                         /* Add a space every 8th bit. */
 157                                         g_string_append_c(ctx->lines[j], ' ');
 158                                 }
 159                         }
 160                         if (ctx->spl_cnt == ctx->samples_per_line)
 161                                 /* Line buffers were already flushed. */
 162                                 ctx->spl_cnt = 0;
 163                 }
 164                 break;
 165         case SR_DF_END:
 166                 if (ctx->spl_cnt) {
 167                         /* Line buffers need flushing. */
 168                         *out = g_string_sized_new(512);
 169                         for (i = 0; i < ctx->num_enabled_channels; i++) {
 170                                 g_string_append_len(*out, ctx->lines[i]->str, ctx->lines[i]->len);
 171                                 g_string_append_c(*out, '\n');
 172                         }
 173                 }
 174                 break;
 175         }
 176
 177         return SR_OK;
 178 }
 179
 180 static int cleanup(struct sr_output *o)
 181 {
 182         struct context *ctx;
 183         unsigned int i;
 184
 185         if (!o)
 186                 return SR_ERR_ARG;
 187
 188         if (!(ctx = o->internal))
 189                 return SR_OK;
 190
 191         g_free(ctx->header);
 192         g_free(ctx->channel_index);
 193         g_free(ctx->channel_names);
 194         for (i = 0; i < ctx->num_enabled_channels; i++)
 195                 g_string_free(ctx->lines[i], TRUE);
 196         g_free(ctx->lines);
 197         if (ctx->header)
 198                 g_string_free(ctx->header, TRUE);
 199         g_free(ctx);
 200         o->internal = NULL;
 201
 202         return SR_OK;
 203 }
 204
 205 SR_PRIV struct sr_output_format output_bits = {
 206         .id = "bits",
 207         .description = "Bits",
 208         .init = init,
 209         .receive = receive,
 210         .cleanup = cleanup,
 211 };