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>
 
#ifdef CONFIG_OVE_PM
 
namespace ove {
 
namespace 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 int init(const Cfg &cfg) {
    return ove_pm_init(&cfg);
}
 
inline void deinit() {
    ove_pm_deinit();
}
 
/* ── State machine ──────────────────────────────────────────────────── */
 
[[nodiscard]] inline int set_state(State state) {
    return ove_pm_set_state(state);
}
 
inline State get_state() {
    return ove_pm_get_state();
}
 
inline void activity() {
    ove_pm_activity();
}
 
/* ── Wake sources ───────────────────────────────────────────────────── */
 
[[nodiscard]] inline int wake_register(const WakeSrc &src) {
    return ove_pm_wake_register(&src);
}
 
[[nodiscard]] inline int wake_unregister(const WakeSrc &src) {
    return ove_pm_wake_unregister(&src);
}
 
/* ── Peripheral power domains ───────────────────────────────────────── */
 
[[nodiscard]] inline int domain_request(Domain domain) {
    return ove_pm_domain_request(domain);
}
 
[[nodiscard]] inline int domain_release(Domain domain) {
    return ove_pm_domain_release(domain);
}
 
[[nodiscard]] inline int domain_get_refcount(Domain domain) {
    return ove_pm_domain_get_refcount(domain);
}
 
/* ── Policy ─────────────────────────────────────────────────────────── */
 
[[nodiscard]] inline int set_policy(ove_pm_policy_fn policy,
                    void *user_data = nullptr) {
    return ove_pm_set_policy(policy, user_data);
}
 
/* ── Notifications ──────────────────────────────────────────────────── */
 
[[nodiscard]] inline int notify_register(ove_pm_notify_fn cb,
                     void *user_data = nullptr) {
    return ove_pm_notify_register(cb, user_data);
}
 
[[nodiscard]] inline int notify_unregister(ove_pm_notify_fn cb,
                       void *user_data = nullptr) {
    return ove_pm_notify_unregister(cb, user_data);
}
 
/* ── Statistics ─────────────────────────────────────────────────────── */
 
[[nodiscard]] inline int get_stats(Stats &stats) {
    return ove_pm_get_stats(&stats);
}
 
inline void reset_stats() {
    ove_pm_reset_stats();
}
 
/* ── Power budget ───────────────────────────────────────────────────── */
 
[[nodiscard]] inline int set_budget(uint32_t target_pct_x100) {
    return ove_pm_set_budget(target_pct_x100);
}
 
[[nodiscard]] inline int get_budget_status(uint32_t &actual_pct_x100) {
    return ove_pm_get_budget_status(&actual_pct_x100);
}
 
/* ── Idle processing ────────────────────────────────────────────────── */
 
inline void idle_process() {
    ove_pm_idle_process();
}
 
} /* namespace pm */
 
} /* namespace ove */
 
#endif /* CONFIG_OVE_PM */