Merge pull request #1362 from NickeZ/nickez/bootloader-rtt

Debug: Adds RTT support to bootloader

Author: NickeZ

bootloader.ld

@@ -110,6 +110,17 @@ SECTIONS
     . = ALIGN(4);
     _etext = .;
 
+    /* Place RTT allocations first in RAM in debug builds, so that they are
+     * aligned between bootloader and firmware */
+    .rtt (NOLOAD) :
+    {
+        . = ALIGN(4);
+        _srtt = .;
+        *(.segger_rtt);
+        *(.segger_rtt_buf);
+        _ertt = .;
+    } > ram
+
     .relocate :
     {
         . = ALIGN(4);

firmware.ld

@@ -109,6 +109,17 @@ SECTIONS
     . = ALIGN(4);
     _etext = .;
 
+    /* Place RTT allocations first in RAM in debug builds, so that they are
+     * aligned between bootloader and firmware */
+    .rtt (NOLOAD) :
+    {
+        . = ALIGN(4);
+        _srtt = .;
+        *(.segger_rtt);
+        *(.segger_rtt_buf);
+        _ertt = .;
+    } > ram
+
     .relocate :
     {
         . = ALIGN(4);

src/bootloader/bootloader.c

@@ -207,6 +207,8 @@ void _binExec(void* l_code_addr)
 
 static void _binary_exec(void)
 {
+    util_log("Jumping to firmware");
+    util_log_flush();
     _render_bootloader_finished_marker();
 
     int i;
@@ -988,6 +990,7 @@ void bootloader_jump(void)
     }
 
     // App not entered. Start USB API to receive boot commands
+    util_log("Not jumping to firmware");
     _compute_is_app_flash_empty();
     _render_default_screen();
     if (usb_start(_api_setup) != ERR_NONE) {

src/hardfault.c

@@ -35,6 +35,7 @@ void MemManage_Handler(void)
 
 void Abort(const char* msg)
 {
+    util_log("%s", msg);
     screen_print_debug(msg, 0);
     usb_stop();
 #if !defined(TESTING)

src/optiga/pal/pal_os_datastore.c

@@ -49,6 +49,7 @@ pal_status_t pal_os_datastore_write(uint16_t datastore_id, const uint8_t* p_buff
 {
     (void)p_buffer;
     (void)length;
+    (void)datastore_id;
     util_log("pal_datastore_write, id=%d", datastore_id);
     return PAL_STATUS_FAILURE;
 }

src/platform/platform_init.c

@@ -18,18 +18,24 @@
 #if !defined(BOOTLOADER)
 #include "sd_mmc/sd_mmc_start.h"
 #endif
-#include "rust/rust.h"
+#include "util.h"
+
+#if defined(BOOTLOADER)
+#define PREFIX "boot"
+#else
+#define PREFIX "fw"
+#endif
 
 void platform_init(void)
 {
     oled_init();
-#if !defined(BOOTLOADER)
 // The factory setup image already has a c implementation of RTT.
 #if FACTORYSETUP != 1
     // these two functions are noops if "rtt" feature isn't enabled in rust
-    rust_rtt_init();
-    util_log("platform_init");
+    util_log_init();
+    util_log(PREFIX ": platform_init");
 #endif
+#if !defined(BOOTLOADER)
     sd_mmc_start();
 #endif
 }

src/rust/.cargo/config.toml

@@ -1,6 +1,11 @@
 [source.crates-io]
 replace-with = "vendored-sources"
 
+[source."git+https://github.com/probe-rs/rtt-target.git?rev=117d9519a5d3b1f4bc024bc05f9e3c5dec0a57f5"]
+git = "https://github.com/probe-rs/rtt-target.git"
+rev = "117d9519a5d3b1f4bc024bc05f9e3c5dec0a57f5"
+replace-with = "vendored-sources"
+
 [source."git+https://github.com/digitalbitbox/rust-bip32-ed25519?tag=v0.1.2"]
 git = "https://github.com/BitBoxSwiss/rust-bip32-ed25519"
 tag = "v0.2.0"

src/rust/Cargo.lock

@@ -36,6 +36,9 @@ sha2 = { version = "0.10.8", default-features = false }
 sha3 = { version = "0.10.8", default-features = false }
 zeroize = "1.7.0"
 
+[patch.crates-io]
+rtt-target = { git = "https://github.com/probe-rs/rtt-target.git", rev = "117d9519a5d3b1f4bc024bc05f9e3c5dec0a57f5" }
+
 [profile.release]
 # This only affects the .elf output. Debug info is stripped from the final .bin.
 # Paths to source code can still appear in the final bin, as they are part of the panic!() output.

src/rust/Cargo.toml

@@ -59,6 +59,11 @@ pub extern "C" fn rust_rtt_init() {
     ::util::log::rtt_init();
 }
 
+#[no_mangle]
+pub extern "C" fn rust_rtt_flush() {
+    ::util::log::rtt_flush();
+}
+
 /// # Safety
 ///
 /// The pointer `ptr` must point to a null terminated string

src/rust/bitbox02-rust-c/src/lib.rs

@@ -22,7 +22,7 @@ license = "Apache-2.0"
 
 [dependencies]
 num-bigint = { workspace = true, default-features = false }
-rtt-target = { version = "0.5.0", optional = true }
+rtt-target = { version = "0.6.1", optional = true }
 cortex-m = { version = "0.7.7", features = ["critical-section-single-core"], optional = true }
 
 [features]

src/rust/util/Cargo.toml

@@ -13,6 +13,27 @@ pub use log;
 
 pub fn rtt_init() {
     #[cfg(feature = "rtt")]
-    rtt_target::rtt_init_print!();
-    log!("RTT Initialized");
+    {
+        let channels = rtt_target::rtt_init! {
+            up: {
+                0: {
+                    size: 1024,
+                    mode: rtt_target::ChannelMode::NoBlockSkip,
+                    name: "Terminal",
+                    section: ".segger_rtt_buf",
+                }
+            }
+            section_cb: ".segger_rtt"
+        };
+
+        rtt_target::set_print_channel(channels.up.0);
+
+        log!("RTT Initialized");
+    }
+}
+
+/// Wait until all messages have been read by host
+pub fn rtt_flush() {
+    #[cfg(feature = "rtt")]
+    rtt_target::with_terminal_channel(|c| c.flush());
 }