oveRTOS C API
Embedded RTOS framework — build system, configuration, and portable C API
Loading...
Searching...
No Matches
Functions
Application lifecycle

Application entry point and RTOS scheduler startup helpers. More...

Functions

void ove_main (void)
 Application-defined entry point called after board and console init.
 
void ove_run (void)
 Start optional subsystems (e.g. audio) and launch the RTOS scheduler.
 
int ove_app_run (void)
 Platform entry point: initialise the board and then run the application.
 

Detailed Description

Application entry point and RTOS scheduler startup helpers.

The typical call chain is: platform main()ove_app_run()ove_main()ove_run()

Function Documentation

◆ ove_main()

void ove_main ( void  )
extern

Application-defined entry point called after board and console init.

The application must implement this function. It is responsible for creating all RTOS resources (threads, queues, timers, …) and then calling ove_run() to start the scheduler.

Note
This function must not return before calling ove_run().
See also
ove_run, ove_app_run

◆ ove_run()

void ove_run ( void  )

Start optional subsystems (e.g. audio) and launch the RTOS scheduler.

Call this from ove_main() after all resources have been created. On most platforms the scheduler never returns and this function blocks forever.

See also
ove_main

◆ ove_app_run()

int ove_app_run ( void  )

Platform entry point: initialise the board and then run the application.

Called by the platform-specific main() after registering any necessary backends. Internally it performs board and console initialisation and then calls ove_main().

Returns
0 on success. On most platforms the scheduler never returns so this function never actually reaches its return statement.
See also
ove_main