api/cpp/board_8hpp_source.html

/*

 * 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/board.h>

#include <ove/types.hpp>

#include <ove/error.hpp>


#ifdef CONFIG_OVE_BOARD


namespace ove::board

{


[[nodiscard]] inline Result<void> init() noexcept

{

    return from_rc(ove_board_init());

}


inline const char *name()

{

    return ove_board_name();

}


inline const struct ove_board_desc *desc()

{

    return ove_board_desc();

}


} /* namespace ove::board */


#endif /* CONFIG_OVE_BOARD */

error.hpp
Strong ove::Error type, Result<T> alias, and std::error_code interop for the oveRTOS C++ binding.

ove::board
Thin C++ wrappers around the oveRTOS board description API.
Definition board.hpp:23

ove::board::init
Result< void > init() noexcept
Initialises the board hardware (clocks, pin-mux, etc.).
Definition board.hpp:37

ove::board::name
const char * name()
Returns the human-readable board name.
Definition board.hpp:46

ove::board::desc
const struct ove_board_desc * desc()
Returns a pointer to the board descriptor structure.
Definition board.hpp:55

ove::from_rc
Result< void > from_rc(int rc) noexcept
Lifts a substrate rc-code into a Result<void>.
Definition error.hpp:254

ove::Result
std::expected< T, Error > Result
std::expected-based result alias.
Definition error.hpp:139

types.hpp
Common type definitions and concepts for the C++ wrapper layer.