OVE_*_DEFINE_STATIC Macros

One-step static primitive declaration with automatic initialisation. More...

Collaboration diagram for OVE_*_DEFINE_STATIC Macros:

Macros
#define	OVE_MUTEX_DEFINE_STATIC(name)
	Declare and auto-initialise a static mutex (heap mode).
#define	OVE_RECURSIVE_MUTEX_DEFINE_STATIC(name)
	Declare and auto-initialise a static recursive mutex (heap mode).
#define	OVE_SEM_DEFINE_STATIC(name, initial, max)
	Declare and auto-initialise a static semaphore (heap mode).
#define	OVE_EVENT_DEFINE_STATIC(name)
	Declare and auto-initialise a static event object (heap mode).
#define	OVE_CONDVAR_DEFINE_STATIC(name)
	Declare and auto-initialise a static condition variable (heap mode).
#define	OVE_THREAD_DEFINE_STATIC(hname, stack_sz, fn, ctx, prio, tname)
	Declare and auto-initialise a static thread (heap mode).
#define	OVE_QUEUE_DEFINE_STATIC(name, item_sz, max)
	Declare and auto-initialise a static message queue (heap mode).
#define	OVE_TIMER_DEFINE_STATIC(name, cb, user_data, period_ms, one_shot)
	Declare and auto-initialise a static timer (heap mode).
#define	OVE_EVENTGROUP_DEFINE_STATIC(name)
	Declare and auto-initialise a static event group (heap mode).
#define	OVE_WORKQUEUE_DEFINE_STATIC(name, stack_sz, wq_name, prio)
	Declare and auto-initialise a static work queue (heap mode).
#define	OVE_WORK_DEFINE_STATIC(name, handler)
	Declare and auto-initialise a static work item (heap mode).
#define	OVE_STREAM_DEFINE_STATIC(name, buf_sz, trigger)
	Declare and auto-initialise a static stream buffer (heap mode).
#define	OVE_WATCHDOG_DEFINE_STATIC(name, timeout_ms)
	Declare and auto-initialise a static watchdog timer (heap mode).

Detailed Description

One-step static primitive declaration with automatic initialisation.

Each macro declares a handle and a C constructor (__attribute__((constructor))) that initialises the handle before main(). No runtime init boilerplate or #ifdef guards are needed.

• In zero-heap mode (CONFIG_OVE_ZERO_HEAP) the constructor calls the corresponding _init() function with static storage.
• In heap mode the constructor calls _create() so the macros work on every backend without modification.

Usage:

OVE_QUEUE_DEFINE_STATIC(my_q, sizeof(int), 8);
// my_q is ready to use in any function.

Macro Definition Documentation

OVE_MUTEX_DEFINE_STATIC

#define OVE_MUTEX_DEFINE_STATIC

(

name

)

Value:

    static ove_mutex_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_mutex_create(&name); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static mutex (heap mode).

Parameters

name	Variable name for the resulting ove_mutex_t handle.

OVE_RECURSIVE_MUTEX_DEFINE_STATIC

#define OVE_RECURSIVE_MUTEX_DEFINE_STATIC

(

name

)

Value:

    static ove_mutex_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_recursive_mutex_create(&name); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static recursive mutex (heap mode).

Parameters

name	Variable name for the resulting ove_mutex_t handle.

OVE_SEM_DEFINE_STATIC

#define OVE_SEM_DEFINE_STATIC	(		name,
			initial,
			max
	)

Value:

    static ove_sem_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_sem_create(&name, (initial), (max)); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static semaphore (heap mode).

Parameters

name	Variable name for the resulting ove_sem_t handle.
initial	Initial semaphore count.
max	Maximum semaphore count.

OVE_EVENT_DEFINE_STATIC

#define OVE_EVENT_DEFINE_STATIC

(

name

)

Value:

    static ove_event_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_event_create(&name); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static event object (heap mode).

Parameters

name	Variable name for the resulting ove_event_t handle.

OVE_CONDVAR_DEFINE_STATIC

#define OVE_CONDVAR_DEFINE_STATIC

(

name

)

Value:

    static ove_condvar_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_condvar_create(&name); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static condition variable (heap mode).

Parameters

name	Variable name for the resulting ove_condvar_t handle.

OVE_THREAD_DEFINE_STATIC

#define OVE_THREAD_DEFINE_STATIC	(		hname,
			stack_sz,
			fn,
			ctx,
			prio,
			tname
	)

Value:

    static ove_thread_t hname; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(hname) \
        struct ove_thread_desc _desc = { \
            .name = (tname), \
            .entry = (fn), \
            .arg = (ctx), \
            .priority = (prio), \
            .stack_size = (stack_sz), \
        }; \
        int _err = ove_thread_create_(&hname, &_desc); \
    OVE_DEFINE_STATIC_CTOR_END_(hname)

Declare and auto-initialise a static thread (heap mode).

Parameters

hname	Variable name for the resulting ove_thread_t handle.
stack_sz	Thread stack size in bytes.
fn	Thread entry function.
ctx	Argument passed to fn.
prio	Thread priority.
tname	Human-readable thread name string.

OVE_QUEUE_DEFINE_STATIC

#define OVE_QUEUE_DEFINE_STATIC	(		name,
			item_sz,
			max
	)

Value:

    static ove_queue_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_queue_create(&name, (item_sz), (max)); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static message queue (heap mode).

Parameters

name	Variable name for the resulting ove_queue_t handle.
item_sz	Size of each queue item in bytes.
max	Maximum number of items in the queue.

OVE_TIMER_DEFINE_STATIC

#define OVE_TIMER_DEFINE_STATIC	(		name,
			cb,
			user_data,
			period_ms,
			one_shot
	)

Value:

    static ove_timer_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_timer_create(&name, \
            (cb), (user_data), (period_ms), (one_shot)); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static timer (heap mode).

Parameters

name	Variable name for the resulting ove_timer_t handle.
cb	Timer expiry callback.
user_data	Opaque pointer forwarded to cb.
period_ms	Timer period in milliseconds.
one_shot	Non-zero for a one-shot timer, zero for periodic.

OVE_EVENTGROUP_DEFINE_STATIC

#define OVE_EVENTGROUP_DEFINE_STATIC

(

name

)

Value:

    static ove_eventgroup_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_eventgroup_create(&name); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static event group (heap mode).

Parameters

name	Variable name for the resulting ove_eventgroup_t handle.

OVE_WORKQUEUE_DEFINE_STATIC

#define OVE_WORKQUEUE_DEFINE_STATIC	(		name,
			stack_sz,
			wq_name,
			prio
	)

Value:

    static ove_workqueue_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_workqueue_create(&name, \
            (wq_name), (prio), (stack_sz)); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static work queue (heap mode).

Parameters

name	Variable name for the resulting ove_workqueue_t handle.
stack_sz	Stack size in bytes for the work queue thread.
wq_name	Human-readable work queue name string.
prio	Thread priority for the work queue thread.

OVE_WORK_DEFINE_STATIC

#define OVE_WORK_DEFINE_STATIC	(		name,
			handler
	)

Value:

    static ove_work_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_work_init(&name, (handler)); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static work item (heap mode).

Parameters

name	Variable name for the resulting ove_work_t handle.
handler	Work handler function invoked when the item is executed.

OVE_STREAM_DEFINE_STATIC

#define OVE_STREAM_DEFINE_STATIC	(		name,
			buf_sz,
			trigger
	)

Value:

    static ove_stream_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_stream_create(&name, \
            (buf_sz), (trigger)); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static stream buffer (heap mode).

Parameters

name	Variable name for the resulting ove_stream_t handle.
buf_sz	Stream buffer capacity in bytes.
trigger	Minimum bytes required before a blocked reader is unblocked.

OVE_WATCHDOG_DEFINE_STATIC

#define OVE_WATCHDOG_DEFINE_STATIC	(		name,
			timeout_ms
	)

Value:

    static ove_watchdog_t name; \
    OVE_DEFINE_STATIC_CTOR_BEGIN_(name) \
        int _err = ove_watchdog_create(&name, (timeout_ms)); \
    OVE_DEFINE_STATIC_CTOR_END_(name)

Declare and auto-initialise a static watchdog timer (heap mode).

Parameters

name	Variable name for the resulting ove_watchdog_t handle.
timeout_ms	Watchdog timeout in milliseconds.