Add recovery flash in emulator and extend flash test cases to recover…

…y flash
chipsalliance · Jan 10, 2025 · cf24629 · cf24629
1 parent ab8c992
commit cf24629
Show file tree

Hide file tree

Showing 23 changed files with 976 additions and 196 deletions.
diff --git a/.gitignore b/.gitignore
@@ -21,5 +21,5 @@ runtime/apps/layout.ld
 book
 
 # flash file
-dummy_flash.bin
-primary_flash
+main_flash
+recovery_flash
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/emulator/app/Cargo.toml b/emulator/app/Cargo.toml
@@ -30,16 +30,17 @@ strum_macros.workspace = true
 strum.workspace = true
 tock-registers.workspace = true
 zerocopy.workspace = true
+tempfile.workspace = true
 
 [features]
 default = []
 test-i3c-simple = []
 test-i3c-constant-writes = ["emulator-periph/test-i3c-constant-writes"]
 test-flash-ctrl-init = []
-test-flash-ctrl-read-write-page = []
-test-flash-ctrl-erase-page = []
-test-flash-storage-read-write = []
-test-flash-storage-erase = []
+test-flash-ctrl-read-write-page = ["emulator-periph/test-flash-ctrl-read-write-page"]
+test-flash-ctrl-erase-page = ["emulator-periph/test-flash-ctrl-erase-page"]
+test-flash-storage-read-write = ["emulator-periph/test-flash-storage-read-write"]
+test-flash-storage-erase = ["emulator-periph/test-flash-storage-erase"]
 test-mctp-ctrl-cmds = ["emulator-periph/test-mctp-ctrl-cmds"]
 test-mctp-capsule-loopback = ["emulator-periph/test-mctp-capsule-loopback"]
 test-mctp-user-loopback = ["emulator-periph/test-mctp-user-loopback"]
diff --git a/emulator/app/src/main.rs b/emulator/app/src/main.rs
@@ -405,15 +405,45 @@ fn run(cli: Emulator, capture_uart_output: bool) -> io::Result<Vec<u8>> {
         );
     }
 
-    let flash_ctrl_error_irq = pic.register_irq(CaliptraRootBus::FLASH_CTRL_ERROR_IRQ);
-    let flash_ctrl_event_irq = pic.register_irq(CaliptraRootBus::FLASH_CTRL_EVENT_IRQ);
-    let flash_controller = DummyFlashCtrl::new(
-        &clock.clone(),
-        Some(PathBuf::from("primary_flash")), // TODO: make this configurable
-        flash_ctrl_error_irq,
-        flash_ctrl_event_irq,
-    )
-    .unwrap();
+    let create_flash_controller = |default_path: &str, error_irq: u8, event_irq: u8| {
+        // Use a temporary file for flash storage if we're running a test
+        let flash_file = if cfg!(any(
+            feature = "test-flash-ctrl-read-write-page",
+            feature = "test-flash-ctrl-erase-page",
+            feature = "test-flash-storage-read-write",
+            feature = "test-flash-storage-erase"
+        )) {
+            println!("[xs debug] flash test feature enabled with temp file");
+            Some(
+                tempfile::NamedTempFile::new()
+                    .unwrap()
+                    .into_temp_path()
+                    .to_path_buf(),
+            )
+        } else {
+            Some(PathBuf::from(default_path))
+        };
+
+        DummyFlashCtrl::new(
+            &clock.clone(),
+            flash_file,
+            pic.register_irq(error_irq),
+            pic.register_irq(event_irq),
+        )
+        .unwrap()
+    };
+
+    let main_flash_controller = create_flash_controller(
+        "main_flash",
+        CaliptraRootBus::MAIN_FLASH_CTRL_ERROR_IRQ,
+        CaliptraRootBus::MAIN_FLASH_CTRL_EVENT_IRQ,
+    );
+
+    let recovery_flash_controller = create_flash_controller(
+        "recovery_flash",
+        CaliptraRootBus::RECOVERY_FLASH_CTRL_ERROR_IRQ,
+        CaliptraRootBus::RECOVERY_FLASH_CTRL_EVENT_IRQ,
+    );
 
     let mut delegates: Vec<Box<dyn Bus>> = vec![Box::new(root_bus)];
     let soc_periph = if let Some(soc_to_caliptra) = soc_to_caliptra {
@@ -428,7 +458,8 @@ fn run(cli: Emulator, capture_uart_output: bool) -> io::Result<Vec<u8>> {
     let mut auto_root_bus = AutoRootBus::new(
         delegates,
         Some(Box::new(i3c)),
-        Some(Box::new(flash_controller)),
+        Some(Box::new(main_flash_controller)),
+        Some(Box::new(recovery_flash_controller)),
         None,
         Some(Box::new(otp)),
         None,
@@ -437,9 +468,17 @@ fn run(cli: Emulator, capture_uart_output: bool) -> io::Result<Vec<u8>> {
         None,
     );
 
-    // Set the DMA RAM for the Flash Controller
+    // Set the DMA RAM for Main Flash Controller
+    auto_root_bus
+        .main_flash_periph
+        .as_mut()
+        .unwrap()
+        .periph
+        .set_dma_ram(dma_ram.clone());
+
+    // Set the DMA RAM for Recovery Flash Controller
     auto_root_bus
-        .flash_periph
+        .recovery_flash_periph
         .as_mut()
         .unwrap()
         .periph

diff --git a/emulator/periph/Cargo.toml b/emulator/periph/Cargo.toml
@@ -22,6 +22,9 @@ serde.workspace = true
 tock-registers.workspace = true
 zerocopy.workspace = true
 
+[dev-dependencies]
+tempfile.workspace = true
+
 [features]
 default = []
 test-i3c-constant-writes = []