additional safety comments for rosc/xosc dormant() - thanks @jannic

rp-rs · Nov 15, 2023 · 01da9fd · 01da9fd
1 parent f823a81
commit 01da9fd
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/rp2040-hal/src/rosc.rs b/rp2040-hal/src/rosc.rs
@@ -100,6 +100,7 @@ impl RingOscillator<Enabled> {
     /// This method is marked unsafe because prior to switch the ROSC into DORMANT state,
     /// PLLs must be stopped and IRQs have to be properly configured.
     /// This method does not do any of that, it merely switches the ROSC to DORMANT state.
+    /// It should only be called if this oscillator is the clock source for the system clock.
     /// See Chapter 2, Section 16, §5) for details.
     pub unsafe fn dormant(self) {
         //taken from the C SDK

diff --git a/rp2040-hal/src/xosc.rs b/rp2040-hal/src/xosc.rs
@@ -171,6 +171,7 @@ impl CrystalOscillator<Stable> {
     /// This method is marked unsafe because prior to switch the XOSC into DORMANT state,
     /// PLLs must be stopped and IRQs have to be properly configured.
     /// This method does not do any of that, it merely switches the XOSC to DORMANT state.
+    /// It should only be called if this oscillator is the clock source for the system clock.
     /// See Chapter 2, Section 16, §5) for details.
     pub unsafe fn dormant(self) -> CrystalOscillator<Unstable> {
         //taken from the C SDK