oveRTOS C++ API
C++20 RAII wrappers for the oveRTOS C API
Loading...
Searching...
No Matches
Functions
ove::board Namespace Reference

Thin C++ wrappers around the oveRTOS board description API. More...

Functions

int init ()
 Initialises the board hardware (clocks, pin-mux, etc.).
 
const char * name ()
 Returns the human-readable board name.
 
const struct ove_board_desc * desc ()
 Returns a pointer to the board descriptor structure.
 

Detailed Description

Thin C++ wrappers around the oveRTOS board description API.

Available when CONFIG_OVE_BOARD is enabled.

Function Documentation

◆ init()

int ove::board::init ( )
inline

Initialises the board hardware (clocks, pin-mux, etc.).

Returns
OVE_OK on success, or a negative error code.

◆ name()

const char * ove::board::name ( )
inline

Returns the human-readable board name.

Returns
Null-terminated string with the board identifier.

◆ desc()

const struct ove_board_desc * ove::board::desc ( )
inline

Returns a pointer to the board descriptor structure.

Returns
Pointer to a read-only ove_board_desc describing board capabilities.