src/output/chronovu_la8.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) 2014 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, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <glib.h>
  24 #include <libsigrok/libsigrok.h>
  25 #include "libsigrok-internal.h"
  26
  27 #define LOG_PREFIX "output/chronovu-la8"
  28
  29 struct context {
  30         unsigned int num_enabled_channels;
  31         gboolean triggered;
  32         uint64_t samplerate;
  33         uint64_t samplecount;
  34         int *channel_index;
  35         GString *pretrig_buf;
  36 };
  37
  38 /**
  39  * Check if the given samplerate is supported by the LA8 hardware.
  40  *
  41  * @param samplerate The samplerate (in Hz) to check.
  42  *
  43  * @return 1 if the samplerate is supported/valid, 0 otherwise.
  44  */
  45 static gboolean is_valid_samplerate(uint64_t samplerate)
  46 {
  47         unsigned int i;
  48
  49         for (i = 0; i < 255; i++) {
  50                 if (samplerate == (SR_MHZ(100) / (i + 1)))
  51                         return TRUE;
  52         }
  53
  54         return FALSE;
  55 }
  56
  57 /**
  58  * Convert a samplerate (in Hz) to the 'divcount' value the LA8 wants.
  59  *
  60  * LA8 hardware: sample period = (divcount + 1) * 10ns.
  61  * Min. value for divcount: 0x00 (10ns sample period, 100MHz samplerate).
  62  * Max. value for divcount: 0xfe (2550ns sample period, 392.15kHz samplerate).
  63  *
  64  * @param samplerate The samplerate in Hz.
  65  *
  66  * @return The divcount value as needed by the hardware, or 0xff upon errors.
  67  */
  68 static uint8_t samplerate_to_divcount(uint64_t samplerate)
  69 {
  70         if (samplerate == 0 || !is_valid_samplerate(samplerate)) {
  71                 sr_warn("Invalid samplerate (%" PRIu64 "Hz)", samplerate);
  72                 return 0xff;
  73         }
  74
  75         return (SR_MHZ(100) / samplerate) - 1;
  76 }
  77
  78 static int init(struct sr_output *o, GHashTable *options)
  79 {
  80         struct context *ctx;
  81         struct sr_channel *ch;
  82         GSList *l;
  83
  84         (void)options;
  85
  86         if (!o || !o->sdi)
  87                 return SR_ERR_ARG;
  88
  89         ctx = g_malloc0(sizeof(struct context));
  90         o->priv = ctx;
  91
  92         for (l = o->sdi->channels; l; l = l->next) {
  93                 ch = l->data;
  94                 if (ch->type != SR_CHANNEL_LOGIC)
  95                         continue;
  96                 if (!ch->enabled)
  97                         continue;
  98                 ctx->num_enabled_channels++;
  99         }
 100         ctx->channel_index = g_malloc(sizeof(int) * ctx->num_enabled_channels);
 101         ctx->pretrig_buf = g_string_sized_new(1024);
 102
 103         return SR_OK;
 104 }
 105
 106 static int receive(const struct sr_output *o, const struct sr_datafeed_packet *packet,
 107                 GString **out)
 108 {
 109         const struct sr_datafeed_logic *logic;
 110         struct context *ctx;
 111         GVariant *gvar;
 112         uint64_t samplerate;
 113         gchar c[4];
 114
 115         *out = NULL;
 116         if (!o || !o->sdi)
 117                 return SR_ERR_ARG;
 118         if (!(ctx = o->priv))
 119                 return SR_ERR_ARG;
 120
 121         switch (packet->type) {
 122         case SR_DF_HEADER:
 123                 /* One byte for the 'divcount' value. */
 124                 if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
 125                                 &gvar) == SR_OK) {
 126                         samplerate = g_variant_get_uint64(gvar);
 127                         g_variant_unref(gvar);
 128                 } else
 129                         samplerate = 0;
 130                 c[0] = samplerate_to_divcount(samplerate);
 131                 *out = g_string_new_len(c, 1);
 132                 ctx->triggered = FALSE;
 133                 break;
 134         case SR_DF_TRIGGER:
 135                 /* Four bytes (little endian) for the trigger point. */
 136                 c[0] = ctx->samplecount & 0xff;
 137                 c[1] = (ctx->samplecount >> 8) & 0xff;
 138                 c[2] = (ctx->samplecount >> 16) & 0xff;
 139                 c[3] = (ctx->samplecount >> 24) & 0xff;
 140                 *out = g_string_new_len(c, 4);
 141                 /* Flush the pre-trigger buffer. */
 142                 if (ctx->pretrig_buf->len)
 143                         g_string_append_len(*out, ctx->pretrig_buf->str,
 144                                         ctx->pretrig_buf->len);
 145                 ctx->triggered = TRUE;
 146                 break;
 147         case SR_DF_LOGIC:
 148                 logic = packet->payload;
 149                 if (!ctx->triggered)
 150                         g_string_append_len(ctx->pretrig_buf, logic->data, logic->length);
 151                 else
 152                         *out = g_string_new_len(logic->data, logic->length);
 153                 ctx->samplecount += logic->length / logic->unitsize;
 154                 break;
 155         case SR_DF_END:
 156                 if (!ctx->triggered && ctx->pretrig_buf->len) {
 157                         /* We never got a trigger, submit an empty one. */
 158                         *out = g_string_sized_new(ctx->pretrig_buf->len + 4);
 159                         g_string_append_len(*out, "\x00\x00\x00\x00", 4);
 160                         g_string_append_len(*out, ctx->pretrig_buf->str, ctx->pretrig_buf->len);
 161                 }
 162                 break;
 163         }
 164
 165         return SR_OK;
 166 }
 167
 168 static int cleanup(struct sr_output *o)
 169 {
 170         struct context *ctx;
 171
 172         if (!o || !o->sdi)
 173                 return SR_ERR_ARG;
 174
 175         if (o->priv) {
 176                 ctx = o->priv;
 177                 g_string_free(ctx->pretrig_buf, TRUE);
 178                 g_free(ctx->channel_index);
 179                 g_free(o->priv);
 180                 o->priv = NULL;
 181         }
 182
 183         return SR_OK;
 184 }
 185
 186 SR_PRIV struct sr_output_module output_chronovu_la8 = {
 187         .id = "chronovu-la8",
 188         .name = "ChronoVu LA8",
 189         .desc = "ChronoVu LA8 native file format",
 190         .exts = (const char*[]){"kdt", NULL},
 191         .flags = 0,
 192         .options = NULL,
 193         .init = init,
 194         .receive = receive,
 195         .cleanup = cleanup,
 196 };