Merge pull request embassy-rs#5602 from jamesmunns/james/577-sosc

[MCXA5] Ungate SOSC and SPLL

Author: jamesmunns

embassy-mcxa/src/clocks/config.rs

@@ -130,11 +130,9 @@ pub struct ClocksConfig {
     /// SOSC, clk_in clock source
     ///
     /// NOTE: Requires `sosc-as-gpio` feature disabled, which also disables GPIO access to P1_30 and P1_31
-    #[cfg(feature = "mcxa2xx")]
     #[cfg(not(feature = "sosc-as-gpio"))]
     pub sosc: Option<SoscConfig>,
     /// SPLL
-    #[cfg(feature = "mcxa2xx")]
     pub spll: Option<SpllConfig>,
 }
 
@@ -281,7 +279,6 @@ pub enum MainClockSource {
     /// Clock derived from `clk_in`, via the external oscillator (8-50MHz)
     ///
     /// NOTE: Requires `sosc-as-gpio` feature disabled, which also disables GPIO access to P1_30 and P1_31
-    #[cfg(feature = "mcxa2xx")]
     #[cfg(not(feature = "sosc-as-gpio"))]
     SoscClkIn,
     /// Clock derived from `fro_12m`, via the internal 12MHz oscillator (12MHz)
@@ -296,7 +293,6 @@ pub enum MainClockSource {
     #[cfg(all(feature = "mcxa5xx", not(feature = "rosc-32k-as-gpio")))]
     RoscOsc32K,
     /// Clock derived from `pll1_clk`, via the internal PLL
-    #[cfg(feature = "mcxa2xx")]
     SPll1,
 }
 
@@ -354,6 +350,7 @@ pub enum SpllSource {
     /// Fast Internal Oscillator (45MHz)
     // NOTE: Figure 69 says "firc_45mhz"/"clk_45m", not "fro_hf_gated",
     // so this is is always 45MHz.
+    #[cfg(feature = "mcxa2xx")]
     Firc,
     /// S Internal Oscillator (12M)
     Sirc,
@@ -673,10 +670,8 @@ impl Default for ClocksConfig {
             }),
             #[cfg(all(feature = "mcxa5xx", not(feature = "rosc-32k-as-gpio")))]
             osc32k: None,
-            #[cfg(feature = "mcxa2xx")]
             #[cfg(not(feature = "sosc-as-gpio"))]
             sosc: None,
-            #[cfg(feature = "mcxa2xx")]
             spll: None,
         }
     }

embassy-mcxa/src/clocks/mod.rs

@@ -50,20 +50,20 @@ use periph_helpers::{PreEnableParts, SPConfHelper};
 use crate::chips::{ClockLimits, clock_limits};
 use crate::pac;
 use crate::pac::cmc::vals::CkctrlCkmode;
-#[cfg(feature = "mcxa2xx")]
 use crate::pac::scg::vals::{
-    Erefs, Fircacc, FircaccIe, FirccsrLk, Fircerr, FircerrIe, Fircsten, Fircvld, FreqSel, Range, SosccsrLk, Soscerr,
-    Source, SpllLock, SpllcsrLk, Spllerr, Spllsten, TrimUnlock,
+    Erefs, Range, Scs, SirccsrLk, Sircerr, Sircvld, SosccsrLk, Soscerr, Source, SpllLock, SpllcsrLk, Spllerr, Spllsten,
+    TrimUnlock,
 };
-use crate::pac::scg::vals::{Scs, SirccsrLk, Sircerr, Sircvld};
+#[cfg(feature = "mcxa2xx")]
+use crate::pac::scg::vals::{Fircacc, FircaccIe, FirccsrLk, Fircerr, FircerrIe, Fircsten, Fircvld, FreqSel};
 use crate::pac::spc::vals::{
     ActiveCfgBgmode, ActiveCfgCoreldoVddDs, ActiveCfgCoreldoVddLvl, LpCfgBgmode, LpCfgCoreldoVddLvl, Vsm,
 };
-use crate::pac::syscon::vals::{AhbclkdivUnstab, FrolfdivHalt, FrolfdivReset, FrolfdivUnstab};
-#[cfg(feature = "mcxa2xx")]
 use crate::pac::syscon::vals::{
-    FrohfdivHalt, FrohfdivReset, FrohfdivUnstab, Pll1clkdivHalt, Pll1clkdivReset, Pll1clkdivUnstab,
+    AhbclkdivUnstab, FrolfdivHalt, FrolfdivReset, FrolfdivUnstab, Pll1clkdivHalt, Pll1clkdivReset, Pll1clkdivUnstab,
 };
+#[cfg(feature = "mcxa2xx")]
+use crate::pac::syscon::vals::{FrohfdivHalt, FrohfdivReset, FrohfdivUnstab};
 pub mod config;
 pub mod periph_helpers;
 
@@ -132,10 +132,8 @@ pub fn init(settings: ClocksConfig) -> Result<(), ClockError> {
     #[cfg(all(feature = "mcxa5xx", not(feature = "rosc-32k-as-gpio")))]
     operator.configure_osc32k_clocks()?;
 
-    #[cfg(feature = "mcxa2xx")]
     #[cfg(not(feature = "sosc-as-gpio"))]
     operator.configure_sosc()?;
-    #[cfg(feature = "mcxa2xx")]
     operator.configure_spll()?;
 
     // Finally, setup main clock
@@ -307,7 +305,6 @@ unsafe fn restart_active_only_clocks(_cs: &CriticalSection) {
     }
 
     // Ensure SOSC is up and running
-    #[cfg(feature = "mcxa2xx")]
     #[cfg(not(feature = "sosc-as-gpio"))]
     if let Some(clk_in) = clocks.clk_in.as_ref()
         && !matches!(clk_in.power, PoweredClock::AlwaysEnabled)
@@ -316,7 +313,6 @@ unsafe fn restart_active_only_clocks(_cs: &CriticalSection) {
     }
 
     // Ensure SPLL is up and running
-    #[cfg(feature = "mcxa2xx")]
     if let Some(spll) = clocks.pll1_clk.as_ref()
         && !matches!(spll.power, PoweredClock::AlwaysEnabled)
     {
@@ -401,7 +397,6 @@ pub struct Clocks {
 
     /// The `clk_in` is a clock provided by an external oscillator
     /// AKA SOSC
-    #[cfg(feature = "mcxa2xx")]
     #[cfg(not(feature = "sosc-as-gpio"))]
     pub clk_in: Option<Clock>,
 
@@ -493,11 +488,9 @@ pub struct Clocks {
     pub cpu_system_clk: Option<Clock>,
 
     /// `pll1_clk` is the output of the main system PLL, `pll1`.
-    #[cfg(feature = "mcxa2xx")]
     pub pll1_clk: Option<Clock>,
 
     /// `pll1_clk_div` is a configurable frequency clock, sourced from `pll1_clk`
-    #[cfg(feature = "mcxa2xx")]
     pub pll1_clk_div: Option<Clock>,
 }
 
@@ -800,7 +793,6 @@ impl Clocks {
     }
 
     /// Ensure the `clk_in` clock is active and valid at the given power state.
-    #[cfg(feature = "mcxa2xx")]
     #[cfg(not(feature = "sosc-as-gpio"))]
     #[inline]
     pub fn ensure_clk_in_active(&self, at_level: &PoweredClock) -> Result<u32, ClockError> {
@@ -875,14 +867,12 @@ impl Clocks {
     }
 
     /// Ensure the `pll1_clk` clock is active and valid at the given power state.
-    #[cfg(feature = "mcxa2xx")]
     #[inline]
     pub fn ensure_pll1_clk_active(&self, at_level: &PoweredClock) -> Result<u32, ClockError> {
         self.ensure_clock_active(&self.pll1_clk, "pll1_clk", at_level)
     }
 
     /// Ensure the `pll1_clk_div` clock is active and valid at the given power state.
-    #[cfg(feature = "mcxa2xx")]
     #[inline]
     pub fn ensure_pll1_clk_div_active(&self, at_level: &PoweredClock) -> Result<u32, ClockError> {
         self.ensure_clock_active(&self.pll1_clk_div, "pll1_clk_div", at_level)
@@ -1576,7 +1566,6 @@ impl ClockOperator<'_> {
         Ok(())
     }
 
-    #[cfg(feature = "mcxa2xx")]
     fn ensure_ldo_active(&mut self, for_clock: &'static str, for_power: &PoweredClock) -> Result<(), ClockError> {
         let bg_good = match for_power {
             PoweredClock::NormalEnabledDeepSleepDisabled => self.clocks.bandgap_active,
@@ -1607,7 +1596,6 @@ impl ClockOperator<'_> {
     }
 
     /// Configure the SOSC/clk_in oscillator
-    #[cfg(feature = "mcxa2xx")]
     #[cfg(not(feature = "sosc-as-gpio"))]
     fn configure_sosc(&mut self) -> Result<(), ClockError> {
         let Some(parts) = self.config.sosc.as_ref() else {
@@ -1712,7 +1700,6 @@ impl ClockOperator<'_> {
         Ok(())
     }
 
-    #[cfg(feature = "mcxa2xx")]
     fn configure_spll(&mut self) -> Result<(), ClockError> {
         // # Vocab
         //
@@ -1746,6 +1733,7 @@ impl ClockOperator<'_> {
                 .as_ref()
                 .map(|c| (c, Source::SOSC))
                 .ok_or("sosc not active"),
+            #[cfg(feature = "mcxa2xx")]
             config::SpllSource::Firc => self
                 .clocks
                 .clk_45m
@@ -2091,7 +2079,6 @@ impl ClockOperator<'_> {
 
     fn configure_main_clk(&mut self) -> Result<(), ClockError> {
         let (var, name, clk) = match self.config.main_clock.source {
-            #[cfg(feature = "mcxa2xx")]
             #[cfg(not(feature = "sosc-as-gpio"))]
             MainClockSource::SoscClkIn => (Scs::SOSC, "clk_in", self.clocks.clk_in.as_ref()),
             MainClockSource::SircFro12M => (Scs::SIRC, "fro_12m", self.clocks.fro_12m.as_ref()),
@@ -2101,7 +2088,6 @@ impl ClockOperator<'_> {
             MainClockSource::RoscFro16K => (Scs::ROSC, "fro16k", self.clocks.clk_16k_vdd_core.as_ref()),
             #[cfg(all(feature = "mcxa5xx", not(feature = "rosc-32k-as-gpio")))]
             MainClockSource::RoscOsc32K => (Scs::ROSC, "osc32k", self.clocks.clk_32k_vdd_core.as_ref()),
-            #[cfg(feature = "mcxa2xx")]
             MainClockSource::SPll1 => (Scs::SPLL, "pll1_clk", self.clocks.pll1_clk.as_ref()),
         };
         let Some(main_clk_src) = clk else {

embassy-mcxa/src/clocks/periph_helpers/mod.rs

@@ -297,7 +297,6 @@ pub enum CTimerClockSel {
     #[cfg(feature = "mcxa2xx")]
     FroHfDiv,
     /// SOSC/XTAL/EXTAL clock source
-    #[cfg(feature = "mcxa2xx")]
     #[cfg(not(feature = "sosc-as-gpio"))]
     ClkIn,
     /// FRO16K/clk_16k source
@@ -306,7 +305,6 @@ pub enum CTimerClockSel {
     /// clk_1m/FRO_LF divided by 12
     Clk1M,
     /// Internal PLL output, with configurable divisor
-    #[cfg(feature = "mcxa2xx")]
     Pll1ClkDiv,
     /// Disabled
     None,
@@ -372,11 +370,17 @@ impl SPConfHelper for CTimerConfig {
                 let freq = clocks.ensure_fro_hf_div_active(&self.power)?;
                 (freq, CtimerClkselMux::CLKROOT_FUNC_1)
             }
-            #[cfg(feature = "mcxa2xx")]
             #[cfg(not(feature = "sosc-as-gpio"))]
             CTimerClockSel::ClkIn => {
                 let freq = clocks.ensure_clk_in_active(&self.power)?;
-                (freq, CtimerClkselMux::CLKROOT_FUNC_3)
+
+                // TODO: fix PAC names for consistency
+                #[cfg(feature = "mcxa2xx")]
+                let mux = CtimerClkselMux::CLKROOT_FUNC_3;
+                #[cfg(feature = "mcxa5xx")]
+                let mux = CtimerClkselMux::I3_CLKROOT_SOSC;
+
+                (freq, mux)
             }
             #[cfg(feature = "mcxa2xx")]
             CTimerClockSel::Clk16K => {
@@ -394,10 +398,16 @@ impl SPConfHelper for CTimerConfig {
 
                 (freq, mux)
             }
-            #[cfg(feature = "mcxa2xx")]
             CTimerClockSel::Pll1ClkDiv => {
                 let freq = clocks.ensure_pll1_clk_div_active(&self.power)?;
-                (freq, CtimerClkselMux::CLKROOT_FUNC_6)
+
+                // TODO: fix PAC names for consistency
+                #[cfg(feature = "mcxa2xx")]
+                let mux = CtimerClkselMux::CLKROOT_FUNC_6;
+                #[cfg(feature = "mcxa5xx")]
+                let mux = CtimerClkselMux::I6_CLKROOT_SPLL_DIV;
+
+                (freq, mux)
             }
             CTimerClockSel::None => {
                 // no ClkrootFunc7, just write manually for now

examples/mcxa5xx/src/bin/blinky-sosc.rs

@@ -0,0 +1,50 @@
+//! Similar to blinky, but clocked with external SOSC
+//!
+//! This will probably go away once we have the CLKOUT peripheral supported.
+
+#![no_std]
+#![no_main]
+
+use embassy_executor::Spawner;
+use embassy_mcxa::clocks::PoweredClock;
+use embassy_mcxa::clocks::config::{MainClockSource, SoscConfig, SoscMode};
+use embassy_time::Timer;
+use hal::gpio::{DriveStrength, Level, Output, SlewRate};
+use {defmt_rtt as _, embassy_mcxa as hal, panic_probe as _};
+
+#[embassy_executor::main]
+async fn main(_spawner: Spawner) {
+    let mut cfg = hal::config::Config::default();
+    let osc = SoscConfig {
+        mode: SoscMode::CrystalOscillator,
+        frequency: 24_000_000,
+        power: PoweredClock::NormalEnabledDeepSleepDisabled,
+    };
+    cfg.clock_cfg.sosc = Some(osc);
+    cfg.clock_cfg.main_clock.source = MainClockSource::SoscClkIn;
+    let p = hal::init(cfg);
+
+    defmt::info!("Blink example");
+
+    let mut red = Output::new(p.P2_14, Level::High, DriveStrength::Normal, SlewRate::Fast);
+    let mut green = Output::new(p.P2_22, Level::High, DriveStrength::Normal, SlewRate::Fast);
+    let mut blue = Output::new(p.P2_23, Level::High, DriveStrength::Normal, SlewRate::Fast);
+
+    loop {
+        defmt::info!("Toggle LEDs");
+
+        red.toggle();
+        Timer::after_millis(250).await;
+
+        red.toggle();
+        green.toggle();
+        Timer::after_millis(250).await;
+
+        green.toggle();
+        blue.toggle();
+        Timer::after_millis(250).await;
+        blue.toggle();
+
+        Timer::after_millis(250).await;
+    }
+}

examples/mcxa5xx/src/bin/blinky-spll.rs

@@ -0,0 +1,57 @@
+//! Similar to blinky, but clocked with external SOSC
+//!
+//! This will probably go away once we have the CLKOUT peripheral supported.
+
+#![no_std]
+#![no_main]
+
+use embassy_executor::Spawner;
+use embassy_mcxa::clocks::PoweredClock;
+use embassy_mcxa::clocks::config::{MainClockSource, SpllConfig, SpllMode, SpllSource};
+use embassy_time::Timer;
+use hal::gpio::{DriveStrength, Level, Output, SlewRate};
+use {defmt_rtt as _, embassy_mcxa as hal, panic_probe as _};
+
+#[embassy_executor::main]
+async fn main(_spawner: Spawner) {
+    let mut cfg = hal::config::Config::default();
+    cfg.clock_cfg.spll = Some(SpllConfig {
+        source: SpllSource::Sirc,
+        // 12MHz
+        // 12 x 32 => 384MHz
+        // 384 / (16 x 2) => 12.0MHz
+        mode: SpllMode::Mode1b {
+            m_mult: 32,
+            p_div: 16,
+            bypass_p2_div: false,
+        },
+        power: PoweredClock::NormalEnabledDeepSleepDisabled,
+        pll1_clk_div: None,
+    });
+    cfg.clock_cfg.main_clock.source = MainClockSource::SPll1;
+    let p = hal::init(cfg);
+
+    defmt::info!("Blink example");
+
+    let mut red = Output::new(p.P2_14, Level::High, DriveStrength::Normal, SlewRate::Fast);
+    let mut green = Output::new(p.P2_22, Level::High, DriveStrength::Normal, SlewRate::Fast);
+    let mut blue = Output::new(p.P2_23, Level::High, DriveStrength::Normal, SlewRate::Fast);
+
+    loop {
+        defmt::info!("Toggle LEDs");
+
+        red.toggle();
+        Timer::after_millis(250).await;
+
+        red.toggle();
+        green.toggle();
+        Timer::after_millis(250).await;
+
+        green.toggle();
+        blue.toggle();
+        Timer::after_millis(250).await;
+        blue.toggle();
+
+        Timer::after_millis(250).await;
+    }
+}