diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index d2e440e5b5a..d6bb7982c50 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -12,7 +12,7 @@
Last Updated: May 18, 2015
+Last Updated: November 20, 2015
@@ -2340,6 +2340,14 @@ elseCONFIG_RTC
CONFIG_RTC_EXTERNAL
+ CONFIG_RTC_EXTERNAL will configure the operating
+ system so that it defers initialization of its time facilities.
CONFIG_RTC_DATETIME
up_rtc_initialize().
- Initialize the hardware RTC per the selected configuration.
- This function is called once during the OS initialization sequence
+ Initialize the builtin, MCU hardware RTC per the selected configuration.
+ This function is called once very early in the OS initialization sequence.
+ NOTE that initialization of external RTC hardware that depends on the
+ availability of OS resources (such as SPI or I2C) must be deferred
+ until the system has fully booted. Other, RTC-specific initialization
+ functions are used in that case.
up_rtc_time().
Get the current time in seconds. This is similar to the standard time() function.