Merge pull request #35 from Alignof/develop

Ver 0.4.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "hikami"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2021"
 
 [lints.clippy]

src/device.rs

@@ -4,6 +4,7 @@ pub mod clint;
 mod initrd;
 mod pci;
 mod plic;
+mod rtc;
 pub mod uart;
 mod virtio;
 
@@ -50,6 +51,7 @@ pub struct Devices {
     pub plic_context: usize,
     pub clint: clint::Clint,
     pub pci: pci::Pci,
+    pub rtc: rtc::Rtc,
 }
 
 impl Devices {
@@ -71,6 +73,7 @@ impl Devices {
             self.plic.memmap(),
             self.clint.memmap(),
             self.pci.memmap(),
+            self.rtc.memmap(),
         ]);
 
         device_mapping
@@ -101,6 +104,7 @@ impl HypervisorData {
                 .value[0] as usize,
             clint: clint::Clint::new(&device_tree, "/soc/clint"),
             pci: pci::Pci::new(&device_tree, "/soc/pci"),
+            rtc: rtc::Rtc::new(&device_tree, "/soc/rtc"),
         });
     }
 }

src/device/plic.rs

@@ -1,4 +1,5 @@
 //! PLIC: Platform-Level Interrupt Controller  
+//! ref: [https://github.com/riscv/riscv-plic-spec/releases/download/1.0.0/riscv-plic-1.0.0.pdf](https://github.com/riscv/riscv-plic-spec/releases/download/1.0.0/riscv-plic-1.0.0.pdf)
 
 use super::{Device, PTE_FLAGS_FOR_DEVICE};
 use crate::memmap::{GuestPhysicalAddress, HostPhysicalAddress, MemoryMap};

src/device/rtc.rs

@@ -0,0 +1,47 @@
+//! RTC: Real Time Clock.
+
+use super::{Device, PTE_FLAGS_FOR_DEVICE};
+use crate::memmap::{GuestPhysicalAddress, HostPhysicalAddress, MemoryMap};
+use fdt::Fdt;
+
+/// RTC: Real Time Clock.
+/// An electronic device that measures the passage of time.
+#[derive(Debug)]
+pub struct Rtc {
+    base_addr: HostPhysicalAddress,
+    size: usize,
+}
+
+impl Device for Rtc {
+    fn new(device_tree: &Fdt, node_path: &str) -> Self {
+        let region = device_tree
+            .find_node(node_path)
+            .unwrap()
+            .reg()
+            .unwrap()
+            .next()
+            .unwrap();
+
+        Rtc {
+            base_addr: HostPhysicalAddress(region.starting_address as usize),
+            size: region.size.unwrap(),
+        }
+    }
+
+    fn size(&self) -> usize {
+        self.size
+    }
+
+    fn paddr(&self) -> HostPhysicalAddress {
+        self.base_addr
+    }
+
+    fn memmap(&self) -> MemoryMap {
+        let vaddr = GuestPhysicalAddress(self.paddr().raw());
+        MemoryMap::new(
+            vaddr..vaddr + self.size(),
+            self.paddr()..self.paddr() + self.size(),
+            &PTE_FLAGS_FOR_DEVICE,
+        )
+    }
+}

src/h_extension/csrs.rs

@@ -61,7 +61,7 @@ macro_rules! set_csr_as {
     };
 }
 
-/// Set CSR bit from enum.
+/// Set CSR bit from enum variant.
 #[macro_export]
 macro_rules! set_csr_from_enum {
     ($enum: ident, $csr_number:literal) => {
@@ -74,14 +74,27 @@ macro_rules! set_csr_from_enum {
     };
 }
 
+/// Clear CSR bit from enum variant.
+#[macro_export]
+macro_rules! clear_csr_from_enum {
+    ($enum: ident, $csr_number:literal) => {
+        #[inline]
+        pub fn clear(field: $enum) {
+            unsafe{
+                core::arch::asm!(concat!("csrrc x0, ", stringify!($csr_number), ", {0}"), in(reg) field as usize);
+            }
+        }
+    };
+}
+
 /// VS-level interrupt kind.
-pub enum InterruptKind {
+pub enum VsInterruptKind {
     /// VS-level external interrupts (bit 10)
-    Vsei = 0b100_0000_0000,
+    External = 0b100_0000_0000,
     /// VS-level timer interrupts (bit 6)
-    Vsti = 0b100_0000,
+    Timer = 0b100_0000,
     /// VS-level software interrupts (bit 2)
-    Vssi = 0b100,
+    Software = 0b100,
 }
 
 pub mod vstvec {
@@ -212,17 +225,43 @@ pub mod hideleg {
     write_csr_as!(0x603);
 }
 
+pub mod hie {
+    //! Hypervisor interrupt-enable register.
+    #![allow(dead_code)]
+    use super::VsInterruptKind;
+
+    const HIE: usize = 0x604;
+    pub struct Hie {
+        bits: usize,
+    }
+
+    set_csr_from_enum!(VsInterruptKind, 0x604);
+}
+
+pub mod hcounteren {
+    //! Hypervisor counter enable.
+    #![allow(dead_code)]
+
+    const HCOUNTEREN: usize = 0x606;
+    pub struct Hcounteren {
+        bits: usize,
+    }
+
+    set_csr_as!(0x606);
+}
+
 pub mod hvip {
     //! Hypervisor virtual interrupt pending.
     #![allow(dead_code)]
-    use super::InterruptKind;
+    use super::VsInterruptKind;
 
     const HVIP: usize = 0x645;
     pub struct Hvip {
         bits: usize,
     }
 
-    set_csr_from_enum!(InterruptKind, 0x645);
+    set_csr_from_enum!(VsInterruptKind, 0x645);
+    clear_csr_from_enum!(VsInterruptKind, 0x645);
 
     read_csr_as!(Hvip, 0x645);
     write_csr_as!(0x645);
@@ -268,8 +307,8 @@ pub mod henvcfg {
         unsafe {
             core::arch::asm!(
                 "
-            csrs henvcfg, {bits}
-            ",
+                csrs henvcfg, {bits}
+                ",
                 bits = in(reg) 1u64 << 63
             );
         }
@@ -280,8 +319,8 @@ pub mod henvcfg {
         unsafe {
             core::arch::asm!(
                 "
-            csrs henvcfg, {bits}
-            ",
+                csrs henvcfg, {bits}
+                ",
                 bits = in(reg) 1u64 << 7
             );
         }
@@ -292,22 +331,10 @@ pub mod henvcfg {
         unsafe {
             core::arch::asm!(
                 "
-            csrs henvcfg, {bits}
-            ",
+                csrs henvcfg, {bits}
+                ",
                 bits = in(reg) 1u64 << 6
             );
         }
     }
 }
-
-pub mod hcounteren {
-    //! Hypervisor counter enable.
-    #![allow(dead_code)]
-
-    const HCOUNTEREN: usize = 0x606;
-    pub struct Hcounteren {
-        bits: usize,
-    }
-
-    set_csr_as!(0x606);
-}

src/hypervisor_init.rs

@@ -3,8 +3,8 @@
 use crate::device::Device;
 use crate::guest::Guest;
 use crate::h_extension::csrs::{
-    hcounteren, hedeleg, hedeleg::ExceptionKind, henvcfg, hgatp, hgatp::HgatpMode, hideleg,
-    hstatus, hvip, vsatp, InterruptKind,
+    hcounteren, hedeleg, hedeleg::ExceptionKind, henvcfg, hgatp, hgatp::HgatpMode, hideleg, hie,
+    hstatus, hvip, vsatp, VsInterruptKind,
 };
 use crate::h_extension::instruction::hfence_gvma_all;
 use crate::memmap::{
@@ -17,7 +17,7 @@ use crate::{GUEST_DTB, HYPERVISOR_DATA};
 use core::arch::asm;
 
 use elf::{endian::AnyEndian, ElfBytes};
-use riscv::register::{sepc, sie, sscratch, sstatus, stvec};
+use riscv::register::{sepc, sscratch, sstatus, stvec};
 
 /// Entry point to HS-mode.
 #[inline(never)]
@@ -29,11 +29,15 @@ pub extern "C" fn hstart(hart_id: usize, dtb_addr: usize) -> ! {
     assert_ne!(dtb_addr, 0);
 
     // clear all hypervisor interrupts.
-    hvip::write(0);
+    hvip::clear(VsInterruptKind::External);
+    hvip::clear(VsInterruptKind::Timer);
+    hvip::clear(VsInterruptKind::Software);
 
     // disable address translation.
     vsatp::write(0);
 
+    // disable hypervisor external interrupt
+
     // enable Sstc extention
     henvcfg::set_stce();
     henvcfg::set_cbze();
@@ -42,12 +46,11 @@ pub extern "C" fn hstart(hart_id: usize, dtb_addr: usize) -> ! {
     // enable hypervisor counter
     hcounteren::set(0xffff_ffff);
 
-    // set sie = 0x222
-    unsafe {
-        sie::set_ssoft();
-        sie::set_stimer();
-        sie::set_sext();
-    }
+    // set hie = 0x444
+    // TODO?: trap VS-mode interrupt.
+    hie::set(VsInterruptKind::External);
+    hie::set(VsInterruptKind::Timer);
+    hie::set(VsInterruptKind::Software);
 
     // specify delegation exception kinds.
     hedeleg::write(
@@ -60,7 +63,9 @@ pub extern "C" fn hstart(hart_id: usize, dtb_addr: usize) -> ! {
     );
     // specify delegation interrupt kinds.
     hideleg::write(
-        InterruptKind::Vsei as usize | InterruptKind::Vsti as usize | InterruptKind::Vssi as usize,
+        VsInterruptKind::External as usize
+            | VsInterruptKind::Timer as usize
+            | VsInterruptKind::Software as usize,
     );
 
     vsmode_setup(hart_id, HostPhysicalAddress(dtb_addr));

src/trap/hypervisor_supervisor/interrupt.rs

@@ -2,7 +2,7 @@
 
 use super::hstrap_exit;
 use crate::device::Device;
-use crate::h_extension::csrs::{hvip, vsip, InterruptKind};
+use crate::h_extension::csrs::{hvip, vsip, VsInterruptKind};
 use crate::HYPERVISOR_DATA;
 use riscv::register::scause::Interrupt;
 use riscv::register::sie;
@@ -21,10 +21,10 @@ pub unsafe fn trap_interrupt(interrupt_cause: Interrupt) -> ! {
             interrupt_addr.write_volatile(0);
         }
         Interrupt::SupervisorTimer => {
-            hvip::set(InterruptKind::Vsti);
+            hvip::set(VsInterruptKind::Timer);
             sie::clear_stimer();
         }
-        Interrupt::SupervisorExternal => riscv::asm::wfi(), // wait for interrupt
+        Interrupt::SupervisorExternal => hvip::set(VsInterruptKind::External),
         Interrupt::Unknown => panic!("unknown interrupt type"),
     }