mock spi_mem in unit tests and in the simulator

Author: benma

src/memory/spi_mem.c

@@ -13,15 +13,13 @@
 // limitations under the License.
 
 #include "spi_mem.h"
+#include "bitbox02_pins.h"
 #include "util.h"
+#include <hal_delay.h>
+#include <spi_lite.h>
 #include <stdbool.h>
 #include <stdint.h>
 #include <stdlib.h>
-#ifndef TESTING
-#include "bitbox02_pins.h"
-#include <hal_delay.h>
-#include <spi_lite.h>
-#endif
 
 #define SECTOR_MASK 0xFFFFF000
 #define MEMORY_LIMIT (SPI_MEM_MEMORY_SIZE - 1)
@@ -35,16 +33,12 @@
 
 static void _spi_mem_cs_low(void)
 {
-#ifndef TESTING
     gpio_set_pin_level(PIN_MEM_CS, 0);
-#endif
 }
 
 static void _spi_mem_cs_high(void)
 {
-#ifndef TESTING
     gpio_set_pin_level(PIN_MEM_CS, 1);
-#endif
 }
 
 static uint8_t _spi_mem_read_sr(void)

src/rust/bitbox02-sys/build.rs

@@ -105,6 +105,7 @@ const ALLOWLIST_FNS: &[&str] = &[
     "memory_setup",
     "menu_create",
     "mock_memory_factoryreset",
+    "spi_mem_full_erase",
     "printf",
     "progress_create",
     "progress_set",

src/rust/bitbox02-sys/wrapper.h

@@ -17,6 +17,7 @@
 #include <memory/bitbox02_smarteeprom.h>
 #include <memory/memory.h>
 #include <memory/smarteeprom.h>
+#include <memory/spi_mem.h>
 #include <random.h>
 #include <reset.h>
 #include <screen.h>

src/rust/bitbox02/src/testing.rs

@@ -94,6 +94,7 @@ pub fn mock_memory() {
 
         bitbox02_sys::smarteeprom_bb02_config();
         bitbox02_sys::bitbox02_smarteeprom_init();
+        bitbox02_sys::spi_mem_full_erase();
     }
 }
 

test/simulator/CMakeLists.txt

@@ -30,6 +30,7 @@ set(IGNORE_SOURCES
     "src/memory/nvmctrl.c"
     "src/memory/smarteeprom.c"
     "src/memory/mpu.c"
+    "src/memory/spi_mem.c"
     )
 
 # Exclude some files which depends on the hardware.
@@ -61,6 +62,7 @@ add_library(bitbox_objects-simulator
   ${ETHEREUM-SOURCES}
   framework/mock_cipher.c
   framework/mock_memory.c
+  framework/mock_spi_mem.c
   framework/mock_screen.c
   framework/mock_smarteeprom.c
   framework/mock_securechip.c

test/simulator/framework/mock_spi_mem.c

@@ -0,0 +1,40 @@
+// Copyright 2025 Shift Crypto AG
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <memory/spi_mem.h>
+#include <stdlib.h>
+#include <string.h>
+
+__extension__ static uint8_t _memory[] = {[0 ... SPI_MEM_MEMORY_SIZE] = 0xFF};
+
+void spi_mem_full_erase(void)
+{
+    memset(_memory, 0xFF, sizeof(_memory));
+}
+
+bool spi_mem_write(uint32_t address, const uint8_t* input, size_t size)
+{
+    memcpy(&_memory[address], input, size);
+    return true;
+}
+
+uint8_t* spi_mem_read(uint32_t address, size_t size)
+{
+    uint8_t* result = (uint8_t*)malloc(size);
+    if (!result) {
+        return NULL;
+    }
+    memcpy(result, &_memory[address], size);
+    return result;
+}

test/unit-test/CMakeLists.txt

@@ -30,6 +30,7 @@ set(IGNORE_SOURCES
     "src/memory/nvmctrl.c"
     "src/memory/smarteeprom.c"
     "src/memory/mpu.c"
+    "src/memory/spi_mem.c"
     )
 
 # Exclude some files which depends on the hardware.
@@ -63,6 +64,7 @@ add_library(bitbox_objects
   framework/mock_screen.c
   framework/mock_screen_stack.c
   framework/mock_memory.c
+  framework/mock_spi_mem.c
   framework/mock_qtouch.c
   framework/mock_gestures.c
   framework/mock_component.c

test/unit-test/framework/mock_spi_mem.c

@@ -0,0 +1,40 @@
+// Copyright 2025 Shift Crypto AG
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <memory/spi_mem.h>
+#include <stdlib.h>
+#include <string.h>
+
+__extension__ static uint8_t _memory[] = {[0 ... SPI_MEM_MEMORY_SIZE] = 0xFF};
+
+void spi_mem_full_erase(void)
+{
+    memset(_memory, 0xFF, sizeof(_memory));
+}
+
+bool spi_mem_write(uint32_t address, const uint8_t* input, size_t size)
+{
+    memcpy(&_memory[address], input, size);
+    return true;
+}
+
+uint8_t* spi_mem_read(uint32_t address, size_t size)
+{
+    uint8_t* result = (uint8_t*)malloc(size);
+    if (!result) {
+        return NULL;
+    }
+    memcpy(result, &_memory[address], size);
+    return result;
+}