board.hpp

Go to the documentation of this file.

/*
 *  SatNOGS-COMMS control library
 *
 *  Copyright (C) 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 <type_traits>
 
#include <satnogs-comms-lib/antenna_gpio.hpp>
#include <satnogs-comms-lib/bsp/adc.hpp>
#include <satnogs-comms-lib/bsp/chrono.hpp>
#include <satnogs-comms-lib/bsp/gpio.hpp>
#include <satnogs-comms-lib/bsp/i2c.hpp>
#include <satnogs-comms-lib/bsp/spi.hpp>
#include <satnogs-comms-lib/emc1702.hpp>
#include <satnogs-comms-lib/emmc.hpp>
#include <satnogs-comms-lib/fpga.hpp>
#include <satnogs-comms-lib/leds.hpp>
#include <satnogs-comms-lib/power.hpp>
#include <satnogs-comms-lib/radio.hpp>
#include <satnogs-comms-lib/temperature.hpp>
#include <satnogs-comms-lib/version.hpp>
 
namespace satnogs::comms::lib
{
class board
{
public:
  class io_conf
  {
  public:
    bsp::gpio &emmc_en;     
    bsp::gpio &emmc_sel;    
    bsp::gpio &emmc_rst;    
    bsp::spi  &fpga_spi;    
    bsp::gpio &led0;        
    bsp::gpio &led1;        
    power::io_conf &pwr_io; 
    bsp::i2c
        &sensors_i2c; 
    bsp::gpio &alert_t_pa_uhf;   
    bsp::gpio &alert_t_pa_sband; 
    radio::io_conf &radio_io;    
    bsp::chrono
        &chrono; 
    bsp::gpio
        &fpga_done; 
    bsp::gpio &fpga_boot_sel_1; 
    bsp::gpio &fpga_boot_sel_0; 
    comms::lib::antenna &uhf_antenna;   
    comms::lib::antenna &sband_antenna; 
  };

  class params
  {
  public:
    radio::params radio_params; 
    fpga::hw      fpga_hw;      
    bsp::imsgq<radio::rx_msg>
        &rx_msgq; 
  };
 
  static void
  init(const io_conf &io, const params &p);
 
  /* Singleton */
  static board &
  get_instance();
 
  static bool
  is_init();
 
  board(board const &) = delete;
 
  void
  operator=(board const &) = delete;
 
  comms::lib::radio &
  radio();
 
  comms::lib::emmc &
  emmc();
 
  comms::lib::power &
  power();
 
  comms::lib::fpga &
  fpga();
 
  comms::lib::leds &
  leds();
 
  comms::lib::antenna &
  antenna(radio::interface iface);
 
  bool
  alert(temperature_sensor s) const;
 
  float
  temperature(temperature_sensor s) const;
 
protected:
  board(const io_conf &io, const params &p);
 
private:
  bool m_init;
  /*
   * power subsystem should be first, because many of the other subsystems
   * depends on it
   */
  comms::lib::power                m_power;
  comms::lib::radio                m_radio;
  comms::lib::fpga                 m_fpga;
  comms::lib::emmc                 m_emmc;
  comms::lib::antenna             &m_uhf_antenna;
  comms::lib::antenna             &m_sband_antenna;
  comms::lib::leds                 m_leds;
  comms::lib::temperature<emc1702> m_temperature;
};


class uninitialization_exception : public exception
{
public:
  uninitialization_exception(string_type file_name, numeric_type line)
      : exception(
            exception::severity::CATASTROPHIC, file_name, line,
            error_msg{"Singleton class not initialized (init() not called)",
                      "noinit", EUNINIT})
  {
  }
};

class initialization_exception : public exception
{
public:
  initialization_exception(string_type file_name, numeric_type line)
      : exception(
            exception::severity::CRITICAL, file_name, line,
            error_msg{"Singleton class already initialized", "init", EINIT})
  {
  }
};
 
} // namespace satnogs::comms::lib