usrp: basically working iq cal on tx

8 files changed, 266 insertions, 0 deletions

diff --git a/host/lib/usrp/common/CMakeLists.txt b/host/lib/usrp/common/CMakeLists.txt
index ec8b60fec..9abd34afa 100644
--- a/host/lib/usrp/common/CMakeLists.txt
+++ b/host/lib/usrp/common/CMakeLists.txt
@@ -29,6 +29,7 @@ ENDIF(ENABLE_USB)
 INCLUDE_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR})
 
 LIBUHD_APPEND_SOURCES(
+    ${CMAKE_CURRENT_SOURCE_DIR}/apply_corrections.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/validate_subdev_spec.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/recv_packet_demuxer.cpp
 )
diff --git a/host/lib/usrp/common/apply_corrections.cpp b/host/lib/usrp/common/apply_corrections.cpp
new file mode 100644
index 000000000..95036e386
--- /dev/null
+++ b/host/lib/usrp/common/apply_corrections.cpp
@@ -0,0 +1,136 @@
+//
+// Copyright 2011 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/>.
+//
+
+#include "apply_corrections.hpp"
+#include <uhd/usrp/dboard_eeprom.hpp>
+#include <uhd/utils/paths.hpp>
+#include <uhd/utils/msg.hpp>
+#include <uhd/utils/csv.hpp>
+#include <uhd/types/dict.hpp>
+#include <boost/filesystem.hpp>
+#include <boost/foreach.hpp>
+#include <cstdio>
+#include <complex>
+#include <fstream>
+
+namespace fs = boost::filesystem;
+
+struct tx_fe_cal_t{
+    double tx_lo_freq;
+    double iq_corr_real;
+    double iq_corr_imag;
+};
+
+static bool tx_fe_cal_comp(tx_fe_cal_t a, tx_fe_cal_t b){
+    return (a.tx_lo_freq < b.tx_lo_freq);
+}
+
+//TODO should lock access to this
+static uhd::dict<std::string, std::vector<tx_fe_cal_t> > cache;
+
+static double linear_interp(double x, double x0, double y0, double x1, double y1){
+    return y0 + (x - x0)*(y1 - y0)/(x1 - x0);
+}
+
+static std::complex<double> get_tx_fe_iq_correction(
+    const std::string &key, const double tx_lo_freq
+){
+    const std::vector<tx_fe_cal_t> &datas = cache[key];
+
+    //search for lo freq
+    size_t lo_index = 0;
+    size_t hi_index = datas.size()-1;
+    for (size_t i = 0; i < datas.size(); i++){
+        if (datas[i].tx_lo_freq > tx_lo_freq){
+            hi_index = i;
+            break;
+        }
+        lo_index = i;
+    }
+
+    if (lo_index == 0) return std::complex<double>(datas[lo_index].iq_corr_real, datas[lo_index].iq_corr_imag);
+    if (hi_index == lo_index) return std::complex<double>(datas[hi_index].iq_corr_real, datas[hi_index].iq_corr_imag);
+
+    //interpolation time
+    return std::complex<double>(
+        linear_interp(tx_lo_freq, datas[lo_index].tx_lo_freq, datas[lo_index].iq_corr_real, datas[hi_index].tx_lo_freq, datas[hi_index].iq_corr_real),
+        linear_interp(tx_lo_freq, datas[lo_index].tx_lo_freq, datas[lo_index].iq_corr_imag, datas[hi_index].tx_lo_freq, datas[hi_index].iq_corr_imag)
+    );
+}
+
+static void _apply_tx_fe_corrections(
+    uhd::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
+){
+    //path constants
+    const uhd::fs_path tx_db_path = "dboards/" + slot + "/tx_eeprom";
+    const uhd::fs_path tx_fe_path = "tx_frontends/" + slot + "/iq_balance/value";
+
+    //extract eeprom serial
+    const uhd::usrp::dboard_eeprom_t db_eeprom = sub_tree->access<uhd::usrp::dboard_eeprom_t>(tx_db_path).get();
+
+    //make the calibration file path
+    const fs::path cal_data_path = fs::path(uhd::get_app_path()) / ".uhd" / "cal" / ("tx_fe_cal_v0.1_" + db_eeprom.serial + ".csv");
+    if (not fs::exists(cal_data_path)) return;
+
+    //parse csv file or get from cache
+    if (not cache.has_key(cal_data_path.string())){
+        std::ifstream cal_data(cal_data_path.string().c_str());
+        const uhd::csv::rows_type rows = uhd::csv::to_rows(cal_data);
+
+        bool read_data = false, skip_next = false;;
+        std::vector<tx_fe_cal_t> datas;
+        BOOST_FOREACH(const uhd::csv::row_type &row, rows){
+            if (not read_data and not row.empty() and row[0] == "DATA STARTS HERE"){
+                read_data = true;
+                skip_next = true;
+                continue;
+            }
+            if (not read_data) continue;
+            if (skip_next){
+                skip_next = false;
+                continue;
+            }
+            tx_fe_cal_t data;
+            std::sscanf(row[0].c_str(), "%lf" , &data.tx_lo_freq);
+            std::sscanf(row[1].c_str(), "%lf" , &data.iq_corr_real);
+            std::sscanf(row[2].c_str(), "%lf" , &data.iq_corr_imag);
+            datas.push_back(data);
+        }
+        std::sort(datas.begin(), datas.end(), tx_fe_cal_comp);
+        cache[cal_data_path.string()] = datas;
+        UHD_MSG(status) << "Loaded " << cal_data_path.string() << std::endl;
+
+    }
+
+    sub_tree->access<std::complex<double> >(tx_fe_path)
+        .set(get_tx_fe_iq_correction(cal_data_path.string(), tx_lo_freq));
+}
+
+void uhd::usrp::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
+){
+    try{
+        _apply_tx_fe_corrections(sub_tree, slot, tx_lo_freq);
+    }
+    catch(const std::exception &e){
+        UHD_MSG(error) << "Failure in apply_tx_fe_corrections: " << e.what() << std::endl;
+    }
+}
diff --git a/host/lib/usrp/common/apply_corrections.hpp b/host/lib/usrp/common/apply_corrections.hpp
new file mode 100644
index 000000000..8aabab636
--- /dev/null
+++ b/host/lib/usrp/common/apply_corrections.hpp
@@ -0,0 +1,35 @@
+//
+// Copyright 2011 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_USRP_COMMON_APPLY_CORRECTIONS_HPP
+#define INCLUDED_LIBUHD_USRP_COMMON_APPLY_CORRECTIONS_HPP
+
+#include <uhd/config.hpp>
+#include <uhd/property_tree.hpp>
+#include <string>
+
+namespace uhd{ namespace usrp{
+
+    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
+    );
+
+}} //namespace uhd::usrp
+
+#endif /* INCLUDED_LIBUHD_USRP_COMMON_APPLY_CORRECTIONS_HPP */
diff --git a/host/lib/usrp/usrp2/usrp2_impl.cpp b/host/lib/usrp/usrp2/usrp2_impl.cpp
index bb3bfc7e4..6170948ca 100644
--- a/host/lib/usrp/usrp2/usrp2_impl.cpp
+++ b/host/lib/usrp/usrp2/usrp2_impl.cpp
@@ -17,6 +17,7 @@
 
 #include "usrp2_impl.hpp"
 #include "fw_common.h"
+#include "apply_corrections.hpp"
 #include <uhd/utils/log.hpp>
 #include <uhd/utils/msg.hpp>
 #include <uhd/exception.hpp>
@@ -600,6 +601,13 @@ usrp2_impl::usrp2_impl(const device_addr_t &_device_addr){
             rx_db_eeprom.id, tx_db_eeprom.id, gdb_eeprom.id,
             _mbc[mb].dboard_iface, _tree->subtree(mb_path / "dboards/A")
         );
+
+        //bind frontend corrections to the dboard freq props
+        const fs_path db_tx_fe_path = mb_path / "dboards" / "A" / "tx_frontends";
+        BOOST_FOREACH(const std::string &name, _tree->list(db_tx_fe_path)){
+            _tree->access<double>(db_tx_fe_path / name / "freq" / "value")
+                .subscribe(boost::bind(&usrp2_impl::set_tx_fe_corrections, this, mb, _1));
+        }
     }
 
     //initialize io handling
@@ -653,6 +661,10 @@ sensor_value_t usrp2_impl::get_ref_locked(const std::string &mb){
     return sensor_value_t("Ref", lock, "locked", "unlocked");
 }
 
+void usrp2_impl::set_tx_fe_corrections(const std::string &mb, const double tx_lo_freq){
+    apply_tx_fe_corrections(this->get_tree()->subtree("/mboards/" + mb), "A", tx_lo_freq);
+}
+
 #include <boost/math/special_functions/round.hpp>
 #include <boost/math/special_functions/sign.hpp>
 
diff --git a/host/lib/usrp/usrp2/usrp2_impl.hpp b/host/lib/usrp/usrp2/usrp2_impl.hpp
index 535397d84..74ef3d460 100644
--- a/host/lib/usrp/usrp2/usrp2_impl.hpp
+++ b/host/lib/usrp/usrp2/usrp2_impl.hpp
@@ -106,6 +106,8 @@ private:
     uhd::sensor_value_t get_mimo_locked(const std::string &);
     uhd::sensor_value_t get_ref_locked(const std::string &);
 
+    void set_tx_fe_corrections(const std::string &mb, const double tx_lo_freq);
+
     //device properties interface
     uhd::property_tree::sptr get_tree(void) const{
         return _tree;
diff --git a/host/lib/utils/CMakeLists.txt b/host/lib/utils/CMakeLists.txt
index 19dde9a56..b50e91299 100644
--- a/host/lib/utils/CMakeLists.txt
+++ b/host/lib/utils/CMakeLists.txt
@@ -128,6 +128,7 @@ SET_SOURCE_FILES_PROPERTIES(
 # Append sources
 ########################################################################
 LIBUHD_APPEND_SOURCES(
+    ${CMAKE_CURRENT_SOURCE_DIR}/csv.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/gain_group.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/images.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/load_modules.cpp
diff --git a/host/lib/utils/csv.cpp b/host/lib/utils/csv.cpp
new file mode 100644
index 000000000..2ffa70196
--- /dev/null
+++ b/host/lib/utils/csv.cpp
@@ -0,0 +1,52 @@
+//
+// Copyright 2011 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/>.
+//
+
+#include <uhd/utils/csv.hpp>
+#include <boost/foreach.hpp>
+
+using namespace uhd;
+
+csv::rows_type csv::to_rows(std::istream &input){
+    csv::rows_type rows;
+    std::string line;
+    //for each line in the input stream
+    while (std::getline(input, line)){
+        csv::row_type row(1, "");
+        bool in_quote = false;
+        char last_ch, next_ch = ' ';
+        //for each character in the line
+        BOOST_FOREACH(char ch, line){
+            last_ch = next_ch;
+            next_ch = ch;
+            //catch a quote character and change the state
+            //we handle double quotes by checking last_ch
+            if (ch == '"'){
+                in_quote = not in_quote;
+                if (last_ch != '"') continue;
+            }
+            //a comma not inside quotes is a column delimiter
+            if (not in_quote and ch == ','){
+                row.push_back("");
+                continue;
+            }
+            //if we got here we record the character
+            row.back() += ch;
+        }
+        rows.push_back(row);
+    }
+    return rows;
+}
diff --git a/host/lib/utils/paths.cpp b/host/lib/utils/paths.cpp
index a3dd377e5..4fc877d5d 100644
--- a/host/lib/utils/paths.cpp
+++ b/host/lib/utils/paths.cpp
@@ -16,6 +16,7 @@
 //
 
 #include <uhd/config.hpp>
+#include <uhd/utils/paths.hpp>
 #include <boost/tokenizer.hpp>
 #include <boost/filesystem.hpp>
 #include <boost/foreach.hpp>
@@ -23,6 +24,8 @@
 #include <cstdlib>
 #include <string>
 #include <vector>
+#include <cstdlib> //getenv
+#include <cstdio>  //P_tmpdir
 
 namespace fs = boost::filesystem;
 
@@ -79,3 +82,27 @@ std::vector<fs::path> get_module_paths(void){
     paths.push_back(get_uhd_pkg_data_path() / "modules");
     return paths;
 }
+
+/***********************************************************************
+ * Implement the functions in paths.hpp
+ **********************************************************************/
+std::string uhd::get_tmp_path(void){
+    const char *tmp_path = std::getenv("TMP");
+    if (tmp_path != NULL) return tmp_path;
+
+    #ifdef P_tmpdir
+    if (P_tmpdir != NULL) return P_tmpdir;
+    #endif
+
+    return "/tmp";
+}
+
+std::string uhd::get_app_path(void){
+    const char *appdata_path = std::getenv("APPDATA");
+    if (appdata_path != NULL) return appdata_path;
+
+    const char *home_path = std::getenv("HOME");
+    if (home_path != NULL) return home_path;
+
+    return uhd::get_tmp_path();
+}