rf_frontend.hpp

Go to the documentation of this file.

/*
 *  SatNOGS-COMMS control library
 *
 *  Copyright (C) 2022-2024, Libre Space Foundation <http://libre.space>
 *
 *  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/>.
 *
 *  SPDX-License-Identifier: GNU General Public License v3.0 or later
 */
 
#pragma once
 
#include <at86rf215.h>
#include <etl/string.h>
#include <satnogs-comms-lib/ad8318.hpp>
#include <satnogs-comms-lib/bsp/adc.hpp>
#include <satnogs-comms-lib/bsp/dac.hpp>
#include <satnogs-comms-lib/bsp/gpio.hpp>
#include <satnogs-comms-lib/exception.hpp>
#include <satnogs-comms-lib/f2972.hpp>
#include <satnogs-comms-lib/power.hpp>
#include <utility>
 
namespace satnogs::comms::lib
{

class rf_frontend
{
public:
  class params
  {
  public:
    const std::pair<uint32_t, uint32_t> rx_range; 
    const std::pair<uint32_t, uint32_t> tx_range; 
    const std::pair<float, float>
        agc0_range; 
    const std::pair<float, float>
        gain0_range; 
    const std::pair<float, float>
        agc0_calib; 
    const std::pair<float, float>
        gain0_calib; 
  };
 
  class io_conf
  {
  public:
    bsp::gpio &en_agc;
    bsp::dac  &agc_vset;
    bsp::gpio &flt_sel;
  };

  enum class dir : uint8_t
  {
    RX, 
    TX, 
    INVALID
  };

  enum class gain_mode : uint8_t
  {
    AUTO,  
    MANUAL 
  };
 
  enum class filter : uint8_t
  {
    WIDE,
    NARROW
  };

  class rx_gain_params
  {
  public:
    gain_mode gain0_mode; 
    union
    {
      float tgt;  
      float gain; 
    } gain0;
    gain_mode gain1_mode; 
    union
    {
      at86rf215_agc_conf agc; 
      float gain;             
    } gain1;
  };
 
  rf_frontend(const params &init_params, io_conf &&io, power &pwr);

  virtual void
  enable(bool set = true) = 0;
 
  virtual bool
  enabled() const = 0;
 
  virtual void
  set_filter(filter f);
 
  virtual filter
  get_filter() const;
 
  virtual void
  set_direction(dir d, uint64_t lo_freq = 0) = 0;
 
  dir
  direction() const;
 
  void
  set_rx_gain(const rx_gain_params &gain);
 
  bool
  frequency_valid(dir d, uint32_t freq) const;
 
protected:
  const params m_params;
  bsp::gpio   &m_filt_sel;
  bsp::dac    &m_dac;
  power       &m_pwr;
  ad8318       m_agc;
  dir          m_dir;
};
 
} // namespace satnogs::comms::lib