From 711e9ab3b66563267a970449f4328aae3e02df48 Mon Sep 17 00:00:00 2001 From: chrysn Date: Mon, 15 Feb 2021 06:01:29 +0100 Subject: [PATCH] doc: Warn against blocking in board_init --- doc/doxygen/src/porting-boards.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/doxygen/src/porting-boards.md b/doc/doxygen/src/porting-boards.md index 7a0809b87c..f5d025348f 100644 --- a/doc/doxygen/src/porting-boards.md +++ b/doc/doxygen/src/porting-boards.md @@ -60,7 +60,9 @@ somewhere else then they must be added to the include path. In Board initialization functions are defined in `board.c`. This file must at least define a `board_init()` function that is called at startup. This -function initializes the `CPU` by calling`cpu_init()` among others. +function initializes the `CPU` by calling`cpu_init()` among others. It is run +before the scheduler is started, so it must not block (e.g. by performing I2C +operations). ```c void board_init(void)