src/output/ols.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2011 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  */
  21
  22 /*
  23  * This implements version 1.3 of the output format for the OpenBench Logic
  24  * Sniffer "Alternative" Java client. Details:
  25  * https://github.com/jawi/ols/wiki/OLS-data-file-format
  26  */
  27
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <glib.h>
  31 #include "libsigrok.h"
  32 #include "libsigrok-internal.h"
  33
  34 #define LOG_PREFIX "output/ols"
  35
  36 struct context {
  37         uint64_t samplerate;
  38         uint64_t num_samples;
  39 };
  40
  41 static int init(struct sr_output *o, GHashTable *options)
  42 {
  43         struct context *ctx;
  44
  45         (void)options;
  46
  47         if (!(ctx = g_try_malloc(sizeof(struct context)))) {
  48                 sr_err("%s: ctx malloc failed", __func__);
  49                 return SR_ERR_MALLOC;
  50         }
  51         o->internal = ctx;
  52
  53         ctx->samplerate = 0;
  54         ctx->num_samples = 0;
  55
  56         return SR_OK;
  57 }
  58
  59 static GString *gen_header(const struct sr_dev_inst *sdi, struct context *ctx)
  60 {
  61         struct sr_channel *ch;
  62         GSList *l;
  63         GString *s;
  64         GVariant *gvar;
  65         int num_enabled_channels;
  66
  67         if (!ctx->samplerate && sr_config_get(sdi->driver, sdi, NULL,
  68                         SR_CONF_SAMPLERATE, &gvar) == SR_OK) {
  69                 ctx->samplerate = g_variant_get_uint64(gvar);
  70                 g_variant_unref(gvar);
  71         }
  72
  73         num_enabled_channels = 0;
  74         for (l = sdi->channels; l; l = l->next) {
  75                 ch = l->data;
  76                 if (ch->type != SR_CHANNEL_LOGIC)
  77                         continue;
  78                 if (!ch->enabled)
  79                         continue;
  80                 num_enabled_channels++;
  81         }
  82
  83         s = g_string_sized_new(512);
  84         g_string_append_printf(s, ";Rate: %"PRIu64"\n", ctx->samplerate);
  85         g_string_append_printf(s, ";Channels: %d\n", num_enabled_channels);
  86         g_string_append_printf(s, ";EnabledChannels: -1\n");
  87         g_string_append_printf(s, ";Compressed: true\n");
  88         g_string_append_printf(s, ";CursorEnabled: false\n");
  89
  90         return s;
  91 }
  92
  93 static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
  94                 GString **out)
  95 {
  96         struct context *ctx;
  97         const struct sr_datafeed_meta *meta;
  98         const struct sr_datafeed_logic *logic;
  99         const struct sr_config *src;
 100         GSList *l;
 101         unsigned int i, j;
 102         uint8_t c;
 103
 104         *out = NULL;
 105         if (!o || !o->sdi)
 106                 return SR_ERR_ARG;
 107         ctx = o->internal;
 108
 109         switch (packet->type) {
 110         case SR_DF_META:
 111                 meta = packet->payload;
 112                 for (l = meta->config; l; l = l->next) {
 113                         src = l->data;
 114                         if (src->key == SR_CONF_SAMPLERATE)
 115                                 ctx->samplerate = g_variant_get_uint64(src->data);
 116                 }
 117                 break;
 118         case SR_DF_LOGIC:
 119                 logic = packet->payload;
 120                 if (ctx->num_samples == 0) {
 121                         /* First logic packet in the feed. */
 122                         *out = gen_header(o->sdi, ctx);
 123                 } else
 124                         *out = g_string_sized_new(512);
 125                 for (i = 0; i <= logic->length - logic->unitsize; i += logic->unitsize) {
 126                         for (j = 0; j < logic->unitsize; j++) {
 127                                 /* The OLS format wants the samples presented MSB first. */
 128                                 c = *((uint8_t *)logic->data + i + logic->unitsize - 1 - j);
 129                                 g_string_append_printf(*out, "%02x", c);
 130                         }
 131                         g_string_append_printf(*out, "@%"PRIu64"\n", ctx->num_samples++);
 132                 }
 133                 break;
 134         }
 135
 136         return SR_OK;
 137 }
 138
 139 static int cleanup(struct sr_output *o)
 140 {
 141         struct context *ctx;
 142
 143         if (!o || !o->sdi)
 144                 return SR_ERR_ARG;
 145
 146         ctx = o->internal;
 147         g_free(ctx);
 148         o->internal = NULL;
 149
 150         return SR_OK;
 151 }
 152
 153 SR_PRIV struct sr_output_module output_ols = {
 154         .id = "ols",
 155         .name = "OLS",
 156         .desc = "OpenBench Logic Sniffer",
 157         .options = NULL,
 158         .init = init,
 159         .receive = receive,
 160         .cleanup = cleanup
 161 };