USRP Hardware Driver and USRP Manual  Version: 4.1.0.5-1
UHD and USRP Manual
radio_control.hpp
Go to the documentation of this file.
1 //
2 // Copyright 2019 Ettus Research, a National Instruments Brand
3 //
4 // SPDX-License-Identifier: GPL-3.0-or-later
5 //
6 
7 #pragma once
8 
9 #include <uhd/config.hpp>
15 #include <uhd/types/direction.hpp>
16 #include <uhd/types/eeprom.hpp>
17 #include <uhd/types/ranges.hpp>
18 #include <uhd/types/sensors.hpp>
19 #include <uhd/types/stream_cmd.hpp>
20 
21 namespace uhd { namespace rfnoc {
22 
31 {
32 public:
33  static const std::string ALL_LOS;
34  static const std::string ALL_GAINS;
35  static constexpr size_t ALL_CHANS = size_t(~0);
36 
38 
39  /**************************************************************************
40  * Rate-Related API Calls
41  *************************************************************************/
43  //
44  // This function will coerce the rate and return the actual, current value.
45  virtual double set_rate(const double rate) = 0;
46 
48  virtual double get_rate() const = 0;
49 
51  virtual uhd::meta_range_t get_rate_range() const = 0;
52 
54  //
55  // Some radios may operate on multiple samples per clock cycle, usually in
56  // order to handle large bandwidths without requiring very fast FPGA clock
57  // rates.
58  //
59  // When the SPC value is greater than one, certain API calls may behave
60  // slightly differently. This is most relevant for issue_stream_cmd(). Other
61  // commands may round their execution time to the next integer multiple of
62  // SPC as well.
63  //
64  // Ultimately, the exact impact of SPC is device-dependent.
65  virtual size_t get_spc() const = 0;
66 
67  /**************************************************************************
68  * RF-Related API Calls
69  *************************************************************************/
72  virtual std::vector<std::string> get_tx_gain_profile_names(
73  const size_t chan) const = 0;
74 
77  virtual std::vector<std::string> get_rx_gain_profile_names(
78  const size_t chan) const = 0;
79 
82  virtual void set_tx_gain_profile(const std::string& profile, const size_t chan) = 0;
83 
86  virtual void set_rx_gain_profile(const std::string& profile, const size_t chan) = 0;
87 
90  virtual std::string get_tx_gain_profile(const size_t chan) const = 0;
91 
94  virtual std::string get_rx_gain_profile(const size_t chan) const = 0;
95 
96  /**************************************************************************
97  * Calibration-Related API Calls
98  *************************************************************************/
106  virtual void set_tx_dc_offset(const std::complex<double>& offset, size_t chan) = 0;
107 
112  virtual meta_range_t get_tx_dc_offset_range(size_t chan) const = 0;
113 
121  virtual void set_tx_iq_balance(
122  const std::complex<double>& correction, size_t chan) = 0;
123 
135  virtual void set_rx_dc_offset(const bool enb, size_t chan = ALL_CHANS) = 0;
136 
144  virtual void set_rx_dc_offset(const std::complex<double>& offset, size_t chan) = 0;
145 
150  virtual meta_range_t get_rx_dc_offset_range(size_t chan) const = 0;
151 
157  virtual void set_rx_iq_balance(const bool enb, size_t chan) = 0;
158 
164  virtual void set_rx_iq_balance(
165  const std::complex<double>& correction, size_t chan) = 0;
166 
167  /**************************************************************************
168  * GPIO Controls
169  *************************************************************************/
174  virtual std::vector<std::string> get_gpio_banks() const = 0;
175 
190  virtual void set_gpio_attr(
191  const std::string& bank, const std::string& attr, const uint32_t value) = 0;
192 
208  virtual uint32_t get_gpio_attr(const std::string& bank, const std::string& attr) = 0;
209 
210  /**************************************************************************
211  * Sensor API
212  *************************************************************************/
217  virtual std::vector<std::string> get_rx_sensor_names(size_t chan) const = 0;
218 
225  virtual uhd::sensor_value_t get_rx_sensor(const std::string& name, size_t chan) = 0;
226 
231  virtual std::vector<std::string> get_tx_sensor_names(size_t chan) const = 0;
232 
239  virtual uhd::sensor_value_t get_tx_sensor(const std::string& name, size_t chan) = 0;
240 
241  /**************************************************************************
242  * Streaming-Related API Calls
243  *************************************************************************/
258  virtual void issue_stream_cmd(
259  const uhd::stream_cmd_t& stream_cmd, const size_t port) = 0;
260 
263  virtual void enable_rx_timestamps(const bool enable, const size_t chan) = 0;
264 
265  /**************************************************************************
266  * Radio Identification API Calls
267  *************************************************************************/
269  virtual std::string get_slot_name() const = 0;
270 
272  //
273  // Example: "0" -> 0 (for UBX), or "A" -> 0 (for E310)
274  virtual size_t get_chan_from_dboard_fe(
275  const std::string& fe, const uhd::direction_t direction) const = 0;
276 
278  //
279  // Example: 0 -> "0" (for UBX), or 0 -> "A" (for E310)
280  virtual std::string get_dboard_fe_from_chan(
281  const size_t chan, const uhd::direction_t direction) const = 0;
282 
284  virtual std::string get_fe_name(
285  const size_t chan, const uhd::direction_t direction) const = 0;
286 
287  /**************************************************************************
288  * EEPROM API Calls
289  *************************************************************************/
291  //
292  // Note: EEPROMs have finite numbers of write cycles, so don't overuse this
293  // method!
294  virtual void set_db_eeprom(const uhd::eeprom_map_t& db_eeprom) = 0;
295 
298 };
299 
300 }} // namespace uhd::rfnoc
Definition: discoverable_feature_getter_iface.hpp:18
Definition: noc_block_base.hpp:42
Definition: radio_control.hpp:31
virtual std::vector< std::string > get_gpio_banks() const =0
virtual std::string get_dboard_fe_from_chan(const size_t chan, const uhd::direction_t direction) const =0
Return the frontend name for a channel index.
virtual uint32_t get_gpio_attr(const std::string &bank, const std::string &attr)=0
virtual meta_range_t get_rx_dc_offset_range(size_t chan) const =0
virtual void set_tx_dc_offset(const std::complex< double > &offset, size_t chan)=0
virtual std::string get_slot_name() const =0
Returns this radio's slot name (typically "A" or "B")
virtual void issue_stream_cmd(const uhd::stream_cmd_t &stream_cmd, const size_t port)=0
virtual void set_rx_iq_balance(const bool enb, size_t chan)=0
static const std::string ALL_LOS
Definition: radio_control.hpp:33
virtual std::vector< std::string > get_tx_gain_profile_names(const size_t chan) const =0
virtual void enable_rx_timestamps(const bool enable, const size_t chan)=0
virtual void set_db_eeprom(const uhd::eeprom_map_t &db_eeprom)=0
Update the daughterboard EEPROM.
virtual uhd::eeprom_map_t get_db_eeprom()=0
Return the content of the daughterboard EEPROM.
virtual uhd::meta_range_t get_rate_range() const =0
Return a list of valid rates.
virtual double get_rate() const =0
Get the sample rate.
virtual void set_tx_iq_balance(const std::complex< double > &correction, size_t chan)=0
virtual double set_rate(const double rate)=0
Set the sample rate.
virtual void set_rx_dc_offset(const bool enb, size_t chan=ALL_CHANS)=0
virtual uhd::sensor_value_t get_rx_sensor(const std::string &name, size_t chan)=0
virtual meta_range_t get_tx_dc_offset_range(size_t chan) const =0
virtual void set_rx_gain_profile(const std::string &profile, const size_t chan)=0
virtual std::string get_tx_gain_profile(const size_t chan) const =0
static const std::string ALL_GAINS
Definition: radio_control.hpp:34
virtual std::vector< std::string > get_rx_gain_profile_names(const size_t chan) const =0
static constexpr size_t ALL_CHANS
Definition: radio_control.hpp:35
virtual std::vector< std::string > get_rx_sensor_names(size_t chan) const =0
virtual void set_gpio_attr(const std::string &bank, const std::string &attr, const uint32_t value)=0
virtual void set_tx_gain_profile(const std::string &profile, const size_t chan)=0
virtual std::vector< std::string > get_tx_sensor_names(size_t chan) const =0
virtual size_t get_spc() const =0
Return the samples per clock (SPC) value of this radio.
virtual std::string get_fe_name(const size_t chan, const uhd::direction_t direction) const =0
Return the name of the frontend, as given by the dboard driver.
virtual size_t get_chan_from_dboard_fe(const std::string &fe, const uhd::direction_t direction) const =0
Return the channel that corresponds to a frontend's name.
virtual uhd::sensor_value_t get_tx_sensor(const std::string &name, size_t chan)=0
virtual std::string get_rx_gain_profile(const size_t chan) const =0
Definition: core_iface.hpp:25
Definition: power_reference_iface.hpp:23
Definition: build_info.hpp:12
direction_t
Definition: direction.hpp:12
std::map< std::string, std::vector< uint8_t > > eeprom_map_t
Definition: eeprom.hpp:15
#define RFNOC_DECLARE_BLOCK(CLASS_NAME)
Definition: noc_block_base.hpp:21
Definition: ranges.hpp:66
Definition: sensors.hpp:29
Definition: stream_cmd.hpp:40