USRPTuner.hxx

Go to the documentation of this file.

/*
Copyright (c) 2012, Matthew H. Reilly (kb1vc)
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
    Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/


#ifndef USRPTUNER_HDR
#define USRPTUNER_HDR
#include "SoDaBase.hxx"
#include "Params.hxx"


#include <uhd/utils/thread_priority.hpp>
#include <uhd/utils/safe_main.hpp>
#include <uhd/usrp/multi_usrp.hpp>
#include <uhd/usrp/dboard_base.hpp>
#include <uhd/types/tune_request.hpp>
#include <uhd/types/tune_result.hpp>
#include <uhd/utils/msg.hpp>

namespace SoDa {

  class USRPTuner : public Debug {
  public:
    USRPTuner(uhd::usrp::multi_usrp::sptr usrp, 
          double min_separation, 
          std::string unit_name = std::string("USRPTuner")); 


    USRPTuner * makeTuner(uhd::usrp::multi_usrp::sptr usrp, 
              double min_separation,
              bool force_fracN = false,
              bool force_simple = false);

    virtual bool setRXFreq(double rx_freq, double avoid_freq, uhd::tune_result_t & tune_result) = 0;
    virtual bool setTXFreq(double tx_freq, double avoid_freq, uhd::tune_result_t & tune_result) = 0;

  protected:
    virtual bool checkLock(uhd::tune_request_t & req,
               char sel,
               uhd::tune_result_t & cur);

    double min_separation;
    uhd::usrp::multi_usrp::sptr usrp;
    bool has_lock_detect; 
  }; 

  class IntNTuner : public USRPTuner {
  public:
    IntNTuner(uhd::usrp::multi_usrp::sptr usrp, 
          double min_separation) : 
      USRPTuner(usrp, min_separation, std::string("IntNTuner")) 
    {
      initTuner(); 
    }

    bool setRXFreq(double rx_freq, double avoid_freq, uhd::tune_result_t & tune_result);

    virtual bool setTXFreq(double tx_freq, double avoid_freq, uhd::tune_result_t & tune_result);

  private:
    void initTuner();
  };

  class SimpleTuner : public USRPTuner {
  public:
    SimpleTuner(uhd::usrp::multi_usrp::sptr usrp) : 
      USRPTuner(usrp, 0.0, std::string("IntNTuner")) 
    {
      initTuner(); 
    }

    bool setRXFreq(double rx_freq, double avoid_freq, uhd::tune_result_t & tune_result)
    {
      uhd::tune_request_t rx_req(rx_freq); 
      tune_result = usrp->set_rx_freq(rx_req); 
      // no need to check lock. 
      return true; 
    }

    bool setTXFreq(double tx_freq, double avoid_freq, uhd::tune_result_t & tune_result)
    {
      uhd::tune_request_t tx_req(tx_freq); 
      tune_result = usrp->set_tx_freq(tx_req); 
      // no need to check lock. 
      return true; 
    }

  private:
    void initTuner() {
      // do nothing. 
    }
  };

}
#endif