From 658a21b946caf205f38d65565220d2a61eb3fba7 Mon Sep 17 00:00:00 2001 From: Graham Sanderson Date: Tue, 17 May 2022 12:59:00 -0500 Subject: [PATCH] Update rtc_set_datetime docs to point out that the written value may not be immediately visible (#832) --- src/rp2_common/hardware_rtc/include/hardware/rtc.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/rp2_common/hardware_rtc/include/hardware/rtc.h b/src/rp2_common/hardware_rtc/include/hardware/rtc.h index 8757e36..2a72a8e 100644 --- a/src/rp2_common/hardware_rtc/include/hardware/rtc.h +++ b/src/rp2_common/hardware_rtc/include/hardware/rtc.h @@ -47,6 +47,10 @@ void rtc_init(void); /*! \brief Set the RTC to the specified time * \ingroup hardware_rtc * + * \note Note that after setting the RTC date and time, a subsequent read of the values (e.g. via rtc_get_datetime()) may not + * reflect the new setting until up to three cycles of the potentially-much-slower RTC clock domain have passed. This represents a period + * of 64 microseconds with the default RTC clock configuration. + * * \param t Pointer to a \ref datetime_t structure contains time to set * \return true if set, false if the passed in datetime was invalid. */