Merge pull request #1437 from NickeZ/nickez/reboot-bootloader-naming

system: reboot was actually reboot_to_bootloader

Author: NickeZ

src/memory/smarteeprom.c

@@ -22,6 +22,7 @@
 #include <screen.h>
 #include <stdint.h>
 #include <string.h>
+#include <system.h>
 
 #define SMARTEEPROM_WRITE_MODE_UNBUFFERED (0)
 #define SMARTEEPROM_WRITE_MODE_BUFFERED (1)
@@ -100,7 +101,7 @@ void smarteeprom_bb02_config(void)
      */
     if (!smarteeprom_is_enabled()) {
         smarteeprom_setup();
-        _reset_mcu();
+        reboot();
     }
     NVMCTRL->SEECFG.bit.WMODE = SMARTEEPROM_WRITE_MODE_BUFFERED;
     if (NVMCTRL->SEESTAT.bit.LOAD != 0) {

src/reset.c

@@ -18,6 +18,7 @@
 #include "keystore.h"
 #include "memory/memory.h"
 #include "memory/smarteeprom.h"
+#include "system.h"
 
 #ifndef TESTING
 #include "securechip/securechip.h"
@@ -78,7 +79,7 @@ void reset_reset(bool status)
     /* Disable SmartEEPROM, so it will be erased on next reboot. */
     smarteeprom_disable();
     _show_reset_label(status);
-    _reset_mcu();
+    reboot();
 #else
     (void)status;
 #endif

src/rust/bitbox02-rust/src/hww.rs

@@ -257,7 +257,7 @@ mod tests {
 
     /// Can initiate noise and send the Reboot protobuf request when the device is not seeded.
     #[test]
-    fn test_reboot_when_unitialized() {
+    fn test_reboot_when_uninitialized() {
         mock_memory();
 
         let mut make_request = init_noise();
@@ -275,7 +275,10 @@ mod tests {
         }));
         match reboot_called {
             Ok(()) => panic!("reboot was not called"),
-            Err(msg) => assert_eq!(msg.downcast_ref::<&str>(), Some(&"reboot called")),
+            Err(msg) => assert_eq!(
+                msg.downcast_ref::<&str>(),
+                Some(&"reboot_to_bootloader called")
+            ),
         }
         assert_eq!(
             mock_hal.ui.screens,
@@ -340,7 +343,10 @@ mod tests {
         }));
         match reboot_called {
             Ok(()) => panic!("reboot was not called"),
-            Err(msg) => assert_eq!(msg.downcast_ref::<&str>(), Some(&"reboot called")),
+            Err(msg) => assert_eq!(
+                msg.downcast_ref::<&str>(),
+                Some(&"reboot_to_bootloader called")
+            ),
         }
         assert_eq!(
             mock_hal.ui.screens,
@@ -454,7 +460,10 @@ mod tests {
         }));
         match reboot_called {
             Ok(()) => panic!("reboot was not called"),
-            Err(msg) => assert_eq!(msg.downcast_ref::<&str>(), Some(&"reboot called")),
+            Err(msg) => assert_eq!(
+                msg.downcast_ref::<&str>(),
+                Some(&"reboot_to_bootloader called")
+            ),
         }
         assert_eq!(
             mock_hal.ui.screens,

src/rust/bitbox02-rust/src/hww/api.rs

@@ -161,7 +161,7 @@ fn can_call(request: &Request) -> bool {
 /// Handle a protobuf api call.
 async fn process_api(hal: &mut impl crate::hal::Hal, request: &Request) -> Result<Response, Error> {
     match request {
-        Request::Reboot(ref request) => system::reboot(hal, request).await,
+        Request::Reboot(ref request) => system::reboot_to_bootloader(hal, request).await,
         Request::DeviceInfo(_) => device_info::process(),
         Request::DeviceName(ref request) => set_device_name::process(hal, request).await,
         Request::SetPassword(ref request) => set_password::process(hal, request).await,

src/rust/bitbox02-rust/src/hww/api/system.rs

@@ -21,7 +21,7 @@ use pb::response::Response;
 use crate::hal::Ui;
 use crate::workflow::confirm;
 
-pub async fn reboot(
+pub async fn reboot_to_bootloader(
     hal: &mut impl crate::hal::Hal,
     &pb::RebootRequest { purpose }: &pb::RebootRequest,
 ) -> Result<Response, Error> {
@@ -38,7 +38,7 @@ pub async fn reboot(
             ..Default::default()
         })
         .await?;
-    bitbox02::reboot()
+    bitbox02::reboot_to_bootloader()
 }
 
 #[cfg(test)]
@@ -52,9 +52,9 @@ mod tests {
     use alloc::boxed::Box;
 
     #[test]
-    pub fn test_reboot() {
+    pub fn test_reboot_to_bootloader() {
         let reboot_called = std::panic::catch_unwind(|| {
-            block_on(reboot(
+            block_on(reboot_to_bootloader(
                 &mut TestingHal::new(),
                 &pb::RebootRequest {
                     purpose: Purpose::Upgrade as _,
@@ -63,17 +63,20 @@ mod tests {
             .unwrap();
         });
         match reboot_called {
-            Ok(()) => panic!("reboot was not called"),
-            Err(msg) => assert_eq!(msg.downcast_ref::<&str>(), Some(&"reboot called")),
+            Ok(()) => panic!("reboot_to_bootloader was not called"),
+            Err(msg) => assert_eq!(
+                msg.downcast_ref::<&str>(),
+                Some(&"reboot_to_bootloader called")
+            ),
         }
     }
 
     #[test]
-    pub fn test_reboot_aborted() {
+    pub fn test_reboot_to_bootloader_aborted() {
         let mut mock_hal = TestingHal::new();
         mock_hal.ui.abort_nth(0);
         assert_eq!(
-            block_on(reboot(
+            block_on(reboot_to_bootloader(
                 &mut mock_hal,
                 &pb::RebootRequest {
                     purpose: Purpose::Upgrade as _

src/rust/bitbox02-sys/build.rs

@@ -108,7 +108,7 @@ const ALLOWLIST_FNS: &[&str] = &[
     "progress_set",
     "random_32_bytes_mcu",
     "random_mock_reset",
-    "reboot",
+    "reboot_to_bootloader",
     "reset_reset",
     "screen_print_debug",
     "screen_process",

src/rust/bitbox02/src/lib.rs

@@ -212,14 +212,14 @@ pub fn format_datetime(
 }
 
 #[cfg(not(feature = "testing"))]
-pub fn reboot() -> ! {
-    unsafe { bitbox02_sys::reboot() }
+pub fn reboot_to_bootloader() -> ! {
+    unsafe { bitbox02_sys::reboot_to_bootloader() }
     loop {}
 }
 
 #[cfg(feature = "testing")]
-pub fn reboot() -> ! {
-    panic!("reboot called")
+pub fn reboot_to_bootloader() -> ! {
+    panic!("reboot_to_bootloader called")
 }
 
 #[cfg(any(feature = "testing", feature = "c-unit-testing"))]

src/system.c

@@ -14,12 +14,13 @@
 
 #include "system.h"
 #include <memory/memory.h>
+#include <memory/memory_shared.h>
 #include <screen.h>
 #ifndef TESTING
 #include <driver_init.h>
 #endif
 
-void reboot(void)
+void reboot_to_bootloader(void)
 {
     auto_enter_t auto_enter = {
         .value = sectrue_u8,
@@ -35,3 +36,10 @@ void reboot(void)
     _reset_mcu();
 #endif
 }
+
+void reboot(void)
+{
+#ifndef TESTING
+    _reset_mcu();
+#endif
+}

src/system.h

@@ -15,6 +15,11 @@
 #ifndef _SYSTEM_H_
 #define _SYSTEM_H_
 
+/**
+ * Reboots the device to bootloader
+ */
+void reboot_to_bootloader(void);
+
 /**
  * Reboots the device.
  */