power.hpp

Go to the documentation of this file.

/*
 *  SatNOGS-COMMS control library
 *
 *  Copyright (C) 2023, 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 <satnogs-comms-lib/bsp/adc.hpp>
#include <satnogs-comms-lib/bsp/gpio.hpp>
#include <satnogs-comms-lib/bsp/i2c.hpp>
#include <satnogs-comms-lib/bsp/sensor.hpp>
#include <satnogs-comms-lib/emc1702.hpp>
#include <satnogs-comms-lib/exception.hpp>
#include <satnogs-comms-lib/version.hpp>
 
namespace satnogs::comms::lib
{
class power
{
public:
  enum class subsys : uint8_t
  {
    CAN1      = 0, 
    CAN2      = 1, 
    RF_5V     = 2, 
    FPGA_5V   = 3, 
    CAN1_LPWR = 4, 
    CAN2_LPWR = 5, 
    UHF       = 6, 
    SBAND     = 7  
  };

  enum class sensor : uint8_t
  {
    EFUSES  = 0, 
    EMC1702 = 1, 
    AVERAGE = 2  
  };

  enum class channel : uint8_t
  {
    FPGA    = 1, 
    RF_5V   = 2, 
    DIG_3V3 = 3, 
    VIN     = 4, 
    V_BAT   = 5  
  };

  enum class pgood_tp : uint8_t
  {
    RAIL_5V    = 0, 
    RAIL_FPGA  = 1, 
    RAIL_UHF   = 2, 
    RAIL_SBAND = 3  
  };

  class r_lim
  {
  public:
    r_lim() = delete;

    r_lim(uint16_t dig_3v3, uint16_t rf_5v, uint16_t fpga_5v)
        : dig_3v3(dig_3v3), rf_5v(rf_5v), fpga_5v(fpga_5v)
    {
    }
 
    /*
     * Only the power class should have access on the protected members of this
     * class
     */
    friend power;
 
  protected:
    uint16_t dig_3v3;
    uint16_t rf_5v;
    uint16_t fpga_5v;
  };

  class io_conf
  {
  public:
    bsp::i2c    &mon_i2c;
    bsp::gpio   &rf_5v_en;
    bsp::gpio   &fpga_5v_en;
    bsp::gpio   &can1_en;
    bsp::gpio   &can1_low_pwr;
    bsp::gpio   &can2_en;
    bsp::gpio   &can2_low_pwr;
    bsp::gpio   &rf_5v_pgood;
    bsp::gpio   &fpga_5v_pgood;
    bsp::gpio   &uhf_en;
    bsp::gpio   &uhf_pgood;
    bsp::gpio   &sband_en;
    bsp::gpio   &sband_pgood;
    bsp::adc    &imon_3v3_d;
    bsp::adc    &imon_5v_rf;
    bsp::adc    &imon_fpga;
    bsp::sensor &v_mon;
    r_lim        rlim;
    uint16_t     efuse_adc_current_gain;
  };
 
  void
  enable(subsys sys, bool en = true);
 
  bool
  enabled(subsys sys) const;
 
  bool
  pgood(pgood_tp tp) const;
 
  float
  voltage(channel sys) const;
 
  float
  current(channel sys) const;
 
  float
  get_power(sensor src) const;
 
  power(const io_conf &io);
 
private:
  bsp::gpio   &m_rf_5v_en;
  bsp::gpio   &m_fpga_5v_en;
  bsp::gpio   &m_can1_en;
  bsp::gpio   &m_can1_low_pwr;
  bsp::gpio   &m_can2_en;
  bsp::gpio   &m_can2_low_pwr;
  bsp::gpio   &m_pgood_5v;
  bsp::gpio   &m_pgood_fpga;
  emc1702      m_monitor;
  bsp::gpio   &m_uhf_en;
  bsp::gpio   &m_uhf_pgood;
  bsp::gpio   &m_sband_en;
  bsp::gpio   &m_sband_pgood;
  bsp::adc    &m_imon_5v_rf;
  bsp::adc    &m_imon_3v3;
  bsp::adc    &m_imon_fpga;
  bsp::sensor &m_v_mon;
  r_lim        m_r_lim;
  uint16_t     m_efuse_adc_current_gain;
};

 
} // namespace satnogs::comms::lib