ESP_SYSTEM_INIT_FN macro

Define a system initialization function which will be executed on the specified cores The function defined using this macro must return ESP_OK on success. Any other value will be logged and the startup process will abort. Initialization functions should be placed in a compilation unit where at least one other symbol is referenced in another compilation unit. This means that the reference should not itself get optimized out by the compiler or discarded by the linker if the related feature is used. It is, on the other hand, a good practice to make sure the initialization function does get discarded if the related feature is not used.

Syntax

Show:

Summary

Declaration

from startup_internal.h:74

#define ESP_SYSTEM_INIT_FN(f, stage_, c, priority, ...) \ static esp_err_t __VA_ARGS__ __esp_system_init_fn_##f(void); \ static __attribute__((used)) _SECTION_ATTR_IMPL(".esp_system_init_fn", priority) \ esp_system_init_fn_t esp_system_init_fn_##f = { \ .fn = ( __esp_system_init_fn_##f), \ .cores = (c), \ .stage = ESP_SYSTEM_INIT_STAGE_##stage_ \ }; \ static esp_err_t __esp_system_init_fn_##f(void)

Arguments

Argument

Description

function name (identifier)

stage_

init stage name (CORE or SECONDARY)

bit mask of cores to execute the function on (ex. if BIT0 is set, the function will be executed on CPU 0, if BIT1 is set - on CPU 1, and so on)

priority

integer, priority of the initialization function. Higher values mean that the function will be executed later in the process.

Examples

References

from examples

ESP_SYSTEM_INIT_FN macro

Syntax

Arguments

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle