memory_monitor.hpp

Go to the documentation of this file.

/*
 *  SatNOGS-COMMS MCU software
 *
 *  Copyright (C) 2025, 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 "settings.hpp"
#include <satnogs-comms-lib/exception.hpp>
#include <zephyr/device.h>
#include <zephyr/drivers/flash.h>
#include <zephyr/kernel.h>
#include <zephyr/storage/flash_map.h>
#include <zephyr/sys/atomic.h>
#include <zephyr/sys/util.h>
 
namespace satnogs::comms
{
class memory_monitor
{
public:
  static memory_monitor &
  get_instance()
  {
    static memory_monitor instance;
    return instance;
  }
 
  /* Singleton */
  memory_monitor(memory_monitor const &) = delete;
 
  void
  operator=(memory_monitor const &) = delete;
 
  void
  start(int32_t delay = CONFIG_FLASH_MONITOR_BURST_DELAY_SECS);
 
  void
  stop();
 
  static void
  flash_monitor_hdlr(struct k_work *work);
 
private:
  atomic_t m_running;
  int32_t  m_burst_delay_ms;
  off_t    m_scan_off;
  size_t   m_flash_size;
  off_t    m_flash_offset;
 
  memory_monitor();
};
 
class flash_init_exception : public lib::exception
{
public:
  flash_init_exception(const char *file_name, int line)
      : exception(
            exception::severity::CRITICAL, file_name, line,
            error_msg{"Error in FLASH initialization", "flashinit", EFLASHINIT})
  {
  }
};
 
class flash_read_exception : public lib::exception
{
public:
  flash_read_exception(const char *file_name, int line)
      : exception(exception::severity::CRITICAL, file_name, line,
                  error_msg{"Unrecoverable double-bit ECC or other flash fault",
                            "flashfault", EFLASHREAD})
  {
  }
};
 
} // namespace satnogs::comms