Skip to content

Commit 581bd8a

Browse files
committed
cpu: add documentation for DISABLE_BOARD_INIT/DISABLE_CPU_INIT
1 parent 5e2ec9d commit 581bd8a

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

cpu/doc.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,27 @@
2020
* @ingroup config
2121
* @brief Compile time configurations for different kinds of CPU.
2222
*/
23+
24+
/**
25+
* @brief Skip calling `board_init()`
26+
*
27+
* Don't call `board_init()`, leave all pins in their default state.
28+
*
29+
* This is intended to be used with basic riotboot_slot which does not interact
30+
* with any external hardware.
31+
*
32+
* @experimental Only use this if you know what you are doing
33+
*/
34+
#define DISABLE_BOARD_INIT 0
35+
36+
/**
37+
* @brief Skip calling `cpu_init()`
38+
*
39+
* Don't call `cpu_init()`, leave all CPU configuration in boot-up state.
40+
*
41+
* This is intended to be used with basic riotboot_slot which does not interact
42+
* with any CPU peripherals.
43+
*
44+
* @experimental Only use this if you know what you are doing
45+
*/
46+
#define DISABLE_CPU_INIT 0

0 commit comments

Comments
 (0)