Mutex, counting semaphore, binary event, recursive mutex, and condition variable APIs. More...

Functions
int	ove_mutex_init (ove_mutex_t mtx, ove_mutex_storage_t storage)
	Initialise a non-recursive mutex using caller-supplied static storage.

void	ove_mutex_deinit (ove_mutex_t mtx)
	Release resources held by a mutex initialised with ove_mutex_init().

int	ove_sem_init (ove_sem_t sem, ove_sem_storage_t storage, unsigned int initial, unsigned int max)
	Initialise a counting semaphore using caller-supplied static storage.

void	ove_sem_deinit (ove_sem_t sem)
	Release resources held by a semaphore initialised with ove_sem_init().

int	ove_event_init (ove_event_t evt, ove_event_storage_t storage)
	Initialise a binary event object using caller-supplied static storage.

void	ove_event_deinit (ove_event_t evt)
	Release resources held by an event initialised with ove_event_init().

int	ove_recursive_mutex_init (ove_mutex_t mtx, ove_mutex_storage_t storage)
	Initialise a recursive mutex using caller-supplied static storage.

int	ove_condvar_init (ove_condvar_t cv, ove_condvar_storage_t storage)
	Initialise a condition variable using caller-supplied static storage.

void	ove_condvar_deinit (ove_condvar_t cv)
	Release resources held by a condition variable initialised with ove_condvar_init().

int	ove_mutex_lock (ove_mutex_t mtx, uint32_t timeout_ms)
	Acquire a non-recursive mutex, blocking until it is available or the timeout expires.

void	ove_mutex_unlock (ove_mutex_t mtx)
	Release a non-recursive mutex previously acquired by ove_mutex_lock().

int	ove_sem_take (ove_sem_t sem, uint32_t timeout_ms)
	Decrement (take) a semaphore, blocking until a count is available or the timeout expires.

void	ove_sem_give (ove_sem_t sem)
	Increment (give) a semaphore, potentially unblocking a waiting thread.

int	ove_event_wait (ove_event_t evt, uint32_t timeout_ms)
	Wait for a binary event to be signalled.

void	ove_event_signal (ove_event_t evt)
	Signal a binary event, unblocking one waiting thread.

void	ove_event_signal_from_isr (ove_event_t evt)
	Signal a binary event from an interrupt service routine.

int	ove_recursive_mutex_lock (ove_mutex_t mtx, uint32_t timeout_ms)
	Acquire a recursive mutex, blocking until it is available or the timeout expires.

void	ove_recursive_mutex_unlock (ove_mutex_t mtx)
	Release one level of a recursive mutex lock.

int	ove_condvar_wait (ove_condvar_t cv, ove_mutex_t mtx, uint32_t timeout_ms)
	Atomically release a mutex and wait on a condition variable.

void	ove_condvar_signal (ove_condvar_t cv)
	Wake one thread waiting on a condition variable.

void	ove_condvar_broadcast (ove_condvar_t cv)
	Wake all threads waiting on a condition variable.

Detailed Description

Mutex, counting semaphore, binary event, recursive mutex, and condition variable APIs.

Note: All functions in this group require CONFIG_OVE_SYNC to be defined. When CONFIG_OVE_SYNC is not set, every function is replaced by a static inline stub that returns OVE_ERR_NOT_SUPPORTED.

Two allocation strategies are available for each primitive:

_create() / _destroy() — unified API that works in both heap and zero-heap mode. In zero-heap mode these are macros that generate per-call-site static storage.
_init() / _deinit() — explicit storage control with caller-supplied buffers. Use when creating objects in loops, arrays, or structs.

Function Documentation

◆ ove_mutex_init()

int ove_mutex_init	(	ove_mutex_t *	mtx,
		ove_mutex_storage_t *	storage
	)

Initialise a non-recursive mutex using caller-supplied static storage.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[out]	mtx	Receives the opaque mutex handle on success.
[in]	storage	Pointer to statically allocated backend storage. Must remain valid for the lifetime of the mutex.

Returns: OVE_OK on success, or a negative error code on failure.

See also: ove_mutex_deinit, ove_mutex_create, ove_mutex_lock, ove_mutex_unlock

◆ ove_mutex_deinit()

void ove_mutex_deinit ( ove_mutex_t mtx )

Release resources held by a mutex initialised with ove_mutex_init().

The static storage supplied at init time is not freed.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] mtx Handle returned by ove_mutex_init().

See also: ove_mutex_init

◆ ove_sem_init()

int ove_sem_init	(	ove_sem_t *	sem,
		ove_sem_storage_t *	storage,
		unsigned int	initial,
		unsigned int	max
	)

Initialise a counting semaphore using caller-supplied static storage.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[out]	sem	Receives the opaque semaphore handle on success.
[in]	storage	Pointer to statically allocated backend storage. Must remain valid for the lifetime of the semaphore.
[in]	initial	Initial count value.
[in]	max	Maximum count value.

Returns: OVE_OK on success, or a negative error code on failure.

See also: ove_sem_deinit, ove_sem_create, ove_sem_take, ove_sem_give

◆ ove_sem_deinit()

void ove_sem_deinit ( ove_sem_t sem )

Release resources held by a semaphore initialised with ove_sem_init().

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] sem Handle returned by ove_sem_init().

See also: ove_sem_init

◆ ove_event_init()

int ove_event_init	(	ove_event_t *	evt,
		ove_event_storage_t *	storage
	)

Initialise a binary event object using caller-supplied static storage.

A binary event starts in the unsignalled state. One waiter is unblocked per ove_event_signal() call.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[out]	evt	Receives the opaque event handle on success.
[in]	storage	Pointer to statically allocated backend storage. Must remain valid for the lifetime of the event.

Returns: OVE_OK on success, or a negative error code on failure.

See also: ove_event_deinit, ove_event_create, ove_event_wait, ove_event_signal

◆ ove_event_deinit()

void ove_event_deinit ( ove_event_t evt )

Release resources held by an event initialised with ove_event_init().

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] evt Handle returned by ove_event_init().

See also: ove_event_init

◆ ove_recursive_mutex_init()

int ove_recursive_mutex_init	(	ove_mutex_t *	mtx,
		ove_mutex_storage_t *	storage
	)

Initialise a recursive mutex using caller-supplied static storage.

A recursive mutex may be locked multiple times by the same thread without deadlocking. Each successful lock must be paired with an unlock.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[out]	mtx	Receives the opaque mutex handle on success.
[in]	storage	Pointer to statically allocated backend storage. Must remain valid for the lifetime of the mutex.

Returns: OVE_OK on success, or a negative error code on failure.

See also: ove_mutex_deinit, ove_recursive_mutex_create, ove_recursive_mutex_lock, ove_recursive_mutex_unlock

◆ ove_condvar_init()

int ove_condvar_init	(	ove_condvar_t *	cv,
		ove_condvar_storage_t *	storage
	)

Initialise a condition variable using caller-supplied static storage.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[out]	cv	Receives the opaque condition variable handle on success.
[in]	storage	Pointer to statically allocated backend storage. Must remain valid for the lifetime of the condvar.

Returns: OVE_OK on success, or a negative error code on failure.

See also: ove_condvar_deinit, ove_condvar_create, ove_condvar_wait, ove_condvar_signal, ove_condvar_broadcast

◆ ove_condvar_deinit()

void ove_condvar_deinit ( ove_condvar_t cv )

Release resources held by a condition variable initialised with ove_condvar_init().

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] cv Handle returned by ove_condvar_init().

See also: ove_condvar_init

◆ ove_mutex_lock()

int ove_mutex_lock	(	ove_mutex_t	mtx,
		uint32_t	timeout_ms
	)

Acquire a non-recursive mutex, blocking until it is available or the timeout expires.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in]	mtx	Mutex handle obtained from ove_mutex_init() or ove_mutex_create().
[in]	timeout_ms	Maximum time to wait in milliseconds. Pass `OVE_WAIT_FOREVER` to block indefinitely.

Returns: OVE_OK on success, OVE_ERR_TIMEOUT if the deadline was reached, or another negative error code on failure.

See also: ove_mutex_unlock

◆ ove_mutex_unlock()

void ove_mutex_unlock ( ove_mutex_t mtx )

Release a non-recursive mutex previously acquired by ove_mutex_lock().

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] mtx Mutex handle to release.

See also: ove_mutex_lock

◆ ove_sem_take()

int ove_sem_take	(	ove_sem_t	sem,
		uint32_t	timeout_ms
	)

Decrement (take) a semaphore, blocking until a count is available or the timeout expires.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in]	sem	Semaphore handle obtained from ove_sem_init() or ove_sem_create().
[in]	timeout_ms	Maximum time to wait in milliseconds. Pass `OVE_WAIT_FOREVER` to block indefinitely.

Returns: OVE_OK on success, OVE_ERR_TIMEOUT if the deadline was reached, or another negative error code on failure.

See also: ove_sem_give

◆ ove_sem_give()

void ove_sem_give ( ove_sem_t sem )

Increment (give) a semaphore, potentially unblocking a waiting thread.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] sem Semaphore handle to increment.

See also: ove_sem_take

◆ ove_event_wait()

int ove_event_wait	(	ove_event_t	evt,
		uint32_t	timeout_ms
	)

Wait for a binary event to be signalled.

Blocks the calling thread until ove_event_signal() or ove_event_signal_from_isr() is called on evt, or until the timeout expires. The event is automatically reset (consumed) after a successful wait.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in]	evt	Event handle obtained from ove_event_init() or ove_event_create().
[in]	timeout_ms	Maximum time to wait in milliseconds. Pass `OVE_WAIT_FOREVER` to block indefinitely.

Returns: OVE_OK on success, OVE_ERR_TIMEOUT if the deadline was reached, or another negative error code on failure.

See also: ove_event_signal, ove_event_signal_from_isr

◆ ove_event_signal()

void ove_event_signal ( ove_event_t evt )

Signal a binary event, unblocking one waiting thread.

Safe to call from any thread context. Must not be called from an ISR — use ove_event_signal_from_isr() instead.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] evt Event handle to signal.

See also: ove_event_wait, ove_event_signal_from_isr

◆ ove_event_signal_from_isr()

void ove_event_signal_from_isr ( ove_event_t evt )

Signal a binary event from an interrupt service routine.

ISR-safe variant of ove_event_signal(). May trigger a context switch to a higher-priority thread after the ISR exits.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] evt Event handle to signal.

See also: ove_event_signal, ove_event_wait

◆ ove_recursive_mutex_lock()

int ove_recursive_mutex_lock	(	ove_mutex_t	mtx,
		uint32_t	timeout_ms
	)

Acquire a recursive mutex, blocking until it is available or the timeout expires.

The same thread may call this function multiple times without deadlocking. Each successful lock must be balanced by a call to ove_recursive_mutex_unlock().

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in]	mtx	Recursive mutex handle obtained from ove_recursive_mutex_init() or ove_recursive_mutex_create().
[in]	timeout_ms	Maximum time to wait in milliseconds. Pass `OVE_WAIT_FOREVER` to block indefinitely.

Returns: OVE_OK on success, OVE_ERR_TIMEOUT if the deadline was reached, or another negative error code on failure.

See also: ove_recursive_mutex_unlock

◆ ove_recursive_mutex_unlock()

void ove_recursive_mutex_unlock ( ove_mutex_t mtx )

Release one level of a recursive mutex lock.

Decrements the recursive lock count. The mutex is fully released and made available to other threads only when the count reaches zero.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] mtx Recursive mutex handle to unlock.

See also: ove_recursive_mutex_lock

◆ ove_condvar_wait()

int ove_condvar_wait	(	ove_condvar_t	cv,
		ove_mutex_t	mtx,
		uint32_t	timeout_ms
	)

Atomically release a mutex and wait on a condition variable.

The mutex mtx must be held by the calling thread before this call. It is released atomically as the thread begins waiting. When the function returns (either due to a signal or timeout), mtx is re-acquired before returning to the caller.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in]	cv	Condition variable handle obtained from ove_condvar_init() or ove_condvar_create().
[in]	mtx	Mutex that guards the condition. Must be locked by the calling thread.
[in]	timeout_ms	Maximum time to wait in milliseconds. Pass `OVE_WAIT_FOREVER` to block indefinitely.

Returns: OVE_OK on success, OVE_ERR_TIMEOUT if the deadline was reached, or another negative error code on failure.

See also: ove_condvar_signal, ove_condvar_broadcast

◆ ove_condvar_signal()

void ove_condvar_signal ( ove_condvar_t cv )

Wake one thread waiting on a condition variable.

If no threads are waiting, the signal is lost (not stored).

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] cv Condition variable handle to signal.

See also: ove_condvar_wait, ove_condvar_broadcast

◆ ove_condvar_broadcast()

void ove_condvar_broadcast ( ove_condvar_t cv )

Wake all threads waiting on a condition variable.

Note: Requires CONFIG_OVE_SYNC.

Parameters

[in] cv Condition variable handle to broadcast on.

See also: ove_condvar_wait, ove_condvar_signal

Functions

Detailed Description

Function Documentation

◆ ove_mutex_init()

◆ ove_mutex_deinit()

◆ ove_sem_init()

◆ ove_sem_deinit()

◆ ove_event_init()

◆ ove_event_deinit()

◆ ove_recursive_mutex_init()

◆ ove_condvar_init()

◆ ove_condvar_deinit()

◆ ove_mutex_lock()

◆ ove_mutex_unlock()

◆ ove_sem_take()

◆ ove_sem_give()

◆ ove_event_wait()

◆ ove_event_signal()

◆ ove_event_signal_from_isr()

◆ ove_recursive_mutex_lock()

◆ ove_recursive_mutex_unlock()

◆ ove_condvar_wait()

◆ ove_condvar_signal()

◆ ove_condvar_broadcast()