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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
//
// Copyright 2015-2016 Ettus Research LLC
//
// This program 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.
//
// This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
//
#ifndef INCLUDED_LIBUHD_RFNOC_RADIO_CTRL_HPP
#define INCLUDED_LIBUHD_RFNOC_RADIO_CTRL_HPP
#include <uhd/types/direction.hpp>
#include <uhd/rfnoc/source_block_ctrl_base.hpp>
#include <uhd/rfnoc/sink_block_ctrl_base.hpp>
#include <uhd/rfnoc/rate_node_ctrl.hpp>
#include <uhd/rfnoc/tick_node_ctrl.hpp>
#include <uhd/rfnoc/scalar_node_ctrl.hpp>
#include <uhd/rfnoc/terminator_node_ctrl.hpp>
namespace uhd {
namespace rfnoc {
/*! \brief Block controller for all RFNoC-based radio blocks
*/
class UHD_RFNOC_API radio_ctrl :
public source_block_ctrl_base,
public sink_block_ctrl_base,
public rate_node_ctrl,
public tick_node_ctrl,
public terminator_node_ctrl
{
public:
UHD_RFNOC_BLOCK_OBJECT(radio_ctrl)
virtual ~radio_ctrl(){}
/************************************************************************
* API calls
***********************************************************************/
/*! Return the tick rate on all channels (rx and tx).
*
* \return The tick rate.
*/
virtual double get_rate() const = 0;
/*! Set the tick/sample rate on all channels (rx and tx).
*
* Will coerce to the nearest possible rate and return the actual value.
*/
virtual double set_rate(double rate) = 0;
/*! Return the selected TX antenna for channel \p chan.
*
* \return The selected antenna.
*/
virtual std::string get_tx_antenna(const size_t chan) /* const */ = 0;
/*! Select RX antenna \p for channel \p chan.
*
* \throws uhd::value_error if \p ant is not a valid value.
*/
virtual void set_tx_antenna(const std::string &ant, const size_t chan) = 0;
/*! Return the selected RX antenna for channel \p chan.
*
* \return The selected antenna.
*/
virtual std::string get_rx_antenna(const size_t chan) /* const */ = 0;
/*! Select RX antenna \p for channel \p chan.
*
* \throws uhd::value_error if \p ant is not a valid value.
*/
virtual void set_rx_antenna(const std::string &ant, const size_t chan) = 0;
/*! Return the current transmit LO frequency on channel \p chan.
*
* Note that the AD9361 only has one LO for all TX channels, and the
* \p chan parameter is thus only for API compatibility.
*
* \return The current LO frequency.
*/
virtual double get_tx_frequency(const size_t chan) /* const */ = 0;
/*! Tune the TX LO for channel \p chan.
*
* This function will attempt to tune as close as possible, and return a
* coerced value of the actual tuning result.
*
* \param freq Frequency in Hz
* \param chan Channel to tune
*
* \return The actual LO frequency.
*/
virtual double set_tx_frequency(const double freq, size_t chan) = 0;
/*! Return the current receive LO frequency on channel \p chan.
*
* \return The current LO frequency.
*/
virtual double get_rx_frequency(const size_t chan) /* const */ = 0;
/*! Tune the RX LO for channel \p.
*
* This function will attempt to tune as close as possible, and return a
* coerced value of the actual tuning result.
*
* \return The actual LO frequency.
*/
virtual double set_rx_frequency(const double freq, const size_t chan) = 0;
/*! Return the transmit gain on channel \p chan
*
* \return The actual gain value
*/
virtual double get_tx_gain(const size_t chan) = 0;
/*! Set the transmit gain on channel \p chan
*
* This function will attempt to set the gain as close as possible,
* and return a coerced value of the actual gain value.
*
* \return The actual gain value
*/
virtual double set_tx_gain(const double gain, const size_t chan) = 0;
/*! Return the transmit gain on channel \p chan
*
* \return The actual gain value
*/
virtual double get_rx_gain(const size_t chan) = 0;
/*! Set the transmit gain on channel \p chan
*
* This function will attempt to set the gain as close as possible,
* and return a coerced value of the actual gain value.
*
* \return The actual gain value
*/
virtual double set_rx_gain(const double gain, const size_t chan) = 0;
/*! Return the analog filter bandwidth channel \p chan
*
* \return The actual bandwidth value
*/
// virtual double get_rx_bandwidth(const double bandwidth, const size_t chan) = 0;
/*! Set the analog filter bandwidth channel \p chan
*
* This function will attempt to set the analog bandwidth.
*
* \return The actual bandwidth value
*/
virtual double set_rx_bandwidth(const double bandwidth, const size_t chan) = 0;
/*! Sets the time in the radio's timekeeper to the given value.
*
* Note that there is a non-deterministic delay between calling this
* function and the valung written to the register. For setting the
* time in alignment with a certain reference time, use
* set_time_next_pps().
*/
virtual void set_time_now(const time_spec_t &time_spec) = 0;
/*! Set the time registers at the next pps tick.
*
* The values will not be latched in until the pulse occurs.
* It is recommended that the user sleep(1) after calling to ensure
* that the time registers will be in a known state prior to use.
*
* Note: Because this call sets the time on the "next" pps,
* the seconds in the time spec should be current seconds + 1.
*
* \param time_spec the time to latch into the timekeeper
*/
virtual void set_time_next_pps(const time_spec_t &time_spec) = 0;
/*! Get the current time in the timekeeper registers.
*
* Note that there is a non-deterministic delay between the time the
* register is read and the time the function value is returned.
* To get the time with respect to a tick edge, use get_time_last_pps().
*
* \return A timespec representing current radio time
*/
virtual time_spec_t get_time_now() = 0;
/*! Get the time when the last PPS pulse occurred.
*
* \return A timespec representing the last PPS
*/
virtual time_spec_t get_time_last_pps() = 0;
/*! Given a frontend name, return the channel mapping.
*
* E.g.: For a TwinRX board, there's two frontends, '0' and '1', which
* map to channels 0 and 1 respectively. A BasicRX boards has alphabetical
* frontends (A, B) which map to channels differently.
*/
virtual size_t get_chan_from_dboard_fe(const std::string &fe, const uhd::direction_t dir) = 0;
/*! The inverse function to get_chan_from_dboard_fe()
*/
virtual std::string get_dboard_fe_from_chan(const size_t chan, const uhd::direction_t dir) = 0;
}; /* class radio_ctrl */
}} /* namespace uhd::rfnoc */
#endif /* INCLUDED_LIBUHD_RFNOC_RADIO_CTRL_HPP */
|
