stash 5 - reset, stash 5 - osculp32k

ianrrees · ianrrees · commit 8edb78121e78 · 2025-07-28T11:42:15.000+12:00
diff --git a/hal/src/clock/v2/osculp32k.rs b/hal/src/clock/v2/osculp32k.rs
@@ -3,7 +3,8 @@
 //! ## Overview
 //!
 //! The `osculp32k` module provides access to the 32 kHz ultra low power
-//! internal oscillator (OSCULP32K) within the `OSC32KCTRL` peripheral.
+//! internal oscillator (OSCULP32K) within the `OSC32KCTRL` or `SYSCTRL`
+//! peripheral.
 //!
 //! The `OSCULP32K` clock is unlike most other clocks. First, it is an internal
 //! clock that is always enabled and can't be disabled. And second, it has two
@@ -13,9 +14,9 @@
 //! We can see, then, that the `OSCULP32K` peripheral forms its own, miniature
 //! clock tree. There is a 1:N producer clock that is always enabled; and there
 //! are two possible consumer clocks that can be independently and optionally
-//! enabled. In fact, this structure is illustrated by the `OSCULP32K`
-//! register, which has no regular `ENABLE` bit and two different enable bits
-//! for clock output, `EN32K` and `EN1K`.
+//! enabled. In fact, this structure is illustrated by the `OSCULP32K` register,
+//! which has no regular `ENABLE` bit and two different enable bits for clock
+//! output, `EN32K` and `EN1K`.
 //!
 //! To represent this structure in the type system, we divide the `OSCULP32K`
 //! peripheral into these three clocks. Users get access to the 1:N
@@ -165,21 +166,16 @@ use atsamd_hal_macros::hal_cfg;
 use fugit::RateExtU32;
 use typenum::U0;
 
-#[hal_cfg("clock-d5x")]
-mod imports {
-    pub use crate::pac::osc32kctrl::Osculp32k;
-    pub use crate::typelevel::{Decrement, Increment};
-}
-
-#[hal_cfg(any("clock-d11", "clock-d21"))]
-mod imports {
-    pub use crate::pac::sysctrl::Osculp32k;
-}
+#[hal_cfg("osc32kctrl")]
+use crate::pac::osc32kctrl::Osculp32k;
+#[hal_cfg("osc32kctrl")]
+use crate::typelevel::{Decrement, Increment, PrivateDecrement, PrivateIncrement};
 
-use imports::*;
+#[hal_cfg("sysctrl")]
+use crate::pac::sysctrl::Osculp32k;
 
 use crate::time::Hertz;
-use crate::typelevel::{PrivateDecrement, PrivateIncrement, Sealed};
+use crate::typelevel::Sealed;
 
 use super::{Enabled, Source};
 
@@ -223,39 +219,17 @@ pub struct OscUlp1kToken(());
 /// first exchange the token for an actual clock with [`OscUlp32k::enable`].
 pub struct OscUlp32kToken(());
 
-/// Set of tokens representing the disabled OSCULP32K clocks power-on reset
-pub struct OscUlp32kTokens {
-    pub osculp1k: OscUlp1kToken,
-    pub osculp32k: OscUlp32kToken,
-}
-
-impl OscUlp32kTokens {
-    /// Create the set of tokens
-    ///
-    /// # Safety
-    ///
-    /// There must never be more than one instance of each token at any given
-    /// time. See the notes on `Token` types and memory safety in the root of
-    /// the `clock` module for more details.
-    pub(super) unsafe fn new() -> Self {
-        Self {
-            osculp1k: OscUlp1kToken(()),
-            osculp32k: OscUlp32kToken(()),
-        }
-    }
-}
-
 impl OscUlp32kBaseToken {
     #[inline]
     fn osculp32k(&self) -> &Osculp32k {
         // Safety: The `OscUlp32kBaseToken` has exclusive access to the
         // `OSCULP32K` register. See the notes on `Token` types and memory
         // safety in the root of the `clock` module for more details.
-        #[hal_cfg("clock-d5x")]
+        #[hal_cfg("osc32kctrl")]
         unsafe {
             &(*crate::pac::Osc32kctrl::PTR).osculp32k()
         }
-        #[hal_cfg(any("clock-d11", "clock-d21"))]
+        #[hal_cfg("sysctrl")]
         unsafe {
             &(*crate::pac::Sysctrl::PTR).osculp32k()
         }
@@ -336,9 +310,9 @@ impl OscUlp32kBase {
     /// the notes on `Token` types and memory safety in the root of the `clock`
     /// module for more details.
     #[inline]
-    pub(super) unsafe fn new() -> EnabledOscUlp32kBase {
+    pub(super) unsafe fn new() -> Self {
         let token = OscUlp32kBaseToken(());
-        Enabled::new(Self { token })
+        Self { token }
     }
 }
 
@@ -401,7 +375,15 @@ pub struct OscUlp1k {
 pub type EnabledOscUlp1k<N = U0> = Enabled<OscUlp1k, N>;
 
 impl OscUlp1k {
-    #[hal_cfg(any("clock-d11", "clock-d21"))]
+    /// Create the ultra-low power base oscillator
+    ///
+    /// # Safety
+    ///
+    /// Because an `OscUlp1k` contains an `OscUlp1kToken`, there must never be
+    /// more than one instance of this struct at any given time. See the notes
+    /// on `Token` types and memory safety in the root of the `clock` module for
+    /// more details.
+    #[inline]
     pub(super) unsafe fn new() -> Self {
         let token = OscUlp1kToken(());
         Self { token }
@@ -473,7 +455,15 @@ pub struct OscUlp32k {
 pub type EnabledOscUlp32k<N = U0> = Enabled<OscUlp32k, N>;
 
 impl OscUlp32k {
-    #[hal_cfg(any("clock-d11", "clock-d21"))]
+    /// Create the ultra-low power base oscillator
+    ///
+    /// # Safety
+    ///
+    /// Because an `OscUlp32k` contains an `OscUlp32kToken`, there must never be
+    /// more than one instance of this struct at any given time. See the notes
+    /// on `Token` types and memory safety in the root of the `clock` module for
+    /// more details.
+    #[inline]
     pub(super) unsafe fn new() -> Self {
         let token = OscUlp32kToken(());
         Self { token }
diff --git a/hal/src/clock/v2/reset_thumbv6m.rs b/hal/src/clock/v2/reset_thumbv6m.rs
@@ -56,7 +56,7 @@ pub struct Buses {
     pub apb: apb::Apb,
 }
 
-pub struct OscUlp32kClocks {
+pub struct OscUlpClocks {
     pub base: osculp32k::EnabledOscUlp32kBase,
     pub osculp1k: osculp32k::EnabledOscUlp1k,
     pub osculp32k: osculp32k::EnabledOscUlp32k<U1>,
@@ -93,10 +93,10 @@ pub struct Clocks {
     pub gclk2: Enabled<gclk::Gclk2<osculp32k::OscUlp32kId>, U1>,
     /// 8 MHz internal oscillator, divided by 8 for a 1 MHz output
     pub osc: Enabled<osc::Osc, U1>,
+    /// Always-enabled OSCULP oscillators
+    pub osculp: OscUlpClocks,
     /// [`Pclk`](pclk::Pclk) for the watchdog timer, sourced from [`Gclk2`](gclk::Gclk2)
     pub wdt: pclk::Pclk<types::Wdt, gclk::Gclk2Id>,
-    /// Always-enabled OSCULP oscillators
-    pub osculp32k: OscUlp32kClocks,
 }
 
 /// Type-level tokens for unused clocks at power-on reset
@@ -147,13 +147,13 @@ pub fn clock_system_at_reset(gclk: Gclk, pm: Pm, sysctrl: Sysctrl) -> (Buses, Cl
         let osc = Enabled::<_, U0>::new(osc::Osc::new(osc::OscToken::new()));
         let (gclk0, osc) = gclk::Gclk0::from_source(gclk::GclkToken::new(), osc);
         let gclk0 = Enabled::new(gclk0);
-        let base = osculp32k::OscUlp32kBase::new();
+        let base = Enabled::new(osculp32k::OscUlp32kBase::new());
         let osculp1k = Enabled::new(osculp32k::OscUlp1k::new());
-        let osculp32k = Enabled::new(osculp32k::OscUlp32k::new());
+        let osculp32k = Enabled::<_, U0>::new(osculp32k::OscUlp32k::new());
         let (gclk2, osculp32k) = gclk::Gclk2::from_source(gclk::GclkToken::new(), osculp32k);
         let gclk2 = Enabled::new(gclk2);
         let wdt = pclk::Pclk::new(pclk::PclkToken::new(), gclk2.freq());
-        let osculp32k = OscUlp32kClocks {
+        let osculp = OscUlpClocks {
             base,
             osculp1k,
             osculp32k,
@@ -166,7 +166,7 @@ pub fn clock_system_at_reset(gclk: Gclk, pm: Pm, sysctrl: Sysctrl) -> (Buses, Cl
             gclk2,
             osc,
             wdt,
-            osculp32k,
+            osculp,
         };
         let tokens = Tokens {
             apbs: apb::ApbTokens::new(),
diff --git a/hal/src/clock/v2/reset_thumbv7em.rs b/hal/src/clock/v2/reset_thumbv7em.rs
@@ -2,7 +2,6 @@
 //! from the `v2` module, which is where the corresponding documentation will
 //! appear.
 
-use atsamd_hal_macros::hal_cfg;
 use typenum::U1;
 
 use crate::pac::{Gclk, Mclk, Osc32kctrl, Oscctrl};
@@ -58,18 +57,10 @@ pub struct Buses {
     pub apb: apb::Apb,
 }
 
-#[hal_cfg("clock-d5x")]
-#[allow(dead_code)]
-pub struct OscUlp32kClocks {
-    base: osculp32k::EnabledOscUlp32kBase,
-}
-
-#[hal_cfg(any("clock-d11", "clock-d21"))]
-#[allow(dead_code)]
-pub struct OscUlp32kClocks {
-    base: osculp32k::EnabledOscUlp32kBase,
-    osculp1k: EnabledOscUlp1k,
-    osculp32k: EnabledOscUlp32k,
+pub struct OscUlpClocks {
+    pub base: osculp32k::EnabledOscUlp32kBase,
+    pub osculp1k: osculp32k::EnabledOscUlp1k,
+    pub osculp32k: osculp32k::EnabledOscUlp32k,
 }
 
 /// Enabled clocks at power-on reset
@@ -103,7 +94,7 @@ pub struct Clocks {
     pub dfll: Enabled<dfll::Dfll, U1>,
     /// Always-enabled base oscillator for the [`OscUlp1k`](osculp32k::OscUlp1k)
     /// and [`OscUlp32k`](osculp32k::OscUlp32k) clocks.
-    pub osculp32k: OscUlp32kClocks,
+    pub osculp: OscUlpClocks,
 }
 
 /// Type-level tokens for unused clocks at power-on reset
@@ -115,32 +106,6 @@ pub struct Clocks {
 /// As described in the [top-level](super::super) documentation for the `clock`
 /// module, token types are used to guanrantee the uniqueness of each clock. To
 /// configure or enable a clock, you must provide the corresponding token.
-#[hal_cfg("clock-d5x")]
-pub struct Tokens {
-    /// Tokens to create [`apb::ApbClk`]s
-    pub apbs: apb::ApbTokens,
-    /// Token to create [`dpll::Dpll0`]
-    pub dpll0: dpll::DpllToken<dpll::Dpll0Id>,
-    /// Token to create [`dpll::Dpll1`]
-    pub dpll1: dpll::DpllToken<dpll::Dpll1Id>,
-    /// Tokens to create [`gclk::Gclk`]
-    pub gclks: gclk::GclkTokens,
-    /// Tokens to create [`pclk::Pclk`]s
-    pub pclks: pclk::PclkTokens,
-    /// Tokens to create [`rtcosc::RtcOsc`]
-    pub rtcosc: rtcosc::RtcOscToken,
-    /// Tokens [`xosc::Xosc0`]
-    pub xosc0: xosc::XoscToken<xosc::Xosc0Id>,
-    /// Token to create [`xosc::Xosc1`]
-    pub xosc1: xosc::XoscToken<xosc::Xosc1Id>,
-    /// Tokens to create [`xosc32k::Xosc32kBase`], [`xosc32k::Xosc1k`] and
-    /// [`xosc32k::Xosc32k`]
-    pub xosc32k: xosc32k::Xosc32kTokens,
-    /// Tokens to create [`osculp32k::OscUlp1k`] and [`osculp32k::OscUlp32k`]
-    pub osculp32k: osculp32k::OscUlp32kTokens,
-}
-
-#[hal_cfg(any("clock-d11", "clock-d21"))]
 pub struct Tokens {
     /// Tokens to create [`apb::ApbClk`]s
     pub apbs: apb::ApbTokens,
@@ -170,59 +135,6 @@ pub struct Tokens {
 /// [`Mclk`] PAC structs and returns the [`Buses`], [`Clocks`] and [`Tokens`].
 ///
 /// See the [module-level documentation](super) for more details.
-#[hal_cfg("clock-d5x")]
-#[inline]
-pub fn clock_system_at_reset(
-    oscctrl: Oscctrl,
-    osc32kctrl: Osc32kctrl,
-    gclk: Gclk,
-    mclk: Mclk,
-) -> (Buses, Clocks, Tokens) {
-    // Safety: No bus, clock or token is instantiated more than once
-    unsafe {
-        let buses = Buses {
-            ahb: ahb::Ahb::new(),
-            apb: apb::Apb::new(),
-        };
-        let pac = Pac {
-            oscctrl,
-            osc32kctrl,
-            gclk,
-            mclk,
-        };
-        let dfll = Enabled::<_>::new(dfll::Dfll::open_loop(dfll::DfllToken::new()));
-        let (gclk0, dfll) = gclk::Gclk0::from_source(gclk::GclkToken::new(), dfll);
-        let gclk0 = Enabled::new(gclk0);
-        let osculp32k_clocks = {
-            OscUlp32kClocks {
-                base: osculp32k::OscUlp32kBase::new(),
-            }
-        };
-        let clocks = Clocks {
-            pac,
-            ahbs: ahb::AhbClks::new(),
-            apbs: apb::ApbClks::new(),
-            gclk0,
-            dfll,
-            osculp32k: osculp32k_clocks,
-        };
-        let tokens = Tokens {
-            apbs: apb::ApbTokens::new(),
-            dpll0: dpll::DpllToken::new(),
-            dpll1: dpll::DpllToken::new(),
-            gclks: gclk::GclkTokens::new(),
-            pclks: pclk::PclkTokens::new(),
-            rtcosc: rtcosc::RtcOscToken::new(),
-            xosc0: xosc::XoscToken::new(),
-            xosc1: xosc::XoscToken::new(),
-            xosc32k: xosc32k::Xosc32kTokens::new(),
-            osculp32k: osculp32k::OscUlp32kTokens::new(),
-        };
-        (buses, clocks, tokens)
-    }
-}
-
-#[hal_cfg(any("clock-d11", "clock-d21"))]
 #[inline]
 pub fn clock_system_at_reset(
     oscctrl: Oscctrl,
@@ -245,20 +157,21 @@ pub fn clock_system_at_reset(
         let dfll = Enabled::<_>::new(dfll::Dfll::open_loop(dfll::DfllToken::new()));
         let (gclk0, dfll) = gclk::Gclk0::from_source(gclk::GclkToken::new(), dfll);
         let gclk0 = Enabled::new(gclk0);
-        let osculp32k_clocks = {
-            OscUlp32kClocks {
-                base: osculp32k::OscUlp32kBase::new(),
-                osculp1k: Enabled::new(osculp32k::OscUlp1k::new()),
-                osculp32k: Enabled::new(osculp32k::OscUlp32k::new()),
-            }
+        let base = Enabled::new(osculp32k::OscUlp32kBase::new());
+        let osculp1k = Enabled::new(osculp32k::OscUlp1k::new());
+        let osculp32k = Enabled::new(osculp32k::OscUlp32k::new());
+        let osculp = OscUlpClocks {
+            base,
+            osculp1k,
+            osculp32k,
         };
         let clocks = Clocks {
             pac,
             ahbs: ahb::AhbClks::new(),
             apbs: apb::ApbClks::new(),
             gclk0,
             dfll,
-            osculp32k: osculp32k_clocks,
+            osculp,
         };
         let tokens = Tokens {
             apbs: apb::ApbTokens::new(),
