pm.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#pragma once
 
#include <ove/pm.h>
#include <ove/types.hpp>
#include <ove/error.hpp>
 
#ifdef CONFIG_OVE_PM
 
namespace ove::pm
{
 
/* ── Enums (re-export C types for convenience) ──────────────────────── */
 
using State = ove_pm_state_t;
using WakeType = ove_pm_wake_type_t;
using Domain = ove_pm_domain_t;
using Event = ove_pm_event_t;
using WakeSrc = ove_pm_wake_src;
using Cfg = ove_pm_cfg;
using Stats = ove_pm_stats;
 
/* ── Lifecycle ──────────────────────────────────────────────────────── */
 
[[nodiscard]] inline Result<void> init(const Cfg &cfg) noexcept
{
    return from_rc(ove_pm_init(&cfg));
}
 
inline void deinit()
{
    ove_pm_deinit();
}
 
/* ── State machine ──────────────────────────────────────────────────── */
 
[[nodiscard]] inline Result<void> set_state(State state) noexcept
{
    return from_rc(ove_pm_set_state(state));
}
 
inline State get_state()
{
    return ove_pm_get_state();
}
 
inline void activity()
{
    ove_pm_activity();
}
 
/* ── Wake sources ───────────────────────────────────────────────────── */
 
[[nodiscard]] inline Result<void> wake_register(const WakeSrc &src) noexcept
{
    return from_rc(ove_pm_wake_register(&src));
}
 
[[nodiscard]] inline Result<void> wake_unregister(const WakeSrc &src) noexcept
{
    return from_rc(ove_pm_wake_unregister(&src));
}
 
/* ── Peripheral power domains ───────────────────────────────────────── */
 
[[nodiscard]] inline Result<void> domain_request(Domain domain) noexcept
{
    return from_rc(ove_pm_domain_request(domain));
}
 
[[nodiscard]] inline Result<void> domain_release(Domain domain) noexcept
{
    return from_rc(ove_pm_domain_release(domain));
}
 
[[nodiscard]] inline Result<int> domain_get_refcount(Domain domain) noexcept
{
    const int rc = ove_pm_domain_get_refcount(domain);
    if (rc >= 0)
        return rc;
    return std::unexpected{static_cast<Error>(rc)};
}
 
/* ── Policy ─────────────────────────────────────────────────────────── */
 
[[nodiscard]] inline Result<void> set_policy(ove_pm_policy_fn policy,
                         void *user_data = nullptr) noexcept
{
    return from_rc(ove_pm_set_policy(policy, user_data));
}
 
/* ── Notifications ──────────────────────────────────────────────────── */
 
[[nodiscard]] inline Result<void> notify_register(ove_pm_notify_fn cb,
                          void *user_data = nullptr) noexcept
{
    return from_rc(ove_pm_notify_register(cb, user_data));
}
 
[[nodiscard]] inline Result<void> notify_unregister(ove_pm_notify_fn cb,
                            void *user_data = nullptr) noexcept
{
    return from_rc(ove_pm_notify_unregister(cb, user_data));
}
 
/* ── Statistics ─────────────────────────────────────────────────────── */
 
[[nodiscard]] inline Result<Stats> get_stats() noexcept
{
    Stats stats{};
    const int rc = ove_pm_get_stats(&stats);
    return from_rc(rc, stats);
}
 
inline void reset_stats()
{
    ove_pm_reset_stats();
}
 
/* ── Power budget ───────────────────────────────────────────────────── */
 
[[nodiscard]] inline Result<void> set_budget(uint32_t target_pct_x100) noexcept
{
    return from_rc(ove_pm_set_budget(target_pct_x100));
}
 
[[nodiscard]] inline Result<uint32_t> get_budget_status() noexcept
{
    uint32_t actual_pct_x100 = 0;
    const int rc = ove_pm_get_budget_status(&actual_pct_x100);
    return from_rc(rc, actual_pct_x100);
}
 
/* ── Idle processing ────────────────────────────────────────────────── */
 
inline void idle_process()
{
    ove_pm_idle_process();
}
 
} /* namespace ove::pm */
 
#endif /* CONFIG_OVE_PM */