auto_init_utils.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2022 Otto-von-Guericke-Universität Magdebug
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
9 #pragma once
10 
30 #include <stdint.h>
31 #include "xfa.h"
32 #include "macros/xtstr.h"
33 #include "modules.h"
34 #if IS_USED(MODULE_PREPROCESSOR_SUCCESSOR)
35 #include "preprocessor_successor.h"
36 #endif
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 #ifndef CONFIG_AUTO_INIT_ENABLE_DEBUG
46 #define CONFIG_AUTO_INIT_ENABLE_DEBUG 0
47 #endif
48 
52 typedef void (*auto_init_fn_t)(void);
53 
57 typedef uint16_t auto_init_prio_t;
58 
62 typedef struct {
63  auto_init_fn_t init;
64 #if IS_ACTIVE(CONFIG_AUTO_INIT_ENABLE_DEBUG) || defined(DOXYGEN)
65  auto_init_prio_t prio;
66  const char *name;
67 #endif
68 } auto_init_module_t;
69 
70 #if IS_ACTIVE(CONFIG_AUTO_INIT_ENABLE_DEBUG) || defined(DOXYGEN)
77 #define AUTO_INIT(function, priority) \
78  XFA_CONST(auto_init_module_t, auto_init_xfa, priority) \
79  auto_init_xfa_ ## function \
80  = { .init = (auto_init_fn_t)function, \
81  .prio = priority, \
82  .name = XTSTR(function) }
83 #else
84 #define AUTO_INIT(function, priority) \
85  XFA_CONST(auto_init_module_t, auto_init_xfa, priority) \
86  auto_init_xfa_ ## function \
87  = { .init = (auto_init_fn_t)function }
88 #endif
89 
94 #define AUTO_INIT_PRIORITY_AFTER(priority) RIOT_PP_SUCCESSOR(priority)
95 
96 #ifdef __cplusplus
97 }
98 #endif
99 
auto_init_fn_t
void(* auto_init_fn_t)(void)
Auto-init function type.
Definition: auto_init_utils.h:52
auto_init_prio_t
uint16_t auto_init_prio_t
Data type to store the priority of a module.
Definition: auto_init_utils.h:57
modules.h
Common macros and compiler attributes/pragmas configuration.
auto_init_module_t
Type to represent a module to be auto-initialized.
Definition: auto_init_utils.h:62
auto_init_module_t::prio
auto_init_prio_t prio
Module priority.
Definition: auto_init_utils.h:65
auto_init_module_t::name
const char * name
Module auto-init function name.
Definition: auto_init_utils.h:66
auto_init_module_t::init
auto_init_fn_t init
Function to initialize the module.
Definition: auto_init_utils.h:63
xfa.h
Cross File Arrays.
xtstr.h
Macro to return string representation of x.