output/ols.c

   1 /*
   2  * This file is part of the sigrok 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 /* Message logging helpers with driver-specific prefix string. */
  35 #define DRIVER_LOG_DOMAIN "output/ols: "
  36 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  37 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  38 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  39 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  40 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  41 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  42
  43 struct context {
  44         GString *header;
  45         uint64_t num_samples;
  46         unsigned int unitsize;
  47 };
  48
  49 static int init(struct sr_output *o)
  50 {
  51         struct context *ctx;
  52         struct sr_probe *probe;
  53         GSList *l;
  54         GVariant *gvar;
  55         uint64_t samplerate;
  56         int num_enabled_probes;
  57
  58         if (!(ctx = g_try_malloc(sizeof(struct context)))) {
  59                 sr_err("%s: ctx malloc failed", __func__);
  60                 return SR_ERR_MALLOC;
  61         }
  62         o->internal = ctx;
  63
  64         ctx->num_samples = 0;
  65         num_enabled_probes = 0;
  66         for (l = o->sdi->probes; l; l = l->next) {
  67                 probe = l->data;
  68                 if (probe->enabled)
  69                         num_enabled_probes++;
  70         }
  71         ctx->unitsize = (num_enabled_probes + 7) / 8;
  72
  73         if (o->sdi->driver && sr_dev_has_option(o->sdi, SR_CONF_SAMPLERATE)) {
  74                 o->sdi->driver->config_get(SR_CONF_SAMPLERATE, &gvar, o->sdi);
  75                 samplerate = g_variant_get_uint64(gvar);
  76                 g_variant_unref(gvar);
  77         } else {
  78                 samplerate = 0;
  79         }
  80
  81         ctx->header = g_string_sized_new(512);
  82         g_string_append_printf(ctx->header, ";Rate: %"PRIu64"\n", samplerate);
  83         g_string_append_printf(ctx->header, ";Channels: %d\n", num_enabled_probes);
  84         g_string_append_printf(ctx->header, ";EnabledChannels: -1\n");
  85         g_string_append_printf(ctx->header, ";Compressed: true\n");
  86         g_string_append_printf(ctx->header, ";CursorEnabled: false\n");
  87
  88         return SR_OK;
  89 }
  90
  91 static int event(struct sr_output *o, int event_type, uint8_t **data_out,
  92                  uint64_t *length_out)
  93 {
  94         struct context *ctx;
  95
  96         ctx = o->internal;
  97
  98         if (ctx && event_type == SR_DF_END) {
  99                 g_string_free(ctx->header, TRUE);
 100                 g_free(o->internal);
 101                 o->internal = NULL;
 102         }
 103
 104         *data_out = NULL;
 105         *length_out = 0;
 106
 107         return SR_OK;
 108 }
 109
 110 static int data(struct sr_output *o, const uint8_t *data_in,
 111                 uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
 112 {
 113         GString *out;
 114         struct context *ctx;
 115         uint64_t sample;
 116         unsigned int i;
 117
 118         ctx = o->internal;
 119         if (ctx->header) {
 120                 /* first data packet */
 121                 out = ctx->header;
 122                 ctx->header = NULL;
 123         } else
 124                 out = g_string_sized_new(512);
 125
 126         for (i = 0; i <= length_in - ctx->unitsize; i += ctx->unitsize) {
 127                 sample = 0;
 128                 memcpy(&sample, data_in + i, ctx->unitsize);
 129                 g_string_append_printf(out, "%08x@%"PRIu64"\n",
 130                                 (uint32_t) sample, ctx->num_samples++);
 131         }
 132         *data_out = (uint8_t *)out->str;
 133         *length_out = out->len;
 134         g_string_free(out, FALSE);
 135
 136         return SR_OK;
 137 }
 138
 139 SR_PRIV struct sr_output_format output_ols = {
 140         .id = "ols",
 141         .description = "OpenBench Logic Sniffer",
 142         .df_type = SR_DF_LOGIC,
 143         .init = init,
 144         .data = data,
 145         .event = event,
 146 };