Merge commit 'refs/pull/1270/head' of https://github.com/BitBoxSwiss/bitbox02-firmware

Author: benma

CHANGELOG.md

@@ -12,6 +12,8 @@ customers cannot upgrade their bootloader, its changes are recorded separately.
 - Bitcoin: UX improvements for payment request confirmations
 - Ethereum: display the addresses on device in the same case as the user input
 - Allow exiting the screen asking to insert the microSD card
+- SD card: Remove API to prompt removal of the microSD card
+- SD card: add auto-detection of insertion
 
 ### 9.19.0
 - Display device name on screen before unlock

py/bitbox02/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## [Unreleased]
 
+# 8.0.0
+- SD card: Remove API to prompt removal of the microSD card from the device
+
 # 7.0.0
 - get_info: add optional device initialized boolean to returned tuple
 - eth_sign: add address_case field, which should be initialized by the client

py/bitbox02/bitbox02/bitbox02/bitbox02.py

@@ -648,16 +648,6 @@ def insert_sdcard(self) -> None:
         )
         self._msg_query(request, expected_response="success")
 
-    def remove_sdcard(self) -> None:
-        # pylint: disable=no-member
-        request = hww.Request()
-        request.insert_remove_sdcard.CopyFrom(
-            bitbox02_system.InsertRemoveSDCardRequest(
-                action=bitbox02_system.InsertRemoveSDCardRequest.REMOVE_CARD
-            )
-        )
-        self._msg_query(request, expected_response="success")
-
     def root_fingerprint(self) -> bytes:
         """
         Get the root fingerprint from the bitbox02

py/send_message.py

@@ -220,7 +220,6 @@ def backup_sd() -> None:
                 return
             print("Backup created sucessfully")
             print("Please Remove SD Card")
-            self._device.remove_sdcard()
 
         def backup_mnemonic() -> None:
             if self._device.version < semver.VersionInfo(9, 13, 0):
@@ -284,7 +283,6 @@ def _restore_backup_workflow(self) -> None:
             eprint("Restoring backup failed")
             return
         print("Please Remove SD Card")
-        self._device.remove_sdcard()
 
     def _restore_from_mnemonic(self) -> None:
         try:
@@ -317,9 +315,6 @@ def _insert_sdcard(self) -> None:
         except UserAbortException:
             print("Aborted by user")
 
-    def _remove_sdcard(self) -> None:
-        self._device.remove_sdcard()
-
     def _get_root_fingerprint(self) -> None:
         print(f"Root fingerprint: {self._device.root_fingerprint().hex()}")
 
@@ -1390,7 +1385,6 @@ def _menu_init(self) -> None:
             ("Reboot into bootloader", self._reboot),
             ("Check if SD card inserted", self._check_sd_presence),
             ("Insert SD card", self._insert_sdcard),
-            ("Remove SD card", self._remove_sdcard),
             ("Toggle BIP39 Mnemonic Passphrase", self._toggle_mnemonic_passphrase),
             ("Retrieve Ethereum xpub", self._get_eth_xpub),
             ("Retrieve Ethereum address", self._display_eth_address),

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

@@ -24,17 +24,15 @@ pub async fn process(
     &pb::InsertRemoveSdCardRequest { action }: &pb::InsertRemoveSdCardRequest,
 ) -> Result<Response, Error> {
     let inserted = bitbox02::sd::sdcard_inserted();
-    let action = match SdCardAction::try_from(action) {
-        Ok(action) => action,
-        Err(_) => return Ok(Response::Success(pb::Success {})),
+    match SdCardAction::try_from(action) {
+        Ok(SdCardAction::InsertCard) => {},
+        _ => return Ok(Response::Success(pb::Success {})),
     };
-    // No action required, already inserted (INSERT request) or not inserted (REMOVE request)
-    if (action == SdCardAction::InsertCard && inserted)
-        || (action == SdCardAction::RemoveCard && !inserted)
+    if inserted
     {
         return Ok(Response::Success(pb::Success {}));
     }
-    sdcard::sdcard(action == SdCardAction::InsertCard).await?;
+    sdcard::sdcard().await?;
     Ok(Response::Success(pb::Success {}))
 }
 
@@ -75,7 +73,6 @@ mod tests {
         // insert
         mock(Data {
             sdcard_inserted: Some(false),
-            ui_sdcard_create_arg: Some(true),
             ..Default::default()
         });
         assert_eq!(
@@ -88,7 +85,6 @@ mod tests {
         // remove
         mock(Data {
             sdcard_inserted: Some(true),
-            ui_sdcard_create_arg: Some(false),
             ..Default::default()
         });
         assert_eq!(

src/rust/bitbox02-rust/src/workflow/sdcard.rs

@@ -17,9 +17,9 @@ use core::cell::RefCell;
 
 pub struct UserAbort;
 
-pub async fn sdcard(insert: bool) -> Result<(), UserAbort> {
+pub async fn sdcard() -> Result<(), UserAbort> {
     let result = RefCell::new(None as Option<Result<(), UserAbort>>);
-    let mut component = bitbox02::ui::sdcard_create(insert, |sd_done| {
+    let mut component = bitbox02::ui::sdcard_create(|sd_done| {
         *result.borrow_mut() = if sd_done {
             Some(Ok(()))
         } else {

src/rust/bitbox02/src/testing.rs

@@ -25,7 +25,6 @@ use crate::keystore;
 pub struct Data {
     pub ui_confirm_create: Option<Box<dyn Fn(&super::ui::ConfirmParams) -> bool>>,
     pub sdcard_inserted: Option<bool>,
-    pub ui_sdcard_create_arg: Option<bool>,
     pub ui_transaction_address_create: Option<Box<dyn Fn(&str, &str) -> bool>>,
     pub ui_transaction_fee_create: Option<Box<dyn Fn(&str, &str, bool) -> bool>>,
     pub ui_trinary_input_string_create:
@@ -40,7 +39,6 @@ unsafe impl Sync for SafeData {}
 pub static DATA: SafeData = SafeData(RefCell::new(Data {
     ui_confirm_create: None,
     sdcard_inserted: None,
-    ui_sdcard_create_arg: None,
     ui_transaction_address_create: None,
     ui_transaction_fee_create: None,
     ui_trinary_input_string_create: None,

src/rust/bitbox02/src/ui/ui.rs

@@ -197,7 +197,7 @@ where
     }
 }
 
-pub fn sdcard_create<'a, F>(insert: bool, callback: F) -> Component<'a>
+pub fn sdcard_create<'a, F>(callback: F) -> Component<'a>
 where
     // Callback must outlive component.
     F: FnMut(bool) + 'a,
@@ -214,7 +214,6 @@ where
 
     let component = unsafe {
         bitbox02_sys::sdcard_create(
-            insert,
             Some(c_callback::<F>),
             // passed to the C callback as `param`
             Box::into_raw(Box::new(callback)) as *mut _,

src/rust/bitbox02/src/ui/ui_stub.rs

@@ -93,12 +93,10 @@ where
     }
 }
 
-pub fn sdcard_create<'a, F>(insert: bool, mut callback: F) -> Component<'a>
+pub fn sdcard_create<'a, F>(mut callback: F) -> Component<'a>
 where
     F: FnMut(bool) + 'a,
 {
-    let data = crate::testing::DATA.0.borrow();
-    assert_eq!(data.ui_sdcard_create_arg.unwrap(), insert);
     callback(true);
     Component {
         is_pushed: false,

src/rust/bitbox02/src/ui/ui_stub_c_unit_tests.rs

@@ -100,7 +100,7 @@ where
     }
 }
 
-pub fn sdcard_create<'a, F>(_insert: bool, mut callback: F) -> Component<'a>
+pub fn sdcard_create<'a, F>(mut callback: F) -> Component<'a>
 where
     F: FnMut(bool) + 'a,
 {