From 2f077a434baa448c3b84cba32e8d51f7e384497f Mon Sep 17 00:00:00 2001 From: Jan Niehusmann Date: Thu, 10 Nov 2022 21:17:48 +0000 Subject: [PATCH] Update doc comment of set_clock_divisor, clock_divisor_fixed_point --- rp2040-hal/src/pio.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/rp2040-hal/src/pio.rs b/rp2040-hal/src/pio.rs index 942122d..2b9e435 100644 --- a/rp2040-hal/src/pio.rs +++ b/rp2040-hal/src/pio.rs @@ -638,6 +638,10 @@ impl StateMachine { } /// Change the clock divider of a state machine. + /// + /// Changing the clock divider of a running state machine is allowed + /// and guaranteed to not cause any glitches, but the exact timing of + /// clock pulses during the change is not specified. pub fn set_clock_divisor(&mut self, divisor: f32) { // sm frequency = clock freq / (CLKDIV_INT + CLKDIV_FRAC / 256) let int = divisor as u16; @@ -647,6 +651,10 @@ impl StateMachine { } /// Change the clock divider of a state machine using a 16.8 fixed point value. + /// + /// Changing the clock divider of a running state machine is allowed + /// and guaranteed to not cause any glitches, but the exact timing of + /// clock pulses during the change is not specified. pub fn clock_divisor_fixed_point(&mut self, int: u16, frac: u8) { self.sm.set_clock_divisor(int, frac); }