feat(all): add multiple instances and peripherals

artinchip-hal/Cargo.toml

@@ -14,6 +14,7 @@ embedded-hal = "1.0.0"
 embedded-time = "0.12.1"
 embedded-io = "0.7.1"
 riscv = "0.15.0"
+xuantie-riscv = {git = "https://github.com/rustsbi/xuantie.git", branch = "main"}
 
 [features]
 d12x = []

artinchip-hal/src/axi_cfg.rs

@@ -1,5 +1,7 @@
 //! AXI Configuration (AXICFG).
 
+mod instance;
 mod register;
 
+pub use instance::AxiCfg;
 pub use register::*;

artinchip-hal/src/axi_cfg/instance.rs

@@ -0,0 +1,25 @@
+//! AXI CFG instance.
+
+use super::register::RegisterBlock;
+use core::marker::PhantomData;
+
+/// AXI CFG instance.
+pub struct AxiCfg {
+    reg: *const RegisterBlock,
+    _private: PhantomData<()>,
+}
+
+impl AxiCfg {
+    /// Create a new AXI CFG instance.
+    pub const fn __new(reg: *const RegisterBlock) -> Self {
+        Self {
+            reg,
+            _private: PhantomData,
+        }
+    }
+
+    /// Get a reference to the register block.
+    pub const fn register_block(&self) -> &'static RegisterBlock {
+        unsafe { &*self.reg }
+    }
+}

artinchip-hal/src/ce.rs

@@ -1,5 +1,7 @@
 //! Crypto Engine (CE).
 
+mod instance;
 mod register;
 
+pub use instance::Ce;
 pub use register::*;

artinchip-hal/src/ce/instance.rs

@@ -0,0 +1,25 @@
+//! CE instance.
+
+use super::register::RegisterBlock;
+use core::marker::PhantomData;
+
+/// CE instance.
+pub struct Ce {
+    reg: *const RegisterBlock,
+    _private: PhantomData<()>,
+}
+
+impl Ce {
+    /// Create a new CE instance.
+    pub const fn __new(reg: *const RegisterBlock) -> Self {
+        Self {
+            reg,
+            _private: PhantomData,
+        }
+    }
+
+    /// Get a reference to the register block.
+    pub const fn register_block(&self) -> &'static RegisterBlock {
+        unsafe { &*self.reg }
+    }
+}

artinchip-hal/src/clic.rs

@@ -0,0 +1,7 @@
+//! Xuantie CLIC (Core Local Interrupt Controller).
+
+mod instance;
+mod register;
+
+pub use instance::Clic;
+pub use register::*;

artinchip-hal/src/clic/instance.rs

@@ -0,0 +1,25 @@
+//! CLIC instance.
+
+use super::register::RegisterBlock;
+use core::marker::PhantomData;
+
+/// CLIC instance.
+pub struct Clic {
+    reg: *const RegisterBlock,
+    _private: PhantomData<()>,
+}
+
+impl Clic {
+    /// Create a new CLIC instance.
+    pub const fn __new(reg: *const RegisterBlock) -> Self {
+        Self {
+            reg,
+            _private: PhantomData,
+        }
+    }
+
+    /// Get a reference to the register block.
+    pub const fn register_block(&self) -> &'static RegisterBlock {
+        unsafe { &*self.reg }
+    }
+}

artinchip-hal/src/clic/register.rs

@@ -0,0 +1,3 @@
+//! CLIC register blocks and registers.
+
+pub use xuantie_riscv::peripheral::clic::Clic as RegisterBlock;

artinchip-hal/src/clint.rs

@@ -0,0 +1,7 @@
+//! Xuantie CLINT (Core Local Interrupt).
+
+mod instance;
+mod register;
+
+pub use instance::Clint;
+pub use register::*;

artinchip-hal/src/clint/instance.rs

@@ -0,0 +1,25 @@
+//! CLINT instance.
+
+use super::register::RegisterBlock;
+use core::marker::PhantomData;
+
+/// CLINT instance.
+pub struct Clint {
+    reg: *const RegisterBlock,
+    _private: PhantomData<()>,
+}
+
+impl Clint {
+    /// Create a new CLINT instance.
+    pub const fn __new(reg: *const RegisterBlock) -> Self {
+        Self {
+            reg,
+            _private: PhantomData,
+        }
+    }
+
+    /// Get a reference to the register block.
+    pub const fn register_block(&self) -> &'static RegisterBlock {
+        unsafe { &*self.reg }
+    }
+}

artinchip-hal/src/clint/register.rs

@@ -0,0 +1,3 @@
+//! CLINT register blocks and registers.
+
+pub use xuantie_riscv::peripheral::clint::THeadClint as RegisterBlock;

artinchip-hal/src/cmu.rs

@@ -1,5 +1,7 @@
 //! Clock Manage Unit (CMU).
 
+mod instance;
 mod register;
 
+pub use instance::Cmu;
 pub use register::*;

artinchip-hal/src/cmu/instance.rs

@@ -0,0 +1,25 @@
+//! CMU instance.
+
+use super::register::RegisterBlock;
+use core::marker::PhantomData;
+
+/// CMU instance.
+pub struct Cmu {
+    reg: *const RegisterBlock,
+    _private: PhantomData<()>,
+}
+
+impl Cmu {
+    /// Create a new CMU instance.
+    pub const fn __new(reg: *const RegisterBlock) -> Self {
+        Self {
+            reg,
+            _private: PhantomData,
+        }
+    }
+
+    /// Get a reference to the register block.
+    pub const fn register_block(&self) -> &'static RegisterBlock {
+        unsafe { &*self.reg }
+    }
+}

artinchip-hal/src/dma.rs

@@ -1,5 +1,7 @@
 //! Direct Memory Access (DMA).
 
+mod instance;
 mod register;
 
+pub use instance::Dma;
 pub use register::*;

artinchip-hal/src/dma/instance.rs

@@ -0,0 +1,25 @@
+//! DMA instance.
+
+use super::register::RegisterBlock;
+use core::marker::PhantomData;
+
+/// DMA instance.
+pub struct Dma {
+    reg: *const RegisterBlock,
+    _private: PhantomData<()>,
+}
+
+impl Dma {
+    /// Create a new DMA instance.
+    pub const fn __new(reg: *const RegisterBlock) -> Self {
+        Self {
+            reg,
+            _private: PhantomData,
+        }
+    }
+
+    /// Get a reference to the register block.
+    pub const fn register_block(&self) -> &'static RegisterBlock {
+        unsafe { &*self.reg }
+    }
+}

artinchip-hal/src/gtc/delay.rs

@@ -1,7 +1,8 @@
 //! Timer delay source.
 
+use super::instance::Gtc;
 use super::register::{CntFreq, RegisterBlock};
-use crate::cmu;
+use crate::cmu::Cmu;
 
 /// Timer delay source.
 pub struct TimerDelay<'a> {
@@ -10,8 +11,8 @@ pub struct TimerDelay<'a> {
 
 impl<'a> TimerDelay<'a> {
     /// Create a new TimerDelay instance.
-    pub fn new(reg: &'a RegisterBlock, freq: CntFreq, cmu: &cmu::RegisterBlock) -> Self {
-        let clk = &cmu.clock_gtc;
+    pub fn new(reg: &'a RegisterBlock, freq: CntFreq, cmu: &Cmu) -> Self {
+        let clk = &cmu.register_block().clock_gtc;
         unsafe {
             // Initialize module clock.
             // Reference: https://aicdoc.artinchip.com/topics/ic/cmu/cmu-function2-d13x.html#topic_yvp_f24_4bc__table_qb3_bn5_ydc
@@ -58,4 +59,13 @@ impl<'a> TimerDelay<'a> {
     pub fn delay_ms(&self, ms: u64) {
         self.delay_us(ms * 1_000);
     }
+
+    /// Free the TimerDelay and return GTC instance.
+    pub fn free(self, cmu: &Cmu) -> Gtc {
+        unsafe {
+            let clk = &cmu.register_block().clock_gtc;
+            clk.modify(|v| v.disable_bus_clk().enable_module_reset());
+        }
+        Gtc::__new(self.reg)
+    }
 }

artinchip-hal/src/gtc/gtc_ext.rs

@@ -2,9 +2,9 @@
 
 use super::delay::TimerDelay;
 use super::register::CntFreq;
-use crate::cmu;
+use crate::cmu::Cmu;
 
 pub trait GtcExt<'a> {
     /// Creates a new TimerDelay instance.
-    fn new_timer_delay(self, freq: CntFreq, cmu: &cmu::RegisterBlock) -> TimerDelay<'a>;
+    fn new_timer_delay(self, freq: CntFreq, cmu: &Cmu) -> TimerDelay<'a>;
 }

artinchip-hal/src/gtc/instance.rs

@@ -3,10 +3,10 @@
 use super::delay::TimerDelay;
 use super::gtc_ext::GtcExt;
 use super::register::{CntFreq, RegisterBlock};
-use crate::cmu;
+use crate::cmu::Cmu;
 use core::marker::PhantomData;
 
-/// Generic Timer Counter.
+/// GTC instance.
 pub struct Gtc {
     reg: *const RegisterBlock,
     _private: PhantomData<()>,
@@ -28,7 +28,7 @@ impl Gtc {
 }
 
 impl GtcExt<'static> for Gtc {
-    fn new_timer_delay(self, freq: CntFreq, cmu: &cmu::RegisterBlock) -> TimerDelay<'static> {
+    fn new_timer_delay(self, freq: CntFreq, cmu: &Cmu) -> TimerDelay<'static> {
         TimerDelay::new(self.register_block(), freq, cmu)
     }
 }

artinchip-hal/src/i2c/blocking.rs

@@ -6,7 +6,7 @@ use super::config::{I2cConfig, Role};
 use super::instance::I2c;
 use super::pad::{I2cPad, SerialClock, SerialData};
 use super::register::{AddressMode, RegisterBlock, SpeedMode, TransferMode};
-use crate::cmu;
+use crate::cmu::Cmu;
 
 /// Blocking I2C interface.
 pub struct BlockingI2c<'a, const I: u8, SCL, SDA>
@@ -28,14 +28,9 @@ where
     const I2C_DEFAULT_CLOCK: u32 = 24_000_000;
 
     /// Create a new blocking serial.
-    pub fn new(
-        reg: &'a RegisterBlock,
-        scl: SCL,
-        sda: SDA,
-        config: I2cConfig,
-        clk: &cmu::RegisterBlock,
-    ) -> Self {
+    pub fn new(reg: &'a RegisterBlock, scl: SCL, sda: SDA, config: I2cConfig, cmu: &Cmu) -> Self {
         // Reference: https://aicdoc.artinchip.com/topics/ic/i2c/i2c-programming-guide-d13x.html
+        let clk = cmu.register_block();
         let i2c_clk = match I {
             0 => &clk.clock_i2c0,
             1 => &clk.clock_i2c1,
@@ -157,8 +152,9 @@ where
     }
 
     /// Free the blocking I2C and return I2C instance, SCL and SDA pads.
-    pub fn free(self, clk: &cmu::RegisterBlock) -> (I2c<I>, SCL, SDA) {
+    pub fn free(self, cmu: &Cmu) -> (I2c<I>, SCL, SDA) {
         unsafe {
+            let clk = cmu.register_block();
             let i2c_clk = match I {
                 0 => &clk.clock_i2c0,
                 1 => &clk.clock_i2c1,

artinchip-hal/src/i2c/i2c_ext.rs

@@ -3,7 +3,7 @@
 use super::blocking::BlockingI2c;
 use super::config::I2cConfig;
 use super::pad::{I2cPad, SerialClock, SerialData};
-use crate::cmu;
+use crate::cmu::Cmu;
 
 pub trait I2cExt<'a, const I: u8> {
     /// Creates a blocking I2C interface with the specified pads.
@@ -12,7 +12,7 @@ pub trait I2cExt<'a, const I: u8> {
         scl: SCL,
         sda: SDA,
         config: I2cConfig,
-        cmu: &cmu::RegisterBlock,
+        cmu: &Cmu,
     ) -> BlockingI2c<'a, I, SCL, SDA>
     where
         SCL: I2cPad<I> + SerialClock<I>,

artinchip-hal/src/i2c/instance.rs

@@ -5,7 +5,7 @@ use super::config::I2cConfig;
 use super::i2c_ext::I2cExt;
 use super::pad::{I2cPad, SerialClock, SerialData};
 use super::register::RegisterBlock;
-use crate::cmu;
+use crate::cmu::Cmu;
 use core::marker::PhantomData;
 
 /// I2C with statically known instance number.
@@ -35,12 +35,12 @@ impl<const I: u8> I2cExt<'static, I> for I2c<I> {
         scl: SCL,
         sda: SDA,
         config: I2cConfig,
-        clk: &cmu::RegisterBlock,
+        cmu: &Cmu,
     ) -> BlockingI2c<'static, I, SCL, SDA>
     where
         SCL: I2cPad<I> + SerialClock<I>,
         SDA: I2cPad<I> + SerialData<I>,
     {
-        BlockingI2c::new(self.register_block(), scl, sda, config, clk)
+        BlockingI2c::new(self.register_block(), scl, sda, config, cmu)
     }
 }