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 /* This is a development feature: it starts a new frame every n samples. */
  37 #define SAMPLES_PER_FRAME               1000UL
  38 #define DEFAULT_LIMIT_FRAMES            0
  39
  40 /* Logic patterns we can generate. */
  41 enum logic_pattern_type {
  42         /**
  43          * Spells "sigrok" across 8 channels using '0's (with '1's as
  44          * "background") when displayed using the 'bits' output format.
  45          * The pattern is repeated every 8 channels, shifted to the right
  46          * in time by one bit.
  47          */
  48         PATTERN_SIGROK,
  49
  50         /** Pseudo-random values on all channels. */
  51         PATTERN_RANDOM,
  52
  53         /**
  54          * Incrementing number across 8 channels. The pattern is repeated
  55          * every 8 channels, shifted to the right in time by one bit.
  56          */
  57         PATTERN_INC,
  58
  59         /**
  60          * Single bit "walking" across all logic channels by being
  61          * shifted across data lines, restarting after the last line
  62          * was used. An all-zero (all-one) state is inserted to prevent
  63          * repetitive patterns (e.g. with 8 data lines, every 8th state
  64          * would show the same line state)
  65          */
  66         PATTERN_WALKING_ONE,
  67         PATTERN_WALKING_ZERO,
  68
  69         /** All channels have a low logic state. */
  70         PATTERN_ALL_LOW,
  71
  72         /** All channels have a high logic state. */
  73         PATTERN_ALL_HIGH,
  74
  75         /**
  76          * Mimics a cable squid. Derived from the "works with" logo
  77          * to occupy a larger number of channels yet "painting"
  78          * something that can get recognized.
  79          */
  80         PATTERN_SQUID,
  81
  82         /** Gray encoded data, like rotary encoder signals. */
  83         PATTERN_GRAYCODE,
  84 };
  85
  86 /* Analog patterns we can generate. */
  87 enum analog_pattern_type {
  88         PATTERN_SQUARE,
  89         PATTERN_SINE,
  90         PATTERN_TRIANGLE,
  91         PATTERN_SAWTOOTH,
  92 };
  93
  94 struct dev_context {
  95         uint64_t cur_samplerate;
  96         uint64_t limit_samples;
  97         uint64_t limit_msec;
  98         uint64_t limit_frames;
  99         uint64_t sent_samples;
 100         uint64_t sent_frame_samples; /* Number of samples that were sent for current frame. */
 101         int64_t start_us;
 102         int64_t spent_us;
 103         uint64_t step;
 104         /* Logic */
 105         int32_t num_logic_channels;
 106         size_t logic_unitsize;
 107         uint64_t all_logic_channels_mask;
 108         /* There is only ever one logic channel group, so its pattern goes here. */
 109         enum logic_pattern_type logic_pattern;
 110         uint8_t logic_data[LOGIC_BUFSIZE];
 111         /* Analog */
 112         int32_t num_analog_channels;
 113         GHashTable *ch_ag;
 114         gboolean avg; /* True if averaging is enabled */
 115         uint64_t avg_samples;
 116         size_t enabled_logic_channels;
 117         size_t enabled_analog_channels;
 118         size_t first_partial_logic_index;
 119         uint8_t first_partial_logic_mask;
 120         /* Triggers */
 121         uint64_t capture_ratio;
 122         gboolean trigger_fired;
 123         struct soft_trigger_logic *stl;
 124 };
 125
 126 static const char *analog_pattern_str[] = {
 127         "square",
 128         "sine",
 129         "triangle",
 130         "sawtooth",
 131 };
 132
 133 struct analog_gen {
 134         struct sr_channel *ch;
 135         enum analog_pattern_type pattern;
 136         float amplitude;
 137         float pattern_data[ANALOG_BUFSIZE];
 138         unsigned int num_samples;
 139         struct sr_datafeed_analog packet;
 140         struct sr_analog_encoding encoding;
 141         struct sr_analog_meaning meaning;
 142         struct sr_analog_spec spec;
 143         float avg_val; /* Average value */
 144         unsigned int num_avgs; /* Number of samples averaged */
 145 };
 146
 147 SR_PRIV void demo_generate_analog_pattern(struct analog_gen *ag, uint64_t sample_rate);
 148 SR_PRIV int demo_prepare_data(int fd, int revents, void *cb_data);
 149
 150 #endif