SiFive Test device

Author: luojia65

rustsbi-qemu/src/execute.rs

@@ -97,7 +97,7 @@ pub fn execute_supervisor(supervisor_mepc: usize, hart_id: usize, a1: usize, hsm
             },
             GeneratorState::Complete(()) => {
                 use rustsbi::Reset;
-                crate::test_device::Reset.system_reset(
+                crate::test_device::SiFiveTest.system_reset(
                     rustsbi::reset::RESET_TYPE_SHUTDOWN,
                     rustsbi::reset::RESET_REASON_NO_REASON,
                 );

rustsbi-qemu/src/main.rs

@@ -42,7 +42,7 @@ fn panic(info: &PanicInfo) -> ! {
     println!("[rustsbi-panic] hart {} {}", hart_id, info);
     println!("[rustsbi-panic] system shutdown scheduled due to RustSBI panic");
     use rustsbi::Reset;
-    test_device::Reset.system_reset(
+    test_device::SiFiveTest.system_reset(
         rustsbi::reset::RESET_TYPE_SHUTDOWN,
         rustsbi::reset::RESET_REASON_SYSTEM_FAILURE,
     );
@@ -119,7 +119,7 @@ fn init_clint() {
 
 fn init_test_device() {
     use rustsbi::init_reset;
-    init_reset(test_device::Reset);
+    init_reset(test_device::SiFiveTest);
 }
 
 // 委托中断；把S的中断全部委托给S层

rustsbi-qemu/src/test_device.rs

@@ -1,25 +1,38 @@
-pub struct Reset;
+// SiFive Test virtual device
+//
+// This is a test finisher memory mapped device used to exit simulation
+//
+// Ref: https://github.com/qemu/qemu/blob/master/hw/misc/sifive_test.c
+use rustsbi::{Reset, SbiRet, reset::{
+    RESET_TYPE_SHUTDOWN, RESET_TYPE_COLD_REBOOT, RESET_TYPE_WARM_REBOOT,
+    RESET_REASON_NO_REASON, RESET_REASON_SYSTEM_FAILURE
+}};
 
+// Zero sized structure for a static write-only device
+pub struct SiFiveTest;
+
+// Write these values to perform test device operations
 const TEST_FAIL: u32 = 0x3333;
 const TEST_PASS: u32 = 0x5555;
 const TEST_RESET: u32 = 0x7777;
 
-impl rustsbi::Reset for Reset {
-    fn system_reset(&self, reset_type: usize, reset_reason: usize) -> rustsbi::SbiRet {
-        // todo: only exit after all harts finished
-        // loop {}
+// On most QEMU host platforms, exit code for a general error is 1
+const QEMU_ERR_EXIT_CODE: u32 = 1;
+
+impl Reset for SiFiveTest {
+    fn system_reset(&self, reset_type: usize, reset_reason: usize) -> SbiRet {
         const VIRT_TEST: *mut u32 = 0x10_0000 as *mut u32;
-        // Fail = 0x3333,
-        // Pass = 0x5555,
-        // Reset = 0x7777,
-        let mut value = match reset_type {
-            rustsbi::reset::RESET_TYPE_SHUTDOWN => TEST_PASS,
-            rustsbi::reset::RESET_TYPE_COLD_REBOOT => TEST_RESET,
-            rustsbi::reset::RESET_TYPE_WARM_REBOOT => TEST_RESET,
-            _ => TEST_FAIL,
-        };
-        if reset_reason == rustsbi::reset::RESET_REASON_SYSTEM_FAILURE {
-            value = TEST_FAIL;
+        let value = match reset_type {
+            RESET_TYPE_SHUTDOWN => match reset_reason {
+                RESET_REASON_NO_REASON => TEST_PASS,
+                RESET_REASON_SYSTEM_FAILURE => TEST_FAIL | (QEMU_ERR_EXIT_CODE << 16),
+                // pass unknown reason from [2, 0xFFFF] to qemu return value output  
+                // reason if reason <= 0xFFFF => TEST_FAIL | (((reason & 0xFFFF) as u32) << 16),
+                _ => return SbiRet::invalid_param(),
+            },
+            RESET_TYPE_COLD_REBOOT => TEST_RESET,
+            RESET_TYPE_WARM_REBOOT => TEST_RESET,
+            _ => return SbiRet::invalid_param(),
         };
         unsafe {
             core::ptr::write_volatile(VIRT_TEST, value);

test-kernel/src/main.rs

@@ -153,7 +153,8 @@ use core::panic::PanicInfo;
 fn panic(info: &PanicInfo) -> ! {
     println!("!! Test-kernel: {}", info);
     println!("!! Test-kernel: SBI test FAILED due to panic");
-    sbi::shutdown()
+    sbi::reset(sbi::RESET_TYPE_SHUTDOWN, sbi::RESET_REASON_SYSTEM_FAILURE);
+    loop {}
 }
 
 const BOOT_STACK_SIZE: usize = 4096 * 4 * 8;

test-kernel/src/sbi.rs

@@ -86,6 +86,24 @@ pub fn get_mimpid() -> usize {
     sbi_call_0(EXTENSION_BASE, FUNCTION_BASE_GET_MIMPID).value
 }
 
+const FUNCTION_SYSTEM_RESET: usize = 0x0;
+
+pub const RESET_TYPE_SHUTDOWN: usize = 0x0000_0000;
+pub const RESET_TYPE_COLD_REBOOT: usize = 0x0000_0001;
+pub const RESET_TYPE_WARM_REBOOT: usize = 0x0000_0002;
+pub const RESET_REASON_NO_REASON: usize = 0x0000_0000;
+pub const RESET_REASON_SYSTEM_FAILURE: usize = 0x0000_0001;
+
+#[inline]
+pub fn reset(reset_type: usize, reset_reason: usize) -> SbiRet {
+    sbi_call_2(EXTENSION_SRST, FUNCTION_SYSTEM_RESET, reset_type, reset_reason)
+}
+
+pub fn shutdown() -> ! {
+    sbi_call_2(EXTENSION_SRST, FUNCTION_SYSTEM_RESET, RESET_TYPE_SHUTDOWN, RESET_REASON_NO_REASON);
+    unreachable!()
+}
+
 #[inline(always)]
 fn sbi_call_legacy(which: usize, arg0: usize, arg1: usize, arg2: usize) -> usize {
     let ret;
@@ -126,11 +144,6 @@ pub fn console_getchar() -> usize {
     sbi_call_legacy(SBI_CONSOLE_GETCHAR, 0, 0, 0)
 }
 
-pub fn shutdown() -> ! {
-    sbi_call_legacy(SBI_SHUTDOWN, 0, 0, 0);
-    unreachable!()
-}
-
 pub fn set_timer(time: usize) {
     sbi_call_legacy(SBI_SET_TIMER, time, 0, 0);
 }