abawo/pico-sdk
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update rtc_set_datetime docs to point out that the written value may not be immediately visible (#832)

Browse Source
This commit is contained in:
Graham Sanderson 2022-05-17 12:59:00 -05:00 committed by GitHub
parent e44d2c0010
commit 658a21b946
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/rp2_common/hardware_rtc/include/hardware/rtc.h
View File

@ -47,6 +47,10 @@ void rtc_init(void);
/*! \brief Set the RTC to the specified time /*! \brief Set the RTC to the specified time
* \ingroup hardware_rtc * \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 * \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. * \return true if set, false if the passed in datetime was invalid.
*/ */