USRP Hardware Driver and USRP Manual  Version: 4.1.0.0-201-gb49e4f1eb
UHD and USRP Manual
multi_usrp.hpp
Go to the documentation of this file.
1 //
2 // Copyright 2010-2012,2014-2015 Ettus Research LLC
3 // Copyright 2018 Ettus Research, a National Instruments Company
4 //
5 // SPDX-License-Identifier: GPL-3.0-or-later
6 //
7 
8 #pragma once
9 
10 // define API capabilities for compile time detection of new features
11 #define UHD_USRP_MULTI_USRP_REF_SOURCES_API
12 #define UHD_USRP_MULTI_USRP_GET_RATES_API
13 #define UHD_USRP_MULTI_USRP_FRONTEND_CAL_API
14 #define UHD_USRP_MULTI_USRP_FRONTEND_IQ_AUTO_API
15 #define UHD_USRP_MULTI_USRP_COMMAND_TIME_API
16 #define UHD_USRP_MULTI_USRP_BW_RANGE_API
17 #define UHD_USRP_MULTI_USRP_USER_REGS_API
18 #define UHD_USRP_MULTI_USRP_GET_USRP_INFO_API
19 #define UHD_USRP_MULTI_USRP_NORMALIZED_GAIN
20 #define UHD_USRP_MULTI_USRP_GPIO_API
21 #define UHD_USRP_MULTI_USRP_REGISTER_API
22 #define UHD_USRP_MULTI_USRP_FILTER_API
23 #define UHD_USRP_MULTI_USRP_LO_CONFIG_API
24 #define UHD_USRP_MULTI_USRP_TX_LO_CONFIG_API
25 #define UHD_USRP_MULTI_USRP_POWER_LEVEL
26 
27 #include <uhd/config.hpp>
28 #include <uhd/device.hpp>
31 #include <uhd/types/filters.hpp>
32 #include <uhd/types/ranges.hpp>
33 #include <uhd/types/sensors.hpp>
34 #include <uhd/types/stream_cmd.hpp>
37 #include <uhd/types/wb_iface.hpp>
39 #include <uhd/usrp/subdev_spec.hpp>
41 #include <complex>
42 #include <memory>
43 #include <string>
44 #include <vector>
45 
46 namespace uhd { namespace usrp {
47 
95 {
96 public:
97  typedef std::shared_ptr<multi_usrp> sptr;
98 
99  virtual ~multi_usrp(void) = 0;
100 
102  static const size_t ALL_MBOARDS;
103 
105  static const size_t ALL_CHANS;
106 
108  static const std::string ALL_GAINS;
109 
111  static const std::string ALL_LOS;
112 
120  static sptr make(const device_addr_t& dev_addr);
121 
136  virtual device::sptr get_device(void) = 0;
137 
140  virtual uhd::property_tree::sptr get_tree(void) const = 0;
141 
143  virtual rx_streamer::sptr get_rx_stream(const stream_args_t& args) = 0;
144 
146  virtual tx_streamer::sptr get_tx_stream(const stream_args_t& args) = 0;
147 
155  virtual dict<std::string, std::string> get_usrp_rx_info(size_t chan = 0) = 0;
156 
164  virtual dict<std::string, std::string> get_usrp_tx_info(size_t chan = 0) = 0;
165 
166  /*******************************************************************
167  * Mboard methods
168  ******************************************************************/
169 
192  virtual void set_master_clock_rate(double rate, size_t mboard = ALL_MBOARDS) = 0;
193 
199  virtual double get_master_clock_rate(size_t mboard = 0) = 0;
200 
219  virtual meta_range_t get_master_clock_rate_range(const size_t mboard = 0) = 0;
220 
225  virtual std::string get_pp_string(void) = 0;
226 
232  virtual std::string get_mboard_name(size_t mboard = 0) = 0;
233 
239  virtual time_spec_t get_time_now(size_t mboard = 0) = 0;
240 
246  virtual time_spec_t get_time_last_pps(size_t mboard = 0) = 0;
247 
259  virtual void set_time_now(
260  const time_spec_t& time_spec, size_t mboard = ALL_MBOARDS) = 0;
261 
274  virtual void set_time_next_pps(
275  const time_spec_t& time_spec, size_t mboard = ALL_MBOARDS) = 0;
276 
292  virtual void set_time_unknown_pps(const time_spec_t& time_spec) = 0;
293 
300  virtual bool get_time_synchronized(void) = 0;
301 
312  virtual void set_command_time(
313  const uhd::time_spec_t& time_spec, size_t mboard = ALL_MBOARDS) = 0;
314 
320  virtual void clear_command_time(size_t mboard = ALL_MBOARDS) = 0;
321 
334  virtual void issue_stream_cmd(
335  const stream_cmd_t& stream_cmd, size_t chan = ALL_CHANS) = 0;
336 
379  virtual void set_time_source(
380  const std::string& source, const size_t mboard = ALL_MBOARDS) = 0;
381 
387  virtual std::string get_time_source(const size_t mboard) = 0;
388 
394  virtual std::vector<std::string> get_time_sources(const size_t mboard) = 0;
395 
438  virtual void set_clock_source(
439  const std::string& source, const size_t mboard = ALL_MBOARDS) = 0;
440 
446  virtual std::string get_clock_source(const size_t mboard) = 0;
447 
453  virtual std::vector<std::string> get_clock_sources(const size_t mboard) = 0;
454 
465  virtual void set_sync_source(const std::string& clock_source,
466  const std::string& time_source,
467  const size_t mboard = ALL_MBOARDS) = 0;
468 
491  virtual void set_sync_source(
492  const device_addr_t& sync_source, const size_t mboard = ALL_MBOARDS) = 0;
493 
499  virtual device_addr_t get_sync_source(const size_t mboard) = 0;
500 
506  virtual std::vector<device_addr_t> get_sync_sources(const size_t mboard) = 0;
507 
522  virtual void set_clock_source_out(
523  const bool enb, const size_t mboard = ALL_MBOARDS) = 0;
524 
539  virtual void set_time_source_out(
540  const bool enb, const size_t mboard = ALL_MBOARDS) = 0;
541 
545  virtual size_t get_num_mboards(void) = 0;
546 
553  virtual sensor_value_t get_mboard_sensor(
554  const std::string& name, size_t mboard = 0) = 0;
555 
561  virtual std::vector<std::string> get_mboard_sensor_names(size_t mboard = 0) = 0;
562 
572  virtual void set_user_register(
573  const uint8_t addr, const uint32_t data, size_t mboard = ALL_MBOARDS) = 0;
574 
599  virtual uhd::wb_iface::sptr get_user_settings_iface(const size_t chan = 0) = 0;
600 
618  virtual uhd::rfnoc::radio_control& get_radio_control(const size_t chan = 0) = 0;
619 
620  /*******************************************************************
621  * RX methods
622  ******************************************************************/
633  virtual void set_rx_subdev_spec(
634  const uhd::usrp::subdev_spec_t& spec, size_t mboard = ALL_MBOARDS) = 0;
635 
641  virtual uhd::usrp::subdev_spec_t get_rx_subdev_spec(size_t mboard = 0) = 0;
642 
648  virtual size_t get_rx_num_channels(void) = 0;
649 
655  virtual std::string get_rx_subdev_name(size_t chan = 0) = 0;
656 
666  virtual void set_rx_rate(double rate, size_t chan = ALL_CHANS) = 0;
667 
677  virtual void set_rx_spp(const size_t spp, const size_t chan = ALL_CHANS) = 0;
678 
684  virtual double get_rx_rate(size_t chan = 0) = 0;
685 
691  virtual meta_range_t get_rx_rates(size_t chan = 0) = 0;
692 
703  virtual tune_result_t set_rx_freq(
704  const tune_request_t& tune_request, size_t chan = 0) = 0;
705 
711  virtual double get_rx_freq(size_t chan = 0) = 0;
712 
722  virtual freq_range_t get_rx_freq_range(size_t chan = 0) = 0;
723 
729  virtual freq_range_t get_fe_rx_freq_range(size_t chan = 0) = 0;
730 
731  /**************************************************************************
732  * LO controls
733  *************************************************************************/
747  virtual std::vector<std::string> get_rx_lo_names(size_t chan = 0) = 0;
748 
767  virtual void set_rx_lo_source(
768  const std::string& src, const std::string& name = ALL_LOS, size_t chan = 0) = 0;
769 
778  virtual const std::string get_rx_lo_source(
779  const std::string& name = ALL_LOS, size_t chan = 0) = 0;
780 
793  virtual std::vector<std::string> get_rx_lo_sources(
794  const std::string& name = ALL_LOS, size_t chan = 0) = 0;
795 
806  virtual void set_rx_lo_export_enabled(
807  bool enabled, const std::string& name = ALL_LOS, size_t chan = 0) = 0;
808 
814  virtual bool get_rx_lo_export_enabled(
815  const std::string& name = ALL_LOS, size_t chan = 0) = 0;
816 
841  virtual double set_rx_lo_freq(
842  double freq, const std::string& name, size_t chan = 0) = 0;
843 
854  virtual double get_rx_lo_freq(const std::string& name, size_t chan = 0) = 0;
855 
865  virtual freq_range_t get_rx_lo_freq_range(
866  const std::string& name, size_t chan = 0) = 0;
867 
880  virtual std::vector<std::string> get_tx_lo_names(size_t chan = 0) = 0;
881 
897  virtual void set_tx_lo_source(const std::string& src,
898  const std::string& name = ALL_LOS,
899  const size_t chan = 0) = 0;
900 
909  virtual const std::string get_tx_lo_source(
910  const std::string& name = ALL_LOS, const size_t chan = 0) = 0;
911 
922  virtual std::vector<std::string> get_tx_lo_sources(
923  const std::string& name = ALL_LOS, const size_t chan = 0) = 0;
924 
935  virtual void set_tx_lo_export_enabled(
936  const bool enabled, const std::string& name = ALL_LOS, const size_t chan = 0) = 0;
937 
943  virtual bool get_tx_lo_export_enabled(
944  const std::string& name = ALL_LOS, const size_t chan = 0) = 0;
945 
970  virtual double set_tx_lo_freq(
971  const double freq, const std::string& name, const size_t chan = 0) = 0;
972 
983  virtual double get_tx_lo_freq(const std::string& name, const size_t chan = 0) = 0;
984 
994  virtual freq_range_t get_tx_lo_freq_range(
995  const std::string& name, const size_t chan = 0) = 0;
996 
997  /**************************************************************************
998  * Gain controls
999  *************************************************************************/
1013  virtual void set_rx_gain(double gain, const std::string& name, size_t chan = 0) = 0;
1014 
1027  virtual std::vector<std::string> get_rx_gain_profile_names(const size_t chan = 0) = 0;
1028 
1037  virtual void set_rx_gain_profile(
1038  const std::string& profile, const size_t chan = 0) = 0;
1039 
1045  virtual std::string get_rx_gain_profile(const size_t chan = 0) = 0;
1046 
1048  void set_rx_gain(double gain, size_t chan = 0)
1049  {
1050  return this->set_rx_gain(gain, ALL_GAINS, chan);
1051  }
1052 
1070  virtual void set_normalized_rx_gain(double gain, size_t chan = 0) = 0;
1071 
1089  virtual void set_rx_agc(bool enable, size_t chan = 0) = 0;
1090 
1098  virtual double get_rx_gain(const std::string& name, size_t chan = 0) = 0;
1099 
1101  double get_rx_gain(size_t chan = 0)
1102  {
1103  return this->get_rx_gain(ALL_GAINS, chan);
1104  }
1105 
1116  virtual double get_normalized_rx_gain(size_t chan = 0) = 0;
1117 
1125  virtual gain_range_t get_rx_gain_range(const std::string& name, size_t chan = 0) = 0;
1126 
1129  {
1130  return this->get_rx_gain_range(ALL_GAINS, chan);
1131  }
1132 
1139  virtual std::vector<std::string> get_rx_gain_names(size_t chan = 0) = 0;
1140 
1149  virtual void set_rx_antenna(const std::string& ant, size_t chan = 0) = 0;
1150 
1156  virtual std::string get_rx_antenna(size_t chan = 0) = 0;
1157 
1163  virtual std::vector<std::string> get_rx_antennas(size_t chan = 0) = 0;
1164 
1174  virtual void set_rx_bandwidth(double bandwidth, size_t chan = 0) = 0;
1175 
1181  virtual double get_rx_bandwidth(size_t chan = 0) = 0;
1182 
1188  virtual meta_range_t get_rx_bandwidth_range(size_t chan = 0) = 0;
1189 
1197  virtual dboard_iface::sptr get_rx_dboard_iface(size_t chan = 0) = 0;
1198 
1205  virtual sensor_value_t get_rx_sensor(const std::string& name, size_t chan = 0) = 0;
1206 
1212  virtual std::vector<std::string> get_rx_sensor_names(size_t chan = 0) = 0;
1213 
1226  virtual void set_rx_dc_offset(const bool enb, size_t chan = ALL_CHANS) = 0;
1227 
1235  virtual void set_rx_dc_offset(
1236  const std::complex<double>& offset, size_t chan = ALL_CHANS) = 0;
1237 
1242  virtual meta_range_t get_rx_dc_offset_range(size_t chan = 0) = 0;
1243 
1250  virtual void set_rx_iq_balance(const bool enb, size_t chan) = 0;
1251 
1259  virtual void set_rx_iq_balance(
1260  const std::complex<double>& correction, size_t chan = ALL_CHANS) = 0;
1261 
1262 
1263  /**************************************************************************
1264  * Power level controls
1265  *************************************************************************/
1282  virtual bool has_rx_power_reference(const size_t chan = 0) = 0;
1283 
1298  virtual void set_rx_power_reference(
1299  const double power_dbm, const size_t chan = 0) = 0;
1300 
1313  virtual double get_rx_power_reference(const size_t chan = 0) = 0;
1314 
1324  virtual meta_range_t get_rx_power_range(const size_t chan) = 0;
1325 
1326  /*******************************************************************
1327  * TX methods
1328  ******************************************************************/
1338  virtual void set_tx_subdev_spec(
1339  const uhd::usrp::subdev_spec_t& spec, size_t mboard = ALL_MBOARDS) = 0;
1340 
1346  virtual uhd::usrp::subdev_spec_t get_tx_subdev_spec(size_t mboard = 0) = 0;
1347 
1353  virtual size_t get_tx_num_channels(void) = 0;
1354 
1360  virtual std::string get_tx_subdev_name(size_t chan = 0) = 0;
1361 
1371  virtual void set_tx_rate(double rate, size_t chan = ALL_CHANS) = 0;
1372 
1378  virtual double get_tx_rate(size_t chan = 0) = 0;
1379 
1385  virtual meta_range_t get_tx_rates(size_t chan = 0) = 0;
1386 
1397  virtual tune_result_t set_tx_freq(
1398  const tune_request_t& tune_request, size_t chan = 0) = 0;
1399 
1405  virtual double get_tx_freq(size_t chan = 0) = 0;
1406 
1416  virtual freq_range_t get_tx_freq_range(size_t chan = 0) = 0;
1417 
1423  virtual freq_range_t get_fe_tx_freq_range(size_t chan = 0) = 0;
1424 
1438  virtual void set_tx_gain(double gain, const std::string& name, size_t chan = 0) = 0;
1439 
1452  virtual std::vector<std::string> get_tx_gain_profile_names(const size_t chan = 0) = 0;
1453 
1462  virtual void set_tx_gain_profile(
1463  const std::string& profile, const size_t chan = 0) = 0;
1464 
1470  virtual std::string get_tx_gain_profile(const size_t chan = 0) = 0;
1471 
1473  void set_tx_gain(double gain, size_t chan = 0)
1474  {
1475  return this->set_tx_gain(gain, ALL_GAINS, chan);
1476  }
1477 
1490  virtual void set_normalized_tx_gain(double gain, size_t chan = 0) = 0;
1491 
1499  virtual double get_tx_gain(const std::string& name, size_t chan = 0) = 0;
1500 
1502  double get_tx_gain(size_t chan = 0)
1503  {
1504  return this->get_tx_gain(ALL_GAINS, chan);
1505  }
1506 
1517  virtual double get_normalized_tx_gain(size_t chan = 0) = 0;
1518 
1526  virtual gain_range_t get_tx_gain_range(const std::string& name, size_t chan = 0) = 0;
1527 
1530  {
1531  return this->get_tx_gain_range(ALL_GAINS, chan);
1532  }
1533 
1540  virtual std::vector<std::string> get_tx_gain_names(size_t chan = 0) = 0;
1541 
1542  /**************************************************************************
1543  * Power level controls
1544  *************************************************************************/
1561  virtual bool has_tx_power_reference(const size_t chan = 0) = 0;
1562 
1577  virtual void set_tx_power_reference(
1578  const double power_dbm, const size_t chan = 0) = 0;
1579 
1592  virtual double get_tx_power_reference(const size_t chan = 0) = 0;
1593 
1603  virtual meta_range_t get_tx_power_range(const size_t chan) = 0;
1604 
1613  virtual void set_tx_antenna(const std::string& ant, size_t chan = 0) = 0;
1614 
1620  virtual std::string get_tx_antenna(size_t chan = 0) = 0;
1621 
1627  virtual std::vector<std::string> get_tx_antennas(size_t chan = 0) = 0;
1628 
1638  virtual void set_tx_bandwidth(double bandwidth, size_t chan = 0) = 0;
1639 
1645  virtual double get_tx_bandwidth(size_t chan = 0) = 0;
1646 
1652  virtual meta_range_t get_tx_bandwidth_range(size_t chan = 0) = 0;
1653 
1661  virtual dboard_iface::sptr get_tx_dboard_iface(size_t chan = 0) = 0;
1662 
1669  virtual sensor_value_t get_tx_sensor(const std::string& name, size_t chan = 0) = 0;
1670 
1676  virtual std::vector<std::string> get_tx_sensor_names(size_t chan = 0) = 0;
1677 
1684  virtual void set_tx_dc_offset(
1685  const std::complex<double>& offset, size_t chan = ALL_CHANS) = 0;
1686 
1691  virtual meta_range_t get_tx_dc_offset_range(size_t chan = 0) = 0;
1692 
1700  virtual void set_tx_iq_balance(
1701  const std::complex<double>& correction, size_t chan = ALL_CHANS) = 0;
1702 
1703  /*******************************************************************
1704  * GPIO methods
1705  ******************************************************************/
1706 
1712  virtual std::vector<std::string> get_gpio_banks(const size_t mboard) = 0;
1713 
1766  virtual void set_gpio_attr(const std::string& bank,
1767  const std::string& attr,
1768  const uint32_t value,
1769  const uint32_t mask = 0xffffffff,
1770  const size_t mboard = 0) = 0;
1771 
1791  virtual uint32_t get_gpio_attr(
1792  const std::string& bank, const std::string& attr, const size_t mboard = 0) = 0;
1793 
1807  virtual std::vector<std::string> get_gpio_src_banks(const size_t mboard = 0) = 0;
1808 
1819  virtual std::vector<std::string> get_gpio_srcs(
1820  const std::string& bank, const size_t mboard = 0) = 0;
1821 
1831  virtual std::vector<std::string> get_gpio_src(
1832  const std::string& bank, const size_t mboard = 0) = 0;
1833 
1848  virtual void set_gpio_src(const std::string& bank,
1849  const std::vector<std::string>& src,
1850  const size_t mboard = 0) = 0;
1851 
1852  /*******************************************************************
1853  * Filter API methods
1854  ******************************************************************/
1855  // TODO: This should be a const function, but I don't want to wrestle with the
1856  // compiler right now
1864  virtual std::vector<std::string> get_rx_filter_names(const size_t chan) = 0;
1865 
1872  virtual uhd::filter_info_base::sptr get_rx_filter(
1873  const std::string& name, const size_t chan) = 0;
1874 
1882  virtual void set_rx_filter(const std::string& name,
1884  const size_t chan) = 0;
1885 
1886  // TODO: This should be a const function, but I don't want to wrestle with the
1887  // compiler right now
1895  virtual std::vector<std::string> get_tx_filter_names(const size_t chan) = 0;
1896 
1903  virtual uhd::filter_info_base::sptr get_tx_filter(
1904  const std::string& name, const size_t chan) = 0;
1905 
1913  virtual void set_tx_filter(const std::string& name,
1915  const size_t chan) = 0;
1916 
1934  virtual uhd::rfnoc::mb_controller& get_mb_controller(const size_t mboard = 0) = 0;
1935 };
1936 
1937 }} // namespace uhd::usrp
std::shared_ptr< rx_streamer > sptr
Definition: stream.hpp:172
gain_range_t get_rx_gain_range(size_t chan=0)
A convenience wrapper for getting overall RX gain range.
Definition: multi_usrp.hpp:1128
Definition: stream_cmd.hpp:39
Definition: tune_result.hpp:18
double get_tx_gain(size_t chan=0)
A convenience wrapper for getting overall TX gain.
Definition: multi_usrp.hpp:1502
boost::noncopyable noncopyable
Definition: noncopyable.hpp:45
void set_tx_gain(double gain, size_t chan=0)
A convenience wrapper for setting overall TX gain.
Definition: multi_usrp.hpp:1473
Definition: mb_controller.hpp:25
Definition: time_spec.hpp:28
static const size_t ALL_MBOARDS
A wildcard motherboard index.
Definition: multi_usrp.hpp:102
std::shared_ptr< multi_usrp > sptr
Definition: multi_usrp.hpp:97
std::shared_ptr< device > sptr
Definition: device.hpp:29
double get_rx_gain(size_t chan=0)
A convenience wrapper for getting overall RX gain.
Definition: multi_usrp.hpp:1101
Definition: tune_request.hpp:24
static const std::string ALL_GAINS
A wildcard gain element name.
Definition: multi_usrp.hpp:108
Definition: build_info.hpp:12
Definition: sensors.hpp:28
Definition: multi_usrp.hpp:94
source
Identify the source of calibration data, i.e., where was it stored.
Definition: database.hpp:22
std::shared_ptr< dboard_iface > sptr
Definition: dboard_iface.hpp:55
Definition: stream.hpp:58
std::shared_ptr< filter_info_base > sptr
Definition: filters.hpp:26
#define UHD_API
Definition: config.h:70
UHD_INLINE data_t mask(const soft_reg_field_t field)
Definition: soft_register.hpp:86
void set_rx_gain(double gain, size_t chan=0)
A convenience wrapper for setting overall RX gain.
Definition: multi_usrp.hpp:1048
static const std::string ALL_LOS
A wildcard LO stage name.
Definition: multi_usrp.hpp:111
Definition: radio_control.hpp:27
Definition: subdev_spec.hpp:59
std::shared_ptr< tx_streamer > sptr
Definition: stream.hpp:270
Definition: ranges.hpp:65
std::shared_ptr< wb_iface > sptr
Definition: wb_iface.hpp:20
std::shared_ptr< property_tree > sptr
Definition: property_tree.hpp:216
static const size_t ALL_CHANS
A wildcard channel index.
Definition: multi_usrp.hpp:105
gain_range_t get_tx_gain_range(size_t chan=0)
A convenience wrapper for getting overall TX gain range.
Definition: multi_usrp.hpp:1529
Definition: device_addr.hpp:37