commit 067f30ae96e12f10422d91ace8eaa8417f142675
author Piotr Dymacz <pepe2k@gmail.com> Fri Aug 12 18:25:34 2022 +0200
committer Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Sat Aug 13 16:02:53 2022 +0200
tree 9680c72be722f9638691179a236850c931a129e5
parent 3942e9bf8f606dab46cbd6ed22c459382d85422b

boot_serial: explain disabled idle state in timeout based recovery

This adds short explanation (in form of a comment) why CPU shouldn't
enter idle state in timeout based serial recovery.

Ref: 3942e9bf8f60 ("boot_serial: fix serial recovery mode with timeout")
Signed-off-by: Piotr Dymacz <pepe2k@gmail.com>

boot/boot_serial/src/boot_serial.c

diff --git a/boot/boot_serial/src/boot_serial.c b/boot/boot_serial/src/boot_serial.c
index 468fa6a..6070a3b 100644
--- a/boot/boot_serial/src/boot_serial.c
+++ b/boot/boot_serial/src/boot_serial.c
@@ -849,6 +849,11 @@
 
     off = 0;
     while (timeout_in_ms > 0 || bs_entry) {
+        /*
+         * Don't enter CPU idle state here if timeout based serial recovery is
+         * used as otherwise the boot process hangs forever, waiting for input
+         * from serial console (if single-thread mode is used).
+         */
 #ifndef MCUBOOT_SERIAL_WAIT_FOR_DFU
         MCUBOOT_CPU_IDLE();
 #endif