PlutoCtrl.hxx

Go to the documentation of this file.

#pragma once
/*
Copyright (c) 2026 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.
*/

 
#include "SoDaBase.hxx"
#include "SoDaThread.hxx"
#include "Command.hxx"
#include "Params.hxx"
#include "RadioControl.hxx"
#include <iio.h>
#include <memory>
#include <string>
#include <vector>
 
namespace SoDa {
  class PlutoCtrl;
  typedef std::shared_ptr<PlutoCtrl> PlutoCtrlPtr;

  class PlutoCtrl : public SoDa::RadioControl {
  protected:
    PlutoCtrl(ParamsPtr params);
 
  public:
    ~PlutoCtrl();
 
    static PlutoCtrlPtr make(ParamsPtr params) {
      auto ret = std::shared_ptr<PlutoCtrl>(new PlutoCtrl(params));
      ret->self = ret;
      ret->registerThread(ret);
      return ret;
    }
 
    RadioControlPtr getSelfPtr() override { return self.lock(); }

    void init() override;
 
    // ---------------------------------------------------------------
    // RadioControl pure-virtual interface
    // ---------------------------------------------------------------
 
    bool isLOLocked(SoDa::RXTX rxtx) override;
 
    double setLOFreq(double freq, SoDa::RXTX rxtx) override;
    double getLOFreq(SoDa::RXTX rxtx) override;
 
    float setRFGain(float gain, SoDa::RXTX rxtx) override;
 
    void  setSampleRate(float rate, SoDa::RXTX rxtx) override;
    float getSampleRate(SoDa::RXTX rxtx) override;
 
    std::string getHardwareDescription() override;
 
    std::vector<std::string> listAntennas(SoDa::RXTX rxtx) override;
    void        setAntenna(const std::string & ant, SoDa::RXTX rxtx) override;
    std::string getAntenna(SoDa::RXTX rxtx) override;
 
    bool getTXEna() override;
    bool getTXRelayOn() override;
    void setTXEna(bool enable, bool full_duplex) override;
 
  private:
    // IIO objects
    iio_context * ctx;         
    iio_device  * phy;         
 
    iio_channel * rx_lo_chan;  
    iio_channel * tx_lo_chan;  
    iio_channel * rx_phy_chan; 
    iio_channel * tx_phy_chan; 
 
    // Cached hardware state
    double rx_lo_freq;         
    double tx_lo_freq;         
    float  rx_samp_rate_hw;    
    float  tx_samp_rate_hw;    
 
    std::string rx_antenna_name;
    std::string tx_antenna_name;
 
    std::string hw_description; 
 
    // AD9361 limits
    static constexpr double RX_GAIN_MAX = 73.0;    
    static constexpr double TX_GAIN_MIN = -89.75;  
    static constexpr double FREQ_MIN    = 70.0e6;  
    static constexpr double FREQ_MAX    =  6.0e9;  
 
    // PlutoRX and PlutoTX each decimate/interpolate 4:1, so the Pluto hardware
    // always runs at 4 * 625k = 2.5 MSPS regardless of what Params requests.
    static constexpr float PLUTO_SAMPLE_RATE = 2500000.0f;
 
    std::weak_ptr<PlutoCtrl> self;

    void writeHWTXGain(double gain_db);
    void writeHWRXGain(double gain_db);
  };
}