uhd: created tune request struct and implemented more fine grained tuning calls

1 files changed, 78 insertions, 60 deletions

diff --git a/host/lib/usrp/tune_helper.cpp b/host/lib/usrp/tune_helper.cpp
index 7633c67f2..8c57cc428 100644
--- a/host/lib/usrp/tune_helper.cpp
+++ b/host/lib/usrp/tune_helper.cpp
@@ -28,55 +28,97 @@ using namespace uhd::usrp;
 /***********************************************************************
  * Tune Helper Functions
  **********************************************************************/
-static tune_result_t tune_xx_subdev_and_dxc(
+static tune_result_t tune_xx_subdev_and_dsp(
     dboard_iface::unit_t unit,
-    wax::obj subdev, wax::obj dxc, size_t chan,
-    double target_freq, double lo_offset
+    wax::obj subdev, wax::obj dsp, size_t chan,
+    const tune_request_t &tune_request
 ){
     wax::obj subdev_freq_proxy = subdev[SUBDEV_PROP_FREQ];
-    std::string freq_name = dxc[DSP_PROP_FREQ_SHIFT_NAMES].as<prop_names_t>().at(chan);
-    wax::obj dxc_freq_proxy = dxc[named_prop_t(DSP_PROP_FREQ_SHIFT, freq_name)];
-    double dxc_sample_rate = dxc[DSP_PROP_CODEC_RATE].as<double>();
+    std::string freq_name = dsp[DSP_PROP_FREQ_SHIFT_NAMES].as<prop_names_t>().at(chan);
+    wax::obj dsp_freq_proxy = dsp[named_prop_t(DSP_PROP_FREQ_SHIFT, freq_name)];
+    double dsp_sample_rate = dsp[DSP_PROP_CODEC_RATE].as<double>();
 
-    // Ask the d'board to tune as closely as it can to target_freq+lo_offset
-    double target_inter_freq = target_freq + lo_offset;
-    subdev_freq_proxy = target_inter_freq;
-    double actual_inter_freq = subdev_freq_proxy.as<double>();
-
-    //perform the correction correction for dxc rates outside of nyquist
-    double delta_freq = std::fmod(target_freq - actual_inter_freq, dxc_sample_rate);
-    bool outside_of_nyquist = std::abs(delta_freq) > dxc_sample_rate/2.0;
-    double target_dxc_freq = (outside_of_nyquist)?
-        boost::math::sign(delta_freq)*dxc_sample_rate - delta_freq : -delta_freq;
+    //------------------------------------------------------------------
+    //-- calculate the LO offset, only used with automatic policy
+    //------------------------------------------------------------------
+    double lo_offset = 0.0;
+    if (subdev[SUBDEV_PROP_USE_LO_OFFSET].as<bool>()){
+        //if the local oscillator will be in the passband, use an offset
+        //TODO make this nicer, use bandwidth property to clip bounds
+        lo_offset = 2.0*dsp[DSP_PROP_HOST_RATE].as<double>();
+    }
 
-    //invert the sign on the dxc freq given the following conditions
-    if (unit == dboard_iface::UNIT_TX) target_dxc_freq *= -1.0;
+    //------------------------------------------------------------------
+    //-- set the intermediate frequency depending upon the IF policy
+    //------------------------------------------------------------------
+    double target_inter_freq = 0.0;
+    switch (tune_request.inter_freq_policy){
+    case tune_request_t::POLICY_AUTO:
+        target_inter_freq = tune_request.target_freq + lo_offset;
+        subdev_freq_proxy = target_inter_freq;
+        break;
+
+    case tune_request_t::POLICY_MANUAL:
+        target_inter_freq = tune_request.inter_freq;
+        subdev_freq_proxy = target_inter_freq;
+        break;
+
+    case tune_request_t::POLICY_NONE: break; //does not set
+    }
+    double actual_inter_freq = subdev_freq_proxy.as<double>();
 
-    dxc_freq_proxy = target_dxc_freq;
-    double actual_dxc_freq = dxc_freq_proxy.as<double>();
+    //------------------------------------------------------------------
+    //-- calculate the dsp freq, only used with automatic policy
+    //------------------------------------------------------------------
+    double delta_freq = std::fmod(target_inter_freq - actual_inter_freq, dsp_sample_rate);
+    bool outside_of_nyquist = std::abs(delta_freq) > dsp_sample_rate/2.0;
+    double target_dsp_freq = (outside_of_nyquist)?
+        boost::math::sign(delta_freq)*dsp_sample_rate - delta_freq : -delta_freq;
+
+    //invert the sign on the dsp freq given the following conditions
+    if (unit == dboard_iface::UNIT_TX) target_dsp_freq *= -1.0;
+
+    //------------------------------------------------------------------
+    //-- set the dsp frequency depending upon the dsp frequency policy
+    //------------------------------------------------------------------
+    switch (tune_request.dsp_freq_policy){
+    case tune_request_t::POLICY_AUTO:
+        dsp_freq_proxy = target_dsp_freq;
+        break;
+
+    case tune_request_t::POLICY_MANUAL:
+        target_dsp_freq = tune_request.dsp_freq;
+        dsp_freq_proxy = target_dsp_freq;
+        break;
+
+    case tune_request_t::POLICY_NONE: break; //does not set
+    }
+    double actual_dsp_freq = dsp_freq_proxy.as<double>();
 
-    //load and return the tune result
+    //------------------------------------------------------------------
+    //-- load and return the tune result
+    //------------------------------------------------------------------
     tune_result_t tune_result;
     tune_result.target_inter_freq = target_inter_freq;
     tune_result.actual_inter_freq = actual_inter_freq;
-    tune_result.target_dsp_freq = target_dxc_freq;
-    tune_result.actual_dsp_freq = actual_dxc_freq;
+    tune_result.target_dsp_freq = target_dsp_freq;
+    tune_result.actual_dsp_freq = actual_dsp_freq;
     return tune_result;
 }
 
-static double derive_freq_from_xx_subdev_and_dxc(
+static double derive_freq_from_xx_subdev_and_dsp(
     dboard_iface::unit_t unit,
-    wax::obj subdev, wax::obj dxc, size_t chan
+    wax::obj subdev, wax::obj dsp, size_t chan
 ){
     //extract actual dsp and IF frequencies
     double actual_inter_freq = subdev[SUBDEV_PROP_FREQ].as<double>();
-    std::string freq_name = dxc[DSP_PROP_FREQ_SHIFT_NAMES].as<prop_names_t>().at(chan);
-    double actual_dxc_freq = dxc[named_prop_t(DSP_PROP_FREQ_SHIFT, freq_name)].as<double>();
+    std::string freq_name = dsp[DSP_PROP_FREQ_SHIFT_NAMES].as<prop_names_t>().at(chan);
+    double actual_dsp_freq = dsp[named_prop_t(DSP_PROP_FREQ_SHIFT, freq_name)].as<double>();
 
-    //invert the sign on the dxc freq given the following conditions
-    if (unit == dboard_iface::UNIT_TX) actual_dxc_freq *= -1.0;
+    //invert the sign on the dsp freq given the following conditions
+    if (unit == dboard_iface::UNIT_TX) actual_dsp_freq *= -1.0;
 
-    return actual_inter_freq - actual_dxc_freq;
+    return actual_inter_freq - actual_dsp_freq;
 }
 
 /***********************************************************************
@@ -84,27 +126,15 @@ static double derive_freq_from_xx_subdev_and_dxc(
  **********************************************************************/
 tune_result_t usrp::tune_rx_subdev_and_dsp(
     wax::obj subdev, wax::obj ddc, size_t chan,
-    double target_freq, double lo_offset
-){
-    return tune_xx_subdev_and_dxc(dboard_iface::UNIT_RX, subdev, ddc, chan, target_freq, lo_offset);
-}
-
-tune_result_t usrp::tune_rx_subdev_and_dsp(
-    wax::obj subdev, wax::obj ddc,
-    size_t chan, double target_freq
+    const tune_request_t &tune_request
 ){
-    double lo_offset = 0.0;
-    //if the local oscillator will be in the passband, use an offset
-    if (subdev[SUBDEV_PROP_USE_LO_OFFSET].as<bool>()){
-        lo_offset = 2.0*ddc[DSP_PROP_HOST_RATE].as<double>();
-    }
-    return tune_rx_subdev_and_dsp(subdev, ddc, chan, target_freq, lo_offset);
+    return tune_xx_subdev_and_dsp(dboard_iface::UNIT_RX, subdev, ddc, chan, tune_request);
 }
 
 double usrp::derive_freq_from_rx_subdev_and_dsp(
     wax::obj subdev, wax::obj ddc, size_t chan
 ){
-    return derive_freq_from_xx_subdev_and_dxc(dboard_iface::UNIT_RX, subdev, ddc, chan);
+    return derive_freq_from_xx_subdev_and_dsp(dboard_iface::UNIT_RX, subdev, ddc, chan);
 }
 
 /***********************************************************************
@@ -112,25 +142,13 @@ double usrp::derive_freq_from_rx_subdev_and_dsp(
  **********************************************************************/
 tune_result_t usrp::tune_tx_subdev_and_dsp(
     wax::obj subdev, wax::obj duc, size_t chan,
-    double target_freq, double lo_offset
+    const tune_request_t &tune_request
 ){
-    return tune_xx_subdev_and_dxc(dboard_iface::UNIT_TX, subdev, duc, chan, target_freq, lo_offset);
-}
-
-tune_result_t usrp::tune_tx_subdev_and_dsp(
-    wax::obj subdev, wax::obj duc,
-    size_t chan, double target_freq
-){
-    double lo_offset = 0.0;
-    //if the local oscillator will be in the passband, use an offset
-    if (subdev[SUBDEV_PROP_USE_LO_OFFSET].as<bool>()){
-        lo_offset = 2.0*duc[DSP_PROP_HOST_RATE].as<double>();
-    }
-    return tune_tx_subdev_and_dsp(subdev, duc, chan, target_freq, lo_offset);
+    return tune_xx_subdev_and_dsp(dboard_iface::UNIT_TX, subdev, duc, chan, tune_request);
 }
 
 double usrp::derive_freq_from_tx_subdev_and_dsp(
     wax::obj subdev, wax::obj duc, size_t chan
 ){
-    return derive_freq_from_xx_subdev_and_dxc(dboard_iface::UNIT_TX, subdev, duc, chan);
+    return derive_freq_from_xx_subdev_and_dsp(dboard_iface::UNIT_TX, subdev, duc, chan);
 }