output/text/text.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2011 Håvard Espeland <gus@ping.uio.no>
   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 3 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 <stdio.h>
  23 #include <string.h>
  24 #include <glib.h>
  25 #include "config.h" /* Needed for PACKAGE_STRING and others. */
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28 #include "text.h"
  29
  30 /* Message logging helpers with driver-specific prefix string. */
  31 #define DRIVER_LOG_DOMAIN "output/text: "
  32 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
  33 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
  34 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
  35 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
  36 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
  37 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
  38
  39 SR_PRIV void flush_linebufs(struct context *ctx, uint8_t *outbuf)
  40 {
  41         static int max_probename_len = 0;
  42         int len, i;
  43         GSList *l;
  44         char *probe_name;
  45
  46         if (ctx->linebuf[0] == 0)
  47                 return;
  48
  49         if (max_probename_len == 0) {
  50                 /* First time through... */
  51                 for (l = ctx->probenames; l; l = l->next) {
  52                         probe_name = l->data;
  53                         len = strlen(probe_name);
  54                         if (len > max_probename_len)
  55                                 max_probename_len = len;
  56                 }
  57         }
  58
  59         for (i = 0, l = ctx->probenames; l; l = l->next, i++) {
  60                 probe_name = l->data;
  61                 sprintf((char *)outbuf + strlen((const char *)outbuf),
  62                         "%*s:%s\n", max_probename_len,
  63                         probe_name, ctx->linebuf + i * ctx->linebuf_len);
  64         }
  65
  66         /* Mark trigger with a ^ character. */
  67         if (ctx->mark_trigger != -1)
  68         {
  69                 int space_offset = ctx->mark_trigger / 8;
  70
  71                 if (ctx->mode == MODE_ASCII)
  72                         space_offset = 0;
  73
  74                 sprintf((char *)outbuf + strlen((const char *)outbuf),
  75                         "T:%*s^\n", ctx->mark_trigger + space_offset, "");
  76         }
  77
  78         memset(ctx->linebuf, 0, i * ctx->linebuf_len);
  79 }
  80
  81 SR_PRIV int init(struct sr_output *o, int default_spl, enum outputmode mode)
  82 {
  83         struct context *ctx;
  84         struct sr_probe *probe;
  85         GSList *l;
  86         GVariant *gvar;
  87         uint64_t samplerate;
  88         int num_probes, ret;
  89         char *samplerate_s;
  90
  91         if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
  92                 sr_err("%s: ctx malloc failed", __func__);
  93                 return SR_ERR_MALLOC;
  94         }
  95
  96         o->internal = ctx;
  97         ctx->num_enabled_probes = 0;
  98         ctx->probenames = NULL;
  99
 100         for (l = o->sdi->probes; l; l = l->next) {
 101                 probe = l->data;
 102                 if (!probe->enabled)
 103                         continue;
 104                 ctx->probenames = g_slist_append(ctx->probenames, probe->name);
 105                 ctx->num_enabled_probes++;
 106         }
 107
 108         ctx->unitsize = (ctx->num_enabled_probes + 7) / 8;
 109         ctx->line_offset = 0;
 110         ctx->spl_cnt = 0;
 111         ctx->mark_trigger = -1;
 112         ctx->mode = mode;
 113
 114         ret = SR_OK;
 115         if (o->param && o->param[0]) {
 116                 ctx->samples_per_line = strtoul(o->param, NULL, 10);
 117                 if (ctx->samples_per_line < 1) {
 118                         ret = SR_ERR;
 119                         goto err;
 120                 }
 121         } else
 122                 ctx->samples_per_line = default_spl;
 123
 124         if (!(ctx->header = g_try_malloc0(512))) {
 125                 sr_err("%s: ctx->header malloc failed", __func__);
 126                 ret = SR_ERR_MALLOC;
 127                 goto err;
 128         }
 129
 130         snprintf(ctx->header, 511, "%s\n", PACKAGE_STRING);
 131         num_probes = g_slist_length(o->sdi->probes);
 132         if (o->sdi->driver || sr_dev_has_option(o->sdi, SR_CONF_SAMPLERATE)) {
 133                 if ((ret = o->sdi->driver->config_get(SR_CONF_SAMPLERATE, &gvar,
 134                                 o->sdi)) != SR_OK)
 135                         goto err;
 136                 samplerate = g_variant_get_uint64(gvar);
 137                 if (!(samplerate_s = sr_samplerate_string(samplerate))) {
 138                         ret = SR_ERR;
 139                         g_variant_unref(gvar);
 140                         goto err;
 141                 }
 142                 snprintf(ctx->header + strlen(ctx->header),
 143                          511 - strlen(ctx->header),
 144                          "Acquisition with %d/%d probes at %s\n",
 145                          ctx->num_enabled_probes, num_probes, samplerate_s);
 146                 g_free(samplerate_s);
 147                 g_variant_unref(gvar);
 148         }
 149
 150         ctx->linebuf_len = ctx->samples_per_line * 2 + 4;
 151         if (!(ctx->linebuf = g_try_malloc0(num_probes * ctx->linebuf_len))) {
 152                 sr_err("%s: ctx->linebuf malloc failed", __func__);
 153                 ret = SR_ERR_MALLOC;
 154                 goto err;
 155         }
 156
 157         if (!(ctx->linevalues = g_try_malloc0(num_probes))) {
 158                 sr_err("%s: ctx->linevalues malloc failed", __func__);
 159                 ret = SR_ERR_MALLOC;
 160         }
 161
 162         if (mode == MODE_ASCII &&
 163                         !(ctx->prevsample = g_try_malloc0(num_probes / 8))) {
 164                 sr_err("%s: ctx->prevsample malloc failed", __func__);
 165                 ret = SR_ERR_MALLOC;
 166         }
 167
 168 err:
 169         if (ret != SR_OK) {
 170                 g_free(ctx->header);
 171                 g_free(ctx);
 172         }
 173
 174         return ret;
 175 }
 176
 177 SR_PRIV int event(struct sr_output *o, int event_type, uint8_t **data_out,
 178                   uint64_t *length_out)
 179 {
 180         struct context *ctx;
 181         int outsize;
 182         uint8_t *outbuf;
 183
 184         ctx = o->internal;
 185         switch (event_type) {
 186         case SR_DF_TRIGGER:
 187                 ctx->mark_trigger = ctx->spl_cnt;
 188                 *data_out = NULL;
 189                 *length_out = 0;
 190                 break;
 191         case SR_DF_END:
 192                 outsize = ctx->num_enabled_probes
 193                                 * (ctx->samples_per_line + 20) + 512;
 194                 if (!(outbuf = g_try_malloc0(outsize))) {
 195                         sr_err("%s: outbuf malloc failed", __func__);
 196                         return SR_ERR_MALLOC;
 197                 }
 198                 flush_linebufs(ctx, outbuf);
 199                 *data_out = outbuf;
 200                 *length_out = strlen((const char *)outbuf);
 201                 g_free(o->internal);
 202                 o->internal = NULL;
 203                 break;
 204         default:
 205                 *data_out = NULL;
 206                 *length_out = 0;
 207                 break;
 208         }
 209
 210         return SR_OK;
 211 }