mirrors/u-boot
1
0
Fork 0
mirror of https://source.denx.de/u-boot/u-boot.git synced 2025-08-08 08:16:59 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

cyclic: doc: Update documentation for CONFIG_CYCLIC_MAX_CPU_TIME_US

Browse Source 
Cyclic now just print a warning once instead of disabling the cyclic
function when the cyclic function upon exceeding CPU time usage.

Fixes: ddc8d36a74 ("cyclic: Don't disable cylic function upon exceeding CPU time")
Signed-off-by: Weizhao Ouyang <o451686892@gmail.com>

Rephrase the paragraph.
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Weizhao Ouyang 2023-10-07 10:52:36 +00:00 committed by Heinrich Schuchardt
parent 58ec39c31c
commit 9e5116433d
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/develop/cyclic.rst
View File

@ -8,11 +8,11 @@ execute code, e.g. every 100ms. Examples for such functions might be LED
blinking etc. The functions that are hooked into this cyclic list should blinking etc. The functions that are hooked into this cyclic list should
be small timewise as otherwise the execution of the other code that relies be small timewise as otherwise the execution of the other code that relies
on a high frequent polling (e.g. UART rx char ready check) might be on a high frequent polling (e.g. UART rx char ready check) might be
delayed too much. To detect cyclic functions with a too long execution delayed too much. To detect cyclic functions with an excessive execution
time, the Kconfig option `CONFIG_CYCLIC_MAX_CPU_TIME_US` is introduced, time, the Kconfig option `CONFIG_CYCLIC_MAX_CPU_TIME_US` was introduced.
which configures the max allowed time for such a cyclic function. If it's It defines the maximum allowable execution time for such a cyclic function. The
execution time exceeds this time, this cyclic function will get removed first time the execution of a cyclic function exceeds this interval, a warning
from the cyclic list. will be displayed indicating the problem to the user.
Registering a cyclic function Registering a cyclic function
----------------------------- -----------------------------