diff options
Diffstat (limited to 'host/lib/include/uhdlib/usrp/common')
| -rw-r--r-- | host/lib/include/uhdlib/usrp/common/apply_corrections.hpp | 47 |
1 files changed, 44 insertions, 3 deletions
diff --git a/host/lib/include/uhdlib/usrp/common/apply_corrections.hpp b/host/lib/include/uhdlib/usrp/common/apply_corrections.hpp index dffefffea..fb9aaa8f1 100644 --- a/host/lib/include/uhdlib/usrp/common/apply_corrections.hpp +++ b/host/lib/include/uhdlib/usrp/common/apply_corrections.hpp @@ -14,26 +14,67 @@ namespace uhd { namespace usrp { +/*! Apply TX DC offset or IQ imbalance corrections (RFNoC version) + * + * \param sub_tree Property tree object + * \param db_serial Daughterboard serial + * \param tx_fe_corr_path This is the path relative to \p sub_tree where the + * coefficients are stored. The path should end in + * `iq_balance/value` or `dc_offset/value` and be a + * complex number. + * \param tx_lo_freq The current LO frequency. Used to look up coefficients in the cal + * data set. + */ void apply_tx_fe_corrections(property_tree::sptr sub_tree, // starts at mboards/x const std::string& db_serial, const fs_path tx_fe_corr_path, const double tx_lo_freq // actual lo freq ); +/*! Apply TX DC offset or IQ imbalance corrections (Gen-2 USRP version) + * + * \param sub_tree Property tree object. It's the motherboard subtree, i.e., + * what comes after /mboards/X. + * \param slot Daughterboard slot ("A" or "B"), used to auto-detect the paths. + * \param tx_lo_freq The current LO frequency. Used to look up coefficients in the cal + * data set. + */ void apply_tx_fe_corrections(property_tree::sptr sub_tree, // starts at mboards/x const std::string& slot, // name of dboard slot const double tx_lo_freq // actual lo freq ); + +/*! Apply RX DC offset or IQ imbalance corrections (RFNoC version) + * + * \param sub_tree Property tree object + * \param db_serial Daughterboard serial + * \param tx_fe_corr_path This is the path relative to \p sub_tree where the + * coefficients are stored. The path should end in + * `iq_balance/value` or `dc_offset/value` and be a + * complex number. + * \param tx_lo_freq The current LO frequency. Used to look up coefficients in the cal + * data set. + */ void apply_rx_fe_corrections(property_tree::sptr sub_tree, // starts at mboards/x - const std::string& slot, // name of dboard slot + const std::string& db_serial, + const fs_path rx_fe_corr_path, const double rx_lo_freq // actual lo freq ); +/*! Apply RX DC offset or IQ imbalance corrections (Gen-2 USRP version) + * + * \param sub_tree Property tree object. It's the motherboard subtree, i.e., + * what comes after /mboards/X. + * \param slot Daughterboard slot ("A" or "B"), used to auto-detect the paths. + * \param rx_lo_freq The current LO frequency. Used to look up coefficients in the cal + * data set. + */ void apply_rx_fe_corrections(property_tree::sptr sub_tree, // starts at mboards/x - const std::string& db_serial, - const fs_path rx_fe_corr_path, + const std::string& slot, // name of dboard slot const double rx_lo_freq // actual lo freq ); + + }} // namespace uhd::usrp #endif /* INCLUDED_LIBUHD_USRP_COMMON_APPLY_CORRECTIONS_HPP */ |