src/hardware/demo/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2010 Uwe Hermann <uwe@hermann-uwe.de>
   5  * Copyright (C) 2011 Olivier Fauchon <olivier@aixmarseille.com>
   6  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
   7  * Copyright (C) 2015 Bartosz Golaszewski <bgolaszewski@baylibre.com>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23 #ifndef LIBSIGROK_HARDWARE_DEMO_PROTOCOL_H
  24 #define LIBSIGROK_HARDWARE_DEMO_PROTOCOL_H
  25
  26 #include <stdint.h>
  27 #include <libsigrok/libsigrok.h>
  28 #include "libsigrok-internal.h"
  29
  30 #define LOG_PREFIX "demo"
  31
  32 /* The size in bytes of chunks to send through the session bus. */
  33 #define LOGIC_BUFSIZE                   4096
  34 /* Size of the analog pattern space per channel. */
  35 #define ANALOG_BUFSIZE                  4096
  36
  37 /* Private, per-device-instance driver context. */
  38 struct dev_context {
  39         uint64_t cur_samplerate;
  40         uint64_t limit_samples;
  41         uint64_t limit_msec;
  42         uint64_t sent_samples;
  43         int64_t start_us;
  44         int64_t spent_us;
  45         uint64_t step;
  46         /* Logic */
  47         int32_t num_logic_channels;
  48         unsigned int logic_unitsize;
  49         /* There is only ever one logic channel group, so its pattern goes here. */
  50         uint8_t logic_pattern;
  51         unsigned char logic_data[LOGIC_BUFSIZE];
  52         /* Analog */
  53         int32_t num_analog_channels;
  54         GHashTable *ch_ag;
  55         gboolean avg; /* True if averaging is enabled */
  56         uint64_t avg_samples;
  57         size_t enabled_logic_channels;
  58         size_t enabled_analog_channels;
  59         size_t first_partial_logic_index;
  60         uint8_t first_partial_logic_mask;
  61 };
  62
  63 /* Logic patterns we can generate. */
  64 enum {
  65         /**
  66          * Spells "sigrok" across 8 channels using '0's (with '1's as
  67          * "background") when displayed using the 'bits' output format.
  68          * The pattern is repeated every 8 channels, shifted to the right
  69          * in time by one bit.
  70          */
  71         PATTERN_SIGROK,
  72
  73         /** Pseudo-random values on all channels. */
  74         PATTERN_RANDOM,
  75
  76         /**
  77          * Incrementing number across 8 channels. The pattern is repeated
  78          * every 8 channels, shifted to the right in time by one bit.
  79          */
  80         PATTERN_INC,
  81
  82         /**
  83          * Single bit "walking" across all logic channels by being
  84          * shifted across data lines, restarting after the last line
  85          * was used. An all-zero (all-one) state is inserted to prevent
  86          * repetitive patterns (e.g. with 8 data lines, every 8th state
  87          * would show the same line state)
  88          */
  89         PATTERN_WALKING_ONE,
  90         PATTERN_WALKING_ZERO,
  91
  92         /** All channels have a low logic state. */
  93         PATTERN_ALL_LOW,
  94
  95         /** All channels have a high logic state. */
  96         PATTERN_ALL_HIGH,
  97
  98         /**
  99          * Mimics a cable squid. Derived from the "works with" logo
 100          * to occupy a larger number of channels yet "painting"
 101          * something that can get recognized.
 102          */
 103         PATTERN_SQUID,
 104 };
 105
 106 /* Analog patterns we can generate. */
 107 enum {
 108         /**
 109          * Square wave.
 110          */
 111         PATTERN_SQUARE,
 112         PATTERN_SINE,
 113         PATTERN_TRIANGLE,
 114         PATTERN_SAWTOOTH,
 115 };
 116
 117 static const char *analog_pattern_str[] = {
 118         "square",
 119         "sine",
 120         "triangle",
 121         "sawtooth",
 122 };
 123
 124 struct analog_gen {
 125         struct sr_channel *ch;
 126         int pattern;
 127         float amplitude;
 128         float pattern_data[ANALOG_BUFSIZE];
 129         unsigned int num_samples;
 130         struct sr_datafeed_analog packet;
 131         struct sr_analog_encoding encoding;
 132         struct sr_analog_meaning meaning;
 133         struct sr_analog_spec spec;
 134         float avg_val; /* Average value */
 135         unsigned num_avgs; /* Number of samples averaged */
 136 };
 137
 138 SR_PRIV void demo_generate_analog_pattern(struct analog_gen *ag, uint64_t sample_rate);
 139 SR_PRIV int demo_prepare_data(int fd, int revents, void *cb_data);
 140
 141 #endif