fpga.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 <cstdint>
#include <etl/string.h>
#include <satnogs-comms-lib/bsp/gpio.hpp>
#include <satnogs-comms-lib/bsp/spi.hpp>
#include <satnogs-comms-lib/power.hpp>
 
namespace satnogs::comms::lib
{
class fpga
{
public:
  enum class reg : uint32_t
  {
    id      = 0,
    version = 1,
    status  = 2
  };
 
  enum class hw : uint8_t
  {
    NONE,
    ALINX_AC7Z020,
    LIBREWAVE
  };
 
  enum class boot_mode : uint8_t
  {
    JTAG,
    NAND,
    QSPI,
    EMMC
  };
 
  fpga(hw h, bsp::spi &spi, power &pwr, bsp::gpio &fpga_done,
       bsp::gpio &boot_sel_1, bsp::gpio &boot_sel_0);
 
  void
  enable(bool en = true);
 
  bool
  enabled() const;
 
  void
  write_reg(uint32_t reg, uint32_t val);
 
  uint32_t
  read_reg(uint32_t reg);
 
  void
  write_reg(reg r, uint32_t val);
 
  uint32_t
  read_reg(reg r);
 
  bool
  get_fpga_done() const;
 
  void
  set_boot_mode(boot_mode mode);
 
  boot_mode
  get_boot_mode() const;
 
private:
  const hw        m_hw;
  etl::string<32> m_name;
  bsp::spi       &m_spi;
  power          &m_pwr;
  bsp::gpio      &m_fpga_done;
  bsp::gpio      &m_boot_sel_1;
  bsp::gpio      &m_boot_sel_0;
};
 
} // namespace satnogs::comms::lib