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

Backward-compatibility wrappers delegating to board, gpio, and led. More...

Functions

Result< void > board_init () noexcept
 Initialises the board hardware (backward-compatibility alias for board::init).
 
void led_set (unsigned int led, int on)
 Turns a LED on or off (backward-compatibility alias for led::set).
 
void led_toggle (unsigned int led)
 Toggles a LED (backward-compatibility alias for led::toggle).
 
Result< void > gpio_set (unsigned int port, unsigned int pin, int value) noexcept
 Drives a GPIO output pin (backward-compatibility alias for gpio::set).
 
Result< int > gpio_get (unsigned int port, unsigned int pin) noexcept
 Reads a GPIO pin level (backward-compatibility alias for gpio::get).
 
Result< void > gpio_irq_register (unsigned int port, unsigned int pin, ove_gpio_irq_mode_t mode, ove_gpio_irq_cb callback, void *user_data) noexcept
 Registers a GPIO interrupt callback (backward-compatibility alias for gpio::irq_register).
 
Result< void > gpio_irq_enable (unsigned int port, unsigned int pin) noexcept
 Enables a GPIO interrupt (backward-compatibility alias for gpio::irq_enable).
 
Result< void > gpio_irq_disable (unsigned int port, unsigned int pin) noexcept
 Disables a GPIO interrupt (backward-compatibility alias for gpio::irq_disable).
 

Detailed Description

Backward-compatibility wrappers delegating to board, gpio, and led.

Available when CONFIG_OVE_BSP is enabled. New code should prefer the individual ove::board, ove::gpio, and ove::led namespaces.

Function Documentation

◆ board_init()

Result< void > ove::bsp::board_init ( )
inlinenoexcept

Initialises the board hardware (backward-compatibility alias for board::init).

Returns
Empty Result<void> on success; unexpected Error on failure.

◆ led_set()

void ove::bsp::led_set ( unsigned int  led,
int  on 
)
inline

Turns a LED on or off (backward-compatibility alias for led::set).

Parameters
[in]ledLED index (0-based).
[in]onNon-zero to turn on, zero to turn off.

◆ led_toggle()

void ove::bsp::led_toggle ( unsigned int  led)
inline

Toggles a LED (backward-compatibility alias for led::toggle).

Parameters
[in]ledLED index (0-based).

◆ gpio_set()

Result< void > ove::bsp::gpio_set ( unsigned int  port,
unsigned int  pin,
int  value 
)
inlinenoexcept

Drives a GPIO output pin (backward-compatibility alias for gpio::set).

Parameters
[in]portGPIO port index.
[in]pinPin number within the port.
[in]valueLogic level to drive (0 = low, non-zero = high).
Returns
Empty Result<void> on success; unexpected Error on failure.

◆ gpio_get()

Result< int > ove::bsp::gpio_get ( unsigned int  port,
unsigned int  pin 
)
inlinenoexcept

Reads a GPIO pin level (backward-compatibility alias for gpio::get).

Parameters
[in]portGPIO port index.
[in]pinPin number within the port.
Returns
On success, the pin level (0 or 1). On failure, an unexpected Error.

◆ gpio_irq_register()

Result< void > ove::bsp::gpio_irq_register ( unsigned int  port,
unsigned int  pin,
ove_gpio_irq_mode_t  mode,
ove_gpio_irq_cb  callback,
void *  user_data 
)
inlinenoexcept

Registers a GPIO interrupt callback (backward-compatibility alias for gpio::irq_register).

Parameters
[in]portGPIO port index.
[in]pinPin number within the port.
[in]modeTrigger mode (rising, falling, both edges, etc.).
[in]callbackFunction to call when the interrupt fires.
[in]user_dataOpaque pointer forwarded to the callback.
Returns
Empty Result<void> on success; unexpected Error on failure.

◆ gpio_irq_enable()

Result< void > ove::bsp::gpio_irq_enable ( unsigned int  port,
unsigned int  pin 
)
inlinenoexcept

Enables a GPIO interrupt (backward-compatibility alias for gpio::irq_enable).

Parameters
[in]portGPIO port index.
[in]pinPin number within the port.
Returns
Empty Result<void> on success; unexpected Error on failure.

◆ gpio_irq_disable()

Result< void > ove::bsp::gpio_irq_disable ( unsigned int  port,
unsigned int  pin 
)
inlinenoexcept

Disables a GPIO interrupt (backward-compatibility alias for gpio::irq_disable).

Parameters
[in]portGPIO port index.
[in]pinPin number within the port.
Returns
Empty Result<void> on success; unexpected Error on failure.