refactor(uart): add enable_uart clock configurator

Signed-off-by: Zhouqi Jiang <[email protected]>

Author: luojia65

allwinner-hal/src/uart/blocking.rs

@@ -19,7 +19,7 @@ impl<'a> Serial<'a> {
         uart: impl Instance<'a>,
         pads: impl Pads<'a, I>,
         config: impl Into<Config>,
-        clock: impl Clock,
+        clock: impl Clock<I>,
     ) -> Serial<'a> {
         // 1. unwrap parameters
         let Config {

allwinner-hal/src/uart/mod.rs

@@ -21,7 +21,7 @@ pub trait UartExt<'a, const I: usize> {
         self,
         pads: impl Pads<'a, I>,
         config: impl Into<Config>,
-        clock: impl Clock,
+        clock: impl Clock<I>,
     ) -> BlockingSerial<'a>;
 }
 
@@ -62,8 +62,8 @@ where
     }
 }
 
-/// Valid clock input for UART peripheral.
-pub trait Clock {
+/// Valid clock input for UART peripheral `I`.
+pub trait Clock<const I: usize> {
     /// UART clock frequency in hertz.
     fn uart_clock(&self) -> Hertz;
 }

allwinner-rt/src/macros.rs

@@ -84,7 +84,7 @@ macro_rules! impl_uart {
                     self,
                     pads: impl allwinner_hal::uart::Pads<'a, $i>,
                     config: impl Into<allwinner_hal::uart::Config>,
-                    clock: impl allwinner_hal::uart::Clock,
+                    clock: impl allwinner_hal::uart::Clock<$i>,
                 ) -> allwinner_hal::uart::BlockingSerial<'a> {
                     allwinner_hal::uart::BlockingSerial::new(self, pads, config, clock)
                 }
@@ -95,7 +95,7 @@ macro_rules! impl_uart {
                     self,
                     pads: impl allwinner_hal::uart::Pads<'static, $i>,
                     config: impl Into<allwinner_hal::uart::Config>,
-                    clock: impl allwinner_hal::uart::Clock,
+                    clock: impl allwinner_hal::uart::Clock<$i>,
                 ) -> allwinner_hal::uart::BlockingSerial<'static> {
                     allwinner_hal::uart::BlockingSerial::new(self, pads, config, clock)
                 }

allwinner-rt/src/soc/d1.rs

@@ -1,8 +1,12 @@
 //! D1-H, D1s, F133, F133A/B chip platforms.
 
+mod clock;
+
+pub use clock::{Clocks, UartClock};
+
 use allwinner_hal::{gpio::PadExt, uart::UartExt};
 use core::num::NonZeroU32;
-use embedded_time::rate::{Extensions, Hertz};
+use embedded_time::rate::Extensions;
 
 /// ROM runtime peripheral ownership and configurations.
 pub struct Peripherals {
@@ -288,44 +292,6 @@ impl_spi_pads! {
 //     ('C', 7, 3): smhc::Data<3>;
 // }
 
-/// ROM clock configuration on current SoC.
-#[derive(Debug)]
-pub struct Clocks {
-    /// PSI clock frequency.
-    pub psi: Hertz,
-    /// Advanced Peripheral Bus 1 clock frequency.
-    pub apb1: Hertz,
-}
-
-impl allwinner_hal::uart::Clock for Clocks {
-    #[inline]
-    fn uart_clock(&self) -> embedded_time::rate::Hertz {
-        self.apb1
-    }
-}
-
-impl<'a> allwinner_hal::uart::Clock for &'a Clocks {
-    #[inline]
-    fn uart_clock(&self) -> embedded_time::rate::Hertz {
-        self.apb1
-    }
-}
-
-impl allwinner_hal::spi::Clock for Clocks {
-    #[inline]
-    fn spi_clock(&self) -> embedded_time::rate::Hertz {
-        // TODO calculate from more clock parameters
-        self.psi
-    }
-}
-
-impl allwinner_hal::smhc::Clock for Clocks {
-    #[inline]
-    fn smhc_clock(&self) -> embedded_time::rate::Hertz {
-        self.psi
-    }
-}
-
 #[doc(hidden)]
 #[inline]
 pub fn __rom_init_params() -> (Peripherals, Clocks) {

allwinner-rt/src/soc/d1/clock.rs

@@ -0,0 +1,60 @@
+use super::CCU;
+use embedded_time::rate::Hertz;
+
+/// ROM clock configuration on current SoC.
+#[derive(Debug)]
+pub struct Clocks {
+    /// PSI clock frequency.
+    pub psi: Hertz,
+    /// Advanced Peripheral Bus 1 clock frequency.
+    pub apb1: Hertz,
+}
+
+impl Clocks {
+    /// Enable clock of UART `I`.
+    #[inline]
+    pub fn enable_uart<const I: usize>(&self, ccu: &CCU) -> UartClock<I> {
+        unsafe {
+            ccu.uart_bgr
+                .modify(|v| v.gate_pass::<0>().deassert_reset::<0>())
+        };
+        UartClock { apb1: self.apb1 }
+    }
+}
+
+// No UART clock; should enable first.
+
+impl allwinner_hal::spi::Clock for Clocks {
+    #[inline]
+    fn spi_clock(&self) -> embedded_time::rate::Hertz {
+        // TODO calculate from more clock parameters
+        self.psi
+    }
+}
+
+impl allwinner_hal::smhc::Clock for Clocks {
+    #[inline]
+    fn smhc_clock(&self) -> embedded_time::rate::Hertz {
+        self.psi
+    }
+}
+
+/// Dynamic configurated clock configuration on current SoC.
+pub struct UartClock<const I: usize> {
+    /// Inherited from Advanced Peripheral Bus 1 clock frequency.
+    apb1: Hertz,
+}
+
+impl<const I: usize> allwinner_hal::uart::Clock<I> for UartClock<I> {
+    #[inline]
+    fn uart_clock(&self) -> embedded_time::rate::Hertz {
+        self.apb1
+    }
+}
+
+impl<'a, const I: usize> allwinner_hal::uart::Clock<I> for &'a UartClock<I> {
+    #[inline]
+    fn uart_clock(&self) -> embedded_time::rate::Hertz {
+        self.apb1
+    }
+}

examples/nezha-d1/src/bin/sdmmc.rs

@@ -21,8 +21,9 @@ impl embedded_sdmmc::TimeSource for MyTimeSource {
 
 #[entry]
 fn main(p: Peripherals, c: Clocks) {
+    let clk = c.enable_uart(&p.ccu);
     let pads = (p.gpio.pb8, p.gpio.pb9);
-    let mut serial = p.uart0.serial(pads, Config::default(), &c);
+    let mut serial = p.uart0.serial(pads, Config::default(), &clk);
 
     writeln!(serial, "Hello World!").ok();
 

examples/nezha-d1/src/bin/uart.rs

@@ -6,15 +6,9 @@ use allwinner_rt::{Clocks, Peripherals, entry};
 
 #[entry]
 fn main(p: Peripherals, c: Clocks) {
-    // TODO make it clean
-    unsafe {
-        p.ccu
-            .uart_bgr
-            .modify(|v| v.gate_pass::<0>().deassert_reset::<0>())
-    };
-
+    let clk = c.enable_uart(&p.ccu);
     let pads = (p.gpio.pb8, p.gpio.pb9);
-    let mut serial = p.uart0.serial(pads, Config::default(), &c);
+    let mut serial = p.uart0.serial(pads, Config::default(), &clk);
 
     writeln!(serial, "Hello World!").ok();