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  *
   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 2 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, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <glib.h>
  24 #include "libsigrok.h"
  25 #include "libsigrok-internal.h"
  26
  27 #define LOG_PREFIX "output/chronovu-la8"
  28
  29 struct context {
  30         unsigned int num_enabled_probes;
  31         unsigned int unitsize;
  32         uint64_t trigger_point;
  33         uint64_t samplerate;
  34 };
  35
  36 /**
  37  * Check if the given samplerate is supported by the LA8 hardware.
  38  *
  39  * @param samplerate The samplerate (in Hz) to check.
  40  *
  41  * @return 1 if the samplerate is supported/valid, 0 otherwise.
  42  */
  43 static int is_valid_samplerate(uint64_t samplerate)
  44 {
  45         unsigned int i;
  46
  47         for (i = 0; i < 255; i++) {
  48                 if (samplerate == (SR_MHZ(100) / (i + 1)))
  49                         return 1;
  50         }
  51
  52         sr_warn("%s: invalid samplerate (%" PRIu64 "Hz)",
  53                 __func__, samplerate);
  54
  55         return 0;
  56 }
  57
  58 /**
  59  * Convert a samplerate (in Hz) to the 'divcount' value the LA8 wants.
  60  *
  61  * LA8 hardware: sample period = (divcount + 1) * 10ns.
  62  * Min. value for divcount: 0x00 (10ns sample period, 100MHz samplerate).
  63  * Max. value for divcount: 0xfe (2550ns sample period, 392.15kHz samplerate).
  64  *
  65  * @param samplerate The samplerate in Hz.
  66  *
  67  * @return The divcount value as needed by the hardware, or 0xff upon errors.
  68  */
  69 static uint8_t samplerate_to_divcount(uint64_t samplerate)
  70 {
  71         if (samplerate == 0) {
  72                 sr_warn("%s: samplerate was 0", __func__);
  73                 return 0xff;
  74         }
  75
  76         if (!is_valid_samplerate(samplerate)) {
  77                 sr_warn("%s: can't get divcount, samplerate invalid", __func__);
  78                 return 0xff;
  79         }
  80
  81         return (SR_MHZ(100) / samplerate) - 1;
  82 }
  83
  84 static int init(struct sr_output *o)
  85 {
  86         struct context *ctx;
  87         struct sr_probe *probe;
  88         GSList *l;
  89         GVariant *gvar;
  90
  91         if (!o) {
  92                 sr_warn("%s: o was NULL", __func__);
  93                 return SR_ERR_ARG;
  94         }
  95
  96         if (!o->sdi) {
  97                 sr_warn("%s: o->sdi was NULL", __func__);
  98                 return SR_ERR_ARG;
  99         }
 100
 101         if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
 102                 sr_warn("%s: ctx malloc failed", __func__);
 103                 return SR_ERR_MALLOC;
 104         }
 105
 106         o->internal = ctx;
 107
 108         /* Get the unitsize. */
 109         for (l = o->sdi->probes; l; l = l->next) {
 110                 probe = l->data;
 111                 if (!probe->enabled)
 112                         continue;
 113                 ctx->num_enabled_probes++;
 114         }
 115         ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
 116
 117         if (sr_config_get(o->sdi->driver, o->sdi, NULL, SR_CONF_SAMPLERATE,
 118                         &gvar) == SR_OK) {
 119                 ctx->samplerate = g_variant_get_uint64(gvar);
 120                 g_variant_unref(gvar);
 121         } else
 122                 ctx->samplerate = 0;
 123
 124         return SR_OK;
 125 }
 126
 127 static int event(struct sr_output *o, int event_type, uint8_t **data_out,
 128                  uint64_t *length_out)
 129 {
 130         struct context *ctx;
 131         uint8_t *outbuf;
 132
 133         if (!o) {
 134                 sr_warn("%s: o was NULL", __func__);
 135                 return SR_ERR_ARG;
 136         }
 137
 138         if (!(ctx = o->internal)) {
 139                 sr_warn("%s: o->internal was NULL", __func__);
 140                 return SR_ERR_ARG;
 141         }
 142
 143         if (!data_out) {
 144                 sr_warn("%s: data_out was NULL", __func__);
 145                 return SR_ERR_ARG;
 146         }
 147
 148         switch (event_type) {
 149         case SR_DF_TRIGGER:
 150                 sr_dbg("%s: SR_DF_TRIGGER event", __func__);
 151                 /* Save the trigger point for later (SR_DF_END). */
 152                 ctx->trigger_point = 0; /* TODO: Store _actual_ value. */
 153                 break;
 154         case SR_DF_END:
 155                 sr_dbg("%s: SR_DF_END event", __func__);
 156                 if (!(outbuf = g_try_malloc(4 + 1))) {
 157                         sr_warn("la8 out: %s: outbuf malloc failed", __func__);
 158                         return SR_ERR_MALLOC;
 159                 }
 160
 161                 /* One byte for the 'divcount' value. */
 162                 outbuf[0] = samplerate_to_divcount(ctx->samplerate);
 163                 // if (outbuf[0] == 0xff) {
 164                 //      sr_warn("%s: invalid divcount", __func__);
 165                 //      return SR_ERR;
 166                 // }
 167
 168                 /* Four bytes (little endian) for the trigger point. */
 169                 outbuf[1] = (ctx->trigger_point >>  0) & 0xff;
 170                 outbuf[2] = (ctx->trigger_point >>  8) & 0xff;
 171                 outbuf[3] = (ctx->trigger_point >> 16) & 0xff;
 172                 outbuf[4] = (ctx->trigger_point >> 24) & 0xff;
 173
 174                 *data_out = outbuf;
 175                 *length_out = 4 + 1;
 176                 g_free(o->internal);
 177                 o->internal = NULL;
 178                 break;
 179         default:
 180                 sr_warn("%s: unsupported event type: %d", __func__,
 181                         event_type);
 182                 *data_out = NULL;
 183                 *length_out = 0;
 184                 break;
 185         }
 186
 187         return SR_OK;
 188 }
 189
 190 static int data(struct sr_output *o, const uint8_t *data_in,
 191                 uint64_t length_in, uint8_t **data_out, uint64_t *length_out)
 192 {
 193         struct context *ctx;
 194         uint8_t *outbuf;
 195
 196         if (!o) {
 197                 sr_warn("%s: o was NULL", __func__);
 198                 return SR_ERR_ARG;
 199         }
 200
 201         if (!(ctx = o->internal)) {
 202                 sr_warn("%s: o->internal was NULL", __func__);
 203                 return SR_ERR_ARG;
 204         }
 205
 206         if (!data_in) {
 207                 sr_warn("%s: data_in was NULL", __func__);
 208                 return SR_ERR_ARG;
 209         }
 210
 211         if (!(outbuf = g_try_malloc0(length_in))) {
 212                 sr_warn("%s: outbuf malloc failed", __func__);
 213                 return SR_ERR_MALLOC;
 214         }
 215
 216         memcpy(outbuf, data_in, length_in);
 217
 218         *data_out = outbuf;
 219         *length_out = length_in;
 220
 221         return SR_OK;
 222 }
 223
 224 SR_PRIV struct sr_output_format output_chronovu_la8 = {
 225         .id = "chronovu-la8",
 226         .description = "ChronoVu LA8",
 227         .df_type = SR_DF_LOGIC,
 228         .init = init,
 229         .data = data,
 230         .event = event,
 231 };