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