output/analog.c

   1 /*
   2  * This file is part of the sigrok project.
   3  *
   4  * Copyright (C) 2010 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2011 Håvard Espeland <gus@ping.uio.no>
   6  * Copyright (C) 2011 Daniel Ribeiro <drwyrm@gmail.com>
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include <stdlib.h>
  23 #include <stdio.h>
  24 #include <string.h>
  25 #include <glib.h>
  26 #include "sigrok.h"
  27
  28 #define DEFAULT_BPL_BITS 64
  29 #define DEFAULT_BPL_HEX  192
  30 #define DEFAULT_BPL_ASCII 74
  31
  32 enum outputmode {
  33         MODE_BITS = 1,
  34         MODE_HEX,
  35         MODE_ASCII,
  36 };
  37
  38 struct context {
  39         unsigned int num_enabled_probes;
  40         int samples_per_line;
  41         unsigned int unitsize;
  42         int line_offset;
  43         int linebuf_len;
  44         char *probelist[65];
  45         char *linebuf;
  46         int spl_cnt;
  47         uint8_t *linevalues;
  48         char *header;
  49         int mark_trigger;
  50 //      struct sr_analog_sample *prevsample;
  51         enum outputmode mode;
  52 };
  53
  54 static void flush_linebufs(struct context *ctx, char *outbuf)
  55 {
  56         static int max_probename_len = 0;
  57         int len, i;
  58
  59         if (ctx->linebuf[0] == 0)
  60                 return;
  61
  62         if (max_probename_len == 0) {
  63                 /* First time through... */
  64                 for (i = 0; ctx->probelist[i]; i++) {
  65                         len = strlen(ctx->probelist[i]);
  66                         if (len > max_probename_len)
  67                                 max_probename_len = len;
  68                 }
  69         }
  70
  71         for (i = 0; ctx->probelist[i]; i++) {
  72                 sprintf(outbuf + strlen(outbuf), "%*s:%s\n", max_probename_len,
  73                         ctx->probelist[i], ctx->linebuf + i * ctx->linebuf_len);
  74         }
  75
  76         /* Mark trigger with a ^ character. */
  77         if (ctx->mark_trigger != -1)
  78         {
  79                 int space_offset = ctx->mark_trigger / 8;
  80
  81                 if (ctx->mode == MODE_ASCII)
  82                         space_offset = 0;
  83
  84                 sprintf(outbuf + strlen(outbuf), "T:%*s^\n",
  85                         ctx->mark_trigger + space_offset, "");
  86         }
  87
  88         memset(ctx->linebuf, 0, i * ctx->linebuf_len);
  89 }
  90
  91 static int init(struct sr_output *o, int default_spl, enum outputmode mode)
  92 {
  93         struct context *ctx;
  94         struct sr_probe *probe;
  95         GSList *l;
  96         uint64_t samplerate;
  97         int num_probes;
  98         char *samplerate_s;
  99
 100         if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
 101                 sr_err("analog out: %s: ctx malloc failed", __func__);
 102                 return SR_ERR_MALLOC;
 103         }
 104
 105         o->internal = ctx;
 106         ctx->num_enabled_probes = 0;
 107
 108         for (l = o->device->probes; l; l = l->next) {
 109                 probe = l->data;
 110                 if (!probe->enabled)
 111                         continue;
 112                 ctx->probelist[ctx->num_enabled_probes++] = probe->name;
 113         }
 114
 115         ctx->probelist[ctx->num_enabled_probes] = 0;
 116         ctx->unitsize = sizeof(struct sr_analog_sample) +
 117                 (ctx->num_enabled_probes * sizeof(struct sr_analog_probe));
 118         ctx->line_offset = 0;
 119         ctx->spl_cnt = 0;
 120         ctx->mark_trigger = -1;
 121         ctx->mode = mode;
 122
 123         if (o->param && o->param[0]) {
 124                 ctx->samples_per_line = strtoul(o->param, NULL, 10);
 125                 if (ctx->samples_per_line < 1)
 126                         return SR_ERR;
 127         } else
 128                 ctx->samples_per_line = default_spl;
 129
 130         if (!(ctx->header = g_try_malloc(512))) {
 131                 g_free(ctx);
 132                 sr_err("analog out: %s: ctx->header malloc failed", __func__);
 133                 return SR_ERR_MALLOC;
 134         }
 135
 136         snprintf(ctx->header, 511, "%s\n", PACKAGE_STRING);
 137         num_probes = g_slist_length(o->device->probes);
 138         if (o->device->plugin && sr_dev_has_hwcap(o->device, SR_HWCAP_SAMPLERATE)) {
 139                 samplerate = *((uint64_t *) o->device->plugin->get_device_info(
 140                                 o->device->plugin_index, SR_DI_CUR_SAMPLERATE));
 141                 if (!(samplerate_s = sr_samplerate_string(samplerate))) {
 142                         g_free(ctx->header);
 143                         g_free(ctx);
 144                         return SR_ERR;
 145                 }
 146                 snprintf(ctx->header + strlen(ctx->header),
 147                          511 - strlen(ctx->header),
 148                          "Acquisition with %d/%d probes at %s\n",
 149                          ctx->num_enabled_probes, num_probes, samplerate_s);
 150                 g_free(samplerate_s);
 151         }
 152
 153         ctx->linebuf_len = ctx->samples_per_line * 2 + 4;
 154         if (!(ctx->linebuf = g_try_malloc0(num_probes * ctx->linebuf_len))) {
 155                 g_free(ctx->header);
 156                 g_free(ctx);
 157                 sr_err("analog out: %s: ctx->linebuf malloc failed", __func__);
 158                 return SR_ERR_MALLOC;
 159         }
 160         if (!(ctx->linevalues = g_try_malloc0(num_probes))) {
 161                 g_free(ctx->header);
 162                 g_free(ctx);
 163                 sr_err("analog out: %s: ctx->linevalues malloc failed",
 164                        __func__);
 165                 return SR_ERR_MALLOC;
 166         }
 167
 168         return SR_OK;
 169 }
 170
 171 static int event(struct sr_output *o, int event_type, char **data_out,
 172                  uint64_t *length_out)
 173 {
 174         struct context *ctx;
 175         int outsize;
 176         char *outbuf;
 177
 178         ctx = o->internal;
 179         switch (event_type) {
 180         case SR_DF_TRIGGER:
 181                 ctx->mark_trigger = ctx->spl_cnt;
 182                 *data_out = NULL;
 183                 *length_out = 0;
 184                 break;
 185         case SR_DF_END:
 186                 outsize = ctx->num_enabled_probes
 187                                 * (ctx->samples_per_line + 20) + 512;
 188                 if (!(outbuf = g_try_malloc0(outsize))) {
 189                         sr_err("analog out: %s: outbuf malloc failed",
 190                                __func__);
 191                         return SR_ERR_MALLOC;
 192                 }
 193                 flush_linebufs(ctx, outbuf);
 194                 *data_out = outbuf;
 195                 *length_out = strlen(outbuf);
 196                 g_free(o->internal);
 197                 o->internal = NULL;
 198                 break;
 199         default:
 200                 *data_out = NULL;
 201                 *length_out = 0;
 202                 break;
 203         }
 204
 205         return SR_OK;
 206 }
 207
 208 static int init_bits(struct sr_output *o)
 209 {
 210         return init(o, DEFAULT_BPL_BITS, MODE_BITS);
 211 }
 212
 213 static int data_bits(struct sr_output *o, const char *data_in,
 214                      uint64_t length_in, char **data_out, uint64_t *length_out)
 215 {
 216         struct context *ctx;
 217         unsigned int outsize, offset, p;
 218         int max_linelen;
 219         struct sr_analog_sample *sample;
 220         char *outbuf, c;
 221
 222         ctx = o->internal;
 223         max_linelen = SR_MAX_PROBENAME_LEN + 3 + ctx->samples_per_line
 224                         + ctx->samples_per_line / 8;
 225         /*
 226          * Calculate space needed for probes. Set aside 512 bytes for
 227          * extra output, e.g. trigger.
 228          */
 229         outsize = 512 + (1 + (length_in / ctx->unitsize) / ctx->samples_per_line)
 230             * (ctx->num_enabled_probes * max_linelen);
 231
 232         if (!(outbuf = g_try_malloc0(outsize + 1))) {
 233                 sr_err("analog out: %s: outbuf malloc failed", __func__);
 234                 return SR_ERR_MALLOC;
 235         }
 236
 237         outbuf[0] = '\0';
 238         if (ctx->header) {
 239                 /* The header is still here, this must be the first packet. */
 240                 strncpy(outbuf, ctx->header, outsize);
 241                 g_free(ctx->header);
 242                 ctx->header = NULL;
 243
 244                 /* Ensure first transition. */
 245 //              memcpy(&ctx->prevsample, data_in, ctx->unitsize);
 246 //              ctx->prevsample = ~ctx->prevsample;
 247         }
 248
 249         if (length_in >= ctx->unitsize) {
 250                 for (offset = 0; offset <= length_in - ctx->unitsize;
 251                      offset += ctx->unitsize) {
 252                         sample = (struct sr_analog_sample *) (data_in + offset);
 253                         for (p = 0; p < ctx->num_enabled_probes; p++) {
 254                                 int val = sample->probes[p].val;
 255                                 int res = sample->probes[p].res;
 256                                 if (res == 1)
 257                                         c = '0' + (val & ((1 << res) - 1));
 258                                 else
 259                                         /*
 260                                          * Scale analog resolution down so it
 261                                          * fits 25 letters
 262                                          */
 263                                         c = 'A' + (((val & ((1 << res) - 1)) /
 264                                                         (res * res)) / 10);
 265                                 ctx->linebuf[p * ctx->linebuf_len +
 266                                              ctx->line_offset] = c;
 267                         }
 268                         ctx->line_offset++;
 269                         ctx->spl_cnt++;
 270
 271                         /* Add a space every 8th bit. */
 272                         if ((ctx->spl_cnt & 7) == 0) {
 273                                 for (p = 0; p < ctx->num_enabled_probes; p++)
 274                                         ctx->linebuf[p * ctx->linebuf_len +
 275                                                      ctx->line_offset] = ' ';
 276                                 ctx->line_offset++;
 277                         }
 278
 279                         /* End of line. */
 280                         if (ctx->spl_cnt >= ctx->samples_per_line) {
 281                                 flush_linebufs(ctx, outbuf);
 282                                 ctx->line_offset = ctx->spl_cnt = 0;
 283                                 ctx->mark_trigger = -1;
 284                         }
 285                 }
 286         } else {
 287                 sr_info("short buffer (length_in=%" PRIu64 ")", length_in);
 288         }
 289
 290         *data_out = outbuf;
 291         *length_out = strlen(outbuf);
 292
 293         return SR_OK;
 294 }
 295 #if 0
 296 static int init_hex(struct sr_output *o)
 297 {
 298         return init(o, DEFAULT_BPL_HEX, MODE_HEX);
 299 }
 300
 301 static int data_hex(struct sr_output *o, const char *data_in,
 302                     uint64_t length_in, char **data_out, uint64_t *length_out)
 303 {
 304         struct context *ctx;
 305         unsigned int outsize, offset, p;
 306         int max_linelen;
 307         uint64_t sample;
 308         char *outbuf;
 309
 310         ctx = o->internal;
 311         max_linelen = SR_MAX_PROBENAME_LEN + 3 + ctx->samples_per_line
 312                         + ctx->samples_per_line / 2;
 313         outsize = length_in / ctx->unitsize * ctx->num_enabled_probes
 314                         / ctx->samples_per_line * max_linelen + 512;
 315
 316         if (!(outbuf = g_try_malloc0(outsize + 1))) {
 317                 sr_err("analog out: %s: outbuf malloc failed", __func__);
 318                 return SR_ERR_MALLOC;
 319         }
 320
 321         outbuf[0] = '\0';
 322         if (ctx->header) {
 323                 /* The header is still here, this must be the first packet. */
 324                 strncpy(outbuf, ctx->header, outsize);
 325                 g_free(ctx->header);
 326                 ctx->header = NULL;
 327         }
 328
 329         ctx->line_offset = 0;
 330         for (offset = 0; offset <= length_in - ctx->unitsize;
 331              offset += ctx->unitsize) {
 332                 memcpy(&sample, data_in + offset, ctx->unitsize);
 333                 for (p = 0; p < ctx->num_enabled_probes; p++) {
 334                         ctx->linevalues[p] <<= 1;
 335                         if (sample & ((uint64_t) 1 << p))
 336                                 ctx->linevalues[p] |= 1;
 337                         sprintf(ctx->linebuf + (p * ctx->linebuf_len) +
 338                                 ctx->line_offset, "%.2x", ctx->linevalues[p]);
 339                 }
 340                 ctx->spl_cnt++;
 341
 342                 /* Add a space after every complete hex byte. */
 343                 if ((ctx->spl_cnt & 7) == 0) {
 344                         for (p = 0; p < ctx->num_enabled_probes; p++)
 345                                 ctx->linebuf[p * ctx->linebuf_len +
 346                                              ctx->line_offset + 2] = ' ';
 347                         ctx->line_offset += 3;
 348                 }
 349
 350                 /* End of line. */
 351                 if (ctx->spl_cnt >= ctx->samples_per_line) {
 352                         flush_linebufs(ctx, outbuf);
 353                         ctx->line_offset = ctx->spl_cnt = 0;
 354                 }
 355         }
 356
 357         *data_out = outbuf;
 358         *length_out = strlen(outbuf);
 359
 360         return SR_OK;
 361 }
 362
 363 static int init_ascii(struct sr_output *o)
 364 {
 365         return init(o, DEFAULT_BPL_ASCII, MODE_ASCII);
 366 }
 367
 368 static int data_ascii(struct sr_output *o, const char *data_in,
 369                       uint64_t length_in, char **data_out, uint64_t *length_out)
 370 {
 371         struct context *ctx;
 372         unsigned int outsize, offset, p;
 373         int max_linelen;
 374         uint64_t sample;
 375         char *outbuf;
 376
 377         ctx = o->internal;
 378         max_linelen = SR_MAX_PROBENAME_LEN + 3 + ctx->samples_per_line
 379                         + ctx->samples_per_line / 8;
 380         /*
 381          * Calculate space needed for probes. Set aside 512 bytes for
 382          * extra output, e.g. trigger.
 383          */
 384         outsize = 512 + (1 + (length_in / ctx->unitsize) / ctx->samples_per_line)
 385             * (ctx->num_enabled_probes * max_linelen);
 386
 387         if (!(outbuf = g_try_malloc0(outsize + 1))) {
 388                 sr_err("analog out: %s: outbuf malloc failed", __func__);
 389                 return SR_ERR_MALLOC;
 390         }
 391
 392         outbuf[0] = '\0';
 393         if (ctx->header) {
 394                 /* The header is still here, this must be the first packet. */
 395                 strncpy(outbuf, ctx->header, outsize);
 396                 g_free(ctx->header);
 397                 ctx->header = NULL;
 398         }
 399
 400         if (length_in >= ctx->unitsize) {
 401                 for (offset = 0; offset <= length_in - ctx->unitsize;
 402                      offset += ctx->unitsize) {
 403                         memcpy(&sample, data_in + offset, ctx->unitsize);
 404
 405                         char tmpval[ctx->num_enabled_probes];
 406
 407                         for (p = 0; p < ctx->num_enabled_probes; p++) {
 408                                 uint64_t curbit = (sample & ((uint64_t) 1 << p));
 409                                 uint64_t prevbit = (ctx->prevsample &
 410                                                 ((uint64_t) 1 << p));
 411
 412                                 if (curbit < prevbit && ctx->line_offset > 0) {
 413                                         ctx->linebuf[p * ctx->linebuf_len +
 414                                                 ctx->line_offset-1] = '\\';
 415                                 }
 416
 417                                 if (curbit > prevbit) {
 418                                         tmpval[p] = '/';
 419                                 } else {
 420                                         if (curbit)
 421                                                 tmpval[p] = '"';
 422                                         else
 423                                                 tmpval[p] = '.';
 424                                 }
 425                         }
 426
 427                         /* End of line. */
 428                         if (ctx->spl_cnt >= ctx->samples_per_line) {
 429                                 flush_linebufs(ctx, outbuf);
 430                                 ctx->line_offset = ctx->spl_cnt = 0;
 431                                 ctx->mark_trigger = -1;
 432                         }
 433
 434                         for (p = 0; p < ctx->num_enabled_probes; p++) {
 435                                 ctx->linebuf[p * ctx->linebuf_len +
 436                                              ctx->line_offset] = tmpval[p];
 437                         }
 438
 439                         ctx->line_offset++;
 440                         ctx->spl_cnt++;
 441
 442                         ctx->prevsample = sample;
 443                 }
 444         } else {
 445                 sr_info("short buffer (length_in=%" PRIu64 ")", length_in);
 446         }
 447
 448         *data_out = outbuf;
 449         *length_out = strlen(outbuf);
 450
 451         return SR_OK;
 452 }
 453 #endif
 454
 455 SR_PRIV struct sr_output_format output_analog_bits = {
 456         .id = "analog_bits",
 457         .description = "Bits (takes argument, default 64)",
 458         .df_type = SR_DF_ANALOG,
 459         .init = init_bits,
 460         .data = data_bits,
 461         .event = event,
 462 };
 463
 464 #if 0
 465 struct sr_output_format output_analog_hex = {
 466         .id = "analog_hex",
 467         .description = "Hexadecimal (takes argument, default 192)",
 468         .df_type = SR_DF_ANALOG,
 469         .init = init_hex,
 470         .data = data_hex,
 471         .event = event,
 472 };
 473
 474 struct sr_output_format output_analog_ascii = {
 475         .id = "analog_ascii",
 476         .description = "ASCII (takes argument, default 74)",
 477         .df_type = SR_DF_ANALOG,
 478         .init = init_ascii,
 479         .data = data_ascii,
 480         .event = event,
 481 };
 482 #endif