Merge pull request #143 from rust-embedded/clean-ulevel-interrupt

Removing user mode registers

CHANGELOG.md

@@ -32,6 +32,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Fix `scause::Exception` missing `SupervisorEnvCall`
 - Removed user-level interrupts from `mcause::Interrupt` and `scause::Interrupt`
 - Removed user-level interrupts from `mstatus`
+- Removed machine environment call delegation from `medeleg`
+- Removed user-level interrupts from machine and supervisor mode interrupt-related registers.
+
+### Removed
+
+- User mode registers removed, as they are no longer supported in RISC-V
 
 ## [v0.10.1] - 2023-01-18
 

src/register.rs

@@ -14,18 +14,6 @@
 #[macro_use]
 mod macros;
 
-// User Trap Setup
-pub mod uie;
-pub mod ustatus;
-pub mod utvec;
-
-// User Trap Handling
-pub mod ucause;
-pub mod uepc;
-pub mod uip;
-pub mod uscratch;
-pub mod utval;
-
 // User Floating-Point CSRs
 // TODO: frm, fflags
 pub mod fcsr;

src/register/medeleg.rs

@@ -73,12 +73,6 @@ impl Medeleg {
         self.bits & (1 << 9) != 0
     }
 
-    /// Environment Call from M-mode Delegate
-    #[inline]
-    pub fn machine_env_call(&self) -> bool {
-        self.bits & (1 << 11) != 0
-    }
-
     /// Instruction Page Fault Delegate
     #[inline]
     pub fn instruction_page_fault(&self) -> bool {
@@ -132,9 +126,6 @@ set_clear_csr!(
 set_clear_csr!(
     /// Environment Call from S-mode Delegate
     , set_supervisor_env_call, clear_supervisor_env_call, 1 << 9);
-set_clear_csr!(
-    /// Environment Call from M-mode Delegate
-    , set_machine_env_call, clear_machine_env_call, 1 << 11);
 set_clear_csr!(
     /// Instruction Page Fault Delegate
     , set_instruction_page_fault, clear_instruction_page_fault, 1 << 12);

src/register/mideleg.rs

@@ -13,36 +13,18 @@ impl Mideleg {
         self.bits
     }
 
-    /// User Software Interrupt Delegate
-    #[inline]
-    pub fn usoft(&self) -> bool {
-        self.bits & (1 << 0) != 0
-    }
-
     /// Supervisor Software Interrupt Delegate
     #[inline]
     pub fn ssoft(&self) -> bool {
         self.bits & (1 << 1) != 0
     }
 
-    /// User Timer Interrupt Delegate
-    #[inline]
-    pub fn utimer(&self) -> bool {
-        self.bits & (1 << 4) != 0
-    }
-
     /// Supervisor Timer Interrupt Delegate
     #[inline]
     pub fn stimer(&self) -> bool {
         self.bits & (1 << 5) != 0
     }
 
-    /// User External Interrupt Delegate
-    #[inline]
-    pub fn uext(&self) -> bool {
-        self.bits & (1 << 8) != 0
-    }
-
     /// Supervisor External Interrupt Delegate
     #[inline]
     pub fn sext(&self) -> bool {
@@ -54,21 +36,12 @@ read_csr_as!(Mideleg, 0x303);
 set!(0x303);
 clear!(0x303);
 
-set_clear_csr!(
-    /// User Software Interrupt Delegate
-    , set_usoft, clear_usoft, 1 << 0);
 set_clear_csr!(
     /// Supervisor Software Interrupt Delegate
     , set_ssoft, clear_ssoft, 1 << 1);
-set_clear_csr!(
-    /// User Timer Interrupt Delegate
-    , set_utimer, clear_utimer, 1 << 4);
 set_clear_csr!(
     /// Supervisor Timer Interrupt Delegate
     , set_stimer, clear_stimer, 1 << 5);
-set_clear_csr!(
-    /// User External Interrupt Delegate
-    , set_uext, clear_uext, 1 << 8);
 set_clear_csr!(
     /// Supervisor External Interrupt Delegate
     , set_sext, clear_sext, 1 << 9);

src/register/mie.rs

@@ -13,12 +13,6 @@ impl Mie {
         self.bits
     }
 
-    /// User Software Interrupt Enable
-    #[inline]
-    pub fn usoft(&self) -> bool {
-        self.bits & (1 << 0) != 0
-    }
-
     /// Supervisor Software Interrupt Enable
     #[inline]
     pub fn ssoft(&self) -> bool {
@@ -31,12 +25,6 @@ impl Mie {
         self.bits & (1 << 3) != 0
     }
 
-    /// User Timer Interrupt Enable
-    #[inline]
-    pub fn utimer(&self) -> bool {
-        self.bits & (1 << 4) != 0
-    }
-
     /// Supervisor Timer Interrupt Enable
     #[inline]
     pub fn stimer(&self) -> bool {
@@ -49,12 +37,6 @@ impl Mie {
         self.bits & (1 << 7) != 0
     }
 
-    /// User External Interrupt Enable
-    #[inline]
-    pub fn uext(&self) -> bool {
-        self.bits & (1 << 8) != 0
-    }
-
     /// Supervisor External Interrupt Enable
     #[inline]
     pub fn sext(&self) -> bool {
@@ -72,27 +54,18 @@ read_csr_as!(Mie, 0x304);
 set!(0x304);
 clear!(0x304);
 
-set_clear_csr!(
-    /// User Software Interrupt Enable
-    , set_usoft, clear_usoft, 1 << 0);
 set_clear_csr!(
     /// Supervisor Software Interrupt Enable
     , set_ssoft, clear_ssoft, 1 << 1);
 set_clear_csr!(
     /// Machine Software Interrupt Enable
     , set_msoft, clear_msoft, 1 << 3);
-set_clear_csr!(
-    /// User Timer Interrupt Enable
-    , set_utimer, clear_utimer, 1 << 4);
 set_clear_csr!(
     /// Supervisor Timer Interrupt Enable
     , set_stimer, clear_stimer, 1 << 5);
 set_clear_csr!(
     /// Machine Timer Interrupt Enable
     , set_mtimer, clear_mtimer, 1 << 7);
-set_clear_csr!(
-    /// User External Interrupt Enable
-    , set_uext, clear_uext, 1 << 8);
 set_clear_csr!(
     /// Supervisor External Interrupt Enable
     , set_sext, clear_sext, 1 << 9);

src/register/mip.rs

@@ -13,12 +13,6 @@ impl Mip {
         self.bits
     }
 
-    /// User Software Interrupt Pending
-    #[inline]
-    pub fn usoft(&self) -> bool {
-        self.bits & (1 << 0) != 0
-    }
-
     /// Supervisor Software Interrupt Pending
     #[inline]
     pub fn ssoft(&self) -> bool {
@@ -31,12 +25,6 @@ impl Mip {
         self.bits & (1 << 3) != 0
     }
 
-    /// User Timer Interrupt Pending
-    #[inline]
-    pub fn utimer(&self) -> bool {
-        self.bits & (1 << 4) != 0
-    }
-
     /// Supervisor Timer Interrupt Pending
     #[inline]
     pub fn stimer(&self) -> bool {
@@ -49,12 +37,6 @@ impl Mip {
         self.bits & (1 << 7) != 0
     }
 
-    /// User External Interrupt Pending
-    #[inline]
-    pub fn uext(&self) -> bool {
-        self.bits & (1 << 8) != 0
-    }
-
     /// Supervisor External Interrupt Pending
     #[inline]
     pub fn sext(&self) -> bool {
@@ -72,21 +54,12 @@ read_csr_as!(Mip, 0x344);
 set!(0x344);
 clear!(0x344);
 
-set_clear_csr!(
-    /// User Software Interrupt Pending
-    , set_usoft, clear_usoft, 1 << 0);
 set_clear_csr!(
     /// Supervisor Software Interrupt Pending
     , set_ssoft, clear_ssoft, 1 << 1);
-set_clear_csr!(
-    /// User Timer Interrupt Pending
-    , set_utimer, clear_utimer, 1 << 4);
 set_clear_csr!(
     /// Supervisor Timer Interrupt Pending
     , set_stimer, clear_stimer, 1 << 5);
-set_clear_csr!(
-    /// User External Interrupt Pending
-    , set_uext, clear_uext, 1 << 8);
 set_clear_csr!(
     /// Supervisor External Interrupt Pending
     , set_sext, clear_sext, 1 << 9);

src/register/sie.rs

@@ -13,36 +13,18 @@ impl Sie {
         self.bits
     }
 
-    /// User Software Interrupt Enable
-    #[inline]
-    pub fn usoft(&self) -> bool {
-        self.bits & (1 << 0) != 0
-    }
-
     /// Supervisor Software Interrupt Enable
     #[inline]
     pub fn ssoft(&self) -> bool {
         self.bits & (1 << 1) != 0
     }
 
-    /// User Timer Interrupt Enable
-    #[inline]
-    pub fn utimer(&self) -> bool {
-        self.bits & (1 << 4) != 0
-    }
-
     /// Supervisor Timer Interrupt Enable
     #[inline]
     pub fn stimer(&self) -> bool {
         self.bits & (1 << 5) != 0
     }
 
-    /// User External Interrupt Enable
-    #[inline]
-    pub fn uext(&self) -> bool {
-        self.bits & (1 << 8) != 0
-    }
-
     /// Supervisor External Interrupt Enable
     #[inline]
     pub fn sext(&self) -> bool {
@@ -54,21 +36,12 @@ read_csr_as!(Sie, 0x104);
 set!(0x104);
 clear!(0x104);
 
-set_clear_csr!(
-    /// User Software Interrupt Enable
-    , set_usoft, clear_usoft, 1 << 0);
 set_clear_csr!(
     /// Supervisor Software Interrupt Enable
     , set_ssoft, clear_ssoft, 1 << 1);
-set_clear_csr!(
-    /// User Timer Interrupt Enable
-    , set_utimer, clear_utimer, 1 << 4);
 set_clear_csr!(
     /// Supervisor Timer Interrupt Enable
     , set_stimer, clear_stimer, 1 << 5);
-set_clear_csr!(
-    /// User External Interrupt Enable
-    , set_uext, clear_uext, 1 << 8);
 set_clear_csr!(
     /// Supervisor External Interrupt Enable
     , set_sext, clear_sext, 1 << 9);

src/register/sip.rs

@@ -13,36 +13,18 @@ impl Sip {
         self.bits
     }
 
-    /// User Software Interrupt Pending
-    #[inline]
-    pub fn usoft(&self) -> bool {
-        self.bits & (1 << 0) != 0
-    }
-
     /// Supervisor Software Interrupt Pending
     #[inline]
     pub fn ssoft(&self) -> bool {
         self.bits & (1 << 1) != 0
     }
 
-    /// User Timer Interrupt Pending
-    #[inline]
-    pub fn utimer(&self) -> bool {
-        self.bits & (1 << 4) != 0
-    }
-
     /// Supervisor Timer Interrupt Pending
     #[inline]
     pub fn stimer(&self) -> bool {
         self.bits & (1 << 5) != 0
     }
 
-    /// User External Interrupt Pending
-    #[inline]
-    pub fn uext(&self) -> bool {
-        self.bits & (1 << 8) != 0
-    }
-
     /// Supervisor External Interrupt Pending
     #[inline]
     pub fn sext(&self) -> bool {
@@ -51,3 +33,9 @@ impl Sip {
 }
 
 read_csr_as!(Sip, 0x144);
+set!(0x344);
+clear!(0x104);
+
+set_clear_csr!(
+    /// Supervisor Software Interrupt Pending
+    , set_ssoft, clear_ssoft, 1 << 1);

src/register/sstatus.rs

@@ -1,5 +1,6 @@
 //! sstatus register
 
+pub use super::misa::XLEN;
 pub use super::mstatus::FS;
 
 /// Supervisor Status Register
@@ -16,24 +17,12 @@ pub enum SPP {
 }
 
 impl Sstatus {
-    /// User Interrupt Enable
-    #[inline]
-    pub fn uie(&self) -> bool {
-        self.bits & (1 << 0) != 0
-    }
-
     /// Supervisor Interrupt Enable
     #[inline]
     pub fn sie(&self) -> bool {
         self.bits & (1 << 1) != 0
     }
 
-    /// User Previous Interrupt Enable
-    #[inline]
-    pub fn upie(&self) -> bool {
-        self.bits & (1 << 4) != 0
-    }
-
     /// Supervisor Previous Interrupt Enable
     #[inline]
     pub fn spie(&self) -> bool {
@@ -88,6 +77,19 @@ impl Sstatus {
         self.bits & (1 << 19) != 0
     }
 
+    /// Effective xlen in U-mode (i.e., `UXLEN`).
+    ///
+    /// In RISCV-32, UXL does not exist, and `UXLEN` is always [`XLEN::XLEN32`].
+    #[inline]
+    pub fn uxl(&self) -> XLEN {
+        match () {
+            #[cfg(riscv32)]
+            () => XLEN::XLEN32,
+            #[cfg(not(riscv32))]
+            () => XLEN::from((self.bits >> 32) as u8 & 0x3),
+        }
+    }
+
     /// Whether either the FS field or XS field
     /// signals the presence of some dirty state
     #[inline]

src/register/ucause.rs

@@ -1,24 +0,0 @@
-//! ucause register
-
-/// ucause register
-#[derive(Clone, Copy, Debug)]
-pub struct Ucause {
-    bits: usize,
-}
-
-impl Ucause {
-    /// Returns the contents of the register as raw bits
-    #[inline]
-    pub fn bits(&self) -> usize {
-        self.bits
-    }
-}
-
-read_csr_as!(Ucause, 0x042);
-write_csr!(0x042);
-
-/// Writes the CSR
-#[inline]
-pub unsafe fn write(bits: usize) {
-    _write(bits)
-}

src/register/uepc.rs

@@ -1,4 +0,0 @@
-//! uepc register
-
-read_csr_as_usize!(0x041);
-write_csr_as_usize!(0x041);

src/register/uie.rs

@@ -1,47 +0,0 @@
-//! uie register
-
-/// uie register
-#[derive(Clone, Copy, Debug)]
-pub struct Uie {
-    bits: usize,
-}
-
-impl Uie {
-    /// Returns the contents of the register as raw bits
-    #[inline]
-    pub fn bits(&self) -> usize {
-        self.bits
-    }
-
-    /// User Software Interrupt Enable
-    #[inline]
-    pub fn usoft(&self) -> bool {
-        self.bits & (1 << 0) != 0
-    }
-
-    /// User Timer Interrupt Enable
-    #[inline]
-    pub fn utimer(&self) -> bool {
-        self.bits & (1 << 4) != 0
-    }
-
-    /// User External Interrupt Enable
-    #[inline]
-    pub fn uext(&self) -> bool {
-        self.bits & (1 << 8) != 0
-    }
-}
-
-read_csr_as!(Uie, 0x004);
-set!(0x004);
-clear!(0x004);
-
-set_clear_csr!(
-    /// User Software Interrupt Enable
-    , set_usoft, clear_usoft, 1 << 0);
-set_clear_csr!(
-    /// User Timer Interrupt Enable
-    , set_utimer, clear_utimer, 1 << 4);
-set_clear_csr!(
-    /// User External Interrupt Enable
-    , set_uext, clear_uext, 1 << 8);

src/register/uip.rs

@@ -1,35 +0,0 @@
-//! uip register
-
-/// uip register
-#[derive(Clone, Copy, Debug)]
-pub struct Uip {
-    bits: usize,
-}
-
-impl Uip {
-    /// Returns the contents of the register as raw bits
-    #[inline]
-    pub fn bits(&self) -> usize {
-        self.bits
-    }
-
-    /// User Software Interrupt Pending
-    #[inline]
-    pub fn usoft(&self) -> bool {
-        self.bits & (1 << 0) != 0
-    }
-
-    /// User Timer Interrupt Pending
-    #[inline]
-    pub fn utimer(&self) -> bool {
-        self.bits & (1 << 4) != 0
-    }
-
-    /// User External Interrupt Pending
-    #[inline]
-    pub fn uext(&self) -> bool {
-        self.bits & (1 << 8) != 0
-    }
-}
-
-read_csr_as!(Uip, 0x044);

src/register/uscratch.rs

@@ -1,4 +0,0 @@
-//! uscratch register
-
-read_csr_as_usize!(0x040);
-write_csr_as_usize!(0x040);

src/register/ustatus.rs

@@ -1,35 +0,0 @@
-//! ustatus register
-// TODO: Virtualization, Memory Privilege and Extension Context Fields
-
-/// ustatus register
-#[derive(Clone, Copy, Debug)]
-pub struct Ustatus {
-    bits: usize,
-}
-
-impl Ustatus {
-    /// User Interrupt Enable
-    #[inline]
-    pub fn uie(&self) -> bool {
-        self.bits & (1 << 0) != 0
-    }
-
-    /// User Previous Interrupt Enable
-    #[inline]
-    pub fn upie(&self) -> bool {
-        self.bits & (1 << 4) != 0
-    }
-}
-
-read_csr_as!(Ustatus, 0x000);
-write_csr!(0x000);
-set!(0x000);
-clear!(0x000);
-
-set_clear_csr!(
-    /// User Interrupt Enable
-    , set_uie, clear_uie, 1 << 0);
-
-set_csr!(
-    /// User Previous Interrupt Enable
-    , set_upie, 1 << 4);

src/register/utval.rs

@@ -1,10 +0,0 @@
-//! utval register
-
-read_csr_as_usize!(0x043);
-write_csr!(0x043);
-
-/// Writes the CSR
-#[inline]
-pub unsafe fn write(bits: usize) {
-    _write(bits)
-}

src/register/utvec.rs

@@ -1,43 +0,0 @@
-//! stvec register
-
-pub use crate::register::mtvec::TrapMode;
-
-/// stvec register
-#[derive(Clone, Copy, Debug)]
-pub struct Utvec {
-    bits: usize,
-}
-
-impl Utvec {
-    /// Returns the contents of the register as raw bits
-    #[inline]
-    pub fn bits(&self) -> usize {
-        self.bits
-    }
-
-    /// Returns the trap-vector base-address
-    #[inline]
-    pub fn address(&self) -> usize {
-        self.bits - (self.bits & 0b11)
-    }
-
-    /// Returns the trap-vector mode
-    #[inline]
-    pub fn trap_mode(&self) -> Option<TrapMode> {
-        let mode = self.bits & 0b11;
-        match mode {
-            0 => Some(TrapMode::Direct),
-            1 => Some(TrapMode::Vectored),
-            _ => None,
-        }
-    }
-}
-
-read_csr_as!(Utvec, 0x005);
-write_csr!(0x005);
-
-/// Writes the CSR
-#[inline]
-pub unsafe fn write(addr: usize, mode: TrapMode) {
-    _write(addr + mode as usize);
-}