aboutsummaryrefslogtreecommitdiffstats
path: root/src/output/SDRDevice.h
blob: f84b340326356c78add705de6a8552033d6db647 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/*
   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Her Majesty the
   Queen in Right of Canada (Communications Research Center Canada)

   Copyright (C) 2023
   Matthias P. Braendli, matthias.braendli@mpb.li

    http://opendigitalradio.org

DESCRIPTION:
   Common interface for all SDR outputs
*/

/*
   This file is part of ODR-DabMod.

   ODR-DabMod is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as
   published by the Free Software Foundation, either version 3 of the
   License, or (at your option) any later version.

   ODR-DabMod is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with ODR-DabMod.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#ifdef HAVE_CONFIG_H
#   include <config.h>
#endif

#include <cstdint>
#include <string>
#include <vector>
#include <complex>
#include <variant>
#include <optional>
#include <unordered_map>

#include "TimestampDecoder.h"

namespace Output {

enum refclk_lock_loss_behaviour_t { CRASH, IGNORE };

using complexf = std::complex<float>;

/* This structure is used as initial configuration for all SDR devices.
 * It must also contain all remote-controllable settings, otherwise
 * they will get lost on a modulator restart. */
struct SDRDeviceConfig {
    std::string device;
    std::string subDevice; // For UHD
    std::string tx_antenna;
    std::string rx_antenna;

    long masterClockRate = 32768000;
    unsigned sampleRate = 2048000;
    double frequency = 0.0;
    double lo_offset = 0.0;
    double txgain = 0.0;
    double rxgain = 0.0;
    bool enableSync = false;
    double bandwidth = 0.0;
    unsigned upsample = 1;

    // When working with timestamps, mute the frames that
    // do not have a timestamp
    bool muteNoTimestamps = false;
    unsigned dabMode = 0;
    unsigned maxGPSHoldoverTime = 0;

    /* allowed values for UHD      : auto, int, sma, mimo */
    /* allowed values for BladeRF  : pps, 10mhz */
    std::string refclk_src;

    /* allowed values for UHD : int, sma, mimo */
    std::string pps_src;

    /* allowed values for UHD : pos, neg */
    std::string pps_polarity;

    /* What to do when the reference clock PLL loses lock */
    refclk_lock_loss_behaviour_t refclk_lock_loss_behaviour;

    // muting can only be changed using the remote control
    bool muting = false;

    // TCP port on which to serve TX and RX samples for the
    // digital pre distortion learning tool
    uint16_t dpdFeedbackServerPort = 0;

    // DEXTER-specific
    std::string pacontrol_config_endpoint;
    std::optional<int> pacontrol_targetpower; // dBm
};

// Each frame contains one OFDM frame, and its
// associated timestamp
struct FrameData {
    // Buffer holding frame data
    std::vector<uint8_t> buf;
    size_t sampleSize = sizeof(complexf);

    // A full timestamp contains a TIST according to standard
    // and time information within MNSC with tx_second.
    frame_timestamp ts;
};


// All SDR Devices must implement the SDRDevice interface
class SDRDevice {
    public:
        using run_statistics_t = RemoteControllable::map_t;

        virtual void tune(double lo_offset, double frequency) = 0;
        virtual double get_tx_freq(void) const = 0;
        virtual void set_txgain(double txgain) = 0;
        virtual double get_txgain(void) const = 0;
        virtual void transmit_frame(struct FrameData&& frame) = 0;
        virtual run_statistics_t get_run_statistics(void) const = 0;
        virtual double get_real_secs(void) const = 0;
        virtual void set_rxgain(double rxgain) = 0;
        virtual double get_rxgain(void) const = 0;
        virtual void set_bandwidth(double bandwidth) = 0;
        virtual double get_bandwidth(void) const = 0;
        virtual size_t receive_frame(
                complexf *buf,
                size_t num_samples,
                frame_timestamp& ts,
                double timeout_secs) = 0;

        // Returns device temperature in degrees C
        virtual std::optional<double> get_temperature(void) const = 0;

        // Return true if GPS and reference clock inputs are ok
        virtual bool is_clk_source_ok(void) = 0;

        virtual const char* device_name(void) const = 0;

        virtual void require_timestamp_refresh() { m_require_timestamp_refresh = true; }

    protected:
        bool m_require_timestamp_refresh = false;
};

} // namespace Output