Merge pull request #74 from GrassedgeT/main

feat: add some config flags with bitflags in chapter 11

sbi-spec/CHANGELOG.md

@@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 ## [Unreleased]
 
 ### Added
+- pmu: add config flags with bitflags in chapter 11
 
 ### Modified
 

sbi-spec/Cargo.toml

@@ -18,3 +18,6 @@ static_assertions = "1.1.0"
 default = []
 # Support for the legacy extension; this feature is not included by default.
 legacy = []
+
+[dependencies]
+bitflags = "2.6.0"

sbi-spec/src/lib.rs

@@ -253,6 +253,18 @@ mod tests {
         const_assert_eq!(65535, firmware_event::PLATFORM);
 
         const_assert_eq!(4096, shmem_size::SIZE);
+        const_assert_eq!(1, flags::CounterCfgFlags::SKIP_MATCH.bits());
+        const_assert_eq!(2, flags::CounterCfgFlags::CLEAR_VALUE.bits());
+        const_assert_eq!(4, flags::CounterCfgFlags::AUTO_START.bits());
+        const_assert_eq!(8, flags::CounterCfgFlags::SET_VUINH.bits());
+        const_assert_eq!(16, flags::CounterCfgFlags::SET_VSINH.bits());
+        const_assert_eq!(32, flags::CounterCfgFlags::SET_UINH.bits());
+        const_assert_eq!(64, flags::CounterCfgFlags::SET_SINH.bits());
+        const_assert_eq!(128, flags::CounterCfgFlags::SET_MINH.bits());
+        const_assert_eq!(1, flags::CounterStartFlags::INIT_VALUE.bits());
+        const_assert_eq!(2, flags::CounterStartFlags::INIT_SNAPSHOT.bits());
+        const_assert_eq!(1, flags::CounterStopFlags::RESET.bits());
+        const_assert_eq!(2, flags::CounterStopFlags::TAKE_SNAPSHOT.bits());
     }
     // §12
     #[test]

sbi-spec/src/pmu.rs

@@ -193,3 +193,57 @@ pub mod shmem_size {
     /// PMU snapshot memory size must be 4096 size on all architecture XLEN configurations.
     pub const SIZE: usize = 4096;
 }
+
+/// Find and configure a matching counter.
+/// Start a set of counters.
+/// Stop a set of counters.
+///  
+/// Declared in §11.7, §11.8 and §11.9.
+pub mod flags {
+    use bitflags::bitflags;
+
+    bitflags! {
+        #[derive(Clone, Copy, PartialEq, Eq)]
+        /// Declared in Table 36.
+        pub struct CounterCfgFlags: usize {
+            /// Skip the counter matching.
+            const SKIP_MATCH = 1 << 0;
+            /// Clear (or zero) the counter value in counter configuration.
+            const CLEAR_VALUE = 1 << 1;
+            /// Start the counter after configuring a matching counter.
+            const AUTO_START = 1 << 2;
+            /// Event counting inhibited in VU-mode.
+            const SET_VUINH = 1 << 3;
+            /// Event counting inhibited in VS-mode.
+            const SET_VSINH = 1 << 4;
+            /// Event counting inhibited in U-mode.
+            const SET_UINH = 1 << 5;
+            /// Event counting inhibited in S-mode.
+            const SET_SINH = 1 << 6;
+            /// Event counting inhibited in M-mode.
+            const SET_MINH = 1 << 7;
+        }
+    }
+
+    bitflags! {
+        #[derive(Clone, Copy, PartialEq, Eq)]
+        /// Declared in Table 38
+        pub struct CounterStartFlags: usize {
+            /// Set the value of counters based on the initial_value parameter.
+            const INIT_VALUE = 1 << 0;
+            /// Initialize the given counters from shared memory if available.
+            const INIT_SNAPSHOT = 1 << 1;
+        }
+    }
+
+    bitflags! {
+        #[derive(Clone, Copy, PartialEq, Eq)]
+        /// Declared in Table 40.
+        pub struct CounterStopFlags: usize {
+            /// Reset the counter to event mapping.
+            const RESET = 1 << 0;
+            /// Save a snapshot of the given counter’s values in the shared memory if available.
+            const TAKE_SNAPSHOT = 1 << 1;
+        }
+    }
+}