Board Initialization

Board-level initialisation and identification. More...

Functions
int	ove_board_init (void)
	Initialise the board hardware.
const char *	ove_board_name (void)
	Return a human-readable name for the current board.
const struct ove_board_desc *	ove_board_desc (void)
	Return a pointer to the current board's descriptor structure.

Detailed Description

Board-level initialisation and identification.

Exposes the board name, the full board descriptor, and a single initialisation entry-point that sets up clocks, memory, and peripheral infrastructure required before any other oveRTOS API is used.

Note

Requires CONFIG_OVE_BOARD. When the option is disabled every function is replaced by a harmless stub.

Function Documentation

ove_board_init()

int ove_board_init

(

void

)

Initialise the board hardware.

Configures system clocks, enables necessary peripherals, and performs any board-specific low-level setup. Must be called once before any other oveRTOS API.

Returns

OVE_OK on success, negative error code on failure.

ove_board_name()

const char * ove_board_name

(

void

)

Return a human-readable name for the current board.

The returned pointer is valid for the lifetime of the program.

Returns

Null-terminated board name string (e.g. "STM32F4-Discovery").

ove_board_desc()

const struct ove_board_desc * ove_board_desc

(

void

)

Return a pointer to the current board's descriptor structure.

The descriptor contains GPIO port counts, LED definitions, and MCU identification fields.

Returns

Pointer to a read-only ove_board_desc, or NULL if no descriptor is registered.