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 };
  58
  59 /* Logic patterns we can generate. */
  60 enum {
  61         /**
  62          * Spells "sigrok" across 8 channels using '0's (with '1's as
  63          * "background") when displayed using the 'bits' output format.
  64          * The pattern is repeated every 8 channels, shifted to the right
  65          * in time by one bit.
  66          */
  67         PATTERN_SIGROK,
  68
  69         /** Pseudo-random values on all channels. */
  70         PATTERN_RANDOM,
  71
  72         /**
  73          * Incrementing number across 8 channels. The pattern is repeated
  74          * every 8 channels, shifted to the right in time by one bit.
  75          */
  76         PATTERN_INC,
  77
  78         /**
  79          * Single bit "walking" across all logic channels by being
  80          * shifted across data lines, restarting after the last line
  81          * was used. An all-zero (all-one) state is inserted to prevent
  82          * repetitive patterns (e.g. with 8 data lines, every 8th state
  83          * would show the same line state)
  84          */
  85         PATTERN_WALKING_ONE,
  86         PATTERN_WALKING_ZERO,
  87
  88         /** All channels have a low logic state. */
  89         PATTERN_ALL_LOW,
  90
  91         /** All channels have a high logic state. */
  92         PATTERN_ALL_HIGH,
  93
  94         /**
  95          * Mimics a cable squid. Derived from the "works with" logo
  96          * to occupy a larger number of channels yet "painting"
  97          * something that can get recognized.
  98          */
  99         PATTERN_SQUID,
 100 };
 101
 102 /* Analog patterns we can generate. */
 103 enum {
 104         /**
 105          * Square wave.
 106          */
 107         PATTERN_SQUARE,
 108         PATTERN_SINE,
 109         PATTERN_TRIANGLE,
 110         PATTERN_SAWTOOTH,
 111 };
 112
 113 static const char *analog_pattern_str[] = {
 114         "square",
 115         "sine",
 116         "triangle",
 117         "sawtooth",
 118 };
 119
 120 struct analog_gen {
 121         int pattern;
 122         float amplitude;
 123         float pattern_data[ANALOG_BUFSIZE];
 124         unsigned int num_samples;
 125         struct sr_datafeed_analog packet;
 126         struct sr_analog_encoding encoding;
 127         struct sr_analog_meaning meaning;
 128         struct sr_analog_spec spec;
 129         float avg_val; /* Average value */
 130         unsigned num_avgs; /* Number of samples averaged */
 131 };
 132
 133 SR_PRIV void demo_generate_analog_pattern(struct analog_gen *ag, uint64_t sample_rate);
 134 SR_PRIV int demo_prepare_data(int fd, int revents, void *cb_data);
 135
 136 #endif