Additional dbg logging in MCUboot to allow easier finding of reason for image validation failure #2308
+159
−7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
de-nordic
force-pushed
the
additional-logs
branch
12 times, most recently
from
283c6f5 to
f183240
Compare
de-nordic
force-pushed
the
additional-logs
branch
from
f183240 to
bd265d2
Compare
nordicjm
reviewed
May 20, 2025
boot/bootutil/src/bootutil_public.c
Outdated
| @@ -783,6 +799,7 @@ boot_image_load_header(const struct flash_area *fa_p, | |||
|
|
|||
| if (!boot_u32_safe_add(&size, hdr->ih_img_size, hdr->ih_hdr_size) || | |||
| size >= flash_area_get_size(fa_p)) { | |||
| BOOT_LOG_ERR("Incorrect image size"); | |||
There was a problem hiding this comment.
should log them probably
boot/bootutil/src/encrypted.c
Outdated
| @@ -411,6 +414,8 @@ boot_decrypt_key(const uint8_t *buf, uint8_t *enckey) | |||
| uint8_t *cpend; | |||
| size_t olen; | |||
| #endif | |||
|
|
|||
| BOOT_LOG_DBG("boot_decrypt_key:"); | |||
There was a problem hiding this comment.
No, I have done several of these as a general notification that code has entered specific function.
boot/bootutil/src/image_validate.c
Outdated
| @@ -280,6 +287,8 @@ bootutil_find_key(uint8_t *keyhash, uint8_t keyhash_len) | |||
| const struct bootutil_key *key; | |||
| uint8_t hash[IMAGE_HASH_SIZE]; | |||
|
|
|||
| BOOT_LOG_DBG("bootutil_find_key:"); | |||
There was a problem hiding this comment.
likewise here, the : makes it look like there is some expected output but other ones above do not have it when there is nothing to output
boot/bootutil/src/loader.c
Outdated
Comment on lines
286
to
298
| BOOT_LOG_DBG("boot_version_cmp: ver1 %d.%d.%d vs ver2 %d.%d.%d", | ||
| ver1->iv_major, ver1->iv_minor, ver1->iv_revision, | ||
| ver2->iv_major, ver2->iv_minor, ver2->iv_revision); | ||
|
|
There was a problem hiding this comment.
this should just log the full versions part if the Kconfig is enabled, having it output in 2 parts is ugly
boot/bootutil/src/loader.c
Outdated
| @@ -2340,6 +2357,8 @@ context_boot_go(struct boot_loader_state *state, struct boot_rsp *rsp) | |||
| bool has_upgrade; | |||
| volatile int fih_cnt; | |||
|
|
|||
| BOOT_LOG_DBG("context_boot_go:"); | |||
boot/bootutil/src/image_validate.c
Outdated
| @@ -120,6 +124,7 @@ bootutil_img_hash(struct boot_loader_state *state, | |||
| /* Encrypted images only exist in the secondary slot */ | |||
| if (MUST_DECRYPT(fap, image_index, hdr) && | |||
| !boot_enc_valid(enc_state, 1)) { | |||
| BOOT_LOG_DBG("bootutil_img_hash Error: encrypted image found in primary slot"); | |||
There was a problem hiding this comment.
: should be before error and error should be lowercase like other instances
nvlsianpu
reviewed
May 20, 2025
boot/bootutil/src/bootutil_public.c
Outdated
| @@ -262,6 +264,7 @@ boot_read_swap_state(const struct flash_area *fap, | |||
| off = boot_swap_info_off(fap); | |||
| rc = flash_area_read(fap, off, &swap_info, sizeof swap_info); | |||
| if (rc < 0) { | |||
| BOOT_LOG_DBG("boot_read_swap_state: error %d reading state", rc); | |||
There was a problem hiding this comment.
For all places where code exits with BOOT_EFLASH i would go with BOOT_LOG_ERR()
de-nordic
force-pushed
the
additional-logs
branch
from
bd265d2 to
21a6163
Compare
Add additional log lines to allow easier tracking potential failures in image validation. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
Improve logging to make it easier to track image validation failures in development. Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
de-nordic
force-pushed
the
additional-logs
branch
2 times, most recently
from
1609c02 to
a2b1cf2
Compare
de-nordic
force-pushed
the
additional-logs
branch
2 times, most recently
from
24764d9 to
1609c02
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.