added trap macros with tests in riscv-rt

Author: romancardenas

riscv-pac/CHANGELOG.md

@@ -16,7 +16,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed 
 
-- `InterruptNumber` trait now expects `usize`
+- All traits now work with `usize` data type.
 
 ## [v0.1.1] - 2024-02-15
 

riscv-pac/src/lib.rs

@@ -26,7 +26,6 @@ pub unsafe trait ExceptionNumber: Copy {
     fn number(self) -> usize;
 
     /// Tries to convert a number to a valid exception.
-    /// If the conversion fails, it returns an error with the number back.
     fn from_number(value: usize) -> Result<Self>;
 }
 
@@ -51,8 +50,7 @@ pub unsafe trait InterruptNumber: Copy {
     /// Converts an interrupt source to its corresponding number.
     fn number(self) -> usize;
 
-    /// Tries to convert a number to a valid interrupt source.
-    /// If the conversion fails, it returns an error with the number back.
+    /// Tries to convert a number to a valid interrupt.
     fn from_number(value: usize) -> Result<Self>;
 }
 
@@ -83,7 +81,7 @@ pub unsafe trait ExternalInterruptNumber: InterruptNumber {}
 /// Trait for enums of priority levels.
 ///
 /// This trait should be implemented by a peripheral access crate (PAC) on its enum of available
-/// priority numbers for a specific device. Each variant must convert to a `u8` of its priority level.
+/// priority numbers for a specific device. Each variant must convert to a `usize` of its priority level.
 ///
 /// # Safety
 ///
@@ -95,20 +93,19 @@ pub unsafe trait ExternalInterruptNumber: InterruptNumber {}
 /// * `MAX_PRIORITY_NUMBER` must coincide with the highest allowed priority number.
 pub unsafe trait PriorityNumber: Copy {
     /// Number assigned to the highest priority level.
-    const MAX_PRIORITY_NUMBER: u8;
+    const MAX_PRIORITY_NUMBER: usize;
 
     /// Converts a priority level to its corresponding number.
-    fn number(self) -> u8;
+    fn number(self) -> usize;
 
     /// Tries to convert a number to a valid priority level.
-    /// If the conversion fails, it returns an error with the number back.
-    fn from_number(value: u8) -> Result<Self>;
+    fn from_number(value: usize) -> Result<Self>;
 }
 
 /// Trait for enums of HART identifiers.
 ///
 /// This trait should be implemented by a peripheral access crate (PAC) on its enum of available
-/// HARTs for a specific device. Each variant must convert to a `u16` of its HART ID number.
+/// HARTs for a specific device. Each variant must convert to a `usize` of its HART ID number.
 ///
 /// # Safety
 ///
@@ -120,14 +117,13 @@ pub unsafe trait PriorityNumber: Copy {
 /// * `MAX_HART_ID_NUMBER` must coincide with the highest allowed HART ID number.
 pub unsafe trait HartIdNumber: Copy {
     /// Highest number assigned to a context.
-    const MAX_HART_ID_NUMBER: u16;
+    const MAX_HART_ID_NUMBER: usize;
 
     /// Converts a HART ID to its corresponding number.
-    fn number(self) -> u16;
+    fn number(self) -> usize;
 
     /// Tries to convert a number to a valid HART ID.
-    /// If the conversion fails, it returns an error with the number back.
-    fn from_number(value: u16) -> Result<Self>;
+    fn from_number(value: usize) -> Result<Self>;
 }
 
 #[cfg(test)]
@@ -201,40 +197,40 @@ mod test {
     }
 
     unsafe impl PriorityNumber for Priority {
-        const MAX_PRIORITY_NUMBER: u8 = Self::P3 as u8;
+        const MAX_PRIORITY_NUMBER: usize = Self::P3 as usize;
 
         #[inline]
-        fn number(self) -> u8 {
+        fn number(self) -> usize {
             self as _
         }
 
         #[inline]
-        fn from_number(number: u8) -> Result<Self> {
+        fn from_number(number: usize) -> Result<Self> {
             match number {
                 0 => Ok(Priority::P0),
                 1 => Ok(Priority::P1),
                 2 => Ok(Priority::P2),
                 3 => Ok(Priority::P3),
-                _ => Err(Error::InvalidVariant(number as _)),
+                _ => Err(Error::InvalidVariant(number)),
             }
         }
     }
 
     unsafe impl HartIdNumber for HartId {
-        const MAX_HART_ID_NUMBER: u16 = Self::H2 as u16;
+        const MAX_HART_ID_NUMBER: usize = Self::H2 as usize;
 
         #[inline]
-        fn number(self) -> u16 {
+        fn number(self) -> usize {
             self as _
         }
 
         #[inline]
-        fn from_number(number: u16) -> Result<Self> {
+        fn from_number(number: usize) -> Result<Self> {
             match number {
                 0 => Ok(HartId::H0),
                 1 => Ok(HartId::H1),
                 2 => Ok(HartId::H2),
-                _ => Err(Error::InvalidVariant(number as _)),
+                _ => Err(Error::InvalidVariant(number)),
             }
         }
     }

riscv-peripheral/CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
+- Adapt to new version of `riscv-pac` traits.
 - `PLIC` now expects interrupt enums to implement the `riscv_pac::ExternalInterruptNumber` trait.
 
 ### Fixed

riscv-peripheral/examples/e310x.rs

@@ -13,18 +13,18 @@ pub enum HartId {
 }
 
 unsafe impl HartIdNumber for HartId {
-    const MAX_HART_ID_NUMBER: u16 = Self::H0 as u16;
+    const MAX_HART_ID_NUMBER: usize = Self::H0 as usize;
 
     #[inline]
-    fn number(self) -> u16 {
+    fn number(self) -> usize {
         self as _
     }
 
     #[inline]
-    fn from_number(number: u16) -> Result<Self> {
+    fn from_number(number: usize) -> Result<Self> {
         match number {
             0 => Ok(Self::H0),
-            _ => Err(Error::InvalidVariant(number as usize)),
+            _ => Err(Error::InvalidVariant(number)),
         }
     }
 }
@@ -108,6 +108,7 @@ unsafe impl InterruptNumber for Interrupt {
 unsafe impl ExternalInterruptNumber for Interrupt {}
 
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
+#[repr(usize)]
 pub enum Priority {
     P0 = 0,
     P1 = 1,
@@ -120,20 +121,20 @@ pub enum Priority {
 }
 
 unsafe impl PriorityNumber for Priority {
-    const MAX_PRIORITY_NUMBER: u8 = Self::P7 as u8;
+    const MAX_PRIORITY_NUMBER: usize = Self::P7 as usize;
 
     #[inline]
-    fn number(self) -> u8 {
+    fn number(self) -> usize {
         self as _
     }
 
     #[inline]
-    fn from_number(number: u8) -> Result<Self> {
+    fn from_number(number: usize) -> Result<Self> {
         if number > Self::MAX_PRIORITY_NUMBER {
-            Err(Error::InvalidVariant(number as usize))
+            Err(Error::InvalidVariant(number))
         } else {
             // SAFETY: valid priority number
-            Ok(unsafe { core::mem::transmute::<u8, Priority>(number) })
+            Ok(unsafe { core::mem::transmute::<usize, Priority>(number) })
         }
     }
 }

riscv-peripheral/src/aclint.rs

@@ -66,28 +66,28 @@ pub(crate) mod test {
     use riscv_pac::result::{Error, Result};
 
     #[derive(Clone, Copy, Debug, Eq, PartialEq)]
-    #[repr(u16)]
+    #[repr(usize)]
     pub(crate) enum HartId {
         H0 = 0,
         H1 = 1,
         H2 = 2,
     }
 
     unsafe impl HartIdNumber for HartId {
-        const MAX_HART_ID_NUMBER: u16 = 2;
+        const MAX_HART_ID_NUMBER: usize = Self::H2 as usize;
 
         #[inline]
-        fn number(self) -> u16 {
+        fn number(self) -> usize {
             self as _
         }
 
         #[inline]
-        fn from_number(number: u16) -> Result<Self> {
+        fn from_number(number: usize) -> Result<Self> {
             if number > Self::MAX_HART_ID_NUMBER {
-                Err(Error::InvalidVariant(number as usize))
+                Err(Error::InvalidVariant(number))
             } else {
                 // SAFETY: valid context number
-                Ok(unsafe { core::mem::transmute::<u16, HartId>(number) })
+                Ok(unsafe { core::mem::transmute::<usize, HartId>(number) })
             }
         }
     }

riscv-peripheral/src/aclint/mswi.rs

@@ -33,7 +33,7 @@ impl MSWI {
     #[inline]
     pub fn msip<H: HartIdNumber>(&self, hart_id: H) -> MSIP {
         // SAFETY: `hart_id` is valid for the target
-        unsafe { MSIP::new(self.msip0.get_ptr().offset(hart_id.number() as _) as _) }
+        unsafe { MSIP::new(self.msip0.get_ptr().add(hart_id.number()) as _) }
     }
 
     /// Returns the `MSIP` register for the current HART.

riscv-peripheral/src/aclint/mtimer.rs

@@ -35,7 +35,7 @@ impl MTIMER {
     #[inline]
     pub fn mtimecmp<H: HartIdNumber>(&self, hart_id: H) -> MTIMECMP {
         // SAFETY: `hart_id` is valid for the target
-        unsafe { MTIMECMP::new(self.mtimecmp0.get_ptr().offset(hart_id.number() as _) as _) }
+        unsafe { MTIMECMP::new(self.mtimecmp0.get_ptr().add(hart_id.number()) as _) }
     }
 
     /// Returns the `MTIMECMP` register for the current HART.

riscv-peripheral/src/aclint/sswi.rs

@@ -64,7 +64,7 @@ impl SSWI {
     #[inline]
     pub fn setssip<H: HartIdNumber>(&self, hart_id: H) -> SETSSIP {
         // SAFETY: `hart_id` is valid for the target
-        unsafe { SETSSIP::new(self.setssip0.get_ptr().offset(hart_id.number() as _) as _) }
+        unsafe { SETSSIP::new(self.setssip0.get_ptr().add(hart_id.number()) as _) }
     }
 }
 

riscv-peripheral/src/macros.rs

@@ -37,14 +37,14 @@
 ///
 /// // Implement `HartIdNumber` for `HartId`
 /// unsafe impl riscv_peripheral::aclint::HartIdNumber for HartId {
-///   const MAX_HART_ID_NUMBER: u16 = 2;
-///   fn number(self) -> u16 { self as _ }
-///   fn from_number(number: u16) -> Result<Self> {
+///   const MAX_HART_ID_NUMBER: usize = Self::H2 as usize;
+///   fn number(self) -> usize { self as _ }
+///   fn from_number(number: usize) -> Result<Self> {
 ///     match number {
 ///      0 => Ok(HartId::H0),
 ///      1 => Ok(HartId::H1),
 ///      2 => Ok(HartId::H2),
-///      _ => Err(Error::InvalidVariant(number as _)),
+///      _ => Err(Error::InvalidVariant(number)),
 ///     }
 ///   }
 /// }

riscv-peripheral/src/plic.rs

@@ -64,7 +64,7 @@ impl<P: Plic> PLIC<P> {
     #[inline]
     pub fn ctx<H: HartIdNumber>(hart_id: H) -> CTX<P> {
         // SAFETY: valid context number
-        unsafe { CTX::new(hart_id.number()) }
+        unsafe { CTX::new(hart_id.number() as _) }
     }
 
     /// Returns the PLIC HART context for the current HART.
@@ -149,7 +149,6 @@ pub(crate) mod test {
     use riscv_pac::{ExternalInterruptNumber, HartIdNumber, InterruptNumber, PriorityNumber};
 
     #[derive(Clone, Copy, Debug, Eq, PartialEq)]
-    #[repr(usize)]
     pub(crate) enum Interrupt {
         I1 = 1,
         I2 = 2,
@@ -158,7 +157,6 @@ pub(crate) mod test {
     }
 
     #[derive(Clone, Copy, Debug, Eq, PartialEq)]
-    #[repr(u8)]
     pub(crate) enum Priority {
         P0 = 0,
         P1 = 1,
@@ -167,15 +165,14 @@ pub(crate) mod test {
     }
 
     #[derive(Clone, Copy, Debug, Eq, PartialEq)]
-    #[repr(u16)]
     pub(crate) enum Context {
         C0 = 0,
         C1 = 1,
         C2 = 2,
     }
 
     unsafe impl InterruptNumber for Interrupt {
-        const MAX_INTERRUPT_NUMBER: usize = 4;
+        const MAX_INTERRUPT_NUMBER: usize = Self::I4 as usize;
 
         #[inline]
         fn number(self) -> usize {
@@ -197,40 +194,40 @@ pub(crate) mod test {
     unsafe impl ExternalInterruptNumber for Interrupt {}
 
     unsafe impl PriorityNumber for Priority {
-        const MAX_PRIORITY_NUMBER: u8 = 3;
+        const MAX_PRIORITY_NUMBER: usize = Self::P3 as usize;
 
         #[inline]
-        fn number(self) -> u8 {
+        fn number(self) -> usize {
             self as _
         }
 
         #[inline]
-        fn from_number(number: u8) -> Result<Self> {
+        fn from_number(number: usize) -> Result<Self> {
             match number {
                 0 => Ok(Priority::P0),
                 1 => Ok(Priority::P1),
                 2 => Ok(Priority::P2),
                 3 => Ok(Priority::P3),
-                _ => Err(Error::InvalidVariant(number as usize)),
+                _ => Err(Error::InvalidVariant(number)),
             }
         }
     }
 
     unsafe impl HartIdNumber for Context {
-        const MAX_HART_ID_NUMBER: u16 = 2;
+        const MAX_HART_ID_NUMBER: usize = Self::C2 as usize;
 
         #[inline]
-        fn number(self) -> u16 {
+        fn number(self) -> usize {
             self as _
         }
 
         #[inline]
-        fn from_number(number: u16) -> Result<Self> {
+        fn from_number(number: usize) -> Result<Self> {
             match number {
                 0 => Ok(Context::C0),
                 1 => Ok(Context::C1),
                 2 => Ok(Context::C2),
-                _ => Err(Error::InvalidVariant(number as usize)),
+                _ => Err(Error::InvalidVariant(number)),
             }
         }
     }

riscv-rt/CHANGELOG.md

@@ -9,17 +9,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+- Add integration tests to check that macros work as expected.
 - Add `no-exceptions` feature to opt-out the default implementation of `_dispatch_exception`
 - Add `no-interrupts` feature to opt-out the default implementation of `_dispatch_core_interrupt`
 - Add `pre_init_trap` to detect early errors during the boot process.
 - Add `v-trap` feature to enable interrupt handling in vectored mode.
 - Add `core_interrupt` proc macro to help defining core interrupt handlers.
+  If `v-trap` feature is enabled, this macro also generates its corresponding trap.
 - Add `external_interrupt` proc macro to help defining external interrupt handlers.
 - Add `exception` proc macro to help defining exception handlers.
-  If `v-trap` feature is enabled, this macro also generates its corresponding trap.
 
 ### Changed
 
+- Use `cfg_attr` in `start_trap_rust` to allow compilation in non-riscv targets.
 - Moved all the assembly code to `asm.rs`
 - Use `weak` symbols for functions such as `_mp_hook` or `_start_trap`
 - `abort` is now `weak`, so it is possible to link third-party libraries including this symbol.