system.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 Chris Leishman
 
#pragma once
 
#include <idfxx/error>
 
#include <cstddef>
#include <esp_system.h>
#include <string>
 
namespace idfxx {
 
enum class reset_reason : int {
    // clang-format off
    unknown            = 0,  
    power_on           = 1,  
    external           = 2,  
    software           = 3,  
    panic              = 4,  
    interrupt_watchdog = 5,  
    task_watchdog      = 6,  
    watchdog           = 7,  
    deep_sleep         = 8,  
    brownout           = 9,  
    sdio               = 10, 
    usb                = 11, 
    jtag               = 12, 
    efuse              = 13, 
    power_glitch       = 14, 
    cpu_lockup         = 15, 
    // clang-format on
};
 
[[nodiscard]] std::string to_string(reset_reason r);
 
[[nodiscard]] inline reset_reason last_reset_reason() noexcept {
    return static_cast<reset_reason>(esp_reset_reason());
}
 
[[noreturn]] inline void restart() {
    esp_restart();
}
 
// =============================================================================
// Shutdown handlers
// =============================================================================
 
#ifdef CONFIG_COMPILER_CXX_EXCEPTIONS
void register_shutdown_handler(void (*handler)());
 
void unregister_shutdown_handler(void (*handler)());
#endif
 
[[nodiscard]] result<void> try_register_shutdown_handler(void (*handler)());
 
[[nodiscard]] result<void> try_unregister_shutdown_handler(void (*handler)());
 
// =============================================================================
// Heap information
// =============================================================================
 
[[nodiscard]] inline std::size_t free_heap_size() noexcept {
    return esp_get_free_heap_size();
}
 
[[nodiscard]] inline std::size_t free_internal_heap_size() noexcept {
    return esp_get_free_internal_heap_size();
}
 
[[nodiscard]] inline std::size_t minimum_free_heap_size() noexcept {
    return esp_get_minimum_free_heap_size();
}
 
 
} // namespace idfxx
 
#include "sdkconfig.h"
#ifdef CONFIG_IDFXX_STD_FORMAT
#include <algorithm>
#include <format>
namespace std {
template<>
struct formatter<idfxx::reset_reason> {
    constexpr auto parse(format_parse_context& ctx) { return ctx.begin(); }
 
    template<typename FormatContext>
    auto format(idfxx::reset_reason r, FormatContext& ctx) const {
        auto s = to_string(r);
        return std::copy(s.begin(), s.end(), ctx.out());
    }
};
} // namespace std
#endif // CONFIG_IDFXX_STD_FORMAT